]> code.delx.au - gnu-emacs/blob - src/xdisp.c
Cleanup tooltips
[gnu-emacs] / src / xdisp.c
1 /* Display generation from window structure and buffer text.
2
3 Copyright (C) 1985-1988, 1993-1995, 1997-2016 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 (at
11 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 "composite.h"
296 #include "keyboard.h"
297 #include "systime.h"
298 #include "frame.h"
299 #include "window.h"
300 #include "termchar.h"
301 #include "dispextern.h"
302 #include "character.h"
303 #include "buffer.h"
304 #include "charset.h"
305 #include "indent.h"
306 #include "commands.h"
307 #include "keymap.h"
308 #include "disptab.h"
309 #include "termhooks.h"
310 #include "termopts.h"
311 #include "intervals.h"
312 #include "coding.h"
313 #include "region-cache.h"
314 #include "font.h"
315 #include "fontset.h"
316 #include "blockinput.h"
317 #include "xwidget.h"
318 #ifdef HAVE_WINDOW_SYSTEM
319 #include TERM_HEADER
320 #endif /* HAVE_WINDOW_SYSTEM */
321
322 #ifndef FRAME_X_OUTPUT
323 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
324 #endif
325
326 #define INFINITY 10000000
327
328 /* Holds the list (error). */
329 static Lisp_Object list_of_error;
330
331 #ifdef HAVE_WINDOW_SYSTEM
332
333 /* Test if overflow newline into fringe. Called with iterator IT
334 at or past right window margin, and with IT->current_x set. */
335
336 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
337 (!NILP (Voverflow_newline_into_fringe) \
338 && FRAME_WINDOW_P ((IT)->f) \
339 && ((IT)->bidi_it.paragraph_dir == R2L \
340 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
341 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
342 && (IT)->current_x == (IT)->last_visible_x)
343
344 #else /* !HAVE_WINDOW_SYSTEM */
345 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) false
346 #endif /* HAVE_WINDOW_SYSTEM */
347
348 /* Test if the display element loaded in IT, or the underlying buffer
349 or string character, is a space or a TAB character. This is used
350 to determine where word wrapping can occur. */
351
352 #define IT_DISPLAYING_WHITESPACE(it) \
353 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
354 || ((STRINGP (it->string) \
355 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
356 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
357 || (it->s \
358 && (it->s[IT_BYTEPOS (*it)] == ' ' \
359 || it->s[IT_BYTEPOS (*it)] == '\t')) \
360 || (IT_BYTEPOS (*it) < ZV_BYTE \
361 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
362 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
363
364 /* True means print newline to stdout before next mini-buffer message. */
365
366 bool noninteractive_need_newline;
367
368 /* True means print newline to message log before next message. */
369
370 static bool message_log_need_newline;
371
372 /* Three markers that message_dolog uses.
373 It could allocate them itself, but that causes trouble
374 in handling memory-full errors. */
375 static Lisp_Object message_dolog_marker1;
376 static Lisp_Object message_dolog_marker2;
377 static Lisp_Object message_dolog_marker3;
378 \f
379 /* The buffer position of the first character appearing entirely or
380 partially on the line of the selected window which contains the
381 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
382 redisplay optimization in redisplay_internal. */
383
384 static struct text_pos this_line_start_pos;
385
386 /* Number of characters past the end of the line above, including the
387 terminating newline. */
388
389 static struct text_pos this_line_end_pos;
390
391 /* The vertical positions and the height of this line. */
392
393 static int this_line_vpos;
394 static int this_line_y;
395 static int this_line_pixel_height;
396
397 /* X position at which this display line starts. Usually zero;
398 negative if first character is partially visible. */
399
400 static int this_line_start_x;
401
402 /* The smallest character position seen by move_it_* functions as they
403 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
404 hscrolled lines, see display_line. */
405
406 static struct text_pos this_line_min_pos;
407
408 /* Buffer that this_line_.* variables are referring to. */
409
410 static struct buffer *this_line_buffer;
411
412 /* True if an overlay arrow has been displayed in this window. */
413
414 static bool overlay_arrow_seen;
415
416 /* Vector containing glyphs for an ellipsis `...'. */
417
418 static Lisp_Object default_invis_vector[3];
419
420 /* This is the window where the echo area message was displayed. It
421 is always a mini-buffer window, but it may not be the same window
422 currently active as a mini-buffer. */
423
424 Lisp_Object echo_area_window;
425
426 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
427 pushes the current message and the value of
428 message_enable_multibyte on the stack, the function restore_message
429 pops the stack and displays MESSAGE again. */
430
431 static Lisp_Object Vmessage_stack;
432
433 /* True means multibyte characters were enabled when the echo area
434 message was specified. */
435
436 static bool message_enable_multibyte;
437
438 /* At each redisplay cycle, we should refresh everything there is to refresh.
439 To do that efficiently, we use many optimizations that try to make sure we
440 don't waste too much time updating things that haven't changed.
441 The coarsest such optimization is that, in the most common cases, we only
442 look at the selected-window.
443
444 To know whether other windows should be considered for redisplay, we use the
445 variable windows_or_buffers_changed: as long as it is 0, it means that we
446 have not noticed anything that should require updating anything else than
447 the selected-window. If it is set to REDISPLAY_SOME, it means that since
448 last redisplay, some changes have been made which could impact other
449 windows. To know which ones need redisplay, every buffer, window, and frame
450 has a `redisplay' bit, which (if true) means that this object needs to be
451 redisplayed. If windows_or_buffers_changed is 0, we know there's no point
452 looking for those `redisplay' bits (actually, there might be some such bits
453 set, but then only on objects which aren't displayed anyway).
454
455 OTOH if it's non-zero we wil have to loop through all windows and then check
456 the `redisplay' bit of the corresponding window, frame, and buffer, in order
457 to decide whether that window needs attention or not. Note that we can't
458 just look at the frame's redisplay bit to decide that the whole frame can be
459 skipped, since even if the frame's redisplay bit is unset, some of its
460 windows's redisplay bits may be set.
461
462 Mostly for historical reasons, windows_or_buffers_changed can also take
463 other non-zero values. In that case, the precise value doesn't matter (it
464 encodes the cause of the setting but is only used for debugging purposes),
465 and what it means is that we shouldn't pay attention to any `redisplay' bits
466 and we should simply try and redisplay every window out there. */
467
468 int windows_or_buffers_changed;
469
470 /* Nonzero if we should redraw the mode lines on the next redisplay.
471 Similarly to `windows_or_buffers_changed', If it has value REDISPLAY_SOME,
472 then only redisplay the mode lines in those buffers/windows/frames where the
473 `redisplay' bit has been set.
474 For any other value, redisplay all mode lines (the number used is then only
475 used to track down the cause for this full-redisplay).
476
477 Since the frame title uses the same %-constructs as the mode line
478 (except %c and %l), if this variable is non-zero, we also consider
479 redisplaying the title of each frame, see x_consider_frame_title.
480
481 The `redisplay' bits are the same as those used for
482 windows_or_buffers_changed, and setting windows_or_buffers_changed also
483 causes recomputation of the mode lines of all those windows. IOW this
484 variable only has an effect if windows_or_buffers_changed is zero, in which
485 case we should only need to redisplay the mode-line of those objects with
486 a `redisplay' bit set but not the window's text content (tho we may still
487 need to refresh the text content of the selected-window). */
488
489 int update_mode_lines;
490
491 /* True after display_mode_line if %l was used and it displayed a
492 line number. */
493
494 static bool line_number_displayed;
495
496 /* The name of the *Messages* buffer, a string. */
497
498 static Lisp_Object Vmessages_buffer_name;
499
500 /* Current, index 0, and last displayed echo area message. Either
501 buffers from echo_buffers, or nil to indicate no message. */
502
503 Lisp_Object echo_area_buffer[2];
504
505 /* The buffers referenced from echo_area_buffer. */
506
507 static Lisp_Object echo_buffer[2];
508
509 /* A vector saved used in with_area_buffer to reduce consing. */
510
511 static Lisp_Object Vwith_echo_area_save_vector;
512
513 /* True means display_echo_area should display the last echo area
514 message again. Set by redisplay_preserve_echo_area. */
515
516 static bool display_last_displayed_message_p;
517
518 /* True if echo area is being used by print; false if being used by
519 message. */
520
521 static bool message_buf_print;
522
523 /* Set to true in clear_message to make redisplay_internal aware
524 of an emptied echo area. */
525
526 static bool message_cleared_p;
527
528 /* A scratch glyph row with contents used for generating truncation
529 glyphs. Also used in direct_output_for_insert. */
530
531 #define MAX_SCRATCH_GLYPHS 100
532 static struct glyph_row scratch_glyph_row;
533 static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
534
535 /* Ascent and height of the last line processed by move_it_to. */
536
537 static int last_height;
538
539 /* True if there's a help-echo in the echo area. */
540
541 bool help_echo_showing_p;
542
543 /* The maximum distance to look ahead for text properties. Values
544 that are too small let us call compute_char_face and similar
545 functions too often which is expensive. Values that are too large
546 let us call compute_char_face and alike too often because we
547 might not be interested in text properties that far away. */
548
549 #define TEXT_PROP_DISTANCE_LIMIT 100
550
551 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
552 iterator state and later restore it. This is needed because the
553 bidi iterator on bidi.c keeps a stacked cache of its states, which
554 is really a singleton. When we use scratch iterator objects to
555 move around the buffer, we can cause the bidi cache to be pushed or
556 popped, and therefore we need to restore the cache state when we
557 return to the original iterator. */
558 #define SAVE_IT(ITCOPY, ITORIG, CACHE) \
559 do { \
560 if (CACHE) \
561 bidi_unshelve_cache (CACHE, true); \
562 ITCOPY = ITORIG; \
563 CACHE = bidi_shelve_cache (); \
564 } while (false)
565
566 #define RESTORE_IT(pITORIG, pITCOPY, CACHE) \
567 do { \
568 if (pITORIG != pITCOPY) \
569 *(pITORIG) = *(pITCOPY); \
570 bidi_unshelve_cache (CACHE, false); \
571 CACHE = NULL; \
572 } while (false)
573
574 /* Functions to mark elements as needing redisplay. */
575 enum { REDISPLAY_SOME = 2}; /* Arbitrary choice. */
576
577 void
578 redisplay_other_windows (void)
579 {
580 if (!windows_or_buffers_changed)
581 windows_or_buffers_changed = REDISPLAY_SOME;
582 }
583
584 void
585 wset_redisplay (struct window *w)
586 {
587 /* Beware: selected_window can be nil during early stages. */
588 if (!EQ (make_lisp_ptr (w, Lisp_Vectorlike), selected_window))
589 redisplay_other_windows ();
590 w->redisplay = true;
591 }
592
593 void
594 fset_redisplay (struct frame *f)
595 {
596 redisplay_other_windows ();
597 f->redisplay = true;
598 }
599
600 void
601 bset_redisplay (struct buffer *b)
602 {
603 int count = buffer_window_count (b);
604 if (count > 0)
605 {
606 /* ... it's visible in other window than selected, */
607 if (count > 1 || b != XBUFFER (XWINDOW (selected_window)->contents))
608 redisplay_other_windows ();
609 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
610 so that if we later set windows_or_buffers_changed, this buffer will
611 not be omitted. */
612 b->text->redisplay = true;
613 }
614 }
615
616 void
617 bset_update_mode_line (struct buffer *b)
618 {
619 if (!update_mode_lines)
620 update_mode_lines = REDISPLAY_SOME;
621 b->text->redisplay = true;
622 }
623
624 void
625 maybe_set_redisplay (Lisp_Object symbol)
626 {
627 if (HASH_TABLE_P (Vredisplay__variables)
628 && hash_lookup (XHASH_TABLE (Vredisplay__variables), symbol, NULL) >= 0)
629 {
630 bset_update_mode_line (current_buffer);
631 current_buffer->prevent_redisplay_optimizations_p = true;
632 }
633 }
634
635 #ifdef GLYPH_DEBUG
636
637 /* True means print traces of redisplay if compiled with
638 GLYPH_DEBUG defined. */
639
640 bool trace_redisplay_p;
641
642 #endif /* GLYPH_DEBUG */
643
644 #ifdef DEBUG_TRACE_MOVE
645 /* True means trace with TRACE_MOVE to stderr. */
646 static bool trace_move;
647
648 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
649 #else
650 #define TRACE_MOVE(x) (void) 0
651 #endif
652
653 /* Buffer being redisplayed -- for redisplay_window_error. */
654
655 static struct buffer *displayed_buffer;
656
657 /* Value returned from text property handlers (see below). */
658
659 enum prop_handled
660 {
661 HANDLED_NORMALLY,
662 HANDLED_RECOMPUTE_PROPS,
663 HANDLED_OVERLAY_STRING_CONSUMED,
664 HANDLED_RETURN
665 };
666
667 /* A description of text properties that redisplay is interested
668 in. */
669
670 struct props
671 {
672 /* The symbol index of the name of the property. */
673 short name;
674
675 /* A unique index for the property. */
676 enum prop_idx idx;
677
678 /* A handler function called to set up iterator IT from the property
679 at IT's current position. Value is used to steer handle_stop. */
680 enum prop_handled (*handler) (struct it *it);
681 };
682
683 static enum prop_handled handle_face_prop (struct it *);
684 static enum prop_handled handle_invisible_prop (struct it *);
685 static enum prop_handled handle_display_prop (struct it *);
686 static enum prop_handled handle_composition_prop (struct it *);
687 static enum prop_handled handle_overlay_change (struct it *);
688 static enum prop_handled handle_fontified_prop (struct it *);
689
690 /* Properties handled by iterators. */
691
692 static struct props it_props[] =
693 {
694 {SYMBOL_INDEX (Qfontified), FONTIFIED_PROP_IDX, handle_fontified_prop},
695 /* Handle `face' before `display' because some sub-properties of
696 `display' need to know the face. */
697 {SYMBOL_INDEX (Qface), FACE_PROP_IDX, handle_face_prop},
698 {SYMBOL_INDEX (Qdisplay), DISPLAY_PROP_IDX, handle_display_prop},
699 {SYMBOL_INDEX (Qinvisible), INVISIBLE_PROP_IDX, handle_invisible_prop},
700 {SYMBOL_INDEX (Qcomposition), COMPOSITION_PROP_IDX, handle_composition_prop},
701 {0, 0, NULL}
702 };
703
704 /* Value is the position described by X. If X is a marker, value is
705 the marker_position of X. Otherwise, value is X. */
706
707 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
708
709 /* Enumeration returned by some move_it_.* functions internally. */
710
711 enum move_it_result
712 {
713 /* Not used. Undefined value. */
714 MOVE_UNDEFINED,
715
716 /* Move ended at the requested buffer position or ZV. */
717 MOVE_POS_MATCH_OR_ZV,
718
719 /* Move ended at the requested X pixel position. */
720 MOVE_X_REACHED,
721
722 /* Move within a line ended at the end of a line that must be
723 continued. */
724 MOVE_LINE_CONTINUED,
725
726 /* Move within a line ended at the end of a line that would
727 be displayed truncated. */
728 MOVE_LINE_TRUNCATED,
729
730 /* Move within a line ended at a line end. */
731 MOVE_NEWLINE_OR_CR
732 };
733
734 /* This counter is used to clear the face cache every once in a while
735 in redisplay_internal. It is incremented for each redisplay.
736 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
737 cleared. */
738
739 #define CLEAR_FACE_CACHE_COUNT 500
740 static int clear_face_cache_count;
741
742 /* Similarly for the image cache. */
743
744 #ifdef HAVE_WINDOW_SYSTEM
745 #define CLEAR_IMAGE_CACHE_COUNT 101
746 static int clear_image_cache_count;
747
748 /* Null glyph slice */
749 static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
750 #endif
751
752 /* True while redisplay_internal is in progress. */
753
754 bool redisplaying_p;
755
756 /* If a string, XTread_socket generates an event to display that string.
757 (The display is done in read_char.) */
758
759 Lisp_Object help_echo_string;
760 Lisp_Object help_echo_window;
761 Lisp_Object help_echo_object;
762 ptrdiff_t help_echo_pos;
763
764 /* Temporary variable for XTread_socket. */
765
766 Lisp_Object previous_help_echo_string;
767
768 /* Platform-independent portion of hourglass implementation. */
769
770 #ifdef HAVE_WINDOW_SYSTEM
771
772 /* True means an hourglass cursor is currently shown. */
773 static bool hourglass_shown_p;
774
775 /* If non-null, an asynchronous timer that, when it expires, displays
776 an hourglass cursor on all frames. */
777 static struct atimer *hourglass_atimer;
778
779 #endif /* HAVE_WINDOW_SYSTEM */
780
781 /* Default number of seconds to wait before displaying an hourglass
782 cursor. */
783 #define DEFAULT_HOURGLASS_DELAY 1
784
785 #ifdef HAVE_WINDOW_SYSTEM
786
787 /* Default pixel width of `thin-space' display method. */
788 #define THIN_SPACE_WIDTH 1
789
790 #endif /* HAVE_WINDOW_SYSTEM */
791
792 /* Function prototypes. */
793
794 static void setup_for_ellipsis (struct it *, int);
795 static void set_iterator_to_next (struct it *, bool);
796 static void mark_window_display_accurate_1 (struct window *, bool);
797 static bool row_for_charpos_p (struct glyph_row *, ptrdiff_t);
798 static bool cursor_row_p (struct glyph_row *);
799 static int redisplay_mode_lines (Lisp_Object, bool);
800
801 static void handle_line_prefix (struct it *);
802
803 static void handle_stop_backwards (struct it *, ptrdiff_t);
804 static void unwind_with_echo_area_buffer (Lisp_Object);
805 static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
806 static bool current_message_1 (ptrdiff_t, Lisp_Object);
807 static bool truncate_message_1 (ptrdiff_t, Lisp_Object);
808 static void set_message (Lisp_Object);
809 static bool set_message_1 (ptrdiff_t, Lisp_Object);
810 static bool display_echo_area_1 (ptrdiff_t, Lisp_Object);
811 static bool resize_mini_window_1 (ptrdiff_t, Lisp_Object);
812 static void unwind_redisplay (void);
813 static void extend_face_to_end_of_line (struct it *);
814 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
815 static void push_it (struct it *, struct text_pos *);
816 static void iterate_out_of_display_property (struct it *);
817 static void pop_it (struct it *);
818 static void redisplay_internal (void);
819 static void echo_area_display (bool);
820 static void redisplay_windows (Lisp_Object);
821 static void redisplay_window (Lisp_Object, bool);
822 static Lisp_Object redisplay_window_error (Lisp_Object);
823 static Lisp_Object redisplay_window_0 (Lisp_Object);
824 static Lisp_Object redisplay_window_1 (Lisp_Object);
825 static bool set_cursor_from_row (struct window *, struct glyph_row *,
826 struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
827 int, int);
828 static bool cursor_row_fully_visible_p (struct window *, bool, bool);
829 static bool update_menu_bar (struct frame *, bool, bool);
830 static bool try_window_reusing_current_matrix (struct window *);
831 static int try_window_id (struct window *);
832 static bool display_line (struct it *);
833 static int display_mode_lines (struct window *);
834 static int display_mode_line (struct window *, enum face_id, Lisp_Object);
835 static int display_mode_element (struct it *, int, int, int, Lisp_Object,
836 Lisp_Object, bool);
837 static int store_mode_line_string (const char *, Lisp_Object, bool, int, int,
838 Lisp_Object);
839 static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
840 static void display_menu_bar (struct window *);
841 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
842 ptrdiff_t *);
843 static int display_string (const char *, Lisp_Object, Lisp_Object,
844 ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
845 static void compute_line_metrics (struct it *);
846 static void run_redisplay_end_trigger_hook (struct it *);
847 static bool get_overlay_strings (struct it *, ptrdiff_t);
848 static bool get_overlay_strings_1 (struct it *, ptrdiff_t, bool);
849 static void next_overlay_string (struct it *);
850 static void reseat (struct it *, struct text_pos, bool);
851 static void reseat_1 (struct it *, struct text_pos, bool);
852 static bool next_element_from_display_vector (struct it *);
853 static bool next_element_from_string (struct it *);
854 static bool next_element_from_c_string (struct it *);
855 static bool next_element_from_buffer (struct it *);
856 static bool next_element_from_composition (struct it *);
857 static bool next_element_from_image (struct it *);
858 static bool next_element_from_stretch (struct it *);
859 static bool next_element_from_xwidget (struct it *);
860 static void load_overlay_strings (struct it *, ptrdiff_t);
861 static bool get_next_display_element (struct it *);
862 static enum move_it_result
863 move_it_in_display_line_to (struct it *, ptrdiff_t, int,
864 enum move_operation_enum);
865 static void get_visually_first_element (struct it *);
866 static void compute_stop_pos (struct it *);
867 static int face_before_or_after_it_pos (struct it *, bool);
868 static ptrdiff_t next_overlay_change (ptrdiff_t);
869 static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
870 Lisp_Object, struct text_pos *, ptrdiff_t, bool);
871 static int handle_single_display_spec (struct it *, Lisp_Object,
872 Lisp_Object, Lisp_Object,
873 struct text_pos *, ptrdiff_t, int, bool);
874 static int underlying_face_id (struct it *);
875
876 #define face_before_it_pos(IT) face_before_or_after_it_pos (IT, true)
877 #define face_after_it_pos(IT) face_before_or_after_it_pos (IT, false)
878
879 #ifdef HAVE_WINDOW_SYSTEM
880
881 static void update_tool_bar (struct frame *, bool);
882 static void x_draw_bottom_divider (struct window *w);
883 static void notice_overwritten_cursor (struct window *,
884 enum glyph_row_area,
885 int, int, int, int);
886 static int normal_char_height (struct font *, int);
887 static void normal_char_ascent_descent (struct font *, int, int *, int *);
888
889 static void append_stretch_glyph (struct it *, Lisp_Object,
890 int, int, int);
891
892 static Lisp_Object get_it_property (struct it *, Lisp_Object);
893 static Lisp_Object calc_line_height_property (struct it *, Lisp_Object,
894 struct font *, int, bool);
895
896 #endif /* HAVE_WINDOW_SYSTEM */
897
898 static void produce_special_glyphs (struct it *, enum display_element_type);
899 static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
900 static bool coords_in_mouse_face_p (struct window *, int, int);
901
902
903 \f
904 /***********************************************************************
905 Window display dimensions
906 ***********************************************************************/
907
908 /* Return the bottom boundary y-position for text lines in window W.
909 This is the first y position at which a line cannot start.
910 It is relative to the top of the window.
911
912 This is the height of W minus the height of a mode line, if any. */
913
914 int
915 window_text_bottom_y (struct window *w)
916 {
917 int height = WINDOW_PIXEL_HEIGHT (w);
918
919 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
920
921 if (WINDOW_WANTS_MODELINE_P (w))
922 height -= CURRENT_MODE_LINE_HEIGHT (w);
923
924 height -= WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
925
926 return height;
927 }
928
929 /* Return the pixel width of display area AREA of window W.
930 ANY_AREA means return the total width of W, not including
931 fringes to the left and right of the window. */
932
933 int
934 window_box_width (struct window *w, enum glyph_row_area area)
935 {
936 int width = w->pixel_width;
937
938 if (!w->pseudo_window_p)
939 {
940 width -= WINDOW_SCROLL_BAR_AREA_WIDTH (w);
941 width -= WINDOW_RIGHT_DIVIDER_WIDTH (w);
942
943 if (area == TEXT_AREA)
944 width -= (WINDOW_MARGINS_WIDTH (w)
945 + WINDOW_FRINGES_WIDTH (w));
946 else if (area == LEFT_MARGIN_AREA)
947 width = WINDOW_LEFT_MARGIN_WIDTH (w);
948 else if (area == RIGHT_MARGIN_AREA)
949 width = WINDOW_RIGHT_MARGIN_WIDTH (w);
950 }
951
952 /* With wide margins, fringes, etc. we might end up with a negative
953 width, correct that here. */
954 return max (0, width);
955 }
956
957
958 /* Return the pixel height of the display area of window W, not
959 including mode lines of W, if any. */
960
961 int
962 window_box_height (struct window *w)
963 {
964 struct frame *f = XFRAME (w->frame);
965 int height = WINDOW_PIXEL_HEIGHT (w);
966
967 eassert (height >= 0);
968
969 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
970 height -= WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
971
972 /* Note: the code below that determines the mode-line/header-line
973 height is essentially the same as that contained in the macro
974 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
975 the appropriate glyph row has its `mode_line_p' flag set,
976 and if it doesn't, uses estimate_mode_line_height instead. */
977
978 if (WINDOW_WANTS_MODELINE_P (w))
979 {
980 struct glyph_row *ml_row
981 = (w->current_matrix && w->current_matrix->rows
982 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
983 : 0);
984 if (ml_row && ml_row->mode_line_p)
985 height -= ml_row->height;
986 else
987 height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
988 }
989
990 if (WINDOW_WANTS_HEADER_LINE_P (w))
991 {
992 struct glyph_row *hl_row
993 = (w->current_matrix && w->current_matrix->rows
994 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
995 : 0);
996 if (hl_row && hl_row->mode_line_p)
997 height -= hl_row->height;
998 else
999 height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
1000 }
1001
1002 /* With a very small font and a mode-line that's taller than
1003 default, we might end up with a negative height. */
1004 return max (0, height);
1005 }
1006
1007 /* Return the window-relative coordinate of the left edge of display
1008 area AREA of window W. ANY_AREA means return the left edge of the
1009 whole window, to the right of the left fringe of W. */
1010
1011 int
1012 window_box_left_offset (struct window *w, enum glyph_row_area area)
1013 {
1014 int x;
1015
1016 if (w->pseudo_window_p)
1017 return 0;
1018
1019 x = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
1020
1021 if (area == TEXT_AREA)
1022 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1023 + window_box_width (w, LEFT_MARGIN_AREA));
1024 else if (area == RIGHT_MARGIN_AREA)
1025 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1026 + window_box_width (w, LEFT_MARGIN_AREA)
1027 + window_box_width (w, TEXT_AREA)
1028 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1029 ? 0
1030 : WINDOW_RIGHT_FRINGE_WIDTH (w)));
1031 else if (area == LEFT_MARGIN_AREA
1032 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1033 x += WINDOW_LEFT_FRINGE_WIDTH (w);
1034
1035 /* Don't return more than the window's pixel width. */
1036 return min (x, w->pixel_width);
1037 }
1038
1039
1040 /* Return the window-relative coordinate of the right edge of display
1041 area AREA of window W. ANY_AREA means return the right edge of the
1042 whole window, to the left of the right fringe of W. */
1043
1044 static int
1045 window_box_right_offset (struct window *w, enum glyph_row_area area)
1046 {
1047 /* Don't return more than the window's pixel width. */
1048 return min (window_box_left_offset (w, area) + window_box_width (w, area),
1049 w->pixel_width);
1050 }
1051
1052 /* Return the frame-relative coordinate of the left edge of display
1053 area AREA of window W. ANY_AREA means return the left edge of the
1054 whole window, to the right of the left fringe of W. */
1055
1056 int
1057 window_box_left (struct window *w, enum glyph_row_area area)
1058 {
1059 struct frame *f = XFRAME (w->frame);
1060 int x;
1061
1062 if (w->pseudo_window_p)
1063 return FRAME_INTERNAL_BORDER_WIDTH (f);
1064
1065 x = (WINDOW_LEFT_EDGE_X (w)
1066 + window_box_left_offset (w, area));
1067
1068 return x;
1069 }
1070
1071
1072 /* Return the frame-relative coordinate of the right edge of display
1073 area AREA of window W. ANY_AREA means return the right edge of the
1074 whole window, to the left of the right fringe of W. */
1075
1076 int
1077 window_box_right (struct window *w, enum glyph_row_area area)
1078 {
1079 return window_box_left (w, area) + window_box_width (w, area);
1080 }
1081
1082 /* Get the bounding box of the display area AREA of window W, without
1083 mode lines, in frame-relative coordinates. ANY_AREA means the
1084 whole window, not including the left and right fringes of
1085 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1086 coordinates of the upper-left corner of the box. Return in
1087 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1088
1089 void
1090 window_box (struct window *w, enum glyph_row_area area, int *box_x,
1091 int *box_y, int *box_width, int *box_height)
1092 {
1093 if (box_width)
1094 *box_width = window_box_width (w, area);
1095 if (box_height)
1096 *box_height = window_box_height (w);
1097 if (box_x)
1098 *box_x = window_box_left (w, area);
1099 if (box_y)
1100 {
1101 *box_y = WINDOW_TOP_EDGE_Y (w);
1102 if (WINDOW_WANTS_HEADER_LINE_P (w))
1103 *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
1104 }
1105 }
1106
1107 #ifdef HAVE_WINDOW_SYSTEM
1108
1109 /* Get the bounding box of the display area AREA of window W, without
1110 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1111 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1112 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1113 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1114 box. */
1115
1116 static void
1117 window_box_edges (struct window *w, int *top_left_x, int *top_left_y,
1118 int *bottom_right_x, int *bottom_right_y)
1119 {
1120 window_box (w, ANY_AREA, top_left_x, top_left_y,
1121 bottom_right_x, bottom_right_y);
1122 *bottom_right_x += *top_left_x;
1123 *bottom_right_y += *top_left_y;
1124 }
1125
1126 #endif /* HAVE_WINDOW_SYSTEM */
1127
1128 /***********************************************************************
1129 Utilities
1130 ***********************************************************************/
1131
1132 /* Return the bottom y-position of the line the iterator IT is in.
1133 This can modify IT's settings. */
1134
1135 int
1136 line_bottom_y (struct it *it)
1137 {
1138 int line_height = it->max_ascent + it->max_descent;
1139 int line_top_y = it->current_y;
1140
1141 if (line_height == 0)
1142 {
1143 if (last_height)
1144 line_height = last_height;
1145 else if (IT_CHARPOS (*it) < ZV)
1146 {
1147 move_it_by_lines (it, 1);
1148 line_height = (it->max_ascent || it->max_descent
1149 ? it->max_ascent + it->max_descent
1150 : last_height);
1151 }
1152 else
1153 {
1154 struct glyph_row *row = it->glyph_row;
1155
1156 /* Use the default character height. */
1157 it->glyph_row = NULL;
1158 it->what = IT_CHARACTER;
1159 it->c = ' ';
1160 it->len = 1;
1161 PRODUCE_GLYPHS (it);
1162 line_height = it->ascent + it->descent;
1163 it->glyph_row = row;
1164 }
1165 }
1166
1167 return line_top_y + line_height;
1168 }
1169
1170 DEFUN ("line-pixel-height", Fline_pixel_height,
1171 Sline_pixel_height, 0, 0, 0,
1172 doc: /* Return height in pixels of text line in the selected window.
1173
1174 Value is the height in pixels of the line at point. */)
1175 (void)
1176 {
1177 struct it it;
1178 struct text_pos pt;
1179 struct window *w = XWINDOW (selected_window);
1180 struct buffer *old_buffer = NULL;
1181 Lisp_Object result;
1182
1183 if (XBUFFER (w->contents) != current_buffer)
1184 {
1185 old_buffer = current_buffer;
1186 set_buffer_internal_1 (XBUFFER (w->contents));
1187 }
1188 SET_TEXT_POS (pt, PT, PT_BYTE);
1189 start_display (&it, w, pt);
1190 it.vpos = it.current_y = 0;
1191 last_height = 0;
1192 result = make_number (line_bottom_y (&it));
1193 if (old_buffer)
1194 set_buffer_internal_1 (old_buffer);
1195
1196 return result;
1197 }
1198
1199 /* Return the default pixel height of text lines in window W. The
1200 value is the canonical height of the W frame's default font, plus
1201 any extra space required by the line-spacing variable or frame
1202 parameter.
1203
1204 Implementation note: this ignores any line-spacing text properties
1205 put on the newline characters. This is because those properties
1206 only affect the _screen_ line ending in the newline (i.e., in a
1207 continued line, only the last screen line will be affected), which
1208 means only a small number of lines in a buffer can ever use this
1209 feature. Since this function is used to compute the default pixel
1210 equivalent of text lines in a window, we can safely ignore those
1211 few lines. For the same reasons, we ignore the line-height
1212 properties. */
1213 int
1214 default_line_pixel_height (struct window *w)
1215 {
1216 struct frame *f = WINDOW_XFRAME (w);
1217 int height = FRAME_LINE_HEIGHT (f);
1218
1219 if (!FRAME_INITIAL_P (f) && BUFFERP (w->contents))
1220 {
1221 struct buffer *b = XBUFFER (w->contents);
1222 Lisp_Object val = BVAR (b, extra_line_spacing);
1223
1224 if (NILP (val))
1225 val = BVAR (&buffer_defaults, extra_line_spacing);
1226 if (!NILP (val))
1227 {
1228 if (RANGED_INTEGERP (0, val, INT_MAX))
1229 height += XFASTINT (val);
1230 else if (FLOATP (val))
1231 {
1232 int addon = XFLOAT_DATA (val) * height + 0.5;
1233
1234 if (addon >= 0)
1235 height += addon;
1236 }
1237 }
1238 else
1239 height += f->extra_line_spacing;
1240 }
1241
1242 return height;
1243 }
1244
1245 /* Subroutine of pos_visible_p below. Extracts a display string, if
1246 any, from the display spec given as its argument. */
1247 static Lisp_Object
1248 string_from_display_spec (Lisp_Object spec)
1249 {
1250 if (CONSP (spec))
1251 {
1252 while (CONSP (spec))
1253 {
1254 if (STRINGP (XCAR (spec)))
1255 return XCAR (spec);
1256 spec = XCDR (spec);
1257 }
1258 }
1259 else if (VECTORP (spec))
1260 {
1261 ptrdiff_t i;
1262
1263 for (i = 0; i < ASIZE (spec); i++)
1264 {
1265 if (STRINGP (AREF (spec, i)))
1266 return AREF (spec, i);
1267 }
1268 return Qnil;
1269 }
1270
1271 return spec;
1272 }
1273
1274
1275 /* Limit insanely large values of W->hscroll on frame F to the largest
1276 value that will still prevent first_visible_x and last_visible_x of
1277 'struct it' from overflowing an int. */
1278 static int
1279 window_hscroll_limited (struct window *w, struct frame *f)
1280 {
1281 ptrdiff_t window_hscroll = w->hscroll;
1282 int window_text_width = window_box_width (w, TEXT_AREA);
1283 int colwidth = FRAME_COLUMN_WIDTH (f);
1284
1285 if (window_hscroll > (INT_MAX - window_text_width) / colwidth - 1)
1286 window_hscroll = (INT_MAX - window_text_width) / colwidth - 1;
1287
1288 return window_hscroll;
1289 }
1290
1291 /* Return true if position CHARPOS is visible in window W.
1292 CHARPOS < 0 means return info about WINDOW_END position.
1293 If visible, set *X and *Y to pixel coordinates of top left corner.
1294 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1295 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1296
1297 bool
1298 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1299 int *rtop, int *rbot, int *rowh, int *vpos)
1300 {
1301 struct it it;
1302 void *itdata = bidi_shelve_cache ();
1303 struct text_pos top;
1304 bool visible_p = false;
1305 struct buffer *old_buffer = NULL;
1306 bool r2l = false;
1307
1308 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1309 return visible_p;
1310
1311 if (XBUFFER (w->contents) != current_buffer)
1312 {
1313 old_buffer = current_buffer;
1314 set_buffer_internal_1 (XBUFFER (w->contents));
1315 }
1316
1317 SET_TEXT_POS_FROM_MARKER (top, w->start);
1318 /* Scrolling a minibuffer window via scroll bar when the echo area
1319 shows long text sometimes resets the minibuffer contents behind
1320 our backs. */
1321 if (CHARPOS (top) > ZV)
1322 SET_TEXT_POS (top, BEGV, BEGV_BYTE);
1323
1324 /* If the top of the window is after CHARPOS, the latter is surely
1325 not visible. */
1326 if (charpos >= 0 && CHARPOS (top) > charpos)
1327 return visible_p;
1328
1329 /* Compute exact mode line heights. */
1330 if (WINDOW_WANTS_MODELINE_P (w))
1331 w->mode_line_height
1332 = display_mode_line (w, CURRENT_MODE_LINE_FACE_ID (w),
1333 BVAR (current_buffer, mode_line_format));
1334
1335 if (WINDOW_WANTS_HEADER_LINE_P (w))
1336 w->header_line_height
1337 = display_mode_line (w, HEADER_LINE_FACE_ID,
1338 BVAR (current_buffer, header_line_format));
1339
1340 start_display (&it, w, top);
1341 move_it_to (&it, charpos, -1, it.last_visible_y - 1, -1,
1342 (charpos >= 0 ? MOVE_TO_POS : 0) | MOVE_TO_Y);
1343
1344 if (charpos >= 0
1345 && (((!it.bidi_p || it.bidi_it.scan_dir != -1)
1346 && IT_CHARPOS (it) >= charpos)
1347 /* When scanning backwards under bidi iteration, move_it_to
1348 stops at or _before_ CHARPOS, because it stops at or to
1349 the _right_ of the character at CHARPOS. */
1350 || (it.bidi_p && it.bidi_it.scan_dir == -1
1351 && IT_CHARPOS (it) <= charpos)))
1352 {
1353 /* We have reached CHARPOS, or passed it. How the call to
1354 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1355 or covered by a display property, move_it_to stops at the end
1356 of the invisible text, to the right of CHARPOS. (ii) If
1357 CHARPOS is in a display vector, move_it_to stops on its last
1358 glyph. */
1359 int top_x = it.current_x;
1360 int top_y = it.current_y;
1361 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1362 int bottom_y;
1363 struct it save_it;
1364 void *save_it_data = NULL;
1365
1366 /* Calling line_bottom_y may change it.method, it.position, etc. */
1367 SAVE_IT (save_it, it, save_it_data);
1368 last_height = 0;
1369 bottom_y = line_bottom_y (&it);
1370 if (top_y < window_top_y)
1371 visible_p = bottom_y > window_top_y;
1372 else if (top_y < it.last_visible_y)
1373 visible_p = true;
1374 if (bottom_y >= it.last_visible_y
1375 && it.bidi_p && it.bidi_it.scan_dir == -1
1376 && IT_CHARPOS (it) < charpos)
1377 {
1378 /* When the last line of the window is scanned backwards
1379 under bidi iteration, we could be duped into thinking
1380 that we have passed CHARPOS, when in fact move_it_to
1381 simply stopped short of CHARPOS because it reached
1382 last_visible_y. To see if that's what happened, we call
1383 move_it_to again with a slightly larger vertical limit,
1384 and see if it actually moved vertically; if it did, we
1385 didn't really reach CHARPOS, which is beyond window end. */
1386 /* Why 10? because we don't know how many canonical lines
1387 will the height of the next line(s) be. So we guess. */
1388 int ten_more_lines = 10 * default_line_pixel_height (w);
1389
1390 move_it_to (&it, charpos, -1, bottom_y + ten_more_lines, -1,
1391 MOVE_TO_POS | MOVE_TO_Y);
1392 if (it.current_y > top_y)
1393 visible_p = false;
1394
1395 }
1396 RESTORE_IT (&it, &save_it, save_it_data);
1397 if (visible_p)
1398 {
1399 if (it.method == GET_FROM_DISPLAY_VECTOR)
1400 {
1401 /* We stopped on the last glyph of a display vector.
1402 Try and recompute. Hack alert! */
1403 if (charpos < 2 || top.charpos >= charpos)
1404 top_x = it.glyph_row->x;
1405 else
1406 {
1407 struct it it2, it2_prev;
1408 /* The idea is to get to the previous buffer
1409 position, consume the character there, and use
1410 the pixel coordinates we get after that. But if
1411 the previous buffer position is also displayed
1412 from a display vector, we need to consume all of
1413 the glyphs from that display vector. */
1414 start_display (&it2, w, top);
1415 move_it_to (&it2, charpos - 1, -1, -1, -1, MOVE_TO_POS);
1416 /* If we didn't get to CHARPOS - 1, there's some
1417 replacing display property at that position, and
1418 we stopped after it. That is exactly the place
1419 whose coordinates we want. */
1420 if (IT_CHARPOS (it2) != charpos - 1)
1421 it2_prev = it2;
1422 else
1423 {
1424 /* Iterate until we get out of the display
1425 vector that displays the character at
1426 CHARPOS - 1. */
1427 do {
1428 get_next_display_element (&it2);
1429 PRODUCE_GLYPHS (&it2);
1430 it2_prev = it2;
1431 set_iterator_to_next (&it2, true);
1432 } while (it2.method == GET_FROM_DISPLAY_VECTOR
1433 && IT_CHARPOS (it2) < charpos);
1434 }
1435 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev)
1436 || it2_prev.current_x > it2_prev.last_visible_x)
1437 top_x = it.glyph_row->x;
1438 else
1439 {
1440 top_x = it2_prev.current_x;
1441 top_y = it2_prev.current_y;
1442 }
1443 }
1444 }
1445 else if (IT_CHARPOS (it) != charpos)
1446 {
1447 Lisp_Object cpos = make_number (charpos);
1448 Lisp_Object spec = Fget_char_property (cpos, Qdisplay, Qnil);
1449 Lisp_Object string = string_from_display_spec (spec);
1450 struct text_pos tpos;
1451 bool newline_in_string
1452 = (STRINGP (string)
1453 && memchr (SDATA (string), '\n', SBYTES (string)));
1454
1455 SET_TEXT_POS (tpos, charpos, CHAR_TO_BYTE (charpos));
1456 bool replacing_spec_p
1457 = (!NILP (spec)
1458 && handle_display_spec (NULL, spec, Qnil, Qnil, &tpos,
1459 charpos, FRAME_WINDOW_P (it.f)));
1460 /* The tricky code below is needed because there's a
1461 discrepancy between move_it_to and how we set cursor
1462 when PT is at the beginning of a portion of text
1463 covered by a display property or an overlay with a
1464 display property, or the display line ends in a
1465 newline from a display string. move_it_to will stop
1466 _after_ such display strings, whereas
1467 set_cursor_from_row conspires with cursor_row_p to
1468 place the cursor on the first glyph produced from the
1469 display string. */
1470
1471 /* We have overshoot PT because it is covered by a
1472 display property that replaces the text it covers.
1473 If the string includes embedded newlines, we are also
1474 in the wrong display line. Backtrack to the correct
1475 line, where the display property begins. */
1476 if (replacing_spec_p)
1477 {
1478 Lisp_Object startpos, endpos;
1479 EMACS_INT start, end;
1480 struct it it3;
1481
1482 /* Find the first and the last buffer positions
1483 covered by the display string. */
1484 endpos =
1485 Fnext_single_char_property_change (cpos, Qdisplay,
1486 Qnil, Qnil);
1487 startpos =
1488 Fprevious_single_char_property_change (endpos, Qdisplay,
1489 Qnil, Qnil);
1490 start = XFASTINT (startpos);
1491 end = XFASTINT (endpos);
1492 /* Move to the last buffer position before the
1493 display property. */
1494 start_display (&it3, w, top);
1495 if (start > CHARPOS (top))
1496 move_it_to (&it3, start - 1, -1, -1, -1, MOVE_TO_POS);
1497 /* Move forward one more line if the position before
1498 the display string is a newline or if it is the
1499 rightmost character on a line that is
1500 continued or word-wrapped. */
1501 if (it3.method == GET_FROM_BUFFER
1502 && (it3.c == '\n'
1503 || FETCH_BYTE (IT_BYTEPOS (it3)) == '\n'))
1504 move_it_by_lines (&it3, 1);
1505 else if (move_it_in_display_line_to (&it3, -1,
1506 it3.current_x
1507 + it3.pixel_width,
1508 MOVE_TO_X)
1509 == MOVE_LINE_CONTINUED)
1510 {
1511 move_it_by_lines (&it3, 1);
1512 /* When we are under word-wrap, the #$@%!
1513 move_it_by_lines moves 2 lines, so we need to
1514 fix that up. */
1515 if (it3.line_wrap == WORD_WRAP)
1516 move_it_by_lines (&it3, -1);
1517 }
1518
1519 /* Record the vertical coordinate of the display
1520 line where we wound up. */
1521 top_y = it3.current_y;
1522 if (it3.bidi_p)
1523 {
1524 /* When characters are reordered for display,
1525 the character displayed to the left of the
1526 display string could be _after_ the display
1527 property in the logical order. Use the
1528 smallest vertical position of these two. */
1529 start_display (&it3, w, top);
1530 move_it_to (&it3, end + 1, -1, -1, -1, MOVE_TO_POS);
1531 if (it3.current_y < top_y)
1532 top_y = it3.current_y;
1533 }
1534 /* Move from the top of the window to the beginning
1535 of the display line where the display string
1536 begins. */
1537 start_display (&it3, w, top);
1538 move_it_to (&it3, -1, 0, top_y, -1, MOVE_TO_X | MOVE_TO_Y);
1539 /* If it3_moved stays false after the 'while' loop
1540 below, that means we already were at a newline
1541 before the loop (e.g., the display string begins
1542 with a newline), so we don't need to (and cannot)
1543 inspect the glyphs of it3.glyph_row, because
1544 PRODUCE_GLYPHS will not produce anything for a
1545 newline, and thus it3.glyph_row stays at its
1546 stale content it got at top of the window. */
1547 bool it3_moved = false;
1548 /* Finally, advance the iterator until we hit the
1549 first display element whose character position is
1550 CHARPOS, or until the first newline from the
1551 display string, which signals the end of the
1552 display line. */
1553 while (get_next_display_element (&it3))
1554 {
1555 PRODUCE_GLYPHS (&it3);
1556 if (IT_CHARPOS (it3) == charpos
1557 || ITERATOR_AT_END_OF_LINE_P (&it3))
1558 break;
1559 it3_moved = true;
1560 set_iterator_to_next (&it3, false);
1561 }
1562 top_x = it3.current_x - it3.pixel_width;
1563 /* Normally, we would exit the above loop because we
1564 found the display element whose character
1565 position is CHARPOS. For the contingency that we
1566 didn't, and stopped at the first newline from the
1567 display string, move back over the glyphs
1568 produced from the string, until we find the
1569 rightmost glyph not from the string. */
1570 if (it3_moved
1571 && newline_in_string
1572 && IT_CHARPOS (it3) != charpos && EQ (it3.object, string))
1573 {
1574 struct glyph *g = it3.glyph_row->glyphs[TEXT_AREA]
1575 + it3.glyph_row->used[TEXT_AREA];
1576
1577 while (EQ ((g - 1)->object, string))
1578 {
1579 --g;
1580 top_x -= g->pixel_width;
1581 }
1582 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1583 + it3.glyph_row->used[TEXT_AREA]);
1584 }
1585 }
1586 }
1587
1588 *x = top_x;
1589 *y = max (top_y + max (0, it.max_ascent - it.ascent), window_top_y);
1590 *rtop = max (0, window_top_y - top_y);
1591 *rbot = max (0, bottom_y - it.last_visible_y);
1592 *rowh = max (0, (min (bottom_y, it.last_visible_y)
1593 - max (top_y, window_top_y)));
1594 *vpos = it.vpos;
1595 if (it.bidi_it.paragraph_dir == R2L)
1596 r2l = true;
1597 }
1598 }
1599 else
1600 {
1601 /* Either we were asked to provide info about WINDOW_END, or
1602 CHARPOS is in the partially visible glyph row at end of
1603 window. */
1604 struct it it2;
1605 void *it2data = NULL;
1606
1607 SAVE_IT (it2, it, it2data);
1608 if (IT_CHARPOS (it) < ZV && FETCH_BYTE (IT_BYTEPOS (it)) != '\n')
1609 move_it_by_lines (&it, 1);
1610 if (charpos < IT_CHARPOS (it)
1611 || (it.what == IT_EOB && charpos == IT_CHARPOS (it)))
1612 {
1613 visible_p = true;
1614 RESTORE_IT (&it2, &it2, it2data);
1615 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1616 *x = it2.current_x;
1617 *y = it2.current_y + it2.max_ascent - it2.ascent;
1618 *rtop = max (0, -it2.current_y);
1619 *rbot = max (0, ((it2.current_y + it2.max_ascent + it2.max_descent)
1620 - it.last_visible_y));
1621 *rowh = max (0, (min (it2.current_y + it2.max_ascent + it2.max_descent,
1622 it.last_visible_y)
1623 - max (it2.current_y,
1624 WINDOW_HEADER_LINE_HEIGHT (w))));
1625 *vpos = it2.vpos;
1626 if (it2.bidi_it.paragraph_dir == R2L)
1627 r2l = true;
1628 }
1629 else
1630 bidi_unshelve_cache (it2data, true);
1631 }
1632 bidi_unshelve_cache (itdata, false);
1633
1634 if (old_buffer)
1635 set_buffer_internal_1 (old_buffer);
1636
1637 if (visible_p)
1638 {
1639 if (w->hscroll > 0)
1640 *x -=
1641 window_hscroll_limited (w, WINDOW_XFRAME (w))
1642 * WINDOW_FRAME_COLUMN_WIDTH (w);
1643 /* For lines in an R2L paragraph, we need to mirror the X pixel
1644 coordinate wrt the text area. For the reasons, see the
1645 commentary in buffer_posn_from_coords and the explanation of
1646 the geometry used by the move_it_* functions at the end of
1647 the large commentary near the beginning of this file. */
1648 if (r2l)
1649 *x = window_box_width (w, TEXT_AREA) - *x - 1;
1650 }
1651
1652 #if false
1653 /* Debugging code. */
1654 if (visible_p)
1655 fprintf (stderr, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1656 charpos, w->vscroll, *x, *y, *rtop, *rbot, *rowh, *vpos);
1657 else
1658 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1659 #endif
1660
1661 return visible_p;
1662 }
1663
1664
1665 /* Return the next character from STR. Return in *LEN the length of
1666 the character. This is like STRING_CHAR_AND_LENGTH but never
1667 returns an invalid character. If we find one, we return a `?', but
1668 with the length of the invalid character. */
1669
1670 static int
1671 string_char_and_length (const unsigned char *str, int *len)
1672 {
1673 int c;
1674
1675 c = STRING_CHAR_AND_LENGTH (str, *len);
1676 if (!CHAR_VALID_P (c))
1677 /* We may not change the length here because other places in Emacs
1678 don't use this function, i.e. they silently accept invalid
1679 characters. */
1680 c = '?';
1681
1682 return c;
1683 }
1684
1685
1686
1687 /* Given a position POS containing a valid character and byte position
1688 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1689
1690 static struct text_pos
1691 string_pos_nchars_ahead (struct text_pos pos, Lisp_Object string, ptrdiff_t nchars)
1692 {
1693 eassert (STRINGP (string) && nchars >= 0);
1694
1695 if (STRING_MULTIBYTE (string))
1696 {
1697 const unsigned char *p = SDATA (string) + BYTEPOS (pos);
1698 int len;
1699
1700 while (nchars--)
1701 {
1702 string_char_and_length (p, &len);
1703 p += len;
1704 CHARPOS (pos) += 1;
1705 BYTEPOS (pos) += len;
1706 }
1707 }
1708 else
1709 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1710
1711 return pos;
1712 }
1713
1714
1715 /* Value is the text position, i.e. character and byte position,
1716 for character position CHARPOS in STRING. */
1717
1718 static struct text_pos
1719 string_pos (ptrdiff_t charpos, Lisp_Object string)
1720 {
1721 struct text_pos pos;
1722 eassert (STRINGP (string));
1723 eassert (charpos >= 0);
1724 SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
1725 return pos;
1726 }
1727
1728
1729 /* Value is a text position, i.e. character and byte position, for
1730 character position CHARPOS in C string S. MULTIBYTE_P
1731 means recognize multibyte characters. */
1732
1733 static struct text_pos
1734 c_string_pos (ptrdiff_t charpos, const char *s, bool multibyte_p)
1735 {
1736 struct text_pos pos;
1737
1738 eassert (s != NULL);
1739 eassert (charpos >= 0);
1740
1741 if (multibyte_p)
1742 {
1743 int len;
1744
1745 SET_TEXT_POS (pos, 0, 0);
1746 while (charpos--)
1747 {
1748 string_char_and_length ((const unsigned char *) s, &len);
1749 s += len;
1750 CHARPOS (pos) += 1;
1751 BYTEPOS (pos) += len;
1752 }
1753 }
1754 else
1755 SET_TEXT_POS (pos, charpos, charpos);
1756
1757 return pos;
1758 }
1759
1760
1761 /* Value is the number of characters in C string S. MULTIBYTE_P
1762 means recognize multibyte characters. */
1763
1764 static ptrdiff_t
1765 number_of_chars (const char *s, bool multibyte_p)
1766 {
1767 ptrdiff_t nchars;
1768
1769 if (multibyte_p)
1770 {
1771 ptrdiff_t rest = strlen (s);
1772 int len;
1773 const unsigned char *p = (const unsigned char *) s;
1774
1775 for (nchars = 0; rest > 0; ++nchars)
1776 {
1777 string_char_and_length (p, &len);
1778 rest -= len, p += len;
1779 }
1780 }
1781 else
1782 nchars = strlen (s);
1783
1784 return nchars;
1785 }
1786
1787
1788 /* Compute byte position NEWPOS->bytepos corresponding to
1789 NEWPOS->charpos. POS is a known position in string STRING.
1790 NEWPOS->charpos must be >= POS.charpos. */
1791
1792 static void
1793 compute_string_pos (struct text_pos *newpos, struct text_pos pos, Lisp_Object string)
1794 {
1795 eassert (STRINGP (string));
1796 eassert (CHARPOS (*newpos) >= CHARPOS (pos));
1797
1798 if (STRING_MULTIBYTE (string))
1799 *newpos = string_pos_nchars_ahead (pos, string,
1800 CHARPOS (*newpos) - CHARPOS (pos));
1801 else
1802 BYTEPOS (*newpos) = CHARPOS (*newpos);
1803 }
1804
1805 /* EXPORT:
1806 Return an estimation of the pixel height of mode or header lines on
1807 frame F. FACE_ID specifies what line's height to estimate. */
1808
1809 int
1810 estimate_mode_line_height (struct frame *f, enum face_id face_id)
1811 {
1812 #ifdef HAVE_WINDOW_SYSTEM
1813 if (FRAME_WINDOW_P (f))
1814 {
1815 int height = FONT_HEIGHT (FRAME_FONT (f));
1816
1817 /* This function is called so early when Emacs starts that the face
1818 cache and mode line face are not yet initialized. */
1819 if (FRAME_FACE_CACHE (f))
1820 {
1821 struct face *face = FACE_FROM_ID_OR_NULL (f, face_id);
1822 if (face)
1823 {
1824 if (face->font)
1825 height = normal_char_height (face->font, -1);
1826 if (face->box_line_width > 0)
1827 height += 2 * face->box_line_width;
1828 }
1829 }
1830
1831 return height;
1832 }
1833 #endif
1834
1835 return 1;
1836 }
1837
1838 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1839 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1840 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP, do
1841 not force the value into range. */
1842
1843 void
1844 pixel_to_glyph_coords (struct frame *f, int pix_x, int pix_y, int *x, int *y,
1845 NativeRectangle *bounds, bool noclip)
1846 {
1847
1848 #ifdef HAVE_WINDOW_SYSTEM
1849 if (FRAME_WINDOW_P (f))
1850 {
1851 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1852 even for negative values. */
1853 if (pix_x < 0)
1854 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1855 if (pix_y < 0)
1856 pix_y -= FRAME_LINE_HEIGHT (f) - 1;
1857
1858 pix_x = FRAME_PIXEL_X_TO_COL (f, pix_x);
1859 pix_y = FRAME_PIXEL_Y_TO_LINE (f, pix_y);
1860
1861 if (bounds)
1862 STORE_NATIVE_RECT (*bounds,
1863 FRAME_COL_TO_PIXEL_X (f, pix_x),
1864 FRAME_LINE_TO_PIXEL_Y (f, pix_y),
1865 FRAME_COLUMN_WIDTH (f) - 1,
1866 FRAME_LINE_HEIGHT (f) - 1);
1867
1868 /* PXW: Should we clip pixels before converting to columns/lines? */
1869 if (!noclip)
1870 {
1871 if (pix_x < 0)
1872 pix_x = 0;
1873 else if (pix_x > FRAME_TOTAL_COLS (f))
1874 pix_x = FRAME_TOTAL_COLS (f);
1875
1876 if (pix_y < 0)
1877 pix_y = 0;
1878 else if (pix_y > FRAME_TOTAL_LINES (f))
1879 pix_y = FRAME_TOTAL_LINES (f);
1880 }
1881 }
1882 #endif
1883
1884 *x = pix_x;
1885 *y = pix_y;
1886 }
1887
1888
1889 /* Find the glyph under window-relative coordinates X/Y in window W.
1890 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1891 strings. Return in *HPOS and *VPOS the row and column number of
1892 the glyph found. Return in *AREA the glyph area containing X.
1893 Value is a pointer to the glyph found or null if X/Y is not on
1894 text, or we can't tell because W's current matrix is not up to
1895 date. */
1896
1897 static struct glyph *
1898 x_y_to_hpos_vpos (struct window *w, int x, int y, int *hpos, int *vpos,
1899 int *dx, int *dy, int *area)
1900 {
1901 struct glyph *glyph, *end;
1902 struct glyph_row *row = NULL;
1903 int x0, i;
1904
1905 /* Find row containing Y. Give up if some row is not enabled. */
1906 for (i = 0; i < w->current_matrix->nrows; ++i)
1907 {
1908 row = MATRIX_ROW (w->current_matrix, i);
1909 if (!row->enabled_p)
1910 return NULL;
1911 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1912 break;
1913 }
1914
1915 *vpos = i;
1916 *hpos = 0;
1917
1918 /* Give up if Y is not in the window. */
1919 if (i == w->current_matrix->nrows)
1920 return NULL;
1921
1922 /* Get the glyph area containing X. */
1923 if (w->pseudo_window_p)
1924 {
1925 *area = TEXT_AREA;
1926 x0 = 0;
1927 }
1928 else
1929 {
1930 if (x < window_box_left_offset (w, TEXT_AREA))
1931 {
1932 *area = LEFT_MARGIN_AREA;
1933 x0 = window_box_left_offset (w, LEFT_MARGIN_AREA);
1934 }
1935 else if (x < window_box_right_offset (w, TEXT_AREA))
1936 {
1937 *area = TEXT_AREA;
1938 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
1939 }
1940 else
1941 {
1942 *area = RIGHT_MARGIN_AREA;
1943 x0 = window_box_left_offset (w, RIGHT_MARGIN_AREA);
1944 }
1945 }
1946
1947 /* Find glyph containing X. */
1948 glyph = row->glyphs[*area];
1949 end = glyph + row->used[*area];
1950 x -= x0;
1951 while (glyph < end && x >= glyph->pixel_width)
1952 {
1953 x -= glyph->pixel_width;
1954 ++glyph;
1955 }
1956
1957 if (glyph == end)
1958 return NULL;
1959
1960 if (dx)
1961 {
1962 *dx = x;
1963 *dy = y - (row->y + row->ascent - glyph->ascent);
1964 }
1965
1966 *hpos = glyph - row->glyphs[*area];
1967 return glyph;
1968 }
1969
1970 /* Convert frame-relative x/y to coordinates relative to window W.
1971 Takes pseudo-windows into account. */
1972
1973 static void
1974 frame_to_window_pixel_xy (struct window *w, int *x, int *y)
1975 {
1976 if (w->pseudo_window_p)
1977 {
1978 /* A pseudo-window is always full-width, and starts at the
1979 left edge of the frame, plus a frame border. */
1980 struct frame *f = XFRAME (w->frame);
1981 *x -= FRAME_INTERNAL_BORDER_WIDTH (f);
1982 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1983 }
1984 else
1985 {
1986 *x -= WINDOW_LEFT_EDGE_X (w);
1987 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
1988 }
1989 }
1990
1991 #ifdef HAVE_WINDOW_SYSTEM
1992
1993 /* EXPORT:
1994 Return in RECTS[] at most N clipping rectangles for glyph string S.
1995 Return the number of stored rectangles. */
1996
1997 int
1998 get_glyph_string_clip_rects (struct glyph_string *s, NativeRectangle *rects, int n)
1999 {
2000 XRectangle r;
2001
2002 if (n <= 0)
2003 return 0;
2004
2005 if (s->row->full_width_p)
2006 {
2007 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2008 r.x = WINDOW_LEFT_EDGE_X (s->w);
2009 if (s->row->mode_line_p)
2010 r.width = WINDOW_PIXEL_WIDTH (s->w) - WINDOW_RIGHT_DIVIDER_WIDTH (s->w);
2011 else
2012 r.width = WINDOW_PIXEL_WIDTH (s->w);
2013
2014 /* Unless displaying a mode or menu bar line, which are always
2015 fully visible, clip to the visible part of the row. */
2016 if (s->w->pseudo_window_p)
2017 r.height = s->row->visible_height;
2018 else
2019 r.height = s->height;
2020 }
2021 else
2022 {
2023 /* This is a text line that may be partially visible. */
2024 r.x = window_box_left (s->w, s->area);
2025 r.width = window_box_width (s->w, s->area);
2026 r.height = s->row->visible_height;
2027 }
2028
2029 if (s->clip_head)
2030 if (r.x < s->clip_head->x)
2031 {
2032 if (r.width >= s->clip_head->x - r.x)
2033 r.width -= s->clip_head->x - r.x;
2034 else
2035 r.width = 0;
2036 r.x = s->clip_head->x;
2037 }
2038 if (s->clip_tail)
2039 if (r.x + r.width > s->clip_tail->x + s->clip_tail->background_width)
2040 {
2041 if (s->clip_tail->x + s->clip_tail->background_width >= r.x)
2042 r.width = s->clip_tail->x + s->clip_tail->background_width - r.x;
2043 else
2044 r.width = 0;
2045 }
2046
2047 /* If S draws overlapping rows, it's sufficient to use the top and
2048 bottom of the window for clipping because this glyph string
2049 intentionally draws over other lines. */
2050 if (s->for_overlaps)
2051 {
2052 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2053 r.height = window_text_bottom_y (s->w) - r.y;
2054
2055 /* Alas, the above simple strategy does not work for the
2056 environments with anti-aliased text: if the same text is
2057 drawn onto the same place multiple times, it gets thicker.
2058 If the overlap we are processing is for the erased cursor, we
2059 take the intersection with the rectangle of the cursor. */
2060 if (s->for_overlaps & OVERLAPS_ERASED_CURSOR)
2061 {
2062 XRectangle rc, r_save = r;
2063
2064 rc.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (s->w, s->w->phys_cursor.x);
2065 rc.y = s->w->phys_cursor.y;
2066 rc.width = s->w->phys_cursor_width;
2067 rc.height = s->w->phys_cursor_height;
2068
2069 x_intersect_rectangles (&r_save, &rc, &r);
2070 }
2071 }
2072 else
2073 {
2074 /* Don't use S->y for clipping because it doesn't take partially
2075 visible lines into account. For example, it can be negative for
2076 partially visible lines at the top of a window. */
2077 if (!s->row->full_width_p
2078 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s->w, s->row))
2079 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2080 else
2081 r.y = max (0, s->row->y);
2082 }
2083
2084 r.y = WINDOW_TO_FRAME_PIXEL_Y (s->w, r.y);
2085
2086 /* If drawing the cursor, don't let glyph draw outside its
2087 advertised boundaries. Cleartype does this under some circumstances. */
2088 if (s->hl == DRAW_CURSOR)
2089 {
2090 struct glyph *glyph = s->first_glyph;
2091 int height, max_y;
2092
2093 if (s->x > r.x)
2094 {
2095 if (r.width >= s->x - r.x)
2096 r.width -= s->x - r.x;
2097 else /* R2L hscrolled row with cursor outside text area */
2098 r.width = 0;
2099 r.x = s->x;
2100 }
2101 r.width = min (r.width, glyph->pixel_width);
2102
2103 /* If r.y is below window bottom, ensure that we still see a cursor. */
2104 height = min (glyph->ascent + glyph->descent,
2105 min (FRAME_LINE_HEIGHT (s->f), s->row->visible_height));
2106 max_y = window_text_bottom_y (s->w) - height;
2107 max_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, max_y);
2108 if (s->ybase - glyph->ascent > max_y)
2109 {
2110 r.y = max_y;
2111 r.height = height;
2112 }
2113 else
2114 {
2115 /* Don't draw cursor glyph taller than our actual glyph. */
2116 height = max (FRAME_LINE_HEIGHT (s->f), glyph->ascent + glyph->descent);
2117 if (height < r.height)
2118 {
2119 max_y = r.y + r.height;
2120 r.y = min (max_y, max (r.y, s->ybase + glyph->descent - height));
2121 r.height = min (max_y - r.y, height);
2122 }
2123 }
2124 }
2125
2126 if (s->row->clip)
2127 {
2128 XRectangle r_save = r;
2129
2130 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2131 r.width = 0;
2132 }
2133
2134 if ((s->for_overlaps & OVERLAPS_BOTH) == 0
2135 || ((s->for_overlaps & OVERLAPS_BOTH) == OVERLAPS_BOTH && n == 1))
2136 {
2137 #ifdef CONVERT_FROM_XRECT
2138 CONVERT_FROM_XRECT (r, *rects);
2139 #else
2140 *rects = r;
2141 #endif
2142 return 1;
2143 }
2144 else
2145 {
2146 /* If we are processing overlapping and allowed to return
2147 multiple clipping rectangles, we exclude the row of the glyph
2148 string from the clipping rectangle. This is to avoid drawing
2149 the same text on the environment with anti-aliasing. */
2150 #ifdef CONVERT_FROM_XRECT
2151 XRectangle rs[2];
2152 #else
2153 XRectangle *rs = rects;
2154 #endif
2155 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2156
2157 if (s->for_overlaps & OVERLAPS_PRED)
2158 {
2159 rs[i] = r;
2160 if (r.y + r.height > row_y)
2161 {
2162 if (r.y < row_y)
2163 rs[i].height = row_y - r.y;
2164 else
2165 rs[i].height = 0;
2166 }
2167 i++;
2168 }
2169 if (s->for_overlaps & OVERLAPS_SUCC)
2170 {
2171 rs[i] = r;
2172 if (r.y < row_y + s->row->visible_height)
2173 {
2174 if (r.y + r.height > row_y + s->row->visible_height)
2175 {
2176 rs[i].y = row_y + s->row->visible_height;
2177 rs[i].height = r.y + r.height - rs[i].y;
2178 }
2179 else
2180 rs[i].height = 0;
2181 }
2182 i++;
2183 }
2184
2185 n = i;
2186 #ifdef CONVERT_FROM_XRECT
2187 for (i = 0; i < n; i++)
2188 CONVERT_FROM_XRECT (rs[i], rects[i]);
2189 #endif
2190 return n;
2191 }
2192 }
2193
2194 /* EXPORT:
2195 Return in *NR the clipping rectangle for glyph string S. */
2196
2197 void
2198 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2199 {
2200 get_glyph_string_clip_rects (s, nr, 1);
2201 }
2202
2203
2204 /* EXPORT:
2205 Return the position and height of the phys cursor in window W.
2206 Set w->phys_cursor_width to width of phys cursor.
2207 */
2208
2209 void
2210 get_phys_cursor_geometry (struct window *w, struct glyph_row *row,
2211 struct glyph *glyph, int *xp, int *yp, int *heightp)
2212 {
2213 struct frame *f = XFRAME (WINDOW_FRAME (w));
2214 int x, y, wd, h, h0, y0, ascent;
2215
2216 /* Compute the width of the rectangle to draw. If on a stretch
2217 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2218 rectangle as wide as the glyph, but use a canonical character
2219 width instead. */
2220 wd = glyph->pixel_width;
2221
2222 x = w->phys_cursor.x;
2223 if (x < 0)
2224 {
2225 wd += x;
2226 x = 0;
2227 }
2228
2229 if (glyph->type == STRETCH_GLYPH
2230 && !x_stretch_cursor_p)
2231 wd = min (FRAME_COLUMN_WIDTH (f), wd);
2232 w->phys_cursor_width = wd;
2233
2234 /* Don't let the hollow cursor glyph descend below the glyph row's
2235 ascent value, lest the hollow cursor looks funny. */
2236 y = w->phys_cursor.y;
2237 ascent = row->ascent;
2238 if (row->ascent < glyph->ascent)
2239 {
2240 y =- glyph->ascent - row->ascent;
2241 ascent = glyph->ascent;
2242 }
2243
2244 /* If y is below window bottom, ensure that we still see a cursor. */
2245 h0 = min (FRAME_LINE_HEIGHT (f), row->visible_height);
2246
2247 h = max (h0, ascent + glyph->descent);
2248 h0 = min (h0, ascent + glyph->descent);
2249
2250 y0 = WINDOW_HEADER_LINE_HEIGHT (w);
2251 if (y < y0)
2252 {
2253 h = max (h - (y0 - y) + 1, h0);
2254 y = y0 - 1;
2255 }
2256 else
2257 {
2258 y0 = window_text_bottom_y (w) - h0;
2259 if (y > y0)
2260 {
2261 h += y - y0;
2262 y = y0;
2263 }
2264 }
2265
2266 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2267 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2268 *heightp = h;
2269 }
2270
2271 /*
2272 * Remember which glyph the mouse is over.
2273 */
2274
2275 void
2276 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2277 {
2278 Lisp_Object window;
2279 struct window *w;
2280 struct glyph_row *r, *gr, *end_row;
2281 enum window_part part;
2282 enum glyph_row_area area;
2283 int x, y, width, height;
2284
2285 /* Try to determine frame pixel position and size of the glyph under
2286 frame pixel coordinates X/Y on frame F. */
2287
2288 if (window_resize_pixelwise)
2289 {
2290 width = height = 1;
2291 goto virtual_glyph;
2292 }
2293 else if (!f->glyphs_initialized_p
2294 || (window = window_from_coordinates (f, gx, gy, &part, false),
2295 NILP (window)))
2296 {
2297 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2298 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2299 goto virtual_glyph;
2300 }
2301
2302 w = XWINDOW (window);
2303 width = WINDOW_FRAME_COLUMN_WIDTH (w);
2304 height = WINDOW_FRAME_LINE_HEIGHT (w);
2305
2306 x = window_relative_x_coord (w, part, gx);
2307 y = gy - WINDOW_TOP_EDGE_Y (w);
2308
2309 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
2310 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
2311
2312 if (w->pseudo_window_p)
2313 {
2314 area = TEXT_AREA;
2315 part = ON_MODE_LINE; /* Don't adjust margin. */
2316 goto text_glyph;
2317 }
2318
2319 switch (part)
2320 {
2321 case ON_LEFT_MARGIN:
2322 area = LEFT_MARGIN_AREA;
2323 goto text_glyph;
2324
2325 case ON_RIGHT_MARGIN:
2326 area = RIGHT_MARGIN_AREA;
2327 goto text_glyph;
2328
2329 case ON_HEADER_LINE:
2330 case ON_MODE_LINE:
2331 gr = (part == ON_HEADER_LINE
2332 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2333 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2334 gy = gr->y;
2335 area = TEXT_AREA;
2336 goto text_glyph_row_found;
2337
2338 case ON_TEXT:
2339 area = TEXT_AREA;
2340
2341 text_glyph:
2342 gr = 0; gy = 0;
2343 for (; r <= end_row && r->enabled_p; ++r)
2344 if (r->y + r->height > y)
2345 {
2346 gr = r; gy = r->y;
2347 break;
2348 }
2349
2350 text_glyph_row_found:
2351 if (gr && gy <= y)
2352 {
2353 struct glyph *g = gr->glyphs[area];
2354 struct glyph *end = g + gr->used[area];
2355
2356 height = gr->height;
2357 for (gx = gr->x; g < end; gx += g->pixel_width, ++g)
2358 if (gx + g->pixel_width > x)
2359 break;
2360
2361 if (g < end)
2362 {
2363 if (g->type == IMAGE_GLYPH)
2364 {
2365 /* Don't remember when mouse is over image, as
2366 image may have hot-spots. */
2367 STORE_NATIVE_RECT (*rect, 0, 0, 0, 0);
2368 return;
2369 }
2370 width = g->pixel_width;
2371 }
2372 else
2373 {
2374 /* Use nominal char spacing at end of line. */
2375 x -= gx;
2376 gx += (x / width) * width;
2377 }
2378
2379 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2380 {
2381 gx += window_box_left_offset (w, area);
2382 /* Don't expand over the modeline to make sure the vertical
2383 drag cursor is shown early enough. */
2384 height = min (height,
2385 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2386 }
2387 }
2388 else
2389 {
2390 /* Use nominal line height at end of window. */
2391 gx = (x / width) * width;
2392 y -= gy;
2393 gy += (y / height) * height;
2394 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2395 /* See comment above. */
2396 height = min (height,
2397 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2398 }
2399 break;
2400
2401 case ON_LEFT_FRINGE:
2402 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2403 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2404 : window_box_right_offset (w, LEFT_MARGIN_AREA));
2405 width = WINDOW_LEFT_FRINGE_WIDTH (w);
2406 goto row_glyph;
2407
2408 case ON_RIGHT_FRINGE:
2409 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2410 ? window_box_right_offset (w, RIGHT_MARGIN_AREA)
2411 : window_box_right_offset (w, TEXT_AREA));
2412 if (WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
2413 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
2414 && !WINDOW_RIGHTMOST_P (w))
2415 if (gx < WINDOW_PIXEL_WIDTH (w) - width)
2416 /* Make sure the vertical border can get her own glyph to the
2417 right of the one we build here. */
2418 width = WINDOW_RIGHT_FRINGE_WIDTH (w) - width;
2419 else
2420 width = WINDOW_PIXEL_WIDTH (w) - gx;
2421 else
2422 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2423
2424 goto row_glyph;
2425
2426 case ON_VERTICAL_BORDER:
2427 gx = WINDOW_PIXEL_WIDTH (w) - width;
2428 goto row_glyph;
2429
2430 case ON_VERTICAL_SCROLL_BAR:
2431 gx = (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
2432 ? 0
2433 : (window_box_right_offset (w, RIGHT_MARGIN_AREA)
2434 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2435 ? WINDOW_RIGHT_FRINGE_WIDTH (w)
2436 : 0)));
2437 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2438
2439 row_glyph:
2440 gr = 0, gy = 0;
2441 for (; r <= end_row && r->enabled_p; ++r)
2442 if (r->y + r->height > y)
2443 {
2444 gr = r; gy = r->y;
2445 break;
2446 }
2447
2448 if (gr && gy <= y)
2449 height = gr->height;
2450 else
2451 {
2452 /* Use nominal line height at end of window. */
2453 y -= gy;
2454 gy += (y / height) * height;
2455 }
2456 break;
2457
2458 case ON_RIGHT_DIVIDER:
2459 gx = WINDOW_PIXEL_WIDTH (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
2460 width = WINDOW_RIGHT_DIVIDER_WIDTH (w);
2461 gy = 0;
2462 /* The bottom divider prevails. */
2463 height = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2464 goto add_edge;
2465
2466 case ON_BOTTOM_DIVIDER:
2467 gx = 0;
2468 width = WINDOW_PIXEL_WIDTH (w);
2469 gy = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2470 height = WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2471 goto add_edge;
2472
2473 default:
2474 ;
2475 virtual_glyph:
2476 /* If there is no glyph under the mouse, then we divide the screen
2477 into a grid of the smallest glyph in the frame, and use that
2478 as our "glyph". */
2479
2480 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2481 round down even for negative values. */
2482 if (gx < 0)
2483 gx -= width - 1;
2484 if (gy < 0)
2485 gy -= height - 1;
2486
2487 gx = (gx / width) * width;
2488 gy = (gy / height) * height;
2489
2490 goto store_rect;
2491 }
2492
2493 add_edge:
2494 gx += WINDOW_LEFT_EDGE_X (w);
2495 gy += WINDOW_TOP_EDGE_Y (w);
2496
2497 store_rect:
2498 STORE_NATIVE_RECT (*rect, gx, gy, width, height);
2499
2500 /* Visible feedback for debugging. */
2501 #if false && defined HAVE_X_WINDOWS
2502 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2503 f->output_data.x->normal_gc,
2504 gx, gy, width, height);
2505 #endif
2506 }
2507
2508
2509 #endif /* HAVE_WINDOW_SYSTEM */
2510
2511 static void
2512 adjust_window_ends (struct window *w, struct glyph_row *row, bool current)
2513 {
2514 eassert (w);
2515 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
2516 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
2517 w->window_end_vpos
2518 = MATRIX_ROW_VPOS (row, current ? w->current_matrix : w->desired_matrix);
2519 }
2520
2521 /***********************************************************************
2522 Lisp form evaluation
2523 ***********************************************************************/
2524
2525 /* Error handler for safe_eval and safe_call. */
2526
2527 static Lisp_Object
2528 safe_eval_handler (Lisp_Object arg, ptrdiff_t nargs, Lisp_Object *args)
2529 {
2530 add_to_log ("Error during redisplay: %S signaled %S",
2531 Flist (nargs, args), arg);
2532 return Qnil;
2533 }
2534
2535 /* Call function FUNC with the rest of NARGS - 1 arguments
2536 following. Return the result, or nil if something went
2537 wrong. Prevent redisplay during the evaluation. */
2538
2539 static Lisp_Object
2540 safe__call (bool inhibit_quit, ptrdiff_t nargs, Lisp_Object func, va_list ap)
2541 {
2542 Lisp_Object val;
2543
2544 if (inhibit_eval_during_redisplay)
2545 val = Qnil;
2546 else
2547 {
2548 ptrdiff_t i;
2549 ptrdiff_t count = SPECPDL_INDEX ();
2550 Lisp_Object *args;
2551 USE_SAFE_ALLOCA;
2552 SAFE_ALLOCA_LISP (args, nargs);
2553
2554 args[0] = func;
2555 for (i = 1; i < nargs; i++)
2556 args[i] = va_arg (ap, Lisp_Object);
2557
2558 specbind (Qinhibit_redisplay, Qt);
2559 if (inhibit_quit)
2560 specbind (Qinhibit_quit, Qt);
2561 /* Use Qt to ensure debugger does not run,
2562 so there is no possibility of wanting to redisplay. */
2563 val = internal_condition_case_n (Ffuncall, nargs, args, Qt,
2564 safe_eval_handler);
2565 SAFE_FREE ();
2566 val = unbind_to (count, val);
2567 }
2568
2569 return val;
2570 }
2571
2572 Lisp_Object
2573 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2574 {
2575 Lisp_Object retval;
2576 va_list ap;
2577
2578 va_start (ap, func);
2579 retval = safe__call (false, nargs, func, ap);
2580 va_end (ap);
2581 return retval;
2582 }
2583
2584 /* Call function FN with one argument ARG.
2585 Return the result, or nil if something went wrong. */
2586
2587 Lisp_Object
2588 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2589 {
2590 return safe_call (2, fn, arg);
2591 }
2592
2593 static Lisp_Object
2594 safe__call1 (bool inhibit_quit, Lisp_Object fn, ...)
2595 {
2596 Lisp_Object retval;
2597 va_list ap;
2598
2599 va_start (ap, fn);
2600 retval = safe__call (inhibit_quit, 2, fn, ap);
2601 va_end (ap);
2602 return retval;
2603 }
2604
2605 Lisp_Object
2606 safe_eval (Lisp_Object sexpr)
2607 {
2608 return safe__call1 (false, Qeval, sexpr);
2609 }
2610
2611 static Lisp_Object
2612 safe__eval (bool inhibit_quit, Lisp_Object sexpr)
2613 {
2614 return safe__call1 (inhibit_quit, Qeval, sexpr);
2615 }
2616
2617 /* Call function FN with two arguments ARG1 and ARG2.
2618 Return the result, or nil if something went wrong. */
2619
2620 Lisp_Object
2621 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2622 {
2623 return safe_call (3, fn, arg1, arg2);
2624 }
2625
2626
2627 \f
2628 /***********************************************************************
2629 Debugging
2630 ***********************************************************************/
2631
2632 /* Define CHECK_IT to perform sanity checks on iterators.
2633 This is for debugging. It is too slow to do unconditionally. */
2634
2635 static void
2636 CHECK_IT (struct it *it)
2637 {
2638 #if false
2639 if (it->method == GET_FROM_STRING)
2640 {
2641 eassert (STRINGP (it->string));
2642 eassert (IT_STRING_CHARPOS (*it) >= 0);
2643 }
2644 else
2645 {
2646 eassert (IT_STRING_CHARPOS (*it) < 0);
2647 if (it->method == GET_FROM_BUFFER)
2648 {
2649 /* Check that character and byte positions agree. */
2650 eassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
2651 }
2652 }
2653
2654 if (it->dpvec)
2655 eassert (it->current.dpvec_index >= 0);
2656 else
2657 eassert (it->current.dpvec_index < 0);
2658 #endif
2659 }
2660
2661
2662 /* Check that the window end of window W is what we expect it
2663 to be---the last row in the current matrix displaying text. */
2664
2665 static void
2666 CHECK_WINDOW_END (struct window *w)
2667 {
2668 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2669 if (!MINI_WINDOW_P (w) && w->window_end_valid)
2670 {
2671 struct glyph_row *row;
2672 eassert ((row = MATRIX_ROW (w->current_matrix, w->window_end_vpos),
2673 !row->enabled_p
2674 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2675 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2676 }
2677 #endif
2678 }
2679
2680 /***********************************************************************
2681 Iterator initialization
2682 ***********************************************************************/
2683
2684 /* Initialize IT for displaying current_buffer in window W, starting
2685 at character position CHARPOS. CHARPOS < 0 means that no buffer
2686 position is specified which is useful when the iterator is assigned
2687 a position later. BYTEPOS is the byte position corresponding to
2688 CHARPOS.
2689
2690 If ROW is not null, calls to produce_glyphs with IT as parameter
2691 will produce glyphs in that row.
2692
2693 BASE_FACE_ID is the id of a base face to use. It must be one of
2694 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2695 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2696 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2697
2698 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2699 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2700 will be initialized to use the corresponding mode line glyph row of
2701 the desired matrix of W. */
2702
2703 void
2704 init_iterator (struct it *it, struct window *w,
2705 ptrdiff_t charpos, ptrdiff_t bytepos,
2706 struct glyph_row *row, enum face_id base_face_id)
2707 {
2708 enum face_id remapped_base_face_id = base_face_id;
2709
2710 /* Some precondition checks. */
2711 eassert (w != NULL && it != NULL);
2712 eassert (charpos < 0 || (charpos >= BUF_BEG (current_buffer)
2713 && charpos <= ZV));
2714
2715 /* If face attributes have been changed since the last redisplay,
2716 free realized faces now because they depend on face definitions
2717 that might have changed. Don't free faces while there might be
2718 desired matrices pending which reference these faces. */
2719 if (!inhibit_free_realized_faces)
2720 {
2721 if (face_change)
2722 {
2723 face_change = false;
2724 free_all_realized_faces (Qnil);
2725 }
2726 else if (XFRAME (w->frame)->face_change)
2727 {
2728 XFRAME (w->frame)->face_change = 0;
2729 free_all_realized_faces (w->frame);
2730 }
2731 }
2732
2733 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2734 if (! NILP (Vface_remapping_alist))
2735 remapped_base_face_id
2736 = lookup_basic_face (XFRAME (w->frame), base_face_id);
2737
2738 /* Use one of the mode line rows of W's desired matrix if
2739 appropriate. */
2740 if (row == NULL)
2741 {
2742 if (base_face_id == MODE_LINE_FACE_ID
2743 || base_face_id == MODE_LINE_INACTIVE_FACE_ID)
2744 row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
2745 else if (base_face_id == HEADER_LINE_FACE_ID)
2746 row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
2747 }
2748
2749 /* Clear IT, and set it->object and other IT's Lisp objects to Qnil.
2750 Other parts of redisplay rely on that. */
2751 memclear (it, sizeof *it);
2752 it->current.overlay_string_index = -1;
2753 it->current.dpvec_index = -1;
2754 it->base_face_id = remapped_base_face_id;
2755 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
2756 it->paragraph_embedding = L2R;
2757 it->bidi_it.w = w;
2758
2759 /* The window in which we iterate over current_buffer: */
2760 XSETWINDOW (it->window, w);
2761 it->w = w;
2762 it->f = XFRAME (w->frame);
2763
2764 it->cmp_it.id = -1;
2765
2766 /* Extra space between lines (on window systems only). */
2767 if (base_face_id == DEFAULT_FACE_ID
2768 && FRAME_WINDOW_P (it->f))
2769 {
2770 if (NATNUMP (BVAR (current_buffer, extra_line_spacing)))
2771 it->extra_line_spacing = XFASTINT (BVAR (current_buffer, extra_line_spacing));
2772 else if (FLOATP (BVAR (current_buffer, extra_line_spacing)))
2773 it->extra_line_spacing = (XFLOAT_DATA (BVAR (current_buffer, extra_line_spacing))
2774 * FRAME_LINE_HEIGHT (it->f));
2775 else if (it->f->extra_line_spacing > 0)
2776 it->extra_line_spacing = it->f->extra_line_spacing;
2777 }
2778
2779 /* If realized faces have been removed, e.g. because of face
2780 attribute changes of named faces, recompute them. When running
2781 in batch mode, the face cache of the initial frame is null. If
2782 we happen to get called, make a dummy face cache. */
2783 if (FRAME_FACE_CACHE (it->f) == NULL)
2784 init_frame_faces (it->f);
2785 if (FRAME_FACE_CACHE (it->f)->used == 0)
2786 recompute_basic_faces (it->f);
2787
2788 it->override_ascent = -1;
2789
2790 /* Are control characters displayed as `^C'? */
2791 it->ctl_arrow_p = !NILP (BVAR (current_buffer, ctl_arrow));
2792
2793 /* -1 means everything between a CR and the following line end
2794 is invisible. >0 means lines indented more than this value are
2795 invisible. */
2796 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2797 ? (clip_to_bounds
2798 (-1, XINT (BVAR (current_buffer, selective_display)),
2799 PTRDIFF_MAX))
2800 : (!NILP (BVAR (current_buffer, selective_display))
2801 ? -1 : 0));
2802 it->selective_display_ellipsis_p
2803 = !NILP (BVAR (current_buffer, selective_display_ellipses));
2804
2805 /* Display table to use. */
2806 it->dp = window_display_table (w);
2807
2808 /* Are multibyte characters enabled in current_buffer? */
2809 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2810
2811 /* Get the position at which the redisplay_end_trigger hook should
2812 be run, if it is to be run at all. */
2813 if (MARKERP (w->redisplay_end_trigger)
2814 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
2815 it->redisplay_end_trigger_charpos
2816 = marker_position (w->redisplay_end_trigger);
2817 else if (INTEGERP (w->redisplay_end_trigger))
2818 it->redisplay_end_trigger_charpos
2819 = clip_to_bounds (PTRDIFF_MIN, XINT (w->redisplay_end_trigger),
2820 PTRDIFF_MAX);
2821
2822 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2823
2824 /* Are lines in the display truncated? */
2825 if (TRUNCATE != 0)
2826 it->line_wrap = TRUNCATE;
2827 if (base_face_id == DEFAULT_FACE_ID
2828 && !it->w->hscroll
2829 && (WINDOW_FULL_WIDTH_P (it->w)
2830 || NILP (Vtruncate_partial_width_windows)
2831 || (INTEGERP (Vtruncate_partial_width_windows)
2832 /* PXW: Shall we do something about this? */
2833 && (XINT (Vtruncate_partial_width_windows)
2834 <= WINDOW_TOTAL_COLS (it->w))))
2835 && NILP (BVAR (current_buffer, truncate_lines)))
2836 it->line_wrap = NILP (BVAR (current_buffer, word_wrap))
2837 ? WINDOW_WRAP : WORD_WRAP;
2838
2839 /* Get dimensions of truncation and continuation glyphs. These are
2840 displayed as fringe bitmaps under X, but we need them for such
2841 frames when the fringes are turned off. But leave the dimensions
2842 zero for tooltip frames, as these glyphs look ugly there and also
2843 sabotage calculations of tooltip dimensions in x-show-tip. */
2844 if (!FRAME_TOOLTIP_P (it->f))
2845 {
2846 if (it->line_wrap == TRUNCATE)
2847 {
2848 /* We will need the truncation glyph. */
2849 eassert (it->glyph_row == NULL);
2850 produce_special_glyphs (it, IT_TRUNCATION);
2851 it->truncation_pixel_width = it->pixel_width;
2852 }
2853 else
2854 {
2855 /* We will need the continuation glyph. */
2856 eassert (it->glyph_row == NULL);
2857 produce_special_glyphs (it, IT_CONTINUATION);
2858 it->continuation_pixel_width = it->pixel_width;
2859 }
2860 }
2861
2862 /* Reset these values to zero because the produce_special_glyphs
2863 above has changed them. */
2864 it->pixel_width = it->ascent = it->descent = 0;
2865 it->phys_ascent = it->phys_descent = 0;
2866
2867 /* Set this after getting the dimensions of truncation and
2868 continuation glyphs, so that we don't produce glyphs when calling
2869 produce_special_glyphs, above. */
2870 it->glyph_row = row;
2871 it->area = TEXT_AREA;
2872
2873 /* Get the dimensions of the display area. The display area
2874 consists of the visible window area plus a horizontally scrolled
2875 part to the left of the window. All x-values are relative to the
2876 start of this total display area. */
2877 if (base_face_id != DEFAULT_FACE_ID)
2878 {
2879 /* Mode lines, menu bar in terminal frames. */
2880 it->first_visible_x = 0;
2881 it->last_visible_x = WINDOW_PIXEL_WIDTH (w);
2882 }
2883 else
2884 {
2885 it->first_visible_x
2886 = window_hscroll_limited (it->w, it->f) * FRAME_COLUMN_WIDTH (it->f);
2887 it->last_visible_x = (it->first_visible_x
2888 + window_box_width (w, TEXT_AREA));
2889
2890 /* If we truncate lines, leave room for the truncation glyph(s) at
2891 the right margin. Otherwise, leave room for the continuation
2892 glyph(s). Done only if the window has no right fringe. */
2893 if (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
2894 {
2895 if (it->line_wrap == TRUNCATE)
2896 it->last_visible_x -= it->truncation_pixel_width;
2897 else
2898 it->last_visible_x -= it->continuation_pixel_width;
2899 }
2900
2901 it->header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
2902 it->current_y = WINDOW_HEADER_LINE_HEIGHT (w) + w->vscroll;
2903 }
2904
2905 /* Leave room for a border glyph. */
2906 if (!FRAME_WINDOW_P (it->f)
2907 && !WINDOW_RIGHTMOST_P (it->w))
2908 it->last_visible_x -= 1;
2909
2910 it->last_visible_y = window_text_bottom_y (w);
2911
2912 /* For mode lines and alike, arrange for the first glyph having a
2913 left box line if the face specifies a box. */
2914 if (base_face_id != DEFAULT_FACE_ID)
2915 {
2916 struct face *face;
2917
2918 it->face_id = remapped_base_face_id;
2919
2920 /* If we have a boxed mode line, make the first character appear
2921 with a left box line. */
2922 face = FACE_FROM_ID_OR_NULL (it->f, remapped_base_face_id);
2923 if (face && face->box != FACE_NO_BOX)
2924 it->start_of_box_run_p = true;
2925 }
2926
2927 /* If a buffer position was specified, set the iterator there,
2928 getting overlays and face properties from that position. */
2929 if (charpos >= BUF_BEG (current_buffer))
2930 {
2931 it->stop_charpos = charpos;
2932 it->end_charpos = ZV;
2933 eassert (charpos == BYTE_TO_CHAR (bytepos));
2934 IT_CHARPOS (*it) = charpos;
2935 IT_BYTEPOS (*it) = bytepos;
2936
2937 /* We will rely on `reseat' to set this up properly, via
2938 handle_face_prop. */
2939 it->face_id = it->base_face_id;
2940
2941 it->start = it->current;
2942 /* Do we need to reorder bidirectional text? Not if this is a
2943 unibyte buffer: by definition, none of the single-byte
2944 characters are strong R2L, so no reordering is needed. And
2945 bidi.c doesn't support unibyte buffers anyway. Also, don't
2946 reorder while we are loading loadup.el, since the tables of
2947 character properties needed for reordering are not yet
2948 available. */
2949 it->bidi_p =
2950 !redisplay__inhibit_bidi
2951 && !NILP (BVAR (current_buffer, bidi_display_reordering))
2952 && it->multibyte_p;
2953
2954 /* If we are to reorder bidirectional text, init the bidi
2955 iterator. */
2956 if (it->bidi_p)
2957 {
2958 /* Since we don't know at this point whether there will be
2959 any R2L lines in the window, we reserve space for
2960 truncation/continuation glyphs even if only the left
2961 fringe is absent. */
2962 if (base_face_id == DEFAULT_FACE_ID
2963 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
2964 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
2965 {
2966 if (it->line_wrap == TRUNCATE)
2967 it->last_visible_x -= it->truncation_pixel_width;
2968 else
2969 it->last_visible_x -= it->continuation_pixel_width;
2970 }
2971 /* Note the paragraph direction that this buffer wants to
2972 use. */
2973 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2974 Qleft_to_right))
2975 it->paragraph_embedding = L2R;
2976 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
2977 Qright_to_left))
2978 it->paragraph_embedding = R2L;
2979 else
2980 it->paragraph_embedding = NEUTRAL_DIR;
2981 bidi_unshelve_cache (NULL, false);
2982 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
2983 &it->bidi_it);
2984 }
2985
2986 /* Compute faces etc. */
2987 reseat (it, it->current.pos, true);
2988 }
2989
2990 CHECK_IT (it);
2991 }
2992
2993
2994 /* Initialize IT for the display of window W with window start POS. */
2995
2996 void
2997 start_display (struct it *it, struct window *w, struct text_pos pos)
2998 {
2999 struct glyph_row *row;
3000 bool first_vpos = WINDOW_WANTS_HEADER_LINE_P (w);
3001
3002 row = w->desired_matrix->rows + first_vpos;
3003 init_iterator (it, w, CHARPOS (pos), BYTEPOS (pos), row, DEFAULT_FACE_ID);
3004 it->first_vpos = first_vpos;
3005
3006 /* Don't reseat to previous visible line start if current start
3007 position is in a string or image. */
3008 if (it->method == GET_FROM_BUFFER && it->line_wrap != TRUNCATE)
3009 {
3010 int first_y = it->current_y;
3011
3012 /* If window start is not at a line start, skip forward to POS to
3013 get the correct continuation lines width. */
3014 bool start_at_line_beg_p = (CHARPOS (pos) == BEGV
3015 || FETCH_BYTE (BYTEPOS (pos) - 1) == '\n');
3016 if (!start_at_line_beg_p)
3017 {
3018 int new_x;
3019
3020 reseat_at_previous_visible_line_start (it);
3021 move_it_to (it, CHARPOS (pos), -1, -1, -1, MOVE_TO_POS);
3022
3023 new_x = it->current_x + it->pixel_width;
3024
3025 /* If lines are continued, this line may end in the middle
3026 of a multi-glyph character (e.g. a control character
3027 displayed as \003, or in the middle of an overlay
3028 string). In this case move_it_to above will not have
3029 taken us to the start of the continuation line but to the
3030 end of the continued line. */
3031 if (it->current_x > 0
3032 && it->line_wrap != TRUNCATE /* Lines are continued. */
3033 && (/* And glyph doesn't fit on the line. */
3034 new_x > it->last_visible_x
3035 /* Or it fits exactly and we're on a window
3036 system frame. */
3037 || (new_x == it->last_visible_x
3038 && FRAME_WINDOW_P (it->f)
3039 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
3040 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
3041 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
3042 {
3043 if ((it->current.dpvec_index >= 0
3044 || it->current.overlay_string_index >= 0)
3045 /* If we are on a newline from a display vector or
3046 overlay string, then we are already at the end of
3047 a screen line; no need to go to the next line in
3048 that case, as this line is not really continued.
3049 (If we do go to the next line, C-e will not DTRT.) */
3050 && it->c != '\n')
3051 {
3052 set_iterator_to_next (it, true);
3053 move_it_in_display_line_to (it, -1, -1, 0);
3054 }
3055
3056 it->continuation_lines_width += it->current_x;
3057 }
3058 /* If the character at POS is displayed via a display
3059 vector, move_it_to above stops at the final glyph of
3060 IT->dpvec. To make the caller redisplay that character
3061 again (a.k.a. start at POS), we need to reset the
3062 dpvec_index to the beginning of IT->dpvec. */
3063 else if (it->current.dpvec_index >= 0)
3064 it->current.dpvec_index = 0;
3065
3066 /* We're starting a new display line, not affected by the
3067 height of the continued line, so clear the appropriate
3068 fields in the iterator structure. */
3069 it->max_ascent = it->max_descent = 0;
3070 it->max_phys_ascent = it->max_phys_descent = 0;
3071
3072 it->current_y = first_y;
3073 it->vpos = 0;
3074 it->current_x = it->hpos = 0;
3075 }
3076 }
3077 }
3078
3079
3080 /* Return true if POS is a position in ellipses displayed for invisible
3081 text. W is the window we display, for text property lookup. */
3082
3083 static bool
3084 in_ellipses_for_invisible_text_p (struct display_pos *pos, struct window *w)
3085 {
3086 Lisp_Object prop, window;
3087 bool ellipses_p = false;
3088 ptrdiff_t charpos = CHARPOS (pos->pos);
3089
3090 /* If POS specifies a position in a display vector, this might
3091 be for an ellipsis displayed for invisible text. We won't
3092 get the iterator set up for delivering that ellipsis unless
3093 we make sure that it gets aware of the invisible text. */
3094 if (pos->dpvec_index >= 0
3095 && pos->overlay_string_index < 0
3096 && CHARPOS (pos->string_pos) < 0
3097 && charpos > BEGV
3098 && (XSETWINDOW (window, w),
3099 prop = Fget_char_property (make_number (charpos),
3100 Qinvisible, window),
3101 TEXT_PROP_MEANS_INVISIBLE (prop) == 0))
3102 {
3103 prop = Fget_char_property (make_number (charpos - 1), Qinvisible,
3104 window);
3105 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3106 }
3107
3108 return ellipses_p;
3109 }
3110
3111
3112 /* Initialize IT for stepping through current_buffer in window W,
3113 starting at position POS that includes overlay string and display
3114 vector/ control character translation position information. Value
3115 is false if there are overlay strings with newlines at POS. */
3116
3117 static bool
3118 init_from_display_pos (struct it *it, struct window *w, struct display_pos *pos)
3119 {
3120 ptrdiff_t charpos = CHARPOS (pos->pos), bytepos = BYTEPOS (pos->pos);
3121 int i;
3122 bool overlay_strings_with_newlines = false;
3123
3124 /* If POS specifies a position in a display vector, this might
3125 be for an ellipsis displayed for invisible text. We won't
3126 get the iterator set up for delivering that ellipsis unless
3127 we make sure that it gets aware of the invisible text. */
3128 if (in_ellipses_for_invisible_text_p (pos, w))
3129 {
3130 --charpos;
3131 bytepos = 0;
3132 }
3133
3134 /* Keep in mind: the call to reseat in init_iterator skips invisible
3135 text, so we might end up at a position different from POS. This
3136 is only a problem when POS is a row start after a newline and an
3137 overlay starts there with an after-string, and the overlay has an
3138 invisible property. Since we don't skip invisible text in
3139 display_line and elsewhere immediately after consuming the
3140 newline before the row start, such a POS will not be in a string,
3141 but the call to init_iterator below will move us to the
3142 after-string. */
3143 init_iterator (it, w, charpos, bytepos, NULL, DEFAULT_FACE_ID);
3144
3145 /* This only scans the current chunk -- it should scan all chunks.
3146 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3147 to 16 in 22.1 to make this a lesser problem. */
3148 for (i = 0; i < it->n_overlay_strings && i < OVERLAY_STRING_CHUNK_SIZE; ++i)
3149 {
3150 const char *s = SSDATA (it->overlay_strings[i]);
3151 const char *e = s + SBYTES (it->overlay_strings[i]);
3152
3153 while (s < e && *s != '\n')
3154 ++s;
3155
3156 if (s < e)
3157 {
3158 overlay_strings_with_newlines = true;
3159 break;
3160 }
3161 }
3162
3163 /* If position is within an overlay string, set up IT to the right
3164 overlay string. */
3165 if (pos->overlay_string_index >= 0)
3166 {
3167 int relative_index;
3168
3169 /* If the first overlay string happens to have a `display'
3170 property for an image, the iterator will be set up for that
3171 image, and we have to undo that setup first before we can
3172 correct the overlay string index. */
3173 if (it->method == GET_FROM_IMAGE)
3174 pop_it (it);
3175
3176 /* We already have the first chunk of overlay strings in
3177 IT->overlay_strings. Load more until the one for
3178 pos->overlay_string_index is in IT->overlay_strings. */
3179 if (pos->overlay_string_index >= OVERLAY_STRING_CHUNK_SIZE)
3180 {
3181 ptrdiff_t n = pos->overlay_string_index / OVERLAY_STRING_CHUNK_SIZE;
3182 it->current.overlay_string_index = 0;
3183 while (n--)
3184 {
3185 load_overlay_strings (it, 0);
3186 it->current.overlay_string_index += OVERLAY_STRING_CHUNK_SIZE;
3187 }
3188 }
3189
3190 it->current.overlay_string_index = pos->overlay_string_index;
3191 relative_index = (it->current.overlay_string_index
3192 % OVERLAY_STRING_CHUNK_SIZE);
3193 it->string = it->overlay_strings[relative_index];
3194 eassert (STRINGP (it->string));
3195 it->current.string_pos = pos->string_pos;
3196 it->method = GET_FROM_STRING;
3197 it->end_charpos = SCHARS (it->string);
3198 /* Set up the bidi iterator for this overlay string. */
3199 if (it->bidi_p)
3200 {
3201 it->bidi_it.string.lstring = it->string;
3202 it->bidi_it.string.s = NULL;
3203 it->bidi_it.string.schars = SCHARS (it->string);
3204 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
3205 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
3206 it->bidi_it.string.unibyte = !it->multibyte_p;
3207 it->bidi_it.w = it->w;
3208 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3209 FRAME_WINDOW_P (it->f), &it->bidi_it);
3210
3211 /* Synchronize the state of the bidi iterator with
3212 pos->string_pos. For any string position other than
3213 zero, this will be done automagically when we resume
3214 iteration over the string and get_visually_first_element
3215 is called. But if string_pos is zero, and the string is
3216 to be reordered for display, we need to resync manually,
3217 since it could be that the iteration state recorded in
3218 pos ended at string_pos of 0 moving backwards in string. */
3219 if (CHARPOS (pos->string_pos) == 0)
3220 {
3221 get_visually_first_element (it);
3222 if (IT_STRING_CHARPOS (*it) != 0)
3223 do {
3224 /* Paranoia. */
3225 eassert (it->bidi_it.charpos < it->bidi_it.string.schars);
3226 bidi_move_to_visually_next (&it->bidi_it);
3227 } while (it->bidi_it.charpos != 0);
3228 }
3229 eassert (IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
3230 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos);
3231 }
3232 }
3233
3234 if (CHARPOS (pos->string_pos) >= 0)
3235 {
3236 /* Recorded position is not in an overlay string, but in another
3237 string. This can only be a string from a `display' property.
3238 IT should already be filled with that string. */
3239 it->current.string_pos = pos->string_pos;
3240 eassert (STRINGP (it->string));
3241 if (it->bidi_p)
3242 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3243 FRAME_WINDOW_P (it->f), &it->bidi_it);
3244 }
3245
3246 /* Restore position in display vector translations, control
3247 character translations or ellipses. */
3248 if (pos->dpvec_index >= 0)
3249 {
3250 if (it->dpvec == NULL)
3251 get_next_display_element (it);
3252 eassert (it->dpvec && it->current.dpvec_index == 0);
3253 it->current.dpvec_index = pos->dpvec_index;
3254 }
3255
3256 CHECK_IT (it);
3257 return !overlay_strings_with_newlines;
3258 }
3259
3260
3261 /* Initialize IT for stepping through current_buffer in window W
3262 starting at ROW->start. */
3263
3264 static void
3265 init_to_row_start (struct it *it, struct window *w, struct glyph_row *row)
3266 {
3267 init_from_display_pos (it, w, &row->start);
3268 it->start = row->start;
3269 it->continuation_lines_width = row->continuation_lines_width;
3270 CHECK_IT (it);
3271 }
3272
3273
3274 /* Initialize IT for stepping through current_buffer in window W
3275 starting in the line following ROW, i.e. starting at ROW->end.
3276 Value is false if there are overlay strings with newlines at ROW's
3277 end position. */
3278
3279 static bool
3280 init_to_row_end (struct it *it, struct window *w, struct glyph_row *row)
3281 {
3282 bool success = false;
3283
3284 if (init_from_display_pos (it, w, &row->end))
3285 {
3286 if (row->continued_p)
3287 it->continuation_lines_width
3288 = row->continuation_lines_width + row->pixel_width;
3289 CHECK_IT (it);
3290 success = true;
3291 }
3292
3293 return success;
3294 }
3295
3296
3297
3298 \f
3299 /***********************************************************************
3300 Text properties
3301 ***********************************************************************/
3302
3303 /* Called when IT reaches IT->stop_charpos. Handle text property and
3304 overlay changes. Set IT->stop_charpos to the next position where
3305 to stop. */
3306
3307 static void
3308 handle_stop (struct it *it)
3309 {
3310 enum prop_handled handled;
3311 bool handle_overlay_change_p;
3312 struct props *p;
3313
3314 it->dpvec = NULL;
3315 it->current.dpvec_index = -1;
3316 handle_overlay_change_p = !it->ignore_overlay_strings_at_pos_p;
3317 it->ellipsis_p = false;
3318
3319 /* Use face of preceding text for ellipsis (if invisible) */
3320 if (it->selective_display_ellipsis_p)
3321 it->saved_face_id = it->face_id;
3322
3323 /* Here's the description of the semantics of, and the logic behind,
3324 the various HANDLED_* statuses:
3325
3326 HANDLED_NORMALLY means the handler did its job, and the loop
3327 should proceed to calling the next handler in order.
3328
3329 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3330 change in the properties and overlays at current position, so the
3331 loop should be restarted, to re-invoke the handlers that were
3332 already called. This happens when fontification-functions were
3333 called by handle_fontified_prop, and actually fontified
3334 something. Another case where HANDLED_RECOMPUTE_PROPS is
3335 returned is when we discover overlay strings that need to be
3336 displayed right away. The loop below will continue for as long
3337 as the status is HANDLED_RECOMPUTE_PROPS.
3338
3339 HANDLED_RETURN means return immediately to the caller, to
3340 continue iteration without calling any further handlers. This is
3341 used when we need to act on some property right away, for example
3342 when we need to display the ellipsis or a replacing display
3343 property, such as display string or image.
3344
3345 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3346 consumed, and the handler switched to the next overlay string.
3347 This signals the loop below to refrain from looking for more
3348 overlays before all the overlay strings of the current overlay
3349 are processed.
3350
3351 Some of the handlers called by the loop push the iterator state
3352 onto the stack (see 'push_it'), and arrange for the iteration to
3353 continue with another object, such as an image, a display string,
3354 or an overlay string. In most such cases, it->stop_charpos is
3355 set to the first character of the string, so that when the
3356 iteration resumes, this function will immediately be called
3357 again, to examine the properties at the beginning of the string.
3358
3359 When a display or overlay string is exhausted, the iterator state
3360 is popped (see 'pop_it'), and iteration continues with the
3361 previous object. Again, in many such cases this function is
3362 called again to find the next position where properties might
3363 change. */
3364
3365 do
3366 {
3367 handled = HANDLED_NORMALLY;
3368
3369 /* Call text property handlers. */
3370 for (p = it_props; p->handler; ++p)
3371 {
3372 handled = p->handler (it);
3373
3374 if (handled == HANDLED_RECOMPUTE_PROPS)
3375 break;
3376 else if (handled == HANDLED_RETURN)
3377 {
3378 /* We still want to show before and after strings from
3379 overlays even if the actual buffer text is replaced. */
3380 if (!handle_overlay_change_p
3381 || it->sp > 1
3382 /* Don't call get_overlay_strings_1 if we already
3383 have overlay strings loaded, because doing so
3384 will load them again and push the iterator state
3385 onto the stack one more time, which is not
3386 expected by the rest of the code that processes
3387 overlay strings. */
3388 || (it->current.overlay_string_index < 0
3389 && !get_overlay_strings_1 (it, 0, false)))
3390 {
3391 if (it->ellipsis_p)
3392 setup_for_ellipsis (it, 0);
3393 /* When handling a display spec, we might load an
3394 empty string. In that case, discard it here. We
3395 used to discard it in handle_single_display_spec,
3396 but that causes get_overlay_strings_1, above, to
3397 ignore overlay strings that we must check. */
3398 if (STRINGP (it->string) && !SCHARS (it->string))
3399 pop_it (it);
3400 return;
3401 }
3402 else if (STRINGP (it->string) && !SCHARS (it->string))
3403 pop_it (it);
3404 else
3405 {
3406 it->string_from_display_prop_p = false;
3407 it->from_disp_prop_p = false;
3408 handle_overlay_change_p = false;
3409 }
3410 handled = HANDLED_RECOMPUTE_PROPS;
3411 break;
3412 }
3413 else if (handled == HANDLED_OVERLAY_STRING_CONSUMED)
3414 handle_overlay_change_p = false;
3415 }
3416
3417 if (handled != HANDLED_RECOMPUTE_PROPS)
3418 {
3419 /* Don't check for overlay strings below when set to deliver
3420 characters from a display vector. */
3421 if (it->method == GET_FROM_DISPLAY_VECTOR)
3422 handle_overlay_change_p = false;
3423
3424 /* Handle overlay changes.
3425 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3426 if it finds overlays. */
3427 if (handle_overlay_change_p)
3428 handled = handle_overlay_change (it);
3429 }
3430
3431 if (it->ellipsis_p)
3432 {
3433 setup_for_ellipsis (it, 0);
3434 break;
3435 }
3436 }
3437 while (handled == HANDLED_RECOMPUTE_PROPS);
3438
3439 /* Determine where to stop next. */
3440 if (handled == HANDLED_NORMALLY)
3441 compute_stop_pos (it);
3442 }
3443
3444
3445 /* Compute IT->stop_charpos from text property and overlay change
3446 information for IT's current position. */
3447
3448 static void
3449 compute_stop_pos (struct it *it)
3450 {
3451 register INTERVAL iv, next_iv;
3452 Lisp_Object object, limit, position;
3453 ptrdiff_t charpos, bytepos;
3454
3455 if (STRINGP (it->string))
3456 {
3457 /* Strings are usually short, so don't limit the search for
3458 properties. */
3459 it->stop_charpos = it->end_charpos;
3460 object = it->string;
3461 limit = Qnil;
3462 charpos = IT_STRING_CHARPOS (*it);
3463 bytepos = IT_STRING_BYTEPOS (*it);
3464 }
3465 else
3466 {
3467 ptrdiff_t pos;
3468
3469 /* If end_charpos is out of range for some reason, such as a
3470 misbehaving display function, rationalize it (Bug#5984). */
3471 if (it->end_charpos > ZV)
3472 it->end_charpos = ZV;
3473 it->stop_charpos = it->end_charpos;
3474
3475 /* If next overlay change is in front of the current stop pos
3476 (which is IT->end_charpos), stop there. Note: value of
3477 next_overlay_change is point-max if no overlay change
3478 follows. */
3479 charpos = IT_CHARPOS (*it);
3480 bytepos = IT_BYTEPOS (*it);
3481 pos = next_overlay_change (charpos);
3482 if (pos < it->stop_charpos)
3483 it->stop_charpos = pos;
3484
3485 /* Set up variables for computing the stop position from text
3486 property changes. */
3487 XSETBUFFER (object, current_buffer);
3488 limit = make_number (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT);
3489 }
3490
3491 /* Get the interval containing IT's position. Value is a null
3492 interval if there isn't such an interval. */
3493 position = make_number (charpos);
3494 iv = validate_interval_range (object, &position, &position, false);
3495 if (iv)
3496 {
3497 Lisp_Object values_here[LAST_PROP_IDX];
3498 struct props *p;
3499
3500 /* Get properties here. */
3501 for (p = it_props; p->handler; ++p)
3502 values_here[p->idx] = textget (iv->plist,
3503 builtin_lisp_symbol (p->name));
3504
3505 /* Look for an interval following iv that has different
3506 properties. */
3507 for (next_iv = next_interval (iv);
3508 (next_iv
3509 && (NILP (limit)
3510 || XFASTINT (limit) > next_iv->position));
3511 next_iv = next_interval (next_iv))
3512 {
3513 for (p = it_props; p->handler; ++p)
3514 {
3515 Lisp_Object new_value = textget (next_iv->plist,
3516 builtin_lisp_symbol (p->name));
3517 if (!EQ (values_here[p->idx], new_value))
3518 break;
3519 }
3520
3521 if (p->handler)
3522 break;
3523 }
3524
3525 if (next_iv)
3526 {
3527 if (INTEGERP (limit)
3528 && next_iv->position >= XFASTINT (limit))
3529 /* No text property change up to limit. */
3530 it->stop_charpos = min (XFASTINT (limit), it->stop_charpos);
3531 else
3532 /* Text properties change in next_iv. */
3533 it->stop_charpos = min (it->stop_charpos, next_iv->position);
3534 }
3535 }
3536
3537 if (it->cmp_it.id < 0)
3538 {
3539 ptrdiff_t stoppos = it->end_charpos;
3540
3541 if (it->bidi_p && it->bidi_it.scan_dir < 0)
3542 stoppos = -1;
3543 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos,
3544 stoppos, it->string);
3545 }
3546
3547 eassert (STRINGP (it->string)
3548 || (it->stop_charpos >= BEGV
3549 && it->stop_charpos >= IT_CHARPOS (*it)));
3550 }
3551
3552
3553 /* Return the position of the next overlay change after POS in
3554 current_buffer. Value is point-max if no overlay change
3555 follows. This is like `next-overlay-change' but doesn't use
3556 xmalloc. */
3557
3558 static ptrdiff_t
3559 next_overlay_change (ptrdiff_t pos)
3560 {
3561 ptrdiff_t i, noverlays;
3562 ptrdiff_t endpos;
3563 Lisp_Object *overlays;
3564 USE_SAFE_ALLOCA;
3565
3566 /* Get all overlays at the given position. */
3567 GET_OVERLAYS_AT (pos, overlays, noverlays, &endpos, true);
3568
3569 /* If any of these overlays ends before endpos,
3570 use its ending point instead. */
3571 for (i = 0; i < noverlays; ++i)
3572 {
3573 Lisp_Object oend;
3574 ptrdiff_t oendpos;
3575
3576 oend = OVERLAY_END (overlays[i]);
3577 oendpos = OVERLAY_POSITION (oend);
3578 endpos = min (endpos, oendpos);
3579 }
3580
3581 SAFE_FREE ();
3582 return endpos;
3583 }
3584
3585 /* How many characters forward to search for a display property or
3586 display string. Searching too far forward makes the bidi display
3587 sluggish, especially in small windows. */
3588 #define MAX_DISP_SCAN 250
3589
3590 /* Return the character position of a display string at or after
3591 position specified by POSITION. If no display string exists at or
3592 after POSITION, return ZV. A display string is either an overlay
3593 with `display' property whose value is a string, or a `display'
3594 text property whose value is a string. STRING is data about the
3595 string to iterate; if STRING->lstring is nil, we are iterating a
3596 buffer. FRAME_WINDOW_P is true when we are displaying a window
3597 on a GUI frame. DISP_PROP is set to zero if we searched
3598 MAX_DISP_SCAN characters forward without finding any display
3599 strings, non-zero otherwise. It is set to 2 if the display string
3600 uses any kind of `(space ...)' spec that will produce a stretch of
3601 white space in the text area. */
3602 ptrdiff_t
3603 compute_display_string_pos (struct text_pos *position,
3604 struct bidi_string_data *string,
3605 struct window *w,
3606 bool frame_window_p, int *disp_prop)
3607 {
3608 /* OBJECT = nil means current buffer. */
3609 Lisp_Object object, object1;
3610 Lisp_Object pos, spec, limpos;
3611 bool string_p = string && (STRINGP (string->lstring) || string->s);
3612 ptrdiff_t eob = string_p ? string->schars : ZV;
3613 ptrdiff_t begb = string_p ? 0 : BEGV;
3614 ptrdiff_t bufpos, charpos = CHARPOS (*position);
3615 ptrdiff_t lim =
3616 (charpos < eob - MAX_DISP_SCAN) ? charpos + MAX_DISP_SCAN : eob;
3617 struct text_pos tpos;
3618 int rv = 0;
3619
3620 if (string && STRINGP (string->lstring))
3621 object1 = object = string->lstring;
3622 else if (w && !string_p)
3623 {
3624 XSETWINDOW (object, w);
3625 object1 = Qnil;
3626 }
3627 else
3628 object1 = object = Qnil;
3629
3630 *disp_prop = 1;
3631
3632 if (charpos >= eob
3633 /* We don't support display properties whose values are strings
3634 that have display string properties. */
3635 || string->from_disp_str
3636 /* C strings cannot have display properties. */
3637 || (string->s && !STRINGP (object)))
3638 {
3639 *disp_prop = 0;
3640 return eob;
3641 }
3642
3643 /* If the character at CHARPOS is where the display string begins,
3644 return CHARPOS. */
3645 pos = make_number (charpos);
3646 if (STRINGP (object))
3647 bufpos = string->bufpos;
3648 else
3649 bufpos = charpos;
3650 tpos = *position;
3651 if (!NILP (spec = Fget_char_property (pos, Qdisplay, object))
3652 && (charpos <= begb
3653 || !EQ (Fget_char_property (make_number (charpos - 1), Qdisplay,
3654 object),
3655 spec))
3656 && (rv = handle_display_spec (NULL, spec, object, Qnil, &tpos, bufpos,
3657 frame_window_p)))
3658 {
3659 if (rv == 2)
3660 *disp_prop = 2;
3661 return charpos;
3662 }
3663
3664 /* Look forward for the first character with a `display' property
3665 that will replace the underlying text when displayed. */
3666 limpos = make_number (lim);
3667 do {
3668 pos = Fnext_single_char_property_change (pos, Qdisplay, object1, limpos);
3669 CHARPOS (tpos) = XFASTINT (pos);
3670 if (CHARPOS (tpos) >= lim)
3671 {
3672 *disp_prop = 0;
3673 break;
3674 }
3675 if (STRINGP (object))
3676 BYTEPOS (tpos) = string_char_to_byte (object, CHARPOS (tpos));
3677 else
3678 BYTEPOS (tpos) = CHAR_TO_BYTE (CHARPOS (tpos));
3679 spec = Fget_char_property (pos, Qdisplay, object);
3680 if (!STRINGP (object))
3681 bufpos = CHARPOS (tpos);
3682 } while (NILP (spec)
3683 || !(rv = handle_display_spec (NULL, spec, object, Qnil, &tpos,
3684 bufpos, frame_window_p)));
3685 if (rv == 2)
3686 *disp_prop = 2;
3687
3688 return CHARPOS (tpos);
3689 }
3690
3691 /* Return the character position of the end of the display string that
3692 started at CHARPOS. If there's no display string at CHARPOS,
3693 return -1. A display string is either an overlay with `display'
3694 property whose value is a string or a `display' text property whose
3695 value is a string. */
3696 ptrdiff_t
3697 compute_display_string_end (ptrdiff_t charpos, struct bidi_string_data *string)
3698 {
3699 /* OBJECT = nil means current buffer. */
3700 Lisp_Object object =
3701 (string && STRINGP (string->lstring)) ? string->lstring : Qnil;
3702 Lisp_Object pos = make_number (charpos);
3703 ptrdiff_t eob =
3704 (STRINGP (object) || (string && string->s)) ? string->schars : ZV;
3705
3706 if (charpos >= eob || (string->s && !STRINGP (object)))
3707 return eob;
3708
3709 /* It could happen that the display property or overlay was removed
3710 since we found it in compute_display_string_pos above. One way
3711 this can happen is if JIT font-lock was called (through
3712 handle_fontified_prop), and jit-lock-functions remove text
3713 properties or overlays from the portion of buffer that includes
3714 CHARPOS. Muse mode is known to do that, for example. In this
3715 case, we return -1 to the caller, to signal that no display
3716 string is actually present at CHARPOS. See bidi_fetch_char for
3717 how this is handled.
3718
3719 An alternative would be to never look for display properties past
3720 it->stop_charpos. But neither compute_display_string_pos nor
3721 bidi_fetch_char that calls it know or care where the next
3722 stop_charpos is. */
3723 if (NILP (Fget_char_property (pos, Qdisplay, object)))
3724 return -1;
3725
3726 /* Look forward for the first character where the `display' property
3727 changes. */
3728 pos = Fnext_single_char_property_change (pos, Qdisplay, object, Qnil);
3729
3730 return XFASTINT (pos);
3731 }
3732
3733
3734 \f
3735 /***********************************************************************
3736 Fontification
3737 ***********************************************************************/
3738
3739 /* Handle changes in the `fontified' property of the current buffer by
3740 calling hook functions from Qfontification_functions to fontify
3741 regions of text. */
3742
3743 static enum prop_handled
3744 handle_fontified_prop (struct it *it)
3745 {
3746 Lisp_Object prop, pos;
3747 enum prop_handled handled = HANDLED_NORMALLY;
3748
3749 if (!NILP (Vmemory_full))
3750 return handled;
3751
3752 /* Get the value of the `fontified' property at IT's current buffer
3753 position. (The `fontified' property doesn't have a special
3754 meaning in strings.) If the value is nil, call functions from
3755 Qfontification_functions. */
3756 if (!STRINGP (it->string)
3757 && it->s == NULL
3758 && !NILP (Vfontification_functions)
3759 && !NILP (Vrun_hooks)
3760 && (pos = make_number (IT_CHARPOS (*it)),
3761 prop = Fget_char_property (pos, Qfontified, Qnil),
3762 /* Ignore the special cased nil value always present at EOB since
3763 no amount of fontifying will be able to change it. */
3764 NILP (prop) && IT_CHARPOS (*it) < Z))
3765 {
3766 ptrdiff_t count = SPECPDL_INDEX ();
3767 Lisp_Object val;
3768 struct buffer *obuf = current_buffer;
3769 ptrdiff_t begv = BEGV, zv = ZV;
3770 bool old_clip_changed = current_buffer->clip_changed;
3771
3772 val = Vfontification_functions;
3773 specbind (Qfontification_functions, Qnil);
3774
3775 eassert (it->end_charpos == ZV);
3776
3777 if (!CONSP (val) || EQ (XCAR (val), Qlambda))
3778 safe_call1 (val, pos);
3779 else
3780 {
3781 Lisp_Object fns, fn;
3782
3783 fns = Qnil;
3784
3785 for (; CONSP (val); val = XCDR (val))
3786 {
3787 fn = XCAR (val);
3788
3789 if (EQ (fn, Qt))
3790 {
3791 /* A value of t indicates this hook has a local
3792 binding; it means to run the global binding too.
3793 In a global value, t should not occur. If it
3794 does, we must ignore it to avoid an endless
3795 loop. */
3796 for (fns = Fdefault_value (Qfontification_functions);
3797 CONSP (fns);
3798 fns = XCDR (fns))
3799 {
3800 fn = XCAR (fns);
3801 if (!EQ (fn, Qt))
3802 safe_call1 (fn, pos);
3803 }
3804 }
3805 else
3806 safe_call1 (fn, pos);
3807 }
3808 }
3809
3810 unbind_to (count, Qnil);
3811
3812 /* Fontification functions routinely call `save-restriction'.
3813 Normally, this tags clip_changed, which can confuse redisplay
3814 (see discussion in Bug#6671). Since we don't perform any
3815 special handling of fontification changes in the case where
3816 `save-restriction' isn't called, there's no point doing so in
3817 this case either. So, if the buffer's restrictions are
3818 actually left unchanged, reset clip_changed. */
3819 if (obuf == current_buffer)
3820 {
3821 if (begv == BEGV && zv == ZV)
3822 current_buffer->clip_changed = old_clip_changed;
3823 }
3824 /* There isn't much we can reasonably do to protect against
3825 misbehaving fontification, but here's a fig leaf. */
3826 else if (BUFFER_LIVE_P (obuf))
3827 set_buffer_internal_1 (obuf);
3828
3829 /* The fontification code may have added/removed text.
3830 It could do even a lot worse, but let's at least protect against
3831 the most obvious case where only the text past `pos' gets changed',
3832 as is/was done in grep.el where some escapes sequences are turned
3833 into face properties (bug#7876). */
3834 it->end_charpos = ZV;
3835
3836 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3837 something. This avoids an endless loop if they failed to
3838 fontify the text for which reason ever. */
3839 if (!NILP (Fget_char_property (pos, Qfontified, Qnil)))
3840 handled = HANDLED_RECOMPUTE_PROPS;
3841 }
3842
3843 return handled;
3844 }
3845
3846
3847 \f
3848 /***********************************************************************
3849 Faces
3850 ***********************************************************************/
3851
3852 /* Set up iterator IT from face properties at its current position.
3853 Called from handle_stop. */
3854
3855 static enum prop_handled
3856 handle_face_prop (struct it *it)
3857 {
3858 int new_face_id;
3859 ptrdiff_t next_stop;
3860
3861 if (!STRINGP (it->string))
3862 {
3863 new_face_id
3864 = face_at_buffer_position (it->w,
3865 IT_CHARPOS (*it),
3866 &next_stop,
3867 (IT_CHARPOS (*it)
3868 + TEXT_PROP_DISTANCE_LIMIT),
3869 false, it->base_face_id);
3870
3871 /* Is this a start of a run of characters with box face?
3872 Caveat: this can be called for a freshly initialized
3873 iterator; face_id is -1 in this case. We know that the new
3874 face will not change until limit, i.e. if the new face has a
3875 box, all characters up to limit will have one. But, as
3876 usual, we don't know whether limit is really the end. */
3877 if (new_face_id != it->face_id)
3878 {
3879 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3880 /* If it->face_id is -1, old_face below will be NULL, see
3881 the definition of FACE_FROM_ID_OR_NULL. This will happen
3882 if this is the initial call that gets the face. */
3883 struct face *old_face = FACE_FROM_ID_OR_NULL (it->f, it->face_id);
3884
3885 /* If the value of face_id of the iterator is -1, we have to
3886 look in front of IT's position and see whether there is a
3887 face there that's different from new_face_id. */
3888 if (!old_face && IT_CHARPOS (*it) > BEG)
3889 {
3890 int prev_face_id = face_before_it_pos (it);
3891
3892 old_face = FACE_FROM_ID_OR_NULL (it->f, prev_face_id);
3893 }
3894
3895 /* If the new face has a box, but the old face does not,
3896 this is the start of a run of characters with box face,
3897 i.e. this character has a shadow on the left side. */
3898 it->start_of_box_run_p = (new_face->box != FACE_NO_BOX
3899 && (old_face == NULL || !old_face->box));
3900 it->face_box_p = new_face->box != FACE_NO_BOX;
3901 }
3902 }
3903 else
3904 {
3905 int base_face_id;
3906 ptrdiff_t bufpos;
3907 int i;
3908 Lisp_Object from_overlay
3909 = (it->current.overlay_string_index >= 0
3910 ? it->string_overlays[it->current.overlay_string_index
3911 % OVERLAY_STRING_CHUNK_SIZE]
3912 : Qnil);
3913
3914 /* See if we got to this string directly or indirectly from
3915 an overlay property. That includes the before-string or
3916 after-string of an overlay, strings in display properties
3917 provided by an overlay, their text properties, etc.
3918
3919 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3920 if (! NILP (from_overlay))
3921 for (i = it->sp - 1; i >= 0; i--)
3922 {
3923 if (it->stack[i].current.overlay_string_index >= 0)
3924 from_overlay
3925 = it->string_overlays[it->stack[i].current.overlay_string_index
3926 % OVERLAY_STRING_CHUNK_SIZE];
3927 else if (! NILP (it->stack[i].from_overlay))
3928 from_overlay = it->stack[i].from_overlay;
3929
3930 if (!NILP (from_overlay))
3931 break;
3932 }
3933
3934 if (! NILP (from_overlay))
3935 {
3936 bufpos = IT_CHARPOS (*it);
3937 /* For a string from an overlay, the base face depends
3938 only on text properties and ignores overlays. */
3939 base_face_id
3940 = face_for_overlay_string (it->w,
3941 IT_CHARPOS (*it),
3942 &next_stop,
3943 (IT_CHARPOS (*it)
3944 + TEXT_PROP_DISTANCE_LIMIT),
3945 false,
3946 from_overlay);
3947 }
3948 else
3949 {
3950 bufpos = 0;
3951
3952 /* For strings from a `display' property, use the face at
3953 IT's current buffer position as the base face to merge
3954 with, so that overlay strings appear in the same face as
3955 surrounding text, unless they specify their own faces.
3956 For strings from wrap-prefix and line-prefix properties,
3957 use the default face, possibly remapped via
3958 Vface_remapping_alist. */
3959 /* Note that the fact that we use the face at _buffer_
3960 position means that a 'display' property on an overlay
3961 string will not inherit the face of that overlay string,
3962 but will instead revert to the face of buffer text
3963 covered by the overlay. This is visible, e.g., when the
3964 overlay specifies a box face, but neither the buffer nor
3965 the display string do. This sounds like a design bug,
3966 but Emacs always did that since v21.1, so changing that
3967 might be a big deal. */
3968 base_face_id = it->string_from_prefix_prop_p
3969 ? (!NILP (Vface_remapping_alist)
3970 ? lookup_basic_face (it->f, DEFAULT_FACE_ID)
3971 : DEFAULT_FACE_ID)
3972 : underlying_face_id (it);
3973 }
3974
3975 new_face_id = face_at_string_position (it->w,
3976 it->string,
3977 IT_STRING_CHARPOS (*it),
3978 bufpos,
3979 &next_stop,
3980 base_face_id, false);
3981
3982 /* Is this a start of a run of characters with box? Caveat:
3983 this can be called for a freshly allocated iterator; face_id
3984 is -1 is this case. We know that the new face will not
3985 change until the next check pos, i.e. if the new face has a
3986 box, all characters up to that position will have a
3987 box. But, as usual, we don't know whether that position
3988 is really the end. */
3989 if (new_face_id != it->face_id)
3990 {
3991 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3992 struct face *old_face = FACE_FROM_ID_OR_NULL (it->f, it->face_id);
3993
3994 /* If new face has a box but old face hasn't, this is the
3995 start of a run of characters with box, i.e. it has a
3996 shadow on the left side. */
3997 it->start_of_box_run_p
3998 = new_face->box && (old_face == NULL || !old_face->box);
3999 it->face_box_p = new_face->box != FACE_NO_BOX;
4000 }
4001 }
4002
4003 it->face_id = new_face_id;
4004 return HANDLED_NORMALLY;
4005 }
4006
4007
4008 /* Return the ID of the face ``underlying'' IT's current position,
4009 which is in a string. If the iterator is associated with a
4010 buffer, return the face at IT's current buffer position.
4011 Otherwise, use the iterator's base_face_id. */
4012
4013 static int
4014 underlying_face_id (struct it *it)
4015 {
4016 int face_id = it->base_face_id, i;
4017
4018 eassert (STRINGP (it->string));
4019
4020 for (i = it->sp - 1; i >= 0; --i)
4021 if (NILP (it->stack[i].string))
4022 face_id = it->stack[i].face_id;
4023
4024 return face_id;
4025 }
4026
4027
4028 /* Compute the face one character before or after the current position
4029 of IT, in the visual order. BEFORE_P means get the face
4030 in front (to the left in L2R paragraphs, to the right in R2L
4031 paragraphs) of IT's screen position. Value is the ID of the face. */
4032
4033 static int
4034 face_before_or_after_it_pos (struct it *it, bool before_p)
4035 {
4036 int face_id, limit;
4037 ptrdiff_t next_check_charpos;
4038 struct it it_copy;
4039 void *it_copy_data = NULL;
4040
4041 eassert (it->s == NULL);
4042
4043 if (STRINGP (it->string))
4044 {
4045 ptrdiff_t bufpos, charpos;
4046 int base_face_id;
4047
4048 /* No face change past the end of the string (for the case
4049 we are padding with spaces). No face change before the
4050 string start. */
4051 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string)
4052 || (IT_STRING_CHARPOS (*it) == 0 && before_p))
4053 return it->face_id;
4054
4055 if (!it->bidi_p)
4056 {
4057 /* Set charpos to the position before or after IT's current
4058 position, in the logical order, which in the non-bidi
4059 case is the same as the visual order. */
4060 if (before_p)
4061 charpos = IT_STRING_CHARPOS (*it) - 1;
4062 else if (it->what == IT_COMPOSITION)
4063 /* For composition, we must check the character after the
4064 composition. */
4065 charpos = IT_STRING_CHARPOS (*it) + it->cmp_it.nchars;
4066 else
4067 charpos = IT_STRING_CHARPOS (*it) + 1;
4068 }
4069 else
4070 {
4071 if (before_p)
4072 {
4073 /* With bidi iteration, the character before the current
4074 in the visual order cannot be found by simple
4075 iteration, because "reverse" reordering is not
4076 supported. Instead, we need to start from the string
4077 beginning and go all the way to the current string
4078 position, remembering the previous position. */
4079 /* Ignore face changes before the first visible
4080 character on this display line. */
4081 if (it->current_x <= it->first_visible_x)
4082 return it->face_id;
4083 SAVE_IT (it_copy, *it, it_copy_data);
4084 IT_STRING_CHARPOS (it_copy) = 0;
4085 bidi_init_it (0, 0, FRAME_WINDOW_P (it_copy.f), &it_copy.bidi_it);
4086
4087 do
4088 {
4089 charpos = IT_STRING_CHARPOS (it_copy);
4090 if (charpos >= SCHARS (it->string))
4091 break;
4092 bidi_move_to_visually_next (&it_copy.bidi_it);
4093 }
4094 while (IT_STRING_CHARPOS (it_copy) != IT_STRING_CHARPOS (*it));
4095
4096 RESTORE_IT (it, it, it_copy_data);
4097 }
4098 else
4099 {
4100 /* Set charpos to the string position of the character
4101 that comes after IT's current position in the visual
4102 order. */
4103 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4104
4105 it_copy = *it;
4106 while (n--)
4107 bidi_move_to_visually_next (&it_copy.bidi_it);
4108
4109 charpos = it_copy.bidi_it.charpos;
4110 }
4111 }
4112 eassert (0 <= charpos && charpos <= SCHARS (it->string));
4113
4114 if (it->current.overlay_string_index >= 0)
4115 bufpos = IT_CHARPOS (*it);
4116 else
4117 bufpos = 0;
4118
4119 base_face_id = underlying_face_id (it);
4120
4121 /* Get the face for ASCII, or unibyte. */
4122 face_id = face_at_string_position (it->w,
4123 it->string,
4124 charpos,
4125 bufpos,
4126 &next_check_charpos,
4127 base_face_id, false);
4128
4129 /* Correct the face for charsets different from ASCII. Do it
4130 for the multibyte case only. The face returned above is
4131 suitable for unibyte text if IT->string is unibyte. */
4132 if (STRING_MULTIBYTE (it->string))
4133 {
4134 struct text_pos pos1 = string_pos (charpos, it->string);
4135 const unsigned char *p = SDATA (it->string) + BYTEPOS (pos1);
4136 int c, len;
4137 struct face *face = FACE_FROM_ID (it->f, face_id);
4138
4139 c = string_char_and_length (p, &len);
4140 face_id = FACE_FOR_CHAR (it->f, face, c, charpos, it->string);
4141 }
4142 }
4143 else
4144 {
4145 struct text_pos pos;
4146
4147 if ((IT_CHARPOS (*it) >= ZV && !before_p)
4148 || (IT_CHARPOS (*it) <= BEGV && before_p))
4149 return it->face_id;
4150
4151 limit = IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT;
4152 pos = it->current.pos;
4153
4154 if (!it->bidi_p)
4155 {
4156 if (before_p)
4157 DEC_TEXT_POS (pos, it->multibyte_p);
4158 else
4159 {
4160 if (it->what == IT_COMPOSITION)
4161 {
4162 /* For composition, we must check the position after
4163 the composition. */
4164 pos.charpos += it->cmp_it.nchars;
4165 pos.bytepos += it->len;
4166 }
4167 else
4168 INC_TEXT_POS (pos, it->multibyte_p);
4169 }
4170 }
4171 else
4172 {
4173 if (before_p)
4174 {
4175 int current_x;
4176
4177 /* With bidi iteration, the character before the current
4178 in the visual order cannot be found by simple
4179 iteration, because "reverse" reordering is not
4180 supported. Instead, we need to use the move_it_*
4181 family of functions, and move to the previous
4182 character starting from the beginning of the visual
4183 line. */
4184 /* Ignore face changes before the first visible
4185 character on this display line. */
4186 if (it->current_x <= it->first_visible_x)
4187 return it->face_id;
4188 SAVE_IT (it_copy, *it, it_copy_data);
4189 /* Implementation note: Since move_it_in_display_line
4190 works in the iterator geometry, and thinks the first
4191 character is always the leftmost, even in R2L lines,
4192 we don't need to distinguish between the R2L and L2R
4193 cases here. */
4194 current_x = it_copy.current_x;
4195 move_it_vertically_backward (&it_copy, 0);
4196 move_it_in_display_line (&it_copy, ZV, current_x - 1, MOVE_TO_X);
4197 pos = it_copy.current.pos;
4198 RESTORE_IT (it, it, it_copy_data);
4199 }
4200 else
4201 {
4202 /* Set charpos to the buffer position of the character
4203 that comes after IT's current position in the visual
4204 order. */
4205 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4206
4207 it_copy = *it;
4208 while (n--)
4209 bidi_move_to_visually_next (&it_copy.bidi_it);
4210
4211 SET_TEXT_POS (pos,
4212 it_copy.bidi_it.charpos, it_copy.bidi_it.bytepos);
4213 }
4214 }
4215 eassert (BEGV <= CHARPOS (pos) && CHARPOS (pos) <= ZV);
4216
4217 /* Determine face for CHARSET_ASCII, or unibyte. */
4218 face_id = face_at_buffer_position (it->w,
4219 CHARPOS (pos),
4220 &next_check_charpos,
4221 limit, false, -1);
4222
4223 /* Correct the face for charsets different from ASCII. Do it
4224 for the multibyte case only. The face returned above is
4225 suitable for unibyte text if current_buffer is unibyte. */
4226 if (it->multibyte_p)
4227 {
4228 int c = FETCH_MULTIBYTE_CHAR (BYTEPOS (pos));
4229 struct face *face = FACE_FROM_ID (it->f, face_id);
4230 face_id = FACE_FOR_CHAR (it->f, face, c, CHARPOS (pos), Qnil);
4231 }
4232 }
4233
4234 return face_id;
4235 }
4236
4237
4238 \f
4239 /***********************************************************************
4240 Invisible text
4241 ***********************************************************************/
4242
4243 /* Set up iterator IT from invisible properties at its current
4244 position. Called from handle_stop. */
4245
4246 static enum prop_handled
4247 handle_invisible_prop (struct it *it)
4248 {
4249 enum prop_handled handled = HANDLED_NORMALLY;
4250 int invis;
4251 Lisp_Object prop;
4252
4253 if (STRINGP (it->string))
4254 {
4255 Lisp_Object end_charpos, limit;
4256
4257 /* Get the value of the invisible text property at the
4258 current position. Value will be nil if there is no such
4259 property. */
4260 end_charpos = make_number (IT_STRING_CHARPOS (*it));
4261 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4262 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4263
4264 if (invis != 0 && IT_STRING_CHARPOS (*it) < it->end_charpos)
4265 {
4266 /* Record whether we have to display an ellipsis for the
4267 invisible text. */
4268 bool display_ellipsis_p = (invis == 2);
4269 ptrdiff_t len, endpos;
4270
4271 handled = HANDLED_RECOMPUTE_PROPS;
4272
4273 /* Get the position at which the next visible text can be
4274 found in IT->string, if any. */
4275 endpos = len = SCHARS (it->string);
4276 XSETINT (limit, len);
4277 do
4278 {
4279 end_charpos
4280 = Fnext_single_property_change (end_charpos, Qinvisible,
4281 it->string, limit);
4282 /* Since LIMIT is always an integer, so should be the
4283 value returned by Fnext_single_property_change. */
4284 eassert (INTEGERP (end_charpos));
4285 if (INTEGERP (end_charpos))
4286 {
4287 endpos = XFASTINT (end_charpos);
4288 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4289 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4290 if (invis == 2)
4291 display_ellipsis_p = true;
4292 }
4293 else /* Should never happen; but if it does, exit the loop. */
4294 endpos = len;
4295 }
4296 while (invis != 0 && endpos < len);
4297
4298 if (display_ellipsis_p)
4299 it->ellipsis_p = true;
4300
4301 if (endpos < len)
4302 {
4303 /* Text at END_CHARPOS is visible. Move IT there. */
4304 struct text_pos old;
4305 ptrdiff_t oldpos;
4306
4307 old = it->current.string_pos;
4308 oldpos = CHARPOS (old);
4309 if (it->bidi_p)
4310 {
4311 if (it->bidi_it.first_elt
4312 && it->bidi_it.charpos < SCHARS (it->string))
4313 bidi_paragraph_init (it->paragraph_embedding,
4314 &it->bidi_it, true);
4315 /* Bidi-iterate out of the invisible text. */
4316 do
4317 {
4318 bidi_move_to_visually_next (&it->bidi_it);
4319 }
4320 while (oldpos <= it->bidi_it.charpos
4321 && it->bidi_it.charpos < endpos);
4322
4323 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
4324 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
4325 if (IT_CHARPOS (*it) >= endpos)
4326 it->prev_stop = endpos;
4327 }
4328 else
4329 {
4330 IT_STRING_CHARPOS (*it) = endpos;
4331 compute_string_pos (&it->current.string_pos, old, it->string);
4332 }
4333 }
4334 else
4335 {
4336 /* The rest of the string is invisible. If this is an
4337 overlay string, proceed with the next overlay string
4338 or whatever comes and return a character from there. */
4339 if (it->current.overlay_string_index >= 0
4340 && !display_ellipsis_p)
4341 {
4342 next_overlay_string (it);
4343 /* Don't check for overlay strings when we just
4344 finished processing them. */
4345 handled = HANDLED_OVERLAY_STRING_CONSUMED;
4346 }
4347 else
4348 {
4349 IT_STRING_CHARPOS (*it) = SCHARS (it->string);
4350 IT_STRING_BYTEPOS (*it) = SBYTES (it->string);
4351 }
4352 }
4353 }
4354 }
4355 else
4356 {
4357 ptrdiff_t newpos, next_stop, start_charpos, tem;
4358 Lisp_Object pos, overlay;
4359
4360 /* First of all, is there invisible text at this position? */
4361 tem = start_charpos = IT_CHARPOS (*it);
4362 pos = make_number (tem);
4363 prop = get_char_property_and_overlay (pos, Qinvisible, it->window,
4364 &overlay);
4365 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4366
4367 /* If we are on invisible text, skip over it. */
4368 if (invis != 0 && start_charpos < it->end_charpos)
4369 {
4370 /* Record whether we have to display an ellipsis for the
4371 invisible text. */
4372 bool display_ellipsis_p = invis == 2;
4373
4374 handled = HANDLED_RECOMPUTE_PROPS;
4375
4376 /* Loop skipping over invisible text. The loop is left at
4377 ZV or with IT on the first char being visible again. */
4378 do
4379 {
4380 /* Try to skip some invisible text. Return value is the
4381 position reached which can be equal to where we start
4382 if there is nothing invisible there. This skips both
4383 over invisible text properties and overlays with
4384 invisible property. */
4385 newpos = skip_invisible (tem, &next_stop, ZV, it->window);
4386
4387 /* If we skipped nothing at all we weren't at invisible
4388 text in the first place. If everything to the end of
4389 the buffer was skipped, end the loop. */
4390 if (newpos == tem || newpos >= ZV)
4391 invis = 0;
4392 else
4393 {
4394 /* We skipped some characters but not necessarily
4395 all there are. Check if we ended up on visible
4396 text. Fget_char_property returns the property of
4397 the char before the given position, i.e. if we
4398 get invis = 0, this means that the char at
4399 newpos is visible. */
4400 pos = make_number (newpos);
4401 prop = Fget_char_property (pos, Qinvisible, it->window);
4402 invis = TEXT_PROP_MEANS_INVISIBLE (prop);
4403 }
4404
4405 /* If we ended up on invisible text, proceed to
4406 skip starting with next_stop. */
4407 if (invis != 0)
4408 tem = next_stop;
4409
4410 /* If there are adjacent invisible texts, don't lose the
4411 second one's ellipsis. */
4412 if (invis == 2)
4413 display_ellipsis_p = true;
4414 }
4415 while (invis != 0);
4416
4417 /* The position newpos is now either ZV or on visible text. */
4418 if (it->bidi_p)
4419 {
4420 ptrdiff_t bpos = CHAR_TO_BYTE (newpos);
4421 bool on_newline
4422 = bpos == ZV_BYTE || FETCH_BYTE (bpos) == '\n';
4423 bool after_newline
4424 = newpos <= BEGV || FETCH_BYTE (bpos - 1) == '\n';
4425
4426 /* If the invisible text ends on a newline or on a
4427 character after a newline, we can avoid the costly,
4428 character by character, bidi iteration to NEWPOS, and
4429 instead simply reseat the iterator there. That's
4430 because all bidi reordering information is tossed at
4431 the newline. This is a big win for modes that hide
4432 complete lines, like Outline, Org, etc. */
4433 if (on_newline || after_newline)
4434 {
4435 struct text_pos tpos;
4436 bidi_dir_t pdir = it->bidi_it.paragraph_dir;
4437
4438 SET_TEXT_POS (tpos, newpos, bpos);
4439 reseat_1 (it, tpos, false);
4440 /* If we reseat on a newline/ZV, we need to prep the
4441 bidi iterator for advancing to the next character
4442 after the newline/EOB, keeping the current paragraph
4443 direction (so that PRODUCE_GLYPHS does TRT wrt
4444 prepending/appending glyphs to a glyph row). */
4445 if (on_newline)
4446 {
4447 it->bidi_it.first_elt = false;
4448 it->bidi_it.paragraph_dir = pdir;
4449 it->bidi_it.ch = (bpos == ZV_BYTE) ? -1 : '\n';
4450 it->bidi_it.nchars = 1;
4451 it->bidi_it.ch_len = 1;
4452 }
4453 }
4454 else /* Must use the slow method. */
4455 {
4456 /* With bidi iteration, the region of invisible text
4457 could start and/or end in the middle of a
4458 non-base embedding level. Therefore, we need to
4459 skip invisible text using the bidi iterator,
4460 starting at IT's current position, until we find
4461 ourselves outside of the invisible text.
4462 Skipping invisible text _after_ bidi iteration
4463 avoids affecting the visual order of the
4464 displayed text when invisible properties are
4465 added or removed. */
4466 if (it->bidi_it.first_elt && it->bidi_it.charpos < ZV)
4467 {
4468 /* If we were `reseat'ed to a new paragraph,
4469 determine the paragraph base direction. We
4470 need to do it now because
4471 next_element_from_buffer may not have a
4472 chance to do it, if we are going to skip any
4473 text at the beginning, which resets the
4474 FIRST_ELT flag. */
4475 bidi_paragraph_init (it->paragraph_embedding,
4476 &it->bidi_it, true);
4477 }
4478 do
4479 {
4480 bidi_move_to_visually_next (&it->bidi_it);
4481 }
4482 while (it->stop_charpos <= it->bidi_it.charpos
4483 && it->bidi_it.charpos < newpos);
4484 IT_CHARPOS (*it) = it->bidi_it.charpos;
4485 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
4486 /* If we overstepped NEWPOS, record its position in
4487 the iterator, so that we skip invisible text if
4488 later the bidi iteration lands us in the
4489 invisible region again. */
4490 if (IT_CHARPOS (*it) >= newpos)
4491 it->prev_stop = newpos;
4492 }
4493 }
4494 else
4495 {
4496 IT_CHARPOS (*it) = newpos;
4497 IT_BYTEPOS (*it) = CHAR_TO_BYTE (newpos);
4498 }
4499
4500 if (display_ellipsis_p)
4501 {
4502 /* Make sure that the glyphs of the ellipsis will get
4503 correct `charpos' values. If we would not update
4504 it->position here, the glyphs would belong to the
4505 last visible character _before_ the invisible
4506 text, which confuses `set_cursor_from_row'.
4507
4508 We use the last invisible position instead of the
4509 first because this way the cursor is always drawn on
4510 the first "." of the ellipsis, whenever PT is inside
4511 the invisible text. Otherwise the cursor would be
4512 placed _after_ the ellipsis when the point is after the
4513 first invisible character. */
4514 if (!STRINGP (it->object))
4515 {
4516 it->position.charpos = newpos - 1;
4517 it->position.bytepos = CHAR_TO_BYTE (it->position.charpos);
4518 }
4519 }
4520
4521 /* If there are before-strings at the start of invisible
4522 text, and the text is invisible because of a text
4523 property, arrange to show before-strings because 20.x did
4524 it that way. (If the text is invisible because of an
4525 overlay property instead of a text property, this is
4526 already handled in the overlay code.) */
4527 if (NILP (overlay)
4528 && get_overlay_strings (it, it->stop_charpos))
4529 {
4530 handled = HANDLED_RECOMPUTE_PROPS;
4531 if (it->sp > 0)
4532 {
4533 it->stack[it->sp - 1].display_ellipsis_p = display_ellipsis_p;
4534 /* The call to get_overlay_strings above recomputes
4535 it->stop_charpos, but it only considers changes
4536 in properties and overlays beyond iterator's
4537 current position. This causes us to miss changes
4538 that happen exactly where the invisible property
4539 ended. So we play it safe here and force the
4540 iterator to check for potential stop positions
4541 immediately after the invisible text. Note that
4542 if get_overlay_strings returns true, it
4543 normally also pushed the iterator stack, so we
4544 need to update the stop position in the slot
4545 below the current one. */
4546 it->stack[it->sp - 1].stop_charpos
4547 = CHARPOS (it->stack[it->sp - 1].current.pos);
4548 }
4549 }
4550 else if (display_ellipsis_p)
4551 {
4552 it->ellipsis_p = true;
4553 /* Let the ellipsis display before
4554 considering any properties of the following char.
4555 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4556 handled = HANDLED_RETURN;
4557 }
4558 }
4559 }
4560
4561 return handled;
4562 }
4563
4564
4565 /* Make iterator IT return `...' next.
4566 Replaces LEN characters from buffer. */
4567
4568 static void
4569 setup_for_ellipsis (struct it *it, int len)
4570 {
4571 /* Use the display table definition for `...'. Invalid glyphs
4572 will be handled by the method returning elements from dpvec. */
4573 if (it->dp && VECTORP (DISP_INVIS_VECTOR (it->dp)))
4574 {
4575 struct Lisp_Vector *v = XVECTOR (DISP_INVIS_VECTOR (it->dp));
4576 it->dpvec = v->contents;
4577 it->dpend = v->contents + v->header.size;
4578 }
4579 else
4580 {
4581 /* Default `...'. */
4582 it->dpvec = default_invis_vector;
4583 it->dpend = default_invis_vector + 3;
4584 }
4585
4586 it->dpvec_char_len = len;
4587 it->current.dpvec_index = 0;
4588 it->dpvec_face_id = -1;
4589
4590 /* Use IT->saved_face_id for the ellipsis, so that it has the same
4591 face as the preceding text. IT->saved_face_id was set in
4592 handle_stop to the face of the preceding character, and will be
4593 different from IT->face_id only if the invisible text skipped in
4594 handle_invisible_prop has some non-default face on its first
4595 character. We thus ignore the face of the invisible text when we
4596 display the ellipsis. IT's face is restored in set_iterator_to_next. */
4597 if (it->saved_face_id >= 0)
4598 it->face_id = it->saved_face_id;
4599
4600 /* If the ellipsis represents buffer text, it means we advanced in
4601 the buffer, so we should no longer ignore overlay strings. */
4602 if (it->method == GET_FROM_BUFFER)
4603 it->ignore_overlay_strings_at_pos_p = false;
4604
4605 it->method = GET_FROM_DISPLAY_VECTOR;
4606 it->ellipsis_p = true;
4607 }
4608
4609
4610 \f
4611 /***********************************************************************
4612 'display' property
4613 ***********************************************************************/
4614
4615 /* Set up iterator IT from `display' property at its current position.
4616 Called from handle_stop.
4617 We return HANDLED_RETURN if some part of the display property
4618 overrides the display of the buffer text itself.
4619 Otherwise we return HANDLED_NORMALLY. */
4620
4621 static enum prop_handled
4622 handle_display_prop (struct it *it)
4623 {
4624 Lisp_Object propval, object, overlay;
4625 struct text_pos *position;
4626 ptrdiff_t bufpos;
4627 /* Nonzero if some property replaces the display of the text itself. */
4628 int display_replaced = 0;
4629
4630 if (STRINGP (it->string))
4631 {
4632 object = it->string;
4633 position = &it->current.string_pos;
4634 bufpos = CHARPOS (it->current.pos);
4635 }
4636 else
4637 {
4638 XSETWINDOW (object, it->w);
4639 position = &it->current.pos;
4640 bufpos = CHARPOS (*position);
4641 }
4642
4643 /* Reset those iterator values set from display property values. */
4644 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
4645 it->space_width = Qnil;
4646 it->font_height = Qnil;
4647 it->voffset = 0;
4648
4649 /* We don't support recursive `display' properties, i.e. string
4650 values that have a string `display' property, that have a string
4651 `display' property etc. */
4652 if (!it->string_from_display_prop_p)
4653 it->area = TEXT_AREA;
4654
4655 propval = get_char_property_and_overlay (make_number (position->charpos),
4656 Qdisplay, object, &overlay);
4657 if (NILP (propval))
4658 return HANDLED_NORMALLY;
4659 /* Now OVERLAY is the overlay that gave us this property, or nil
4660 if it was a text property. */
4661
4662 if (!STRINGP (it->string))
4663 object = it->w->contents;
4664
4665 display_replaced = handle_display_spec (it, propval, object, overlay,
4666 position, bufpos,
4667 FRAME_WINDOW_P (it->f));
4668 return display_replaced != 0 ? HANDLED_RETURN : HANDLED_NORMALLY;
4669 }
4670
4671 /* Subroutine of handle_display_prop. Returns non-zero if the display
4672 specification in SPEC is a replacing specification, i.e. it would
4673 replace the text covered by `display' property with something else,
4674 such as an image or a display string. If SPEC includes any kind or
4675 `(space ...) specification, the value is 2; this is used by
4676 compute_display_string_pos, which see.
4677
4678 See handle_single_display_spec for documentation of arguments.
4679 FRAME_WINDOW_P is true if the window being redisplayed is on a
4680 GUI frame; this argument is used only if IT is NULL, see below.
4681
4682 IT can be NULL, if this is called by the bidi reordering code
4683 through compute_display_string_pos, which see. In that case, this
4684 function only examines SPEC, but does not otherwise "handle" it, in
4685 the sense that it doesn't set up members of IT from the display
4686 spec. */
4687 static int
4688 handle_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4689 Lisp_Object overlay, struct text_pos *position,
4690 ptrdiff_t bufpos, bool frame_window_p)
4691 {
4692 int replacing = 0;
4693
4694 if (CONSP (spec)
4695 /* Simple specifications. */
4696 && !EQ (XCAR (spec), Qimage)
4697 #ifdef HAVE_XWIDGETS
4698 && !EQ (XCAR (spec), Qxwidget)
4699 #endif
4700 && !EQ (XCAR (spec), Qspace)
4701 && !EQ (XCAR (spec), Qwhen)
4702 && !EQ (XCAR (spec), Qslice)
4703 && !EQ (XCAR (spec), Qspace_width)
4704 && !EQ (XCAR (spec), Qheight)
4705 && !EQ (XCAR (spec), Qraise)
4706 /* Marginal area specifications. */
4707 && !(CONSP (XCAR (spec)) && EQ (XCAR (XCAR (spec)), Qmargin))
4708 && !EQ (XCAR (spec), Qleft_fringe)
4709 && !EQ (XCAR (spec), Qright_fringe)
4710 && !NILP (XCAR (spec)))
4711 {
4712 for (; CONSP (spec); spec = XCDR (spec))
4713 {
4714 int rv = handle_single_display_spec (it, XCAR (spec), object,
4715 overlay, position, bufpos,
4716 replacing, frame_window_p);
4717 if (rv != 0)
4718 {
4719 replacing = rv;
4720 /* If some text in a string is replaced, `position' no
4721 longer points to the position of `object'. */
4722 if (!it || STRINGP (object))
4723 break;
4724 }
4725 }
4726 }
4727 else if (VECTORP (spec))
4728 {
4729 ptrdiff_t i;
4730 for (i = 0; i < ASIZE (spec); ++i)
4731 {
4732 int rv = handle_single_display_spec (it, AREF (spec, i), object,
4733 overlay, position, bufpos,
4734 replacing, frame_window_p);
4735 if (rv != 0)
4736 {
4737 replacing = rv;
4738 /* If some text in a string is replaced, `position' no
4739 longer points to the position of `object'. */
4740 if (!it || STRINGP (object))
4741 break;
4742 }
4743 }
4744 }
4745 else
4746 replacing = handle_single_display_spec (it, spec, object, overlay, position,
4747 bufpos, 0, frame_window_p);
4748 return replacing;
4749 }
4750
4751 /* Value is the position of the end of the `display' property starting
4752 at START_POS in OBJECT. */
4753
4754 static struct text_pos
4755 display_prop_end (struct it *it, Lisp_Object object, struct text_pos start_pos)
4756 {
4757 Lisp_Object end;
4758 struct text_pos end_pos;
4759
4760 end = Fnext_single_char_property_change (make_number (CHARPOS (start_pos)),
4761 Qdisplay, object, Qnil);
4762 CHARPOS (end_pos) = XFASTINT (end);
4763 if (STRINGP (object))
4764 compute_string_pos (&end_pos, start_pos, it->string);
4765 else
4766 BYTEPOS (end_pos) = CHAR_TO_BYTE (XFASTINT (end));
4767
4768 return end_pos;
4769 }
4770
4771
4772 /* Set up IT from a single `display' property specification SPEC. OBJECT
4773 is the object in which the `display' property was found. *POSITION
4774 is the position in OBJECT at which the `display' property was found.
4775 BUFPOS is the buffer position of OBJECT (different from POSITION if
4776 OBJECT is not a buffer). DISPLAY_REPLACED non-zero means that we
4777 previously saw a display specification which already replaced text
4778 display with something else, for example an image; we ignore such
4779 properties after the first one has been processed.
4780
4781 OVERLAY is the overlay this `display' property came from,
4782 or nil if it was a text property.
4783
4784 If SPEC is a `space' or `image' specification, and in some other
4785 cases too, set *POSITION to the position where the `display'
4786 property ends.
4787
4788 If IT is NULL, only examine the property specification in SPEC, but
4789 don't set up IT. In that case, FRAME_WINDOW_P means SPEC
4790 is intended to be displayed in a window on a GUI frame.
4791
4792 Value is non-zero if something was found which replaces the display
4793 of buffer or string text. */
4794
4795 static int
4796 handle_single_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4797 Lisp_Object overlay, struct text_pos *position,
4798 ptrdiff_t bufpos, int display_replaced,
4799 bool frame_window_p)
4800 {
4801 Lisp_Object form;
4802 Lisp_Object location, value;
4803 struct text_pos start_pos = *position;
4804
4805 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4806 If the result is non-nil, use VALUE instead of SPEC. */
4807 form = Qt;
4808 if (CONSP (spec) && EQ (XCAR (spec), Qwhen))
4809 {
4810 spec = XCDR (spec);
4811 if (!CONSP (spec))
4812 return 0;
4813 form = XCAR (spec);
4814 spec = XCDR (spec);
4815 }
4816
4817 if (!NILP (form) && !EQ (form, Qt))
4818 {
4819 ptrdiff_t count = SPECPDL_INDEX ();
4820
4821 /* Bind `object' to the object having the `display' property, a
4822 buffer or string. Bind `position' to the position in the
4823 object where the property was found, and `buffer-position'
4824 to the current position in the buffer. */
4825
4826 if (NILP (object))
4827 XSETBUFFER (object, current_buffer);
4828 specbind (Qobject, object);
4829 specbind (Qposition, make_number (CHARPOS (*position)));
4830 specbind (Qbuffer_position, make_number (bufpos));
4831 form = safe_eval (form);
4832 unbind_to (count, Qnil);
4833 }
4834
4835 if (NILP (form))
4836 return 0;
4837
4838 /* Handle `(height HEIGHT)' specifications. */
4839 if (CONSP (spec)
4840 && EQ (XCAR (spec), Qheight)
4841 && CONSP (XCDR (spec)))
4842 {
4843 if (it)
4844 {
4845 if (!FRAME_WINDOW_P (it->f))
4846 return 0;
4847
4848 it->font_height = XCAR (XCDR (spec));
4849 if (!NILP (it->font_height))
4850 {
4851 int new_height = -1;
4852
4853 if (CONSP (it->font_height)
4854 && (EQ (XCAR (it->font_height), Qplus)
4855 || EQ (XCAR (it->font_height), Qminus))
4856 && CONSP (XCDR (it->font_height))
4857 && RANGED_INTEGERP (0, XCAR (XCDR (it->font_height)), INT_MAX))
4858 {
4859 /* `(+ N)' or `(- N)' where N is an integer. */
4860 int steps = XINT (XCAR (XCDR (it->font_height)));
4861 if (EQ (XCAR (it->font_height), Qplus))
4862 steps = - steps;
4863 it->face_id = smaller_face (it->f, it->face_id, steps);
4864 }
4865 else if (FUNCTIONP (it->font_height))
4866 {
4867 /* Call function with current height as argument.
4868 Value is the new height. */
4869 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4870 Lisp_Object height;
4871 height = safe_call1 (it->font_height,
4872 face->lface[LFACE_HEIGHT_INDEX]);
4873 if (NUMBERP (height))
4874 new_height = XFLOATINT (height);
4875 }
4876 else if (NUMBERP (it->font_height))
4877 {
4878 /* Value is a multiple of the canonical char height. */
4879 struct face *f;
4880
4881 f = FACE_FROM_ID (it->f,
4882 lookup_basic_face (it->f, DEFAULT_FACE_ID));
4883 new_height = (XFLOATINT (it->font_height)
4884 * XINT (f->lface[LFACE_HEIGHT_INDEX]));
4885 }
4886 else
4887 {
4888 /* Evaluate IT->font_height with `height' bound to the
4889 current specified height to get the new height. */
4890 ptrdiff_t count = SPECPDL_INDEX ();
4891 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4892
4893 specbind (Qheight, face->lface[LFACE_HEIGHT_INDEX]);
4894 value = safe_eval (it->font_height);
4895 unbind_to (count, Qnil);
4896
4897 if (NUMBERP (value))
4898 new_height = XFLOATINT (value);
4899 }
4900
4901 if (new_height > 0)
4902 it->face_id = face_with_height (it->f, it->face_id, new_height);
4903 }
4904 }
4905
4906 return 0;
4907 }
4908
4909 /* Handle `(space-width WIDTH)'. */
4910 if (CONSP (spec)
4911 && EQ (XCAR (spec), Qspace_width)
4912 && CONSP (XCDR (spec)))
4913 {
4914 if (it)
4915 {
4916 if (!FRAME_WINDOW_P (it->f))
4917 return 0;
4918
4919 value = XCAR (XCDR (spec));
4920 if (NUMBERP (value) && XFLOATINT (value) > 0)
4921 it->space_width = value;
4922 }
4923
4924 return 0;
4925 }
4926
4927 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4928 if (CONSP (spec)
4929 && EQ (XCAR (spec), Qslice))
4930 {
4931 Lisp_Object tem;
4932
4933 if (it)
4934 {
4935 if (!FRAME_WINDOW_P (it->f))
4936 return 0;
4937
4938 if (tem = XCDR (spec), CONSP (tem))
4939 {
4940 it->slice.x = XCAR (tem);
4941 if (tem = XCDR (tem), CONSP (tem))
4942 {
4943 it->slice.y = XCAR (tem);
4944 if (tem = XCDR (tem), CONSP (tem))
4945 {
4946 it->slice.width = XCAR (tem);
4947 if (tem = XCDR (tem), CONSP (tem))
4948 it->slice.height = XCAR (tem);
4949 }
4950 }
4951 }
4952 }
4953
4954 return 0;
4955 }
4956
4957 /* Handle `(raise FACTOR)'. */
4958 if (CONSP (spec)
4959 && EQ (XCAR (spec), Qraise)
4960 && CONSP (XCDR (spec)))
4961 {
4962 if (it)
4963 {
4964 if (!FRAME_WINDOW_P (it->f))
4965 return 0;
4966
4967 #ifdef HAVE_WINDOW_SYSTEM
4968 value = XCAR (XCDR (spec));
4969 if (NUMBERP (value))
4970 {
4971 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4972 it->voffset = - (XFLOATINT (value)
4973 * (normal_char_height (face->font, -1)));
4974 }
4975 #endif /* HAVE_WINDOW_SYSTEM */
4976 }
4977
4978 return 0;
4979 }
4980
4981 /* Don't handle the other kinds of display specifications
4982 inside a string that we got from a `display' property. */
4983 if (it && it->string_from_display_prop_p)
4984 return 0;
4985
4986 /* Characters having this form of property are not displayed, so
4987 we have to find the end of the property. */
4988 if (it)
4989 {
4990 start_pos = *position;
4991 *position = display_prop_end (it, object, start_pos);
4992 /* If the display property comes from an overlay, don't consider
4993 any potential stop_charpos values before the end of that
4994 overlay. Since display_prop_end will happily find another
4995 'display' property coming from some other overlay or text
4996 property on buffer positions before this overlay's end, we
4997 need to ignore them, or else we risk displaying this
4998 overlay's display string/image twice. */
4999 if (!NILP (overlay))
5000 {
5001 ptrdiff_t ovendpos = OVERLAY_POSITION (OVERLAY_END (overlay));
5002
5003 if (ovendpos > CHARPOS (*position))
5004 SET_TEXT_POS (*position, ovendpos, CHAR_TO_BYTE (ovendpos));
5005 }
5006 }
5007 value = Qnil;
5008
5009 /* Stop the scan at that end position--we assume that all
5010 text properties change there. */
5011 if (it)
5012 it->stop_charpos = position->charpos;
5013
5014 /* Handle `(left-fringe BITMAP [FACE])'
5015 and `(right-fringe BITMAP [FACE])'. */
5016 if (CONSP (spec)
5017 && (EQ (XCAR (spec), Qleft_fringe)
5018 || EQ (XCAR (spec), Qright_fringe))
5019 && CONSP (XCDR (spec)))
5020 {
5021 if (it)
5022 {
5023 if (!FRAME_WINDOW_P (it->f))
5024 /* If we return here, POSITION has been advanced
5025 across the text with this property. */
5026 {
5027 /* Synchronize the bidi iterator with POSITION. This is
5028 needed because we are not going to push the iterator
5029 on behalf of this display property, so there will be
5030 no pop_it call to do this synchronization for us. */
5031 if (it->bidi_p)
5032 {
5033 it->position = *position;
5034 iterate_out_of_display_property (it);
5035 *position = it->position;
5036 }
5037 return 1;
5038 }
5039 }
5040 else if (!frame_window_p)
5041 return 1;
5042
5043 #ifdef HAVE_WINDOW_SYSTEM
5044 value = XCAR (XCDR (spec));
5045 int fringe_bitmap = SYMBOLP (value) ? lookup_fringe_bitmap (value) : 0;
5046 if (! fringe_bitmap)
5047 /* If we return here, POSITION has been advanced
5048 across the text with this property. */
5049 {
5050 if (it && it->bidi_p)
5051 {
5052 it->position = *position;
5053 iterate_out_of_display_property (it);
5054 *position = it->position;
5055 }
5056 return 1;
5057 }
5058
5059 if (it)
5060 {
5061 int face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
5062
5063 if (CONSP (XCDR (XCDR (spec))))
5064 {
5065 Lisp_Object face_name = XCAR (XCDR (XCDR (spec)));
5066 int face_id2 = lookup_derived_face (it->f, face_name,
5067 FRINGE_FACE_ID, false);
5068 if (face_id2 >= 0)
5069 face_id = face_id2;
5070 }
5071
5072 /* Save current settings of IT so that we can restore them
5073 when we are finished with the glyph property value. */
5074 push_it (it, position);
5075
5076 it->area = TEXT_AREA;
5077 it->what = IT_IMAGE;
5078 it->image_id = -1; /* no image */
5079 it->position = start_pos;
5080 it->object = NILP (object) ? it->w->contents : object;
5081 it->method = GET_FROM_IMAGE;
5082 it->from_overlay = Qnil;
5083 it->face_id = face_id;
5084 it->from_disp_prop_p = true;
5085
5086 /* Say that we haven't consumed the characters with
5087 `display' property yet. The call to pop_it in
5088 set_iterator_to_next will clean this up. */
5089 *position = start_pos;
5090
5091 if (EQ (XCAR (spec), Qleft_fringe))
5092 {
5093 it->left_user_fringe_bitmap = fringe_bitmap;
5094 it->left_user_fringe_face_id = face_id;
5095 }
5096 else
5097 {
5098 it->right_user_fringe_bitmap = fringe_bitmap;
5099 it->right_user_fringe_face_id = face_id;
5100 }
5101 }
5102 #endif /* HAVE_WINDOW_SYSTEM */
5103 return 1;
5104 }
5105
5106 /* Prepare to handle `((margin left-margin) ...)',
5107 `((margin right-margin) ...)' and `((margin nil) ...)'
5108 prefixes for display specifications. */
5109 location = Qunbound;
5110 if (CONSP (spec) && CONSP (XCAR (spec)))
5111 {
5112 Lisp_Object tem;
5113
5114 value = XCDR (spec);
5115 if (CONSP (value))
5116 value = XCAR (value);
5117
5118 tem = XCAR (spec);
5119 if (EQ (XCAR (tem), Qmargin)
5120 && (tem = XCDR (tem),
5121 tem = CONSP (tem) ? XCAR (tem) : Qnil,
5122 (NILP (tem)
5123 || EQ (tem, Qleft_margin)
5124 || EQ (tem, Qright_margin))))
5125 location = tem;
5126 }
5127
5128 if (EQ (location, Qunbound))
5129 {
5130 location = Qnil;
5131 value = spec;
5132 }
5133
5134 /* After this point, VALUE is the property after any
5135 margin prefix has been stripped. It must be a string,
5136 an image specification, or `(space ...)'.
5137
5138 LOCATION specifies where to display: `left-margin',
5139 `right-margin' or nil. */
5140
5141 bool valid_p = (STRINGP (value)
5142 #ifdef HAVE_WINDOW_SYSTEM
5143 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
5144 && valid_image_p (value))
5145 #endif /* not HAVE_WINDOW_SYSTEM */
5146 || (CONSP (value) && EQ (XCAR (value), Qspace))
5147 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
5148 && valid_xwidget_spec_p (value)));
5149
5150 if (valid_p && display_replaced == 0)
5151 {
5152 int retval = 1;
5153
5154 if (!it)
5155 {
5156 /* Callers need to know whether the display spec is any kind
5157 of `(space ...)' spec that is about to affect text-area
5158 display. */
5159 if (CONSP (value) && EQ (XCAR (value), Qspace) && NILP (location))
5160 retval = 2;
5161 return retval;
5162 }
5163
5164 /* Save current settings of IT so that we can restore them
5165 when we are finished with the glyph property value. */
5166 push_it (it, position);
5167 it->from_overlay = overlay;
5168 it->from_disp_prop_p = true;
5169
5170 if (NILP (location))
5171 it->area = TEXT_AREA;
5172 else if (EQ (location, Qleft_margin))
5173 it->area = LEFT_MARGIN_AREA;
5174 else
5175 it->area = RIGHT_MARGIN_AREA;
5176
5177 if (STRINGP (value))
5178 {
5179 it->string = value;
5180 it->multibyte_p = STRING_MULTIBYTE (it->string);
5181 it->current.overlay_string_index = -1;
5182 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5183 it->end_charpos = it->string_nchars = SCHARS (it->string);
5184 it->method = GET_FROM_STRING;
5185 it->stop_charpos = 0;
5186 it->prev_stop = 0;
5187 it->base_level_stop = 0;
5188 it->string_from_display_prop_p = true;
5189 /* Say that we haven't consumed the characters with
5190 `display' property yet. The call to pop_it in
5191 set_iterator_to_next will clean this up. */
5192 if (BUFFERP (object))
5193 *position = start_pos;
5194
5195 /* Force paragraph direction to be that of the parent
5196 object. If the parent object's paragraph direction is
5197 not yet determined, default to L2R. */
5198 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5199 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5200 else
5201 it->paragraph_embedding = L2R;
5202
5203 /* Set up the bidi iterator for this display string. */
5204 if (it->bidi_p)
5205 {
5206 it->bidi_it.string.lstring = it->string;
5207 it->bidi_it.string.s = NULL;
5208 it->bidi_it.string.schars = it->end_charpos;
5209 it->bidi_it.string.bufpos = bufpos;
5210 it->bidi_it.string.from_disp_str = true;
5211 it->bidi_it.string.unibyte = !it->multibyte_p;
5212 it->bidi_it.w = it->w;
5213 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5214 }
5215 }
5216 else if (CONSP (value) && EQ (XCAR (value), Qspace))
5217 {
5218 it->method = GET_FROM_STRETCH;
5219 it->object = value;
5220 *position = it->position = start_pos;
5221 retval = 1 + (it->area == TEXT_AREA);
5222 }
5223 else if (valid_xwidget_spec_p (value))
5224 {
5225 it->what = IT_XWIDGET;
5226 it->method = GET_FROM_XWIDGET;
5227 it->position = start_pos;
5228 it->object = NILP (object) ? it->w->contents : object;
5229 *position = start_pos;
5230 it->xwidget = lookup_xwidget (value);
5231 }
5232 #ifdef HAVE_WINDOW_SYSTEM
5233 else
5234 {
5235 it->what = IT_IMAGE;
5236 it->image_id = lookup_image (it->f, value);
5237 it->position = start_pos;
5238 it->object = NILP (object) ? it->w->contents : object;
5239 it->method = GET_FROM_IMAGE;
5240
5241 /* Say that we haven't consumed the characters with
5242 `display' property yet. The call to pop_it in
5243 set_iterator_to_next will clean this up. */
5244 *position = start_pos;
5245 }
5246 #endif /* HAVE_WINDOW_SYSTEM */
5247
5248 return retval;
5249 }
5250
5251 /* Invalid property or property not supported. Restore
5252 POSITION to what it was before. */
5253 *position = start_pos;
5254 return 0;
5255 }
5256
5257 /* Check if PROP is a display property value whose text should be
5258 treated as intangible. OVERLAY is the overlay from which PROP
5259 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5260 specify the buffer position covered by PROP. */
5261
5262 bool
5263 display_prop_intangible_p (Lisp_Object prop, Lisp_Object overlay,
5264 ptrdiff_t charpos, ptrdiff_t bytepos)
5265 {
5266 bool frame_window_p = FRAME_WINDOW_P (XFRAME (selected_frame));
5267 struct text_pos position;
5268
5269 SET_TEXT_POS (position, charpos, bytepos);
5270 return (handle_display_spec (NULL, prop, Qnil, overlay,
5271 &position, charpos, frame_window_p)
5272 != 0);
5273 }
5274
5275
5276 /* Return true if PROP is a display sub-property value containing STRING.
5277
5278 Implementation note: this and the following function are really
5279 special cases of handle_display_spec and
5280 handle_single_display_spec, and should ideally use the same code.
5281 Until they do, these two pairs must be consistent and must be
5282 modified in sync. */
5283
5284 static bool
5285 single_display_spec_string_p (Lisp_Object prop, Lisp_Object string)
5286 {
5287 if (EQ (string, prop))
5288 return true;
5289
5290 /* Skip over `when FORM'. */
5291 if (CONSP (prop) && EQ (XCAR (prop), Qwhen))
5292 {
5293 prop = XCDR (prop);
5294 if (!CONSP (prop))
5295 return false;
5296 /* Actually, the condition following `when' should be eval'ed,
5297 like handle_single_display_spec does, and we should return
5298 false if it evaluates to nil. However, this function is
5299 called only when the buffer was already displayed and some
5300 glyph in the glyph matrix was found to come from a display
5301 string. Therefore, the condition was already evaluated, and
5302 the result was non-nil, otherwise the display string wouldn't
5303 have been displayed and we would have never been called for
5304 this property. Thus, we can skip the evaluation and assume
5305 its result is non-nil. */
5306 prop = XCDR (prop);
5307 }
5308
5309 if (CONSP (prop))
5310 /* Skip over `margin LOCATION'. */
5311 if (EQ (XCAR (prop), Qmargin))
5312 {
5313 prop = XCDR (prop);
5314 if (!CONSP (prop))
5315 return false;
5316
5317 prop = XCDR (prop);
5318 if (!CONSP (prop))
5319 return false;
5320 }
5321
5322 return EQ (prop, string) || (CONSP (prop) && EQ (XCAR (prop), string));
5323 }
5324
5325
5326 /* Return true if STRING appears in the `display' property PROP. */
5327
5328 static bool
5329 display_prop_string_p (Lisp_Object prop, Lisp_Object string)
5330 {
5331 if (CONSP (prop)
5332 && !EQ (XCAR (prop), Qwhen)
5333 && !(CONSP (XCAR (prop)) && EQ (Qmargin, XCAR (XCAR (prop)))))
5334 {
5335 /* A list of sub-properties. */
5336 while (CONSP (prop))
5337 {
5338 if (single_display_spec_string_p (XCAR (prop), string))
5339 return true;
5340 prop = XCDR (prop);
5341 }
5342 }
5343 else if (VECTORP (prop))
5344 {
5345 /* A vector of sub-properties. */
5346 ptrdiff_t i;
5347 for (i = 0; i < ASIZE (prop); ++i)
5348 if (single_display_spec_string_p (AREF (prop, i), string))
5349 return true;
5350 }
5351 else
5352 return single_display_spec_string_p (prop, string);
5353
5354 return false;
5355 }
5356
5357 /* Look for STRING in overlays and text properties in the current
5358 buffer, between character positions FROM and TO (excluding TO).
5359 BACK_P means look back (in this case, TO is supposed to be
5360 less than FROM).
5361 Value is the first character position where STRING was found, or
5362 zero if it wasn't found before hitting TO.
5363
5364 This function may only use code that doesn't eval because it is
5365 called asynchronously from note_mouse_highlight. */
5366
5367 static ptrdiff_t
5368 string_buffer_position_lim (Lisp_Object string,
5369 ptrdiff_t from, ptrdiff_t to, bool back_p)
5370 {
5371 Lisp_Object limit, prop, pos;
5372 bool found = false;
5373
5374 pos = make_number (max (from, BEGV));
5375
5376 if (!back_p) /* looking forward */
5377 {
5378 limit = make_number (min (to, ZV));
5379 while (!found && !EQ (pos, limit))
5380 {
5381 prop = Fget_char_property (pos, Qdisplay, Qnil);
5382 if (!NILP (prop) && display_prop_string_p (prop, string))
5383 found = true;
5384 else
5385 pos = Fnext_single_char_property_change (pos, Qdisplay, Qnil,
5386 limit);
5387 }
5388 }
5389 else /* looking back */
5390 {
5391 limit = make_number (max (to, BEGV));
5392 while (!found && !EQ (pos, limit))
5393 {
5394 prop = Fget_char_property (pos, Qdisplay, Qnil);
5395 if (!NILP (prop) && display_prop_string_p (prop, string))
5396 found = true;
5397 else
5398 pos = Fprevious_single_char_property_change (pos, Qdisplay, Qnil,
5399 limit);
5400 }
5401 }
5402
5403 return found ? XINT (pos) : 0;
5404 }
5405
5406 /* Determine which buffer position in current buffer STRING comes from.
5407 AROUND_CHARPOS is an approximate position where it could come from.
5408 Value is the buffer position or 0 if it couldn't be determined.
5409
5410 This function is necessary because we don't record buffer positions
5411 in glyphs generated from strings (to keep struct glyph small).
5412 This function may only use code that doesn't eval because it is
5413 called asynchronously from note_mouse_highlight. */
5414
5415 static ptrdiff_t
5416 string_buffer_position (Lisp_Object string, ptrdiff_t around_charpos)
5417 {
5418 const int MAX_DISTANCE = 1000;
5419 ptrdiff_t found = string_buffer_position_lim (string, around_charpos,
5420 around_charpos + MAX_DISTANCE,
5421 false);
5422
5423 if (!found)
5424 found = string_buffer_position_lim (string, around_charpos,
5425 around_charpos - MAX_DISTANCE, true);
5426 return found;
5427 }
5428
5429
5430 \f
5431 /***********************************************************************
5432 `composition' property
5433 ***********************************************************************/
5434
5435 /* Set up iterator IT from `composition' property at its current
5436 position. Called from handle_stop. */
5437
5438 static enum prop_handled
5439 handle_composition_prop (struct it *it)
5440 {
5441 Lisp_Object prop, string;
5442 ptrdiff_t pos, pos_byte, start, end;
5443
5444 if (STRINGP (it->string))
5445 {
5446 unsigned char *s;
5447
5448 pos = IT_STRING_CHARPOS (*it);
5449 pos_byte = IT_STRING_BYTEPOS (*it);
5450 string = it->string;
5451 s = SDATA (string) + pos_byte;
5452 it->c = STRING_CHAR (s);
5453 }
5454 else
5455 {
5456 pos = IT_CHARPOS (*it);
5457 pos_byte = IT_BYTEPOS (*it);
5458 string = Qnil;
5459 it->c = FETCH_CHAR (pos_byte);
5460 }
5461
5462 /* If there's a valid composition and point is not inside of the
5463 composition (in the case that the composition is from the current
5464 buffer), draw a glyph composed from the composition components. */
5465 if (find_composition (pos, -1, &start, &end, &prop, string)
5466 && composition_valid_p (start, end, prop)
5467 && (STRINGP (it->string) || (PT <= start || PT >= end)))
5468 {
5469 if (start < pos)
5470 /* As we can't handle this situation (perhaps font-lock added
5471 a new composition), we just return here hoping that next
5472 redisplay will detect this composition much earlier. */
5473 return HANDLED_NORMALLY;
5474 if (start != pos)
5475 {
5476 if (STRINGP (it->string))
5477 pos_byte = string_char_to_byte (it->string, start);
5478 else
5479 pos_byte = CHAR_TO_BYTE (start);
5480 }
5481 it->cmp_it.id = get_composition_id (start, pos_byte, end - start,
5482 prop, string);
5483
5484 if (it->cmp_it.id >= 0)
5485 {
5486 it->cmp_it.ch = -1;
5487 it->cmp_it.nchars = COMPOSITION_LENGTH (prop);
5488 it->cmp_it.nglyphs = -1;
5489 }
5490 }
5491
5492 return HANDLED_NORMALLY;
5493 }
5494
5495
5496 \f
5497 /***********************************************************************
5498 Overlay strings
5499 ***********************************************************************/
5500
5501 /* The following structure is used to record overlay strings for
5502 later sorting in load_overlay_strings. */
5503
5504 struct overlay_entry
5505 {
5506 Lisp_Object overlay;
5507 Lisp_Object string;
5508 EMACS_INT priority;
5509 bool after_string_p;
5510 };
5511
5512
5513 /* Set up iterator IT from overlay strings at its current position.
5514 Called from handle_stop. */
5515
5516 static enum prop_handled
5517 handle_overlay_change (struct it *it)
5518 {
5519 if (!STRINGP (it->string) && get_overlay_strings (it, 0))
5520 return HANDLED_RECOMPUTE_PROPS;
5521 else
5522 return HANDLED_NORMALLY;
5523 }
5524
5525
5526 /* Set up the next overlay string for delivery by IT, if there is an
5527 overlay string to deliver. Called by set_iterator_to_next when the
5528 end of the current overlay string is reached. If there are more
5529 overlay strings to display, IT->string and
5530 IT->current.overlay_string_index are set appropriately here.
5531 Otherwise IT->string is set to nil. */
5532
5533 static void
5534 next_overlay_string (struct it *it)
5535 {
5536 ++it->current.overlay_string_index;
5537 if (it->current.overlay_string_index == it->n_overlay_strings)
5538 {
5539 /* No more overlay strings. Restore IT's settings to what
5540 they were before overlay strings were processed, and
5541 continue to deliver from current_buffer. */
5542
5543 it->ellipsis_p = it->stack[it->sp - 1].display_ellipsis_p;
5544 pop_it (it);
5545 eassert (it->sp > 0
5546 || (NILP (it->string)
5547 && it->method == GET_FROM_BUFFER
5548 && it->stop_charpos >= BEGV
5549 && it->stop_charpos <= it->end_charpos));
5550 it->current.overlay_string_index = -1;
5551 it->n_overlay_strings = 0;
5552 /* If there's an empty display string on the stack, pop the
5553 stack, to resync the bidi iterator with IT's position. Such
5554 empty strings are pushed onto the stack in
5555 get_overlay_strings_1. */
5556 if (it->sp > 0 && STRINGP (it->string) && !SCHARS (it->string))
5557 pop_it (it);
5558
5559 /* Since we've exhausted overlay strings at this buffer
5560 position, set the flag to ignore overlays until we move to
5561 another position. The flag is reset in
5562 next_element_from_buffer. */
5563 it->ignore_overlay_strings_at_pos_p = true;
5564
5565 /* If we're at the end of the buffer, record that we have
5566 processed the overlay strings there already, so that
5567 next_element_from_buffer doesn't try it again. */
5568 if (NILP (it->string)
5569 && IT_CHARPOS (*it) >= it->end_charpos
5570 && it->overlay_strings_charpos >= it->end_charpos)
5571 it->overlay_strings_at_end_processed_p = true;
5572 /* Note: we reset overlay_strings_charpos only here, to make
5573 sure the just-processed overlays were indeed at EOB.
5574 Otherwise, overlays on text with invisible text property,
5575 which are processed with IT's position past the invisible
5576 text, might fool us into thinking the overlays at EOB were
5577 already processed (linum-mode can cause this, for
5578 example). */
5579 it->overlay_strings_charpos = -1;
5580 }
5581 else
5582 {
5583 /* There are more overlay strings to process. If
5584 IT->current.overlay_string_index has advanced to a position
5585 where we must load IT->overlay_strings with more strings, do
5586 it. We must load at the IT->overlay_strings_charpos where
5587 IT->n_overlay_strings was originally computed; when invisible
5588 text is present, this might not be IT_CHARPOS (Bug#7016). */
5589 int i = it->current.overlay_string_index % OVERLAY_STRING_CHUNK_SIZE;
5590
5591 if (it->current.overlay_string_index && i == 0)
5592 load_overlay_strings (it, it->overlay_strings_charpos);
5593
5594 /* Initialize IT to deliver display elements from the overlay
5595 string. */
5596 it->string = it->overlay_strings[i];
5597 it->multibyte_p = STRING_MULTIBYTE (it->string);
5598 SET_TEXT_POS (it->current.string_pos, 0, 0);
5599 it->method = GET_FROM_STRING;
5600 it->stop_charpos = 0;
5601 it->end_charpos = SCHARS (it->string);
5602 if (it->cmp_it.stop_pos >= 0)
5603 it->cmp_it.stop_pos = 0;
5604 it->prev_stop = 0;
5605 it->base_level_stop = 0;
5606
5607 /* Set up the bidi iterator for this overlay string. */
5608 if (it->bidi_p)
5609 {
5610 it->bidi_it.string.lstring = it->string;
5611 it->bidi_it.string.s = NULL;
5612 it->bidi_it.string.schars = SCHARS (it->string);
5613 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
5614 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5615 it->bidi_it.string.unibyte = !it->multibyte_p;
5616 it->bidi_it.w = it->w;
5617 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5618 }
5619 }
5620
5621 CHECK_IT (it);
5622 }
5623
5624
5625 /* Compare two overlay_entry structures E1 and E2. Used as a
5626 comparison function for qsort in load_overlay_strings. Overlay
5627 strings for the same position are sorted so that
5628
5629 1. All after-strings come in front of before-strings, except
5630 when they come from the same overlay.
5631
5632 2. Within after-strings, strings are sorted so that overlay strings
5633 from overlays with higher priorities come first.
5634
5635 2. Within before-strings, strings are sorted so that overlay
5636 strings from overlays with higher priorities come last.
5637
5638 Value is analogous to strcmp. */
5639
5640
5641 static int
5642 compare_overlay_entries (const void *e1, const void *e2)
5643 {
5644 struct overlay_entry const *entry1 = e1;
5645 struct overlay_entry const *entry2 = e2;
5646 int result;
5647
5648 if (entry1->after_string_p != entry2->after_string_p)
5649 {
5650 /* Let after-strings appear in front of before-strings if
5651 they come from different overlays. */
5652 if (EQ (entry1->overlay, entry2->overlay))
5653 result = entry1->after_string_p ? 1 : -1;
5654 else
5655 result = entry1->after_string_p ? -1 : 1;
5656 }
5657 else if (entry1->priority != entry2->priority)
5658 {
5659 if (entry1->after_string_p)
5660 /* After-strings sorted in order of decreasing priority. */
5661 result = entry2->priority < entry1->priority ? -1 : 1;
5662 else
5663 /* Before-strings sorted in order of increasing priority. */
5664 result = entry1->priority < entry2->priority ? -1 : 1;
5665 }
5666 else
5667 result = 0;
5668
5669 return result;
5670 }
5671
5672
5673 /* Load the vector IT->overlay_strings with overlay strings from IT's
5674 current buffer position, or from CHARPOS if that is > 0. Set
5675 IT->n_overlays to the total number of overlay strings found.
5676
5677 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5678 a time. On entry into load_overlay_strings,
5679 IT->current.overlay_string_index gives the number of overlay
5680 strings that have already been loaded by previous calls to this
5681 function.
5682
5683 IT->add_overlay_start contains an additional overlay start
5684 position to consider for taking overlay strings from, if non-zero.
5685 This position comes into play when the overlay has an `invisible'
5686 property, and both before and after-strings. When we've skipped to
5687 the end of the overlay, because of its `invisible' property, we
5688 nevertheless want its before-string to appear.
5689 IT->add_overlay_start will contain the overlay start position
5690 in this case.
5691
5692 Overlay strings are sorted so that after-string strings come in
5693 front of before-string strings. Within before and after-strings,
5694 strings are sorted by overlay priority. See also function
5695 compare_overlay_entries. */
5696
5697 static void
5698 load_overlay_strings (struct it *it, ptrdiff_t charpos)
5699 {
5700 Lisp_Object overlay, window, str, invisible;
5701 struct Lisp_Overlay *ov;
5702 ptrdiff_t start, end;
5703 ptrdiff_t n = 0, i, j;
5704 int invis;
5705 struct overlay_entry entriesbuf[20];
5706 ptrdiff_t size = ARRAYELTS (entriesbuf);
5707 struct overlay_entry *entries = entriesbuf;
5708 USE_SAFE_ALLOCA;
5709
5710 if (charpos <= 0)
5711 charpos = IT_CHARPOS (*it);
5712
5713 /* Append the overlay string STRING of overlay OVERLAY to vector
5714 `entries' which has size `size' and currently contains `n'
5715 elements. AFTER_P means STRING is an after-string of
5716 OVERLAY. */
5717 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5718 do \
5719 { \
5720 Lisp_Object priority; \
5721 \
5722 if (n == size) \
5723 { \
5724 struct overlay_entry *old = entries; \
5725 SAFE_NALLOCA (entries, 2, size); \
5726 memcpy (entries, old, size * sizeof *entries); \
5727 size *= 2; \
5728 } \
5729 \
5730 entries[n].string = (STRING); \
5731 entries[n].overlay = (OVERLAY); \
5732 priority = Foverlay_get ((OVERLAY), Qpriority); \
5733 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5734 entries[n].after_string_p = (AFTER_P); \
5735 ++n; \
5736 } \
5737 while (false)
5738
5739 /* Process overlay before the overlay center. */
5740 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5741 {
5742 XSETMISC (overlay, ov);
5743 eassert (OVERLAYP (overlay));
5744 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5745 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5746
5747 if (end < charpos)
5748 break;
5749
5750 /* Skip this overlay if it doesn't start or end at IT's current
5751 position. */
5752 if (end != charpos && start != charpos)
5753 continue;
5754
5755 /* Skip this overlay if it doesn't apply to IT->w. */
5756 window = Foverlay_get (overlay, Qwindow);
5757 if (WINDOWP (window) && XWINDOW (window) != it->w)
5758 continue;
5759
5760 /* If the text ``under'' the overlay is invisible, both before-
5761 and after-strings from this overlay are visible; start and
5762 end position are indistinguishable. */
5763 invisible = Foverlay_get (overlay, Qinvisible);
5764 invis = TEXT_PROP_MEANS_INVISIBLE (invisible);
5765
5766 /* If overlay has a non-empty before-string, record it. */
5767 if ((start == charpos || (end == charpos && invis != 0))
5768 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5769 && SCHARS (str))
5770 RECORD_OVERLAY_STRING (overlay, str, false);
5771
5772 /* If overlay has a non-empty after-string, record it. */
5773 if ((end == charpos || (start == charpos && invis != 0))
5774 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5775 && SCHARS (str))
5776 RECORD_OVERLAY_STRING (overlay, str, true);
5777 }
5778
5779 /* Process overlays after the overlay center. */
5780 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5781 {
5782 XSETMISC (overlay, ov);
5783 eassert (OVERLAYP (overlay));
5784 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5785 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5786
5787 if (start > charpos)
5788 break;
5789
5790 /* Skip this overlay if it doesn't start or end at IT's current
5791 position. */
5792 if (end != charpos && start != charpos)
5793 continue;
5794
5795 /* Skip this overlay if it doesn't apply to IT->w. */
5796 window = Foverlay_get (overlay, Qwindow);
5797 if (WINDOWP (window) && XWINDOW (window) != it->w)
5798 continue;
5799
5800 /* If the text ``under'' the overlay is invisible, it has a zero
5801 dimension, and both before- and after-strings apply. */
5802 invisible = Foverlay_get (overlay, Qinvisible);
5803 invis = TEXT_PROP_MEANS_INVISIBLE (invisible);
5804
5805 /* If overlay has a non-empty before-string, record it. */
5806 if ((start == charpos || (end == charpos && invis != 0))
5807 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5808 && SCHARS (str))
5809 RECORD_OVERLAY_STRING (overlay, str, false);
5810
5811 /* If overlay has a non-empty after-string, record it. */
5812 if ((end == charpos || (start == charpos && invis != 0))
5813 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5814 && SCHARS (str))
5815 RECORD_OVERLAY_STRING (overlay, str, true);
5816 }
5817
5818 #undef RECORD_OVERLAY_STRING
5819
5820 /* Sort entries. */
5821 if (n > 1)
5822 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5823
5824 /* Record number of overlay strings, and where we computed it. */
5825 it->n_overlay_strings = n;
5826 it->overlay_strings_charpos = charpos;
5827
5828 /* IT->current.overlay_string_index is the number of overlay strings
5829 that have already been consumed by IT. Copy some of the
5830 remaining overlay strings to IT->overlay_strings. */
5831 i = 0;
5832 j = it->current.overlay_string_index;
5833 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5834 {
5835 it->overlay_strings[i] = entries[j].string;
5836 it->string_overlays[i++] = entries[j++].overlay;
5837 }
5838
5839 CHECK_IT (it);
5840 SAFE_FREE ();
5841 }
5842
5843
5844 /* Get the first chunk of overlay strings at IT's current buffer
5845 position, or at CHARPOS if that is > 0. Value is true if at
5846 least one overlay string was found. */
5847
5848 static bool
5849 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, bool compute_stop_p)
5850 {
5851 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5852 process. This fills IT->overlay_strings with strings, and sets
5853 IT->n_overlay_strings to the total number of strings to process.
5854 IT->pos.overlay_string_index has to be set temporarily to zero
5855 because load_overlay_strings needs this; it must be set to -1
5856 when no overlay strings are found because a zero value would
5857 indicate a position in the first overlay string. */
5858 it->current.overlay_string_index = 0;
5859 load_overlay_strings (it, charpos);
5860
5861 /* If we found overlay strings, set up IT to deliver display
5862 elements from the first one. Otherwise set up IT to deliver
5863 from current_buffer. */
5864 if (it->n_overlay_strings)
5865 {
5866 /* Make sure we know settings in current_buffer, so that we can
5867 restore meaningful values when we're done with the overlay
5868 strings. */
5869 if (compute_stop_p)
5870 compute_stop_pos (it);
5871 eassert (it->face_id >= 0);
5872
5873 /* Save IT's settings. They are restored after all overlay
5874 strings have been processed. */
5875 eassert (!compute_stop_p || it->sp == 0);
5876
5877 /* When called from handle_stop, there might be an empty display
5878 string loaded. In that case, don't bother saving it. But
5879 don't use this optimization with the bidi iterator, since we
5880 need the corresponding pop_it call to resync the bidi
5881 iterator's position with IT's position, after we are done
5882 with the overlay strings. (The corresponding call to pop_it
5883 in case of an empty display string is in
5884 next_overlay_string.) */
5885 if (!(!it->bidi_p
5886 && STRINGP (it->string) && !SCHARS (it->string)))
5887 push_it (it, NULL);
5888
5889 /* Set up IT to deliver display elements from the first overlay
5890 string. */
5891 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5892 it->string = it->overlay_strings[0];
5893 it->from_overlay = Qnil;
5894 it->stop_charpos = 0;
5895 eassert (STRINGP (it->string));
5896 it->end_charpos = SCHARS (it->string);
5897 it->prev_stop = 0;
5898 it->base_level_stop = 0;
5899 it->multibyte_p = STRING_MULTIBYTE (it->string);
5900 it->method = GET_FROM_STRING;
5901 it->from_disp_prop_p = 0;
5902
5903 /* Force paragraph direction to be that of the parent
5904 buffer. */
5905 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5906 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5907 else
5908 it->paragraph_embedding = L2R;
5909
5910 /* Set up the bidi iterator for this overlay string. */
5911 if (it->bidi_p)
5912 {
5913 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5914
5915 it->bidi_it.string.lstring = it->string;
5916 it->bidi_it.string.s = NULL;
5917 it->bidi_it.string.schars = SCHARS (it->string);
5918 it->bidi_it.string.bufpos = pos;
5919 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5920 it->bidi_it.string.unibyte = !it->multibyte_p;
5921 it->bidi_it.w = it->w;
5922 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5923 }
5924 return true;
5925 }
5926
5927 it->current.overlay_string_index = -1;
5928 return false;
5929 }
5930
5931 static bool
5932 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5933 {
5934 it->string = Qnil;
5935 it->method = GET_FROM_BUFFER;
5936
5937 get_overlay_strings_1 (it, charpos, true);
5938
5939 CHECK_IT (it);
5940
5941 /* Value is true if we found at least one overlay string. */
5942 return STRINGP (it->string);
5943 }
5944
5945
5946 \f
5947 /***********************************************************************
5948 Saving and restoring state
5949 ***********************************************************************/
5950
5951 /* Save current settings of IT on IT->stack. Called, for example,
5952 before setting up IT for an overlay string, to be able to restore
5953 IT's settings to what they were after the overlay string has been
5954 processed. If POSITION is non-NULL, it is the position to save on
5955 the stack instead of IT->position. */
5956
5957 static void
5958 push_it (struct it *it, struct text_pos *position)
5959 {
5960 struct iterator_stack_entry *p;
5961
5962 eassert (it->sp < IT_STACK_SIZE);
5963 p = it->stack + it->sp;
5964
5965 p->stop_charpos = it->stop_charpos;
5966 p->prev_stop = it->prev_stop;
5967 p->base_level_stop = it->base_level_stop;
5968 p->cmp_it = it->cmp_it;
5969 eassert (it->face_id >= 0);
5970 p->face_id = it->face_id;
5971 p->string = it->string;
5972 p->method = it->method;
5973 p->from_overlay = it->from_overlay;
5974 switch (p->method)
5975 {
5976 case GET_FROM_IMAGE:
5977 p->u.image.object = it->object;
5978 p->u.image.image_id = it->image_id;
5979 p->u.image.slice = it->slice;
5980 break;
5981 case GET_FROM_STRETCH:
5982 p->u.stretch.object = it->object;
5983 break;
5984 case GET_FROM_XWIDGET:
5985 p->u.xwidget.object = it->object;
5986 break;
5987 case GET_FROM_BUFFER:
5988 case GET_FROM_DISPLAY_VECTOR:
5989 case GET_FROM_STRING:
5990 case GET_FROM_C_STRING:
5991 break;
5992 default:
5993 emacs_abort ();
5994 }
5995 p->position = position ? *position : it->position;
5996 p->current = it->current;
5997 p->end_charpos = it->end_charpos;
5998 p->string_nchars = it->string_nchars;
5999 p->area = it->area;
6000 p->multibyte_p = it->multibyte_p;
6001 p->avoid_cursor_p = it->avoid_cursor_p;
6002 p->space_width = it->space_width;
6003 p->font_height = it->font_height;
6004 p->voffset = it->voffset;
6005 p->string_from_display_prop_p = it->string_from_display_prop_p;
6006 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
6007 p->display_ellipsis_p = false;
6008 p->line_wrap = it->line_wrap;
6009 p->bidi_p = it->bidi_p;
6010 p->paragraph_embedding = it->paragraph_embedding;
6011 p->from_disp_prop_p = it->from_disp_prop_p;
6012 ++it->sp;
6013
6014 /* Save the state of the bidi iterator as well. */
6015 if (it->bidi_p)
6016 bidi_push_it (&it->bidi_it);
6017 }
6018
6019 static void
6020 iterate_out_of_display_property (struct it *it)
6021 {
6022 bool buffer_p = !STRINGP (it->string);
6023 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
6024 ptrdiff_t bob = (buffer_p ? BEGV : 0);
6025
6026 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
6027
6028 /* Maybe initialize paragraph direction. If we are at the beginning
6029 of a new paragraph, next_element_from_buffer may not have a
6030 chance to do that. */
6031 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
6032 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
6033 /* prev_stop can be zero, so check against BEGV as well. */
6034 while (it->bidi_it.charpos >= bob
6035 && it->prev_stop <= it->bidi_it.charpos
6036 && it->bidi_it.charpos < CHARPOS (it->position)
6037 && it->bidi_it.charpos < eob)
6038 bidi_move_to_visually_next (&it->bidi_it);
6039 /* Record the stop_pos we just crossed, for when we cross it
6040 back, maybe. */
6041 if (it->bidi_it.charpos > CHARPOS (it->position))
6042 it->prev_stop = CHARPOS (it->position);
6043 /* If we ended up not where pop_it put us, resync IT's
6044 positional members with the bidi iterator. */
6045 if (it->bidi_it.charpos != CHARPOS (it->position))
6046 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
6047 if (buffer_p)
6048 it->current.pos = it->position;
6049 else
6050 it->current.string_pos = it->position;
6051 }
6052
6053 /* Restore IT's settings from IT->stack. Called, for example, when no
6054 more overlay strings must be processed, and we return to delivering
6055 display elements from a buffer, or when the end of a string from a
6056 `display' property is reached and we return to delivering display
6057 elements from an overlay string, or from a buffer. */
6058
6059 static void
6060 pop_it (struct it *it)
6061 {
6062 struct iterator_stack_entry *p;
6063 bool from_display_prop = it->from_disp_prop_p;
6064 ptrdiff_t prev_pos = IT_CHARPOS (*it);
6065
6066 eassert (it->sp > 0);
6067 --it->sp;
6068 p = it->stack + it->sp;
6069 it->stop_charpos = p->stop_charpos;
6070 it->prev_stop = p->prev_stop;
6071 it->base_level_stop = p->base_level_stop;
6072 it->cmp_it = p->cmp_it;
6073 it->face_id = p->face_id;
6074 it->current = p->current;
6075 it->position = p->position;
6076 it->string = p->string;
6077 it->from_overlay = p->from_overlay;
6078 if (NILP (it->string))
6079 SET_TEXT_POS (it->current.string_pos, -1, -1);
6080 it->method = p->method;
6081 switch (it->method)
6082 {
6083 case GET_FROM_IMAGE:
6084 it->image_id = p->u.image.image_id;
6085 it->object = p->u.image.object;
6086 it->slice = p->u.image.slice;
6087 break;
6088 case GET_FROM_XWIDGET:
6089 it->object = p->u.xwidget.object;
6090 break;
6091 case GET_FROM_STRETCH:
6092 it->object = p->u.stretch.object;
6093 break;
6094 case GET_FROM_BUFFER:
6095 it->object = it->w->contents;
6096 break;
6097 case GET_FROM_STRING:
6098 {
6099 struct face *face = FACE_FROM_ID_OR_NULL (it->f, it->face_id);
6100
6101 /* Restore the face_box_p flag, since it could have been
6102 overwritten by the face of the object that we just finished
6103 displaying. */
6104 if (face)
6105 it->face_box_p = face->box != FACE_NO_BOX;
6106 it->object = it->string;
6107 }
6108 break;
6109 case GET_FROM_DISPLAY_VECTOR:
6110 if (it->s)
6111 it->method = GET_FROM_C_STRING;
6112 else if (STRINGP (it->string))
6113 it->method = GET_FROM_STRING;
6114 else
6115 {
6116 it->method = GET_FROM_BUFFER;
6117 it->object = it->w->contents;
6118 }
6119 break;
6120 case GET_FROM_C_STRING:
6121 break;
6122 default:
6123 emacs_abort ();
6124 }
6125 it->end_charpos = p->end_charpos;
6126 it->string_nchars = p->string_nchars;
6127 it->area = p->area;
6128 it->multibyte_p = p->multibyte_p;
6129 it->avoid_cursor_p = p->avoid_cursor_p;
6130 it->space_width = p->space_width;
6131 it->font_height = p->font_height;
6132 it->voffset = p->voffset;
6133 it->string_from_display_prop_p = p->string_from_display_prop_p;
6134 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
6135 it->line_wrap = p->line_wrap;
6136 it->bidi_p = p->bidi_p;
6137 it->paragraph_embedding = p->paragraph_embedding;
6138 it->from_disp_prop_p = p->from_disp_prop_p;
6139 if (it->bidi_p)
6140 {
6141 bidi_pop_it (&it->bidi_it);
6142 /* Bidi-iterate until we get out of the portion of text, if any,
6143 covered by a `display' text property or by an overlay with
6144 `display' property. (We cannot just jump there, because the
6145 internal coherency of the bidi iterator state can not be
6146 preserved across such jumps.) We also must determine the
6147 paragraph base direction if the overlay we just processed is
6148 at the beginning of a new paragraph. */
6149 if (from_display_prop
6150 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
6151 iterate_out_of_display_property (it);
6152
6153 eassert ((BUFFERP (it->object)
6154 && IT_CHARPOS (*it) == it->bidi_it.charpos
6155 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
6156 || (STRINGP (it->object)
6157 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
6158 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
6159 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
6160 }
6161 /* If we move the iterator over text covered by a display property
6162 to a new buffer position, any info about previously seen overlays
6163 is no longer valid. */
6164 if (from_display_prop && it->sp == 0 && CHARPOS (it->position) != prev_pos)
6165 it->ignore_overlay_strings_at_pos_p = false;
6166 }
6167
6168
6169 \f
6170 /***********************************************************************
6171 Moving over lines
6172 ***********************************************************************/
6173
6174 /* Set IT's current position to the previous line start. */
6175
6176 static void
6177 back_to_previous_line_start (struct it *it)
6178 {
6179 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
6180
6181 DEC_BOTH (cp, bp);
6182 IT_CHARPOS (*it) = find_newline_no_quit (cp, bp, -1, &IT_BYTEPOS (*it));
6183 }
6184
6185
6186 /* Move IT to the next line start.
6187
6188 Value is true if a newline was found. Set *SKIPPED_P to true if
6189 we skipped over part of the text (as opposed to moving the iterator
6190 continuously over the text). Otherwise, don't change the value
6191 of *SKIPPED_P.
6192
6193 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6194 iterator on the newline, if it was found.
6195
6196 Newlines may come from buffer text, overlay strings, or strings
6197 displayed via the `display' property. That's the reason we can't
6198 simply use find_newline_no_quit.
6199
6200 Note that this function may not skip over invisible text that is so
6201 because of text properties and immediately follows a newline. If
6202 it would, function reseat_at_next_visible_line_start, when called
6203 from set_iterator_to_next, would effectively make invisible
6204 characters following a newline part of the wrong glyph row, which
6205 leads to wrong cursor motion. */
6206
6207 static bool
6208 forward_to_next_line_start (struct it *it, bool *skipped_p,
6209 struct bidi_it *bidi_it_prev)
6210 {
6211 ptrdiff_t old_selective;
6212 bool newline_found_p = false;
6213 int n;
6214 const int MAX_NEWLINE_DISTANCE = 500;
6215
6216 /* If already on a newline, just consume it to avoid unintended
6217 skipping over invisible text below. */
6218 if (it->what == IT_CHARACTER
6219 && it->c == '\n'
6220 && CHARPOS (it->position) == IT_CHARPOS (*it))
6221 {
6222 if (it->bidi_p && bidi_it_prev)
6223 *bidi_it_prev = it->bidi_it;
6224 set_iterator_to_next (it, false);
6225 it->c = 0;
6226 return true;
6227 }
6228
6229 /* Don't handle selective display in the following. It's (a)
6230 unnecessary because it's done by the caller, and (b) leads to an
6231 infinite recursion because next_element_from_ellipsis indirectly
6232 calls this function. */
6233 old_selective = it->selective;
6234 it->selective = 0;
6235
6236 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6237 from buffer text. */
6238 for (n = 0;
6239 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
6240 n += !STRINGP (it->string))
6241 {
6242 if (!get_next_display_element (it))
6243 return false;
6244 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
6245 if (newline_found_p && it->bidi_p && bidi_it_prev)
6246 *bidi_it_prev = it->bidi_it;
6247 set_iterator_to_next (it, false);
6248 }
6249
6250 /* If we didn't find a newline near enough, see if we can use a
6251 short-cut. */
6252 if (!newline_found_p)
6253 {
6254 ptrdiff_t bytepos, start = IT_CHARPOS (*it);
6255 ptrdiff_t limit = find_newline_no_quit (start, IT_BYTEPOS (*it),
6256 1, &bytepos);
6257 Lisp_Object pos;
6258
6259 eassert (!STRINGP (it->string));
6260
6261 /* If there isn't any `display' property in sight, and no
6262 overlays, we can just use the position of the newline in
6263 buffer text. */
6264 if (it->stop_charpos >= limit
6265 || ((pos = Fnext_single_property_change (make_number (start),
6266 Qdisplay, Qnil,
6267 make_number (limit)),
6268 NILP (pos))
6269 && next_overlay_change (start) == ZV))
6270 {
6271 if (!it->bidi_p)
6272 {
6273 IT_CHARPOS (*it) = limit;
6274 IT_BYTEPOS (*it) = bytepos;
6275 }
6276 else
6277 {
6278 struct bidi_it bprev;
6279
6280 /* Help bidi.c avoid expensive searches for display
6281 properties and overlays, by telling it that there are
6282 none up to `limit'. */
6283 if (it->bidi_it.disp_pos < limit)
6284 {
6285 it->bidi_it.disp_pos = limit;
6286 it->bidi_it.disp_prop = 0;
6287 }
6288 do {
6289 bprev = it->bidi_it;
6290 bidi_move_to_visually_next (&it->bidi_it);
6291 } while (it->bidi_it.charpos != limit);
6292 IT_CHARPOS (*it) = limit;
6293 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6294 if (bidi_it_prev)
6295 *bidi_it_prev = bprev;
6296 }
6297 *skipped_p = newline_found_p = true;
6298 }
6299 else
6300 {
6301 while (get_next_display_element (it)
6302 && !newline_found_p)
6303 {
6304 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6305 if (newline_found_p && it->bidi_p && bidi_it_prev)
6306 *bidi_it_prev = it->bidi_it;
6307 set_iterator_to_next (it, false);
6308 }
6309 }
6310 }
6311
6312 it->selective = old_selective;
6313 return newline_found_p;
6314 }
6315
6316
6317 /* Set IT's current position to the previous visible line start. Skip
6318 invisible text that is so either due to text properties or due to
6319 selective display. Caution: this does not change IT->current_x and
6320 IT->hpos. */
6321
6322 static void
6323 back_to_previous_visible_line_start (struct it *it)
6324 {
6325 while (IT_CHARPOS (*it) > BEGV)
6326 {
6327 back_to_previous_line_start (it);
6328
6329 if (IT_CHARPOS (*it) <= BEGV)
6330 break;
6331
6332 /* If selective > 0, then lines indented more than its value are
6333 invisible. */
6334 if (it->selective > 0
6335 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6336 it->selective))
6337 continue;
6338
6339 /* Check the newline before point for invisibility. */
6340 {
6341 Lisp_Object prop;
6342 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6343 Qinvisible, it->window);
6344 if (TEXT_PROP_MEANS_INVISIBLE (prop) != 0)
6345 continue;
6346 }
6347
6348 if (IT_CHARPOS (*it) <= BEGV)
6349 break;
6350
6351 {
6352 struct it it2;
6353 void *it2data = NULL;
6354 ptrdiff_t pos;
6355 ptrdiff_t beg, end;
6356 Lisp_Object val, overlay;
6357
6358 SAVE_IT (it2, *it, it2data);
6359
6360 /* If newline is part of a composition, continue from start of composition */
6361 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6362 && beg < IT_CHARPOS (*it))
6363 goto replaced;
6364
6365 /* If newline is replaced by a display property, find start of overlay
6366 or interval and continue search from that point. */
6367 pos = --IT_CHARPOS (it2);
6368 --IT_BYTEPOS (it2);
6369 it2.sp = 0;
6370 bidi_unshelve_cache (NULL, false);
6371 it2.string_from_display_prop_p = false;
6372 it2.from_disp_prop_p = false;
6373 if (handle_display_prop (&it2) == HANDLED_RETURN
6374 && !NILP (val = get_char_property_and_overlay
6375 (make_number (pos), Qdisplay, Qnil, &overlay))
6376 && (OVERLAYP (overlay)
6377 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6378 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6379 {
6380 RESTORE_IT (it, it, it2data);
6381 goto replaced;
6382 }
6383
6384 /* Newline is not replaced by anything -- so we are done. */
6385 RESTORE_IT (it, it, it2data);
6386 break;
6387
6388 replaced:
6389 if (beg < BEGV)
6390 beg = BEGV;
6391 IT_CHARPOS (*it) = beg;
6392 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6393 }
6394 }
6395
6396 it->continuation_lines_width = 0;
6397
6398 eassert (IT_CHARPOS (*it) >= BEGV);
6399 eassert (IT_CHARPOS (*it) == BEGV
6400 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6401 CHECK_IT (it);
6402 }
6403
6404
6405 /* Reseat iterator IT at the previous visible line start. Skip
6406 invisible text that is so either due to text properties or due to
6407 selective display. At the end, update IT's overlay information,
6408 face information etc. */
6409
6410 void
6411 reseat_at_previous_visible_line_start (struct it *it)
6412 {
6413 back_to_previous_visible_line_start (it);
6414 reseat (it, it->current.pos, true);
6415 CHECK_IT (it);
6416 }
6417
6418
6419 /* Reseat iterator IT on the next visible line start in the current
6420 buffer. ON_NEWLINE_P means position IT on the newline
6421 preceding the line start. Skip over invisible text that is so
6422 because of selective display. Compute faces, overlays etc at the
6423 new position. Note that this function does not skip over text that
6424 is invisible because of text properties. */
6425
6426 static void
6427 reseat_at_next_visible_line_start (struct it *it, bool on_newline_p)
6428 {
6429 bool skipped_p = false;
6430 struct bidi_it bidi_it_prev;
6431 bool newline_found_p
6432 = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6433
6434 /* Skip over lines that are invisible because they are indented
6435 more than the value of IT->selective. */
6436 if (it->selective > 0)
6437 while (IT_CHARPOS (*it) < ZV
6438 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6439 it->selective))
6440 {
6441 eassert (IT_BYTEPOS (*it) == BEGV
6442 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6443 newline_found_p =
6444 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6445 }
6446
6447 /* Position on the newline if that's what's requested. */
6448 if (on_newline_p && newline_found_p)
6449 {
6450 if (STRINGP (it->string))
6451 {
6452 if (IT_STRING_CHARPOS (*it) > 0)
6453 {
6454 if (!it->bidi_p)
6455 {
6456 --IT_STRING_CHARPOS (*it);
6457 --IT_STRING_BYTEPOS (*it);
6458 }
6459 else
6460 {
6461 /* We need to restore the bidi iterator to the state
6462 it had on the newline, and resync the IT's
6463 position with that. */
6464 it->bidi_it = bidi_it_prev;
6465 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6466 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6467 }
6468 }
6469 }
6470 else if (IT_CHARPOS (*it) > BEGV)
6471 {
6472 if (!it->bidi_p)
6473 {
6474 --IT_CHARPOS (*it);
6475 --IT_BYTEPOS (*it);
6476 }
6477 else
6478 {
6479 /* We need to restore the bidi iterator to the state it
6480 had on the newline and resync IT with that. */
6481 it->bidi_it = bidi_it_prev;
6482 IT_CHARPOS (*it) = it->bidi_it.charpos;
6483 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6484 }
6485 reseat (it, it->current.pos, false);
6486 }
6487 }
6488 else if (skipped_p)
6489 reseat (it, it->current.pos, false);
6490
6491 CHECK_IT (it);
6492 }
6493
6494
6495 \f
6496 /***********************************************************************
6497 Changing an iterator's position
6498 ***********************************************************************/
6499
6500 /* Change IT's current position to POS in current_buffer.
6501 If FORCE_P, always check for text properties at the new position.
6502 Otherwise, text properties are only looked up if POS >=
6503 IT->check_charpos of a property. */
6504
6505 static void
6506 reseat (struct it *it, struct text_pos pos, bool force_p)
6507 {
6508 ptrdiff_t original_pos = IT_CHARPOS (*it);
6509
6510 reseat_1 (it, pos, false);
6511
6512 /* Determine where to check text properties. Avoid doing it
6513 where possible because text property lookup is very expensive. */
6514 if (force_p
6515 || CHARPOS (pos) > it->stop_charpos
6516 || CHARPOS (pos) < original_pos)
6517 {
6518 if (it->bidi_p)
6519 {
6520 /* For bidi iteration, we need to prime prev_stop and
6521 base_level_stop with our best estimations. */
6522 /* Implementation note: Of course, POS is not necessarily a
6523 stop position, so assigning prev_pos to it is a lie; we
6524 should have called compute_stop_backwards. However, if
6525 the current buffer does not include any R2L characters,
6526 that call would be a waste of cycles, because the
6527 iterator will never move back, and thus never cross this
6528 "fake" stop position. So we delay that backward search
6529 until the time we really need it, in next_element_from_buffer. */
6530 if (CHARPOS (pos) != it->prev_stop)
6531 it->prev_stop = CHARPOS (pos);
6532 if (CHARPOS (pos) < it->base_level_stop)
6533 it->base_level_stop = 0; /* meaning it's unknown */
6534 handle_stop (it);
6535 }
6536 else
6537 {
6538 handle_stop (it);
6539 it->prev_stop = it->base_level_stop = 0;
6540 }
6541
6542 }
6543
6544 CHECK_IT (it);
6545 }
6546
6547
6548 /* Change IT's buffer position to POS. SET_STOP_P means set
6549 IT->stop_pos to POS, also. */
6550
6551 static void
6552 reseat_1 (struct it *it, struct text_pos pos, bool set_stop_p)
6553 {
6554 /* Don't call this function when scanning a C string. */
6555 eassert (it->s == NULL);
6556
6557 /* POS must be a reasonable value. */
6558 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6559
6560 it->current.pos = it->position = pos;
6561 it->end_charpos = ZV;
6562 it->dpvec = NULL;
6563 it->current.dpvec_index = -1;
6564 it->current.overlay_string_index = -1;
6565 IT_STRING_CHARPOS (*it) = -1;
6566 IT_STRING_BYTEPOS (*it) = -1;
6567 it->string = Qnil;
6568 it->method = GET_FROM_BUFFER;
6569 it->object = it->w->contents;
6570 it->area = TEXT_AREA;
6571 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6572 it->sp = 0;
6573 it->string_from_display_prop_p = false;
6574 it->string_from_prefix_prop_p = false;
6575
6576 it->from_disp_prop_p = false;
6577 it->face_before_selective_p = false;
6578 if (it->bidi_p)
6579 {
6580 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6581 &it->bidi_it);
6582 bidi_unshelve_cache (NULL, false);
6583 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6584 it->bidi_it.string.s = NULL;
6585 it->bidi_it.string.lstring = Qnil;
6586 it->bidi_it.string.bufpos = 0;
6587 it->bidi_it.string.from_disp_str = false;
6588 it->bidi_it.string.unibyte = false;
6589 it->bidi_it.w = it->w;
6590 }
6591
6592 if (set_stop_p)
6593 {
6594 it->stop_charpos = CHARPOS (pos);
6595 it->base_level_stop = CHARPOS (pos);
6596 }
6597 /* This make the information stored in it->cmp_it invalidate. */
6598 it->cmp_it.id = -1;
6599 }
6600
6601
6602 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6603 If S is non-null, it is a C string to iterate over. Otherwise,
6604 STRING gives a Lisp string to iterate over.
6605
6606 If PRECISION > 0, don't return more then PRECISION number of
6607 characters from the string.
6608
6609 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6610 characters have been returned. FIELD_WIDTH < 0 means an infinite
6611 field width.
6612
6613 MULTIBYTE = 0 means disable processing of multibyte characters,
6614 MULTIBYTE > 0 means enable it,
6615 MULTIBYTE < 0 means use IT->multibyte_p.
6616
6617 IT must be initialized via a prior call to init_iterator before
6618 calling this function. */
6619
6620 static void
6621 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6622 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6623 int multibyte)
6624 {
6625 /* No text property checks performed by default, but see below. */
6626 it->stop_charpos = -1;
6627
6628 /* Set iterator position and end position. */
6629 memset (&it->current, 0, sizeof it->current);
6630 it->current.overlay_string_index = -1;
6631 it->current.dpvec_index = -1;
6632 eassert (charpos >= 0);
6633
6634 /* If STRING is specified, use its multibyteness, otherwise use the
6635 setting of MULTIBYTE, if specified. */
6636 if (multibyte >= 0)
6637 it->multibyte_p = multibyte > 0;
6638
6639 /* Bidirectional reordering of strings is controlled by the default
6640 value of bidi-display-reordering. Don't try to reorder while
6641 loading loadup.el, as the necessary character property tables are
6642 not yet available. */
6643 it->bidi_p =
6644 !redisplay__inhibit_bidi
6645 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6646
6647 if (s == NULL)
6648 {
6649 eassert (STRINGP (string));
6650 it->string = string;
6651 it->s = NULL;
6652 it->end_charpos = it->string_nchars = SCHARS (string);
6653 it->method = GET_FROM_STRING;
6654 it->current.string_pos = string_pos (charpos, string);
6655
6656 if (it->bidi_p)
6657 {
6658 it->bidi_it.string.lstring = string;
6659 it->bidi_it.string.s = NULL;
6660 it->bidi_it.string.schars = it->end_charpos;
6661 it->bidi_it.string.bufpos = 0;
6662 it->bidi_it.string.from_disp_str = false;
6663 it->bidi_it.string.unibyte = !it->multibyte_p;
6664 it->bidi_it.w = it->w;
6665 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6666 FRAME_WINDOW_P (it->f), &it->bidi_it);
6667 }
6668 }
6669 else
6670 {
6671 it->s = (const unsigned char *) s;
6672 it->string = Qnil;
6673
6674 /* Note that we use IT->current.pos, not it->current.string_pos,
6675 for displaying C strings. */
6676 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6677 if (it->multibyte_p)
6678 {
6679 it->current.pos = c_string_pos (charpos, s, true);
6680 it->end_charpos = it->string_nchars = number_of_chars (s, true);
6681 }
6682 else
6683 {
6684 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6685 it->end_charpos = it->string_nchars = strlen (s);
6686 }
6687
6688 if (it->bidi_p)
6689 {
6690 it->bidi_it.string.lstring = Qnil;
6691 it->bidi_it.string.s = (const unsigned char *) s;
6692 it->bidi_it.string.schars = it->end_charpos;
6693 it->bidi_it.string.bufpos = 0;
6694 it->bidi_it.string.from_disp_str = false;
6695 it->bidi_it.string.unibyte = !it->multibyte_p;
6696 it->bidi_it.w = it->w;
6697 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6698 &it->bidi_it);
6699 }
6700 it->method = GET_FROM_C_STRING;
6701 }
6702
6703 /* PRECISION > 0 means don't return more than PRECISION characters
6704 from the string. */
6705 if (precision > 0 && it->end_charpos - charpos > precision)
6706 {
6707 it->end_charpos = it->string_nchars = charpos + precision;
6708 if (it->bidi_p)
6709 it->bidi_it.string.schars = it->end_charpos;
6710 }
6711
6712 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6713 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6714 FIELD_WIDTH < 0 means infinite field width. This is useful for
6715 padding with `-' at the end of a mode line. */
6716 if (field_width < 0)
6717 field_width = INFINITY;
6718 /* Implementation note: We deliberately don't enlarge
6719 it->bidi_it.string.schars here to fit it->end_charpos, because
6720 the bidi iterator cannot produce characters out of thin air. */
6721 if (field_width > it->end_charpos - charpos)
6722 it->end_charpos = charpos + field_width;
6723
6724 /* Use the standard display table for displaying strings. */
6725 if (DISP_TABLE_P (Vstandard_display_table))
6726 it->dp = XCHAR_TABLE (Vstandard_display_table);
6727
6728 it->stop_charpos = charpos;
6729 it->prev_stop = charpos;
6730 it->base_level_stop = 0;
6731 if (it->bidi_p)
6732 {
6733 it->bidi_it.first_elt = true;
6734 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6735 it->bidi_it.disp_pos = -1;
6736 }
6737 if (s == NULL && it->multibyte_p)
6738 {
6739 ptrdiff_t endpos = SCHARS (it->string);
6740 if (endpos > it->end_charpos)
6741 endpos = it->end_charpos;
6742 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6743 it->string);
6744 }
6745 CHECK_IT (it);
6746 }
6747
6748
6749 \f
6750 /***********************************************************************
6751 Iteration
6752 ***********************************************************************/
6753
6754 /* Map enum it_method value to corresponding next_element_from_* function. */
6755
6756 typedef bool (*next_element_function) (struct it *);
6757
6758 static next_element_function const get_next_element[NUM_IT_METHODS] =
6759 {
6760 next_element_from_buffer,
6761 next_element_from_display_vector,
6762 next_element_from_string,
6763 next_element_from_c_string,
6764 next_element_from_image,
6765 next_element_from_stretch,
6766 next_element_from_xwidget,
6767 };
6768
6769 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6770
6771
6772 /* Return true iff a character at CHARPOS (and BYTEPOS) is composed
6773 (possibly with the following characters). */
6774
6775 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6776 ((IT)->cmp_it.id >= 0 \
6777 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6778 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6779 END_CHARPOS, (IT)->w, \
6780 FACE_FROM_ID_OR_NULL ((IT)->f, \
6781 (IT)->face_id), \
6782 (IT)->string)))
6783
6784
6785 /* Lookup the char-table Vglyphless_char_display for character C (-1
6786 if we want information for no-font case), and return the display
6787 method symbol. By side-effect, update it->what and
6788 it->glyphless_method. This function is called from
6789 get_next_display_element for each character element, and from
6790 x_produce_glyphs when no suitable font was found. */
6791
6792 Lisp_Object
6793 lookup_glyphless_char_display (int c, struct it *it)
6794 {
6795 Lisp_Object glyphless_method = Qnil;
6796
6797 if (CHAR_TABLE_P (Vglyphless_char_display)
6798 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6799 {
6800 if (c >= 0)
6801 {
6802 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6803 if (CONSP (glyphless_method))
6804 glyphless_method = FRAME_WINDOW_P (it->f)
6805 ? XCAR (glyphless_method)
6806 : XCDR (glyphless_method);
6807 }
6808 else
6809 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6810 }
6811
6812 retry:
6813 if (NILP (glyphless_method))
6814 {
6815 if (c >= 0)
6816 /* The default is to display the character by a proper font. */
6817 return Qnil;
6818 /* The default for the no-font case is to display an empty box. */
6819 glyphless_method = Qempty_box;
6820 }
6821 if (EQ (glyphless_method, Qzero_width))
6822 {
6823 if (c >= 0)
6824 return glyphless_method;
6825 /* This method can't be used for the no-font case. */
6826 glyphless_method = Qempty_box;
6827 }
6828 if (EQ (glyphless_method, Qthin_space))
6829 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6830 else if (EQ (glyphless_method, Qempty_box))
6831 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6832 else if (EQ (glyphless_method, Qhex_code))
6833 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6834 else if (STRINGP (glyphless_method))
6835 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6836 else
6837 {
6838 /* Invalid value. We use the default method. */
6839 glyphless_method = Qnil;
6840 goto retry;
6841 }
6842 it->what = IT_GLYPHLESS;
6843 return glyphless_method;
6844 }
6845
6846 /* Merge escape glyph face and cache the result. */
6847
6848 static struct frame *last_escape_glyph_frame = NULL;
6849 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6850 static int last_escape_glyph_merged_face_id = 0;
6851
6852 static int
6853 merge_escape_glyph_face (struct it *it)
6854 {
6855 int face_id;
6856
6857 if (it->f == last_escape_glyph_frame
6858 && it->face_id == last_escape_glyph_face_id)
6859 face_id = last_escape_glyph_merged_face_id;
6860 else
6861 {
6862 /* Merge the `escape-glyph' face into the current face. */
6863 face_id = merge_faces (it->f, Qescape_glyph, 0, it->face_id);
6864 last_escape_glyph_frame = it->f;
6865 last_escape_glyph_face_id = it->face_id;
6866 last_escape_glyph_merged_face_id = face_id;
6867 }
6868 return face_id;
6869 }
6870
6871 /* Likewise for glyphless glyph face. */
6872
6873 static struct frame *last_glyphless_glyph_frame = NULL;
6874 static int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6875 static int last_glyphless_glyph_merged_face_id = 0;
6876
6877 int
6878 merge_glyphless_glyph_face (struct it *it)
6879 {
6880 int face_id;
6881
6882 if (it->f == last_glyphless_glyph_frame
6883 && it->face_id == last_glyphless_glyph_face_id)
6884 face_id = last_glyphless_glyph_merged_face_id;
6885 else
6886 {
6887 /* Merge the `glyphless-char' face into the current face. */
6888 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
6889 last_glyphless_glyph_frame = it->f;
6890 last_glyphless_glyph_face_id = it->face_id;
6891 last_glyphless_glyph_merged_face_id = face_id;
6892 }
6893 return face_id;
6894 }
6895
6896 /* Forget the `escape-glyph' and `glyphless-char' faces. This should
6897 be called before redisplaying windows, and when the frame's face
6898 cache is freed. */
6899 void
6900 forget_escape_and_glyphless_faces (void)
6901 {
6902 last_escape_glyph_frame = NULL;
6903 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6904 last_glyphless_glyph_frame = NULL;
6905 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6906 }
6907
6908 /* Load IT's display element fields with information about the next
6909 display element from the current position of IT. Value is false if
6910 end of buffer (or C string) is reached. */
6911
6912 static bool
6913 get_next_display_element (struct it *it)
6914 {
6915 /* True means that we found a display element. False means that
6916 we hit the end of what we iterate over. Performance note: the
6917 function pointer `method' used here turns out to be faster than
6918 using a sequence of if-statements. */
6919 bool success_p;
6920
6921 get_next:
6922 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6923
6924 if (it->what == IT_CHARACTER)
6925 {
6926 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6927 and only if (a) the resolved directionality of that character
6928 is R..." */
6929 /* FIXME: Do we need an exception for characters from display
6930 tables? */
6931 if (it->bidi_p && it->bidi_it.type == STRONG_R
6932 && !inhibit_bidi_mirroring)
6933 it->c = bidi_mirror_char (it->c);
6934 /* Map via display table or translate control characters.
6935 IT->c, IT->len etc. have been set to the next character by
6936 the function call above. If we have a display table, and it
6937 contains an entry for IT->c, translate it. Don't do this if
6938 IT->c itself comes from a display table, otherwise we could
6939 end up in an infinite recursion. (An alternative could be to
6940 count the recursion depth of this function and signal an
6941 error when a certain maximum depth is reached.) Is it worth
6942 it? */
6943 if (success_p && it->dpvec == NULL)
6944 {
6945 Lisp_Object dv;
6946 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6947 bool nonascii_space_p = false;
6948 bool nonascii_hyphen_p = false;
6949 int c = it->c; /* This is the character to display. */
6950
6951 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6952 {
6953 eassert (SINGLE_BYTE_CHAR_P (c));
6954 if (unibyte_display_via_language_environment)
6955 {
6956 c = DECODE_CHAR (unibyte, c);
6957 if (c < 0)
6958 c = BYTE8_TO_CHAR (it->c);
6959 }
6960 else
6961 c = BYTE8_TO_CHAR (it->c);
6962 }
6963
6964 if (it->dp
6965 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6966 VECTORP (dv)))
6967 {
6968 struct Lisp_Vector *v = XVECTOR (dv);
6969
6970 /* Return the first character from the display table
6971 entry, if not empty. If empty, don't display the
6972 current character. */
6973 if (v->header.size)
6974 {
6975 it->dpvec_char_len = it->len;
6976 it->dpvec = v->contents;
6977 it->dpend = v->contents + v->header.size;
6978 it->current.dpvec_index = 0;
6979 it->dpvec_face_id = -1;
6980 it->saved_face_id = it->face_id;
6981 it->method = GET_FROM_DISPLAY_VECTOR;
6982 it->ellipsis_p = false;
6983 }
6984 else
6985 {
6986 set_iterator_to_next (it, false);
6987 }
6988 goto get_next;
6989 }
6990
6991 if (! NILP (lookup_glyphless_char_display (c, it)))
6992 {
6993 if (it->what == IT_GLYPHLESS)
6994 goto done;
6995 /* Don't display this character. */
6996 set_iterator_to_next (it, false);
6997 goto get_next;
6998 }
6999
7000 /* If `nobreak-char-display' is non-nil, we display
7001 non-ASCII spaces and hyphens specially. */
7002 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
7003 {
7004 if (c == NO_BREAK_SPACE)
7005 nonascii_space_p = true;
7006 else if (c == SOFT_HYPHEN || c == HYPHEN
7007 || c == NON_BREAKING_HYPHEN)
7008 nonascii_hyphen_p = true;
7009 }
7010
7011 /* Translate control characters into `\003' or `^C' form.
7012 Control characters coming from a display table entry are
7013 currently not translated because we use IT->dpvec to hold
7014 the translation. This could easily be changed but I
7015 don't believe that it is worth doing.
7016
7017 The characters handled by `nobreak-char-display' must be
7018 translated too.
7019
7020 Non-printable characters and raw-byte characters are also
7021 translated to octal form. */
7022 if (((c < ' ' || c == 127) /* ASCII control chars. */
7023 ? (it->area != TEXT_AREA
7024 /* In mode line, treat \n, \t like other crl chars. */
7025 || (c != '\t'
7026 && it->glyph_row
7027 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
7028 || (c != '\n' && c != '\t'))
7029 : (nonascii_space_p
7030 || nonascii_hyphen_p
7031 || CHAR_BYTE8_P (c)
7032 || ! CHAR_PRINTABLE_P (c))))
7033 {
7034 /* C is a control character, non-ASCII space/hyphen,
7035 raw-byte, or a non-printable character which must be
7036 displayed either as '\003' or as `^C' where the '\\'
7037 and '^' can be defined in the display table. Fill
7038 IT->ctl_chars with glyphs for what we have to
7039 display. Then, set IT->dpvec to these glyphs. */
7040 Lisp_Object gc;
7041 int ctl_len;
7042 int face_id;
7043 int lface_id = 0;
7044 int escape_glyph;
7045
7046 /* Handle control characters with ^. */
7047
7048 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
7049 {
7050 int g;
7051
7052 g = '^'; /* default glyph for Control */
7053 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7054 if (it->dp
7055 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7056 {
7057 g = GLYPH_CODE_CHAR (gc);
7058 lface_id = GLYPH_CODE_FACE (gc);
7059 }
7060
7061 face_id = (lface_id
7062 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7063 : merge_escape_glyph_face (it));
7064
7065 XSETINT (it->ctl_chars[0], g);
7066 XSETINT (it->ctl_chars[1], c ^ 0100);
7067 ctl_len = 2;
7068 goto display_control;
7069 }
7070
7071 /* Handle non-ascii space in the mode where it only gets
7072 highlighting. */
7073
7074 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
7075 {
7076 /* Merge `nobreak-space' into the current face. */
7077 face_id = merge_faces (it->f, Qnobreak_space, 0,
7078 it->face_id);
7079 XSETINT (it->ctl_chars[0], ' ');
7080 ctl_len = 1;
7081 goto display_control;
7082 }
7083
7084 /* Handle non-ascii hyphens in the mode where it only
7085 gets highlighting. */
7086
7087 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
7088 {
7089 /* Merge `nobreak-space' into the current face. */
7090 face_id = merge_faces (it->f, Qnobreak_hyphen, 0,
7091 it->face_id);
7092 XSETINT (it->ctl_chars[0], '-');
7093 ctl_len = 1;
7094 goto display_control;
7095 }
7096
7097 /* Handle sequences that start with the "escape glyph". */
7098
7099 /* the default escape glyph is \. */
7100 escape_glyph = '\\';
7101
7102 if (it->dp
7103 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7104 {
7105 escape_glyph = GLYPH_CODE_CHAR (gc);
7106 lface_id = GLYPH_CODE_FACE (gc);
7107 }
7108
7109 face_id = (lface_id
7110 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7111 : merge_escape_glyph_face (it));
7112
7113 /* Draw non-ASCII space/hyphen with escape glyph: */
7114
7115 if (nonascii_space_p || nonascii_hyphen_p)
7116 {
7117 XSETINT (it->ctl_chars[0], escape_glyph);
7118 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
7119 ctl_len = 2;
7120 goto display_control;
7121 }
7122
7123 {
7124 char str[10];
7125 int len, i;
7126
7127 if (CHAR_BYTE8_P (c))
7128 /* Display \200 instead of \17777600. */
7129 c = CHAR_TO_BYTE8 (c);
7130 len = sprintf (str, "%03o", c + 0u);
7131
7132 XSETINT (it->ctl_chars[0], escape_glyph);
7133 for (i = 0; i < len; i++)
7134 XSETINT (it->ctl_chars[i + 1], str[i]);
7135 ctl_len = len + 1;
7136 }
7137
7138 display_control:
7139 /* Set up IT->dpvec and return first character from it. */
7140 it->dpvec_char_len = it->len;
7141 it->dpvec = it->ctl_chars;
7142 it->dpend = it->dpvec + ctl_len;
7143 it->current.dpvec_index = 0;
7144 it->dpvec_face_id = face_id;
7145 it->saved_face_id = it->face_id;
7146 it->method = GET_FROM_DISPLAY_VECTOR;
7147 it->ellipsis_p = false;
7148 goto get_next;
7149 }
7150 it->char_to_display = c;
7151 }
7152 else if (success_p)
7153 {
7154 it->char_to_display = it->c;
7155 }
7156 }
7157
7158 #ifdef HAVE_WINDOW_SYSTEM
7159 /* Adjust face id for a multibyte character. There are no multibyte
7160 character in unibyte text. */
7161 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
7162 && it->multibyte_p
7163 && success_p
7164 && FRAME_WINDOW_P (it->f))
7165 {
7166 struct face *face = FACE_FROM_ID (it->f, it->face_id);
7167
7168 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
7169 {
7170 /* Automatic composition with glyph-string. */
7171 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
7172
7173 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
7174 }
7175 else
7176 {
7177 ptrdiff_t pos = (it->s ? -1
7178 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
7179 : IT_CHARPOS (*it));
7180 int c;
7181
7182 if (it->what == IT_CHARACTER)
7183 c = it->char_to_display;
7184 else
7185 {
7186 struct composition *cmp = composition_table[it->cmp_it.id];
7187 int i;
7188
7189 c = ' ';
7190 for (i = 0; i < cmp->glyph_len; i++)
7191 /* TAB in a composition means display glyphs with
7192 padding space on the left or right. */
7193 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
7194 break;
7195 }
7196 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
7197 }
7198 }
7199 #endif /* HAVE_WINDOW_SYSTEM */
7200
7201 done:
7202 /* Is this character the last one of a run of characters with
7203 box? If yes, set IT->end_of_box_run_p to true. */
7204 if (it->face_box_p
7205 && it->s == NULL)
7206 {
7207 if (it->method == GET_FROM_STRING && it->sp)
7208 {
7209 int face_id = underlying_face_id (it);
7210 struct face *face = FACE_FROM_ID_OR_NULL (it->f, face_id);
7211
7212 if (face)
7213 {
7214 if (face->box == FACE_NO_BOX)
7215 {
7216 /* If the box comes from face properties in a
7217 display string, check faces in that string. */
7218 int string_face_id = face_after_it_pos (it);
7219 it->end_of_box_run_p
7220 = (FACE_FROM_ID (it->f, string_face_id)->box
7221 == FACE_NO_BOX);
7222 }
7223 /* Otherwise, the box comes from the underlying face.
7224 If this is the last string character displayed, check
7225 the next buffer location. */
7226 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
7227 /* n_overlay_strings is unreliable unless
7228 overlay_string_index is non-negative. */
7229 && ((it->current.overlay_string_index >= 0
7230 && (it->current.overlay_string_index
7231 == it->n_overlay_strings - 1))
7232 /* A string from display property. */
7233 || it->from_disp_prop_p))
7234 {
7235 ptrdiff_t ignore;
7236 int next_face_id;
7237 bool text_from_string = false;
7238 /* Normally, the next buffer location is stored in
7239 IT->current.pos... */
7240 struct text_pos pos = it->current.pos;
7241
7242 /* ...but for a string from a display property, the
7243 next buffer position is stored in the 'position'
7244 member of the iteration stack slot below the
7245 current one, see handle_single_display_spec. By
7246 contrast, it->current.pos was not yet updated to
7247 point to that buffer position; that will happen
7248 in pop_it, after we finish displaying the current
7249 string. Note that we already checked above that
7250 it->sp is positive, so subtracting one from it is
7251 safe. */
7252 if (it->from_disp_prop_p)
7253 {
7254 int stackp = it->sp - 1;
7255
7256 /* Find the stack level with data from buffer. */
7257 while (stackp >= 0
7258 && STRINGP ((it->stack + stackp)->string))
7259 stackp--;
7260 if (stackp < 0)
7261 {
7262 /* If no stack slot was found for iterating
7263 a buffer, we are displaying text from a
7264 string, most probably the mode line or
7265 the header line, and that string has a
7266 display string on some of its
7267 characters. */
7268 text_from_string = true;
7269 pos = it->stack[it->sp - 1].position;
7270 }
7271 else
7272 pos = (it->stack + stackp)->position;
7273 }
7274 else
7275 INC_TEXT_POS (pos, it->multibyte_p);
7276
7277 if (text_from_string)
7278 {
7279 Lisp_Object base_string = it->stack[it->sp - 1].string;
7280
7281 if (CHARPOS (pos) >= SCHARS (base_string) - 1)
7282 it->end_of_box_run_p = true;
7283 else
7284 {
7285 next_face_id
7286 = face_at_string_position (it->w, base_string,
7287 CHARPOS (pos), 0,
7288 &ignore, face_id, false);
7289 it->end_of_box_run_p
7290 = (FACE_FROM_ID (it->f, next_face_id)->box
7291 == FACE_NO_BOX);
7292 }
7293 }
7294 else if (CHARPOS (pos) >= ZV)
7295 it->end_of_box_run_p = true;
7296 else
7297 {
7298 next_face_id =
7299 face_at_buffer_position (it->w, CHARPOS (pos), &ignore,
7300 CHARPOS (pos)
7301 + TEXT_PROP_DISTANCE_LIMIT,
7302 false, -1);
7303 it->end_of_box_run_p
7304 = (FACE_FROM_ID (it->f, next_face_id)->box
7305 == FACE_NO_BOX);
7306 }
7307 }
7308 }
7309 }
7310 /* next_element_from_display_vector sets this flag according to
7311 faces of the display vector glyphs, see there. */
7312 else if (it->method != GET_FROM_DISPLAY_VECTOR)
7313 {
7314 int face_id = face_after_it_pos (it);
7315 it->end_of_box_run_p
7316 = (face_id != it->face_id
7317 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
7318 }
7319 }
7320 /* If we reached the end of the object we've been iterating (e.g., a
7321 display string or an overlay string), and there's something on
7322 IT->stack, proceed with what's on the stack. It doesn't make
7323 sense to return false if there's unprocessed stuff on the stack,
7324 because otherwise that stuff will never be displayed. */
7325 if (!success_p && it->sp > 0)
7326 {
7327 set_iterator_to_next (it, false);
7328 success_p = get_next_display_element (it);
7329 }
7330
7331 /* Value is false if end of buffer or string reached. */
7332 return success_p;
7333 }
7334
7335
7336 /* Move IT to the next display element.
7337
7338 RESEAT_P means if called on a newline in buffer text,
7339 skip to the next visible line start.
7340
7341 Functions get_next_display_element and set_iterator_to_next are
7342 separate because I find this arrangement easier to handle than a
7343 get_next_display_element function that also increments IT's
7344 position. The way it is we can first look at an iterator's current
7345 display element, decide whether it fits on a line, and if it does,
7346 increment the iterator position. The other way around we probably
7347 would either need a flag indicating whether the iterator has to be
7348 incremented the next time, or we would have to implement a
7349 decrement position function which would not be easy to write. */
7350
7351 void
7352 set_iterator_to_next (struct it *it, bool reseat_p)
7353 {
7354 /* Reset flags indicating start and end of a sequence of characters
7355 with box. Reset them at the start of this function because
7356 moving the iterator to a new position might set them. */
7357 it->start_of_box_run_p = it->end_of_box_run_p = false;
7358
7359 switch (it->method)
7360 {
7361 case GET_FROM_BUFFER:
7362 /* The current display element of IT is a character from
7363 current_buffer. Advance in the buffer, and maybe skip over
7364 invisible lines that are so because of selective display. */
7365 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
7366 reseat_at_next_visible_line_start (it, false);
7367 else if (it->cmp_it.id >= 0)
7368 {
7369 /* We are currently getting glyphs from a composition. */
7370 if (! it->bidi_p)
7371 {
7372 IT_CHARPOS (*it) += it->cmp_it.nchars;
7373 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
7374 }
7375 else
7376 {
7377 int i;
7378
7379 /* Update IT's char/byte positions to point to the first
7380 character of the next grapheme cluster, or to the
7381 character visually after the current composition. */
7382 for (i = 0; i < it->cmp_it.nchars; i++)
7383 bidi_move_to_visually_next (&it->bidi_it);
7384 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7385 IT_CHARPOS (*it) = it->bidi_it.charpos;
7386 }
7387
7388 if ((! it->bidi_p || ! it->cmp_it.reversed_p)
7389 && it->cmp_it.to < it->cmp_it.nglyphs)
7390 {
7391 /* Composition created while scanning forward. Proceed
7392 to the next grapheme cluster. */
7393 it->cmp_it.from = it->cmp_it.to;
7394 }
7395 else if ((it->bidi_p && it->cmp_it.reversed_p)
7396 && it->cmp_it.from > 0)
7397 {
7398 /* Composition created while scanning backward. Proceed
7399 to the previous grapheme cluster. */
7400 it->cmp_it.to = it->cmp_it.from;
7401 }
7402 else
7403 {
7404 /* No more grapheme clusters in this composition.
7405 Find the next stop position. */
7406 ptrdiff_t stop = it->end_charpos;
7407
7408 if (it->bidi_it.scan_dir < 0)
7409 /* Now we are scanning backward and don't know
7410 where to stop. */
7411 stop = -1;
7412 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7413 IT_BYTEPOS (*it), stop, Qnil);
7414 }
7415 }
7416 else
7417 {
7418 eassert (it->len != 0);
7419
7420 if (!it->bidi_p)
7421 {
7422 IT_BYTEPOS (*it) += it->len;
7423 IT_CHARPOS (*it) += 1;
7424 }
7425 else
7426 {
7427 int prev_scan_dir = it->bidi_it.scan_dir;
7428 /* If this is a new paragraph, determine its base
7429 direction (a.k.a. its base embedding level). */
7430 if (it->bidi_it.new_paragraph)
7431 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it,
7432 false);
7433 bidi_move_to_visually_next (&it->bidi_it);
7434 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7435 IT_CHARPOS (*it) = it->bidi_it.charpos;
7436 if (prev_scan_dir != it->bidi_it.scan_dir)
7437 {
7438 /* As the scan direction was changed, we must
7439 re-compute the stop position for composition. */
7440 ptrdiff_t stop = it->end_charpos;
7441 if (it->bidi_it.scan_dir < 0)
7442 stop = -1;
7443 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7444 IT_BYTEPOS (*it), stop, Qnil);
7445 }
7446 }
7447 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7448 }
7449 break;
7450
7451 case GET_FROM_C_STRING:
7452 /* Current display element of IT is from a C string. */
7453 if (!it->bidi_p
7454 /* If the string position is beyond string's end, it means
7455 next_element_from_c_string is padding the string with
7456 blanks, in which case we bypass the bidi iterator,
7457 because it cannot deal with such virtual characters. */
7458 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7459 {
7460 IT_BYTEPOS (*it) += it->len;
7461 IT_CHARPOS (*it) += 1;
7462 }
7463 else
7464 {
7465 bidi_move_to_visually_next (&it->bidi_it);
7466 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7467 IT_CHARPOS (*it) = it->bidi_it.charpos;
7468 }
7469 break;
7470
7471 case GET_FROM_DISPLAY_VECTOR:
7472 /* Current display element of IT is from a display table entry.
7473 Advance in the display table definition. Reset it to null if
7474 end reached, and continue with characters from buffers/
7475 strings. */
7476 ++it->current.dpvec_index;
7477
7478 /* Restore face of the iterator to what they were before the
7479 display vector entry (these entries may contain faces). */
7480 it->face_id = it->saved_face_id;
7481
7482 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7483 {
7484 bool recheck_faces = it->ellipsis_p;
7485
7486 if (it->s)
7487 it->method = GET_FROM_C_STRING;
7488 else if (STRINGP (it->string))
7489 it->method = GET_FROM_STRING;
7490 else
7491 {
7492 it->method = GET_FROM_BUFFER;
7493 it->object = it->w->contents;
7494 }
7495
7496 it->dpvec = NULL;
7497 it->current.dpvec_index = -1;
7498
7499 /* Skip over characters which were displayed via IT->dpvec. */
7500 if (it->dpvec_char_len < 0)
7501 reseat_at_next_visible_line_start (it, true);
7502 else if (it->dpvec_char_len > 0)
7503 {
7504 it->len = it->dpvec_char_len;
7505 set_iterator_to_next (it, reseat_p);
7506 }
7507
7508 /* Maybe recheck faces after display vector. */
7509 if (recheck_faces)
7510 {
7511 if (it->method == GET_FROM_STRING)
7512 it->stop_charpos = IT_STRING_CHARPOS (*it);
7513 else
7514 it->stop_charpos = IT_CHARPOS (*it);
7515 }
7516 }
7517 break;
7518
7519 case GET_FROM_STRING:
7520 /* Current display element is a character from a Lisp string. */
7521 eassert (it->s == NULL && STRINGP (it->string));
7522 /* Don't advance past string end. These conditions are true
7523 when set_iterator_to_next is called at the end of
7524 get_next_display_element, in which case the Lisp string is
7525 already exhausted, and all we want is pop the iterator
7526 stack. */
7527 if (it->current.overlay_string_index >= 0)
7528 {
7529 /* This is an overlay string, so there's no padding with
7530 spaces, and the number of characters in the string is
7531 where the string ends. */
7532 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7533 goto consider_string_end;
7534 }
7535 else
7536 {
7537 /* Not an overlay string. There could be padding, so test
7538 against it->end_charpos. */
7539 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7540 goto consider_string_end;
7541 }
7542 if (it->cmp_it.id >= 0)
7543 {
7544 /* We are delivering display elements from a composition.
7545 Update the string position past the grapheme cluster
7546 we've just processed. */
7547 if (! it->bidi_p)
7548 {
7549 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7550 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7551 }
7552 else
7553 {
7554 int i;
7555
7556 for (i = 0; i < it->cmp_it.nchars; i++)
7557 bidi_move_to_visually_next (&it->bidi_it);
7558 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7559 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7560 }
7561
7562 /* Did we exhaust all the grapheme clusters of this
7563 composition? */
7564 if ((! it->bidi_p || ! it->cmp_it.reversed_p)
7565 && (it->cmp_it.to < it->cmp_it.nglyphs))
7566 {
7567 /* Not all the grapheme clusters were processed yet;
7568 advance to the next cluster. */
7569 it->cmp_it.from = it->cmp_it.to;
7570 }
7571 else if ((it->bidi_p && it->cmp_it.reversed_p)
7572 && it->cmp_it.from > 0)
7573 {
7574 /* Likewise: advance to the next cluster, but going in
7575 the reverse direction. */
7576 it->cmp_it.to = it->cmp_it.from;
7577 }
7578 else
7579 {
7580 /* This composition was fully processed; find the next
7581 candidate place for checking for composed
7582 characters. */
7583 /* Always limit string searches to the string length;
7584 any padding spaces are not part of the string, and
7585 there cannot be any compositions in that padding. */
7586 ptrdiff_t stop = SCHARS (it->string);
7587
7588 if (it->bidi_p && it->bidi_it.scan_dir < 0)
7589 stop = -1;
7590 else if (it->end_charpos < stop)
7591 {
7592 /* Cf. PRECISION in reseat_to_string: we might be
7593 limited in how many of the string characters we
7594 need to deliver. */
7595 stop = it->end_charpos;
7596 }
7597 composition_compute_stop_pos (&it->cmp_it,
7598 IT_STRING_CHARPOS (*it),
7599 IT_STRING_BYTEPOS (*it), stop,
7600 it->string);
7601 }
7602 }
7603 else
7604 {
7605 if (!it->bidi_p
7606 /* If the string position is beyond string's end, it
7607 means next_element_from_string is padding the string
7608 with blanks, in which case we bypass the bidi
7609 iterator, because it cannot deal with such virtual
7610 characters. */
7611 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7612 {
7613 IT_STRING_BYTEPOS (*it) += it->len;
7614 IT_STRING_CHARPOS (*it) += 1;
7615 }
7616 else
7617 {
7618 int prev_scan_dir = it->bidi_it.scan_dir;
7619
7620 bidi_move_to_visually_next (&it->bidi_it);
7621 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7622 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7623 /* If the scan direction changes, we may need to update
7624 the place where to check for composed characters. */
7625 if (prev_scan_dir != it->bidi_it.scan_dir)
7626 {
7627 ptrdiff_t stop = SCHARS (it->string);
7628
7629 if (it->bidi_it.scan_dir < 0)
7630 stop = -1;
7631 else if (it->end_charpos < stop)
7632 stop = it->end_charpos;
7633
7634 composition_compute_stop_pos (&it->cmp_it,
7635 IT_STRING_CHARPOS (*it),
7636 IT_STRING_BYTEPOS (*it), stop,
7637 it->string);
7638 }
7639 }
7640 }
7641
7642 consider_string_end:
7643
7644 if (it->current.overlay_string_index >= 0)
7645 {
7646 /* IT->string is an overlay string. Advance to the
7647 next, if there is one. */
7648 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7649 {
7650 it->ellipsis_p = false;
7651 next_overlay_string (it);
7652 if (it->ellipsis_p)
7653 setup_for_ellipsis (it, 0);
7654 }
7655 }
7656 else
7657 {
7658 /* IT->string is not an overlay string. If we reached
7659 its end, and there is something on IT->stack, proceed
7660 with what is on the stack. This can be either another
7661 string, this time an overlay string, or a buffer. */
7662 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7663 && it->sp > 0)
7664 {
7665 pop_it (it);
7666 if (it->method == GET_FROM_STRING)
7667 goto consider_string_end;
7668 }
7669 }
7670 break;
7671
7672 case GET_FROM_IMAGE:
7673 case GET_FROM_STRETCH:
7674 case GET_FROM_XWIDGET:
7675
7676 /* The position etc with which we have to proceed are on
7677 the stack. The position may be at the end of a string,
7678 if the `display' property takes up the whole string. */
7679 eassert (it->sp > 0);
7680 pop_it (it);
7681 if (it->method == GET_FROM_STRING)
7682 goto consider_string_end;
7683 break;
7684
7685 default:
7686 /* There are no other methods defined, so this should be a bug. */
7687 emacs_abort ();
7688 }
7689
7690 eassert (it->method != GET_FROM_STRING
7691 || (STRINGP (it->string)
7692 && IT_STRING_CHARPOS (*it) >= 0));
7693 }
7694
7695 /* Load IT's display element fields with information about the next
7696 display element which comes from a display table entry or from the
7697 result of translating a control character to one of the forms `^C'
7698 or `\003'.
7699
7700 IT->dpvec holds the glyphs to return as characters.
7701 IT->saved_face_id holds the face id before the display vector--it
7702 is restored into IT->face_id in set_iterator_to_next. */
7703
7704 static bool
7705 next_element_from_display_vector (struct it *it)
7706 {
7707 Lisp_Object gc;
7708 int prev_face_id = it->face_id;
7709 int next_face_id;
7710
7711 /* Precondition. */
7712 eassert (it->dpvec && it->current.dpvec_index >= 0);
7713
7714 it->face_id = it->saved_face_id;
7715
7716 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7717 That seemed totally bogus - so I changed it... */
7718 gc = it->dpvec[it->current.dpvec_index];
7719
7720 if (GLYPH_CODE_P (gc))
7721 {
7722 struct face *this_face, *prev_face, *next_face;
7723
7724 it->c = GLYPH_CODE_CHAR (gc);
7725 it->len = CHAR_BYTES (it->c);
7726
7727 /* The entry may contain a face id to use. Such a face id is
7728 the id of a Lisp face, not a realized face. A face id of
7729 zero means no face is specified. */
7730 if (it->dpvec_face_id >= 0)
7731 it->face_id = it->dpvec_face_id;
7732 else
7733 {
7734 int lface_id = GLYPH_CODE_FACE (gc);
7735 if (lface_id > 0)
7736 it->face_id = merge_faces (it->f, Qt, lface_id,
7737 it->saved_face_id);
7738 }
7739
7740 /* Glyphs in the display vector could have the box face, so we
7741 need to set the related flags in the iterator, as
7742 appropriate. */
7743 this_face = FACE_FROM_ID_OR_NULL (it->f, it->face_id);
7744 prev_face = FACE_FROM_ID_OR_NULL (it->f, prev_face_id);
7745
7746 /* Is this character the first character of a box-face run? */
7747 it->start_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7748 && (!prev_face
7749 || prev_face->box == FACE_NO_BOX));
7750
7751 /* For the last character of the box-face run, we need to look
7752 either at the next glyph from the display vector, or at the
7753 face we saw before the display vector. */
7754 next_face_id = it->saved_face_id;
7755 if (it->current.dpvec_index < it->dpend - it->dpvec - 1)
7756 {
7757 if (it->dpvec_face_id >= 0)
7758 next_face_id = it->dpvec_face_id;
7759 else
7760 {
7761 int lface_id =
7762 GLYPH_CODE_FACE (it->dpvec[it->current.dpvec_index + 1]);
7763
7764 if (lface_id > 0)
7765 next_face_id = merge_faces (it->f, Qt, lface_id,
7766 it->saved_face_id);
7767 }
7768 }
7769 next_face = FACE_FROM_ID_OR_NULL (it->f, next_face_id);
7770 it->end_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7771 && (!next_face
7772 || next_face->box == FACE_NO_BOX));
7773 it->face_box_p = this_face && this_face->box != FACE_NO_BOX;
7774 }
7775 else
7776 /* Display table entry is invalid. Return a space. */
7777 it->c = ' ', it->len = 1;
7778
7779 /* Don't change position and object of the iterator here. They are
7780 still the values of the character that had this display table
7781 entry or was translated, and that's what we want. */
7782 it->what = IT_CHARACTER;
7783 return true;
7784 }
7785
7786 /* Get the first element of string/buffer in the visual order, after
7787 being reseated to a new position in a string or a buffer. */
7788 static void
7789 get_visually_first_element (struct it *it)
7790 {
7791 bool string_p = STRINGP (it->string) || it->s;
7792 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7793 ptrdiff_t bob = (string_p ? 0 : BEGV);
7794
7795 if (STRINGP (it->string))
7796 {
7797 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7798 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7799 }
7800 else
7801 {
7802 it->bidi_it.charpos = IT_CHARPOS (*it);
7803 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7804 }
7805
7806 if (it->bidi_it.charpos == eob)
7807 {
7808 /* Nothing to do, but reset the FIRST_ELT flag, like
7809 bidi_paragraph_init does, because we are not going to
7810 call it. */
7811 it->bidi_it.first_elt = false;
7812 }
7813 else if (it->bidi_it.charpos == bob
7814 || (!string_p
7815 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7816 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7817 {
7818 /* If we are at the beginning of a line/string, we can produce
7819 the next element right away. */
7820 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
7821 bidi_move_to_visually_next (&it->bidi_it);
7822 }
7823 else
7824 {
7825 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7826
7827 /* We need to prime the bidi iterator starting at the line's or
7828 string's beginning, before we will be able to produce the
7829 next element. */
7830 if (string_p)
7831 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7832 else
7833 it->bidi_it.charpos = find_newline_no_quit (IT_CHARPOS (*it),
7834 IT_BYTEPOS (*it), -1,
7835 &it->bidi_it.bytepos);
7836 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, true);
7837 do
7838 {
7839 /* Now return to buffer/string position where we were asked
7840 to get the next display element, and produce that. */
7841 bidi_move_to_visually_next (&it->bidi_it);
7842 }
7843 while (it->bidi_it.bytepos != orig_bytepos
7844 && it->bidi_it.charpos < eob);
7845 }
7846
7847 /* Adjust IT's position information to where we ended up. */
7848 if (STRINGP (it->string))
7849 {
7850 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7851 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7852 }
7853 else
7854 {
7855 IT_CHARPOS (*it) = it->bidi_it.charpos;
7856 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7857 }
7858
7859 if (STRINGP (it->string) || !it->s)
7860 {
7861 ptrdiff_t stop, charpos, bytepos;
7862
7863 if (STRINGP (it->string))
7864 {
7865 eassert (!it->s);
7866 stop = SCHARS (it->string);
7867 if (stop > it->end_charpos)
7868 stop = it->end_charpos;
7869 charpos = IT_STRING_CHARPOS (*it);
7870 bytepos = IT_STRING_BYTEPOS (*it);
7871 }
7872 else
7873 {
7874 stop = it->end_charpos;
7875 charpos = IT_CHARPOS (*it);
7876 bytepos = IT_BYTEPOS (*it);
7877 }
7878 if (it->bidi_it.scan_dir < 0)
7879 stop = -1;
7880 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7881 it->string);
7882 }
7883 }
7884
7885 /* Load IT with the next display element from Lisp string IT->string.
7886 IT->current.string_pos is the current position within the string.
7887 If IT->current.overlay_string_index >= 0, the Lisp string is an
7888 overlay string. */
7889
7890 static bool
7891 next_element_from_string (struct it *it)
7892 {
7893 struct text_pos position;
7894
7895 eassert (STRINGP (it->string));
7896 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7897 eassert (IT_STRING_CHARPOS (*it) >= 0);
7898 position = it->current.string_pos;
7899
7900 /* With bidi reordering, the character to display might not be the
7901 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT means
7902 that we were reseat()ed to a new string, whose paragraph
7903 direction is not known. */
7904 if (it->bidi_p && it->bidi_it.first_elt)
7905 {
7906 get_visually_first_element (it);
7907 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7908 }
7909
7910 /* Time to check for invisible text? */
7911 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7912 {
7913 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7914 {
7915 if (!(!it->bidi_p
7916 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7917 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7918 {
7919 /* With bidi non-linear iteration, we could find
7920 ourselves far beyond the last computed stop_charpos,
7921 with several other stop positions in between that we
7922 missed. Scan them all now, in buffer's logical
7923 order, until we find and handle the last stop_charpos
7924 that precedes our current position. */
7925 handle_stop_backwards (it, it->stop_charpos);
7926 return GET_NEXT_DISPLAY_ELEMENT (it);
7927 }
7928 else
7929 {
7930 if (it->bidi_p)
7931 {
7932 /* Take note of the stop position we just moved
7933 across, for when we will move back across it. */
7934 it->prev_stop = it->stop_charpos;
7935 /* If we are at base paragraph embedding level, take
7936 note of the last stop position seen at this
7937 level. */
7938 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7939 it->base_level_stop = it->stop_charpos;
7940 }
7941 handle_stop (it);
7942
7943 /* Since a handler may have changed IT->method, we must
7944 recurse here. */
7945 return GET_NEXT_DISPLAY_ELEMENT (it);
7946 }
7947 }
7948 else if (it->bidi_p
7949 /* If we are before prev_stop, we may have overstepped
7950 on our way backwards a stop_pos, and if so, we need
7951 to handle that stop_pos. */
7952 && IT_STRING_CHARPOS (*it) < it->prev_stop
7953 /* We can sometimes back up for reasons that have nothing
7954 to do with bidi reordering. E.g., compositions. The
7955 code below is only needed when we are above the base
7956 embedding level, so test for that explicitly. */
7957 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7958 {
7959 /* If we lost track of base_level_stop, we have no better
7960 place for handle_stop_backwards to start from than string
7961 beginning. This happens, e.g., when we were reseated to
7962 the previous screenful of text by vertical-motion. */
7963 if (it->base_level_stop <= 0
7964 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7965 it->base_level_stop = 0;
7966 handle_stop_backwards (it, it->base_level_stop);
7967 return GET_NEXT_DISPLAY_ELEMENT (it);
7968 }
7969 }
7970
7971 if (it->current.overlay_string_index >= 0)
7972 {
7973 /* Get the next character from an overlay string. In overlay
7974 strings, there is no field width or padding with spaces to
7975 do. */
7976 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7977 {
7978 it->what = IT_EOB;
7979 return false;
7980 }
7981 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7982 IT_STRING_BYTEPOS (*it),
7983 it->bidi_it.scan_dir < 0
7984 ? -1
7985 : SCHARS (it->string))
7986 && next_element_from_composition (it))
7987 {
7988 return true;
7989 }
7990 else if (STRING_MULTIBYTE (it->string))
7991 {
7992 const unsigned char *s = (SDATA (it->string)
7993 + IT_STRING_BYTEPOS (*it));
7994 it->c = string_char_and_length (s, &it->len);
7995 }
7996 else
7997 {
7998 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7999 it->len = 1;
8000 }
8001 }
8002 else
8003 {
8004 /* Get the next character from a Lisp string that is not an
8005 overlay string. Such strings come from the mode line, for
8006 example. We may have to pad with spaces, or truncate the
8007 string. See also next_element_from_c_string. */
8008 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
8009 {
8010 it->what = IT_EOB;
8011 return false;
8012 }
8013 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
8014 {
8015 /* Pad with spaces. */
8016 it->c = ' ', it->len = 1;
8017 CHARPOS (position) = BYTEPOS (position) = -1;
8018 }
8019 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
8020 IT_STRING_BYTEPOS (*it),
8021 it->bidi_it.scan_dir < 0
8022 ? -1
8023 : it->string_nchars)
8024 && next_element_from_composition (it))
8025 {
8026 return true;
8027 }
8028 else if (STRING_MULTIBYTE (it->string))
8029 {
8030 const unsigned char *s = (SDATA (it->string)
8031 + IT_STRING_BYTEPOS (*it));
8032 it->c = string_char_and_length (s, &it->len);
8033 }
8034 else
8035 {
8036 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
8037 it->len = 1;
8038 }
8039 }
8040
8041 /* Record what we have and where it came from. */
8042 it->what = IT_CHARACTER;
8043 it->object = it->string;
8044 it->position = position;
8045 return true;
8046 }
8047
8048
8049 /* Load IT with next display element from C string IT->s.
8050 IT->string_nchars is the maximum number of characters to return
8051 from the string. IT->end_charpos may be greater than
8052 IT->string_nchars when this function is called, in which case we
8053 may have to return padding spaces. Value is false if end of string
8054 reached, including padding spaces. */
8055
8056 static bool
8057 next_element_from_c_string (struct it *it)
8058 {
8059 bool success_p = true;
8060
8061 eassert (it->s);
8062 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
8063 it->what = IT_CHARACTER;
8064 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
8065 it->object = make_number (0);
8066
8067 /* With bidi reordering, the character to display might not be the
8068 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8069 we were reseated to a new string, whose paragraph direction is
8070 not known. */
8071 if (it->bidi_p && it->bidi_it.first_elt)
8072 get_visually_first_element (it);
8073
8074 /* IT's position can be greater than IT->string_nchars in case a
8075 field width or precision has been specified when the iterator was
8076 initialized. */
8077 if (IT_CHARPOS (*it) >= it->end_charpos)
8078 {
8079 /* End of the game. */
8080 it->what = IT_EOB;
8081 success_p = false;
8082 }
8083 else if (IT_CHARPOS (*it) >= it->string_nchars)
8084 {
8085 /* Pad with spaces. */
8086 it->c = ' ', it->len = 1;
8087 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
8088 }
8089 else if (it->multibyte_p)
8090 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
8091 else
8092 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
8093
8094 return success_p;
8095 }
8096
8097
8098 /* Set up IT to return characters from an ellipsis, if appropriate.
8099 The definition of the ellipsis glyphs may come from a display table
8100 entry. This function fills IT with the first glyph from the
8101 ellipsis if an ellipsis is to be displayed. */
8102
8103 static bool
8104 next_element_from_ellipsis (struct it *it)
8105 {
8106 if (it->selective_display_ellipsis_p)
8107 setup_for_ellipsis (it, it->len);
8108 else
8109 {
8110 /* The face at the current position may be different from the
8111 face we find after the invisible text. Remember what it
8112 was in IT->saved_face_id, and signal that it's there by
8113 setting face_before_selective_p. */
8114 it->saved_face_id = it->face_id;
8115 it->method = GET_FROM_BUFFER;
8116 it->object = it->w->contents;
8117 reseat_at_next_visible_line_start (it, true);
8118 it->face_before_selective_p = true;
8119 }
8120
8121 return GET_NEXT_DISPLAY_ELEMENT (it);
8122 }
8123
8124
8125 /* Deliver an image display element. The iterator IT is already
8126 filled with image information (done in handle_display_prop). Value
8127 is always true. */
8128
8129
8130 static bool
8131 next_element_from_image (struct it *it)
8132 {
8133 it->what = IT_IMAGE;
8134 return true;
8135 }
8136
8137 static bool
8138 next_element_from_xwidget (struct it *it)
8139 {
8140 it->what = IT_XWIDGET;
8141 return true;
8142 }
8143
8144
8145 /* Fill iterator IT with next display element from a stretch glyph
8146 property. IT->object is the value of the text property. Value is
8147 always true. */
8148
8149 static bool
8150 next_element_from_stretch (struct it *it)
8151 {
8152 it->what = IT_STRETCH;
8153 return true;
8154 }
8155
8156 /* Scan backwards from IT's current position until we find a stop
8157 position, or until BEGV. This is called when we find ourself
8158 before both the last known prev_stop and base_level_stop while
8159 reordering bidirectional text. */
8160
8161 static void
8162 compute_stop_pos_backwards (struct it *it)
8163 {
8164 const int SCAN_BACK_LIMIT = 1000;
8165 struct text_pos pos;
8166 struct display_pos save_current = it->current;
8167 struct text_pos save_position = it->position;
8168 ptrdiff_t charpos = IT_CHARPOS (*it);
8169 ptrdiff_t where_we_are = charpos;
8170 ptrdiff_t save_stop_pos = it->stop_charpos;
8171 ptrdiff_t save_end_pos = it->end_charpos;
8172
8173 eassert (NILP (it->string) && !it->s);
8174 eassert (it->bidi_p);
8175 it->bidi_p = false;
8176 do
8177 {
8178 it->end_charpos = min (charpos + 1, ZV);
8179 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
8180 SET_TEXT_POS (pos, charpos, CHAR_TO_BYTE (charpos));
8181 reseat_1 (it, pos, false);
8182 compute_stop_pos (it);
8183 /* We must advance forward, right? */
8184 if (it->stop_charpos <= charpos)
8185 emacs_abort ();
8186 }
8187 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
8188
8189 if (it->stop_charpos <= where_we_are)
8190 it->prev_stop = it->stop_charpos;
8191 else
8192 it->prev_stop = BEGV;
8193 it->bidi_p = true;
8194 it->current = save_current;
8195 it->position = save_position;
8196 it->stop_charpos = save_stop_pos;
8197 it->end_charpos = save_end_pos;
8198 }
8199
8200 /* Scan forward from CHARPOS in the current buffer/string, until we
8201 find a stop position > current IT's position. Then handle the stop
8202 position before that. This is called when we bump into a stop
8203 position while reordering bidirectional text. CHARPOS should be
8204 the last previously processed stop_pos (or BEGV/0, if none were
8205 processed yet) whose position is less that IT's current
8206 position. */
8207
8208 static void
8209 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
8210 {
8211 bool bufp = !STRINGP (it->string);
8212 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
8213 struct display_pos save_current = it->current;
8214 struct text_pos save_position = it->position;
8215 struct text_pos pos1;
8216 ptrdiff_t next_stop;
8217
8218 /* Scan in strict logical order. */
8219 eassert (it->bidi_p);
8220 it->bidi_p = false;
8221 do
8222 {
8223 it->prev_stop = charpos;
8224 if (bufp)
8225 {
8226 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
8227 reseat_1 (it, pos1, false);
8228 }
8229 else
8230 it->current.string_pos = string_pos (charpos, it->string);
8231 compute_stop_pos (it);
8232 /* We must advance forward, right? */
8233 if (it->stop_charpos <= it->prev_stop)
8234 emacs_abort ();
8235 charpos = it->stop_charpos;
8236 }
8237 while (charpos <= where_we_are);
8238
8239 it->bidi_p = true;
8240 it->current = save_current;
8241 it->position = save_position;
8242 next_stop = it->stop_charpos;
8243 it->stop_charpos = it->prev_stop;
8244 handle_stop (it);
8245 it->stop_charpos = next_stop;
8246 }
8247
8248 /* Load IT with the next display element from current_buffer. Value
8249 is false if end of buffer reached. IT->stop_charpos is the next
8250 position at which to stop and check for text properties or buffer
8251 end. */
8252
8253 static bool
8254 next_element_from_buffer (struct it *it)
8255 {
8256 bool success_p = true;
8257
8258 eassert (IT_CHARPOS (*it) >= BEGV);
8259 eassert (NILP (it->string) && !it->s);
8260 eassert (!it->bidi_p
8261 || (EQ (it->bidi_it.string.lstring, Qnil)
8262 && it->bidi_it.string.s == NULL));
8263
8264 /* With bidi reordering, the character to display might not be the
8265 character at IT_CHARPOS. BIDI_IT.FIRST_ELT means that
8266 we were reseat()ed to a new buffer position, which is potentially
8267 a different paragraph. */
8268 if (it->bidi_p && it->bidi_it.first_elt)
8269 {
8270 get_visually_first_element (it);
8271 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8272 }
8273
8274 if (IT_CHARPOS (*it) >= it->stop_charpos)
8275 {
8276 if (IT_CHARPOS (*it) >= it->end_charpos)
8277 {
8278 bool overlay_strings_follow_p;
8279
8280 /* End of the game, except when overlay strings follow that
8281 haven't been returned yet. */
8282 if (it->overlay_strings_at_end_processed_p)
8283 overlay_strings_follow_p = false;
8284 else
8285 {
8286 it->overlay_strings_at_end_processed_p = true;
8287 overlay_strings_follow_p = get_overlay_strings (it, 0);
8288 }
8289
8290 if (overlay_strings_follow_p)
8291 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
8292 else
8293 {
8294 it->what = IT_EOB;
8295 it->position = it->current.pos;
8296 success_p = false;
8297 }
8298 }
8299 else if (!(!it->bidi_p
8300 || BIDI_AT_BASE_LEVEL (it->bidi_it)
8301 || IT_CHARPOS (*it) == it->stop_charpos))
8302 {
8303 /* With bidi non-linear iteration, we could find ourselves
8304 far beyond the last computed stop_charpos, with several
8305 other stop positions in between that we missed. Scan
8306 them all now, in buffer's logical order, until we find
8307 and handle the last stop_charpos that precedes our
8308 current position. */
8309 handle_stop_backwards (it, it->stop_charpos);
8310 it->ignore_overlay_strings_at_pos_p = false;
8311 return GET_NEXT_DISPLAY_ELEMENT (it);
8312 }
8313 else
8314 {
8315 if (it->bidi_p)
8316 {
8317 /* Take note of the stop position we just moved across,
8318 for when we will move back across it. */
8319 it->prev_stop = it->stop_charpos;
8320 /* If we are at base paragraph embedding level, take
8321 note of the last stop position seen at this
8322 level. */
8323 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
8324 it->base_level_stop = it->stop_charpos;
8325 }
8326 handle_stop (it);
8327 it->ignore_overlay_strings_at_pos_p = false;
8328 return GET_NEXT_DISPLAY_ELEMENT (it);
8329 }
8330 }
8331 else if (it->bidi_p
8332 /* If we are before prev_stop, we may have overstepped on
8333 our way backwards a stop_pos, and if so, we need to
8334 handle that stop_pos. */
8335 && IT_CHARPOS (*it) < it->prev_stop
8336 /* We can sometimes back up for reasons that have nothing
8337 to do with bidi reordering. E.g., compositions. The
8338 code below is only needed when we are above the base
8339 embedding level, so test for that explicitly. */
8340 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
8341 {
8342 if (it->base_level_stop <= 0
8343 || IT_CHARPOS (*it) < it->base_level_stop)
8344 {
8345 /* If we lost track of base_level_stop, we need to find
8346 prev_stop by looking backwards. This happens, e.g., when
8347 we were reseated to the previous screenful of text by
8348 vertical-motion. */
8349 it->base_level_stop = BEGV;
8350 compute_stop_pos_backwards (it);
8351 handle_stop_backwards (it, it->prev_stop);
8352 }
8353 else
8354 handle_stop_backwards (it, it->base_level_stop);
8355 it->ignore_overlay_strings_at_pos_p = false;
8356 return GET_NEXT_DISPLAY_ELEMENT (it);
8357 }
8358 else
8359 {
8360 /* No face changes, overlays etc. in sight, so just return a
8361 character from current_buffer. */
8362 unsigned char *p;
8363 ptrdiff_t stop;
8364
8365 /* We moved to the next buffer position, so any info about
8366 previously seen overlays is no longer valid. */
8367 it->ignore_overlay_strings_at_pos_p = false;
8368
8369 /* Maybe run the redisplay end trigger hook. Performance note:
8370 This doesn't seem to cost measurable time. */
8371 if (it->redisplay_end_trigger_charpos
8372 && it->glyph_row
8373 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
8374 run_redisplay_end_trigger_hook (it);
8375
8376 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
8377 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
8378 stop)
8379 && next_element_from_composition (it))
8380 {
8381 return true;
8382 }
8383
8384 /* Get the next character, maybe multibyte. */
8385 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
8386 if (it->multibyte_p && !ASCII_CHAR_P (*p))
8387 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
8388 else
8389 it->c = *p, it->len = 1;
8390
8391 /* Record what we have and where it came from. */
8392 it->what = IT_CHARACTER;
8393 it->object = it->w->contents;
8394 it->position = it->current.pos;
8395
8396 /* Normally we return the character found above, except when we
8397 really want to return an ellipsis for selective display. */
8398 if (it->selective)
8399 {
8400 if (it->c == '\n')
8401 {
8402 /* A value of selective > 0 means hide lines indented more
8403 than that number of columns. */
8404 if (it->selective > 0
8405 && IT_CHARPOS (*it) + 1 < ZV
8406 && indented_beyond_p (IT_CHARPOS (*it) + 1,
8407 IT_BYTEPOS (*it) + 1,
8408 it->selective))
8409 {
8410 success_p = next_element_from_ellipsis (it);
8411 it->dpvec_char_len = -1;
8412 }
8413 }
8414 else if (it->c == '\r' && it->selective == -1)
8415 {
8416 /* A value of selective == -1 means that everything from the
8417 CR to the end of the line is invisible, with maybe an
8418 ellipsis displayed for it. */
8419 success_p = next_element_from_ellipsis (it);
8420 it->dpvec_char_len = -1;
8421 }
8422 }
8423 }
8424
8425 /* Value is false if end of buffer reached. */
8426 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8427 return success_p;
8428 }
8429
8430
8431 /* Run the redisplay end trigger hook for IT. */
8432
8433 static void
8434 run_redisplay_end_trigger_hook (struct it *it)
8435 {
8436 /* IT->glyph_row should be non-null, i.e. we should be actually
8437 displaying something, or otherwise we should not run the hook. */
8438 eassert (it->glyph_row);
8439
8440 ptrdiff_t charpos = it->redisplay_end_trigger_charpos;
8441 it->redisplay_end_trigger_charpos = 0;
8442
8443 /* Since we are *trying* to run these functions, don't try to run
8444 them again, even if they get an error. */
8445 wset_redisplay_end_trigger (it->w, Qnil);
8446 CALLN (Frun_hook_with_args, Qredisplay_end_trigger_functions, it->window,
8447 make_number (charpos));
8448
8449 /* Notice if it changed the face of the character we are on. */
8450 handle_face_prop (it);
8451 }
8452
8453
8454 /* Deliver a composition display element. Unlike the other
8455 next_element_from_XXX, this function is not registered in the array
8456 get_next_element[]. It is called from next_element_from_buffer and
8457 next_element_from_string when necessary. */
8458
8459 static bool
8460 next_element_from_composition (struct it *it)
8461 {
8462 it->what = IT_COMPOSITION;
8463 it->len = it->cmp_it.nbytes;
8464 if (STRINGP (it->string))
8465 {
8466 if (it->c < 0)
8467 {
8468 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8469 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8470 return false;
8471 }
8472 it->position = it->current.string_pos;
8473 it->object = it->string;
8474 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8475 IT_STRING_BYTEPOS (*it), it->string);
8476 }
8477 else
8478 {
8479 if (it->c < 0)
8480 {
8481 IT_CHARPOS (*it) += it->cmp_it.nchars;
8482 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8483 if (it->bidi_p)
8484 {
8485 if (it->bidi_it.new_paragraph)
8486 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it,
8487 false);
8488 /* Resync the bidi iterator with IT's new position.
8489 FIXME: this doesn't support bidirectional text. */
8490 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8491 bidi_move_to_visually_next (&it->bidi_it);
8492 }
8493 return false;
8494 }
8495 it->position = it->current.pos;
8496 it->object = it->w->contents;
8497 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8498 IT_BYTEPOS (*it), Qnil);
8499 }
8500 return true;
8501 }
8502
8503
8504 \f
8505 /***********************************************************************
8506 Moving an iterator without producing glyphs
8507 ***********************************************************************/
8508
8509 /* Check if iterator is at a position corresponding to a valid buffer
8510 position after some move_it_ call. */
8511
8512 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8513 ((it)->method != GET_FROM_STRING || IT_STRING_CHARPOS (*it) == 0)
8514
8515
8516 /* Move iterator IT to a specified buffer or X position within one
8517 line on the display without producing glyphs.
8518
8519 OP should be a bit mask including some or all of these bits:
8520 MOVE_TO_X: Stop upon reaching x-position TO_X.
8521 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8522 Regardless of OP's value, stop upon reaching the end of the display line.
8523
8524 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8525 This means, in particular, that TO_X includes window's horizontal
8526 scroll amount.
8527
8528 The return value has several possible values that
8529 say what condition caused the scan to stop:
8530
8531 MOVE_POS_MATCH_OR_ZV
8532 - when TO_POS or ZV was reached.
8533
8534 MOVE_X_REACHED
8535 -when TO_X was reached before TO_POS or ZV were reached.
8536
8537 MOVE_LINE_CONTINUED
8538 - when we reached the end of the display area and the line must
8539 be continued.
8540
8541 MOVE_LINE_TRUNCATED
8542 - when we reached the end of the display area and the line is
8543 truncated.
8544
8545 MOVE_NEWLINE_OR_CR
8546 - when we stopped at a line end, i.e. a newline or a CR and selective
8547 display is on. */
8548
8549 static enum move_it_result
8550 move_it_in_display_line_to (struct it *it,
8551 ptrdiff_t to_charpos, int to_x,
8552 enum move_operation_enum op)
8553 {
8554 enum move_it_result result = MOVE_UNDEFINED;
8555 struct glyph_row *saved_glyph_row;
8556 struct it wrap_it, atpos_it, atx_it, ppos_it;
8557 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8558 void *ppos_data = NULL;
8559 bool may_wrap = false;
8560 enum it_method prev_method = it->method;
8561 ptrdiff_t closest_pos UNINIT;
8562 ptrdiff_t prev_pos = IT_CHARPOS (*it);
8563 bool saw_smaller_pos = prev_pos < to_charpos;
8564
8565 /* Don't produce glyphs in produce_glyphs. */
8566 saved_glyph_row = it->glyph_row;
8567 it->glyph_row = NULL;
8568
8569 /* Use wrap_it to save a copy of IT wherever a word wrap could
8570 occur. Use atpos_it to save a copy of IT at the desired buffer
8571 position, if found, so that we can scan ahead and check if the
8572 word later overshoots the window edge. Use atx_it similarly, for
8573 pixel positions. */
8574 wrap_it.sp = -1;
8575 atpos_it.sp = -1;
8576 atx_it.sp = -1;
8577
8578 /* Use ppos_it under bidi reordering to save a copy of IT for the
8579 initial position. We restore that position in IT when we have
8580 scanned the entire display line without finding a match for
8581 TO_CHARPOS and all the character positions are greater than
8582 TO_CHARPOS. We then restart the scan from the initial position,
8583 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8584 the closest to TO_CHARPOS. */
8585 if (it->bidi_p)
8586 {
8587 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8588 {
8589 SAVE_IT (ppos_it, *it, ppos_data);
8590 closest_pos = IT_CHARPOS (*it);
8591 }
8592 else
8593 closest_pos = ZV;
8594 }
8595
8596 #define BUFFER_POS_REACHED_P() \
8597 ((op & MOVE_TO_POS) != 0 \
8598 && BUFFERP (it->object) \
8599 && (IT_CHARPOS (*it) == to_charpos \
8600 || ((!it->bidi_p \
8601 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8602 && IT_CHARPOS (*it) > to_charpos) \
8603 || (it->what == IT_COMPOSITION \
8604 && ((IT_CHARPOS (*it) > to_charpos \
8605 && to_charpos >= it->cmp_it.charpos) \
8606 || (IT_CHARPOS (*it) < to_charpos \
8607 && to_charpos <= it->cmp_it.charpos)))) \
8608 && (it->method == GET_FROM_BUFFER \
8609 || (it->method == GET_FROM_DISPLAY_VECTOR \
8610 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8611
8612 /* If there's a line-/wrap-prefix, handle it. */
8613 if (it->hpos == 0 && it->method == GET_FROM_BUFFER)
8614 handle_line_prefix (it);
8615
8616 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8617 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8618
8619 while (true)
8620 {
8621 int x, i, ascent = 0, descent = 0;
8622
8623 /* Utility macro to reset an iterator with x, ascent, and descent. */
8624 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8625 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8626 (IT)->max_descent = descent)
8627
8628 /* Stop if we move beyond TO_CHARPOS (after an image or a
8629 display string or stretch glyph). */
8630 if ((op & MOVE_TO_POS) != 0
8631 && BUFFERP (it->object)
8632 && it->method == GET_FROM_BUFFER
8633 && (((!it->bidi_p
8634 /* When the iterator is at base embedding level, we
8635 are guaranteed that characters are delivered for
8636 display in strictly increasing order of their
8637 buffer positions. */
8638 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8639 && IT_CHARPOS (*it) > to_charpos)
8640 || (it->bidi_p
8641 && (prev_method == GET_FROM_IMAGE
8642 || prev_method == GET_FROM_STRETCH
8643 || prev_method == GET_FROM_STRING)
8644 /* Passed TO_CHARPOS from left to right. */
8645 && ((prev_pos < to_charpos
8646 && IT_CHARPOS (*it) > to_charpos)
8647 /* Passed TO_CHARPOS from right to left. */
8648 || (prev_pos > to_charpos
8649 && IT_CHARPOS (*it) < to_charpos)))))
8650 {
8651 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8652 {
8653 result = MOVE_POS_MATCH_OR_ZV;
8654 break;
8655 }
8656 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8657 /* If wrap_it is valid, the current position might be in a
8658 word that is wrapped. So, save the iterator in
8659 atpos_it and continue to see if wrapping happens. */
8660 SAVE_IT (atpos_it, *it, atpos_data);
8661 }
8662
8663 /* Stop when ZV reached.
8664 We used to stop here when TO_CHARPOS reached as well, but that is
8665 too soon if this glyph does not fit on this line. So we handle it
8666 explicitly below. */
8667 if (!get_next_display_element (it))
8668 {
8669 result = MOVE_POS_MATCH_OR_ZV;
8670 break;
8671 }
8672
8673 if (it->line_wrap == TRUNCATE)
8674 {
8675 if (BUFFER_POS_REACHED_P ())
8676 {
8677 result = MOVE_POS_MATCH_OR_ZV;
8678 break;
8679 }
8680 }
8681 else
8682 {
8683 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
8684 {
8685 if (IT_DISPLAYING_WHITESPACE (it))
8686 may_wrap = true;
8687 else if (may_wrap)
8688 {
8689 /* We have reached a glyph that follows one or more
8690 whitespace characters. If the position is
8691 already found, we are done. */
8692 if (atpos_it.sp >= 0)
8693 {
8694 RESTORE_IT (it, &atpos_it, atpos_data);
8695 result = MOVE_POS_MATCH_OR_ZV;
8696 goto done;
8697 }
8698 if (atx_it.sp >= 0)
8699 {
8700 RESTORE_IT (it, &atx_it, atx_data);
8701 result = MOVE_X_REACHED;
8702 goto done;
8703 }
8704 /* Otherwise, we can wrap here. */
8705 SAVE_IT (wrap_it, *it, wrap_data);
8706 may_wrap = false;
8707 }
8708 }
8709 }
8710
8711 /* Remember the line height for the current line, in case
8712 the next element doesn't fit on the line. */
8713 ascent = it->max_ascent;
8714 descent = it->max_descent;
8715
8716 /* The call to produce_glyphs will get the metrics of the
8717 display element IT is loaded with. Record the x-position
8718 before this display element, in case it doesn't fit on the
8719 line. */
8720 x = it->current_x;
8721
8722 PRODUCE_GLYPHS (it);
8723
8724 if (it->area != TEXT_AREA)
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 if (it->bidi_p
8734 && (op & MOVE_TO_POS)
8735 && IT_CHARPOS (*it) > to_charpos
8736 && IT_CHARPOS (*it) < closest_pos)
8737 closest_pos = IT_CHARPOS (*it);
8738 continue;
8739 }
8740
8741 /* The number of glyphs we get back in IT->nglyphs will normally
8742 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8743 character on a terminal frame, or (iii) a line end. For the
8744 second case, IT->nglyphs - 1 padding glyphs will be present.
8745 (On X frames, there is only one glyph produced for a
8746 composite character.)
8747
8748 The behavior implemented below means, for continuation lines,
8749 that as many spaces of a TAB as fit on the current line are
8750 displayed there. For terminal frames, as many glyphs of a
8751 multi-glyph character are displayed in the current line, too.
8752 This is what the old redisplay code did, and we keep it that
8753 way. Under X, the whole shape of a complex character must
8754 fit on the line or it will be completely displayed in the
8755 next line.
8756
8757 Note that both for tabs and padding glyphs, all glyphs have
8758 the same width. */
8759 if (it->nglyphs)
8760 {
8761 /* More than one glyph or glyph doesn't fit on line. All
8762 glyphs have the same width. */
8763 int single_glyph_width = it->pixel_width / it->nglyphs;
8764 int new_x;
8765 int x_before_this_char = x;
8766 int hpos_before_this_char = it->hpos;
8767
8768 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8769 {
8770 new_x = x + single_glyph_width;
8771
8772 /* We want to leave anything reaching TO_X to the caller. */
8773 if ((op & MOVE_TO_X) && new_x > to_x)
8774 {
8775 if (BUFFER_POS_REACHED_P ())
8776 {
8777 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8778 goto buffer_pos_reached;
8779 if (atpos_it.sp < 0)
8780 {
8781 SAVE_IT (atpos_it, *it, atpos_data);
8782 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8783 }
8784 }
8785 else
8786 {
8787 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8788 {
8789 it->current_x = x;
8790 result = MOVE_X_REACHED;
8791 break;
8792 }
8793 if (atx_it.sp < 0)
8794 {
8795 SAVE_IT (atx_it, *it, atx_data);
8796 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8797 }
8798 }
8799 }
8800
8801 if (/* Lines are continued. */
8802 it->line_wrap != TRUNCATE
8803 && (/* And glyph doesn't fit on the line. */
8804 new_x > it->last_visible_x
8805 /* Or it fits exactly and we're on a window
8806 system frame. */
8807 || (new_x == it->last_visible_x
8808 && FRAME_WINDOW_P (it->f)
8809 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8810 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8811 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8812 {
8813 bool moved_forward = false;
8814
8815 if (/* IT->hpos == 0 means the very first glyph
8816 doesn't fit on the line, e.g. a wide image. */
8817 it->hpos == 0
8818 || (new_x == it->last_visible_x
8819 && FRAME_WINDOW_P (it->f)))
8820 {
8821 ++it->hpos;
8822 it->current_x = new_x;
8823
8824 /* The character's last glyph just barely fits
8825 in this row. */
8826 if (i == it->nglyphs - 1)
8827 {
8828 /* If this is the destination position,
8829 return a position *before* it in this row,
8830 now that we know it fits in this row. */
8831 if (BUFFER_POS_REACHED_P ())
8832 {
8833 bool can_wrap = true;
8834
8835 /* If we are at a whitespace character
8836 that barely fits on this screen line,
8837 but the next character is also
8838 whitespace, we cannot wrap here. */
8839 if (it->line_wrap == WORD_WRAP
8840 && wrap_it.sp >= 0
8841 && may_wrap
8842 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8843 {
8844 struct it tem_it;
8845 void *tem_data = NULL;
8846
8847 SAVE_IT (tem_it, *it, tem_data);
8848 set_iterator_to_next (it, true);
8849 if (get_next_display_element (it)
8850 && IT_DISPLAYING_WHITESPACE (it))
8851 can_wrap = false;
8852 RESTORE_IT (it, &tem_it, tem_data);
8853 }
8854 if (it->line_wrap != WORD_WRAP
8855 || wrap_it.sp < 0
8856 /* If we've just found whitespace
8857 where we can wrap, effectively
8858 ignore the previous wrap point --
8859 it is no longer relevant, but we
8860 won't have an opportunity to
8861 update it, since we've reached
8862 the edge of this screen line. */
8863 || (may_wrap && can_wrap
8864 && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)))
8865 {
8866 it->hpos = hpos_before_this_char;
8867 it->current_x = x_before_this_char;
8868 result = MOVE_POS_MATCH_OR_ZV;
8869 break;
8870 }
8871 if (it->line_wrap == WORD_WRAP
8872 && atpos_it.sp < 0)
8873 {
8874 SAVE_IT (atpos_it, *it, atpos_data);
8875 atpos_it.current_x = x_before_this_char;
8876 atpos_it.hpos = hpos_before_this_char;
8877 }
8878 }
8879
8880 prev_method = it->method;
8881 if (it->method == GET_FROM_BUFFER)
8882 prev_pos = IT_CHARPOS (*it);
8883 set_iterator_to_next (it, true);
8884 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8885 SET_TEXT_POS (this_line_min_pos,
8886 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8887 /* On graphical terminals, newlines may
8888 "overflow" into the fringe if
8889 overflow-newline-into-fringe is non-nil.
8890 On text terminals, and on graphical
8891 terminals with no right margin, newlines
8892 may overflow into the last glyph on the
8893 display line.*/
8894 if (!FRAME_WINDOW_P (it->f)
8895 || ((it->bidi_p
8896 && it->bidi_it.paragraph_dir == R2L)
8897 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8898 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8899 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8900 {
8901 if (!get_next_display_element (it))
8902 {
8903 result = MOVE_POS_MATCH_OR_ZV;
8904 break;
8905 }
8906 moved_forward = true;
8907 if (BUFFER_POS_REACHED_P ())
8908 {
8909 if (ITERATOR_AT_END_OF_LINE_P (it))
8910 result = MOVE_POS_MATCH_OR_ZV;
8911 else
8912 result = MOVE_LINE_CONTINUED;
8913 break;
8914 }
8915 if (ITERATOR_AT_END_OF_LINE_P (it)
8916 && (it->line_wrap != WORD_WRAP
8917 || wrap_it.sp < 0
8918 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)))
8919 {
8920 result = MOVE_NEWLINE_OR_CR;
8921 break;
8922 }
8923 }
8924 }
8925 }
8926 else
8927 IT_RESET_X_ASCENT_DESCENT (it);
8928
8929 /* If the screen line ends with whitespace, and we
8930 are under word-wrap, don't use wrap_it: it is no
8931 longer relevant, but we won't have an opportunity
8932 to update it, since we are done with this screen
8933 line. */
8934 if (may_wrap && IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)
8935 /* If the character after the one which set the
8936 may_wrap flag is also whitespace, we can't
8937 wrap here, since the screen line cannot be
8938 wrapped in the middle of whitespace.
8939 Therefore, wrap_it _is_ relevant in that
8940 case. */
8941 && !(moved_forward && IT_DISPLAYING_WHITESPACE (it)))
8942 {
8943 /* If we've found TO_X, go back there, as we now
8944 know the last word fits on this screen line. */
8945 if ((op & MOVE_TO_X) && new_x == it->last_visible_x
8946 && atx_it.sp >= 0)
8947 {
8948 RESTORE_IT (it, &atx_it, atx_data);
8949 atpos_it.sp = -1;
8950 atx_it.sp = -1;
8951 result = MOVE_X_REACHED;
8952 break;
8953 }
8954 }
8955 else if (wrap_it.sp >= 0)
8956 {
8957 RESTORE_IT (it, &wrap_it, wrap_data);
8958 atpos_it.sp = -1;
8959 atx_it.sp = -1;
8960 }
8961
8962 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8963 IT_CHARPOS (*it)));
8964 result = MOVE_LINE_CONTINUED;
8965 break;
8966 }
8967
8968 if (BUFFER_POS_REACHED_P ())
8969 {
8970 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8971 goto buffer_pos_reached;
8972 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8973 {
8974 SAVE_IT (atpos_it, *it, atpos_data);
8975 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8976 }
8977 }
8978
8979 if (new_x > it->first_visible_x)
8980 {
8981 /* Glyph is visible. Increment number of glyphs that
8982 would be displayed. */
8983 ++it->hpos;
8984 }
8985 }
8986
8987 if (result != MOVE_UNDEFINED)
8988 break;
8989 }
8990 else if (BUFFER_POS_REACHED_P ())
8991 {
8992 buffer_pos_reached:
8993 IT_RESET_X_ASCENT_DESCENT (it);
8994 result = MOVE_POS_MATCH_OR_ZV;
8995 break;
8996 }
8997 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8998 {
8999 /* Stop when TO_X specified and reached. This check is
9000 necessary here because of lines consisting of a line end,
9001 only. The line end will not produce any glyphs and we
9002 would never get MOVE_X_REACHED. */
9003 eassert (it->nglyphs == 0);
9004 result = MOVE_X_REACHED;
9005 break;
9006 }
9007
9008 /* Is this a line end? If yes, we're done. */
9009 if (ITERATOR_AT_END_OF_LINE_P (it))
9010 {
9011 /* If we are past TO_CHARPOS, but never saw any character
9012 positions smaller than TO_CHARPOS, return
9013 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
9014 did. */
9015 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
9016 {
9017 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
9018 {
9019 if (closest_pos < ZV)
9020 {
9021 RESTORE_IT (it, &ppos_it, ppos_data);
9022 /* Don't recurse if closest_pos is equal to
9023 to_charpos, since we have just tried that. */
9024 if (closest_pos != to_charpos)
9025 move_it_in_display_line_to (it, closest_pos, -1,
9026 MOVE_TO_POS);
9027 result = MOVE_POS_MATCH_OR_ZV;
9028 }
9029 else
9030 goto buffer_pos_reached;
9031 }
9032 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
9033 && IT_CHARPOS (*it) > to_charpos)
9034 goto buffer_pos_reached;
9035 else
9036 result = MOVE_NEWLINE_OR_CR;
9037 }
9038 else
9039 result = MOVE_NEWLINE_OR_CR;
9040 /* If we've processed the newline, make sure this flag is
9041 reset, as it must only be set when the newline itself is
9042 processed. */
9043 if (result == MOVE_NEWLINE_OR_CR)
9044 it->constrain_row_ascent_descent_p = false;
9045 break;
9046 }
9047
9048 prev_method = it->method;
9049 if (it->method == GET_FROM_BUFFER)
9050 prev_pos = IT_CHARPOS (*it);
9051 /* The current display element has been consumed. Advance
9052 to the next. */
9053 set_iterator_to_next (it, true);
9054 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
9055 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
9056 if (IT_CHARPOS (*it) < to_charpos)
9057 saw_smaller_pos = true;
9058 if (it->bidi_p
9059 && (op & MOVE_TO_POS)
9060 && IT_CHARPOS (*it) >= to_charpos
9061 && IT_CHARPOS (*it) < closest_pos)
9062 closest_pos = IT_CHARPOS (*it);
9063
9064 /* Stop if lines are truncated and IT's current x-position is
9065 past the right edge of the window now. */
9066 if (it->line_wrap == TRUNCATE
9067 && it->current_x >= it->last_visible_x)
9068 {
9069 if (!FRAME_WINDOW_P (it->f)
9070 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
9071 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
9072 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
9073 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
9074 {
9075 bool at_eob_p = false;
9076
9077 if ((at_eob_p = !get_next_display_element (it))
9078 || BUFFER_POS_REACHED_P ()
9079 /* If we are past TO_CHARPOS, but never saw any
9080 character positions smaller than TO_CHARPOS,
9081 return MOVE_POS_MATCH_OR_ZV, like the
9082 unidirectional display did. */
9083 || (it->bidi_p && (op & MOVE_TO_POS) != 0
9084 && !saw_smaller_pos
9085 && IT_CHARPOS (*it) > to_charpos))
9086 {
9087 if (it->bidi_p
9088 && !BUFFER_POS_REACHED_P ()
9089 && !at_eob_p && closest_pos < ZV)
9090 {
9091 RESTORE_IT (it, &ppos_it, ppos_data);
9092 if (closest_pos != to_charpos)
9093 move_it_in_display_line_to (it, closest_pos, -1,
9094 MOVE_TO_POS);
9095 }
9096 result = MOVE_POS_MATCH_OR_ZV;
9097 break;
9098 }
9099 if (ITERATOR_AT_END_OF_LINE_P (it))
9100 {
9101 result = MOVE_NEWLINE_OR_CR;
9102 break;
9103 }
9104 }
9105 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
9106 && !saw_smaller_pos
9107 && IT_CHARPOS (*it) > to_charpos)
9108 {
9109 if (closest_pos < ZV)
9110 {
9111 RESTORE_IT (it, &ppos_it, ppos_data);
9112 if (closest_pos != to_charpos)
9113 move_it_in_display_line_to (it, closest_pos, -1,
9114 MOVE_TO_POS);
9115 }
9116 result = MOVE_POS_MATCH_OR_ZV;
9117 break;
9118 }
9119 result = MOVE_LINE_TRUNCATED;
9120 break;
9121 }
9122 #undef IT_RESET_X_ASCENT_DESCENT
9123 }
9124
9125 #undef BUFFER_POS_REACHED_P
9126
9127 /* If we scanned beyond TO_POS, restore the saved iterator either to
9128 the wrap point (if found), or to atpos/atx location. We decide which
9129 data to use to restore the saved iterator state by their X coordinates,
9130 since buffer positions might increase non-monotonically with screen
9131 coordinates due to bidi reordering. */
9132 if (result == MOVE_LINE_CONTINUED
9133 && it->line_wrap == WORD_WRAP
9134 && wrap_it.sp >= 0
9135 && ((atpos_it.sp >= 0 && wrap_it.current_x < atpos_it.current_x)
9136 || (atx_it.sp >= 0 && wrap_it.current_x < atx_it.current_x)))
9137 RESTORE_IT (it, &wrap_it, wrap_data);
9138 else if (atpos_it.sp >= 0)
9139 RESTORE_IT (it, &atpos_it, atpos_data);
9140 else if (atx_it.sp >= 0)
9141 RESTORE_IT (it, &atx_it, atx_data);
9142
9143 done:
9144
9145 if (atpos_data)
9146 bidi_unshelve_cache (atpos_data, true);
9147 if (atx_data)
9148 bidi_unshelve_cache (atx_data, true);
9149 if (wrap_data)
9150 bidi_unshelve_cache (wrap_data, true);
9151 if (ppos_data)
9152 bidi_unshelve_cache (ppos_data, true);
9153
9154 /* Restore the iterator settings altered at the beginning of this
9155 function. */
9156 it->glyph_row = saved_glyph_row;
9157 return result;
9158 }
9159
9160 /* For external use. */
9161 void
9162 move_it_in_display_line (struct it *it,
9163 ptrdiff_t to_charpos, int to_x,
9164 enum move_operation_enum op)
9165 {
9166 if (it->line_wrap == WORD_WRAP
9167 && (op & MOVE_TO_X))
9168 {
9169 struct it save_it;
9170 void *save_data = NULL;
9171 int skip;
9172
9173 SAVE_IT (save_it, *it, save_data);
9174 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9175 /* When word-wrap is on, TO_X may lie past the end
9176 of a wrapped line. Then it->current is the
9177 character on the next line, so backtrack to the
9178 space before the wrap point. */
9179 if (skip == MOVE_LINE_CONTINUED)
9180 {
9181 int prev_x = max (it->current_x - 1, 0);
9182 RESTORE_IT (it, &save_it, save_data);
9183 move_it_in_display_line_to
9184 (it, -1, prev_x, MOVE_TO_X);
9185 }
9186 else
9187 bidi_unshelve_cache (save_data, true);
9188 }
9189 else
9190 move_it_in_display_line_to (it, to_charpos, to_x, op);
9191 }
9192
9193
9194 /* Move IT forward until it satisfies one or more of the criteria in
9195 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9196
9197 OP is a bit-mask that specifies where to stop, and in particular,
9198 which of those four position arguments makes a difference. See the
9199 description of enum move_operation_enum.
9200
9201 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9202 screen line, this function will set IT to the next position that is
9203 displayed to the right of TO_CHARPOS on the screen.
9204
9205 Return the maximum pixel length of any line scanned but never more
9206 than it.last_visible_x. */
9207
9208 int
9209 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
9210 {
9211 enum move_it_result skip, skip2 = MOVE_X_REACHED;
9212 int line_height, line_start_x = 0, reached = 0;
9213 int max_current_x = 0;
9214 void *backup_data = NULL;
9215
9216 for (;;)
9217 {
9218 if (op & MOVE_TO_VPOS)
9219 {
9220 /* If no TO_CHARPOS and no TO_X specified, stop at the
9221 start of the line TO_VPOS. */
9222 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
9223 {
9224 if (it->vpos == to_vpos)
9225 {
9226 reached = 1;
9227 break;
9228 }
9229 else
9230 skip = move_it_in_display_line_to (it, -1, -1, 0);
9231 }
9232 else
9233 {
9234 /* TO_VPOS >= 0 means stop at TO_X in the line at
9235 TO_VPOS, or at TO_POS, whichever comes first. */
9236 if (it->vpos == to_vpos)
9237 {
9238 reached = 2;
9239 break;
9240 }
9241
9242 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9243
9244 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
9245 {
9246 reached = 3;
9247 break;
9248 }
9249 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
9250 {
9251 /* We have reached TO_X but not in the line we want. */
9252 skip = move_it_in_display_line_to (it, to_charpos,
9253 -1, MOVE_TO_POS);
9254 if (skip == MOVE_POS_MATCH_OR_ZV)
9255 {
9256 reached = 4;
9257 break;
9258 }
9259 }
9260 }
9261 }
9262 else if (op & MOVE_TO_Y)
9263 {
9264 struct it it_backup;
9265
9266 if (it->line_wrap == WORD_WRAP)
9267 SAVE_IT (it_backup, *it, backup_data);
9268
9269 /* TO_Y specified means stop at TO_X in the line containing
9270 TO_Y---or at TO_CHARPOS if this is reached first. The
9271 problem is that we can't really tell whether the line
9272 contains TO_Y before we have completely scanned it, and
9273 this may skip past TO_X. What we do is to first scan to
9274 TO_X.
9275
9276 If TO_X is not specified, use a TO_X of zero. The reason
9277 is to make the outcome of this function more predictable.
9278 If we didn't use TO_X == 0, we would stop at the end of
9279 the line which is probably not what a caller would expect
9280 to happen. */
9281 skip = move_it_in_display_line_to
9282 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
9283 (MOVE_TO_X | (op & MOVE_TO_POS)));
9284
9285 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9286 if (skip == MOVE_POS_MATCH_OR_ZV)
9287 reached = 5;
9288 else if (skip == MOVE_X_REACHED)
9289 {
9290 /* If TO_X was reached, we want to know whether TO_Y is
9291 in the line. We know this is the case if the already
9292 scanned glyphs make the line tall enough. Otherwise,
9293 we must check by scanning the rest of the line. */
9294 line_height = it->max_ascent + it->max_descent;
9295 if (to_y >= it->current_y
9296 && to_y < it->current_y + line_height)
9297 {
9298 reached = 6;
9299 break;
9300 }
9301 SAVE_IT (it_backup, *it, backup_data);
9302 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
9303 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
9304 op & MOVE_TO_POS);
9305 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
9306 line_height = it->max_ascent + it->max_descent;
9307 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9308
9309 if (to_y >= it->current_y
9310 && to_y < it->current_y + line_height)
9311 {
9312 /* If TO_Y is in this line and TO_X was reached
9313 above, we scanned too far. We have to restore
9314 IT's settings to the ones before skipping. But
9315 keep the more accurate values of max_ascent and
9316 max_descent we've found while skipping the rest
9317 of the line, for the sake of callers, such as
9318 pos_visible_p, that need to know the line
9319 height. */
9320 int max_ascent = it->max_ascent;
9321 int max_descent = it->max_descent;
9322
9323 RESTORE_IT (it, &it_backup, backup_data);
9324 it->max_ascent = max_ascent;
9325 it->max_descent = max_descent;
9326 reached = 6;
9327 }
9328 else
9329 {
9330 skip = skip2;
9331 if (skip == MOVE_POS_MATCH_OR_ZV)
9332 reached = 7;
9333 }
9334 }
9335 else
9336 {
9337 /* Check whether TO_Y is in this line. */
9338 line_height = it->max_ascent + it->max_descent;
9339 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9340
9341 if (to_y >= it->current_y
9342 && to_y < it->current_y + line_height)
9343 {
9344 if (to_y > it->current_y)
9345 max_current_x = max (it->current_x, max_current_x);
9346
9347 /* When word-wrap is on, TO_X may lie past the end
9348 of a wrapped line. Then it->current is the
9349 character on the next line, so backtrack to the
9350 space before the wrap point. */
9351 if (skip == MOVE_LINE_CONTINUED
9352 && it->line_wrap == WORD_WRAP)
9353 {
9354 int prev_x = max (it->current_x - 1, 0);
9355 RESTORE_IT (it, &it_backup, backup_data);
9356 skip = move_it_in_display_line_to
9357 (it, -1, prev_x, MOVE_TO_X);
9358 }
9359
9360 reached = 6;
9361 }
9362 }
9363
9364 if (reached)
9365 {
9366 max_current_x = max (it->current_x, max_current_x);
9367 break;
9368 }
9369 }
9370 else if (BUFFERP (it->object)
9371 && (it->method == GET_FROM_BUFFER
9372 || it->method == GET_FROM_STRETCH)
9373 && IT_CHARPOS (*it) >= to_charpos
9374 /* Under bidi iteration, a call to set_iterator_to_next
9375 can scan far beyond to_charpos if the initial
9376 portion of the next line needs to be reordered. In
9377 that case, give move_it_in_display_line_to another
9378 chance below. */
9379 && !(it->bidi_p
9380 && it->bidi_it.scan_dir == -1))
9381 skip = MOVE_POS_MATCH_OR_ZV;
9382 else
9383 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
9384
9385 switch (skip)
9386 {
9387 case MOVE_POS_MATCH_OR_ZV:
9388 max_current_x = max (it->current_x, max_current_x);
9389 reached = 8;
9390 goto out;
9391
9392 case MOVE_NEWLINE_OR_CR:
9393 max_current_x = max (it->current_x, max_current_x);
9394 set_iterator_to_next (it, true);
9395 it->continuation_lines_width = 0;
9396 break;
9397
9398 case MOVE_LINE_TRUNCATED:
9399 max_current_x = it->last_visible_x;
9400 it->continuation_lines_width = 0;
9401 reseat_at_next_visible_line_start (it, false);
9402 if ((op & MOVE_TO_POS) != 0
9403 && IT_CHARPOS (*it) > to_charpos)
9404 {
9405 reached = 9;
9406 goto out;
9407 }
9408 break;
9409
9410 case MOVE_LINE_CONTINUED:
9411 max_current_x = it->last_visible_x;
9412 /* For continued lines ending in a tab, some of the glyphs
9413 associated with the tab are displayed on the current
9414 line. Since it->current_x does not include these glyphs,
9415 we use it->last_visible_x instead. */
9416 if (it->c == '\t')
9417 {
9418 it->continuation_lines_width += it->last_visible_x;
9419 /* When moving by vpos, ensure that the iterator really
9420 advances to the next line (bug#847, bug#969). Fixme:
9421 do we need to do this in other circumstances? */
9422 if (it->current_x != it->last_visible_x
9423 && (op & MOVE_TO_VPOS)
9424 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
9425 {
9426 line_start_x = it->current_x + it->pixel_width
9427 - it->last_visible_x;
9428 if (FRAME_WINDOW_P (it->f))
9429 {
9430 struct face *face = FACE_FROM_ID (it->f, it->face_id);
9431 struct font *face_font = face->font;
9432
9433 /* When display_line produces a continued line
9434 that ends in a TAB, it skips a tab stop that
9435 is closer than the font's space character
9436 width (see x_produce_glyphs where it produces
9437 the stretch glyph which represents a TAB).
9438 We need to reproduce the same logic here. */
9439 eassert (face_font);
9440 if (face_font)
9441 {
9442 if (line_start_x < face_font->space_width)
9443 line_start_x
9444 += it->tab_width * face_font->space_width;
9445 }
9446 }
9447 set_iterator_to_next (it, false);
9448 }
9449 }
9450 else
9451 it->continuation_lines_width += it->current_x;
9452 break;
9453
9454 default:
9455 emacs_abort ();
9456 }
9457
9458 /* Reset/increment for the next run. */
9459 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
9460 it->current_x = line_start_x;
9461 line_start_x = 0;
9462 it->hpos = 0;
9463 it->current_y += it->max_ascent + it->max_descent;
9464 ++it->vpos;
9465 last_height = it->max_ascent + it->max_descent;
9466 it->max_ascent = it->max_descent = 0;
9467 }
9468
9469 out:
9470
9471 /* On text terminals, we may stop at the end of a line in the middle
9472 of a multi-character glyph. If the glyph itself is continued,
9473 i.e. it is actually displayed on the next line, don't treat this
9474 stopping point as valid; move to the next line instead (unless
9475 that brings us offscreen). */
9476 if (!FRAME_WINDOW_P (it->f)
9477 && op & MOVE_TO_POS
9478 && IT_CHARPOS (*it) == to_charpos
9479 && it->what == IT_CHARACTER
9480 && it->nglyphs > 1
9481 && it->line_wrap == WINDOW_WRAP
9482 && it->current_x == it->last_visible_x - 1
9483 && it->c != '\n'
9484 && it->c != '\t'
9485 && it->w->window_end_valid
9486 && it->vpos < it->w->window_end_vpos)
9487 {
9488 it->continuation_lines_width += it->current_x;
9489 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
9490 it->current_y += it->max_ascent + it->max_descent;
9491 ++it->vpos;
9492 last_height = it->max_ascent + it->max_descent;
9493 }
9494
9495 if (backup_data)
9496 bidi_unshelve_cache (backup_data, true);
9497
9498 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
9499
9500 return max_current_x;
9501 }
9502
9503
9504 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9505
9506 If DY > 0, move IT backward at least that many pixels. DY = 0
9507 means move IT backward to the preceding line start or BEGV. This
9508 function may move over more than DY pixels if IT->current_y - DY
9509 ends up in the middle of a line; in this case IT->current_y will be
9510 set to the top of the line moved to. */
9511
9512 void
9513 move_it_vertically_backward (struct it *it, int dy)
9514 {
9515 int nlines, h;
9516 struct it it2, it3;
9517 void *it2data = NULL, *it3data = NULL;
9518 ptrdiff_t start_pos;
9519 int nchars_per_row
9520 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9521 ptrdiff_t pos_limit;
9522
9523 move_further_back:
9524 eassert (dy >= 0);
9525
9526 start_pos = IT_CHARPOS (*it);
9527
9528 /* Estimate how many newlines we must move back. */
9529 nlines = max (1, dy / default_line_pixel_height (it->w));
9530 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9531 pos_limit = BEGV;
9532 else
9533 pos_limit = max (start_pos - nlines * nchars_per_row, BEGV);
9534
9535 /* Set the iterator's position that many lines back. But don't go
9536 back more than NLINES full screen lines -- this wins a day with
9537 buffers which have very long lines. */
9538 while (nlines-- && IT_CHARPOS (*it) > pos_limit)
9539 back_to_previous_visible_line_start (it);
9540
9541 /* Reseat the iterator here. When moving backward, we don't want
9542 reseat to skip forward over invisible text, set up the iterator
9543 to deliver from overlay strings at the new position etc. So,
9544 use reseat_1 here. */
9545 reseat_1 (it, it->current.pos, true);
9546
9547 /* We are now surely at a line start. */
9548 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
9549 reordering is in effect. */
9550 it->continuation_lines_width = 0;
9551
9552 /* Move forward and see what y-distance we moved. First move to the
9553 start of the next line so that we get its height. We need this
9554 height to be able to tell whether we reached the specified
9555 y-distance. */
9556 SAVE_IT (it2, *it, it2data);
9557 it2.max_ascent = it2.max_descent = 0;
9558 do
9559 {
9560 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
9561 MOVE_TO_POS | MOVE_TO_VPOS);
9562 }
9563 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9564 /* If we are in a display string which starts at START_POS,
9565 and that display string includes a newline, and we are
9566 right after that newline (i.e. at the beginning of a
9567 display line), exit the loop, because otherwise we will
9568 infloop, since move_it_to will see that it is already at
9569 START_POS and will not move. */
9570 || (it2.method == GET_FROM_STRING
9571 && IT_CHARPOS (it2) == start_pos
9572 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9573 eassert (IT_CHARPOS (*it) >= BEGV);
9574 SAVE_IT (it3, it2, it3data);
9575
9576 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9577 eassert (IT_CHARPOS (*it) >= BEGV);
9578 /* H is the actual vertical distance from the position in *IT
9579 and the starting position. */
9580 h = it2.current_y - it->current_y;
9581 /* NLINES is the distance in number of lines. */
9582 nlines = it2.vpos - it->vpos;
9583
9584 /* Correct IT's y and vpos position
9585 so that they are relative to the starting point. */
9586 it->vpos -= nlines;
9587 it->current_y -= h;
9588
9589 if (dy == 0)
9590 {
9591 /* DY == 0 means move to the start of the screen line. The
9592 value of nlines is > 0 if continuation lines were involved,
9593 or if the original IT position was at start of a line. */
9594 RESTORE_IT (it, it, it2data);
9595 if (nlines > 0)
9596 move_it_by_lines (it, nlines);
9597 /* The above code moves us to some position NLINES down,
9598 usually to its first glyph (leftmost in an L2R line), but
9599 that's not necessarily the start of the line, under bidi
9600 reordering. We want to get to the character position
9601 that is immediately after the newline of the previous
9602 line. */
9603 if (it->bidi_p
9604 && !it->continuation_lines_width
9605 && !STRINGP (it->string)
9606 && IT_CHARPOS (*it) > BEGV
9607 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9608 {
9609 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
9610
9611 DEC_BOTH (cp, bp);
9612 cp = find_newline_no_quit (cp, bp, -1, NULL);
9613 move_it_to (it, cp, -1, -1, -1, MOVE_TO_POS);
9614 }
9615 bidi_unshelve_cache (it3data, true);
9616 }
9617 else
9618 {
9619 /* The y-position we try to reach, relative to *IT.
9620 Note that H has been subtracted in front of the if-statement. */
9621 int target_y = it->current_y + h - dy;
9622 int y0 = it3.current_y;
9623 int y1;
9624 int line_height;
9625
9626 RESTORE_IT (&it3, &it3, it3data);
9627 y1 = line_bottom_y (&it3);
9628 line_height = y1 - y0;
9629 RESTORE_IT (it, it, it2data);
9630 /* If we did not reach target_y, try to move further backward if
9631 we can. If we moved too far backward, try to move forward. */
9632 if (target_y < it->current_y
9633 /* This is heuristic. In a window that's 3 lines high, with
9634 a line height of 13 pixels each, recentering with point
9635 on the bottom line will try to move -39/2 = 19 pixels
9636 backward. Try to avoid moving into the first line. */
9637 && (it->current_y - target_y
9638 > min (window_box_height (it->w), line_height * 2 / 3))
9639 && IT_CHARPOS (*it) > BEGV)
9640 {
9641 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9642 target_y - it->current_y));
9643 dy = it->current_y - target_y;
9644 goto move_further_back;
9645 }
9646 else if (target_y >= it->current_y + line_height
9647 && IT_CHARPOS (*it) < ZV)
9648 {
9649 /* Should move forward by at least one line, maybe more.
9650
9651 Note: Calling move_it_by_lines can be expensive on
9652 terminal frames, where compute_motion is used (via
9653 vmotion) to do the job, when there are very long lines
9654 and truncate-lines is nil. That's the reason for
9655 treating terminal frames specially here. */
9656
9657 if (!FRAME_WINDOW_P (it->f))
9658 move_it_vertically (it, target_y - it->current_y);
9659 else
9660 {
9661 do
9662 {
9663 move_it_by_lines (it, 1);
9664 }
9665 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9666 }
9667 }
9668 }
9669 }
9670
9671
9672 /* Move IT by a specified amount of pixel lines DY. DY negative means
9673 move backwards. DY = 0 means move to start of screen line. At the
9674 end, IT will be on the start of a screen line. */
9675
9676 void
9677 move_it_vertically (struct it *it, int dy)
9678 {
9679 if (dy <= 0)
9680 move_it_vertically_backward (it, -dy);
9681 else
9682 {
9683 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9684 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9685 MOVE_TO_POS | MOVE_TO_Y);
9686 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9687
9688 /* If buffer ends in ZV without a newline, move to the start of
9689 the line to satisfy the post-condition. */
9690 if (IT_CHARPOS (*it) == ZV
9691 && ZV > BEGV
9692 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9693 move_it_by_lines (it, 0);
9694 }
9695 }
9696
9697
9698 /* Move iterator IT past the end of the text line it is in. */
9699
9700 void
9701 move_it_past_eol (struct it *it)
9702 {
9703 enum move_it_result rc;
9704
9705 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9706 if (rc == MOVE_NEWLINE_OR_CR)
9707 set_iterator_to_next (it, false);
9708 }
9709
9710
9711 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9712 negative means move up. DVPOS == 0 means move to the start of the
9713 screen line.
9714
9715 Optimization idea: If we would know that IT->f doesn't use
9716 a face with proportional font, we could be faster for
9717 truncate-lines nil. */
9718
9719 void
9720 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9721 {
9722
9723 /* The commented-out optimization uses vmotion on terminals. This
9724 gives bad results, because elements like it->what, on which
9725 callers such as pos_visible_p rely, aren't updated. */
9726 /* struct position pos;
9727 if (!FRAME_WINDOW_P (it->f))
9728 {
9729 struct text_pos textpos;
9730
9731 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9732 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9733 reseat (it, textpos, true);
9734 it->vpos += pos.vpos;
9735 it->current_y += pos.vpos;
9736 }
9737 else */
9738
9739 if (dvpos == 0)
9740 {
9741 /* DVPOS == 0 means move to the start of the screen line. */
9742 move_it_vertically_backward (it, 0);
9743 /* Let next call to line_bottom_y calculate real line height. */
9744 last_height = 0;
9745 }
9746 else if (dvpos > 0)
9747 {
9748 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9749 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9750 {
9751 /* Only move to the next buffer position if we ended up in a
9752 string from display property, not in an overlay string
9753 (before-string or after-string). That is because the
9754 latter don't conceal the underlying buffer position, so
9755 we can ask to move the iterator to the exact position we
9756 are interested in. Note that, even if we are already at
9757 IT_CHARPOS (*it), the call below is not a no-op, as it
9758 will detect that we are at the end of the string, pop the
9759 iterator, and compute it->current_x and it->hpos
9760 correctly. */
9761 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9762 -1, -1, -1, MOVE_TO_POS);
9763 }
9764 }
9765 else
9766 {
9767 struct it it2;
9768 void *it2data = NULL;
9769 ptrdiff_t start_charpos, i;
9770 int nchars_per_row
9771 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9772 bool hit_pos_limit = false;
9773 ptrdiff_t pos_limit;
9774
9775 /* Start at the beginning of the screen line containing IT's
9776 position. This may actually move vertically backwards,
9777 in case of overlays, so adjust dvpos accordingly. */
9778 dvpos += it->vpos;
9779 move_it_vertically_backward (it, 0);
9780 dvpos -= it->vpos;
9781
9782 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9783 screen lines, and reseat the iterator there. */
9784 start_charpos = IT_CHARPOS (*it);
9785 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9786 pos_limit = BEGV;
9787 else
9788 pos_limit = max (start_charpos + dvpos * nchars_per_row, BEGV);
9789
9790 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > pos_limit; --i)
9791 back_to_previous_visible_line_start (it);
9792 if (i > 0 && IT_CHARPOS (*it) <= pos_limit)
9793 hit_pos_limit = true;
9794 reseat (it, it->current.pos, true);
9795
9796 /* Move further back if we end up in a string or an image. */
9797 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9798 {
9799 /* First try to move to start of display line. */
9800 dvpos += it->vpos;
9801 move_it_vertically_backward (it, 0);
9802 dvpos -= it->vpos;
9803 if (IT_POS_VALID_AFTER_MOVE_P (it))
9804 break;
9805 /* If start of line is still in string or image,
9806 move further back. */
9807 back_to_previous_visible_line_start (it);
9808 reseat (it, it->current.pos, true);
9809 dvpos--;
9810 }
9811
9812 it->current_x = it->hpos = 0;
9813
9814 /* Above call may have moved too far if continuation lines
9815 are involved. Scan forward and see if it did. */
9816 SAVE_IT (it2, *it, it2data);
9817 it2.vpos = it2.current_y = 0;
9818 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9819 it->vpos -= it2.vpos;
9820 it->current_y -= it2.current_y;
9821 it->current_x = it->hpos = 0;
9822
9823 /* If we moved too far back, move IT some lines forward. */
9824 if (it2.vpos > -dvpos)
9825 {
9826 int delta = it2.vpos + dvpos;
9827
9828 RESTORE_IT (&it2, &it2, it2data);
9829 SAVE_IT (it2, *it, it2data);
9830 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9831 /* Move back again if we got too far ahead. */
9832 if (IT_CHARPOS (*it) >= start_charpos)
9833 RESTORE_IT (it, &it2, it2data);
9834 else
9835 bidi_unshelve_cache (it2data, true);
9836 }
9837 else if (hit_pos_limit && pos_limit > BEGV
9838 && dvpos < 0 && it2.vpos < -dvpos)
9839 {
9840 /* If we hit the limit, but still didn't make it far enough
9841 back, that means there's a display string with a newline
9842 covering a large chunk of text, and that caused
9843 back_to_previous_visible_line_start try to go too far.
9844 Punish those who commit such atrocities by going back
9845 until we've reached DVPOS, after lifting the limit, which
9846 could make it slow for very long lines. "If it hurts,
9847 don't do that!" */
9848 dvpos += it2.vpos;
9849 RESTORE_IT (it, it, it2data);
9850 for (i = -dvpos; i > 0; --i)
9851 {
9852 back_to_previous_visible_line_start (it);
9853 it->vpos--;
9854 }
9855 reseat_1 (it, it->current.pos, true);
9856 }
9857 else
9858 RESTORE_IT (it, it, it2data);
9859 }
9860 }
9861
9862 /* Return true if IT points into the middle of a display vector. */
9863
9864 bool
9865 in_display_vector_p (struct it *it)
9866 {
9867 return (it->method == GET_FROM_DISPLAY_VECTOR
9868 && it->current.dpvec_index > 0
9869 && it->dpvec + it->current.dpvec_index != it->dpend);
9870 }
9871
9872 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9873 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9874 WINDOW must be a live window and defaults to the selected one. The
9875 return value is a cons of the maximum pixel-width of any text line and
9876 the maximum pixel-height of all text lines.
9877
9878 The optional argument FROM, if non-nil, specifies the first text
9879 position and defaults to the minimum accessible position of the buffer.
9880 If FROM is t, use the minimum accessible position that starts a
9881 non-empty line. TO, if non-nil, specifies the last text position and
9882 defaults to the maximum accessible position of the buffer. If TO is t,
9883 use the maximum accessible position that ends a non-empty line.
9884
9885 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9886 width that can be returned. X-LIMIT nil or omitted, means to use the
9887 pixel-width of WINDOW's body; use this if you want to know how high
9888 WINDOW should be become in order to fit all of its buffer's text with
9889 the width of WINDOW unaltered. Use the maximum width WINDOW may assume
9890 if you intend to change WINDOW's width. In any case, text whose
9891 x-coordinate is beyond X-LIMIT is ignored. Since calculating the width
9892 of long lines can take some time, it's always a good idea to make this
9893 argument as small as possible; in particular, if the buffer contains
9894 long lines that shall be truncated anyway.
9895
9896 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9897 height (excluding the height of the mode- or header-line, if any) that
9898 can be returned. Text lines whose y-coordinate is beyond Y-LIMIT are
9899 ignored. Since calculating the text height of a large buffer can take
9900 some time, it makes sense to specify this argument if the size of the
9901 buffer is large or unknown.
9902
9903 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9904 include the height of the mode- or header-line of WINDOW in the return
9905 value. If it is either the symbol `mode-line' or `header-line', include
9906 only the height of that line, if present, in the return value. If t,
9907 include the height of both, if present, in the return value. */)
9908 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit,
9909 Lisp_Object y_limit, Lisp_Object mode_and_header_line)
9910 {
9911 struct window *w = decode_live_window (window);
9912 Lisp_Object buffer = w->contents;
9913 struct buffer *b;
9914 struct it it;
9915 struct buffer *old_b = NULL;
9916 ptrdiff_t start, end, pos;
9917 struct text_pos startp;
9918 void *itdata = NULL;
9919 int c, max_x = 0, max_y = 0, x = 0, y = 0;
9920
9921 CHECK_BUFFER (buffer);
9922 b = XBUFFER (buffer);
9923
9924 if (b != current_buffer)
9925 {
9926 old_b = current_buffer;
9927 set_buffer_internal (b);
9928 }
9929
9930 if (NILP (from))
9931 start = BEGV;
9932 else if (EQ (from, Qt))
9933 {
9934 start = pos = BEGV;
9935 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9936 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9937 start = pos;
9938 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9939 start = pos;
9940 }
9941 else
9942 {
9943 CHECK_NUMBER_COERCE_MARKER (from);
9944 start = min (max (XINT (from), BEGV), ZV);
9945 }
9946
9947 if (NILP (to))
9948 end = ZV;
9949 else if (EQ (to, Qt))
9950 {
9951 end = pos = ZV;
9952 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9953 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9954 end = pos;
9955 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9956 end = pos;
9957 }
9958 else
9959 {
9960 CHECK_NUMBER_COERCE_MARKER (to);
9961 end = max (start, min (XINT (to), ZV));
9962 }
9963
9964 if (!NILP (x_limit) && RANGED_INTEGERP (0, x_limit, INT_MAX))
9965 max_x = XINT (x_limit);
9966
9967 if (NILP (y_limit))
9968 max_y = INT_MAX;
9969 else if (RANGED_INTEGERP (0, y_limit, INT_MAX))
9970 max_y = XINT (y_limit);
9971
9972 itdata = bidi_shelve_cache ();
9973 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9974 start_display (&it, w, startp);
9975
9976 if (NILP (x_limit))
9977 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9978 else
9979 {
9980 it.last_visible_x = max_x;
9981 /* Actually, we never want move_it_to stop at to_x. But to make
9982 sure that move_it_in_display_line_to always moves far enough,
9983 we set it to INT_MAX and specify MOVE_TO_X. */
9984 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9985 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9986 /* Don't return more than X-LIMIT. */
9987 if (x > max_x)
9988 x = max_x;
9989 }
9990
9991 /* Subtract height of header-line which was counted automatically by
9992 start_display. */
9993 y = it.current_y + it.max_ascent + it.max_descent
9994 - WINDOW_HEADER_LINE_HEIGHT (w);
9995 /* Don't return more than Y-LIMIT. */
9996 if (y > max_y)
9997 y = max_y;
9998
9999 if (EQ (mode_and_header_line, Qheader_line)
10000 || EQ (mode_and_header_line, Qt))
10001 /* Re-add height of header-line as requested. */
10002 y = y + WINDOW_HEADER_LINE_HEIGHT (w);
10003
10004 if (EQ (mode_and_header_line, Qmode_line)
10005 || EQ (mode_and_header_line, Qt))
10006 /* Add height of mode-line as requested. */
10007 y = y + WINDOW_MODE_LINE_HEIGHT (w);
10008
10009 bidi_unshelve_cache (itdata, false);
10010
10011 if (old_b)
10012 set_buffer_internal (old_b);
10013
10014 return Fcons (make_number (x), make_number (y));
10015 }
10016 \f
10017 /***********************************************************************
10018 Messages
10019 ***********************************************************************/
10020
10021 /* Return the number of arguments the format string FORMAT needs. */
10022
10023 static ptrdiff_t
10024 format_nargs (char const *format)
10025 {
10026 ptrdiff_t nargs = 0;
10027 for (char const *p = format; (p = strchr (p, '%')); p++)
10028 if (p[1] == '%')
10029 p++;
10030 else
10031 nargs++;
10032 return nargs;
10033 }
10034
10035 /* Add a message with format string FORMAT and formatted arguments
10036 to *Messages*. */
10037
10038 void
10039 add_to_log (const char *format, ...)
10040 {
10041 va_list ap;
10042 va_start (ap, format);
10043 vadd_to_log (format, ap);
10044 va_end (ap);
10045 }
10046
10047 void
10048 vadd_to_log (char const *format, va_list ap)
10049 {
10050 ptrdiff_t form_nargs = format_nargs (format);
10051 ptrdiff_t nargs = 1 + form_nargs;
10052 Lisp_Object args[10];
10053 eassert (nargs <= ARRAYELTS (args));
10054 AUTO_STRING (args0, format);
10055 args[0] = args0;
10056 for (ptrdiff_t i = 1; i <= nargs; i++)
10057 args[i] = va_arg (ap, Lisp_Object);
10058 Lisp_Object msg = Qnil;
10059 msg = Fformat_message (nargs, args);
10060
10061 ptrdiff_t len = SBYTES (msg) + 1;
10062 USE_SAFE_ALLOCA;
10063 char *buffer = SAFE_ALLOCA (len);
10064 memcpy (buffer, SDATA (msg), len);
10065
10066 message_dolog (buffer, len - 1, true, STRING_MULTIBYTE (msg));
10067 SAFE_FREE ();
10068 }
10069
10070
10071 /* Output a newline in the *Messages* buffer if "needs" one. */
10072
10073 void
10074 message_log_maybe_newline (void)
10075 {
10076 if (message_log_need_newline)
10077 message_dolog ("", 0, true, false);
10078 }
10079
10080
10081 /* Add a string M of length NBYTES to the message log, optionally
10082 terminated with a newline when NLFLAG is true. MULTIBYTE, if
10083 true, means interpret the contents of M as multibyte. This
10084 function calls low-level routines in order to bypass text property
10085 hooks, etc. which might not be safe to run.
10086
10087 This may GC (insert may run before/after change hooks),
10088 so the buffer M must NOT point to a Lisp string. */
10089
10090 void
10091 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
10092 {
10093 const unsigned char *msg = (const unsigned char *) m;
10094
10095 if (!NILP (Vmemory_full))
10096 return;
10097
10098 if (!NILP (Vmessage_log_max))
10099 {
10100 struct buffer *oldbuf;
10101 Lisp_Object oldpoint, oldbegv, oldzv;
10102 int old_windows_or_buffers_changed = windows_or_buffers_changed;
10103 ptrdiff_t point_at_end = 0;
10104 ptrdiff_t zv_at_end = 0;
10105 Lisp_Object old_deactivate_mark;
10106
10107 old_deactivate_mark = Vdeactivate_mark;
10108 oldbuf = current_buffer;
10109
10110 /* Ensure the Messages buffer exists, and switch to it.
10111 If we created it, set the major-mode. */
10112 bool newbuffer = NILP (Fget_buffer (Vmessages_buffer_name));
10113 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
10114 if (newbuffer
10115 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
10116 call0 (intern ("messages-buffer-mode"));
10117
10118 bset_undo_list (current_buffer, Qt);
10119 bset_cache_long_scans (current_buffer, Qnil);
10120
10121 oldpoint = message_dolog_marker1;
10122 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
10123 oldbegv = message_dolog_marker2;
10124 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
10125 oldzv = message_dolog_marker3;
10126 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
10127
10128 if (PT == Z)
10129 point_at_end = 1;
10130 if (ZV == Z)
10131 zv_at_end = 1;
10132
10133 BEGV = BEG;
10134 BEGV_BYTE = BEG_BYTE;
10135 ZV = Z;
10136 ZV_BYTE = Z_BYTE;
10137 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10138
10139 /* Insert the string--maybe converting multibyte to single byte
10140 or vice versa, so that all the text fits the buffer. */
10141 if (multibyte
10142 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
10143 {
10144 ptrdiff_t i;
10145 int c, char_bytes;
10146 char work[1];
10147
10148 /* Convert a multibyte string to single-byte
10149 for the *Message* buffer. */
10150 for (i = 0; i < nbytes; i += char_bytes)
10151 {
10152 c = string_char_and_length (msg + i, &char_bytes);
10153 work[0] = CHAR_TO_BYTE8 (c);
10154 insert_1_both (work, 1, 1, true, false, false);
10155 }
10156 }
10157 else if (! multibyte
10158 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
10159 {
10160 ptrdiff_t i;
10161 int c, char_bytes;
10162 unsigned char str[MAX_MULTIBYTE_LENGTH];
10163 /* Convert a single-byte string to multibyte
10164 for the *Message* buffer. */
10165 for (i = 0; i < nbytes; i++)
10166 {
10167 c = msg[i];
10168 MAKE_CHAR_MULTIBYTE (c);
10169 char_bytes = CHAR_STRING (c, str);
10170 insert_1_both ((char *) str, 1, char_bytes, true, false, false);
10171 }
10172 }
10173 else if (nbytes)
10174 insert_1_both (m, chars_in_text (msg, nbytes), nbytes,
10175 true, false, false);
10176
10177 if (nlflag)
10178 {
10179 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
10180 printmax_t dups;
10181
10182 insert_1_both ("\n", 1, 1, true, false, false);
10183
10184 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, false);
10185 this_bol = PT;
10186 this_bol_byte = PT_BYTE;
10187
10188 /* See if this line duplicates the previous one.
10189 If so, combine duplicates. */
10190 if (this_bol > BEG)
10191 {
10192 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, false);
10193 prev_bol = PT;
10194 prev_bol_byte = PT_BYTE;
10195
10196 dups = message_log_check_duplicate (prev_bol_byte,
10197 this_bol_byte);
10198 if (dups)
10199 {
10200 del_range_both (prev_bol, prev_bol_byte,
10201 this_bol, this_bol_byte, false);
10202 if (dups > 1)
10203 {
10204 char dupstr[sizeof " [ times]"
10205 + INT_STRLEN_BOUND (printmax_t)];
10206
10207 /* If you change this format, don't forget to also
10208 change message_log_check_duplicate. */
10209 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
10210 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
10211 insert_1_both (dupstr, duplen, duplen,
10212 true, false, true);
10213 }
10214 }
10215 }
10216
10217 /* If we have more than the desired maximum number of lines
10218 in the *Messages* buffer now, delete the oldest ones.
10219 This is safe because we don't have undo in this buffer. */
10220
10221 if (NATNUMP (Vmessage_log_max))
10222 {
10223 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
10224 -XFASTINT (Vmessage_log_max) - 1, false);
10225 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, false);
10226 }
10227 }
10228 BEGV = marker_position (oldbegv);
10229 BEGV_BYTE = marker_byte_position (oldbegv);
10230
10231 if (zv_at_end)
10232 {
10233 ZV = Z;
10234 ZV_BYTE = Z_BYTE;
10235 }
10236 else
10237 {
10238 ZV = marker_position (oldzv);
10239 ZV_BYTE = marker_byte_position (oldzv);
10240 }
10241
10242 if (point_at_end)
10243 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10244 else
10245 /* We can't do Fgoto_char (oldpoint) because it will run some
10246 Lisp code. */
10247 TEMP_SET_PT_BOTH (marker_position (oldpoint),
10248 marker_byte_position (oldpoint));
10249
10250 unchain_marker (XMARKER (oldpoint));
10251 unchain_marker (XMARKER (oldbegv));
10252 unchain_marker (XMARKER (oldzv));
10253
10254 /* We called insert_1_both above with its 5th argument (PREPARE)
10255 false, which prevents insert_1_both from calling
10256 prepare_to_modify_buffer, which in turns prevents us from
10257 incrementing windows_or_buffers_changed even if *Messages* is
10258 shown in some window. So we must manually set
10259 windows_or_buffers_changed here to make up for that. */
10260 windows_or_buffers_changed = old_windows_or_buffers_changed;
10261 bset_redisplay (current_buffer);
10262
10263 set_buffer_internal (oldbuf);
10264
10265 message_log_need_newline = !nlflag;
10266 Vdeactivate_mark = old_deactivate_mark;
10267 }
10268 }
10269
10270
10271 /* We are at the end of the buffer after just having inserted a newline.
10272 (Note: We depend on the fact we won't be crossing the gap.)
10273 Check to see if the most recent message looks a lot like the previous one.
10274 Return 0 if different, 1 if the new one should just replace it, or a
10275 value N > 1 if we should also append " [N times]". */
10276
10277 static intmax_t
10278 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
10279 {
10280 ptrdiff_t i;
10281 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
10282 bool seen_dots = false;
10283 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
10284 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
10285
10286 for (i = 0; i < len; i++)
10287 {
10288 if (i >= 3 && p1[i - 3] == '.' && p1[i - 2] == '.' && p1[i - 1] == '.')
10289 seen_dots = true;
10290 if (p1[i] != p2[i])
10291 return seen_dots;
10292 }
10293 p1 += len;
10294 if (*p1 == '\n')
10295 return 2;
10296 if (*p1++ == ' ' && *p1++ == '[')
10297 {
10298 char *pend;
10299 intmax_t n = strtoimax ((char *) p1, &pend, 10);
10300 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
10301 return n + 1;
10302 }
10303 return 0;
10304 }
10305 \f
10306
10307 /* Display an echo area message M with a specified length of NBYTES
10308 bytes. The string may include null characters. If M is not a
10309 string, clear out any existing message, and let the mini-buffer
10310 text show through.
10311
10312 This function cancels echoing. */
10313
10314 void
10315 message3 (Lisp_Object m)
10316 {
10317 clear_message (true, true);
10318 cancel_echoing ();
10319
10320 /* First flush out any partial line written with print. */
10321 message_log_maybe_newline ();
10322 if (STRINGP (m))
10323 {
10324 ptrdiff_t nbytes = SBYTES (m);
10325 bool multibyte = STRING_MULTIBYTE (m);
10326 char *buffer;
10327 USE_SAFE_ALLOCA;
10328 SAFE_ALLOCA_STRING (buffer, m);
10329 message_dolog (buffer, nbytes, true, multibyte);
10330 SAFE_FREE ();
10331 }
10332 if (! inhibit_message)
10333 message3_nolog (m);
10334 }
10335
10336 /* Log the message M to stderr. Log an empty line if M is not a string. */
10337
10338 static void
10339 message_to_stderr (Lisp_Object m)
10340 {
10341 if (noninteractive_need_newline)
10342 {
10343 noninteractive_need_newline = false;
10344 fputc ('\n', stderr);
10345 }
10346 if (STRINGP (m))
10347 {
10348 Lisp_Object coding_system = Vlocale_coding_system;
10349 Lisp_Object s;
10350
10351 if (!NILP (Vcoding_system_for_write))
10352 coding_system = Vcoding_system_for_write;
10353 if (!NILP (coding_system))
10354 s = code_convert_string_norecord (m, coding_system, true);
10355 else
10356 s = m;
10357
10358 fwrite (SDATA (s), SBYTES (s), 1, stderr);
10359 }
10360 if (!cursor_in_echo_area)
10361 fputc ('\n', stderr);
10362 fflush (stderr);
10363 }
10364
10365 /* The non-logging version of message3.
10366 This does not cancel echoing, because it is used for echoing.
10367 Perhaps we need to make a separate function for echoing
10368 and make this cancel echoing. */
10369
10370 void
10371 message3_nolog (Lisp_Object m)
10372 {
10373 struct frame *sf = SELECTED_FRAME ();
10374
10375 if (FRAME_INITIAL_P (sf))
10376 message_to_stderr (m);
10377 /* Error messages get reported properly by cmd_error, so this must be just an
10378 informative message; if the frame hasn't really been initialized yet, just
10379 toss it. */
10380 else if (INTERACTIVE && sf->glyphs_initialized_p)
10381 {
10382 /* Get the frame containing the mini-buffer
10383 that the selected frame is using. */
10384 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
10385 Lisp_Object frame = XWINDOW (mini_window)->frame;
10386 struct frame *f = XFRAME (frame);
10387
10388 if (FRAME_VISIBLE_P (sf) && !FRAME_VISIBLE_P (f))
10389 Fmake_frame_visible (frame);
10390
10391 if (STRINGP (m) && SCHARS (m) > 0)
10392 {
10393 set_message (m);
10394 if (minibuffer_auto_raise)
10395 Fraise_frame (frame);
10396 /* Assume we are not echoing.
10397 (If we are, echo_now will override this.) */
10398 echo_message_buffer = Qnil;
10399 }
10400 else
10401 clear_message (true, true);
10402
10403 do_pending_window_change (false);
10404 echo_area_display (true);
10405 do_pending_window_change (false);
10406 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
10407 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
10408 }
10409 }
10410
10411
10412 /* Display a null-terminated echo area message M. If M is 0, clear
10413 out any existing message, and let the mini-buffer text show through.
10414
10415 The buffer M must continue to exist until after the echo area gets
10416 cleared or some other message gets displayed there. Do not pass
10417 text that is stored in a Lisp string. Do not pass text in a buffer
10418 that was alloca'd. */
10419
10420 void
10421 message1 (const char *m)
10422 {
10423 message3 (m ? build_unibyte_string (m) : Qnil);
10424 }
10425
10426
10427 /* The non-logging counterpart of message1. */
10428
10429 void
10430 message1_nolog (const char *m)
10431 {
10432 message3_nolog (m ? build_unibyte_string (m) : Qnil);
10433 }
10434
10435 /* Display a message M which contains a single %s
10436 which gets replaced with STRING. */
10437
10438 void
10439 message_with_string (const char *m, Lisp_Object string, bool log)
10440 {
10441 CHECK_STRING (string);
10442
10443 bool need_message;
10444 if (noninteractive)
10445 need_message = !!m;
10446 else if (!INTERACTIVE)
10447 need_message = false;
10448 else
10449 {
10450 /* The frame whose minibuffer we're going to display the message on.
10451 It may be larger than the selected frame, so we need
10452 to use its buffer, not the selected frame's buffer. */
10453 Lisp_Object mini_window;
10454 struct frame *f, *sf = SELECTED_FRAME ();
10455
10456 /* Get the frame containing the minibuffer
10457 that the selected frame is using. */
10458 mini_window = FRAME_MINIBUF_WINDOW (sf);
10459 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10460
10461 /* Error messages get reported properly by cmd_error, so this must be
10462 just an informative message; if the frame hasn't really been
10463 initialized yet, just toss it. */
10464 need_message = f->glyphs_initialized_p;
10465 }
10466
10467 if (need_message)
10468 {
10469 AUTO_STRING (fmt, m);
10470 Lisp_Object msg = CALLN (Fformat_message, fmt, string);
10471
10472 if (noninteractive)
10473 message_to_stderr (msg);
10474 else
10475 {
10476 if (log)
10477 message3 (msg);
10478 else
10479 message3_nolog (msg);
10480
10481 /* Print should start at the beginning of the message
10482 buffer next time. */
10483 message_buf_print = false;
10484 }
10485 }
10486 }
10487
10488
10489 /* Dump an informative message to the minibuf. If M is 0, clear out
10490 any existing message, and let the mini-buffer text show through.
10491
10492 The message must be safe ASCII and the format must not contain ` or
10493 '. If your message and format do not fit into this category,
10494 convert your arguments to Lisp objects and use Fmessage instead. */
10495
10496 static void ATTRIBUTE_FORMAT_PRINTF (1, 0)
10497 vmessage (const char *m, va_list ap)
10498 {
10499 if (noninteractive)
10500 {
10501 if (m)
10502 {
10503 if (noninteractive_need_newline)
10504 putc ('\n', stderr);
10505 noninteractive_need_newline = false;
10506 vfprintf (stderr, m, ap);
10507 if (!cursor_in_echo_area)
10508 fprintf (stderr, "\n");
10509 fflush (stderr);
10510 }
10511 }
10512 else if (INTERACTIVE)
10513 {
10514 /* The frame whose mini-buffer we're going to display the message
10515 on. It may be larger than the selected frame, so we need to
10516 use its buffer, not the selected frame's buffer. */
10517 Lisp_Object mini_window;
10518 struct frame *f, *sf = SELECTED_FRAME ();
10519
10520 /* Get the frame containing the mini-buffer
10521 that the selected frame is using. */
10522 mini_window = FRAME_MINIBUF_WINDOW (sf);
10523 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10524
10525 /* Error messages get reported properly by cmd_error, so this must be
10526 just an informative message; if the frame hasn't really been
10527 initialized yet, just toss it. */
10528 if (f->glyphs_initialized_p)
10529 {
10530 if (m)
10531 {
10532 ptrdiff_t len;
10533 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10534 USE_SAFE_ALLOCA;
10535 char *message_buf = SAFE_ALLOCA (maxsize + 1);
10536
10537 len = doprnt (message_buf, maxsize, m, 0, ap);
10538
10539 message3 (make_string (message_buf, len));
10540 SAFE_FREE ();
10541 }
10542 else
10543 message1 (0);
10544
10545 /* Print should start at the beginning of the message
10546 buffer next time. */
10547 message_buf_print = false;
10548 }
10549 }
10550 }
10551
10552 void
10553 message (const char *m, ...)
10554 {
10555 va_list ap;
10556 va_start (ap, m);
10557 vmessage (m, ap);
10558 va_end (ap);
10559 }
10560
10561
10562 /* Display the current message in the current mini-buffer. This is
10563 only called from error handlers in process.c, and is not time
10564 critical. */
10565
10566 void
10567 update_echo_area (void)
10568 {
10569 if (!NILP (echo_area_buffer[0]))
10570 {
10571 Lisp_Object string;
10572 string = Fcurrent_message ();
10573 message3 (string);
10574 }
10575 }
10576
10577
10578 /* Make sure echo area buffers in `echo_buffers' are live.
10579 If they aren't, make new ones. */
10580
10581 static void
10582 ensure_echo_area_buffers (void)
10583 {
10584 for (int i = 0; i < 2; i++)
10585 if (!BUFFERP (echo_buffer[i])
10586 || !BUFFER_LIVE_P (XBUFFER (echo_buffer[i])))
10587 {
10588 Lisp_Object old_buffer = echo_buffer[i];
10589 static char const name_fmt[] = " *Echo Area %d*";
10590 char name[sizeof name_fmt + INT_STRLEN_BOUND (int)];
10591 AUTO_STRING_WITH_LEN (lname, name, sprintf (name, name_fmt, i));
10592 echo_buffer[i] = Fget_buffer_create (lname);
10593 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
10594 /* to force word wrap in echo area -
10595 it was decided to postpone this*/
10596 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10597
10598 for (int j = 0; j < 2; j++)
10599 if (EQ (old_buffer, echo_area_buffer[j]))
10600 echo_area_buffer[j] = echo_buffer[i];
10601 }
10602 }
10603
10604
10605 /* Call FN with args A1..A2 with either the current or last displayed
10606 echo_area_buffer as current buffer.
10607
10608 WHICH zero means use the current message buffer
10609 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10610 from echo_buffer[] and clear it.
10611
10612 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10613 suitable buffer from echo_buffer[] and clear it.
10614
10615 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10616 that the current message becomes the last displayed one, choose a
10617 suitable buffer for echo_area_buffer[0], and clear it.
10618
10619 Value is what FN returns. */
10620
10621 static bool
10622 with_echo_area_buffer (struct window *w, int which,
10623 bool (*fn) (ptrdiff_t, Lisp_Object),
10624 ptrdiff_t a1, Lisp_Object a2)
10625 {
10626 Lisp_Object buffer;
10627 bool this_one, the_other, clear_buffer_p, rc;
10628 ptrdiff_t count = SPECPDL_INDEX ();
10629
10630 /* If buffers aren't live, make new ones. */
10631 ensure_echo_area_buffers ();
10632
10633 clear_buffer_p = false;
10634
10635 if (which == 0)
10636 this_one = false, the_other = true;
10637 else if (which > 0)
10638 this_one = true, the_other = false;
10639 else
10640 {
10641 this_one = false, the_other = true;
10642 clear_buffer_p = true;
10643
10644 /* We need a fresh one in case the current echo buffer equals
10645 the one containing the last displayed echo area message. */
10646 if (!NILP (echo_area_buffer[this_one])
10647 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
10648 echo_area_buffer[this_one] = Qnil;
10649 }
10650
10651 /* Choose a suitable buffer from echo_buffer[] if we don't
10652 have one. */
10653 if (NILP (echo_area_buffer[this_one]))
10654 {
10655 echo_area_buffer[this_one]
10656 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
10657 ? echo_buffer[the_other]
10658 : echo_buffer[this_one]);
10659 clear_buffer_p = true;
10660 }
10661
10662 buffer = echo_area_buffer[this_one];
10663
10664 /* Don't get confused by reusing the buffer used for echoing
10665 for a different purpose. */
10666 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
10667 cancel_echoing ();
10668
10669 record_unwind_protect (unwind_with_echo_area_buffer,
10670 with_echo_area_buffer_unwind_data (w));
10671
10672 /* Make the echo area buffer current. Note that for display
10673 purposes, it is not necessary that the displayed window's buffer
10674 == current_buffer, except for text property lookup. So, let's
10675 only set that buffer temporarily here without doing a full
10676 Fset_window_buffer. We must also change w->pointm, though,
10677 because otherwise an assertions in unshow_buffer fails, and Emacs
10678 aborts. */
10679 set_buffer_internal_1 (XBUFFER (buffer));
10680 if (w)
10681 {
10682 wset_buffer (w, buffer);
10683 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10684 set_marker_both (w->old_pointm, buffer, BEG, BEG_BYTE);
10685 }
10686
10687 bset_undo_list (current_buffer, Qt);
10688 bset_read_only (current_buffer, Qnil);
10689 specbind (Qinhibit_read_only, Qt);
10690 specbind (Qinhibit_modification_hooks, Qt);
10691
10692 if (clear_buffer_p && Z > BEG)
10693 del_range (BEG, Z);
10694
10695 eassert (BEGV >= BEG);
10696 eassert (ZV <= Z && ZV >= BEGV);
10697
10698 rc = fn (a1, a2);
10699
10700 eassert (BEGV >= BEG);
10701 eassert (ZV <= Z && ZV >= BEGV);
10702
10703 unbind_to (count, Qnil);
10704 return rc;
10705 }
10706
10707
10708 /* Save state that should be preserved around the call to the function
10709 FN called in with_echo_area_buffer. */
10710
10711 static Lisp_Object
10712 with_echo_area_buffer_unwind_data (struct window *w)
10713 {
10714 int i = 0;
10715 Lisp_Object vector, tmp;
10716
10717 /* Reduce consing by keeping one vector in
10718 Vwith_echo_area_save_vector. */
10719 vector = Vwith_echo_area_save_vector;
10720 Vwith_echo_area_save_vector = Qnil;
10721
10722 if (NILP (vector))
10723 vector = Fmake_vector (make_number (11), Qnil);
10724
10725 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10726 ASET (vector, i, Vdeactivate_mark); ++i;
10727 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10728
10729 if (w)
10730 {
10731 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10732 ASET (vector, i, w->contents); ++i;
10733 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10734 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10735 ASET (vector, i, make_number (marker_position (w->old_pointm))); ++i;
10736 ASET (vector, i, make_number (marker_byte_position (w->old_pointm))); ++i;
10737 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10738 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10739 }
10740 else
10741 {
10742 int end = i + 8;
10743 for (; i < end; ++i)
10744 ASET (vector, i, Qnil);
10745 }
10746
10747 eassert (i == ASIZE (vector));
10748 return vector;
10749 }
10750
10751
10752 /* Restore global state from VECTOR which was created by
10753 with_echo_area_buffer_unwind_data. */
10754
10755 static void
10756 unwind_with_echo_area_buffer (Lisp_Object vector)
10757 {
10758 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10759 Vdeactivate_mark = AREF (vector, 1);
10760 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10761
10762 if (WINDOWP (AREF (vector, 3)))
10763 {
10764 struct window *w;
10765 Lisp_Object buffer;
10766
10767 w = XWINDOW (AREF (vector, 3));
10768 buffer = AREF (vector, 4);
10769
10770 wset_buffer (w, buffer);
10771 set_marker_both (w->pointm, buffer,
10772 XFASTINT (AREF (vector, 5)),
10773 XFASTINT (AREF (vector, 6)));
10774 set_marker_both (w->old_pointm, buffer,
10775 XFASTINT (AREF (vector, 7)),
10776 XFASTINT (AREF (vector, 8)));
10777 set_marker_both (w->start, buffer,
10778 XFASTINT (AREF (vector, 9)),
10779 XFASTINT (AREF (vector, 10)));
10780 }
10781
10782 Vwith_echo_area_save_vector = vector;
10783 }
10784
10785
10786 /* Set up the echo area for use by print functions. MULTIBYTE_P
10787 means we will print multibyte. */
10788
10789 void
10790 setup_echo_area_for_printing (bool multibyte_p)
10791 {
10792 /* If we can't find an echo area any more, exit. */
10793 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10794 Fkill_emacs (Qnil);
10795
10796 ensure_echo_area_buffers ();
10797
10798 if (!message_buf_print)
10799 {
10800 /* A message has been output since the last time we printed.
10801 Choose a fresh echo area buffer. */
10802 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10803 echo_area_buffer[0] = echo_buffer[1];
10804 else
10805 echo_area_buffer[0] = echo_buffer[0];
10806
10807 /* Switch to that buffer and clear it. */
10808 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10809 bset_truncate_lines (current_buffer, Qnil);
10810
10811 if (Z > BEG)
10812 {
10813 ptrdiff_t count = SPECPDL_INDEX ();
10814 specbind (Qinhibit_read_only, Qt);
10815 /* Note that undo recording is always disabled. */
10816 del_range (BEG, Z);
10817 unbind_to (count, Qnil);
10818 }
10819 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10820
10821 /* Set up the buffer for the multibyteness we need. */
10822 if (multibyte_p
10823 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10824 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10825
10826 /* Raise the frame containing the echo area. */
10827 if (minibuffer_auto_raise)
10828 {
10829 struct frame *sf = SELECTED_FRAME ();
10830 Lisp_Object mini_window;
10831 mini_window = FRAME_MINIBUF_WINDOW (sf);
10832 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10833 }
10834
10835 message_log_maybe_newline ();
10836 message_buf_print = true;
10837 }
10838 else
10839 {
10840 if (NILP (echo_area_buffer[0]))
10841 {
10842 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10843 echo_area_buffer[0] = echo_buffer[1];
10844 else
10845 echo_area_buffer[0] = echo_buffer[0];
10846 }
10847
10848 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10849 {
10850 /* Someone switched buffers between print requests. */
10851 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10852 bset_truncate_lines (current_buffer, Qnil);
10853 }
10854 }
10855 }
10856
10857
10858 /* Display an echo area message in window W. Value is true if W's
10859 height is changed. If display_last_displayed_message_p,
10860 display the message that was last displayed, otherwise
10861 display the current message. */
10862
10863 static bool
10864 display_echo_area (struct window *w)
10865 {
10866 bool no_message_p, window_height_changed_p;
10867
10868 /* Temporarily disable garbage collections while displaying the echo
10869 area. This is done because a GC can print a message itself.
10870 That message would modify the echo area buffer's contents while a
10871 redisplay of the buffer is going on, and seriously confuse
10872 redisplay. */
10873 ptrdiff_t count = inhibit_garbage_collection ();
10874
10875 /* If there is no message, we must call display_echo_area_1
10876 nevertheless because it resizes the window. But we will have to
10877 reset the echo_area_buffer in question to nil at the end because
10878 with_echo_area_buffer will sets it to an empty buffer. */
10879 bool i = display_last_displayed_message_p;
10880 /* According to the C99, C11 and C++11 standards, the integral value
10881 of a "bool" is always 0 or 1, so this array access is safe here,
10882 if oddly typed. */
10883 no_message_p = NILP (echo_area_buffer[i]);
10884
10885 window_height_changed_p
10886 = with_echo_area_buffer (w, display_last_displayed_message_p,
10887 display_echo_area_1,
10888 (intptr_t) w, Qnil);
10889
10890 if (no_message_p)
10891 echo_area_buffer[i] = Qnil;
10892
10893 unbind_to (count, Qnil);
10894 return window_height_changed_p;
10895 }
10896
10897
10898 /* Helper for display_echo_area. Display the current buffer which
10899 contains the current echo area message in window W, a mini-window,
10900 a pointer to which is passed in A1. A2..A4 are currently not used.
10901 Change the height of W so that all of the message is displayed.
10902 Value is true if height of W was changed. */
10903
10904 static bool
10905 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10906 {
10907 intptr_t i1 = a1;
10908 struct window *w = (struct window *) i1;
10909 Lisp_Object window;
10910 struct text_pos start;
10911
10912 /* We are about to enter redisplay without going through
10913 redisplay_internal, so we need to forget these faces by hand
10914 here. */
10915 forget_escape_and_glyphless_faces ();
10916
10917 /* Do this before displaying, so that we have a large enough glyph
10918 matrix for the display. If we can't get enough space for the
10919 whole text, display the last N lines. That works by setting w->start. */
10920 bool window_height_changed_p = resize_mini_window (w, false);
10921
10922 /* Use the starting position chosen by resize_mini_window. */
10923 SET_TEXT_POS_FROM_MARKER (start, w->start);
10924
10925 /* Display. */
10926 clear_glyph_matrix (w->desired_matrix);
10927 XSETWINDOW (window, w);
10928 try_window (window, start, 0);
10929
10930 return window_height_changed_p;
10931 }
10932
10933
10934 /* Resize the echo area window to exactly the size needed for the
10935 currently displayed message, if there is one. If a mini-buffer
10936 is active, don't shrink it. */
10937
10938 void
10939 resize_echo_area_exactly (void)
10940 {
10941 if (BUFFERP (echo_area_buffer[0])
10942 && WINDOWP (echo_area_window))
10943 {
10944 struct window *w = XWINDOW (echo_area_window);
10945 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10946 bool resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10947 (intptr_t) w, resize_exactly);
10948 if (resized_p)
10949 {
10950 windows_or_buffers_changed = 42;
10951 update_mode_lines = 30;
10952 redisplay_internal ();
10953 }
10954 }
10955 }
10956
10957
10958 /* Callback function for with_echo_area_buffer, when used from
10959 resize_echo_area_exactly. A1 contains a pointer to the window to
10960 resize, EXACTLY non-nil means resize the mini-window exactly to the
10961 size of the text displayed. A3 and A4 are not used. Value is what
10962 resize_mini_window returns. */
10963
10964 static bool
10965 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10966 {
10967 intptr_t i1 = a1;
10968 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10969 }
10970
10971
10972 /* Resize mini-window W to fit the size of its contents. EXACT_P
10973 means size the window exactly to the size needed. Otherwise, it's
10974 only enlarged until W's buffer is empty.
10975
10976 Set W->start to the right place to begin display. If the whole
10977 contents fit, start at the beginning. Otherwise, start so as
10978 to make the end of the contents appear. This is particularly
10979 important for y-or-n-p, but seems desirable generally.
10980
10981 Value is true if the window height has been changed. */
10982
10983 bool
10984 resize_mini_window (struct window *w, bool exact_p)
10985 {
10986 struct frame *f = XFRAME (w->frame);
10987 bool window_height_changed_p = false;
10988
10989 eassert (MINI_WINDOW_P (w));
10990
10991 /* By default, start display at the beginning. */
10992 set_marker_both (w->start, w->contents,
10993 BUF_BEGV (XBUFFER (w->contents)),
10994 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10995
10996 /* Don't resize windows while redisplaying a window; it would
10997 confuse redisplay functions when the size of the window they are
10998 displaying changes from under them. Such a resizing can happen,
10999 for instance, when which-func prints a long message while
11000 we are running fontification-functions. We're running these
11001 functions with safe_call which binds inhibit-redisplay to t. */
11002 if (!NILP (Vinhibit_redisplay))
11003 return false;
11004
11005 /* Nil means don't try to resize. */
11006 if (NILP (Vresize_mini_windows)
11007 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
11008 return false;
11009
11010 if (!FRAME_MINIBUF_ONLY_P (f))
11011 {
11012 struct it it;
11013 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
11014 + WINDOW_PIXEL_HEIGHT (w));
11015 int unit = FRAME_LINE_HEIGHT (f);
11016 int height, max_height;
11017 struct text_pos start;
11018 struct buffer *old_current_buffer = NULL;
11019
11020 if (current_buffer != XBUFFER (w->contents))
11021 {
11022 old_current_buffer = current_buffer;
11023 set_buffer_internal (XBUFFER (w->contents));
11024 }
11025
11026 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
11027
11028 /* Compute the max. number of lines specified by the user. */
11029 if (FLOATP (Vmax_mini_window_height))
11030 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
11031 else if (INTEGERP (Vmax_mini_window_height))
11032 max_height = XINT (Vmax_mini_window_height) * unit;
11033 else
11034 max_height = total_height / 4;
11035
11036 /* Correct that max. height if it's bogus. */
11037 max_height = clip_to_bounds (unit, max_height, total_height);
11038
11039 /* Find out the height of the text in the window. */
11040 if (it.line_wrap == TRUNCATE)
11041 height = unit;
11042 else
11043 {
11044 last_height = 0;
11045 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
11046 if (it.max_ascent == 0 && it.max_descent == 0)
11047 height = it.current_y + last_height;
11048 else
11049 height = it.current_y + it.max_ascent + it.max_descent;
11050 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
11051 }
11052
11053 /* Compute a suitable window start. */
11054 if (height > max_height)
11055 {
11056 height = (max_height / unit) * unit;
11057 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
11058 move_it_vertically_backward (&it, height - unit);
11059 start = it.current.pos;
11060 }
11061 else
11062 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
11063 SET_MARKER_FROM_TEXT_POS (w->start, start);
11064
11065 if (EQ (Vresize_mini_windows, Qgrow_only))
11066 {
11067 /* Let it grow only, until we display an empty message, in which
11068 case the window shrinks again. */
11069 if (height > WINDOW_PIXEL_HEIGHT (w))
11070 {
11071 int old_height = WINDOW_PIXEL_HEIGHT (w);
11072
11073 FRAME_WINDOWS_FROZEN (f) = true;
11074 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
11075 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11076 }
11077 else if (height < WINDOW_PIXEL_HEIGHT (w)
11078 && (exact_p || BEGV == ZV))
11079 {
11080 int old_height = WINDOW_PIXEL_HEIGHT (w);
11081
11082 FRAME_WINDOWS_FROZEN (f) = false;
11083 shrink_mini_window (w, true);
11084 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11085 }
11086 }
11087 else
11088 {
11089 /* Always resize to exact size needed. */
11090 if (height > WINDOW_PIXEL_HEIGHT (w))
11091 {
11092 int old_height = WINDOW_PIXEL_HEIGHT (w);
11093
11094 FRAME_WINDOWS_FROZEN (f) = true;
11095 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
11096 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11097 }
11098 else if (height < WINDOW_PIXEL_HEIGHT (w))
11099 {
11100 int old_height = WINDOW_PIXEL_HEIGHT (w);
11101
11102 FRAME_WINDOWS_FROZEN (f) = false;
11103 shrink_mini_window (w, true);
11104
11105 if (height)
11106 {
11107 FRAME_WINDOWS_FROZEN (f) = true;
11108 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), true);
11109 }
11110
11111 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11112 }
11113 }
11114
11115 if (old_current_buffer)
11116 set_buffer_internal (old_current_buffer);
11117 }
11118
11119 return window_height_changed_p;
11120 }
11121
11122
11123 /* Value is the current message, a string, or nil if there is no
11124 current message. */
11125
11126 Lisp_Object
11127 current_message (void)
11128 {
11129 Lisp_Object msg;
11130
11131 if (!BUFFERP (echo_area_buffer[0]))
11132 msg = Qnil;
11133 else
11134 {
11135 with_echo_area_buffer (0, 0, current_message_1,
11136 (intptr_t) &msg, Qnil);
11137 if (NILP (msg))
11138 echo_area_buffer[0] = Qnil;
11139 }
11140
11141 return msg;
11142 }
11143
11144
11145 static bool
11146 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
11147 {
11148 intptr_t i1 = a1;
11149 Lisp_Object *msg = (Lisp_Object *) i1;
11150
11151 if (Z > BEG)
11152 *msg = make_buffer_string (BEG, Z, true);
11153 else
11154 *msg = Qnil;
11155 return false;
11156 }
11157
11158
11159 /* Push the current message on Vmessage_stack for later restoration
11160 by restore_message. Value is true if the current message isn't
11161 empty. This is a relatively infrequent operation, so it's not
11162 worth optimizing. */
11163
11164 bool
11165 push_message (void)
11166 {
11167 Lisp_Object msg = current_message ();
11168 Vmessage_stack = Fcons (msg, Vmessage_stack);
11169 return STRINGP (msg);
11170 }
11171
11172
11173 /* Restore message display from the top of Vmessage_stack. */
11174
11175 void
11176 restore_message (void)
11177 {
11178 eassert (CONSP (Vmessage_stack));
11179 message3_nolog (XCAR (Vmessage_stack));
11180 }
11181
11182
11183 /* Handler for unwind-protect calling pop_message. */
11184
11185 void
11186 pop_message_unwind (void)
11187 {
11188 /* Pop the top-most entry off Vmessage_stack. */
11189 eassert (CONSP (Vmessage_stack));
11190 Vmessage_stack = XCDR (Vmessage_stack);
11191 }
11192
11193
11194 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11195 exits. If the stack is not empty, we have a missing pop_message
11196 somewhere. */
11197
11198 void
11199 check_message_stack (void)
11200 {
11201 if (!NILP (Vmessage_stack))
11202 emacs_abort ();
11203 }
11204
11205
11206 /* Truncate to NCHARS what will be displayed in the echo area the next
11207 time we display it---but don't redisplay it now. */
11208
11209 void
11210 truncate_echo_area (ptrdiff_t nchars)
11211 {
11212 if (nchars == 0)
11213 echo_area_buffer[0] = Qnil;
11214 else if (!noninteractive
11215 && INTERACTIVE
11216 && !NILP (echo_area_buffer[0]))
11217 {
11218 struct frame *sf = SELECTED_FRAME ();
11219 /* Error messages get reported properly by cmd_error, so this must be
11220 just an informative message; if the frame hasn't really been
11221 initialized yet, just toss it. */
11222 if (sf->glyphs_initialized_p)
11223 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
11224 }
11225 }
11226
11227
11228 /* Helper function for truncate_echo_area. Truncate the current
11229 message to at most NCHARS characters. */
11230
11231 static bool
11232 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11233 {
11234 if (BEG + nchars < Z)
11235 del_range (BEG + nchars, Z);
11236 if (Z == BEG)
11237 echo_area_buffer[0] = Qnil;
11238 return false;
11239 }
11240
11241 /* Set the current message to STRING. */
11242
11243 static void
11244 set_message (Lisp_Object string)
11245 {
11246 eassert (STRINGP (string));
11247
11248 message_enable_multibyte = STRING_MULTIBYTE (string);
11249
11250 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11251 message_buf_print = false;
11252 help_echo_showing_p = false;
11253
11254 if (STRINGP (Vdebug_on_message)
11255 && STRINGP (string)
11256 && fast_string_match (Vdebug_on_message, string) >= 0)
11257 call_debugger (list2 (Qerror, string));
11258 }
11259
11260
11261 /* Helper function for set_message. First argument is ignored and second
11262 argument has the same meaning as for set_message.
11263 This function is called with the echo area buffer being current. */
11264
11265 static bool
11266 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11267 {
11268 eassert (STRINGP (string));
11269
11270 /* Change multibyteness of the echo buffer appropriately. */
11271 if (message_enable_multibyte
11272 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11273 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11274
11275 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11276 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11277 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11278
11279 /* Insert new message at BEG. */
11280 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11281
11282 /* This function takes care of single/multibyte conversion.
11283 We just have to ensure that the echo area buffer has the right
11284 setting of enable_multibyte_characters. */
11285 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), true);
11286
11287 return false;
11288 }
11289
11290
11291 /* Clear messages. CURRENT_P means clear the current message.
11292 LAST_DISPLAYED_P means clear the message last displayed. */
11293
11294 void
11295 clear_message (bool current_p, bool last_displayed_p)
11296 {
11297 if (current_p)
11298 {
11299 echo_area_buffer[0] = Qnil;
11300 message_cleared_p = true;
11301 }
11302
11303 if (last_displayed_p)
11304 echo_area_buffer[1] = Qnil;
11305
11306 message_buf_print = false;
11307 }
11308
11309 /* Clear garbaged frames.
11310
11311 This function is used where the old redisplay called
11312 redraw_garbaged_frames which in turn called redraw_frame which in
11313 turn called clear_frame. The call to clear_frame was a source of
11314 flickering. I believe a clear_frame is not necessary. It should
11315 suffice in the new redisplay to invalidate all current matrices,
11316 and ensure a complete redisplay of all windows. */
11317
11318 static void
11319 clear_garbaged_frames (void)
11320 {
11321 if (frame_garbaged)
11322 {
11323 Lisp_Object tail, frame;
11324 struct frame *sf = SELECTED_FRAME ();
11325
11326 FOR_EACH_FRAME (tail, frame)
11327 {
11328 struct frame *f = XFRAME (frame);
11329
11330 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11331 {
11332 if (f->resized_p
11333 /* It makes no sense to redraw a non-selected TTY
11334 frame, since that will actually clear the
11335 selected frame, and might leave the selected
11336 frame with corrupted display, if it happens not
11337 to be marked garbaged. */
11338 && !(f != sf && (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))))
11339 redraw_frame (f);
11340 else
11341 clear_current_matrices (f);
11342 fset_redisplay (f);
11343 f->garbaged = false;
11344 f->resized_p = false;
11345 }
11346 }
11347
11348 frame_garbaged = false;
11349 }
11350 }
11351
11352
11353 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P, update
11354 selected_frame. */
11355
11356 static void
11357 echo_area_display (bool update_frame_p)
11358 {
11359 Lisp_Object mini_window;
11360 struct window *w;
11361 struct frame *f;
11362 bool window_height_changed_p = false;
11363 struct frame *sf = SELECTED_FRAME ();
11364
11365 mini_window = FRAME_MINIBUF_WINDOW (sf);
11366 w = XWINDOW (mini_window);
11367 f = XFRAME (WINDOW_FRAME (w));
11368
11369 /* Don't display if frame is invisible or not yet initialized. */
11370 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11371 return;
11372
11373 #ifdef HAVE_WINDOW_SYSTEM
11374 /* When Emacs starts, selected_frame may be the initial terminal
11375 frame. If we let this through, a message would be displayed on
11376 the terminal. */
11377 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11378 return;
11379 #endif /* HAVE_WINDOW_SYSTEM */
11380
11381 /* Redraw garbaged frames. */
11382 clear_garbaged_frames ();
11383
11384 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11385 {
11386 echo_area_window = mini_window;
11387 window_height_changed_p = display_echo_area (w);
11388 w->must_be_updated_p = true;
11389
11390 /* Update the display, unless called from redisplay_internal.
11391 Also don't update the screen during redisplay itself. The
11392 update will happen at the end of redisplay, and an update
11393 here could cause confusion. */
11394 if (update_frame_p && !redisplaying_p)
11395 {
11396 int n = 0;
11397
11398 /* If the display update has been interrupted by pending
11399 input, update mode lines in the frame. Due to the
11400 pending input, it might have been that redisplay hasn't
11401 been called, so that mode lines above the echo area are
11402 garbaged. This looks odd, so we prevent it here. */
11403 if (!display_completed)
11404 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11405
11406 if (window_height_changed_p
11407 /* Don't do this if Emacs is shutting down. Redisplay
11408 needs to run hooks. */
11409 && !NILP (Vrun_hooks))
11410 {
11411 /* Must update other windows. Likewise as in other
11412 cases, don't let this update be interrupted by
11413 pending input. */
11414 ptrdiff_t count = SPECPDL_INDEX ();
11415 specbind (Qredisplay_dont_pause, Qt);
11416 fset_redisplay (f);
11417 redisplay_internal ();
11418 unbind_to (count, Qnil);
11419 }
11420 else if (FRAME_WINDOW_P (f) && n == 0)
11421 {
11422 /* Window configuration is the same as before.
11423 Can do with a display update of the echo area,
11424 unless we displayed some mode lines. */
11425 update_single_window (w);
11426 flush_frame (f);
11427 }
11428 else
11429 update_frame (f, true, true);
11430
11431 /* If cursor is in the echo area, make sure that the next
11432 redisplay displays the minibuffer, so that the cursor will
11433 be replaced with what the minibuffer wants. */
11434 if (cursor_in_echo_area)
11435 wset_redisplay (XWINDOW (mini_window));
11436 }
11437 }
11438 else if (!EQ (mini_window, selected_window))
11439 wset_redisplay (XWINDOW (mini_window));
11440
11441 /* Last displayed message is now the current message. */
11442 echo_area_buffer[1] = echo_area_buffer[0];
11443 /* Inform read_char that we're not echoing. */
11444 echo_message_buffer = Qnil;
11445
11446 /* Prevent redisplay optimization in redisplay_internal by resetting
11447 this_line_start_pos. This is done because the mini-buffer now
11448 displays the message instead of its buffer text. */
11449 if (EQ (mini_window, selected_window))
11450 CHARPOS (this_line_start_pos) = 0;
11451
11452 if (window_height_changed_p)
11453 {
11454 fset_redisplay (f);
11455
11456 /* If window configuration was changed, frames may have been
11457 marked garbaged. Clear them or we will experience
11458 surprises wrt scrolling.
11459 FIXME: How/why/when? */
11460 clear_garbaged_frames ();
11461 }
11462 }
11463
11464 /* True if W's buffer was changed but not saved. */
11465
11466 static bool
11467 window_buffer_changed (struct window *w)
11468 {
11469 struct buffer *b = XBUFFER (w->contents);
11470
11471 eassert (BUFFER_LIVE_P (b));
11472
11473 return (BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star;
11474 }
11475
11476 /* True if W has %c in its mode line and mode line should be updated. */
11477
11478 static bool
11479 mode_line_update_needed (struct window *w)
11480 {
11481 return (w->column_number_displayed != -1
11482 && !(PT == w->last_point && !window_outdated (w))
11483 && (w->column_number_displayed != current_column ()));
11484 }
11485
11486 /* True if window start of W is frozen and may not be changed during
11487 redisplay. */
11488
11489 static bool
11490 window_frozen_p (struct window *w)
11491 {
11492 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11493 {
11494 Lisp_Object window;
11495
11496 XSETWINDOW (window, w);
11497 if (MINI_WINDOW_P (w))
11498 return false;
11499 else if (EQ (window, selected_window))
11500 return false;
11501 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11502 && EQ (window, Vminibuf_scroll_window))
11503 /* This special window can't be frozen too. */
11504 return false;
11505 else
11506 return true;
11507 }
11508 return false;
11509 }
11510
11511 /***********************************************************************
11512 Mode Lines and Frame Titles
11513 ***********************************************************************/
11514
11515 /* A buffer for constructing non-propertized mode-line strings and
11516 frame titles in it; allocated from the heap in init_xdisp and
11517 resized as needed in store_mode_line_noprop_char. */
11518
11519 static char *mode_line_noprop_buf;
11520
11521 /* The buffer's end, and a current output position in it. */
11522
11523 static char *mode_line_noprop_buf_end;
11524 static char *mode_line_noprop_ptr;
11525
11526 #define MODE_LINE_NOPROP_LEN(start) \
11527 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11528
11529 static enum {
11530 MODE_LINE_DISPLAY = 0,
11531 MODE_LINE_TITLE,
11532 MODE_LINE_NOPROP,
11533 MODE_LINE_STRING
11534 } mode_line_target;
11535
11536 /* Alist that caches the results of :propertize.
11537 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11538 static Lisp_Object mode_line_proptrans_alist;
11539
11540 /* List of strings making up the mode-line. */
11541 static Lisp_Object mode_line_string_list;
11542
11543 /* Base face property when building propertized mode line string. */
11544 static Lisp_Object mode_line_string_face;
11545 static Lisp_Object mode_line_string_face_prop;
11546
11547
11548 /* Unwind data for mode line strings */
11549
11550 static Lisp_Object Vmode_line_unwind_vector;
11551
11552 static Lisp_Object
11553 format_mode_line_unwind_data (struct frame *target_frame,
11554 struct buffer *obuf,
11555 Lisp_Object owin,
11556 bool save_proptrans)
11557 {
11558 Lisp_Object vector, tmp;
11559
11560 /* Reduce consing by keeping one vector in
11561 Vwith_echo_area_save_vector. */
11562 vector = Vmode_line_unwind_vector;
11563 Vmode_line_unwind_vector = Qnil;
11564
11565 if (NILP (vector))
11566 vector = Fmake_vector (make_number (10), Qnil);
11567
11568 ASET (vector, 0, make_number (mode_line_target));
11569 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11570 ASET (vector, 2, mode_line_string_list);
11571 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11572 ASET (vector, 4, mode_line_string_face);
11573 ASET (vector, 5, mode_line_string_face_prop);
11574
11575 if (obuf)
11576 XSETBUFFER (tmp, obuf);
11577 else
11578 tmp = Qnil;
11579 ASET (vector, 6, tmp);
11580 ASET (vector, 7, owin);
11581 if (target_frame)
11582 {
11583 /* Similarly to `with-selected-window', if the operation selects
11584 a window on another frame, we must restore that frame's
11585 selected window, and (for a tty) the top-frame. */
11586 ASET (vector, 8, target_frame->selected_window);
11587 if (FRAME_TERMCAP_P (target_frame))
11588 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11589 }
11590
11591 return vector;
11592 }
11593
11594 static void
11595 unwind_format_mode_line (Lisp_Object vector)
11596 {
11597 Lisp_Object old_window = AREF (vector, 7);
11598 Lisp_Object target_frame_window = AREF (vector, 8);
11599 Lisp_Object old_top_frame = AREF (vector, 9);
11600
11601 mode_line_target = XINT (AREF (vector, 0));
11602 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11603 mode_line_string_list = AREF (vector, 2);
11604 if (! EQ (AREF (vector, 3), Qt))
11605 mode_line_proptrans_alist = AREF (vector, 3);
11606 mode_line_string_face = AREF (vector, 4);
11607 mode_line_string_face_prop = AREF (vector, 5);
11608
11609 /* Select window before buffer, since it may change the buffer. */
11610 if (!NILP (old_window))
11611 {
11612 /* If the operation that we are unwinding had selected a window
11613 on a different frame, reset its frame-selected-window. For a
11614 text terminal, reset its top-frame if necessary. */
11615 if (!NILP (target_frame_window))
11616 {
11617 Lisp_Object frame
11618 = WINDOW_FRAME (XWINDOW (target_frame_window));
11619
11620 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11621 Fselect_window (target_frame_window, Qt);
11622
11623 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11624 Fselect_frame (old_top_frame, Qt);
11625 }
11626
11627 Fselect_window (old_window, Qt);
11628 }
11629
11630 if (!NILP (AREF (vector, 6)))
11631 {
11632 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11633 ASET (vector, 6, Qnil);
11634 }
11635
11636 Vmode_line_unwind_vector = vector;
11637 }
11638
11639
11640 /* Store a single character C for the frame title in mode_line_noprop_buf.
11641 Re-allocate mode_line_noprop_buf if necessary. */
11642
11643 static void
11644 store_mode_line_noprop_char (char c)
11645 {
11646 /* If output position has reached the end of the allocated buffer,
11647 increase the buffer's size. */
11648 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11649 {
11650 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11651 ptrdiff_t size = len;
11652 mode_line_noprop_buf =
11653 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11654 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11655 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11656 }
11657
11658 *mode_line_noprop_ptr++ = c;
11659 }
11660
11661
11662 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11663 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11664 characters that yield more columns than PRECISION; PRECISION <= 0
11665 means copy the whole string. Pad with spaces until FIELD_WIDTH
11666 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11667 pad. Called from display_mode_element when it is used to build a
11668 frame title. */
11669
11670 static int
11671 store_mode_line_noprop (const char *string, int field_width, int precision)
11672 {
11673 const unsigned char *str = (const unsigned char *) string;
11674 int n = 0;
11675 ptrdiff_t dummy, nbytes;
11676
11677 /* Copy at most PRECISION chars from STR. */
11678 nbytes = strlen (string);
11679 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11680 while (nbytes--)
11681 store_mode_line_noprop_char (*str++);
11682
11683 /* Fill up with spaces until FIELD_WIDTH reached. */
11684 while (field_width > 0
11685 && n < field_width)
11686 {
11687 store_mode_line_noprop_char (' ');
11688 ++n;
11689 }
11690
11691 return n;
11692 }
11693
11694 /***********************************************************************
11695 Frame Titles
11696 ***********************************************************************/
11697
11698 #ifdef HAVE_WINDOW_SYSTEM
11699
11700 /* Set the title of FRAME, if it has changed. The title format is
11701 Vicon_title_format if FRAME is iconified, otherwise it is
11702 frame_title_format. */
11703
11704 static void
11705 x_consider_frame_title (Lisp_Object frame)
11706 {
11707 struct frame *f = XFRAME (frame);
11708
11709 if ((FRAME_WINDOW_P (f)
11710 || FRAME_MINIBUF_ONLY_P (f)
11711 || f->explicit_name)
11712 && !FRAME_TOOLTIP_P (f))
11713 {
11714 /* Do we have more than one visible frame on this X display? */
11715 Lisp_Object tail, other_frame, fmt;
11716 ptrdiff_t title_start;
11717 char *title;
11718 ptrdiff_t len;
11719 struct it it;
11720 ptrdiff_t count = SPECPDL_INDEX ();
11721
11722 FOR_EACH_FRAME (tail, other_frame)
11723 {
11724 struct frame *tf = XFRAME (other_frame);
11725
11726 if (tf != f
11727 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11728 && !FRAME_MINIBUF_ONLY_P (tf)
11729 && !FRAME_TOOLTIP_P (tf)
11730 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11731 break;
11732 }
11733
11734 /* Set global variable indicating that multiple frames exist. */
11735 multiple_frames = CONSP (tail);
11736
11737 /* Switch to the buffer of selected window of the frame. Set up
11738 mode_line_target so that display_mode_element will output into
11739 mode_line_noprop_buf; then display the title. */
11740 record_unwind_protect (unwind_format_mode_line,
11741 format_mode_line_unwind_data
11742 (f, current_buffer, selected_window, false));
11743
11744 Fselect_window (f->selected_window, Qt);
11745 set_buffer_internal_1
11746 (XBUFFER (XWINDOW (f->selected_window)->contents));
11747 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11748
11749 mode_line_target = MODE_LINE_TITLE;
11750 title_start = MODE_LINE_NOPROP_LEN (0);
11751 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11752 NULL, DEFAULT_FACE_ID);
11753 display_mode_element (&it, 0, -1, -1, fmt, Qnil, false);
11754 len = MODE_LINE_NOPROP_LEN (title_start);
11755 title = mode_line_noprop_buf + title_start;
11756 unbind_to (count, Qnil);
11757
11758 /* Set the title only if it's changed. This avoids consing in
11759 the common case where it hasn't. (If it turns out that we've
11760 already wasted too much time by walking through the list with
11761 display_mode_element, then we might need to optimize at a
11762 higher level than this.) */
11763 if (! STRINGP (f->name)
11764 || SBYTES (f->name) != len
11765 || memcmp (title, SDATA (f->name), len) != 0)
11766 x_implicitly_set_name (f, make_string (title, len), Qnil);
11767 }
11768 }
11769
11770 #endif /* not HAVE_WINDOW_SYSTEM */
11771
11772 \f
11773 /***********************************************************************
11774 Menu Bars
11775 ***********************************************************************/
11776
11777 /* True if we will not redisplay all visible windows. */
11778 #define REDISPLAY_SOME_P() \
11779 ((windows_or_buffers_changed == 0 \
11780 || windows_or_buffers_changed == REDISPLAY_SOME) \
11781 && (update_mode_lines == 0 \
11782 || update_mode_lines == REDISPLAY_SOME))
11783
11784 /* Prepare for redisplay by updating menu-bar item lists when
11785 appropriate. This can call eval. */
11786
11787 static void
11788 prepare_menu_bars (void)
11789 {
11790 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11791 bool some_windows = REDISPLAY_SOME_P ();
11792
11793 if (FUNCTIONP (Vpre_redisplay_function))
11794 {
11795 Lisp_Object windows = all_windows ? Qt : Qnil;
11796 if (all_windows && some_windows)
11797 {
11798 Lisp_Object ws = window_list ();
11799 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11800 {
11801 Lisp_Object this = XCAR (ws);
11802 struct window *w = XWINDOW (this);
11803 if (w->redisplay
11804 || XFRAME (w->frame)->redisplay
11805 || XBUFFER (w->contents)->text->redisplay)
11806 {
11807 windows = Fcons (this, windows);
11808 }
11809 }
11810 }
11811 safe__call1 (true, Vpre_redisplay_function, windows);
11812 }
11813
11814 /* Update all frame titles based on their buffer names, etc. We do
11815 this before the menu bars so that the buffer-menu will show the
11816 up-to-date frame titles. */
11817 #ifdef HAVE_WINDOW_SYSTEM
11818 if (all_windows)
11819 {
11820 Lisp_Object tail, frame;
11821
11822 FOR_EACH_FRAME (tail, frame)
11823 {
11824 struct frame *f = XFRAME (frame);
11825 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11826 if (some_windows
11827 && !f->redisplay
11828 && !w->redisplay
11829 && !XBUFFER (w->contents)->text->redisplay)
11830 continue;
11831
11832 if (!FRAME_TOOLTIP_P (f)
11833 && (FRAME_ICONIFIED_P (f)
11834 || FRAME_VISIBLE_P (f) == 1
11835 /* Exclude TTY frames that are obscured because they
11836 are not the top frame on their console. This is
11837 because x_consider_frame_title actually switches
11838 to the frame, which for TTY frames means it is
11839 marked as garbaged, and will be completely
11840 redrawn on the next redisplay cycle. This causes
11841 TTY frames to be completely redrawn, when there
11842 are more than one of them, even though nothing
11843 should be changed on display. */
11844 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11845 x_consider_frame_title (frame);
11846 }
11847 }
11848 #endif /* HAVE_WINDOW_SYSTEM */
11849
11850 /* Update the menu bar item lists, if appropriate. This has to be
11851 done before any actual redisplay or generation of display lines. */
11852
11853 if (all_windows)
11854 {
11855 Lisp_Object tail, frame;
11856 ptrdiff_t count = SPECPDL_INDEX ();
11857 /* True means that update_menu_bar has run its hooks
11858 so any further calls to update_menu_bar shouldn't do so again. */
11859 bool menu_bar_hooks_run = false;
11860
11861 record_unwind_save_match_data ();
11862
11863 FOR_EACH_FRAME (tail, frame)
11864 {
11865 struct frame *f = XFRAME (frame);
11866 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11867
11868 /* Ignore tooltip frame. */
11869 if (FRAME_TOOLTIP_P (f))
11870 continue;
11871
11872 if (some_windows
11873 && !f->redisplay
11874 && !w->redisplay
11875 && !XBUFFER (w->contents)->text->redisplay)
11876 continue;
11877
11878 run_window_size_change_functions (frame);
11879 menu_bar_hooks_run = update_menu_bar (f, false, menu_bar_hooks_run);
11880 #ifdef HAVE_WINDOW_SYSTEM
11881 update_tool_bar (f, false);
11882 #endif
11883 }
11884
11885 unbind_to (count, Qnil);
11886 }
11887 else
11888 {
11889 struct frame *sf = SELECTED_FRAME ();
11890 update_menu_bar (sf, true, false);
11891 #ifdef HAVE_WINDOW_SYSTEM
11892 update_tool_bar (sf, true);
11893 #endif
11894 }
11895 }
11896
11897
11898 /* Update the menu bar item list for frame F. This has to be done
11899 before we start to fill in any display lines, because it can call
11900 eval.
11901
11902 If SAVE_MATCH_DATA, we must save and restore it here.
11903
11904 If HOOKS_RUN, a previous call to update_menu_bar
11905 already ran the menu bar hooks for this redisplay, so there
11906 is no need to run them again. The return value is the
11907 updated value of this flag, to pass to the next call. */
11908
11909 static bool
11910 update_menu_bar (struct frame *f, bool save_match_data, bool hooks_run)
11911 {
11912 Lisp_Object window;
11913 struct window *w;
11914
11915 /* If called recursively during a menu update, do nothing. This can
11916 happen when, for instance, an activate-menubar-hook causes a
11917 redisplay. */
11918 if (inhibit_menubar_update)
11919 return hooks_run;
11920
11921 window = FRAME_SELECTED_WINDOW (f);
11922 w = XWINDOW (window);
11923
11924 if (FRAME_WINDOW_P (f)
11925 ?
11926 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11927 || defined (HAVE_NS) || defined (USE_GTK)
11928 FRAME_EXTERNAL_MENU_BAR (f)
11929 #else
11930 FRAME_MENU_BAR_LINES (f) > 0
11931 #endif
11932 : FRAME_MENU_BAR_LINES (f) > 0)
11933 {
11934 /* If the user has switched buffers or windows, we need to
11935 recompute to reflect the new bindings. But we'll
11936 recompute when update_mode_lines is set too; that means
11937 that people can use force-mode-line-update to request
11938 that the menu bar be recomputed. The adverse effect on
11939 the rest of the redisplay algorithm is about the same as
11940 windows_or_buffers_changed anyway. */
11941 if (windows_or_buffers_changed
11942 /* This used to test w->update_mode_line, but we believe
11943 there is no need to recompute the menu in that case. */
11944 || update_mode_lines
11945 || window_buffer_changed (w))
11946 {
11947 struct buffer *prev = current_buffer;
11948 ptrdiff_t count = SPECPDL_INDEX ();
11949
11950 specbind (Qinhibit_menubar_update, Qt);
11951
11952 set_buffer_internal_1 (XBUFFER (w->contents));
11953 if (save_match_data)
11954 record_unwind_save_match_data ();
11955 if (NILP (Voverriding_local_map_menu_flag))
11956 {
11957 specbind (Qoverriding_terminal_local_map, Qnil);
11958 specbind (Qoverriding_local_map, Qnil);
11959 }
11960
11961 if (!hooks_run)
11962 {
11963 /* Run the Lucid hook. */
11964 safe_run_hooks (Qactivate_menubar_hook);
11965
11966 /* If it has changed current-menubar from previous value,
11967 really recompute the menu-bar from the value. */
11968 if (! NILP (Vlucid_menu_bar_dirty_flag))
11969 call0 (Qrecompute_lucid_menubar);
11970
11971 safe_run_hooks (Qmenu_bar_update_hook);
11972
11973 hooks_run = true;
11974 }
11975
11976 XSETFRAME (Vmenu_updating_frame, f);
11977 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11978
11979 /* Redisplay the menu bar in case we changed it. */
11980 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11981 || defined (HAVE_NS) || defined (USE_GTK)
11982 if (FRAME_WINDOW_P (f))
11983 {
11984 #if defined (HAVE_NS)
11985 /* All frames on Mac OS share the same menubar. So only
11986 the selected frame should be allowed to set it. */
11987 if (f == SELECTED_FRAME ())
11988 #endif
11989 set_frame_menubar (f, false, false);
11990 }
11991 else
11992 /* On a terminal screen, the menu bar is an ordinary screen
11993 line, and this makes it get updated. */
11994 w->update_mode_line = true;
11995 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11996 /* In the non-toolkit version, the menu bar is an ordinary screen
11997 line, and this makes it get updated. */
11998 w->update_mode_line = true;
11999 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
12000
12001 unbind_to (count, Qnil);
12002 set_buffer_internal_1 (prev);
12003 }
12004 }
12005
12006 return hooks_run;
12007 }
12008
12009 /***********************************************************************
12010 Tool-bars
12011 ***********************************************************************/
12012
12013 #ifdef HAVE_WINDOW_SYSTEM
12014
12015 /* Select `frame' temporarily without running all the code in
12016 do_switch_frame.
12017 FIXME: Maybe do_switch_frame should be trimmed down similarly
12018 when `norecord' is set. */
12019 static void
12020 fast_set_selected_frame (Lisp_Object frame)
12021 {
12022 if (!EQ (selected_frame, frame))
12023 {
12024 selected_frame = frame;
12025 selected_window = XFRAME (frame)->selected_window;
12026 }
12027 }
12028
12029 /* Update the tool-bar item list for frame F. This has to be done
12030 before we start to fill in any display lines. Called from
12031 prepare_menu_bars. If SAVE_MATCH_DATA, we must save
12032 and restore it here. */
12033
12034 static void
12035 update_tool_bar (struct frame *f, bool save_match_data)
12036 {
12037 #if defined (USE_GTK) || defined (HAVE_NS)
12038 bool do_update = FRAME_EXTERNAL_TOOL_BAR (f);
12039 #else
12040 bool do_update = (WINDOWP (f->tool_bar_window)
12041 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0);
12042 #endif
12043
12044 if (do_update)
12045 {
12046 Lisp_Object window;
12047 struct window *w;
12048
12049 window = FRAME_SELECTED_WINDOW (f);
12050 w = XWINDOW (window);
12051
12052 /* If the user has switched buffers or windows, we need to
12053 recompute to reflect the new bindings. But we'll
12054 recompute when update_mode_lines is set too; that means
12055 that people can use force-mode-line-update to request
12056 that the menu bar be recomputed. The adverse effect on
12057 the rest of the redisplay algorithm is about the same as
12058 windows_or_buffers_changed anyway. */
12059 if (windows_or_buffers_changed
12060 || w->update_mode_line
12061 || update_mode_lines
12062 || window_buffer_changed (w))
12063 {
12064 struct buffer *prev = current_buffer;
12065 ptrdiff_t count = SPECPDL_INDEX ();
12066 Lisp_Object frame, new_tool_bar;
12067 int new_n_tool_bar;
12068
12069 /* Set current_buffer to the buffer of the selected
12070 window of the frame, so that we get the right local
12071 keymaps. */
12072 set_buffer_internal_1 (XBUFFER (w->contents));
12073
12074 /* Save match data, if we must. */
12075 if (save_match_data)
12076 record_unwind_save_match_data ();
12077
12078 /* Make sure that we don't accidentally use bogus keymaps. */
12079 if (NILP (Voverriding_local_map_menu_flag))
12080 {
12081 specbind (Qoverriding_terminal_local_map, Qnil);
12082 specbind (Qoverriding_local_map, Qnil);
12083 }
12084
12085 /* We must temporarily set the selected frame to this frame
12086 before calling tool_bar_items, because the calculation of
12087 the tool-bar keymap uses the selected frame (see
12088 `tool-bar-make-keymap' in tool-bar.el). */
12089 eassert (EQ (selected_window,
12090 /* Since we only explicitly preserve selected_frame,
12091 check that selected_window would be redundant. */
12092 XFRAME (selected_frame)->selected_window));
12093 record_unwind_protect (fast_set_selected_frame, selected_frame);
12094 XSETFRAME (frame, f);
12095 fast_set_selected_frame (frame);
12096
12097 /* Build desired tool-bar items from keymaps. */
12098 new_tool_bar
12099 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
12100 &new_n_tool_bar);
12101
12102 /* Redisplay the tool-bar if we changed it. */
12103 if (new_n_tool_bar != f->n_tool_bar_items
12104 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
12105 {
12106 /* Redisplay that happens asynchronously due to an expose event
12107 may access f->tool_bar_items. Make sure we update both
12108 variables within BLOCK_INPUT so no such event interrupts. */
12109 block_input ();
12110 fset_tool_bar_items (f, new_tool_bar);
12111 f->n_tool_bar_items = new_n_tool_bar;
12112 w->update_mode_line = true;
12113 unblock_input ();
12114 }
12115
12116 unbind_to (count, Qnil);
12117 set_buffer_internal_1 (prev);
12118 }
12119 }
12120 }
12121
12122 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12123
12124 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12125 F's desired tool-bar contents. F->tool_bar_items must have
12126 been set up previously by calling prepare_menu_bars. */
12127
12128 static void
12129 build_desired_tool_bar_string (struct frame *f)
12130 {
12131 int i, size, size_needed;
12132 Lisp_Object image, plist;
12133
12134 image = plist = Qnil;
12135
12136 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12137 Otherwise, make a new string. */
12138
12139 /* The size of the string we might be able to reuse. */
12140 size = (STRINGP (f->desired_tool_bar_string)
12141 ? SCHARS (f->desired_tool_bar_string)
12142 : 0);
12143
12144 /* We need one space in the string for each image. */
12145 size_needed = f->n_tool_bar_items;
12146
12147 /* Reuse f->desired_tool_bar_string, if possible. */
12148 if (size < size_needed || NILP (f->desired_tool_bar_string))
12149 fset_desired_tool_bar_string
12150 (f, Fmake_string (make_number (size_needed), make_number (' ')));
12151 else
12152 {
12153 AUTO_LIST4 (props, Qdisplay, Qnil, Qmenu_item, Qnil);
12154 Fremove_text_properties (make_number (0), make_number (size),
12155 props, f->desired_tool_bar_string);
12156 }
12157
12158 /* Put a `display' property on the string for the images to display,
12159 put a `menu_item' property on tool-bar items with a value that
12160 is the index of the item in F's tool-bar item vector. */
12161 for (i = 0; i < f->n_tool_bar_items; ++i)
12162 {
12163 #define PROP(IDX) \
12164 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12165
12166 bool enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
12167 bool selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
12168 int hmargin, vmargin, relief, idx, end;
12169
12170 /* If image is a vector, choose the image according to the
12171 button state. */
12172 image = PROP (TOOL_BAR_ITEM_IMAGES);
12173 if (VECTORP (image))
12174 {
12175 if (enabled_p)
12176 idx = (selected_p
12177 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12178 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
12179 else
12180 idx = (selected_p
12181 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12182 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
12183
12184 eassert (ASIZE (image) >= idx);
12185 image = AREF (image, idx);
12186 }
12187 else
12188 idx = -1;
12189
12190 /* Ignore invalid image specifications. */
12191 if (!valid_image_p (image))
12192 continue;
12193
12194 /* Display the tool-bar button pressed, or depressed. */
12195 plist = Fcopy_sequence (XCDR (image));
12196
12197 /* Compute margin and relief to draw. */
12198 relief = (tool_bar_button_relief >= 0
12199 ? tool_bar_button_relief
12200 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12201 hmargin = vmargin = relief;
12202
12203 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12204 INT_MAX - max (hmargin, vmargin)))
12205 {
12206 hmargin += XFASTINT (Vtool_bar_button_margin);
12207 vmargin += XFASTINT (Vtool_bar_button_margin);
12208 }
12209 else if (CONSP (Vtool_bar_button_margin))
12210 {
12211 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12212 INT_MAX - hmargin))
12213 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12214
12215 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12216 INT_MAX - vmargin))
12217 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12218 }
12219
12220 if (auto_raise_tool_bar_buttons_p)
12221 {
12222 /* Add a `:relief' property to the image spec if the item is
12223 selected. */
12224 if (selected_p)
12225 {
12226 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12227 hmargin -= relief;
12228 vmargin -= relief;
12229 }
12230 }
12231 else
12232 {
12233 /* If image is selected, display it pressed, i.e. with a
12234 negative relief. If it's not selected, display it with a
12235 raised relief. */
12236 plist = Fplist_put (plist, QCrelief,
12237 (selected_p
12238 ? make_number (-relief)
12239 : make_number (relief)));
12240 hmargin -= relief;
12241 vmargin -= relief;
12242 }
12243
12244 /* Put a margin around the image. */
12245 if (hmargin || vmargin)
12246 {
12247 if (hmargin == vmargin)
12248 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12249 else
12250 plist = Fplist_put (plist, QCmargin,
12251 Fcons (make_number (hmargin),
12252 make_number (vmargin)));
12253 }
12254
12255 /* If button is not enabled, and we don't have special images
12256 for the disabled state, make the image appear disabled by
12257 applying an appropriate algorithm to it. */
12258 if (!enabled_p && idx < 0)
12259 plist = Fplist_put (plist, QCconversion, Qdisabled);
12260
12261 /* Put a `display' text property on the string for the image to
12262 display. Put a `menu-item' property on the string that gives
12263 the start of this item's properties in the tool-bar items
12264 vector. */
12265 image = Fcons (Qimage, plist);
12266 AUTO_LIST4 (props, Qdisplay, image, Qmenu_item,
12267 make_number (i * TOOL_BAR_ITEM_NSLOTS));
12268
12269 /* Let the last image hide all remaining spaces in the tool bar
12270 string. The string can be longer than needed when we reuse a
12271 previous string. */
12272 if (i + 1 == f->n_tool_bar_items)
12273 end = SCHARS (f->desired_tool_bar_string);
12274 else
12275 end = i + 1;
12276 Fadd_text_properties (make_number (i), make_number (end),
12277 props, f->desired_tool_bar_string);
12278 #undef PROP
12279 }
12280 }
12281
12282
12283 /* Display one line of the tool-bar of frame IT->f.
12284
12285 HEIGHT specifies the desired height of the tool-bar line.
12286 If the actual height of the glyph row is less than HEIGHT, the
12287 row's height is increased to HEIGHT, and the icons are centered
12288 vertically in the new height.
12289
12290 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12291 count a final empty row in case the tool-bar width exactly matches
12292 the window width.
12293 */
12294
12295 static void
12296 display_tool_bar_line (struct it *it, int height)
12297 {
12298 struct glyph_row *row = it->glyph_row;
12299 int max_x = it->last_visible_x;
12300 struct glyph *last;
12301
12302 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12303 clear_glyph_row (row);
12304 row->enabled_p = true;
12305 row->y = it->current_y;
12306
12307 /* Note that this isn't made use of if the face hasn't a box,
12308 so there's no need to check the face here. */
12309 it->start_of_box_run_p = true;
12310
12311 while (it->current_x < max_x)
12312 {
12313 int x, n_glyphs_before, i, nglyphs;
12314 struct it it_before;
12315
12316 /* Get the next display element. */
12317 if (!get_next_display_element (it))
12318 {
12319 /* Don't count empty row if we are counting needed tool-bar lines. */
12320 if (height < 0 && !it->hpos)
12321 return;
12322 break;
12323 }
12324
12325 /* Produce glyphs. */
12326 n_glyphs_before = row->used[TEXT_AREA];
12327 it_before = *it;
12328
12329 PRODUCE_GLYPHS (it);
12330
12331 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12332 i = 0;
12333 x = it_before.current_x;
12334 while (i < nglyphs)
12335 {
12336 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12337
12338 if (x + glyph->pixel_width > max_x)
12339 {
12340 /* Glyph doesn't fit on line. Backtrack. */
12341 row->used[TEXT_AREA] = n_glyphs_before;
12342 *it = it_before;
12343 /* If this is the only glyph on this line, it will never fit on the
12344 tool-bar, so skip it. But ensure there is at least one glyph,
12345 so we don't accidentally disable the tool-bar. */
12346 if (n_glyphs_before == 0
12347 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12348 break;
12349 goto out;
12350 }
12351
12352 ++it->hpos;
12353 x += glyph->pixel_width;
12354 ++i;
12355 }
12356
12357 /* Stop at line end. */
12358 if (ITERATOR_AT_END_OF_LINE_P (it))
12359 break;
12360
12361 set_iterator_to_next (it, true);
12362 }
12363
12364 out:;
12365
12366 row->displays_text_p = row->used[TEXT_AREA] != 0;
12367
12368 /* Use default face for the border below the tool bar.
12369
12370 FIXME: When auto-resize-tool-bars is grow-only, there is
12371 no additional border below the possibly empty tool-bar lines.
12372 So to make the extra empty lines look "normal", we have to
12373 use the tool-bar face for the border too. */
12374 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12375 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12376 it->face_id = DEFAULT_FACE_ID;
12377
12378 extend_face_to_end_of_line (it);
12379 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12380 last->right_box_line_p = true;
12381 if (last == row->glyphs[TEXT_AREA])
12382 last->left_box_line_p = true;
12383
12384 /* Make line the desired height and center it vertically. */
12385 if ((height -= it->max_ascent + it->max_descent) > 0)
12386 {
12387 /* Don't add more than one line height. */
12388 height %= FRAME_LINE_HEIGHT (it->f);
12389 it->max_ascent += height / 2;
12390 it->max_descent += (height + 1) / 2;
12391 }
12392
12393 compute_line_metrics (it);
12394
12395 /* If line is empty, make it occupy the rest of the tool-bar. */
12396 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12397 {
12398 row->height = row->phys_height = it->last_visible_y - row->y;
12399 row->visible_height = row->height;
12400 row->ascent = row->phys_ascent = 0;
12401 row->extra_line_spacing = 0;
12402 }
12403
12404 row->full_width_p = true;
12405 row->continued_p = false;
12406 row->truncated_on_left_p = false;
12407 row->truncated_on_right_p = false;
12408
12409 it->current_x = it->hpos = 0;
12410 it->current_y += row->height;
12411 ++it->vpos;
12412 ++it->glyph_row;
12413 }
12414
12415
12416 /* Value is the number of pixels needed to make all tool-bar items of
12417 frame F visible. The actual number of glyph rows needed is
12418 returned in *N_ROWS if non-NULL. */
12419 static int
12420 tool_bar_height (struct frame *f, int *n_rows, bool pixelwise)
12421 {
12422 struct window *w = XWINDOW (f->tool_bar_window);
12423 struct it it;
12424 /* tool_bar_height is called from redisplay_tool_bar after building
12425 the desired matrix, so use (unused) mode-line row as temporary row to
12426 avoid destroying the first tool-bar row. */
12427 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
12428
12429 /* Initialize an iterator for iteration over
12430 F->desired_tool_bar_string in the tool-bar window of frame F. */
12431 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
12432 temp_row->reversed_p = false;
12433 it.first_visible_x = 0;
12434 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12435 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12436 it.paragraph_embedding = L2R;
12437
12438 while (!ITERATOR_AT_END_P (&it))
12439 {
12440 clear_glyph_row (temp_row);
12441 it.glyph_row = temp_row;
12442 display_tool_bar_line (&it, -1);
12443 }
12444 clear_glyph_row (temp_row);
12445
12446 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12447 if (n_rows)
12448 *n_rows = it.vpos > 0 ? it.vpos : -1;
12449
12450 if (pixelwise)
12451 return it.current_y;
12452 else
12453 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12454 }
12455
12456 #endif /* !USE_GTK && !HAVE_NS */
12457
12458 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12459 0, 2, 0,
12460 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12461 If FRAME is nil or omitted, use the selected frame. Optional argument
12462 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12463 (Lisp_Object frame, Lisp_Object pixelwise)
12464 {
12465 int height = 0;
12466
12467 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12468 struct frame *f = decode_any_frame (frame);
12469
12470 if (WINDOWP (f->tool_bar_window)
12471 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12472 {
12473 update_tool_bar (f, true);
12474 if (f->n_tool_bar_items)
12475 {
12476 build_desired_tool_bar_string (f);
12477 height = tool_bar_height (f, NULL, !NILP (pixelwise));
12478 }
12479 }
12480 #endif
12481
12482 return make_number (height);
12483 }
12484
12485
12486 /* Display the tool-bar of frame F. Value is true if tool-bar's
12487 height should be changed. */
12488 static bool
12489 redisplay_tool_bar (struct frame *f)
12490 {
12491 f->tool_bar_redisplayed = true;
12492 #if defined (USE_GTK) || defined (HAVE_NS)
12493
12494 if (FRAME_EXTERNAL_TOOL_BAR (f))
12495 update_frame_tool_bar (f);
12496 return false;
12497
12498 #else /* !USE_GTK && !HAVE_NS */
12499
12500 struct window *w;
12501 struct it it;
12502 struct glyph_row *row;
12503
12504 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12505 do anything. This means you must start with tool-bar-lines
12506 non-zero to get the auto-sizing effect. Or in other words, you
12507 can turn off tool-bars by specifying tool-bar-lines zero. */
12508 if (!WINDOWP (f->tool_bar_window)
12509 || (w = XWINDOW (f->tool_bar_window),
12510 WINDOW_TOTAL_LINES (w) == 0))
12511 return false;
12512
12513 /* Set up an iterator for the tool-bar window. */
12514 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12515 it.first_visible_x = 0;
12516 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12517 row = it.glyph_row;
12518 row->reversed_p = false;
12519
12520 /* Build a string that represents the contents of the tool-bar. */
12521 build_desired_tool_bar_string (f);
12522 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12523 /* FIXME: This should be controlled by a user option. But it
12524 doesn't make sense to have an R2L tool bar if the menu bar cannot
12525 be drawn also R2L, and making the menu bar R2L is tricky due
12526 toolkit-specific code that implements it. If an R2L tool bar is
12527 ever supported, display_tool_bar_line should also be augmented to
12528 call unproduce_glyphs like display_line and display_string
12529 do. */
12530 it.paragraph_embedding = L2R;
12531
12532 if (f->n_tool_bar_rows == 0)
12533 {
12534 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, true);
12535
12536 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12537 {
12538 x_change_tool_bar_height (f, new_height);
12539 frame_default_tool_bar_height = new_height;
12540 /* Always do that now. */
12541 clear_glyph_matrix (w->desired_matrix);
12542 f->fonts_changed = true;
12543 return true;
12544 }
12545 }
12546
12547 /* Display as many lines as needed to display all tool-bar items. */
12548
12549 if (f->n_tool_bar_rows > 0)
12550 {
12551 int border, rows, height, extra;
12552
12553 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12554 border = XINT (Vtool_bar_border);
12555 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12556 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12557 else if (EQ (Vtool_bar_border, Qborder_width))
12558 border = f->border_width;
12559 else
12560 border = 0;
12561 if (border < 0)
12562 border = 0;
12563
12564 rows = f->n_tool_bar_rows;
12565 height = max (1, (it.last_visible_y - border) / rows);
12566 extra = it.last_visible_y - border - height * rows;
12567
12568 while (it.current_y < it.last_visible_y)
12569 {
12570 int h = 0;
12571 if (extra > 0 && rows-- > 0)
12572 {
12573 h = (extra + rows - 1) / rows;
12574 extra -= h;
12575 }
12576 display_tool_bar_line (&it, height + h);
12577 }
12578 }
12579 else
12580 {
12581 while (it.current_y < it.last_visible_y)
12582 display_tool_bar_line (&it, 0);
12583 }
12584
12585 /* It doesn't make much sense to try scrolling in the tool-bar
12586 window, so don't do it. */
12587 w->desired_matrix->no_scrolling_p = true;
12588 w->must_be_updated_p = true;
12589
12590 if (!NILP (Vauto_resize_tool_bars))
12591 {
12592 bool change_height_p = true;
12593
12594 /* If we couldn't display everything, change the tool-bar's
12595 height if there is room for more. */
12596 if (IT_STRING_CHARPOS (it) < it.end_charpos)
12597 change_height_p = true;
12598
12599 /* We subtract 1 because display_tool_bar_line advances the
12600 glyph_row pointer before returning to its caller. We want to
12601 examine the last glyph row produced by
12602 display_tool_bar_line. */
12603 row = it.glyph_row - 1;
12604
12605 /* If there are blank lines at the end, except for a partially
12606 visible blank line at the end that is smaller than
12607 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12608 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12609 && row->height >= FRAME_LINE_HEIGHT (f))
12610 change_height_p = true;
12611
12612 /* If row displays tool-bar items, but is partially visible,
12613 change the tool-bar's height. */
12614 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12615 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y)
12616 change_height_p = true;
12617
12618 /* Resize windows as needed by changing the `tool-bar-lines'
12619 frame parameter. */
12620 if (change_height_p)
12621 {
12622 int nrows;
12623 int new_height = tool_bar_height (f, &nrows, true);
12624
12625 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12626 && !f->minimize_tool_bar_window_p)
12627 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12628 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12629 f->minimize_tool_bar_window_p = false;
12630
12631 if (change_height_p)
12632 {
12633 x_change_tool_bar_height (f, new_height);
12634 frame_default_tool_bar_height = new_height;
12635 clear_glyph_matrix (w->desired_matrix);
12636 f->n_tool_bar_rows = nrows;
12637 f->fonts_changed = true;
12638
12639 return true;
12640 }
12641 }
12642 }
12643
12644 f->minimize_tool_bar_window_p = false;
12645 return false;
12646
12647 #endif /* USE_GTK || HAVE_NS */
12648 }
12649
12650 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12651
12652 /* Get information about the tool-bar item which is displayed in GLYPH
12653 on frame F. Return in *PROP_IDX the index where tool-bar item
12654 properties start in F->tool_bar_items. Value is false if
12655 GLYPH doesn't display a tool-bar item. */
12656
12657 static bool
12658 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12659 {
12660 Lisp_Object prop;
12661 int charpos;
12662
12663 /* This function can be called asynchronously, which means we must
12664 exclude any possibility that Fget_text_property signals an
12665 error. */
12666 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12667 charpos = max (0, charpos);
12668
12669 /* Get the text property `menu-item' at pos. The value of that
12670 property is the start index of this item's properties in
12671 F->tool_bar_items. */
12672 prop = Fget_text_property (make_number (charpos),
12673 Qmenu_item, f->current_tool_bar_string);
12674 if (! INTEGERP (prop))
12675 return false;
12676 *prop_idx = XINT (prop);
12677 return true;
12678 }
12679
12680 \f
12681 /* Get information about the tool-bar item at position X/Y on frame F.
12682 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12683 the current matrix of the tool-bar window of F, or NULL if not
12684 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12685 item in F->tool_bar_items. Value is
12686
12687 -1 if X/Y is not on a tool-bar item
12688 0 if X/Y is on the same item that was highlighted before.
12689 1 otherwise. */
12690
12691 static int
12692 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12693 int *hpos, int *vpos, int *prop_idx)
12694 {
12695 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12696 struct window *w = XWINDOW (f->tool_bar_window);
12697 int area;
12698
12699 /* Find the glyph under X/Y. */
12700 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12701 if (*glyph == NULL)
12702 return -1;
12703
12704 /* Get the start of this tool-bar item's properties in
12705 f->tool_bar_items. */
12706 if (!tool_bar_item_info (f, *glyph, prop_idx))
12707 return -1;
12708
12709 /* Is mouse on the highlighted item? */
12710 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12711 && *vpos >= hlinfo->mouse_face_beg_row
12712 && *vpos <= hlinfo->mouse_face_end_row
12713 && (*vpos > hlinfo->mouse_face_beg_row
12714 || *hpos >= hlinfo->mouse_face_beg_col)
12715 && (*vpos < hlinfo->mouse_face_end_row
12716 || *hpos < hlinfo->mouse_face_end_col
12717 || hlinfo->mouse_face_past_end))
12718 return 0;
12719
12720 return 1;
12721 }
12722
12723
12724 /* EXPORT:
12725 Handle mouse button event on the tool-bar of frame F, at
12726 frame-relative coordinates X/Y. DOWN_P is true for a button press,
12727 false for button release. MODIFIERS is event modifiers for button
12728 release. */
12729
12730 void
12731 handle_tool_bar_click (struct frame *f, int x, int y, bool down_p,
12732 int modifiers)
12733 {
12734 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12735 struct window *w = XWINDOW (f->tool_bar_window);
12736 int hpos, vpos, prop_idx;
12737 struct glyph *glyph;
12738 Lisp_Object enabled_p;
12739 int ts;
12740
12741 /* If not on the highlighted tool-bar item, and mouse-highlight is
12742 non-nil, return. This is so we generate the tool-bar button
12743 click only when the mouse button is released on the same item as
12744 where it was pressed. However, when mouse-highlight is disabled,
12745 generate the click when the button is released regardless of the
12746 highlight, since tool-bar items are not highlighted in that
12747 case. */
12748 frame_to_window_pixel_xy (w, &x, &y);
12749 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12750 if (ts == -1
12751 || (ts != 0 && !NILP (Vmouse_highlight)))
12752 return;
12753
12754 /* When mouse-highlight is off, generate the click for the item
12755 where the button was pressed, disregarding where it was
12756 released. */
12757 if (NILP (Vmouse_highlight) && !down_p)
12758 prop_idx = f->last_tool_bar_item;
12759
12760 /* If item is disabled, do nothing. */
12761 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12762 if (NILP (enabled_p))
12763 return;
12764
12765 if (down_p)
12766 {
12767 /* Show item in pressed state. */
12768 if (!NILP (Vmouse_highlight))
12769 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12770 f->last_tool_bar_item = prop_idx;
12771 }
12772 else
12773 {
12774 Lisp_Object key, frame;
12775 struct input_event event;
12776 EVENT_INIT (event);
12777
12778 /* Show item in released state. */
12779 if (!NILP (Vmouse_highlight))
12780 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12781
12782 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12783
12784 XSETFRAME (frame, f);
12785 event.kind = TOOL_BAR_EVENT;
12786 event.frame_or_window = frame;
12787 event.arg = frame;
12788 kbd_buffer_store_event (&event);
12789
12790 event.kind = TOOL_BAR_EVENT;
12791 event.frame_or_window = frame;
12792 event.arg = key;
12793 event.modifiers = modifiers;
12794 kbd_buffer_store_event (&event);
12795 f->last_tool_bar_item = -1;
12796 }
12797 }
12798
12799
12800 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12801 tool-bar window-relative coordinates X/Y. Called from
12802 note_mouse_highlight. */
12803
12804 static void
12805 note_tool_bar_highlight (struct frame *f, int x, int y)
12806 {
12807 Lisp_Object window = f->tool_bar_window;
12808 struct window *w = XWINDOW (window);
12809 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12810 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12811 int hpos, vpos;
12812 struct glyph *glyph;
12813 struct glyph_row *row;
12814 int i;
12815 Lisp_Object enabled_p;
12816 int prop_idx;
12817 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12818 bool mouse_down_p;
12819 int rc;
12820
12821 /* Function note_mouse_highlight is called with negative X/Y
12822 values when mouse moves outside of the frame. */
12823 if (x <= 0 || y <= 0)
12824 {
12825 clear_mouse_face (hlinfo);
12826 return;
12827 }
12828
12829 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12830 if (rc < 0)
12831 {
12832 /* Not on tool-bar item. */
12833 clear_mouse_face (hlinfo);
12834 return;
12835 }
12836 else if (rc == 0)
12837 /* On same tool-bar item as before. */
12838 goto set_help_echo;
12839
12840 clear_mouse_face (hlinfo);
12841
12842 /* Mouse is down, but on different tool-bar item? */
12843 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12844 && f == dpyinfo->last_mouse_frame);
12845
12846 if (mouse_down_p && f->last_tool_bar_item != prop_idx)
12847 return;
12848
12849 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12850
12851 /* If tool-bar item is not enabled, don't highlight it. */
12852 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12853 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12854 {
12855 /* Compute the x-position of the glyph. In front and past the
12856 image is a space. We include this in the highlighted area. */
12857 row = MATRIX_ROW (w->current_matrix, vpos);
12858 for (i = x = 0; i < hpos; ++i)
12859 x += row->glyphs[TEXT_AREA][i].pixel_width;
12860
12861 /* Record this as the current active region. */
12862 hlinfo->mouse_face_beg_col = hpos;
12863 hlinfo->mouse_face_beg_row = vpos;
12864 hlinfo->mouse_face_beg_x = x;
12865 hlinfo->mouse_face_past_end = false;
12866
12867 hlinfo->mouse_face_end_col = hpos + 1;
12868 hlinfo->mouse_face_end_row = vpos;
12869 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12870 hlinfo->mouse_face_window = window;
12871 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12872
12873 /* Display it as active. */
12874 show_mouse_face (hlinfo, draw);
12875 }
12876
12877 set_help_echo:
12878
12879 /* Set help_echo_string to a help string to display for this tool-bar item.
12880 XTread_socket does the rest. */
12881 help_echo_object = help_echo_window = Qnil;
12882 help_echo_pos = -1;
12883 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12884 if (NILP (help_echo_string))
12885 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12886 }
12887
12888 #endif /* !USE_GTK && !HAVE_NS */
12889
12890 #endif /* HAVE_WINDOW_SYSTEM */
12891
12892
12893 \f
12894 /************************************************************************
12895 Horizontal scrolling
12896 ************************************************************************/
12897
12898 /* For all leaf windows in the window tree rooted at WINDOW, set their
12899 hscroll value so that PT is (i) visible in the window, and (ii) so
12900 that it is not within a certain margin at the window's left and
12901 right border. Value is true if any window's hscroll has been
12902 changed. */
12903
12904 static bool
12905 hscroll_window_tree (Lisp_Object window)
12906 {
12907 bool hscrolled_p = false;
12908 bool hscroll_relative_p = FLOATP (Vhscroll_step);
12909 int hscroll_step_abs = 0;
12910 double hscroll_step_rel = 0;
12911
12912 if (hscroll_relative_p)
12913 {
12914 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12915 if (hscroll_step_rel < 0)
12916 {
12917 hscroll_relative_p = false;
12918 hscroll_step_abs = 0;
12919 }
12920 }
12921 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12922 {
12923 hscroll_step_abs = XINT (Vhscroll_step);
12924 if (hscroll_step_abs < 0)
12925 hscroll_step_abs = 0;
12926 }
12927 else
12928 hscroll_step_abs = 0;
12929
12930 while (WINDOWP (window))
12931 {
12932 struct window *w = XWINDOW (window);
12933
12934 if (WINDOWP (w->contents))
12935 hscrolled_p |= hscroll_window_tree (w->contents);
12936 else if (w->cursor.vpos >= 0)
12937 {
12938 int h_margin;
12939 int text_area_width;
12940 struct glyph_row *cursor_row;
12941 struct glyph_row *bottom_row;
12942
12943 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12944 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12945 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12946 else
12947 cursor_row = bottom_row - 1;
12948
12949 if (!cursor_row->enabled_p)
12950 {
12951 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12952 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12953 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12954 else
12955 cursor_row = bottom_row - 1;
12956 }
12957 bool row_r2l_p = cursor_row->reversed_p;
12958
12959 text_area_width = window_box_width (w, TEXT_AREA);
12960
12961 /* Scroll when cursor is inside this scroll margin. */
12962 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12963
12964 /* If the position of this window's point has explicitly
12965 changed, no more suspend auto hscrolling. */
12966 if (NILP (Fequal (Fwindow_point (window), Fwindow_old_point (window))))
12967 w->suspend_auto_hscroll = false;
12968
12969 /* Remember window point. */
12970 Fset_marker (w->old_pointm,
12971 ((w == XWINDOW (selected_window))
12972 ? make_number (BUF_PT (XBUFFER (w->contents)))
12973 : Fmarker_position (w->pointm)),
12974 w->contents);
12975
12976 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12977 && !w->suspend_auto_hscroll
12978 /* In some pathological cases, like restoring a window
12979 configuration into a frame that is much smaller than
12980 the one from which the configuration was saved, we
12981 get glyph rows whose start and end have zero buffer
12982 positions, which we cannot handle below. Just skip
12983 such windows. */
12984 && CHARPOS (cursor_row->start.pos) >= BUF_BEG (w->contents)
12985 /* For left-to-right rows, hscroll when cursor is either
12986 (i) inside the right hscroll margin, or (ii) if it is
12987 inside the left margin and the window is already
12988 hscrolled. */
12989 && ((!row_r2l_p
12990 && ((w->hscroll && w->cursor.x <= h_margin)
12991 || (cursor_row->enabled_p
12992 && cursor_row->truncated_on_right_p
12993 && (w->cursor.x >= text_area_width - h_margin))))
12994 /* For right-to-left rows, the logic is similar,
12995 except that rules for scrolling to left and right
12996 are reversed. E.g., if cursor.x <= h_margin, we
12997 need to hscroll "to the right" unconditionally,
12998 and that will scroll the screen to the left so as
12999 to reveal the next portion of the row. */
13000 || (row_r2l_p
13001 && ((cursor_row->enabled_p
13002 /* FIXME: It is confusing to set the
13003 truncated_on_right_p flag when R2L rows
13004 are actually truncated on the left. */
13005 && cursor_row->truncated_on_right_p
13006 && w->cursor.x <= h_margin)
13007 || (w->hscroll
13008 && (w->cursor.x >= text_area_width - h_margin))))))
13009 {
13010 struct it it;
13011 ptrdiff_t hscroll;
13012 struct buffer *saved_current_buffer;
13013 ptrdiff_t pt;
13014 int wanted_x;
13015
13016 /* Find point in a display of infinite width. */
13017 saved_current_buffer = current_buffer;
13018 current_buffer = XBUFFER (w->contents);
13019
13020 if (w == XWINDOW (selected_window))
13021 pt = PT;
13022 else
13023 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
13024
13025 /* Move iterator to pt starting at cursor_row->start in
13026 a line with infinite width. */
13027 init_to_row_start (&it, w, cursor_row);
13028 it.last_visible_x = INFINITY;
13029 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
13030 current_buffer = saved_current_buffer;
13031
13032 /* Position cursor in window. */
13033 if (!hscroll_relative_p && hscroll_step_abs == 0)
13034 hscroll = max (0, (it.current_x
13035 - (ITERATOR_AT_END_OF_LINE_P (&it)
13036 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
13037 : (text_area_width / 2))))
13038 / FRAME_COLUMN_WIDTH (it.f);
13039 else if ((!row_r2l_p
13040 && w->cursor.x >= text_area_width - h_margin)
13041 || (row_r2l_p && w->cursor.x <= h_margin))
13042 {
13043 if (hscroll_relative_p)
13044 wanted_x = text_area_width * (1 - hscroll_step_rel)
13045 - h_margin;
13046 else
13047 wanted_x = text_area_width
13048 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
13049 - h_margin;
13050 hscroll
13051 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
13052 }
13053 else
13054 {
13055 if (hscroll_relative_p)
13056 wanted_x = text_area_width * hscroll_step_rel
13057 + h_margin;
13058 else
13059 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
13060 + h_margin;
13061 hscroll
13062 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
13063 }
13064 hscroll = max (hscroll, w->min_hscroll);
13065
13066 /* Don't prevent redisplay optimizations if hscroll
13067 hasn't changed, as it will unnecessarily slow down
13068 redisplay. */
13069 if (w->hscroll != hscroll)
13070 {
13071 struct buffer *b = XBUFFER (w->contents);
13072 b->prevent_redisplay_optimizations_p = true;
13073 w->hscroll = hscroll;
13074 hscrolled_p = true;
13075 }
13076 }
13077 }
13078
13079 window = w->next;
13080 }
13081
13082 /* Value is true if hscroll of any leaf window has been changed. */
13083 return hscrolled_p;
13084 }
13085
13086
13087 /* Set hscroll so that cursor is visible and not inside horizontal
13088 scroll margins for all windows in the tree rooted at WINDOW. See
13089 also hscroll_window_tree above. Value is true if any window's
13090 hscroll has been changed. If it has, desired matrices on the frame
13091 of WINDOW are cleared. */
13092
13093 static bool
13094 hscroll_windows (Lisp_Object window)
13095 {
13096 bool hscrolled_p = hscroll_window_tree (window);
13097 if (hscrolled_p)
13098 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
13099 return hscrolled_p;
13100 }
13101
13102
13103 \f
13104 /************************************************************************
13105 Redisplay
13106 ************************************************************************/
13107
13108 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined.
13109 This is sometimes handy to have in a debugger session. */
13110
13111 #ifdef GLYPH_DEBUG
13112
13113 /* First and last unchanged row for try_window_id. */
13114
13115 static int debug_first_unchanged_at_end_vpos;
13116 static int debug_last_unchanged_at_beg_vpos;
13117
13118 /* Delta vpos and y. */
13119
13120 static int debug_dvpos, debug_dy;
13121
13122 /* Delta in characters and bytes for try_window_id. */
13123
13124 static ptrdiff_t debug_delta, debug_delta_bytes;
13125
13126 /* Values of window_end_pos and window_end_vpos at the end of
13127 try_window_id. */
13128
13129 static ptrdiff_t debug_end_vpos;
13130
13131 /* Append a string to W->desired_matrix->method. FMT is a printf
13132 format string. If trace_redisplay_p is true also printf the
13133 resulting string to stderr. */
13134
13135 static void debug_method_add (struct window *, char const *, ...)
13136 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13137
13138 static void
13139 debug_method_add (struct window *w, char const *fmt, ...)
13140 {
13141 void *ptr = w;
13142 char *method = w->desired_matrix->method;
13143 int len = strlen (method);
13144 int size = sizeof w->desired_matrix->method;
13145 int remaining = size - len - 1;
13146 va_list ap;
13147
13148 if (len && remaining)
13149 {
13150 method[len] = '|';
13151 --remaining, ++len;
13152 }
13153
13154 va_start (ap, fmt);
13155 vsnprintf (method + len, remaining + 1, fmt, ap);
13156 va_end (ap);
13157
13158 if (trace_redisplay_p)
13159 fprintf (stderr, "%p (%s): %s\n",
13160 ptr,
13161 ((BUFFERP (w->contents)
13162 && STRINGP (BVAR (XBUFFER (w->contents), name)))
13163 ? SSDATA (BVAR (XBUFFER (w->contents), name))
13164 : "no buffer"),
13165 method + len);
13166 }
13167
13168 #endif /* GLYPH_DEBUG */
13169
13170
13171 /* Value is true if all changes in window W, which displays
13172 current_buffer, are in the text between START and END. START is a
13173 buffer position, END is given as a distance from Z. Used in
13174 redisplay_internal for display optimization. */
13175
13176 static bool
13177 text_outside_line_unchanged_p (struct window *w,
13178 ptrdiff_t start, ptrdiff_t end)
13179 {
13180 bool unchanged_p = true;
13181
13182 /* If text or overlays have changed, see where. */
13183 if (window_outdated (w))
13184 {
13185 /* Gap in the line? */
13186 if (GPT < start || Z - GPT < end)
13187 unchanged_p = false;
13188
13189 /* Changes start in front of the line, or end after it? */
13190 if (unchanged_p
13191 && (BEG_UNCHANGED < start - 1
13192 || END_UNCHANGED < end))
13193 unchanged_p = false;
13194
13195 /* If selective display, can't optimize if changes start at the
13196 beginning of the line. */
13197 if (unchanged_p
13198 && INTEGERP (BVAR (current_buffer, selective_display))
13199 && XINT (BVAR (current_buffer, selective_display)) > 0
13200 && (BEG_UNCHANGED < start || GPT <= start))
13201 unchanged_p = false;
13202
13203 /* If there are overlays at the start or end of the line, these
13204 may have overlay strings with newlines in them. A change at
13205 START, for instance, may actually concern the display of such
13206 overlay strings as well, and they are displayed on different
13207 lines. So, quickly rule out this case. (For the future, it
13208 might be desirable to implement something more telling than
13209 just BEG/END_UNCHANGED.) */
13210 if (unchanged_p)
13211 {
13212 if (BEG + BEG_UNCHANGED == start
13213 && overlay_touches_p (start))
13214 unchanged_p = false;
13215 if (END_UNCHANGED == end
13216 && overlay_touches_p (Z - end))
13217 unchanged_p = false;
13218 }
13219
13220 /* Under bidi reordering, adding or deleting a character in the
13221 beginning of a paragraph, before the first strong directional
13222 character, can change the base direction of the paragraph (unless
13223 the buffer specifies a fixed paragraph direction), which will
13224 require redisplaying the whole paragraph. It might be worthwhile
13225 to find the paragraph limits and widen the range of redisplayed
13226 lines to that, but for now just give up this optimization. */
13227 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13228 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13229 unchanged_p = false;
13230 }
13231
13232 return unchanged_p;
13233 }
13234
13235
13236 /* Do a frame update, taking possible shortcuts into account. This is
13237 the main external entry point for redisplay.
13238
13239 If the last redisplay displayed an echo area message and that message
13240 is no longer requested, we clear the echo area or bring back the
13241 mini-buffer if that is in use. */
13242
13243 void
13244 redisplay (void)
13245 {
13246 redisplay_internal ();
13247 }
13248
13249
13250 static Lisp_Object
13251 overlay_arrow_string_or_property (Lisp_Object var)
13252 {
13253 Lisp_Object val;
13254
13255 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13256 return val;
13257
13258 return Voverlay_arrow_string;
13259 }
13260
13261 /* Return true if there are any overlay-arrows in current_buffer. */
13262 static bool
13263 overlay_arrow_in_current_buffer_p (void)
13264 {
13265 Lisp_Object vlist;
13266
13267 for (vlist = Voverlay_arrow_variable_list;
13268 CONSP (vlist);
13269 vlist = XCDR (vlist))
13270 {
13271 Lisp_Object var = XCAR (vlist);
13272 Lisp_Object val;
13273
13274 if (!SYMBOLP (var))
13275 continue;
13276 val = find_symbol_value (var);
13277 if (MARKERP (val)
13278 && current_buffer == XMARKER (val)->buffer)
13279 return true;
13280 }
13281 return false;
13282 }
13283
13284
13285 /* Return true if any overlay_arrows have moved or overlay-arrow-string
13286 has changed. */
13287
13288 static bool
13289 overlay_arrows_changed_p (void)
13290 {
13291 Lisp_Object vlist;
13292
13293 for (vlist = Voverlay_arrow_variable_list;
13294 CONSP (vlist);
13295 vlist = XCDR (vlist))
13296 {
13297 Lisp_Object var = XCAR (vlist);
13298 Lisp_Object val, pstr;
13299
13300 if (!SYMBOLP (var))
13301 continue;
13302 val = find_symbol_value (var);
13303 if (!MARKERP (val))
13304 continue;
13305 if (! EQ (COERCE_MARKER (val),
13306 Fget (var, Qlast_arrow_position))
13307 || ! (pstr = overlay_arrow_string_or_property (var),
13308 EQ (pstr, Fget (var, Qlast_arrow_string))))
13309 return true;
13310 }
13311 return false;
13312 }
13313
13314 /* Mark overlay arrows to be updated on next redisplay. */
13315
13316 static void
13317 update_overlay_arrows (int up_to_date)
13318 {
13319 Lisp_Object vlist;
13320
13321 for (vlist = Voverlay_arrow_variable_list;
13322 CONSP (vlist);
13323 vlist = XCDR (vlist))
13324 {
13325 Lisp_Object var = XCAR (vlist);
13326
13327 if (!SYMBOLP (var))
13328 continue;
13329
13330 if (up_to_date > 0)
13331 {
13332 Lisp_Object val = find_symbol_value (var);
13333 Fput (var, Qlast_arrow_position,
13334 COERCE_MARKER (val));
13335 Fput (var, Qlast_arrow_string,
13336 overlay_arrow_string_or_property (var));
13337 }
13338 else if (up_to_date < 0
13339 || !NILP (Fget (var, Qlast_arrow_position)))
13340 {
13341 Fput (var, Qlast_arrow_position, Qt);
13342 Fput (var, Qlast_arrow_string, Qt);
13343 }
13344 }
13345 }
13346
13347
13348 /* Return overlay arrow string to display at row.
13349 Return integer (bitmap number) for arrow bitmap in left fringe.
13350 Return nil if no overlay arrow. */
13351
13352 static Lisp_Object
13353 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13354 {
13355 Lisp_Object vlist;
13356
13357 for (vlist = Voverlay_arrow_variable_list;
13358 CONSP (vlist);
13359 vlist = XCDR (vlist))
13360 {
13361 Lisp_Object var = XCAR (vlist);
13362 Lisp_Object val;
13363
13364 if (!SYMBOLP (var))
13365 continue;
13366
13367 val = find_symbol_value (var);
13368
13369 if (MARKERP (val)
13370 && current_buffer == XMARKER (val)->buffer
13371 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13372 {
13373 if (FRAME_WINDOW_P (it->f)
13374 /* FIXME: if ROW->reversed_p is set, this should test
13375 the right fringe, not the left one. */
13376 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13377 {
13378 #ifdef HAVE_WINDOW_SYSTEM
13379 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13380 {
13381 int fringe_bitmap = lookup_fringe_bitmap (val);
13382 if (fringe_bitmap != 0)
13383 return make_number (fringe_bitmap);
13384 }
13385 #endif
13386 return make_number (-1); /* Use default arrow bitmap. */
13387 }
13388 return overlay_arrow_string_or_property (var);
13389 }
13390 }
13391
13392 return Qnil;
13393 }
13394
13395 /* Return true if point moved out of or into a composition. Otherwise
13396 return false. PREV_BUF and PREV_PT are the last point buffer and
13397 position. BUF and PT are the current point buffer and position. */
13398
13399 static bool
13400 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13401 struct buffer *buf, ptrdiff_t pt)
13402 {
13403 ptrdiff_t start, end;
13404 Lisp_Object prop;
13405 Lisp_Object buffer;
13406
13407 XSETBUFFER (buffer, buf);
13408 /* Check a composition at the last point if point moved within the
13409 same buffer. */
13410 if (prev_buf == buf)
13411 {
13412 if (prev_pt == pt)
13413 /* Point didn't move. */
13414 return false;
13415
13416 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13417 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13418 && composition_valid_p (start, end, prop)
13419 && start < prev_pt && end > prev_pt)
13420 /* The last point was within the composition. Return true iff
13421 point moved out of the composition. */
13422 return (pt <= start || pt >= end);
13423 }
13424
13425 /* Check a composition at the current point. */
13426 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13427 && find_composition (pt, -1, &start, &end, &prop, buffer)
13428 && composition_valid_p (start, end, prop)
13429 && start < pt && end > pt);
13430 }
13431
13432 /* Reconsider the clip changes of buffer which is displayed in W. */
13433
13434 static void
13435 reconsider_clip_changes (struct window *w)
13436 {
13437 struct buffer *b = XBUFFER (w->contents);
13438
13439 if (b->clip_changed
13440 && w->window_end_valid
13441 && w->current_matrix->buffer == b
13442 && w->current_matrix->zv == BUF_ZV (b)
13443 && w->current_matrix->begv == BUF_BEGV (b))
13444 b->clip_changed = false;
13445
13446 /* If display wasn't paused, and W is not a tool bar window, see if
13447 point has been moved into or out of a composition. In that case,
13448 set b->clip_changed to force updating the screen. If
13449 b->clip_changed has already been set, skip this check. */
13450 if (!b->clip_changed && w->window_end_valid)
13451 {
13452 ptrdiff_t pt = (w == XWINDOW (selected_window)
13453 ? PT : marker_position (w->pointm));
13454
13455 if ((w->current_matrix->buffer != b || pt != w->last_point)
13456 && check_point_in_composition (w->current_matrix->buffer,
13457 w->last_point, b, pt))
13458 b->clip_changed = true;
13459 }
13460 }
13461
13462 static void
13463 propagate_buffer_redisplay (void)
13464 { /* Resetting b->text->redisplay is problematic!
13465 We can't just reset it in the case that some window that displays
13466 it has not been redisplayed; and such a window can stay
13467 unredisplayed for a long time if it's currently invisible.
13468 But we do want to reset it at the end of redisplay otherwise
13469 its displayed windows will keep being redisplayed over and over
13470 again.
13471 So we copy all b->text->redisplay flags up to their windows here,
13472 such that mark_window_display_accurate can safely reset
13473 b->text->redisplay. */
13474 Lisp_Object ws = window_list ();
13475 for (; CONSP (ws); ws = XCDR (ws))
13476 {
13477 struct window *thisw = XWINDOW (XCAR (ws));
13478 struct buffer *thisb = XBUFFER (thisw->contents);
13479 if (thisb->text->redisplay)
13480 thisw->redisplay = true;
13481 }
13482 }
13483
13484 #define STOP_POLLING \
13485 do { if (! polling_stopped_here) stop_polling (); \
13486 polling_stopped_here = true; } while (false)
13487
13488 #define RESUME_POLLING \
13489 do { if (polling_stopped_here) start_polling (); \
13490 polling_stopped_here = false; } while (false)
13491
13492
13493 /* Perhaps in the future avoid recentering windows if it
13494 is not necessary; currently that causes some problems. */
13495
13496 static void
13497 redisplay_internal (void)
13498 {
13499 struct window *w = XWINDOW (selected_window);
13500 struct window *sw;
13501 struct frame *fr;
13502 bool pending;
13503 bool must_finish = false, match_p;
13504 struct text_pos tlbufpos, tlendpos;
13505 int number_of_visible_frames;
13506 ptrdiff_t count;
13507 struct frame *sf;
13508 bool polling_stopped_here = false;
13509 Lisp_Object tail, frame;
13510
13511 /* True means redisplay has to consider all windows on all
13512 frames. False, only selected_window is considered. */
13513 bool consider_all_windows_p;
13514
13515 /* True means redisplay has to redisplay the miniwindow. */
13516 bool update_miniwindow_p = false;
13517
13518 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13519
13520 /* No redisplay if running in batch mode or frame is not yet fully
13521 initialized, or redisplay is explicitly turned off by setting
13522 Vinhibit_redisplay. */
13523 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13524 || !NILP (Vinhibit_redisplay))
13525 return;
13526
13527 /* Don't examine these until after testing Vinhibit_redisplay.
13528 When Emacs is shutting down, perhaps because its connection to
13529 X has dropped, we should not look at them at all. */
13530 fr = XFRAME (w->frame);
13531 sf = SELECTED_FRAME ();
13532
13533 if (!fr->glyphs_initialized_p)
13534 return;
13535
13536 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13537 if (popup_activated ())
13538 return;
13539 #endif
13540
13541 /* I don't think this happens but let's be paranoid. */
13542 if (redisplaying_p)
13543 return;
13544
13545 /* Record a function that clears redisplaying_p
13546 when we leave this function. */
13547 count = SPECPDL_INDEX ();
13548 record_unwind_protect_void (unwind_redisplay);
13549 redisplaying_p = true;
13550 specbind (Qinhibit_free_realized_faces, Qnil);
13551
13552 /* Record this function, so it appears on the profiler's backtraces. */
13553 record_in_backtrace (Qredisplay_internal_xC_functionx, 0, 0);
13554
13555 FOR_EACH_FRAME (tail, frame)
13556 XFRAME (frame)->already_hscrolled_p = false;
13557
13558 retry:
13559 /* Remember the currently selected window. */
13560 sw = w;
13561
13562 pending = false;
13563 forget_escape_and_glyphless_faces ();
13564
13565 inhibit_free_realized_faces = false;
13566
13567 /* If face_change, init_iterator will free all realized faces, which
13568 includes the faces referenced from current matrices. So, we
13569 can't reuse current matrices in this case. */
13570 if (face_change)
13571 windows_or_buffers_changed = 47;
13572
13573 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13574 && FRAME_TTY (sf)->previous_frame != sf)
13575 {
13576 /* Since frames on a single ASCII terminal share the same
13577 display area, displaying a different frame means redisplay
13578 the whole thing. */
13579 SET_FRAME_GARBAGED (sf);
13580 #ifndef DOS_NT
13581 set_tty_color_mode (FRAME_TTY (sf), sf);
13582 #endif
13583 FRAME_TTY (sf)->previous_frame = sf;
13584 }
13585
13586 /* Set the visible flags for all frames. Do this before checking for
13587 resized or garbaged frames; they want to know if their frames are
13588 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13589 number_of_visible_frames = 0;
13590
13591 FOR_EACH_FRAME (tail, frame)
13592 {
13593 struct frame *f = XFRAME (frame);
13594
13595 if (FRAME_VISIBLE_P (f))
13596 {
13597 ++number_of_visible_frames;
13598 /* Adjust matrices for visible frames only. */
13599 if (f->fonts_changed)
13600 {
13601 adjust_frame_glyphs (f);
13602 /* Disable all redisplay optimizations for this frame.
13603 This is because adjust_frame_glyphs resets the
13604 enabled_p flag for all glyph rows of all windows, so
13605 many optimizations will fail anyway, and some might
13606 fail to test that flag and do bogus things as
13607 result. */
13608 SET_FRAME_GARBAGED (f);
13609 f->fonts_changed = false;
13610 }
13611 /* If cursor type has been changed on the frame
13612 other than selected, consider all frames. */
13613 if (f != sf && f->cursor_type_changed)
13614 fset_redisplay (f);
13615 }
13616 clear_desired_matrices (f);
13617 }
13618
13619 /* Notice any pending interrupt request to change frame size. */
13620 do_pending_window_change (true);
13621
13622 /* do_pending_window_change could change the selected_window due to
13623 frame resizing which makes the selected window too small. */
13624 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13625 sw = w;
13626
13627 /* Clear frames marked as garbaged. */
13628 clear_garbaged_frames ();
13629
13630 /* Build menubar and tool-bar items. */
13631 if (NILP (Vmemory_full))
13632 prepare_menu_bars ();
13633
13634 reconsider_clip_changes (w);
13635
13636 /* In most cases selected window displays current buffer. */
13637 match_p = XBUFFER (w->contents) == current_buffer;
13638 if (match_p)
13639 {
13640 /* Detect case that we need to write or remove a star in the mode line. */
13641 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13642 w->update_mode_line = true;
13643
13644 if (mode_line_update_needed (w))
13645 w->update_mode_line = true;
13646
13647 /* If reconsider_clip_changes above decided that the narrowing
13648 in the current buffer changed, make sure all other windows
13649 showing that buffer will be redisplayed. */
13650 if (current_buffer->clip_changed)
13651 bset_update_mode_line (current_buffer);
13652 }
13653
13654 /* Normally the message* functions will have already displayed and
13655 updated the echo area, but the frame may have been trashed, or
13656 the update may have been preempted, so display the echo area
13657 again here. Checking message_cleared_p captures the case that
13658 the echo area should be cleared. */
13659 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13660 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13661 || (message_cleared_p
13662 && minibuf_level == 0
13663 /* If the mini-window is currently selected, this means the
13664 echo-area doesn't show through. */
13665 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13666 {
13667 echo_area_display (false);
13668
13669 /* If echo_area_display resizes the mini-window, the redisplay and
13670 window_sizes_changed flags of the selected frame are set, but
13671 it's too late for the hooks in window-size-change-functions,
13672 which have been examined already in prepare_menu_bars. So in
13673 that case we call the hooks here only for the selected frame. */
13674 if (sf->redisplay)
13675 {
13676 ptrdiff_t count1 = SPECPDL_INDEX ();
13677
13678 record_unwind_save_match_data ();
13679 run_window_size_change_functions (selected_frame);
13680 unbind_to (count1, Qnil);
13681 }
13682
13683 if (message_cleared_p)
13684 update_miniwindow_p = true;
13685
13686 must_finish = true;
13687
13688 /* If we don't display the current message, don't clear the
13689 message_cleared_p flag, because, if we did, we wouldn't clear
13690 the echo area in the next redisplay which doesn't preserve
13691 the echo area. */
13692 if (!display_last_displayed_message_p)
13693 message_cleared_p = false;
13694 }
13695 else if (EQ (selected_window, minibuf_window)
13696 && (current_buffer->clip_changed || window_outdated (w))
13697 && resize_mini_window (w, false))
13698 {
13699 if (sf->redisplay)
13700 {
13701 ptrdiff_t count1 = SPECPDL_INDEX ();
13702
13703 record_unwind_save_match_data ();
13704 run_window_size_change_functions (selected_frame);
13705 unbind_to (count1, Qnil);
13706 }
13707
13708 /* Resized active mini-window to fit the size of what it is
13709 showing if its contents might have changed. */
13710 must_finish = true;
13711
13712 /* If window configuration was changed, frames may have been
13713 marked garbaged. Clear them or we will experience
13714 surprises wrt scrolling. */
13715 clear_garbaged_frames ();
13716 }
13717
13718 if (windows_or_buffers_changed && !update_mode_lines)
13719 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13720 only the windows's contents needs to be refreshed, or whether the
13721 mode-lines also need a refresh. */
13722 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13723 ? REDISPLAY_SOME : 32);
13724
13725 /* If specs for an arrow have changed, do thorough redisplay
13726 to ensure we remove any arrow that should no longer exist. */
13727 if (overlay_arrows_changed_p ())
13728 /* Apparently, this is the only case where we update other windows,
13729 without updating other mode-lines. */
13730 windows_or_buffers_changed = 49;
13731
13732 consider_all_windows_p = (update_mode_lines
13733 || windows_or_buffers_changed);
13734
13735 #define AINC(a,i) \
13736 { \
13737 Lisp_Object entry = Fgethash (make_number (i), a, make_number (0)); \
13738 if (INTEGERP (entry)) \
13739 Fputhash (make_number (i), make_number (1 + XINT (entry)), a); \
13740 }
13741
13742 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13743 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13744
13745 /* Optimize the case that only the line containing the cursor in the
13746 selected window has changed. Variables starting with this_ are
13747 set in display_line and record information about the line
13748 containing the cursor. */
13749 tlbufpos = this_line_start_pos;
13750 tlendpos = this_line_end_pos;
13751 if (!consider_all_windows_p
13752 && CHARPOS (tlbufpos) > 0
13753 && !w->update_mode_line
13754 && !current_buffer->clip_changed
13755 && !current_buffer->prevent_redisplay_optimizations_p
13756 && FRAME_VISIBLE_P (XFRAME (w->frame))
13757 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13758 && !XFRAME (w->frame)->cursor_type_changed
13759 && !XFRAME (w->frame)->face_change
13760 /* Make sure recorded data applies to current buffer, etc. */
13761 && this_line_buffer == current_buffer
13762 && match_p
13763 && !w->force_start
13764 && !w->optional_new_start
13765 /* Point must be on the line that we have info recorded about. */
13766 && PT >= CHARPOS (tlbufpos)
13767 && PT <= Z - CHARPOS (tlendpos)
13768 /* All text outside that line, including its final newline,
13769 must be unchanged. */
13770 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13771 CHARPOS (tlendpos)))
13772 {
13773 if (CHARPOS (tlbufpos) > BEGV
13774 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13775 && (CHARPOS (tlbufpos) == ZV
13776 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13777 /* Former continuation line has disappeared by becoming empty. */
13778 goto cancel;
13779 else if (window_outdated (w) || MINI_WINDOW_P (w))
13780 {
13781 /* We have to handle the case of continuation around a
13782 wide-column character (see the comment in indent.c around
13783 line 1340).
13784
13785 For instance, in the following case:
13786
13787 -------- Insert --------
13788 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13789 J_I_ ==> J_I_ `^^' are cursors.
13790 ^^ ^^
13791 -------- --------
13792
13793 As we have to redraw the line above, we cannot use this
13794 optimization. */
13795
13796 struct it it;
13797 int line_height_before = this_line_pixel_height;
13798
13799 /* Note that start_display will handle the case that the
13800 line starting at tlbufpos is a continuation line. */
13801 start_display (&it, w, tlbufpos);
13802
13803 /* Implementation note: It this still necessary? */
13804 if (it.current_x != this_line_start_x)
13805 goto cancel;
13806
13807 TRACE ((stderr, "trying display optimization 1\n"));
13808 w->cursor.vpos = -1;
13809 overlay_arrow_seen = false;
13810 it.vpos = this_line_vpos;
13811 it.current_y = this_line_y;
13812 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13813 display_line (&it);
13814
13815 /* If line contains point, is not continued,
13816 and ends at same distance from eob as before, we win. */
13817 if (w->cursor.vpos >= 0
13818 /* Line is not continued, otherwise this_line_start_pos
13819 would have been set to 0 in display_line. */
13820 && CHARPOS (this_line_start_pos)
13821 /* Line ends as before. */
13822 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13823 /* Line has same height as before. Otherwise other lines
13824 would have to be shifted up or down. */
13825 && this_line_pixel_height == line_height_before)
13826 {
13827 /* If this is not the window's last line, we must adjust
13828 the charstarts of the lines below. */
13829 if (it.current_y < it.last_visible_y)
13830 {
13831 struct glyph_row *row
13832 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13833 ptrdiff_t delta, delta_bytes;
13834
13835 /* We used to distinguish between two cases here,
13836 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13837 when the line ends in a newline or the end of the
13838 buffer's accessible portion. But both cases did
13839 the same, so they were collapsed. */
13840 delta = (Z
13841 - CHARPOS (tlendpos)
13842 - MATRIX_ROW_START_CHARPOS (row));
13843 delta_bytes = (Z_BYTE
13844 - BYTEPOS (tlendpos)
13845 - MATRIX_ROW_START_BYTEPOS (row));
13846
13847 increment_matrix_positions (w->current_matrix,
13848 this_line_vpos + 1,
13849 w->current_matrix->nrows,
13850 delta, delta_bytes);
13851 }
13852
13853 /* If this row displays text now but previously didn't,
13854 or vice versa, w->window_end_vpos may have to be
13855 adjusted. */
13856 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13857 {
13858 if (w->window_end_vpos < this_line_vpos)
13859 w->window_end_vpos = this_line_vpos;
13860 }
13861 else if (w->window_end_vpos == this_line_vpos
13862 && this_line_vpos > 0)
13863 w->window_end_vpos = this_line_vpos - 1;
13864 w->window_end_valid = false;
13865
13866 /* Update hint: No need to try to scroll in update_window. */
13867 w->desired_matrix->no_scrolling_p = true;
13868
13869 #ifdef GLYPH_DEBUG
13870 *w->desired_matrix->method = 0;
13871 debug_method_add (w, "optimization 1");
13872 #endif
13873 #ifdef HAVE_WINDOW_SYSTEM
13874 update_window_fringes (w, false);
13875 #endif
13876 goto update;
13877 }
13878 else
13879 goto cancel;
13880 }
13881 else if (/* Cursor position hasn't changed. */
13882 PT == w->last_point
13883 /* Make sure the cursor was last displayed
13884 in this window. Otherwise we have to reposition it. */
13885
13886 /* PXW: Must be converted to pixels, probably. */
13887 && 0 <= w->cursor.vpos
13888 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13889 {
13890 if (!must_finish)
13891 {
13892 do_pending_window_change (true);
13893 /* If selected_window changed, redisplay again. */
13894 if (WINDOWP (selected_window)
13895 && (w = XWINDOW (selected_window)) != sw)
13896 goto retry;
13897
13898 /* We used to always goto end_of_redisplay here, but this
13899 isn't enough if we have a blinking cursor. */
13900 if (w->cursor_off_p == w->last_cursor_off_p)
13901 goto end_of_redisplay;
13902 }
13903 goto update;
13904 }
13905 /* If highlighting the region, or if the cursor is in the echo area,
13906 then we can't just move the cursor. */
13907 else if (NILP (Vshow_trailing_whitespace)
13908 && !cursor_in_echo_area)
13909 {
13910 struct it it;
13911 struct glyph_row *row;
13912
13913 /* Skip from tlbufpos to PT and see where it is. Note that
13914 PT may be in invisible text. If so, we will end at the
13915 next visible position. */
13916 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13917 NULL, DEFAULT_FACE_ID);
13918 it.current_x = this_line_start_x;
13919 it.current_y = this_line_y;
13920 it.vpos = this_line_vpos;
13921
13922 /* The call to move_it_to stops in front of PT, but
13923 moves over before-strings. */
13924 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13925
13926 if (it.vpos == this_line_vpos
13927 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13928 row->enabled_p))
13929 {
13930 eassert (this_line_vpos == it.vpos);
13931 eassert (this_line_y == it.current_y);
13932 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13933 if (cursor_row_fully_visible_p (w, false, true))
13934 {
13935 #ifdef GLYPH_DEBUG
13936 *w->desired_matrix->method = 0;
13937 debug_method_add (w, "optimization 3");
13938 #endif
13939 goto update;
13940 }
13941 else
13942 goto cancel;
13943 }
13944 else
13945 goto cancel;
13946 }
13947
13948 cancel:
13949 /* Text changed drastically or point moved off of line. */
13950 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13951 }
13952
13953 CHARPOS (this_line_start_pos) = 0;
13954 ++clear_face_cache_count;
13955 #ifdef HAVE_WINDOW_SYSTEM
13956 ++clear_image_cache_count;
13957 #endif
13958
13959 /* Build desired matrices, and update the display. If
13960 consider_all_windows_p, do it for all windows on all frames that
13961 require redisplay, as specified by their 'redisplay' flag.
13962 Otherwise do it for selected_window, only. */
13963
13964 if (consider_all_windows_p)
13965 {
13966 FOR_EACH_FRAME (tail, frame)
13967 XFRAME (frame)->updated_p = false;
13968
13969 propagate_buffer_redisplay ();
13970
13971 FOR_EACH_FRAME (tail, frame)
13972 {
13973 struct frame *f = XFRAME (frame);
13974
13975 /* We don't have to do anything for unselected terminal
13976 frames. */
13977 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13978 && !EQ (FRAME_TTY (f)->top_frame, frame))
13979 continue;
13980
13981 retry_frame:
13982 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13983 {
13984 bool gcscrollbars
13985 /* Only GC scrollbars when we redisplay the whole frame. */
13986 = f->redisplay || !REDISPLAY_SOME_P ();
13987 bool f_redisplay_flag = f->redisplay;
13988 /* Mark all the scroll bars to be removed; we'll redeem
13989 the ones we want when we redisplay their windows. */
13990 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13991 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13992
13993 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13994 redisplay_windows (FRAME_ROOT_WINDOW (f));
13995 /* Remember that the invisible frames need to be redisplayed next
13996 time they're visible. */
13997 else if (!REDISPLAY_SOME_P ())
13998 f->redisplay = true;
13999
14000 /* The X error handler may have deleted that frame. */
14001 if (!FRAME_LIVE_P (f))
14002 continue;
14003
14004 /* Any scroll bars which redisplay_windows should have
14005 nuked should now go away. */
14006 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
14007 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
14008
14009 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
14010 {
14011 /* If fonts changed on visible frame, display again. */
14012 if (f->fonts_changed)
14013 {
14014 adjust_frame_glyphs (f);
14015 /* Disable all redisplay optimizations for this
14016 frame. For the reasons, see the comment near
14017 the previous call to adjust_frame_glyphs above. */
14018 SET_FRAME_GARBAGED (f);
14019 f->fonts_changed = false;
14020 goto retry_frame;
14021 }
14022
14023 /* See if we have to hscroll. */
14024 if (!f->already_hscrolled_p)
14025 {
14026 f->already_hscrolled_p = true;
14027 if (hscroll_windows (f->root_window))
14028 goto retry_frame;
14029 }
14030
14031 /* If the frame's redisplay flag was not set before
14032 we went about redisplaying its windows, but it is
14033 set now, that means we employed some redisplay
14034 optimizations inside redisplay_windows, and
14035 bypassed producing some screen lines. But if
14036 f->redisplay is now set, it might mean the old
14037 faces are no longer valid (e.g., if redisplaying
14038 some window called some Lisp which defined a new
14039 face or redefined an existing face), so trying to
14040 use them in update_frame will segfault.
14041 Therefore, we must redisplay this frame. */
14042 if (!f_redisplay_flag && f->redisplay)
14043 goto retry_frame;
14044
14045 /* Prevent various kinds of signals during display
14046 update. stdio is not robust about handling
14047 signals, which can cause an apparent I/O error. */
14048 if (interrupt_input)
14049 unrequest_sigio ();
14050 STOP_POLLING;
14051
14052 pending |= update_frame (f, false, false);
14053 f->cursor_type_changed = false;
14054 f->updated_p = true;
14055 }
14056 }
14057 }
14058
14059 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
14060
14061 if (!pending)
14062 {
14063 /* Do the mark_window_display_accurate after all windows have
14064 been redisplayed because this call resets flags in buffers
14065 which are needed for proper redisplay. */
14066 FOR_EACH_FRAME (tail, frame)
14067 {
14068 struct frame *f = XFRAME (frame);
14069 if (f->updated_p)
14070 {
14071 f->redisplay = false;
14072 mark_window_display_accurate (f->root_window, true);
14073 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
14074 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
14075 }
14076 }
14077 }
14078 }
14079 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
14080 {
14081 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
14082 /* Use list_of_error, not Qerror, so that
14083 we catch only errors and don't run the debugger. */
14084 internal_condition_case_1 (redisplay_window_1, selected_window,
14085 list_of_error,
14086 redisplay_window_error);
14087 if (update_miniwindow_p)
14088 internal_condition_case_1 (redisplay_window_1,
14089 FRAME_MINIBUF_WINDOW (sf), list_of_error,
14090 redisplay_window_error);
14091
14092 /* Compare desired and current matrices, perform output. */
14093
14094 update:
14095 /* If fonts changed, display again. Likewise if redisplay_window_1
14096 above caused some change (e.g., a change in faces) that requires
14097 considering the entire frame again. */
14098 if (sf->fonts_changed || sf->redisplay)
14099 {
14100 if (sf->redisplay)
14101 {
14102 /* Set this to force a more thorough redisplay.
14103 Otherwise, we might immediately loop back to the
14104 above "else-if" clause (since all the conditions that
14105 led here might still be true), and we will then
14106 infloop, because the selected-frame's redisplay flag
14107 is not (and cannot be) reset. */
14108 windows_or_buffers_changed = 50;
14109 }
14110 goto retry;
14111 }
14112
14113 /* Prevent freeing of realized faces, since desired matrices are
14114 pending that reference the faces we computed and cached. */
14115 inhibit_free_realized_faces = true;
14116
14117 /* Prevent various kinds of signals during display update.
14118 stdio is not robust about handling signals,
14119 which can cause an apparent I/O error. */
14120 if (interrupt_input)
14121 unrequest_sigio ();
14122 STOP_POLLING;
14123
14124 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
14125 {
14126 if (hscroll_windows (selected_window))
14127 goto retry;
14128
14129 XWINDOW (selected_window)->must_be_updated_p = true;
14130 pending = update_frame (sf, false, false);
14131 sf->cursor_type_changed = false;
14132 }
14133
14134 /* We may have called echo_area_display at the top of this
14135 function. If the echo area is on another frame, that may
14136 have put text on a frame other than the selected one, so the
14137 above call to update_frame would not have caught it. Catch
14138 it here. */
14139 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
14140 struct frame *mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
14141
14142 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
14143 {
14144 XWINDOW (mini_window)->must_be_updated_p = true;
14145 pending |= update_frame (mini_frame, false, false);
14146 mini_frame->cursor_type_changed = false;
14147 if (!pending && hscroll_windows (mini_window))
14148 goto retry;
14149 }
14150 }
14151
14152 /* If display was paused because of pending input, make sure we do a
14153 thorough update the next time. */
14154 if (pending)
14155 {
14156 /* Prevent the optimization at the beginning of
14157 redisplay_internal that tries a single-line update of the
14158 line containing the cursor in the selected window. */
14159 CHARPOS (this_line_start_pos) = 0;
14160
14161 /* Let the overlay arrow be updated the next time. */
14162 update_overlay_arrows (0);
14163
14164 /* If we pause after scrolling, some rows in the current
14165 matrices of some windows are not valid. */
14166 if (!WINDOW_FULL_WIDTH_P (w)
14167 && !FRAME_WINDOW_P (XFRAME (w->frame)))
14168 update_mode_lines = 36;
14169 }
14170 else
14171 {
14172 if (!consider_all_windows_p)
14173 {
14174 /* This has already been done above if
14175 consider_all_windows_p is set. */
14176 if (XBUFFER (w->contents)->text->redisplay
14177 && buffer_window_count (XBUFFER (w->contents)) > 1)
14178 /* This can happen if b->text->redisplay was set during
14179 jit-lock. */
14180 propagate_buffer_redisplay ();
14181 mark_window_display_accurate_1 (w, true);
14182
14183 /* Say overlay arrows are up to date. */
14184 update_overlay_arrows (1);
14185
14186 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
14187 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
14188 }
14189
14190 update_mode_lines = 0;
14191 windows_or_buffers_changed = 0;
14192 }
14193
14194 /* Start SIGIO interrupts coming again. Having them off during the
14195 code above makes it less likely one will discard output, but not
14196 impossible, since there might be stuff in the system buffer here.
14197 But it is much hairier to try to do anything about that. */
14198 if (interrupt_input)
14199 request_sigio ();
14200 RESUME_POLLING;
14201
14202 /* If a frame has become visible which was not before, redisplay
14203 again, so that we display it. Expose events for such a frame
14204 (which it gets when becoming visible) don't call the parts of
14205 redisplay constructing glyphs, so simply exposing a frame won't
14206 display anything in this case. So, we have to display these
14207 frames here explicitly. */
14208 if (!pending)
14209 {
14210 int new_count = 0;
14211
14212 FOR_EACH_FRAME (tail, frame)
14213 {
14214 if (XFRAME (frame)->visible)
14215 new_count++;
14216 }
14217
14218 if (new_count != number_of_visible_frames)
14219 windows_or_buffers_changed = 52;
14220 }
14221
14222 /* Change frame size now if a change is pending. */
14223 do_pending_window_change (true);
14224
14225 /* If we just did a pending size change, or have additional
14226 visible frames, or selected_window changed, redisplay again. */
14227 if ((windows_or_buffers_changed && !pending)
14228 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
14229 goto retry;
14230
14231 /* Clear the face and image caches.
14232
14233 We used to do this only if consider_all_windows_p. But the cache
14234 needs to be cleared if a timer creates images in the current
14235 buffer (e.g. the test case in Bug#6230). */
14236
14237 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14238 {
14239 clear_face_cache (false);
14240 clear_face_cache_count = 0;
14241 }
14242
14243 #ifdef HAVE_WINDOW_SYSTEM
14244 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14245 {
14246 clear_image_caches (Qnil);
14247 clear_image_cache_count = 0;
14248 }
14249 #endif /* HAVE_WINDOW_SYSTEM */
14250
14251 end_of_redisplay:
14252 #ifdef HAVE_NS
14253 ns_set_doc_edited ();
14254 #endif
14255 if (interrupt_input && interrupts_deferred)
14256 request_sigio ();
14257
14258 unbind_to (count, Qnil);
14259 RESUME_POLLING;
14260 }
14261
14262
14263 /* Redisplay, but leave alone any recent echo area message unless
14264 another message has been requested in its place.
14265
14266 This is useful in situations where you need to redisplay but no
14267 user action has occurred, making it inappropriate for the message
14268 area to be cleared. See tracking_off and
14269 wait_reading_process_output for examples of these situations.
14270
14271 FROM_WHERE is an integer saying from where this function was
14272 called. This is useful for debugging. */
14273
14274 void
14275 redisplay_preserve_echo_area (int from_where)
14276 {
14277 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14278
14279 if (!NILP (echo_area_buffer[1]))
14280 {
14281 /* We have a previously displayed message, but no current
14282 message. Redisplay the previous message. */
14283 display_last_displayed_message_p = true;
14284 redisplay_internal ();
14285 display_last_displayed_message_p = false;
14286 }
14287 else
14288 redisplay_internal ();
14289
14290 flush_frame (SELECTED_FRAME ());
14291 }
14292
14293
14294 /* Function registered with record_unwind_protect in redisplay_internal. */
14295
14296 static void
14297 unwind_redisplay (void)
14298 {
14299 redisplaying_p = false;
14300 }
14301
14302
14303 /* Mark the display of leaf window W as accurate or inaccurate.
14304 If ACCURATE_P, mark display of W as accurate.
14305 If !ACCURATE_P, arrange for W to be redisplayed the next
14306 time redisplay_internal is called. */
14307
14308 static void
14309 mark_window_display_accurate_1 (struct window *w, bool accurate_p)
14310 {
14311 struct buffer *b = XBUFFER (w->contents);
14312
14313 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14314 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14315 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14316
14317 if (accurate_p)
14318 {
14319 b->clip_changed = false;
14320 b->prevent_redisplay_optimizations_p = false;
14321 eassert (buffer_window_count (b) > 0);
14322 /* Resetting b->text->redisplay is problematic!
14323 In order to make it safer to do it here, redisplay_internal must
14324 have copied all b->text->redisplay to their respective windows. */
14325 b->text->redisplay = false;
14326
14327 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14328 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14329 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14330 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14331
14332 w->current_matrix->buffer = b;
14333 w->current_matrix->begv = BUF_BEGV (b);
14334 w->current_matrix->zv = BUF_ZV (b);
14335
14336 w->last_cursor_vpos = w->cursor.vpos;
14337 w->last_cursor_off_p = w->cursor_off_p;
14338
14339 if (w == XWINDOW (selected_window))
14340 w->last_point = BUF_PT (b);
14341 else
14342 w->last_point = marker_position (w->pointm);
14343
14344 w->window_end_valid = true;
14345 w->update_mode_line = false;
14346 }
14347
14348 w->redisplay = !accurate_p;
14349 }
14350
14351
14352 /* Mark the display of windows in the window tree rooted at WINDOW as
14353 accurate or inaccurate. If ACCURATE_P, mark display of
14354 windows as accurate. If !ACCURATE_P, arrange for windows to
14355 be redisplayed the next time redisplay_internal is called. */
14356
14357 void
14358 mark_window_display_accurate (Lisp_Object window, bool accurate_p)
14359 {
14360 struct window *w;
14361
14362 for (; !NILP (window); window = w->next)
14363 {
14364 w = XWINDOW (window);
14365 if (WINDOWP (w->contents))
14366 mark_window_display_accurate (w->contents, accurate_p);
14367 else
14368 mark_window_display_accurate_1 (w, accurate_p);
14369 }
14370
14371 if (accurate_p)
14372 update_overlay_arrows (1);
14373 else
14374 /* Force a thorough redisplay the next time by setting
14375 last_arrow_position and last_arrow_string to t, which is
14376 unequal to any useful value of Voverlay_arrow_... */
14377 update_overlay_arrows (-1);
14378 }
14379
14380
14381 /* Return value in display table DP (Lisp_Char_Table *) for character
14382 C. Since a display table doesn't have any parent, we don't have to
14383 follow parent. Do not call this function directly but use the
14384 macro DISP_CHAR_VECTOR. */
14385
14386 Lisp_Object
14387 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14388 {
14389 Lisp_Object val;
14390
14391 if (ASCII_CHAR_P (c))
14392 {
14393 val = dp->ascii;
14394 if (SUB_CHAR_TABLE_P (val))
14395 val = XSUB_CHAR_TABLE (val)->contents[c];
14396 }
14397 else
14398 {
14399 Lisp_Object table;
14400
14401 XSETCHAR_TABLE (table, dp);
14402 val = char_table_ref (table, c);
14403 }
14404 if (NILP (val))
14405 val = dp->defalt;
14406 return val;
14407 }
14408
14409
14410 \f
14411 /***********************************************************************
14412 Window Redisplay
14413 ***********************************************************************/
14414
14415 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14416
14417 static void
14418 redisplay_windows (Lisp_Object window)
14419 {
14420 while (!NILP (window))
14421 {
14422 struct window *w = XWINDOW (window);
14423
14424 if (WINDOWP (w->contents))
14425 redisplay_windows (w->contents);
14426 else if (BUFFERP (w->contents))
14427 {
14428 displayed_buffer = XBUFFER (w->contents);
14429 /* Use list_of_error, not Qerror, so that
14430 we catch only errors and don't run the debugger. */
14431 internal_condition_case_1 (redisplay_window_0, window,
14432 list_of_error,
14433 redisplay_window_error);
14434 }
14435
14436 window = w->next;
14437 }
14438 }
14439
14440 static Lisp_Object
14441 redisplay_window_error (Lisp_Object ignore)
14442 {
14443 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14444 return Qnil;
14445 }
14446
14447 static Lisp_Object
14448 redisplay_window_0 (Lisp_Object window)
14449 {
14450 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14451 redisplay_window (window, false);
14452 return Qnil;
14453 }
14454
14455 static Lisp_Object
14456 redisplay_window_1 (Lisp_Object window)
14457 {
14458 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14459 redisplay_window (window, true);
14460 return Qnil;
14461 }
14462 \f
14463
14464 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14465 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14466 which positions recorded in ROW differ from current buffer
14467 positions.
14468
14469 Return true iff cursor is on this row. */
14470
14471 static bool
14472 set_cursor_from_row (struct window *w, struct glyph_row *row,
14473 struct glyph_matrix *matrix,
14474 ptrdiff_t delta, ptrdiff_t delta_bytes,
14475 int dy, int dvpos)
14476 {
14477 struct glyph *glyph = row->glyphs[TEXT_AREA];
14478 struct glyph *end = glyph + row->used[TEXT_AREA];
14479 struct glyph *cursor = NULL;
14480 /* The last known character position in row. */
14481 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14482 int x = row->x;
14483 ptrdiff_t pt_old = PT - delta;
14484 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14485 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14486 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14487 /* A glyph beyond the edge of TEXT_AREA which we should never
14488 touch. */
14489 struct glyph *glyphs_end = end;
14490 /* True means we've found a match for cursor position, but that
14491 glyph has the avoid_cursor_p flag set. */
14492 bool match_with_avoid_cursor = false;
14493 /* True means we've seen at least one glyph that came from a
14494 display string. */
14495 bool string_seen = false;
14496 /* Largest and smallest buffer positions seen so far during scan of
14497 glyph row. */
14498 ptrdiff_t bpos_max = pos_before;
14499 ptrdiff_t bpos_min = pos_after;
14500 /* Last buffer position covered by an overlay string with an integer
14501 `cursor' property. */
14502 ptrdiff_t bpos_covered = 0;
14503 /* True means the display string on which to display the cursor
14504 comes from a text property, not from an overlay. */
14505 bool string_from_text_prop = false;
14506
14507 /* Don't even try doing anything if called for a mode-line or
14508 header-line row, since the rest of the code isn't prepared to
14509 deal with such calamities. */
14510 eassert (!row->mode_line_p);
14511 if (row->mode_line_p)
14512 return false;
14513
14514 /* Skip over glyphs not having an object at the start and the end of
14515 the row. These are special glyphs like truncation marks on
14516 terminal frames. */
14517 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14518 {
14519 if (!row->reversed_p)
14520 {
14521 while (glyph < end
14522 && NILP (glyph->object)
14523 && glyph->charpos < 0)
14524 {
14525 x += glyph->pixel_width;
14526 ++glyph;
14527 }
14528 while (end > glyph
14529 && NILP ((end - 1)->object)
14530 /* CHARPOS is zero for blanks and stretch glyphs
14531 inserted by extend_face_to_end_of_line. */
14532 && (end - 1)->charpos <= 0)
14533 --end;
14534 glyph_before = glyph - 1;
14535 glyph_after = end;
14536 }
14537 else
14538 {
14539 struct glyph *g;
14540
14541 /* If the glyph row is reversed, we need to process it from back
14542 to front, so swap the edge pointers. */
14543 glyphs_end = end = glyph - 1;
14544 glyph += row->used[TEXT_AREA] - 1;
14545
14546 while (glyph > end + 1
14547 && NILP (glyph->object)
14548 && glyph->charpos < 0)
14549 {
14550 --glyph;
14551 x -= glyph->pixel_width;
14552 }
14553 if (NILP (glyph->object) && glyph->charpos < 0)
14554 --glyph;
14555 /* By default, in reversed rows we put the cursor on the
14556 rightmost (first in the reading order) glyph. */
14557 for (g = end + 1; g < glyph; g++)
14558 x += g->pixel_width;
14559 while (end < glyph
14560 && NILP ((end + 1)->object)
14561 && (end + 1)->charpos <= 0)
14562 ++end;
14563 glyph_before = glyph + 1;
14564 glyph_after = end;
14565 }
14566 }
14567 else if (row->reversed_p)
14568 {
14569 /* In R2L rows that don't display text, put the cursor on the
14570 rightmost glyph. Case in point: an empty last line that is
14571 part of an R2L paragraph. */
14572 cursor = end - 1;
14573 /* Avoid placing the cursor on the last glyph of the row, where
14574 on terminal frames we hold the vertical border between
14575 adjacent windows. */
14576 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14577 && !WINDOW_RIGHTMOST_P (w)
14578 && cursor == row->glyphs[LAST_AREA] - 1)
14579 cursor--;
14580 x = -1; /* will be computed below, at label compute_x */
14581 }
14582
14583 /* Step 1: Try to find the glyph whose character position
14584 corresponds to point. If that's not possible, find 2 glyphs
14585 whose character positions are the closest to point, one before
14586 point, the other after it. */
14587 if (!row->reversed_p)
14588 while (/* not marched to end of glyph row */
14589 glyph < end
14590 /* glyph was not inserted by redisplay for internal purposes */
14591 && !NILP (glyph->object))
14592 {
14593 if (BUFFERP (glyph->object))
14594 {
14595 ptrdiff_t dpos = glyph->charpos - pt_old;
14596
14597 if (glyph->charpos > bpos_max)
14598 bpos_max = glyph->charpos;
14599 if (glyph->charpos < bpos_min)
14600 bpos_min = glyph->charpos;
14601 if (!glyph->avoid_cursor_p)
14602 {
14603 /* If we hit point, we've found the glyph on which to
14604 display the cursor. */
14605 if (dpos == 0)
14606 {
14607 match_with_avoid_cursor = false;
14608 break;
14609 }
14610 /* See if we've found a better approximation to
14611 POS_BEFORE or to POS_AFTER. */
14612 if (0 > dpos && dpos > pos_before - pt_old)
14613 {
14614 pos_before = glyph->charpos;
14615 glyph_before = glyph;
14616 }
14617 else if (0 < dpos && dpos < pos_after - pt_old)
14618 {
14619 pos_after = glyph->charpos;
14620 glyph_after = glyph;
14621 }
14622 }
14623 else if (dpos == 0)
14624 match_with_avoid_cursor = true;
14625 }
14626 else if (STRINGP (glyph->object))
14627 {
14628 Lisp_Object chprop;
14629 ptrdiff_t glyph_pos = glyph->charpos;
14630
14631 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14632 glyph->object);
14633 if (!NILP (chprop))
14634 {
14635 /* If the string came from a `display' text property,
14636 look up the buffer position of that property and
14637 use that position to update bpos_max, as if we
14638 actually saw such a position in one of the row's
14639 glyphs. This helps with supporting integer values
14640 of `cursor' property on the display string in
14641 situations where most or all of the row's buffer
14642 text is completely covered by display properties,
14643 so that no glyph with valid buffer positions is
14644 ever seen in the row. */
14645 ptrdiff_t prop_pos =
14646 string_buffer_position_lim (glyph->object, pos_before,
14647 pos_after, false);
14648
14649 if (prop_pos >= pos_before)
14650 bpos_max = prop_pos;
14651 }
14652 if (INTEGERP (chprop))
14653 {
14654 bpos_covered = bpos_max + XINT (chprop);
14655 /* If the `cursor' property covers buffer positions up
14656 to and including point, we should display cursor on
14657 this glyph. Note that, if a `cursor' property on one
14658 of the string's characters has an integer value, we
14659 will break out of the loop below _before_ we get to
14660 the position match above. IOW, integer values of
14661 the `cursor' property override the "exact match for
14662 point" strategy of positioning the cursor. */
14663 /* Implementation note: bpos_max == pt_old when, e.g.,
14664 we are in an empty line, where bpos_max is set to
14665 MATRIX_ROW_START_CHARPOS, see above. */
14666 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14667 {
14668 cursor = glyph;
14669 break;
14670 }
14671 }
14672
14673 string_seen = true;
14674 }
14675 x += glyph->pixel_width;
14676 ++glyph;
14677 }
14678 else if (glyph > end) /* row is reversed */
14679 while (!NILP (glyph->object))
14680 {
14681 if (BUFFERP (glyph->object))
14682 {
14683 ptrdiff_t dpos = glyph->charpos - pt_old;
14684
14685 if (glyph->charpos > bpos_max)
14686 bpos_max = glyph->charpos;
14687 if (glyph->charpos < bpos_min)
14688 bpos_min = glyph->charpos;
14689 if (!glyph->avoid_cursor_p)
14690 {
14691 if (dpos == 0)
14692 {
14693 match_with_avoid_cursor = false;
14694 break;
14695 }
14696 if (0 > dpos && dpos > pos_before - pt_old)
14697 {
14698 pos_before = glyph->charpos;
14699 glyph_before = glyph;
14700 }
14701 else if (0 < dpos && dpos < pos_after - pt_old)
14702 {
14703 pos_after = glyph->charpos;
14704 glyph_after = glyph;
14705 }
14706 }
14707 else if (dpos == 0)
14708 match_with_avoid_cursor = true;
14709 }
14710 else if (STRINGP (glyph->object))
14711 {
14712 Lisp_Object chprop;
14713 ptrdiff_t glyph_pos = glyph->charpos;
14714
14715 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14716 glyph->object);
14717 if (!NILP (chprop))
14718 {
14719 ptrdiff_t prop_pos =
14720 string_buffer_position_lim (glyph->object, pos_before,
14721 pos_after, false);
14722
14723 if (prop_pos >= pos_before)
14724 bpos_max = prop_pos;
14725 }
14726 if (INTEGERP (chprop))
14727 {
14728 bpos_covered = bpos_max + XINT (chprop);
14729 /* If the `cursor' property covers buffer positions up
14730 to and including point, we should display cursor on
14731 this glyph. */
14732 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14733 {
14734 cursor = glyph;
14735 break;
14736 }
14737 }
14738 string_seen = true;
14739 }
14740 --glyph;
14741 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14742 {
14743 x--; /* can't use any pixel_width */
14744 break;
14745 }
14746 x -= glyph->pixel_width;
14747 }
14748
14749 /* Step 2: If we didn't find an exact match for point, we need to
14750 look for a proper place to put the cursor among glyphs between
14751 GLYPH_BEFORE and GLYPH_AFTER. */
14752 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14753 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14754 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14755 {
14756 /* An empty line has a single glyph whose OBJECT is nil and
14757 whose CHARPOS is the position of a newline on that line.
14758 Note that on a TTY, there are more glyphs after that, which
14759 were produced by extend_face_to_end_of_line, but their
14760 CHARPOS is zero or negative. */
14761 bool empty_line_p =
14762 ((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14763 && NILP (glyph->object) && glyph->charpos > 0
14764 /* On a TTY, continued and truncated rows also have a glyph at
14765 their end whose OBJECT is nil and whose CHARPOS is
14766 positive (the continuation and truncation glyphs), but such
14767 rows are obviously not "empty". */
14768 && !(row->continued_p || row->truncated_on_right_p));
14769
14770 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14771 {
14772 ptrdiff_t ellipsis_pos;
14773
14774 /* Scan back over the ellipsis glyphs. */
14775 if (!row->reversed_p)
14776 {
14777 ellipsis_pos = (glyph - 1)->charpos;
14778 while (glyph > row->glyphs[TEXT_AREA]
14779 && (glyph - 1)->charpos == ellipsis_pos)
14780 glyph--, x -= glyph->pixel_width;
14781 /* That loop always goes one position too far, including
14782 the glyph before the ellipsis. So scan forward over
14783 that one. */
14784 x += glyph->pixel_width;
14785 glyph++;
14786 }
14787 else /* row is reversed */
14788 {
14789 ellipsis_pos = (glyph + 1)->charpos;
14790 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14791 && (glyph + 1)->charpos == ellipsis_pos)
14792 glyph++, x += glyph->pixel_width;
14793 x -= glyph->pixel_width;
14794 glyph--;
14795 }
14796 }
14797 else if (match_with_avoid_cursor)
14798 {
14799 cursor = glyph_after;
14800 x = -1;
14801 }
14802 else if (string_seen)
14803 {
14804 int incr = row->reversed_p ? -1 : +1;
14805
14806 /* Need to find the glyph that came out of a string which is
14807 present at point. That glyph is somewhere between
14808 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14809 positioned between POS_BEFORE and POS_AFTER in the
14810 buffer. */
14811 struct glyph *start, *stop;
14812 ptrdiff_t pos = pos_before;
14813
14814 x = -1;
14815
14816 /* If the row ends in a newline from a display string,
14817 reordering could have moved the glyphs belonging to the
14818 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14819 in this case we extend the search to the last glyph in
14820 the row that was not inserted by redisplay. */
14821 if (row->ends_in_newline_from_string_p)
14822 {
14823 glyph_after = end;
14824 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14825 }
14826
14827 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14828 correspond to POS_BEFORE and POS_AFTER, respectively. We
14829 need START and STOP in the order that corresponds to the
14830 row's direction as given by its reversed_p flag. If the
14831 directionality of characters between POS_BEFORE and
14832 POS_AFTER is the opposite of the row's base direction,
14833 these characters will have been reordered for display,
14834 and we need to reverse START and STOP. */
14835 if (!row->reversed_p)
14836 {
14837 start = min (glyph_before, glyph_after);
14838 stop = max (glyph_before, glyph_after);
14839 }
14840 else
14841 {
14842 start = max (glyph_before, glyph_after);
14843 stop = min (glyph_before, glyph_after);
14844 }
14845 for (glyph = start + incr;
14846 row->reversed_p ? glyph > stop : glyph < stop; )
14847 {
14848
14849 /* Any glyphs that come from the buffer are here because
14850 of bidi reordering. Skip them, and only pay
14851 attention to glyphs that came from some string. */
14852 if (STRINGP (glyph->object))
14853 {
14854 Lisp_Object str;
14855 ptrdiff_t tem;
14856 /* If the display property covers the newline, we
14857 need to search for it one position farther. */
14858 ptrdiff_t lim = pos_after
14859 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14860
14861 string_from_text_prop = false;
14862 str = glyph->object;
14863 tem = string_buffer_position_lim (str, pos, lim, false);
14864 if (tem == 0 /* from overlay */
14865 || pos <= tem)
14866 {
14867 /* If the string from which this glyph came is
14868 found in the buffer at point, or at position
14869 that is closer to point than pos_after, then
14870 we've found the glyph we've been looking for.
14871 If it comes from an overlay (tem == 0), and
14872 it has the `cursor' property on one of its
14873 glyphs, record that glyph as a candidate for
14874 displaying the cursor. (As in the
14875 unidirectional version, we will display the
14876 cursor on the last candidate we find.) */
14877 if (tem == 0
14878 || tem == pt_old
14879 || (tem - pt_old > 0 && tem < pos_after))
14880 {
14881 /* The glyphs from this string could have
14882 been reordered. Find the one with the
14883 smallest string position. Or there could
14884 be a character in the string with the
14885 `cursor' property, which means display
14886 cursor on that character's glyph. */
14887 ptrdiff_t strpos = glyph->charpos;
14888
14889 if (tem)
14890 {
14891 cursor = glyph;
14892 string_from_text_prop = true;
14893 }
14894 for ( ;
14895 (row->reversed_p ? glyph > stop : glyph < stop)
14896 && EQ (glyph->object, str);
14897 glyph += incr)
14898 {
14899 Lisp_Object cprop;
14900 ptrdiff_t gpos = glyph->charpos;
14901
14902 cprop = Fget_char_property (make_number (gpos),
14903 Qcursor,
14904 glyph->object);
14905 if (!NILP (cprop))
14906 {
14907 cursor = glyph;
14908 break;
14909 }
14910 if (tem && glyph->charpos < strpos)
14911 {
14912 strpos = glyph->charpos;
14913 cursor = glyph;
14914 }
14915 }
14916
14917 if (tem == pt_old
14918 || (tem - pt_old > 0 && tem < pos_after))
14919 goto compute_x;
14920 }
14921 if (tem)
14922 pos = tem + 1; /* don't find previous instances */
14923 }
14924 /* This string is not what we want; skip all of the
14925 glyphs that came from it. */
14926 while ((row->reversed_p ? glyph > stop : glyph < stop)
14927 && EQ (glyph->object, str))
14928 glyph += incr;
14929 }
14930 else
14931 glyph += incr;
14932 }
14933
14934 /* If we reached the end of the line, and END was from a string,
14935 the cursor is not on this line. */
14936 if (cursor == NULL
14937 && (row->reversed_p ? glyph <= end : glyph >= end)
14938 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14939 && STRINGP (end->object)
14940 && row->continued_p)
14941 return false;
14942 }
14943 /* A truncated row may not include PT among its character positions.
14944 Setting the cursor inside the scroll margin will trigger
14945 recalculation of hscroll in hscroll_window_tree. But if a
14946 display string covers point, defer to the string-handling
14947 code below to figure this out. */
14948 else if (row->truncated_on_left_p && pt_old < bpos_min)
14949 {
14950 cursor = glyph_before;
14951 x = -1;
14952 }
14953 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14954 /* Zero-width characters produce no glyphs. */
14955 || (!empty_line_p
14956 && (row->reversed_p
14957 ? glyph_after > glyphs_end
14958 : glyph_after < glyphs_end)))
14959 {
14960 cursor = glyph_after;
14961 x = -1;
14962 }
14963 }
14964
14965 compute_x:
14966 if (cursor != NULL)
14967 glyph = cursor;
14968 else if (glyph == glyphs_end
14969 && pos_before == pos_after
14970 && STRINGP ((row->reversed_p
14971 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14972 : row->glyphs[TEXT_AREA])->object))
14973 {
14974 /* If all the glyphs of this row came from strings, put the
14975 cursor on the first glyph of the row. This avoids having the
14976 cursor outside of the text area in this very rare and hard
14977 use case. */
14978 glyph =
14979 row->reversed_p
14980 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14981 : row->glyphs[TEXT_AREA];
14982 }
14983 if (x < 0)
14984 {
14985 struct glyph *g;
14986
14987 /* Need to compute x that corresponds to GLYPH. */
14988 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14989 {
14990 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14991 emacs_abort ();
14992 x += g->pixel_width;
14993 }
14994 }
14995
14996 /* ROW could be part of a continued line, which, under bidi
14997 reordering, might have other rows whose start and end charpos
14998 occlude point. Only set w->cursor if we found a better
14999 approximation to the cursor position than we have from previously
15000 examined candidate rows belonging to the same continued line. */
15001 if (/* We already have a candidate row. */
15002 w->cursor.vpos >= 0
15003 /* That candidate is not the row we are processing. */
15004 && MATRIX_ROW (matrix, w->cursor.vpos) != row
15005 /* Make sure cursor.vpos specifies a row whose start and end
15006 charpos occlude point, and it is valid candidate for being a
15007 cursor-row. This is because some callers of this function
15008 leave cursor.vpos at the row where the cursor was displayed
15009 during the last redisplay cycle. */
15010 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
15011 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
15012 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
15013 {
15014 struct glyph *g1
15015 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
15016
15017 /* Don't consider glyphs that are outside TEXT_AREA. */
15018 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
15019 return false;
15020 /* Keep the candidate whose buffer position is the closest to
15021 point or has the `cursor' property. */
15022 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
15023 w->cursor.hpos >= 0
15024 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
15025 && ((BUFFERP (g1->object)
15026 && (g1->charpos == pt_old /* An exact match always wins. */
15027 || (BUFFERP (glyph->object)
15028 && eabs (g1->charpos - pt_old)
15029 < eabs (glyph->charpos - pt_old))))
15030 /* Previous candidate is a glyph from a string that has
15031 a non-nil `cursor' property. */
15032 || (STRINGP (g1->object)
15033 && (!NILP (Fget_char_property (make_number (g1->charpos),
15034 Qcursor, g1->object))
15035 /* Previous candidate is from the same display
15036 string as this one, and the display string
15037 came from a text property. */
15038 || (EQ (g1->object, glyph->object)
15039 && string_from_text_prop)
15040 /* this candidate is from newline and its
15041 position is not an exact match */
15042 || (NILP (glyph->object)
15043 && glyph->charpos != pt_old)))))
15044 return false;
15045 /* If this candidate gives an exact match, use that. */
15046 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
15047 /* If this candidate is a glyph created for the
15048 terminating newline of a line, and point is on that
15049 newline, it wins because it's an exact match. */
15050 || (!row->continued_p
15051 && NILP (glyph->object)
15052 && glyph->charpos == 0
15053 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
15054 /* Otherwise, keep the candidate that comes from a row
15055 spanning less buffer positions. This may win when one or
15056 both candidate positions are on glyphs that came from
15057 display strings, for which we cannot compare buffer
15058 positions. */
15059 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
15060 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
15061 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
15062 return false;
15063 }
15064 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
15065 w->cursor.x = x;
15066 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
15067 w->cursor.y = row->y + dy;
15068
15069 if (w == XWINDOW (selected_window))
15070 {
15071 if (!row->continued_p
15072 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15073 && row->x == 0)
15074 {
15075 this_line_buffer = XBUFFER (w->contents);
15076
15077 CHARPOS (this_line_start_pos)
15078 = MATRIX_ROW_START_CHARPOS (row) + delta;
15079 BYTEPOS (this_line_start_pos)
15080 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
15081
15082 CHARPOS (this_line_end_pos)
15083 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
15084 BYTEPOS (this_line_end_pos)
15085 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
15086
15087 this_line_y = w->cursor.y;
15088 this_line_pixel_height = row->height;
15089 this_line_vpos = w->cursor.vpos;
15090 this_line_start_x = row->x;
15091 }
15092 else
15093 CHARPOS (this_line_start_pos) = 0;
15094 }
15095
15096 return true;
15097 }
15098
15099
15100 /* Run window scroll functions, if any, for WINDOW with new window
15101 start STARTP. Sets the window start of WINDOW to that position.
15102
15103 We assume that the window's buffer is really current. */
15104
15105 static struct text_pos
15106 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
15107 {
15108 struct window *w = XWINDOW (window);
15109 SET_MARKER_FROM_TEXT_POS (w->start, startp);
15110
15111 eassert (current_buffer == XBUFFER (w->contents));
15112
15113 if (!NILP (Vwindow_scroll_functions))
15114 {
15115 run_hook_with_args_2 (Qwindow_scroll_functions, window,
15116 make_number (CHARPOS (startp)));
15117 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15118 /* In case the hook functions switch buffers. */
15119 set_buffer_internal (XBUFFER (w->contents));
15120 }
15121
15122 return startp;
15123 }
15124
15125
15126 /* Make sure the line containing the cursor is fully visible.
15127 A value of true means there is nothing to be done.
15128 (Either the line is fully visible, or it cannot be made so,
15129 or we cannot tell.)
15130
15131 If FORCE_P, return false even if partial visible cursor row
15132 is higher than window.
15133
15134 If CURRENT_MATRIX_P, use the information from the
15135 window's current glyph matrix; otherwise use the desired glyph
15136 matrix.
15137
15138 A value of false means the caller should do scrolling
15139 as if point had gone off the screen. */
15140
15141 static bool
15142 cursor_row_fully_visible_p (struct window *w, bool force_p,
15143 bool current_matrix_p)
15144 {
15145 struct glyph_matrix *matrix;
15146 struct glyph_row *row;
15147 int window_height;
15148
15149 if (!make_cursor_line_fully_visible_p)
15150 return true;
15151
15152 /* It's not always possible to find the cursor, e.g, when a window
15153 is full of overlay strings. Don't do anything in that case. */
15154 if (w->cursor.vpos < 0)
15155 return true;
15156
15157 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
15158 row = MATRIX_ROW (matrix, w->cursor.vpos);
15159
15160 /* If the cursor row is not partially visible, there's nothing to do. */
15161 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
15162 return true;
15163
15164 /* If the row the cursor is in is taller than the window's height,
15165 it's not clear what to do, so do nothing. */
15166 window_height = window_box_height (w);
15167 if (row->height >= window_height)
15168 {
15169 if (!force_p || MINI_WINDOW_P (w)
15170 || w->vscroll || w->cursor.vpos == 0)
15171 return true;
15172 }
15173 return false;
15174 }
15175
15176
15177 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15178 means only WINDOW is redisplayed in redisplay_internal.
15179 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15180 in redisplay_window to bring a partially visible line into view in
15181 the case that only the cursor has moved.
15182
15183 LAST_LINE_MISFIT should be true if we're scrolling because the
15184 last screen line's vertical height extends past the end of the screen.
15185
15186 Value is
15187
15188 1 if scrolling succeeded
15189
15190 0 if scrolling didn't find point.
15191
15192 -1 if new fonts have been loaded so that we must interrupt
15193 redisplay, adjust glyph matrices, and try again. */
15194
15195 enum
15196 {
15197 SCROLLING_SUCCESS,
15198 SCROLLING_FAILED,
15199 SCROLLING_NEED_LARGER_MATRICES
15200 };
15201
15202 /* If scroll-conservatively is more than this, never recenter.
15203
15204 If you change this, don't forget to update the doc string of
15205 `scroll-conservatively' and the Emacs manual. */
15206 #define SCROLL_LIMIT 100
15207
15208 static int
15209 try_scrolling (Lisp_Object window, bool just_this_one_p,
15210 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
15211 bool temp_scroll_step, bool last_line_misfit)
15212 {
15213 struct window *w = XWINDOW (window);
15214 struct frame *f = XFRAME (w->frame);
15215 struct text_pos pos, startp;
15216 struct it it;
15217 int this_scroll_margin, scroll_max, rc, height;
15218 int dy = 0, amount_to_scroll = 0;
15219 bool scroll_down_p = false;
15220 int extra_scroll_margin_lines = last_line_misfit;
15221 Lisp_Object aggressive;
15222 /* We will never try scrolling more than this number of lines. */
15223 int scroll_limit = SCROLL_LIMIT;
15224 int frame_line_height = default_line_pixel_height (w);
15225 int window_total_lines
15226 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15227
15228 #ifdef GLYPH_DEBUG
15229 debug_method_add (w, "try_scrolling");
15230 #endif
15231
15232 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15233
15234 /* Compute scroll margin height in pixels. We scroll when point is
15235 within this distance from the top or bottom of the window. */
15236 if (scroll_margin > 0)
15237 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
15238 * frame_line_height;
15239 else
15240 this_scroll_margin = 0;
15241
15242 /* Force arg_scroll_conservatively to have a reasonable value, to
15243 avoid scrolling too far away with slow move_it_* functions. Note
15244 that the user can supply scroll-conservatively equal to
15245 `most-positive-fixnum', which can be larger than INT_MAX. */
15246 if (arg_scroll_conservatively > scroll_limit)
15247 {
15248 arg_scroll_conservatively = scroll_limit + 1;
15249 scroll_max = scroll_limit * frame_line_height;
15250 }
15251 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15252 /* Compute how much we should try to scroll maximally to bring
15253 point into view. */
15254 scroll_max = (max (scroll_step,
15255 max (arg_scroll_conservatively, temp_scroll_step))
15256 * frame_line_height);
15257 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15258 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15259 /* We're trying to scroll because of aggressive scrolling but no
15260 scroll_step is set. Choose an arbitrary one. */
15261 scroll_max = 10 * frame_line_height;
15262 else
15263 scroll_max = 0;
15264
15265 too_near_end:
15266
15267 /* Decide whether to scroll down. */
15268 if (PT > CHARPOS (startp))
15269 {
15270 int scroll_margin_y;
15271
15272 /* Compute the pixel ypos of the scroll margin, then move IT to
15273 either that ypos or PT, whichever comes first. */
15274 start_display (&it, w, startp);
15275 scroll_margin_y = it.last_visible_y - this_scroll_margin
15276 - frame_line_height * extra_scroll_margin_lines;
15277 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15278 (MOVE_TO_POS | MOVE_TO_Y));
15279
15280 if (PT > CHARPOS (it.current.pos))
15281 {
15282 int y0 = line_bottom_y (&it);
15283 /* Compute how many pixels below window bottom to stop searching
15284 for PT. This avoids costly search for PT that is far away if
15285 the user limited scrolling by a small number of lines, but
15286 always finds PT if scroll_conservatively is set to a large
15287 number, such as most-positive-fixnum. */
15288 int slack = max (scroll_max, 10 * frame_line_height);
15289 int y_to_move = it.last_visible_y + slack;
15290
15291 /* Compute the distance from the scroll margin to PT or to
15292 the scroll limit, whichever comes first. This should
15293 include the height of the cursor line, to make that line
15294 fully visible. */
15295 move_it_to (&it, PT, -1, y_to_move,
15296 -1, MOVE_TO_POS | MOVE_TO_Y);
15297 dy = line_bottom_y (&it) - y0;
15298
15299 if (dy > scroll_max)
15300 return SCROLLING_FAILED;
15301
15302 if (dy > 0)
15303 scroll_down_p = true;
15304 }
15305 }
15306
15307 if (scroll_down_p)
15308 {
15309 /* Point is in or below the bottom scroll margin, so move the
15310 window start down. If scrolling conservatively, move it just
15311 enough down to make point visible. If scroll_step is set,
15312 move it down by scroll_step. */
15313 if (arg_scroll_conservatively)
15314 amount_to_scroll
15315 = min (max (dy, frame_line_height),
15316 frame_line_height * arg_scroll_conservatively);
15317 else if (scroll_step || temp_scroll_step)
15318 amount_to_scroll = scroll_max;
15319 else
15320 {
15321 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15322 height = WINDOW_BOX_TEXT_HEIGHT (w);
15323 if (NUMBERP (aggressive))
15324 {
15325 double float_amount = XFLOATINT (aggressive) * height;
15326 int aggressive_scroll = float_amount;
15327 if (aggressive_scroll == 0 && float_amount > 0)
15328 aggressive_scroll = 1;
15329 /* Don't let point enter the scroll margin near top of
15330 the window. This could happen if the value of
15331 scroll_up_aggressively is too large and there are
15332 non-zero margins, because scroll_up_aggressively
15333 means put point that fraction of window height
15334 _from_the_bottom_margin_. */
15335 if (aggressive_scroll + 2 * this_scroll_margin > height)
15336 aggressive_scroll = height - 2 * this_scroll_margin;
15337 amount_to_scroll = dy + aggressive_scroll;
15338 }
15339 }
15340
15341 if (amount_to_scroll <= 0)
15342 return SCROLLING_FAILED;
15343
15344 start_display (&it, w, startp);
15345 if (arg_scroll_conservatively <= scroll_limit)
15346 move_it_vertically (&it, amount_to_scroll);
15347 else
15348 {
15349 /* Extra precision for users who set scroll-conservatively
15350 to a large number: make sure the amount we scroll
15351 the window start is never less than amount_to_scroll,
15352 which was computed as distance from window bottom to
15353 point. This matters when lines at window top and lines
15354 below window bottom have different height. */
15355 struct it it1;
15356 void *it1data = NULL;
15357 /* We use a temporary it1 because line_bottom_y can modify
15358 its argument, if it moves one line down; see there. */
15359 int start_y;
15360
15361 SAVE_IT (it1, it, it1data);
15362 start_y = line_bottom_y (&it1);
15363 do {
15364 RESTORE_IT (&it, &it, it1data);
15365 move_it_by_lines (&it, 1);
15366 SAVE_IT (it1, it, it1data);
15367 } while (IT_CHARPOS (it) < ZV
15368 && line_bottom_y (&it1) - start_y < amount_to_scroll);
15369 bidi_unshelve_cache (it1data, true);
15370 }
15371
15372 /* If STARTP is unchanged, move it down another screen line. */
15373 if (IT_CHARPOS (it) == CHARPOS (startp))
15374 move_it_by_lines (&it, 1);
15375 startp = it.current.pos;
15376 }
15377 else
15378 {
15379 struct text_pos scroll_margin_pos = startp;
15380 int y_offset = 0;
15381
15382 /* See if point is inside the scroll margin at the top of the
15383 window. */
15384 if (this_scroll_margin)
15385 {
15386 int y_start;
15387
15388 start_display (&it, w, startp);
15389 y_start = it.current_y;
15390 move_it_vertically (&it, this_scroll_margin);
15391 scroll_margin_pos = it.current.pos;
15392 /* If we didn't move enough before hitting ZV, request
15393 additional amount of scroll, to move point out of the
15394 scroll margin. */
15395 if (IT_CHARPOS (it) == ZV
15396 && it.current_y - y_start < this_scroll_margin)
15397 y_offset = this_scroll_margin - (it.current_y - y_start);
15398 }
15399
15400 if (PT < CHARPOS (scroll_margin_pos))
15401 {
15402 /* Point is in the scroll margin at the top of the window or
15403 above what is displayed in the window. */
15404 int y0, y_to_move;
15405
15406 /* Compute the vertical distance from PT to the scroll
15407 margin position. Move as far as scroll_max allows, or
15408 one screenful, or 10 screen lines, whichever is largest.
15409 Give up if distance is greater than scroll_max or if we
15410 didn't reach the scroll margin position. */
15411 SET_TEXT_POS (pos, PT, PT_BYTE);
15412 start_display (&it, w, pos);
15413 y0 = it.current_y;
15414 y_to_move = max (it.last_visible_y,
15415 max (scroll_max, 10 * frame_line_height));
15416 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15417 y_to_move, -1,
15418 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15419 dy = it.current_y - y0;
15420 if (dy > scroll_max
15421 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15422 return SCROLLING_FAILED;
15423
15424 /* Additional scroll for when ZV was too close to point. */
15425 dy += y_offset;
15426
15427 /* Compute new window start. */
15428 start_display (&it, w, startp);
15429
15430 if (arg_scroll_conservatively)
15431 amount_to_scroll = max (dy, frame_line_height
15432 * max (scroll_step, temp_scroll_step));
15433 else if (scroll_step || temp_scroll_step)
15434 amount_to_scroll = scroll_max;
15435 else
15436 {
15437 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15438 height = WINDOW_BOX_TEXT_HEIGHT (w);
15439 if (NUMBERP (aggressive))
15440 {
15441 double float_amount = XFLOATINT (aggressive) * height;
15442 int aggressive_scroll = float_amount;
15443 if (aggressive_scroll == 0 && float_amount > 0)
15444 aggressive_scroll = 1;
15445 /* Don't let point enter the scroll margin near
15446 bottom of the window, if the value of
15447 scroll_down_aggressively happens to be too
15448 large. */
15449 if (aggressive_scroll + 2 * this_scroll_margin > height)
15450 aggressive_scroll = height - 2 * this_scroll_margin;
15451 amount_to_scroll = dy + aggressive_scroll;
15452 }
15453 }
15454
15455 if (amount_to_scroll <= 0)
15456 return SCROLLING_FAILED;
15457
15458 move_it_vertically_backward (&it, amount_to_scroll);
15459 startp = it.current.pos;
15460 }
15461 }
15462
15463 /* Run window scroll functions. */
15464 startp = run_window_scroll_functions (window, startp);
15465
15466 /* Display the window. Give up if new fonts are loaded, or if point
15467 doesn't appear. */
15468 if (!try_window (window, startp, 0))
15469 rc = SCROLLING_NEED_LARGER_MATRICES;
15470 else if (w->cursor.vpos < 0)
15471 {
15472 clear_glyph_matrix (w->desired_matrix);
15473 rc = SCROLLING_FAILED;
15474 }
15475 else
15476 {
15477 /* Maybe forget recorded base line for line number display. */
15478 if (!just_this_one_p
15479 || current_buffer->clip_changed
15480 || BEG_UNCHANGED < CHARPOS (startp))
15481 w->base_line_number = 0;
15482
15483 /* If cursor ends up on a partially visible line,
15484 treat that as being off the bottom of the screen. */
15485 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1,
15486 false)
15487 /* It's possible that the cursor is on the first line of the
15488 buffer, which is partially obscured due to a vscroll
15489 (Bug#7537). In that case, avoid looping forever. */
15490 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15491 {
15492 clear_glyph_matrix (w->desired_matrix);
15493 ++extra_scroll_margin_lines;
15494 goto too_near_end;
15495 }
15496 rc = SCROLLING_SUCCESS;
15497 }
15498
15499 return rc;
15500 }
15501
15502
15503 /* Compute a suitable window start for window W if display of W starts
15504 on a continuation line. Value is true if a new window start
15505 was computed.
15506
15507 The new window start will be computed, based on W's width, starting
15508 from the start of the continued line. It is the start of the
15509 screen line with the minimum distance from the old start W->start,
15510 which is still before point (otherwise point will definitely not
15511 be visible in the window). */
15512
15513 static bool
15514 compute_window_start_on_continuation_line (struct window *w)
15515 {
15516 struct text_pos pos, start_pos, pos_before_pt;
15517 bool window_start_changed_p = false;
15518
15519 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15520
15521 /* If window start is on a continuation line... Window start may be
15522 < BEGV in case there's invisible text at the start of the
15523 buffer (M-x rmail, for example). */
15524 if (CHARPOS (start_pos) > BEGV
15525 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15526 {
15527 struct it it;
15528 struct glyph_row *row;
15529
15530 /* Handle the case that the window start is out of range. */
15531 if (CHARPOS (start_pos) < BEGV)
15532 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15533 else if (CHARPOS (start_pos) > ZV)
15534 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15535
15536 /* Find the start of the continued line. This should be fast
15537 because find_newline is fast (newline cache). */
15538 row = w->desired_matrix->rows + WINDOW_WANTS_HEADER_LINE_P (w);
15539 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15540 row, DEFAULT_FACE_ID);
15541 reseat_at_previous_visible_line_start (&it);
15542
15543 /* If the line start is "too far" away from the window start,
15544 say it takes too much time to compute a new window start.
15545 Also, give up if the line start is after point, as in that
15546 case point will not be visible with any window start we
15547 compute. */
15548 if (IT_CHARPOS (it) <= PT
15549 || (CHARPOS (start_pos) - IT_CHARPOS (it)
15550 /* PXW: Do we need upper bounds here? */
15551 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w)))
15552 {
15553 int min_distance, distance;
15554
15555 /* Move forward by display lines to find the new window
15556 start. If window width was enlarged, the new start can
15557 be expected to be > the old start. If window width was
15558 decreased, the new window start will be < the old start.
15559 So, we're looking for the display line start with the
15560 minimum distance from the old window start. */
15561 pos_before_pt = pos = it.current.pos;
15562 min_distance = INFINITY;
15563 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15564 distance < min_distance)
15565 {
15566 min_distance = distance;
15567 if (CHARPOS (pos) <= PT)
15568 pos_before_pt = pos;
15569 pos = it.current.pos;
15570 if (it.line_wrap == WORD_WRAP)
15571 {
15572 /* Under WORD_WRAP, move_it_by_lines is likely to
15573 overshoot and stop not at the first, but the
15574 second character from the left margin. So in
15575 that case, we need a more tight control on the X
15576 coordinate of the iterator than move_it_by_lines
15577 promises in its contract. The method is to first
15578 go to the last (rightmost) visible character of a
15579 line, then move to the leftmost character on the
15580 next line in a separate call. */
15581 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15582 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15583 move_it_to (&it, ZV, 0,
15584 it.current_y + it.max_ascent + it.max_descent, -1,
15585 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15586 }
15587 else
15588 move_it_by_lines (&it, 1);
15589 }
15590
15591 /* It makes very little sense to make the new window start
15592 after point, as point won't be visible. If that's what
15593 the loop above finds, fall back on the candidate before
15594 or at point that is closest to the old window start. */
15595 if (CHARPOS (pos) > PT)
15596 pos = pos_before_pt;
15597
15598 /* Set the window start there. */
15599 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15600 window_start_changed_p = true;
15601 }
15602 }
15603
15604 return window_start_changed_p;
15605 }
15606
15607
15608 /* Try cursor movement in case text has not changed in window WINDOW,
15609 with window start STARTP. Value is
15610
15611 CURSOR_MOVEMENT_SUCCESS if successful
15612
15613 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15614
15615 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15616 display. *SCROLL_STEP is set to true, under certain circumstances, if
15617 we want to scroll as if scroll-step were set to 1. See the code.
15618
15619 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15620 which case we have to abort this redisplay, and adjust matrices
15621 first. */
15622
15623 enum
15624 {
15625 CURSOR_MOVEMENT_SUCCESS,
15626 CURSOR_MOVEMENT_CANNOT_BE_USED,
15627 CURSOR_MOVEMENT_MUST_SCROLL,
15628 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15629 };
15630
15631 static int
15632 try_cursor_movement (Lisp_Object window, struct text_pos startp,
15633 bool *scroll_step)
15634 {
15635 struct window *w = XWINDOW (window);
15636 struct frame *f = XFRAME (w->frame);
15637 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15638
15639 #ifdef GLYPH_DEBUG
15640 if (inhibit_try_cursor_movement)
15641 return rc;
15642 #endif
15643
15644 /* Previously, there was a check for Lisp integer in the
15645 if-statement below. Now, this field is converted to
15646 ptrdiff_t, thus zero means invalid position in a buffer. */
15647 eassert (w->last_point > 0);
15648 /* Likewise there was a check whether window_end_vpos is nil or larger
15649 than the window. Now window_end_vpos is int and so never nil, but
15650 let's leave eassert to check whether it fits in the window. */
15651 eassert (!w->window_end_valid
15652 || w->window_end_vpos < w->current_matrix->nrows);
15653
15654 /* Handle case where text has not changed, only point, and it has
15655 not moved off the frame. */
15656 if (/* Point may be in this window. */
15657 PT >= CHARPOS (startp)
15658 /* Selective display hasn't changed. */
15659 && !current_buffer->clip_changed
15660 /* Function force-mode-line-update is used to force a thorough
15661 redisplay. It sets either windows_or_buffers_changed or
15662 update_mode_lines. So don't take a shortcut here for these
15663 cases. */
15664 && !update_mode_lines
15665 && !windows_or_buffers_changed
15666 && !f->cursor_type_changed
15667 && NILP (Vshow_trailing_whitespace)
15668 /* This code is not used for mini-buffer for the sake of the case
15669 of redisplaying to replace an echo area message; since in
15670 that case the mini-buffer contents per se are usually
15671 unchanged. This code is of no real use in the mini-buffer
15672 since the handling of this_line_start_pos, etc., in redisplay
15673 handles the same cases. */
15674 && !EQ (window, minibuf_window)
15675 && (FRAME_WINDOW_P (f)
15676 || !overlay_arrow_in_current_buffer_p ()))
15677 {
15678 int this_scroll_margin, top_scroll_margin;
15679 struct glyph_row *row = NULL;
15680 int frame_line_height = default_line_pixel_height (w);
15681 int window_total_lines
15682 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15683
15684 #ifdef GLYPH_DEBUG
15685 debug_method_add (w, "cursor movement");
15686 #endif
15687
15688 /* Scroll if point within this distance from the top or bottom
15689 of the window. This is a pixel value. */
15690 if (scroll_margin > 0)
15691 {
15692 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15693 this_scroll_margin *= frame_line_height;
15694 }
15695 else
15696 this_scroll_margin = 0;
15697
15698 top_scroll_margin = this_scroll_margin;
15699 if (WINDOW_WANTS_HEADER_LINE_P (w))
15700 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15701
15702 /* Start with the row the cursor was displayed during the last
15703 not paused redisplay. Give up if that row is not valid. */
15704 if (w->last_cursor_vpos < 0
15705 || w->last_cursor_vpos >= w->current_matrix->nrows)
15706 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15707 else
15708 {
15709 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15710 if (row->mode_line_p)
15711 ++row;
15712 if (!row->enabled_p)
15713 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15714 }
15715
15716 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15717 {
15718 bool scroll_p = false, must_scroll = false;
15719 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15720
15721 if (PT > w->last_point)
15722 {
15723 /* Point has moved forward. */
15724 while (MATRIX_ROW_END_CHARPOS (row) < PT
15725 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15726 {
15727 eassert (row->enabled_p);
15728 ++row;
15729 }
15730
15731 /* If the end position of a row equals the start
15732 position of the next row, and PT is at that position,
15733 we would rather display cursor in the next line. */
15734 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15735 && MATRIX_ROW_END_CHARPOS (row) == PT
15736 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15737 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15738 && !cursor_row_p (row))
15739 ++row;
15740
15741 /* If within the scroll margin, scroll. Note that
15742 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15743 the next line would be drawn, and that
15744 this_scroll_margin can be zero. */
15745 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15746 || PT > MATRIX_ROW_END_CHARPOS (row)
15747 /* Line is completely visible last line in window
15748 and PT is to be set in the next line. */
15749 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15750 && PT == MATRIX_ROW_END_CHARPOS (row)
15751 && !row->ends_at_zv_p
15752 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15753 scroll_p = true;
15754 }
15755 else if (PT < w->last_point)
15756 {
15757 /* Cursor has to be moved backward. Note that PT >=
15758 CHARPOS (startp) because of the outer if-statement. */
15759 while (!row->mode_line_p
15760 && (MATRIX_ROW_START_CHARPOS (row) > PT
15761 || (MATRIX_ROW_START_CHARPOS (row) == PT
15762 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15763 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15764 row > w->current_matrix->rows
15765 && (row-1)->ends_in_newline_from_string_p))))
15766 && (row->y > top_scroll_margin
15767 || CHARPOS (startp) == BEGV))
15768 {
15769 eassert (row->enabled_p);
15770 --row;
15771 }
15772
15773 /* Consider the following case: Window starts at BEGV,
15774 there is invisible, intangible text at BEGV, so that
15775 display starts at some point START > BEGV. It can
15776 happen that we are called with PT somewhere between
15777 BEGV and START. Try to handle that case. */
15778 if (row < w->current_matrix->rows
15779 || row->mode_line_p)
15780 {
15781 row = w->current_matrix->rows;
15782 if (row->mode_line_p)
15783 ++row;
15784 }
15785
15786 /* Due to newlines in overlay strings, we may have to
15787 skip forward over overlay strings. */
15788 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15789 && MATRIX_ROW_END_CHARPOS (row) == PT
15790 && !cursor_row_p (row))
15791 ++row;
15792
15793 /* If within the scroll margin, scroll. */
15794 if (row->y < top_scroll_margin
15795 && CHARPOS (startp) != BEGV)
15796 scroll_p = true;
15797 }
15798 else
15799 {
15800 /* Cursor did not move. So don't scroll even if cursor line
15801 is partially visible, as it was so before. */
15802 rc = CURSOR_MOVEMENT_SUCCESS;
15803 }
15804
15805 if (PT < MATRIX_ROW_START_CHARPOS (row)
15806 || PT > MATRIX_ROW_END_CHARPOS (row))
15807 {
15808 /* if PT is not in the glyph row, give up. */
15809 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15810 must_scroll = true;
15811 }
15812 else if (rc != CURSOR_MOVEMENT_SUCCESS
15813 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15814 {
15815 struct glyph_row *row1;
15816
15817 /* If rows are bidi-reordered and point moved, back up
15818 until we find a row that does not belong to a
15819 continuation line. This is because we must consider
15820 all rows of a continued line as candidates for the
15821 new cursor positioning, since row start and end
15822 positions change non-linearly with vertical position
15823 in such rows. */
15824 /* FIXME: Revisit this when glyph ``spilling'' in
15825 continuation lines' rows is implemented for
15826 bidi-reordered rows. */
15827 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15828 MATRIX_ROW_CONTINUATION_LINE_P (row);
15829 --row)
15830 {
15831 /* If we hit the beginning of the displayed portion
15832 without finding the first row of a continued
15833 line, give up. */
15834 if (row <= row1)
15835 {
15836 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15837 break;
15838 }
15839 eassert (row->enabled_p);
15840 }
15841 }
15842 if (must_scroll)
15843 ;
15844 else if (rc != CURSOR_MOVEMENT_SUCCESS
15845 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15846 /* Make sure this isn't a header line by any chance, since
15847 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield true. */
15848 && !row->mode_line_p
15849 && make_cursor_line_fully_visible_p)
15850 {
15851 if (PT == MATRIX_ROW_END_CHARPOS (row)
15852 && !row->ends_at_zv_p
15853 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15854 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15855 else if (row->height > window_box_height (w))
15856 {
15857 /* If we end up in a partially visible line, let's
15858 make it fully visible, except when it's taller
15859 than the window, in which case we can't do much
15860 about it. */
15861 *scroll_step = true;
15862 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15863 }
15864 else
15865 {
15866 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15867 if (!cursor_row_fully_visible_p (w, false, true))
15868 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15869 else
15870 rc = CURSOR_MOVEMENT_SUCCESS;
15871 }
15872 }
15873 else if (scroll_p)
15874 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15875 else if (rc != CURSOR_MOVEMENT_SUCCESS
15876 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15877 {
15878 /* With bidi-reordered rows, there could be more than
15879 one candidate row whose start and end positions
15880 occlude point. We need to let set_cursor_from_row
15881 find the best candidate. */
15882 /* FIXME: Revisit this when glyph ``spilling'' in
15883 continuation lines' rows is implemented for
15884 bidi-reordered rows. */
15885 bool rv = false;
15886
15887 do
15888 {
15889 bool at_zv_p = false, exact_match_p = false;
15890
15891 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15892 && PT <= MATRIX_ROW_END_CHARPOS (row)
15893 && cursor_row_p (row))
15894 rv |= set_cursor_from_row (w, row, w->current_matrix,
15895 0, 0, 0, 0);
15896 /* As soon as we've found the exact match for point,
15897 or the first suitable row whose ends_at_zv_p flag
15898 is set, we are done. */
15899 if (rv)
15900 {
15901 at_zv_p = MATRIX_ROW (w->current_matrix,
15902 w->cursor.vpos)->ends_at_zv_p;
15903 if (!at_zv_p
15904 && w->cursor.hpos >= 0
15905 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15906 w->cursor.vpos))
15907 {
15908 struct glyph_row *candidate =
15909 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15910 struct glyph *g =
15911 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15912 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15913
15914 exact_match_p =
15915 (BUFFERP (g->object) && g->charpos == PT)
15916 || (NILP (g->object)
15917 && (g->charpos == PT
15918 || (g->charpos == 0 && endpos - 1 == PT)));
15919 }
15920 if (at_zv_p || exact_match_p)
15921 {
15922 rc = CURSOR_MOVEMENT_SUCCESS;
15923 break;
15924 }
15925 }
15926 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15927 break;
15928 ++row;
15929 }
15930 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15931 || row->continued_p)
15932 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15933 || (MATRIX_ROW_START_CHARPOS (row) == PT
15934 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15935 /* If we didn't find any candidate rows, or exited the
15936 loop before all the candidates were examined, signal
15937 to the caller that this method failed. */
15938 if (rc != CURSOR_MOVEMENT_SUCCESS
15939 && !(rv
15940 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15941 && !row->continued_p))
15942 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15943 else if (rv)
15944 rc = CURSOR_MOVEMENT_SUCCESS;
15945 }
15946 else
15947 {
15948 do
15949 {
15950 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15951 {
15952 rc = CURSOR_MOVEMENT_SUCCESS;
15953 break;
15954 }
15955 ++row;
15956 }
15957 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15958 && MATRIX_ROW_START_CHARPOS (row) == PT
15959 && cursor_row_p (row));
15960 }
15961 }
15962 }
15963
15964 return rc;
15965 }
15966
15967
15968 void
15969 set_vertical_scroll_bar (struct window *w)
15970 {
15971 ptrdiff_t start, end, whole;
15972
15973 /* Calculate the start and end positions for the current window.
15974 At some point, it would be nice to choose between scrollbars
15975 which reflect the whole buffer size, with special markers
15976 indicating narrowing, and scrollbars which reflect only the
15977 visible region.
15978
15979 Note that mini-buffers sometimes aren't displaying any text. */
15980 if (!MINI_WINDOW_P (w)
15981 || (w == XWINDOW (minibuf_window)
15982 && NILP (echo_area_buffer[0])))
15983 {
15984 struct buffer *buf = XBUFFER (w->contents);
15985 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15986 start = marker_position (w->start) - BUF_BEGV (buf);
15987 /* I don't think this is guaranteed to be right. For the
15988 moment, we'll pretend it is. */
15989 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15990
15991 if (end < start)
15992 end = start;
15993 if (whole < (end - start))
15994 whole = end - start;
15995 }
15996 else
15997 start = end = whole = 0;
15998
15999 /* Indicate what this scroll bar ought to be displaying now. */
16000 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
16001 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
16002 (w, end - start, whole, start);
16003 }
16004
16005
16006 void
16007 set_horizontal_scroll_bar (struct window *w)
16008 {
16009 int start, end, whole, portion;
16010
16011 if (!MINI_WINDOW_P (w)
16012 || (w == XWINDOW (minibuf_window)
16013 && NILP (echo_area_buffer[0])))
16014 {
16015 struct buffer *b = XBUFFER (w->contents);
16016 struct buffer *old_buffer = NULL;
16017 struct it it;
16018 struct text_pos startp;
16019
16020 if (b != current_buffer)
16021 {
16022 old_buffer = current_buffer;
16023 set_buffer_internal (b);
16024 }
16025
16026 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16027 start_display (&it, w, startp);
16028 it.last_visible_x = INT_MAX;
16029 whole = move_it_to (&it, -1, INT_MAX, window_box_height (w), -1,
16030 MOVE_TO_X | MOVE_TO_Y);
16031 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
16032 window_box_height (w), -1,
16033 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
16034
16035 start = w->hscroll * FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));
16036 end = start + window_box_width (w, TEXT_AREA);
16037 portion = end - start;
16038 /* After enlarging a horizontally scrolled window such that it
16039 gets at least as wide as the text it contains, make sure that
16040 the thumb doesn't fill the entire scroll bar so we can still
16041 drag it back to see the entire text. */
16042 whole = max (whole, end);
16043
16044 if (it.bidi_p)
16045 {
16046 Lisp_Object pdir;
16047
16048 pdir = Fcurrent_bidi_paragraph_direction (Qnil);
16049 if (EQ (pdir, Qright_to_left))
16050 {
16051 start = whole - end;
16052 end = start + portion;
16053 }
16054 }
16055
16056 if (old_buffer)
16057 set_buffer_internal (old_buffer);
16058 }
16059 else
16060 start = end = whole = portion = 0;
16061
16062 w->hscroll_whole = whole;
16063
16064 /* Indicate what this scroll bar ought to be displaying now. */
16065 if (FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
16066 (*FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
16067 (w, portion, whole, start);
16068 }
16069
16070
16071 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P means only
16072 selected_window is redisplayed.
16073
16074 We can return without actually redisplaying the window if fonts has been
16075 changed on window's frame. In that case, redisplay_internal will retry.
16076
16077 As one of the important parts of redisplaying a window, we need to
16078 decide whether the previous window-start position (stored in the
16079 window's w->start marker position) is still valid, and if it isn't,
16080 recompute it. Some details about that:
16081
16082 . The previous window-start could be in a continuation line, in
16083 which case we need to recompute it when the window width
16084 changes. See compute_window_start_on_continuation_line and its
16085 call below.
16086
16087 . The text that changed since last redisplay could include the
16088 previous window-start position. In that case, we try to salvage
16089 what we can from the current glyph matrix by calling
16090 try_scrolling, which see.
16091
16092 . Some Emacs command could force us to use a specific window-start
16093 position by setting the window's force_start flag, or gently
16094 propose doing that by setting the window's optional_new_start
16095 flag. In these cases, we try using the specified start point if
16096 that succeeds (i.e. the window desired matrix is successfully
16097 recomputed, and point location is within the window). In case
16098 of optional_new_start, we first check if the specified start
16099 position is feasible, i.e. if it will allow point to be
16100 displayed in the window. If using the specified start point
16101 fails, e.g., if new fonts are needed to be loaded, we abort the
16102 redisplay cycle and leave it up to the next cycle to figure out
16103 things.
16104
16105 . Note that the window's force_start flag is sometimes set by
16106 redisplay itself, when it decides that the previous window start
16107 point is fine and should be kept. Search for "goto force_start"
16108 below to see the details. Like the values of window-start
16109 specified outside of redisplay, these internally-deduced values
16110 are tested for feasibility, and ignored if found to be
16111 unfeasible.
16112
16113 . Note that the function try_window, used to completely redisplay
16114 a window, accepts the window's start point as its argument.
16115 This is used several times in the redisplay code to control
16116 where the window start will be, according to user options such
16117 as scroll-conservatively, and also to ensure the screen line
16118 showing point will be fully (as opposed to partially) visible on
16119 display. */
16120
16121 static void
16122 redisplay_window (Lisp_Object window, bool just_this_one_p)
16123 {
16124 struct window *w = XWINDOW (window);
16125 struct frame *f = XFRAME (w->frame);
16126 struct buffer *buffer = XBUFFER (w->contents);
16127 struct buffer *old = current_buffer;
16128 struct text_pos lpoint, opoint, startp;
16129 bool update_mode_line;
16130 int tem;
16131 struct it it;
16132 /* Record it now because it's overwritten. */
16133 bool current_matrix_up_to_date_p = false;
16134 bool used_current_matrix_p = false;
16135 /* This is less strict than current_matrix_up_to_date_p.
16136 It indicates that the buffer contents and narrowing are unchanged. */
16137 bool buffer_unchanged_p = false;
16138 bool temp_scroll_step = false;
16139 ptrdiff_t count = SPECPDL_INDEX ();
16140 int rc;
16141 int centering_position = -1;
16142 bool last_line_misfit = false;
16143 ptrdiff_t beg_unchanged, end_unchanged;
16144 int frame_line_height;
16145 bool use_desired_matrix;
16146
16147 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16148 opoint = lpoint;
16149
16150 #ifdef GLYPH_DEBUG
16151 *w->desired_matrix->method = 0;
16152 #endif
16153
16154 if (!just_this_one_p
16155 && REDISPLAY_SOME_P ()
16156 && !w->redisplay
16157 && !w->update_mode_line
16158 && !f->face_change
16159 && !f->redisplay
16160 && !buffer->text->redisplay
16161 && BUF_PT (buffer) == w->last_point)
16162 return;
16163
16164 /* Make sure that both W's markers are valid. */
16165 eassert (XMARKER (w->start)->buffer == buffer);
16166 eassert (XMARKER (w->pointm)->buffer == buffer);
16167
16168 /* We come here again if we need to run window-text-change-functions
16169 below. */
16170 restart:
16171 reconsider_clip_changes (w);
16172 frame_line_height = default_line_pixel_height (w);
16173
16174 /* Has the mode line to be updated? */
16175 update_mode_line = (w->update_mode_line
16176 || update_mode_lines
16177 || buffer->clip_changed
16178 || buffer->prevent_redisplay_optimizations_p);
16179
16180 if (!just_this_one_p)
16181 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16182 cleverly elsewhere. */
16183 w->must_be_updated_p = true;
16184
16185 if (MINI_WINDOW_P (w))
16186 {
16187 if (w == XWINDOW (echo_area_window)
16188 && !NILP (echo_area_buffer[0]))
16189 {
16190 if (update_mode_line)
16191 /* We may have to update a tty frame's menu bar or a
16192 tool-bar. Example `M-x C-h C-h C-g'. */
16193 goto finish_menu_bars;
16194 else
16195 /* We've already displayed the echo area glyphs in this window. */
16196 goto finish_scroll_bars;
16197 }
16198 else if ((w != XWINDOW (minibuf_window)
16199 || minibuf_level == 0)
16200 /* When buffer is nonempty, redisplay window normally. */
16201 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
16202 /* Quail displays non-mini buffers in minibuffer window.
16203 In that case, redisplay the window normally. */
16204 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
16205 {
16206 /* W is a mini-buffer window, but it's not active, so clear
16207 it. */
16208 int yb = window_text_bottom_y (w);
16209 struct glyph_row *row;
16210 int y;
16211
16212 for (y = 0, row = w->desired_matrix->rows;
16213 y < yb;
16214 y += row->height, ++row)
16215 blank_row (w, row, y);
16216 goto finish_scroll_bars;
16217 }
16218
16219 clear_glyph_matrix (w->desired_matrix);
16220 }
16221
16222 /* Otherwise set up data on this window; select its buffer and point
16223 value. */
16224 /* Really select the buffer, for the sake of buffer-local
16225 variables. */
16226 set_buffer_internal_1 (XBUFFER (w->contents));
16227
16228 current_matrix_up_to_date_p
16229 = (w->window_end_valid
16230 && !current_buffer->clip_changed
16231 && !current_buffer->prevent_redisplay_optimizations_p
16232 && !window_outdated (w));
16233
16234 /* Run the window-text-change-functions
16235 if it is possible that the text on the screen has changed
16236 (either due to modification of the text, or any other reason). */
16237 if (!current_matrix_up_to_date_p
16238 && !NILP (Vwindow_text_change_functions))
16239 {
16240 safe_run_hooks (Qwindow_text_change_functions);
16241 goto restart;
16242 }
16243
16244 beg_unchanged = BEG_UNCHANGED;
16245 end_unchanged = END_UNCHANGED;
16246
16247 SET_TEXT_POS (opoint, PT, PT_BYTE);
16248
16249 specbind (Qinhibit_point_motion_hooks, Qt);
16250
16251 buffer_unchanged_p
16252 = (w->window_end_valid
16253 && !current_buffer->clip_changed
16254 && !window_outdated (w));
16255
16256 /* When windows_or_buffers_changed is non-zero, we can't rely
16257 on the window end being valid, so set it to zero there. */
16258 if (windows_or_buffers_changed)
16259 {
16260 /* If window starts on a continuation line, maybe adjust the
16261 window start in case the window's width changed. */
16262 if (XMARKER (w->start)->buffer == current_buffer)
16263 compute_window_start_on_continuation_line (w);
16264
16265 w->window_end_valid = false;
16266 /* If so, we also can't rely on current matrix
16267 and should not fool try_cursor_movement below. */
16268 current_matrix_up_to_date_p = false;
16269 }
16270
16271 /* Some sanity checks. */
16272 CHECK_WINDOW_END (w);
16273 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
16274 emacs_abort ();
16275 if (BYTEPOS (opoint) < CHARPOS (opoint))
16276 emacs_abort ();
16277
16278 if (mode_line_update_needed (w))
16279 update_mode_line = true;
16280
16281 /* Point refers normally to the selected window. For any other
16282 window, set up appropriate value. */
16283 if (!EQ (window, selected_window))
16284 {
16285 ptrdiff_t new_pt = marker_position (w->pointm);
16286 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
16287
16288 if (new_pt < BEGV)
16289 {
16290 new_pt = BEGV;
16291 new_pt_byte = BEGV_BYTE;
16292 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
16293 }
16294 else if (new_pt > (ZV - 1))
16295 {
16296 new_pt = ZV;
16297 new_pt_byte = ZV_BYTE;
16298 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
16299 }
16300
16301 /* We don't use SET_PT so that the point-motion hooks don't run. */
16302 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
16303 }
16304
16305 /* If any of the character widths specified in the display table
16306 have changed, invalidate the width run cache. It's true that
16307 this may be a bit late to catch such changes, but the rest of
16308 redisplay goes (non-fatally) haywire when the display table is
16309 changed, so why should we worry about doing any better? */
16310 if (current_buffer->width_run_cache
16311 || (current_buffer->base_buffer
16312 && current_buffer->base_buffer->width_run_cache))
16313 {
16314 struct Lisp_Char_Table *disptab = buffer_display_table ();
16315
16316 if (! disptab_matches_widthtab
16317 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
16318 {
16319 struct buffer *buf = current_buffer;
16320
16321 if (buf->base_buffer)
16322 buf = buf->base_buffer;
16323 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
16324 recompute_width_table (current_buffer, disptab);
16325 }
16326 }
16327
16328 /* If window-start is screwed up, choose a new one. */
16329 if (XMARKER (w->start)->buffer != current_buffer)
16330 goto recenter;
16331
16332 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16333
16334 /* If someone specified a new starting point but did not insist,
16335 check whether it can be used. */
16336 if ((w->optional_new_start || window_frozen_p (w))
16337 && CHARPOS (startp) >= BEGV
16338 && CHARPOS (startp) <= ZV)
16339 {
16340 ptrdiff_t it_charpos;
16341
16342 w->optional_new_start = false;
16343 start_display (&it, w, startp);
16344 move_it_to (&it, PT, 0, it.last_visible_y, -1,
16345 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
16346 /* Record IT's position now, since line_bottom_y might change
16347 that. */
16348 it_charpos = IT_CHARPOS (it);
16349 /* Make sure we set the force_start flag only if the cursor row
16350 will be fully visible. Otherwise, the code under force_start
16351 label below will try to move point back into view, which is
16352 not what the code which sets optional_new_start wants. */
16353 if ((it.current_y == 0 || line_bottom_y (&it) < it.last_visible_y)
16354 && !w->force_start)
16355 {
16356 if (it_charpos == PT)
16357 w->force_start = true;
16358 /* IT may overshoot PT if text at PT is invisible. */
16359 else if (it_charpos > PT && CHARPOS (startp) <= PT)
16360 w->force_start = true;
16361 #ifdef GLYPH_DEBUG
16362 if (w->force_start)
16363 {
16364 if (window_frozen_p (w))
16365 debug_method_add (w, "set force_start from frozen window start");
16366 else
16367 debug_method_add (w, "set force_start from optional_new_start");
16368 }
16369 #endif
16370 }
16371 }
16372
16373 force_start:
16374
16375 /* Handle case where place to start displaying has been specified,
16376 unless the specified location is outside the accessible range. */
16377 if (w->force_start)
16378 {
16379 /* We set this later on if we have to adjust point. */
16380 int new_vpos = -1;
16381
16382 w->force_start = false;
16383 w->vscroll = 0;
16384 w->window_end_valid = false;
16385
16386 /* Forget any recorded base line for line number display. */
16387 if (!buffer_unchanged_p)
16388 w->base_line_number = 0;
16389
16390 /* Redisplay the mode line. Select the buffer properly for that.
16391 Also, run the hook window-scroll-functions
16392 because we have scrolled. */
16393 /* Note, we do this after clearing force_start because
16394 if there's an error, it is better to forget about force_start
16395 than to get into an infinite loop calling the hook functions
16396 and having them get more errors. */
16397 if (!update_mode_line
16398 || ! NILP (Vwindow_scroll_functions))
16399 {
16400 update_mode_line = true;
16401 w->update_mode_line = true;
16402 startp = run_window_scroll_functions (window, startp);
16403 }
16404
16405 if (CHARPOS (startp) < BEGV)
16406 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16407 else if (CHARPOS (startp) > ZV)
16408 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16409
16410 /* Redisplay, then check if cursor has been set during the
16411 redisplay. Give up if new fonts were loaded. */
16412 /* We used to issue a CHECK_MARGINS argument to try_window here,
16413 but this causes scrolling to fail when point begins inside
16414 the scroll margin (bug#148) -- cyd */
16415 if (!try_window (window, startp, 0))
16416 {
16417 w->force_start = true;
16418 clear_glyph_matrix (w->desired_matrix);
16419 goto need_larger_matrices;
16420 }
16421
16422 if (w->cursor.vpos < 0)
16423 {
16424 /* If point does not appear, try to move point so it does
16425 appear. The desired matrix has been built above, so we
16426 can use it here. First see if point is in invisible
16427 text, and if so, move it to the first visible buffer
16428 position past that. */
16429 struct glyph_row *r = NULL;
16430 Lisp_Object invprop =
16431 get_char_property_and_overlay (make_number (PT), Qinvisible,
16432 Qnil, NULL);
16433
16434 if (TEXT_PROP_MEANS_INVISIBLE (invprop) != 0)
16435 {
16436 ptrdiff_t alt_pt;
16437 Lisp_Object invprop_end =
16438 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16439 Qnil, Qnil);
16440
16441 if (NATNUMP (invprop_end))
16442 alt_pt = XFASTINT (invprop_end);
16443 else
16444 alt_pt = ZV;
16445 r = row_containing_pos (w, alt_pt, w->desired_matrix->rows,
16446 NULL, 0);
16447 }
16448 if (r)
16449 new_vpos = MATRIX_ROW_BOTTOM_Y (r);
16450 else /* Give up and just move to the middle of the window. */
16451 new_vpos = window_box_height (w) / 2;
16452 }
16453
16454 if (!cursor_row_fully_visible_p (w, false, false))
16455 {
16456 /* Point does appear, but on a line partly visible at end of window.
16457 Move it back to a fully-visible line. */
16458 new_vpos = window_box_height (w);
16459 /* But if window_box_height suggests a Y coordinate that is
16460 not less than we already have, that line will clearly not
16461 be fully visible, so give up and scroll the display.
16462 This can happen when the default face uses a font whose
16463 dimensions are different from the frame's default
16464 font. */
16465 if (new_vpos >= w->cursor.y)
16466 {
16467 w->cursor.vpos = -1;
16468 clear_glyph_matrix (w->desired_matrix);
16469 goto try_to_scroll;
16470 }
16471 }
16472 else if (w->cursor.vpos >= 0)
16473 {
16474 /* Some people insist on not letting point enter the scroll
16475 margin, even though this part handles windows that didn't
16476 scroll at all. */
16477 int window_total_lines
16478 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16479 int margin = min (scroll_margin, window_total_lines / 4);
16480 int pixel_margin = margin * frame_line_height;
16481 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16482
16483 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16484 below, which finds the row to move point to, advances by
16485 the Y coordinate of the _next_ row, see the definition of
16486 MATRIX_ROW_BOTTOM_Y. */
16487 if (w->cursor.vpos < margin + header_line)
16488 {
16489 w->cursor.vpos = -1;
16490 clear_glyph_matrix (w->desired_matrix);
16491 goto try_to_scroll;
16492 }
16493 else
16494 {
16495 int window_height = window_box_height (w);
16496
16497 if (header_line)
16498 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16499 if (w->cursor.y >= window_height - pixel_margin)
16500 {
16501 w->cursor.vpos = -1;
16502 clear_glyph_matrix (w->desired_matrix);
16503 goto try_to_scroll;
16504 }
16505 }
16506 }
16507
16508 /* If we need to move point for either of the above reasons,
16509 now actually do it. */
16510 if (new_vpos >= 0)
16511 {
16512 struct glyph_row *row;
16513
16514 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16515 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16516 ++row;
16517
16518 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16519 MATRIX_ROW_START_BYTEPOS (row));
16520
16521 if (w != XWINDOW (selected_window))
16522 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16523 else if (current_buffer == old)
16524 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16525
16526 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16527
16528 /* Re-run pre-redisplay-function so it can update the region
16529 according to the new position of point. */
16530 /* Other than the cursor, w's redisplay is done so we can set its
16531 redisplay to false. Also the buffer's redisplay can be set to
16532 false, since propagate_buffer_redisplay should have already
16533 propagated its info to `w' anyway. */
16534 w->redisplay = false;
16535 XBUFFER (w->contents)->text->redisplay = false;
16536 safe__call1 (true, Vpre_redisplay_function, Fcons (window, Qnil));
16537
16538 if (w->redisplay || XBUFFER (w->contents)->text->redisplay)
16539 {
16540 /* pre-redisplay-function made changes (e.g. move the region)
16541 that require another round of redisplay. */
16542 clear_glyph_matrix (w->desired_matrix);
16543 if (!try_window (window, startp, 0))
16544 goto need_larger_matrices;
16545 }
16546 }
16547 if (w->cursor.vpos < 0 || !cursor_row_fully_visible_p (w, false, false))
16548 {
16549 clear_glyph_matrix (w->desired_matrix);
16550 goto try_to_scroll;
16551 }
16552
16553 #ifdef GLYPH_DEBUG
16554 debug_method_add (w, "forced window start");
16555 #endif
16556 goto done;
16557 }
16558
16559 /* Handle case where text has not changed, only point, and it has
16560 not moved off the frame, and we are not retrying after hscroll.
16561 (current_matrix_up_to_date_p is true when retrying.) */
16562 if (current_matrix_up_to_date_p
16563 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16564 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16565 {
16566 switch (rc)
16567 {
16568 case CURSOR_MOVEMENT_SUCCESS:
16569 used_current_matrix_p = true;
16570 goto done;
16571
16572 case CURSOR_MOVEMENT_MUST_SCROLL:
16573 goto try_to_scroll;
16574
16575 default:
16576 emacs_abort ();
16577 }
16578 }
16579 /* If current starting point was originally the beginning of a line
16580 but no longer is, find a new starting point. */
16581 else if (w->start_at_line_beg
16582 && !(CHARPOS (startp) <= BEGV
16583 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16584 {
16585 #ifdef GLYPH_DEBUG
16586 debug_method_add (w, "recenter 1");
16587 #endif
16588 goto recenter;
16589 }
16590
16591 /* Try scrolling with try_window_id. Value is > 0 if update has
16592 been done, it is -1 if we know that the same window start will
16593 not work. It is 0 if unsuccessful for some other reason. */
16594 else if ((tem = try_window_id (w)) != 0)
16595 {
16596 #ifdef GLYPH_DEBUG
16597 debug_method_add (w, "try_window_id %d", tem);
16598 #endif
16599
16600 if (f->fonts_changed)
16601 goto need_larger_matrices;
16602 if (tem > 0)
16603 goto done;
16604
16605 /* Otherwise try_window_id has returned -1 which means that we
16606 don't want the alternative below this comment to execute. */
16607 }
16608 else if (CHARPOS (startp) >= BEGV
16609 && CHARPOS (startp) <= ZV
16610 && PT >= CHARPOS (startp)
16611 && (CHARPOS (startp) < ZV
16612 /* Avoid starting at end of buffer. */
16613 || CHARPOS (startp) == BEGV
16614 || !window_outdated (w)))
16615 {
16616 int d1, d2, d5, d6;
16617 int rtop, rbot;
16618
16619 /* If first window line is a continuation line, and window start
16620 is inside the modified region, but the first change is before
16621 current window start, we must select a new window start.
16622
16623 However, if this is the result of a down-mouse event (e.g. by
16624 extending the mouse-drag-overlay), we don't want to select a
16625 new window start, since that would change the position under
16626 the mouse, resulting in an unwanted mouse-movement rather
16627 than a simple mouse-click. */
16628 if (!w->start_at_line_beg
16629 && NILP (do_mouse_tracking)
16630 && CHARPOS (startp) > BEGV
16631 && CHARPOS (startp) > BEG + beg_unchanged
16632 && CHARPOS (startp) <= Z - end_unchanged
16633 /* Even if w->start_at_line_beg is nil, a new window may
16634 start at a line_beg, since that's how set_buffer_window
16635 sets it. So, we need to check the return value of
16636 compute_window_start_on_continuation_line. (See also
16637 bug#197). */
16638 && XMARKER (w->start)->buffer == current_buffer
16639 && compute_window_start_on_continuation_line (w)
16640 /* It doesn't make sense to force the window start like we
16641 do at label force_start if it is already known that point
16642 will not be fully visible in the resulting window, because
16643 doing so will move point from its correct position
16644 instead of scrolling the window to bring point into view.
16645 See bug#9324. */
16646 && pos_visible_p (w, PT, &d1, &d2, &rtop, &rbot, &d5, &d6)
16647 /* A very tall row could need more than the window height,
16648 in which case we accept that it is partially visible. */
16649 && (rtop != 0) == (rbot != 0))
16650 {
16651 w->force_start = true;
16652 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16653 #ifdef GLYPH_DEBUG
16654 debug_method_add (w, "recomputed window start in continuation line");
16655 #endif
16656 goto force_start;
16657 }
16658
16659 #ifdef GLYPH_DEBUG
16660 debug_method_add (w, "same window start");
16661 #endif
16662
16663 /* Try to redisplay starting at same place as before.
16664 If point has not moved off frame, accept the results. */
16665 if (!current_matrix_up_to_date_p
16666 /* Don't use try_window_reusing_current_matrix in this case
16667 because a window scroll function can have changed the
16668 buffer. */
16669 || !NILP (Vwindow_scroll_functions)
16670 || MINI_WINDOW_P (w)
16671 || !(used_current_matrix_p
16672 = try_window_reusing_current_matrix (w)))
16673 {
16674 IF_DEBUG (debug_method_add (w, "1"));
16675 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16676 /* -1 means we need to scroll.
16677 0 means we need new matrices, but fonts_changed
16678 is set in that case, so we will detect it below. */
16679 goto try_to_scroll;
16680 }
16681
16682 if (f->fonts_changed)
16683 goto need_larger_matrices;
16684
16685 if (w->cursor.vpos >= 0)
16686 {
16687 if (!just_this_one_p
16688 || current_buffer->clip_changed
16689 || BEG_UNCHANGED < CHARPOS (startp))
16690 /* Forget any recorded base line for line number display. */
16691 w->base_line_number = 0;
16692
16693 if (!cursor_row_fully_visible_p (w, true, false))
16694 {
16695 clear_glyph_matrix (w->desired_matrix);
16696 last_line_misfit = true;
16697 }
16698 /* Drop through and scroll. */
16699 else
16700 goto done;
16701 }
16702 else
16703 clear_glyph_matrix (w->desired_matrix);
16704 }
16705
16706 try_to_scroll:
16707
16708 /* Redisplay the mode line. Select the buffer properly for that. */
16709 if (!update_mode_line)
16710 {
16711 update_mode_line = true;
16712 w->update_mode_line = true;
16713 }
16714
16715 /* Try to scroll by specified few lines. */
16716 if ((scroll_conservatively
16717 || emacs_scroll_step
16718 || temp_scroll_step
16719 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16720 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16721 && CHARPOS (startp) >= BEGV
16722 && CHARPOS (startp) <= ZV)
16723 {
16724 /* The function returns -1 if new fonts were loaded, 1 if
16725 successful, 0 if not successful. */
16726 int ss = try_scrolling (window, just_this_one_p,
16727 scroll_conservatively,
16728 emacs_scroll_step,
16729 temp_scroll_step, last_line_misfit);
16730 switch (ss)
16731 {
16732 case SCROLLING_SUCCESS:
16733 goto done;
16734
16735 case SCROLLING_NEED_LARGER_MATRICES:
16736 goto need_larger_matrices;
16737
16738 case SCROLLING_FAILED:
16739 break;
16740
16741 default:
16742 emacs_abort ();
16743 }
16744 }
16745
16746 /* Finally, just choose a place to start which positions point
16747 according to user preferences. */
16748
16749 recenter:
16750
16751 #ifdef GLYPH_DEBUG
16752 debug_method_add (w, "recenter");
16753 #endif
16754
16755 /* Forget any previously recorded base line for line number display. */
16756 if (!buffer_unchanged_p)
16757 w->base_line_number = 0;
16758
16759 /* Determine the window start relative to point. */
16760 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16761 it.current_y = it.last_visible_y;
16762 if (centering_position < 0)
16763 {
16764 int window_total_lines
16765 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16766 int margin
16767 = scroll_margin > 0
16768 ? min (scroll_margin, window_total_lines / 4)
16769 : 0;
16770 ptrdiff_t margin_pos = CHARPOS (startp);
16771 Lisp_Object aggressive;
16772 bool scrolling_up;
16773
16774 /* If there is a scroll margin at the top of the window, find
16775 its character position. */
16776 if (margin
16777 /* Cannot call start_display if startp is not in the
16778 accessible region of the buffer. This can happen when we
16779 have just switched to a different buffer and/or changed
16780 its restriction. In that case, startp is initialized to
16781 the character position 1 (BEGV) because we did not yet
16782 have chance to display the buffer even once. */
16783 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16784 {
16785 struct it it1;
16786 void *it1data = NULL;
16787
16788 SAVE_IT (it1, it, it1data);
16789 start_display (&it1, w, startp);
16790 move_it_vertically (&it1, margin * frame_line_height);
16791 margin_pos = IT_CHARPOS (it1);
16792 RESTORE_IT (&it, &it, it1data);
16793 }
16794 scrolling_up = PT > margin_pos;
16795 aggressive =
16796 scrolling_up
16797 ? BVAR (current_buffer, scroll_up_aggressively)
16798 : BVAR (current_buffer, scroll_down_aggressively);
16799
16800 if (!MINI_WINDOW_P (w)
16801 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16802 {
16803 int pt_offset = 0;
16804
16805 /* Setting scroll-conservatively overrides
16806 scroll-*-aggressively. */
16807 if (!scroll_conservatively && NUMBERP (aggressive))
16808 {
16809 double float_amount = XFLOATINT (aggressive);
16810
16811 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16812 if (pt_offset == 0 && float_amount > 0)
16813 pt_offset = 1;
16814 if (pt_offset && margin > 0)
16815 margin -= 1;
16816 }
16817 /* Compute how much to move the window start backward from
16818 point so that point will be displayed where the user
16819 wants it. */
16820 if (scrolling_up)
16821 {
16822 centering_position = it.last_visible_y;
16823 if (pt_offset)
16824 centering_position -= pt_offset;
16825 centering_position -=
16826 (frame_line_height * (1 + margin + last_line_misfit)
16827 + WINDOW_HEADER_LINE_HEIGHT (w));
16828 /* Don't let point enter the scroll margin near top of
16829 the window. */
16830 if (centering_position < margin * frame_line_height)
16831 centering_position = margin * frame_line_height;
16832 }
16833 else
16834 centering_position = margin * frame_line_height + pt_offset;
16835 }
16836 else
16837 /* Set the window start half the height of the window backward
16838 from point. */
16839 centering_position = window_box_height (w) / 2;
16840 }
16841 move_it_vertically_backward (&it, centering_position);
16842
16843 eassert (IT_CHARPOS (it) >= BEGV);
16844
16845 /* The function move_it_vertically_backward may move over more
16846 than the specified y-distance. If it->w is small, e.g. a
16847 mini-buffer window, we may end up in front of the window's
16848 display area. Start displaying at the start of the line
16849 containing PT in this case. */
16850 if (it.current_y <= 0)
16851 {
16852 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16853 move_it_vertically_backward (&it, 0);
16854 it.current_y = 0;
16855 }
16856
16857 it.current_x = it.hpos = 0;
16858
16859 /* Set the window start position here explicitly, to avoid an
16860 infinite loop in case the functions in window-scroll-functions
16861 get errors. */
16862 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16863
16864 /* Run scroll hooks. */
16865 startp = run_window_scroll_functions (window, it.current.pos);
16866
16867 /* Redisplay the window. */
16868 use_desired_matrix = false;
16869 if (!current_matrix_up_to_date_p
16870 || windows_or_buffers_changed
16871 || f->cursor_type_changed
16872 /* Don't use try_window_reusing_current_matrix in this case
16873 because it can have changed the buffer. */
16874 || !NILP (Vwindow_scroll_functions)
16875 || !just_this_one_p
16876 || MINI_WINDOW_P (w)
16877 || !(used_current_matrix_p
16878 = try_window_reusing_current_matrix (w)))
16879 use_desired_matrix = (try_window (window, startp, 0) == 1);
16880
16881 /* If new fonts have been loaded (due to fontsets), give up. We
16882 have to start a new redisplay since we need to re-adjust glyph
16883 matrices. */
16884 if (f->fonts_changed)
16885 goto need_larger_matrices;
16886
16887 /* If cursor did not appear assume that the middle of the window is
16888 in the first line of the window. Do it again with the next line.
16889 (Imagine a window of height 100, displaying two lines of height
16890 60. Moving back 50 from it->last_visible_y will end in the first
16891 line.) */
16892 if (w->cursor.vpos < 0)
16893 {
16894 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16895 {
16896 clear_glyph_matrix (w->desired_matrix);
16897 move_it_by_lines (&it, 1);
16898 try_window (window, it.current.pos, 0);
16899 }
16900 else if (PT < IT_CHARPOS (it))
16901 {
16902 clear_glyph_matrix (w->desired_matrix);
16903 move_it_by_lines (&it, -1);
16904 try_window (window, it.current.pos, 0);
16905 }
16906 else
16907 {
16908 /* Not much we can do about it. */
16909 }
16910 }
16911
16912 /* Consider the following case: Window starts at BEGV, there is
16913 invisible, intangible text at BEGV, so that display starts at
16914 some point START > BEGV. It can happen that we are called with
16915 PT somewhere between BEGV and START. Try to handle that case,
16916 and similar ones. */
16917 if (w->cursor.vpos < 0)
16918 {
16919 /* Prefer the desired matrix to the current matrix, if possible,
16920 in the fallback calculations below. This is because using
16921 the current matrix might completely goof, e.g. if its first
16922 row is after point. */
16923 struct glyph_matrix *matrix =
16924 use_desired_matrix ? w->desired_matrix : w->current_matrix;
16925 /* First, try locating the proper glyph row for PT. */
16926 struct glyph_row *row =
16927 row_containing_pos (w, PT, matrix->rows, NULL, 0);
16928
16929 /* Sometimes point is at the beginning of invisible text that is
16930 before the 1st character displayed in the row. In that case,
16931 row_containing_pos fails to find the row, because no glyphs
16932 with appropriate buffer positions are present in the row.
16933 Therefore, we next try to find the row which shows the 1st
16934 position after the invisible text. */
16935 if (!row)
16936 {
16937 Lisp_Object val =
16938 get_char_property_and_overlay (make_number (PT), Qinvisible,
16939 Qnil, NULL);
16940
16941 if (TEXT_PROP_MEANS_INVISIBLE (val) != 0)
16942 {
16943 ptrdiff_t alt_pos;
16944 Lisp_Object invis_end =
16945 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16946 Qnil, Qnil);
16947
16948 if (NATNUMP (invis_end))
16949 alt_pos = XFASTINT (invis_end);
16950 else
16951 alt_pos = ZV;
16952 row = row_containing_pos (w, alt_pos, matrix->rows, NULL, 0);
16953 }
16954 }
16955 /* Finally, fall back on the first row of the window after the
16956 header line (if any). This is slightly better than not
16957 displaying the cursor at all. */
16958 if (!row)
16959 {
16960 row = matrix->rows;
16961 if (row->mode_line_p)
16962 ++row;
16963 }
16964 set_cursor_from_row (w, row, matrix, 0, 0, 0, 0);
16965 }
16966
16967 if (!cursor_row_fully_visible_p (w, false, false))
16968 {
16969 /* If vscroll is enabled, disable it and try again. */
16970 if (w->vscroll)
16971 {
16972 w->vscroll = 0;
16973 clear_glyph_matrix (w->desired_matrix);
16974 goto recenter;
16975 }
16976
16977 /* Users who set scroll-conservatively to a large number want
16978 point just above/below the scroll margin. If we ended up
16979 with point's row partially visible, move the window start to
16980 make that row fully visible and out of the margin. */
16981 if (scroll_conservatively > SCROLL_LIMIT)
16982 {
16983 int window_total_lines
16984 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16985 int margin =
16986 scroll_margin > 0
16987 ? min (scroll_margin, window_total_lines / 4)
16988 : 0;
16989 bool move_down = w->cursor.vpos >= window_total_lines / 2;
16990
16991 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16992 clear_glyph_matrix (w->desired_matrix);
16993 if (1 == try_window (window, it.current.pos,
16994 TRY_WINDOW_CHECK_MARGINS))
16995 goto done;
16996 }
16997
16998 /* If centering point failed to make the whole line visible,
16999 put point at the top instead. That has to make the whole line
17000 visible, if it can be done. */
17001 if (centering_position == 0)
17002 goto done;
17003
17004 clear_glyph_matrix (w->desired_matrix);
17005 centering_position = 0;
17006 goto recenter;
17007 }
17008
17009 done:
17010
17011 SET_TEXT_POS_FROM_MARKER (startp, w->start);
17012 w->start_at_line_beg = (CHARPOS (startp) == BEGV
17013 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
17014
17015 /* Display the mode line, if we must. */
17016 if ((update_mode_line
17017 /* If window not full width, must redo its mode line
17018 if (a) the window to its side is being redone and
17019 (b) we do a frame-based redisplay. This is a consequence
17020 of how inverted lines are drawn in frame-based redisplay. */
17021 || (!just_this_one_p
17022 && !FRAME_WINDOW_P (f)
17023 && !WINDOW_FULL_WIDTH_P (w))
17024 /* Line number to display. */
17025 || w->base_line_pos > 0
17026 /* Column number is displayed and different from the one displayed. */
17027 || (w->column_number_displayed != -1
17028 && (w->column_number_displayed != current_column ())))
17029 /* This means that the window has a mode line. */
17030 && (WINDOW_WANTS_MODELINE_P (w)
17031 || WINDOW_WANTS_HEADER_LINE_P (w)))
17032 {
17033
17034 display_mode_lines (w);
17035
17036 /* If mode line height has changed, arrange for a thorough
17037 immediate redisplay using the correct mode line height. */
17038 if (WINDOW_WANTS_MODELINE_P (w)
17039 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
17040 {
17041 f->fonts_changed = true;
17042 w->mode_line_height = -1;
17043 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
17044 = DESIRED_MODE_LINE_HEIGHT (w);
17045 }
17046
17047 /* If header line height has changed, arrange for a thorough
17048 immediate redisplay using the correct header line height. */
17049 if (WINDOW_WANTS_HEADER_LINE_P (w)
17050 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
17051 {
17052 f->fonts_changed = true;
17053 w->header_line_height = -1;
17054 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
17055 = DESIRED_HEADER_LINE_HEIGHT (w);
17056 }
17057
17058 if (f->fonts_changed)
17059 goto need_larger_matrices;
17060 }
17061
17062 if (!line_number_displayed && w->base_line_pos != -1)
17063 {
17064 w->base_line_pos = 0;
17065 w->base_line_number = 0;
17066 }
17067
17068 finish_menu_bars:
17069
17070 /* When we reach a frame's selected window, redo the frame's menu
17071 bar and the frame's title. */
17072 if (update_mode_line
17073 && EQ (FRAME_SELECTED_WINDOW (f), window))
17074 {
17075 bool redisplay_menu_p;
17076
17077 if (FRAME_WINDOW_P (f))
17078 {
17079 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
17080 || defined (HAVE_NS) || defined (USE_GTK)
17081 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
17082 #else
17083 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
17084 #endif
17085 }
17086 else
17087 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
17088
17089 if (redisplay_menu_p)
17090 display_menu_bar (w);
17091
17092 #ifdef HAVE_WINDOW_SYSTEM
17093 if (FRAME_WINDOW_P (f))
17094 {
17095 #if defined (USE_GTK) || defined (HAVE_NS)
17096 if (FRAME_EXTERNAL_TOOL_BAR (f))
17097 redisplay_tool_bar (f);
17098 #else
17099 if (WINDOWP (f->tool_bar_window)
17100 && (FRAME_TOOL_BAR_LINES (f) > 0
17101 || !NILP (Vauto_resize_tool_bars))
17102 && redisplay_tool_bar (f))
17103 ignore_mouse_drag_p = true;
17104 #endif
17105 }
17106 ptrdiff_t count1 = SPECPDL_INDEX ();
17107 /* x_consider_frame_title calls select-frame, which calls
17108 resize_mini_window, which could resize the mini-window and by
17109 that undo the effect of this redisplay cycle wrt minibuffer
17110 and echo-area display. Binding inhibit-redisplay to t makes
17111 the call to resize_mini_window a no-op, thus avoiding the
17112 adverse side effects. */
17113 specbind (Qinhibit_redisplay, Qt);
17114 x_consider_frame_title (w->frame);
17115 unbind_to (count1, Qnil);
17116 #endif
17117 }
17118
17119 #ifdef HAVE_WINDOW_SYSTEM
17120 if (FRAME_WINDOW_P (f)
17121 && update_window_fringes (w, (just_this_one_p
17122 || (!used_current_matrix_p && !overlay_arrow_seen)
17123 || w->pseudo_window_p)))
17124 {
17125 update_begin (f);
17126 block_input ();
17127 if (draw_window_fringes (w, true))
17128 {
17129 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
17130 x_draw_right_divider (w);
17131 else
17132 x_draw_vertical_border (w);
17133 }
17134 unblock_input ();
17135 update_end (f);
17136 }
17137
17138 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
17139 x_draw_bottom_divider (w);
17140 #endif /* HAVE_WINDOW_SYSTEM */
17141
17142 /* We go to this label, with fonts_changed set, if it is
17143 necessary to try again using larger glyph matrices.
17144 We have to redeem the scroll bar even in this case,
17145 because the loop in redisplay_internal expects that. */
17146 need_larger_matrices:
17147 ;
17148 finish_scroll_bars:
17149
17150 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
17151 {
17152 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
17153 /* Set the thumb's position and size. */
17154 set_vertical_scroll_bar (w);
17155
17156 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
17157 /* Set the thumb's position and size. */
17158 set_horizontal_scroll_bar (w);
17159
17160 /* Note that we actually used the scroll bar attached to this
17161 window, so it shouldn't be deleted at the end of redisplay. */
17162 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
17163 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
17164 }
17165
17166 /* Restore current_buffer and value of point in it. The window
17167 update may have changed the buffer, so first make sure `opoint'
17168 is still valid (Bug#6177). */
17169 if (CHARPOS (opoint) < BEGV)
17170 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
17171 else if (CHARPOS (opoint) > ZV)
17172 TEMP_SET_PT_BOTH (Z, Z_BYTE);
17173 else
17174 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
17175
17176 set_buffer_internal_1 (old);
17177 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
17178 shorter. This can be caused by log truncation in *Messages*. */
17179 if (CHARPOS (lpoint) <= ZV)
17180 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
17181
17182 unbind_to (count, Qnil);
17183 }
17184
17185
17186 /* Build the complete desired matrix of WINDOW with a window start
17187 buffer position POS.
17188
17189 Value is 1 if successful. It is zero if fonts were loaded during
17190 redisplay which makes re-adjusting glyph matrices necessary, and -1
17191 if point would appear in the scroll margins.
17192 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
17193 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
17194 set in FLAGS.) */
17195
17196 int
17197 try_window (Lisp_Object window, struct text_pos pos, int flags)
17198 {
17199 struct window *w = XWINDOW (window);
17200 struct it it;
17201 struct glyph_row *last_text_row = NULL;
17202 struct frame *f = XFRAME (w->frame);
17203 int frame_line_height = default_line_pixel_height (w);
17204
17205 /* Make POS the new window start. */
17206 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
17207
17208 /* Mark cursor position as unknown. No overlay arrow seen. */
17209 w->cursor.vpos = -1;
17210 overlay_arrow_seen = false;
17211
17212 /* Initialize iterator and info to start at POS. */
17213 start_display (&it, w, pos);
17214 it.glyph_row->reversed_p = false;
17215
17216 /* Display all lines of W. */
17217 while (it.current_y < it.last_visible_y)
17218 {
17219 if (display_line (&it))
17220 last_text_row = it.glyph_row - 1;
17221 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
17222 return 0;
17223 }
17224
17225 /* Don't let the cursor end in the scroll margins. */
17226 if ((flags & TRY_WINDOW_CHECK_MARGINS)
17227 && !MINI_WINDOW_P (w))
17228 {
17229 int this_scroll_margin;
17230 int window_total_lines
17231 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
17232
17233 if (scroll_margin > 0)
17234 {
17235 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
17236 this_scroll_margin *= frame_line_height;
17237 }
17238 else
17239 this_scroll_margin = 0;
17240
17241 if ((w->cursor.y >= 0 /* not vscrolled */
17242 && w->cursor.y < this_scroll_margin
17243 && CHARPOS (pos) > BEGV
17244 && IT_CHARPOS (it) < ZV)
17245 /* rms: considering make_cursor_line_fully_visible_p here
17246 seems to give wrong results. We don't want to recenter
17247 when the last line is partly visible, we want to allow
17248 that case to be handled in the usual way. */
17249 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
17250 {
17251 w->cursor.vpos = -1;
17252 clear_glyph_matrix (w->desired_matrix);
17253 return -1;
17254 }
17255 }
17256
17257 /* If bottom moved off end of frame, change mode line percentage. */
17258 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
17259 w->update_mode_line = true;
17260
17261 /* Set window_end_pos to the offset of the last character displayed
17262 on the window from the end of current_buffer. Set
17263 window_end_vpos to its row number. */
17264 if (last_text_row)
17265 {
17266 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
17267 adjust_window_ends (w, last_text_row, false);
17268 eassert
17269 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
17270 w->window_end_vpos)));
17271 }
17272 else
17273 {
17274 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17275 w->window_end_pos = Z - ZV;
17276 w->window_end_vpos = 0;
17277 }
17278
17279 /* But that is not valid info until redisplay finishes. */
17280 w->window_end_valid = false;
17281 return 1;
17282 }
17283
17284
17285 \f
17286 /************************************************************************
17287 Window redisplay reusing current matrix when buffer has not changed
17288 ************************************************************************/
17289
17290 /* Try redisplay of window W showing an unchanged buffer with a
17291 different window start than the last time it was displayed by
17292 reusing its current matrix. Value is true if successful.
17293 W->start is the new window start. */
17294
17295 static bool
17296 try_window_reusing_current_matrix (struct window *w)
17297 {
17298 struct frame *f = XFRAME (w->frame);
17299 struct glyph_row *bottom_row;
17300 struct it it;
17301 struct run run;
17302 struct text_pos start, new_start;
17303 int nrows_scrolled, i;
17304 struct glyph_row *last_text_row;
17305 struct glyph_row *last_reused_text_row;
17306 struct glyph_row *start_row;
17307 int start_vpos, min_y, max_y;
17308
17309 #ifdef GLYPH_DEBUG
17310 if (inhibit_try_window_reusing)
17311 return false;
17312 #endif
17313
17314 if (/* This function doesn't handle terminal frames. */
17315 !FRAME_WINDOW_P (f)
17316 /* Don't try to reuse the display if windows have been split
17317 or such. */
17318 || windows_or_buffers_changed
17319 || f->cursor_type_changed)
17320 return false;
17321
17322 /* Can't do this if showing trailing whitespace. */
17323 if (!NILP (Vshow_trailing_whitespace))
17324 return false;
17325
17326 /* If top-line visibility has changed, give up. */
17327 if (WINDOW_WANTS_HEADER_LINE_P (w)
17328 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
17329 return false;
17330
17331 /* Give up if old or new display is scrolled vertically. We could
17332 make this function handle this, but right now it doesn't. */
17333 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17334 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
17335 return false;
17336
17337 /* The variable new_start now holds the new window start. The old
17338 start `start' can be determined from the current matrix. */
17339 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
17340 start = start_row->minpos;
17341 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17342
17343 /* Clear the desired matrix for the display below. */
17344 clear_glyph_matrix (w->desired_matrix);
17345
17346 if (CHARPOS (new_start) <= CHARPOS (start))
17347 {
17348 /* Don't use this method if the display starts with an ellipsis
17349 displayed for invisible text. It's not easy to handle that case
17350 below, and it's certainly not worth the effort since this is
17351 not a frequent case. */
17352 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
17353 return false;
17354
17355 IF_DEBUG (debug_method_add (w, "twu1"));
17356
17357 /* Display up to a row that can be reused. The variable
17358 last_text_row is set to the last row displayed that displays
17359 text. Note that it.vpos == 0 if or if not there is a
17360 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17361 start_display (&it, w, new_start);
17362 w->cursor.vpos = -1;
17363 last_text_row = last_reused_text_row = NULL;
17364
17365 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17366 {
17367 /* If we have reached into the characters in the START row,
17368 that means the line boundaries have changed. So we
17369 can't start copying with the row START. Maybe it will
17370 work to start copying with the following row. */
17371 while (IT_CHARPOS (it) > CHARPOS (start))
17372 {
17373 /* Advance to the next row as the "start". */
17374 start_row++;
17375 start = start_row->minpos;
17376 /* If there are no more rows to try, or just one, give up. */
17377 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
17378 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
17379 || CHARPOS (start) == ZV)
17380 {
17381 clear_glyph_matrix (w->desired_matrix);
17382 return false;
17383 }
17384
17385 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17386 }
17387 /* If we have reached alignment, we can copy the rest of the
17388 rows. */
17389 if (IT_CHARPOS (it) == CHARPOS (start)
17390 /* Don't accept "alignment" inside a display vector,
17391 since start_row could have started in the middle of
17392 that same display vector (thus their character
17393 positions match), and we have no way of telling if
17394 that is the case. */
17395 && it.current.dpvec_index < 0)
17396 break;
17397
17398 it.glyph_row->reversed_p = false;
17399 if (display_line (&it))
17400 last_text_row = it.glyph_row - 1;
17401
17402 }
17403
17404 /* A value of current_y < last_visible_y means that we stopped
17405 at the previous window start, which in turn means that we
17406 have at least one reusable row. */
17407 if (it.current_y < it.last_visible_y)
17408 {
17409 struct glyph_row *row;
17410
17411 /* IT.vpos always starts from 0; it counts text lines. */
17412 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
17413
17414 /* Find PT if not already found in the lines displayed. */
17415 if (w->cursor.vpos < 0)
17416 {
17417 int dy = it.current_y - start_row->y;
17418
17419 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17420 row = row_containing_pos (w, PT, row, NULL, dy);
17421 if (row)
17422 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
17423 dy, nrows_scrolled);
17424 else
17425 {
17426 clear_glyph_matrix (w->desired_matrix);
17427 return false;
17428 }
17429 }
17430
17431 /* Scroll the display. Do it before the current matrix is
17432 changed. The problem here is that update has not yet
17433 run, i.e. part of the current matrix is not up to date.
17434 scroll_run_hook will clear the cursor, and use the
17435 current matrix to get the height of the row the cursor is
17436 in. */
17437 run.current_y = start_row->y;
17438 run.desired_y = it.current_y;
17439 run.height = it.last_visible_y - it.current_y;
17440
17441 if (run.height > 0 && run.current_y != run.desired_y)
17442 {
17443 update_begin (f);
17444 FRAME_RIF (f)->update_window_begin_hook (w);
17445 FRAME_RIF (f)->clear_window_mouse_face (w);
17446 FRAME_RIF (f)->scroll_run_hook (w, &run);
17447 FRAME_RIF (f)->update_window_end_hook (w, false, false);
17448 update_end (f);
17449 }
17450
17451 /* Shift current matrix down by nrows_scrolled lines. */
17452 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17453 rotate_matrix (w->current_matrix,
17454 start_vpos,
17455 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17456 nrows_scrolled);
17457
17458 /* Disable lines that must be updated. */
17459 for (i = 0; i < nrows_scrolled; ++i)
17460 (start_row + i)->enabled_p = false;
17461
17462 /* Re-compute Y positions. */
17463 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17464 max_y = it.last_visible_y;
17465 for (row = start_row + nrows_scrolled;
17466 row < bottom_row;
17467 ++row)
17468 {
17469 row->y = it.current_y;
17470 row->visible_height = row->height;
17471
17472 if (row->y < min_y)
17473 row->visible_height -= min_y - row->y;
17474 if (row->y + row->height > max_y)
17475 row->visible_height -= row->y + row->height - max_y;
17476 if (row->fringe_bitmap_periodic_p)
17477 row->redraw_fringe_bitmaps_p = true;
17478
17479 it.current_y += row->height;
17480
17481 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17482 last_reused_text_row = row;
17483 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17484 break;
17485 }
17486
17487 /* Disable lines in the current matrix which are now
17488 below the window. */
17489 for (++row; row < bottom_row; ++row)
17490 row->enabled_p = row->mode_line_p = false;
17491 }
17492
17493 /* Update window_end_pos etc.; last_reused_text_row is the last
17494 reused row from the current matrix containing text, if any.
17495 The value of last_text_row is the last displayed line
17496 containing text. */
17497 if (last_reused_text_row)
17498 adjust_window_ends (w, last_reused_text_row, true);
17499 else if (last_text_row)
17500 adjust_window_ends (w, last_text_row, false);
17501 else
17502 {
17503 /* This window must be completely empty. */
17504 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17505 w->window_end_pos = Z - ZV;
17506 w->window_end_vpos = 0;
17507 }
17508 w->window_end_valid = false;
17509
17510 /* Update hint: don't try scrolling again in update_window. */
17511 w->desired_matrix->no_scrolling_p = true;
17512
17513 #ifdef GLYPH_DEBUG
17514 debug_method_add (w, "try_window_reusing_current_matrix 1");
17515 #endif
17516 return true;
17517 }
17518 else if (CHARPOS (new_start) > CHARPOS (start))
17519 {
17520 struct glyph_row *pt_row, *row;
17521 struct glyph_row *first_reusable_row;
17522 struct glyph_row *first_row_to_display;
17523 int dy;
17524 int yb = window_text_bottom_y (w);
17525
17526 /* Find the row starting at new_start, if there is one. Don't
17527 reuse a partially visible line at the end. */
17528 first_reusable_row = start_row;
17529 while (first_reusable_row->enabled_p
17530 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17531 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17532 < CHARPOS (new_start)))
17533 ++first_reusable_row;
17534
17535 /* Give up if there is no row to reuse. */
17536 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17537 || !first_reusable_row->enabled_p
17538 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17539 != CHARPOS (new_start)))
17540 return false;
17541
17542 /* We can reuse fully visible rows beginning with
17543 first_reusable_row to the end of the window. Set
17544 first_row_to_display to the first row that cannot be reused.
17545 Set pt_row to the row containing point, if there is any. */
17546 pt_row = NULL;
17547 for (first_row_to_display = first_reusable_row;
17548 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17549 ++first_row_to_display)
17550 {
17551 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17552 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17553 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17554 && first_row_to_display->ends_at_zv_p
17555 && pt_row == NULL)))
17556 pt_row = first_row_to_display;
17557 }
17558
17559 /* Start displaying at the start of first_row_to_display. */
17560 eassert (first_row_to_display->y < yb);
17561 init_to_row_start (&it, w, first_row_to_display);
17562
17563 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17564 - start_vpos);
17565 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17566 - nrows_scrolled);
17567 it.current_y = (first_row_to_display->y - first_reusable_row->y
17568 + WINDOW_HEADER_LINE_HEIGHT (w));
17569
17570 /* Display lines beginning with first_row_to_display in the
17571 desired matrix. Set last_text_row to the last row displayed
17572 that displays text. */
17573 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17574 if (pt_row == NULL)
17575 w->cursor.vpos = -1;
17576 last_text_row = NULL;
17577 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17578 if (display_line (&it))
17579 last_text_row = it.glyph_row - 1;
17580
17581 /* If point is in a reused row, adjust y and vpos of the cursor
17582 position. */
17583 if (pt_row)
17584 {
17585 w->cursor.vpos -= nrows_scrolled;
17586 w->cursor.y -= first_reusable_row->y - start_row->y;
17587 }
17588
17589 /* Give up if point isn't in a row displayed or reused. (This
17590 also handles the case where w->cursor.vpos < nrows_scrolled
17591 after the calls to display_line, which can happen with scroll
17592 margins. See bug#1295.) */
17593 if (w->cursor.vpos < 0)
17594 {
17595 clear_glyph_matrix (w->desired_matrix);
17596 return false;
17597 }
17598
17599 /* Scroll the display. */
17600 run.current_y = first_reusable_row->y;
17601 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17602 run.height = it.last_visible_y - run.current_y;
17603 dy = run.current_y - run.desired_y;
17604
17605 if (run.height)
17606 {
17607 update_begin (f);
17608 FRAME_RIF (f)->update_window_begin_hook (w);
17609 FRAME_RIF (f)->clear_window_mouse_face (w);
17610 FRAME_RIF (f)->scroll_run_hook (w, &run);
17611 FRAME_RIF (f)->update_window_end_hook (w, false, false);
17612 update_end (f);
17613 }
17614
17615 /* Adjust Y positions of reused rows. */
17616 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17617 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17618 max_y = it.last_visible_y;
17619 for (row = first_reusable_row; row < first_row_to_display; ++row)
17620 {
17621 row->y -= dy;
17622 row->visible_height = row->height;
17623 if (row->y < min_y)
17624 row->visible_height -= min_y - row->y;
17625 if (row->y + row->height > max_y)
17626 row->visible_height -= row->y + row->height - max_y;
17627 if (row->fringe_bitmap_periodic_p)
17628 row->redraw_fringe_bitmaps_p = true;
17629 }
17630
17631 /* Scroll the current matrix. */
17632 eassert (nrows_scrolled > 0);
17633 rotate_matrix (w->current_matrix,
17634 start_vpos,
17635 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17636 -nrows_scrolled);
17637
17638 /* Disable rows not reused. */
17639 for (row -= nrows_scrolled; row < bottom_row; ++row)
17640 row->enabled_p = false;
17641
17642 /* Point may have moved to a different line, so we cannot assume that
17643 the previous cursor position is valid; locate the correct row. */
17644 if (pt_row)
17645 {
17646 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17647 row < bottom_row
17648 && PT >= MATRIX_ROW_END_CHARPOS (row)
17649 && !row->ends_at_zv_p;
17650 row++)
17651 {
17652 w->cursor.vpos++;
17653 w->cursor.y = row->y;
17654 }
17655 if (row < bottom_row)
17656 {
17657 /* Can't simply scan the row for point with
17658 bidi-reordered glyph rows. Let set_cursor_from_row
17659 figure out where to put the cursor, and if it fails,
17660 give up. */
17661 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17662 {
17663 if (!set_cursor_from_row (w, row, w->current_matrix,
17664 0, 0, 0, 0))
17665 {
17666 clear_glyph_matrix (w->desired_matrix);
17667 return false;
17668 }
17669 }
17670 else
17671 {
17672 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17673 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17674
17675 for (; glyph < end
17676 && (!BUFFERP (glyph->object)
17677 || glyph->charpos < PT);
17678 glyph++)
17679 {
17680 w->cursor.hpos++;
17681 w->cursor.x += glyph->pixel_width;
17682 }
17683 }
17684 }
17685 }
17686
17687 /* Adjust window end. A null value of last_text_row means that
17688 the window end is in reused rows which in turn means that
17689 only its vpos can have changed. */
17690 if (last_text_row)
17691 adjust_window_ends (w, last_text_row, false);
17692 else
17693 w->window_end_vpos -= nrows_scrolled;
17694
17695 w->window_end_valid = false;
17696 w->desired_matrix->no_scrolling_p = true;
17697
17698 #ifdef GLYPH_DEBUG
17699 debug_method_add (w, "try_window_reusing_current_matrix 2");
17700 #endif
17701 return true;
17702 }
17703
17704 return false;
17705 }
17706
17707
17708 \f
17709 /************************************************************************
17710 Window redisplay reusing current matrix when buffer has changed
17711 ************************************************************************/
17712
17713 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17714 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17715 ptrdiff_t *, ptrdiff_t *);
17716 static struct glyph_row *
17717 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17718 struct glyph_row *);
17719
17720
17721 /* Return the last row in MATRIX displaying text. If row START is
17722 non-null, start searching with that row. IT gives the dimensions
17723 of the display. Value is null if matrix is empty; otherwise it is
17724 a pointer to the row found. */
17725
17726 static struct glyph_row *
17727 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17728 struct glyph_row *start)
17729 {
17730 struct glyph_row *row, *row_found;
17731
17732 /* Set row_found to the last row in IT->w's current matrix
17733 displaying text. The loop looks funny but think of partially
17734 visible lines. */
17735 row_found = NULL;
17736 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17737 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17738 {
17739 eassert (row->enabled_p);
17740 row_found = row;
17741 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17742 break;
17743 ++row;
17744 }
17745
17746 return row_found;
17747 }
17748
17749
17750 /* Return the last row in the current matrix of W that is not affected
17751 by changes at the start of current_buffer that occurred since W's
17752 current matrix was built. Value is null if no such row exists.
17753
17754 BEG_UNCHANGED us the number of characters unchanged at the start of
17755 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17756 first changed character in current_buffer. Characters at positions <
17757 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17758 when the current matrix was built. */
17759
17760 static struct glyph_row *
17761 find_last_unchanged_at_beg_row (struct window *w)
17762 {
17763 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17764 struct glyph_row *row;
17765 struct glyph_row *row_found = NULL;
17766 int yb = window_text_bottom_y (w);
17767
17768 /* Find the last row displaying unchanged text. */
17769 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17770 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17771 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17772 ++row)
17773 {
17774 if (/* If row ends before first_changed_pos, it is unchanged,
17775 except in some case. */
17776 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17777 /* When row ends in ZV and we write at ZV it is not
17778 unchanged. */
17779 && !row->ends_at_zv_p
17780 /* When first_changed_pos is the end of a continued line,
17781 row is not unchanged because it may be no longer
17782 continued. */
17783 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17784 && (row->continued_p
17785 || row->exact_window_width_line_p))
17786 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17787 needs to be recomputed, so don't consider this row as
17788 unchanged. This happens when the last line was
17789 bidi-reordered and was killed immediately before this
17790 redisplay cycle. In that case, ROW->end stores the
17791 buffer position of the first visual-order character of
17792 the killed text, which is now beyond ZV. */
17793 && CHARPOS (row->end.pos) <= ZV)
17794 row_found = row;
17795
17796 /* Stop if last visible row. */
17797 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17798 break;
17799 }
17800
17801 return row_found;
17802 }
17803
17804
17805 /* Find the first glyph row in the current matrix of W that is not
17806 affected by changes at the end of current_buffer since the
17807 time W's current matrix was built.
17808
17809 Return in *DELTA the number of chars by which buffer positions in
17810 unchanged text at the end of current_buffer must be adjusted.
17811
17812 Return in *DELTA_BYTES the corresponding number of bytes.
17813
17814 Value is null if no such row exists, i.e. all rows are affected by
17815 changes. */
17816
17817 static struct glyph_row *
17818 find_first_unchanged_at_end_row (struct window *w,
17819 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17820 {
17821 struct glyph_row *row;
17822 struct glyph_row *row_found = NULL;
17823
17824 *delta = *delta_bytes = 0;
17825
17826 /* Display must not have been paused, otherwise the current matrix
17827 is not up to date. */
17828 eassert (w->window_end_valid);
17829
17830 /* A value of window_end_pos >= END_UNCHANGED means that the window
17831 end is in the range of changed text. If so, there is no
17832 unchanged row at the end of W's current matrix. */
17833 if (w->window_end_pos >= END_UNCHANGED)
17834 return NULL;
17835
17836 /* Set row to the last row in W's current matrix displaying text. */
17837 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17838
17839 /* If matrix is entirely empty, no unchanged row exists. */
17840 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17841 {
17842 /* The value of row is the last glyph row in the matrix having a
17843 meaningful buffer position in it. The end position of row
17844 corresponds to window_end_pos. This allows us to translate
17845 buffer positions in the current matrix to current buffer
17846 positions for characters not in changed text. */
17847 ptrdiff_t Z_old =
17848 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17849 ptrdiff_t Z_BYTE_old =
17850 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17851 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17852 struct glyph_row *first_text_row
17853 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17854
17855 *delta = Z - Z_old;
17856 *delta_bytes = Z_BYTE - Z_BYTE_old;
17857
17858 /* Set last_unchanged_pos to the buffer position of the last
17859 character in the buffer that has not been changed. Z is the
17860 index + 1 of the last character in current_buffer, i.e. by
17861 subtracting END_UNCHANGED we get the index of the last
17862 unchanged character, and we have to add BEG to get its buffer
17863 position. */
17864 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17865 last_unchanged_pos_old = last_unchanged_pos - *delta;
17866
17867 /* Search backward from ROW for a row displaying a line that
17868 starts at a minimum position >= last_unchanged_pos_old. */
17869 for (; row > first_text_row; --row)
17870 {
17871 /* This used to abort, but it can happen.
17872 It is ok to just stop the search instead here. KFS. */
17873 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17874 break;
17875
17876 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17877 row_found = row;
17878 }
17879 }
17880
17881 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17882
17883 return row_found;
17884 }
17885
17886
17887 /* Make sure that glyph rows in the current matrix of window W
17888 reference the same glyph memory as corresponding rows in the
17889 frame's frame matrix. This function is called after scrolling W's
17890 current matrix on a terminal frame in try_window_id and
17891 try_window_reusing_current_matrix. */
17892
17893 static void
17894 sync_frame_with_window_matrix_rows (struct window *w)
17895 {
17896 struct frame *f = XFRAME (w->frame);
17897 struct glyph_row *window_row, *window_row_end, *frame_row;
17898
17899 /* Preconditions: W must be a leaf window and full-width. Its frame
17900 must have a frame matrix. */
17901 eassert (BUFFERP (w->contents));
17902 eassert (WINDOW_FULL_WIDTH_P (w));
17903 eassert (!FRAME_WINDOW_P (f));
17904
17905 /* If W is a full-width window, glyph pointers in W's current matrix
17906 have, by definition, to be the same as glyph pointers in the
17907 corresponding frame matrix. Note that frame matrices have no
17908 marginal areas (see build_frame_matrix). */
17909 window_row = w->current_matrix->rows;
17910 window_row_end = window_row + w->current_matrix->nrows;
17911 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17912 while (window_row < window_row_end)
17913 {
17914 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17915 struct glyph *end = window_row->glyphs[LAST_AREA];
17916
17917 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17918 frame_row->glyphs[TEXT_AREA] = start;
17919 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17920 frame_row->glyphs[LAST_AREA] = end;
17921
17922 /* Disable frame rows whose corresponding window rows have
17923 been disabled in try_window_id. */
17924 if (!window_row->enabled_p)
17925 frame_row->enabled_p = false;
17926
17927 ++window_row, ++frame_row;
17928 }
17929 }
17930
17931
17932 /* Find the glyph row in window W containing CHARPOS. Consider all
17933 rows between START and END (not inclusive). END null means search
17934 all rows to the end of the display area of W. Value is the row
17935 containing CHARPOS or null. */
17936
17937 struct glyph_row *
17938 row_containing_pos (struct window *w, ptrdiff_t charpos,
17939 struct glyph_row *start, struct glyph_row *end, int dy)
17940 {
17941 struct glyph_row *row = start;
17942 struct glyph_row *best_row = NULL;
17943 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17944 int last_y;
17945
17946 /* If we happen to start on a header-line, skip that. */
17947 if (row->mode_line_p)
17948 ++row;
17949
17950 if ((end && row >= end) || !row->enabled_p)
17951 return NULL;
17952
17953 last_y = window_text_bottom_y (w) - dy;
17954
17955 while (true)
17956 {
17957 /* Give up if we have gone too far. */
17958 if ((end && row >= end) || !row->enabled_p)
17959 return NULL;
17960 /* This formerly returned if they were equal.
17961 I think that both quantities are of a "last plus one" type;
17962 if so, when they are equal, the row is within the screen. -- rms. */
17963 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17964 return NULL;
17965
17966 /* If it is in this row, return this row. */
17967 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17968 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17969 /* The end position of a row equals the start
17970 position of the next row. If CHARPOS is there, we
17971 would rather consider it displayed in the next
17972 line, except when this line ends in ZV. */
17973 && !row_for_charpos_p (row, charpos)))
17974 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17975 {
17976 struct glyph *g;
17977
17978 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17979 || (!best_row && !row->continued_p))
17980 return row;
17981 /* In bidi-reordered rows, there could be several rows whose
17982 edges surround CHARPOS, all of these rows belonging to
17983 the same continued line. We need to find the row which
17984 fits CHARPOS the best. */
17985 for (g = row->glyphs[TEXT_AREA];
17986 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17987 g++)
17988 {
17989 if (!STRINGP (g->object))
17990 {
17991 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17992 {
17993 mindif = eabs (g->charpos - charpos);
17994 best_row = row;
17995 /* Exact match always wins. */
17996 if (mindif == 0)
17997 return best_row;
17998 }
17999 }
18000 }
18001 }
18002 else if (best_row && !row->continued_p)
18003 return best_row;
18004 ++row;
18005 }
18006 }
18007
18008
18009 /* Try to redisplay window W by reusing its existing display. W's
18010 current matrix must be up to date when this function is called,
18011 i.e., window_end_valid must be true.
18012
18013 Value is
18014
18015 >= 1 if successful, i.e. display has been updated
18016 specifically:
18017 1 means the changes were in front of a newline that precedes
18018 the window start, and the whole current matrix was reused
18019 2 means the changes were after the last position displayed
18020 in the window, and the whole current matrix was reused
18021 3 means portions of the current matrix were reused, while
18022 some of the screen lines were redrawn
18023 -1 if redisplay with same window start is known not to succeed
18024 0 if otherwise unsuccessful
18025
18026 The following steps are performed:
18027
18028 1. Find the last row in the current matrix of W that is not
18029 affected by changes at the start of current_buffer. If no such row
18030 is found, give up.
18031
18032 2. Find the first row in W's current matrix that is not affected by
18033 changes at the end of current_buffer. Maybe there is no such row.
18034
18035 3. Display lines beginning with the row + 1 found in step 1 to the
18036 row found in step 2 or, if step 2 didn't find a row, to the end of
18037 the window.
18038
18039 4. If cursor is not known to appear on the window, give up.
18040
18041 5. If display stopped at the row found in step 2, scroll the
18042 display and current matrix as needed.
18043
18044 6. Maybe display some lines at the end of W, if we must. This can
18045 happen under various circumstances, like a partially visible line
18046 becoming fully visible, or because newly displayed lines are displayed
18047 in smaller font sizes.
18048
18049 7. Update W's window end information. */
18050
18051 static int
18052 try_window_id (struct window *w)
18053 {
18054 struct frame *f = XFRAME (w->frame);
18055 struct glyph_matrix *current_matrix = w->current_matrix;
18056 struct glyph_matrix *desired_matrix = w->desired_matrix;
18057 struct glyph_row *last_unchanged_at_beg_row;
18058 struct glyph_row *first_unchanged_at_end_row;
18059 struct glyph_row *row;
18060 struct glyph_row *bottom_row;
18061 int bottom_vpos;
18062 struct it it;
18063 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
18064 int dvpos, dy;
18065 struct text_pos start_pos;
18066 struct run run;
18067 int first_unchanged_at_end_vpos = 0;
18068 struct glyph_row *last_text_row, *last_text_row_at_end;
18069 struct text_pos start;
18070 ptrdiff_t first_changed_charpos, last_changed_charpos;
18071
18072 #ifdef GLYPH_DEBUG
18073 if (inhibit_try_window_id)
18074 return 0;
18075 #endif
18076
18077 /* This is handy for debugging. */
18078 #if false
18079 #define GIVE_UP(X) \
18080 do { \
18081 TRACE ((stderr, "try_window_id give up %d\n", (X))); \
18082 return 0; \
18083 } while (false)
18084 #else
18085 #define GIVE_UP(X) return 0
18086 #endif
18087
18088 SET_TEXT_POS_FROM_MARKER (start, w->start);
18089
18090 /* Don't use this for mini-windows because these can show
18091 messages and mini-buffers, and we don't handle that here. */
18092 if (MINI_WINDOW_P (w))
18093 GIVE_UP (1);
18094
18095 /* This flag is used to prevent redisplay optimizations. */
18096 if (windows_or_buffers_changed || f->cursor_type_changed)
18097 GIVE_UP (2);
18098
18099 /* This function's optimizations cannot be used if overlays have
18100 changed in the buffer displayed by the window, so give up if they
18101 have. */
18102 if (w->last_overlay_modified != OVERLAY_MODIFF)
18103 GIVE_UP (200);
18104
18105 /* Verify that narrowing has not changed.
18106 Also verify that we were not told to prevent redisplay optimizations.
18107 It would be nice to further
18108 reduce the number of cases where this prevents try_window_id. */
18109 if (current_buffer->clip_changed
18110 || current_buffer->prevent_redisplay_optimizations_p)
18111 GIVE_UP (3);
18112
18113 /* Window must either use window-based redisplay or be full width. */
18114 if (!FRAME_WINDOW_P (f)
18115 && (!FRAME_LINE_INS_DEL_OK (f)
18116 || !WINDOW_FULL_WIDTH_P (w)))
18117 GIVE_UP (4);
18118
18119 /* Give up if point is known NOT to appear in W. */
18120 if (PT < CHARPOS (start))
18121 GIVE_UP (5);
18122
18123 /* Another way to prevent redisplay optimizations. */
18124 if (w->last_modified == 0)
18125 GIVE_UP (6);
18126
18127 /* Verify that window is not hscrolled. */
18128 if (w->hscroll != 0)
18129 GIVE_UP (7);
18130
18131 /* Verify that display wasn't paused. */
18132 if (!w->window_end_valid)
18133 GIVE_UP (8);
18134
18135 /* Likewise if highlighting trailing whitespace. */
18136 if (!NILP (Vshow_trailing_whitespace))
18137 GIVE_UP (11);
18138
18139 /* Can't use this if overlay arrow position and/or string have
18140 changed. */
18141 if (overlay_arrows_changed_p ())
18142 GIVE_UP (12);
18143
18144 /* When word-wrap is on, adding a space to the first word of a
18145 wrapped line can change the wrap position, altering the line
18146 above it. It might be worthwhile to handle this more
18147 intelligently, but for now just redisplay from scratch. */
18148 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
18149 GIVE_UP (21);
18150
18151 /* Under bidi reordering, adding or deleting a character in the
18152 beginning of a paragraph, before the first strong directional
18153 character, can change the base direction of the paragraph (unless
18154 the buffer specifies a fixed paragraph direction), which will
18155 require redisplaying the whole paragraph. It might be worthwhile
18156 to find the paragraph limits and widen the range of redisplayed
18157 lines to that, but for now just give up this optimization and
18158 redisplay from scratch. */
18159 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
18160 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
18161 GIVE_UP (22);
18162
18163 /* Give up if the buffer has line-spacing set, as Lisp-level changes
18164 to that variable require thorough redisplay. */
18165 if (!NILP (BVAR (XBUFFER (w->contents), extra_line_spacing)))
18166 GIVE_UP (23);
18167
18168 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
18169 only if buffer has really changed. The reason is that the gap is
18170 initially at Z for freshly visited files. The code below would
18171 set end_unchanged to 0 in that case. */
18172 if (MODIFF > SAVE_MODIFF
18173 /* This seems to happen sometimes after saving a buffer. */
18174 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
18175 {
18176 if (GPT - BEG < BEG_UNCHANGED)
18177 BEG_UNCHANGED = GPT - BEG;
18178 if (Z - GPT < END_UNCHANGED)
18179 END_UNCHANGED = Z - GPT;
18180 }
18181
18182 /* The position of the first and last character that has been changed. */
18183 first_changed_charpos = BEG + BEG_UNCHANGED;
18184 last_changed_charpos = Z - END_UNCHANGED;
18185
18186 /* If window starts after a line end, and the last change is in
18187 front of that newline, then changes don't affect the display.
18188 This case happens with stealth-fontification. Note that although
18189 the display is unchanged, glyph positions in the matrix have to
18190 be adjusted, of course. */
18191 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
18192 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
18193 && ((last_changed_charpos < CHARPOS (start)
18194 && CHARPOS (start) == BEGV)
18195 || (last_changed_charpos < CHARPOS (start) - 1
18196 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
18197 {
18198 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
18199 struct glyph_row *r0;
18200
18201 /* Compute how many chars/bytes have been added to or removed
18202 from the buffer. */
18203 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
18204 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
18205 Z_delta = Z - Z_old;
18206 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
18207
18208 /* Give up if PT is not in the window. Note that it already has
18209 been checked at the start of try_window_id that PT is not in
18210 front of the window start. */
18211 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
18212 GIVE_UP (13);
18213
18214 /* If window start is unchanged, we can reuse the whole matrix
18215 as is, after adjusting glyph positions. No need to compute
18216 the window end again, since its offset from Z hasn't changed. */
18217 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
18218 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
18219 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
18220 /* PT must not be in a partially visible line. */
18221 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
18222 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
18223 {
18224 /* Adjust positions in the glyph matrix. */
18225 if (Z_delta || Z_delta_bytes)
18226 {
18227 struct glyph_row *r1
18228 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18229 increment_matrix_positions (w->current_matrix,
18230 MATRIX_ROW_VPOS (r0, current_matrix),
18231 MATRIX_ROW_VPOS (r1, current_matrix),
18232 Z_delta, Z_delta_bytes);
18233 }
18234
18235 /* Set the cursor. */
18236 row = row_containing_pos (w, PT, r0, NULL, 0);
18237 if (row)
18238 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
18239 return 1;
18240 }
18241 }
18242
18243 /* Handle the case that changes are all below what is displayed in
18244 the window, and that PT is in the window. This shortcut cannot
18245 be taken if ZV is visible in the window, and text has been added
18246 there that is visible in the window. */
18247 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
18248 /* ZV is not visible in the window, or there are no
18249 changes at ZV, actually. */
18250 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
18251 || first_changed_charpos == last_changed_charpos))
18252 {
18253 struct glyph_row *r0;
18254
18255 /* Give up if PT is not in the window. Note that it already has
18256 been checked at the start of try_window_id that PT is not in
18257 front of the window start. */
18258 if (PT >= MATRIX_ROW_END_CHARPOS (row))
18259 GIVE_UP (14);
18260
18261 /* If window start is unchanged, we can reuse the whole matrix
18262 as is, without changing glyph positions since no text has
18263 been added/removed in front of the window end. */
18264 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
18265 if (TEXT_POS_EQUAL_P (start, r0->minpos)
18266 /* PT must not be in a partially visible line. */
18267 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
18268 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
18269 {
18270 /* We have to compute the window end anew since text
18271 could have been added/removed after it. */
18272 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18273 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18274
18275 /* Set the cursor. */
18276 row = row_containing_pos (w, PT, r0, NULL, 0);
18277 if (row)
18278 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
18279 return 2;
18280 }
18281 }
18282
18283 /* Give up if window start is in the changed area.
18284
18285 The condition used to read
18286
18287 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18288
18289 but why that was tested escapes me at the moment. */
18290 if (CHARPOS (start) >= first_changed_charpos
18291 && CHARPOS (start) <= last_changed_charpos)
18292 GIVE_UP (15);
18293
18294 /* Check that window start agrees with the start of the first glyph
18295 row in its current matrix. Check this after we know the window
18296 start is not in changed text, otherwise positions would not be
18297 comparable. */
18298 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
18299 if (!TEXT_POS_EQUAL_P (start, row->minpos))
18300 GIVE_UP (16);
18301
18302 /* Give up if the window ends in strings. Overlay strings
18303 at the end are difficult to handle, so don't try. */
18304 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
18305 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
18306 GIVE_UP (20);
18307
18308 /* Compute the position at which we have to start displaying new
18309 lines. Some of the lines at the top of the window might be
18310 reusable because they are not displaying changed text. Find the
18311 last row in W's current matrix not affected by changes at the
18312 start of current_buffer. Value is null if changes start in the
18313 first line of window. */
18314 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
18315 if (last_unchanged_at_beg_row)
18316 {
18317 /* Avoid starting to display in the middle of a character, a TAB
18318 for instance. This is easier than to set up the iterator
18319 exactly, and it's not a frequent case, so the additional
18320 effort wouldn't really pay off. */
18321 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
18322 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
18323 && last_unchanged_at_beg_row > w->current_matrix->rows)
18324 --last_unchanged_at_beg_row;
18325
18326 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
18327 GIVE_UP (17);
18328
18329 if (! init_to_row_end (&it, w, last_unchanged_at_beg_row))
18330 GIVE_UP (18);
18331 start_pos = it.current.pos;
18332
18333 /* Start displaying new lines in the desired matrix at the same
18334 vpos we would use in the current matrix, i.e. below
18335 last_unchanged_at_beg_row. */
18336 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
18337 current_matrix);
18338 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18339 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
18340
18341 eassert (it.hpos == 0 && it.current_x == 0);
18342 }
18343 else
18344 {
18345 /* There are no reusable lines at the start of the window.
18346 Start displaying in the first text line. */
18347 start_display (&it, w, start);
18348 it.vpos = it.first_vpos;
18349 start_pos = it.current.pos;
18350 }
18351
18352 /* Find the first row that is not affected by changes at the end of
18353 the buffer. Value will be null if there is no unchanged row, in
18354 which case we must redisplay to the end of the window. delta
18355 will be set to the value by which buffer positions beginning with
18356 first_unchanged_at_end_row have to be adjusted due to text
18357 changes. */
18358 first_unchanged_at_end_row
18359 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
18360 IF_DEBUG (debug_delta = delta);
18361 IF_DEBUG (debug_delta_bytes = delta_bytes);
18362
18363 /* Set stop_pos to the buffer position up to which we will have to
18364 display new lines. If first_unchanged_at_end_row != NULL, this
18365 is the buffer position of the start of the line displayed in that
18366 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18367 that we don't stop at a buffer position. */
18368 stop_pos = 0;
18369 if (first_unchanged_at_end_row)
18370 {
18371 eassert (last_unchanged_at_beg_row == NULL
18372 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
18373
18374 /* If this is a continuation line, move forward to the next one
18375 that isn't. Changes in lines above affect this line.
18376 Caution: this may move first_unchanged_at_end_row to a row
18377 not displaying text. */
18378 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
18379 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18380 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18381 < it.last_visible_y))
18382 ++first_unchanged_at_end_row;
18383
18384 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18385 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18386 >= it.last_visible_y))
18387 first_unchanged_at_end_row = NULL;
18388 else
18389 {
18390 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
18391 + delta);
18392 first_unchanged_at_end_vpos
18393 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
18394 eassert (stop_pos >= Z - END_UNCHANGED);
18395 }
18396 }
18397 else if (last_unchanged_at_beg_row == NULL)
18398 GIVE_UP (19);
18399
18400
18401 #ifdef GLYPH_DEBUG
18402
18403 /* Either there is no unchanged row at the end, or the one we have
18404 now displays text. This is a necessary condition for the window
18405 end pos calculation at the end of this function. */
18406 eassert (first_unchanged_at_end_row == NULL
18407 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18408
18409 debug_last_unchanged_at_beg_vpos
18410 = (last_unchanged_at_beg_row
18411 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
18412 : -1);
18413 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
18414
18415 #endif /* GLYPH_DEBUG */
18416
18417
18418 /* Display new lines. Set last_text_row to the last new line
18419 displayed which has text on it, i.e. might end up as being the
18420 line where the window_end_vpos is. */
18421 w->cursor.vpos = -1;
18422 last_text_row = NULL;
18423 overlay_arrow_seen = false;
18424 if (it.current_y < it.last_visible_y
18425 && !f->fonts_changed
18426 && (first_unchanged_at_end_row == NULL
18427 || IT_CHARPOS (it) < stop_pos))
18428 it.glyph_row->reversed_p = false;
18429 while (it.current_y < it.last_visible_y
18430 && !f->fonts_changed
18431 && (first_unchanged_at_end_row == NULL
18432 || IT_CHARPOS (it) < stop_pos))
18433 {
18434 if (display_line (&it))
18435 last_text_row = it.glyph_row - 1;
18436 }
18437
18438 if (f->fonts_changed)
18439 return -1;
18440
18441 /* The redisplay iterations in display_line above could have
18442 triggered font-lock, which could have done something that
18443 invalidates IT->w window's end-point information, on which we
18444 rely below. E.g., one package, which will remain unnamed, used
18445 to install a font-lock-fontify-region-function that called
18446 bury-buffer, whose side effect is to switch the buffer displayed
18447 by IT->w, and that predictably resets IT->w's window_end_valid
18448 flag, which we already tested at the entry to this function.
18449 Amply punish such packages/modes by giving up on this
18450 optimization in those cases. */
18451 if (!w->window_end_valid)
18452 {
18453 clear_glyph_matrix (w->desired_matrix);
18454 return -1;
18455 }
18456
18457 /* Compute differences in buffer positions, y-positions etc. for
18458 lines reused at the bottom of the window. Compute what we can
18459 scroll. */
18460 if (first_unchanged_at_end_row
18461 /* No lines reused because we displayed everything up to the
18462 bottom of the window. */
18463 && it.current_y < it.last_visible_y)
18464 {
18465 dvpos = (it.vpos
18466 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
18467 current_matrix));
18468 dy = it.current_y - first_unchanged_at_end_row->y;
18469 run.current_y = first_unchanged_at_end_row->y;
18470 run.desired_y = run.current_y + dy;
18471 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
18472 }
18473 else
18474 {
18475 delta = delta_bytes = dvpos = dy
18476 = run.current_y = run.desired_y = run.height = 0;
18477 first_unchanged_at_end_row = NULL;
18478 }
18479 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
18480
18481
18482 /* Find the cursor if not already found. We have to decide whether
18483 PT will appear on this window (it sometimes doesn't, but this is
18484 not a very frequent case.) This decision has to be made before
18485 the current matrix is altered. A value of cursor.vpos < 0 means
18486 that PT is either in one of the lines beginning at
18487 first_unchanged_at_end_row or below the window. Don't care for
18488 lines that might be displayed later at the window end; as
18489 mentioned, this is not a frequent case. */
18490 if (w->cursor.vpos < 0)
18491 {
18492 /* Cursor in unchanged rows at the top? */
18493 if (PT < CHARPOS (start_pos)
18494 && last_unchanged_at_beg_row)
18495 {
18496 row = row_containing_pos (w, PT,
18497 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
18498 last_unchanged_at_beg_row + 1, 0);
18499 if (row)
18500 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
18501 }
18502
18503 /* Start from first_unchanged_at_end_row looking for PT. */
18504 else if (first_unchanged_at_end_row)
18505 {
18506 row = row_containing_pos (w, PT - delta,
18507 first_unchanged_at_end_row, NULL, 0);
18508 if (row)
18509 set_cursor_from_row (w, row, w->current_matrix, delta,
18510 delta_bytes, dy, dvpos);
18511 }
18512
18513 /* Give up if cursor was not found. */
18514 if (w->cursor.vpos < 0)
18515 {
18516 clear_glyph_matrix (w->desired_matrix);
18517 return -1;
18518 }
18519 }
18520
18521 /* Don't let the cursor end in the scroll margins. */
18522 {
18523 int this_scroll_margin, cursor_height;
18524 int frame_line_height = default_line_pixel_height (w);
18525 int window_total_lines
18526 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18527
18528 this_scroll_margin =
18529 max (0, min (scroll_margin, window_total_lines / 4));
18530 this_scroll_margin *= frame_line_height;
18531 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18532
18533 if ((w->cursor.y < this_scroll_margin
18534 && CHARPOS (start) > BEGV)
18535 /* Old redisplay didn't take scroll margin into account at the bottom,
18536 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18537 || (w->cursor.y + (make_cursor_line_fully_visible_p
18538 ? cursor_height + this_scroll_margin
18539 : 1)) > it.last_visible_y)
18540 {
18541 w->cursor.vpos = -1;
18542 clear_glyph_matrix (w->desired_matrix);
18543 return -1;
18544 }
18545 }
18546
18547 /* Scroll the display. Do it before changing the current matrix so
18548 that xterm.c doesn't get confused about where the cursor glyph is
18549 found. */
18550 if (dy && run.height)
18551 {
18552 update_begin (f);
18553
18554 if (FRAME_WINDOW_P (f))
18555 {
18556 FRAME_RIF (f)->update_window_begin_hook (w);
18557 FRAME_RIF (f)->clear_window_mouse_face (w);
18558 FRAME_RIF (f)->scroll_run_hook (w, &run);
18559 FRAME_RIF (f)->update_window_end_hook (w, false, false);
18560 }
18561 else
18562 {
18563 /* Terminal frame. In this case, dvpos gives the number of
18564 lines to scroll by; dvpos < 0 means scroll up. */
18565 int from_vpos
18566 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18567 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18568 int end = (WINDOW_TOP_EDGE_LINE (w)
18569 + WINDOW_WANTS_HEADER_LINE_P (w)
18570 + window_internal_height (w));
18571
18572 #if defined (HAVE_GPM) || defined (MSDOS)
18573 x_clear_window_mouse_face (w);
18574 #endif
18575 /* Perform the operation on the screen. */
18576 if (dvpos > 0)
18577 {
18578 /* Scroll last_unchanged_at_beg_row to the end of the
18579 window down dvpos lines. */
18580 set_terminal_window (f, end);
18581
18582 /* On dumb terminals delete dvpos lines at the end
18583 before inserting dvpos empty lines. */
18584 if (!FRAME_SCROLL_REGION_OK (f))
18585 ins_del_lines (f, end - dvpos, -dvpos);
18586
18587 /* Insert dvpos empty lines in front of
18588 last_unchanged_at_beg_row. */
18589 ins_del_lines (f, from, dvpos);
18590 }
18591 else if (dvpos < 0)
18592 {
18593 /* Scroll up last_unchanged_at_beg_vpos to the end of
18594 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18595 set_terminal_window (f, end);
18596
18597 /* Delete dvpos lines in front of
18598 last_unchanged_at_beg_vpos. ins_del_lines will set
18599 the cursor to the given vpos and emit |dvpos| delete
18600 line sequences. */
18601 ins_del_lines (f, from + dvpos, dvpos);
18602
18603 /* On a dumb terminal insert dvpos empty lines at the
18604 end. */
18605 if (!FRAME_SCROLL_REGION_OK (f))
18606 ins_del_lines (f, end + dvpos, -dvpos);
18607 }
18608
18609 set_terminal_window (f, 0);
18610 }
18611
18612 update_end (f);
18613 }
18614
18615 /* Shift reused rows of the current matrix to the right position.
18616 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18617 text. */
18618 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18619 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18620 if (dvpos < 0)
18621 {
18622 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18623 bottom_vpos, dvpos);
18624 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18625 bottom_vpos);
18626 }
18627 else if (dvpos > 0)
18628 {
18629 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18630 bottom_vpos, dvpos);
18631 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18632 first_unchanged_at_end_vpos + dvpos);
18633 }
18634
18635 /* For frame-based redisplay, make sure that current frame and window
18636 matrix are in sync with respect to glyph memory. */
18637 if (!FRAME_WINDOW_P (f))
18638 sync_frame_with_window_matrix_rows (w);
18639
18640 /* Adjust buffer positions in reused rows. */
18641 if (delta || delta_bytes)
18642 increment_matrix_positions (current_matrix,
18643 first_unchanged_at_end_vpos + dvpos,
18644 bottom_vpos, delta, delta_bytes);
18645
18646 /* Adjust Y positions. */
18647 if (dy)
18648 shift_glyph_matrix (w, current_matrix,
18649 first_unchanged_at_end_vpos + dvpos,
18650 bottom_vpos, dy);
18651
18652 if (first_unchanged_at_end_row)
18653 {
18654 first_unchanged_at_end_row += dvpos;
18655 if (first_unchanged_at_end_row->y >= it.last_visible_y
18656 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18657 first_unchanged_at_end_row = NULL;
18658 }
18659
18660 /* If scrolling up, there may be some lines to display at the end of
18661 the window. */
18662 last_text_row_at_end = NULL;
18663 if (dy < 0)
18664 {
18665 /* Scrolling up can leave for example a partially visible line
18666 at the end of the window to be redisplayed. */
18667 /* Set last_row to the glyph row in the current matrix where the
18668 window end line is found. It has been moved up or down in
18669 the matrix by dvpos. */
18670 int last_vpos = w->window_end_vpos + dvpos;
18671 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18672
18673 /* If last_row is the window end line, it should display text. */
18674 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18675
18676 /* If window end line was partially visible before, begin
18677 displaying at that line. Otherwise begin displaying with the
18678 line following it. */
18679 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18680 {
18681 init_to_row_start (&it, w, last_row);
18682 it.vpos = last_vpos;
18683 it.current_y = last_row->y;
18684 }
18685 else
18686 {
18687 init_to_row_end (&it, w, last_row);
18688 it.vpos = 1 + last_vpos;
18689 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18690 ++last_row;
18691 }
18692
18693 /* We may start in a continuation line. If so, we have to
18694 get the right continuation_lines_width and current_x. */
18695 it.continuation_lines_width = last_row->continuation_lines_width;
18696 it.hpos = it.current_x = 0;
18697
18698 /* Display the rest of the lines at the window end. */
18699 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18700 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18701 {
18702 /* Is it always sure that the display agrees with lines in
18703 the current matrix? I don't think so, so we mark rows
18704 displayed invalid in the current matrix by setting their
18705 enabled_p flag to false. */
18706 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18707 if (display_line (&it))
18708 last_text_row_at_end = it.glyph_row - 1;
18709 }
18710 }
18711
18712 /* Update window_end_pos and window_end_vpos. */
18713 if (first_unchanged_at_end_row && !last_text_row_at_end)
18714 {
18715 /* Window end line if one of the preserved rows from the current
18716 matrix. Set row to the last row displaying text in current
18717 matrix starting at first_unchanged_at_end_row, after
18718 scrolling. */
18719 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18720 row = find_last_row_displaying_text (w->current_matrix, &it,
18721 first_unchanged_at_end_row);
18722 eassume (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18723 adjust_window_ends (w, row, true);
18724 eassert (w->window_end_bytepos >= 0);
18725 IF_DEBUG (debug_method_add (w, "A"));
18726 }
18727 else if (last_text_row_at_end)
18728 {
18729 adjust_window_ends (w, last_text_row_at_end, false);
18730 eassert (w->window_end_bytepos >= 0);
18731 IF_DEBUG (debug_method_add (w, "B"));
18732 }
18733 else if (last_text_row)
18734 {
18735 /* We have displayed either to the end of the window or at the
18736 end of the window, i.e. the last row with text is to be found
18737 in the desired matrix. */
18738 adjust_window_ends (w, last_text_row, false);
18739 eassert (w->window_end_bytepos >= 0);
18740 }
18741 else if (first_unchanged_at_end_row == NULL
18742 && last_text_row == NULL
18743 && last_text_row_at_end == NULL)
18744 {
18745 /* Displayed to end of window, but no line containing text was
18746 displayed. Lines were deleted at the end of the window. */
18747 bool first_vpos = WINDOW_WANTS_HEADER_LINE_P (w);
18748 int vpos = w->window_end_vpos;
18749 struct glyph_row *current_row = current_matrix->rows + vpos;
18750 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18751
18752 for (row = NULL; !row; --vpos, --current_row, --desired_row)
18753 {
18754 eassert (first_vpos <= vpos);
18755 if (desired_row->enabled_p)
18756 {
18757 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18758 row = desired_row;
18759 }
18760 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18761 row = current_row;
18762 }
18763
18764 w->window_end_vpos = vpos + 1;
18765 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18766 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18767 eassert (w->window_end_bytepos >= 0);
18768 IF_DEBUG (debug_method_add (w, "C"));
18769 }
18770 else
18771 emacs_abort ();
18772
18773 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18774 debug_end_vpos = w->window_end_vpos));
18775
18776 /* Record that display has not been completed. */
18777 w->window_end_valid = false;
18778 w->desired_matrix->no_scrolling_p = true;
18779 return 3;
18780
18781 #undef GIVE_UP
18782 }
18783
18784
18785 \f
18786 /***********************************************************************
18787 More debugging support
18788 ***********************************************************************/
18789
18790 #ifdef GLYPH_DEBUG
18791
18792 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18793 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18794 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18795
18796
18797 /* Dump the contents of glyph matrix MATRIX on stderr.
18798
18799 GLYPHS 0 means don't show glyph contents.
18800 GLYPHS 1 means show glyphs in short form
18801 GLYPHS > 1 means show glyphs in long form. */
18802
18803 void
18804 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18805 {
18806 int i;
18807 for (i = 0; i < matrix->nrows; ++i)
18808 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18809 }
18810
18811
18812 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18813 the glyph row and area where the glyph comes from. */
18814
18815 void
18816 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18817 {
18818 if (glyph->type == CHAR_GLYPH
18819 || glyph->type == GLYPHLESS_GLYPH)
18820 {
18821 fprintf (stderr,
18822 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18823 glyph - row->glyphs[TEXT_AREA],
18824 (glyph->type == CHAR_GLYPH
18825 ? 'C'
18826 : 'G'),
18827 glyph->charpos,
18828 (BUFFERP (glyph->object)
18829 ? 'B'
18830 : (STRINGP (glyph->object)
18831 ? 'S'
18832 : (NILP (glyph->object)
18833 ? '0'
18834 : '-'))),
18835 glyph->pixel_width,
18836 glyph->u.ch,
18837 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18838 ? glyph->u.ch
18839 : '.'),
18840 glyph->face_id,
18841 glyph->left_box_line_p,
18842 glyph->right_box_line_p);
18843 }
18844 else if (glyph->type == STRETCH_GLYPH)
18845 {
18846 fprintf (stderr,
18847 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18848 glyph - row->glyphs[TEXT_AREA],
18849 'S',
18850 glyph->charpos,
18851 (BUFFERP (glyph->object)
18852 ? 'B'
18853 : (STRINGP (glyph->object)
18854 ? 'S'
18855 : (NILP (glyph->object)
18856 ? '0'
18857 : '-'))),
18858 glyph->pixel_width,
18859 0,
18860 ' ',
18861 glyph->face_id,
18862 glyph->left_box_line_p,
18863 glyph->right_box_line_p);
18864 }
18865 else if (glyph->type == IMAGE_GLYPH)
18866 {
18867 fprintf (stderr,
18868 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18869 glyph - row->glyphs[TEXT_AREA],
18870 'I',
18871 glyph->charpos,
18872 (BUFFERP (glyph->object)
18873 ? 'B'
18874 : (STRINGP (glyph->object)
18875 ? 'S'
18876 : (NILP (glyph->object)
18877 ? '0'
18878 : '-'))),
18879 glyph->pixel_width,
18880 glyph->u.img_id,
18881 '.',
18882 glyph->face_id,
18883 glyph->left_box_line_p,
18884 glyph->right_box_line_p);
18885 }
18886 else if (glyph->type == COMPOSITE_GLYPH)
18887 {
18888 fprintf (stderr,
18889 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18890 glyph - row->glyphs[TEXT_AREA],
18891 '+',
18892 glyph->charpos,
18893 (BUFFERP (glyph->object)
18894 ? 'B'
18895 : (STRINGP (glyph->object)
18896 ? 'S'
18897 : (NILP (glyph->object)
18898 ? '0'
18899 : '-'))),
18900 glyph->pixel_width,
18901 glyph->u.cmp.id);
18902 if (glyph->u.cmp.automatic)
18903 fprintf (stderr,
18904 "[%d-%d]",
18905 glyph->slice.cmp.from, glyph->slice.cmp.to);
18906 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18907 glyph->face_id,
18908 glyph->left_box_line_p,
18909 glyph->right_box_line_p);
18910 }
18911 else if (glyph->type == XWIDGET_GLYPH)
18912 {
18913 #ifndef HAVE_XWIDGETS
18914 eassume (false);
18915 #else
18916 fprintf (stderr,
18917 " %5d %4c %6d %c %3d 0x%05x %c %4d %1.1d%1.1d\n",
18918 glyph - row->glyphs[TEXT_AREA],
18919 'X',
18920 glyph->charpos,
18921 (BUFFERP (glyph->object)
18922 ? 'B'
18923 : (STRINGP (glyph->object)
18924 ? 'S'
18925 : '-')),
18926 glyph->pixel_width,
18927 glyph->u.xwidget,
18928 '.',
18929 glyph->face_id,
18930 glyph->left_box_line_p,
18931 glyph->right_box_line_p);
18932 #endif
18933 }
18934 }
18935
18936
18937 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18938 GLYPHS 0 means don't show glyph contents.
18939 GLYPHS 1 means show glyphs in short form
18940 GLYPHS > 1 means show glyphs in long form. */
18941
18942 void
18943 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18944 {
18945 if (glyphs != 1)
18946 {
18947 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18948 fprintf (stderr, "==============================================================================\n");
18949
18950 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18951 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18952 vpos,
18953 MATRIX_ROW_START_CHARPOS (row),
18954 MATRIX_ROW_END_CHARPOS (row),
18955 row->used[TEXT_AREA],
18956 row->contains_overlapping_glyphs_p,
18957 row->enabled_p,
18958 row->truncated_on_left_p,
18959 row->truncated_on_right_p,
18960 row->continued_p,
18961 MATRIX_ROW_CONTINUATION_LINE_P (row),
18962 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18963 row->ends_at_zv_p,
18964 row->fill_line_p,
18965 row->ends_in_middle_of_char_p,
18966 row->starts_in_middle_of_char_p,
18967 row->mouse_face_p,
18968 row->x,
18969 row->y,
18970 row->pixel_width,
18971 row->height,
18972 row->visible_height,
18973 row->ascent,
18974 row->phys_ascent);
18975 /* The next 3 lines should align to "Start" in the header. */
18976 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18977 row->end.overlay_string_index,
18978 row->continuation_lines_width);
18979 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18980 CHARPOS (row->start.string_pos),
18981 CHARPOS (row->end.string_pos));
18982 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18983 row->end.dpvec_index);
18984 }
18985
18986 if (glyphs > 1)
18987 {
18988 int area;
18989
18990 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18991 {
18992 struct glyph *glyph = row->glyphs[area];
18993 struct glyph *glyph_end = glyph + row->used[area];
18994
18995 /* Glyph for a line end in text. */
18996 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18997 ++glyph_end;
18998
18999 if (glyph < glyph_end)
19000 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
19001
19002 for (; glyph < glyph_end; ++glyph)
19003 dump_glyph (row, glyph, area);
19004 }
19005 }
19006 else if (glyphs == 1)
19007 {
19008 int area;
19009 char s[SHRT_MAX + 4];
19010
19011 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19012 {
19013 int i;
19014
19015 for (i = 0; i < row->used[area]; ++i)
19016 {
19017 struct glyph *glyph = row->glyphs[area] + i;
19018 if (i == row->used[area] - 1
19019 && area == TEXT_AREA
19020 && NILP (glyph->object)
19021 && glyph->type == CHAR_GLYPH
19022 && glyph->u.ch == ' ')
19023 {
19024 strcpy (&s[i], "[\\n]");
19025 i += 4;
19026 }
19027 else if (glyph->type == CHAR_GLYPH
19028 && glyph->u.ch < 0x80
19029 && glyph->u.ch >= ' ')
19030 s[i] = glyph->u.ch;
19031 else
19032 s[i] = '.';
19033 }
19034
19035 s[i] = '\0';
19036 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
19037 }
19038 }
19039 }
19040
19041
19042 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
19043 Sdump_glyph_matrix, 0, 1, "p",
19044 doc: /* Dump the current matrix of the selected window to stderr.
19045 Shows contents of glyph row structures. With non-nil
19046 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
19047 glyphs in short form, otherwise show glyphs in long form.
19048
19049 Interactively, no argument means show glyphs in short form;
19050 with numeric argument, its value is passed as the GLYPHS flag. */)
19051 (Lisp_Object glyphs)
19052 {
19053 struct window *w = XWINDOW (selected_window);
19054 struct buffer *buffer = XBUFFER (w->contents);
19055
19056 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
19057 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
19058 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
19059 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
19060 fprintf (stderr, "=============================================\n");
19061 dump_glyph_matrix (w->current_matrix,
19062 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
19063 return Qnil;
19064 }
19065
19066
19067 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
19068 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* Dump the current glyph matrix of the selected frame to stderr.
19069 Only text-mode frames have frame glyph matrices. */)
19070 (void)
19071 {
19072 struct frame *f = XFRAME (selected_frame);
19073
19074 if (f->current_matrix)
19075 dump_glyph_matrix (f->current_matrix, 1);
19076 else
19077 fprintf (stderr, "*** This frame doesn't have a frame glyph matrix ***\n");
19078 return Qnil;
19079 }
19080
19081
19082 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
19083 doc: /* Dump glyph row ROW to stderr.
19084 GLYPH 0 means don't dump glyphs.
19085 GLYPH 1 means dump glyphs in short form.
19086 GLYPH > 1 or omitted means dump glyphs in long form. */)
19087 (Lisp_Object row, Lisp_Object glyphs)
19088 {
19089 struct glyph_matrix *matrix;
19090 EMACS_INT vpos;
19091
19092 CHECK_NUMBER (row);
19093 matrix = XWINDOW (selected_window)->current_matrix;
19094 vpos = XINT (row);
19095 if (vpos >= 0 && vpos < matrix->nrows)
19096 dump_glyph_row (MATRIX_ROW (matrix, vpos),
19097 vpos,
19098 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
19099 return Qnil;
19100 }
19101
19102
19103 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
19104 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
19105 GLYPH 0 means don't dump glyphs.
19106 GLYPH 1 means dump glyphs in short form.
19107 GLYPH > 1 or omitted means dump glyphs in long form.
19108
19109 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
19110 do nothing. */)
19111 (Lisp_Object row, Lisp_Object glyphs)
19112 {
19113 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19114 struct frame *sf = SELECTED_FRAME ();
19115 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
19116 EMACS_INT vpos;
19117
19118 CHECK_NUMBER (row);
19119 vpos = XINT (row);
19120 if (vpos >= 0 && vpos < m->nrows)
19121 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
19122 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
19123 #endif
19124 return Qnil;
19125 }
19126
19127
19128 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
19129 doc: /* Toggle tracing of redisplay.
19130 With ARG, turn tracing on if and only if ARG is positive. */)
19131 (Lisp_Object arg)
19132 {
19133 if (NILP (arg))
19134 trace_redisplay_p = !trace_redisplay_p;
19135 else
19136 {
19137 arg = Fprefix_numeric_value (arg);
19138 trace_redisplay_p = XINT (arg) > 0;
19139 }
19140
19141 return Qnil;
19142 }
19143
19144
19145 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
19146 doc: /* Like `format', but print result to stderr.
19147 usage: (trace-to-stderr STRING &rest OBJECTS) */)
19148 (ptrdiff_t nargs, Lisp_Object *args)
19149 {
19150 Lisp_Object s = Fformat (nargs, args);
19151 fwrite (SDATA (s), 1, SBYTES (s), stderr);
19152 return Qnil;
19153 }
19154
19155 #endif /* GLYPH_DEBUG */
19156
19157
19158 \f
19159 /***********************************************************************
19160 Building Desired Matrix Rows
19161 ***********************************************************************/
19162
19163 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
19164 Used for non-window-redisplay windows, and for windows w/o left fringe. */
19165
19166 static struct glyph_row *
19167 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
19168 {
19169 struct frame *f = XFRAME (WINDOW_FRAME (w));
19170 struct buffer *buffer = XBUFFER (w->contents);
19171 struct buffer *old = current_buffer;
19172 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
19173 ptrdiff_t arrow_len = SCHARS (overlay_arrow_string);
19174 const unsigned char *arrow_end = arrow_string + arrow_len;
19175 const unsigned char *p;
19176 struct it it;
19177 bool multibyte_p;
19178 int n_glyphs_before;
19179
19180 set_buffer_temp (buffer);
19181 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
19182 scratch_glyph_row.reversed_p = false;
19183 it.glyph_row->used[TEXT_AREA] = 0;
19184 SET_TEXT_POS (it.position, 0, 0);
19185
19186 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
19187 p = arrow_string;
19188 while (p < arrow_end)
19189 {
19190 Lisp_Object face, ilisp;
19191
19192 /* Get the next character. */
19193 if (multibyte_p)
19194 it.c = it.char_to_display = string_char_and_length (p, &it.len);
19195 else
19196 {
19197 it.c = it.char_to_display = *p, it.len = 1;
19198 if (! ASCII_CHAR_P (it.c))
19199 it.char_to_display = BYTE8_TO_CHAR (it.c);
19200 }
19201 p += it.len;
19202
19203 /* Get its face. */
19204 ilisp = make_number (p - arrow_string);
19205 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
19206 it.face_id = compute_char_face (f, it.char_to_display, face);
19207
19208 /* Compute its width, get its glyphs. */
19209 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
19210 SET_TEXT_POS (it.position, -1, -1);
19211 PRODUCE_GLYPHS (&it);
19212
19213 /* If this character doesn't fit any more in the line, we have
19214 to remove some glyphs. */
19215 if (it.current_x > it.last_visible_x)
19216 {
19217 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
19218 break;
19219 }
19220 }
19221
19222 set_buffer_temp (old);
19223 return it.glyph_row;
19224 }
19225
19226
19227 /* Insert truncation glyphs at the start of IT->glyph_row. Which
19228 glyphs to insert is determined by produce_special_glyphs. */
19229
19230 static void
19231 insert_left_trunc_glyphs (struct it *it)
19232 {
19233 struct it truncate_it;
19234 struct glyph *from, *end, *to, *toend;
19235
19236 eassert (!FRAME_WINDOW_P (it->f)
19237 || (!it->glyph_row->reversed_p
19238 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19239 || (it->glyph_row->reversed_p
19240 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
19241
19242 /* Get the truncation glyphs. */
19243 truncate_it = *it;
19244 truncate_it.current_x = 0;
19245 truncate_it.face_id = DEFAULT_FACE_ID;
19246 truncate_it.glyph_row = &scratch_glyph_row;
19247 truncate_it.area = TEXT_AREA;
19248 truncate_it.glyph_row->used[TEXT_AREA] = 0;
19249 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
19250 truncate_it.object = Qnil;
19251 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
19252
19253 /* Overwrite glyphs from IT with truncation glyphs. */
19254 if (!it->glyph_row->reversed_p)
19255 {
19256 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19257
19258 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19259 end = from + tused;
19260 to = it->glyph_row->glyphs[TEXT_AREA];
19261 toend = to + it->glyph_row->used[TEXT_AREA];
19262 if (FRAME_WINDOW_P (it->f))
19263 {
19264 /* On GUI frames, when variable-size fonts are displayed,
19265 the truncation glyphs may need more pixels than the row's
19266 glyphs they overwrite. We overwrite more glyphs to free
19267 enough screen real estate, and enlarge the stretch glyph
19268 on the right (see display_line), if there is one, to
19269 preserve the screen position of the truncation glyphs on
19270 the right. */
19271 int w = 0;
19272 struct glyph *g = to;
19273 short used;
19274
19275 /* The first glyph could be partially visible, in which case
19276 it->glyph_row->x will be negative. But we want the left
19277 truncation glyphs to be aligned at the left margin of the
19278 window, so we override the x coordinate at which the row
19279 will begin. */
19280 it->glyph_row->x = 0;
19281 while (g < toend && w < it->truncation_pixel_width)
19282 {
19283 w += g->pixel_width;
19284 ++g;
19285 }
19286 if (g - to - tused > 0)
19287 {
19288 memmove (to + tused, g, (toend - g) * sizeof(*g));
19289 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
19290 }
19291 used = it->glyph_row->used[TEXT_AREA];
19292 if (it->glyph_row->truncated_on_right_p
19293 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
19294 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
19295 == STRETCH_GLYPH)
19296 {
19297 int extra = w - it->truncation_pixel_width;
19298
19299 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
19300 }
19301 }
19302
19303 while (from < end)
19304 *to++ = *from++;
19305
19306 /* There may be padding glyphs left over. Overwrite them too. */
19307 if (!FRAME_WINDOW_P (it->f))
19308 {
19309 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
19310 {
19311 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19312 while (from < end)
19313 *to++ = *from++;
19314 }
19315 }
19316
19317 if (to > toend)
19318 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
19319 }
19320 else
19321 {
19322 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19323
19324 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19325 that back to front. */
19326 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
19327 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19328 toend = it->glyph_row->glyphs[TEXT_AREA];
19329 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
19330 if (FRAME_WINDOW_P (it->f))
19331 {
19332 int w = 0;
19333 struct glyph *g = to;
19334
19335 while (g >= toend && w < it->truncation_pixel_width)
19336 {
19337 w += g->pixel_width;
19338 --g;
19339 }
19340 if (to - g - tused > 0)
19341 to = g + tused;
19342 if (it->glyph_row->truncated_on_right_p
19343 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
19344 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
19345 {
19346 int extra = w - it->truncation_pixel_width;
19347
19348 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
19349 }
19350 }
19351
19352 while (from >= end && to >= toend)
19353 *to-- = *from--;
19354 if (!FRAME_WINDOW_P (it->f))
19355 {
19356 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
19357 {
19358 from =
19359 truncate_it.glyph_row->glyphs[TEXT_AREA]
19360 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19361 while (from >= end && to >= toend)
19362 *to-- = *from--;
19363 }
19364 }
19365 if (from >= end)
19366 {
19367 /* Need to free some room before prepending additional
19368 glyphs. */
19369 int move_by = from - end + 1;
19370 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
19371 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
19372
19373 for ( ; g >= g0; g--)
19374 g[move_by] = *g;
19375 while (from >= end)
19376 *to-- = *from--;
19377 it->glyph_row->used[TEXT_AREA] += move_by;
19378 }
19379 }
19380 }
19381
19382 /* Compute the hash code for ROW. */
19383 unsigned
19384 row_hash (struct glyph_row *row)
19385 {
19386 int area, k;
19387 unsigned hashval = 0;
19388
19389 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19390 for (k = 0; k < row->used[area]; ++k)
19391 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
19392 + row->glyphs[area][k].u.val
19393 + row->glyphs[area][k].face_id
19394 + row->glyphs[area][k].padding_p
19395 + (row->glyphs[area][k].type << 2));
19396
19397 return hashval;
19398 }
19399
19400 /* Compute the pixel height and width of IT->glyph_row.
19401
19402 Most of the time, ascent and height of a display line will be equal
19403 to the max_ascent and max_height values of the display iterator
19404 structure. This is not the case if
19405
19406 1. We hit ZV without displaying anything. In this case, max_ascent
19407 and max_height will be zero.
19408
19409 2. We have some glyphs that don't contribute to the line height.
19410 (The glyph row flag contributes_to_line_height_p is for future
19411 pixmap extensions).
19412
19413 The first case is easily covered by using default values because in
19414 these cases, the line height does not really matter, except that it
19415 must not be zero. */
19416
19417 static void
19418 compute_line_metrics (struct it *it)
19419 {
19420 struct glyph_row *row = it->glyph_row;
19421
19422 if (FRAME_WINDOW_P (it->f))
19423 {
19424 int i, min_y, max_y;
19425
19426 /* The line may consist of one space only, that was added to
19427 place the cursor on it. If so, the row's height hasn't been
19428 computed yet. */
19429 if (row->height == 0)
19430 {
19431 if (it->max_ascent + it->max_descent == 0)
19432 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
19433 row->ascent = it->max_ascent;
19434 row->height = it->max_ascent + it->max_descent;
19435 row->phys_ascent = it->max_phys_ascent;
19436 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19437 row->extra_line_spacing = it->max_extra_line_spacing;
19438 }
19439
19440 /* Compute the width of this line. */
19441 row->pixel_width = row->x;
19442 for (i = 0; i < row->used[TEXT_AREA]; ++i)
19443 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
19444
19445 eassert (row->pixel_width >= 0);
19446 eassert (row->ascent >= 0 && row->height > 0);
19447
19448 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
19449 || MATRIX_ROW_OVERLAPS_PRED_P (row));
19450
19451 /* If first line's physical ascent is larger than its logical
19452 ascent, use the physical ascent, and make the row taller.
19453 This makes accented characters fully visible. */
19454 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
19455 && row->phys_ascent > row->ascent)
19456 {
19457 row->height += row->phys_ascent - row->ascent;
19458 row->ascent = row->phys_ascent;
19459 }
19460
19461 /* Compute how much of the line is visible. */
19462 row->visible_height = row->height;
19463
19464 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
19465 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
19466
19467 if (row->y < min_y)
19468 row->visible_height -= min_y - row->y;
19469 if (row->y + row->height > max_y)
19470 row->visible_height -= row->y + row->height - max_y;
19471 }
19472 else
19473 {
19474 row->pixel_width = row->used[TEXT_AREA];
19475 if (row->continued_p)
19476 row->pixel_width -= it->continuation_pixel_width;
19477 else if (row->truncated_on_right_p)
19478 row->pixel_width -= it->truncation_pixel_width;
19479 row->ascent = row->phys_ascent = 0;
19480 row->height = row->phys_height = row->visible_height = 1;
19481 row->extra_line_spacing = 0;
19482 }
19483
19484 /* Compute a hash code for this row. */
19485 row->hash = row_hash (row);
19486
19487 it->max_ascent = it->max_descent = 0;
19488 it->max_phys_ascent = it->max_phys_descent = 0;
19489 }
19490
19491
19492 /* Append one space to the glyph row of iterator IT if doing a
19493 window-based redisplay. The space has the same face as
19494 IT->face_id. Value is true if a space was added.
19495
19496 This function is called to make sure that there is always one glyph
19497 at the end of a glyph row that the cursor can be set on under
19498 window-systems. (If there weren't such a glyph we would not know
19499 how wide and tall a box cursor should be displayed).
19500
19501 At the same time this space let's a nicely handle clearing to the
19502 end of the line if the row ends in italic text. */
19503
19504 static bool
19505 append_space_for_newline (struct it *it, bool default_face_p)
19506 {
19507 if (FRAME_WINDOW_P (it->f))
19508 {
19509 int n = it->glyph_row->used[TEXT_AREA];
19510
19511 if (it->glyph_row->glyphs[TEXT_AREA] + n
19512 < it->glyph_row->glyphs[1 + TEXT_AREA])
19513 {
19514 /* Save some values that must not be changed.
19515 Must save IT->c and IT->len because otherwise
19516 ITERATOR_AT_END_P wouldn't work anymore after
19517 append_space_for_newline has been called. */
19518 enum display_element_type saved_what = it->what;
19519 int saved_c = it->c, saved_len = it->len;
19520 int saved_char_to_display = it->char_to_display;
19521 int saved_x = it->current_x;
19522 int saved_face_id = it->face_id;
19523 bool saved_box_end = it->end_of_box_run_p;
19524 struct text_pos saved_pos;
19525 Lisp_Object saved_object;
19526 struct face *face;
19527
19528 saved_object = it->object;
19529 saved_pos = it->position;
19530
19531 it->what = IT_CHARACTER;
19532 memset (&it->position, 0, sizeof it->position);
19533 it->object = Qnil;
19534 it->c = it->char_to_display = ' ';
19535 it->len = 1;
19536
19537 /* If the default face was remapped, be sure to use the
19538 remapped face for the appended newline. */
19539 if (default_face_p)
19540 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19541 else if (it->face_before_selective_p)
19542 it->face_id = it->saved_face_id;
19543 face = FACE_FROM_ID (it->f, it->face_id);
19544 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19545 /* In R2L rows, we will prepend a stretch glyph that will
19546 have the end_of_box_run_p flag set for it, so there's no
19547 need for the appended newline glyph to have that flag
19548 set. */
19549 if (it->glyph_row->reversed_p
19550 /* But if the appended newline glyph goes all the way to
19551 the end of the row, there will be no stretch glyph,
19552 so leave the box flag set. */
19553 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19554 it->end_of_box_run_p = false;
19555
19556 PRODUCE_GLYPHS (it);
19557
19558 #ifdef HAVE_WINDOW_SYSTEM
19559 /* Make sure this space glyph has the right ascent and
19560 descent values, or else cursor at end of line will look
19561 funny, and height of empty lines will be incorrect. */
19562 struct glyph *g = it->glyph_row->glyphs[TEXT_AREA] + n;
19563 struct font *font = face->font ? face->font : FRAME_FONT (it->f);
19564 if (n == 0)
19565 {
19566 Lisp_Object height, total_height;
19567 int extra_line_spacing = it->extra_line_spacing;
19568 int boff = font->baseline_offset;
19569
19570 if (font->vertical_centering)
19571 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
19572
19573 it->object = saved_object; /* get_it_property needs this */
19574 normal_char_ascent_descent (font, -1, &it->ascent, &it->descent);
19575 /* Must do a subset of line height processing from
19576 x_produce_glyph for newline characters. */
19577 height = get_it_property (it, Qline_height);
19578 if (CONSP (height)
19579 && CONSP (XCDR (height))
19580 && NILP (XCDR (XCDR (height))))
19581 {
19582 total_height = XCAR (XCDR (height));
19583 height = XCAR (height);
19584 }
19585 else
19586 total_height = Qnil;
19587 height = calc_line_height_property (it, height, font, boff, true);
19588
19589 if (it->override_ascent >= 0)
19590 {
19591 it->ascent = it->override_ascent;
19592 it->descent = it->override_descent;
19593 boff = it->override_boff;
19594 }
19595 if (EQ (height, Qt))
19596 extra_line_spacing = 0;
19597 else
19598 {
19599 Lisp_Object spacing;
19600
19601 it->phys_ascent = it->ascent;
19602 it->phys_descent = it->descent;
19603 if (!NILP (height)
19604 && XINT (height) > it->ascent + it->descent)
19605 it->ascent = XINT (height) - it->descent;
19606
19607 if (!NILP (total_height))
19608 spacing = calc_line_height_property (it, total_height, font,
19609 boff, false);
19610 else
19611 {
19612 spacing = get_it_property (it, Qline_spacing);
19613 spacing = calc_line_height_property (it, spacing, font,
19614 boff, false);
19615 }
19616 if (INTEGERP (spacing))
19617 {
19618 extra_line_spacing = XINT (spacing);
19619 if (!NILP (total_height))
19620 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
19621 }
19622 }
19623 if (extra_line_spacing > 0)
19624 {
19625 it->descent += extra_line_spacing;
19626 if (extra_line_spacing > it->max_extra_line_spacing)
19627 it->max_extra_line_spacing = extra_line_spacing;
19628 }
19629 it->max_ascent = it->ascent;
19630 it->max_descent = it->descent;
19631 /* Make sure compute_line_metrics recomputes the row height. */
19632 it->glyph_row->height = 0;
19633 }
19634
19635 g->ascent = it->max_ascent;
19636 g->descent = it->max_descent;
19637 #endif
19638
19639 it->override_ascent = -1;
19640 it->constrain_row_ascent_descent_p = false;
19641 it->current_x = saved_x;
19642 it->object = saved_object;
19643 it->position = saved_pos;
19644 it->what = saved_what;
19645 it->face_id = saved_face_id;
19646 it->len = saved_len;
19647 it->c = saved_c;
19648 it->char_to_display = saved_char_to_display;
19649 it->end_of_box_run_p = saved_box_end;
19650 return true;
19651 }
19652 }
19653
19654 return false;
19655 }
19656
19657
19658 /* Extend the face of the last glyph in the text area of IT->glyph_row
19659 to the end of the display line. Called from display_line. If the
19660 glyph row is empty, add a space glyph to it so that we know the
19661 face to draw. Set the glyph row flag fill_line_p. If the glyph
19662 row is R2L, prepend a stretch glyph to cover the empty space to the
19663 left of the leftmost glyph. */
19664
19665 static void
19666 extend_face_to_end_of_line (struct it *it)
19667 {
19668 struct face *face, *default_face;
19669 struct frame *f = it->f;
19670
19671 /* If line is already filled, do nothing. Non window-system frames
19672 get a grace of one more ``pixel'' because their characters are
19673 1-``pixel'' wide, so they hit the equality too early. This grace
19674 is needed only for R2L rows that are not continued, to produce
19675 one extra blank where we could display the cursor. */
19676 if ((it->current_x >= it->last_visible_x
19677 + (!FRAME_WINDOW_P (f)
19678 && it->glyph_row->reversed_p
19679 && !it->glyph_row->continued_p))
19680 /* If the window has display margins, we will need to extend
19681 their face even if the text area is filled. */
19682 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19683 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19684 return;
19685
19686 /* The default face, possibly remapped. */
19687 default_face = FACE_FROM_ID_OR_NULL (f,
19688 lookup_basic_face (f, DEFAULT_FACE_ID));
19689
19690 /* Face extension extends the background and box of IT->face_id
19691 to the end of the line. If the background equals the background
19692 of the frame, we don't have to do anything. */
19693 face = FACE_FROM_ID (f, (it->face_before_selective_p
19694 ? it->saved_face_id
19695 : it->face_id));
19696
19697 if (FRAME_WINDOW_P (f)
19698 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19699 && face->box == FACE_NO_BOX
19700 && face->background == FRAME_BACKGROUND_PIXEL (f)
19701 #ifdef HAVE_WINDOW_SYSTEM
19702 && !face->stipple
19703 #endif
19704 && !it->glyph_row->reversed_p)
19705 return;
19706
19707 /* Set the glyph row flag indicating that the face of the last glyph
19708 in the text area has to be drawn to the end of the text area. */
19709 it->glyph_row->fill_line_p = true;
19710
19711 /* If current character of IT is not ASCII, make sure we have the
19712 ASCII face. This will be automatically undone the next time
19713 get_next_display_element returns a multibyte character. Note
19714 that the character will always be single byte in unibyte
19715 text. */
19716 if (!ASCII_CHAR_P (it->c))
19717 {
19718 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19719 }
19720
19721 if (FRAME_WINDOW_P (f))
19722 {
19723 /* If the row is empty, add a space with the current face of IT,
19724 so that we know which face to draw. */
19725 if (it->glyph_row->used[TEXT_AREA] == 0)
19726 {
19727 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19728 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19729 it->glyph_row->used[TEXT_AREA] = 1;
19730 }
19731 /* Mode line and the header line don't have margins, and
19732 likewise the frame's tool-bar window, if there is any. */
19733 if (!(it->glyph_row->mode_line_p
19734 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19735 || (WINDOWP (f->tool_bar_window)
19736 && it->w == XWINDOW (f->tool_bar_window))
19737 #endif
19738 ))
19739 {
19740 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19741 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19742 {
19743 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19744 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19745 default_face->id;
19746 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19747 }
19748 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19749 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19750 {
19751 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19752 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19753 default_face->id;
19754 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19755 }
19756 }
19757 #ifdef HAVE_WINDOW_SYSTEM
19758 if (it->glyph_row->reversed_p)
19759 {
19760 /* Prepend a stretch glyph to the row, such that the
19761 rightmost glyph will be drawn flushed all the way to the
19762 right margin of the window. The stretch glyph that will
19763 occupy the empty space, if any, to the left of the
19764 glyphs. */
19765 struct font *font = face->font ? face->font : FRAME_FONT (f);
19766 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19767 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19768 struct glyph *g;
19769 int row_width, stretch_ascent, stretch_width;
19770 struct text_pos saved_pos;
19771 int saved_face_id;
19772 bool saved_avoid_cursor, saved_box_start;
19773
19774 for (row_width = 0, g = row_start; g < row_end; g++)
19775 row_width += g->pixel_width;
19776
19777 /* FIXME: There are various minor display glitches in R2L
19778 rows when only one of the fringes is missing. The
19779 strange condition below produces the least bad effect. */
19780 if ((WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19781 == (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
19782 || WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
19783 stretch_width = window_box_width (it->w, TEXT_AREA);
19784 else
19785 stretch_width = it->last_visible_x - it->first_visible_x;
19786 stretch_width -= row_width;
19787
19788 if (stretch_width > 0)
19789 {
19790 stretch_ascent =
19791 (((it->ascent + it->descent)
19792 * FONT_BASE (font)) / FONT_HEIGHT (font));
19793 saved_pos = it->position;
19794 memset (&it->position, 0, sizeof it->position);
19795 saved_avoid_cursor = it->avoid_cursor_p;
19796 it->avoid_cursor_p = true;
19797 saved_face_id = it->face_id;
19798 saved_box_start = it->start_of_box_run_p;
19799 /* The last row's stretch glyph should get the default
19800 face, to avoid painting the rest of the window with
19801 the region face, if the region ends at ZV. */
19802 if (it->glyph_row->ends_at_zv_p)
19803 it->face_id = default_face->id;
19804 else
19805 it->face_id = face->id;
19806 it->start_of_box_run_p = false;
19807 append_stretch_glyph (it, Qnil, stretch_width,
19808 it->ascent + it->descent, stretch_ascent);
19809 it->position = saved_pos;
19810 it->avoid_cursor_p = saved_avoid_cursor;
19811 it->face_id = saved_face_id;
19812 it->start_of_box_run_p = saved_box_start;
19813 }
19814 /* If stretch_width comes out negative, it means that the
19815 last glyph is only partially visible. In R2L rows, we
19816 want the leftmost glyph to be partially visible, so we
19817 need to give the row the corresponding left offset. */
19818 if (stretch_width < 0)
19819 it->glyph_row->x = stretch_width;
19820 }
19821 #endif /* HAVE_WINDOW_SYSTEM */
19822 }
19823 else
19824 {
19825 /* Save some values that must not be changed. */
19826 int saved_x = it->current_x;
19827 struct text_pos saved_pos;
19828 Lisp_Object saved_object;
19829 enum display_element_type saved_what = it->what;
19830 int saved_face_id = it->face_id;
19831
19832 saved_object = it->object;
19833 saved_pos = it->position;
19834
19835 it->what = IT_CHARACTER;
19836 memset (&it->position, 0, sizeof it->position);
19837 it->object = Qnil;
19838 it->c = it->char_to_display = ' ';
19839 it->len = 1;
19840
19841 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19842 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19843 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19844 && !it->glyph_row->mode_line_p
19845 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19846 {
19847 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19848 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19849
19850 for (it->current_x = 0; g < e; g++)
19851 it->current_x += g->pixel_width;
19852
19853 it->area = LEFT_MARGIN_AREA;
19854 it->face_id = default_face->id;
19855 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19856 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19857 {
19858 PRODUCE_GLYPHS (it);
19859 /* term.c:produce_glyphs advances it->current_x only for
19860 TEXT_AREA. */
19861 it->current_x += it->pixel_width;
19862 }
19863
19864 it->current_x = saved_x;
19865 it->area = TEXT_AREA;
19866 }
19867
19868 /* The last row's blank glyphs should get the default face, to
19869 avoid painting the rest of the window with the region face,
19870 if the region ends at ZV. */
19871 if (it->glyph_row->ends_at_zv_p)
19872 it->face_id = default_face->id;
19873 else
19874 it->face_id = face->id;
19875 PRODUCE_GLYPHS (it);
19876
19877 while (it->current_x <= it->last_visible_x)
19878 PRODUCE_GLYPHS (it);
19879
19880 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19881 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19882 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19883 && !it->glyph_row->mode_line_p
19884 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19885 {
19886 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19887 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19888
19889 for ( ; g < e; g++)
19890 it->current_x += g->pixel_width;
19891
19892 it->area = RIGHT_MARGIN_AREA;
19893 it->face_id = default_face->id;
19894 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19895 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19896 {
19897 PRODUCE_GLYPHS (it);
19898 it->current_x += it->pixel_width;
19899 }
19900
19901 it->area = TEXT_AREA;
19902 }
19903
19904 /* Don't count these blanks really. It would let us insert a left
19905 truncation glyph below and make us set the cursor on them, maybe. */
19906 it->current_x = saved_x;
19907 it->object = saved_object;
19908 it->position = saved_pos;
19909 it->what = saved_what;
19910 it->face_id = saved_face_id;
19911 }
19912 }
19913
19914
19915 /* Value is true if text starting at CHARPOS in current_buffer is
19916 trailing whitespace. */
19917
19918 static bool
19919 trailing_whitespace_p (ptrdiff_t charpos)
19920 {
19921 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19922 int c = 0;
19923
19924 while (bytepos < ZV_BYTE
19925 && (c = FETCH_CHAR (bytepos),
19926 c == ' ' || c == '\t'))
19927 ++bytepos;
19928
19929 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19930 {
19931 if (bytepos != PT_BYTE)
19932 return true;
19933 }
19934 return false;
19935 }
19936
19937
19938 /* Highlight trailing whitespace, if any, in ROW. */
19939
19940 static void
19941 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19942 {
19943 int used = row->used[TEXT_AREA];
19944
19945 if (used)
19946 {
19947 struct glyph *start = row->glyphs[TEXT_AREA];
19948 struct glyph *glyph = start + used - 1;
19949
19950 if (row->reversed_p)
19951 {
19952 /* Right-to-left rows need to be processed in the opposite
19953 direction, so swap the edge pointers. */
19954 glyph = start;
19955 start = row->glyphs[TEXT_AREA] + used - 1;
19956 }
19957
19958 /* Skip over glyphs inserted to display the cursor at the
19959 end of a line, for extending the face of the last glyph
19960 to the end of the line on terminals, and for truncation
19961 and continuation glyphs. */
19962 if (!row->reversed_p)
19963 {
19964 while (glyph >= start
19965 && glyph->type == CHAR_GLYPH
19966 && NILP (glyph->object))
19967 --glyph;
19968 }
19969 else
19970 {
19971 while (glyph <= start
19972 && glyph->type == CHAR_GLYPH
19973 && NILP (glyph->object))
19974 ++glyph;
19975 }
19976
19977 /* If last glyph is a space or stretch, and it's trailing
19978 whitespace, set the face of all trailing whitespace glyphs in
19979 IT->glyph_row to `trailing-whitespace'. */
19980 if ((row->reversed_p ? glyph <= start : glyph >= start)
19981 && BUFFERP (glyph->object)
19982 && (glyph->type == STRETCH_GLYPH
19983 || (glyph->type == CHAR_GLYPH
19984 && glyph->u.ch == ' '))
19985 && trailing_whitespace_p (glyph->charpos))
19986 {
19987 int face_id = lookup_named_face (f, Qtrailing_whitespace, false);
19988 if (face_id < 0)
19989 return;
19990
19991 if (!row->reversed_p)
19992 {
19993 while (glyph >= start
19994 && BUFFERP (glyph->object)
19995 && (glyph->type == STRETCH_GLYPH
19996 || (glyph->type == CHAR_GLYPH
19997 && glyph->u.ch == ' ')))
19998 (glyph--)->face_id = face_id;
19999 }
20000 else
20001 {
20002 while (glyph <= start
20003 && BUFFERP (glyph->object)
20004 && (glyph->type == STRETCH_GLYPH
20005 || (glyph->type == CHAR_GLYPH
20006 && glyph->u.ch == ' ')))
20007 (glyph++)->face_id = face_id;
20008 }
20009 }
20010 }
20011 }
20012
20013
20014 /* Value is true if glyph row ROW should be
20015 considered to hold the buffer position CHARPOS. */
20016
20017 static bool
20018 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
20019 {
20020 bool result = true;
20021
20022 if (charpos == CHARPOS (row->end.pos)
20023 || charpos == MATRIX_ROW_END_CHARPOS (row))
20024 {
20025 /* Suppose the row ends on a string.
20026 Unless the row is continued, that means it ends on a newline
20027 in the string. If it's anything other than a display string
20028 (e.g., a before-string from an overlay), we don't want the
20029 cursor there. (This heuristic seems to give the optimal
20030 behavior for the various types of multi-line strings.)
20031 One exception: if the string has `cursor' property on one of
20032 its characters, we _do_ want the cursor there. */
20033 if (CHARPOS (row->end.string_pos) >= 0)
20034 {
20035 if (row->continued_p)
20036 result = true;
20037 else
20038 {
20039 /* Check for `display' property. */
20040 struct glyph *beg = row->glyphs[TEXT_AREA];
20041 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
20042 struct glyph *glyph;
20043
20044 result = false;
20045 for (glyph = end; glyph >= beg; --glyph)
20046 if (STRINGP (glyph->object))
20047 {
20048 Lisp_Object prop
20049 = Fget_char_property (make_number (charpos),
20050 Qdisplay, Qnil);
20051 result =
20052 (!NILP (prop)
20053 && display_prop_string_p (prop, glyph->object));
20054 /* If there's a `cursor' property on one of the
20055 string's characters, this row is a cursor row,
20056 even though this is not a display string. */
20057 if (!result)
20058 {
20059 Lisp_Object s = glyph->object;
20060
20061 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
20062 {
20063 ptrdiff_t gpos = glyph->charpos;
20064
20065 if (!NILP (Fget_char_property (make_number (gpos),
20066 Qcursor, s)))
20067 {
20068 result = true;
20069 break;
20070 }
20071 }
20072 }
20073 break;
20074 }
20075 }
20076 }
20077 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
20078 {
20079 /* If the row ends in middle of a real character,
20080 and the line is continued, we want the cursor here.
20081 That's because CHARPOS (ROW->end.pos) would equal
20082 PT if PT is before the character. */
20083 if (!row->ends_in_ellipsis_p)
20084 result = row->continued_p;
20085 else
20086 /* If the row ends in an ellipsis, then
20087 CHARPOS (ROW->end.pos) will equal point after the
20088 invisible text. We want that position to be displayed
20089 after the ellipsis. */
20090 result = false;
20091 }
20092 /* If the row ends at ZV, display the cursor at the end of that
20093 row instead of at the start of the row below. */
20094 else
20095 result = row->ends_at_zv_p;
20096 }
20097
20098 return result;
20099 }
20100
20101 /* Value is true if glyph row ROW should be
20102 used to hold the cursor. */
20103
20104 static bool
20105 cursor_row_p (struct glyph_row *row)
20106 {
20107 return row_for_charpos_p (row, PT);
20108 }
20109
20110 \f
20111
20112 /* Push the property PROP so that it will be rendered at the current
20113 position in IT. Return true if PROP was successfully pushed, false
20114 otherwise. Called from handle_line_prefix to handle the
20115 `line-prefix' and `wrap-prefix' properties. */
20116
20117 static bool
20118 push_prefix_prop (struct it *it, Lisp_Object prop)
20119 {
20120 struct text_pos pos =
20121 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
20122
20123 eassert (it->method == GET_FROM_BUFFER
20124 || it->method == GET_FROM_DISPLAY_VECTOR
20125 || it->method == GET_FROM_STRING
20126 || it->method == GET_FROM_IMAGE);
20127
20128 /* We need to save the current buffer/string position, so it will be
20129 restored by pop_it, because iterate_out_of_display_property
20130 depends on that being set correctly, but some situations leave
20131 it->position not yet set when this function is called. */
20132 push_it (it, &pos);
20133
20134 if (STRINGP (prop))
20135 {
20136 if (SCHARS (prop) == 0)
20137 {
20138 pop_it (it);
20139 return false;
20140 }
20141
20142 it->string = prop;
20143 it->string_from_prefix_prop_p = true;
20144 it->multibyte_p = STRING_MULTIBYTE (it->string);
20145 it->current.overlay_string_index = -1;
20146 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
20147 it->end_charpos = it->string_nchars = SCHARS (it->string);
20148 it->method = GET_FROM_STRING;
20149 it->stop_charpos = 0;
20150 it->prev_stop = 0;
20151 it->base_level_stop = 0;
20152
20153 /* Force paragraph direction to be that of the parent
20154 buffer/string. */
20155 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
20156 it->paragraph_embedding = it->bidi_it.paragraph_dir;
20157 else
20158 it->paragraph_embedding = L2R;
20159
20160 /* Set up the bidi iterator for this display string. */
20161 if (it->bidi_p)
20162 {
20163 it->bidi_it.string.lstring = it->string;
20164 it->bidi_it.string.s = NULL;
20165 it->bidi_it.string.schars = it->end_charpos;
20166 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
20167 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
20168 it->bidi_it.string.unibyte = !it->multibyte_p;
20169 it->bidi_it.w = it->w;
20170 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
20171 }
20172 }
20173 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
20174 {
20175 it->method = GET_FROM_STRETCH;
20176 it->object = prop;
20177 }
20178 #ifdef HAVE_WINDOW_SYSTEM
20179 else if (IMAGEP (prop))
20180 {
20181 it->what = IT_IMAGE;
20182 it->image_id = lookup_image (it->f, prop);
20183 it->method = GET_FROM_IMAGE;
20184 }
20185 #endif /* HAVE_WINDOW_SYSTEM */
20186 else
20187 {
20188 pop_it (it); /* bogus display property, give up */
20189 return false;
20190 }
20191
20192 return true;
20193 }
20194
20195 /* Return the character-property PROP at the current position in IT. */
20196
20197 static Lisp_Object
20198 get_it_property (struct it *it, Lisp_Object prop)
20199 {
20200 Lisp_Object position, object = it->object;
20201
20202 if (STRINGP (object))
20203 position = make_number (IT_STRING_CHARPOS (*it));
20204 else if (BUFFERP (object))
20205 {
20206 position = make_number (IT_CHARPOS (*it));
20207 object = it->window;
20208 }
20209 else
20210 return Qnil;
20211
20212 return Fget_char_property (position, prop, object);
20213 }
20214
20215 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
20216
20217 static void
20218 handle_line_prefix (struct it *it)
20219 {
20220 Lisp_Object prefix;
20221
20222 if (it->continuation_lines_width > 0)
20223 {
20224 prefix = get_it_property (it, Qwrap_prefix);
20225 if (NILP (prefix))
20226 prefix = Vwrap_prefix;
20227 }
20228 else
20229 {
20230 prefix = get_it_property (it, Qline_prefix);
20231 if (NILP (prefix))
20232 prefix = Vline_prefix;
20233 }
20234 if (! NILP (prefix) && push_prefix_prop (it, prefix))
20235 {
20236 /* If the prefix is wider than the window, and we try to wrap
20237 it, it would acquire its own wrap prefix, and so on till the
20238 iterator stack overflows. So, don't wrap the prefix. */
20239 it->line_wrap = TRUNCATE;
20240 it->avoid_cursor_p = true;
20241 }
20242 }
20243
20244 \f
20245
20246 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
20247 only for R2L lines from display_line and display_string, when they
20248 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
20249 the line/string needs to be continued on the next glyph row. */
20250 static void
20251 unproduce_glyphs (struct it *it, int n)
20252 {
20253 struct glyph *glyph, *end;
20254
20255 eassert (it->glyph_row);
20256 eassert (it->glyph_row->reversed_p);
20257 eassert (it->area == TEXT_AREA);
20258 eassert (n <= it->glyph_row->used[TEXT_AREA]);
20259
20260 if (n > it->glyph_row->used[TEXT_AREA])
20261 n = it->glyph_row->used[TEXT_AREA];
20262 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
20263 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
20264 for ( ; glyph < end; glyph++)
20265 glyph[-n] = *glyph;
20266 }
20267
20268 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
20269 and ROW->maxpos. */
20270 static void
20271 find_row_edges (struct it *it, struct glyph_row *row,
20272 ptrdiff_t min_pos, ptrdiff_t min_bpos,
20273 ptrdiff_t max_pos, ptrdiff_t max_bpos)
20274 {
20275 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20276 lines' rows is implemented for bidi-reordered rows. */
20277
20278 /* ROW->minpos is the value of min_pos, the minimal buffer position
20279 we have in ROW, or ROW->start.pos if that is smaller. */
20280 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
20281 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
20282 else
20283 /* We didn't find buffer positions smaller than ROW->start, or
20284 didn't find _any_ valid buffer positions in any of the glyphs,
20285 so we must trust the iterator's computed positions. */
20286 row->minpos = row->start.pos;
20287 if (max_pos <= 0)
20288 {
20289 max_pos = CHARPOS (it->current.pos);
20290 max_bpos = BYTEPOS (it->current.pos);
20291 }
20292
20293 /* Here are the various use-cases for ending the row, and the
20294 corresponding values for ROW->maxpos:
20295
20296 Line ends in a newline from buffer eol_pos + 1
20297 Line is continued from buffer max_pos + 1
20298 Line is truncated on right it->current.pos
20299 Line ends in a newline from string max_pos + 1(*)
20300 (*) + 1 only when line ends in a forward scan
20301 Line is continued from string max_pos
20302 Line is continued from display vector max_pos
20303 Line is entirely from a string min_pos == max_pos
20304 Line is entirely from a display vector min_pos == max_pos
20305 Line that ends at ZV ZV
20306
20307 If you discover other use-cases, please add them here as
20308 appropriate. */
20309 if (row->ends_at_zv_p)
20310 row->maxpos = it->current.pos;
20311 else if (row->used[TEXT_AREA])
20312 {
20313 bool seen_this_string = false;
20314 struct glyph_row *r1 = row - 1;
20315
20316 /* Did we see the same display string on the previous row? */
20317 if (STRINGP (it->object)
20318 /* this is not the first row */
20319 && row > it->w->desired_matrix->rows
20320 /* previous row is not the header line */
20321 && !r1->mode_line_p
20322 /* previous row also ends in a newline from a string */
20323 && r1->ends_in_newline_from_string_p)
20324 {
20325 struct glyph *start, *end;
20326
20327 /* Search for the last glyph of the previous row that came
20328 from buffer or string. Depending on whether the row is
20329 L2R or R2L, we need to process it front to back or the
20330 other way round. */
20331 if (!r1->reversed_p)
20332 {
20333 start = r1->glyphs[TEXT_AREA];
20334 end = start + r1->used[TEXT_AREA];
20335 /* Glyphs inserted by redisplay have nil as their object. */
20336 while (end > start
20337 && NILP ((end - 1)->object)
20338 && (end - 1)->charpos <= 0)
20339 --end;
20340 if (end > start)
20341 {
20342 if (EQ ((end - 1)->object, it->object))
20343 seen_this_string = true;
20344 }
20345 else
20346 /* If all the glyphs of the previous row were inserted
20347 by redisplay, it means the previous row was
20348 produced from a single newline, which is only
20349 possible if that newline came from the same string
20350 as the one which produced this ROW. */
20351 seen_this_string = true;
20352 }
20353 else
20354 {
20355 end = r1->glyphs[TEXT_AREA] - 1;
20356 start = end + r1->used[TEXT_AREA];
20357 while (end < start
20358 && NILP ((end + 1)->object)
20359 && (end + 1)->charpos <= 0)
20360 ++end;
20361 if (end < start)
20362 {
20363 if (EQ ((end + 1)->object, it->object))
20364 seen_this_string = true;
20365 }
20366 else
20367 seen_this_string = true;
20368 }
20369 }
20370 /* Take note of each display string that covers a newline only
20371 once, the first time we see it. This is for when a display
20372 string includes more than one newline in it. */
20373 if (row->ends_in_newline_from_string_p && !seen_this_string)
20374 {
20375 /* If we were scanning the buffer forward when we displayed
20376 the string, we want to account for at least one buffer
20377 position that belongs to this row (position covered by
20378 the display string), so that cursor positioning will
20379 consider this row as a candidate when point is at the end
20380 of the visual line represented by this row. This is not
20381 required when scanning back, because max_pos will already
20382 have a much larger value. */
20383 if (CHARPOS (row->end.pos) > max_pos)
20384 INC_BOTH (max_pos, max_bpos);
20385 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20386 }
20387 else if (CHARPOS (it->eol_pos) > 0)
20388 SET_TEXT_POS (row->maxpos,
20389 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
20390 else if (row->continued_p)
20391 {
20392 /* If max_pos is different from IT's current position, it
20393 means IT->method does not belong to the display element
20394 at max_pos. However, it also means that the display
20395 element at max_pos was displayed in its entirety on this
20396 line, which is equivalent to saying that the next line
20397 starts at the next buffer position. */
20398 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
20399 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20400 else
20401 {
20402 INC_BOTH (max_pos, max_bpos);
20403 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20404 }
20405 }
20406 else if (row->truncated_on_right_p)
20407 /* display_line already called reseat_at_next_visible_line_start,
20408 which puts the iterator at the beginning of the next line, in
20409 the logical order. */
20410 row->maxpos = it->current.pos;
20411 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
20412 /* A line that is entirely from a string/image/stretch... */
20413 row->maxpos = row->minpos;
20414 else
20415 emacs_abort ();
20416 }
20417 else
20418 row->maxpos = it->current.pos;
20419 }
20420
20421 /* Construct the glyph row IT->glyph_row in the desired matrix of
20422 IT->w from text at the current position of IT. See dispextern.h
20423 for an overview of struct it. Value is true if
20424 IT->glyph_row displays text, as opposed to a line displaying ZV
20425 only. */
20426
20427 static bool
20428 display_line (struct it *it)
20429 {
20430 struct glyph_row *row = it->glyph_row;
20431 Lisp_Object overlay_arrow_string;
20432 struct it wrap_it;
20433 void *wrap_data = NULL;
20434 bool may_wrap = false;
20435 int wrap_x UNINIT;
20436 int wrap_row_used = -1;
20437 int wrap_row_ascent UNINIT, wrap_row_height UNINIT;
20438 int wrap_row_phys_ascent UNINIT, wrap_row_phys_height UNINIT;
20439 int wrap_row_extra_line_spacing UNINIT;
20440 ptrdiff_t wrap_row_min_pos UNINIT, wrap_row_min_bpos UNINIT;
20441 ptrdiff_t wrap_row_max_pos UNINIT, wrap_row_max_bpos UNINIT;
20442 int cvpos;
20443 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
20444 ptrdiff_t min_bpos UNINIT, max_bpos UNINIT;
20445 bool pending_handle_line_prefix = false;
20446
20447 /* We always start displaying at hpos zero even if hscrolled. */
20448 eassert (it->hpos == 0 && it->current_x == 0);
20449
20450 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
20451 >= it->w->desired_matrix->nrows)
20452 {
20453 it->w->nrows_scale_factor++;
20454 it->f->fonts_changed = true;
20455 return false;
20456 }
20457
20458 /* Clear the result glyph row and enable it. */
20459 prepare_desired_row (it->w, row, false);
20460
20461 row->y = it->current_y;
20462 row->start = it->start;
20463 row->continuation_lines_width = it->continuation_lines_width;
20464 row->displays_text_p = true;
20465 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
20466 it->starts_in_middle_of_char_p = false;
20467
20468 /* Arrange the overlays nicely for our purposes. Usually, we call
20469 display_line on only one line at a time, in which case this
20470 can't really hurt too much, or we call it on lines which appear
20471 one after another in the buffer, in which case all calls to
20472 recenter_overlay_lists but the first will be pretty cheap. */
20473 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
20474
20475 /* Move over display elements that are not visible because we are
20476 hscrolled. This may stop at an x-position < IT->first_visible_x
20477 if the first glyph is partially visible or if we hit a line end. */
20478 if (it->current_x < it->first_visible_x)
20479 {
20480 enum move_it_result move_result;
20481
20482 this_line_min_pos = row->start.pos;
20483 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
20484 MOVE_TO_POS | MOVE_TO_X);
20485 /* If we are under a large hscroll, move_it_in_display_line_to
20486 could hit the end of the line without reaching
20487 it->first_visible_x. Pretend that we did reach it. This is
20488 especially important on a TTY, where we will call
20489 extend_face_to_end_of_line, which needs to know how many
20490 blank glyphs to produce. */
20491 if (it->current_x < it->first_visible_x
20492 && (move_result == MOVE_NEWLINE_OR_CR
20493 || move_result == MOVE_POS_MATCH_OR_ZV))
20494 it->current_x = it->first_visible_x;
20495
20496 /* Record the smallest positions seen while we moved over
20497 display elements that are not visible. This is needed by
20498 redisplay_internal for optimizing the case where the cursor
20499 stays inside the same line. The rest of this function only
20500 considers positions that are actually displayed, so
20501 RECORD_MAX_MIN_POS will not otherwise record positions that
20502 are hscrolled to the left of the left edge of the window. */
20503 min_pos = CHARPOS (this_line_min_pos);
20504 min_bpos = BYTEPOS (this_line_min_pos);
20505 }
20506 else if (it->area == TEXT_AREA)
20507 {
20508 /* We only do this when not calling move_it_in_display_line_to
20509 above, because that function calls itself handle_line_prefix. */
20510 handle_line_prefix (it);
20511 }
20512 else
20513 {
20514 /* Line-prefix and wrap-prefix are always displayed in the text
20515 area. But if this is the first call to display_line after
20516 init_iterator, the iterator might have been set up to write
20517 into a marginal area, e.g. if the line begins with some
20518 display property that writes to the margins. So we need to
20519 wait with the call to handle_line_prefix until whatever
20520 writes to the margin has done its job. */
20521 pending_handle_line_prefix = true;
20522 }
20523
20524 /* Get the initial row height. This is either the height of the
20525 text hscrolled, if there is any, or zero. */
20526 row->ascent = it->max_ascent;
20527 row->height = it->max_ascent + it->max_descent;
20528 row->phys_ascent = it->max_phys_ascent;
20529 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
20530 row->extra_line_spacing = it->max_extra_line_spacing;
20531
20532 /* Utility macro to record max and min buffer positions seen until now. */
20533 #define RECORD_MAX_MIN_POS(IT) \
20534 do \
20535 { \
20536 bool composition_p \
20537 = !STRINGP ((IT)->string) && ((IT)->what == IT_COMPOSITION); \
20538 ptrdiff_t current_pos = \
20539 composition_p ? (IT)->cmp_it.charpos \
20540 : IT_CHARPOS (*(IT)); \
20541 ptrdiff_t current_bpos = \
20542 composition_p ? CHAR_TO_BYTE (current_pos) \
20543 : IT_BYTEPOS (*(IT)); \
20544 if (current_pos < min_pos) \
20545 { \
20546 min_pos = current_pos; \
20547 min_bpos = current_bpos; \
20548 } \
20549 if (IT_CHARPOS (*it) > max_pos) \
20550 { \
20551 max_pos = IT_CHARPOS (*it); \
20552 max_bpos = IT_BYTEPOS (*it); \
20553 } \
20554 } \
20555 while (false)
20556
20557 /* Loop generating characters. The loop is left with IT on the next
20558 character to display. */
20559 while (true)
20560 {
20561 int n_glyphs_before, hpos_before, x_before;
20562 int x, nglyphs;
20563 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
20564
20565 /* Retrieve the next thing to display. Value is false if end of
20566 buffer reached. */
20567 if (!get_next_display_element (it))
20568 {
20569 /* Maybe add a space at the end of this line that is used to
20570 display the cursor there under X. Set the charpos of the
20571 first glyph of blank lines not corresponding to any text
20572 to -1. */
20573 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20574 row->exact_window_width_line_p = true;
20575 else if ((append_space_for_newline (it, true)
20576 && row->used[TEXT_AREA] == 1)
20577 || row->used[TEXT_AREA] == 0)
20578 {
20579 row->glyphs[TEXT_AREA]->charpos = -1;
20580 row->displays_text_p = false;
20581
20582 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
20583 && (!MINI_WINDOW_P (it->w)
20584 || (minibuf_level && EQ (it->window, minibuf_window))))
20585 row->indicate_empty_line_p = true;
20586 }
20587
20588 it->continuation_lines_width = 0;
20589 row->ends_at_zv_p = true;
20590 /* A row that displays right-to-left text must always have
20591 its last face extended all the way to the end of line,
20592 even if this row ends in ZV, because we still write to
20593 the screen left to right. We also need to extend the
20594 last face if the default face is remapped to some
20595 different face, otherwise the functions that clear
20596 portions of the screen will clear with the default face's
20597 background color. */
20598 if (row->reversed_p
20599 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
20600 extend_face_to_end_of_line (it);
20601 break;
20602 }
20603
20604 /* Now, get the metrics of what we want to display. This also
20605 generates glyphs in `row' (which is IT->glyph_row). */
20606 n_glyphs_before = row->used[TEXT_AREA];
20607 x = it->current_x;
20608
20609 /* Remember the line height so far in case the next element doesn't
20610 fit on the line. */
20611 if (it->line_wrap != TRUNCATE)
20612 {
20613 ascent = it->max_ascent;
20614 descent = it->max_descent;
20615 phys_ascent = it->max_phys_ascent;
20616 phys_descent = it->max_phys_descent;
20617
20618 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
20619 {
20620 if (IT_DISPLAYING_WHITESPACE (it))
20621 may_wrap = true;
20622 else if (may_wrap)
20623 {
20624 SAVE_IT (wrap_it, *it, wrap_data);
20625 wrap_x = x;
20626 wrap_row_used = row->used[TEXT_AREA];
20627 wrap_row_ascent = row->ascent;
20628 wrap_row_height = row->height;
20629 wrap_row_phys_ascent = row->phys_ascent;
20630 wrap_row_phys_height = row->phys_height;
20631 wrap_row_extra_line_spacing = row->extra_line_spacing;
20632 wrap_row_min_pos = min_pos;
20633 wrap_row_min_bpos = min_bpos;
20634 wrap_row_max_pos = max_pos;
20635 wrap_row_max_bpos = max_bpos;
20636 may_wrap = false;
20637 }
20638 }
20639 }
20640
20641 PRODUCE_GLYPHS (it);
20642
20643 /* If this display element was in marginal areas, continue with
20644 the next one. */
20645 if (it->area != TEXT_AREA)
20646 {
20647 row->ascent = max (row->ascent, it->max_ascent);
20648 row->height = max (row->height, it->max_ascent + it->max_descent);
20649 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20650 row->phys_height = max (row->phys_height,
20651 it->max_phys_ascent + it->max_phys_descent);
20652 row->extra_line_spacing = max (row->extra_line_spacing,
20653 it->max_extra_line_spacing);
20654 set_iterator_to_next (it, true);
20655 /* If we didn't handle the line/wrap prefix above, and the
20656 call to set_iterator_to_next just switched to TEXT_AREA,
20657 process the prefix now. */
20658 if (it->area == TEXT_AREA && pending_handle_line_prefix)
20659 {
20660 pending_handle_line_prefix = false;
20661 handle_line_prefix (it);
20662 }
20663 continue;
20664 }
20665
20666 /* Does the display element fit on the line? If we truncate
20667 lines, we should draw past the right edge of the window. If
20668 we don't truncate, we want to stop so that we can display the
20669 continuation glyph before the right margin. If lines are
20670 continued, there are two possible strategies for characters
20671 resulting in more than 1 glyph (e.g. tabs): Display as many
20672 glyphs as possible in this line and leave the rest for the
20673 continuation line, or display the whole element in the next
20674 line. Original redisplay did the former, so we do it also. */
20675 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20676 hpos_before = it->hpos;
20677 x_before = x;
20678
20679 if (/* Not a newline. */
20680 nglyphs > 0
20681 /* Glyphs produced fit entirely in the line. */
20682 && it->current_x < it->last_visible_x)
20683 {
20684 it->hpos += nglyphs;
20685 row->ascent = max (row->ascent, it->max_ascent);
20686 row->height = max (row->height, it->max_ascent + it->max_descent);
20687 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20688 row->phys_height = max (row->phys_height,
20689 it->max_phys_ascent + it->max_phys_descent);
20690 row->extra_line_spacing = max (row->extra_line_spacing,
20691 it->max_extra_line_spacing);
20692 if (it->current_x - it->pixel_width < it->first_visible_x
20693 /* In R2L rows, we arrange in extend_face_to_end_of_line
20694 to add a right offset to the line, by a suitable
20695 change to the stretch glyph that is the leftmost
20696 glyph of the line. */
20697 && !row->reversed_p)
20698 row->x = x - it->first_visible_x;
20699 /* Record the maximum and minimum buffer positions seen so
20700 far in glyphs that will be displayed by this row. */
20701 if (it->bidi_p)
20702 RECORD_MAX_MIN_POS (it);
20703 }
20704 else
20705 {
20706 int i, new_x;
20707 struct glyph *glyph;
20708
20709 for (i = 0; i < nglyphs; ++i, x = new_x)
20710 {
20711 /* Identify the glyphs added by the last call to
20712 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20713 the previous glyphs. */
20714 if (!row->reversed_p)
20715 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20716 else
20717 glyph = row->glyphs[TEXT_AREA] + nglyphs - 1 - i;
20718 new_x = x + glyph->pixel_width;
20719
20720 if (/* Lines are continued. */
20721 it->line_wrap != TRUNCATE
20722 && (/* Glyph doesn't fit on the line. */
20723 new_x > it->last_visible_x
20724 /* Or it fits exactly on a window system frame. */
20725 || (new_x == it->last_visible_x
20726 && FRAME_WINDOW_P (it->f)
20727 && (row->reversed_p
20728 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20729 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20730 {
20731 /* End of a continued line. */
20732
20733 if (it->hpos == 0
20734 || (new_x == it->last_visible_x
20735 && FRAME_WINDOW_P (it->f)
20736 && (row->reversed_p
20737 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20738 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20739 {
20740 /* Current glyph is the only one on the line or
20741 fits exactly on the line. We must continue
20742 the line because we can't draw the cursor
20743 after the glyph. */
20744 row->continued_p = true;
20745 it->current_x = new_x;
20746 it->continuation_lines_width += new_x;
20747 ++it->hpos;
20748 if (i == nglyphs - 1)
20749 {
20750 /* If line-wrap is on, check if a previous
20751 wrap point was found. */
20752 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it)
20753 && wrap_row_used > 0
20754 /* Even if there is a previous wrap
20755 point, continue the line here as
20756 usual, if (i) the previous character
20757 was a space or tab AND (ii) the
20758 current character is not. */
20759 && (!may_wrap
20760 || IT_DISPLAYING_WHITESPACE (it)))
20761 goto back_to_wrap;
20762
20763 /* Record the maximum and minimum buffer
20764 positions seen so far in glyphs that will be
20765 displayed by this row. */
20766 if (it->bidi_p)
20767 RECORD_MAX_MIN_POS (it);
20768 set_iterator_to_next (it, true);
20769 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20770 {
20771 if (!get_next_display_element (it))
20772 {
20773 row->exact_window_width_line_p = true;
20774 it->continuation_lines_width = 0;
20775 row->continued_p = false;
20776 row->ends_at_zv_p = true;
20777 }
20778 else if (ITERATOR_AT_END_OF_LINE_P (it))
20779 {
20780 row->continued_p = false;
20781 row->exact_window_width_line_p = true;
20782 }
20783 /* If line-wrap is on, check if a
20784 previous wrap point was found. */
20785 else if (wrap_row_used > 0
20786 /* Even if there is a previous wrap
20787 point, continue the line here as
20788 usual, if (i) the previous character
20789 was a space or tab AND (ii) the
20790 current character is not. */
20791 && (!may_wrap
20792 || IT_DISPLAYING_WHITESPACE (it)))
20793 goto back_to_wrap;
20794
20795 }
20796 }
20797 else if (it->bidi_p)
20798 RECORD_MAX_MIN_POS (it);
20799 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20800 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20801 extend_face_to_end_of_line (it);
20802 }
20803 else if (CHAR_GLYPH_PADDING_P (*glyph)
20804 && !FRAME_WINDOW_P (it->f))
20805 {
20806 /* A padding glyph that doesn't fit on this line.
20807 This means the whole character doesn't fit
20808 on the line. */
20809 if (row->reversed_p)
20810 unproduce_glyphs (it, row->used[TEXT_AREA]
20811 - n_glyphs_before);
20812 row->used[TEXT_AREA] = n_glyphs_before;
20813
20814 /* Fill the rest of the row with continuation
20815 glyphs like in 20.x. */
20816 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20817 < row->glyphs[1 + TEXT_AREA])
20818 produce_special_glyphs (it, IT_CONTINUATION);
20819
20820 row->continued_p = true;
20821 it->current_x = x_before;
20822 it->continuation_lines_width += x_before;
20823
20824 /* Restore the height to what it was before the
20825 element not fitting on the line. */
20826 it->max_ascent = ascent;
20827 it->max_descent = descent;
20828 it->max_phys_ascent = phys_ascent;
20829 it->max_phys_descent = phys_descent;
20830 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20831 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20832 extend_face_to_end_of_line (it);
20833 }
20834 else if (wrap_row_used > 0)
20835 {
20836 back_to_wrap:
20837 if (row->reversed_p)
20838 unproduce_glyphs (it,
20839 row->used[TEXT_AREA] - wrap_row_used);
20840 RESTORE_IT (it, &wrap_it, wrap_data);
20841 it->continuation_lines_width += wrap_x;
20842 row->used[TEXT_AREA] = wrap_row_used;
20843 row->ascent = wrap_row_ascent;
20844 row->height = wrap_row_height;
20845 row->phys_ascent = wrap_row_phys_ascent;
20846 row->phys_height = wrap_row_phys_height;
20847 row->extra_line_spacing = wrap_row_extra_line_spacing;
20848 min_pos = wrap_row_min_pos;
20849 min_bpos = wrap_row_min_bpos;
20850 max_pos = wrap_row_max_pos;
20851 max_bpos = wrap_row_max_bpos;
20852 row->continued_p = true;
20853 row->ends_at_zv_p = false;
20854 row->exact_window_width_line_p = false;
20855 it->continuation_lines_width += x;
20856
20857 /* Make sure that a non-default face is extended
20858 up to the right margin of the window. */
20859 extend_face_to_end_of_line (it);
20860 }
20861 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20862 {
20863 /* A TAB that extends past the right edge of the
20864 window. This produces a single glyph on
20865 window system frames. We leave the glyph in
20866 this row and let it fill the row, but don't
20867 consume the TAB. */
20868 if ((row->reversed_p
20869 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20870 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20871 produce_special_glyphs (it, IT_CONTINUATION);
20872 it->continuation_lines_width += it->last_visible_x;
20873 row->ends_in_middle_of_char_p = true;
20874 row->continued_p = true;
20875 glyph->pixel_width = it->last_visible_x - x;
20876 it->starts_in_middle_of_char_p = true;
20877 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20878 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20879 extend_face_to_end_of_line (it);
20880 }
20881 else
20882 {
20883 /* Something other than a TAB that draws past
20884 the right edge of the window. Restore
20885 positions to values before the element. */
20886 if (row->reversed_p)
20887 unproduce_glyphs (it, row->used[TEXT_AREA]
20888 - (n_glyphs_before + i));
20889 row->used[TEXT_AREA] = n_glyphs_before + i;
20890
20891 /* Display continuation glyphs. */
20892 it->current_x = x_before;
20893 it->continuation_lines_width += x;
20894 if (!FRAME_WINDOW_P (it->f)
20895 || (row->reversed_p
20896 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20897 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20898 produce_special_glyphs (it, IT_CONTINUATION);
20899 row->continued_p = true;
20900
20901 extend_face_to_end_of_line (it);
20902
20903 if (nglyphs > 1 && i > 0)
20904 {
20905 row->ends_in_middle_of_char_p = true;
20906 it->starts_in_middle_of_char_p = true;
20907 }
20908
20909 /* Restore the height to what it was before the
20910 element not fitting on the line. */
20911 it->max_ascent = ascent;
20912 it->max_descent = descent;
20913 it->max_phys_ascent = phys_ascent;
20914 it->max_phys_descent = phys_descent;
20915 }
20916
20917 break;
20918 }
20919 else if (new_x > it->first_visible_x)
20920 {
20921 /* Increment number of glyphs actually displayed. */
20922 ++it->hpos;
20923
20924 /* Record the maximum and minimum buffer positions
20925 seen so far in glyphs that will be displayed by
20926 this row. */
20927 if (it->bidi_p)
20928 RECORD_MAX_MIN_POS (it);
20929
20930 if (x < it->first_visible_x && !row->reversed_p)
20931 /* Glyph is partially visible, i.e. row starts at
20932 negative X position. Don't do that in R2L
20933 rows, where we arrange to add a right offset to
20934 the line in extend_face_to_end_of_line, by a
20935 suitable change to the stretch glyph that is
20936 the leftmost glyph of the line. */
20937 row->x = x - it->first_visible_x;
20938 /* When the last glyph of an R2L row only fits
20939 partially on the line, we need to set row->x to a
20940 negative offset, so that the leftmost glyph is
20941 the one that is partially visible. But if we are
20942 going to produce the truncation glyph, this will
20943 be taken care of in produce_special_glyphs. */
20944 if (row->reversed_p
20945 && new_x > it->last_visible_x
20946 && !(it->line_wrap == TRUNCATE
20947 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
20948 {
20949 eassert (FRAME_WINDOW_P (it->f));
20950 row->x = it->last_visible_x - new_x;
20951 }
20952 }
20953 else
20954 {
20955 /* Glyph is completely off the left margin of the
20956 window. This should not happen because of the
20957 move_it_in_display_line at the start of this
20958 function, unless the text display area of the
20959 window is empty. */
20960 eassert (it->first_visible_x <= it->last_visible_x);
20961 }
20962 }
20963 /* Even if this display element produced no glyphs at all,
20964 we want to record its position. */
20965 if (it->bidi_p && nglyphs == 0)
20966 RECORD_MAX_MIN_POS (it);
20967
20968 row->ascent = max (row->ascent, it->max_ascent);
20969 row->height = max (row->height, it->max_ascent + it->max_descent);
20970 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20971 row->phys_height = max (row->phys_height,
20972 it->max_phys_ascent + it->max_phys_descent);
20973 row->extra_line_spacing = max (row->extra_line_spacing,
20974 it->max_extra_line_spacing);
20975
20976 /* End of this display line if row is continued. */
20977 if (row->continued_p || row->ends_at_zv_p)
20978 break;
20979 }
20980
20981 at_end_of_line:
20982 /* Is this a line end? If yes, we're also done, after making
20983 sure that a non-default face is extended up to the right
20984 margin of the window. */
20985 if (ITERATOR_AT_END_OF_LINE_P (it))
20986 {
20987 int used_before = row->used[TEXT_AREA];
20988
20989 row->ends_in_newline_from_string_p = STRINGP (it->object);
20990
20991 /* Add a space at the end of the line that is used to
20992 display the cursor there. */
20993 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20994 append_space_for_newline (it, false);
20995
20996 /* Extend the face to the end of the line. */
20997 extend_face_to_end_of_line (it);
20998
20999 /* Make sure we have the position. */
21000 if (used_before == 0)
21001 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
21002
21003 /* Record the position of the newline, for use in
21004 find_row_edges. */
21005 it->eol_pos = it->current.pos;
21006
21007 /* Consume the line end. This skips over invisible lines. */
21008 set_iterator_to_next (it, true);
21009 it->continuation_lines_width = 0;
21010 break;
21011 }
21012
21013 /* Proceed with next display element. Note that this skips
21014 over lines invisible because of selective display. */
21015 set_iterator_to_next (it, true);
21016
21017 /* If we truncate lines, we are done when the last displayed
21018 glyphs reach past the right margin of the window. */
21019 if (it->line_wrap == TRUNCATE
21020 && ((FRAME_WINDOW_P (it->f)
21021 /* Images are preprocessed in produce_image_glyph such
21022 that they are cropped at the right edge of the
21023 window, so an image glyph will always end exactly at
21024 last_visible_x, even if there's no right fringe. */
21025 && ((row->reversed_p
21026 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
21027 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))
21028 || it->what == IT_IMAGE))
21029 ? (it->current_x >= it->last_visible_x)
21030 : (it->current_x > it->last_visible_x)))
21031 {
21032 /* Maybe add truncation glyphs. */
21033 if (!FRAME_WINDOW_P (it->f)
21034 || (row->reversed_p
21035 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
21036 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
21037 {
21038 int i, n;
21039
21040 if (!row->reversed_p)
21041 {
21042 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
21043 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
21044 break;
21045 }
21046 else
21047 {
21048 for (i = 0; i < row->used[TEXT_AREA]; i++)
21049 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
21050 break;
21051 /* Remove any padding glyphs at the front of ROW, to
21052 make room for the truncation glyphs we will be
21053 adding below. The loop below always inserts at
21054 least one truncation glyph, so also remove the
21055 last glyph added to ROW. */
21056 unproduce_glyphs (it, i + 1);
21057 /* Adjust i for the loop below. */
21058 i = row->used[TEXT_AREA] - (i + 1);
21059 }
21060
21061 /* produce_special_glyphs overwrites the last glyph, so
21062 we don't want that if we want to keep that last
21063 glyph, which means it's an image. */
21064 if (it->current_x > it->last_visible_x)
21065 {
21066 it->current_x = x_before;
21067 if (!FRAME_WINDOW_P (it->f))
21068 {
21069 for (n = row->used[TEXT_AREA]; i < n; ++i)
21070 {
21071 row->used[TEXT_AREA] = i;
21072 produce_special_glyphs (it, IT_TRUNCATION);
21073 }
21074 }
21075 else
21076 {
21077 row->used[TEXT_AREA] = i;
21078 produce_special_glyphs (it, IT_TRUNCATION);
21079 }
21080 it->hpos = hpos_before;
21081 }
21082 }
21083 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
21084 {
21085 /* Don't truncate if we can overflow newline into fringe. */
21086 if (!get_next_display_element (it))
21087 {
21088 it->continuation_lines_width = 0;
21089 row->ends_at_zv_p = true;
21090 row->exact_window_width_line_p = true;
21091 break;
21092 }
21093 if (ITERATOR_AT_END_OF_LINE_P (it))
21094 {
21095 row->exact_window_width_line_p = true;
21096 goto at_end_of_line;
21097 }
21098 it->current_x = x_before;
21099 it->hpos = hpos_before;
21100 }
21101
21102 row->truncated_on_right_p = true;
21103 it->continuation_lines_width = 0;
21104 reseat_at_next_visible_line_start (it, false);
21105 /* We insist below that IT's position be at ZV because in
21106 bidi-reordered lines the character at visible line start
21107 might not be the character that follows the newline in
21108 the logical order. */
21109 if (IT_BYTEPOS (*it) > BEG_BYTE)
21110 row->ends_at_zv_p =
21111 IT_BYTEPOS (*it) >= ZV_BYTE && FETCH_BYTE (ZV_BYTE - 1) != '\n';
21112 else
21113 row->ends_at_zv_p = false;
21114 break;
21115 }
21116 }
21117
21118 if (wrap_data)
21119 bidi_unshelve_cache (wrap_data, true);
21120
21121 /* If line is not empty and hscrolled, maybe insert truncation glyphs
21122 at the left window margin. */
21123 if (it->first_visible_x
21124 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
21125 {
21126 if (!FRAME_WINDOW_P (it->f)
21127 || (((row->reversed_p
21128 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
21129 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
21130 /* Don't let insert_left_trunc_glyphs overwrite the
21131 first glyph of the row if it is an image. */
21132 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
21133 insert_left_trunc_glyphs (it);
21134 row->truncated_on_left_p = true;
21135 }
21136
21137 /* Remember the position at which this line ends.
21138
21139 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
21140 cannot be before the call to find_row_edges below, since that is
21141 where these positions are determined. */
21142 row->end = it->current;
21143 if (!it->bidi_p)
21144 {
21145 row->minpos = row->start.pos;
21146 row->maxpos = row->end.pos;
21147 }
21148 else
21149 {
21150 /* ROW->minpos and ROW->maxpos must be the smallest and
21151 `1 + the largest' buffer positions in ROW. But if ROW was
21152 bidi-reordered, these two positions can be anywhere in the
21153 row, so we must determine them now. */
21154 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
21155 }
21156
21157 /* If the start of this line is the overlay arrow-position, then
21158 mark this glyph row as the one containing the overlay arrow.
21159 This is clearly a mess with variable size fonts. It would be
21160 better to let it be displayed like cursors under X. */
21161 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
21162 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
21163 !NILP (overlay_arrow_string)))
21164 {
21165 /* Overlay arrow in window redisplay is a fringe bitmap. */
21166 if (STRINGP (overlay_arrow_string))
21167 {
21168 struct glyph_row *arrow_row
21169 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
21170 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
21171 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
21172 struct glyph *p = row->glyphs[TEXT_AREA];
21173 struct glyph *p2, *end;
21174
21175 /* Copy the arrow glyphs. */
21176 while (glyph < arrow_end)
21177 *p++ = *glyph++;
21178
21179 /* Throw away padding glyphs. */
21180 p2 = p;
21181 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
21182 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
21183 ++p2;
21184 if (p2 > p)
21185 {
21186 while (p2 < end)
21187 *p++ = *p2++;
21188 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
21189 }
21190 }
21191 else
21192 {
21193 eassert (INTEGERP (overlay_arrow_string));
21194 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
21195 }
21196 overlay_arrow_seen = true;
21197 }
21198
21199 /* Highlight trailing whitespace. */
21200 if (!NILP (Vshow_trailing_whitespace))
21201 highlight_trailing_whitespace (it->f, it->glyph_row);
21202
21203 /* Compute pixel dimensions of this line. */
21204 compute_line_metrics (it);
21205
21206 /* Implementation note: No changes in the glyphs of ROW or in their
21207 faces can be done past this point, because compute_line_metrics
21208 computes ROW's hash value and stores it within the glyph_row
21209 structure. */
21210
21211 /* Record whether this row ends inside an ellipsis. */
21212 row->ends_in_ellipsis_p
21213 = (it->method == GET_FROM_DISPLAY_VECTOR
21214 && it->ellipsis_p);
21215
21216 /* Save fringe bitmaps in this row. */
21217 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
21218 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
21219 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
21220 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
21221
21222 it->left_user_fringe_bitmap = 0;
21223 it->left_user_fringe_face_id = 0;
21224 it->right_user_fringe_bitmap = 0;
21225 it->right_user_fringe_face_id = 0;
21226
21227 /* Maybe set the cursor. */
21228 cvpos = it->w->cursor.vpos;
21229 if ((cvpos < 0
21230 /* In bidi-reordered rows, keep checking for proper cursor
21231 position even if one has been found already, because buffer
21232 positions in such rows change non-linearly with ROW->VPOS,
21233 when a line is continued. One exception: when we are at ZV,
21234 display cursor on the first suitable glyph row, since all
21235 the empty rows after that also have their position set to ZV. */
21236 /* FIXME: Revisit this when glyph ``spilling'' in continuation
21237 lines' rows is implemented for bidi-reordered rows. */
21238 || (it->bidi_p
21239 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
21240 && PT >= MATRIX_ROW_START_CHARPOS (row)
21241 && PT <= MATRIX_ROW_END_CHARPOS (row)
21242 && cursor_row_p (row))
21243 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
21244
21245 /* Prepare for the next line. This line starts horizontally at (X
21246 HPOS) = (0 0). Vertical positions are incremented. As a
21247 convenience for the caller, IT->glyph_row is set to the next
21248 row to be used. */
21249 it->current_x = it->hpos = 0;
21250 it->current_y += row->height;
21251 SET_TEXT_POS (it->eol_pos, 0, 0);
21252 ++it->vpos;
21253 ++it->glyph_row;
21254 /* The next row should by default use the same value of the
21255 reversed_p flag as this one. set_iterator_to_next decides when
21256 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
21257 the flag accordingly. */
21258 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
21259 it->glyph_row->reversed_p = row->reversed_p;
21260 it->start = row->end;
21261 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
21262
21263 #undef RECORD_MAX_MIN_POS
21264 }
21265
21266 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
21267 Scurrent_bidi_paragraph_direction, 0, 1, 0,
21268 doc: /* Return paragraph direction at point in BUFFER.
21269 Value is either `left-to-right' or `right-to-left'.
21270 If BUFFER is omitted or nil, it defaults to the current buffer.
21271
21272 Paragraph direction determines how the text in the paragraph is displayed.
21273 In left-to-right paragraphs, text begins at the left margin of the window
21274 and the reading direction is generally left to right. In right-to-left
21275 paragraphs, text begins at the right margin and is read from right to left.
21276
21277 See also `bidi-paragraph-direction'. */)
21278 (Lisp_Object buffer)
21279 {
21280 struct buffer *buf = current_buffer;
21281 struct buffer *old = buf;
21282
21283 if (! NILP (buffer))
21284 {
21285 CHECK_BUFFER (buffer);
21286 buf = XBUFFER (buffer);
21287 }
21288
21289 if (NILP (BVAR (buf, bidi_display_reordering))
21290 || NILP (BVAR (buf, enable_multibyte_characters))
21291 /* When we are loading loadup.el, the character property tables
21292 needed for bidi iteration are not yet available. */
21293 || redisplay__inhibit_bidi)
21294 return Qleft_to_right;
21295 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
21296 return BVAR (buf, bidi_paragraph_direction);
21297 else
21298 {
21299 /* Determine the direction from buffer text. We could try to
21300 use current_matrix if it is up to date, but this seems fast
21301 enough as it is. */
21302 struct bidi_it itb;
21303 ptrdiff_t pos = BUF_PT (buf);
21304 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
21305 int c;
21306 void *itb_data = bidi_shelve_cache ();
21307
21308 set_buffer_temp (buf);
21309 /* bidi_paragraph_init finds the base direction of the paragraph
21310 by searching forward from paragraph start. We need the base
21311 direction of the current or _previous_ paragraph, so we need
21312 to make sure we are within that paragraph. To that end, find
21313 the previous non-empty line. */
21314 if (pos >= ZV && pos > BEGV)
21315 DEC_BOTH (pos, bytepos);
21316 AUTO_STRING (trailing_white_space, "[\f\t ]*\n");
21317 if (fast_looking_at (trailing_white_space,
21318 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
21319 {
21320 while ((c = FETCH_BYTE (bytepos)) == '\n'
21321 || c == ' ' || c == '\t' || c == '\f')
21322 {
21323 if (bytepos <= BEGV_BYTE)
21324 break;
21325 bytepos--;
21326 pos--;
21327 }
21328 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
21329 bytepos--;
21330 }
21331 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
21332 itb.paragraph_dir = NEUTRAL_DIR;
21333 itb.string.s = NULL;
21334 itb.string.lstring = Qnil;
21335 itb.string.bufpos = 0;
21336 itb.string.from_disp_str = false;
21337 itb.string.unibyte = false;
21338 /* We have no window to use here for ignoring window-specific
21339 overlays. Using NULL for window pointer will cause
21340 compute_display_string_pos to use the current buffer. */
21341 itb.w = NULL;
21342 bidi_paragraph_init (NEUTRAL_DIR, &itb, true);
21343 bidi_unshelve_cache (itb_data, false);
21344 set_buffer_temp (old);
21345 switch (itb.paragraph_dir)
21346 {
21347 case L2R:
21348 return Qleft_to_right;
21349 break;
21350 case R2L:
21351 return Qright_to_left;
21352 break;
21353 default:
21354 emacs_abort ();
21355 }
21356 }
21357 }
21358
21359 DEFUN ("bidi-find-overridden-directionality",
21360 Fbidi_find_overridden_directionality,
21361 Sbidi_find_overridden_directionality, 2, 3, 0,
21362 doc: /* Return position between FROM and TO where directionality was overridden.
21363
21364 This function returns the first character position in the specified
21365 region of OBJECT where there is a character whose `bidi-class' property
21366 is `L', but which was forced to display as `R' by a directional
21367 override, and likewise with characters whose `bidi-class' is `R'
21368 or `AL' that were forced to display as `L'.
21369
21370 If no such character is found, the function returns nil.
21371
21372 OBJECT is a Lisp string or buffer to search for overridden
21373 directionality, and defaults to the current buffer if nil or omitted.
21374 OBJECT can also be a window, in which case the function will search
21375 the buffer displayed in that window. Passing the window instead of
21376 a buffer is preferable when the buffer is displayed in some window,
21377 because this function will then be able to correctly account for
21378 window-specific overlays, which can affect the results.
21379
21380 Strong directional characters `L', `R', and `AL' can have their
21381 intrinsic directionality overridden by directional override
21382 control characters RLO (u+202e) and LRO (u+202d). See the
21383 function `get-char-code-property' for a way to inquire about
21384 the `bidi-class' property of a character. */)
21385 (Lisp_Object from, Lisp_Object to, Lisp_Object object)
21386 {
21387 struct buffer *buf = current_buffer;
21388 struct buffer *old = buf;
21389 struct window *w = NULL;
21390 bool frame_window_p = FRAME_WINDOW_P (SELECTED_FRAME ());
21391 struct bidi_it itb;
21392 ptrdiff_t from_pos, to_pos, from_bpos;
21393 void *itb_data;
21394
21395 if (!NILP (object))
21396 {
21397 if (BUFFERP (object))
21398 buf = XBUFFER (object);
21399 else if (WINDOWP (object))
21400 {
21401 w = decode_live_window (object);
21402 buf = XBUFFER (w->contents);
21403 frame_window_p = FRAME_WINDOW_P (XFRAME (w->frame));
21404 }
21405 else
21406 CHECK_STRING (object);
21407 }
21408
21409 if (STRINGP (object))
21410 {
21411 /* Characters in unibyte strings are always treated by bidi.c as
21412 strong LTR. */
21413 if (!STRING_MULTIBYTE (object)
21414 /* When we are loading loadup.el, the character property
21415 tables needed for bidi iteration are not yet
21416 available. */
21417 || redisplay__inhibit_bidi)
21418 return Qnil;
21419
21420 validate_subarray (object, from, to, SCHARS (object), &from_pos, &to_pos);
21421 if (from_pos >= SCHARS (object))
21422 return Qnil;
21423
21424 /* Set up the bidi iterator. */
21425 itb_data = bidi_shelve_cache ();
21426 itb.paragraph_dir = NEUTRAL_DIR;
21427 itb.string.lstring = object;
21428 itb.string.s = NULL;
21429 itb.string.schars = SCHARS (object);
21430 itb.string.bufpos = 0;
21431 itb.string.from_disp_str = false;
21432 itb.string.unibyte = false;
21433 itb.w = w;
21434 bidi_init_it (0, 0, frame_window_p, &itb);
21435 }
21436 else
21437 {
21438 /* Nothing this fancy can happen in unibyte buffers, or in a
21439 buffer that disabled reordering, or if FROM is at EOB. */
21440 if (NILP (BVAR (buf, bidi_display_reordering))
21441 || NILP (BVAR (buf, enable_multibyte_characters))
21442 /* When we are loading loadup.el, the character property
21443 tables needed for bidi iteration are not yet
21444 available. */
21445 || redisplay__inhibit_bidi)
21446 return Qnil;
21447
21448 set_buffer_temp (buf);
21449 validate_region (&from, &to);
21450 from_pos = XINT (from);
21451 to_pos = XINT (to);
21452 if (from_pos >= ZV)
21453 return Qnil;
21454
21455 /* Set up the bidi iterator. */
21456 itb_data = bidi_shelve_cache ();
21457 from_bpos = CHAR_TO_BYTE (from_pos);
21458 if (from_pos == BEGV)
21459 {
21460 itb.charpos = BEGV;
21461 itb.bytepos = BEGV_BYTE;
21462 }
21463 else if (FETCH_CHAR (from_bpos - 1) == '\n')
21464 {
21465 itb.charpos = from_pos;
21466 itb.bytepos = from_bpos;
21467 }
21468 else
21469 itb.charpos = find_newline_no_quit (from_pos, CHAR_TO_BYTE (from_pos),
21470 -1, &itb.bytepos);
21471 itb.paragraph_dir = NEUTRAL_DIR;
21472 itb.string.s = NULL;
21473 itb.string.lstring = Qnil;
21474 itb.string.bufpos = 0;
21475 itb.string.from_disp_str = false;
21476 itb.string.unibyte = false;
21477 itb.w = w;
21478 bidi_init_it (itb.charpos, itb.bytepos, frame_window_p, &itb);
21479 }
21480
21481 ptrdiff_t found;
21482 do {
21483 /* For the purposes of this function, the actual base direction of
21484 the paragraph doesn't matter, so just set it to L2R. */
21485 bidi_paragraph_init (L2R, &itb, false);
21486 while ((found = bidi_find_first_overridden (&itb)) < from_pos)
21487 ;
21488 } while (found == ZV && itb.ch == '\n' && itb.charpos < to_pos);
21489
21490 bidi_unshelve_cache (itb_data, false);
21491 set_buffer_temp (old);
21492
21493 return (from_pos <= found && found < to_pos) ? make_number (found) : Qnil;
21494 }
21495
21496 DEFUN ("move-point-visually", Fmove_point_visually,
21497 Smove_point_visually, 1, 1, 0,
21498 doc: /* Move point in the visual order in the specified DIRECTION.
21499 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21500 left.
21501
21502 Value is the new character position of point. */)
21503 (Lisp_Object direction)
21504 {
21505 struct window *w = XWINDOW (selected_window);
21506 struct buffer *b = XBUFFER (w->contents);
21507 struct glyph_row *row;
21508 int dir;
21509 Lisp_Object paragraph_dir;
21510
21511 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21512 (!(ROW)->continued_p \
21513 && NILP ((GLYPH)->object) \
21514 && (GLYPH)->type == CHAR_GLYPH \
21515 && (GLYPH)->u.ch == ' ' \
21516 && (GLYPH)->charpos >= 0 \
21517 && !(GLYPH)->avoid_cursor_p)
21518
21519 CHECK_NUMBER (direction);
21520 dir = XINT (direction);
21521 if (dir > 0)
21522 dir = 1;
21523 else
21524 dir = -1;
21525
21526 /* If current matrix is up-to-date, we can use the information
21527 recorded in the glyphs, at least as long as the goal is on the
21528 screen. */
21529 if (w->window_end_valid
21530 && !windows_or_buffers_changed
21531 && b
21532 && !b->clip_changed
21533 && !b->prevent_redisplay_optimizations_p
21534 && !window_outdated (w)
21535 /* We rely below on the cursor coordinates to be up to date, but
21536 we cannot trust them if some command moved point since the
21537 last complete redisplay. */
21538 && w->last_point == BUF_PT (b)
21539 && w->cursor.vpos >= 0
21540 && w->cursor.vpos < w->current_matrix->nrows
21541 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
21542 {
21543 struct glyph *g = row->glyphs[TEXT_AREA];
21544 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
21545 struct glyph *gpt = g + w->cursor.hpos;
21546
21547 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
21548 {
21549 if (BUFFERP (g->object) && g->charpos != PT)
21550 {
21551 SET_PT (g->charpos);
21552 w->cursor.vpos = -1;
21553 return make_number (PT);
21554 }
21555 else if (!NILP (g->object) && !EQ (g->object, gpt->object))
21556 {
21557 ptrdiff_t new_pos;
21558
21559 if (BUFFERP (gpt->object))
21560 {
21561 new_pos = PT;
21562 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
21563 new_pos += (row->reversed_p ? -dir : dir);
21564 else
21565 new_pos -= (row->reversed_p ? -dir : dir);
21566 }
21567 else if (BUFFERP (g->object))
21568 new_pos = g->charpos;
21569 else
21570 break;
21571 SET_PT (new_pos);
21572 w->cursor.vpos = -1;
21573 return make_number (PT);
21574 }
21575 else if (ROW_GLYPH_NEWLINE_P (row, g))
21576 {
21577 /* Glyphs inserted at the end of a non-empty line for
21578 positioning the cursor have zero charpos, so we must
21579 deduce the value of point by other means. */
21580 if (g->charpos > 0)
21581 SET_PT (g->charpos);
21582 else if (row->ends_at_zv_p && PT != ZV)
21583 SET_PT (ZV);
21584 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
21585 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21586 else
21587 break;
21588 w->cursor.vpos = -1;
21589 return make_number (PT);
21590 }
21591 }
21592 if (g == e || NILP (g->object))
21593 {
21594 if (row->truncated_on_left_p || row->truncated_on_right_p)
21595 goto simulate_display;
21596 if (!row->reversed_p)
21597 row += dir;
21598 else
21599 row -= dir;
21600 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
21601 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
21602 goto simulate_display;
21603
21604 if (dir > 0)
21605 {
21606 if (row->reversed_p && !row->continued_p)
21607 {
21608 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21609 w->cursor.vpos = -1;
21610 return make_number (PT);
21611 }
21612 g = row->glyphs[TEXT_AREA];
21613 e = g + row->used[TEXT_AREA];
21614 for ( ; g < e; g++)
21615 {
21616 if (BUFFERP (g->object)
21617 /* Empty lines have only one glyph, which stands
21618 for the newline, and whose charpos is the
21619 buffer position of the newline. */
21620 || ROW_GLYPH_NEWLINE_P (row, g)
21621 /* When the buffer ends in a newline, the line at
21622 EOB also has one glyph, but its charpos is -1. */
21623 || (row->ends_at_zv_p
21624 && !row->reversed_p
21625 && NILP (g->object)
21626 && g->type == CHAR_GLYPH
21627 && g->u.ch == ' '))
21628 {
21629 if (g->charpos > 0)
21630 SET_PT (g->charpos);
21631 else if (!row->reversed_p
21632 && row->ends_at_zv_p
21633 && PT != ZV)
21634 SET_PT (ZV);
21635 else
21636 continue;
21637 w->cursor.vpos = -1;
21638 return make_number (PT);
21639 }
21640 }
21641 }
21642 else
21643 {
21644 if (!row->reversed_p && !row->continued_p)
21645 {
21646 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21647 w->cursor.vpos = -1;
21648 return make_number (PT);
21649 }
21650 e = row->glyphs[TEXT_AREA];
21651 g = e + row->used[TEXT_AREA] - 1;
21652 for ( ; g >= e; g--)
21653 {
21654 if (BUFFERP (g->object)
21655 || (ROW_GLYPH_NEWLINE_P (row, g)
21656 && g->charpos > 0)
21657 /* Empty R2L lines on GUI frames have the buffer
21658 position of the newline stored in the stretch
21659 glyph. */
21660 || g->type == STRETCH_GLYPH
21661 || (row->ends_at_zv_p
21662 && row->reversed_p
21663 && NILP (g->object)
21664 && g->type == CHAR_GLYPH
21665 && g->u.ch == ' '))
21666 {
21667 if (g->charpos > 0)
21668 SET_PT (g->charpos);
21669 else if (row->reversed_p
21670 && row->ends_at_zv_p
21671 && PT != ZV)
21672 SET_PT (ZV);
21673 else
21674 continue;
21675 w->cursor.vpos = -1;
21676 return make_number (PT);
21677 }
21678 }
21679 }
21680 }
21681 }
21682
21683 simulate_display:
21684
21685 /* If we wind up here, we failed to move by using the glyphs, so we
21686 need to simulate display instead. */
21687
21688 if (b)
21689 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
21690 else
21691 paragraph_dir = Qleft_to_right;
21692 if (EQ (paragraph_dir, Qright_to_left))
21693 dir = -dir;
21694 if (PT <= BEGV && dir < 0)
21695 xsignal0 (Qbeginning_of_buffer);
21696 else if (PT >= ZV && dir > 0)
21697 xsignal0 (Qend_of_buffer);
21698 else
21699 {
21700 struct text_pos pt;
21701 struct it it;
21702 int pt_x, target_x, pixel_width, pt_vpos;
21703 bool at_eol_p;
21704 bool overshoot_expected = false;
21705 bool target_is_eol_p = false;
21706
21707 /* Setup the arena. */
21708 SET_TEXT_POS (pt, PT, PT_BYTE);
21709 start_display (&it, w, pt);
21710 /* When lines are truncated, we could be called with point
21711 outside of the windows edges, in which case move_it_*
21712 functions either prematurely stop at window's edge or jump to
21713 the next screen line, whereas we rely below on our ability to
21714 reach point, in order to start from its X coordinate. So we
21715 need to disregard the window's horizontal extent in that case. */
21716 if (it.line_wrap == TRUNCATE)
21717 it.last_visible_x = INFINITY;
21718
21719 if (it.cmp_it.id < 0
21720 && it.method == GET_FROM_STRING
21721 && it.area == TEXT_AREA
21722 && it.string_from_display_prop_p
21723 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
21724 overshoot_expected = true;
21725
21726 /* Find the X coordinate of point. We start from the beginning
21727 of this or previous line to make sure we are before point in
21728 the logical order (since the move_it_* functions can only
21729 move forward). */
21730 reseat:
21731 reseat_at_previous_visible_line_start (&it);
21732 it.current_x = it.hpos = it.current_y = it.vpos = 0;
21733 if (IT_CHARPOS (it) != PT)
21734 {
21735 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
21736 -1, -1, -1, MOVE_TO_POS);
21737 /* If we missed point because the character there is
21738 displayed out of a display vector that has more than one
21739 glyph, retry expecting overshoot. */
21740 if (it.method == GET_FROM_DISPLAY_VECTOR
21741 && it.current.dpvec_index > 0
21742 && !overshoot_expected)
21743 {
21744 overshoot_expected = true;
21745 goto reseat;
21746 }
21747 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
21748 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
21749 }
21750 pt_x = it.current_x;
21751 pt_vpos = it.vpos;
21752 if (dir > 0 || overshoot_expected)
21753 {
21754 struct glyph_row *row = it.glyph_row;
21755
21756 /* When point is at beginning of line, we don't have
21757 information about the glyph there loaded into struct
21758 it. Calling get_next_display_element fixes that. */
21759 if (pt_x == 0)
21760 get_next_display_element (&it);
21761 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21762 it.glyph_row = NULL;
21763 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
21764 it.glyph_row = row;
21765 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21766 it, lest it will become out of sync with it's buffer
21767 position. */
21768 it.current_x = pt_x;
21769 }
21770 else
21771 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21772 pixel_width = it.pixel_width;
21773 if (overshoot_expected && at_eol_p)
21774 pixel_width = 0;
21775 else if (pixel_width <= 0)
21776 pixel_width = 1;
21777
21778 /* If there's a display string (or something similar) at point,
21779 we are actually at the glyph to the left of point, so we need
21780 to correct the X coordinate. */
21781 if (overshoot_expected)
21782 {
21783 if (it.bidi_p)
21784 pt_x += pixel_width * it.bidi_it.scan_dir;
21785 else
21786 pt_x += pixel_width;
21787 }
21788
21789 /* Compute target X coordinate, either to the left or to the
21790 right of point. On TTY frames, all characters have the same
21791 pixel width of 1, so we can use that. On GUI frames we don't
21792 have an easy way of getting at the pixel width of the
21793 character to the left of point, so we use a different method
21794 of getting to that place. */
21795 if (dir > 0)
21796 target_x = pt_x + pixel_width;
21797 else
21798 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
21799
21800 /* Target X coordinate could be one line above or below the line
21801 of point, in which case we need to adjust the target X
21802 coordinate. Also, if moving to the left, we need to begin at
21803 the left edge of the point's screen line. */
21804 if (dir < 0)
21805 {
21806 if (pt_x > 0)
21807 {
21808 start_display (&it, w, pt);
21809 if (it.line_wrap == TRUNCATE)
21810 it.last_visible_x = INFINITY;
21811 reseat_at_previous_visible_line_start (&it);
21812 it.current_x = it.current_y = it.hpos = 0;
21813 if (pt_vpos != 0)
21814 move_it_by_lines (&it, pt_vpos);
21815 }
21816 else
21817 {
21818 move_it_by_lines (&it, -1);
21819 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
21820 target_is_eol_p = true;
21821 /* Under word-wrap, we don't know the x coordinate of
21822 the last character displayed on the previous line,
21823 which immediately precedes the wrap point. To find
21824 out its x coordinate, we try moving to the right
21825 margin of the window, which will stop at the wrap
21826 point, and then reset target_x to point at the
21827 character that precedes the wrap point. This is not
21828 needed on GUI frames, because (see below) there we
21829 move from the left margin one grapheme cluster at a
21830 time, and stop when we hit the wrap point. */
21831 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
21832 {
21833 void *it_data = NULL;
21834 struct it it2;
21835
21836 SAVE_IT (it2, it, it_data);
21837 move_it_in_display_line_to (&it, ZV, target_x,
21838 MOVE_TO_POS | MOVE_TO_X);
21839 /* If we arrived at target_x, that _is_ the last
21840 character on the previous line. */
21841 if (it.current_x != target_x)
21842 target_x = it.current_x - 1;
21843 RESTORE_IT (&it, &it2, it_data);
21844 }
21845 }
21846 }
21847 else
21848 {
21849 if (at_eol_p
21850 || (target_x >= it.last_visible_x
21851 && it.line_wrap != TRUNCATE))
21852 {
21853 if (pt_x > 0)
21854 move_it_by_lines (&it, 0);
21855 move_it_by_lines (&it, 1);
21856 target_x = 0;
21857 }
21858 }
21859
21860 /* Move to the target X coordinate. */
21861 /* On GUI frames, as we don't know the X coordinate of the
21862 character to the left of point, moving point to the left
21863 requires walking, one grapheme cluster at a time, until we
21864 find ourself at a place immediately to the left of the
21865 character at point. */
21866 if (FRAME_WINDOW_P (it.f) && dir < 0)
21867 {
21868 struct text_pos new_pos;
21869 enum move_it_result rc = MOVE_X_REACHED;
21870
21871 if (it.current_x == 0)
21872 get_next_display_element (&it);
21873 if (it.what == IT_COMPOSITION)
21874 {
21875 new_pos.charpos = it.cmp_it.charpos;
21876 new_pos.bytepos = -1;
21877 }
21878 else
21879 new_pos = it.current.pos;
21880
21881 while (it.current_x + it.pixel_width <= target_x
21882 && (rc == MOVE_X_REACHED
21883 /* Under word-wrap, move_it_in_display_line_to
21884 stops at correct coordinates, but sometimes
21885 returns MOVE_POS_MATCH_OR_ZV. */
21886 || (it.line_wrap == WORD_WRAP
21887 && rc == MOVE_POS_MATCH_OR_ZV)))
21888 {
21889 int new_x = it.current_x + it.pixel_width;
21890
21891 /* For composed characters, we want the position of the
21892 first character in the grapheme cluster (usually, the
21893 composition's base character), whereas it.current
21894 might give us the position of the _last_ one, e.g. if
21895 the composition is rendered in reverse due to bidi
21896 reordering. */
21897 if (it.what == IT_COMPOSITION)
21898 {
21899 new_pos.charpos = it.cmp_it.charpos;
21900 new_pos.bytepos = -1;
21901 }
21902 else
21903 new_pos = it.current.pos;
21904 if (new_x == it.current_x)
21905 new_x++;
21906 rc = move_it_in_display_line_to (&it, ZV, new_x,
21907 MOVE_TO_POS | MOVE_TO_X);
21908 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21909 break;
21910 }
21911 /* The previous position we saw in the loop is the one we
21912 want. */
21913 if (new_pos.bytepos == -1)
21914 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21915 it.current.pos = new_pos;
21916 }
21917 else if (it.current_x != target_x)
21918 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21919
21920 /* If we ended up in a display string that covers point, move to
21921 buffer position to the right in the visual order. */
21922 if (dir > 0)
21923 {
21924 while (IT_CHARPOS (it) == PT)
21925 {
21926 set_iterator_to_next (&it, false);
21927 if (!get_next_display_element (&it))
21928 break;
21929 }
21930 }
21931
21932 /* Move point to that position. */
21933 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21934 }
21935
21936 return make_number (PT);
21937
21938 #undef ROW_GLYPH_NEWLINE_P
21939 }
21940
21941 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels,
21942 Sbidi_resolved_levels, 0, 1, 0,
21943 doc: /* Return the resolved bidirectional levels of characters at VPOS.
21944
21945 The resolved levels are produced by the Emacs bidi reordering engine
21946 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21947 read the Unicode Standard Annex 9 (UAX#9) for background information
21948 about these levels.
21949
21950 VPOS is the zero-based number of the current window's screen line
21951 for which to produce the resolved levels. If VPOS is nil or omitted,
21952 it defaults to the screen line of point. If the window displays a
21953 header line, VPOS of zero will report on the header line, and first
21954 line of text in the window will have VPOS of 1.
21955
21956 Value is an array of resolved levels, indexed by glyph number.
21957 Glyphs are numbered from zero starting from the beginning of the
21958 screen line, i.e. the left edge of the window for left-to-right lines
21959 and from the right edge for right-to-left lines. The resolved levels
21960 are produced only for the window's text area; text in display margins
21961 is not included.
21962
21963 If the selected window's display is not up-to-date, or if the specified
21964 screen line does not display text, this function returns nil. It is
21965 highly recommended to bind this function to some simple key, like F8,
21966 in order to avoid these problems.
21967
21968 This function exists mainly for testing the correctness of the
21969 Emacs UBA implementation, in particular with the test suite. */)
21970 (Lisp_Object vpos)
21971 {
21972 struct window *w = XWINDOW (selected_window);
21973 struct buffer *b = XBUFFER (w->contents);
21974 int nrow;
21975 struct glyph_row *row;
21976
21977 if (NILP (vpos))
21978 {
21979 int d1, d2, d3, d4, d5;
21980
21981 pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &nrow);
21982 }
21983 else
21984 {
21985 CHECK_NUMBER_COERCE_MARKER (vpos);
21986 nrow = XINT (vpos);
21987 }
21988
21989 /* We require up-to-date glyph matrix for this window. */
21990 if (w->window_end_valid
21991 && !windows_or_buffers_changed
21992 && b
21993 && !b->clip_changed
21994 && !b->prevent_redisplay_optimizations_p
21995 && !window_outdated (w)
21996 && nrow >= 0
21997 && nrow < w->current_matrix->nrows
21998 && (row = MATRIX_ROW (w->current_matrix, nrow))->enabled_p
21999 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
22000 {
22001 struct glyph *g, *e, *g1;
22002 int nglyphs, i;
22003 Lisp_Object levels;
22004
22005 if (!row->reversed_p) /* Left-to-right glyph row. */
22006 {
22007 g = g1 = row->glyphs[TEXT_AREA];
22008 e = g + row->used[TEXT_AREA];
22009
22010 /* Skip over glyphs at the start of the row that was
22011 generated by redisplay for its own needs. */
22012 while (g < e
22013 && NILP (g->object)
22014 && g->charpos < 0)
22015 g++;
22016 g1 = g;
22017
22018 /* Count the "interesting" glyphs in this row. */
22019 for (nglyphs = 0; g < e && !NILP (g->object); g++)
22020 nglyphs++;
22021
22022 /* Create and fill the array. */
22023 levels = make_uninit_vector (nglyphs);
22024 for (i = 0; g1 < g; i++, g1++)
22025 ASET (levels, i, make_number (g1->resolved_level));
22026 }
22027 else /* Right-to-left glyph row. */
22028 {
22029 g = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
22030 e = row->glyphs[TEXT_AREA] - 1;
22031 while (g > e
22032 && NILP (g->object)
22033 && g->charpos < 0)
22034 g--;
22035 g1 = g;
22036 for (nglyphs = 0; g > e && !NILP (g->object); g--)
22037 nglyphs++;
22038 levels = make_uninit_vector (nglyphs);
22039 for (i = 0; g1 > g; i++, g1--)
22040 ASET (levels, i, make_number (g1->resolved_level));
22041 }
22042 return levels;
22043 }
22044 else
22045 return Qnil;
22046 }
22047
22048
22049 \f
22050 /***********************************************************************
22051 Menu Bar
22052 ***********************************************************************/
22053
22054 /* Redisplay the menu bar in the frame for window W.
22055
22056 The menu bar of X frames that don't have X toolkit support is
22057 displayed in a special window W->frame->menu_bar_window.
22058
22059 The menu bar of terminal frames is treated specially as far as
22060 glyph matrices are concerned. Menu bar lines are not part of
22061 windows, so the update is done directly on the frame matrix rows
22062 for the menu bar. */
22063
22064 static void
22065 display_menu_bar (struct window *w)
22066 {
22067 struct frame *f = XFRAME (WINDOW_FRAME (w));
22068 struct it it;
22069 Lisp_Object items;
22070 int i;
22071
22072 /* Don't do all this for graphical frames. */
22073 #ifdef HAVE_NTGUI
22074 if (FRAME_W32_P (f))
22075 return;
22076 #endif
22077 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22078 if (FRAME_X_P (f))
22079 return;
22080 #endif
22081
22082 #ifdef HAVE_NS
22083 if (FRAME_NS_P (f))
22084 return;
22085 #endif /* HAVE_NS */
22086
22087 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
22088 eassert (!FRAME_WINDOW_P (f));
22089 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
22090 it.first_visible_x = 0;
22091 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
22092 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
22093 if (FRAME_WINDOW_P (f))
22094 {
22095 /* Menu bar lines are displayed in the desired matrix of the
22096 dummy window menu_bar_window. */
22097 struct window *menu_w;
22098 menu_w = XWINDOW (f->menu_bar_window);
22099 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
22100 MENU_FACE_ID);
22101 it.first_visible_x = 0;
22102 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
22103 }
22104 else
22105 #endif /* not USE_X_TOOLKIT and not USE_GTK */
22106 {
22107 /* This is a TTY frame, i.e. character hpos/vpos are used as
22108 pixel x/y. */
22109 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
22110 MENU_FACE_ID);
22111 it.first_visible_x = 0;
22112 it.last_visible_x = FRAME_COLS (f);
22113 }
22114
22115 /* FIXME: This should be controlled by a user option. See the
22116 comments in redisplay_tool_bar and display_mode_line about
22117 this. */
22118 it.paragraph_embedding = L2R;
22119
22120 /* Clear all rows of the menu bar. */
22121 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
22122 {
22123 struct glyph_row *row = it.glyph_row + i;
22124 clear_glyph_row (row);
22125 row->enabled_p = true;
22126 row->full_width_p = true;
22127 row->reversed_p = false;
22128 }
22129
22130 /* Display all items of the menu bar. */
22131 items = FRAME_MENU_BAR_ITEMS (it.f);
22132 for (i = 0; i < ASIZE (items); i += 4)
22133 {
22134 Lisp_Object string;
22135
22136 /* Stop at nil string. */
22137 string = AREF (items, i + 1);
22138 if (NILP (string))
22139 break;
22140
22141 /* Remember where item was displayed. */
22142 ASET (items, i + 3, make_number (it.hpos));
22143
22144 /* Display the item, pad with one space. */
22145 if (it.current_x < it.last_visible_x)
22146 display_string (NULL, string, Qnil, 0, 0, &it,
22147 SCHARS (string) + 1, 0, 0, -1);
22148 }
22149
22150 /* Fill out the line with spaces. */
22151 if (it.current_x < it.last_visible_x)
22152 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
22153
22154 /* Compute the total height of the lines. */
22155 compute_line_metrics (&it);
22156 }
22157
22158 /* Deep copy of a glyph row, including the glyphs. */
22159 static void
22160 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
22161 {
22162 struct glyph *pointers[1 + LAST_AREA];
22163 int to_used = to->used[TEXT_AREA];
22164
22165 /* Save glyph pointers of TO. */
22166 memcpy (pointers, to->glyphs, sizeof to->glyphs);
22167
22168 /* Do a structure assignment. */
22169 *to = *from;
22170
22171 /* Restore original glyph pointers of TO. */
22172 memcpy (to->glyphs, pointers, sizeof to->glyphs);
22173
22174 /* Copy the glyphs. */
22175 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
22176 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
22177
22178 /* If we filled only part of the TO row, fill the rest with
22179 space_glyph (which will display as empty space). */
22180 if (to_used > from->used[TEXT_AREA])
22181 fill_up_frame_row_with_spaces (to, to_used);
22182 }
22183
22184 /* Display one menu item on a TTY, by overwriting the glyphs in the
22185 frame F's desired glyph matrix with glyphs produced from the menu
22186 item text. Called from term.c to display TTY drop-down menus one
22187 item at a time.
22188
22189 ITEM_TEXT is the menu item text as a C string.
22190
22191 FACE_ID is the face ID to be used for this menu item. FACE_ID
22192 could specify one of 3 faces: a face for an enabled item, a face
22193 for a disabled item, or a face for a selected item.
22194
22195 X and Y are coordinates of the first glyph in the frame's desired
22196 matrix to be overwritten by the menu item. Since this is a TTY, Y
22197 is the zero-based number of the glyph row and X is the zero-based
22198 glyph number in the row, starting from left, where to start
22199 displaying the item.
22200
22201 SUBMENU means this menu item drops down a submenu, which
22202 should be indicated by displaying a proper visual cue after the
22203 item text. */
22204
22205 void
22206 display_tty_menu_item (const char *item_text, int width, int face_id,
22207 int x, int y, bool submenu)
22208 {
22209 struct it it;
22210 struct frame *f = SELECTED_FRAME ();
22211 struct window *w = XWINDOW (f->selected_window);
22212 struct glyph_row *row;
22213 size_t item_len = strlen (item_text);
22214
22215 eassert (FRAME_TERMCAP_P (f));
22216
22217 /* Don't write beyond the matrix's last row. This can happen for
22218 TTY screens that are not high enough to show the entire menu.
22219 (This is actually a bit of defensive programming, as
22220 tty_menu_display already limits the number of menu items to one
22221 less than the number of screen lines.) */
22222 if (y >= f->desired_matrix->nrows)
22223 return;
22224
22225 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
22226 it.first_visible_x = 0;
22227 it.last_visible_x = FRAME_COLS (f) - 1;
22228 row = it.glyph_row;
22229 /* Start with the row contents from the current matrix. */
22230 deep_copy_glyph_row (row, f->current_matrix->rows + y);
22231 bool saved_width = row->full_width_p;
22232 row->full_width_p = true;
22233 bool saved_reversed = row->reversed_p;
22234 row->reversed_p = false;
22235 row->enabled_p = true;
22236
22237 /* Arrange for the menu item glyphs to start at (X,Y) and have the
22238 desired face. */
22239 eassert (x < f->desired_matrix->matrix_w);
22240 it.current_x = it.hpos = x;
22241 it.current_y = it.vpos = y;
22242 int saved_used = row->used[TEXT_AREA];
22243 bool saved_truncated = row->truncated_on_right_p;
22244 row->used[TEXT_AREA] = x;
22245 it.face_id = face_id;
22246 it.line_wrap = TRUNCATE;
22247
22248 /* FIXME: This should be controlled by a user option. See the
22249 comments in redisplay_tool_bar and display_mode_line about this.
22250 Also, if paragraph_embedding could ever be R2L, changes will be
22251 needed to avoid shifting to the right the row characters in
22252 term.c:append_glyph. */
22253 it.paragraph_embedding = L2R;
22254
22255 /* Pad with a space on the left. */
22256 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
22257 width--;
22258 /* Display the menu item, pad with spaces to WIDTH. */
22259 if (submenu)
22260 {
22261 display_string (item_text, Qnil, Qnil, 0, 0, &it,
22262 item_len, 0, FRAME_COLS (f) - 1, -1);
22263 width -= item_len;
22264 /* Indicate with " >" that there's a submenu. */
22265 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
22266 FRAME_COLS (f) - 1, -1);
22267 }
22268 else
22269 display_string (item_text, Qnil, Qnil, 0, 0, &it,
22270 width, 0, FRAME_COLS (f) - 1, -1);
22271
22272 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
22273 row->truncated_on_right_p = saved_truncated;
22274 row->hash = row_hash (row);
22275 row->full_width_p = saved_width;
22276 row->reversed_p = saved_reversed;
22277 }
22278 \f
22279 /***********************************************************************
22280 Mode Line
22281 ***********************************************************************/
22282
22283 /* Redisplay mode lines in the window tree whose root is WINDOW.
22284 If FORCE, redisplay mode lines unconditionally.
22285 Otherwise, redisplay only mode lines that are garbaged. Value is
22286 the number of windows whose mode lines were redisplayed. */
22287
22288 static int
22289 redisplay_mode_lines (Lisp_Object window, bool force)
22290 {
22291 int nwindows = 0;
22292
22293 while (!NILP (window))
22294 {
22295 struct window *w = XWINDOW (window);
22296
22297 if (WINDOWP (w->contents))
22298 nwindows += redisplay_mode_lines (w->contents, force);
22299 else if (force
22300 || FRAME_GARBAGED_P (XFRAME (w->frame))
22301 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
22302 {
22303 struct text_pos lpoint;
22304 struct buffer *old = current_buffer;
22305
22306 /* Set the window's buffer for the mode line display. */
22307 SET_TEXT_POS (lpoint, PT, PT_BYTE);
22308 set_buffer_internal_1 (XBUFFER (w->contents));
22309
22310 /* Point refers normally to the selected window. For any
22311 other window, set up appropriate value. */
22312 if (!EQ (window, selected_window))
22313 {
22314 struct text_pos pt;
22315
22316 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
22317 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
22318 }
22319
22320 /* Display mode lines. */
22321 clear_glyph_matrix (w->desired_matrix);
22322 if (display_mode_lines (w))
22323 ++nwindows;
22324
22325 /* Restore old settings. */
22326 set_buffer_internal_1 (old);
22327 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
22328 }
22329
22330 window = w->next;
22331 }
22332
22333 return nwindows;
22334 }
22335
22336
22337 /* Display the mode and/or header line of window W. Value is the
22338 sum number of mode lines and header lines displayed. */
22339
22340 static int
22341 display_mode_lines (struct window *w)
22342 {
22343 Lisp_Object old_selected_window = selected_window;
22344 Lisp_Object old_selected_frame = selected_frame;
22345 Lisp_Object new_frame = w->frame;
22346 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
22347 int n = 0;
22348
22349 selected_frame = new_frame;
22350 /* FIXME: If we were to allow the mode-line's computation changing the buffer
22351 or window's point, then we'd need select_window_1 here as well. */
22352 XSETWINDOW (selected_window, w);
22353 XFRAME (new_frame)->selected_window = selected_window;
22354
22355 /* These will be set while the mode line specs are processed. */
22356 line_number_displayed = false;
22357 w->column_number_displayed = -1;
22358
22359 if (WINDOW_WANTS_MODELINE_P (w))
22360 {
22361 struct window *sel_w = XWINDOW (old_selected_window);
22362
22363 /* Select mode line face based on the real selected window. */
22364 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
22365 BVAR (current_buffer, mode_line_format));
22366 ++n;
22367 }
22368
22369 if (WINDOW_WANTS_HEADER_LINE_P (w))
22370 {
22371 display_mode_line (w, HEADER_LINE_FACE_ID,
22372 BVAR (current_buffer, header_line_format));
22373 ++n;
22374 }
22375
22376 XFRAME (new_frame)->selected_window = old_frame_selected_window;
22377 selected_frame = old_selected_frame;
22378 selected_window = old_selected_window;
22379 if (n > 0)
22380 w->must_be_updated_p = true;
22381 return n;
22382 }
22383
22384
22385 /* Display mode or header line of window W. FACE_ID specifies which
22386 line to display; it is either MODE_LINE_FACE_ID or
22387 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
22388 display. Value is the pixel height of the mode/header line
22389 displayed. */
22390
22391 static int
22392 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
22393 {
22394 struct it it;
22395 struct face *face;
22396 ptrdiff_t count = SPECPDL_INDEX ();
22397
22398 init_iterator (&it, w, -1, -1, NULL, face_id);
22399 /* Don't extend on a previously drawn mode-line.
22400 This may happen if called from pos_visible_p. */
22401 it.glyph_row->enabled_p = false;
22402 prepare_desired_row (w, it.glyph_row, true);
22403
22404 it.glyph_row->mode_line_p = true;
22405
22406 /* FIXME: This should be controlled by a user option. But
22407 supporting such an option is not trivial, since the mode line is
22408 made up of many separate strings. */
22409 it.paragraph_embedding = L2R;
22410
22411 record_unwind_protect (unwind_format_mode_line,
22412 format_mode_line_unwind_data (NULL, NULL,
22413 Qnil, false));
22414
22415 mode_line_target = MODE_LINE_DISPLAY;
22416
22417 /* Temporarily make frame's keyboard the current kboard so that
22418 kboard-local variables in the mode_line_format will get the right
22419 values. */
22420 push_kboard (FRAME_KBOARD (it.f));
22421 record_unwind_save_match_data ();
22422 display_mode_element (&it, 0, 0, 0, format, Qnil, false);
22423 pop_kboard ();
22424
22425 unbind_to (count, Qnil);
22426
22427 /* Fill up with spaces. */
22428 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
22429
22430 compute_line_metrics (&it);
22431 it.glyph_row->full_width_p = true;
22432 it.glyph_row->continued_p = false;
22433 it.glyph_row->truncated_on_left_p = false;
22434 it.glyph_row->truncated_on_right_p = false;
22435
22436 /* Make a 3D mode-line have a shadow at its right end. */
22437 face = FACE_FROM_ID (it.f, face_id);
22438 extend_face_to_end_of_line (&it);
22439 if (face->box != FACE_NO_BOX)
22440 {
22441 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
22442 + it.glyph_row->used[TEXT_AREA] - 1);
22443 last->right_box_line_p = true;
22444 }
22445
22446 return it.glyph_row->height;
22447 }
22448
22449 /* Move element ELT in LIST to the front of LIST.
22450 Return the updated list. */
22451
22452 static Lisp_Object
22453 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
22454 {
22455 register Lisp_Object tail, prev;
22456 register Lisp_Object tem;
22457
22458 tail = list;
22459 prev = Qnil;
22460 while (CONSP (tail))
22461 {
22462 tem = XCAR (tail);
22463
22464 if (EQ (elt, tem))
22465 {
22466 /* Splice out the link TAIL. */
22467 if (NILP (prev))
22468 list = XCDR (tail);
22469 else
22470 Fsetcdr (prev, XCDR (tail));
22471
22472 /* Now make it the first. */
22473 Fsetcdr (tail, list);
22474 return tail;
22475 }
22476 else
22477 prev = tail;
22478 tail = XCDR (tail);
22479 QUIT;
22480 }
22481
22482 /* Not found--return unchanged LIST. */
22483 return list;
22484 }
22485
22486 /* Contribute ELT to the mode line for window IT->w. How it
22487 translates into text depends on its data type.
22488
22489 IT describes the display environment in which we display, as usual.
22490
22491 DEPTH is the depth in recursion. It is used to prevent
22492 infinite recursion here.
22493
22494 FIELD_WIDTH is the number of characters the display of ELT should
22495 occupy in the mode line, and PRECISION is the maximum number of
22496 characters to display from ELT's representation. See
22497 display_string for details.
22498
22499 Returns the hpos of the end of the text generated by ELT.
22500
22501 PROPS is a property list to add to any string we encounter.
22502
22503 If RISKY, remove (disregard) any properties in any string
22504 we encounter, and ignore :eval and :propertize.
22505
22506 The global variable `mode_line_target' determines whether the
22507 output is passed to `store_mode_line_noprop',
22508 `store_mode_line_string', or `display_string'. */
22509
22510 static int
22511 display_mode_element (struct it *it, int depth, int field_width, int precision,
22512 Lisp_Object elt, Lisp_Object props, bool risky)
22513 {
22514 int n = 0, field, prec;
22515 bool literal = false;
22516
22517 tail_recurse:
22518 if (depth > 100)
22519 elt = build_string ("*too-deep*");
22520
22521 depth++;
22522
22523 switch (XTYPE (elt))
22524 {
22525 case Lisp_String:
22526 {
22527 /* A string: output it and check for %-constructs within it. */
22528 unsigned char c;
22529 ptrdiff_t offset = 0;
22530
22531 if (SCHARS (elt) > 0
22532 && (!NILP (props) || risky))
22533 {
22534 Lisp_Object oprops, aelt;
22535 oprops = Ftext_properties_at (make_number (0), elt);
22536
22537 /* If the starting string's properties are not what
22538 we want, translate the string. Also, if the string
22539 is risky, do that anyway. */
22540
22541 if (NILP (Fequal (props, oprops)) || risky)
22542 {
22543 /* If the starting string has properties,
22544 merge the specified ones onto the existing ones. */
22545 if (! NILP (oprops) && !risky)
22546 {
22547 Lisp_Object tem;
22548
22549 oprops = Fcopy_sequence (oprops);
22550 tem = props;
22551 while (CONSP (tem))
22552 {
22553 oprops = Fplist_put (oprops, XCAR (tem),
22554 XCAR (XCDR (tem)));
22555 tem = XCDR (XCDR (tem));
22556 }
22557 props = oprops;
22558 }
22559
22560 aelt = Fassoc (elt, mode_line_proptrans_alist);
22561 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
22562 {
22563 /* AELT is what we want. Move it to the front
22564 without consing. */
22565 elt = XCAR (aelt);
22566 mode_line_proptrans_alist
22567 = move_elt_to_front (aelt, mode_line_proptrans_alist);
22568 }
22569 else
22570 {
22571 Lisp_Object tem;
22572
22573 /* If AELT has the wrong props, it is useless.
22574 so get rid of it. */
22575 if (! NILP (aelt))
22576 mode_line_proptrans_alist
22577 = Fdelq (aelt, mode_line_proptrans_alist);
22578
22579 elt = Fcopy_sequence (elt);
22580 Fset_text_properties (make_number (0), Flength (elt),
22581 props, elt);
22582 /* Add this item to mode_line_proptrans_alist. */
22583 mode_line_proptrans_alist
22584 = Fcons (Fcons (elt, props),
22585 mode_line_proptrans_alist);
22586 /* Truncate mode_line_proptrans_alist
22587 to at most 50 elements. */
22588 tem = Fnthcdr (make_number (50),
22589 mode_line_proptrans_alist);
22590 if (! NILP (tem))
22591 XSETCDR (tem, Qnil);
22592 }
22593 }
22594 }
22595
22596 offset = 0;
22597
22598 if (literal)
22599 {
22600 prec = precision - n;
22601 switch (mode_line_target)
22602 {
22603 case MODE_LINE_NOPROP:
22604 case MODE_LINE_TITLE:
22605 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
22606 break;
22607 case MODE_LINE_STRING:
22608 n += store_mode_line_string (NULL, elt, true, 0, prec, Qnil);
22609 break;
22610 case MODE_LINE_DISPLAY:
22611 n += display_string (NULL, elt, Qnil, 0, 0, it,
22612 0, prec, 0, STRING_MULTIBYTE (elt));
22613 break;
22614 }
22615
22616 break;
22617 }
22618
22619 /* Handle the non-literal case. */
22620
22621 while ((precision <= 0 || n < precision)
22622 && SREF (elt, offset) != 0
22623 && (mode_line_target != MODE_LINE_DISPLAY
22624 || it->current_x < it->last_visible_x))
22625 {
22626 ptrdiff_t last_offset = offset;
22627
22628 /* Advance to end of string or next format specifier. */
22629 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
22630 ;
22631
22632 if (offset - 1 != last_offset)
22633 {
22634 ptrdiff_t nchars, nbytes;
22635
22636 /* Output to end of string or up to '%'. Field width
22637 is length of string. Don't output more than
22638 PRECISION allows us. */
22639 offset--;
22640
22641 prec = c_string_width (SDATA (elt) + last_offset,
22642 offset - last_offset, precision - n,
22643 &nchars, &nbytes);
22644
22645 switch (mode_line_target)
22646 {
22647 case MODE_LINE_NOPROP:
22648 case MODE_LINE_TITLE:
22649 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
22650 break;
22651 case MODE_LINE_STRING:
22652 {
22653 ptrdiff_t bytepos = last_offset;
22654 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22655 ptrdiff_t endpos = (precision <= 0
22656 ? string_byte_to_char (elt, offset)
22657 : charpos + nchars);
22658 Lisp_Object mode_string
22659 = Fsubstring (elt, make_number (charpos),
22660 make_number (endpos));
22661 n += store_mode_line_string (NULL, mode_string, false,
22662 0, 0, Qnil);
22663 }
22664 break;
22665 case MODE_LINE_DISPLAY:
22666 {
22667 ptrdiff_t bytepos = last_offset;
22668 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22669
22670 if (precision <= 0)
22671 nchars = string_byte_to_char (elt, offset) - charpos;
22672 n += display_string (NULL, elt, Qnil, 0, charpos,
22673 it, 0, nchars, 0,
22674 STRING_MULTIBYTE (elt));
22675 }
22676 break;
22677 }
22678 }
22679 else /* c == '%' */
22680 {
22681 ptrdiff_t percent_position = offset;
22682
22683 /* Get the specified minimum width. Zero means
22684 don't pad. */
22685 field = 0;
22686 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
22687 field = field * 10 + c - '0';
22688
22689 /* Don't pad beyond the total padding allowed. */
22690 if (field_width - n > 0 && field > field_width - n)
22691 field = field_width - n;
22692
22693 /* Note that either PRECISION <= 0 or N < PRECISION. */
22694 prec = precision - n;
22695
22696 if (c == 'M')
22697 n += display_mode_element (it, depth, field, prec,
22698 Vglobal_mode_string, props,
22699 risky);
22700 else if (c != 0)
22701 {
22702 bool multibyte;
22703 ptrdiff_t bytepos, charpos;
22704 const char *spec;
22705 Lisp_Object string;
22706
22707 bytepos = percent_position;
22708 charpos = (STRING_MULTIBYTE (elt)
22709 ? string_byte_to_char (elt, bytepos)
22710 : bytepos);
22711 spec = decode_mode_spec (it->w, c, field, &string);
22712 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
22713
22714 switch (mode_line_target)
22715 {
22716 case MODE_LINE_NOPROP:
22717 case MODE_LINE_TITLE:
22718 n += store_mode_line_noprop (spec, field, prec);
22719 break;
22720 case MODE_LINE_STRING:
22721 {
22722 Lisp_Object tem = build_string (spec);
22723 props = Ftext_properties_at (make_number (charpos), elt);
22724 /* Should only keep face property in props */
22725 n += store_mode_line_string (NULL, tem, false,
22726 field, prec, props);
22727 }
22728 break;
22729 case MODE_LINE_DISPLAY:
22730 {
22731 int nglyphs_before, nwritten;
22732
22733 nglyphs_before = it->glyph_row->used[TEXT_AREA];
22734 nwritten = display_string (spec, string, elt,
22735 charpos, 0, it,
22736 field, prec, 0,
22737 multibyte);
22738
22739 /* Assign to the glyphs written above the
22740 string where the `%x' came from, position
22741 of the `%'. */
22742 if (nwritten > 0)
22743 {
22744 struct glyph *glyph
22745 = (it->glyph_row->glyphs[TEXT_AREA]
22746 + nglyphs_before);
22747 int i;
22748
22749 for (i = 0; i < nwritten; ++i)
22750 {
22751 glyph[i].object = elt;
22752 glyph[i].charpos = charpos;
22753 }
22754
22755 n += nwritten;
22756 }
22757 }
22758 break;
22759 }
22760 }
22761 else /* c == 0 */
22762 break;
22763 }
22764 }
22765 }
22766 break;
22767
22768 case Lisp_Symbol:
22769 /* A symbol: process the value of the symbol recursively
22770 as if it appeared here directly. Avoid error if symbol void.
22771 Special case: if value of symbol is a string, output the string
22772 literally. */
22773 {
22774 register Lisp_Object tem;
22775
22776 /* If the variable is not marked as risky to set
22777 then its contents are risky to use. */
22778 if (NILP (Fget (elt, Qrisky_local_variable)))
22779 risky = true;
22780
22781 tem = Fboundp (elt);
22782 if (!NILP (tem))
22783 {
22784 tem = Fsymbol_value (elt);
22785 /* If value is a string, output that string literally:
22786 don't check for % within it. */
22787 if (STRINGP (tem))
22788 literal = true;
22789
22790 if (!EQ (tem, elt))
22791 {
22792 /* Give up right away for nil or t. */
22793 elt = tem;
22794 goto tail_recurse;
22795 }
22796 }
22797 }
22798 break;
22799
22800 case Lisp_Cons:
22801 {
22802 register Lisp_Object car, tem;
22803
22804 /* A cons cell: five distinct cases.
22805 If first element is :eval or :propertize, do something special.
22806 If first element is a string or a cons, process all the elements
22807 and effectively concatenate them.
22808 If first element is a negative number, truncate displaying cdr to
22809 at most that many characters. If positive, pad (with spaces)
22810 to at least that many characters.
22811 If first element is a symbol, process the cadr or caddr recursively
22812 according to whether the symbol's value is non-nil or nil. */
22813 car = XCAR (elt);
22814 if (EQ (car, QCeval))
22815 {
22816 /* An element of the form (:eval FORM) means evaluate FORM
22817 and use the result as mode line elements. */
22818
22819 if (risky)
22820 break;
22821
22822 if (CONSP (XCDR (elt)))
22823 {
22824 Lisp_Object spec;
22825 spec = safe__eval (true, XCAR (XCDR (elt)));
22826 n += display_mode_element (it, depth, field_width - n,
22827 precision - n, spec, props,
22828 risky);
22829 }
22830 }
22831 else if (EQ (car, QCpropertize))
22832 {
22833 /* An element of the form (:propertize ELT PROPS...)
22834 means display ELT but applying properties PROPS. */
22835
22836 if (risky)
22837 break;
22838
22839 if (CONSP (XCDR (elt)))
22840 n += display_mode_element (it, depth, field_width - n,
22841 precision - n, XCAR (XCDR (elt)),
22842 XCDR (XCDR (elt)), risky);
22843 }
22844 else if (SYMBOLP (car))
22845 {
22846 tem = Fboundp (car);
22847 elt = XCDR (elt);
22848 if (!CONSP (elt))
22849 goto invalid;
22850 /* elt is now the cdr, and we know it is a cons cell.
22851 Use its car if CAR has a non-nil value. */
22852 if (!NILP (tem))
22853 {
22854 tem = Fsymbol_value (car);
22855 if (!NILP (tem))
22856 {
22857 elt = XCAR (elt);
22858 goto tail_recurse;
22859 }
22860 }
22861 /* Symbol's value is nil (or symbol is unbound)
22862 Get the cddr of the original list
22863 and if possible find the caddr and use that. */
22864 elt = XCDR (elt);
22865 if (NILP (elt))
22866 break;
22867 else if (!CONSP (elt))
22868 goto invalid;
22869 elt = XCAR (elt);
22870 goto tail_recurse;
22871 }
22872 else if (INTEGERP (car))
22873 {
22874 register int lim = XINT (car);
22875 elt = XCDR (elt);
22876 if (lim < 0)
22877 {
22878 /* Negative int means reduce maximum width. */
22879 if (precision <= 0)
22880 precision = -lim;
22881 else
22882 precision = min (precision, -lim);
22883 }
22884 else if (lim > 0)
22885 {
22886 /* Padding specified. Don't let it be more than
22887 current maximum. */
22888 if (precision > 0)
22889 lim = min (precision, lim);
22890
22891 /* If that's more padding than already wanted, queue it.
22892 But don't reduce padding already specified even if
22893 that is beyond the current truncation point. */
22894 field_width = max (lim, field_width);
22895 }
22896 goto tail_recurse;
22897 }
22898 else if (STRINGP (car) || CONSP (car))
22899 {
22900 Lisp_Object halftail = elt;
22901 int len = 0;
22902
22903 while (CONSP (elt)
22904 && (precision <= 0 || n < precision))
22905 {
22906 n += display_mode_element (it, depth,
22907 /* Do padding only after the last
22908 element in the list. */
22909 (! CONSP (XCDR (elt))
22910 ? field_width - n
22911 : 0),
22912 precision - n, XCAR (elt),
22913 props, risky);
22914 elt = XCDR (elt);
22915 len++;
22916 if ((len & 1) == 0)
22917 halftail = XCDR (halftail);
22918 /* Check for cycle. */
22919 if (EQ (halftail, elt))
22920 break;
22921 }
22922 }
22923 }
22924 break;
22925
22926 default:
22927 invalid:
22928 elt = build_string ("*invalid*");
22929 goto tail_recurse;
22930 }
22931
22932 /* Pad to FIELD_WIDTH. */
22933 if (field_width > 0 && n < field_width)
22934 {
22935 switch (mode_line_target)
22936 {
22937 case MODE_LINE_NOPROP:
22938 case MODE_LINE_TITLE:
22939 n += store_mode_line_noprop ("", field_width - n, 0);
22940 break;
22941 case MODE_LINE_STRING:
22942 n += store_mode_line_string ("", Qnil, false, field_width - n, 0,
22943 Qnil);
22944 break;
22945 case MODE_LINE_DISPLAY:
22946 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22947 0, 0, 0);
22948 break;
22949 }
22950 }
22951
22952 return n;
22953 }
22954
22955 /* Store a mode-line string element in mode_line_string_list.
22956
22957 If STRING is non-null, display that C string. Otherwise, the Lisp
22958 string LISP_STRING is displayed.
22959
22960 FIELD_WIDTH is the minimum number of output glyphs to produce.
22961 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22962 with spaces. FIELD_WIDTH <= 0 means don't pad.
22963
22964 PRECISION is the maximum number of characters to output from
22965 STRING. PRECISION <= 0 means don't truncate the string.
22966
22967 If COPY_STRING, make a copy of LISP_STRING before adding
22968 properties to the string.
22969
22970 PROPS are the properties to add to the string.
22971 The mode_line_string_face face property is always added to the string.
22972 */
22973
22974 static int
22975 store_mode_line_string (const char *string, Lisp_Object lisp_string,
22976 bool copy_string,
22977 int field_width, int precision, Lisp_Object props)
22978 {
22979 ptrdiff_t len;
22980 int n = 0;
22981
22982 if (string != NULL)
22983 {
22984 len = strlen (string);
22985 if (precision > 0 && len > precision)
22986 len = precision;
22987 lisp_string = make_string (string, len);
22988 if (NILP (props))
22989 props = mode_line_string_face_prop;
22990 else if (!NILP (mode_line_string_face))
22991 {
22992 Lisp_Object face = Fplist_get (props, Qface);
22993 props = Fcopy_sequence (props);
22994 if (NILP (face))
22995 face = mode_line_string_face;
22996 else
22997 face = list2 (face, mode_line_string_face);
22998 props = Fplist_put (props, Qface, face);
22999 }
23000 Fadd_text_properties (make_number (0), make_number (len),
23001 props, lisp_string);
23002 }
23003 else
23004 {
23005 len = XFASTINT (Flength (lisp_string));
23006 if (precision > 0 && len > precision)
23007 {
23008 len = precision;
23009 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
23010 precision = -1;
23011 }
23012 if (!NILP (mode_line_string_face))
23013 {
23014 Lisp_Object face;
23015 if (NILP (props))
23016 props = Ftext_properties_at (make_number (0), lisp_string);
23017 face = Fplist_get (props, Qface);
23018 if (NILP (face))
23019 face = mode_line_string_face;
23020 else
23021 face = list2 (face, mode_line_string_face);
23022 props = list2 (Qface, face);
23023 if (copy_string)
23024 lisp_string = Fcopy_sequence (lisp_string);
23025 }
23026 if (!NILP (props))
23027 Fadd_text_properties (make_number (0), make_number (len),
23028 props, lisp_string);
23029 }
23030
23031 if (len > 0)
23032 {
23033 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
23034 n += len;
23035 }
23036
23037 if (field_width > len)
23038 {
23039 field_width -= len;
23040 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
23041 if (!NILP (props))
23042 Fadd_text_properties (make_number (0), make_number (field_width),
23043 props, lisp_string);
23044 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
23045 n += field_width;
23046 }
23047
23048 return n;
23049 }
23050
23051
23052 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
23053 1, 4, 0,
23054 doc: /* Format a string out of a mode line format specification.
23055 First arg FORMAT specifies the mode line format (see `mode-line-format'
23056 for details) to use.
23057
23058 By default, the format is evaluated for the currently selected window.
23059
23060 Optional second arg FACE specifies the face property to put on all
23061 characters for which no face is specified. The value nil means the
23062 default face. The value t means whatever face the window's mode line
23063 currently uses (either `mode-line' or `mode-line-inactive',
23064 depending on whether the window is the selected window or not).
23065 An integer value means the value string has no text
23066 properties.
23067
23068 Optional third and fourth args WINDOW and BUFFER specify the window
23069 and buffer to use as the context for the formatting (defaults
23070 are the selected window and the WINDOW's buffer). */)
23071 (Lisp_Object format, Lisp_Object face,
23072 Lisp_Object window, Lisp_Object buffer)
23073 {
23074 struct it it;
23075 int len;
23076 struct window *w;
23077 struct buffer *old_buffer = NULL;
23078 int face_id;
23079 bool no_props = INTEGERP (face);
23080 ptrdiff_t count = SPECPDL_INDEX ();
23081 Lisp_Object str;
23082 int string_start = 0;
23083
23084 w = decode_any_window (window);
23085 XSETWINDOW (window, w);
23086
23087 if (NILP (buffer))
23088 buffer = w->contents;
23089 CHECK_BUFFER (buffer);
23090
23091 /* Make formatting the modeline a non-op when noninteractive, otherwise
23092 there will be problems later caused by a partially initialized frame. */
23093 if (NILP (format) || noninteractive)
23094 return empty_unibyte_string;
23095
23096 if (no_props)
23097 face = Qnil;
23098
23099 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
23100 : EQ (face, Qt) ? (EQ (window, selected_window)
23101 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
23102 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
23103 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
23104 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
23105 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
23106 : DEFAULT_FACE_ID;
23107
23108 old_buffer = current_buffer;
23109
23110 /* Save things including mode_line_proptrans_alist,
23111 and set that to nil so that we don't alter the outer value. */
23112 record_unwind_protect (unwind_format_mode_line,
23113 format_mode_line_unwind_data
23114 (XFRAME (WINDOW_FRAME (w)),
23115 old_buffer, selected_window, true));
23116 mode_line_proptrans_alist = Qnil;
23117
23118 Fselect_window (window, Qt);
23119 set_buffer_internal_1 (XBUFFER (buffer));
23120
23121 init_iterator (&it, w, -1, -1, NULL, face_id);
23122
23123 if (no_props)
23124 {
23125 mode_line_target = MODE_LINE_NOPROP;
23126 mode_line_string_face_prop = Qnil;
23127 mode_line_string_list = Qnil;
23128 string_start = MODE_LINE_NOPROP_LEN (0);
23129 }
23130 else
23131 {
23132 mode_line_target = MODE_LINE_STRING;
23133 mode_line_string_list = Qnil;
23134 mode_line_string_face = face;
23135 mode_line_string_face_prop
23136 = NILP (face) ? Qnil : list2 (Qface, face);
23137 }
23138
23139 push_kboard (FRAME_KBOARD (it.f));
23140 display_mode_element (&it, 0, 0, 0, format, Qnil, false);
23141 pop_kboard ();
23142
23143 if (no_props)
23144 {
23145 len = MODE_LINE_NOPROP_LEN (string_start);
23146 str = make_string (mode_line_noprop_buf + string_start, len);
23147 }
23148 else
23149 {
23150 mode_line_string_list = Fnreverse (mode_line_string_list);
23151 str = Fmapconcat (Qidentity, mode_line_string_list,
23152 empty_unibyte_string);
23153 }
23154
23155 unbind_to (count, Qnil);
23156 return str;
23157 }
23158
23159 /* Write a null-terminated, right justified decimal representation of
23160 the positive integer D to BUF using a minimal field width WIDTH. */
23161
23162 static void
23163 pint2str (register char *buf, register int width, register ptrdiff_t d)
23164 {
23165 register char *p = buf;
23166
23167 if (d <= 0)
23168 *p++ = '0';
23169 else
23170 {
23171 while (d > 0)
23172 {
23173 *p++ = d % 10 + '0';
23174 d /= 10;
23175 }
23176 }
23177
23178 for (width -= (int) (p - buf); width > 0; --width)
23179 *p++ = ' ';
23180 *p-- = '\0';
23181 while (p > buf)
23182 {
23183 d = *buf;
23184 *buf++ = *p;
23185 *p-- = d;
23186 }
23187 }
23188
23189 /* Write a null-terminated, right justified decimal and "human
23190 readable" representation of the nonnegative integer D to BUF using
23191 a minimal field width WIDTH. D should be smaller than 999.5e24. */
23192
23193 static const char power_letter[] =
23194 {
23195 0, /* no letter */
23196 'k', /* kilo */
23197 'M', /* mega */
23198 'G', /* giga */
23199 'T', /* tera */
23200 'P', /* peta */
23201 'E', /* exa */
23202 'Z', /* zetta */
23203 'Y' /* yotta */
23204 };
23205
23206 static void
23207 pint2hrstr (char *buf, int width, ptrdiff_t d)
23208 {
23209 /* We aim to represent the nonnegative integer D as
23210 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
23211 ptrdiff_t quotient = d;
23212 int remainder = 0;
23213 /* -1 means: do not use TENTHS. */
23214 int tenths = -1;
23215 int exponent = 0;
23216
23217 /* Length of QUOTIENT.TENTHS as a string. */
23218 int length;
23219
23220 char * psuffix;
23221 char * p;
23222
23223 if (quotient >= 1000)
23224 {
23225 /* Scale to the appropriate EXPONENT. */
23226 do
23227 {
23228 remainder = quotient % 1000;
23229 quotient /= 1000;
23230 exponent++;
23231 }
23232 while (quotient >= 1000);
23233
23234 /* Round to nearest and decide whether to use TENTHS or not. */
23235 if (quotient <= 9)
23236 {
23237 tenths = remainder / 100;
23238 if (remainder % 100 >= 50)
23239 {
23240 if (tenths < 9)
23241 tenths++;
23242 else
23243 {
23244 quotient++;
23245 if (quotient == 10)
23246 tenths = -1;
23247 else
23248 tenths = 0;
23249 }
23250 }
23251 }
23252 else
23253 if (remainder >= 500)
23254 {
23255 if (quotient < 999)
23256 quotient++;
23257 else
23258 {
23259 quotient = 1;
23260 exponent++;
23261 tenths = 0;
23262 }
23263 }
23264 }
23265
23266 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
23267 if (tenths == -1 && quotient <= 99)
23268 if (quotient <= 9)
23269 length = 1;
23270 else
23271 length = 2;
23272 else
23273 length = 3;
23274 p = psuffix = buf + max (width, length);
23275
23276 /* Print EXPONENT. */
23277 *psuffix++ = power_letter[exponent];
23278 *psuffix = '\0';
23279
23280 /* Print TENTHS. */
23281 if (tenths >= 0)
23282 {
23283 *--p = '0' + tenths;
23284 *--p = '.';
23285 }
23286
23287 /* Print QUOTIENT. */
23288 do
23289 {
23290 int digit = quotient % 10;
23291 *--p = '0' + digit;
23292 }
23293 while ((quotient /= 10) != 0);
23294
23295 /* Print leading spaces. */
23296 while (buf < p)
23297 *--p = ' ';
23298 }
23299
23300 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
23301 If EOL_FLAG, set also a mnemonic character for end-of-line
23302 type of CODING_SYSTEM. Return updated pointer into BUF. */
23303
23304 static unsigned char invalid_eol_type[] = "(*invalid*)";
23305
23306 static char *
23307 decode_mode_spec_coding (Lisp_Object coding_system, char *buf, bool eol_flag)
23308 {
23309 Lisp_Object val;
23310 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
23311 const unsigned char *eol_str;
23312 int eol_str_len;
23313 /* The EOL conversion we are using. */
23314 Lisp_Object eoltype;
23315
23316 val = CODING_SYSTEM_SPEC (coding_system);
23317 eoltype = Qnil;
23318
23319 if (!VECTORP (val)) /* Not yet decided. */
23320 {
23321 *buf++ = multibyte ? '-' : ' ';
23322 if (eol_flag)
23323 eoltype = eol_mnemonic_undecided;
23324 /* Don't mention EOL conversion if it isn't decided. */
23325 }
23326 else
23327 {
23328 Lisp_Object attrs;
23329 Lisp_Object eolvalue;
23330
23331 attrs = AREF (val, 0);
23332 eolvalue = AREF (val, 2);
23333
23334 *buf++ = multibyte
23335 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
23336 : ' ';
23337
23338 if (eol_flag)
23339 {
23340 /* The EOL conversion that is normal on this system. */
23341
23342 if (NILP (eolvalue)) /* Not yet decided. */
23343 eoltype = eol_mnemonic_undecided;
23344 else if (VECTORP (eolvalue)) /* Not yet decided. */
23345 eoltype = eol_mnemonic_undecided;
23346 else /* eolvalue is Qunix, Qdos, or Qmac. */
23347 eoltype = (EQ (eolvalue, Qunix)
23348 ? eol_mnemonic_unix
23349 : EQ (eolvalue, Qdos)
23350 ? eol_mnemonic_dos : eol_mnemonic_mac);
23351 }
23352 }
23353
23354 if (eol_flag)
23355 {
23356 /* Mention the EOL conversion if it is not the usual one. */
23357 if (STRINGP (eoltype))
23358 {
23359 eol_str = SDATA (eoltype);
23360 eol_str_len = SBYTES (eoltype);
23361 }
23362 else if (CHARACTERP (eoltype))
23363 {
23364 int c = XFASTINT (eoltype);
23365 return buf + CHAR_STRING (c, (unsigned char *) buf);
23366 }
23367 else
23368 {
23369 eol_str = invalid_eol_type;
23370 eol_str_len = sizeof (invalid_eol_type) - 1;
23371 }
23372 memcpy (buf, eol_str, eol_str_len);
23373 buf += eol_str_len;
23374 }
23375
23376 return buf;
23377 }
23378
23379 /* Return a string for the output of a mode line %-spec for window W,
23380 generated by character C. FIELD_WIDTH > 0 means pad the string
23381 returned with spaces to that value. Return a Lisp string in
23382 *STRING if the resulting string is taken from that Lisp string.
23383
23384 Note we operate on the current buffer for most purposes. */
23385
23386 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
23387
23388 static const char *
23389 decode_mode_spec (struct window *w, register int c, int field_width,
23390 Lisp_Object *string)
23391 {
23392 Lisp_Object obj;
23393 struct frame *f = XFRAME (WINDOW_FRAME (w));
23394 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
23395 /* We are going to use f->decode_mode_spec_buffer as the buffer to
23396 produce strings from numerical values, so limit preposterously
23397 large values of FIELD_WIDTH to avoid overrunning the buffer's
23398 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
23399 bytes plus the terminating null. */
23400 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
23401 struct buffer *b = current_buffer;
23402
23403 obj = Qnil;
23404 *string = Qnil;
23405
23406 switch (c)
23407 {
23408 case '*':
23409 if (!NILP (BVAR (b, read_only)))
23410 return "%";
23411 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23412 return "*";
23413 return "-";
23414
23415 case '+':
23416 /* This differs from %* only for a modified read-only buffer. */
23417 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23418 return "*";
23419 if (!NILP (BVAR (b, read_only)))
23420 return "%";
23421 return "-";
23422
23423 case '&':
23424 /* This differs from %* in ignoring read-only-ness. */
23425 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
23426 return "*";
23427 return "-";
23428
23429 case '%':
23430 return "%";
23431
23432 case '[':
23433 {
23434 int i;
23435 char *p;
23436
23437 if (command_loop_level > 5)
23438 return "[[[... ";
23439 p = decode_mode_spec_buf;
23440 for (i = 0; i < command_loop_level; i++)
23441 *p++ = '[';
23442 *p = 0;
23443 return decode_mode_spec_buf;
23444 }
23445
23446 case ']':
23447 {
23448 int i;
23449 char *p;
23450
23451 if (command_loop_level > 5)
23452 return " ...]]]";
23453 p = decode_mode_spec_buf;
23454 for (i = 0; i < command_loop_level; i++)
23455 *p++ = ']';
23456 *p = 0;
23457 return decode_mode_spec_buf;
23458 }
23459
23460 case '-':
23461 {
23462 register int i;
23463
23464 /* Let lots_of_dashes be a string of infinite length. */
23465 if (mode_line_target == MODE_LINE_NOPROP
23466 || mode_line_target == MODE_LINE_STRING)
23467 return "--";
23468 if (field_width <= 0
23469 || field_width > sizeof (lots_of_dashes))
23470 {
23471 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
23472 decode_mode_spec_buf[i] = '-';
23473 decode_mode_spec_buf[i] = '\0';
23474 return decode_mode_spec_buf;
23475 }
23476 else
23477 return lots_of_dashes;
23478 }
23479
23480 case 'b':
23481 obj = BVAR (b, name);
23482 break;
23483
23484 case 'c':
23485 /* %c and %l are ignored in `frame-title-format'.
23486 (In redisplay_internal, the frame title is drawn _before_ the
23487 windows are updated, so the stuff which depends on actual
23488 window contents (such as %l) may fail to render properly, or
23489 even crash emacs.) */
23490 if (mode_line_target == MODE_LINE_TITLE)
23491 return "";
23492 else
23493 {
23494 ptrdiff_t col = current_column ();
23495 w->column_number_displayed = col;
23496 pint2str (decode_mode_spec_buf, width, col);
23497 return decode_mode_spec_buf;
23498 }
23499
23500 case 'e':
23501 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23502 {
23503 if (NILP (Vmemory_full))
23504 return "";
23505 else
23506 return "!MEM FULL! ";
23507 }
23508 #else
23509 return "";
23510 #endif
23511
23512 case 'F':
23513 /* %F displays the frame name. */
23514 if (!NILP (f->title))
23515 return SSDATA (f->title);
23516 if (f->explicit_name || ! FRAME_WINDOW_P (f))
23517 return SSDATA (f->name);
23518 return "Emacs";
23519
23520 case 'f':
23521 obj = BVAR (b, filename);
23522 break;
23523
23524 case 'i':
23525 {
23526 ptrdiff_t size = ZV - BEGV;
23527 pint2str (decode_mode_spec_buf, width, size);
23528 return decode_mode_spec_buf;
23529 }
23530
23531 case 'I':
23532 {
23533 ptrdiff_t size = ZV - BEGV;
23534 pint2hrstr (decode_mode_spec_buf, width, size);
23535 return decode_mode_spec_buf;
23536 }
23537
23538 case 'l':
23539 {
23540 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
23541 ptrdiff_t topline, nlines, height;
23542 ptrdiff_t junk;
23543
23544 /* %c and %l are ignored in `frame-title-format'. */
23545 if (mode_line_target == MODE_LINE_TITLE)
23546 return "";
23547
23548 startpos = marker_position (w->start);
23549 startpos_byte = marker_byte_position (w->start);
23550 height = WINDOW_TOTAL_LINES (w);
23551
23552 /* If we decided that this buffer isn't suitable for line numbers,
23553 don't forget that too fast. */
23554 if (w->base_line_pos == -1)
23555 goto no_value;
23556
23557 /* If the buffer is very big, don't waste time. */
23558 if (INTEGERP (Vline_number_display_limit)
23559 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
23560 {
23561 w->base_line_pos = 0;
23562 w->base_line_number = 0;
23563 goto no_value;
23564 }
23565
23566 if (w->base_line_number > 0
23567 && w->base_line_pos > 0
23568 && w->base_line_pos <= startpos)
23569 {
23570 line = w->base_line_number;
23571 linepos = w->base_line_pos;
23572 linepos_byte = buf_charpos_to_bytepos (b, linepos);
23573 }
23574 else
23575 {
23576 line = 1;
23577 linepos = BUF_BEGV (b);
23578 linepos_byte = BUF_BEGV_BYTE (b);
23579 }
23580
23581 /* Count lines from base line to window start position. */
23582 nlines = display_count_lines (linepos_byte,
23583 startpos_byte,
23584 startpos, &junk);
23585
23586 topline = nlines + line;
23587
23588 /* Determine a new base line, if the old one is too close
23589 or too far away, or if we did not have one.
23590 "Too close" means it's plausible a scroll-down would
23591 go back past it. */
23592 if (startpos == BUF_BEGV (b))
23593 {
23594 w->base_line_number = topline;
23595 w->base_line_pos = BUF_BEGV (b);
23596 }
23597 else if (nlines < height + 25 || nlines > height * 3 + 50
23598 || linepos == BUF_BEGV (b))
23599 {
23600 ptrdiff_t limit = BUF_BEGV (b);
23601 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
23602 ptrdiff_t position;
23603 ptrdiff_t distance =
23604 (height * 2 + 30) * line_number_display_limit_width;
23605
23606 if (startpos - distance > limit)
23607 {
23608 limit = startpos - distance;
23609 limit_byte = CHAR_TO_BYTE (limit);
23610 }
23611
23612 nlines = display_count_lines (startpos_byte,
23613 limit_byte,
23614 - (height * 2 + 30),
23615 &position);
23616 /* If we couldn't find the lines we wanted within
23617 line_number_display_limit_width chars per line,
23618 give up on line numbers for this window. */
23619 if (position == limit_byte && limit == startpos - distance)
23620 {
23621 w->base_line_pos = -1;
23622 w->base_line_number = 0;
23623 goto no_value;
23624 }
23625
23626 w->base_line_number = topline - nlines;
23627 w->base_line_pos = BYTE_TO_CHAR (position);
23628 }
23629
23630 /* Now count lines from the start pos to point. */
23631 nlines = display_count_lines (startpos_byte,
23632 PT_BYTE, PT, &junk);
23633
23634 /* Record that we did display the line number. */
23635 line_number_displayed = true;
23636
23637 /* Make the string to show. */
23638 pint2str (decode_mode_spec_buf, width, topline + nlines);
23639 return decode_mode_spec_buf;
23640 no_value:
23641 {
23642 char *p = decode_mode_spec_buf;
23643 int pad = width - 2;
23644 while (pad-- > 0)
23645 *p++ = ' ';
23646 *p++ = '?';
23647 *p++ = '?';
23648 *p = '\0';
23649 return decode_mode_spec_buf;
23650 }
23651 }
23652 break;
23653
23654 case 'm':
23655 obj = BVAR (b, mode_name);
23656 break;
23657
23658 case 'n':
23659 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
23660 return " Narrow";
23661 break;
23662
23663 case 'p':
23664 {
23665 ptrdiff_t pos = marker_position (w->start);
23666 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23667
23668 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
23669 {
23670 if (pos <= BUF_BEGV (b))
23671 return "All";
23672 else
23673 return "Bottom";
23674 }
23675 else if (pos <= BUF_BEGV (b))
23676 return "Top";
23677 else
23678 {
23679 if (total > 1000000)
23680 /* Do it differently for a large value, to avoid overflow. */
23681 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23682 else
23683 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
23684 /* We can't normally display a 3-digit number,
23685 so get us a 2-digit number that is close. */
23686 if (total == 100)
23687 total = 99;
23688 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23689 return decode_mode_spec_buf;
23690 }
23691 }
23692
23693 /* Display percentage of size above the bottom of the screen. */
23694 case 'P':
23695 {
23696 ptrdiff_t toppos = marker_position (w->start);
23697 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
23698 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23699
23700 if (botpos >= BUF_ZV (b))
23701 {
23702 if (toppos <= BUF_BEGV (b))
23703 return "All";
23704 else
23705 return "Bottom";
23706 }
23707 else
23708 {
23709 if (total > 1000000)
23710 /* Do it differently for a large value, to avoid overflow. */
23711 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23712 else
23713 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
23714 /* We can't normally display a 3-digit number,
23715 so get us a 2-digit number that is close. */
23716 if (total == 100)
23717 total = 99;
23718 if (toppos <= BUF_BEGV (b))
23719 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
23720 else
23721 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23722 return decode_mode_spec_buf;
23723 }
23724 }
23725
23726 case 's':
23727 /* status of process */
23728 obj = Fget_buffer_process (Fcurrent_buffer ());
23729 if (NILP (obj))
23730 return "no process";
23731 #ifndef MSDOS
23732 obj = Fsymbol_name (Fprocess_status (obj));
23733 #endif
23734 break;
23735
23736 case '@':
23737 {
23738 ptrdiff_t count = inhibit_garbage_collection ();
23739 Lisp_Object curdir = BVAR (current_buffer, directory);
23740 Lisp_Object val = Qnil;
23741
23742 if (STRINGP (curdir))
23743 val = call1 (intern ("file-remote-p"), curdir);
23744
23745 unbind_to (count, Qnil);
23746
23747 if (NILP (val))
23748 return "-";
23749 else
23750 return "@";
23751 }
23752
23753 case 'z':
23754 /* coding-system (not including end-of-line format) */
23755 case 'Z':
23756 /* coding-system (including end-of-line type) */
23757 {
23758 bool eol_flag = (c == 'Z');
23759 char *p = decode_mode_spec_buf;
23760
23761 if (! FRAME_WINDOW_P (f))
23762 {
23763 /* No need to mention EOL here--the terminal never needs
23764 to do EOL conversion. */
23765 p = decode_mode_spec_coding (CODING_ID_NAME
23766 (FRAME_KEYBOARD_CODING (f)->id),
23767 p, false);
23768 p = decode_mode_spec_coding (CODING_ID_NAME
23769 (FRAME_TERMINAL_CODING (f)->id),
23770 p, false);
23771 }
23772 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
23773 p, eol_flag);
23774
23775 #if false /* This proves to be annoying; I think we can do without. -- rms. */
23776 #ifdef subprocesses
23777 obj = Fget_buffer_process (Fcurrent_buffer ());
23778 if (PROCESSP (obj))
23779 {
23780 p = decode_mode_spec_coding
23781 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
23782 p = decode_mode_spec_coding
23783 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
23784 }
23785 #endif /* subprocesses */
23786 #endif /* false */
23787 *p = 0;
23788 return decode_mode_spec_buf;
23789 }
23790 }
23791
23792 if (STRINGP (obj))
23793 {
23794 *string = obj;
23795 return SSDATA (obj);
23796 }
23797 else
23798 return "";
23799 }
23800
23801
23802 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23803 means count lines back from START_BYTE. But don't go beyond
23804 LIMIT_BYTE. Return the number of lines thus found (always
23805 nonnegative).
23806
23807 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23808 either the position COUNT lines after/before START_BYTE, if we
23809 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23810 COUNT lines. */
23811
23812 static ptrdiff_t
23813 display_count_lines (ptrdiff_t start_byte,
23814 ptrdiff_t limit_byte, ptrdiff_t count,
23815 ptrdiff_t *byte_pos_ptr)
23816 {
23817 register unsigned char *cursor;
23818 unsigned char *base;
23819
23820 register ptrdiff_t ceiling;
23821 register unsigned char *ceiling_addr;
23822 ptrdiff_t orig_count = count;
23823
23824 /* If we are not in selective display mode,
23825 check only for newlines. */
23826 bool selective_display
23827 = (!NILP (BVAR (current_buffer, selective_display))
23828 && !INTEGERP (BVAR (current_buffer, selective_display)));
23829
23830 if (count > 0)
23831 {
23832 while (start_byte < limit_byte)
23833 {
23834 ceiling = BUFFER_CEILING_OF (start_byte);
23835 ceiling = min (limit_byte - 1, ceiling);
23836 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
23837 base = (cursor = BYTE_POS_ADDR (start_byte));
23838
23839 do
23840 {
23841 if (selective_display)
23842 {
23843 while (*cursor != '\n' && *cursor != 015
23844 && ++cursor != ceiling_addr)
23845 continue;
23846 if (cursor == ceiling_addr)
23847 break;
23848 }
23849 else
23850 {
23851 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
23852 if (! cursor)
23853 break;
23854 }
23855
23856 cursor++;
23857
23858 if (--count == 0)
23859 {
23860 start_byte += cursor - base;
23861 *byte_pos_ptr = start_byte;
23862 return orig_count;
23863 }
23864 }
23865 while (cursor < ceiling_addr);
23866
23867 start_byte += ceiling_addr - base;
23868 }
23869 }
23870 else
23871 {
23872 while (start_byte > limit_byte)
23873 {
23874 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
23875 ceiling = max (limit_byte, ceiling);
23876 ceiling_addr = BYTE_POS_ADDR (ceiling);
23877 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
23878 while (true)
23879 {
23880 if (selective_display)
23881 {
23882 while (--cursor >= ceiling_addr
23883 && *cursor != '\n' && *cursor != 015)
23884 continue;
23885 if (cursor < ceiling_addr)
23886 break;
23887 }
23888 else
23889 {
23890 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
23891 if (! cursor)
23892 break;
23893 }
23894
23895 if (++count == 0)
23896 {
23897 start_byte += cursor - base + 1;
23898 *byte_pos_ptr = start_byte;
23899 /* When scanning backwards, we should
23900 not count the newline posterior to which we stop. */
23901 return - orig_count - 1;
23902 }
23903 }
23904 start_byte += ceiling_addr - base;
23905 }
23906 }
23907
23908 *byte_pos_ptr = limit_byte;
23909
23910 if (count < 0)
23911 return - orig_count + count;
23912 return orig_count - count;
23913
23914 }
23915
23916
23917 \f
23918 /***********************************************************************
23919 Displaying strings
23920 ***********************************************************************/
23921
23922 /* Display a NUL-terminated string, starting with index START.
23923
23924 If STRING is non-null, display that C string. Otherwise, the Lisp
23925 string LISP_STRING is displayed. There's a case that STRING is
23926 non-null and LISP_STRING is not nil. It means STRING is a string
23927 data of LISP_STRING. In that case, we display LISP_STRING while
23928 ignoring its text properties.
23929
23930 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23931 FACE_STRING. Display STRING or LISP_STRING with the face at
23932 FACE_STRING_POS in FACE_STRING:
23933
23934 Display the string in the environment given by IT, but use the
23935 standard display table, temporarily.
23936
23937 FIELD_WIDTH is the minimum number of output glyphs to produce.
23938 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23939 with spaces. If STRING has more characters, more than FIELD_WIDTH
23940 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23941
23942 PRECISION is the maximum number of characters to output from
23943 STRING. PRECISION < 0 means don't truncate the string.
23944
23945 This is roughly equivalent to printf format specifiers:
23946
23947 FIELD_WIDTH PRECISION PRINTF
23948 ----------------------------------------
23949 -1 -1 %s
23950 -1 10 %.10s
23951 10 -1 %10s
23952 20 10 %20.10s
23953
23954 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23955 display them, and < 0 means obey the current buffer's value of
23956 enable_multibyte_characters.
23957
23958 Value is the number of columns displayed. */
23959
23960 static int
23961 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23962 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23963 int field_width, int precision, int max_x, int multibyte)
23964 {
23965 int hpos_at_start = it->hpos;
23966 int saved_face_id = it->face_id;
23967 struct glyph_row *row = it->glyph_row;
23968 ptrdiff_t it_charpos;
23969
23970 /* Initialize the iterator IT for iteration over STRING beginning
23971 with index START. */
23972 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23973 precision, field_width, multibyte);
23974 if (string && STRINGP (lisp_string))
23975 /* LISP_STRING is the one returned by decode_mode_spec. We should
23976 ignore its text properties. */
23977 it->stop_charpos = it->end_charpos;
23978
23979 /* If displaying STRING, set up the face of the iterator from
23980 FACE_STRING, if that's given. */
23981 if (STRINGP (face_string))
23982 {
23983 ptrdiff_t endptr;
23984 struct face *face;
23985
23986 it->face_id
23987 = face_at_string_position (it->w, face_string, face_string_pos,
23988 0, &endptr, it->base_face_id, false);
23989 face = FACE_FROM_ID (it->f, it->face_id);
23990 it->face_box_p = face->box != FACE_NO_BOX;
23991 }
23992
23993 /* Set max_x to the maximum allowed X position. Don't let it go
23994 beyond the right edge of the window. */
23995 if (max_x <= 0)
23996 max_x = it->last_visible_x;
23997 else
23998 max_x = min (max_x, it->last_visible_x);
23999
24000 /* Skip over display elements that are not visible. because IT->w is
24001 hscrolled. */
24002 if (it->current_x < it->first_visible_x)
24003 move_it_in_display_line_to (it, 100000, it->first_visible_x,
24004 MOVE_TO_POS | MOVE_TO_X);
24005
24006 row->ascent = it->max_ascent;
24007 row->height = it->max_ascent + it->max_descent;
24008 row->phys_ascent = it->max_phys_ascent;
24009 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
24010 row->extra_line_spacing = it->max_extra_line_spacing;
24011
24012 if (STRINGP (it->string))
24013 it_charpos = IT_STRING_CHARPOS (*it);
24014 else
24015 it_charpos = IT_CHARPOS (*it);
24016
24017 /* This condition is for the case that we are called with current_x
24018 past last_visible_x. */
24019 while (it->current_x < max_x)
24020 {
24021 int x_before, x, n_glyphs_before, i, nglyphs;
24022
24023 /* Get the next display element. */
24024 if (!get_next_display_element (it))
24025 break;
24026
24027 /* Produce glyphs. */
24028 x_before = it->current_x;
24029 n_glyphs_before = row->used[TEXT_AREA];
24030 PRODUCE_GLYPHS (it);
24031
24032 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
24033 i = 0;
24034 x = x_before;
24035 while (i < nglyphs)
24036 {
24037 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
24038
24039 if (it->line_wrap != TRUNCATE
24040 && x + glyph->pixel_width > max_x)
24041 {
24042 /* End of continued line or max_x reached. */
24043 if (CHAR_GLYPH_PADDING_P (*glyph))
24044 {
24045 /* A wide character is unbreakable. */
24046 if (row->reversed_p)
24047 unproduce_glyphs (it, row->used[TEXT_AREA]
24048 - n_glyphs_before);
24049 row->used[TEXT_AREA] = n_glyphs_before;
24050 it->current_x = x_before;
24051 }
24052 else
24053 {
24054 if (row->reversed_p)
24055 unproduce_glyphs (it, row->used[TEXT_AREA]
24056 - (n_glyphs_before + i));
24057 row->used[TEXT_AREA] = n_glyphs_before + i;
24058 it->current_x = x;
24059 }
24060 break;
24061 }
24062 else if (x + glyph->pixel_width >= it->first_visible_x)
24063 {
24064 /* Glyph is at least partially visible. */
24065 ++it->hpos;
24066 if (x < it->first_visible_x)
24067 row->x = x - it->first_visible_x;
24068 }
24069 else
24070 {
24071 /* Glyph is off the left margin of the display area.
24072 Should not happen. */
24073 emacs_abort ();
24074 }
24075
24076 row->ascent = max (row->ascent, it->max_ascent);
24077 row->height = max (row->height, it->max_ascent + it->max_descent);
24078 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
24079 row->phys_height = max (row->phys_height,
24080 it->max_phys_ascent + it->max_phys_descent);
24081 row->extra_line_spacing = max (row->extra_line_spacing,
24082 it->max_extra_line_spacing);
24083 x += glyph->pixel_width;
24084 ++i;
24085 }
24086
24087 /* Stop if max_x reached. */
24088 if (i < nglyphs)
24089 break;
24090
24091 /* Stop at line ends. */
24092 if (ITERATOR_AT_END_OF_LINE_P (it))
24093 {
24094 it->continuation_lines_width = 0;
24095 break;
24096 }
24097
24098 set_iterator_to_next (it, true);
24099 if (STRINGP (it->string))
24100 it_charpos = IT_STRING_CHARPOS (*it);
24101 else
24102 it_charpos = IT_CHARPOS (*it);
24103
24104 /* Stop if truncating at the right edge. */
24105 if (it->line_wrap == TRUNCATE
24106 && it->current_x >= it->last_visible_x)
24107 {
24108 /* Add truncation mark, but don't do it if the line is
24109 truncated at a padding space. */
24110 if (it_charpos < it->string_nchars)
24111 {
24112 if (!FRAME_WINDOW_P (it->f))
24113 {
24114 int ii, n;
24115
24116 if (it->current_x > it->last_visible_x)
24117 {
24118 if (!row->reversed_p)
24119 {
24120 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
24121 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
24122 break;
24123 }
24124 else
24125 {
24126 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
24127 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
24128 break;
24129 unproduce_glyphs (it, ii + 1);
24130 ii = row->used[TEXT_AREA] - (ii + 1);
24131 }
24132 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
24133 {
24134 row->used[TEXT_AREA] = ii;
24135 produce_special_glyphs (it, IT_TRUNCATION);
24136 }
24137 }
24138 produce_special_glyphs (it, IT_TRUNCATION);
24139 }
24140 row->truncated_on_right_p = true;
24141 }
24142 break;
24143 }
24144 }
24145
24146 /* Maybe insert a truncation at the left. */
24147 if (it->first_visible_x
24148 && it_charpos > 0)
24149 {
24150 if (!FRAME_WINDOW_P (it->f)
24151 || (row->reversed_p
24152 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
24153 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
24154 insert_left_trunc_glyphs (it);
24155 row->truncated_on_left_p = true;
24156 }
24157
24158 it->face_id = saved_face_id;
24159
24160 /* Value is number of columns displayed. */
24161 return it->hpos - hpos_at_start;
24162 }
24163
24164
24165 \f
24166 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
24167 appears as an element of LIST or as the car of an element of LIST.
24168 If PROPVAL is a list, compare each element against LIST in that
24169 way, and return 1/2 if any element of PROPVAL is found in LIST.
24170 Otherwise return 0. This function cannot quit.
24171 The return value is 2 if the text is invisible but with an ellipsis
24172 and 1 if it's invisible and without an ellipsis. */
24173
24174 int
24175 invisible_prop (Lisp_Object propval, Lisp_Object list)
24176 {
24177 Lisp_Object tail, proptail;
24178
24179 for (tail = list; CONSP (tail); tail = XCDR (tail))
24180 {
24181 register Lisp_Object tem;
24182 tem = XCAR (tail);
24183 if (EQ (propval, tem))
24184 return 1;
24185 if (CONSP (tem) && EQ (propval, XCAR (tem)))
24186 return NILP (XCDR (tem)) ? 1 : 2;
24187 }
24188
24189 if (CONSP (propval))
24190 {
24191 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
24192 {
24193 Lisp_Object propelt;
24194 propelt = XCAR (proptail);
24195 for (tail = list; CONSP (tail); tail = XCDR (tail))
24196 {
24197 register Lisp_Object tem;
24198 tem = XCAR (tail);
24199 if (EQ (propelt, tem))
24200 return 1;
24201 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
24202 return NILP (XCDR (tem)) ? 1 : 2;
24203 }
24204 }
24205 }
24206
24207 return 0;
24208 }
24209
24210 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
24211 doc: /* Non-nil if the property makes the text invisible.
24212 POS-OR-PROP can be a marker or number, in which case it is taken to be
24213 a position in the current buffer and the value of the `invisible' property
24214 is checked; or it can be some other value, which is then presumed to be the
24215 value of the `invisible' property of the text of interest.
24216 The non-nil value returned can be t for truly invisible text or something
24217 else if the text is replaced by an ellipsis. */)
24218 (Lisp_Object pos_or_prop)
24219 {
24220 Lisp_Object prop
24221 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
24222 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
24223 : pos_or_prop);
24224 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
24225 return (invis == 0 ? Qnil
24226 : invis == 1 ? Qt
24227 : make_number (invis));
24228 }
24229
24230 /* Calculate a width or height in pixels from a specification using
24231 the following elements:
24232
24233 SPEC ::=
24234 NUM - a (fractional) multiple of the default font width/height
24235 (NUM) - specifies exactly NUM pixels
24236 UNIT - a fixed number of pixels, see below.
24237 ELEMENT - size of a display element in pixels, see below.
24238 (NUM . SPEC) - equals NUM * SPEC
24239 (+ SPEC SPEC ...) - add pixel values
24240 (- SPEC SPEC ...) - subtract pixel values
24241 (- SPEC) - negate pixel value
24242
24243 NUM ::=
24244 INT or FLOAT - a number constant
24245 SYMBOL - use symbol's (buffer local) variable binding.
24246
24247 UNIT ::=
24248 in - pixels per inch *)
24249 mm - pixels per 1/1000 meter *)
24250 cm - pixels per 1/100 meter *)
24251 width - width of current font in pixels.
24252 height - height of current font in pixels.
24253
24254 *) using the ratio(s) defined in display-pixels-per-inch.
24255
24256 ELEMENT ::=
24257
24258 left-fringe - left fringe width in pixels
24259 right-fringe - right fringe width in pixels
24260
24261 left-margin - left margin width in pixels
24262 right-margin - right margin width in pixels
24263
24264 scroll-bar - scroll-bar area width in pixels
24265
24266 Examples:
24267
24268 Pixels corresponding to 5 inches:
24269 (5 . in)
24270
24271 Total width of non-text areas on left side of window (if scroll-bar is on left):
24272 '(space :width (+ left-fringe left-margin scroll-bar))
24273
24274 Align to first text column (in header line):
24275 '(space :align-to 0)
24276
24277 Align to middle of text area minus half the width of variable `my-image'
24278 containing a loaded image:
24279 '(space :align-to (0.5 . (- text my-image)))
24280
24281 Width of left margin minus width of 1 character in the default font:
24282 '(space :width (- left-margin 1))
24283
24284 Width of left margin minus width of 2 characters in the current font:
24285 '(space :width (- left-margin (2 . width)))
24286
24287 Center 1 character over left-margin (in header line):
24288 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
24289
24290 Different ways to express width of left fringe plus left margin minus one pixel:
24291 '(space :width (- (+ left-fringe left-margin) (1)))
24292 '(space :width (+ left-fringe left-margin (- (1))))
24293 '(space :width (+ left-fringe left-margin (-1)))
24294
24295 */
24296
24297 static bool
24298 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
24299 struct font *font, bool width_p, int *align_to)
24300 {
24301 double pixels;
24302
24303 # define OK_PIXELS(val) (*res = (val), true)
24304 # define OK_ALIGN_TO(val) (*align_to = (val), true)
24305
24306 if (NILP (prop))
24307 return OK_PIXELS (0);
24308
24309 eassert (FRAME_LIVE_P (it->f));
24310
24311 if (SYMBOLP (prop))
24312 {
24313 if (SCHARS (SYMBOL_NAME (prop)) == 2)
24314 {
24315 char *unit = SSDATA (SYMBOL_NAME (prop));
24316
24317 if (unit[0] == 'i' && unit[1] == 'n')
24318 pixels = 1.0;
24319 else if (unit[0] == 'm' && unit[1] == 'm')
24320 pixels = 25.4;
24321 else if (unit[0] == 'c' && unit[1] == 'm')
24322 pixels = 2.54;
24323 else
24324 pixels = 0;
24325 if (pixels > 0)
24326 {
24327 double ppi = (width_p ? FRAME_RES_X (it->f)
24328 : FRAME_RES_Y (it->f));
24329
24330 if (ppi > 0)
24331 return OK_PIXELS (ppi / pixels);
24332 return false;
24333 }
24334 }
24335
24336 #ifdef HAVE_WINDOW_SYSTEM
24337 if (EQ (prop, Qheight))
24338 return OK_PIXELS (font
24339 ? normal_char_height (font, -1)
24340 : FRAME_LINE_HEIGHT (it->f));
24341 if (EQ (prop, Qwidth))
24342 return OK_PIXELS (font
24343 ? FONT_WIDTH (font)
24344 : FRAME_COLUMN_WIDTH (it->f));
24345 #else
24346 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
24347 return OK_PIXELS (1);
24348 #endif
24349
24350 if (EQ (prop, Qtext))
24351 return OK_PIXELS (width_p
24352 ? window_box_width (it->w, TEXT_AREA)
24353 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
24354
24355 if (align_to && *align_to < 0)
24356 {
24357 *res = 0;
24358 if (EQ (prop, Qleft))
24359 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
24360 if (EQ (prop, Qright))
24361 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
24362 if (EQ (prop, Qcenter))
24363 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
24364 + window_box_width (it->w, TEXT_AREA) / 2);
24365 if (EQ (prop, Qleft_fringe))
24366 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24367 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
24368 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
24369 if (EQ (prop, Qright_fringe))
24370 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24371 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
24372 : window_box_right_offset (it->w, TEXT_AREA));
24373 if (EQ (prop, Qleft_margin))
24374 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
24375 if (EQ (prop, Qright_margin))
24376 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
24377 if (EQ (prop, Qscroll_bar))
24378 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
24379 ? 0
24380 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
24381 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
24382 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
24383 : 0)));
24384 }
24385 else
24386 {
24387 if (EQ (prop, Qleft_fringe))
24388 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
24389 if (EQ (prop, Qright_fringe))
24390 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
24391 if (EQ (prop, Qleft_margin))
24392 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
24393 if (EQ (prop, Qright_margin))
24394 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
24395 if (EQ (prop, Qscroll_bar))
24396 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
24397 }
24398
24399 prop = buffer_local_value (prop, it->w->contents);
24400 if (EQ (prop, Qunbound))
24401 prop = Qnil;
24402 }
24403
24404 if (NUMBERP (prop))
24405 {
24406 int base_unit = (width_p
24407 ? FRAME_COLUMN_WIDTH (it->f)
24408 : FRAME_LINE_HEIGHT (it->f));
24409 return OK_PIXELS (XFLOATINT (prop) * base_unit);
24410 }
24411
24412 if (CONSP (prop))
24413 {
24414 Lisp_Object car = XCAR (prop);
24415 Lisp_Object cdr = XCDR (prop);
24416
24417 if (SYMBOLP (car))
24418 {
24419 #ifdef HAVE_WINDOW_SYSTEM
24420 if (FRAME_WINDOW_P (it->f)
24421 && valid_image_p (prop))
24422 {
24423 ptrdiff_t id = lookup_image (it->f, prop);
24424 struct image *img = IMAGE_FROM_ID (it->f, id);
24425
24426 return OK_PIXELS (width_p ? img->width : img->height);
24427 }
24428 if (FRAME_WINDOW_P (it->f) && valid_xwidget_spec_p (prop))
24429 {
24430 // TODO: Don't return dummy size.
24431 return OK_PIXELS (100);
24432 }
24433 #endif
24434 if (EQ (car, Qplus) || EQ (car, Qminus))
24435 {
24436 bool first = true;
24437 double px;
24438
24439 pixels = 0;
24440 while (CONSP (cdr))
24441 {
24442 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
24443 font, width_p, align_to))
24444 return false;
24445 if (first)
24446 pixels = (EQ (car, Qplus) ? px : -px), first = false;
24447 else
24448 pixels += px;
24449 cdr = XCDR (cdr);
24450 }
24451 if (EQ (car, Qminus))
24452 pixels = -pixels;
24453 return OK_PIXELS (pixels);
24454 }
24455
24456 car = buffer_local_value (car, it->w->contents);
24457 if (EQ (car, Qunbound))
24458 car = Qnil;
24459 }
24460
24461 if (NUMBERP (car))
24462 {
24463 double fact;
24464 pixels = XFLOATINT (car);
24465 if (NILP (cdr))
24466 return OK_PIXELS (pixels);
24467 if (calc_pixel_width_or_height (&fact, it, cdr,
24468 font, width_p, align_to))
24469 return OK_PIXELS (pixels * fact);
24470 return false;
24471 }
24472
24473 return false;
24474 }
24475
24476 return false;
24477 }
24478
24479 void
24480 get_font_ascent_descent (struct font *font, int *ascent, int *descent)
24481 {
24482 #ifdef HAVE_WINDOW_SYSTEM
24483 normal_char_ascent_descent (font, -1, ascent, descent);
24484 #else
24485 *ascent = 1;
24486 *descent = 0;
24487 #endif
24488 }
24489
24490 \f
24491 /***********************************************************************
24492 Glyph Display
24493 ***********************************************************************/
24494
24495 #ifdef HAVE_WINDOW_SYSTEM
24496
24497 #ifdef GLYPH_DEBUG
24498
24499 void
24500 dump_glyph_string (struct glyph_string *s)
24501 {
24502 fprintf (stderr, "glyph string\n");
24503 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
24504 s->x, s->y, s->width, s->height);
24505 fprintf (stderr, " ybase = %d\n", s->ybase);
24506 fprintf (stderr, " hl = %d\n", s->hl);
24507 fprintf (stderr, " left overhang = %d, right = %d\n",
24508 s->left_overhang, s->right_overhang);
24509 fprintf (stderr, " nchars = %d\n", s->nchars);
24510 fprintf (stderr, " extends to end of line = %d\n",
24511 s->extends_to_end_of_line_p);
24512 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
24513 fprintf (stderr, " bg width = %d\n", s->background_width);
24514 }
24515
24516 #endif /* GLYPH_DEBUG */
24517
24518 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24519 of XChar2b structures for S; it can't be allocated in
24520 init_glyph_string because it must be allocated via `alloca'. W
24521 is the window on which S is drawn. ROW and AREA are the glyph row
24522 and area within the row from which S is constructed. START is the
24523 index of the first glyph structure covered by S. HL is a
24524 face-override for drawing S. */
24525
24526 #ifdef HAVE_NTGUI
24527 #define OPTIONAL_HDC(hdc) HDC hdc,
24528 #define DECLARE_HDC(hdc) HDC hdc;
24529 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24530 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24531 #endif
24532
24533 #ifndef OPTIONAL_HDC
24534 #define OPTIONAL_HDC(hdc)
24535 #define DECLARE_HDC(hdc)
24536 #define ALLOCATE_HDC(hdc, f)
24537 #define RELEASE_HDC(hdc, f)
24538 #endif
24539
24540 static void
24541 init_glyph_string (struct glyph_string *s,
24542 OPTIONAL_HDC (hdc)
24543 XChar2b *char2b, struct window *w, struct glyph_row *row,
24544 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
24545 {
24546 memset (s, 0, sizeof *s);
24547 s->w = w;
24548 s->f = XFRAME (w->frame);
24549 #ifdef HAVE_NTGUI
24550 s->hdc = hdc;
24551 #endif
24552 s->display = FRAME_X_DISPLAY (s->f);
24553 s->window = FRAME_X_WINDOW (s->f);
24554 s->char2b = char2b;
24555 s->hl = hl;
24556 s->row = row;
24557 s->area = area;
24558 s->first_glyph = row->glyphs[area] + start;
24559 s->height = row->height;
24560 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
24561 s->ybase = s->y + row->ascent;
24562 }
24563
24564
24565 /* Append the list of glyph strings with head H and tail T to the list
24566 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24567
24568 static void
24569 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24570 struct glyph_string *h, struct glyph_string *t)
24571 {
24572 if (h)
24573 {
24574 if (*head)
24575 (*tail)->next = h;
24576 else
24577 *head = h;
24578 h->prev = *tail;
24579 *tail = t;
24580 }
24581 }
24582
24583
24584 /* Prepend the list of glyph strings with head H and tail T to the
24585 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24586 result. */
24587
24588 static void
24589 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24590 struct glyph_string *h, struct glyph_string *t)
24591 {
24592 if (h)
24593 {
24594 if (*head)
24595 (*head)->prev = t;
24596 else
24597 *tail = t;
24598 t->next = *head;
24599 *head = h;
24600 }
24601 }
24602
24603
24604 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24605 Set *HEAD and *TAIL to the resulting list. */
24606
24607 static void
24608 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
24609 struct glyph_string *s)
24610 {
24611 s->next = s->prev = NULL;
24612 append_glyph_string_lists (head, tail, s, s);
24613 }
24614
24615
24616 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24617 The encoding of C is returned in *CHAR2B. DISPLAY_P means
24618 make sure that X resources for the face returned are allocated.
24619 Value is a pointer to a realized face that is ready for display if
24620 DISPLAY_P. */
24621
24622 static struct face *
24623 get_char_face_and_encoding (struct frame *f, int c, int face_id,
24624 XChar2b *char2b, bool display_p)
24625 {
24626 struct face *face = FACE_FROM_ID (f, face_id);
24627 unsigned code = 0;
24628
24629 if (face->font)
24630 {
24631 code = face->font->driver->encode_char (face->font, c);
24632
24633 if (code == FONT_INVALID_CODE)
24634 code = 0;
24635 }
24636 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24637
24638 /* Make sure X resources of the face are allocated. */
24639 #ifdef HAVE_X_WINDOWS
24640 if (display_p)
24641 #endif
24642 {
24643 eassert (face != NULL);
24644 prepare_face_for_display (f, face);
24645 }
24646
24647 return face;
24648 }
24649
24650
24651 /* Get face and two-byte form of character glyph GLYPH on frame F.
24652 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24653 a pointer to a realized face that is ready for display. */
24654
24655 static struct face *
24656 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
24657 XChar2b *char2b)
24658 {
24659 struct face *face;
24660 unsigned code = 0;
24661
24662 eassert (glyph->type == CHAR_GLYPH);
24663 face = FACE_FROM_ID (f, glyph->face_id);
24664
24665 /* Make sure X resources of the face are allocated. */
24666 prepare_face_for_display (f, face);
24667
24668 if (face->font)
24669 {
24670 if (CHAR_BYTE8_P (glyph->u.ch))
24671 code = CHAR_TO_BYTE8 (glyph->u.ch);
24672 else
24673 code = face->font->driver->encode_char (face->font, glyph->u.ch);
24674
24675 if (code == FONT_INVALID_CODE)
24676 code = 0;
24677 }
24678
24679 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24680 return face;
24681 }
24682
24683
24684 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24685 Return true iff FONT has a glyph for C. */
24686
24687 static bool
24688 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
24689 {
24690 unsigned code;
24691
24692 if (CHAR_BYTE8_P (c))
24693 code = CHAR_TO_BYTE8 (c);
24694 else
24695 code = font->driver->encode_char (font, c);
24696
24697 if (code == FONT_INVALID_CODE)
24698 return false;
24699 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24700 return true;
24701 }
24702
24703
24704 /* Fill glyph string S with composition components specified by S->cmp.
24705
24706 BASE_FACE is the base face of the composition.
24707 S->cmp_from is the index of the first component for S.
24708
24709 OVERLAPS non-zero means S should draw the foreground only, and use
24710 its physical height for clipping. See also draw_glyphs.
24711
24712 Value is the index of a component not in S. */
24713
24714 static int
24715 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
24716 int overlaps)
24717 {
24718 int i;
24719 /* For all glyphs of this composition, starting at the offset
24720 S->cmp_from, until we reach the end of the definition or encounter a
24721 glyph that requires the different face, add it to S. */
24722 struct face *face;
24723
24724 eassert (s);
24725
24726 s->for_overlaps = overlaps;
24727 s->face = NULL;
24728 s->font = NULL;
24729 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
24730 {
24731 int c = COMPOSITION_GLYPH (s->cmp, i);
24732
24733 /* TAB in a composition means display glyphs with padding space
24734 on the left or right. */
24735 if (c != '\t')
24736 {
24737 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
24738 -1, Qnil);
24739
24740 face = get_char_face_and_encoding (s->f, c, face_id,
24741 s->char2b + i, true);
24742 if (face)
24743 {
24744 if (! s->face)
24745 {
24746 s->face = face;
24747 s->font = s->face->font;
24748 }
24749 else if (s->face != face)
24750 break;
24751 }
24752 }
24753 ++s->nchars;
24754 }
24755 s->cmp_to = i;
24756
24757 if (s->face == NULL)
24758 {
24759 s->face = base_face->ascii_face;
24760 s->font = s->face->font;
24761 }
24762
24763 /* All glyph strings for the same composition has the same width,
24764 i.e. the width set for the first component of the composition. */
24765 s->width = s->first_glyph->pixel_width;
24766
24767 /* If the specified font could not be loaded, use the frame's
24768 default font, but record the fact that we couldn't load it in
24769 the glyph string so that we can draw rectangles for the
24770 characters of the glyph string. */
24771 if (s->font == NULL)
24772 {
24773 s->font_not_found_p = true;
24774 s->font = FRAME_FONT (s->f);
24775 }
24776
24777 /* Adjust base line for subscript/superscript text. */
24778 s->ybase += s->first_glyph->voffset;
24779
24780 return s->cmp_to;
24781 }
24782
24783 static int
24784 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
24785 int start, int end, int overlaps)
24786 {
24787 struct glyph *glyph, *last;
24788 Lisp_Object lgstring;
24789 int i;
24790
24791 s->for_overlaps = overlaps;
24792 glyph = s->row->glyphs[s->area] + start;
24793 last = s->row->glyphs[s->area] + end;
24794 s->cmp_id = glyph->u.cmp.id;
24795 s->cmp_from = glyph->slice.cmp.from;
24796 s->cmp_to = glyph->slice.cmp.to + 1;
24797 s->face = FACE_FROM_ID (s->f, face_id);
24798 lgstring = composition_gstring_from_id (s->cmp_id);
24799 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
24800 glyph++;
24801 while (glyph < last
24802 && glyph->u.cmp.automatic
24803 && glyph->u.cmp.id == s->cmp_id
24804 && s->cmp_to == glyph->slice.cmp.from)
24805 s->cmp_to = (glyph++)->slice.cmp.to + 1;
24806
24807 for (i = s->cmp_from; i < s->cmp_to; i++)
24808 {
24809 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
24810 unsigned code = LGLYPH_CODE (lglyph);
24811
24812 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
24813 }
24814 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
24815 return glyph - s->row->glyphs[s->area];
24816 }
24817
24818
24819 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24820 See the comment of fill_glyph_string for arguments.
24821 Value is the index of the first glyph not in S. */
24822
24823
24824 static int
24825 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
24826 int start, int end, int overlaps)
24827 {
24828 struct glyph *glyph, *last;
24829 int voffset;
24830
24831 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
24832 s->for_overlaps = overlaps;
24833 glyph = s->row->glyphs[s->area] + start;
24834 last = s->row->glyphs[s->area] + end;
24835 voffset = glyph->voffset;
24836 s->face = FACE_FROM_ID (s->f, face_id);
24837 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
24838 s->nchars = 1;
24839 s->width = glyph->pixel_width;
24840 glyph++;
24841 while (glyph < last
24842 && glyph->type == GLYPHLESS_GLYPH
24843 && glyph->voffset == voffset
24844 && glyph->face_id == face_id)
24845 {
24846 s->nchars++;
24847 s->width += glyph->pixel_width;
24848 glyph++;
24849 }
24850 s->ybase += voffset;
24851 return glyph - s->row->glyphs[s->area];
24852 }
24853
24854
24855 /* Fill glyph string S from a sequence of character glyphs.
24856
24857 FACE_ID is the face id of the string. START is the index of the
24858 first glyph to consider, END is the index of the last + 1.
24859 OVERLAPS non-zero means S should draw the foreground only, and use
24860 its physical height for clipping. See also draw_glyphs.
24861
24862 Value is the index of the first glyph not in S. */
24863
24864 static int
24865 fill_glyph_string (struct glyph_string *s, int face_id,
24866 int start, int end, int overlaps)
24867 {
24868 struct glyph *glyph, *last;
24869 int voffset;
24870 bool glyph_not_available_p;
24871
24872 eassert (s->f == XFRAME (s->w->frame));
24873 eassert (s->nchars == 0);
24874 eassert (start >= 0 && end > start);
24875
24876 s->for_overlaps = overlaps;
24877 glyph = s->row->glyphs[s->area] + start;
24878 last = s->row->glyphs[s->area] + end;
24879 voffset = glyph->voffset;
24880 s->padding_p = glyph->padding_p;
24881 glyph_not_available_p = glyph->glyph_not_available_p;
24882
24883 while (glyph < last
24884 && glyph->type == CHAR_GLYPH
24885 && glyph->voffset == voffset
24886 /* Same face id implies same font, nowadays. */
24887 && glyph->face_id == face_id
24888 && glyph->glyph_not_available_p == glyph_not_available_p)
24889 {
24890 s->face = get_glyph_face_and_encoding (s->f, glyph,
24891 s->char2b + s->nchars);
24892 ++s->nchars;
24893 eassert (s->nchars <= end - start);
24894 s->width += glyph->pixel_width;
24895 if (glyph++->padding_p != s->padding_p)
24896 break;
24897 }
24898
24899 s->font = s->face->font;
24900
24901 /* If the specified font could not be loaded, use the frame's font,
24902 but record the fact that we couldn't load it in
24903 S->font_not_found_p so that we can draw rectangles for the
24904 characters of the glyph string. */
24905 if (s->font == NULL || glyph_not_available_p)
24906 {
24907 s->font_not_found_p = true;
24908 s->font = FRAME_FONT (s->f);
24909 }
24910
24911 /* Adjust base line for subscript/superscript text. */
24912 s->ybase += voffset;
24913
24914 eassert (s->face && s->face->gc);
24915 return glyph - s->row->glyphs[s->area];
24916 }
24917
24918
24919 /* Fill glyph string S from image glyph S->first_glyph. */
24920
24921 static void
24922 fill_image_glyph_string (struct glyph_string *s)
24923 {
24924 eassert (s->first_glyph->type == IMAGE_GLYPH);
24925 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
24926 eassert (s->img);
24927 s->slice = s->first_glyph->slice.img;
24928 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24929 s->font = s->face->font;
24930 s->width = s->first_glyph->pixel_width;
24931
24932 /* Adjust base line for subscript/superscript text. */
24933 s->ybase += s->first_glyph->voffset;
24934 }
24935
24936
24937 #ifdef HAVE_XWIDGETS
24938 static void
24939 fill_xwidget_glyph_string (struct glyph_string *s)
24940 {
24941 eassert (s->first_glyph->type == XWIDGET_GLYPH);
24942 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24943 s->font = s->face->font;
24944 s->width = s->first_glyph->pixel_width;
24945 s->ybase += s->first_glyph->voffset;
24946 s->xwidget = s->first_glyph->u.xwidget;
24947 }
24948 #endif
24949 /* Fill glyph string S from a sequence of stretch glyphs.
24950
24951 START is the index of the first glyph to consider,
24952 END is the index of the last + 1.
24953
24954 Value is the index of the first glyph not in S. */
24955
24956 static int
24957 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
24958 {
24959 struct glyph *glyph, *last;
24960 int voffset, face_id;
24961
24962 eassert (s->first_glyph->type == STRETCH_GLYPH);
24963
24964 glyph = s->row->glyphs[s->area] + start;
24965 last = s->row->glyphs[s->area] + end;
24966 face_id = glyph->face_id;
24967 s->face = FACE_FROM_ID (s->f, face_id);
24968 s->font = s->face->font;
24969 s->width = glyph->pixel_width;
24970 s->nchars = 1;
24971 voffset = glyph->voffset;
24972
24973 for (++glyph;
24974 (glyph < last
24975 && glyph->type == STRETCH_GLYPH
24976 && glyph->voffset == voffset
24977 && glyph->face_id == face_id);
24978 ++glyph)
24979 s->width += glyph->pixel_width;
24980
24981 /* Adjust base line for subscript/superscript text. */
24982 s->ybase += voffset;
24983
24984 /* The case that face->gc == 0 is handled when drawing the glyph
24985 string by calling prepare_face_for_display. */
24986 eassert (s->face);
24987 return glyph - s->row->glyphs[s->area];
24988 }
24989
24990 static struct font_metrics *
24991 get_per_char_metric (struct font *font, XChar2b *char2b)
24992 {
24993 static struct font_metrics metrics;
24994 unsigned code;
24995
24996 if (! font)
24997 return NULL;
24998 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24999 if (code == FONT_INVALID_CODE)
25000 return NULL;
25001 font->driver->text_extents (font, &code, 1, &metrics);
25002 return &metrics;
25003 }
25004
25005 /* A subroutine that computes "normal" values of ASCENT and DESCENT
25006 for FONT. Values are taken from font-global ones, except for fonts
25007 that claim preposterously large values, but whose glyphs actually
25008 have reasonable dimensions. C is the character to use for metrics
25009 if the font-global values are too large; if C is negative, the
25010 function selects a default character. */
25011 static void
25012 normal_char_ascent_descent (struct font *font, int c, int *ascent, int *descent)
25013 {
25014 *ascent = FONT_BASE (font);
25015 *descent = FONT_DESCENT (font);
25016
25017 if (FONT_TOO_HIGH (font))
25018 {
25019 XChar2b char2b;
25020
25021 /* Get metrics of C, defaulting to a reasonably sized ASCII
25022 character. */
25023 if (get_char_glyph_code (c >= 0 ? c : '{', font, &char2b))
25024 {
25025 struct font_metrics *pcm = get_per_char_metric (font, &char2b);
25026
25027 if (!(pcm->width == 0 && pcm->rbearing == 0 && pcm->lbearing == 0))
25028 {
25029 /* We add 1 pixel to character dimensions as heuristics
25030 that produces nicer display, e.g. when the face has
25031 the box attribute. */
25032 *ascent = pcm->ascent + 1;
25033 *descent = pcm->descent + 1;
25034 }
25035 }
25036 }
25037 }
25038
25039 /* A subroutine that computes a reasonable "normal character height"
25040 for fonts that claim preposterously large vertical dimensions, but
25041 whose glyphs are actually reasonably sized. C is the character
25042 whose metrics to use for those fonts, or -1 for default
25043 character. */
25044 static int
25045 normal_char_height (struct font *font, int c)
25046 {
25047 int ascent, descent;
25048
25049 normal_char_ascent_descent (font, c, &ascent, &descent);
25050
25051 return ascent + descent;
25052 }
25053
25054 /* EXPORT for RIF:
25055 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
25056 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
25057 assumed to be zero. */
25058
25059 void
25060 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
25061 {
25062 *left = *right = 0;
25063
25064 if (glyph->type == CHAR_GLYPH)
25065 {
25066 XChar2b char2b;
25067 struct face *face = get_glyph_face_and_encoding (f, glyph, &char2b);
25068 if (face->font)
25069 {
25070 struct font_metrics *pcm = get_per_char_metric (face->font, &char2b);
25071 if (pcm)
25072 {
25073 if (pcm->rbearing > pcm->width)
25074 *right = pcm->rbearing - pcm->width;
25075 if (pcm->lbearing < 0)
25076 *left = -pcm->lbearing;
25077 }
25078 }
25079 }
25080 else if (glyph->type == COMPOSITE_GLYPH)
25081 {
25082 if (! glyph->u.cmp.automatic)
25083 {
25084 struct composition *cmp = composition_table[glyph->u.cmp.id];
25085
25086 if (cmp->rbearing > cmp->pixel_width)
25087 *right = cmp->rbearing - cmp->pixel_width;
25088 if (cmp->lbearing < 0)
25089 *left = - cmp->lbearing;
25090 }
25091 else
25092 {
25093 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
25094 struct font_metrics metrics;
25095
25096 composition_gstring_width (gstring, glyph->slice.cmp.from,
25097 glyph->slice.cmp.to + 1, &metrics);
25098 if (metrics.rbearing > metrics.width)
25099 *right = metrics.rbearing - metrics.width;
25100 if (metrics.lbearing < 0)
25101 *left = - metrics.lbearing;
25102 }
25103 }
25104 }
25105
25106
25107 /* Return the index of the first glyph preceding glyph string S that
25108 is overwritten by S because of S's left overhang. Value is -1
25109 if no glyphs are overwritten. */
25110
25111 static int
25112 left_overwritten (struct glyph_string *s)
25113 {
25114 int k;
25115
25116 if (s->left_overhang)
25117 {
25118 int x = 0, i;
25119 struct glyph *glyphs = s->row->glyphs[s->area];
25120 int first = s->first_glyph - glyphs;
25121
25122 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
25123 x -= glyphs[i].pixel_width;
25124
25125 k = i + 1;
25126 }
25127 else
25128 k = -1;
25129
25130 return k;
25131 }
25132
25133
25134 /* Return the index of the first glyph preceding glyph string S that
25135 is overwriting S because of its right overhang. Value is -1 if no
25136 glyph in front of S overwrites S. */
25137
25138 static int
25139 left_overwriting (struct glyph_string *s)
25140 {
25141 int i, k, x;
25142 struct glyph *glyphs = s->row->glyphs[s->area];
25143 int first = s->first_glyph - glyphs;
25144
25145 k = -1;
25146 x = 0;
25147 for (i = first - 1; i >= 0; --i)
25148 {
25149 int left, right;
25150 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
25151 if (x + right > 0)
25152 k = i;
25153 x -= glyphs[i].pixel_width;
25154 }
25155
25156 return k;
25157 }
25158
25159
25160 /* Return the index of the last glyph following glyph string S that is
25161 overwritten by S because of S's right overhang. Value is -1 if
25162 no such glyph is found. */
25163
25164 static int
25165 right_overwritten (struct glyph_string *s)
25166 {
25167 int k = -1;
25168
25169 if (s->right_overhang)
25170 {
25171 int x = 0, i;
25172 struct glyph *glyphs = s->row->glyphs[s->area];
25173 int first = (s->first_glyph - glyphs
25174 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
25175 int end = s->row->used[s->area];
25176
25177 for (i = first; i < end && s->right_overhang > x; ++i)
25178 x += glyphs[i].pixel_width;
25179
25180 k = i;
25181 }
25182
25183 return k;
25184 }
25185
25186
25187 /* Return the index of the last glyph following glyph string S that
25188 overwrites S because of its left overhang. Value is negative
25189 if no such glyph is found. */
25190
25191 static int
25192 right_overwriting (struct glyph_string *s)
25193 {
25194 int i, k, x;
25195 int end = s->row->used[s->area];
25196 struct glyph *glyphs = s->row->glyphs[s->area];
25197 int first = (s->first_glyph - glyphs
25198 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
25199
25200 k = -1;
25201 x = 0;
25202 for (i = first; i < end; ++i)
25203 {
25204 int left, right;
25205 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
25206 if (x - left < 0)
25207 k = i;
25208 x += glyphs[i].pixel_width;
25209 }
25210
25211 return k;
25212 }
25213
25214
25215 /* Set background width of glyph string S. START is the index of the
25216 first glyph following S. LAST_X is the right-most x-position + 1
25217 in the drawing area. */
25218
25219 static void
25220 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
25221 {
25222 /* If the face of this glyph string has to be drawn to the end of
25223 the drawing area, set S->extends_to_end_of_line_p. */
25224
25225 if (start == s->row->used[s->area]
25226 && ((s->row->fill_line_p
25227 && (s->hl == DRAW_NORMAL_TEXT
25228 || s->hl == DRAW_IMAGE_RAISED
25229 || s->hl == DRAW_IMAGE_SUNKEN))
25230 || s->hl == DRAW_MOUSE_FACE))
25231 s->extends_to_end_of_line_p = true;
25232
25233 /* If S extends its face to the end of the line, set its
25234 background_width to the distance to the right edge of the drawing
25235 area. */
25236 if (s->extends_to_end_of_line_p)
25237 s->background_width = last_x - s->x + 1;
25238 else
25239 s->background_width = s->width;
25240 }
25241
25242
25243 /* Compute overhangs and x-positions for glyph string S and its
25244 predecessors, or successors. X is the starting x-position for S.
25245 BACKWARD_P means process predecessors. */
25246
25247 static void
25248 compute_overhangs_and_x (struct glyph_string *s, int x, bool backward_p)
25249 {
25250 if (backward_p)
25251 {
25252 while (s)
25253 {
25254 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
25255 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
25256 x -= s->width;
25257 s->x = x;
25258 s = s->prev;
25259 }
25260 }
25261 else
25262 {
25263 while (s)
25264 {
25265 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
25266 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
25267 s->x = x;
25268 x += s->width;
25269 s = s->next;
25270 }
25271 }
25272 }
25273
25274
25275
25276 /* The following macros are only called from draw_glyphs below.
25277 They reference the following parameters of that function directly:
25278 `w', `row', `area', and `overlap_p'
25279 as well as the following local variables:
25280 `s', `f', and `hdc' (in W32) */
25281
25282 #ifdef HAVE_NTGUI
25283 /* On W32, silently add local `hdc' variable to argument list of
25284 init_glyph_string. */
25285 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25286 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
25287 #else
25288 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
25289 init_glyph_string (s, char2b, w, row, area, start, hl)
25290 #endif
25291
25292 /* Add a glyph string for a stretch glyph to the list of strings
25293 between HEAD and TAIL. START is the index of the stretch glyph in
25294 row area AREA of glyph row ROW. END is the index of the last glyph
25295 in that glyph row area. X is the current output position assigned
25296 to the new glyph string constructed. HL overrides that face of the
25297 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25298 is the right-most x-position of the drawing area. */
25299
25300 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
25301 and below -- keep them on one line. */
25302 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25303 do \
25304 { \
25305 s = alloca (sizeof *s); \
25306 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25307 START = fill_stretch_glyph_string (s, START, END); \
25308 append_glyph_string (&HEAD, &TAIL, s); \
25309 s->x = (X); \
25310 } \
25311 while (false)
25312
25313
25314 /* Add a glyph string for an image glyph to the list of strings
25315 between HEAD and TAIL. START is the index of the image glyph in
25316 row area AREA of glyph row ROW. END is the index of the last glyph
25317 in that glyph row area. X is the current output position assigned
25318 to the new glyph string constructed. HL overrides that face of the
25319 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
25320 is the right-most x-position of the drawing area. */
25321
25322 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25323 do \
25324 { \
25325 s = alloca (sizeof *s); \
25326 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25327 fill_image_glyph_string (s); \
25328 append_glyph_string (&HEAD, &TAIL, s); \
25329 ++START; \
25330 s->x = (X); \
25331 } \
25332 while (false)
25333
25334 #ifndef HAVE_XWIDGETS
25335 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25336 eassume (false)
25337 #else
25338 # define BUILD_XWIDGET_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25339 do \
25340 { \
25341 s = alloca (sizeof *s); \
25342 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25343 fill_xwidget_glyph_string (s); \
25344 append_glyph_string (&(HEAD), &(TAIL), s); \
25345 ++(START); \
25346 s->x = (X); \
25347 } \
25348 while (false)
25349 #endif
25350
25351 /* Add a glyph string for a sequence of character glyphs to the list
25352 of strings between HEAD and TAIL. START is the index of the first
25353 glyph in row area AREA of glyph row ROW that is part of the new
25354 glyph string. END is the index of the last glyph in that glyph row
25355 area. X is the current output position assigned to the new glyph
25356 string constructed. HL overrides that face of the glyph; e.g. it
25357 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
25358 right-most x-position of the drawing area. */
25359
25360 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25361 do \
25362 { \
25363 int face_id; \
25364 XChar2b *char2b; \
25365 \
25366 face_id = (row)->glyphs[area][START].face_id; \
25367 \
25368 s = alloca (sizeof *s); \
25369 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
25370 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25371 append_glyph_string (&HEAD, &TAIL, s); \
25372 s->x = (X); \
25373 START = fill_glyph_string (s, face_id, START, END, overlaps); \
25374 } \
25375 while (false)
25376
25377
25378 /* Add a glyph string for a composite sequence to the list of strings
25379 between HEAD and TAIL. START is the index of the first glyph in
25380 row area AREA of glyph row ROW that is part of the new glyph
25381 string. END is the index of the last glyph in that glyph row area.
25382 X is the current output position assigned to the new glyph string
25383 constructed. HL overrides that face of the glyph; e.g. it is
25384 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
25385 x-position of the drawing area. */
25386
25387 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25388 do { \
25389 int face_id = (row)->glyphs[area][START].face_id; \
25390 struct face *base_face = FACE_FROM_ID (f, face_id); \
25391 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
25392 struct composition *cmp = composition_table[cmp_id]; \
25393 XChar2b *char2b; \
25394 struct glyph_string *first_s = NULL; \
25395 int n; \
25396 \
25397 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
25398 \
25399 /* Make glyph_strings for each glyph sequence that is drawable by \
25400 the same face, and append them to HEAD/TAIL. */ \
25401 for (n = 0; n < cmp->glyph_len;) \
25402 { \
25403 s = alloca (sizeof *s); \
25404 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25405 append_glyph_string (&(HEAD), &(TAIL), s); \
25406 s->cmp = cmp; \
25407 s->cmp_from = n; \
25408 s->x = (X); \
25409 if (n == 0) \
25410 first_s = s; \
25411 n = fill_composite_glyph_string (s, base_face, overlaps); \
25412 } \
25413 \
25414 ++START; \
25415 s = first_s; \
25416 } while (false)
25417
25418
25419 /* Add a glyph string for a glyph-string sequence to the list of strings
25420 between HEAD and TAIL. */
25421
25422 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25423 do { \
25424 int face_id; \
25425 XChar2b *char2b; \
25426 Lisp_Object gstring; \
25427 \
25428 face_id = (row)->glyphs[area][START].face_id; \
25429 gstring = (composition_gstring_from_id \
25430 ((row)->glyphs[area][START].u.cmp.id)); \
25431 s = alloca (sizeof *s); \
25432 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
25433 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
25434 append_glyph_string (&(HEAD), &(TAIL), s); \
25435 s->x = (X); \
25436 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
25437 } while (false)
25438
25439
25440 /* Add a glyph string for a sequence of glyphless character's glyphs
25441 to the list of strings between HEAD and TAIL. The meanings of
25442 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
25443
25444 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
25445 do \
25446 { \
25447 int face_id; \
25448 \
25449 face_id = (row)->glyphs[area][START].face_id; \
25450 \
25451 s = alloca (sizeof *s); \
25452 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
25453 append_glyph_string (&HEAD, &TAIL, s); \
25454 s->x = (X); \
25455 START = fill_glyphless_glyph_string (s, face_id, START, END, \
25456 overlaps); \
25457 } \
25458 while (false)
25459
25460
25461 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
25462 of AREA of glyph row ROW on window W between indices START and END.
25463 HL overrides the face for drawing glyph strings, e.g. it is
25464 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
25465 x-positions of the drawing area.
25466
25467 This is an ugly monster macro construct because we must use alloca
25468 to allocate glyph strings (because draw_glyphs can be called
25469 asynchronously). */
25470
25471 #define BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25472 do \
25473 { \
25474 HEAD = TAIL = NULL; \
25475 while (START < END) \
25476 { \
25477 struct glyph *first_glyph = (row)->glyphs[area] + START; \
25478 switch (first_glyph->type) \
25479 { \
25480 case CHAR_GLYPH: \
25481 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
25482 HL, X, LAST_X); \
25483 break; \
25484 \
25485 case COMPOSITE_GLYPH: \
25486 if (first_glyph->u.cmp.automatic) \
25487 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
25488 HL, X, LAST_X); \
25489 else \
25490 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
25491 HL, X, LAST_X); \
25492 break; \
25493 \
25494 case STRETCH_GLYPH: \
25495 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
25496 HL, X, LAST_X); \
25497 break; \
25498 \
25499 case IMAGE_GLYPH: \
25500 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
25501 HL, X, LAST_X); \
25502 break;
25503
25504 #define BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25505 case XWIDGET_GLYPH: \
25506 BUILD_XWIDGET_GLYPH_STRING (START, END, HEAD, TAIL, \
25507 HL, X, LAST_X); \
25508 break;
25509
25510 #define BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X) \
25511 case GLYPHLESS_GLYPH: \
25512 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
25513 HL, X, LAST_X); \
25514 break; \
25515 \
25516 default: \
25517 emacs_abort (); \
25518 } \
25519 \
25520 if (s) \
25521 { \
25522 set_glyph_string_background_width (s, START, LAST_X); \
25523 (X) += s->width; \
25524 } \
25525 } \
25526 } while (false)
25527
25528
25529 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
25530 BUILD_GLYPH_STRINGS_1(START, END, HEAD, TAIL, HL, X, LAST_X) \
25531 BUILD_GLYPH_STRINGS_XW(START, END, HEAD, TAIL, HL, X, LAST_X) \
25532 BUILD_GLYPH_STRINGS_2(START, END, HEAD, TAIL, HL, X, LAST_X)
25533
25534
25535 /* Draw glyphs between START and END in AREA of ROW on window W,
25536 starting at x-position X. X is relative to AREA in W. HL is a
25537 face-override with the following meaning:
25538
25539 DRAW_NORMAL_TEXT draw normally
25540 DRAW_CURSOR draw in cursor face
25541 DRAW_MOUSE_FACE draw in mouse face.
25542 DRAW_INVERSE_VIDEO draw in mode line face
25543 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
25544 DRAW_IMAGE_RAISED draw an image with a raised relief around it
25545
25546 If OVERLAPS is non-zero, draw only the foreground of characters and
25547 clip to the physical height of ROW. Non-zero value also defines
25548 the overlapping part to be drawn:
25549
25550 OVERLAPS_PRED overlap with preceding rows
25551 OVERLAPS_SUCC overlap with succeeding rows
25552 OVERLAPS_BOTH overlap with both preceding/succeeding rows
25553 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
25554
25555 Value is the x-position reached, relative to AREA of W. */
25556
25557 static int
25558 draw_glyphs (struct window *w, int x, struct glyph_row *row,
25559 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
25560 enum draw_glyphs_face hl, int overlaps)
25561 {
25562 struct glyph_string *head, *tail;
25563 struct glyph_string *s;
25564 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
25565 int i, j, x_reached, last_x, area_left = 0;
25566 struct frame *f = XFRAME (WINDOW_FRAME (w));
25567 DECLARE_HDC (hdc);
25568
25569 ALLOCATE_HDC (hdc, f);
25570
25571 /* Let's rather be paranoid than getting a SEGV. */
25572 end = min (end, row->used[area]);
25573 start = clip_to_bounds (0, start, end);
25574
25575 /* Translate X to frame coordinates. Set last_x to the right
25576 end of the drawing area. */
25577 if (row->full_width_p)
25578 {
25579 /* X is relative to the left edge of W, without scroll bars
25580 or fringes. */
25581 area_left = WINDOW_LEFT_EDGE_X (w);
25582 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
25583 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
25584 }
25585 else
25586 {
25587 area_left = window_box_left (w, area);
25588 last_x = area_left + window_box_width (w, area);
25589 }
25590 x += area_left;
25591
25592 /* Build a doubly-linked list of glyph_string structures between
25593 head and tail from what we have to draw. Note that the macro
25594 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25595 the reason we use a separate variable `i'. */
25596 i = start;
25597 USE_SAFE_ALLOCA;
25598 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
25599 if (tail)
25600 x_reached = tail->x + tail->background_width;
25601 else
25602 x_reached = x;
25603
25604 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25605 the row, redraw some glyphs in front or following the glyph
25606 strings built above. */
25607 if (head && !overlaps && row->contains_overlapping_glyphs_p)
25608 {
25609 struct glyph_string *h, *t;
25610 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
25611 int mouse_beg_col UNINIT, mouse_end_col UNINIT;
25612 bool check_mouse_face = false;
25613 int dummy_x = 0;
25614
25615 /* If mouse highlighting is on, we may need to draw adjacent
25616 glyphs using mouse-face highlighting. */
25617 if (area == TEXT_AREA && row->mouse_face_p
25618 && hlinfo->mouse_face_beg_row >= 0
25619 && hlinfo->mouse_face_end_row >= 0)
25620 {
25621 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
25622
25623 if (row_vpos >= hlinfo->mouse_face_beg_row
25624 && row_vpos <= hlinfo->mouse_face_end_row)
25625 {
25626 check_mouse_face = true;
25627 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
25628 ? hlinfo->mouse_face_beg_col : 0;
25629 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
25630 ? hlinfo->mouse_face_end_col
25631 : row->used[TEXT_AREA];
25632 }
25633 }
25634
25635 /* Compute overhangs for all glyph strings. */
25636 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
25637 for (s = head; s; s = s->next)
25638 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
25639
25640 /* Prepend glyph strings for glyphs in front of the first glyph
25641 string that are overwritten because of the first glyph
25642 string's left overhang. The background of all strings
25643 prepended must be drawn because the first glyph string
25644 draws over it. */
25645 i = left_overwritten (head);
25646 if (i >= 0)
25647 {
25648 enum draw_glyphs_face overlap_hl;
25649
25650 /* If this row contains mouse highlighting, attempt to draw
25651 the overlapped glyphs with the correct highlight. This
25652 code fails if the overlap encompasses more than one glyph
25653 and mouse-highlight spans only some of these glyphs.
25654 However, making it work perfectly involves a lot more
25655 code, and I don't know if the pathological case occurs in
25656 practice, so we'll stick to this for now. --- cyd */
25657 if (check_mouse_face
25658 && mouse_beg_col < start && mouse_end_col > i)
25659 overlap_hl = DRAW_MOUSE_FACE;
25660 else
25661 overlap_hl = DRAW_NORMAL_TEXT;
25662
25663 if (hl != overlap_hl)
25664 clip_head = head;
25665 j = i;
25666 BUILD_GLYPH_STRINGS (j, start, h, t,
25667 overlap_hl, dummy_x, last_x);
25668 start = i;
25669 compute_overhangs_and_x (t, head->x, true);
25670 prepend_glyph_string_lists (&head, &tail, h, t);
25671 if (clip_head == NULL)
25672 clip_head = head;
25673 }
25674
25675 /* Prepend glyph strings for glyphs in front of the first glyph
25676 string that overwrite that glyph string because of their
25677 right overhang. For these strings, only the foreground must
25678 be drawn, because it draws over the glyph string at `head'.
25679 The background must not be drawn because this would overwrite
25680 right overhangs of preceding glyphs for which no glyph
25681 strings exist. */
25682 i = left_overwriting (head);
25683 if (i >= 0)
25684 {
25685 enum draw_glyphs_face overlap_hl;
25686
25687 if (check_mouse_face
25688 && mouse_beg_col < start && mouse_end_col > i)
25689 overlap_hl = DRAW_MOUSE_FACE;
25690 else
25691 overlap_hl = DRAW_NORMAL_TEXT;
25692
25693 if (hl == overlap_hl || clip_head == NULL)
25694 clip_head = head;
25695 BUILD_GLYPH_STRINGS (i, start, h, t,
25696 overlap_hl, dummy_x, last_x);
25697 for (s = h; s; s = s->next)
25698 s->background_filled_p = true;
25699 compute_overhangs_and_x (t, head->x, true);
25700 prepend_glyph_string_lists (&head, &tail, h, t);
25701 }
25702
25703 /* Append glyphs strings for glyphs following the last glyph
25704 string tail that are overwritten by tail. The background of
25705 these strings has to be drawn because tail's foreground draws
25706 over it. */
25707 i = right_overwritten (tail);
25708 if (i >= 0)
25709 {
25710 enum draw_glyphs_face overlap_hl;
25711
25712 if (check_mouse_face
25713 && mouse_beg_col < i && mouse_end_col > end)
25714 overlap_hl = DRAW_MOUSE_FACE;
25715 else
25716 overlap_hl = DRAW_NORMAL_TEXT;
25717
25718 if (hl != overlap_hl)
25719 clip_tail = tail;
25720 BUILD_GLYPH_STRINGS (end, i, h, t,
25721 overlap_hl, x, last_x);
25722 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25723 we don't have `end = i;' here. */
25724 compute_overhangs_and_x (h, tail->x + tail->width, false);
25725 append_glyph_string_lists (&head, &tail, h, t);
25726 if (clip_tail == NULL)
25727 clip_tail = tail;
25728 }
25729
25730 /* Append glyph strings for glyphs following the last glyph
25731 string tail that overwrite tail. The foreground of such
25732 glyphs has to be drawn because it writes into the background
25733 of tail. The background must not be drawn because it could
25734 paint over the foreground of following glyphs. */
25735 i = right_overwriting (tail);
25736 if (i >= 0)
25737 {
25738 enum draw_glyphs_face overlap_hl;
25739 if (check_mouse_face
25740 && mouse_beg_col < i && mouse_end_col > end)
25741 overlap_hl = DRAW_MOUSE_FACE;
25742 else
25743 overlap_hl = DRAW_NORMAL_TEXT;
25744
25745 if (hl == overlap_hl || clip_tail == NULL)
25746 clip_tail = tail;
25747 i++; /* We must include the Ith glyph. */
25748 BUILD_GLYPH_STRINGS (end, i, h, t,
25749 overlap_hl, x, last_x);
25750 for (s = h; s; s = s->next)
25751 s->background_filled_p = true;
25752 compute_overhangs_and_x (h, tail->x + tail->width, false);
25753 append_glyph_string_lists (&head, &tail, h, t);
25754 }
25755 if (clip_head || clip_tail)
25756 for (s = head; s; s = s->next)
25757 {
25758 s->clip_head = clip_head;
25759 s->clip_tail = clip_tail;
25760 }
25761 }
25762
25763 /* Draw all strings. */
25764 for (s = head; s; s = s->next)
25765 FRAME_RIF (f)->draw_glyph_string (s);
25766
25767 #ifndef HAVE_NS
25768 /* When focus a sole frame and move horizontally, this clears on_p
25769 causing a failure to erase prev cursor position. */
25770 if (area == TEXT_AREA
25771 && !row->full_width_p
25772 /* When drawing overlapping rows, only the glyph strings'
25773 foreground is drawn, which doesn't erase a cursor
25774 completely. */
25775 && !overlaps)
25776 {
25777 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
25778 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
25779 : (tail ? tail->x + tail->background_width : x));
25780 x0 -= area_left;
25781 x1 -= area_left;
25782
25783 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
25784 row->y, MATRIX_ROW_BOTTOM_Y (row));
25785 }
25786 #endif
25787
25788 /* Value is the x-position up to which drawn, relative to AREA of W.
25789 This doesn't include parts drawn because of overhangs. */
25790 if (row->full_width_p)
25791 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
25792 else
25793 x_reached -= area_left;
25794
25795 RELEASE_HDC (hdc, f);
25796
25797 SAFE_FREE ();
25798 return x_reached;
25799 }
25800
25801 /* Expand row matrix if too narrow. Don't expand if area
25802 is not present. */
25803
25804 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25805 { \
25806 if (!it->f->fonts_changed \
25807 && (it->glyph_row->glyphs[area] \
25808 < it->glyph_row->glyphs[area + 1])) \
25809 { \
25810 it->w->ncols_scale_factor++; \
25811 it->f->fonts_changed = true; \
25812 } \
25813 }
25814
25815 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25816 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25817
25818 static void
25819 append_glyph (struct it *it)
25820 {
25821 struct glyph *glyph;
25822 enum glyph_row_area area = it->area;
25823
25824 eassert (it->glyph_row);
25825 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
25826
25827 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25828 if (glyph < it->glyph_row->glyphs[area + 1])
25829 {
25830 /* If the glyph row is reversed, we need to prepend the glyph
25831 rather than append it. */
25832 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25833 {
25834 struct glyph *g;
25835
25836 /* Make room for the additional glyph. */
25837 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25838 g[1] = *g;
25839 glyph = it->glyph_row->glyphs[area];
25840 }
25841 glyph->charpos = CHARPOS (it->position);
25842 glyph->object = it->object;
25843 if (it->pixel_width > 0)
25844 {
25845 eassert (it->pixel_width <= SHRT_MAX);
25846 glyph->pixel_width = it->pixel_width;
25847 glyph->padding_p = false;
25848 }
25849 else
25850 {
25851 /* Assure at least 1-pixel width. Otherwise, cursor can't
25852 be displayed correctly. */
25853 glyph->pixel_width = 1;
25854 glyph->padding_p = true;
25855 }
25856 glyph->ascent = it->ascent;
25857 glyph->descent = it->descent;
25858 glyph->voffset = it->voffset;
25859 glyph->type = CHAR_GLYPH;
25860 glyph->avoid_cursor_p = it->avoid_cursor_p;
25861 glyph->multibyte_p = it->multibyte_p;
25862 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25863 {
25864 /* In R2L rows, the left and the right box edges need to be
25865 drawn in reverse direction. */
25866 glyph->right_box_line_p = it->start_of_box_run_p;
25867 glyph->left_box_line_p = it->end_of_box_run_p;
25868 }
25869 else
25870 {
25871 glyph->left_box_line_p = it->start_of_box_run_p;
25872 glyph->right_box_line_p = it->end_of_box_run_p;
25873 }
25874 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25875 || it->phys_descent > it->descent);
25876 glyph->glyph_not_available_p = it->glyph_not_available_p;
25877 glyph->face_id = it->face_id;
25878 glyph->u.ch = it->char_to_display;
25879 glyph->slice.img = null_glyph_slice;
25880 glyph->font_type = FONT_TYPE_UNKNOWN;
25881 if (it->bidi_p)
25882 {
25883 glyph->resolved_level = it->bidi_it.resolved_level;
25884 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25885 glyph->bidi_type = it->bidi_it.type;
25886 }
25887 else
25888 {
25889 glyph->resolved_level = 0;
25890 glyph->bidi_type = UNKNOWN_BT;
25891 }
25892 ++it->glyph_row->used[area];
25893 }
25894 else
25895 IT_EXPAND_MATRIX_WIDTH (it, area);
25896 }
25897
25898 /* Store one glyph for the composition IT->cmp_it.id in
25899 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25900 non-null. */
25901
25902 static void
25903 append_composite_glyph (struct it *it)
25904 {
25905 struct glyph *glyph;
25906 enum glyph_row_area area = it->area;
25907
25908 eassert (it->glyph_row);
25909
25910 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25911 if (glyph < it->glyph_row->glyphs[area + 1])
25912 {
25913 /* If the glyph row is reversed, we need to prepend the glyph
25914 rather than append it. */
25915 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
25916 {
25917 struct glyph *g;
25918
25919 /* Make room for the new glyph. */
25920 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25921 g[1] = *g;
25922 glyph = it->glyph_row->glyphs[it->area];
25923 }
25924 glyph->charpos = it->cmp_it.charpos;
25925 glyph->object = it->object;
25926 eassert (it->pixel_width <= SHRT_MAX);
25927 glyph->pixel_width = it->pixel_width;
25928 glyph->ascent = it->ascent;
25929 glyph->descent = it->descent;
25930 glyph->voffset = it->voffset;
25931 glyph->type = COMPOSITE_GLYPH;
25932 if (it->cmp_it.ch < 0)
25933 {
25934 glyph->u.cmp.automatic = false;
25935 glyph->u.cmp.id = it->cmp_it.id;
25936 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
25937 }
25938 else
25939 {
25940 glyph->u.cmp.automatic = true;
25941 glyph->u.cmp.id = it->cmp_it.id;
25942 glyph->slice.cmp.from = it->cmp_it.from;
25943 glyph->slice.cmp.to = it->cmp_it.to - 1;
25944 }
25945 glyph->avoid_cursor_p = it->avoid_cursor_p;
25946 glyph->multibyte_p = it->multibyte_p;
25947 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25948 {
25949 /* In R2L rows, the left and the right box edges need to be
25950 drawn in reverse direction. */
25951 glyph->right_box_line_p = it->start_of_box_run_p;
25952 glyph->left_box_line_p = it->end_of_box_run_p;
25953 }
25954 else
25955 {
25956 glyph->left_box_line_p = it->start_of_box_run_p;
25957 glyph->right_box_line_p = it->end_of_box_run_p;
25958 }
25959 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25960 || it->phys_descent > it->descent);
25961 glyph->padding_p = false;
25962 glyph->glyph_not_available_p = false;
25963 glyph->face_id = it->face_id;
25964 glyph->font_type = FONT_TYPE_UNKNOWN;
25965 if (it->bidi_p)
25966 {
25967 glyph->resolved_level = it->bidi_it.resolved_level;
25968 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25969 glyph->bidi_type = it->bidi_it.type;
25970 }
25971 ++it->glyph_row->used[area];
25972 }
25973 else
25974 IT_EXPAND_MATRIX_WIDTH (it, area);
25975 }
25976
25977
25978 /* Change IT->ascent and IT->height according to the setting of
25979 IT->voffset. */
25980
25981 static void
25982 take_vertical_position_into_account (struct it *it)
25983 {
25984 if (it->voffset)
25985 {
25986 if (it->voffset < 0)
25987 /* Increase the ascent so that we can display the text higher
25988 in the line. */
25989 it->ascent -= it->voffset;
25990 else
25991 /* Increase the descent so that we can display the text lower
25992 in the line. */
25993 it->descent += it->voffset;
25994 }
25995 }
25996
25997
25998 /* Produce glyphs/get display metrics for the image IT is loaded with.
25999 See the description of struct display_iterator in dispextern.h for
26000 an overview of struct display_iterator. */
26001
26002 static void
26003 produce_image_glyph (struct it *it)
26004 {
26005 struct image *img;
26006 struct face *face;
26007 int glyph_ascent, crop;
26008 struct glyph_slice slice;
26009
26010 eassert (it->what == IT_IMAGE);
26011
26012 face = FACE_FROM_ID (it->f, it->face_id);
26013 /* Make sure X resources of the face is loaded. */
26014 prepare_face_for_display (it->f, face);
26015
26016 if (it->image_id < 0)
26017 {
26018 /* Fringe bitmap. */
26019 it->ascent = it->phys_ascent = 0;
26020 it->descent = it->phys_descent = 0;
26021 it->pixel_width = 0;
26022 it->nglyphs = 0;
26023 return;
26024 }
26025
26026 img = IMAGE_FROM_ID (it->f, it->image_id);
26027 /* Make sure X resources of the image is loaded. */
26028 prepare_image_for_display (it->f, img);
26029
26030 slice.x = slice.y = 0;
26031 slice.width = img->width;
26032 slice.height = img->height;
26033
26034 if (INTEGERP (it->slice.x))
26035 slice.x = XINT (it->slice.x);
26036 else if (FLOATP (it->slice.x))
26037 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
26038
26039 if (INTEGERP (it->slice.y))
26040 slice.y = XINT (it->slice.y);
26041 else if (FLOATP (it->slice.y))
26042 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
26043
26044 if (INTEGERP (it->slice.width))
26045 slice.width = XINT (it->slice.width);
26046 else if (FLOATP (it->slice.width))
26047 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
26048
26049 if (INTEGERP (it->slice.height))
26050 slice.height = XINT (it->slice.height);
26051 else if (FLOATP (it->slice.height))
26052 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
26053
26054 if (slice.x >= img->width)
26055 slice.x = img->width;
26056 if (slice.y >= img->height)
26057 slice.y = img->height;
26058 if (slice.x + slice.width >= img->width)
26059 slice.width = img->width - slice.x;
26060 if (slice.y + slice.height > img->height)
26061 slice.height = img->height - slice.y;
26062
26063 if (slice.width == 0 || slice.height == 0)
26064 return;
26065
26066 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
26067
26068 it->descent = slice.height - glyph_ascent;
26069 if (slice.y == 0)
26070 it->descent += img->vmargin;
26071 if (slice.y + slice.height == img->height)
26072 it->descent += img->vmargin;
26073 it->phys_descent = it->descent;
26074
26075 it->pixel_width = slice.width;
26076 if (slice.x == 0)
26077 it->pixel_width += img->hmargin;
26078 if (slice.x + slice.width == img->width)
26079 it->pixel_width += img->hmargin;
26080
26081 /* It's quite possible for images to have an ascent greater than
26082 their height, so don't get confused in that case. */
26083 if (it->descent < 0)
26084 it->descent = 0;
26085
26086 it->nglyphs = 1;
26087
26088 if (face->box != FACE_NO_BOX)
26089 {
26090 if (face->box_line_width > 0)
26091 {
26092 if (slice.y == 0)
26093 it->ascent += face->box_line_width;
26094 if (slice.y + slice.height == img->height)
26095 it->descent += face->box_line_width;
26096 }
26097
26098 if (it->start_of_box_run_p && slice.x == 0)
26099 it->pixel_width += eabs (face->box_line_width);
26100 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
26101 it->pixel_width += eabs (face->box_line_width);
26102 }
26103
26104 take_vertical_position_into_account (it);
26105
26106 /* Automatically crop wide image glyphs at right edge so we can
26107 draw the cursor on same display row. */
26108 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
26109 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
26110 {
26111 it->pixel_width -= crop;
26112 slice.width -= crop;
26113 }
26114
26115 if (it->glyph_row)
26116 {
26117 struct glyph *glyph;
26118 enum glyph_row_area area = it->area;
26119
26120 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26121 if (it->glyph_row->reversed_p)
26122 {
26123 struct glyph *g;
26124
26125 /* Make room for the new glyph. */
26126 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
26127 g[1] = *g;
26128 glyph = it->glyph_row->glyphs[it->area];
26129 }
26130 if (glyph < it->glyph_row->glyphs[area + 1])
26131 {
26132 glyph->charpos = CHARPOS (it->position);
26133 glyph->object = it->object;
26134 glyph->pixel_width = clip_to_bounds (-1, it->pixel_width, SHRT_MAX);
26135 glyph->ascent = glyph_ascent;
26136 glyph->descent = it->descent;
26137 glyph->voffset = it->voffset;
26138 glyph->type = IMAGE_GLYPH;
26139 glyph->avoid_cursor_p = it->avoid_cursor_p;
26140 glyph->multibyte_p = it->multibyte_p;
26141 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26142 {
26143 /* In R2L rows, the left and the right box edges need to be
26144 drawn in reverse direction. */
26145 glyph->right_box_line_p = it->start_of_box_run_p;
26146 glyph->left_box_line_p = it->end_of_box_run_p;
26147 }
26148 else
26149 {
26150 glyph->left_box_line_p = it->start_of_box_run_p;
26151 glyph->right_box_line_p = it->end_of_box_run_p;
26152 }
26153 glyph->overlaps_vertically_p = false;
26154 glyph->padding_p = false;
26155 glyph->glyph_not_available_p = false;
26156 glyph->face_id = it->face_id;
26157 glyph->u.img_id = img->id;
26158 glyph->slice.img = slice;
26159 glyph->font_type = FONT_TYPE_UNKNOWN;
26160 if (it->bidi_p)
26161 {
26162 glyph->resolved_level = it->bidi_it.resolved_level;
26163 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26164 glyph->bidi_type = it->bidi_it.type;
26165 }
26166 ++it->glyph_row->used[area];
26167 }
26168 else
26169 IT_EXPAND_MATRIX_WIDTH (it, area);
26170 }
26171 }
26172
26173 static void
26174 produce_xwidget_glyph (struct it *it)
26175 {
26176 #ifdef HAVE_XWIDGETS
26177 struct xwidget *xw;
26178 int glyph_ascent, crop;
26179 eassert (it->what == IT_XWIDGET);
26180
26181 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26182 /* Make sure X resources of the face is loaded. */
26183 prepare_face_for_display (it->f, face);
26184
26185 xw = it->xwidget;
26186 it->ascent = it->phys_ascent = glyph_ascent = xw->height/2;
26187 it->descent = xw->height/2;
26188 it->phys_descent = it->descent;
26189 it->pixel_width = xw->width;
26190 /* It's quite possible for images to have an ascent greater than
26191 their height, so don't get confused in that case. */
26192 if (it->descent < 0)
26193 it->descent = 0;
26194
26195 it->nglyphs = 1;
26196
26197 if (face->box != FACE_NO_BOX)
26198 {
26199 if (face->box_line_width > 0)
26200 {
26201 it->ascent += face->box_line_width;
26202 it->descent += face->box_line_width;
26203 }
26204
26205 if (it->start_of_box_run_p)
26206 it->pixel_width += eabs (face->box_line_width);
26207 it->pixel_width += eabs (face->box_line_width);
26208 }
26209
26210 take_vertical_position_into_account (it);
26211
26212 /* Automatically crop wide image glyphs at right edge so we can
26213 draw the cursor on same display row. */
26214 crop = it->pixel_width - (it->last_visible_x - it->current_x);
26215 if (crop > 0 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
26216 it->pixel_width -= crop;
26217
26218 if (it->glyph_row)
26219 {
26220 enum glyph_row_area area = it->area;
26221 struct glyph *glyph
26222 = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26223
26224 if (it->glyph_row->reversed_p)
26225 {
26226 struct glyph *g;
26227
26228 /* Make room for the new glyph. */
26229 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
26230 g[1] = *g;
26231 glyph = it->glyph_row->glyphs[it->area];
26232 }
26233 if (glyph < it->glyph_row->glyphs[area + 1])
26234 {
26235 glyph->charpos = CHARPOS (it->position);
26236 glyph->object = it->object;
26237 glyph->pixel_width = clip_to_bounds (-1, it->pixel_width, SHRT_MAX);
26238 glyph->ascent = glyph_ascent;
26239 glyph->descent = it->descent;
26240 glyph->voffset = it->voffset;
26241 glyph->type = XWIDGET_GLYPH;
26242 glyph->avoid_cursor_p = it->avoid_cursor_p;
26243 glyph->multibyte_p = it->multibyte_p;
26244 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26245 {
26246 /* In R2L rows, the left and the right box edges need to be
26247 drawn in reverse direction. */
26248 glyph->right_box_line_p = it->start_of_box_run_p;
26249 glyph->left_box_line_p = it->end_of_box_run_p;
26250 }
26251 else
26252 {
26253 glyph->left_box_line_p = it->start_of_box_run_p;
26254 glyph->right_box_line_p = it->end_of_box_run_p;
26255 }
26256 glyph->overlaps_vertically_p = 0;
26257 glyph->padding_p = 0;
26258 glyph->glyph_not_available_p = 0;
26259 glyph->face_id = it->face_id;
26260 glyph->u.xwidget = it->xwidget;
26261 glyph->font_type = FONT_TYPE_UNKNOWN;
26262 if (it->bidi_p)
26263 {
26264 glyph->resolved_level = it->bidi_it.resolved_level;
26265 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26266 glyph->bidi_type = it->bidi_it.type;
26267 }
26268 ++it->glyph_row->used[area];
26269 }
26270 else
26271 IT_EXPAND_MATRIX_WIDTH (it, area);
26272 }
26273 #endif
26274 }
26275
26276 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
26277 of the glyph, WIDTH and HEIGHT are the width and height of the
26278 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
26279
26280 static void
26281 append_stretch_glyph (struct it *it, Lisp_Object object,
26282 int width, int height, int ascent)
26283 {
26284 struct glyph *glyph;
26285 enum glyph_row_area area = it->area;
26286
26287 eassert (ascent >= 0 && ascent <= height);
26288
26289 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26290 if (glyph < it->glyph_row->glyphs[area + 1])
26291 {
26292 /* If the glyph row is reversed, we need to prepend the glyph
26293 rather than append it. */
26294 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26295 {
26296 struct glyph *g;
26297
26298 /* Make room for the additional glyph. */
26299 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
26300 g[1] = *g;
26301 glyph = it->glyph_row->glyphs[area];
26302
26303 /* Decrease the width of the first glyph of the row that
26304 begins before first_visible_x (e.g., due to hscroll).
26305 This is so the overall width of the row becomes smaller
26306 by the scroll amount, and the stretch glyph appended by
26307 extend_face_to_end_of_line will be wider, to shift the
26308 row glyphs to the right. (In L2R rows, the corresponding
26309 left-shift effect is accomplished by setting row->x to a
26310 negative value, which won't work with R2L rows.)
26311
26312 This must leave us with a positive value of WIDTH, since
26313 otherwise the call to move_it_in_display_line_to at the
26314 beginning of display_line would have got past the entire
26315 first glyph, and then it->current_x would have been
26316 greater or equal to it->first_visible_x. */
26317 if (it->current_x < it->first_visible_x)
26318 width -= it->first_visible_x - it->current_x;
26319 eassert (width > 0);
26320 }
26321 glyph->charpos = CHARPOS (it->position);
26322 glyph->object = object;
26323 /* FIXME: It would be better to use TYPE_MAX here, but
26324 __typeof__ is not portable enough... */
26325 glyph->pixel_width = clip_to_bounds (-1, width, SHRT_MAX);
26326 glyph->ascent = ascent;
26327 glyph->descent = height - ascent;
26328 glyph->voffset = it->voffset;
26329 glyph->type = STRETCH_GLYPH;
26330 glyph->avoid_cursor_p = it->avoid_cursor_p;
26331 glyph->multibyte_p = it->multibyte_p;
26332 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26333 {
26334 /* In R2L rows, the left and the right box edges need to be
26335 drawn in reverse direction. */
26336 glyph->right_box_line_p = it->start_of_box_run_p;
26337 glyph->left_box_line_p = it->end_of_box_run_p;
26338 }
26339 else
26340 {
26341 glyph->left_box_line_p = it->start_of_box_run_p;
26342 glyph->right_box_line_p = it->end_of_box_run_p;
26343 }
26344 glyph->overlaps_vertically_p = false;
26345 glyph->padding_p = false;
26346 glyph->glyph_not_available_p = false;
26347 glyph->face_id = it->face_id;
26348 glyph->u.stretch.ascent = ascent;
26349 glyph->u.stretch.height = height;
26350 glyph->slice.img = null_glyph_slice;
26351 glyph->font_type = FONT_TYPE_UNKNOWN;
26352 if (it->bidi_p)
26353 {
26354 glyph->resolved_level = it->bidi_it.resolved_level;
26355 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26356 glyph->bidi_type = it->bidi_it.type;
26357 }
26358 else
26359 {
26360 glyph->resolved_level = 0;
26361 glyph->bidi_type = UNKNOWN_BT;
26362 }
26363 ++it->glyph_row->used[area];
26364 }
26365 else
26366 IT_EXPAND_MATRIX_WIDTH (it, area);
26367 }
26368
26369 #endif /* HAVE_WINDOW_SYSTEM */
26370
26371 /* Produce a stretch glyph for iterator IT. IT->object is the value
26372 of the glyph property displayed. The value must be a list
26373 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
26374 being recognized:
26375
26376 1. `:width WIDTH' specifies that the space should be WIDTH *
26377 canonical char width wide. WIDTH may be an integer or floating
26378 point number.
26379
26380 2. `:relative-width FACTOR' specifies that the width of the stretch
26381 should be computed from the width of the first character having the
26382 `glyph' property, and should be FACTOR times that width.
26383
26384 3. `:align-to HPOS' specifies that the space should be wide enough
26385 to reach HPOS, a value in canonical character units.
26386
26387 Exactly one of the above pairs must be present.
26388
26389 4. `:height HEIGHT' specifies that the height of the stretch produced
26390 should be HEIGHT, measured in canonical character units.
26391
26392 5. `:relative-height FACTOR' specifies that the height of the
26393 stretch should be FACTOR times the height of the characters having
26394 the glyph property.
26395
26396 Either none or exactly one of 4 or 5 must be present.
26397
26398 6. `:ascent ASCENT' specifies that ASCENT percent of the height
26399 of the stretch should be used for the ascent of the stretch.
26400 ASCENT must be in the range 0 <= ASCENT <= 100. */
26401
26402 void
26403 produce_stretch_glyph (struct it *it)
26404 {
26405 /* (space :width WIDTH :height HEIGHT ...) */
26406 Lisp_Object prop, plist;
26407 int width = 0, height = 0, align_to = -1;
26408 bool zero_width_ok_p = false;
26409 double tem;
26410 struct font *font = NULL;
26411
26412 #ifdef HAVE_WINDOW_SYSTEM
26413 int ascent = 0;
26414 bool zero_height_ok_p = false;
26415
26416 if (FRAME_WINDOW_P (it->f))
26417 {
26418 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26419 font = face->font ? face->font : FRAME_FONT (it->f);
26420 prepare_face_for_display (it->f, face);
26421 }
26422 #endif
26423
26424 /* List should start with `space'. */
26425 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
26426 plist = XCDR (it->object);
26427
26428 /* Compute the width of the stretch. */
26429 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
26430 && calc_pixel_width_or_height (&tem, it, prop, font, true, 0))
26431 {
26432 /* Absolute width `:width WIDTH' specified and valid. */
26433 zero_width_ok_p = true;
26434 width = (int)tem;
26435 }
26436 else if (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0)
26437 {
26438 /* Relative width `:relative-width FACTOR' specified and valid.
26439 Compute the width of the characters having the `glyph'
26440 property. */
26441 struct it it2;
26442 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
26443
26444 it2 = *it;
26445 if (it->multibyte_p)
26446 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
26447 else
26448 {
26449 it2.c = it2.char_to_display = *p, it2.len = 1;
26450 if (! ASCII_CHAR_P (it2.c))
26451 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
26452 }
26453
26454 it2.glyph_row = NULL;
26455 it2.what = IT_CHARACTER;
26456 PRODUCE_GLYPHS (&it2);
26457 width = NUMVAL (prop) * it2.pixel_width;
26458 }
26459 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
26460 && calc_pixel_width_or_height (&tem, it, prop, font, true,
26461 &align_to))
26462 {
26463 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
26464 align_to = (align_to < 0
26465 ? 0
26466 : align_to - window_box_left_offset (it->w, TEXT_AREA));
26467 else if (align_to < 0)
26468 align_to = window_box_left_offset (it->w, TEXT_AREA);
26469 width = max (0, (int)tem + align_to - it->current_x);
26470 zero_width_ok_p = true;
26471 }
26472 else
26473 /* Nothing specified -> width defaults to canonical char width. */
26474 width = FRAME_COLUMN_WIDTH (it->f);
26475
26476 if (width <= 0 && (width < 0 || !zero_width_ok_p))
26477 width = 1;
26478
26479 #ifdef HAVE_WINDOW_SYSTEM
26480 /* Compute height. */
26481 if (FRAME_WINDOW_P (it->f))
26482 {
26483 int default_height = normal_char_height (font, ' ');
26484
26485 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
26486 && calc_pixel_width_or_height (&tem, it, prop, font, false, 0))
26487 {
26488 height = (int)tem;
26489 zero_height_ok_p = true;
26490 }
26491 else if (prop = Fplist_get (plist, QCrelative_height),
26492 NUMVAL (prop) > 0)
26493 height = default_height * NUMVAL (prop);
26494 else
26495 height = default_height;
26496
26497 if (height <= 0 && (height < 0 || !zero_height_ok_p))
26498 height = 1;
26499
26500 /* Compute percentage of height used for ascent. If
26501 `:ascent ASCENT' is present and valid, use that. Otherwise,
26502 derive the ascent from the font in use. */
26503 if (prop = Fplist_get (plist, QCascent),
26504 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
26505 ascent = height * NUMVAL (prop) / 100.0;
26506 else if (!NILP (prop)
26507 && calc_pixel_width_or_height (&tem, it, prop, font, false, 0))
26508 ascent = min (max (0, (int)tem), height);
26509 else
26510 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
26511 }
26512 else
26513 #endif /* HAVE_WINDOW_SYSTEM */
26514 height = 1;
26515
26516 if (width > 0 && it->line_wrap != TRUNCATE
26517 && it->current_x + width > it->last_visible_x)
26518 {
26519 width = it->last_visible_x - it->current_x;
26520 #ifdef HAVE_WINDOW_SYSTEM
26521 /* Subtract one more pixel from the stretch width, but only on
26522 GUI frames, since on a TTY each glyph is one "pixel" wide. */
26523 width -= FRAME_WINDOW_P (it->f);
26524 #endif
26525 }
26526
26527 if (width > 0 && height > 0 && it->glyph_row)
26528 {
26529 Lisp_Object o_object = it->object;
26530 Lisp_Object object = it->stack[it->sp - 1].string;
26531 int n = width;
26532
26533 if (!STRINGP (object))
26534 object = it->w->contents;
26535 #ifdef HAVE_WINDOW_SYSTEM
26536 if (FRAME_WINDOW_P (it->f))
26537 append_stretch_glyph (it, object, width, height, ascent);
26538 else
26539 #endif
26540 {
26541 it->object = object;
26542 it->char_to_display = ' ';
26543 it->pixel_width = it->len = 1;
26544 while (n--)
26545 tty_append_glyph (it);
26546 it->object = o_object;
26547 }
26548 }
26549
26550 it->pixel_width = width;
26551 #ifdef HAVE_WINDOW_SYSTEM
26552 if (FRAME_WINDOW_P (it->f))
26553 {
26554 it->ascent = it->phys_ascent = ascent;
26555 it->descent = it->phys_descent = height - it->ascent;
26556 it->nglyphs = width > 0 && height > 0;
26557 take_vertical_position_into_account (it);
26558 }
26559 else
26560 #endif
26561 it->nglyphs = width;
26562 }
26563
26564 /* Get information about special display element WHAT in an
26565 environment described by IT. WHAT is one of IT_TRUNCATION or
26566 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
26567 non-null glyph_row member. This function ensures that fields like
26568 face_id, c, len of IT are left untouched. */
26569
26570 static void
26571 produce_special_glyphs (struct it *it, enum display_element_type what)
26572 {
26573 struct it temp_it;
26574 Lisp_Object gc;
26575 GLYPH glyph;
26576
26577 temp_it = *it;
26578 temp_it.object = Qnil;
26579 memset (&temp_it.current, 0, sizeof temp_it.current);
26580
26581 if (what == IT_CONTINUATION)
26582 {
26583 /* Continuation glyph. For R2L lines, we mirror it by hand. */
26584 if (it->bidi_it.paragraph_dir == R2L)
26585 SET_GLYPH_FROM_CHAR (glyph, '/');
26586 else
26587 SET_GLYPH_FROM_CHAR (glyph, '\\');
26588 if (it->dp
26589 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
26590 {
26591 /* FIXME: Should we mirror GC for R2L lines? */
26592 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
26593 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
26594 }
26595 }
26596 else if (what == IT_TRUNCATION)
26597 {
26598 /* Truncation glyph. */
26599 SET_GLYPH_FROM_CHAR (glyph, '$');
26600 if (it->dp
26601 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
26602 {
26603 /* FIXME: Should we mirror GC for R2L lines? */
26604 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
26605 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
26606 }
26607 }
26608 else
26609 emacs_abort ();
26610
26611 #ifdef HAVE_WINDOW_SYSTEM
26612 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
26613 is turned off, we precede the truncation/continuation glyphs by a
26614 stretch glyph whose width is computed such that these special
26615 glyphs are aligned at the window margin, even when very different
26616 fonts are used in different glyph rows. */
26617 if (FRAME_WINDOW_P (temp_it.f)
26618 /* init_iterator calls this with it->glyph_row == NULL, and it
26619 wants only the pixel width of the truncation/continuation
26620 glyphs. */
26621 && temp_it.glyph_row
26622 /* insert_left_trunc_glyphs calls us at the beginning of the
26623 row, and it has its own calculation of the stretch glyph
26624 width. */
26625 && temp_it.glyph_row->used[TEXT_AREA] > 0
26626 && (temp_it.glyph_row->reversed_p
26627 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
26628 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
26629 {
26630 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
26631
26632 if (stretch_width > 0)
26633 {
26634 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
26635 struct font *font =
26636 face->font ? face->font : FRAME_FONT (temp_it.f);
26637 int stretch_ascent =
26638 (((temp_it.ascent + temp_it.descent)
26639 * FONT_BASE (font)) / FONT_HEIGHT (font));
26640
26641 append_stretch_glyph (&temp_it, Qnil, stretch_width,
26642 temp_it.ascent + temp_it.descent,
26643 stretch_ascent);
26644 }
26645 }
26646 #endif
26647
26648 temp_it.dp = NULL;
26649 temp_it.what = IT_CHARACTER;
26650 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
26651 temp_it.face_id = GLYPH_FACE (glyph);
26652 temp_it.len = CHAR_BYTES (temp_it.c);
26653
26654 PRODUCE_GLYPHS (&temp_it);
26655 it->pixel_width = temp_it.pixel_width;
26656 it->nglyphs = temp_it.nglyphs;
26657 }
26658
26659 #ifdef HAVE_WINDOW_SYSTEM
26660
26661 /* Calculate line-height and line-spacing properties.
26662 An integer value specifies explicit pixel value.
26663 A float value specifies relative value to current face height.
26664 A cons (float . face-name) specifies relative value to
26665 height of specified face font.
26666
26667 Returns height in pixels, or nil. */
26668
26669 static Lisp_Object
26670 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
26671 int boff, bool override)
26672 {
26673 Lisp_Object face_name = Qnil;
26674 int ascent, descent, height;
26675
26676 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
26677 return val;
26678
26679 if (CONSP (val))
26680 {
26681 face_name = XCAR (val);
26682 val = XCDR (val);
26683 if (!NUMBERP (val))
26684 val = make_number (1);
26685 if (NILP (face_name))
26686 {
26687 height = it->ascent + it->descent;
26688 goto scale;
26689 }
26690 }
26691
26692 if (NILP (face_name))
26693 {
26694 font = FRAME_FONT (it->f);
26695 boff = FRAME_BASELINE_OFFSET (it->f);
26696 }
26697 else if (EQ (face_name, Qt))
26698 {
26699 override = false;
26700 }
26701 else
26702 {
26703 int face_id;
26704 struct face *face;
26705
26706 face_id = lookup_named_face (it->f, face_name, false);
26707 face = FACE_FROM_ID_OR_NULL (it->f, face_id);
26708 if (face == NULL || ((font = face->font) == NULL))
26709 return make_number (-1);
26710 boff = font->baseline_offset;
26711 if (font->vertical_centering)
26712 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26713 }
26714
26715 normal_char_ascent_descent (font, -1, &ascent, &descent);
26716
26717 if (override)
26718 {
26719 it->override_ascent = ascent;
26720 it->override_descent = descent;
26721 it->override_boff = boff;
26722 }
26723
26724 height = ascent + descent;
26725
26726 scale:
26727 if (FLOATP (val))
26728 height = (int)(XFLOAT_DATA (val) * height);
26729 else if (INTEGERP (val))
26730 height *= XINT (val);
26731
26732 return make_number (height);
26733 }
26734
26735
26736 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26737 is a face ID to be used for the glyph. FOR_NO_FONT is true if
26738 and only if this is for a character for which no font was found.
26739
26740 If the display method (it->glyphless_method) is
26741 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26742 length of the acronym or the hexadecimal string, UPPER_XOFF and
26743 UPPER_YOFF are pixel offsets for the upper part of the string,
26744 LOWER_XOFF and LOWER_YOFF are for the lower part.
26745
26746 For the other display methods, LEN through LOWER_YOFF are zero. */
26747
26748 static void
26749 append_glyphless_glyph (struct it *it, int face_id, bool for_no_font, int len,
26750 short upper_xoff, short upper_yoff,
26751 short lower_xoff, short lower_yoff)
26752 {
26753 struct glyph *glyph;
26754 enum glyph_row_area area = it->area;
26755
26756 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26757 if (glyph < it->glyph_row->glyphs[area + 1])
26758 {
26759 /* If the glyph row is reversed, we need to prepend the glyph
26760 rather than append it. */
26761 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26762 {
26763 struct glyph *g;
26764
26765 /* Make room for the additional glyph. */
26766 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
26767 g[1] = *g;
26768 glyph = it->glyph_row->glyphs[area];
26769 }
26770 glyph->charpos = CHARPOS (it->position);
26771 glyph->object = it->object;
26772 eassert (it->pixel_width <= SHRT_MAX);
26773 glyph->pixel_width = it->pixel_width;
26774 glyph->ascent = it->ascent;
26775 glyph->descent = it->descent;
26776 glyph->voffset = it->voffset;
26777 glyph->type = GLYPHLESS_GLYPH;
26778 glyph->u.glyphless.method = it->glyphless_method;
26779 glyph->u.glyphless.for_no_font = for_no_font;
26780 glyph->u.glyphless.len = len;
26781 glyph->u.glyphless.ch = it->c;
26782 glyph->slice.glyphless.upper_xoff = upper_xoff;
26783 glyph->slice.glyphless.upper_yoff = upper_yoff;
26784 glyph->slice.glyphless.lower_xoff = lower_xoff;
26785 glyph->slice.glyphless.lower_yoff = lower_yoff;
26786 glyph->avoid_cursor_p = it->avoid_cursor_p;
26787 glyph->multibyte_p = it->multibyte_p;
26788 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26789 {
26790 /* In R2L rows, the left and the right box edges need to be
26791 drawn in reverse direction. */
26792 glyph->right_box_line_p = it->start_of_box_run_p;
26793 glyph->left_box_line_p = it->end_of_box_run_p;
26794 }
26795 else
26796 {
26797 glyph->left_box_line_p = it->start_of_box_run_p;
26798 glyph->right_box_line_p = it->end_of_box_run_p;
26799 }
26800 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
26801 || it->phys_descent > it->descent);
26802 glyph->padding_p = false;
26803 glyph->glyph_not_available_p = false;
26804 glyph->face_id = face_id;
26805 glyph->font_type = FONT_TYPE_UNKNOWN;
26806 if (it->bidi_p)
26807 {
26808 glyph->resolved_level = it->bidi_it.resolved_level;
26809 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26810 glyph->bidi_type = it->bidi_it.type;
26811 }
26812 ++it->glyph_row->used[area];
26813 }
26814 else
26815 IT_EXPAND_MATRIX_WIDTH (it, area);
26816 }
26817
26818
26819 /* Produce a glyph for a glyphless character for iterator IT.
26820 IT->glyphless_method specifies which method to use for displaying
26821 the character. See the description of enum
26822 glyphless_display_method in dispextern.h for the detail.
26823
26824 FOR_NO_FONT is true if and only if this is for a character for
26825 which no font was found. ACRONYM, if non-nil, is an acronym string
26826 for the character. */
26827
26828 static void
26829 produce_glyphless_glyph (struct it *it, bool for_no_font, Lisp_Object acronym)
26830 {
26831 int face_id;
26832 struct face *face;
26833 struct font *font;
26834 int base_width, base_height, width, height;
26835 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
26836 int len;
26837
26838 /* Get the metrics of the base font. We always refer to the current
26839 ASCII face. */
26840 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
26841 font = face->font ? face->font : FRAME_FONT (it->f);
26842 normal_char_ascent_descent (font, -1, &it->ascent, &it->descent);
26843 it->ascent += font->baseline_offset;
26844 it->descent -= font->baseline_offset;
26845 base_height = it->ascent + it->descent;
26846 base_width = font->average_width;
26847
26848 face_id = merge_glyphless_glyph_face (it);
26849
26850 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
26851 {
26852 it->pixel_width = THIN_SPACE_WIDTH;
26853 len = 0;
26854 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26855 }
26856 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
26857 {
26858 width = CHAR_WIDTH (it->c);
26859 if (width == 0)
26860 width = 1;
26861 else if (width > 4)
26862 width = 4;
26863 it->pixel_width = base_width * width;
26864 len = 0;
26865 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26866 }
26867 else
26868 {
26869 char buf[7];
26870 const char *str;
26871 unsigned int code[6];
26872 int upper_len;
26873 int ascent, descent;
26874 struct font_metrics metrics_upper, metrics_lower;
26875
26876 face = FACE_FROM_ID (it->f, face_id);
26877 font = face->font ? face->font : FRAME_FONT (it->f);
26878 prepare_face_for_display (it->f, face);
26879
26880 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
26881 {
26882 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
26883 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
26884 if (CONSP (acronym))
26885 acronym = XCAR (acronym);
26886 str = STRINGP (acronym) ? SSDATA (acronym) : "";
26887 }
26888 else
26889 {
26890 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
26891 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c + 0u);
26892 str = buf;
26893 }
26894 for (len = 0; str[len] && ASCII_CHAR_P (str[len]) && len < 6; len++)
26895 code[len] = font->driver->encode_char (font, str[len]);
26896 upper_len = (len + 1) / 2;
26897 font->driver->text_extents (font, code, upper_len,
26898 &metrics_upper);
26899 font->driver->text_extents (font, code + upper_len, len - upper_len,
26900 &metrics_lower);
26901
26902
26903
26904 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26905 width = max (metrics_upper.width, metrics_lower.width) + 4;
26906 upper_xoff = upper_yoff = 2; /* the typical case */
26907 if (base_width >= width)
26908 {
26909 /* Align the upper to the left, the lower to the right. */
26910 it->pixel_width = base_width;
26911 lower_xoff = base_width - 2 - metrics_lower.width;
26912 }
26913 else
26914 {
26915 /* Center the shorter one. */
26916 it->pixel_width = width;
26917 if (metrics_upper.width >= metrics_lower.width)
26918 lower_xoff = (width - metrics_lower.width) / 2;
26919 else
26920 {
26921 /* FIXME: This code doesn't look right. It formerly was
26922 missing the "lower_xoff = 0;", which couldn't have
26923 been right since it left lower_xoff uninitialized. */
26924 lower_xoff = 0;
26925 upper_xoff = (width - metrics_upper.width) / 2;
26926 }
26927 }
26928
26929 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26930 top, bottom, and between upper and lower strings. */
26931 height = (metrics_upper.ascent + metrics_upper.descent
26932 + metrics_lower.ascent + metrics_lower.descent) + 5;
26933 /* Center vertically.
26934 H:base_height, D:base_descent
26935 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26936
26937 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26938 descent = D - H/2 + h/2;
26939 lower_yoff = descent - 2 - ld;
26940 upper_yoff = lower_yoff - la - 1 - ud; */
26941 ascent = - (it->descent - (base_height + height + 1) / 2);
26942 descent = it->descent - (base_height - height) / 2;
26943 lower_yoff = descent - 2 - metrics_lower.descent;
26944 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
26945 - metrics_upper.descent);
26946 /* Don't make the height shorter than the base height. */
26947 if (height > base_height)
26948 {
26949 it->ascent = ascent;
26950 it->descent = descent;
26951 }
26952 }
26953
26954 it->phys_ascent = it->ascent;
26955 it->phys_descent = it->descent;
26956 if (it->glyph_row)
26957 append_glyphless_glyph (it, face_id, for_no_font, len,
26958 upper_xoff, upper_yoff,
26959 lower_xoff, lower_yoff);
26960 it->nglyphs = 1;
26961 take_vertical_position_into_account (it);
26962 }
26963
26964
26965 /* RIF:
26966 Produce glyphs/get display metrics for the display element IT is
26967 loaded with. See the description of struct it in dispextern.h
26968 for an overview of struct it. */
26969
26970 void
26971 x_produce_glyphs (struct it *it)
26972 {
26973 int extra_line_spacing = it->extra_line_spacing;
26974
26975 it->glyph_not_available_p = false;
26976
26977 if (it->what == IT_CHARACTER)
26978 {
26979 XChar2b char2b;
26980 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26981 struct font *font = face->font;
26982 struct font_metrics *pcm = NULL;
26983 int boff; /* Baseline offset. */
26984
26985 if (font == NULL)
26986 {
26987 /* When no suitable font is found, display this character by
26988 the method specified in the first extra slot of
26989 Vglyphless_char_display. */
26990 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
26991
26992 eassert (it->what == IT_GLYPHLESS);
26993 produce_glyphless_glyph (it, true,
26994 STRINGP (acronym) ? acronym : Qnil);
26995 goto done;
26996 }
26997
26998 boff = font->baseline_offset;
26999 if (font->vertical_centering)
27000 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
27001
27002 if (it->char_to_display != '\n' && it->char_to_display != '\t')
27003 {
27004 it->nglyphs = 1;
27005
27006 if (it->override_ascent >= 0)
27007 {
27008 it->ascent = it->override_ascent;
27009 it->descent = it->override_descent;
27010 boff = it->override_boff;
27011 }
27012 else
27013 {
27014 it->ascent = FONT_BASE (font) + boff;
27015 it->descent = FONT_DESCENT (font) - boff;
27016 }
27017
27018 if (get_char_glyph_code (it->char_to_display, font, &char2b))
27019 {
27020 pcm = get_per_char_metric (font, &char2b);
27021 if (pcm->width == 0
27022 && pcm->rbearing == 0 && pcm->lbearing == 0)
27023 pcm = NULL;
27024 }
27025
27026 if (pcm)
27027 {
27028 it->phys_ascent = pcm->ascent + boff;
27029 it->phys_descent = pcm->descent - boff;
27030 it->pixel_width = pcm->width;
27031 /* Don't use font-global values for ascent and descent
27032 if they result in an exceedingly large line height. */
27033 if (it->override_ascent < 0)
27034 {
27035 if (FONT_TOO_HIGH (font))
27036 {
27037 it->ascent = it->phys_ascent;
27038 it->descent = it->phys_descent;
27039 /* These limitations are enforced by an
27040 assertion near the end of this function. */
27041 if (it->ascent < 0)
27042 it->ascent = 0;
27043 if (it->descent < 0)
27044 it->descent = 0;
27045 }
27046 }
27047 }
27048 else
27049 {
27050 it->glyph_not_available_p = true;
27051 it->phys_ascent = it->ascent;
27052 it->phys_descent = it->descent;
27053 it->pixel_width = font->space_width;
27054 }
27055
27056 if (it->constrain_row_ascent_descent_p)
27057 {
27058 if (it->descent > it->max_descent)
27059 {
27060 it->ascent += it->descent - it->max_descent;
27061 it->descent = it->max_descent;
27062 }
27063 if (it->ascent > it->max_ascent)
27064 {
27065 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
27066 it->ascent = it->max_ascent;
27067 }
27068 it->phys_ascent = min (it->phys_ascent, it->ascent);
27069 it->phys_descent = min (it->phys_descent, it->descent);
27070 extra_line_spacing = 0;
27071 }
27072
27073 /* If this is a space inside a region of text with
27074 `space-width' property, change its width. */
27075 bool stretched_p
27076 = it->char_to_display == ' ' && !NILP (it->space_width);
27077 if (stretched_p)
27078 it->pixel_width *= XFLOATINT (it->space_width);
27079
27080 /* If face has a box, add the box thickness to the character
27081 height. If character has a box line to the left and/or
27082 right, add the box line width to the character's width. */
27083 if (face->box != FACE_NO_BOX)
27084 {
27085 int thick = face->box_line_width;
27086
27087 if (thick > 0)
27088 {
27089 it->ascent += thick;
27090 it->descent += thick;
27091 }
27092 else
27093 thick = -thick;
27094
27095 if (it->start_of_box_run_p)
27096 it->pixel_width += thick;
27097 if (it->end_of_box_run_p)
27098 it->pixel_width += thick;
27099 }
27100
27101 /* If face has an overline, add the height of the overline
27102 (1 pixel) and a 1 pixel margin to the character height. */
27103 if (face->overline_p)
27104 it->ascent += overline_margin;
27105
27106 if (it->constrain_row_ascent_descent_p)
27107 {
27108 if (it->ascent > it->max_ascent)
27109 it->ascent = it->max_ascent;
27110 if (it->descent > it->max_descent)
27111 it->descent = it->max_descent;
27112 }
27113
27114 take_vertical_position_into_account (it);
27115
27116 /* If we have to actually produce glyphs, do it. */
27117 if (it->glyph_row)
27118 {
27119 if (stretched_p)
27120 {
27121 /* Translate a space with a `space-width' property
27122 into a stretch glyph. */
27123 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
27124 / FONT_HEIGHT (font));
27125 append_stretch_glyph (it, it->object, it->pixel_width,
27126 it->ascent + it->descent, ascent);
27127 }
27128 else
27129 append_glyph (it);
27130
27131 /* If characters with lbearing or rbearing are displayed
27132 in this line, record that fact in a flag of the
27133 glyph row. This is used to optimize X output code. */
27134 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
27135 it->glyph_row->contains_overlapping_glyphs_p = true;
27136 }
27137 if (! stretched_p && it->pixel_width == 0)
27138 /* We assure that all visible glyphs have at least 1-pixel
27139 width. */
27140 it->pixel_width = 1;
27141 }
27142 else if (it->char_to_display == '\n')
27143 {
27144 /* A newline has no width, but we need the height of the
27145 line. But if previous part of the line sets a height,
27146 don't increase that height. */
27147
27148 Lisp_Object height;
27149 Lisp_Object total_height = Qnil;
27150
27151 it->override_ascent = -1;
27152 it->pixel_width = 0;
27153 it->nglyphs = 0;
27154
27155 height = get_it_property (it, Qline_height);
27156 /* Split (line-height total-height) list. */
27157 if (CONSP (height)
27158 && CONSP (XCDR (height))
27159 && NILP (XCDR (XCDR (height))))
27160 {
27161 total_height = XCAR (XCDR (height));
27162 height = XCAR (height);
27163 }
27164 height = calc_line_height_property (it, height, font, boff, true);
27165
27166 if (it->override_ascent >= 0)
27167 {
27168 it->ascent = it->override_ascent;
27169 it->descent = it->override_descent;
27170 boff = it->override_boff;
27171 }
27172 else
27173 {
27174 if (FONT_TOO_HIGH (font))
27175 {
27176 it->ascent = font->pixel_size + boff - 1;
27177 it->descent = -boff + 1;
27178 if (it->descent < 0)
27179 it->descent = 0;
27180 }
27181 else
27182 {
27183 it->ascent = FONT_BASE (font) + boff;
27184 it->descent = FONT_DESCENT (font) - boff;
27185 }
27186 }
27187
27188 if (EQ (height, Qt))
27189 {
27190 if (it->descent > it->max_descent)
27191 {
27192 it->ascent += it->descent - it->max_descent;
27193 it->descent = it->max_descent;
27194 }
27195 if (it->ascent > it->max_ascent)
27196 {
27197 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
27198 it->ascent = it->max_ascent;
27199 }
27200 it->phys_ascent = min (it->phys_ascent, it->ascent);
27201 it->phys_descent = min (it->phys_descent, it->descent);
27202 it->constrain_row_ascent_descent_p = true;
27203 extra_line_spacing = 0;
27204 }
27205 else
27206 {
27207 Lisp_Object spacing;
27208
27209 it->phys_ascent = it->ascent;
27210 it->phys_descent = it->descent;
27211
27212 if ((it->max_ascent > 0 || it->max_descent > 0)
27213 && face->box != FACE_NO_BOX
27214 && face->box_line_width > 0)
27215 {
27216 it->ascent += face->box_line_width;
27217 it->descent += face->box_line_width;
27218 }
27219 if (!NILP (height)
27220 && XINT (height) > it->ascent + it->descent)
27221 it->ascent = XINT (height) - it->descent;
27222
27223 if (!NILP (total_height))
27224 spacing = calc_line_height_property (it, total_height, font,
27225 boff, false);
27226 else
27227 {
27228 spacing = get_it_property (it, Qline_spacing);
27229 spacing = calc_line_height_property (it, spacing, font,
27230 boff, false);
27231 }
27232 if (INTEGERP (spacing))
27233 {
27234 extra_line_spacing = XINT (spacing);
27235 if (!NILP (total_height))
27236 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
27237 }
27238 }
27239 }
27240 else /* i.e. (it->char_to_display == '\t') */
27241 {
27242 if (font->space_width > 0)
27243 {
27244 int tab_width = it->tab_width * font->space_width;
27245 int x = it->current_x + it->continuation_lines_width;
27246 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
27247
27248 /* If the distance from the current position to the next tab
27249 stop is less than a space character width, use the
27250 tab stop after that. */
27251 if (next_tab_x - x < font->space_width)
27252 next_tab_x += tab_width;
27253
27254 it->pixel_width = next_tab_x - x;
27255 it->nglyphs = 1;
27256 if (FONT_TOO_HIGH (font))
27257 {
27258 if (get_char_glyph_code (' ', font, &char2b))
27259 {
27260 pcm = get_per_char_metric (font, &char2b);
27261 if (pcm->width == 0
27262 && pcm->rbearing == 0 && pcm->lbearing == 0)
27263 pcm = NULL;
27264 }
27265
27266 if (pcm)
27267 {
27268 it->ascent = pcm->ascent + boff;
27269 it->descent = pcm->descent - boff;
27270 }
27271 else
27272 {
27273 it->ascent = font->pixel_size + boff - 1;
27274 it->descent = -boff + 1;
27275 }
27276 if (it->ascent < 0)
27277 it->ascent = 0;
27278 if (it->descent < 0)
27279 it->descent = 0;
27280 }
27281 else
27282 {
27283 it->ascent = FONT_BASE (font) + boff;
27284 it->descent = FONT_DESCENT (font) - boff;
27285 }
27286 it->phys_ascent = it->ascent;
27287 it->phys_descent = it->descent;
27288
27289 if (it->glyph_row)
27290 {
27291 append_stretch_glyph (it, it->object, it->pixel_width,
27292 it->ascent + it->descent, it->ascent);
27293 }
27294 }
27295 else
27296 {
27297 it->pixel_width = 0;
27298 it->nglyphs = 1;
27299 }
27300 }
27301
27302 if (FONT_TOO_HIGH (font))
27303 {
27304 int font_ascent, font_descent;
27305
27306 /* For very large fonts, where we ignore the declared font
27307 dimensions, and go by per-character metrics instead,
27308 don't let the row ascent and descent values (and the row
27309 height computed from them) be smaller than the "normal"
27310 character metrics. This avoids unpleasant effects
27311 whereby lines on display would change their height
27312 depending on which characters are shown. */
27313 normal_char_ascent_descent (font, -1, &font_ascent, &font_descent);
27314 it->max_ascent = max (it->max_ascent, font_ascent);
27315 it->max_descent = max (it->max_descent, font_descent);
27316 }
27317 }
27318 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
27319 {
27320 /* A static composition.
27321
27322 Note: A composition is represented as one glyph in the
27323 glyph matrix. There are no padding glyphs.
27324
27325 Important note: pixel_width, ascent, and descent are the
27326 values of what is drawn by draw_glyphs (i.e. the values of
27327 the overall glyphs composed). */
27328 struct face *face = FACE_FROM_ID (it->f, it->face_id);
27329 int boff; /* baseline offset */
27330 struct composition *cmp = composition_table[it->cmp_it.id];
27331 int glyph_len = cmp->glyph_len;
27332 struct font *font = face->font;
27333
27334 it->nglyphs = 1;
27335
27336 /* If we have not yet calculated pixel size data of glyphs of
27337 the composition for the current face font, calculate them
27338 now. Theoretically, we have to check all fonts for the
27339 glyphs, but that requires much time and memory space. So,
27340 here we check only the font of the first glyph. This may
27341 lead to incorrect display, but it's very rare, and C-l
27342 (recenter-top-bottom) can correct the display anyway. */
27343 if (! cmp->font || cmp->font != font)
27344 {
27345 /* Ascent and descent of the font of the first character
27346 of this composition (adjusted by baseline offset).
27347 Ascent and descent of overall glyphs should not be less
27348 than these, respectively. */
27349 int font_ascent, font_descent, font_height;
27350 /* Bounding box of the overall glyphs. */
27351 int leftmost, rightmost, lowest, highest;
27352 int lbearing, rbearing;
27353 int i, width, ascent, descent;
27354 int c;
27355 XChar2b char2b;
27356 struct font_metrics *pcm;
27357 ptrdiff_t pos;
27358
27359 eassume (0 < glyph_len); /* See Bug#8512. */
27360 do
27361 c = COMPOSITION_GLYPH (cmp, glyph_len - 1);
27362 while (c == '\t' && 0 < --glyph_len);
27363
27364 bool right_padded = glyph_len < cmp->glyph_len;
27365 for (i = 0; i < glyph_len; i++)
27366 {
27367 c = COMPOSITION_GLYPH (cmp, i);
27368 if (c != '\t')
27369 break;
27370 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
27371 }
27372 bool left_padded = i > 0;
27373
27374 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
27375 : IT_CHARPOS (*it));
27376 /* If no suitable font is found, use the default font. */
27377 bool font_not_found_p = font == NULL;
27378 if (font_not_found_p)
27379 {
27380 face = face->ascii_face;
27381 font = face->font;
27382 }
27383 boff = font->baseline_offset;
27384 if (font->vertical_centering)
27385 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
27386 normal_char_ascent_descent (font, -1, &font_ascent, &font_descent);
27387 font_ascent += boff;
27388 font_descent -= boff;
27389 font_height = font_ascent + font_descent;
27390
27391 cmp->font = font;
27392
27393 pcm = NULL;
27394 if (! font_not_found_p)
27395 {
27396 get_char_face_and_encoding (it->f, c, it->face_id,
27397 &char2b, false);
27398 pcm = get_per_char_metric (font, &char2b);
27399 }
27400
27401 /* Initialize the bounding box. */
27402 if (pcm)
27403 {
27404 width = cmp->glyph_len > 0 ? pcm->width : 0;
27405 ascent = pcm->ascent;
27406 descent = pcm->descent;
27407 lbearing = pcm->lbearing;
27408 rbearing = pcm->rbearing;
27409 }
27410 else
27411 {
27412 width = cmp->glyph_len > 0 ? font->space_width : 0;
27413 ascent = FONT_BASE (font);
27414 descent = FONT_DESCENT (font);
27415 lbearing = 0;
27416 rbearing = width;
27417 }
27418
27419 rightmost = width;
27420 leftmost = 0;
27421 lowest = - descent + boff;
27422 highest = ascent + boff;
27423
27424 if (! font_not_found_p
27425 && font->default_ascent
27426 && CHAR_TABLE_P (Vuse_default_ascent)
27427 && !NILP (Faref (Vuse_default_ascent,
27428 make_number (it->char_to_display))))
27429 highest = font->default_ascent + boff;
27430
27431 /* Draw the first glyph at the normal position. It may be
27432 shifted to right later if some other glyphs are drawn
27433 at the left. */
27434 cmp->offsets[i * 2] = 0;
27435 cmp->offsets[i * 2 + 1] = boff;
27436 cmp->lbearing = lbearing;
27437 cmp->rbearing = rbearing;
27438
27439 /* Set cmp->offsets for the remaining glyphs. */
27440 for (i++; i < glyph_len; i++)
27441 {
27442 int left, right, btm, top;
27443 int ch = COMPOSITION_GLYPH (cmp, i);
27444 int face_id;
27445 struct face *this_face;
27446
27447 if (ch == '\t')
27448 ch = ' ';
27449 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
27450 this_face = FACE_FROM_ID (it->f, face_id);
27451 font = this_face->font;
27452
27453 if (font == NULL)
27454 pcm = NULL;
27455 else
27456 {
27457 get_char_face_and_encoding (it->f, ch, face_id,
27458 &char2b, false);
27459 pcm = get_per_char_metric (font, &char2b);
27460 }
27461 if (! pcm)
27462 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
27463 else
27464 {
27465 width = pcm->width;
27466 ascent = pcm->ascent;
27467 descent = pcm->descent;
27468 lbearing = pcm->lbearing;
27469 rbearing = pcm->rbearing;
27470 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
27471 {
27472 /* Relative composition with or without
27473 alternate chars. */
27474 left = (leftmost + rightmost - width) / 2;
27475 btm = - descent + boff;
27476 if (font->relative_compose
27477 && (! CHAR_TABLE_P (Vignore_relative_composition)
27478 || NILP (Faref (Vignore_relative_composition,
27479 make_number (ch)))))
27480 {
27481
27482 if (- descent >= font->relative_compose)
27483 /* One extra pixel between two glyphs. */
27484 btm = highest + 1;
27485 else if (ascent <= 0)
27486 /* One extra pixel between two glyphs. */
27487 btm = lowest - 1 - ascent - descent;
27488 }
27489 }
27490 else
27491 {
27492 /* A composition rule is specified by an integer
27493 value that encodes global and new reference
27494 points (GREF and NREF). GREF and NREF are
27495 specified by numbers as below:
27496
27497 0---1---2 -- ascent
27498 | |
27499 | |
27500 | |
27501 9--10--11 -- center
27502 | |
27503 ---3---4---5--- baseline
27504 | |
27505 6---7---8 -- descent
27506 */
27507 int rule = COMPOSITION_RULE (cmp, i);
27508 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
27509
27510 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
27511 grefx = gref % 3, nrefx = nref % 3;
27512 grefy = gref / 3, nrefy = nref / 3;
27513 if (xoff)
27514 xoff = font_height * (xoff - 128) / 256;
27515 if (yoff)
27516 yoff = font_height * (yoff - 128) / 256;
27517
27518 left = (leftmost
27519 + grefx * (rightmost - leftmost) / 2
27520 - nrefx * width / 2
27521 + xoff);
27522
27523 btm = ((grefy == 0 ? highest
27524 : grefy == 1 ? 0
27525 : grefy == 2 ? lowest
27526 : (highest + lowest) / 2)
27527 - (nrefy == 0 ? ascent + descent
27528 : nrefy == 1 ? descent - boff
27529 : nrefy == 2 ? 0
27530 : (ascent + descent) / 2)
27531 + yoff);
27532 }
27533
27534 cmp->offsets[i * 2] = left;
27535 cmp->offsets[i * 2 + 1] = btm + descent;
27536
27537 /* Update the bounding box of the overall glyphs. */
27538 if (width > 0)
27539 {
27540 right = left + width;
27541 if (left < leftmost)
27542 leftmost = left;
27543 if (right > rightmost)
27544 rightmost = right;
27545 }
27546 top = btm + descent + ascent;
27547 if (top > highest)
27548 highest = top;
27549 if (btm < lowest)
27550 lowest = btm;
27551
27552 if (cmp->lbearing > left + lbearing)
27553 cmp->lbearing = left + lbearing;
27554 if (cmp->rbearing < left + rbearing)
27555 cmp->rbearing = left + rbearing;
27556 }
27557 }
27558
27559 /* If there are glyphs whose x-offsets are negative,
27560 shift all glyphs to the right and make all x-offsets
27561 non-negative. */
27562 if (leftmost < 0)
27563 {
27564 for (i = 0; i < cmp->glyph_len; i++)
27565 cmp->offsets[i * 2] -= leftmost;
27566 rightmost -= leftmost;
27567 cmp->lbearing -= leftmost;
27568 cmp->rbearing -= leftmost;
27569 }
27570
27571 if (left_padded && cmp->lbearing < 0)
27572 {
27573 for (i = 0; i < cmp->glyph_len; i++)
27574 cmp->offsets[i * 2] -= cmp->lbearing;
27575 rightmost -= cmp->lbearing;
27576 cmp->rbearing -= cmp->lbearing;
27577 cmp->lbearing = 0;
27578 }
27579 if (right_padded && rightmost < cmp->rbearing)
27580 {
27581 rightmost = cmp->rbearing;
27582 }
27583
27584 cmp->pixel_width = rightmost;
27585 cmp->ascent = highest;
27586 cmp->descent = - lowest;
27587 if (cmp->ascent < font_ascent)
27588 cmp->ascent = font_ascent;
27589 if (cmp->descent < font_descent)
27590 cmp->descent = font_descent;
27591 }
27592
27593 if (it->glyph_row
27594 && (cmp->lbearing < 0
27595 || cmp->rbearing > cmp->pixel_width))
27596 it->glyph_row->contains_overlapping_glyphs_p = true;
27597
27598 it->pixel_width = cmp->pixel_width;
27599 it->ascent = it->phys_ascent = cmp->ascent;
27600 it->descent = it->phys_descent = cmp->descent;
27601 if (face->box != FACE_NO_BOX)
27602 {
27603 int thick = face->box_line_width;
27604
27605 if (thick > 0)
27606 {
27607 it->ascent += thick;
27608 it->descent += thick;
27609 }
27610 else
27611 thick = - thick;
27612
27613 if (it->start_of_box_run_p)
27614 it->pixel_width += thick;
27615 if (it->end_of_box_run_p)
27616 it->pixel_width += thick;
27617 }
27618
27619 /* If face has an overline, add the height of the overline
27620 (1 pixel) and a 1 pixel margin to the character height. */
27621 if (face->overline_p)
27622 it->ascent += overline_margin;
27623
27624 take_vertical_position_into_account (it);
27625 if (it->ascent < 0)
27626 it->ascent = 0;
27627 if (it->descent < 0)
27628 it->descent = 0;
27629
27630 if (it->glyph_row && cmp->glyph_len > 0)
27631 append_composite_glyph (it);
27632 }
27633 else if (it->what == IT_COMPOSITION)
27634 {
27635 /* A dynamic (automatic) composition. */
27636 struct face *face = FACE_FROM_ID (it->f, it->face_id);
27637 Lisp_Object gstring;
27638 struct font_metrics metrics;
27639
27640 it->nglyphs = 1;
27641
27642 gstring = composition_gstring_from_id (it->cmp_it.id);
27643 it->pixel_width
27644 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
27645 &metrics);
27646 if (it->glyph_row
27647 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
27648 it->glyph_row->contains_overlapping_glyphs_p = true;
27649 it->ascent = it->phys_ascent = metrics.ascent;
27650 it->descent = it->phys_descent = metrics.descent;
27651 if (face->box != FACE_NO_BOX)
27652 {
27653 int thick = face->box_line_width;
27654
27655 if (thick > 0)
27656 {
27657 it->ascent += thick;
27658 it->descent += thick;
27659 }
27660 else
27661 thick = - thick;
27662
27663 if (it->start_of_box_run_p)
27664 it->pixel_width += thick;
27665 if (it->end_of_box_run_p)
27666 it->pixel_width += thick;
27667 }
27668 /* If face has an overline, add the height of the overline
27669 (1 pixel) and a 1 pixel margin to the character height. */
27670 if (face->overline_p)
27671 it->ascent += overline_margin;
27672 take_vertical_position_into_account (it);
27673 if (it->ascent < 0)
27674 it->ascent = 0;
27675 if (it->descent < 0)
27676 it->descent = 0;
27677
27678 if (it->glyph_row)
27679 append_composite_glyph (it);
27680 }
27681 else if (it->what == IT_GLYPHLESS)
27682 produce_glyphless_glyph (it, false, Qnil);
27683 else if (it->what == IT_IMAGE)
27684 produce_image_glyph (it);
27685 else if (it->what == IT_STRETCH)
27686 produce_stretch_glyph (it);
27687 else if (it->what == IT_XWIDGET)
27688 produce_xwidget_glyph (it);
27689
27690 done:
27691 /* Accumulate dimensions. Note: can't assume that it->descent > 0
27692 because this isn't true for images with `:ascent 100'. */
27693 eassert (it->ascent >= 0 && it->descent >= 0);
27694 if (it->area == TEXT_AREA)
27695 it->current_x += it->pixel_width;
27696
27697 if (extra_line_spacing > 0)
27698 {
27699 it->descent += extra_line_spacing;
27700 if (extra_line_spacing > it->max_extra_line_spacing)
27701 it->max_extra_line_spacing = extra_line_spacing;
27702 }
27703
27704 it->max_ascent = max (it->max_ascent, it->ascent);
27705 it->max_descent = max (it->max_descent, it->descent);
27706 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
27707 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
27708 }
27709
27710 /* EXPORT for RIF:
27711 Output LEN glyphs starting at START at the nominal cursor position.
27712 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
27713 being updated, and UPDATED_AREA is the area of that row being updated. */
27714
27715 void
27716 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
27717 struct glyph *start, enum glyph_row_area updated_area, int len)
27718 {
27719 int x, hpos, chpos = w->phys_cursor.hpos;
27720
27721 eassert (updated_row);
27722 /* When the window is hscrolled, cursor hpos can legitimately be out
27723 of bounds, but we draw the cursor at the corresponding window
27724 margin in that case. */
27725 if (!updated_row->reversed_p && chpos < 0)
27726 chpos = 0;
27727 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
27728 chpos = updated_row->used[TEXT_AREA] - 1;
27729
27730 block_input ();
27731
27732 /* Write glyphs. */
27733
27734 hpos = start - updated_row->glyphs[updated_area];
27735 x = draw_glyphs (w, w->output_cursor.x,
27736 updated_row, updated_area,
27737 hpos, hpos + len,
27738 DRAW_NORMAL_TEXT, 0);
27739
27740 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
27741 if (updated_area == TEXT_AREA
27742 && w->phys_cursor_on_p
27743 && w->phys_cursor.vpos == w->output_cursor.vpos
27744 && chpos >= hpos
27745 && chpos < hpos + len)
27746 w->phys_cursor_on_p = false;
27747
27748 unblock_input ();
27749
27750 /* Advance the output cursor. */
27751 w->output_cursor.hpos += len;
27752 w->output_cursor.x = x;
27753 }
27754
27755
27756 /* EXPORT for RIF:
27757 Insert LEN glyphs from START at the nominal cursor position. */
27758
27759 void
27760 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
27761 struct glyph *start, enum glyph_row_area updated_area, int len)
27762 {
27763 struct frame *f;
27764 int line_height, shift_by_width, shifted_region_width;
27765 struct glyph_row *row;
27766 struct glyph *glyph;
27767 int frame_x, frame_y;
27768 ptrdiff_t hpos;
27769
27770 eassert (updated_row);
27771 block_input ();
27772 f = XFRAME (WINDOW_FRAME (w));
27773
27774 /* Get the height of the line we are in. */
27775 row = updated_row;
27776 line_height = row->height;
27777
27778 /* Get the width of the glyphs to insert. */
27779 shift_by_width = 0;
27780 for (glyph = start; glyph < start + len; ++glyph)
27781 shift_by_width += glyph->pixel_width;
27782
27783 /* Get the width of the region to shift right. */
27784 shifted_region_width = (window_box_width (w, updated_area)
27785 - w->output_cursor.x
27786 - shift_by_width);
27787
27788 /* Shift right. */
27789 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
27790 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
27791
27792 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
27793 line_height, shift_by_width);
27794
27795 /* Write the glyphs. */
27796 hpos = start - row->glyphs[updated_area];
27797 draw_glyphs (w, w->output_cursor.x, row, updated_area,
27798 hpos, hpos + len,
27799 DRAW_NORMAL_TEXT, 0);
27800
27801 /* Advance the output cursor. */
27802 w->output_cursor.hpos += len;
27803 w->output_cursor.x += shift_by_width;
27804 unblock_input ();
27805 }
27806
27807
27808 /* EXPORT for RIF:
27809 Erase the current text line from the nominal cursor position
27810 (inclusive) to pixel column TO_X (exclusive). The idea is that
27811 everything from TO_X onward is already erased.
27812
27813 TO_X is a pixel position relative to UPDATED_AREA of currently
27814 updated window W. TO_X == -1 means clear to the end of this area. */
27815
27816 void
27817 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
27818 enum glyph_row_area updated_area, int to_x)
27819 {
27820 struct frame *f;
27821 int max_x, min_y, max_y;
27822 int from_x, from_y, to_y;
27823
27824 eassert (updated_row);
27825 f = XFRAME (w->frame);
27826
27827 if (updated_row->full_width_p)
27828 max_x = (WINDOW_PIXEL_WIDTH (w)
27829 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
27830 else
27831 max_x = window_box_width (w, updated_area);
27832 max_y = window_text_bottom_y (w);
27833
27834 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27835 of window. For TO_X > 0, truncate to end of drawing area. */
27836 if (to_x == 0)
27837 return;
27838 else if (to_x < 0)
27839 to_x = max_x;
27840 else
27841 to_x = min (to_x, max_x);
27842
27843 to_y = min (max_y, w->output_cursor.y + updated_row->height);
27844
27845 /* Notice if the cursor will be cleared by this operation. */
27846 if (!updated_row->full_width_p)
27847 notice_overwritten_cursor (w, updated_area,
27848 w->output_cursor.x, -1,
27849 updated_row->y,
27850 MATRIX_ROW_BOTTOM_Y (updated_row));
27851
27852 from_x = w->output_cursor.x;
27853
27854 /* Translate to frame coordinates. */
27855 if (updated_row->full_width_p)
27856 {
27857 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
27858 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
27859 }
27860 else
27861 {
27862 int area_left = window_box_left (w, updated_area);
27863 from_x += area_left;
27864 to_x += area_left;
27865 }
27866
27867 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
27868 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
27869 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
27870
27871 /* Prevent inadvertently clearing to end of the X window. */
27872 if (to_x > from_x && to_y > from_y)
27873 {
27874 block_input ();
27875 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
27876 to_x - from_x, to_y - from_y);
27877 unblock_input ();
27878 }
27879 }
27880
27881 #endif /* HAVE_WINDOW_SYSTEM */
27882
27883
27884 \f
27885 /***********************************************************************
27886 Cursor types
27887 ***********************************************************************/
27888
27889 /* Value is the internal representation of the specified cursor type
27890 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27891 of the bar cursor. */
27892
27893 static enum text_cursor_kinds
27894 get_specified_cursor_type (Lisp_Object arg, int *width)
27895 {
27896 enum text_cursor_kinds type;
27897
27898 if (NILP (arg))
27899 return NO_CURSOR;
27900
27901 if (EQ (arg, Qbox))
27902 return FILLED_BOX_CURSOR;
27903
27904 if (EQ (arg, Qhollow))
27905 return HOLLOW_BOX_CURSOR;
27906
27907 if (EQ (arg, Qbar))
27908 {
27909 *width = 2;
27910 return BAR_CURSOR;
27911 }
27912
27913 if (CONSP (arg)
27914 && EQ (XCAR (arg), Qbar)
27915 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27916 {
27917 *width = XINT (XCDR (arg));
27918 return BAR_CURSOR;
27919 }
27920
27921 if (EQ (arg, Qhbar))
27922 {
27923 *width = 2;
27924 return HBAR_CURSOR;
27925 }
27926
27927 if (CONSP (arg)
27928 && EQ (XCAR (arg), Qhbar)
27929 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27930 {
27931 *width = XINT (XCDR (arg));
27932 return HBAR_CURSOR;
27933 }
27934
27935 /* Treat anything unknown as "hollow box cursor".
27936 It was bad to signal an error; people have trouble fixing
27937 .Xdefaults with Emacs, when it has something bad in it. */
27938 type = HOLLOW_BOX_CURSOR;
27939
27940 return type;
27941 }
27942
27943 /* Set the default cursor types for specified frame. */
27944 void
27945 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
27946 {
27947 int width = 1;
27948 Lisp_Object tem;
27949
27950 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
27951 FRAME_CURSOR_WIDTH (f) = width;
27952
27953 /* By default, set up the blink-off state depending on the on-state. */
27954
27955 tem = Fassoc (arg, Vblink_cursor_alist);
27956 if (!NILP (tem))
27957 {
27958 FRAME_BLINK_OFF_CURSOR (f)
27959 = get_specified_cursor_type (XCDR (tem), &width);
27960 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
27961 }
27962 else
27963 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
27964
27965 /* Make sure the cursor gets redrawn. */
27966 f->cursor_type_changed = true;
27967 }
27968
27969
27970 #ifdef HAVE_WINDOW_SYSTEM
27971
27972 /* Return the cursor we want to be displayed in window W. Return
27973 width of bar/hbar cursor through WIDTH arg. Return with
27974 ACTIVE_CURSOR arg set to true if cursor in window W is `active'
27975 (i.e. if the `system caret' should track this cursor).
27976
27977 In a mini-buffer window, we want the cursor only to appear if we
27978 are reading input from this window. For the selected window, we
27979 want the cursor type given by the frame parameter or buffer local
27980 setting of cursor-type. If explicitly marked off, draw no cursor.
27981 In all other cases, we want a hollow box cursor. */
27982
27983 static enum text_cursor_kinds
27984 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
27985 bool *active_cursor)
27986 {
27987 struct frame *f = XFRAME (w->frame);
27988 struct buffer *b = XBUFFER (w->contents);
27989 int cursor_type = DEFAULT_CURSOR;
27990 Lisp_Object alt_cursor;
27991 bool non_selected = false;
27992
27993 *active_cursor = true;
27994
27995 /* Echo area */
27996 if (cursor_in_echo_area
27997 && FRAME_HAS_MINIBUF_P (f)
27998 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
27999 {
28000 if (w == XWINDOW (echo_area_window))
28001 {
28002 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
28003 {
28004 *width = FRAME_CURSOR_WIDTH (f);
28005 return FRAME_DESIRED_CURSOR (f);
28006 }
28007 else
28008 return get_specified_cursor_type (BVAR (b, cursor_type), width);
28009 }
28010
28011 *active_cursor = false;
28012 non_selected = true;
28013 }
28014
28015 /* Detect a nonselected window or nonselected frame. */
28016 else if (w != XWINDOW (f->selected_window)
28017 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
28018 {
28019 *active_cursor = false;
28020
28021 if (MINI_WINDOW_P (w) && minibuf_level == 0)
28022 return NO_CURSOR;
28023
28024 non_selected = true;
28025 }
28026
28027 /* Never display a cursor in a window in which cursor-type is nil. */
28028 if (NILP (BVAR (b, cursor_type)))
28029 return NO_CURSOR;
28030
28031 /* Get the normal cursor type for this window. */
28032 if (EQ (BVAR (b, cursor_type), Qt))
28033 {
28034 cursor_type = FRAME_DESIRED_CURSOR (f);
28035 *width = FRAME_CURSOR_WIDTH (f);
28036 }
28037 else
28038 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
28039
28040 /* Use cursor-in-non-selected-windows instead
28041 for non-selected window or frame. */
28042 if (non_selected)
28043 {
28044 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
28045 if (!EQ (Qt, alt_cursor))
28046 return get_specified_cursor_type (alt_cursor, width);
28047 /* t means modify the normal cursor type. */
28048 if (cursor_type == FILLED_BOX_CURSOR)
28049 cursor_type = HOLLOW_BOX_CURSOR;
28050 else if (cursor_type == BAR_CURSOR && *width > 1)
28051 --*width;
28052 return cursor_type;
28053 }
28054
28055 /* Use normal cursor if not blinked off. */
28056 if (!w->cursor_off_p)
28057 {
28058 if (glyph != NULL && glyph->type == XWIDGET_GLYPH)
28059 return NO_CURSOR;
28060 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
28061 {
28062 if (cursor_type == FILLED_BOX_CURSOR)
28063 {
28064 /* Using a block cursor on large images can be very annoying.
28065 So use a hollow cursor for "large" images.
28066 If image is not transparent (no mask), also use hollow cursor. */
28067 struct image *img = IMAGE_OPT_FROM_ID (f, glyph->u.img_id);
28068 if (img != NULL && IMAGEP (img->spec))
28069 {
28070 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
28071 where N = size of default frame font size.
28072 This should cover most of the "tiny" icons people may use. */
28073 if (!img->mask
28074 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
28075 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
28076 cursor_type = HOLLOW_BOX_CURSOR;
28077 }
28078 }
28079 else if (cursor_type != NO_CURSOR)
28080 {
28081 /* Display current only supports BOX and HOLLOW cursors for images.
28082 So for now, unconditionally use a HOLLOW cursor when cursor is
28083 not a solid box cursor. */
28084 cursor_type = HOLLOW_BOX_CURSOR;
28085 }
28086 }
28087 return cursor_type;
28088 }
28089
28090 /* Cursor is blinked off, so determine how to "toggle" it. */
28091
28092 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
28093 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
28094 return get_specified_cursor_type (XCDR (alt_cursor), width);
28095
28096 /* Then see if frame has specified a specific blink off cursor type. */
28097 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
28098 {
28099 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
28100 return FRAME_BLINK_OFF_CURSOR (f);
28101 }
28102
28103 #if false
28104 /* Some people liked having a permanently visible blinking cursor,
28105 while others had very strong opinions against it. So it was
28106 decided to remove it. KFS 2003-09-03 */
28107
28108 /* Finally perform built-in cursor blinking:
28109 filled box <-> hollow box
28110 wide [h]bar <-> narrow [h]bar
28111 narrow [h]bar <-> no cursor
28112 other type <-> no cursor */
28113
28114 if (cursor_type == FILLED_BOX_CURSOR)
28115 return HOLLOW_BOX_CURSOR;
28116
28117 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
28118 {
28119 *width = 1;
28120 return cursor_type;
28121 }
28122 #endif
28123
28124 return NO_CURSOR;
28125 }
28126
28127
28128 /* Notice when the text cursor of window W has been completely
28129 overwritten by a drawing operation that outputs glyphs in AREA
28130 starting at X0 and ending at X1 in the line starting at Y0 and
28131 ending at Y1. X coordinates are area-relative. X1 < 0 means all
28132 the rest of the line after X0 has been written. Y coordinates
28133 are window-relative. */
28134
28135 static void
28136 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
28137 int x0, int x1, int y0, int y1)
28138 {
28139 int cx0, cx1, cy0, cy1;
28140 struct glyph_row *row;
28141
28142 if (!w->phys_cursor_on_p)
28143 return;
28144 if (area != TEXT_AREA)
28145 return;
28146
28147 if (w->phys_cursor.vpos < 0
28148 || w->phys_cursor.vpos >= w->current_matrix->nrows
28149 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
28150 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
28151 return;
28152
28153 if (row->cursor_in_fringe_p)
28154 {
28155 row->cursor_in_fringe_p = false;
28156 draw_fringe_bitmap (w, row, row->reversed_p);
28157 w->phys_cursor_on_p = false;
28158 return;
28159 }
28160
28161 cx0 = w->phys_cursor.x;
28162 cx1 = cx0 + w->phys_cursor_width;
28163 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
28164 return;
28165
28166 /* The cursor image will be completely removed from the
28167 screen if the output area intersects the cursor area in
28168 y-direction. When we draw in [y0 y1[, and some part of
28169 the cursor is at y < y0, that part must have been drawn
28170 before. When scrolling, the cursor is erased before
28171 actually scrolling, so we don't come here. When not
28172 scrolling, the rows above the old cursor row must have
28173 changed, and in this case these rows must have written
28174 over the cursor image.
28175
28176 Likewise if part of the cursor is below y1, with the
28177 exception of the cursor being in the first blank row at
28178 the buffer and window end because update_text_area
28179 doesn't draw that row. (Except when it does, but
28180 that's handled in update_text_area.) */
28181
28182 cy0 = w->phys_cursor.y;
28183 cy1 = cy0 + w->phys_cursor_height;
28184 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
28185 return;
28186
28187 w->phys_cursor_on_p = false;
28188 }
28189
28190 #endif /* HAVE_WINDOW_SYSTEM */
28191
28192 \f
28193 /************************************************************************
28194 Mouse Face
28195 ************************************************************************/
28196
28197 #ifdef HAVE_WINDOW_SYSTEM
28198
28199 /* EXPORT for RIF:
28200 Fix the display of area AREA of overlapping row ROW in window W
28201 with respect to the overlapping part OVERLAPS. */
28202
28203 void
28204 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
28205 enum glyph_row_area area, int overlaps)
28206 {
28207 int i, x;
28208
28209 block_input ();
28210
28211 x = 0;
28212 for (i = 0; i < row->used[area];)
28213 {
28214 if (row->glyphs[area][i].overlaps_vertically_p)
28215 {
28216 int start = i, start_x = x;
28217
28218 do
28219 {
28220 x += row->glyphs[area][i].pixel_width;
28221 ++i;
28222 }
28223 while (i < row->used[area]
28224 && row->glyphs[area][i].overlaps_vertically_p);
28225
28226 draw_glyphs (w, start_x, row, area,
28227 start, i,
28228 DRAW_NORMAL_TEXT, overlaps);
28229 }
28230 else
28231 {
28232 x += row->glyphs[area][i].pixel_width;
28233 ++i;
28234 }
28235 }
28236
28237 unblock_input ();
28238 }
28239
28240
28241 /* EXPORT:
28242 Draw the cursor glyph of window W in glyph row ROW. See the
28243 comment of draw_glyphs for the meaning of HL. */
28244
28245 void
28246 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
28247 enum draw_glyphs_face hl)
28248 {
28249 /* If cursor hpos is out of bounds, don't draw garbage. This can
28250 happen in mini-buffer windows when switching between echo area
28251 glyphs and mini-buffer. */
28252 if ((row->reversed_p
28253 ? (w->phys_cursor.hpos >= 0)
28254 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
28255 {
28256 bool on_p = w->phys_cursor_on_p;
28257 int x1;
28258 int hpos = w->phys_cursor.hpos;
28259
28260 /* When the window is hscrolled, cursor hpos can legitimately be
28261 out of bounds, but we draw the cursor at the corresponding
28262 window margin in that case. */
28263 if (!row->reversed_p && hpos < 0)
28264 hpos = 0;
28265 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28266 hpos = row->used[TEXT_AREA] - 1;
28267
28268 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
28269 hl, 0);
28270 w->phys_cursor_on_p = on_p;
28271
28272 if (hl == DRAW_CURSOR)
28273 w->phys_cursor_width = x1 - w->phys_cursor.x;
28274 /* When we erase the cursor, and ROW is overlapped by other
28275 rows, make sure that these overlapping parts of other rows
28276 are redrawn. */
28277 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
28278 {
28279 w->phys_cursor_width = x1 - w->phys_cursor.x;
28280
28281 if (row > w->current_matrix->rows
28282 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
28283 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
28284 OVERLAPS_ERASED_CURSOR);
28285
28286 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
28287 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
28288 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
28289 OVERLAPS_ERASED_CURSOR);
28290 }
28291 }
28292 }
28293
28294
28295 /* Erase the image of a cursor of window W from the screen. */
28296
28297 void
28298 erase_phys_cursor (struct window *w)
28299 {
28300 struct frame *f = XFRAME (w->frame);
28301 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28302 int hpos = w->phys_cursor.hpos;
28303 int vpos = w->phys_cursor.vpos;
28304 bool mouse_face_here_p = false;
28305 struct glyph_matrix *active_glyphs = w->current_matrix;
28306 struct glyph_row *cursor_row;
28307 struct glyph *cursor_glyph;
28308 enum draw_glyphs_face hl;
28309
28310 /* No cursor displayed or row invalidated => nothing to do on the
28311 screen. */
28312 if (w->phys_cursor_type == NO_CURSOR)
28313 goto mark_cursor_off;
28314
28315 /* VPOS >= active_glyphs->nrows means that window has been resized.
28316 Don't bother to erase the cursor. */
28317 if (vpos >= active_glyphs->nrows)
28318 goto mark_cursor_off;
28319
28320 /* If row containing cursor is marked invalid, there is nothing we
28321 can do. */
28322 cursor_row = MATRIX_ROW (active_glyphs, vpos);
28323 if (!cursor_row->enabled_p)
28324 goto mark_cursor_off;
28325
28326 /* If line spacing is > 0, old cursor may only be partially visible in
28327 window after split-window. So adjust visible height. */
28328 cursor_row->visible_height = min (cursor_row->visible_height,
28329 window_text_bottom_y (w) - cursor_row->y);
28330
28331 /* If row is completely invisible, don't attempt to delete a cursor which
28332 isn't there. This can happen if cursor is at top of a window, and
28333 we switch to a buffer with a header line in that window. */
28334 if (cursor_row->visible_height <= 0)
28335 goto mark_cursor_off;
28336
28337 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
28338 if (cursor_row->cursor_in_fringe_p)
28339 {
28340 cursor_row->cursor_in_fringe_p = false;
28341 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
28342 goto mark_cursor_off;
28343 }
28344
28345 /* This can happen when the new row is shorter than the old one.
28346 In this case, either draw_glyphs or clear_end_of_line
28347 should have cleared the cursor. Note that we wouldn't be
28348 able to erase the cursor in this case because we don't have a
28349 cursor glyph at hand. */
28350 if ((cursor_row->reversed_p
28351 ? (w->phys_cursor.hpos < 0)
28352 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
28353 goto mark_cursor_off;
28354
28355 /* When the window is hscrolled, cursor hpos can legitimately be out
28356 of bounds, but we draw the cursor at the corresponding window
28357 margin in that case. */
28358 if (!cursor_row->reversed_p && hpos < 0)
28359 hpos = 0;
28360 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
28361 hpos = cursor_row->used[TEXT_AREA] - 1;
28362
28363 /* If the cursor is in the mouse face area, redisplay that when
28364 we clear the cursor. */
28365 if (! NILP (hlinfo->mouse_face_window)
28366 && coords_in_mouse_face_p (w, hpos, vpos)
28367 /* Don't redraw the cursor's spot in mouse face if it is at the
28368 end of a line (on a newline). The cursor appears there, but
28369 mouse highlighting does not. */
28370 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
28371 mouse_face_here_p = true;
28372
28373 /* Maybe clear the display under the cursor. */
28374 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
28375 {
28376 int x, y;
28377 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
28378 int width;
28379
28380 cursor_glyph = get_phys_cursor_glyph (w);
28381 if (cursor_glyph == NULL)
28382 goto mark_cursor_off;
28383
28384 width = cursor_glyph->pixel_width;
28385 x = w->phys_cursor.x;
28386 if (x < 0)
28387 {
28388 width += x;
28389 x = 0;
28390 }
28391 width = min (width, window_box_width (w, TEXT_AREA) - x);
28392 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
28393 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
28394
28395 if (width > 0)
28396 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
28397 }
28398
28399 /* Erase the cursor by redrawing the character underneath it. */
28400 if (mouse_face_here_p)
28401 hl = DRAW_MOUSE_FACE;
28402 else
28403 hl = DRAW_NORMAL_TEXT;
28404 draw_phys_cursor_glyph (w, cursor_row, hl);
28405
28406 mark_cursor_off:
28407 w->phys_cursor_on_p = false;
28408 w->phys_cursor_type = NO_CURSOR;
28409 }
28410
28411
28412 /* Display or clear cursor of window W. If !ON, clear the cursor.
28413 If ON, display the cursor; where to put the cursor is specified by
28414 HPOS, VPOS, X and Y. */
28415
28416 void
28417 display_and_set_cursor (struct window *w, bool on,
28418 int hpos, int vpos, int x, int y)
28419 {
28420 struct frame *f = XFRAME (w->frame);
28421 int new_cursor_type;
28422 int new_cursor_width;
28423 bool active_cursor;
28424 struct glyph_row *glyph_row;
28425 struct glyph *glyph;
28426
28427 /* This is pointless on invisible frames, and dangerous on garbaged
28428 windows and frames; in the latter case, the frame or window may
28429 be in the midst of changing its size, and x and y may be off the
28430 window. */
28431 if (! FRAME_VISIBLE_P (f)
28432 || FRAME_GARBAGED_P (f)
28433 || vpos >= w->current_matrix->nrows
28434 || hpos >= w->current_matrix->matrix_w)
28435 return;
28436
28437 /* If cursor is off and we want it off, return quickly. */
28438 if (!on && !w->phys_cursor_on_p)
28439 return;
28440
28441 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
28442 /* If cursor row is not enabled, we don't really know where to
28443 display the cursor. */
28444 if (!glyph_row->enabled_p)
28445 {
28446 w->phys_cursor_on_p = false;
28447 return;
28448 }
28449
28450 glyph = NULL;
28451 if (!glyph_row->exact_window_width_line_p
28452 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
28453 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
28454
28455 eassert (input_blocked_p ());
28456
28457 /* Set new_cursor_type to the cursor we want to be displayed. */
28458 new_cursor_type = get_window_cursor_type (w, glyph,
28459 &new_cursor_width, &active_cursor);
28460
28461 /* If cursor is currently being shown and we don't want it to be or
28462 it is in the wrong place, or the cursor type is not what we want,
28463 erase it. */
28464 if (w->phys_cursor_on_p
28465 && (!on
28466 || w->phys_cursor.x != x
28467 || w->phys_cursor.y != y
28468 /* HPOS can be negative in R2L rows whose
28469 exact_window_width_line_p flag is set (i.e. their newline
28470 would "overflow into the fringe"). */
28471 || hpos < 0
28472 || new_cursor_type != w->phys_cursor_type
28473 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
28474 && new_cursor_width != w->phys_cursor_width)))
28475 erase_phys_cursor (w);
28476
28477 /* Don't check phys_cursor_on_p here because that flag is only set
28478 to false in some cases where we know that the cursor has been
28479 completely erased, to avoid the extra work of erasing the cursor
28480 twice. In other words, phys_cursor_on_p can be true and the cursor
28481 still not be visible, or it has only been partly erased. */
28482 if (on)
28483 {
28484 w->phys_cursor_ascent = glyph_row->ascent;
28485 w->phys_cursor_height = glyph_row->height;
28486
28487 /* Set phys_cursor_.* before x_draw_.* is called because some
28488 of them may need the information. */
28489 w->phys_cursor.x = x;
28490 w->phys_cursor.y = glyph_row->y;
28491 w->phys_cursor.hpos = hpos;
28492 w->phys_cursor.vpos = vpos;
28493 }
28494
28495 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
28496 new_cursor_type, new_cursor_width,
28497 on, active_cursor);
28498 }
28499
28500
28501 /* Switch the display of W's cursor on or off, according to the value
28502 of ON. */
28503
28504 static void
28505 update_window_cursor (struct window *w, bool on)
28506 {
28507 /* Don't update cursor in windows whose frame is in the process
28508 of being deleted. */
28509 if (w->current_matrix)
28510 {
28511 int hpos = w->phys_cursor.hpos;
28512 int vpos = w->phys_cursor.vpos;
28513 struct glyph_row *row;
28514
28515 if (vpos >= w->current_matrix->nrows
28516 || hpos >= w->current_matrix->matrix_w)
28517 return;
28518
28519 row = MATRIX_ROW (w->current_matrix, vpos);
28520
28521 /* When the window is hscrolled, cursor hpos can legitimately be
28522 out of bounds, but we draw the cursor at the corresponding
28523 window margin in that case. */
28524 if (!row->reversed_p && hpos < 0)
28525 hpos = 0;
28526 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28527 hpos = row->used[TEXT_AREA] - 1;
28528
28529 block_input ();
28530 display_and_set_cursor (w, on, hpos, vpos,
28531 w->phys_cursor.x, w->phys_cursor.y);
28532 unblock_input ();
28533 }
28534 }
28535
28536
28537 /* Call update_window_cursor with parameter ON_P on all leaf windows
28538 in the window tree rooted at W. */
28539
28540 static void
28541 update_cursor_in_window_tree (struct window *w, bool on_p)
28542 {
28543 while (w)
28544 {
28545 if (WINDOWP (w->contents))
28546 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
28547 else
28548 update_window_cursor (w, on_p);
28549
28550 w = NILP (w->next) ? 0 : XWINDOW (w->next);
28551 }
28552 }
28553
28554
28555 /* EXPORT:
28556 Display the cursor on window W, or clear it, according to ON_P.
28557 Don't change the cursor's position. */
28558
28559 void
28560 x_update_cursor (struct frame *f, bool on_p)
28561 {
28562 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
28563 }
28564
28565
28566 /* EXPORT:
28567 Clear the cursor of window W to background color, and mark the
28568 cursor as not shown. This is used when the text where the cursor
28569 is about to be rewritten. */
28570
28571 void
28572 x_clear_cursor (struct window *w)
28573 {
28574 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
28575 update_window_cursor (w, false);
28576 }
28577
28578 #endif /* HAVE_WINDOW_SYSTEM */
28579
28580 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
28581 and MSDOS. */
28582 static void
28583 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
28584 int start_hpos, int end_hpos,
28585 enum draw_glyphs_face draw)
28586 {
28587 #ifdef HAVE_WINDOW_SYSTEM
28588 if (FRAME_WINDOW_P (XFRAME (w->frame)))
28589 {
28590 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
28591 return;
28592 }
28593 #endif
28594 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
28595 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
28596 #endif
28597 }
28598
28599 /* Display the active region described by mouse_face_* according to DRAW. */
28600
28601 static void
28602 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
28603 {
28604 struct window *w = XWINDOW (hlinfo->mouse_face_window);
28605 struct frame *f = XFRAME (WINDOW_FRAME (w));
28606
28607 if (/* If window is in the process of being destroyed, don't bother
28608 to do anything. */
28609 w->current_matrix != NULL
28610 /* Don't update mouse highlight if hidden. */
28611 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
28612 /* Recognize when we are called to operate on rows that don't exist
28613 anymore. This can happen when a window is split. */
28614 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
28615 {
28616 bool phys_cursor_on_p = w->phys_cursor_on_p;
28617 struct glyph_row *row, *first, *last;
28618
28619 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
28620 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
28621
28622 for (row = first; row <= last && row->enabled_p; ++row)
28623 {
28624 int start_hpos, end_hpos, start_x;
28625
28626 /* For all but the first row, the highlight starts at column 0. */
28627 if (row == first)
28628 {
28629 /* R2L rows have BEG and END in reversed order, but the
28630 screen drawing geometry is always left to right. So
28631 we need to mirror the beginning and end of the
28632 highlighted area in R2L rows. */
28633 if (!row->reversed_p)
28634 {
28635 start_hpos = hlinfo->mouse_face_beg_col;
28636 start_x = hlinfo->mouse_face_beg_x;
28637 }
28638 else if (row == last)
28639 {
28640 start_hpos = hlinfo->mouse_face_end_col;
28641 start_x = hlinfo->mouse_face_end_x;
28642 }
28643 else
28644 {
28645 start_hpos = 0;
28646 start_x = 0;
28647 }
28648 }
28649 else if (row->reversed_p && row == last)
28650 {
28651 start_hpos = hlinfo->mouse_face_end_col;
28652 start_x = hlinfo->mouse_face_end_x;
28653 }
28654 else
28655 {
28656 start_hpos = 0;
28657 start_x = 0;
28658 }
28659
28660 if (row == last)
28661 {
28662 if (!row->reversed_p)
28663 end_hpos = hlinfo->mouse_face_end_col;
28664 else if (row == first)
28665 end_hpos = hlinfo->mouse_face_beg_col;
28666 else
28667 {
28668 end_hpos = row->used[TEXT_AREA];
28669 if (draw == DRAW_NORMAL_TEXT)
28670 row->fill_line_p = true; /* Clear to end of line. */
28671 }
28672 }
28673 else if (row->reversed_p && row == first)
28674 end_hpos = hlinfo->mouse_face_beg_col;
28675 else
28676 {
28677 end_hpos = row->used[TEXT_AREA];
28678 if (draw == DRAW_NORMAL_TEXT)
28679 row->fill_line_p = true; /* Clear to end of line. */
28680 }
28681
28682 if (end_hpos > start_hpos)
28683 {
28684 draw_row_with_mouse_face (w, start_x, row,
28685 start_hpos, end_hpos, draw);
28686
28687 row->mouse_face_p
28688 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
28689 }
28690 }
28691
28692 /* When we've written over the cursor, arrange for it to
28693 be displayed again. */
28694 if (FRAME_WINDOW_P (f)
28695 && phys_cursor_on_p && !w->phys_cursor_on_p)
28696 {
28697 #ifdef HAVE_WINDOW_SYSTEM
28698 int hpos = w->phys_cursor.hpos;
28699
28700 /* When the window is hscrolled, cursor hpos can legitimately be
28701 out of bounds, but we draw the cursor at the corresponding
28702 window margin in that case. */
28703 if (!row->reversed_p && hpos < 0)
28704 hpos = 0;
28705 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28706 hpos = row->used[TEXT_AREA] - 1;
28707
28708 block_input ();
28709 display_and_set_cursor (w, true, hpos, w->phys_cursor.vpos,
28710 w->phys_cursor.x, w->phys_cursor.y);
28711 unblock_input ();
28712 #endif /* HAVE_WINDOW_SYSTEM */
28713 }
28714 }
28715
28716 #ifdef HAVE_WINDOW_SYSTEM
28717 /* Change the mouse cursor. */
28718 if (FRAME_WINDOW_P (f) && NILP (do_mouse_tracking))
28719 {
28720 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
28721 if (draw == DRAW_NORMAL_TEXT
28722 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
28723 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
28724 else
28725 #endif
28726 if (draw == DRAW_MOUSE_FACE)
28727 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
28728 else
28729 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
28730 }
28731 #endif /* HAVE_WINDOW_SYSTEM */
28732 }
28733
28734 /* EXPORT:
28735 Clear out the mouse-highlighted active region.
28736 Redraw it un-highlighted first. Value is true if mouse
28737 face was actually drawn unhighlighted. */
28738
28739 bool
28740 clear_mouse_face (Mouse_HLInfo *hlinfo)
28741 {
28742 bool cleared
28743 = !hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window);
28744 if (cleared)
28745 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
28746 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
28747 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
28748 hlinfo->mouse_face_window = Qnil;
28749 hlinfo->mouse_face_overlay = Qnil;
28750 return cleared;
28751 }
28752
28753 /* Return true if the coordinates HPOS and VPOS on windows W are
28754 within the mouse face on that window. */
28755 static bool
28756 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
28757 {
28758 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
28759
28760 /* Quickly resolve the easy cases. */
28761 if (!(WINDOWP (hlinfo->mouse_face_window)
28762 && XWINDOW (hlinfo->mouse_face_window) == w))
28763 return false;
28764 if (vpos < hlinfo->mouse_face_beg_row
28765 || vpos > hlinfo->mouse_face_end_row)
28766 return false;
28767 if (vpos > hlinfo->mouse_face_beg_row
28768 && vpos < hlinfo->mouse_face_end_row)
28769 return true;
28770
28771 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
28772 {
28773 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28774 {
28775 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
28776 return true;
28777 }
28778 else if ((vpos == hlinfo->mouse_face_beg_row
28779 && hpos >= hlinfo->mouse_face_beg_col)
28780 || (vpos == hlinfo->mouse_face_end_row
28781 && hpos < hlinfo->mouse_face_end_col))
28782 return true;
28783 }
28784 else
28785 {
28786 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28787 {
28788 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
28789 return true;
28790 }
28791 else if ((vpos == hlinfo->mouse_face_beg_row
28792 && hpos <= hlinfo->mouse_face_beg_col)
28793 || (vpos == hlinfo->mouse_face_end_row
28794 && hpos > hlinfo->mouse_face_end_col))
28795 return true;
28796 }
28797 return false;
28798 }
28799
28800
28801 /* EXPORT:
28802 True if physical cursor of window W is within mouse face. */
28803
28804 bool
28805 cursor_in_mouse_face_p (struct window *w)
28806 {
28807 int hpos = w->phys_cursor.hpos;
28808 int vpos = w->phys_cursor.vpos;
28809 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
28810
28811 /* When the window is hscrolled, cursor hpos can legitimately be out
28812 of bounds, but we draw the cursor at the corresponding window
28813 margin in that case. */
28814 if (!row->reversed_p && hpos < 0)
28815 hpos = 0;
28816 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28817 hpos = row->used[TEXT_AREA] - 1;
28818
28819 return coords_in_mouse_face_p (w, hpos, vpos);
28820 }
28821
28822
28823 \f
28824 /* Find the glyph rows START_ROW and END_ROW of window W that display
28825 characters between buffer positions START_CHARPOS and END_CHARPOS
28826 (excluding END_CHARPOS). DISP_STRING is a display string that
28827 covers these buffer positions. This is similar to
28828 row_containing_pos, but is more accurate when bidi reordering makes
28829 buffer positions change non-linearly with glyph rows. */
28830 static void
28831 rows_from_pos_range (struct window *w,
28832 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
28833 Lisp_Object disp_string,
28834 struct glyph_row **start, struct glyph_row **end)
28835 {
28836 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28837 int last_y = window_text_bottom_y (w);
28838 struct glyph_row *row;
28839
28840 *start = NULL;
28841 *end = NULL;
28842
28843 while (!first->enabled_p
28844 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
28845 first++;
28846
28847 /* Find the START row. */
28848 for (row = first;
28849 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
28850 row++)
28851 {
28852 /* A row can potentially be the START row if the range of the
28853 characters it displays intersects the range
28854 [START_CHARPOS..END_CHARPOS). */
28855 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
28856 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
28857 /* See the commentary in row_containing_pos, for the
28858 explanation of the complicated way to check whether
28859 some position is beyond the end of the characters
28860 displayed by a row. */
28861 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
28862 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
28863 && !row->ends_at_zv_p
28864 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
28865 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
28866 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
28867 && !row->ends_at_zv_p
28868 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
28869 {
28870 /* Found a candidate row. Now make sure at least one of the
28871 glyphs it displays has a charpos from the range
28872 [START_CHARPOS..END_CHARPOS).
28873
28874 This is not obvious because bidi reordering could make
28875 buffer positions of a row be 1,2,3,102,101,100, and if we
28876 want to highlight characters in [50..60), we don't want
28877 this row, even though [50..60) does intersect [1..103),
28878 the range of character positions given by the row's start
28879 and end positions. */
28880 struct glyph *g = row->glyphs[TEXT_AREA];
28881 struct glyph *e = g + row->used[TEXT_AREA];
28882
28883 while (g < e)
28884 {
28885 if (((BUFFERP (g->object) || NILP (g->object))
28886 && start_charpos <= g->charpos && g->charpos < end_charpos)
28887 /* A glyph that comes from DISP_STRING is by
28888 definition to be highlighted. */
28889 || EQ (g->object, disp_string))
28890 *start = row;
28891 g++;
28892 }
28893 if (*start)
28894 break;
28895 }
28896 }
28897
28898 /* Find the END row. */
28899 if (!*start
28900 /* If the last row is partially visible, start looking for END
28901 from that row, instead of starting from FIRST. */
28902 && !(row->enabled_p
28903 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
28904 row = first;
28905 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
28906 {
28907 struct glyph_row *next = row + 1;
28908 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
28909
28910 if (!next->enabled_p
28911 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
28912 /* The first row >= START whose range of displayed characters
28913 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28914 is the row END + 1. */
28915 || (start_charpos < next_start
28916 && end_charpos < next_start)
28917 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
28918 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
28919 && !next->ends_at_zv_p
28920 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
28921 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
28922 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
28923 && !next->ends_at_zv_p
28924 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
28925 {
28926 *end = row;
28927 break;
28928 }
28929 else
28930 {
28931 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28932 but none of the characters it displays are in the range, it is
28933 also END + 1. */
28934 struct glyph *g = next->glyphs[TEXT_AREA];
28935 struct glyph *s = g;
28936 struct glyph *e = g + next->used[TEXT_AREA];
28937
28938 while (g < e)
28939 {
28940 if (((BUFFERP (g->object) || NILP (g->object))
28941 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
28942 /* If the buffer position of the first glyph in
28943 the row is equal to END_CHARPOS, it means
28944 the last character to be highlighted is the
28945 newline of ROW, and we must consider NEXT as
28946 END, not END+1. */
28947 || (((!next->reversed_p && g == s)
28948 || (next->reversed_p && g == e - 1))
28949 && (g->charpos == end_charpos
28950 /* Special case for when NEXT is an
28951 empty line at ZV. */
28952 || (g->charpos == -1
28953 && !row->ends_at_zv_p
28954 && next_start == end_charpos)))))
28955 /* A glyph that comes from DISP_STRING is by
28956 definition to be highlighted. */
28957 || EQ (g->object, disp_string))
28958 break;
28959 g++;
28960 }
28961 if (g == e)
28962 {
28963 *end = row;
28964 break;
28965 }
28966 /* The first row that ends at ZV must be the last to be
28967 highlighted. */
28968 else if (next->ends_at_zv_p)
28969 {
28970 *end = next;
28971 break;
28972 }
28973 }
28974 }
28975 }
28976
28977 /* This function sets the mouse_face_* elements of HLINFO, assuming
28978 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28979 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28980 for the overlay or run of text properties specifying the mouse
28981 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28982 before-string and after-string that must also be highlighted.
28983 DISP_STRING, if non-nil, is a display string that may cover some
28984 or all of the highlighted text. */
28985
28986 static void
28987 mouse_face_from_buffer_pos (Lisp_Object window,
28988 Mouse_HLInfo *hlinfo,
28989 ptrdiff_t mouse_charpos,
28990 ptrdiff_t start_charpos,
28991 ptrdiff_t end_charpos,
28992 Lisp_Object before_string,
28993 Lisp_Object after_string,
28994 Lisp_Object disp_string)
28995 {
28996 struct window *w = XWINDOW (window);
28997 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28998 struct glyph_row *r1, *r2;
28999 struct glyph *glyph, *end;
29000 ptrdiff_t ignore, pos;
29001 int x;
29002
29003 eassert (NILP (disp_string) || STRINGP (disp_string));
29004 eassert (NILP (before_string) || STRINGP (before_string));
29005 eassert (NILP (after_string) || STRINGP (after_string));
29006
29007 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
29008 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
29009 if (r1 == NULL)
29010 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
29011 /* If the before-string or display-string contains newlines,
29012 rows_from_pos_range skips to its last row. Move back. */
29013 if (!NILP (before_string) || !NILP (disp_string))
29014 {
29015 struct glyph_row *prev;
29016 while ((prev = r1 - 1, prev >= first)
29017 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
29018 && prev->used[TEXT_AREA] > 0)
29019 {
29020 struct glyph *beg = prev->glyphs[TEXT_AREA];
29021 glyph = beg + prev->used[TEXT_AREA];
29022 while (--glyph >= beg && NILP (glyph->object));
29023 if (glyph < beg
29024 || !(EQ (glyph->object, before_string)
29025 || EQ (glyph->object, disp_string)))
29026 break;
29027 r1 = prev;
29028 }
29029 }
29030 if (r2 == NULL)
29031 {
29032 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
29033 hlinfo->mouse_face_past_end = true;
29034 }
29035 else if (!NILP (after_string))
29036 {
29037 /* If the after-string has newlines, advance to its last row. */
29038 struct glyph_row *next;
29039 struct glyph_row *last
29040 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
29041
29042 for (next = r2 + 1;
29043 next <= last
29044 && next->used[TEXT_AREA] > 0
29045 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
29046 ++next)
29047 r2 = next;
29048 }
29049 /* The rest of the display engine assumes that mouse_face_beg_row is
29050 either above mouse_face_end_row or identical to it. But with
29051 bidi-reordered continued lines, the row for START_CHARPOS could
29052 be below the row for END_CHARPOS. If so, swap the rows and store
29053 them in correct order. */
29054 if (r1->y > r2->y)
29055 {
29056 struct glyph_row *tem = r2;
29057
29058 r2 = r1;
29059 r1 = tem;
29060 }
29061
29062 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
29063 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
29064
29065 /* For a bidi-reordered row, the positions of BEFORE_STRING,
29066 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
29067 could be anywhere in the row and in any order. The strategy
29068 below is to find the leftmost and the rightmost glyph that
29069 belongs to either of these 3 strings, or whose position is
29070 between START_CHARPOS and END_CHARPOS, and highlight all the
29071 glyphs between those two. This may cover more than just the text
29072 between START_CHARPOS and END_CHARPOS if the range of characters
29073 strides the bidi level boundary, e.g. if the beginning is in R2L
29074 text while the end is in L2R text or vice versa. */
29075 if (!r1->reversed_p)
29076 {
29077 /* This row is in a left to right paragraph. Scan it left to
29078 right. */
29079 glyph = r1->glyphs[TEXT_AREA];
29080 end = glyph + r1->used[TEXT_AREA];
29081 x = r1->x;
29082
29083 /* Skip truncation glyphs at the start of the glyph row. */
29084 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
29085 for (; glyph < end
29086 && NILP (glyph->object)
29087 && glyph->charpos < 0;
29088 ++glyph)
29089 x += glyph->pixel_width;
29090
29091 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29092 or DISP_STRING, and the first glyph from buffer whose
29093 position is between START_CHARPOS and END_CHARPOS. */
29094 for (; glyph < end
29095 && !NILP (glyph->object)
29096 && !EQ (glyph->object, disp_string)
29097 && !(BUFFERP (glyph->object)
29098 && (glyph->charpos >= start_charpos
29099 && glyph->charpos < end_charpos));
29100 ++glyph)
29101 {
29102 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29103 are present at buffer positions between START_CHARPOS and
29104 END_CHARPOS, or if they come from an overlay. */
29105 if (EQ (glyph->object, before_string))
29106 {
29107 pos = string_buffer_position (before_string,
29108 start_charpos);
29109 /* If pos == 0, it means before_string came from an
29110 overlay, not from a buffer position. */
29111 if (!pos || (pos >= start_charpos && pos < end_charpos))
29112 break;
29113 }
29114 else if (EQ (glyph->object, after_string))
29115 {
29116 pos = string_buffer_position (after_string, end_charpos);
29117 if (!pos || (pos >= start_charpos && pos < end_charpos))
29118 break;
29119 }
29120 x += glyph->pixel_width;
29121 }
29122 hlinfo->mouse_face_beg_x = x;
29123 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
29124 }
29125 else
29126 {
29127 /* This row is in a right to left paragraph. Scan it right to
29128 left. */
29129 struct glyph *g;
29130
29131 end = r1->glyphs[TEXT_AREA] - 1;
29132 glyph = end + r1->used[TEXT_AREA];
29133
29134 /* Skip truncation glyphs at the start of the glyph row. */
29135 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
29136 for (; glyph > end
29137 && NILP (glyph->object)
29138 && glyph->charpos < 0;
29139 --glyph)
29140 ;
29141
29142 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
29143 or DISP_STRING, and the first glyph from buffer whose
29144 position is between START_CHARPOS and END_CHARPOS. */
29145 for (; glyph > end
29146 && !NILP (glyph->object)
29147 && !EQ (glyph->object, disp_string)
29148 && !(BUFFERP (glyph->object)
29149 && (glyph->charpos >= start_charpos
29150 && glyph->charpos < end_charpos));
29151 --glyph)
29152 {
29153 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29154 are present at buffer positions between START_CHARPOS and
29155 END_CHARPOS, or if they come from an overlay. */
29156 if (EQ (glyph->object, before_string))
29157 {
29158 pos = string_buffer_position (before_string, start_charpos);
29159 /* If pos == 0, it means before_string came from an
29160 overlay, not from a buffer position. */
29161 if (!pos || (pos >= start_charpos && pos < end_charpos))
29162 break;
29163 }
29164 else if (EQ (glyph->object, after_string))
29165 {
29166 pos = string_buffer_position (after_string, end_charpos);
29167 if (!pos || (pos >= start_charpos && pos < end_charpos))
29168 break;
29169 }
29170 }
29171
29172 glyph++; /* first glyph to the right of the highlighted area */
29173 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
29174 x += g->pixel_width;
29175 hlinfo->mouse_face_beg_x = x;
29176 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
29177 }
29178
29179 /* If the highlight ends in a different row, compute GLYPH and END
29180 for the end row. Otherwise, reuse the values computed above for
29181 the row where the highlight begins. */
29182 if (r2 != r1)
29183 {
29184 if (!r2->reversed_p)
29185 {
29186 glyph = r2->glyphs[TEXT_AREA];
29187 end = glyph + r2->used[TEXT_AREA];
29188 x = r2->x;
29189 }
29190 else
29191 {
29192 end = r2->glyphs[TEXT_AREA] - 1;
29193 glyph = end + r2->used[TEXT_AREA];
29194 }
29195 }
29196
29197 if (!r2->reversed_p)
29198 {
29199 /* Skip truncation and continuation glyphs near the end of the
29200 row, and also blanks and stretch glyphs inserted by
29201 extend_face_to_end_of_line. */
29202 while (end > glyph
29203 && NILP ((end - 1)->object))
29204 --end;
29205 /* Scan the rest of the glyph row from the end, looking for the
29206 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29207 DISP_STRING, or whose position is between START_CHARPOS
29208 and END_CHARPOS */
29209 for (--end;
29210 end > glyph
29211 && !NILP (end->object)
29212 && !EQ (end->object, disp_string)
29213 && !(BUFFERP (end->object)
29214 && (end->charpos >= start_charpos
29215 && end->charpos < end_charpos));
29216 --end)
29217 {
29218 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29219 are present at buffer positions between START_CHARPOS and
29220 END_CHARPOS, or if they come from an overlay. */
29221 if (EQ (end->object, before_string))
29222 {
29223 pos = string_buffer_position (before_string, start_charpos);
29224 if (!pos || (pos >= start_charpos && pos < end_charpos))
29225 break;
29226 }
29227 else if (EQ (end->object, after_string))
29228 {
29229 pos = string_buffer_position (after_string, end_charpos);
29230 if (!pos || (pos >= start_charpos && pos < end_charpos))
29231 break;
29232 }
29233 }
29234 /* Find the X coordinate of the last glyph to be highlighted. */
29235 for (; glyph <= end; ++glyph)
29236 x += glyph->pixel_width;
29237
29238 hlinfo->mouse_face_end_x = x;
29239 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
29240 }
29241 else
29242 {
29243 /* Skip truncation and continuation glyphs near the end of the
29244 row, and also blanks and stretch glyphs inserted by
29245 extend_face_to_end_of_line. */
29246 x = r2->x;
29247 end++;
29248 while (end < glyph
29249 && NILP (end->object))
29250 {
29251 x += end->pixel_width;
29252 ++end;
29253 }
29254 /* Scan the rest of the glyph row from the end, looking for the
29255 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
29256 DISP_STRING, or whose position is between START_CHARPOS
29257 and END_CHARPOS */
29258 for ( ;
29259 end < glyph
29260 && !NILP (end->object)
29261 && !EQ (end->object, disp_string)
29262 && !(BUFFERP (end->object)
29263 && (end->charpos >= start_charpos
29264 && end->charpos < end_charpos));
29265 ++end)
29266 {
29267 /* BEFORE_STRING or AFTER_STRING are only relevant if they
29268 are present at buffer positions between START_CHARPOS and
29269 END_CHARPOS, or if they come from an overlay. */
29270 if (EQ (end->object, before_string))
29271 {
29272 pos = string_buffer_position (before_string, start_charpos);
29273 if (!pos || (pos >= start_charpos && pos < end_charpos))
29274 break;
29275 }
29276 else if (EQ (end->object, after_string))
29277 {
29278 pos = string_buffer_position (after_string, end_charpos);
29279 if (!pos || (pos >= start_charpos && pos < end_charpos))
29280 break;
29281 }
29282 x += end->pixel_width;
29283 }
29284 /* If we exited the above loop because we arrived at the last
29285 glyph of the row, and its buffer position is still not in
29286 range, it means the last character in range is the preceding
29287 newline. Bump the end column and x values to get past the
29288 last glyph. */
29289 if (end == glyph
29290 && BUFFERP (end->object)
29291 && (end->charpos < start_charpos
29292 || end->charpos >= end_charpos))
29293 {
29294 x += end->pixel_width;
29295 ++end;
29296 }
29297 hlinfo->mouse_face_end_x = x;
29298 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
29299 }
29300
29301 hlinfo->mouse_face_window = window;
29302 hlinfo->mouse_face_face_id
29303 = face_at_buffer_position (w, mouse_charpos, &ignore,
29304 mouse_charpos + 1,
29305 !hlinfo->mouse_face_hidden, -1);
29306 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29307 }
29308
29309 /* The following function is not used anymore (replaced with
29310 mouse_face_from_string_pos), but I leave it here for the time
29311 being, in case someone would. */
29312
29313 #if false /* not used */
29314
29315 /* Find the position of the glyph for position POS in OBJECT in
29316 window W's current matrix, and return in *X, *Y the pixel
29317 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
29318
29319 RIGHT_P means return the position of the right edge of the glyph.
29320 !RIGHT_P means return the left edge position.
29321
29322 If no glyph for POS exists in the matrix, return the position of
29323 the glyph with the next smaller position that is in the matrix, if
29324 RIGHT_P is false. If RIGHT_P, and no glyph for POS
29325 exists in the matrix, return the position of the glyph with the
29326 next larger position in OBJECT.
29327
29328 Value is true if a glyph was found. */
29329
29330 static bool
29331 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
29332 int *hpos, int *vpos, int *x, int *y, bool right_p)
29333 {
29334 int yb = window_text_bottom_y (w);
29335 struct glyph_row *r;
29336 struct glyph *best_glyph = NULL;
29337 struct glyph_row *best_row = NULL;
29338 int best_x = 0;
29339
29340 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
29341 r->enabled_p && r->y < yb;
29342 ++r)
29343 {
29344 struct glyph *g = r->glyphs[TEXT_AREA];
29345 struct glyph *e = g + r->used[TEXT_AREA];
29346 int gx;
29347
29348 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
29349 if (EQ (g->object, object))
29350 {
29351 if (g->charpos == pos)
29352 {
29353 best_glyph = g;
29354 best_x = gx;
29355 best_row = r;
29356 goto found;
29357 }
29358 else if (best_glyph == NULL
29359 || ((eabs (g->charpos - pos)
29360 < eabs (best_glyph->charpos - pos))
29361 && (right_p
29362 ? g->charpos < pos
29363 : g->charpos > pos)))
29364 {
29365 best_glyph = g;
29366 best_x = gx;
29367 best_row = r;
29368 }
29369 }
29370 }
29371
29372 found:
29373
29374 if (best_glyph)
29375 {
29376 *x = best_x;
29377 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
29378
29379 if (right_p)
29380 {
29381 *x += best_glyph->pixel_width;
29382 ++*hpos;
29383 }
29384
29385 *y = best_row->y;
29386 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
29387 }
29388
29389 return best_glyph != NULL;
29390 }
29391 #endif /* not used */
29392
29393 /* Find the positions of the first and the last glyphs in window W's
29394 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
29395 (assumed to be a string), and return in HLINFO's mouse_face_*
29396 members the pixel and column/row coordinates of those glyphs. */
29397
29398 static void
29399 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
29400 Lisp_Object object,
29401 ptrdiff_t startpos, ptrdiff_t endpos)
29402 {
29403 int yb = window_text_bottom_y (w);
29404 struct glyph_row *r;
29405 struct glyph *g, *e;
29406 int gx;
29407 bool found = false;
29408
29409 /* Find the glyph row with at least one position in the range
29410 [STARTPOS..ENDPOS), and the first glyph in that row whose
29411 position belongs to that range. */
29412 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
29413 r->enabled_p && r->y < yb;
29414 ++r)
29415 {
29416 if (!r->reversed_p)
29417 {
29418 g = r->glyphs[TEXT_AREA];
29419 e = g + r->used[TEXT_AREA];
29420 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
29421 if (EQ (g->object, object)
29422 && startpos <= g->charpos && g->charpos < endpos)
29423 {
29424 hlinfo->mouse_face_beg_row
29425 = MATRIX_ROW_VPOS (r, w->current_matrix);
29426 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
29427 hlinfo->mouse_face_beg_x = gx;
29428 found = true;
29429 break;
29430 }
29431 }
29432 else
29433 {
29434 struct glyph *g1;
29435
29436 e = r->glyphs[TEXT_AREA];
29437 g = e + r->used[TEXT_AREA];
29438 for ( ; g > e; --g)
29439 if (EQ ((g-1)->object, object)
29440 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
29441 {
29442 hlinfo->mouse_face_beg_row
29443 = MATRIX_ROW_VPOS (r, w->current_matrix);
29444 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
29445 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
29446 gx += g1->pixel_width;
29447 hlinfo->mouse_face_beg_x = gx;
29448 found = true;
29449 break;
29450 }
29451 }
29452 if (found)
29453 break;
29454 }
29455
29456 if (!found)
29457 return;
29458
29459 /* Starting with the next row, look for the first row which does NOT
29460 include any glyphs whose positions are in the range. */
29461 for (++r; r->enabled_p && r->y < yb; ++r)
29462 {
29463 g = r->glyphs[TEXT_AREA];
29464 e = g + r->used[TEXT_AREA];
29465 found = false;
29466 for ( ; g < e; ++g)
29467 if (EQ (g->object, object)
29468 && startpos <= g->charpos && g->charpos < endpos)
29469 {
29470 found = true;
29471 break;
29472 }
29473 if (!found)
29474 break;
29475 }
29476
29477 /* The highlighted region ends on the previous row. */
29478 r--;
29479
29480 /* Set the end row. */
29481 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
29482
29483 /* Compute and set the end column and the end column's horizontal
29484 pixel coordinate. */
29485 if (!r->reversed_p)
29486 {
29487 g = r->glyphs[TEXT_AREA];
29488 e = g + r->used[TEXT_AREA];
29489 for ( ; e > g; --e)
29490 if (EQ ((e-1)->object, object)
29491 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
29492 break;
29493 hlinfo->mouse_face_end_col = e - g;
29494
29495 for (gx = r->x; g < e; ++g)
29496 gx += g->pixel_width;
29497 hlinfo->mouse_face_end_x = gx;
29498 }
29499 else
29500 {
29501 e = r->glyphs[TEXT_AREA];
29502 g = e + r->used[TEXT_AREA];
29503 for (gx = r->x ; e < g; ++e)
29504 {
29505 if (EQ (e->object, object)
29506 && startpos <= e->charpos && e->charpos < endpos)
29507 break;
29508 gx += e->pixel_width;
29509 }
29510 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
29511 hlinfo->mouse_face_end_x = gx;
29512 }
29513 }
29514
29515 #ifdef HAVE_WINDOW_SYSTEM
29516
29517 /* See if position X, Y is within a hot-spot of an image. */
29518
29519 static bool
29520 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
29521 {
29522 if (!CONSP (hot_spot))
29523 return false;
29524
29525 if (EQ (XCAR (hot_spot), Qrect))
29526 {
29527 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
29528 Lisp_Object rect = XCDR (hot_spot);
29529 Lisp_Object tem;
29530 if (!CONSP (rect))
29531 return false;
29532 if (!CONSP (XCAR (rect)))
29533 return false;
29534 if (!CONSP (XCDR (rect)))
29535 return false;
29536 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
29537 return false;
29538 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
29539 return false;
29540 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
29541 return false;
29542 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
29543 return false;
29544 return true;
29545 }
29546 else if (EQ (XCAR (hot_spot), Qcircle))
29547 {
29548 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
29549 Lisp_Object circ = XCDR (hot_spot);
29550 Lisp_Object lr, lx0, ly0;
29551 if (CONSP (circ)
29552 && CONSP (XCAR (circ))
29553 && (lr = XCDR (circ), NUMBERP (lr))
29554 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
29555 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
29556 {
29557 double r = XFLOATINT (lr);
29558 double dx = XINT (lx0) - x;
29559 double dy = XINT (ly0) - y;
29560 return (dx * dx + dy * dy <= r * r);
29561 }
29562 }
29563 else if (EQ (XCAR (hot_spot), Qpoly))
29564 {
29565 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
29566 if (VECTORP (XCDR (hot_spot)))
29567 {
29568 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
29569 Lisp_Object *poly = v->contents;
29570 ptrdiff_t n = v->header.size;
29571 ptrdiff_t i;
29572 bool inside = false;
29573 Lisp_Object lx, ly;
29574 int x0, y0;
29575
29576 /* Need an even number of coordinates, and at least 3 edges. */
29577 if (n < 6 || n & 1)
29578 return false;
29579
29580 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
29581 If count is odd, we are inside polygon. Pixels on edges
29582 may or may not be included depending on actual geometry of the
29583 polygon. */
29584 if ((lx = poly[n-2], !INTEGERP (lx))
29585 || (ly = poly[n-1], !INTEGERP (lx)))
29586 return false;
29587 x0 = XINT (lx), y0 = XINT (ly);
29588 for (i = 0; i < n; i += 2)
29589 {
29590 int x1 = x0, y1 = y0;
29591 if ((lx = poly[i], !INTEGERP (lx))
29592 || (ly = poly[i+1], !INTEGERP (ly)))
29593 return false;
29594 x0 = XINT (lx), y0 = XINT (ly);
29595
29596 /* Does this segment cross the X line? */
29597 if (x0 >= x)
29598 {
29599 if (x1 >= x)
29600 continue;
29601 }
29602 else if (x1 < x)
29603 continue;
29604 if (y > y0 && y > y1)
29605 continue;
29606 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
29607 inside = !inside;
29608 }
29609 return inside;
29610 }
29611 }
29612 return false;
29613 }
29614
29615 Lisp_Object
29616 find_hot_spot (Lisp_Object map, int x, int y)
29617 {
29618 while (CONSP (map))
29619 {
29620 if (CONSP (XCAR (map))
29621 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
29622 return XCAR (map);
29623 map = XCDR (map);
29624 }
29625
29626 return Qnil;
29627 }
29628
29629 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
29630 3, 3, 0,
29631 doc: /* Lookup in image map MAP coordinates X and Y.
29632 An image map is an alist where each element has the format (AREA ID PLIST).
29633 An AREA is specified as either a rectangle, a circle, or a polygon:
29634 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
29635 pixel coordinates of the upper left and bottom right corners.
29636 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
29637 and the radius of the circle; r may be a float or integer.
29638 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
29639 vector describes one corner in the polygon.
29640 Returns the alist element for the first matching AREA in MAP. */)
29641 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
29642 {
29643 if (NILP (map))
29644 return Qnil;
29645
29646 CHECK_NUMBER (x);
29647 CHECK_NUMBER (y);
29648
29649 return find_hot_spot (map,
29650 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
29651 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
29652 }
29653 #endif /* HAVE_WINDOW_SYSTEM */
29654
29655
29656 /* Display frame CURSOR, optionally using shape defined by POINTER. */
29657 static void
29658 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
29659 {
29660 #ifdef HAVE_WINDOW_SYSTEM
29661 if (!FRAME_WINDOW_P (f))
29662 return;
29663
29664 /* Do not change cursor shape while dragging mouse. */
29665 if (EQ (do_mouse_tracking, Qdragging))
29666 return;
29667
29668 if (!NILP (pointer))
29669 {
29670 if (EQ (pointer, Qarrow))
29671 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29672 else if (EQ (pointer, Qhand))
29673 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
29674 else if (EQ (pointer, Qtext))
29675 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29676 else if (EQ (pointer, intern ("hdrag")))
29677 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29678 else if (EQ (pointer, intern ("nhdrag")))
29679 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29680 # ifdef HAVE_X_WINDOWS
29681 else if (EQ (pointer, intern ("vdrag")))
29682 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29683 # endif
29684 else if (EQ (pointer, intern ("hourglass")))
29685 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
29686 else if (EQ (pointer, Qmodeline))
29687 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
29688 else
29689 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29690 }
29691
29692 if (cursor != No_Cursor)
29693 FRAME_RIF (f)->define_frame_cursor (f, cursor);
29694 #endif
29695 }
29696
29697 /* Take proper action when mouse has moved to the mode or header line
29698 or marginal area AREA of window W, x-position X and y-position Y.
29699 X is relative to the start of the text display area of W, so the
29700 width of bitmap areas and scroll bars must be subtracted to get a
29701 position relative to the start of the mode line. */
29702
29703 static void
29704 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
29705 enum window_part area)
29706 {
29707 struct window *w = XWINDOW (window);
29708 struct frame *f = XFRAME (w->frame);
29709 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29710 #ifdef HAVE_WINDOW_SYSTEM
29711 Display_Info *dpyinfo;
29712 #endif
29713 Cursor cursor = No_Cursor;
29714 Lisp_Object pointer = Qnil;
29715 int dx, dy, width, height;
29716 ptrdiff_t charpos;
29717 Lisp_Object string, object = Qnil;
29718 Lisp_Object pos UNINIT;
29719 Lisp_Object mouse_face;
29720 int original_x_pixel = x;
29721 struct glyph * glyph = NULL, * row_start_glyph = NULL;
29722 struct glyph_row *row UNINIT;
29723
29724 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
29725 {
29726 int x0;
29727 struct glyph *end;
29728
29729 /* Kludge alert: mode_line_string takes X/Y in pixels, but
29730 returns them in row/column units! */
29731 string = mode_line_string (w, area, &x, &y, &charpos,
29732 &object, &dx, &dy, &width, &height);
29733
29734 row = (area == ON_MODE_LINE
29735 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
29736 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
29737
29738 /* Find the glyph under the mouse pointer. */
29739 if (row->mode_line_p && row->enabled_p)
29740 {
29741 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
29742 end = glyph + row->used[TEXT_AREA];
29743
29744 for (x0 = original_x_pixel;
29745 glyph < end && x0 >= glyph->pixel_width;
29746 ++glyph)
29747 x0 -= glyph->pixel_width;
29748
29749 if (glyph >= end)
29750 glyph = NULL;
29751 }
29752 }
29753 else
29754 {
29755 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
29756 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29757 returns them in row/column units! */
29758 string = marginal_area_string (w, area, &x, &y, &charpos,
29759 &object, &dx, &dy, &width, &height);
29760 }
29761
29762 Lisp_Object help = Qnil;
29763
29764 #ifdef HAVE_WINDOW_SYSTEM
29765 if (IMAGEP (object))
29766 {
29767 Lisp_Object image_map, hotspot;
29768 if ((image_map = Fplist_get (XCDR (object), QCmap),
29769 !NILP (image_map))
29770 && (hotspot = find_hot_spot (image_map, dx, dy),
29771 CONSP (hotspot))
29772 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29773 {
29774 Lisp_Object plist;
29775
29776 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29777 If so, we could look for mouse-enter, mouse-leave
29778 properties in PLIST (and do something...). */
29779 hotspot = XCDR (hotspot);
29780 if (CONSP (hotspot)
29781 && (plist = XCAR (hotspot), CONSP (plist)))
29782 {
29783 pointer = Fplist_get (plist, Qpointer);
29784 if (NILP (pointer))
29785 pointer = Qhand;
29786 help = Fplist_get (plist, Qhelp_echo);
29787 if (!NILP (help))
29788 {
29789 help_echo_string = help;
29790 XSETWINDOW (help_echo_window, w);
29791 help_echo_object = w->contents;
29792 help_echo_pos = charpos;
29793 }
29794 }
29795 }
29796 if (NILP (pointer))
29797 pointer = Fplist_get (XCDR (object), QCpointer);
29798 }
29799 #endif /* HAVE_WINDOW_SYSTEM */
29800
29801 if (STRINGP (string))
29802 pos = make_number (charpos);
29803
29804 /* Set the help text and mouse pointer. If the mouse is on a part
29805 of the mode line without any text (e.g. past the right edge of
29806 the mode line text), use the default help text and pointer. */
29807 if (STRINGP (string) || area == ON_MODE_LINE)
29808 {
29809 /* Arrange to display the help by setting the global variables
29810 help_echo_string, help_echo_object, and help_echo_pos. */
29811 if (NILP (help))
29812 {
29813 if (STRINGP (string))
29814 help = Fget_text_property (pos, Qhelp_echo, string);
29815
29816 if (!NILP (help))
29817 {
29818 help_echo_string = help;
29819 XSETWINDOW (help_echo_window, w);
29820 help_echo_object = string;
29821 help_echo_pos = charpos;
29822 }
29823 else if (area == ON_MODE_LINE)
29824 {
29825 Lisp_Object default_help
29826 = buffer_local_value (Qmode_line_default_help_echo,
29827 w->contents);
29828
29829 if (STRINGP (default_help))
29830 {
29831 help_echo_string = default_help;
29832 XSETWINDOW (help_echo_window, w);
29833 help_echo_object = Qnil;
29834 help_echo_pos = -1;
29835 }
29836 }
29837 }
29838
29839 #ifdef HAVE_WINDOW_SYSTEM
29840 /* Change the mouse pointer according to what is under it. */
29841 if (FRAME_WINDOW_P (f))
29842 {
29843 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
29844 || minibuf_level
29845 || NILP (Vresize_mini_windows));
29846
29847 dpyinfo = FRAME_DISPLAY_INFO (f);
29848 if (STRINGP (string))
29849 {
29850 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29851
29852 if (NILP (pointer))
29853 pointer = Fget_text_property (pos, Qpointer, string);
29854
29855 /* Change the mouse pointer according to what is under X/Y. */
29856 if (NILP (pointer)
29857 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
29858 {
29859 Lisp_Object map;
29860 map = Fget_text_property (pos, Qlocal_map, string);
29861 if (!KEYMAPP (map))
29862 map = Fget_text_property (pos, Qkeymap, string);
29863 if (!KEYMAPP (map) && draggable)
29864 cursor = dpyinfo->vertical_scroll_bar_cursor;
29865 }
29866 }
29867 else if (draggable)
29868 /* Default mode-line pointer. */
29869 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29870 }
29871 #endif
29872 }
29873
29874 /* Change the mouse face according to what is under X/Y. */
29875 bool mouse_face_shown = false;
29876 if (STRINGP (string))
29877 {
29878 mouse_face = Fget_text_property (pos, Qmouse_face, string);
29879 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
29880 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29881 && glyph)
29882 {
29883 Lisp_Object b, e;
29884
29885 struct glyph * tmp_glyph;
29886
29887 int gpos;
29888 int gseq_length;
29889 int total_pixel_width;
29890 ptrdiff_t begpos, endpos, ignore;
29891
29892 int vpos, hpos;
29893
29894 b = Fprevious_single_property_change (make_number (charpos + 1),
29895 Qmouse_face, string, Qnil);
29896 if (NILP (b))
29897 begpos = 0;
29898 else
29899 begpos = XINT (b);
29900
29901 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
29902 if (NILP (e))
29903 endpos = SCHARS (string);
29904 else
29905 endpos = XINT (e);
29906
29907 /* Calculate the glyph position GPOS of GLYPH in the
29908 displayed string, relative to the beginning of the
29909 highlighted part of the string.
29910
29911 Note: GPOS is different from CHARPOS. CHARPOS is the
29912 position of GLYPH in the internal string object. A mode
29913 line string format has structures which are converted to
29914 a flattened string by the Emacs Lisp interpreter. The
29915 internal string is an element of those structures. The
29916 displayed string is the flattened string. */
29917 tmp_glyph = row_start_glyph;
29918 while (tmp_glyph < glyph
29919 && (!(EQ (tmp_glyph->object, glyph->object)
29920 && begpos <= tmp_glyph->charpos
29921 && tmp_glyph->charpos < endpos)))
29922 tmp_glyph++;
29923 gpos = glyph - tmp_glyph;
29924
29925 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29926 the highlighted part of the displayed string to which
29927 GLYPH belongs. Note: GSEQ_LENGTH is different from
29928 SCHARS (STRING), because the latter returns the length of
29929 the internal string. */
29930 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
29931 tmp_glyph > glyph
29932 && (!(EQ (tmp_glyph->object, glyph->object)
29933 && begpos <= tmp_glyph->charpos
29934 && tmp_glyph->charpos < endpos));
29935 tmp_glyph--)
29936 ;
29937 gseq_length = gpos + (tmp_glyph - glyph) + 1;
29938
29939 /* Calculate the total pixel width of all the glyphs between
29940 the beginning of the highlighted area and GLYPH. */
29941 total_pixel_width = 0;
29942 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
29943 total_pixel_width += tmp_glyph->pixel_width;
29944
29945 /* Pre calculation of re-rendering position. Note: X is in
29946 column units here, after the call to mode_line_string or
29947 marginal_area_string. */
29948 hpos = x - gpos;
29949 vpos = (area == ON_MODE_LINE
29950 ? (w->current_matrix)->nrows - 1
29951 : 0);
29952
29953 /* If GLYPH's position is included in the region that is
29954 already drawn in mouse face, we have nothing to do. */
29955 if ( EQ (window, hlinfo->mouse_face_window)
29956 && (!row->reversed_p
29957 ? (hlinfo->mouse_face_beg_col <= hpos
29958 && hpos < hlinfo->mouse_face_end_col)
29959 /* In R2L rows we swap BEG and END, see below. */
29960 : (hlinfo->mouse_face_end_col <= hpos
29961 && hpos < hlinfo->mouse_face_beg_col))
29962 && hlinfo->mouse_face_beg_row == vpos )
29963 return;
29964
29965 if (clear_mouse_face (hlinfo))
29966 cursor = No_Cursor;
29967
29968 if (!row->reversed_p)
29969 {
29970 hlinfo->mouse_face_beg_col = hpos;
29971 hlinfo->mouse_face_beg_x = original_x_pixel
29972 - (total_pixel_width + dx);
29973 hlinfo->mouse_face_end_col = hpos + gseq_length;
29974 hlinfo->mouse_face_end_x = 0;
29975 }
29976 else
29977 {
29978 /* In R2L rows, show_mouse_face expects BEG and END
29979 coordinates to be swapped. */
29980 hlinfo->mouse_face_end_col = hpos;
29981 hlinfo->mouse_face_end_x = original_x_pixel
29982 - (total_pixel_width + dx);
29983 hlinfo->mouse_face_beg_col = hpos + gseq_length;
29984 hlinfo->mouse_face_beg_x = 0;
29985 }
29986
29987 hlinfo->mouse_face_beg_row = vpos;
29988 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
29989 hlinfo->mouse_face_past_end = false;
29990 hlinfo->mouse_face_window = window;
29991
29992 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
29993 charpos,
29994 0, &ignore,
29995 glyph->face_id,
29996 true);
29997 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29998 mouse_face_shown = true;
29999
30000 if (NILP (pointer))
30001 pointer = Qhand;
30002 }
30003 }
30004
30005 /* If mouse-face doesn't need to be shown, clear any existing
30006 mouse-face. */
30007 if ((area == ON_MODE_LINE || area == ON_HEADER_LINE) && !mouse_face_shown)
30008 clear_mouse_face (hlinfo);
30009
30010 define_frame_cursor1 (f, cursor, pointer);
30011 }
30012
30013
30014 /* EXPORT:
30015 Take proper action when the mouse has moved to position X, Y on
30016 frame F with regards to highlighting portions of display that have
30017 mouse-face properties. Also de-highlight portions of display where
30018 the mouse was before, set the mouse pointer shape as appropriate
30019 for the mouse coordinates, and activate help echo (tooltips).
30020 X and Y can be negative or out of range. */
30021
30022 void
30023 note_mouse_highlight (struct frame *f, int x, int y)
30024 {
30025 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30026 enum window_part part = ON_NOTHING;
30027 Lisp_Object window;
30028 struct window *w;
30029 Cursor cursor = No_Cursor;
30030 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
30031 struct buffer *b;
30032
30033 /* When a menu is active, don't highlight because this looks odd. */
30034 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
30035 if (popup_activated ())
30036 return;
30037 #endif
30038
30039 if (!f->glyphs_initialized_p
30040 || f->pointer_invisible)
30041 return;
30042
30043 hlinfo->mouse_face_mouse_x = x;
30044 hlinfo->mouse_face_mouse_y = y;
30045 hlinfo->mouse_face_mouse_frame = f;
30046
30047 if (hlinfo->mouse_face_defer)
30048 return;
30049
30050 /* Which window is that in? */
30051 window = window_from_coordinates (f, x, y, &part, true);
30052
30053 /* If displaying active text in another window, clear that. */
30054 if (! EQ (window, hlinfo->mouse_face_window)
30055 /* Also clear if we move out of text area in same window. */
30056 || (!NILP (hlinfo->mouse_face_window)
30057 && !NILP (window)
30058 && part != ON_TEXT
30059 && part != ON_MODE_LINE
30060 && part != ON_HEADER_LINE))
30061 clear_mouse_face (hlinfo);
30062
30063 /* Not on a window -> return. */
30064 if (!WINDOWP (window))
30065 return;
30066
30067 /* Reset help_echo_string. It will get recomputed below. */
30068 help_echo_string = Qnil;
30069
30070 /* Convert to window-relative pixel coordinates. */
30071 w = XWINDOW (window);
30072 frame_to_window_pixel_xy (w, &x, &y);
30073
30074 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
30075 /* Handle tool-bar window differently since it doesn't display a
30076 buffer. */
30077 if (EQ (window, f->tool_bar_window))
30078 {
30079 note_tool_bar_highlight (f, x, y);
30080 return;
30081 }
30082 #endif
30083
30084 /* Mouse is on the mode, header line or margin? */
30085 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
30086 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
30087 {
30088 note_mode_line_or_margin_highlight (window, x, y, part);
30089
30090 #ifdef HAVE_WINDOW_SYSTEM
30091 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
30092 {
30093 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
30094 /* Show non-text cursor (Bug#16647). */
30095 goto set_cursor;
30096 }
30097 else
30098 #endif
30099 return;
30100 }
30101
30102 #ifdef HAVE_WINDOW_SYSTEM
30103 if (part == ON_VERTICAL_BORDER)
30104 {
30105 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
30106 help_echo_string = build_string ("drag-mouse-1: resize");
30107 }
30108 else if (part == ON_RIGHT_DIVIDER)
30109 {
30110 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
30111 help_echo_string = build_string ("drag-mouse-1: resize");
30112 }
30113 else if (part == ON_BOTTOM_DIVIDER)
30114 if (! WINDOW_BOTTOMMOST_P (w)
30115 || minibuf_level
30116 || NILP (Vresize_mini_windows))
30117 {
30118 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
30119 help_echo_string = build_string ("drag-mouse-1: resize");
30120 }
30121 else
30122 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
30123 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
30124 || part == ON_VERTICAL_SCROLL_BAR
30125 || part == ON_HORIZONTAL_SCROLL_BAR)
30126 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
30127 else
30128 cursor = FRAME_X_OUTPUT (f)->text_cursor;
30129 #endif
30130
30131 /* Are we in a window whose display is up to date?
30132 And verify the buffer's text has not changed. */
30133 b = XBUFFER (w->contents);
30134 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
30135 {
30136 int hpos, vpos, dx, dy, area = LAST_AREA;
30137 ptrdiff_t pos;
30138 struct glyph *glyph;
30139 Lisp_Object object;
30140 Lisp_Object mouse_face = Qnil, position;
30141 Lisp_Object *overlay_vec = NULL;
30142 ptrdiff_t i, noverlays;
30143 struct buffer *obuf;
30144 ptrdiff_t obegv, ozv;
30145 bool same_region;
30146
30147 /* Find the glyph under X/Y. */
30148 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
30149
30150 #ifdef HAVE_WINDOW_SYSTEM
30151 /* Look for :pointer property on image. */
30152 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
30153 {
30154 struct image *img = IMAGE_OPT_FROM_ID (f, glyph->u.img_id);
30155 if (img != NULL && IMAGEP (img->spec))
30156 {
30157 Lisp_Object image_map, hotspot;
30158 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
30159 !NILP (image_map))
30160 && (hotspot = find_hot_spot (image_map,
30161 glyph->slice.img.x + dx,
30162 glyph->slice.img.y + dy),
30163 CONSP (hotspot))
30164 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
30165 {
30166 Lisp_Object plist;
30167
30168 /* Could check XCAR (hotspot) to see if we enter/leave
30169 this hot-spot.
30170 If so, we could look for mouse-enter, mouse-leave
30171 properties in PLIST (and do something...). */
30172 hotspot = XCDR (hotspot);
30173 if (CONSP (hotspot)
30174 && (plist = XCAR (hotspot), CONSP (plist)))
30175 {
30176 pointer = Fplist_get (plist, Qpointer);
30177 if (NILP (pointer))
30178 pointer = Qhand;
30179 help_echo_string = Fplist_get (plist, Qhelp_echo);
30180 if (!NILP (help_echo_string))
30181 {
30182 help_echo_window = window;
30183 help_echo_object = glyph->object;
30184 help_echo_pos = glyph->charpos;
30185 }
30186 }
30187 }
30188 if (NILP (pointer))
30189 pointer = Fplist_get (XCDR (img->spec), QCpointer);
30190 }
30191 }
30192 #endif /* HAVE_WINDOW_SYSTEM */
30193
30194 /* Clear mouse face if X/Y not over text. */
30195 if (glyph == NULL
30196 || area != TEXT_AREA
30197 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
30198 /* Glyph's OBJECT is nil for glyphs inserted by the
30199 display engine for its internal purposes, like truncation
30200 and continuation glyphs and blanks beyond the end of
30201 line's text on text terminals. If we are over such a
30202 glyph, we are not over any text. */
30203 || NILP (glyph->object)
30204 /* R2L rows have a stretch glyph at their front, which
30205 stands for no text, whereas L2R rows have no glyphs at
30206 all beyond the end of text. Treat such stretch glyphs
30207 like we do with NULL glyphs in L2R rows. */
30208 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
30209 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
30210 && glyph->type == STRETCH_GLYPH
30211 && glyph->avoid_cursor_p))
30212 {
30213 if (clear_mouse_face (hlinfo))
30214 cursor = No_Cursor;
30215 if (FRAME_WINDOW_P (f) && NILP (pointer))
30216 {
30217 #ifdef HAVE_WINDOW_SYSTEM
30218 if (area != TEXT_AREA)
30219 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
30220 else
30221 pointer = Vvoid_text_area_pointer;
30222 #endif
30223 }
30224 goto set_cursor;
30225 }
30226
30227 pos = glyph->charpos;
30228 object = glyph->object;
30229 if (!STRINGP (object) && !BUFFERP (object))
30230 goto set_cursor;
30231
30232 /* If we get an out-of-range value, return now; avoid an error. */
30233 if (BUFFERP (object) && pos > BUF_Z (b))
30234 goto set_cursor;
30235
30236 /* Make the window's buffer temporarily current for
30237 overlays_at and compute_char_face. */
30238 obuf = current_buffer;
30239 current_buffer = b;
30240 obegv = BEGV;
30241 ozv = ZV;
30242 BEGV = BEG;
30243 ZV = Z;
30244
30245 /* Is this char mouse-active or does it have help-echo? */
30246 position = make_number (pos);
30247
30248 USE_SAFE_ALLOCA;
30249
30250 if (BUFFERP (object))
30251 {
30252 /* Put all the overlays we want in a vector in overlay_vec. */
30253 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, false);
30254 /* Sort overlays into increasing priority order. */
30255 noverlays = sort_overlays (overlay_vec, noverlays, w);
30256 }
30257 else
30258 noverlays = 0;
30259
30260 if (NILP (Vmouse_highlight))
30261 {
30262 clear_mouse_face (hlinfo);
30263 goto check_help_echo;
30264 }
30265
30266 same_region = coords_in_mouse_face_p (w, hpos, vpos);
30267
30268 if (same_region)
30269 cursor = No_Cursor;
30270
30271 /* Check mouse-face highlighting. */
30272 if (! same_region
30273 /* If there exists an overlay with mouse-face overlapping
30274 the one we are currently highlighting, we have to
30275 check if we enter the overlapping overlay, and then
30276 highlight only that. */
30277 || (OVERLAYP (hlinfo->mouse_face_overlay)
30278 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
30279 {
30280 /* Find the highest priority overlay with a mouse-face. */
30281 Lisp_Object overlay = Qnil;
30282 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
30283 {
30284 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
30285 if (!NILP (mouse_face))
30286 overlay = overlay_vec[i];
30287 }
30288
30289 /* If we're highlighting the same overlay as before, there's
30290 no need to do that again. */
30291 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
30292 goto check_help_echo;
30293 hlinfo->mouse_face_overlay = overlay;
30294
30295 /* Clear the display of the old active region, if any. */
30296 if (clear_mouse_face (hlinfo))
30297 cursor = No_Cursor;
30298
30299 /* If no overlay applies, get a text property. */
30300 if (NILP (overlay))
30301 mouse_face = Fget_text_property (position, Qmouse_face, object);
30302
30303 /* Next, compute the bounds of the mouse highlighting and
30304 display it. */
30305 if (!NILP (mouse_face) && STRINGP (object))
30306 {
30307 /* The mouse-highlighting comes from a display string
30308 with a mouse-face. */
30309 Lisp_Object s, e;
30310 ptrdiff_t ignore;
30311
30312 s = Fprevious_single_property_change
30313 (make_number (pos + 1), Qmouse_face, object, Qnil);
30314 e = Fnext_single_property_change
30315 (position, Qmouse_face, object, Qnil);
30316 if (NILP (s))
30317 s = make_number (0);
30318 if (NILP (e))
30319 e = make_number (SCHARS (object));
30320 mouse_face_from_string_pos (w, hlinfo, object,
30321 XINT (s), XINT (e));
30322 hlinfo->mouse_face_past_end = false;
30323 hlinfo->mouse_face_window = window;
30324 hlinfo->mouse_face_face_id
30325 = face_at_string_position (w, object, pos, 0, &ignore,
30326 glyph->face_id, true);
30327 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
30328 cursor = No_Cursor;
30329 }
30330 else
30331 {
30332 /* The mouse-highlighting, if any, comes from an overlay
30333 or text property in the buffer. */
30334 Lisp_Object buffer UNINIT;
30335 Lisp_Object disp_string UNINIT;
30336
30337 if (STRINGP (object))
30338 {
30339 /* If we are on a display string with no mouse-face,
30340 check if the text under it has one. */
30341 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
30342 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30343 pos = string_buffer_position (object, start);
30344 if (pos > 0)
30345 {
30346 mouse_face = get_char_property_and_overlay
30347 (make_number (pos), Qmouse_face, w->contents, &overlay);
30348 buffer = w->contents;
30349 disp_string = object;
30350 }
30351 }
30352 else
30353 {
30354 buffer = object;
30355 disp_string = Qnil;
30356 }
30357
30358 if (!NILP (mouse_face))
30359 {
30360 Lisp_Object before, after;
30361 Lisp_Object before_string, after_string;
30362 /* To correctly find the limits of mouse highlight
30363 in a bidi-reordered buffer, we must not use the
30364 optimization of limiting the search in
30365 previous-single-property-change and
30366 next-single-property-change, because
30367 rows_from_pos_range needs the real start and end
30368 positions to DTRT in this case. That's because
30369 the first row visible in a window does not
30370 necessarily display the character whose position
30371 is the smallest. */
30372 Lisp_Object lim1
30373 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
30374 ? Fmarker_position (w->start)
30375 : Qnil;
30376 Lisp_Object lim2
30377 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
30378 ? make_number (BUF_Z (XBUFFER (buffer))
30379 - w->window_end_pos)
30380 : Qnil;
30381
30382 if (NILP (overlay))
30383 {
30384 /* Handle the text property case. */
30385 before = Fprevious_single_property_change
30386 (make_number (pos + 1), Qmouse_face, buffer, lim1);
30387 after = Fnext_single_property_change
30388 (make_number (pos), Qmouse_face, buffer, lim2);
30389 before_string = after_string = Qnil;
30390 }
30391 else
30392 {
30393 /* Handle the overlay case. */
30394 before = Foverlay_start (overlay);
30395 after = Foverlay_end (overlay);
30396 before_string = Foverlay_get (overlay, Qbefore_string);
30397 after_string = Foverlay_get (overlay, Qafter_string);
30398
30399 if (!STRINGP (before_string)) before_string = Qnil;
30400 if (!STRINGP (after_string)) after_string = Qnil;
30401 }
30402
30403 mouse_face_from_buffer_pos (window, hlinfo, pos,
30404 NILP (before)
30405 ? 1
30406 : XFASTINT (before),
30407 NILP (after)
30408 ? BUF_Z (XBUFFER (buffer))
30409 : XFASTINT (after),
30410 before_string, after_string,
30411 disp_string);
30412 cursor = No_Cursor;
30413 }
30414 }
30415 }
30416
30417 check_help_echo:
30418
30419 /* Look for a `help-echo' property. */
30420 if (NILP (help_echo_string)) {
30421 Lisp_Object help, overlay;
30422
30423 /* Check overlays first. */
30424 help = overlay = Qnil;
30425 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
30426 {
30427 overlay = overlay_vec[i];
30428 help = Foverlay_get (overlay, Qhelp_echo);
30429 }
30430
30431 if (!NILP (help))
30432 {
30433 help_echo_string = help;
30434 help_echo_window = window;
30435 help_echo_object = overlay;
30436 help_echo_pos = pos;
30437 }
30438 else
30439 {
30440 Lisp_Object obj = glyph->object;
30441 ptrdiff_t charpos = glyph->charpos;
30442
30443 /* Try text properties. */
30444 if (STRINGP (obj)
30445 && charpos >= 0
30446 && charpos < SCHARS (obj))
30447 {
30448 help = Fget_text_property (make_number (charpos),
30449 Qhelp_echo, obj);
30450 if (NILP (help))
30451 {
30452 /* If the string itself doesn't specify a help-echo,
30453 see if the buffer text ``under'' it does. */
30454 struct glyph_row *r
30455 = MATRIX_ROW (w->current_matrix, vpos);
30456 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30457 ptrdiff_t p = string_buffer_position (obj, start);
30458 if (p > 0)
30459 {
30460 help = Fget_char_property (make_number (p),
30461 Qhelp_echo, w->contents);
30462 if (!NILP (help))
30463 {
30464 charpos = p;
30465 obj = w->contents;
30466 }
30467 }
30468 }
30469 }
30470 else if (BUFFERP (obj)
30471 && charpos >= BEGV
30472 && charpos < ZV)
30473 help = Fget_text_property (make_number (charpos), Qhelp_echo,
30474 obj);
30475
30476 if (!NILP (help))
30477 {
30478 help_echo_string = help;
30479 help_echo_window = window;
30480 help_echo_object = obj;
30481 help_echo_pos = charpos;
30482 }
30483 }
30484 }
30485
30486 #ifdef HAVE_WINDOW_SYSTEM
30487 /* Look for a `pointer' property. */
30488 if (FRAME_WINDOW_P (f) && NILP (pointer))
30489 {
30490 /* Check overlays first. */
30491 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
30492 pointer = Foverlay_get (overlay_vec[i], Qpointer);
30493
30494 if (NILP (pointer))
30495 {
30496 Lisp_Object obj = glyph->object;
30497 ptrdiff_t charpos = glyph->charpos;
30498
30499 /* Try text properties. */
30500 if (STRINGP (obj)
30501 && charpos >= 0
30502 && charpos < SCHARS (obj))
30503 {
30504 pointer = Fget_text_property (make_number (charpos),
30505 Qpointer, obj);
30506 if (NILP (pointer))
30507 {
30508 /* If the string itself doesn't specify a pointer,
30509 see if the buffer text ``under'' it does. */
30510 struct glyph_row *r
30511 = MATRIX_ROW (w->current_matrix, vpos);
30512 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
30513 ptrdiff_t p = string_buffer_position (obj, start);
30514 if (p > 0)
30515 pointer = Fget_char_property (make_number (p),
30516 Qpointer, w->contents);
30517 }
30518 }
30519 else if (BUFFERP (obj)
30520 && charpos >= BEGV
30521 && charpos < ZV)
30522 pointer = Fget_text_property (make_number (charpos),
30523 Qpointer, obj);
30524 }
30525 }
30526 #endif /* HAVE_WINDOW_SYSTEM */
30527
30528 BEGV = obegv;
30529 ZV = ozv;
30530 current_buffer = obuf;
30531 SAFE_FREE ();
30532 }
30533
30534 set_cursor:
30535 define_frame_cursor1 (f, cursor, pointer);
30536 }
30537
30538
30539 /* EXPORT for RIF:
30540 Clear any mouse-face on window W. This function is part of the
30541 redisplay interface, and is called from try_window_id and similar
30542 functions to ensure the mouse-highlight is off. */
30543
30544 void
30545 x_clear_window_mouse_face (struct window *w)
30546 {
30547 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
30548 Lisp_Object window;
30549
30550 block_input ();
30551 XSETWINDOW (window, w);
30552 if (EQ (window, hlinfo->mouse_face_window))
30553 clear_mouse_face (hlinfo);
30554 unblock_input ();
30555 }
30556
30557
30558 /* EXPORT:
30559 Just discard the mouse face information for frame F, if any.
30560 This is used when the size of F is changed. */
30561
30562 void
30563 cancel_mouse_face (struct frame *f)
30564 {
30565 Lisp_Object window;
30566 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30567
30568 window = hlinfo->mouse_face_window;
30569 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
30570 reset_mouse_highlight (hlinfo);
30571 }
30572
30573
30574 \f
30575 /***********************************************************************
30576 Exposure Events
30577 ***********************************************************************/
30578
30579 #ifdef HAVE_WINDOW_SYSTEM
30580
30581 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
30582 which intersects rectangle R. R is in window-relative coordinates. */
30583
30584 static void
30585 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
30586 enum glyph_row_area area)
30587 {
30588 struct glyph *first = row->glyphs[area];
30589 struct glyph *end = row->glyphs[area] + row->used[area];
30590 struct glyph *last;
30591 int first_x, start_x, x;
30592
30593 if (area == TEXT_AREA && row->fill_line_p)
30594 /* If row extends face to end of line write the whole line. */
30595 draw_glyphs (w, 0, row, area,
30596 0, row->used[area],
30597 DRAW_NORMAL_TEXT, 0);
30598 else
30599 {
30600 /* Set START_X to the window-relative start position for drawing glyphs of
30601 AREA. The first glyph of the text area can be partially visible.
30602 The first glyphs of other areas cannot. */
30603 start_x = window_box_left_offset (w, area);
30604 x = start_x;
30605 if (area == TEXT_AREA)
30606 x += row->x;
30607
30608 /* Find the first glyph that must be redrawn. */
30609 while (first < end
30610 && x + first->pixel_width < r->x)
30611 {
30612 x += first->pixel_width;
30613 ++first;
30614 }
30615
30616 /* Find the last one. */
30617 last = first;
30618 first_x = x;
30619 /* Use a signed int intermediate value to avoid catastrophic
30620 failures due to comparison between signed and unsigned, when
30621 x is negative (can happen for wide images that are hscrolled). */
30622 int r_end = r->x + r->width;
30623 while (last < end && x < r_end)
30624 {
30625 x += last->pixel_width;
30626 ++last;
30627 }
30628
30629 /* Repaint. */
30630 if (last > first)
30631 draw_glyphs (w, first_x - start_x, row, area,
30632 first - row->glyphs[area], last - row->glyphs[area],
30633 DRAW_NORMAL_TEXT, 0);
30634 }
30635 }
30636
30637
30638 /* Redraw the parts of the glyph row ROW on window W intersecting
30639 rectangle R. R is in window-relative coordinates. Value is
30640 true if mouse-face was overwritten. */
30641
30642 static bool
30643 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
30644 {
30645 eassert (row->enabled_p);
30646
30647 if (row->mode_line_p || w->pseudo_window_p)
30648 draw_glyphs (w, 0, row, TEXT_AREA,
30649 0, row->used[TEXT_AREA],
30650 DRAW_NORMAL_TEXT, 0);
30651 else
30652 {
30653 if (row->used[LEFT_MARGIN_AREA])
30654 expose_area (w, row, r, LEFT_MARGIN_AREA);
30655 if (row->used[TEXT_AREA])
30656 expose_area (w, row, r, TEXT_AREA);
30657 if (row->used[RIGHT_MARGIN_AREA])
30658 expose_area (w, row, r, RIGHT_MARGIN_AREA);
30659 draw_row_fringe_bitmaps (w, row);
30660 }
30661
30662 return row->mouse_face_p;
30663 }
30664
30665
30666 /* Redraw those parts of glyphs rows during expose event handling that
30667 overlap other rows. Redrawing of an exposed line writes over parts
30668 of lines overlapping that exposed line; this function fixes that.
30669
30670 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
30671 row in W's current matrix that is exposed and overlaps other rows.
30672 LAST_OVERLAPPING_ROW is the last such row. */
30673
30674 static void
30675 expose_overlaps (struct window *w,
30676 struct glyph_row *first_overlapping_row,
30677 struct glyph_row *last_overlapping_row,
30678 XRectangle *r)
30679 {
30680 struct glyph_row *row;
30681
30682 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
30683 if (row->overlapping_p)
30684 {
30685 eassert (row->enabled_p && !row->mode_line_p);
30686
30687 row->clip = r;
30688 if (row->used[LEFT_MARGIN_AREA])
30689 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
30690
30691 if (row->used[TEXT_AREA])
30692 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
30693
30694 if (row->used[RIGHT_MARGIN_AREA])
30695 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
30696 row->clip = NULL;
30697 }
30698 }
30699
30700
30701 /* Return true if W's cursor intersects rectangle R. */
30702
30703 static bool
30704 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
30705 {
30706 XRectangle cr, result;
30707 struct glyph *cursor_glyph;
30708 struct glyph_row *row;
30709
30710 if (w->phys_cursor.vpos >= 0
30711 && w->phys_cursor.vpos < w->current_matrix->nrows
30712 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
30713 row->enabled_p)
30714 && row->cursor_in_fringe_p)
30715 {
30716 /* Cursor is in the fringe. */
30717 cr.x = window_box_right_offset (w,
30718 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
30719 ? RIGHT_MARGIN_AREA
30720 : TEXT_AREA));
30721 cr.y = row->y;
30722 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
30723 cr.height = row->height;
30724 return x_intersect_rectangles (&cr, r, &result);
30725 }
30726
30727 cursor_glyph = get_phys_cursor_glyph (w);
30728 if (cursor_glyph)
30729 {
30730 /* r is relative to W's box, but w->phys_cursor.x is relative
30731 to left edge of W's TEXT area. Adjust it. */
30732 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
30733 cr.y = w->phys_cursor.y;
30734 cr.width = cursor_glyph->pixel_width;
30735 cr.height = w->phys_cursor_height;
30736 /* ++KFS: W32 version used W32-specific IntersectRect here, but
30737 I assume the effect is the same -- and this is portable. */
30738 return x_intersect_rectangles (&cr, r, &result);
30739 }
30740 /* If we don't understand the format, pretend we're not in the hot-spot. */
30741 return false;
30742 }
30743
30744
30745 /* EXPORT:
30746 Draw a vertical window border to the right of window W if W doesn't
30747 have vertical scroll bars. */
30748
30749 void
30750 x_draw_vertical_border (struct window *w)
30751 {
30752 struct frame *f = XFRAME (WINDOW_FRAME (w));
30753
30754 /* We could do better, if we knew what type of scroll-bar the adjacent
30755 windows (on either side) have... But we don't :-(
30756 However, I think this works ok. ++KFS 2003-04-25 */
30757
30758 /* Redraw borders between horizontally adjacent windows. Don't
30759 do it for frames with vertical scroll bars because either the
30760 right scroll bar of a window, or the left scroll bar of its
30761 neighbor will suffice as a border. */
30762 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
30763 return;
30764
30765 /* Note: It is necessary to redraw both the left and the right
30766 borders, for when only this single window W is being
30767 redisplayed. */
30768 if (!WINDOW_RIGHTMOST_P (w)
30769 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
30770 {
30771 int x0, x1, y0, y1;
30772
30773 window_box_edges (w, &x0, &y0, &x1, &y1);
30774 y1 -= 1;
30775
30776 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30777 x1 -= 1;
30778
30779 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
30780 }
30781
30782 if (!WINDOW_LEFTMOST_P (w)
30783 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
30784 {
30785 int x0, x1, y0, y1;
30786
30787 window_box_edges (w, &x0, &y0, &x1, &y1);
30788 y1 -= 1;
30789
30790 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30791 x0 -= 1;
30792
30793 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
30794 }
30795 }
30796
30797
30798 /* Draw window dividers for window W. */
30799
30800 void
30801 x_draw_right_divider (struct window *w)
30802 {
30803 struct frame *f = WINDOW_XFRAME (w);
30804
30805 if (w->mini || w->pseudo_window_p)
30806 return;
30807 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30808 {
30809 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
30810 int x1 = WINDOW_RIGHT_EDGE_X (w);
30811 int y0 = WINDOW_TOP_EDGE_Y (w);
30812 /* The bottom divider prevails. */
30813 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30814
30815 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30816 }
30817 }
30818
30819 static void
30820 x_draw_bottom_divider (struct window *w)
30821 {
30822 struct frame *f = XFRAME (WINDOW_FRAME (w));
30823
30824 if (w->mini || w->pseudo_window_p)
30825 return;
30826 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30827 {
30828 int x0 = WINDOW_LEFT_EDGE_X (w);
30829 int x1 = WINDOW_RIGHT_EDGE_X (w);
30830 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30831 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
30832
30833 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30834 }
30835 }
30836
30837 /* Redraw the part of window W intersection rectangle FR. Pixel
30838 coordinates in FR are frame-relative. Call this function with
30839 input blocked. Value is true if the exposure overwrites
30840 mouse-face. */
30841
30842 static bool
30843 expose_window (struct window *w, XRectangle *fr)
30844 {
30845 struct frame *f = XFRAME (w->frame);
30846 XRectangle wr, r;
30847 bool mouse_face_overwritten_p = false;
30848
30849 /* If window is not yet fully initialized, do nothing. This can
30850 happen when toolkit scroll bars are used and a window is split.
30851 Reconfiguring the scroll bar will generate an expose for a newly
30852 created window. */
30853 if (w->current_matrix == NULL)
30854 return false;
30855
30856 /* When we're currently updating the window, display and current
30857 matrix usually don't agree. Arrange for a thorough display
30858 later. */
30859 if (w->must_be_updated_p)
30860 {
30861 SET_FRAME_GARBAGED (f);
30862 return false;
30863 }
30864
30865 /* Frame-relative pixel rectangle of W. */
30866 wr.x = WINDOW_LEFT_EDGE_X (w);
30867 wr.y = WINDOW_TOP_EDGE_Y (w);
30868 wr.width = WINDOW_PIXEL_WIDTH (w);
30869 wr.height = WINDOW_PIXEL_HEIGHT (w);
30870
30871 if (x_intersect_rectangles (fr, &wr, &r))
30872 {
30873 int yb = window_text_bottom_y (w);
30874 struct glyph_row *row;
30875 struct glyph_row *first_overlapping_row, *last_overlapping_row;
30876
30877 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
30878 r.x, r.y, r.width, r.height));
30879
30880 /* Convert to window coordinates. */
30881 r.x -= WINDOW_LEFT_EDGE_X (w);
30882 r.y -= WINDOW_TOP_EDGE_Y (w);
30883
30884 /* Turn off the cursor. */
30885 bool cursor_cleared_p = (!w->pseudo_window_p
30886 && phys_cursor_in_rect_p (w, &r));
30887 if (cursor_cleared_p)
30888 x_clear_cursor (w);
30889
30890 /* If the row containing the cursor extends face to end of line,
30891 then expose_area might overwrite the cursor outside the
30892 rectangle and thus notice_overwritten_cursor might clear
30893 w->phys_cursor_on_p. We remember the original value and
30894 check later if it is changed. */
30895 bool phys_cursor_on_p = w->phys_cursor_on_p;
30896
30897 /* Use a signed int intermediate value to avoid catastrophic
30898 failures due to comparison between signed and unsigned, when
30899 y0 or y1 is negative (can happen for tall images). */
30900 int r_bottom = r.y + r.height;
30901
30902 /* Update lines intersecting rectangle R. */
30903 first_overlapping_row = last_overlapping_row = NULL;
30904 for (row = w->current_matrix->rows;
30905 row->enabled_p;
30906 ++row)
30907 {
30908 int y0 = row->y;
30909 int y1 = MATRIX_ROW_BOTTOM_Y (row);
30910
30911 if ((y0 >= r.y && y0 < r_bottom)
30912 || (y1 > r.y && y1 < r_bottom)
30913 || (r.y >= y0 && r.y < y1)
30914 || (r_bottom > y0 && r_bottom < y1))
30915 {
30916 /* A header line may be overlapping, but there is no need
30917 to fix overlapping areas for them. KFS 2005-02-12 */
30918 if (row->overlapping_p && !row->mode_line_p)
30919 {
30920 if (first_overlapping_row == NULL)
30921 first_overlapping_row = row;
30922 last_overlapping_row = row;
30923 }
30924
30925 row->clip = fr;
30926 if (expose_line (w, row, &r))
30927 mouse_face_overwritten_p = true;
30928 row->clip = NULL;
30929 }
30930 else if (row->overlapping_p)
30931 {
30932 /* We must redraw a row overlapping the exposed area. */
30933 if (y0 < r.y
30934 ? y0 + row->phys_height > r.y
30935 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
30936 {
30937 if (first_overlapping_row == NULL)
30938 first_overlapping_row = row;
30939 last_overlapping_row = row;
30940 }
30941 }
30942
30943 if (y1 >= yb)
30944 break;
30945 }
30946
30947 /* Display the mode line if there is one. */
30948 if (WINDOW_WANTS_MODELINE_P (w)
30949 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
30950 row->enabled_p)
30951 && row->y < r_bottom)
30952 {
30953 if (expose_line (w, row, &r))
30954 mouse_face_overwritten_p = true;
30955 }
30956
30957 if (!w->pseudo_window_p)
30958 {
30959 /* Fix the display of overlapping rows. */
30960 if (first_overlapping_row)
30961 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
30962 fr);
30963
30964 /* Draw border between windows. */
30965 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30966 x_draw_right_divider (w);
30967 else
30968 x_draw_vertical_border (w);
30969
30970 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30971 x_draw_bottom_divider (w);
30972
30973 /* Turn the cursor on again. */
30974 if (cursor_cleared_p
30975 || (phys_cursor_on_p && !w->phys_cursor_on_p))
30976 update_window_cursor (w, true);
30977 }
30978 }
30979
30980 return mouse_face_overwritten_p;
30981 }
30982
30983
30984
30985 /* Redraw (parts) of all windows in the window tree rooted at W that
30986 intersect R. R contains frame pixel coordinates. Value is
30987 true if the exposure overwrites mouse-face. */
30988
30989 static bool
30990 expose_window_tree (struct window *w, XRectangle *r)
30991 {
30992 struct frame *f = XFRAME (w->frame);
30993 bool mouse_face_overwritten_p = false;
30994
30995 while (w && !FRAME_GARBAGED_P (f))
30996 {
30997 mouse_face_overwritten_p
30998 |= (WINDOWP (w->contents)
30999 ? expose_window_tree (XWINDOW (w->contents), r)
31000 : expose_window (w, r));
31001
31002 w = NILP (w->next) ? NULL : XWINDOW (w->next);
31003 }
31004
31005 return mouse_face_overwritten_p;
31006 }
31007
31008
31009 /* EXPORT:
31010 Redisplay an exposed area of frame F. X and Y are the upper-left
31011 corner of the exposed rectangle. W and H are width and height of
31012 the exposed area. All are pixel values. W or H zero means redraw
31013 the entire frame. */
31014
31015 void
31016 expose_frame (struct frame *f, int x, int y, int w, int h)
31017 {
31018 XRectangle r;
31019 bool mouse_face_overwritten_p = false;
31020
31021 TRACE ((stderr, "expose_frame "));
31022
31023 /* No need to redraw if frame will be redrawn soon. */
31024 if (FRAME_GARBAGED_P (f))
31025 {
31026 TRACE ((stderr, " garbaged\n"));
31027 return;
31028 }
31029
31030 /* If basic faces haven't been realized yet, there is no point in
31031 trying to redraw anything. This can happen when we get an expose
31032 event while Emacs is starting, e.g. by moving another window. */
31033 if (FRAME_FACE_CACHE (f) == NULL
31034 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
31035 {
31036 TRACE ((stderr, " no faces\n"));
31037 return;
31038 }
31039
31040 if (w == 0 || h == 0)
31041 {
31042 r.x = r.y = 0;
31043 r.width = FRAME_TEXT_WIDTH (f);
31044 r.height = FRAME_TEXT_HEIGHT (f);
31045 }
31046 else
31047 {
31048 r.x = x;
31049 r.y = y;
31050 r.width = w;
31051 r.height = h;
31052 }
31053
31054 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
31055 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
31056
31057 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
31058 if (WINDOWP (f->tool_bar_window))
31059 mouse_face_overwritten_p
31060 |= expose_window (XWINDOW (f->tool_bar_window), &r);
31061 #endif
31062
31063 #ifdef HAVE_X_WINDOWS
31064 #ifndef MSDOS
31065 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
31066 if (WINDOWP (f->menu_bar_window))
31067 mouse_face_overwritten_p
31068 |= expose_window (XWINDOW (f->menu_bar_window), &r);
31069 #endif /* not USE_X_TOOLKIT and not USE_GTK */
31070 #endif
31071 #endif
31072
31073 /* Some window managers support a focus-follows-mouse style with
31074 delayed raising of frames. Imagine a partially obscured frame,
31075 and moving the mouse into partially obscured mouse-face on that
31076 frame. The visible part of the mouse-face will be highlighted,
31077 then the WM raises the obscured frame. With at least one WM, KDE
31078 2.1, Emacs is not getting any event for the raising of the frame
31079 (even tried with SubstructureRedirectMask), only Expose events.
31080 These expose events will draw text normally, i.e. not
31081 highlighted. Which means we must redo the highlight here.
31082 Subsume it under ``we love X''. --gerd 2001-08-15 */
31083 /* Included in Windows version because Windows most likely does not
31084 do the right thing if any third party tool offers
31085 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
31086 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
31087 {
31088 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
31089 if (f == hlinfo->mouse_face_mouse_frame)
31090 {
31091 int mouse_x = hlinfo->mouse_face_mouse_x;
31092 int mouse_y = hlinfo->mouse_face_mouse_y;
31093 clear_mouse_face (hlinfo);
31094 note_mouse_highlight (f, mouse_x, mouse_y);
31095 }
31096 }
31097 }
31098
31099
31100 /* EXPORT:
31101 Determine the intersection of two rectangles R1 and R2. Return
31102 the intersection in *RESULT. Value is true if RESULT is not
31103 empty. */
31104
31105 bool
31106 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
31107 {
31108 XRectangle *left, *right;
31109 XRectangle *upper, *lower;
31110 bool intersection_p = false;
31111
31112 /* Rearrange so that R1 is the left-most rectangle. */
31113 if (r1->x < r2->x)
31114 left = r1, right = r2;
31115 else
31116 left = r2, right = r1;
31117
31118 /* X0 of the intersection is right.x0, if this is inside R1,
31119 otherwise there is no intersection. */
31120 if (right->x <= left->x + left->width)
31121 {
31122 result->x = right->x;
31123
31124 /* The right end of the intersection is the minimum of
31125 the right ends of left and right. */
31126 result->width = (min (left->x + left->width, right->x + right->width)
31127 - result->x);
31128
31129 /* Same game for Y. */
31130 if (r1->y < r2->y)
31131 upper = r1, lower = r2;
31132 else
31133 upper = r2, lower = r1;
31134
31135 /* The upper end of the intersection is lower.y0, if this is inside
31136 of upper. Otherwise, there is no intersection. */
31137 if (lower->y <= upper->y + upper->height)
31138 {
31139 result->y = lower->y;
31140
31141 /* The lower end of the intersection is the minimum of the lower
31142 ends of upper and lower. */
31143 result->height = (min (lower->y + lower->height,
31144 upper->y + upper->height)
31145 - result->y);
31146 intersection_p = true;
31147 }
31148 }
31149
31150 return intersection_p;
31151 }
31152
31153 #endif /* HAVE_WINDOW_SYSTEM */
31154
31155 \f
31156 /***********************************************************************
31157 Initialization
31158 ***********************************************************************/
31159
31160 void
31161 syms_of_xdisp (void)
31162 {
31163 Vwith_echo_area_save_vector = Qnil;
31164 staticpro (&Vwith_echo_area_save_vector);
31165
31166 Vmessage_stack = Qnil;
31167 staticpro (&Vmessage_stack);
31168
31169 /* Non-nil means don't actually do any redisplay. */
31170 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
31171
31172 DEFSYM (Qredisplay_internal_xC_functionx, "redisplay_internal (C function)");
31173
31174 DEFVAR_BOOL("inhibit-message", inhibit_message,
31175 doc: /* Non-nil means calls to `message' are not displayed.
31176 They are still logged to the *Messages* buffer. */);
31177 inhibit_message = 0;
31178
31179 message_dolog_marker1 = Fmake_marker ();
31180 staticpro (&message_dolog_marker1);
31181 message_dolog_marker2 = Fmake_marker ();
31182 staticpro (&message_dolog_marker2);
31183 message_dolog_marker3 = Fmake_marker ();
31184 staticpro (&message_dolog_marker3);
31185
31186 #ifdef GLYPH_DEBUG
31187 defsubr (&Sdump_frame_glyph_matrix);
31188 defsubr (&Sdump_glyph_matrix);
31189 defsubr (&Sdump_glyph_row);
31190 defsubr (&Sdump_tool_bar_row);
31191 defsubr (&Strace_redisplay);
31192 defsubr (&Strace_to_stderr);
31193 #endif
31194 #ifdef HAVE_WINDOW_SYSTEM
31195 defsubr (&Stool_bar_height);
31196 defsubr (&Slookup_image_map);
31197 #endif
31198 defsubr (&Sline_pixel_height);
31199 defsubr (&Sformat_mode_line);
31200 defsubr (&Sinvisible_p);
31201 defsubr (&Scurrent_bidi_paragraph_direction);
31202 defsubr (&Swindow_text_pixel_size);
31203 defsubr (&Smove_point_visually);
31204 defsubr (&Sbidi_find_overridden_directionality);
31205
31206 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
31207 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
31208 DEFSYM (Qoverriding_local_map, "overriding-local-map");
31209 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
31210 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
31211 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
31212 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
31213 DEFSYM (Qeval, "eval");
31214 DEFSYM (QCdata, ":data");
31215
31216 /* Names of text properties relevant for redisplay. */
31217 DEFSYM (Qdisplay, "display");
31218 DEFSYM (Qspace_width, "space-width");
31219 DEFSYM (Qraise, "raise");
31220 DEFSYM (Qslice, "slice");
31221 DEFSYM (Qspace, "space");
31222 DEFSYM (Qmargin, "margin");
31223 DEFSYM (Qpointer, "pointer");
31224 DEFSYM (Qleft_margin, "left-margin");
31225 DEFSYM (Qright_margin, "right-margin");
31226 DEFSYM (Qcenter, "center");
31227 DEFSYM (Qline_height, "line-height");
31228 DEFSYM (QCalign_to, ":align-to");
31229 DEFSYM (QCrelative_width, ":relative-width");
31230 DEFSYM (QCrelative_height, ":relative-height");
31231 DEFSYM (QCeval, ":eval");
31232 DEFSYM (QCpropertize, ":propertize");
31233 DEFSYM (QCfile, ":file");
31234 DEFSYM (Qfontified, "fontified");
31235 DEFSYM (Qfontification_functions, "fontification-functions");
31236
31237 /* Name of the face used to highlight trailing whitespace. */
31238 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
31239
31240 /* Name and number of the face used to highlight escape glyphs. */
31241 DEFSYM (Qescape_glyph, "escape-glyph");
31242
31243 /* Name and number of the face used to highlight non-breaking
31244 spaces/hyphens. */
31245 DEFSYM (Qnobreak_space, "nobreak-space");
31246 DEFSYM (Qnobreak_hyphen, "nobreak-hyphen");
31247
31248 /* The symbol 'image' which is the car of the lists used to represent
31249 images in Lisp. Also a tool bar style. */
31250 DEFSYM (Qimage, "image");
31251
31252 /* Tool bar styles. */
31253 DEFSYM (Qtext, "text");
31254 DEFSYM (Qboth, "both");
31255 DEFSYM (Qboth_horiz, "both-horiz");
31256 DEFSYM (Qtext_image_horiz, "text-image-horiz");
31257
31258 /* The image map types. */
31259 DEFSYM (QCmap, ":map");
31260 DEFSYM (QCpointer, ":pointer");
31261 DEFSYM (Qrect, "rect");
31262 DEFSYM (Qcircle, "circle");
31263 DEFSYM (Qpoly, "poly");
31264
31265 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
31266
31267 DEFSYM (Qgrow_only, "grow-only");
31268 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
31269 DEFSYM (Qposition, "position");
31270 DEFSYM (Qbuffer_position, "buffer-position");
31271 DEFSYM (Qobject, "object");
31272
31273 /* Cursor shapes. */
31274 DEFSYM (Qbar, "bar");
31275 DEFSYM (Qhbar, "hbar");
31276 DEFSYM (Qbox, "box");
31277 DEFSYM (Qhollow, "hollow");
31278
31279 /* Pointer shapes. */
31280 DEFSYM (Qhand, "hand");
31281 DEFSYM (Qarrow, "arrow");
31282 /* also Qtext */
31283
31284 DEFSYM (Qdragging, "dragging");
31285
31286 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
31287
31288 list_of_error = list1 (list2 (Qerror, Qvoid_variable));
31289 staticpro (&list_of_error);
31290
31291 /* Values of those variables at last redisplay are stored as
31292 properties on 'overlay-arrow-position' symbol. However, if
31293 Voverlay_arrow_position is a marker, last-arrow-position is its
31294 numerical position. */
31295 DEFSYM (Qlast_arrow_position, "last-arrow-position");
31296 DEFSYM (Qlast_arrow_string, "last-arrow-string");
31297
31298 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
31299 properties on a symbol in overlay-arrow-variable-list. */
31300 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
31301 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
31302
31303 echo_buffer[0] = echo_buffer[1] = Qnil;
31304 staticpro (&echo_buffer[0]);
31305 staticpro (&echo_buffer[1]);
31306
31307 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
31308 staticpro (&echo_area_buffer[0]);
31309 staticpro (&echo_area_buffer[1]);
31310
31311 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
31312 staticpro (&Vmessages_buffer_name);
31313
31314 mode_line_proptrans_alist = Qnil;
31315 staticpro (&mode_line_proptrans_alist);
31316 mode_line_string_list = Qnil;
31317 staticpro (&mode_line_string_list);
31318 mode_line_string_face = Qnil;
31319 staticpro (&mode_line_string_face);
31320 mode_line_string_face_prop = Qnil;
31321 staticpro (&mode_line_string_face_prop);
31322 Vmode_line_unwind_vector = Qnil;
31323 staticpro (&Vmode_line_unwind_vector);
31324
31325 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
31326
31327 help_echo_string = Qnil;
31328 staticpro (&help_echo_string);
31329 help_echo_object = Qnil;
31330 staticpro (&help_echo_object);
31331 help_echo_window = Qnil;
31332 staticpro (&help_echo_window);
31333 previous_help_echo_string = Qnil;
31334 staticpro (&previous_help_echo_string);
31335 help_echo_pos = -1;
31336
31337 DEFSYM (Qright_to_left, "right-to-left");
31338 DEFSYM (Qleft_to_right, "left-to-right");
31339 defsubr (&Sbidi_resolved_levels);
31340
31341 #ifdef HAVE_WINDOW_SYSTEM
31342 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
31343 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
31344 For example, if a block cursor is over a tab, it will be drawn as
31345 wide as that tab on the display. */);
31346 x_stretch_cursor_p = 0;
31347 #endif
31348
31349 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
31350 doc: /* Non-nil means highlight trailing whitespace.
31351 The face used for trailing whitespace is `trailing-whitespace'. */);
31352 Vshow_trailing_whitespace = Qnil;
31353
31354 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
31355 doc: /* Control highlighting of non-ASCII space and hyphen chars.
31356 If the value is t, Emacs highlights non-ASCII chars which have the
31357 same appearance as an ASCII space or hyphen, using the `nobreak-space'
31358 or `nobreak-hyphen' face respectively.
31359
31360 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
31361 U+2011 (non-breaking hyphen) are affected.
31362
31363 Any other non-nil value means to display these characters as a escape
31364 glyph followed by an ordinary space or hyphen.
31365
31366 A value of nil means no special handling of these characters. */);
31367 Vnobreak_char_display = Qt;
31368
31369 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
31370 doc: /* The pointer shape to show in void text areas.
31371 A value of nil means to show the text pointer. Other options are
31372 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
31373 `hourglass'. */);
31374 Vvoid_text_area_pointer = Qarrow;
31375
31376 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
31377 doc: /* Non-nil means don't actually do any redisplay.
31378 This is used for internal purposes. */);
31379 Vinhibit_redisplay = Qnil;
31380
31381 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
31382 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
31383 Vglobal_mode_string = Qnil;
31384
31385 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
31386 doc: /* Marker for where to display an arrow on top of the buffer text.
31387 This must be the beginning of a line in order to work.
31388 See also `overlay-arrow-string'. */);
31389 Voverlay_arrow_position = Qnil;
31390
31391 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
31392 doc: /* String to display as an arrow in non-window frames.
31393 See also `overlay-arrow-position'. */);
31394 Voverlay_arrow_string = build_pure_c_string ("=>");
31395
31396 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
31397 doc: /* List of variables (symbols) which hold markers for overlay arrows.
31398 The symbols on this list are examined during redisplay to determine
31399 where to display overlay arrows. */);
31400 Voverlay_arrow_variable_list
31401 = list1 (intern_c_string ("overlay-arrow-position"));
31402
31403 DEFVAR_INT ("scroll-step", emacs_scroll_step,
31404 doc: /* The number of lines to try scrolling a window by when point moves out.
31405 If that fails to bring point back on frame, point is centered instead.
31406 If this is zero, point is always centered after it moves off frame.
31407 If you want scrolling to always be a line at a time, you should set
31408 `scroll-conservatively' to a large value rather than set this to 1. */);
31409
31410 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
31411 doc: /* Scroll up to this many lines, to bring point back on screen.
31412 If point moves off-screen, redisplay will scroll by up to
31413 `scroll-conservatively' lines in order to bring point just barely
31414 onto the screen again. If that cannot be done, then redisplay
31415 recenters point as usual.
31416
31417 If the value is greater than 100, redisplay will never recenter point,
31418 but will always scroll just enough text to bring point into view, even
31419 if you move far away.
31420
31421 A value of zero means always recenter point if it moves off screen. */);
31422 scroll_conservatively = 0;
31423
31424 DEFVAR_INT ("scroll-margin", scroll_margin,
31425 doc: /* Number of lines of margin at the top and bottom of a window.
31426 Recenter the window whenever point gets within this many lines
31427 of the top or bottom of the window. */);
31428 scroll_margin = 0;
31429
31430 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
31431 doc: /* Pixels per inch value for non-window system displays.
31432 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
31433 Vdisplay_pixels_per_inch = make_float (72.0);
31434
31435 #ifdef GLYPH_DEBUG
31436 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
31437 #endif
31438
31439 DEFVAR_LISP ("truncate-partial-width-windows",
31440 Vtruncate_partial_width_windows,
31441 doc: /* Non-nil means truncate lines in windows narrower than the frame.
31442 For an integer value, truncate lines in each window narrower than the
31443 full frame width, provided the total window width in column units is less
31444 than that integer; otherwise, respect the value of `truncate-lines'.
31445 The total width of the window is as returned by `window-total-width', it
31446 includes the fringes, the continuation and truncation glyphs, the
31447 display margins (if any), and the scroll bar
31448
31449 For any other non-nil value, truncate lines in all windows that do
31450 not span the full frame width.
31451
31452 A value of nil means to respect the value of `truncate-lines'.
31453
31454 If `word-wrap' is enabled, you might want to reduce this. */);
31455 Vtruncate_partial_width_windows = make_number (50);
31456
31457 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
31458 doc: /* Maximum buffer size for which line number should be displayed.
31459 If the buffer is bigger than this, the line number does not appear
31460 in the mode line. A value of nil means no limit. */);
31461 Vline_number_display_limit = Qnil;
31462
31463 DEFVAR_INT ("line-number-display-limit-width",
31464 line_number_display_limit_width,
31465 doc: /* Maximum line width (in characters) for line number display.
31466 If the average length of the lines near point is bigger than this, then the
31467 line number may be omitted from the mode line. */);
31468 line_number_display_limit_width = 200;
31469
31470 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
31471 doc: /* Non-nil means highlight region even in nonselected windows. */);
31472 highlight_nonselected_windows = false;
31473
31474 DEFVAR_BOOL ("multiple-frames", multiple_frames,
31475 doc: /* Non-nil if more than one frame is visible on this display.
31476 Minibuffer-only frames don't count, but iconified frames do.
31477 This variable is not guaranteed to be accurate except while processing
31478 `frame-title-format' and `icon-title-format'. */);
31479
31480 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
31481 doc: /* Template for displaying the title bar of visible frames.
31482 \(Assuming the window manager supports this feature.)
31483
31484 This variable has the same structure as `mode-line-format', except that
31485 the %c and %l constructs are ignored. It is used only on frames for
31486 which no explicit name has been set (see `modify-frame-parameters'). */);
31487
31488 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
31489 doc: /* Template for displaying the title bar of an iconified frame.
31490 \(Assuming the window manager supports this feature.)
31491 This variable has the same structure as `mode-line-format' (which see),
31492 and is used only on frames for which no explicit name has been set
31493 \(see `modify-frame-parameters'). */);
31494 Vicon_title_format
31495 = Vframe_title_format
31496 = listn (CONSTYPE_PURE, 3,
31497 intern_c_string ("multiple-frames"),
31498 build_pure_c_string ("%b"),
31499 listn (CONSTYPE_PURE, 4,
31500 empty_unibyte_string,
31501 intern_c_string ("invocation-name"),
31502 build_pure_c_string ("@"),
31503 intern_c_string ("system-name")));
31504
31505 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
31506 doc: /* Maximum number of lines to keep in the message log buffer.
31507 If nil, disable message logging. If t, log messages but don't truncate
31508 the buffer when it becomes large. */);
31509 Vmessage_log_max = make_number (1000);
31510
31511 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
31512 doc: /* List of functions to call before redisplaying a window with scrolling.
31513 Each function is called with two arguments, the window and its new
31514 display-start position.
31515 These functions are called whenever the `window-start' marker is modified,
31516 either to point into another buffer (e.g. via `set-window-buffer') or another
31517 place in the same buffer.
31518 Note that the value of `window-end' is not valid when these functions are
31519 called.
31520
31521 Warning: Do not use this feature to alter the way the window
31522 is scrolled. It is not designed for that, and such use probably won't
31523 work. */);
31524 Vwindow_scroll_functions = Qnil;
31525
31526 DEFVAR_LISP ("window-text-change-functions",
31527 Vwindow_text_change_functions,
31528 doc: /* Functions to call in redisplay when text in the window might change. */);
31529 Vwindow_text_change_functions = Qnil;
31530
31531 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
31532 doc: /* Functions called when redisplay of a window reaches the end trigger.
31533 Each function is called with two arguments, the window and the end trigger value.
31534 See `set-window-redisplay-end-trigger'. */);
31535 Vredisplay_end_trigger_functions = Qnil;
31536
31537 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
31538 doc: /* Non-nil means autoselect window with mouse pointer.
31539 If nil, do not autoselect windows.
31540 A positive number means delay autoselection by that many seconds: a
31541 window is autoselected only after the mouse has remained in that
31542 window for the duration of the delay.
31543 A negative number has a similar effect, but causes windows to be
31544 autoselected only after the mouse has stopped moving. (Because of
31545 the way Emacs compares mouse events, you will occasionally wait twice
31546 that time before the window gets selected.)
31547 Any other value means to autoselect window instantaneously when the
31548 mouse pointer enters it.
31549
31550 Autoselection selects the minibuffer only if it is active, and never
31551 unselects the minibuffer if it is active.
31552
31553 When customizing this variable make sure that the actual value of
31554 `focus-follows-mouse' matches the behavior of your window manager. */);
31555 Vmouse_autoselect_window = Qnil;
31556
31557 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
31558 doc: /* Non-nil means automatically resize tool-bars.
31559 This dynamically changes the tool-bar's height to the minimum height
31560 that is needed to make all tool-bar items visible.
31561 If value is `grow-only', the tool-bar's height is only increased
31562 automatically; to decrease the tool-bar height, use \\[recenter]. */);
31563 Vauto_resize_tool_bars = Qt;
31564
31565 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
31566 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
31567 auto_raise_tool_bar_buttons_p = true;
31568
31569 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
31570 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
31571 make_cursor_line_fully_visible_p = true;
31572
31573 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
31574 doc: /* Border below tool-bar in pixels.
31575 If an integer, use it as the height of the border.
31576 If it is one of `internal-border-width' or `border-width', use the
31577 value of the corresponding frame parameter.
31578 Otherwise, no border is added below the tool-bar. */);
31579 Vtool_bar_border = Qinternal_border_width;
31580
31581 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
31582 doc: /* Margin around tool-bar buttons in pixels.
31583 If an integer, use that for both horizontal and vertical margins.
31584 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
31585 HORZ specifying the horizontal margin, and VERT specifying the
31586 vertical margin. */);
31587 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
31588
31589 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
31590 doc: /* Relief thickness of tool-bar buttons. */);
31591 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
31592
31593 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
31594 doc: /* Tool bar style to use.
31595 It can be one of
31596 image - show images only
31597 text - show text only
31598 both - show both, text below image
31599 both-horiz - show text to the right of the image
31600 text-image-horiz - show text to the left of the image
31601 any other - use system default or image if no system default.
31602
31603 This variable only affects the GTK+ toolkit version of Emacs. */);
31604 Vtool_bar_style = Qnil;
31605
31606 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
31607 doc: /* Maximum number of characters a label can have to be shown.
31608 The tool bar style must also show labels for this to have any effect, see
31609 `tool-bar-style'. */);
31610 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
31611
31612 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
31613 doc: /* List of functions to call to fontify regions of text.
31614 Each function is called with one argument POS. Functions must
31615 fontify a region starting at POS in the current buffer, and give
31616 fontified regions the property `fontified'. */);
31617 Vfontification_functions = Qnil;
31618 Fmake_variable_buffer_local (Qfontification_functions);
31619
31620 DEFVAR_BOOL ("unibyte-display-via-language-environment",
31621 unibyte_display_via_language_environment,
31622 doc: /* Non-nil means display unibyte text according to language environment.
31623 Specifically, this means that raw bytes in the range 160-255 decimal
31624 are displayed by converting them to the equivalent multibyte characters
31625 according to the current language environment. As a result, they are
31626 displayed according to the current fontset.
31627
31628 Note that this variable affects only how these bytes are displayed,
31629 but does not change the fact they are interpreted as raw bytes. */);
31630 unibyte_display_via_language_environment = false;
31631
31632 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
31633 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
31634 If a float, it specifies a fraction of the mini-window frame's height.
31635 If an integer, it specifies a number of lines. */);
31636 Vmax_mini_window_height = make_float (0.25);
31637
31638 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
31639 doc: /* How to resize mini-windows (the minibuffer and the echo area).
31640 A value of nil means don't automatically resize mini-windows.
31641 A value of t means resize them to fit the text displayed in them.
31642 A value of `grow-only', the default, means let mini-windows grow only;
31643 they return to their normal size when the minibuffer is closed, or the
31644 echo area becomes empty. */);
31645 /* Contrary to the doc string, we initialize this to nil, so that
31646 loading loadup.el won't try to resize windows before loading
31647 window.el, where some functions we need to call for this live.
31648 We assign the 'grow-only' value right after loading window.el
31649 during loadup. */
31650 Vresize_mini_windows = Qnil;
31651
31652 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
31653 doc: /* Alist specifying how to blink the cursor off.
31654 Each element has the form (ON-STATE . OFF-STATE). Whenever the
31655 `cursor-type' frame-parameter or variable equals ON-STATE,
31656 comparing using `equal', Emacs uses OFF-STATE to specify
31657 how to blink it off. ON-STATE and OFF-STATE are values for
31658 the `cursor-type' frame parameter.
31659
31660 If a frame's ON-STATE has no entry in this list,
31661 the frame's other specifications determine how to blink the cursor off. */);
31662 Vblink_cursor_alist = Qnil;
31663
31664 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
31665 doc: /* Allow or disallow automatic horizontal scrolling of windows.
31666 If non-nil, windows are automatically scrolled horizontally to make
31667 point visible. */);
31668 automatic_hscrolling_p = true;
31669 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
31670
31671 DEFVAR_INT ("hscroll-margin", hscroll_margin,
31672 doc: /* How many columns away from the window edge point is allowed to get
31673 before automatic hscrolling will horizontally scroll the window. */);
31674 hscroll_margin = 5;
31675
31676 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
31677 doc: /* How many columns to scroll the window when point gets too close to the edge.
31678 When point is less than `hscroll-margin' columns from the window
31679 edge, automatic hscrolling will scroll the window by the amount of columns
31680 determined by this variable. If its value is a positive integer, scroll that
31681 many columns. If it's a positive floating-point number, it specifies the
31682 fraction of the window's width to scroll. If it's nil or zero, point will be
31683 centered horizontally after the scroll. Any other value, including negative
31684 numbers, are treated as if the value were zero.
31685
31686 Automatic hscrolling always moves point outside the scroll margin, so if
31687 point was more than scroll step columns inside the margin, the window will
31688 scroll more than the value given by the scroll step.
31689
31690 Note that the lower bound for automatic hscrolling specified by `scroll-left'
31691 and `scroll-right' overrides this variable's effect. */);
31692 Vhscroll_step = make_number (0);
31693
31694 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
31695 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
31696 Bind this around calls to `message' to let it take effect. */);
31697 message_truncate_lines = false;
31698
31699 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
31700 doc: /* Normal hook run to update the menu bar definitions.
31701 Redisplay runs this hook before it redisplays the menu bar.
31702 This is used to update menus such as Buffers, whose contents depend on
31703 various data. */);
31704 Vmenu_bar_update_hook = Qnil;
31705
31706 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
31707 doc: /* Frame for which we are updating a menu.
31708 The enable predicate for a menu binding should check this variable. */);
31709 Vmenu_updating_frame = Qnil;
31710
31711 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
31712 doc: /* Non-nil means don't update menu bars. Internal use only. */);
31713 inhibit_menubar_update = false;
31714
31715 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
31716 doc: /* Prefix prepended to all continuation lines at display time.
31717 The value may be a string, an image, or a stretch-glyph; it is
31718 interpreted in the same way as the value of a `display' text property.
31719
31720 This variable is overridden by any `wrap-prefix' text or overlay
31721 property.
31722
31723 To add a prefix to non-continuation lines, use `line-prefix'. */);
31724 Vwrap_prefix = Qnil;
31725 DEFSYM (Qwrap_prefix, "wrap-prefix");
31726 Fmake_variable_buffer_local (Qwrap_prefix);
31727
31728 DEFVAR_LISP ("line-prefix", Vline_prefix,
31729 doc: /* Prefix prepended to all non-continuation lines at display time.
31730 The value may be a string, an image, or a stretch-glyph; it is
31731 interpreted in the same way as the value of a `display' text property.
31732
31733 This variable is overridden by any `line-prefix' text or overlay
31734 property.
31735
31736 To add a prefix to continuation lines, use `wrap-prefix'. */);
31737 Vline_prefix = Qnil;
31738 DEFSYM (Qline_prefix, "line-prefix");
31739 Fmake_variable_buffer_local (Qline_prefix);
31740
31741 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
31742 doc: /* Non-nil means don't eval Lisp during redisplay. */);
31743 inhibit_eval_during_redisplay = false;
31744
31745 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
31746 doc: /* Non-nil means don't free realized faces. Internal use only. */);
31747 inhibit_free_realized_faces = false;
31748
31749 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring,
31750 doc: /* Non-nil means don't mirror characters even when bidi context requires that.
31751 Intended for use during debugging and for testing bidi display;
31752 see biditest.el in the test suite. */);
31753 inhibit_bidi_mirroring = false;
31754
31755 #ifdef GLYPH_DEBUG
31756 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
31757 doc: /* Inhibit try_window_id display optimization. */);
31758 inhibit_try_window_id = false;
31759
31760 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
31761 doc: /* Inhibit try_window_reusing display optimization. */);
31762 inhibit_try_window_reusing = false;
31763
31764 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
31765 doc: /* Inhibit try_cursor_movement display optimization. */);
31766 inhibit_try_cursor_movement = false;
31767 #endif /* GLYPH_DEBUG */
31768
31769 DEFVAR_INT ("overline-margin", overline_margin,
31770 doc: /* Space between overline and text, in pixels.
31771 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
31772 margin to the character height. */);
31773 overline_margin = 2;
31774
31775 DEFVAR_INT ("underline-minimum-offset",
31776 underline_minimum_offset,
31777 doc: /* Minimum distance between baseline and underline.
31778 This can improve legibility of underlined text at small font sizes,
31779 particularly when using variable `x-use-underline-position-properties'
31780 with fonts that specify an UNDERLINE_POSITION relatively close to the
31781 baseline. The default value is 1. */);
31782 underline_minimum_offset = 1;
31783
31784 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
31785 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
31786 This feature only works when on a window system that can change
31787 cursor shapes. */);
31788 display_hourglass_p = true;
31789
31790 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
31791 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31792 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
31793
31794 #ifdef HAVE_WINDOW_SYSTEM
31795 hourglass_atimer = NULL;
31796 hourglass_shown_p = false;
31797 #endif /* HAVE_WINDOW_SYSTEM */
31798
31799 /* Name of the face used to display glyphless characters. */
31800 DEFSYM (Qglyphless_char, "glyphless-char");
31801
31802 /* Method symbols for Vglyphless_char_display. */
31803 DEFSYM (Qhex_code, "hex-code");
31804 DEFSYM (Qempty_box, "empty-box");
31805 DEFSYM (Qthin_space, "thin-space");
31806 DEFSYM (Qzero_width, "zero-width");
31807
31808 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
31809 doc: /* Function run just before redisplay.
31810 It is called with one argument, which is the set of windows that are to
31811 be redisplayed. This set can be nil (meaning, only the selected window),
31812 or t (meaning all windows). */);
31813 Vpre_redisplay_function = intern ("ignore");
31814
31815 /* Symbol for the purpose of Vglyphless_char_display. */
31816 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
31817 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
31818
31819 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
31820 doc: /* Char-table defining glyphless characters.
31821 Each element, if non-nil, should be one of the following:
31822 an ASCII acronym string: display this string in a box
31823 `hex-code': display the hexadecimal code of a character in a box
31824 `empty-box': display as an empty box
31825 `thin-space': display as 1-pixel width space
31826 `zero-width': don't display
31827 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31828 display method for graphical terminals and text terminals respectively.
31829 GRAPHICAL and TEXT should each have one of the values listed above.
31830
31831 The char-table has one extra slot to control the display of a character for
31832 which no font is found. This slot only takes effect on graphical terminals.
31833 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31834 `thin-space'. The default is `empty-box'.
31835
31836 If a character has a non-nil entry in an active display table, the
31837 display table takes effect; in this case, Emacs does not consult
31838 `glyphless-char-display' at all. */);
31839 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
31840 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
31841 Qempty_box);
31842
31843 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
31844 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
31845 Vdebug_on_message = Qnil;
31846
31847 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
31848 doc: /* */);
31849 Vredisplay__all_windows_cause = Fmake_hash_table (0, NULL);
31850
31851 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
31852 doc: /* */);
31853 Vredisplay__mode_lines_cause = Fmake_hash_table (0, NULL);
31854
31855 DEFVAR_LISP ("redisplay--variables", Vredisplay__variables,
31856 doc: /* A hash-table of variables changing which triggers a thorough redisplay. */);
31857 Vredisplay__variables = Qnil;
31858
31859 DEFVAR_BOOL ("redisplay--inhibit-bidi", redisplay__inhibit_bidi,
31860 doc: /* Non-nil means it is not safe to attempt bidi reordering for display. */);
31861 /* Initialize to t, since we need to disable reordering until
31862 loadup.el successfully loads charprop.el. */
31863 redisplay__inhibit_bidi = true;
31864 }
31865
31866
31867 /* Initialize this module when Emacs starts. */
31868
31869 void
31870 init_xdisp (void)
31871 {
31872 CHARPOS (this_line_start_pos) = 0;
31873
31874 if (!noninteractive)
31875 {
31876 struct window *m = XWINDOW (minibuf_window);
31877 Lisp_Object frame = m->frame;
31878 struct frame *f = XFRAME (frame);
31879 Lisp_Object root = FRAME_ROOT_WINDOW (f);
31880 struct window *r = XWINDOW (root);
31881 int i;
31882
31883 echo_area_window = minibuf_window;
31884
31885 r->top_line = FRAME_TOP_MARGIN (f);
31886 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
31887 r->total_cols = FRAME_COLS (f);
31888 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
31889 r->total_lines = FRAME_TOTAL_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
31890 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
31891
31892 m->top_line = FRAME_TOTAL_LINES (f) - 1;
31893 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
31894 m->total_cols = FRAME_COLS (f);
31895 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
31896 m->total_lines = 1;
31897 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
31898
31899 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
31900 scratch_glyph_row.glyphs[TEXT_AREA + 1]
31901 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
31902
31903 /* The default ellipsis glyphs `...'. */
31904 for (i = 0; i < 3; ++i)
31905 default_invis_vector[i] = make_number ('.');
31906 }
31907
31908 {
31909 /* Allocate the buffer for frame titles.
31910 Also used for `format-mode-line'. */
31911 int size = 100;
31912 mode_line_noprop_buf = xmalloc (size);
31913 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
31914 mode_line_noprop_ptr = mode_line_noprop_buf;
31915 mode_line_target = MODE_LINE_DISPLAY;
31916 }
31917
31918 help_echo_showing_p = false;
31919 }
31920
31921 #ifdef HAVE_WINDOW_SYSTEM
31922
31923 /* Platform-independent portion of hourglass implementation. */
31924
31925 /* Timer function of hourglass_atimer. */
31926
31927 static void
31928 show_hourglass (struct atimer *timer)
31929 {
31930 /* The timer implementation will cancel this timer automatically
31931 after this function has run. Set hourglass_atimer to null
31932 so that we know the timer doesn't have to be canceled. */
31933 hourglass_atimer = NULL;
31934
31935 if (!hourglass_shown_p)
31936 {
31937 Lisp_Object tail, frame;
31938
31939 block_input ();
31940
31941 FOR_EACH_FRAME (tail, frame)
31942 {
31943 struct frame *f = XFRAME (frame);
31944
31945 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31946 && FRAME_RIF (f)->show_hourglass)
31947 FRAME_RIF (f)->show_hourglass (f);
31948 }
31949
31950 hourglass_shown_p = true;
31951 unblock_input ();
31952 }
31953 }
31954
31955 /* Cancel a currently active hourglass timer, and start a new one. */
31956
31957 void
31958 start_hourglass (void)
31959 {
31960 struct timespec delay;
31961
31962 cancel_hourglass ();
31963
31964 if (INTEGERP (Vhourglass_delay)
31965 && XINT (Vhourglass_delay) > 0)
31966 delay = make_timespec (min (XINT (Vhourglass_delay),
31967 TYPE_MAXIMUM (time_t)),
31968 0);
31969 else if (FLOATP (Vhourglass_delay)
31970 && XFLOAT_DATA (Vhourglass_delay) > 0)
31971 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
31972 else
31973 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
31974
31975 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
31976 show_hourglass, NULL);
31977 }
31978
31979 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31980 shown. */
31981
31982 void
31983 cancel_hourglass (void)
31984 {
31985 if (hourglass_atimer)
31986 {
31987 cancel_atimer (hourglass_atimer);
31988 hourglass_atimer = NULL;
31989 }
31990
31991 if (hourglass_shown_p)
31992 {
31993 Lisp_Object tail, frame;
31994
31995 block_input ();
31996
31997 FOR_EACH_FRAME (tail, frame)
31998 {
31999 struct frame *f = XFRAME (frame);
32000
32001 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
32002 && FRAME_RIF (f)->hide_hourglass)
32003 FRAME_RIF (f)->hide_hourglass (f);
32004 #ifdef HAVE_NTGUI
32005 /* No cursors on non GUI frames - restore to stock arrow cursor. */
32006 else if (!FRAME_W32_P (f))
32007 w32_arrow_cursor ();
32008 #endif
32009 }
32010
32011 hourglass_shown_p = false;
32012 unblock_input ();
32013 }
32014 }
32015
32016 #endif /* HAVE_WINDOW_SYSTEM */