]> code.delx.au - gnu-emacs/blob - src/xdisp.c
Merge from emacs-24; up to 2014-06-02T14:17:07Z!michael.albinus@gmx.de
[gnu-emacs] / src / xdisp.c
1 /* Display generation from window structure and buffer text.
2
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
4 Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
22
23 Redisplay.
24
25 Emacs separates the task of updating the display from code
26 modifying global state, e.g. buffer text. This way functions
27 operating on buffers don't also have to be concerned with updating
28 the display.
29
30 Updating the display is triggered by the Lisp interpreter when it
31 decides it's time to do it. This is done either automatically for
32 you as part of the interpreter's command loop or as the result of
33 calling Lisp functions like `sit-for'. The C function `redisplay'
34 in xdisp.c is the only entry into the inner redisplay code.
35
36 The following diagram shows how redisplay code is invoked. As you
37 can see, Lisp calls redisplay and vice versa. Under window systems
38 like X, some portions of the redisplay code are also called
39 asynchronously during mouse movement or expose events. It is very
40 important that these code parts do NOT use the C library (malloc,
41 free) because many C libraries under Unix are not reentrant. They
42 may also NOT call functions of the Lisp interpreter which could
43 change the interpreter's state. If you don't follow these rules,
44 you will encounter bugs which are very hard to explain.
45
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
49 ^ | |
50 +----------------------------------+ |
51 Don't use this path when called |
52 asynchronously! |
53 |
54 expose_window (asynchronous) |
55 |
56 X expose events -----+
57
58 What does redisplay do? Obviously, it has to figure out somehow what
59 has been changed since the last time the display has been updated,
60 and to make these changes visible. Preferably it would do that in
61 a moderately intelligent way, i.e. fast.
62
63 Changes in buffer text can be deduced from window and buffer
64 structures, and from some global variables like `beg_unchanged' and
65 `end_unchanged'. The contents of the display are additionally
66 recorded in a `glyph matrix', a two-dimensional matrix of glyph
67 structures. Each row in such a matrix corresponds to a line on the
68 display, and each glyph in a row corresponds to a column displaying
69 a character, an image, or what else. This matrix is called the
70 `current glyph matrix' or `current matrix' in redisplay
71 terminology.
72
73 For buffer parts that have been changed since the last update, a
74 second glyph matrix is constructed, the so called `desired glyph
75 matrix' or short `desired matrix'. Current and desired matrix are
76 then compared to find a cheap way to update the display, e.g. by
77 reusing part of the display by scrolling lines.
78
79 You will find a lot of redisplay optimizations when you start
80 looking at the innards of redisplay. The overall goal of all these
81 optimizations is to make redisplay fast because it is done
82 frequently. Some of these optimizations are implemented by the
83 following functions:
84
85 . try_cursor_movement
86
87 This function tries to update the display if the text in the
88 window did not change and did not scroll, only point moved, and
89 it did not move off the displayed portion of the text.
90
91 . try_window_reusing_current_matrix
92
93 This function reuses the current matrix of a window when text
94 has not changed, but the window start changed (e.g., due to
95 scrolling).
96
97 . try_window_id
98
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest.
102
103 . try_window
104
105 This function performs the full redisplay of a single window
106 assuming that its fonts were not changed and that the cursor
107 will not end up in the scroll margins. (Loading fonts requires
108 re-adjustment of dimensions of glyph matrices, which makes this
109 method impossible to use.)
110
111 These optimizations are tried in sequence (some can be skipped if
112 it is known that they are not applicable). If none of the
113 optimizations were successful, redisplay calls redisplay_windows,
114 which performs a full redisplay of all windows.
115
116 Desired matrices.
117
118 Desired matrices are always built per Emacs window. The function
119 `display_line' is the central function to look at if you are
120 interested. It constructs one row in a desired matrix given an
121 iterator structure containing both a buffer position and a
122 description of the environment in which the text is to be
123 displayed. But this is too early, read on.
124
125 Characters and pixmaps displayed for a range of buffer text depend
126 on various settings of buffers and windows, on overlays and text
127 properties, on display tables, on selective display. The good news
128 is that all this hairy stuff is hidden behind a small set of
129 interface functions taking an iterator structure (struct it)
130 argument.
131
132 Iteration over things to be displayed is then simple. It is
133 started by initializing an iterator with a call to init_iterator,
134 passing it the buffer position where to start iteration. For
135 iteration over strings, pass -1 as the position to init_iterator,
136 and call reseat_to_string when the string is ready, to initialize
137 the iterator for that string. Thereafter, calls to
138 get_next_display_element fill the iterator structure with relevant
139 information about the next thing to display. Calls to
140 set_iterator_to_next move the iterator to the next thing.
141
142 Besides this, an iterator also contains information about the
143 display environment in which glyphs for display elements are to be
144 produced. It has fields for the width and height of the display,
145 the information whether long lines are truncated or continued, a
146 current X and Y position, and lots of other stuff you can better
147 see in dispextern.h.
148
149 Glyphs in a desired matrix are normally constructed in a loop
150 calling get_next_display_element and then PRODUCE_GLYPHS. The call
151 to PRODUCE_GLYPHS will fill the iterator structure with pixel
152 information about the element being displayed and at the same time
153 produce glyphs for it. If the display element fits on the line
154 being displayed, set_iterator_to_next is called next, otherwise the
155 glyphs produced are discarded. The function display_line is the
156 workhorse of filling glyph rows in the desired matrix with glyphs.
157 In addition to producing glyphs, it also handles line truncation
158 and continuation, word wrap, and cursor positioning (for the
159 latter, see also set_cursor_from_row).
160
161 Frame matrices.
162
163 That just couldn't be all, could it? What about terminal types not
164 supporting operations on sub-windows of the screen? To update the
165 display on such a terminal, window-based glyph matrices are not
166 well suited. To be able to reuse part of the display (scrolling
167 lines up and down), we must instead have a view of the whole
168 screen. This is what `frame matrices' are for. They are a trick.
169
170 Frames on terminals like above have a glyph pool. Windows on such
171 a frame sub-allocate their glyph memory from their frame's glyph
172 pool. The frame itself is given its own glyph matrices. By
173 coincidence---or maybe something else---rows in window glyph
174 matrices are slices of corresponding rows in frame matrices. Thus
175 writing to window matrices implicitly updates a frame matrix which
176 provides us with the view of the whole screen that we originally
177 wanted to have without having to move many bytes around. To be
178 honest, there is a little bit more done, but not much more. If you
179 plan to extend that code, take a look at dispnew.c. The function
180 build_frame_matrix is a good starting point.
181
182 Bidirectional display.
183
184 Bidirectional display adds quite some hair to this already complex
185 design. The good news are that a large portion of that hairy stuff
186 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
187 reordering engine which is called by set_iterator_to_next and
188 returns the next character to display in the visual order. See
189 commentary on bidi.c for more details. As far as redisplay is
190 concerned, the effect of calling bidi_move_to_visually_next, the
191 main interface of the reordering engine, is that the iterator gets
192 magically placed on the buffer or string position that is to be
193 displayed next. In other words, a linear iteration through the
194 buffer/string is replaced with a non-linear one. All the rest of
195 the redisplay is oblivious to the bidi reordering.
196
197 Well, almost oblivious---there are still complications, most of
198 them due to the fact that buffer and string positions no longer
199 change monotonously with glyph indices in a glyph row. Moreover,
200 for continued lines, the buffer positions may not even be
201 monotonously changing with vertical positions. Also, accounting
202 for face changes, overlays, etc. becomes more complex because
203 non-linear iteration could potentially skip many positions with
204 changes, and then cross them again on the way back...
205
206 One other prominent effect of bidirectional display is that some
207 paragraphs of text need to be displayed starting at the right
208 margin of the window---the so-called right-to-left, or R2L
209 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
210 which have their reversed_p flag set. The bidi reordering engine
211 produces characters in such rows starting from the character which
212 should be the rightmost on display. PRODUCE_GLYPHS then reverses
213 the order, when it fills up the glyph row whose reversed_p flag is
214 set, by prepending each new glyph to what is already there, instead
215 of appending it. When the glyph row is complete, the function
216 extend_face_to_end_of_line fills the empty space to the left of the
217 leftmost character with special glyphs, which will display as,
218 well, empty. On text terminals, these special glyphs are simply
219 blank characters. On graphics terminals, there's a single stretch
220 glyph of a suitably computed width. Both the blanks and the
221 stretch glyph are given the face of the background of the line.
222 This way, the terminal-specific back-end can still draw the glyphs
223 left to right, even for R2L lines.
224
225 Bidirectional display and character compositions
226
227 Some scripts cannot be displayed by drawing each character
228 individually, because adjacent characters change each other's shape
229 on display. For example, Arabic and Indic scripts belong to this
230 category.
231
232 Emacs display supports this by providing "character compositions",
233 most of which is implemented in composite.c. During the buffer
234 scan that delivers characters to PRODUCE_GLYPHS, if the next
235 character to be delivered is a composed character, the iteration
236 calls composition_reseat_it and next_element_from_composition. If
237 they succeed to compose the character with one or more of the
238 following characters, the whole sequence of characters that where
239 composed is recorded in the `struct composition_it' object that is
240 part of the buffer iterator. The composed sequence could produce
241 one or more font glyphs (called "grapheme clusters") on the screen.
242 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
243 in the direction corresponding to the current bidi scan direction
244 (recorded in the scan_dir member of the `struct bidi_it' object
245 that is part of the buffer iterator). In particular, if the bidi
246 iterator currently scans the buffer backwards, the grapheme
247 clusters are delivered back to front. This reorders the grapheme
248 clusters as appropriate for the current bidi context. Note that
249 this means that the grapheme clusters are always stored in the
250 LGSTRING object (see composite.c) in the logical order.
251
252 Moving an iterator in bidirectional text
253 without producing glyphs
254
255 Note one important detail mentioned above: that the bidi reordering
256 engine, driven by the iterator, produces characters in R2L rows
257 starting at the character that will be the rightmost on display.
258 As far as the iterator is concerned, the geometry of such rows is
259 still left to right, i.e. the iterator "thinks" the first character
260 is at the leftmost pixel position. The iterator does not know that
261 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
262 delivers. This is important when functions from the move_it_*
263 family are used to get to certain screen position or to match
264 screen coordinates with buffer coordinates: these functions use the
265 iterator geometry, which is left to right even in R2L paragraphs.
266 This works well with most callers of move_it_*, because they need
267 to get to a specific column, and columns are still numbered in the
268 reading order, i.e. the rightmost character in a R2L paragraph is
269 still column zero. But some callers do not get well with this; a
270 notable example is mouse clicks that need to find the character
271 that corresponds to certain pixel coordinates. See
272 buffer_posn_from_coords in dispnew.c for how this is handled. */
273
274 #include <config.h>
275 #include <stdio.h>
276 #include <limits.h>
277
278 #include "lisp.h"
279 #include "atimer.h"
280 #include "keyboard.h"
281 #include "frame.h"
282 #include "window.h"
283 #include "termchar.h"
284 #include "dispextern.h"
285 #include "character.h"
286 #include "buffer.h"
287 #include "charset.h"
288 #include "indent.h"
289 #include "commands.h"
290 #include "keymap.h"
291 #include "macros.h"
292 #include "disptab.h"
293 #include "termhooks.h"
294 #include "termopts.h"
295 #include "intervals.h"
296 #include "coding.h"
297 #include "process.h"
298 #include "region-cache.h"
299 #include "font.h"
300 #include "fontset.h"
301 #include "blockinput.h"
302 #ifdef HAVE_WINDOW_SYSTEM
303 #include TERM_HEADER
304 #endif /* HAVE_WINDOW_SYSTEM */
305
306 #ifndef FRAME_X_OUTPUT
307 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
308 #endif
309
310 #define INFINITY 10000000
311
312 Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
313 Lisp_Object Qwindow_scroll_functions;
314 static Lisp_Object Qwindow_text_change_functions;
315 static Lisp_Object Qredisplay_end_trigger_functions;
316 Lisp_Object Qinhibit_point_motion_hooks;
317 static Lisp_Object QCeval, QCpropertize;
318 Lisp_Object QCfile, QCdata;
319 static Lisp_Object Qfontified;
320 static Lisp_Object Qgrow_only;
321 static Lisp_Object Qinhibit_eval_during_redisplay;
322 static Lisp_Object Qbuffer_position, Qposition, Qobject;
323 static Lisp_Object Qright_to_left, Qleft_to_right;
324
325 /* Cursor shapes. */
326 Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
327
328 /* Pointer shapes. */
329 static Lisp_Object Qarrow, Qhand;
330 Lisp_Object Qtext;
331
332 /* Holds the list (error). */
333 static Lisp_Object list_of_error;
334
335 static Lisp_Object Qfontification_functions;
336
337 static Lisp_Object Qwrap_prefix;
338 static Lisp_Object Qline_prefix;
339 static Lisp_Object Qredisplay_internal;
340
341 /* Non-nil means don't actually do any redisplay. */
342
343 Lisp_Object Qinhibit_redisplay;
344
345 /* Names of text properties relevant for redisplay. */
346
347 Lisp_Object Qdisplay;
348
349 Lisp_Object Qspace, QCalign_to;
350 static Lisp_Object QCrelative_width, QCrelative_height;
351 Lisp_Object Qleft_margin, Qright_margin;
352 static Lisp_Object Qspace_width, Qraise;
353 static Lisp_Object Qslice;
354 Lisp_Object Qcenter;
355 static Lisp_Object Qmargin, Qpointer;
356 static Lisp_Object Qline_height;
357
358 #ifdef HAVE_WINDOW_SYSTEM
359
360 /* Test if overflow newline into fringe. Called with iterator IT
361 at or past right window margin, and with IT->current_x set. */
362
363 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
364 (!NILP (Voverflow_newline_into_fringe) \
365 && FRAME_WINDOW_P ((IT)->f) \
366 && ((IT)->bidi_it.paragraph_dir == R2L \
367 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
368 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
369 && (IT)->current_x == (IT)->last_visible_x)
370
371 #else /* !HAVE_WINDOW_SYSTEM */
372 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
373 #endif /* HAVE_WINDOW_SYSTEM */
374
375 /* Test if the display element loaded in IT, or the underlying buffer
376 or string character, is a space or a TAB character. This is used
377 to determine where word wrapping can occur. */
378
379 #define IT_DISPLAYING_WHITESPACE(it) \
380 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
381 || ((STRINGP (it->string) \
382 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
383 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
384 || (it->s \
385 && (it->s[IT_BYTEPOS (*it)] == ' ' \
386 || it->s[IT_BYTEPOS (*it)] == '\t')) \
387 || (IT_BYTEPOS (*it) < ZV_BYTE \
388 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
389 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
390
391 /* Name of the face used to highlight trailing whitespace. */
392
393 static Lisp_Object Qtrailing_whitespace;
394
395 /* Name and number of the face used to highlight escape glyphs. */
396
397 static Lisp_Object Qescape_glyph;
398
399 /* Name and number of the face used to highlight non-breaking spaces. */
400
401 static Lisp_Object Qnobreak_space;
402
403 /* The symbol `image' which is the car of the lists used to represent
404 images in Lisp. Also a tool bar style. */
405
406 Lisp_Object Qimage;
407
408 /* The image map types. */
409 Lisp_Object QCmap;
410 static Lisp_Object QCpointer;
411 static Lisp_Object Qrect, Qcircle, Qpoly;
412
413 /* Tool bar styles */
414 Lisp_Object Qboth, Qboth_horiz, Qtext_image_horiz;
415
416 /* Non-zero means print newline to stdout before next mini-buffer
417 message. */
418
419 bool noninteractive_need_newline;
420
421 /* Non-zero means print newline to message log before next message. */
422
423 static bool message_log_need_newline;
424
425 /* Three markers that message_dolog uses.
426 It could allocate them itself, but that causes trouble
427 in handling memory-full errors. */
428 static Lisp_Object message_dolog_marker1;
429 static Lisp_Object message_dolog_marker2;
430 static Lisp_Object message_dolog_marker3;
431 \f
432 /* The buffer position of the first character appearing entirely or
433 partially on the line of the selected window which contains the
434 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
435 redisplay optimization in redisplay_internal. */
436
437 static struct text_pos this_line_start_pos;
438
439 /* Number of characters past the end of the line above, including the
440 terminating newline. */
441
442 static struct text_pos this_line_end_pos;
443
444 /* The vertical positions and the height of this line. */
445
446 static int this_line_vpos;
447 static int this_line_y;
448 static int this_line_pixel_height;
449
450 /* X position at which this display line starts. Usually zero;
451 negative if first character is partially visible. */
452
453 static int this_line_start_x;
454
455 /* The smallest character position seen by move_it_* functions as they
456 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
457 hscrolled lines, see display_line. */
458
459 static struct text_pos this_line_min_pos;
460
461 /* Buffer that this_line_.* variables are referring to. */
462
463 static struct buffer *this_line_buffer;
464
465
466 /* Values of those variables at last redisplay are stored as
467 properties on `overlay-arrow-position' symbol. However, if
468 Voverlay_arrow_position is a marker, last-arrow-position is its
469 numerical position. */
470
471 static Lisp_Object Qlast_arrow_position, Qlast_arrow_string;
472
473 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
474 properties on a symbol in overlay-arrow-variable-list. */
475
476 static Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
477
478 Lisp_Object Qmenu_bar_update_hook;
479
480 /* Nonzero if an overlay arrow has been displayed in this window. */
481
482 static bool overlay_arrow_seen;
483
484 /* Vector containing glyphs for an ellipsis `...'. */
485
486 static Lisp_Object default_invis_vector[3];
487
488 /* This is the window where the echo area message was displayed. It
489 is always a mini-buffer window, but it may not be the same window
490 currently active as a mini-buffer. */
491
492 Lisp_Object echo_area_window;
493
494 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
495 pushes the current message and the value of
496 message_enable_multibyte on the stack, the function restore_message
497 pops the stack and displays MESSAGE again. */
498
499 static Lisp_Object Vmessage_stack;
500
501 /* Nonzero means multibyte characters were enabled when the echo area
502 message was specified. */
503
504 static bool message_enable_multibyte;
505
506 /* Nonzero if we should redraw the mode lines on the next redisplay.
507 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
508 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
509 (the number used is then only used to track down the cause for this
510 full-redisplay). */
511
512 int update_mode_lines;
513
514 /* Nonzero if window sizes or contents other than selected-window have changed
515 since last redisplay that finished.
516 If it has value REDISPLAY_SOME, then only redisplay the windows where
517 the `redisplay' bit has been set. Otherwise, redisplay all windows
518 (the number used is then only used to track down the cause for this
519 full-redisplay). */
520
521 int windows_or_buffers_changed;
522
523 /* Nonzero after display_mode_line if %l was used and it displayed a
524 line number. */
525
526 static bool line_number_displayed;
527
528 /* The name of the *Messages* buffer, a string. */
529
530 static Lisp_Object Vmessages_buffer_name;
531
532 /* Current, index 0, and last displayed echo area message. Either
533 buffers from echo_buffers, or nil to indicate no message. */
534
535 Lisp_Object echo_area_buffer[2];
536
537 /* The buffers referenced from echo_area_buffer. */
538
539 static Lisp_Object echo_buffer[2];
540
541 /* A vector saved used in with_area_buffer to reduce consing. */
542
543 static Lisp_Object Vwith_echo_area_save_vector;
544
545 /* Non-zero means display_echo_area should display the last echo area
546 message again. Set by redisplay_preserve_echo_area. */
547
548 static bool display_last_displayed_message_p;
549
550 /* Nonzero if echo area is being used by print; zero if being used by
551 message. */
552
553 static bool message_buf_print;
554
555 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
556
557 static Lisp_Object Qinhibit_menubar_update;
558 static Lisp_Object Qmessage_truncate_lines;
559
560 /* Set to 1 in clear_message to make redisplay_internal aware
561 of an emptied echo area. */
562
563 static bool message_cleared_p;
564
565 /* A scratch glyph row with contents used for generating truncation
566 glyphs. Also used in direct_output_for_insert. */
567
568 #define MAX_SCRATCH_GLYPHS 100
569 static struct glyph_row scratch_glyph_row;
570 static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
571
572 /* Ascent and height of the last line processed by move_it_to. */
573
574 static int last_height;
575
576 /* Non-zero if there's a help-echo in the echo area. */
577
578 bool help_echo_showing_p;
579
580 /* The maximum distance to look ahead for text properties. Values
581 that are too small let us call compute_char_face and similar
582 functions too often which is expensive. Values that are too large
583 let us call compute_char_face and alike too often because we
584 might not be interested in text properties that far away. */
585
586 #define TEXT_PROP_DISTANCE_LIMIT 100
587
588 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
589 iterator state and later restore it. This is needed because the
590 bidi iterator on bidi.c keeps a stacked cache of its states, which
591 is really a singleton. When we use scratch iterator objects to
592 move around the buffer, we can cause the bidi cache to be pushed or
593 popped, and therefore we need to restore the cache state when we
594 return to the original iterator. */
595 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
596 do { \
597 if (CACHE) \
598 bidi_unshelve_cache (CACHE, 1); \
599 ITCOPY = ITORIG; \
600 CACHE = bidi_shelve_cache (); \
601 } while (0)
602
603 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
604 do { \
605 if (pITORIG != pITCOPY) \
606 *(pITORIG) = *(pITCOPY); \
607 bidi_unshelve_cache (CACHE, 0); \
608 CACHE = NULL; \
609 } while (0)
610
611 /* Functions to mark elements as needing redisplay. */
612 enum { REDISPLAY_SOME = 2}; /* Arbitrary choice. */
613
614 void
615 redisplay_other_windows (void)
616 {
617 if (!windows_or_buffers_changed)
618 windows_or_buffers_changed = REDISPLAY_SOME;
619 }
620
621 void
622 wset_redisplay (struct window *w)
623 {
624 /* Beware: selected_window can be nil during early stages. */
625 if (!EQ (make_lisp_ptr (w, Lisp_Vectorlike), selected_window))
626 redisplay_other_windows ();
627 w->redisplay = true;
628 }
629
630 void
631 fset_redisplay (struct frame *f)
632 {
633 redisplay_other_windows ();
634 f->redisplay = true;
635 }
636
637 void
638 bset_redisplay (struct buffer *b)
639 {
640 int count = buffer_window_count (b);
641 if (count > 0)
642 {
643 /* ... it's visible in other window than selected, */
644 if (count > 1 || b != XBUFFER (XWINDOW (selected_window)->contents))
645 redisplay_other_windows ();
646 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
647 so that if we later set windows_or_buffers_changed, this buffer will
648 not be omitted. */
649 b->text->redisplay = true;
650 }
651 }
652
653 void
654 bset_update_mode_line (struct buffer *b)
655 {
656 if (!update_mode_lines)
657 update_mode_lines = REDISPLAY_SOME;
658 b->text->redisplay = true;
659 }
660
661 #ifdef GLYPH_DEBUG
662
663 /* Non-zero means print traces of redisplay if compiled with
664 GLYPH_DEBUG defined. */
665
666 bool trace_redisplay_p;
667
668 #endif /* GLYPH_DEBUG */
669
670 #ifdef DEBUG_TRACE_MOVE
671 /* Non-zero means trace with TRACE_MOVE to stderr. */
672 int trace_move;
673
674 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
675 #else
676 #define TRACE_MOVE(x) (void) 0
677 #endif
678
679 static Lisp_Object Qauto_hscroll_mode;
680
681 /* Buffer being redisplayed -- for redisplay_window_error. */
682
683 static struct buffer *displayed_buffer;
684
685 /* Value returned from text property handlers (see below). */
686
687 enum prop_handled
688 {
689 HANDLED_NORMALLY,
690 HANDLED_RECOMPUTE_PROPS,
691 HANDLED_OVERLAY_STRING_CONSUMED,
692 HANDLED_RETURN
693 };
694
695 /* A description of text properties that redisplay is interested
696 in. */
697
698 struct props
699 {
700 /* The name of the property. */
701 Lisp_Object *name;
702
703 /* A unique index for the property. */
704 enum prop_idx idx;
705
706 /* A handler function called to set up iterator IT from the property
707 at IT's current position. Value is used to steer handle_stop. */
708 enum prop_handled (*handler) (struct it *it);
709 };
710
711 static enum prop_handled handle_face_prop (struct it *);
712 static enum prop_handled handle_invisible_prop (struct it *);
713 static enum prop_handled handle_display_prop (struct it *);
714 static enum prop_handled handle_composition_prop (struct it *);
715 static enum prop_handled handle_overlay_change (struct it *);
716 static enum prop_handled handle_fontified_prop (struct it *);
717
718 /* Properties handled by iterators. */
719
720 static struct props it_props[] =
721 {
722 {&Qfontified, FONTIFIED_PROP_IDX, handle_fontified_prop},
723 /* Handle `face' before `display' because some sub-properties of
724 `display' need to know the face. */
725 {&Qface, FACE_PROP_IDX, handle_face_prop},
726 {&Qdisplay, DISPLAY_PROP_IDX, handle_display_prop},
727 {&Qinvisible, INVISIBLE_PROP_IDX, handle_invisible_prop},
728 {&Qcomposition, COMPOSITION_PROP_IDX, handle_composition_prop},
729 {NULL, 0, NULL}
730 };
731
732 /* Value is the position described by X. If X is a marker, value is
733 the marker_position of X. Otherwise, value is X. */
734
735 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
736
737 /* Enumeration returned by some move_it_.* functions internally. */
738
739 enum move_it_result
740 {
741 /* Not used. Undefined value. */
742 MOVE_UNDEFINED,
743
744 /* Move ended at the requested buffer position or ZV. */
745 MOVE_POS_MATCH_OR_ZV,
746
747 /* Move ended at the requested X pixel position. */
748 MOVE_X_REACHED,
749
750 /* Move within a line ended at the end of a line that must be
751 continued. */
752 MOVE_LINE_CONTINUED,
753
754 /* Move within a line ended at the end of a line that would
755 be displayed truncated. */
756 MOVE_LINE_TRUNCATED,
757
758 /* Move within a line ended at a line end. */
759 MOVE_NEWLINE_OR_CR
760 };
761
762 /* This counter is used to clear the face cache every once in a while
763 in redisplay_internal. It is incremented for each redisplay.
764 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
765 cleared. */
766
767 #define CLEAR_FACE_CACHE_COUNT 500
768 static int clear_face_cache_count;
769
770 /* Similarly for the image cache. */
771
772 #ifdef HAVE_WINDOW_SYSTEM
773 #define CLEAR_IMAGE_CACHE_COUNT 101
774 static int clear_image_cache_count;
775
776 /* Null glyph slice */
777 static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
778 #endif
779
780 /* True while redisplay_internal is in progress. */
781
782 bool redisplaying_p;
783
784 static Lisp_Object Qinhibit_free_realized_faces;
785 static Lisp_Object Qmode_line_default_help_echo;
786
787 /* If a string, XTread_socket generates an event to display that string.
788 (The display is done in read_char.) */
789
790 Lisp_Object help_echo_string;
791 Lisp_Object help_echo_window;
792 Lisp_Object help_echo_object;
793 ptrdiff_t help_echo_pos;
794
795 /* Temporary variable for XTread_socket. */
796
797 Lisp_Object previous_help_echo_string;
798
799 /* Platform-independent portion of hourglass implementation. */
800
801 #ifdef HAVE_WINDOW_SYSTEM
802
803 /* Non-zero means an hourglass cursor is currently shown. */
804 bool hourglass_shown_p;
805
806 /* If non-null, an asynchronous timer that, when it expires, displays
807 an hourglass cursor on all frames. */
808 struct atimer *hourglass_atimer;
809
810 #endif /* HAVE_WINDOW_SYSTEM */
811
812 /* Name of the face used to display glyphless characters. */
813 static Lisp_Object Qglyphless_char;
814
815 /* Symbol for the purpose of Vglyphless_char_display. */
816 static Lisp_Object Qglyphless_char_display;
817
818 /* Method symbols for Vglyphless_char_display. */
819 static Lisp_Object Qhex_code, Qempty_box, Qthin_space, Qzero_width;
820
821 /* Default number of seconds to wait before displaying an hourglass
822 cursor. */
823 #define DEFAULT_HOURGLASS_DELAY 1
824
825 #ifdef HAVE_WINDOW_SYSTEM
826
827 /* Default pixel width of `thin-space' display method. */
828 #define THIN_SPACE_WIDTH 1
829
830 #endif /* HAVE_WINDOW_SYSTEM */
831
832 /* Function prototypes. */
833
834 static void setup_for_ellipsis (struct it *, int);
835 static void set_iterator_to_next (struct it *, int);
836 static void mark_window_display_accurate_1 (struct window *, int);
837 static int single_display_spec_string_p (Lisp_Object, Lisp_Object);
838 static int display_prop_string_p (Lisp_Object, Lisp_Object);
839 static int row_for_charpos_p (struct glyph_row *, ptrdiff_t);
840 static int cursor_row_p (struct glyph_row *);
841 static int redisplay_mode_lines (Lisp_Object, bool);
842 static char *decode_mode_spec_coding (Lisp_Object, char *, int);
843
844 static Lisp_Object get_it_property (struct it *it, Lisp_Object prop);
845
846 static void handle_line_prefix (struct it *);
847
848 static void pint2str (char *, int, ptrdiff_t);
849 static void pint2hrstr (char *, int, ptrdiff_t);
850 static struct text_pos run_window_scroll_functions (Lisp_Object,
851 struct text_pos);
852 static int text_outside_line_unchanged_p (struct window *,
853 ptrdiff_t, ptrdiff_t);
854 static void store_mode_line_noprop_char (char);
855 static int store_mode_line_noprop (const char *, int, int);
856 static void handle_stop (struct it *);
857 static void handle_stop_backwards (struct it *, ptrdiff_t);
858 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
859 static void ensure_echo_area_buffers (void);
860 static void unwind_with_echo_area_buffer (Lisp_Object);
861 static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
862 static int with_echo_area_buffer (struct window *, int,
863 int (*) (ptrdiff_t, Lisp_Object),
864 ptrdiff_t, Lisp_Object);
865 static void clear_garbaged_frames (void);
866 static int current_message_1 (ptrdiff_t, Lisp_Object);
867 static int truncate_message_1 (ptrdiff_t, Lisp_Object);
868 static void set_message (Lisp_Object);
869 static int set_message_1 (ptrdiff_t, Lisp_Object);
870 static int display_echo_area (struct window *);
871 static int display_echo_area_1 (ptrdiff_t, Lisp_Object);
872 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object);
873 static void unwind_redisplay (void);
874 static int string_char_and_length (const unsigned char *, int *);
875 static struct text_pos display_prop_end (struct it *, Lisp_Object,
876 struct text_pos);
877 static int compute_window_start_on_continuation_line (struct window *);
878 static void insert_left_trunc_glyphs (struct it *);
879 static struct glyph_row *get_overlay_arrow_glyph_row (struct window *,
880 Lisp_Object);
881 static void extend_face_to_end_of_line (struct it *);
882 static int append_space_for_newline (struct it *, int);
883 static int cursor_row_fully_visible_p (struct window *, int, int);
884 static int try_scrolling (Lisp_Object, int, ptrdiff_t, ptrdiff_t, int, int);
885 static int try_cursor_movement (Lisp_Object, struct text_pos, int *);
886 static int trailing_whitespace_p (ptrdiff_t);
887 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
888 static void push_it (struct it *, struct text_pos *);
889 static void iterate_out_of_display_property (struct it *);
890 static void pop_it (struct it *);
891 static void sync_frame_with_window_matrix_rows (struct window *);
892 static void redisplay_internal (void);
893 static int echo_area_display (int);
894 static void redisplay_windows (Lisp_Object);
895 static void redisplay_window (Lisp_Object, bool);
896 static Lisp_Object redisplay_window_error (Lisp_Object);
897 static Lisp_Object redisplay_window_0 (Lisp_Object);
898 static Lisp_Object redisplay_window_1 (Lisp_Object);
899 static int set_cursor_from_row (struct window *, struct glyph_row *,
900 struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
901 int, int);
902 static int update_menu_bar (struct frame *, int, int);
903 static int try_window_reusing_current_matrix (struct window *);
904 static int try_window_id (struct window *);
905 static int display_line (struct it *);
906 static int display_mode_lines (struct window *);
907 static int display_mode_line (struct window *, enum face_id, Lisp_Object);
908 static int display_mode_element (struct it *, int, int, int, Lisp_Object, Lisp_Object, int);
909 static int store_mode_line_string (const char *, Lisp_Object, int, int, int, Lisp_Object);
910 static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
911 static void display_menu_bar (struct window *);
912 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
913 ptrdiff_t *);
914 static int display_string (const char *, Lisp_Object, Lisp_Object,
915 ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
916 static void compute_line_metrics (struct it *);
917 static void run_redisplay_end_trigger_hook (struct it *);
918 static int get_overlay_strings (struct it *, ptrdiff_t);
919 static int get_overlay_strings_1 (struct it *, ptrdiff_t, int);
920 static void next_overlay_string (struct it *);
921 static void reseat (struct it *, struct text_pos, int);
922 static void reseat_1 (struct it *, struct text_pos, int);
923 static void back_to_previous_visible_line_start (struct it *);
924 static void reseat_at_next_visible_line_start (struct it *, int);
925 static int next_element_from_ellipsis (struct it *);
926 static int next_element_from_display_vector (struct it *);
927 static int next_element_from_string (struct it *);
928 static int next_element_from_c_string (struct it *);
929 static int next_element_from_buffer (struct it *);
930 static int next_element_from_composition (struct it *);
931 static int next_element_from_image (struct it *);
932 static int next_element_from_stretch (struct it *);
933 static void load_overlay_strings (struct it *, ptrdiff_t);
934 static int init_from_display_pos (struct it *, struct window *,
935 struct display_pos *);
936 static void reseat_to_string (struct it *, const char *,
937 Lisp_Object, ptrdiff_t, ptrdiff_t, int, int);
938 static int get_next_display_element (struct it *);
939 static enum move_it_result
940 move_it_in_display_line_to (struct it *, ptrdiff_t, int,
941 enum move_operation_enum);
942 static void get_visually_first_element (struct it *);
943 static void init_to_row_start (struct it *, struct window *,
944 struct glyph_row *);
945 static int init_to_row_end (struct it *, struct window *,
946 struct glyph_row *);
947 static void back_to_previous_line_start (struct it *);
948 static int forward_to_next_line_start (struct it *, int *, struct bidi_it *);
949 static struct text_pos string_pos_nchars_ahead (struct text_pos,
950 Lisp_Object, ptrdiff_t);
951 static struct text_pos string_pos (ptrdiff_t, Lisp_Object);
952 static struct text_pos c_string_pos (ptrdiff_t, const char *, bool);
953 static ptrdiff_t number_of_chars (const char *, bool);
954 static void compute_stop_pos (struct it *);
955 static void compute_string_pos (struct text_pos *, struct text_pos,
956 Lisp_Object);
957 static int face_before_or_after_it_pos (struct it *, int);
958 static ptrdiff_t next_overlay_change (ptrdiff_t);
959 static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
960 Lisp_Object, struct text_pos *, ptrdiff_t, int);
961 static int handle_single_display_spec (struct it *, Lisp_Object,
962 Lisp_Object, Lisp_Object,
963 struct text_pos *, ptrdiff_t, int, int);
964 static int underlying_face_id (struct it *);
965 static int in_ellipses_for_invisible_text_p (struct display_pos *,
966 struct window *);
967
968 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
969 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
970
971 #ifdef HAVE_WINDOW_SYSTEM
972
973 static void x_consider_frame_title (Lisp_Object);
974 static void update_tool_bar (struct frame *, int);
975 static int redisplay_tool_bar (struct frame *);
976 static void x_draw_bottom_divider (struct window *w);
977 static void notice_overwritten_cursor (struct window *,
978 enum glyph_row_area,
979 int, int, int, int);
980 static void append_stretch_glyph (struct it *, Lisp_Object,
981 int, int, int);
982
983
984 #endif /* HAVE_WINDOW_SYSTEM */
985
986 static void produce_special_glyphs (struct it *, enum display_element_type);
987 static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
988 static bool coords_in_mouse_face_p (struct window *, int, int);
989
990
991 \f
992 /***********************************************************************
993 Window display dimensions
994 ***********************************************************************/
995
996 /* Return the bottom boundary y-position for text lines in window W.
997 This is the first y position at which a line cannot start.
998 It is relative to the top of the window.
999
1000 This is the height of W minus the height of a mode line, if any. */
1001
1002 int
1003 window_text_bottom_y (struct window *w)
1004 {
1005 int height = WINDOW_PIXEL_HEIGHT (w);
1006
1007 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
1008
1009 if (WINDOW_WANTS_MODELINE_P (w))
1010 height -= CURRENT_MODE_LINE_HEIGHT (w);
1011
1012 return height;
1013 }
1014
1015 /* Return the pixel width of display area AREA of window W.
1016 ANY_AREA means return the total width of W, not including
1017 fringes to the left and right of the window. */
1018
1019 int
1020 window_box_width (struct window *w, enum glyph_row_area area)
1021 {
1022 int width = w->pixel_width;
1023
1024 if (!w->pseudo_window_p)
1025 {
1026 width -= WINDOW_SCROLL_BAR_AREA_WIDTH (w);
1027 width -= WINDOW_RIGHT_DIVIDER_WIDTH (w);
1028
1029 if (area == TEXT_AREA)
1030 width -= (WINDOW_MARGINS_WIDTH (w)
1031 + WINDOW_FRINGES_WIDTH (w));
1032 else if (area == LEFT_MARGIN_AREA)
1033 width = WINDOW_LEFT_MARGIN_WIDTH (w);
1034 else if (area == RIGHT_MARGIN_AREA)
1035 width = WINDOW_RIGHT_MARGIN_WIDTH (w);
1036 }
1037
1038 /* With wide margins, fringes, etc. we might end up with a negative
1039 width, correct that here. */
1040 return max (0, width);
1041 }
1042
1043
1044 /* Return the pixel height of the display area of window W, not
1045 including mode lines of W, if any. */
1046
1047 int
1048 window_box_height (struct window *w)
1049 {
1050 struct frame *f = XFRAME (w->frame);
1051 int height = WINDOW_PIXEL_HEIGHT (w);
1052
1053 eassert (height >= 0);
1054
1055 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
1056
1057 /* Note: the code below that determines the mode-line/header-line
1058 height is essentially the same as that contained in the macro
1059 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1060 the appropriate glyph row has its `mode_line_p' flag set,
1061 and if it doesn't, uses estimate_mode_line_height instead. */
1062
1063 if (WINDOW_WANTS_MODELINE_P (w))
1064 {
1065 struct glyph_row *ml_row
1066 = (w->current_matrix && w->current_matrix->rows
1067 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
1068 : 0);
1069 if (ml_row && ml_row->mode_line_p)
1070 height -= ml_row->height;
1071 else
1072 height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
1073 }
1074
1075 if (WINDOW_WANTS_HEADER_LINE_P (w))
1076 {
1077 struct glyph_row *hl_row
1078 = (w->current_matrix && w->current_matrix->rows
1079 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
1080 : 0);
1081 if (hl_row && hl_row->mode_line_p)
1082 height -= hl_row->height;
1083 else
1084 height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
1085 }
1086
1087 /* With a very small font and a mode-line that's taller than
1088 default, we might end up with a negative height. */
1089 return max (0, height);
1090 }
1091
1092 /* Return the window-relative coordinate of the left edge of display
1093 area AREA of window W. ANY_AREA means return the left edge of the
1094 whole window, to the right of the left fringe of W. */
1095
1096 int
1097 window_box_left_offset (struct window *w, enum glyph_row_area area)
1098 {
1099 int x;
1100
1101 if (w->pseudo_window_p)
1102 return 0;
1103
1104 x = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
1105
1106 if (area == TEXT_AREA)
1107 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1108 + window_box_width (w, LEFT_MARGIN_AREA));
1109 else if (area == RIGHT_MARGIN_AREA)
1110 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1111 + window_box_width (w, LEFT_MARGIN_AREA)
1112 + window_box_width (w, TEXT_AREA)
1113 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1114 ? 0
1115 : WINDOW_RIGHT_FRINGE_WIDTH (w)));
1116 else if (area == LEFT_MARGIN_AREA
1117 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1118 x += WINDOW_LEFT_FRINGE_WIDTH (w);
1119
1120 /* Don't return more than the window's pixel width. */
1121 return min (x, w->pixel_width);
1122 }
1123
1124
1125 /* Return the window-relative coordinate of the right edge of display
1126 area AREA of window W. ANY_AREA means return the right edge of the
1127 whole window, to the left of the right fringe of W. */
1128
1129 int
1130 window_box_right_offset (struct window *w, enum glyph_row_area area)
1131 {
1132 /* Don't return more than the window's pixel width. */
1133 return min (window_box_left_offset (w, area) + window_box_width (w, area),
1134 w->pixel_width);
1135 }
1136
1137 /* Return the frame-relative coordinate of the left edge of display
1138 area AREA of window W. ANY_AREA means return the left edge of the
1139 whole window, to the right of the left fringe of W. */
1140
1141 int
1142 window_box_left (struct window *w, enum glyph_row_area area)
1143 {
1144 struct frame *f = XFRAME (w->frame);
1145 int x;
1146
1147 if (w->pseudo_window_p)
1148 return FRAME_INTERNAL_BORDER_WIDTH (f);
1149
1150 x = (WINDOW_LEFT_EDGE_X (w)
1151 + window_box_left_offset (w, area));
1152
1153 return x;
1154 }
1155
1156
1157 /* Return the frame-relative coordinate of the right edge of display
1158 area AREA of window W. ANY_AREA means return the right edge of the
1159 whole window, to the left of the right fringe of W. */
1160
1161 int
1162 window_box_right (struct window *w, enum glyph_row_area area)
1163 {
1164 return window_box_left (w, area) + window_box_width (w, area);
1165 }
1166
1167 /* Get the bounding box of the display area AREA of window W, without
1168 mode lines, in frame-relative coordinates. ANY_AREA means the
1169 whole window, not including the left and right fringes of
1170 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1171 coordinates of the upper-left corner of the box. Return in
1172 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1173
1174 void
1175 window_box (struct window *w, enum glyph_row_area area, int *box_x,
1176 int *box_y, int *box_width, int *box_height)
1177 {
1178 if (box_width)
1179 *box_width = window_box_width (w, area);
1180 if (box_height)
1181 *box_height = window_box_height (w);
1182 if (box_x)
1183 *box_x = window_box_left (w, area);
1184 if (box_y)
1185 {
1186 *box_y = WINDOW_TOP_EDGE_Y (w);
1187 if (WINDOW_WANTS_HEADER_LINE_P (w))
1188 *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
1189 }
1190 }
1191
1192 #ifdef HAVE_WINDOW_SYSTEM
1193
1194 /* Get the bounding box of the display area AREA of window W, without
1195 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1196 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1197 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1198 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1199 box. */
1200
1201 static void
1202 window_box_edges (struct window *w, int *top_left_x, int *top_left_y,
1203 int *bottom_right_x, int *bottom_right_y)
1204 {
1205 window_box (w, ANY_AREA, top_left_x, top_left_y,
1206 bottom_right_x, bottom_right_y);
1207 *bottom_right_x += *top_left_x;
1208 *bottom_right_y += *top_left_y;
1209 }
1210
1211 #endif /* HAVE_WINDOW_SYSTEM */
1212
1213 /***********************************************************************
1214 Utilities
1215 ***********************************************************************/
1216
1217 /* Return the bottom y-position of the line the iterator IT is in.
1218 This can modify IT's settings. */
1219
1220 int
1221 line_bottom_y (struct it *it)
1222 {
1223 int line_height = it->max_ascent + it->max_descent;
1224 int line_top_y = it->current_y;
1225
1226 if (line_height == 0)
1227 {
1228 if (last_height)
1229 line_height = last_height;
1230 else if (IT_CHARPOS (*it) < ZV)
1231 {
1232 move_it_by_lines (it, 1);
1233 line_height = (it->max_ascent || it->max_descent
1234 ? it->max_ascent + it->max_descent
1235 : last_height);
1236 }
1237 else
1238 {
1239 struct glyph_row *row = it->glyph_row;
1240
1241 /* Use the default character height. */
1242 it->glyph_row = NULL;
1243 it->what = IT_CHARACTER;
1244 it->c = ' ';
1245 it->len = 1;
1246 PRODUCE_GLYPHS (it);
1247 line_height = it->ascent + it->descent;
1248 it->glyph_row = row;
1249 }
1250 }
1251
1252 return line_top_y + line_height;
1253 }
1254
1255 DEFUN ("line-pixel-height", Fline_pixel_height,
1256 Sline_pixel_height, 0, 0, 0,
1257 doc: /* Return height in pixels of text line in the selected window.
1258
1259 Value is the height in pixels of the line at point. */)
1260 (void)
1261 {
1262 struct it it;
1263 struct text_pos pt;
1264 struct window *w = XWINDOW (selected_window);
1265 struct buffer *old_buffer = NULL;
1266 Lisp_Object result;
1267
1268 if (XBUFFER (w->contents) != current_buffer)
1269 {
1270 old_buffer = current_buffer;
1271 set_buffer_internal_1 (XBUFFER (w->contents));
1272 }
1273 SET_TEXT_POS (pt, PT, PT_BYTE);
1274 start_display (&it, w, pt);
1275 it.vpos = it.current_y = 0;
1276 last_height = 0;
1277 result = make_number (line_bottom_y (&it));
1278 if (old_buffer)
1279 set_buffer_internal_1 (old_buffer);
1280
1281 return result;
1282 }
1283
1284 /* Return the default pixel height of text lines in window W. The
1285 value is the canonical height of the W frame's default font, plus
1286 any extra space required by the line-spacing variable or frame
1287 parameter.
1288
1289 Implementation note: this ignores any line-spacing text properties
1290 put on the newline characters. This is because those properties
1291 only affect the _screen_ line ending in the newline (i.e., in a
1292 continued line, only the last screen line will be affected), which
1293 means only a small number of lines in a buffer can ever use this
1294 feature. Since this function is used to compute the default pixel
1295 equivalent of text lines in a window, we can safely ignore those
1296 few lines. For the same reasons, we ignore the line-height
1297 properties. */
1298 int
1299 default_line_pixel_height (struct window *w)
1300 {
1301 struct frame *f = WINDOW_XFRAME (w);
1302 int height = FRAME_LINE_HEIGHT (f);
1303
1304 if (!FRAME_INITIAL_P (f) && BUFFERP (w->contents))
1305 {
1306 struct buffer *b = XBUFFER (w->contents);
1307 Lisp_Object val = BVAR (b, extra_line_spacing);
1308
1309 if (NILP (val))
1310 val = BVAR (&buffer_defaults, extra_line_spacing);
1311 if (!NILP (val))
1312 {
1313 if (RANGED_INTEGERP (0, val, INT_MAX))
1314 height += XFASTINT (val);
1315 else if (FLOATP (val))
1316 {
1317 int addon = XFLOAT_DATA (val) * height + 0.5;
1318
1319 if (addon >= 0)
1320 height += addon;
1321 }
1322 }
1323 else
1324 height += f->extra_line_spacing;
1325 }
1326
1327 return height;
1328 }
1329
1330 /* Subroutine of pos_visible_p below. Extracts a display string, if
1331 any, from the display spec given as its argument. */
1332 static Lisp_Object
1333 string_from_display_spec (Lisp_Object spec)
1334 {
1335 if (CONSP (spec))
1336 {
1337 while (CONSP (spec))
1338 {
1339 if (STRINGP (XCAR (spec)))
1340 return XCAR (spec);
1341 spec = XCDR (spec);
1342 }
1343 }
1344 else if (VECTORP (spec))
1345 {
1346 ptrdiff_t i;
1347
1348 for (i = 0; i < ASIZE (spec); i++)
1349 {
1350 if (STRINGP (AREF (spec, i)))
1351 return AREF (spec, i);
1352 }
1353 return Qnil;
1354 }
1355
1356 return spec;
1357 }
1358
1359
1360 /* Limit insanely large values of W->hscroll on frame F to the largest
1361 value that will still prevent first_visible_x and last_visible_x of
1362 'struct it' from overflowing an int. */
1363 static int
1364 window_hscroll_limited (struct window *w, struct frame *f)
1365 {
1366 ptrdiff_t window_hscroll = w->hscroll;
1367 int window_text_width = window_box_width (w, TEXT_AREA);
1368 int colwidth = FRAME_COLUMN_WIDTH (f);
1369
1370 if (window_hscroll > (INT_MAX - window_text_width) / colwidth - 1)
1371 window_hscroll = (INT_MAX - window_text_width) / colwidth - 1;
1372
1373 return window_hscroll;
1374 }
1375
1376 /* Return 1 if position CHARPOS is visible in window W.
1377 CHARPOS < 0 means return info about WINDOW_END position.
1378 If visible, set *X and *Y to pixel coordinates of top left corner.
1379 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1380 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1381
1382 int
1383 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1384 int *rtop, int *rbot, int *rowh, int *vpos)
1385 {
1386 struct it it;
1387 void *itdata = bidi_shelve_cache ();
1388 struct text_pos top;
1389 int visible_p = 0;
1390 struct buffer *old_buffer = NULL;
1391
1392 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1393 return visible_p;
1394
1395 if (XBUFFER (w->contents) != current_buffer)
1396 {
1397 old_buffer = current_buffer;
1398 set_buffer_internal_1 (XBUFFER (w->contents));
1399 }
1400
1401 SET_TEXT_POS_FROM_MARKER (top, w->start);
1402 /* Scrolling a minibuffer window via scroll bar when the echo area
1403 shows long text sometimes resets the minibuffer contents behind
1404 our backs. */
1405 if (CHARPOS (top) > ZV)
1406 SET_TEXT_POS (top, BEGV, BEGV_BYTE);
1407
1408 /* Compute exact mode line heights. */
1409 if (WINDOW_WANTS_MODELINE_P (w))
1410 w->mode_line_height
1411 = display_mode_line (w, CURRENT_MODE_LINE_FACE_ID (w),
1412 BVAR (current_buffer, mode_line_format));
1413
1414 if (WINDOW_WANTS_HEADER_LINE_P (w))
1415 w->header_line_height
1416 = display_mode_line (w, HEADER_LINE_FACE_ID,
1417 BVAR (current_buffer, header_line_format));
1418
1419 start_display (&it, w, top);
1420 move_it_to (&it, charpos, -1, it.last_visible_y - 1, -1,
1421 (charpos >= 0 ? MOVE_TO_POS : 0) | MOVE_TO_Y);
1422
1423 if (charpos >= 0
1424 && (((!it.bidi_p || it.bidi_it.scan_dir == 1)
1425 && IT_CHARPOS (it) >= charpos)
1426 /* When scanning backwards under bidi iteration, move_it_to
1427 stops at or _before_ CHARPOS, because it stops at or to
1428 the _right_ of the character at CHARPOS. */
1429 || (it.bidi_p && it.bidi_it.scan_dir == -1
1430 && IT_CHARPOS (it) <= charpos)))
1431 {
1432 /* We have reached CHARPOS, or passed it. How the call to
1433 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1434 or covered by a display property, move_it_to stops at the end
1435 of the invisible text, to the right of CHARPOS. (ii) If
1436 CHARPOS is in a display vector, move_it_to stops on its last
1437 glyph. */
1438 int top_x = it.current_x;
1439 int top_y = it.current_y;
1440 /* Calling line_bottom_y may change it.method, it.position, etc. */
1441 enum it_method it_method = it.method;
1442 int bottom_y = (last_height = 0, line_bottom_y (&it));
1443 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1444
1445 if (top_y < window_top_y)
1446 visible_p = bottom_y > window_top_y;
1447 else if (top_y < it.last_visible_y)
1448 visible_p = true;
1449 if (bottom_y >= it.last_visible_y
1450 && it.bidi_p && it.bidi_it.scan_dir == -1
1451 && IT_CHARPOS (it) < charpos)
1452 {
1453 /* When the last line of the window is scanned backwards
1454 under bidi iteration, we could be duped into thinking
1455 that we have passed CHARPOS, when in fact move_it_to
1456 simply stopped short of CHARPOS because it reached
1457 last_visible_y. To see if that's what happened, we call
1458 move_it_to again with a slightly larger vertical limit,
1459 and see if it actually moved vertically; if it did, we
1460 didn't really reach CHARPOS, which is beyond window end. */
1461 struct it save_it = it;
1462 /* Why 10? because we don't know how many canonical lines
1463 will the height of the next line(s) be. So we guess. */
1464 int ten_more_lines = 10 * default_line_pixel_height (w);
1465
1466 move_it_to (&it, charpos, -1, bottom_y + ten_more_lines, -1,
1467 MOVE_TO_POS | MOVE_TO_Y);
1468 if (it.current_y > top_y)
1469 visible_p = 0;
1470
1471 it = save_it;
1472 }
1473 if (visible_p)
1474 {
1475 if (it_method == GET_FROM_DISPLAY_VECTOR)
1476 {
1477 /* We stopped on the last glyph of a display vector.
1478 Try and recompute. Hack alert! */
1479 if (charpos < 2 || top.charpos >= charpos)
1480 top_x = it.glyph_row->x;
1481 else
1482 {
1483 struct it it2, it2_prev;
1484 /* The idea is to get to the previous buffer
1485 position, consume the character there, and use
1486 the pixel coordinates we get after that. But if
1487 the previous buffer position is also displayed
1488 from a display vector, we need to consume all of
1489 the glyphs from that display vector. */
1490 start_display (&it2, w, top);
1491 move_it_to (&it2, charpos - 1, -1, -1, -1, MOVE_TO_POS);
1492 /* If we didn't get to CHARPOS - 1, there's some
1493 replacing display property at that position, and
1494 we stopped after it. That is exactly the place
1495 whose coordinates we want. */
1496 if (IT_CHARPOS (it2) != charpos - 1)
1497 it2_prev = it2;
1498 else
1499 {
1500 /* Iterate until we get out of the display
1501 vector that displays the character at
1502 CHARPOS - 1. */
1503 do {
1504 get_next_display_element (&it2);
1505 PRODUCE_GLYPHS (&it2);
1506 it2_prev = it2;
1507 set_iterator_to_next (&it2, 1);
1508 } while (it2.method == GET_FROM_DISPLAY_VECTOR
1509 && IT_CHARPOS (it2) < charpos);
1510 }
1511 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev)
1512 || it2_prev.current_x > it2_prev.last_visible_x)
1513 top_x = it.glyph_row->x;
1514 else
1515 {
1516 top_x = it2_prev.current_x;
1517 top_y = it2_prev.current_y;
1518 }
1519 }
1520 }
1521 else if (IT_CHARPOS (it) != charpos)
1522 {
1523 Lisp_Object cpos = make_number (charpos);
1524 Lisp_Object spec = Fget_char_property (cpos, Qdisplay, Qnil);
1525 Lisp_Object string = string_from_display_spec (spec);
1526 struct text_pos tpos;
1527 int replacing_spec_p;
1528 bool newline_in_string
1529 = (STRINGP (string)
1530 && memchr (SDATA (string), '\n', SBYTES (string)));
1531
1532 SET_TEXT_POS (tpos, charpos, CHAR_TO_BYTE (charpos));
1533 replacing_spec_p
1534 = (!NILP (spec)
1535 && handle_display_spec (NULL, spec, Qnil, Qnil, &tpos,
1536 charpos, FRAME_WINDOW_P (it.f)));
1537 /* The tricky code below is needed because there's a
1538 discrepancy between move_it_to and how we set cursor
1539 when PT is at the beginning of a portion of text
1540 covered by a display property or an overlay with a
1541 display property, or the display line ends in a
1542 newline from a display string. move_it_to will stop
1543 _after_ such display strings, whereas
1544 set_cursor_from_row conspires with cursor_row_p to
1545 place the cursor on the first glyph produced from the
1546 display string. */
1547
1548 /* We have overshoot PT because it is covered by a
1549 display property that replaces the text it covers.
1550 If the string includes embedded newlines, we are also
1551 in the wrong display line. Backtrack to the correct
1552 line, where the display property begins. */
1553 if (replacing_spec_p)
1554 {
1555 Lisp_Object startpos, endpos;
1556 EMACS_INT start, end;
1557 struct it it3;
1558 int it3_moved;
1559
1560 /* Find the first and the last buffer positions
1561 covered by the display string. */
1562 endpos =
1563 Fnext_single_char_property_change (cpos, Qdisplay,
1564 Qnil, Qnil);
1565 startpos =
1566 Fprevious_single_char_property_change (endpos, Qdisplay,
1567 Qnil, Qnil);
1568 start = XFASTINT (startpos);
1569 end = XFASTINT (endpos);
1570 /* Move to the last buffer position before the
1571 display property. */
1572 start_display (&it3, w, top);
1573 move_it_to (&it3, start - 1, -1, -1, -1, MOVE_TO_POS);
1574 /* Move forward one more line if the position before
1575 the display string is a newline or if it is the
1576 rightmost character on a line that is
1577 continued or word-wrapped. */
1578 if (it3.method == GET_FROM_BUFFER
1579 && (it3.c == '\n'
1580 || FETCH_BYTE (IT_BYTEPOS (it3)) == '\n'))
1581 move_it_by_lines (&it3, 1);
1582 else if (move_it_in_display_line_to (&it3, -1,
1583 it3.current_x
1584 + it3.pixel_width,
1585 MOVE_TO_X)
1586 == MOVE_LINE_CONTINUED)
1587 {
1588 move_it_by_lines (&it3, 1);
1589 /* When we are under word-wrap, the #$@%!
1590 move_it_by_lines moves 2 lines, so we need to
1591 fix that up. */
1592 if (it3.line_wrap == WORD_WRAP)
1593 move_it_by_lines (&it3, -1);
1594 }
1595
1596 /* Record the vertical coordinate of the display
1597 line where we wound up. */
1598 top_y = it3.current_y;
1599 if (it3.bidi_p)
1600 {
1601 /* When characters are reordered for display,
1602 the character displayed to the left of the
1603 display string could be _after_ the display
1604 property in the logical order. Use the
1605 smallest vertical position of these two. */
1606 start_display (&it3, w, top);
1607 move_it_to (&it3, end + 1, -1, -1, -1, MOVE_TO_POS);
1608 if (it3.current_y < top_y)
1609 top_y = it3.current_y;
1610 }
1611 /* Move from the top of the window to the beginning
1612 of the display line where the display string
1613 begins. */
1614 start_display (&it3, w, top);
1615 move_it_to (&it3, -1, 0, top_y, -1, MOVE_TO_X | MOVE_TO_Y);
1616 /* If it3_moved stays zero after the 'while' loop
1617 below, that means we already were at a newline
1618 before the loop (e.g., the display string begins
1619 with a newline), so we don't need to (and cannot)
1620 inspect the glyphs of it3.glyph_row, because
1621 PRODUCE_GLYPHS will not produce anything for a
1622 newline, and thus it3.glyph_row stays at its
1623 stale content it got at top of the window. */
1624 it3_moved = 0;
1625 /* Finally, advance the iterator until we hit the
1626 first display element whose character position is
1627 CHARPOS, or until the first newline from the
1628 display string, which signals the end of the
1629 display line. */
1630 while (get_next_display_element (&it3))
1631 {
1632 PRODUCE_GLYPHS (&it3);
1633 if (IT_CHARPOS (it3) == charpos
1634 || ITERATOR_AT_END_OF_LINE_P (&it3))
1635 break;
1636 it3_moved = 1;
1637 set_iterator_to_next (&it3, 0);
1638 }
1639 top_x = it3.current_x - it3.pixel_width;
1640 /* Normally, we would exit the above loop because we
1641 found the display element whose character
1642 position is CHARPOS. For the contingency that we
1643 didn't, and stopped at the first newline from the
1644 display string, move back over the glyphs
1645 produced from the string, until we find the
1646 rightmost glyph not from the string. */
1647 if (it3_moved
1648 && newline_in_string
1649 && IT_CHARPOS (it3) != charpos && EQ (it3.object, string))
1650 {
1651 struct glyph *g = it3.glyph_row->glyphs[TEXT_AREA]
1652 + it3.glyph_row->used[TEXT_AREA];
1653
1654 while (EQ ((g - 1)->object, string))
1655 {
1656 --g;
1657 top_x -= g->pixel_width;
1658 }
1659 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1660 + it3.glyph_row->used[TEXT_AREA]);
1661 }
1662 }
1663 }
1664
1665 *x = top_x;
1666 *y = max (top_y + max (0, it.max_ascent - it.ascent), window_top_y);
1667 *rtop = max (0, window_top_y - top_y);
1668 *rbot = max (0, bottom_y - it.last_visible_y);
1669 *rowh = max (0, (min (bottom_y, it.last_visible_y)
1670 - max (top_y, window_top_y)));
1671 *vpos = it.vpos;
1672 }
1673 }
1674 else
1675 {
1676 /* We were asked to provide info about WINDOW_END. */
1677 struct it it2;
1678 void *it2data = NULL;
1679
1680 SAVE_IT (it2, it, it2data);
1681 if (IT_CHARPOS (it) < ZV && FETCH_BYTE (IT_BYTEPOS (it)) != '\n')
1682 move_it_by_lines (&it, 1);
1683 if (charpos < IT_CHARPOS (it)
1684 || (it.what == IT_EOB && charpos == IT_CHARPOS (it)))
1685 {
1686 visible_p = true;
1687 RESTORE_IT (&it2, &it2, it2data);
1688 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1689 *x = it2.current_x;
1690 *y = it2.current_y + it2.max_ascent - it2.ascent;
1691 *rtop = max (0, -it2.current_y);
1692 *rbot = max (0, ((it2.current_y + it2.max_ascent + it2.max_descent)
1693 - it.last_visible_y));
1694 *rowh = max (0, (min (it2.current_y + it2.max_ascent + it2.max_descent,
1695 it.last_visible_y)
1696 - max (it2.current_y,
1697 WINDOW_HEADER_LINE_HEIGHT (w))));
1698 *vpos = it2.vpos;
1699 }
1700 else
1701 bidi_unshelve_cache (it2data, 1);
1702 }
1703 bidi_unshelve_cache (itdata, 0);
1704
1705 if (old_buffer)
1706 set_buffer_internal_1 (old_buffer);
1707
1708 if (visible_p && w->hscroll > 0)
1709 *x -=
1710 window_hscroll_limited (w, WINDOW_XFRAME (w))
1711 * WINDOW_FRAME_COLUMN_WIDTH (w);
1712
1713 #if 0
1714 /* Debugging code. */
1715 if (visible_p)
1716 fprintf (stderr, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1717 charpos, w->vscroll, *x, *y, *rtop, *rbot, *rowh, *vpos);
1718 else
1719 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1720 #endif
1721
1722 return visible_p;
1723 }
1724
1725
1726 /* Return the next character from STR. Return in *LEN the length of
1727 the character. This is like STRING_CHAR_AND_LENGTH but never
1728 returns an invalid character. If we find one, we return a `?', but
1729 with the length of the invalid character. */
1730
1731 static int
1732 string_char_and_length (const unsigned char *str, int *len)
1733 {
1734 int c;
1735
1736 c = STRING_CHAR_AND_LENGTH (str, *len);
1737 if (!CHAR_VALID_P (c))
1738 /* We may not change the length here because other places in Emacs
1739 don't use this function, i.e. they silently accept invalid
1740 characters. */
1741 c = '?';
1742
1743 return c;
1744 }
1745
1746
1747
1748 /* Given a position POS containing a valid character and byte position
1749 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1750
1751 static struct text_pos
1752 string_pos_nchars_ahead (struct text_pos pos, Lisp_Object string, ptrdiff_t nchars)
1753 {
1754 eassert (STRINGP (string) && nchars >= 0);
1755
1756 if (STRING_MULTIBYTE (string))
1757 {
1758 const unsigned char *p = SDATA (string) + BYTEPOS (pos);
1759 int len;
1760
1761 while (nchars--)
1762 {
1763 string_char_and_length (p, &len);
1764 p += len;
1765 CHARPOS (pos) += 1;
1766 BYTEPOS (pos) += len;
1767 }
1768 }
1769 else
1770 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1771
1772 return pos;
1773 }
1774
1775
1776 /* Value is the text position, i.e. character and byte position,
1777 for character position CHARPOS in STRING. */
1778
1779 static struct text_pos
1780 string_pos (ptrdiff_t charpos, Lisp_Object string)
1781 {
1782 struct text_pos pos;
1783 eassert (STRINGP (string));
1784 eassert (charpos >= 0);
1785 SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
1786 return pos;
1787 }
1788
1789
1790 /* Value is a text position, i.e. character and byte position, for
1791 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1792 means recognize multibyte characters. */
1793
1794 static struct text_pos
1795 c_string_pos (ptrdiff_t charpos, const char *s, bool multibyte_p)
1796 {
1797 struct text_pos pos;
1798
1799 eassert (s != NULL);
1800 eassert (charpos >= 0);
1801
1802 if (multibyte_p)
1803 {
1804 int len;
1805
1806 SET_TEXT_POS (pos, 0, 0);
1807 while (charpos--)
1808 {
1809 string_char_and_length ((const unsigned char *) s, &len);
1810 s += len;
1811 CHARPOS (pos) += 1;
1812 BYTEPOS (pos) += len;
1813 }
1814 }
1815 else
1816 SET_TEXT_POS (pos, charpos, charpos);
1817
1818 return pos;
1819 }
1820
1821
1822 /* Value is the number of characters in C string S. MULTIBYTE_P
1823 non-zero means recognize multibyte characters. */
1824
1825 static ptrdiff_t
1826 number_of_chars (const char *s, bool multibyte_p)
1827 {
1828 ptrdiff_t nchars;
1829
1830 if (multibyte_p)
1831 {
1832 ptrdiff_t rest = strlen (s);
1833 int len;
1834 const unsigned char *p = (const unsigned char *) s;
1835
1836 for (nchars = 0; rest > 0; ++nchars)
1837 {
1838 string_char_and_length (p, &len);
1839 rest -= len, p += len;
1840 }
1841 }
1842 else
1843 nchars = strlen (s);
1844
1845 return nchars;
1846 }
1847
1848
1849 /* Compute byte position NEWPOS->bytepos corresponding to
1850 NEWPOS->charpos. POS is a known position in string STRING.
1851 NEWPOS->charpos must be >= POS.charpos. */
1852
1853 static void
1854 compute_string_pos (struct text_pos *newpos, struct text_pos pos, Lisp_Object string)
1855 {
1856 eassert (STRINGP (string));
1857 eassert (CHARPOS (*newpos) >= CHARPOS (pos));
1858
1859 if (STRING_MULTIBYTE (string))
1860 *newpos = string_pos_nchars_ahead (pos, string,
1861 CHARPOS (*newpos) - CHARPOS (pos));
1862 else
1863 BYTEPOS (*newpos) = CHARPOS (*newpos);
1864 }
1865
1866 /* EXPORT:
1867 Return an estimation of the pixel height of mode or header lines on
1868 frame F. FACE_ID specifies what line's height to estimate. */
1869
1870 int
1871 estimate_mode_line_height (struct frame *f, enum face_id face_id)
1872 {
1873 #ifdef HAVE_WINDOW_SYSTEM
1874 if (FRAME_WINDOW_P (f))
1875 {
1876 int height = FONT_HEIGHT (FRAME_FONT (f));
1877
1878 /* This function is called so early when Emacs starts that the face
1879 cache and mode line face are not yet initialized. */
1880 if (FRAME_FACE_CACHE (f))
1881 {
1882 struct face *face = FACE_FROM_ID (f, face_id);
1883 if (face)
1884 {
1885 if (face->font)
1886 height = FONT_HEIGHT (face->font);
1887 if (face->box_line_width > 0)
1888 height += 2 * face->box_line_width;
1889 }
1890 }
1891
1892 return height;
1893 }
1894 #endif
1895
1896 return 1;
1897 }
1898
1899 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1900 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1901 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1902 not force the value into range. */
1903
1904 void
1905 pixel_to_glyph_coords (struct frame *f, register int pix_x, register int pix_y,
1906 int *x, int *y, NativeRectangle *bounds, int noclip)
1907 {
1908
1909 #ifdef HAVE_WINDOW_SYSTEM
1910 if (FRAME_WINDOW_P (f))
1911 {
1912 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1913 even for negative values. */
1914 if (pix_x < 0)
1915 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1916 if (pix_y < 0)
1917 pix_y -= FRAME_LINE_HEIGHT (f) - 1;
1918
1919 pix_x = FRAME_PIXEL_X_TO_COL (f, pix_x);
1920 pix_y = FRAME_PIXEL_Y_TO_LINE (f, pix_y);
1921
1922 if (bounds)
1923 STORE_NATIVE_RECT (*bounds,
1924 FRAME_COL_TO_PIXEL_X (f, pix_x),
1925 FRAME_LINE_TO_PIXEL_Y (f, pix_y),
1926 FRAME_COLUMN_WIDTH (f) - 1,
1927 FRAME_LINE_HEIGHT (f) - 1);
1928
1929 /* PXW: Should we clip pixels before converting to columns/lines? */
1930 if (!noclip)
1931 {
1932 if (pix_x < 0)
1933 pix_x = 0;
1934 else if (pix_x > FRAME_TOTAL_COLS (f))
1935 pix_x = FRAME_TOTAL_COLS (f);
1936
1937 if (pix_y < 0)
1938 pix_y = 0;
1939 else if (pix_y > FRAME_LINES (f))
1940 pix_y = FRAME_LINES (f);
1941 }
1942 }
1943 #endif
1944
1945 *x = pix_x;
1946 *y = pix_y;
1947 }
1948
1949
1950 /* Find the glyph under window-relative coordinates X/Y in window W.
1951 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1952 strings. Return in *HPOS and *VPOS the row and column number of
1953 the glyph found. Return in *AREA the glyph area containing X.
1954 Value is a pointer to the glyph found or null if X/Y is not on
1955 text, or we can't tell because W's current matrix is not up to
1956 date. */
1957
1958 static struct glyph *
1959 x_y_to_hpos_vpos (struct window *w, int x, int y, int *hpos, int *vpos,
1960 int *dx, int *dy, int *area)
1961 {
1962 struct glyph *glyph, *end;
1963 struct glyph_row *row = NULL;
1964 int x0, i;
1965
1966 /* Find row containing Y. Give up if some row is not enabled. */
1967 for (i = 0; i < w->current_matrix->nrows; ++i)
1968 {
1969 row = MATRIX_ROW (w->current_matrix, i);
1970 if (!row->enabled_p)
1971 return NULL;
1972 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1973 break;
1974 }
1975
1976 *vpos = i;
1977 *hpos = 0;
1978
1979 /* Give up if Y is not in the window. */
1980 if (i == w->current_matrix->nrows)
1981 return NULL;
1982
1983 /* Get the glyph area containing X. */
1984 if (w->pseudo_window_p)
1985 {
1986 *area = TEXT_AREA;
1987 x0 = 0;
1988 }
1989 else
1990 {
1991 if (x < window_box_left_offset (w, TEXT_AREA))
1992 {
1993 *area = LEFT_MARGIN_AREA;
1994 x0 = window_box_left_offset (w, LEFT_MARGIN_AREA);
1995 }
1996 else if (x < window_box_right_offset (w, TEXT_AREA))
1997 {
1998 *area = TEXT_AREA;
1999 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
2000 }
2001 else
2002 {
2003 *area = RIGHT_MARGIN_AREA;
2004 x0 = window_box_left_offset (w, RIGHT_MARGIN_AREA);
2005 }
2006 }
2007
2008 /* Find glyph containing X. */
2009 glyph = row->glyphs[*area];
2010 end = glyph + row->used[*area];
2011 x -= x0;
2012 while (glyph < end && x >= glyph->pixel_width)
2013 {
2014 x -= glyph->pixel_width;
2015 ++glyph;
2016 }
2017
2018 if (glyph == end)
2019 return NULL;
2020
2021 if (dx)
2022 {
2023 *dx = x;
2024 *dy = y - (row->y + row->ascent - glyph->ascent);
2025 }
2026
2027 *hpos = glyph - row->glyphs[*area];
2028 return glyph;
2029 }
2030
2031 /* Convert frame-relative x/y to coordinates relative to window W.
2032 Takes pseudo-windows into account. */
2033
2034 static void
2035 frame_to_window_pixel_xy (struct window *w, int *x, int *y)
2036 {
2037 if (w->pseudo_window_p)
2038 {
2039 /* A pseudo-window is always full-width, and starts at the
2040 left edge of the frame, plus a frame border. */
2041 struct frame *f = XFRAME (w->frame);
2042 *x -= FRAME_INTERNAL_BORDER_WIDTH (f);
2043 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
2044 }
2045 else
2046 {
2047 *x -= WINDOW_LEFT_EDGE_X (w);
2048 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
2049 }
2050 }
2051
2052 #ifdef HAVE_WINDOW_SYSTEM
2053
2054 /* EXPORT:
2055 Return in RECTS[] at most N clipping rectangles for glyph string S.
2056 Return the number of stored rectangles. */
2057
2058 int
2059 get_glyph_string_clip_rects (struct glyph_string *s, NativeRectangle *rects, int n)
2060 {
2061 XRectangle r;
2062
2063 if (n <= 0)
2064 return 0;
2065
2066 if (s->row->full_width_p)
2067 {
2068 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2069 r.x = WINDOW_LEFT_EDGE_X (s->w);
2070 if (s->row->mode_line_p)
2071 r.width = WINDOW_PIXEL_WIDTH (s->w) - WINDOW_RIGHT_DIVIDER_WIDTH (s->w);
2072 else
2073 r.width = WINDOW_PIXEL_WIDTH (s->w);
2074
2075 /* Unless displaying a mode or menu bar line, which are always
2076 fully visible, clip to the visible part of the row. */
2077 if (s->w->pseudo_window_p)
2078 r.height = s->row->visible_height;
2079 else
2080 r.height = s->height;
2081 }
2082 else
2083 {
2084 /* This is a text line that may be partially visible. */
2085 r.x = window_box_left (s->w, s->area);
2086 r.width = window_box_width (s->w, s->area);
2087 r.height = s->row->visible_height;
2088 }
2089
2090 if (s->clip_head)
2091 if (r.x < s->clip_head->x)
2092 {
2093 if (r.width >= s->clip_head->x - r.x)
2094 r.width -= s->clip_head->x - r.x;
2095 else
2096 r.width = 0;
2097 r.x = s->clip_head->x;
2098 }
2099 if (s->clip_tail)
2100 if (r.x + r.width > s->clip_tail->x + s->clip_tail->background_width)
2101 {
2102 if (s->clip_tail->x + s->clip_tail->background_width >= r.x)
2103 r.width = s->clip_tail->x + s->clip_tail->background_width - r.x;
2104 else
2105 r.width = 0;
2106 }
2107
2108 /* If S draws overlapping rows, it's sufficient to use the top and
2109 bottom of the window for clipping because this glyph string
2110 intentionally draws over other lines. */
2111 if (s->for_overlaps)
2112 {
2113 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2114 r.height = window_text_bottom_y (s->w) - r.y;
2115
2116 /* Alas, the above simple strategy does not work for the
2117 environments with anti-aliased text: if the same text is
2118 drawn onto the same place multiple times, it gets thicker.
2119 If the overlap we are processing is for the erased cursor, we
2120 take the intersection with the rectangle of the cursor. */
2121 if (s->for_overlaps & OVERLAPS_ERASED_CURSOR)
2122 {
2123 XRectangle rc, r_save = r;
2124
2125 rc.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (s->w, s->w->phys_cursor.x);
2126 rc.y = s->w->phys_cursor.y;
2127 rc.width = s->w->phys_cursor_width;
2128 rc.height = s->w->phys_cursor_height;
2129
2130 x_intersect_rectangles (&r_save, &rc, &r);
2131 }
2132 }
2133 else
2134 {
2135 /* Don't use S->y for clipping because it doesn't take partially
2136 visible lines into account. For example, it can be negative for
2137 partially visible lines at the top of a window. */
2138 if (!s->row->full_width_p
2139 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s->w, s->row))
2140 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2141 else
2142 r.y = max (0, s->row->y);
2143 }
2144
2145 r.y = WINDOW_TO_FRAME_PIXEL_Y (s->w, r.y);
2146
2147 /* If drawing the cursor, don't let glyph draw outside its
2148 advertised boundaries. Cleartype does this under some circumstances. */
2149 if (s->hl == DRAW_CURSOR)
2150 {
2151 struct glyph *glyph = s->first_glyph;
2152 int height, max_y;
2153
2154 if (s->x > r.x)
2155 {
2156 r.width -= s->x - r.x;
2157 r.x = s->x;
2158 }
2159 r.width = min (r.width, glyph->pixel_width);
2160
2161 /* If r.y is below window bottom, ensure that we still see a cursor. */
2162 height = min (glyph->ascent + glyph->descent,
2163 min (FRAME_LINE_HEIGHT (s->f), s->row->visible_height));
2164 max_y = window_text_bottom_y (s->w) - height;
2165 max_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, max_y);
2166 if (s->ybase - glyph->ascent > max_y)
2167 {
2168 r.y = max_y;
2169 r.height = height;
2170 }
2171 else
2172 {
2173 /* Don't draw cursor glyph taller than our actual glyph. */
2174 height = max (FRAME_LINE_HEIGHT (s->f), glyph->ascent + glyph->descent);
2175 if (height < r.height)
2176 {
2177 max_y = r.y + r.height;
2178 r.y = min (max_y, max (r.y, s->ybase + glyph->descent - height));
2179 r.height = min (max_y - r.y, height);
2180 }
2181 }
2182 }
2183
2184 if (s->row->clip)
2185 {
2186 XRectangle r_save = r;
2187
2188 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2189 r.width = 0;
2190 }
2191
2192 if ((s->for_overlaps & OVERLAPS_BOTH) == 0
2193 || ((s->for_overlaps & OVERLAPS_BOTH) == OVERLAPS_BOTH && n == 1))
2194 {
2195 #ifdef CONVERT_FROM_XRECT
2196 CONVERT_FROM_XRECT (r, *rects);
2197 #else
2198 *rects = r;
2199 #endif
2200 return 1;
2201 }
2202 else
2203 {
2204 /* If we are processing overlapping and allowed to return
2205 multiple clipping rectangles, we exclude the row of the glyph
2206 string from the clipping rectangle. This is to avoid drawing
2207 the same text on the environment with anti-aliasing. */
2208 #ifdef CONVERT_FROM_XRECT
2209 XRectangle rs[2];
2210 #else
2211 XRectangle *rs = rects;
2212 #endif
2213 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2214
2215 if (s->for_overlaps & OVERLAPS_PRED)
2216 {
2217 rs[i] = r;
2218 if (r.y + r.height > row_y)
2219 {
2220 if (r.y < row_y)
2221 rs[i].height = row_y - r.y;
2222 else
2223 rs[i].height = 0;
2224 }
2225 i++;
2226 }
2227 if (s->for_overlaps & OVERLAPS_SUCC)
2228 {
2229 rs[i] = r;
2230 if (r.y < row_y + s->row->visible_height)
2231 {
2232 if (r.y + r.height > row_y + s->row->visible_height)
2233 {
2234 rs[i].y = row_y + s->row->visible_height;
2235 rs[i].height = r.y + r.height - rs[i].y;
2236 }
2237 else
2238 rs[i].height = 0;
2239 }
2240 i++;
2241 }
2242
2243 n = i;
2244 #ifdef CONVERT_FROM_XRECT
2245 for (i = 0; i < n; i++)
2246 CONVERT_FROM_XRECT (rs[i], rects[i]);
2247 #endif
2248 return n;
2249 }
2250 }
2251
2252 /* EXPORT:
2253 Return in *NR the clipping rectangle for glyph string S. */
2254
2255 void
2256 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2257 {
2258 get_glyph_string_clip_rects (s, nr, 1);
2259 }
2260
2261
2262 /* EXPORT:
2263 Return the position and height of the phys cursor in window W.
2264 Set w->phys_cursor_width to width of phys cursor.
2265 */
2266
2267 void
2268 get_phys_cursor_geometry (struct window *w, struct glyph_row *row,
2269 struct glyph *glyph, int *xp, int *yp, int *heightp)
2270 {
2271 struct frame *f = XFRAME (WINDOW_FRAME (w));
2272 int x, y, wd, h, h0, y0;
2273
2274 /* Compute the width of the rectangle to draw. If on a stretch
2275 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2276 rectangle as wide as the glyph, but use a canonical character
2277 width instead. */
2278 wd = glyph->pixel_width - 1;
2279 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2280 wd++; /* Why? */
2281 #endif
2282
2283 x = w->phys_cursor.x;
2284 if (x < 0)
2285 {
2286 wd += x;
2287 x = 0;
2288 }
2289
2290 if (glyph->type == STRETCH_GLYPH
2291 && !x_stretch_cursor_p)
2292 wd = min (FRAME_COLUMN_WIDTH (f), wd);
2293 w->phys_cursor_width = wd;
2294
2295 y = w->phys_cursor.y + row->ascent - glyph->ascent;
2296
2297 /* If y is below window bottom, ensure that we still see a cursor. */
2298 h0 = min (FRAME_LINE_HEIGHT (f), row->visible_height);
2299
2300 h = max (h0, glyph->ascent + glyph->descent);
2301 h0 = min (h0, glyph->ascent + glyph->descent);
2302
2303 y0 = WINDOW_HEADER_LINE_HEIGHT (w);
2304 if (y < y0)
2305 {
2306 h = max (h - (y0 - y) + 1, h0);
2307 y = y0 - 1;
2308 }
2309 else
2310 {
2311 y0 = window_text_bottom_y (w) - h0;
2312 if (y > y0)
2313 {
2314 h += y - y0;
2315 y = y0;
2316 }
2317 }
2318
2319 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2320 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2321 *heightp = h;
2322 }
2323
2324 /*
2325 * Remember which glyph the mouse is over.
2326 */
2327
2328 void
2329 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2330 {
2331 Lisp_Object window;
2332 struct window *w;
2333 struct glyph_row *r, *gr, *end_row;
2334 enum window_part part;
2335 enum glyph_row_area area;
2336 int x, y, width, height;
2337
2338 /* Try to determine frame pixel position and size of the glyph under
2339 frame pixel coordinates X/Y on frame F. */
2340
2341 if (window_resize_pixelwise)
2342 {
2343 width = height = 1;
2344 goto virtual_glyph;
2345 }
2346 else if (!f->glyphs_initialized_p
2347 || (window = window_from_coordinates (f, gx, gy, &part, 0),
2348 NILP (window)))
2349 {
2350 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2351 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2352 goto virtual_glyph;
2353 }
2354
2355 w = XWINDOW (window);
2356 width = WINDOW_FRAME_COLUMN_WIDTH (w);
2357 height = WINDOW_FRAME_LINE_HEIGHT (w);
2358
2359 x = window_relative_x_coord (w, part, gx);
2360 y = gy - WINDOW_TOP_EDGE_Y (w);
2361
2362 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
2363 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
2364
2365 if (w->pseudo_window_p)
2366 {
2367 area = TEXT_AREA;
2368 part = ON_MODE_LINE; /* Don't adjust margin. */
2369 goto text_glyph;
2370 }
2371
2372 switch (part)
2373 {
2374 case ON_LEFT_MARGIN:
2375 area = LEFT_MARGIN_AREA;
2376 goto text_glyph;
2377
2378 case ON_RIGHT_MARGIN:
2379 area = RIGHT_MARGIN_AREA;
2380 goto text_glyph;
2381
2382 case ON_HEADER_LINE:
2383 case ON_MODE_LINE:
2384 gr = (part == ON_HEADER_LINE
2385 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2386 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2387 gy = gr->y;
2388 area = TEXT_AREA;
2389 goto text_glyph_row_found;
2390
2391 case ON_TEXT:
2392 area = TEXT_AREA;
2393
2394 text_glyph:
2395 gr = 0; gy = 0;
2396 for (; r <= end_row && r->enabled_p; ++r)
2397 if (r->y + r->height > y)
2398 {
2399 gr = r; gy = r->y;
2400 break;
2401 }
2402
2403 text_glyph_row_found:
2404 if (gr && gy <= y)
2405 {
2406 struct glyph *g = gr->glyphs[area];
2407 struct glyph *end = g + gr->used[area];
2408
2409 height = gr->height;
2410 for (gx = gr->x; g < end; gx += g->pixel_width, ++g)
2411 if (gx + g->pixel_width > x)
2412 break;
2413
2414 if (g < end)
2415 {
2416 if (g->type == IMAGE_GLYPH)
2417 {
2418 /* Don't remember when mouse is over image, as
2419 image may have hot-spots. */
2420 STORE_NATIVE_RECT (*rect, 0, 0, 0, 0);
2421 return;
2422 }
2423 width = g->pixel_width;
2424 }
2425 else
2426 {
2427 /* Use nominal char spacing at end of line. */
2428 x -= gx;
2429 gx += (x / width) * width;
2430 }
2431
2432 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2433 {
2434 gx += window_box_left_offset (w, area);
2435 /* Don't expand over the modeline to make sure the vertical
2436 drag cursor is shown early enough. */
2437 height = min (height,
2438 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2439 }
2440 }
2441 else
2442 {
2443 /* Use nominal line height at end of window. */
2444 gx = (x / width) * width;
2445 y -= gy;
2446 gy += (y / height) * height;
2447 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2448 /* See comment above. */
2449 height = min (height,
2450 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2451 }
2452 break;
2453
2454 case ON_LEFT_FRINGE:
2455 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2456 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2457 : window_box_right_offset (w, LEFT_MARGIN_AREA));
2458 width = WINDOW_LEFT_FRINGE_WIDTH (w);
2459 goto row_glyph;
2460
2461 case ON_RIGHT_FRINGE:
2462 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2463 ? window_box_right_offset (w, RIGHT_MARGIN_AREA)
2464 : window_box_right_offset (w, TEXT_AREA));
2465 if (WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
2466 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
2467 && !WINDOW_RIGHTMOST_P (w))
2468 if (gx < WINDOW_PIXEL_WIDTH (w) - width)
2469 /* Make sure the vertical border can get her own glyph to the
2470 right of the one we build here. */
2471 width = WINDOW_RIGHT_FRINGE_WIDTH (w) - width;
2472 else
2473 width = WINDOW_PIXEL_WIDTH (w) - gx;
2474 else
2475 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2476
2477 goto row_glyph;
2478
2479 case ON_VERTICAL_BORDER:
2480 gx = WINDOW_PIXEL_WIDTH (w) - width;
2481 goto row_glyph;
2482
2483 case ON_SCROLL_BAR:
2484 gx = (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
2485 ? 0
2486 : (window_box_right_offset (w, RIGHT_MARGIN_AREA)
2487 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2488 ? WINDOW_RIGHT_FRINGE_WIDTH (w)
2489 : 0)));
2490 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2491
2492 row_glyph:
2493 gr = 0, gy = 0;
2494 for (; r <= end_row && r->enabled_p; ++r)
2495 if (r->y + r->height > y)
2496 {
2497 gr = r; gy = r->y;
2498 break;
2499 }
2500
2501 if (gr && gy <= y)
2502 height = gr->height;
2503 else
2504 {
2505 /* Use nominal line height at end of window. */
2506 y -= gy;
2507 gy += (y / height) * height;
2508 }
2509 break;
2510
2511 case ON_RIGHT_DIVIDER:
2512 gx = WINDOW_PIXEL_WIDTH (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
2513 width = WINDOW_RIGHT_DIVIDER_WIDTH (w);
2514 gy = 0;
2515 /* The bottom divider prevails. */
2516 height = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2517 goto add_edge;;
2518
2519 case ON_BOTTOM_DIVIDER:
2520 gx = 0;
2521 width = WINDOW_PIXEL_WIDTH (w);
2522 gy = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2523 height = WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2524 goto add_edge;
2525
2526 default:
2527 ;
2528 virtual_glyph:
2529 /* If there is no glyph under the mouse, then we divide the screen
2530 into a grid of the smallest glyph in the frame, and use that
2531 as our "glyph". */
2532
2533 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2534 round down even for negative values. */
2535 if (gx < 0)
2536 gx -= width - 1;
2537 if (gy < 0)
2538 gy -= height - 1;
2539
2540 gx = (gx / width) * width;
2541 gy = (gy / height) * height;
2542
2543 goto store_rect;
2544 }
2545
2546 add_edge:
2547 gx += WINDOW_LEFT_EDGE_X (w);
2548 gy += WINDOW_TOP_EDGE_Y (w);
2549
2550 store_rect:
2551 STORE_NATIVE_RECT (*rect, gx, gy, width, height);
2552
2553 /* Visible feedback for debugging. */
2554 #if 0
2555 #if HAVE_X_WINDOWS
2556 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2557 f->output_data.x->normal_gc,
2558 gx, gy, width, height);
2559 #endif
2560 #endif
2561 }
2562
2563
2564 #endif /* HAVE_WINDOW_SYSTEM */
2565
2566 static void
2567 adjust_window_ends (struct window *w, struct glyph_row *row, bool current)
2568 {
2569 eassert (w);
2570 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
2571 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
2572 w->window_end_vpos
2573 = MATRIX_ROW_VPOS (row, current ? w->current_matrix : w->desired_matrix);
2574 }
2575
2576 /***********************************************************************
2577 Lisp form evaluation
2578 ***********************************************************************/
2579
2580 /* Error handler for safe_eval and safe_call. */
2581
2582 static Lisp_Object
2583 safe_eval_handler (Lisp_Object arg, ptrdiff_t nargs, Lisp_Object *args)
2584 {
2585 add_to_log ("Error during redisplay: %S signaled %S",
2586 Flist (nargs, args), arg);
2587 return Qnil;
2588 }
2589
2590 /* Call function FUNC with the rest of NARGS - 1 arguments
2591 following. Return the result, or nil if something went
2592 wrong. Prevent redisplay during the evaluation. */
2593
2594 static Lisp_Object
2595 safe__call (bool inhibit_quit, ptrdiff_t nargs, Lisp_Object func, va_list ap)
2596 {
2597 Lisp_Object val;
2598
2599 if (inhibit_eval_during_redisplay)
2600 val = Qnil;
2601 else
2602 {
2603 ptrdiff_t i;
2604 ptrdiff_t count = SPECPDL_INDEX ();
2605 struct gcpro gcpro1;
2606 Lisp_Object *args = alloca (nargs * word_size);
2607
2608 args[0] = func;
2609 for (i = 1; i < nargs; i++)
2610 args[i] = va_arg (ap, Lisp_Object);
2611
2612 GCPRO1 (args[0]);
2613 gcpro1.nvars = nargs;
2614 specbind (Qinhibit_redisplay, Qt);
2615 if (inhibit_quit)
2616 specbind (Qinhibit_quit, Qt);
2617 /* Use Qt to ensure debugger does not run,
2618 so there is no possibility of wanting to redisplay. */
2619 val = internal_condition_case_n (Ffuncall, nargs, args, Qt,
2620 safe_eval_handler);
2621 UNGCPRO;
2622 val = unbind_to (count, val);
2623 }
2624
2625 return val;
2626 }
2627
2628 Lisp_Object
2629 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2630 {
2631 Lisp_Object retval;
2632 va_list ap;
2633
2634 va_start (ap, func);
2635 retval = safe__call (false, nargs, func, ap);
2636 va_end (ap);
2637 return retval;
2638 }
2639
2640 /* Call function FN with one argument ARG.
2641 Return the result, or nil if something went wrong. */
2642
2643 Lisp_Object
2644 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2645 {
2646 return safe_call (2, fn, arg);
2647 }
2648
2649 static Lisp_Object
2650 safe__call1 (bool inhibit_quit, Lisp_Object fn, ...)
2651 {
2652 Lisp_Object retval;
2653 va_list ap;
2654
2655 va_start (ap, fn);
2656 retval = safe__call (inhibit_quit, 2, fn, ap);
2657 va_end (ap);
2658 return retval;
2659 }
2660
2661 static Lisp_Object Qeval;
2662
2663 Lisp_Object
2664 safe_eval (Lisp_Object sexpr)
2665 {
2666 return safe__call1 (false, Qeval, sexpr);
2667 }
2668
2669 static Lisp_Object
2670 safe__eval (bool inhibit_quit, Lisp_Object sexpr)
2671 {
2672 return safe__call1 (inhibit_quit, Qeval, sexpr);
2673 }
2674
2675 /* Call function FN with two arguments ARG1 and ARG2.
2676 Return the result, or nil if something went wrong. */
2677
2678 Lisp_Object
2679 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2680 {
2681 return safe_call (3, fn, arg1, arg2);
2682 }
2683
2684
2685 \f
2686 /***********************************************************************
2687 Debugging
2688 ***********************************************************************/
2689
2690 #if 0
2691
2692 /* Define CHECK_IT to perform sanity checks on iterators.
2693 This is for debugging. It is too slow to do unconditionally. */
2694
2695 static void
2696 check_it (struct it *it)
2697 {
2698 if (it->method == GET_FROM_STRING)
2699 {
2700 eassert (STRINGP (it->string));
2701 eassert (IT_STRING_CHARPOS (*it) >= 0);
2702 }
2703 else
2704 {
2705 eassert (IT_STRING_CHARPOS (*it) < 0);
2706 if (it->method == GET_FROM_BUFFER)
2707 {
2708 /* Check that character and byte positions agree. */
2709 eassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
2710 }
2711 }
2712
2713 if (it->dpvec)
2714 eassert (it->current.dpvec_index >= 0);
2715 else
2716 eassert (it->current.dpvec_index < 0);
2717 }
2718
2719 #define CHECK_IT(IT) check_it ((IT))
2720
2721 #else /* not 0 */
2722
2723 #define CHECK_IT(IT) (void) 0
2724
2725 #endif /* not 0 */
2726
2727
2728 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2729
2730 /* Check that the window end of window W is what we expect it
2731 to be---the last row in the current matrix displaying text. */
2732
2733 static void
2734 check_window_end (struct window *w)
2735 {
2736 if (!MINI_WINDOW_P (w) && w->window_end_valid)
2737 {
2738 struct glyph_row *row;
2739 eassert ((row = MATRIX_ROW (w->current_matrix, w->window_end_vpos),
2740 !row->enabled_p
2741 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2742 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2743 }
2744 }
2745
2746 #define CHECK_WINDOW_END(W) check_window_end ((W))
2747
2748 #else
2749
2750 #define CHECK_WINDOW_END(W) (void) 0
2751
2752 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2753
2754 /***********************************************************************
2755 Iterator initialization
2756 ***********************************************************************/
2757
2758 /* Initialize IT for displaying current_buffer in window W, starting
2759 at character position CHARPOS. CHARPOS < 0 means that no buffer
2760 position is specified which is useful when the iterator is assigned
2761 a position later. BYTEPOS is the byte position corresponding to
2762 CHARPOS.
2763
2764 If ROW is not null, calls to produce_glyphs with IT as parameter
2765 will produce glyphs in that row.
2766
2767 BASE_FACE_ID is the id of a base face to use. It must be one of
2768 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2769 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2770 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2771
2772 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2773 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2774 will be initialized to use the corresponding mode line glyph row of
2775 the desired matrix of W. */
2776
2777 void
2778 init_iterator (struct it *it, struct window *w,
2779 ptrdiff_t charpos, ptrdiff_t bytepos,
2780 struct glyph_row *row, enum face_id base_face_id)
2781 {
2782 enum face_id remapped_base_face_id = base_face_id;
2783
2784 /* Some precondition checks. */
2785 eassert (w != NULL && it != NULL);
2786 eassert (charpos < 0 || (charpos >= BUF_BEG (current_buffer)
2787 && charpos <= ZV));
2788
2789 /* If face attributes have been changed since the last redisplay,
2790 free realized faces now because they depend on face definitions
2791 that might have changed. Don't free faces while there might be
2792 desired matrices pending which reference these faces. */
2793 if (face_change_count && !inhibit_free_realized_faces)
2794 {
2795 face_change_count = 0;
2796 free_all_realized_faces (Qnil);
2797 }
2798
2799 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2800 if (! NILP (Vface_remapping_alist))
2801 remapped_base_face_id
2802 = lookup_basic_face (XFRAME (w->frame), base_face_id);
2803
2804 /* Use one of the mode line rows of W's desired matrix if
2805 appropriate. */
2806 if (row == NULL)
2807 {
2808 if (base_face_id == MODE_LINE_FACE_ID
2809 || base_face_id == MODE_LINE_INACTIVE_FACE_ID)
2810 row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
2811 else if (base_face_id == HEADER_LINE_FACE_ID)
2812 row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
2813 }
2814
2815 /* Clear IT. */
2816 memset (it, 0, sizeof *it);
2817 it->current.overlay_string_index = -1;
2818 it->current.dpvec_index = -1;
2819 it->base_face_id = remapped_base_face_id;
2820 it->string = Qnil;
2821 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
2822 it->paragraph_embedding = L2R;
2823 it->bidi_it.string.lstring = Qnil;
2824 it->bidi_it.string.s = NULL;
2825 it->bidi_it.string.bufpos = 0;
2826 it->bidi_it.w = w;
2827
2828 /* The window in which we iterate over current_buffer: */
2829 XSETWINDOW (it->window, w);
2830 it->w = w;
2831 it->f = XFRAME (w->frame);
2832
2833 it->cmp_it.id = -1;
2834
2835 /* Extra space between lines (on window systems only). */
2836 if (base_face_id == DEFAULT_FACE_ID
2837 && FRAME_WINDOW_P (it->f))
2838 {
2839 if (NATNUMP (BVAR (current_buffer, extra_line_spacing)))
2840 it->extra_line_spacing = XFASTINT (BVAR (current_buffer, extra_line_spacing));
2841 else if (FLOATP (BVAR (current_buffer, extra_line_spacing)))
2842 it->extra_line_spacing = (XFLOAT_DATA (BVAR (current_buffer, extra_line_spacing))
2843 * FRAME_LINE_HEIGHT (it->f));
2844 else if (it->f->extra_line_spacing > 0)
2845 it->extra_line_spacing = it->f->extra_line_spacing;
2846 it->max_extra_line_spacing = 0;
2847 }
2848
2849 /* If realized faces have been removed, e.g. because of face
2850 attribute changes of named faces, recompute them. When running
2851 in batch mode, the face cache of the initial frame is null. If
2852 we happen to get called, make a dummy face cache. */
2853 if (FRAME_FACE_CACHE (it->f) == NULL)
2854 init_frame_faces (it->f);
2855 if (FRAME_FACE_CACHE (it->f)->used == 0)
2856 recompute_basic_faces (it->f);
2857
2858 /* Current value of the `slice', `space-width', and 'height' properties. */
2859 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
2860 it->space_width = Qnil;
2861 it->font_height = Qnil;
2862 it->override_ascent = -1;
2863
2864 /* Are control characters displayed as `^C'? */
2865 it->ctl_arrow_p = !NILP (BVAR (current_buffer, ctl_arrow));
2866
2867 /* -1 means everything between a CR and the following line end
2868 is invisible. >0 means lines indented more than this value are
2869 invisible. */
2870 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2871 ? (clip_to_bounds
2872 (-1, XINT (BVAR (current_buffer, selective_display)),
2873 PTRDIFF_MAX))
2874 : (!NILP (BVAR (current_buffer, selective_display))
2875 ? -1 : 0));
2876 it->selective_display_ellipsis_p
2877 = !NILP (BVAR (current_buffer, selective_display_ellipses));
2878
2879 /* Display table to use. */
2880 it->dp = window_display_table (w);
2881
2882 /* Are multibyte characters enabled in current_buffer? */
2883 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2884
2885 /* Get the position at which the redisplay_end_trigger hook should
2886 be run, if it is to be run at all. */
2887 if (MARKERP (w->redisplay_end_trigger)
2888 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
2889 it->redisplay_end_trigger_charpos
2890 = marker_position (w->redisplay_end_trigger);
2891 else if (INTEGERP (w->redisplay_end_trigger))
2892 it->redisplay_end_trigger_charpos
2893 = clip_to_bounds (PTRDIFF_MIN, XINT (w->redisplay_end_trigger),
2894 PTRDIFF_MAX);
2895
2896 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2897
2898 /* Are lines in the display truncated? */
2899 if (base_face_id != DEFAULT_FACE_ID
2900 || it->w->hscroll
2901 || (! WINDOW_FULL_WIDTH_P (it->w)
2902 && ((!NILP (Vtruncate_partial_width_windows)
2903 && !INTEGERP (Vtruncate_partial_width_windows))
2904 || (INTEGERP (Vtruncate_partial_width_windows)
2905 /* PXW: Shall we do something about this? */
2906 && (WINDOW_TOTAL_COLS (it->w)
2907 < XINT (Vtruncate_partial_width_windows))))))
2908 it->line_wrap = TRUNCATE;
2909 else if (NILP (BVAR (current_buffer, truncate_lines)))
2910 it->line_wrap = NILP (BVAR (current_buffer, word_wrap))
2911 ? WINDOW_WRAP : WORD_WRAP;
2912 else
2913 it->line_wrap = TRUNCATE;
2914
2915 /* Get dimensions of truncation and continuation glyphs. These are
2916 displayed as fringe bitmaps under X, but we need them for such
2917 frames when the fringes are turned off. But leave the dimensions
2918 zero for tooltip frames, as these glyphs look ugly there and also
2919 sabotage calculations of tooltip dimensions in x-show-tip. */
2920 #ifdef HAVE_WINDOW_SYSTEM
2921 if (!(FRAME_WINDOW_P (it->f)
2922 && FRAMEP (tip_frame)
2923 && it->f == XFRAME (tip_frame)))
2924 #endif
2925 {
2926 if (it->line_wrap == TRUNCATE)
2927 {
2928 /* We will need the truncation glyph. */
2929 eassert (it->glyph_row == NULL);
2930 produce_special_glyphs (it, IT_TRUNCATION);
2931 it->truncation_pixel_width = it->pixel_width;
2932 }
2933 else
2934 {
2935 /* We will need the continuation glyph. */
2936 eassert (it->glyph_row == NULL);
2937 produce_special_glyphs (it, IT_CONTINUATION);
2938 it->continuation_pixel_width = it->pixel_width;
2939 }
2940 }
2941
2942 /* Reset these values to zero because the produce_special_glyphs
2943 above has changed them. */
2944 it->pixel_width = it->ascent = it->descent = 0;
2945 it->phys_ascent = it->phys_descent = 0;
2946
2947 /* Set this after getting the dimensions of truncation and
2948 continuation glyphs, so that we don't produce glyphs when calling
2949 produce_special_glyphs, above. */
2950 it->glyph_row = row;
2951 it->area = TEXT_AREA;
2952
2953 /* Forget any previous info about this row being reversed. */
2954 if (it->glyph_row)
2955 it->glyph_row->reversed_p = 0;
2956
2957 /* Get the dimensions of the display area. The display area
2958 consists of the visible window area plus a horizontally scrolled
2959 part to the left of the window. All x-values are relative to the
2960 start of this total display area. */
2961 if (base_face_id != DEFAULT_FACE_ID)
2962 {
2963 /* Mode lines, menu bar in terminal frames. */
2964 it->first_visible_x = 0;
2965 it->last_visible_x = WINDOW_PIXEL_WIDTH (w);
2966 }
2967 else
2968 {
2969 it->first_visible_x
2970 = window_hscroll_limited (it->w, it->f) * FRAME_COLUMN_WIDTH (it->f);
2971 it->last_visible_x = (it->first_visible_x
2972 + window_box_width (w, TEXT_AREA));
2973
2974 /* If we truncate lines, leave room for the truncation glyph(s) at
2975 the right margin. Otherwise, leave room for the continuation
2976 glyph(s). Done only if the window has no fringes. Since we
2977 don't know at this point whether there will be any R2L lines in
2978 the window, we reserve space for truncation/continuation glyphs
2979 even if only one of the fringes is absent. */
2980 if (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
2981 || (it->bidi_p && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
2982 {
2983 if (it->line_wrap == TRUNCATE)
2984 it->last_visible_x -= it->truncation_pixel_width;
2985 else
2986 it->last_visible_x -= it->continuation_pixel_width;
2987 }
2988
2989 it->header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
2990 it->current_y = WINDOW_HEADER_LINE_HEIGHT (w) + w->vscroll;
2991 }
2992
2993 /* Leave room for a border glyph. */
2994 if (!FRAME_WINDOW_P (it->f)
2995 && !WINDOW_RIGHTMOST_P (it->w))
2996 it->last_visible_x -= 1;
2997
2998 it->last_visible_y = window_text_bottom_y (w);
2999
3000 /* For mode lines and alike, arrange for the first glyph having a
3001 left box line if the face specifies a box. */
3002 if (base_face_id != DEFAULT_FACE_ID)
3003 {
3004 struct face *face;
3005
3006 it->face_id = remapped_base_face_id;
3007
3008 /* If we have a boxed mode line, make the first character appear
3009 with a left box line. */
3010 face = FACE_FROM_ID (it->f, remapped_base_face_id);
3011 if (face && face->box != FACE_NO_BOX)
3012 it->start_of_box_run_p = true;
3013 }
3014
3015 /* If a buffer position was specified, set the iterator there,
3016 getting overlays and face properties from that position. */
3017 if (charpos >= BUF_BEG (current_buffer))
3018 {
3019 it->end_charpos = ZV;
3020 eassert (charpos == BYTE_TO_CHAR (bytepos));
3021 IT_CHARPOS (*it) = charpos;
3022 IT_BYTEPOS (*it) = bytepos;
3023
3024 /* We will rely on `reseat' to set this up properly, via
3025 handle_face_prop. */
3026 it->face_id = it->base_face_id;
3027
3028 it->start = it->current;
3029 /* Do we need to reorder bidirectional text? Not if this is a
3030 unibyte buffer: by definition, none of the single-byte
3031 characters are strong R2L, so no reordering is needed. And
3032 bidi.c doesn't support unibyte buffers anyway. Also, don't
3033 reorder while we are loading loadup.el, since the tables of
3034 character properties needed for reordering are not yet
3035 available. */
3036 it->bidi_p =
3037 NILP (Vpurify_flag)
3038 && !NILP (BVAR (current_buffer, bidi_display_reordering))
3039 && it->multibyte_p;
3040
3041 /* If we are to reorder bidirectional text, init the bidi
3042 iterator. */
3043 if (it->bidi_p)
3044 {
3045 /* Note the paragraph direction that this buffer wants to
3046 use. */
3047 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
3048 Qleft_to_right))
3049 it->paragraph_embedding = L2R;
3050 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
3051 Qright_to_left))
3052 it->paragraph_embedding = R2L;
3053 else
3054 it->paragraph_embedding = NEUTRAL_DIR;
3055 bidi_unshelve_cache (NULL, 0);
3056 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
3057 &it->bidi_it);
3058 }
3059
3060 /* Compute faces etc. */
3061 reseat (it, it->current.pos, 1);
3062 }
3063
3064 CHECK_IT (it);
3065 }
3066
3067
3068 /* Initialize IT for the display of window W with window start POS. */
3069
3070 void
3071 start_display (struct it *it, struct window *w, struct text_pos pos)
3072 {
3073 struct glyph_row *row;
3074 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
3075
3076 row = w->desired_matrix->rows + first_vpos;
3077 init_iterator (it, w, CHARPOS (pos), BYTEPOS (pos), row, DEFAULT_FACE_ID);
3078 it->first_vpos = first_vpos;
3079
3080 /* Don't reseat to previous visible line start if current start
3081 position is in a string or image. */
3082 if (it->method == GET_FROM_BUFFER && it->line_wrap != TRUNCATE)
3083 {
3084 int start_at_line_beg_p;
3085 int first_y = it->current_y;
3086
3087 /* If window start is not at a line start, skip forward to POS to
3088 get the correct continuation lines width. */
3089 start_at_line_beg_p = (CHARPOS (pos) == BEGV
3090 || FETCH_BYTE (BYTEPOS (pos) - 1) == '\n');
3091 if (!start_at_line_beg_p)
3092 {
3093 int new_x;
3094
3095 reseat_at_previous_visible_line_start (it);
3096 move_it_to (it, CHARPOS (pos), -1, -1, -1, MOVE_TO_POS);
3097
3098 new_x = it->current_x + it->pixel_width;
3099
3100 /* If lines are continued, this line may end in the middle
3101 of a multi-glyph character (e.g. a control character
3102 displayed as \003, or in the middle of an overlay
3103 string). In this case move_it_to above will not have
3104 taken us to the start of the continuation line but to the
3105 end of the continued line. */
3106 if (it->current_x > 0
3107 && it->line_wrap != TRUNCATE /* Lines are continued. */
3108 && (/* And glyph doesn't fit on the line. */
3109 new_x > it->last_visible_x
3110 /* Or it fits exactly and we're on a window
3111 system frame. */
3112 || (new_x == it->last_visible_x
3113 && FRAME_WINDOW_P (it->f)
3114 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
3115 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
3116 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
3117 {
3118 if ((it->current.dpvec_index >= 0
3119 || it->current.overlay_string_index >= 0)
3120 /* If we are on a newline from a display vector or
3121 overlay string, then we are already at the end of
3122 a screen line; no need to go to the next line in
3123 that case, as this line is not really continued.
3124 (If we do go to the next line, C-e will not DTRT.) */
3125 && it->c != '\n')
3126 {
3127 set_iterator_to_next (it, 1);
3128 move_it_in_display_line_to (it, -1, -1, 0);
3129 }
3130
3131 it->continuation_lines_width += it->current_x;
3132 }
3133 /* If the character at POS is displayed via a display
3134 vector, move_it_to above stops at the final glyph of
3135 IT->dpvec. To make the caller redisplay that character
3136 again (a.k.a. start at POS), we need to reset the
3137 dpvec_index to the beginning of IT->dpvec. */
3138 else if (it->current.dpvec_index >= 0)
3139 it->current.dpvec_index = 0;
3140
3141 /* We're starting a new display line, not affected by the
3142 height of the continued line, so clear the appropriate
3143 fields in the iterator structure. */
3144 it->max_ascent = it->max_descent = 0;
3145 it->max_phys_ascent = it->max_phys_descent = 0;
3146
3147 it->current_y = first_y;
3148 it->vpos = 0;
3149 it->current_x = it->hpos = 0;
3150 }
3151 }
3152 }
3153
3154
3155 /* Return 1 if POS is a position in ellipses displayed for invisible
3156 text. W is the window we display, for text property lookup. */
3157
3158 static int
3159 in_ellipses_for_invisible_text_p (struct display_pos *pos, struct window *w)
3160 {
3161 Lisp_Object prop, window;
3162 int ellipses_p = 0;
3163 ptrdiff_t charpos = CHARPOS (pos->pos);
3164
3165 /* If POS specifies a position in a display vector, this might
3166 be for an ellipsis displayed for invisible text. We won't
3167 get the iterator set up for delivering that ellipsis unless
3168 we make sure that it gets aware of the invisible text. */
3169 if (pos->dpvec_index >= 0
3170 && pos->overlay_string_index < 0
3171 && CHARPOS (pos->string_pos) < 0
3172 && charpos > BEGV
3173 && (XSETWINDOW (window, w),
3174 prop = Fget_char_property (make_number (charpos),
3175 Qinvisible, window),
3176 !TEXT_PROP_MEANS_INVISIBLE (prop)))
3177 {
3178 prop = Fget_char_property (make_number (charpos - 1), Qinvisible,
3179 window);
3180 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3181 }
3182
3183 return ellipses_p;
3184 }
3185
3186
3187 /* Initialize IT for stepping through current_buffer in window W,
3188 starting at position POS that includes overlay string and display
3189 vector/ control character translation position information. Value
3190 is zero if there are overlay strings with newlines at POS. */
3191
3192 static int
3193 init_from_display_pos (struct it *it, struct window *w, struct display_pos *pos)
3194 {
3195 ptrdiff_t charpos = CHARPOS (pos->pos), bytepos = BYTEPOS (pos->pos);
3196 int i, overlay_strings_with_newlines = 0;
3197
3198 /* If POS specifies a position in a display vector, this might
3199 be for an ellipsis displayed for invisible text. We won't
3200 get the iterator set up for delivering that ellipsis unless
3201 we make sure that it gets aware of the invisible text. */
3202 if (in_ellipses_for_invisible_text_p (pos, w))
3203 {
3204 --charpos;
3205 bytepos = 0;
3206 }
3207
3208 /* Keep in mind: the call to reseat in init_iterator skips invisible
3209 text, so we might end up at a position different from POS. This
3210 is only a problem when POS is a row start after a newline and an
3211 overlay starts there with an after-string, and the overlay has an
3212 invisible property. Since we don't skip invisible text in
3213 display_line and elsewhere immediately after consuming the
3214 newline before the row start, such a POS will not be in a string,
3215 but the call to init_iterator below will move us to the
3216 after-string. */
3217 init_iterator (it, w, charpos, bytepos, NULL, DEFAULT_FACE_ID);
3218
3219 /* This only scans the current chunk -- it should scan all chunks.
3220 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3221 to 16 in 22.1 to make this a lesser problem. */
3222 for (i = 0; i < it->n_overlay_strings && i < OVERLAY_STRING_CHUNK_SIZE; ++i)
3223 {
3224 const char *s = SSDATA (it->overlay_strings[i]);
3225 const char *e = s + SBYTES (it->overlay_strings[i]);
3226
3227 while (s < e && *s != '\n')
3228 ++s;
3229
3230 if (s < e)
3231 {
3232 overlay_strings_with_newlines = 1;
3233 break;
3234 }
3235 }
3236
3237 /* If position is within an overlay string, set up IT to the right
3238 overlay string. */
3239 if (pos->overlay_string_index >= 0)
3240 {
3241 int relative_index;
3242
3243 /* If the first overlay string happens to have a `display'
3244 property for an image, the iterator will be set up for that
3245 image, and we have to undo that setup first before we can
3246 correct the overlay string index. */
3247 if (it->method == GET_FROM_IMAGE)
3248 pop_it (it);
3249
3250 /* We already have the first chunk of overlay strings in
3251 IT->overlay_strings. Load more until the one for
3252 pos->overlay_string_index is in IT->overlay_strings. */
3253 if (pos->overlay_string_index >= OVERLAY_STRING_CHUNK_SIZE)
3254 {
3255 ptrdiff_t n = pos->overlay_string_index / OVERLAY_STRING_CHUNK_SIZE;
3256 it->current.overlay_string_index = 0;
3257 while (n--)
3258 {
3259 load_overlay_strings (it, 0);
3260 it->current.overlay_string_index += OVERLAY_STRING_CHUNK_SIZE;
3261 }
3262 }
3263
3264 it->current.overlay_string_index = pos->overlay_string_index;
3265 relative_index = (it->current.overlay_string_index
3266 % OVERLAY_STRING_CHUNK_SIZE);
3267 it->string = it->overlay_strings[relative_index];
3268 eassert (STRINGP (it->string));
3269 it->current.string_pos = pos->string_pos;
3270 it->method = GET_FROM_STRING;
3271 it->end_charpos = SCHARS (it->string);
3272 /* Set up the bidi iterator for this overlay string. */
3273 if (it->bidi_p)
3274 {
3275 it->bidi_it.string.lstring = it->string;
3276 it->bidi_it.string.s = NULL;
3277 it->bidi_it.string.schars = SCHARS (it->string);
3278 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
3279 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
3280 it->bidi_it.string.unibyte = !it->multibyte_p;
3281 it->bidi_it.w = it->w;
3282 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3283 FRAME_WINDOW_P (it->f), &it->bidi_it);
3284
3285 /* Synchronize the state of the bidi iterator with
3286 pos->string_pos. For any string position other than
3287 zero, this will be done automagically when we resume
3288 iteration over the string and get_visually_first_element
3289 is called. But if string_pos is zero, and the string is
3290 to be reordered for display, we need to resync manually,
3291 since it could be that the iteration state recorded in
3292 pos ended at string_pos of 0 moving backwards in string. */
3293 if (CHARPOS (pos->string_pos) == 0)
3294 {
3295 get_visually_first_element (it);
3296 if (IT_STRING_CHARPOS (*it) != 0)
3297 do {
3298 /* Paranoia. */
3299 eassert (it->bidi_it.charpos < it->bidi_it.string.schars);
3300 bidi_move_to_visually_next (&it->bidi_it);
3301 } while (it->bidi_it.charpos != 0);
3302 }
3303 eassert (IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
3304 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos);
3305 }
3306 }
3307
3308 if (CHARPOS (pos->string_pos) >= 0)
3309 {
3310 /* Recorded position is not in an overlay string, but in another
3311 string. This can only be a string from a `display' property.
3312 IT should already be filled with that string. */
3313 it->current.string_pos = pos->string_pos;
3314 eassert (STRINGP (it->string));
3315 if (it->bidi_p)
3316 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3317 FRAME_WINDOW_P (it->f), &it->bidi_it);
3318 }
3319
3320 /* Restore position in display vector translations, control
3321 character translations or ellipses. */
3322 if (pos->dpvec_index >= 0)
3323 {
3324 if (it->dpvec == NULL)
3325 get_next_display_element (it);
3326 eassert (it->dpvec && it->current.dpvec_index == 0);
3327 it->current.dpvec_index = pos->dpvec_index;
3328 }
3329
3330 CHECK_IT (it);
3331 return !overlay_strings_with_newlines;
3332 }
3333
3334
3335 /* Initialize IT for stepping through current_buffer in window W
3336 starting at ROW->start. */
3337
3338 static void
3339 init_to_row_start (struct it *it, struct window *w, struct glyph_row *row)
3340 {
3341 init_from_display_pos (it, w, &row->start);
3342 it->start = row->start;
3343 it->continuation_lines_width = row->continuation_lines_width;
3344 CHECK_IT (it);
3345 }
3346
3347
3348 /* Initialize IT for stepping through current_buffer in window W
3349 starting in the line following ROW, i.e. starting at ROW->end.
3350 Value is zero if there are overlay strings with newlines at ROW's
3351 end position. */
3352
3353 static int
3354 init_to_row_end (struct it *it, struct window *w, struct glyph_row *row)
3355 {
3356 int success = 0;
3357
3358 if (init_from_display_pos (it, w, &row->end))
3359 {
3360 if (row->continued_p)
3361 it->continuation_lines_width
3362 = row->continuation_lines_width + row->pixel_width;
3363 CHECK_IT (it);
3364 success = 1;
3365 }
3366
3367 return success;
3368 }
3369
3370
3371
3372 \f
3373 /***********************************************************************
3374 Text properties
3375 ***********************************************************************/
3376
3377 /* Called when IT reaches IT->stop_charpos. Handle text property and
3378 overlay changes. Set IT->stop_charpos to the next position where
3379 to stop. */
3380
3381 static void
3382 handle_stop (struct it *it)
3383 {
3384 enum prop_handled handled;
3385 int handle_overlay_change_p;
3386 struct props *p;
3387
3388 it->dpvec = NULL;
3389 it->current.dpvec_index = -1;
3390 handle_overlay_change_p = !it->ignore_overlay_strings_at_pos_p;
3391 it->ignore_overlay_strings_at_pos_p = 0;
3392 it->ellipsis_p = 0;
3393
3394 /* Use face of preceding text for ellipsis (if invisible) */
3395 if (it->selective_display_ellipsis_p)
3396 it->saved_face_id = it->face_id;
3397
3398 do
3399 {
3400 handled = HANDLED_NORMALLY;
3401
3402 /* Call text property handlers. */
3403 for (p = it_props; p->handler; ++p)
3404 {
3405 handled = p->handler (it);
3406
3407 if (handled == HANDLED_RECOMPUTE_PROPS)
3408 break;
3409 else if (handled == HANDLED_RETURN)
3410 {
3411 /* We still want to show before and after strings from
3412 overlays even if the actual buffer text is replaced. */
3413 if (!handle_overlay_change_p
3414 || it->sp > 1
3415 /* Don't call get_overlay_strings_1 if we already
3416 have overlay strings loaded, because doing so
3417 will load them again and push the iterator state
3418 onto the stack one more time, which is not
3419 expected by the rest of the code that processes
3420 overlay strings. */
3421 || (it->current.overlay_string_index < 0
3422 ? !get_overlay_strings_1 (it, 0, 0)
3423 : 0))
3424 {
3425 if (it->ellipsis_p)
3426 setup_for_ellipsis (it, 0);
3427 /* When handling a display spec, we might load an
3428 empty string. In that case, discard it here. We
3429 used to discard it in handle_single_display_spec,
3430 but that causes get_overlay_strings_1, above, to
3431 ignore overlay strings that we must check. */
3432 if (STRINGP (it->string) && !SCHARS (it->string))
3433 pop_it (it);
3434 return;
3435 }
3436 else if (STRINGP (it->string) && !SCHARS (it->string))
3437 pop_it (it);
3438 else
3439 {
3440 it->ignore_overlay_strings_at_pos_p = true;
3441 it->string_from_display_prop_p = 0;
3442 it->from_disp_prop_p = 0;
3443 handle_overlay_change_p = 0;
3444 }
3445 handled = HANDLED_RECOMPUTE_PROPS;
3446 break;
3447 }
3448 else if (handled == HANDLED_OVERLAY_STRING_CONSUMED)
3449 handle_overlay_change_p = 0;
3450 }
3451
3452 if (handled != HANDLED_RECOMPUTE_PROPS)
3453 {
3454 /* Don't check for overlay strings below when set to deliver
3455 characters from a display vector. */
3456 if (it->method == GET_FROM_DISPLAY_VECTOR)
3457 handle_overlay_change_p = 0;
3458
3459 /* Handle overlay changes.
3460 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3461 if it finds overlays. */
3462 if (handle_overlay_change_p)
3463 handled = handle_overlay_change (it);
3464 }
3465
3466 if (it->ellipsis_p)
3467 {
3468 setup_for_ellipsis (it, 0);
3469 break;
3470 }
3471 }
3472 while (handled == HANDLED_RECOMPUTE_PROPS);
3473
3474 /* Determine where to stop next. */
3475 if (handled == HANDLED_NORMALLY)
3476 compute_stop_pos (it);
3477 }
3478
3479
3480 /* Compute IT->stop_charpos from text property and overlay change
3481 information for IT's current position. */
3482
3483 static void
3484 compute_stop_pos (struct it *it)
3485 {
3486 register INTERVAL iv, next_iv;
3487 Lisp_Object object, limit, position;
3488 ptrdiff_t charpos, bytepos;
3489
3490 if (STRINGP (it->string))
3491 {
3492 /* Strings are usually short, so don't limit the search for
3493 properties. */
3494 it->stop_charpos = it->end_charpos;
3495 object = it->string;
3496 limit = Qnil;
3497 charpos = IT_STRING_CHARPOS (*it);
3498 bytepos = IT_STRING_BYTEPOS (*it);
3499 }
3500 else
3501 {
3502 ptrdiff_t pos;
3503
3504 /* If end_charpos is out of range for some reason, such as a
3505 misbehaving display function, rationalize it (Bug#5984). */
3506 if (it->end_charpos > ZV)
3507 it->end_charpos = ZV;
3508 it->stop_charpos = it->end_charpos;
3509
3510 /* If next overlay change is in front of the current stop pos
3511 (which is IT->end_charpos), stop there. Note: value of
3512 next_overlay_change is point-max if no overlay change
3513 follows. */
3514 charpos = IT_CHARPOS (*it);
3515 bytepos = IT_BYTEPOS (*it);
3516 pos = next_overlay_change (charpos);
3517 if (pos < it->stop_charpos)
3518 it->stop_charpos = pos;
3519
3520 /* Set up variables for computing the stop position from text
3521 property changes. */
3522 XSETBUFFER (object, current_buffer);
3523 limit = make_number (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT);
3524 }
3525
3526 /* Get the interval containing IT's position. Value is a null
3527 interval if there isn't such an interval. */
3528 position = make_number (charpos);
3529 iv = validate_interval_range (object, &position, &position, 0);
3530 if (iv)
3531 {
3532 Lisp_Object values_here[LAST_PROP_IDX];
3533 struct props *p;
3534
3535 /* Get properties here. */
3536 for (p = it_props; p->handler; ++p)
3537 values_here[p->idx] = textget (iv->plist, *p->name);
3538
3539 /* Look for an interval following iv that has different
3540 properties. */
3541 for (next_iv = next_interval (iv);
3542 (next_iv
3543 && (NILP (limit)
3544 || XFASTINT (limit) > next_iv->position));
3545 next_iv = next_interval (next_iv))
3546 {
3547 for (p = it_props; p->handler; ++p)
3548 {
3549 Lisp_Object new_value;
3550
3551 new_value = textget (next_iv->plist, *p->name);
3552 if (!EQ (values_here[p->idx], new_value))
3553 break;
3554 }
3555
3556 if (p->handler)
3557 break;
3558 }
3559
3560 if (next_iv)
3561 {
3562 if (INTEGERP (limit)
3563 && next_iv->position >= XFASTINT (limit))
3564 /* No text property change up to limit. */
3565 it->stop_charpos = min (XFASTINT (limit), it->stop_charpos);
3566 else
3567 /* Text properties change in next_iv. */
3568 it->stop_charpos = min (it->stop_charpos, next_iv->position);
3569 }
3570 }
3571
3572 if (it->cmp_it.id < 0)
3573 {
3574 ptrdiff_t stoppos = it->end_charpos;
3575
3576 if (it->bidi_p && it->bidi_it.scan_dir < 0)
3577 stoppos = -1;
3578 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos,
3579 stoppos, it->string);
3580 }
3581
3582 eassert (STRINGP (it->string)
3583 || (it->stop_charpos >= BEGV
3584 && it->stop_charpos >= IT_CHARPOS (*it)));
3585 }
3586
3587
3588 /* Return the position of the next overlay change after POS in
3589 current_buffer. Value is point-max if no overlay change
3590 follows. This is like `next-overlay-change' but doesn't use
3591 xmalloc. */
3592
3593 static ptrdiff_t
3594 next_overlay_change (ptrdiff_t pos)
3595 {
3596 ptrdiff_t i, noverlays;
3597 ptrdiff_t endpos;
3598 Lisp_Object *overlays;
3599
3600 /* Get all overlays at the given position. */
3601 GET_OVERLAYS_AT (pos, overlays, noverlays, &endpos, 1);
3602
3603 /* If any of these overlays ends before endpos,
3604 use its ending point instead. */
3605 for (i = 0; i < noverlays; ++i)
3606 {
3607 Lisp_Object oend;
3608 ptrdiff_t oendpos;
3609
3610 oend = OVERLAY_END (overlays[i]);
3611 oendpos = OVERLAY_POSITION (oend);
3612 endpos = min (endpos, oendpos);
3613 }
3614
3615 return endpos;
3616 }
3617
3618 /* How many characters forward to search for a display property or
3619 display string. Searching too far forward makes the bidi display
3620 sluggish, especially in small windows. */
3621 #define MAX_DISP_SCAN 250
3622
3623 /* Return the character position of a display string at or after
3624 position specified by POSITION. If no display string exists at or
3625 after POSITION, return ZV. A display string is either an overlay
3626 with `display' property whose value is a string, or a `display'
3627 text property whose value is a string. STRING is data about the
3628 string to iterate; if STRING->lstring is nil, we are iterating a
3629 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3630 on a GUI frame. DISP_PROP is set to zero if we searched
3631 MAX_DISP_SCAN characters forward without finding any display
3632 strings, non-zero otherwise. It is set to 2 if the display string
3633 uses any kind of `(space ...)' spec that will produce a stretch of
3634 white space in the text area. */
3635 ptrdiff_t
3636 compute_display_string_pos (struct text_pos *position,
3637 struct bidi_string_data *string,
3638 struct window *w,
3639 int frame_window_p, int *disp_prop)
3640 {
3641 /* OBJECT = nil means current buffer. */
3642 Lisp_Object object, object1;
3643 Lisp_Object pos, spec, limpos;
3644 int string_p = (string && (STRINGP (string->lstring) || string->s));
3645 ptrdiff_t eob = string_p ? string->schars : ZV;
3646 ptrdiff_t begb = string_p ? 0 : BEGV;
3647 ptrdiff_t bufpos, charpos = CHARPOS (*position);
3648 ptrdiff_t lim =
3649 (charpos < eob - MAX_DISP_SCAN) ? charpos + MAX_DISP_SCAN : eob;
3650 struct text_pos tpos;
3651 int rv = 0;
3652
3653 if (string && STRINGP (string->lstring))
3654 object1 = object = string->lstring;
3655 else if (w && !string_p)
3656 {
3657 XSETWINDOW (object, w);
3658 object1 = Qnil;
3659 }
3660 else
3661 object1 = object = Qnil;
3662
3663 *disp_prop = 1;
3664
3665 if (charpos >= eob
3666 /* We don't support display properties whose values are strings
3667 that have display string properties. */
3668 || string->from_disp_str
3669 /* C strings cannot have display properties. */
3670 || (string->s && !STRINGP (object)))
3671 {
3672 *disp_prop = 0;
3673 return eob;
3674 }
3675
3676 /* If the character at CHARPOS is where the display string begins,
3677 return CHARPOS. */
3678 pos = make_number (charpos);
3679 if (STRINGP (object))
3680 bufpos = string->bufpos;
3681 else
3682 bufpos = charpos;
3683 tpos = *position;
3684 if (!NILP (spec = Fget_char_property (pos, Qdisplay, object))
3685 && (charpos <= begb
3686 || !EQ (Fget_char_property (make_number (charpos - 1), Qdisplay,
3687 object),
3688 spec))
3689 && (rv = handle_display_spec (NULL, spec, object, Qnil, &tpos, bufpos,
3690 frame_window_p)))
3691 {
3692 if (rv == 2)
3693 *disp_prop = 2;
3694 return charpos;
3695 }
3696
3697 /* Look forward for the first character with a `display' property
3698 that will replace the underlying text when displayed. */
3699 limpos = make_number (lim);
3700 do {
3701 pos = Fnext_single_char_property_change (pos, Qdisplay, object1, limpos);
3702 CHARPOS (tpos) = XFASTINT (pos);
3703 if (CHARPOS (tpos) >= lim)
3704 {
3705 *disp_prop = 0;
3706 break;
3707 }
3708 if (STRINGP (object))
3709 BYTEPOS (tpos) = string_char_to_byte (object, CHARPOS (tpos));
3710 else
3711 BYTEPOS (tpos) = CHAR_TO_BYTE (CHARPOS (tpos));
3712 spec = Fget_char_property (pos, Qdisplay, object);
3713 if (!STRINGP (object))
3714 bufpos = CHARPOS (tpos);
3715 } while (NILP (spec)
3716 || !(rv = handle_display_spec (NULL, spec, object, Qnil, &tpos,
3717 bufpos, frame_window_p)));
3718 if (rv == 2)
3719 *disp_prop = 2;
3720
3721 return CHARPOS (tpos);
3722 }
3723
3724 /* Return the character position of the end of the display string that
3725 started at CHARPOS. If there's no display string at CHARPOS,
3726 return -1. A display string is either an overlay with `display'
3727 property whose value is a string or a `display' text property whose
3728 value is a string. */
3729 ptrdiff_t
3730 compute_display_string_end (ptrdiff_t charpos, struct bidi_string_data *string)
3731 {
3732 /* OBJECT = nil means current buffer. */
3733 Lisp_Object object =
3734 (string && STRINGP (string->lstring)) ? string->lstring : Qnil;
3735 Lisp_Object pos = make_number (charpos);
3736 ptrdiff_t eob =
3737 (STRINGP (object) || (string && string->s)) ? string->schars : ZV;
3738
3739 if (charpos >= eob || (string->s && !STRINGP (object)))
3740 return eob;
3741
3742 /* It could happen that the display property or overlay was removed
3743 since we found it in compute_display_string_pos above. One way
3744 this can happen is if JIT font-lock was called (through
3745 handle_fontified_prop), and jit-lock-functions remove text
3746 properties or overlays from the portion of buffer that includes
3747 CHARPOS. Muse mode is known to do that, for example. In this
3748 case, we return -1 to the caller, to signal that no display
3749 string is actually present at CHARPOS. See bidi_fetch_char for
3750 how this is handled.
3751
3752 An alternative would be to never look for display properties past
3753 it->stop_charpos. But neither compute_display_string_pos nor
3754 bidi_fetch_char that calls it know or care where the next
3755 stop_charpos is. */
3756 if (NILP (Fget_char_property (pos, Qdisplay, object)))
3757 return -1;
3758
3759 /* Look forward for the first character where the `display' property
3760 changes. */
3761 pos = Fnext_single_char_property_change (pos, Qdisplay, object, Qnil);
3762
3763 return XFASTINT (pos);
3764 }
3765
3766
3767 \f
3768 /***********************************************************************
3769 Fontification
3770 ***********************************************************************/
3771
3772 /* Handle changes in the `fontified' property of the current buffer by
3773 calling hook functions from Qfontification_functions to fontify
3774 regions of text. */
3775
3776 static enum prop_handled
3777 handle_fontified_prop (struct it *it)
3778 {
3779 Lisp_Object prop, pos;
3780 enum prop_handled handled = HANDLED_NORMALLY;
3781
3782 if (!NILP (Vmemory_full))
3783 return handled;
3784
3785 /* Get the value of the `fontified' property at IT's current buffer
3786 position. (The `fontified' property doesn't have a special
3787 meaning in strings.) If the value is nil, call functions from
3788 Qfontification_functions. */
3789 if (!STRINGP (it->string)
3790 && it->s == NULL
3791 && !NILP (Vfontification_functions)
3792 && !NILP (Vrun_hooks)
3793 && (pos = make_number (IT_CHARPOS (*it)),
3794 prop = Fget_char_property (pos, Qfontified, Qnil),
3795 /* Ignore the special cased nil value always present at EOB since
3796 no amount of fontifying will be able to change it. */
3797 NILP (prop) && IT_CHARPOS (*it) < Z))
3798 {
3799 ptrdiff_t count = SPECPDL_INDEX ();
3800 Lisp_Object val;
3801 struct buffer *obuf = current_buffer;
3802 ptrdiff_t begv = BEGV, zv = ZV;
3803 bool old_clip_changed = current_buffer->clip_changed;
3804
3805 val = Vfontification_functions;
3806 specbind (Qfontification_functions, Qnil);
3807
3808 eassert (it->end_charpos == ZV);
3809
3810 if (!CONSP (val) || EQ (XCAR (val), Qlambda))
3811 safe_call1 (val, pos);
3812 else
3813 {
3814 Lisp_Object fns, fn;
3815 struct gcpro gcpro1, gcpro2;
3816
3817 fns = Qnil;
3818 GCPRO2 (val, fns);
3819
3820 for (; CONSP (val); val = XCDR (val))
3821 {
3822 fn = XCAR (val);
3823
3824 if (EQ (fn, Qt))
3825 {
3826 /* A value of t indicates this hook has a local
3827 binding; it means to run the global binding too.
3828 In a global value, t should not occur. If it
3829 does, we must ignore it to avoid an endless
3830 loop. */
3831 for (fns = Fdefault_value (Qfontification_functions);
3832 CONSP (fns);
3833 fns = XCDR (fns))
3834 {
3835 fn = XCAR (fns);
3836 if (!EQ (fn, Qt))
3837 safe_call1 (fn, pos);
3838 }
3839 }
3840 else
3841 safe_call1 (fn, pos);
3842 }
3843
3844 UNGCPRO;
3845 }
3846
3847 unbind_to (count, Qnil);
3848
3849 /* Fontification functions routinely call `save-restriction'.
3850 Normally, this tags clip_changed, which can confuse redisplay
3851 (see discussion in Bug#6671). Since we don't perform any
3852 special handling of fontification changes in the case where
3853 `save-restriction' isn't called, there's no point doing so in
3854 this case either. So, if the buffer's restrictions are
3855 actually left unchanged, reset clip_changed. */
3856 if (obuf == current_buffer)
3857 {
3858 if (begv == BEGV && zv == ZV)
3859 current_buffer->clip_changed = old_clip_changed;
3860 }
3861 /* There isn't much we can reasonably do to protect against
3862 misbehaving fontification, but here's a fig leaf. */
3863 else if (BUFFER_LIVE_P (obuf))
3864 set_buffer_internal_1 (obuf);
3865
3866 /* The fontification code may have added/removed text.
3867 It could do even a lot worse, but let's at least protect against
3868 the most obvious case where only the text past `pos' gets changed',
3869 as is/was done in grep.el where some escapes sequences are turned
3870 into face properties (bug#7876). */
3871 it->end_charpos = ZV;
3872
3873 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3874 something. This avoids an endless loop if they failed to
3875 fontify the text for which reason ever. */
3876 if (!NILP (Fget_char_property (pos, Qfontified, Qnil)))
3877 handled = HANDLED_RECOMPUTE_PROPS;
3878 }
3879
3880 return handled;
3881 }
3882
3883
3884 \f
3885 /***********************************************************************
3886 Faces
3887 ***********************************************************************/
3888
3889 /* Set up iterator IT from face properties at its current position.
3890 Called from handle_stop. */
3891
3892 static enum prop_handled
3893 handle_face_prop (struct it *it)
3894 {
3895 int new_face_id;
3896 ptrdiff_t next_stop;
3897
3898 if (!STRINGP (it->string))
3899 {
3900 new_face_id
3901 = face_at_buffer_position (it->w,
3902 IT_CHARPOS (*it),
3903 &next_stop,
3904 (IT_CHARPOS (*it)
3905 + TEXT_PROP_DISTANCE_LIMIT),
3906 0, it->base_face_id);
3907
3908 /* Is this a start of a run of characters with box face?
3909 Caveat: this can be called for a freshly initialized
3910 iterator; face_id is -1 in this case. We know that the new
3911 face will not change until limit, i.e. if the new face has a
3912 box, all characters up to limit will have one. But, as
3913 usual, we don't know whether limit is really the end. */
3914 if (new_face_id != it->face_id)
3915 {
3916 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3917 /* If it->face_id is -1, old_face below will be NULL, see
3918 the definition of FACE_FROM_ID. This will happen if this
3919 is the initial call that gets the face. */
3920 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
3921
3922 /* If the value of face_id of the iterator is -1, we have to
3923 look in front of IT's position and see whether there is a
3924 face there that's different from new_face_id. */
3925 if (!old_face && IT_CHARPOS (*it) > BEG)
3926 {
3927 int prev_face_id = face_before_it_pos (it);
3928
3929 old_face = FACE_FROM_ID (it->f, prev_face_id);
3930 }
3931
3932 /* If the new face has a box, but the old face does not,
3933 this is the start of a run of characters with box face,
3934 i.e. this character has a shadow on the left side. */
3935 it->start_of_box_run_p = (new_face->box != FACE_NO_BOX
3936 && (old_face == NULL || !old_face->box));
3937 it->face_box_p = new_face->box != FACE_NO_BOX;
3938 }
3939 }
3940 else
3941 {
3942 int base_face_id;
3943 ptrdiff_t bufpos;
3944 int i;
3945 Lisp_Object from_overlay
3946 = (it->current.overlay_string_index >= 0
3947 ? it->string_overlays[it->current.overlay_string_index
3948 % OVERLAY_STRING_CHUNK_SIZE]
3949 : Qnil);
3950
3951 /* See if we got to this string directly or indirectly from
3952 an overlay property. That includes the before-string or
3953 after-string of an overlay, strings in display properties
3954 provided by an overlay, their text properties, etc.
3955
3956 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3957 if (! NILP (from_overlay))
3958 for (i = it->sp - 1; i >= 0; i--)
3959 {
3960 if (it->stack[i].current.overlay_string_index >= 0)
3961 from_overlay
3962 = it->string_overlays[it->stack[i].current.overlay_string_index
3963 % OVERLAY_STRING_CHUNK_SIZE];
3964 else if (! NILP (it->stack[i].from_overlay))
3965 from_overlay = it->stack[i].from_overlay;
3966
3967 if (!NILP (from_overlay))
3968 break;
3969 }
3970
3971 if (! NILP (from_overlay))
3972 {
3973 bufpos = IT_CHARPOS (*it);
3974 /* For a string from an overlay, the base face depends
3975 only on text properties and ignores overlays. */
3976 base_face_id
3977 = face_for_overlay_string (it->w,
3978 IT_CHARPOS (*it),
3979 &next_stop,
3980 (IT_CHARPOS (*it)
3981 + TEXT_PROP_DISTANCE_LIMIT),
3982 0,
3983 from_overlay);
3984 }
3985 else
3986 {
3987 bufpos = 0;
3988
3989 /* For strings from a `display' property, use the face at
3990 IT's current buffer position as the base face to merge
3991 with, so that overlay strings appear in the same face as
3992 surrounding text, unless they specify their own faces.
3993 For strings from wrap-prefix and line-prefix properties,
3994 use the default face, possibly remapped via
3995 Vface_remapping_alist. */
3996 /* Note that the fact that we use the face at _buffer_
3997 position means that a 'display' property on an overlay
3998 string will not inherit the face of that overlay string,
3999 but will instead revert to the face of buffer text
4000 covered by the overlay. This is visible, e.g., when the
4001 overlay specifies a box face, but neither the buffer nor
4002 the display string do. This sounds like a design bug,
4003 but Emacs always did that since v21.1, so changing that
4004 might be a big deal. */
4005 base_face_id = it->string_from_prefix_prop_p
4006 ? (!NILP (Vface_remapping_alist)
4007 ? lookup_basic_face (it->f, DEFAULT_FACE_ID)
4008 : DEFAULT_FACE_ID)
4009 : underlying_face_id (it);
4010 }
4011
4012 new_face_id = face_at_string_position (it->w,
4013 it->string,
4014 IT_STRING_CHARPOS (*it),
4015 bufpos,
4016 &next_stop,
4017 base_face_id, 0);
4018
4019 /* Is this a start of a run of characters with box? Caveat:
4020 this can be called for a freshly allocated iterator; face_id
4021 is -1 is this case. We know that the new face will not
4022 change until the next check pos, i.e. if the new face has a
4023 box, all characters up to that position will have a
4024 box. But, as usual, we don't know whether that position
4025 is really the end. */
4026 if (new_face_id != it->face_id)
4027 {
4028 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
4029 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
4030
4031 /* If new face has a box but old face hasn't, this is the
4032 start of a run of characters with box, i.e. it has a
4033 shadow on the left side. */
4034 it->start_of_box_run_p
4035 = new_face->box && (old_face == NULL || !old_face->box);
4036 it->face_box_p = new_face->box != FACE_NO_BOX;
4037 }
4038 }
4039
4040 it->face_id = new_face_id;
4041 return HANDLED_NORMALLY;
4042 }
4043
4044
4045 /* Return the ID of the face ``underlying'' IT's current position,
4046 which is in a string. If the iterator is associated with a
4047 buffer, return the face at IT's current buffer position.
4048 Otherwise, use the iterator's base_face_id. */
4049
4050 static int
4051 underlying_face_id (struct it *it)
4052 {
4053 int face_id = it->base_face_id, i;
4054
4055 eassert (STRINGP (it->string));
4056
4057 for (i = it->sp - 1; i >= 0; --i)
4058 if (NILP (it->stack[i].string))
4059 face_id = it->stack[i].face_id;
4060
4061 return face_id;
4062 }
4063
4064
4065 /* Compute the face one character before or after the current position
4066 of IT, in the visual order. BEFORE_P non-zero means get the face
4067 in front (to the left in L2R paragraphs, to the right in R2L
4068 paragraphs) of IT's screen position. Value is the ID of the face. */
4069
4070 static int
4071 face_before_or_after_it_pos (struct it *it, int before_p)
4072 {
4073 int face_id, limit;
4074 ptrdiff_t next_check_charpos;
4075 struct it it_copy;
4076 void *it_copy_data = NULL;
4077
4078 eassert (it->s == NULL);
4079
4080 if (STRINGP (it->string))
4081 {
4082 ptrdiff_t bufpos, charpos;
4083 int base_face_id;
4084
4085 /* No face change past the end of the string (for the case
4086 we are padding with spaces). No face change before the
4087 string start. */
4088 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string)
4089 || (IT_STRING_CHARPOS (*it) == 0 && before_p))
4090 return it->face_id;
4091
4092 if (!it->bidi_p)
4093 {
4094 /* Set charpos to the position before or after IT's current
4095 position, in the logical order, which in the non-bidi
4096 case is the same as the visual order. */
4097 if (before_p)
4098 charpos = IT_STRING_CHARPOS (*it) - 1;
4099 else if (it->what == IT_COMPOSITION)
4100 /* For composition, we must check the character after the
4101 composition. */
4102 charpos = IT_STRING_CHARPOS (*it) + it->cmp_it.nchars;
4103 else
4104 charpos = IT_STRING_CHARPOS (*it) + 1;
4105 }
4106 else
4107 {
4108 if (before_p)
4109 {
4110 /* With bidi iteration, the character before the current
4111 in the visual order cannot be found by simple
4112 iteration, because "reverse" reordering is not
4113 supported. Instead, we need to use the move_it_*
4114 family of functions. */
4115 /* Ignore face changes before the first visible
4116 character on this display line. */
4117 if (it->current_x <= it->first_visible_x)
4118 return it->face_id;
4119 SAVE_IT (it_copy, *it, it_copy_data);
4120 /* Implementation note: Since move_it_in_display_line
4121 works in the iterator geometry, and thinks the first
4122 character is always the leftmost, even in R2L lines,
4123 we don't need to distinguish between the R2L and L2R
4124 cases here. */
4125 move_it_in_display_line (&it_copy, SCHARS (it_copy.string),
4126 it_copy.current_x - 1, MOVE_TO_X);
4127 charpos = IT_STRING_CHARPOS (it_copy);
4128 RESTORE_IT (it, it, it_copy_data);
4129 }
4130 else
4131 {
4132 /* Set charpos to the string position of the character
4133 that comes after IT's current position in the visual
4134 order. */
4135 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4136
4137 it_copy = *it;
4138 while (n--)
4139 bidi_move_to_visually_next (&it_copy.bidi_it);
4140
4141 charpos = it_copy.bidi_it.charpos;
4142 }
4143 }
4144 eassert (0 <= charpos && charpos <= SCHARS (it->string));
4145
4146 if (it->current.overlay_string_index >= 0)
4147 bufpos = IT_CHARPOS (*it);
4148 else
4149 bufpos = 0;
4150
4151 base_face_id = underlying_face_id (it);
4152
4153 /* Get the face for ASCII, or unibyte. */
4154 face_id = face_at_string_position (it->w,
4155 it->string,
4156 charpos,
4157 bufpos,
4158 &next_check_charpos,
4159 base_face_id, 0);
4160
4161 /* Correct the face for charsets different from ASCII. Do it
4162 for the multibyte case only. The face returned above is
4163 suitable for unibyte text if IT->string is unibyte. */
4164 if (STRING_MULTIBYTE (it->string))
4165 {
4166 struct text_pos pos1 = string_pos (charpos, it->string);
4167 const unsigned char *p = SDATA (it->string) + BYTEPOS (pos1);
4168 int c, len;
4169 struct face *face = FACE_FROM_ID (it->f, face_id);
4170
4171 c = string_char_and_length (p, &len);
4172 face_id = FACE_FOR_CHAR (it->f, face, c, charpos, it->string);
4173 }
4174 }
4175 else
4176 {
4177 struct text_pos pos;
4178
4179 if ((IT_CHARPOS (*it) >= ZV && !before_p)
4180 || (IT_CHARPOS (*it) <= BEGV && before_p))
4181 return it->face_id;
4182
4183 limit = IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT;
4184 pos = it->current.pos;
4185
4186 if (!it->bidi_p)
4187 {
4188 if (before_p)
4189 DEC_TEXT_POS (pos, it->multibyte_p);
4190 else
4191 {
4192 if (it->what == IT_COMPOSITION)
4193 {
4194 /* For composition, we must check the position after
4195 the composition. */
4196 pos.charpos += it->cmp_it.nchars;
4197 pos.bytepos += it->len;
4198 }
4199 else
4200 INC_TEXT_POS (pos, it->multibyte_p);
4201 }
4202 }
4203 else
4204 {
4205 if (before_p)
4206 {
4207 /* With bidi iteration, the character before the current
4208 in the visual order cannot be found by simple
4209 iteration, because "reverse" reordering is not
4210 supported. Instead, we need to use the move_it_*
4211 family of functions. */
4212 /* Ignore face changes before the first visible
4213 character on this display line. */
4214 if (it->current_x <= it->first_visible_x)
4215 return it->face_id;
4216 SAVE_IT (it_copy, *it, it_copy_data);
4217 /* Implementation note: Since move_it_in_display_line
4218 works in the iterator geometry, and thinks the first
4219 character is always the leftmost, even in R2L lines,
4220 we don't need to distinguish between the R2L and L2R
4221 cases here. */
4222 move_it_in_display_line (&it_copy, ZV,
4223 it_copy.current_x - 1, MOVE_TO_X);
4224 pos = it_copy.current.pos;
4225 RESTORE_IT (it, it, it_copy_data);
4226 }
4227 else
4228 {
4229 /* Set charpos to the buffer position of the character
4230 that comes after IT's current position in the visual
4231 order. */
4232 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4233
4234 it_copy = *it;
4235 while (n--)
4236 bidi_move_to_visually_next (&it_copy.bidi_it);
4237
4238 SET_TEXT_POS (pos,
4239 it_copy.bidi_it.charpos, it_copy.bidi_it.bytepos);
4240 }
4241 }
4242 eassert (BEGV <= CHARPOS (pos) && CHARPOS (pos) <= ZV);
4243
4244 /* Determine face for CHARSET_ASCII, or unibyte. */
4245 face_id = face_at_buffer_position (it->w,
4246 CHARPOS (pos),
4247 &next_check_charpos,
4248 limit, 0, -1);
4249
4250 /* Correct the face for charsets different from ASCII. Do it
4251 for the multibyte case only. The face returned above is
4252 suitable for unibyte text if current_buffer is unibyte. */
4253 if (it->multibyte_p)
4254 {
4255 int c = FETCH_MULTIBYTE_CHAR (BYTEPOS (pos));
4256 struct face *face = FACE_FROM_ID (it->f, face_id);
4257 face_id = FACE_FOR_CHAR (it->f, face, c, CHARPOS (pos), Qnil);
4258 }
4259 }
4260
4261 return face_id;
4262 }
4263
4264
4265 \f
4266 /***********************************************************************
4267 Invisible text
4268 ***********************************************************************/
4269
4270 /* Set up iterator IT from invisible properties at its current
4271 position. Called from handle_stop. */
4272
4273 static enum prop_handled
4274 handle_invisible_prop (struct it *it)
4275 {
4276 enum prop_handled handled = HANDLED_NORMALLY;
4277 int invis_p;
4278 Lisp_Object prop;
4279
4280 if (STRINGP (it->string))
4281 {
4282 Lisp_Object end_charpos, limit, charpos;
4283
4284 /* Get the value of the invisible text property at the
4285 current position. Value will be nil if there is no such
4286 property. */
4287 charpos = make_number (IT_STRING_CHARPOS (*it));
4288 prop = Fget_text_property (charpos, Qinvisible, it->string);
4289 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4290
4291 if (invis_p && IT_STRING_CHARPOS (*it) < it->end_charpos)
4292 {
4293 /* Record whether we have to display an ellipsis for the
4294 invisible text. */
4295 int display_ellipsis_p = (invis_p == 2);
4296 ptrdiff_t len, endpos;
4297
4298 handled = HANDLED_RECOMPUTE_PROPS;
4299
4300 /* Get the position at which the next visible text can be
4301 found in IT->string, if any. */
4302 endpos = len = SCHARS (it->string);
4303 XSETINT (limit, len);
4304 do
4305 {
4306 end_charpos = Fnext_single_property_change (charpos, Qinvisible,
4307 it->string, limit);
4308 if (INTEGERP (end_charpos))
4309 {
4310 endpos = XFASTINT (end_charpos);
4311 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4312 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4313 if (invis_p == 2)
4314 display_ellipsis_p = true;
4315 }
4316 }
4317 while (invis_p && endpos < len);
4318
4319 if (display_ellipsis_p)
4320 it->ellipsis_p = true;
4321
4322 if (endpos < len)
4323 {
4324 /* Text at END_CHARPOS is visible. Move IT there. */
4325 struct text_pos old;
4326 ptrdiff_t oldpos;
4327
4328 old = it->current.string_pos;
4329 oldpos = CHARPOS (old);
4330 if (it->bidi_p)
4331 {
4332 if (it->bidi_it.first_elt
4333 && it->bidi_it.charpos < SCHARS (it->string))
4334 bidi_paragraph_init (it->paragraph_embedding,
4335 &it->bidi_it, 1);
4336 /* Bidi-iterate out of the invisible text. */
4337 do
4338 {
4339 bidi_move_to_visually_next (&it->bidi_it);
4340 }
4341 while (oldpos <= it->bidi_it.charpos
4342 && it->bidi_it.charpos < endpos);
4343
4344 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
4345 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
4346 if (IT_CHARPOS (*it) >= endpos)
4347 it->prev_stop = endpos;
4348 }
4349 else
4350 {
4351 IT_STRING_CHARPOS (*it) = XFASTINT (end_charpos);
4352 compute_string_pos (&it->current.string_pos, old, it->string);
4353 }
4354 }
4355 else
4356 {
4357 /* The rest of the string is invisible. If this is an
4358 overlay string, proceed with the next overlay string
4359 or whatever comes and return a character from there. */
4360 if (it->current.overlay_string_index >= 0
4361 && !display_ellipsis_p)
4362 {
4363 next_overlay_string (it);
4364 /* Don't check for overlay strings when we just
4365 finished processing them. */
4366 handled = HANDLED_OVERLAY_STRING_CONSUMED;
4367 }
4368 else
4369 {
4370 IT_STRING_CHARPOS (*it) = SCHARS (it->string);
4371 IT_STRING_BYTEPOS (*it) = SBYTES (it->string);
4372 }
4373 }
4374 }
4375 }
4376 else
4377 {
4378 ptrdiff_t newpos, next_stop, start_charpos, tem;
4379 Lisp_Object pos, overlay;
4380
4381 /* First of all, is there invisible text at this position? */
4382 tem = start_charpos = IT_CHARPOS (*it);
4383 pos = make_number (tem);
4384 prop = get_char_property_and_overlay (pos, Qinvisible, it->window,
4385 &overlay);
4386 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4387
4388 /* If we are on invisible text, skip over it. */
4389 if (invis_p && start_charpos < it->end_charpos)
4390 {
4391 /* Record whether we have to display an ellipsis for the
4392 invisible text. */
4393 int display_ellipsis_p = invis_p == 2;
4394
4395 handled = HANDLED_RECOMPUTE_PROPS;
4396
4397 /* Loop skipping over invisible text. The loop is left at
4398 ZV or with IT on the first char being visible again. */
4399 do
4400 {
4401 /* Try to skip some invisible text. Return value is the
4402 position reached which can be equal to where we start
4403 if there is nothing invisible there. This skips both
4404 over invisible text properties and overlays with
4405 invisible property. */
4406 newpos = skip_invisible (tem, &next_stop, ZV, it->window);
4407
4408 /* If we skipped nothing at all we weren't at invisible
4409 text in the first place. If everything to the end of
4410 the buffer was skipped, end the loop. */
4411 if (newpos == tem || newpos >= ZV)
4412 invis_p = 0;
4413 else
4414 {
4415 /* We skipped some characters but not necessarily
4416 all there are. Check if we ended up on visible
4417 text. Fget_char_property returns the property of
4418 the char before the given position, i.e. if we
4419 get invis_p = 0, this means that the char at
4420 newpos is visible. */
4421 pos = make_number (newpos);
4422 prop = Fget_char_property (pos, Qinvisible, it->window);
4423 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4424 }
4425
4426 /* If we ended up on invisible text, proceed to
4427 skip starting with next_stop. */
4428 if (invis_p)
4429 tem = next_stop;
4430
4431 /* If there are adjacent invisible texts, don't lose the
4432 second one's ellipsis. */
4433 if (invis_p == 2)
4434 display_ellipsis_p = true;
4435 }
4436 while (invis_p);
4437
4438 /* The position newpos is now either ZV or on visible text. */
4439 if (it->bidi_p)
4440 {
4441 ptrdiff_t bpos = CHAR_TO_BYTE (newpos);
4442 int on_newline
4443 = bpos == ZV_BYTE || FETCH_BYTE (bpos) == '\n';
4444 int after_newline
4445 = newpos <= BEGV || FETCH_BYTE (bpos - 1) == '\n';
4446
4447 /* If the invisible text ends on a newline or on a
4448 character after a newline, we can avoid the costly,
4449 character by character, bidi iteration to NEWPOS, and
4450 instead simply reseat the iterator there. That's
4451 because all bidi reordering information is tossed at
4452 the newline. This is a big win for modes that hide
4453 complete lines, like Outline, Org, etc. */
4454 if (on_newline || after_newline)
4455 {
4456 struct text_pos tpos;
4457 bidi_dir_t pdir = it->bidi_it.paragraph_dir;
4458
4459 SET_TEXT_POS (tpos, newpos, bpos);
4460 reseat_1 (it, tpos, 0);
4461 /* If we reseat on a newline/ZV, we need to prep the
4462 bidi iterator for advancing to the next character
4463 after the newline/EOB, keeping the current paragraph
4464 direction (so that PRODUCE_GLYPHS does TRT wrt
4465 prepending/appending glyphs to a glyph row). */
4466 if (on_newline)
4467 {
4468 it->bidi_it.first_elt = 0;
4469 it->bidi_it.paragraph_dir = pdir;
4470 it->bidi_it.ch = (bpos == ZV_BYTE) ? -1 : '\n';
4471 it->bidi_it.nchars = 1;
4472 it->bidi_it.ch_len = 1;
4473 }
4474 }
4475 else /* Must use the slow method. */
4476 {
4477 /* With bidi iteration, the region of invisible text
4478 could start and/or end in the middle of a
4479 non-base embedding level. Therefore, we need to
4480 skip invisible text using the bidi iterator,
4481 starting at IT's current position, until we find
4482 ourselves outside of the invisible text.
4483 Skipping invisible text _after_ bidi iteration
4484 avoids affecting the visual order of the
4485 displayed text when invisible properties are
4486 added or removed. */
4487 if (it->bidi_it.first_elt && it->bidi_it.charpos < ZV)
4488 {
4489 /* If we were `reseat'ed to a new paragraph,
4490 determine the paragraph base direction. We
4491 need to do it now because
4492 next_element_from_buffer may not have a
4493 chance to do it, if we are going to skip any
4494 text at the beginning, which resets the
4495 FIRST_ELT flag. */
4496 bidi_paragraph_init (it->paragraph_embedding,
4497 &it->bidi_it, 1);
4498 }
4499 do
4500 {
4501 bidi_move_to_visually_next (&it->bidi_it);
4502 }
4503 while (it->stop_charpos <= it->bidi_it.charpos
4504 && it->bidi_it.charpos < newpos);
4505 IT_CHARPOS (*it) = it->bidi_it.charpos;
4506 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
4507 /* If we overstepped NEWPOS, record its position in
4508 the iterator, so that we skip invisible text if
4509 later the bidi iteration lands us in the
4510 invisible region again. */
4511 if (IT_CHARPOS (*it) >= newpos)
4512 it->prev_stop = newpos;
4513 }
4514 }
4515 else
4516 {
4517 IT_CHARPOS (*it) = newpos;
4518 IT_BYTEPOS (*it) = CHAR_TO_BYTE (newpos);
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 it->stack[it->sp - 1].display_ellipsis_p = display_ellipsis_p;
4532 }
4533 else if (display_ellipsis_p)
4534 {
4535 /* Make sure that the glyphs of the ellipsis will get
4536 correct `charpos' values. If we would not update
4537 it->position here, the glyphs would belong to the
4538 last visible character _before_ the invisible
4539 text, which confuses `set_cursor_from_row'.
4540
4541 We use the last invisible position instead of the
4542 first because this way the cursor is always drawn on
4543 the first "." of the ellipsis, whenever PT is inside
4544 the invisible text. Otherwise the cursor would be
4545 placed _after_ the ellipsis when the point is after the
4546 first invisible character. */
4547 if (!STRINGP (it->object))
4548 {
4549 it->position.charpos = newpos - 1;
4550 it->position.bytepos = CHAR_TO_BYTE (it->position.charpos);
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 /* Remember the current face id in case glyphs specify faces.
4591 IT's face is restored in set_iterator_to_next.
4592 saved_face_id was set to preceding char's face in handle_stop. */
4593 if (it->saved_face_id < 0 || it->saved_face_id != it->face_id)
4594 it->saved_face_id = it->face_id = DEFAULT_FACE_ID;
4595
4596 it->method = GET_FROM_DISPLAY_VECTOR;
4597 it->ellipsis_p = true;
4598 }
4599
4600
4601 \f
4602 /***********************************************************************
4603 'display' property
4604 ***********************************************************************/
4605
4606 /* Set up iterator IT from `display' property at its current position.
4607 Called from handle_stop.
4608 We return HANDLED_RETURN if some part of the display property
4609 overrides the display of the buffer text itself.
4610 Otherwise we return HANDLED_NORMALLY. */
4611
4612 static enum prop_handled
4613 handle_display_prop (struct it *it)
4614 {
4615 Lisp_Object propval, object, overlay;
4616 struct text_pos *position;
4617 ptrdiff_t bufpos;
4618 /* Nonzero if some property replaces the display of the text itself. */
4619 int display_replaced_p = 0;
4620
4621 if (STRINGP (it->string))
4622 {
4623 object = it->string;
4624 position = &it->current.string_pos;
4625 bufpos = CHARPOS (it->current.pos);
4626 }
4627 else
4628 {
4629 XSETWINDOW (object, it->w);
4630 position = &it->current.pos;
4631 bufpos = CHARPOS (*position);
4632 }
4633
4634 /* Reset those iterator values set from display property values. */
4635 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
4636 it->space_width = Qnil;
4637 it->font_height = Qnil;
4638 it->voffset = 0;
4639
4640 /* We don't support recursive `display' properties, i.e. string
4641 values that have a string `display' property, that have a string
4642 `display' property etc. */
4643 if (!it->string_from_display_prop_p)
4644 it->area = TEXT_AREA;
4645
4646 propval = get_char_property_and_overlay (make_number (position->charpos),
4647 Qdisplay, object, &overlay);
4648 if (NILP (propval))
4649 return HANDLED_NORMALLY;
4650 /* Now OVERLAY is the overlay that gave us this property, or nil
4651 if it was a text property. */
4652
4653 if (!STRINGP (it->string))
4654 object = it->w->contents;
4655
4656 display_replaced_p = handle_display_spec (it, propval, object, overlay,
4657 position, bufpos,
4658 FRAME_WINDOW_P (it->f));
4659
4660 return display_replaced_p ? HANDLED_RETURN : HANDLED_NORMALLY;
4661 }
4662
4663 /* Subroutine of handle_display_prop. Returns non-zero if the display
4664 specification in SPEC is a replacing specification, i.e. it would
4665 replace the text covered by `display' property with something else,
4666 such as an image or a display string. If SPEC includes any kind or
4667 `(space ...) specification, the value is 2; this is used by
4668 compute_display_string_pos, which see.
4669
4670 See handle_single_display_spec for documentation of arguments.
4671 frame_window_p is non-zero if the window being redisplayed is on a
4672 GUI frame; this argument is used only if IT is NULL, see below.
4673
4674 IT can be NULL, if this is called by the bidi reordering code
4675 through compute_display_string_pos, which see. In that case, this
4676 function only examines SPEC, but does not otherwise "handle" it, in
4677 the sense that it doesn't set up members of IT from the display
4678 spec. */
4679 static int
4680 handle_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4681 Lisp_Object overlay, struct text_pos *position,
4682 ptrdiff_t bufpos, int frame_window_p)
4683 {
4684 int replacing_p = 0;
4685 int rv;
4686
4687 if (CONSP (spec)
4688 /* Simple specifications. */
4689 && !EQ (XCAR (spec), Qimage)
4690 && !EQ (XCAR (spec), Qspace)
4691 && !EQ (XCAR (spec), Qwhen)
4692 && !EQ (XCAR (spec), Qslice)
4693 && !EQ (XCAR (spec), Qspace_width)
4694 && !EQ (XCAR (spec), Qheight)
4695 && !EQ (XCAR (spec), Qraise)
4696 /* Marginal area specifications. */
4697 && !(CONSP (XCAR (spec)) && EQ (XCAR (XCAR (spec)), Qmargin))
4698 && !EQ (XCAR (spec), Qleft_fringe)
4699 && !EQ (XCAR (spec), Qright_fringe)
4700 && !NILP (XCAR (spec)))
4701 {
4702 for (; CONSP (spec); spec = XCDR (spec))
4703 {
4704 if ((rv = handle_single_display_spec (it, XCAR (spec), object,
4705 overlay, position, bufpos,
4706 replacing_p, frame_window_p)))
4707 {
4708 replacing_p = rv;
4709 /* If some text in a string is replaced, `position' no
4710 longer points to the position of `object'. */
4711 if (!it || STRINGP (object))
4712 break;
4713 }
4714 }
4715 }
4716 else if (VECTORP (spec))
4717 {
4718 ptrdiff_t i;
4719 for (i = 0; i < ASIZE (spec); ++i)
4720 if ((rv = handle_single_display_spec (it, AREF (spec, i), object,
4721 overlay, position, bufpos,
4722 replacing_p, frame_window_p)))
4723 {
4724 replacing_p = rv;
4725 /* If some text in a string is replaced, `position' no
4726 longer points to the position of `object'. */
4727 if (!it || STRINGP (object))
4728 break;
4729 }
4730 }
4731 else
4732 {
4733 if ((rv = handle_single_display_spec (it, spec, object, overlay,
4734 position, bufpos, 0,
4735 frame_window_p)))
4736 replacing_p = rv;
4737 }
4738
4739 return replacing_p;
4740 }
4741
4742 /* Value is the position of the end of the `display' property starting
4743 at START_POS in OBJECT. */
4744
4745 static struct text_pos
4746 display_prop_end (struct it *it, Lisp_Object object, struct text_pos start_pos)
4747 {
4748 Lisp_Object end;
4749 struct text_pos end_pos;
4750
4751 end = Fnext_single_char_property_change (make_number (CHARPOS (start_pos)),
4752 Qdisplay, object, Qnil);
4753 CHARPOS (end_pos) = XFASTINT (end);
4754 if (STRINGP (object))
4755 compute_string_pos (&end_pos, start_pos, it->string);
4756 else
4757 BYTEPOS (end_pos) = CHAR_TO_BYTE (XFASTINT (end));
4758
4759 return end_pos;
4760 }
4761
4762
4763 /* Set up IT from a single `display' property specification SPEC. OBJECT
4764 is the object in which the `display' property was found. *POSITION
4765 is the position in OBJECT at which the `display' property was found.
4766 BUFPOS is the buffer position of OBJECT (different from POSITION if
4767 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4768 previously saw a display specification which already replaced text
4769 display with something else, for example an image; we ignore such
4770 properties after the first one has been processed.
4771
4772 OVERLAY is the overlay this `display' property came from,
4773 or nil if it was a text property.
4774
4775 If SPEC is a `space' or `image' specification, and in some other
4776 cases too, set *POSITION to the position where the `display'
4777 property ends.
4778
4779 If IT is NULL, only examine the property specification in SPEC, but
4780 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4781 is intended to be displayed in a window on a GUI frame.
4782
4783 Value is non-zero if something was found which replaces the display
4784 of buffer or string text. */
4785
4786 static int
4787 handle_single_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4788 Lisp_Object overlay, struct text_pos *position,
4789 ptrdiff_t bufpos, int display_replaced_p,
4790 int frame_window_p)
4791 {
4792 Lisp_Object form;
4793 Lisp_Object location, value;
4794 struct text_pos start_pos = *position;
4795 int valid_p;
4796
4797 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4798 If the result is non-nil, use VALUE instead of SPEC. */
4799 form = Qt;
4800 if (CONSP (spec) && EQ (XCAR (spec), Qwhen))
4801 {
4802 spec = XCDR (spec);
4803 if (!CONSP (spec))
4804 return 0;
4805 form = XCAR (spec);
4806 spec = XCDR (spec);
4807 }
4808
4809 if (!NILP (form) && !EQ (form, Qt))
4810 {
4811 ptrdiff_t count = SPECPDL_INDEX ();
4812 struct gcpro gcpro1;
4813
4814 /* Bind `object' to the object having the `display' property, a
4815 buffer or string. Bind `position' to the position in the
4816 object where the property was found, and `buffer-position'
4817 to the current position in the buffer. */
4818
4819 if (NILP (object))
4820 XSETBUFFER (object, current_buffer);
4821 specbind (Qobject, object);
4822 specbind (Qposition, make_number (CHARPOS (*position)));
4823 specbind (Qbuffer_position, make_number (bufpos));
4824 GCPRO1 (form);
4825 form = safe_eval (form);
4826 UNGCPRO;
4827 unbind_to (count, Qnil);
4828 }
4829
4830 if (NILP (form))
4831 return 0;
4832
4833 /* Handle `(height HEIGHT)' specifications. */
4834 if (CONSP (spec)
4835 && EQ (XCAR (spec), Qheight)
4836 && CONSP (XCDR (spec)))
4837 {
4838 if (it)
4839 {
4840 if (!FRAME_WINDOW_P (it->f))
4841 return 0;
4842
4843 it->font_height = XCAR (XCDR (spec));
4844 if (!NILP (it->font_height))
4845 {
4846 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4847 int new_height = -1;
4848
4849 if (CONSP (it->font_height)
4850 && (EQ (XCAR (it->font_height), Qplus)
4851 || EQ (XCAR (it->font_height), Qminus))
4852 && CONSP (XCDR (it->font_height))
4853 && RANGED_INTEGERP (0, XCAR (XCDR (it->font_height)), INT_MAX))
4854 {
4855 /* `(+ N)' or `(- N)' where N is an integer. */
4856 int steps = XINT (XCAR (XCDR (it->font_height)));
4857 if (EQ (XCAR (it->font_height), Qplus))
4858 steps = - steps;
4859 it->face_id = smaller_face (it->f, it->face_id, steps);
4860 }
4861 else if (FUNCTIONP (it->font_height))
4862 {
4863 /* Call function with current height as argument.
4864 Value is the new height. */
4865 Lisp_Object height;
4866 height = safe_call1 (it->font_height,
4867 face->lface[LFACE_HEIGHT_INDEX]);
4868 if (NUMBERP (height))
4869 new_height = XFLOATINT (height);
4870 }
4871 else if (NUMBERP (it->font_height))
4872 {
4873 /* Value is a multiple of the canonical char height. */
4874 struct face *f;
4875
4876 f = FACE_FROM_ID (it->f,
4877 lookup_basic_face (it->f, DEFAULT_FACE_ID));
4878 new_height = (XFLOATINT (it->font_height)
4879 * XINT (f->lface[LFACE_HEIGHT_INDEX]));
4880 }
4881 else
4882 {
4883 /* Evaluate IT->font_height with `height' bound to the
4884 current specified height to get the new height. */
4885 ptrdiff_t count = SPECPDL_INDEX ();
4886
4887 specbind (Qheight, face->lface[LFACE_HEIGHT_INDEX]);
4888 value = safe_eval (it->font_height);
4889 unbind_to (count, Qnil);
4890
4891 if (NUMBERP (value))
4892 new_height = XFLOATINT (value);
4893 }
4894
4895 if (new_height > 0)
4896 it->face_id = face_with_height (it->f, it->face_id, new_height);
4897 }
4898 }
4899
4900 return 0;
4901 }
4902
4903 /* Handle `(space-width WIDTH)'. */
4904 if (CONSP (spec)
4905 && EQ (XCAR (spec), Qspace_width)
4906 && CONSP (XCDR (spec)))
4907 {
4908 if (it)
4909 {
4910 if (!FRAME_WINDOW_P (it->f))
4911 return 0;
4912
4913 value = XCAR (XCDR (spec));
4914 if (NUMBERP (value) && XFLOATINT (value) > 0)
4915 it->space_width = value;
4916 }
4917
4918 return 0;
4919 }
4920
4921 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4922 if (CONSP (spec)
4923 && EQ (XCAR (spec), Qslice))
4924 {
4925 Lisp_Object tem;
4926
4927 if (it)
4928 {
4929 if (!FRAME_WINDOW_P (it->f))
4930 return 0;
4931
4932 if (tem = XCDR (spec), CONSP (tem))
4933 {
4934 it->slice.x = XCAR (tem);
4935 if (tem = XCDR (tem), CONSP (tem))
4936 {
4937 it->slice.y = XCAR (tem);
4938 if (tem = XCDR (tem), CONSP (tem))
4939 {
4940 it->slice.width = XCAR (tem);
4941 if (tem = XCDR (tem), CONSP (tem))
4942 it->slice.height = XCAR (tem);
4943 }
4944 }
4945 }
4946 }
4947
4948 return 0;
4949 }
4950
4951 /* Handle `(raise FACTOR)'. */
4952 if (CONSP (spec)
4953 && EQ (XCAR (spec), Qraise)
4954 && CONSP (XCDR (spec)))
4955 {
4956 if (it)
4957 {
4958 if (!FRAME_WINDOW_P (it->f))
4959 return 0;
4960
4961 #ifdef HAVE_WINDOW_SYSTEM
4962 value = XCAR (XCDR (spec));
4963 if (NUMBERP (value))
4964 {
4965 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4966 it->voffset = - (XFLOATINT (value)
4967 * (FONT_HEIGHT (face->font)));
4968 }
4969 #endif /* HAVE_WINDOW_SYSTEM */
4970 }
4971
4972 return 0;
4973 }
4974
4975 /* Don't handle the other kinds of display specifications
4976 inside a string that we got from a `display' property. */
4977 if (it && it->string_from_display_prop_p)
4978 return 0;
4979
4980 /* Characters having this form of property are not displayed, so
4981 we have to find the end of the property. */
4982 if (it)
4983 {
4984 start_pos = *position;
4985 *position = display_prop_end (it, object, start_pos);
4986 }
4987 value = Qnil;
4988
4989 /* Stop the scan at that end position--we assume that all
4990 text properties change there. */
4991 if (it)
4992 it->stop_charpos = position->charpos;
4993
4994 /* Handle `(left-fringe BITMAP [FACE])'
4995 and `(right-fringe BITMAP [FACE])'. */
4996 if (CONSP (spec)
4997 && (EQ (XCAR (spec), Qleft_fringe)
4998 || EQ (XCAR (spec), Qright_fringe))
4999 && CONSP (XCDR (spec)))
5000 {
5001 int fringe_bitmap;
5002
5003 if (it)
5004 {
5005 if (!FRAME_WINDOW_P (it->f))
5006 /* If we return here, POSITION has been advanced
5007 across the text with this property. */
5008 {
5009 /* Synchronize the bidi iterator with POSITION. This is
5010 needed because we are not going to push the iterator
5011 on behalf of this display property, so there will be
5012 no pop_it call to do this synchronization for us. */
5013 if (it->bidi_p)
5014 {
5015 it->position = *position;
5016 iterate_out_of_display_property (it);
5017 *position = it->position;
5018 }
5019 return 1;
5020 }
5021 }
5022 else if (!frame_window_p)
5023 return 1;
5024
5025 #ifdef HAVE_WINDOW_SYSTEM
5026 value = XCAR (XCDR (spec));
5027 if (!SYMBOLP (value)
5028 || !(fringe_bitmap = lookup_fringe_bitmap (value)))
5029 /* If we return here, POSITION has been advanced
5030 across the text with this property. */
5031 {
5032 if (it && it->bidi_p)
5033 {
5034 it->position = *position;
5035 iterate_out_of_display_property (it);
5036 *position = it->position;
5037 }
5038 return 1;
5039 }
5040
5041 if (it)
5042 {
5043 int face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);;
5044
5045 if (CONSP (XCDR (XCDR (spec))))
5046 {
5047 Lisp_Object face_name = XCAR (XCDR (XCDR (spec)));
5048 int face_id2 = lookup_derived_face (it->f, face_name,
5049 FRINGE_FACE_ID, 0);
5050 if (face_id2 >= 0)
5051 face_id = face_id2;
5052 }
5053
5054 /* Save current settings of IT so that we can restore them
5055 when we are finished with the glyph property value. */
5056 push_it (it, position);
5057
5058 it->area = TEXT_AREA;
5059 it->what = IT_IMAGE;
5060 it->image_id = -1; /* no image */
5061 it->position = start_pos;
5062 it->object = NILP (object) ? it->w->contents : object;
5063 it->method = GET_FROM_IMAGE;
5064 it->from_overlay = Qnil;
5065 it->face_id = face_id;
5066 it->from_disp_prop_p = true;
5067
5068 /* Say that we haven't consumed the characters with
5069 `display' property yet. The call to pop_it in
5070 set_iterator_to_next will clean this up. */
5071 *position = start_pos;
5072
5073 if (EQ (XCAR (spec), Qleft_fringe))
5074 {
5075 it->left_user_fringe_bitmap = fringe_bitmap;
5076 it->left_user_fringe_face_id = face_id;
5077 }
5078 else
5079 {
5080 it->right_user_fringe_bitmap = fringe_bitmap;
5081 it->right_user_fringe_face_id = face_id;
5082 }
5083 }
5084 #endif /* HAVE_WINDOW_SYSTEM */
5085 return 1;
5086 }
5087
5088 /* Prepare to handle `((margin left-margin) ...)',
5089 `((margin right-margin) ...)' and `((margin nil) ...)'
5090 prefixes for display specifications. */
5091 location = Qunbound;
5092 if (CONSP (spec) && CONSP (XCAR (spec)))
5093 {
5094 Lisp_Object tem;
5095
5096 value = XCDR (spec);
5097 if (CONSP (value))
5098 value = XCAR (value);
5099
5100 tem = XCAR (spec);
5101 if (EQ (XCAR (tem), Qmargin)
5102 && (tem = XCDR (tem),
5103 tem = CONSP (tem) ? XCAR (tem) : Qnil,
5104 (NILP (tem)
5105 || EQ (tem, Qleft_margin)
5106 || EQ (tem, Qright_margin))))
5107 location = tem;
5108 }
5109
5110 if (EQ (location, Qunbound))
5111 {
5112 location = Qnil;
5113 value = spec;
5114 }
5115
5116 /* After this point, VALUE is the property after any
5117 margin prefix has been stripped. It must be a string,
5118 an image specification, or `(space ...)'.
5119
5120 LOCATION specifies where to display: `left-margin',
5121 `right-margin' or nil. */
5122
5123 valid_p = (STRINGP (value)
5124 #ifdef HAVE_WINDOW_SYSTEM
5125 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
5126 && valid_image_p (value))
5127 #endif /* not HAVE_WINDOW_SYSTEM */
5128 || (CONSP (value) && EQ (XCAR (value), Qspace)));
5129
5130 if (valid_p && !display_replaced_p)
5131 {
5132 int retval = 1;
5133
5134 if (!it)
5135 {
5136 /* Callers need to know whether the display spec is any kind
5137 of `(space ...)' spec that is about to affect text-area
5138 display. */
5139 if (CONSP (value) && EQ (XCAR (value), Qspace) && NILP (location))
5140 retval = 2;
5141 return retval;
5142 }
5143
5144 /* Save current settings of IT so that we can restore them
5145 when we are finished with the glyph property value. */
5146 push_it (it, position);
5147 it->from_overlay = overlay;
5148 it->from_disp_prop_p = true;
5149
5150 if (NILP (location))
5151 it->area = TEXT_AREA;
5152 else if (EQ (location, Qleft_margin))
5153 it->area = LEFT_MARGIN_AREA;
5154 else
5155 it->area = RIGHT_MARGIN_AREA;
5156
5157 if (STRINGP (value))
5158 {
5159 it->string = value;
5160 it->multibyte_p = STRING_MULTIBYTE (it->string);
5161 it->current.overlay_string_index = -1;
5162 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5163 it->end_charpos = it->string_nchars = SCHARS (it->string);
5164 it->method = GET_FROM_STRING;
5165 it->stop_charpos = 0;
5166 it->prev_stop = 0;
5167 it->base_level_stop = 0;
5168 it->string_from_display_prop_p = true;
5169 /* Say that we haven't consumed the characters with
5170 `display' property yet. The call to pop_it in
5171 set_iterator_to_next will clean this up. */
5172 if (BUFFERP (object))
5173 *position = start_pos;
5174
5175 /* Force paragraph direction to be that of the parent
5176 object. If the parent object's paragraph direction is
5177 not yet determined, default to L2R. */
5178 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5179 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5180 else
5181 it->paragraph_embedding = L2R;
5182
5183 /* Set up the bidi iterator for this display string. */
5184 if (it->bidi_p)
5185 {
5186 it->bidi_it.string.lstring = it->string;
5187 it->bidi_it.string.s = NULL;
5188 it->bidi_it.string.schars = it->end_charpos;
5189 it->bidi_it.string.bufpos = bufpos;
5190 it->bidi_it.string.from_disp_str = 1;
5191 it->bidi_it.string.unibyte = !it->multibyte_p;
5192 it->bidi_it.w = it->w;
5193 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5194 }
5195 }
5196 else if (CONSP (value) && EQ (XCAR (value), Qspace))
5197 {
5198 it->method = GET_FROM_STRETCH;
5199 it->object = value;
5200 *position = it->position = start_pos;
5201 retval = 1 + (it->area == TEXT_AREA);
5202 }
5203 #ifdef HAVE_WINDOW_SYSTEM
5204 else
5205 {
5206 it->what = IT_IMAGE;
5207 it->image_id = lookup_image (it->f, value);
5208 it->position = start_pos;
5209 it->object = NILP (object) ? it->w->contents : object;
5210 it->method = GET_FROM_IMAGE;
5211
5212 /* Say that we haven't consumed the characters with
5213 `display' property yet. The call to pop_it in
5214 set_iterator_to_next will clean this up. */
5215 *position = start_pos;
5216 }
5217 #endif /* HAVE_WINDOW_SYSTEM */
5218
5219 return retval;
5220 }
5221
5222 /* Invalid property or property not supported. Restore
5223 POSITION to what it was before. */
5224 *position = start_pos;
5225 return 0;
5226 }
5227
5228 /* Check if PROP is a display property value whose text should be
5229 treated as intangible. OVERLAY is the overlay from which PROP
5230 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5231 specify the buffer position covered by PROP. */
5232
5233 int
5234 display_prop_intangible_p (Lisp_Object prop, Lisp_Object overlay,
5235 ptrdiff_t charpos, ptrdiff_t bytepos)
5236 {
5237 int frame_window_p = FRAME_WINDOW_P (XFRAME (selected_frame));
5238 struct text_pos position;
5239
5240 SET_TEXT_POS (position, charpos, bytepos);
5241 return handle_display_spec (NULL, prop, Qnil, overlay,
5242 &position, charpos, frame_window_p);
5243 }
5244
5245
5246 /* Return 1 if PROP is a display sub-property value containing STRING.
5247
5248 Implementation note: this and the following function are really
5249 special cases of handle_display_spec and
5250 handle_single_display_spec, and should ideally use the same code.
5251 Until they do, these two pairs must be consistent and must be
5252 modified in sync. */
5253
5254 static int
5255 single_display_spec_string_p (Lisp_Object prop, Lisp_Object string)
5256 {
5257 if (EQ (string, prop))
5258 return 1;
5259
5260 /* Skip over `when FORM'. */
5261 if (CONSP (prop) && EQ (XCAR (prop), Qwhen))
5262 {
5263 prop = XCDR (prop);
5264 if (!CONSP (prop))
5265 return 0;
5266 /* Actually, the condition following `when' should be eval'ed,
5267 like handle_single_display_spec does, and we should return
5268 zero if it evaluates to nil. However, this function is
5269 called only when the buffer was already displayed and some
5270 glyph in the glyph matrix was found to come from a display
5271 string. Therefore, the condition was already evaluated, and
5272 the result was non-nil, otherwise the display string wouldn't
5273 have been displayed and we would have never been called for
5274 this property. Thus, we can skip the evaluation and assume
5275 its result is non-nil. */
5276 prop = XCDR (prop);
5277 }
5278
5279 if (CONSP (prop))
5280 /* Skip over `margin LOCATION'. */
5281 if (EQ (XCAR (prop), Qmargin))
5282 {
5283 prop = XCDR (prop);
5284 if (!CONSP (prop))
5285 return 0;
5286
5287 prop = XCDR (prop);
5288 if (!CONSP (prop))
5289 return 0;
5290 }
5291
5292 return EQ (prop, string) || (CONSP (prop) && EQ (XCAR (prop), string));
5293 }
5294
5295
5296 /* Return 1 if STRING appears in the `display' property PROP. */
5297
5298 static int
5299 display_prop_string_p (Lisp_Object prop, Lisp_Object string)
5300 {
5301 if (CONSP (prop)
5302 && !EQ (XCAR (prop), Qwhen)
5303 && !(CONSP (XCAR (prop)) && EQ (Qmargin, XCAR (XCAR (prop)))))
5304 {
5305 /* A list of sub-properties. */
5306 while (CONSP (prop))
5307 {
5308 if (single_display_spec_string_p (XCAR (prop), string))
5309 return 1;
5310 prop = XCDR (prop);
5311 }
5312 }
5313 else if (VECTORP (prop))
5314 {
5315 /* A vector of sub-properties. */
5316 ptrdiff_t i;
5317 for (i = 0; i < ASIZE (prop); ++i)
5318 if (single_display_spec_string_p (AREF (prop, i), string))
5319 return 1;
5320 }
5321 else
5322 return single_display_spec_string_p (prop, string);
5323
5324 return 0;
5325 }
5326
5327 /* Look for STRING in overlays and text properties in the current
5328 buffer, between character positions FROM and TO (excluding TO).
5329 BACK_P non-zero means look back (in this case, TO is supposed to be
5330 less than FROM).
5331 Value is the first character position where STRING was found, or
5332 zero if it wasn't found before hitting TO.
5333
5334 This function may only use code that doesn't eval because it is
5335 called asynchronously from note_mouse_highlight. */
5336
5337 static ptrdiff_t
5338 string_buffer_position_lim (Lisp_Object string,
5339 ptrdiff_t from, ptrdiff_t to, int back_p)
5340 {
5341 Lisp_Object limit, prop, pos;
5342 int found = 0;
5343
5344 pos = make_number (max (from, BEGV));
5345
5346 if (!back_p) /* looking forward */
5347 {
5348 limit = make_number (min (to, ZV));
5349 while (!found && !EQ (pos, limit))
5350 {
5351 prop = Fget_char_property (pos, Qdisplay, Qnil);
5352 if (!NILP (prop) && display_prop_string_p (prop, string))
5353 found = 1;
5354 else
5355 pos = Fnext_single_char_property_change (pos, Qdisplay, Qnil,
5356 limit);
5357 }
5358 }
5359 else /* looking back */
5360 {
5361 limit = make_number (max (to, BEGV));
5362 while (!found && !EQ (pos, limit))
5363 {
5364 prop = Fget_char_property (pos, Qdisplay, Qnil);
5365 if (!NILP (prop) && display_prop_string_p (prop, string))
5366 found = 1;
5367 else
5368 pos = Fprevious_single_char_property_change (pos, Qdisplay, Qnil,
5369 limit);
5370 }
5371 }
5372
5373 return found ? XINT (pos) : 0;
5374 }
5375
5376 /* Determine which buffer position in current buffer STRING comes from.
5377 AROUND_CHARPOS is an approximate position where it could come from.
5378 Value is the buffer position or 0 if it couldn't be determined.
5379
5380 This function is necessary because we don't record buffer positions
5381 in glyphs generated from strings (to keep struct glyph small).
5382 This function may only use code that doesn't eval because it is
5383 called asynchronously from note_mouse_highlight. */
5384
5385 static ptrdiff_t
5386 string_buffer_position (Lisp_Object string, ptrdiff_t around_charpos)
5387 {
5388 const int MAX_DISTANCE = 1000;
5389 ptrdiff_t found = string_buffer_position_lim (string, around_charpos,
5390 around_charpos + MAX_DISTANCE,
5391 0);
5392
5393 if (!found)
5394 found = string_buffer_position_lim (string, around_charpos,
5395 around_charpos - MAX_DISTANCE, 1);
5396 return found;
5397 }
5398
5399
5400 \f
5401 /***********************************************************************
5402 `composition' property
5403 ***********************************************************************/
5404
5405 /* Set up iterator IT from `composition' property at its current
5406 position. Called from handle_stop. */
5407
5408 static enum prop_handled
5409 handle_composition_prop (struct it *it)
5410 {
5411 Lisp_Object prop, string;
5412 ptrdiff_t pos, pos_byte, start, end;
5413
5414 if (STRINGP (it->string))
5415 {
5416 unsigned char *s;
5417
5418 pos = IT_STRING_CHARPOS (*it);
5419 pos_byte = IT_STRING_BYTEPOS (*it);
5420 string = it->string;
5421 s = SDATA (string) + pos_byte;
5422 it->c = STRING_CHAR (s);
5423 }
5424 else
5425 {
5426 pos = IT_CHARPOS (*it);
5427 pos_byte = IT_BYTEPOS (*it);
5428 string = Qnil;
5429 it->c = FETCH_CHAR (pos_byte);
5430 }
5431
5432 /* If there's a valid composition and point is not inside of the
5433 composition (in the case that the composition is from the current
5434 buffer), draw a glyph composed from the composition components. */
5435 if (find_composition (pos, -1, &start, &end, &prop, string)
5436 && composition_valid_p (start, end, prop)
5437 && (STRINGP (it->string) || (PT <= start || PT >= end)))
5438 {
5439 if (start < pos)
5440 /* As we can't handle this situation (perhaps font-lock added
5441 a new composition), we just return here hoping that next
5442 redisplay will detect this composition much earlier. */
5443 return HANDLED_NORMALLY;
5444 if (start != pos)
5445 {
5446 if (STRINGP (it->string))
5447 pos_byte = string_char_to_byte (it->string, start);
5448 else
5449 pos_byte = CHAR_TO_BYTE (start);
5450 }
5451 it->cmp_it.id = get_composition_id (start, pos_byte, end - start,
5452 prop, string);
5453
5454 if (it->cmp_it.id >= 0)
5455 {
5456 it->cmp_it.ch = -1;
5457 it->cmp_it.nchars = COMPOSITION_LENGTH (prop);
5458 it->cmp_it.nglyphs = -1;
5459 }
5460 }
5461
5462 return HANDLED_NORMALLY;
5463 }
5464
5465
5466 \f
5467 /***********************************************************************
5468 Overlay strings
5469 ***********************************************************************/
5470
5471 /* The following structure is used to record overlay strings for
5472 later sorting in load_overlay_strings. */
5473
5474 struct overlay_entry
5475 {
5476 Lisp_Object overlay;
5477 Lisp_Object string;
5478 EMACS_INT priority;
5479 int after_string_p;
5480 };
5481
5482
5483 /* Set up iterator IT from overlay strings at its current position.
5484 Called from handle_stop. */
5485
5486 static enum prop_handled
5487 handle_overlay_change (struct it *it)
5488 {
5489 if (!STRINGP (it->string) && get_overlay_strings (it, 0))
5490 return HANDLED_RECOMPUTE_PROPS;
5491 else
5492 return HANDLED_NORMALLY;
5493 }
5494
5495
5496 /* Set up the next overlay string for delivery by IT, if there is an
5497 overlay string to deliver. Called by set_iterator_to_next when the
5498 end of the current overlay string is reached. If there are more
5499 overlay strings to display, IT->string and
5500 IT->current.overlay_string_index are set appropriately here.
5501 Otherwise IT->string is set to nil. */
5502
5503 static void
5504 next_overlay_string (struct it *it)
5505 {
5506 ++it->current.overlay_string_index;
5507 if (it->current.overlay_string_index == it->n_overlay_strings)
5508 {
5509 /* No more overlay strings. Restore IT's settings to what
5510 they were before overlay strings were processed, and
5511 continue to deliver from current_buffer. */
5512
5513 it->ellipsis_p = (it->stack[it->sp - 1].display_ellipsis_p != 0);
5514 pop_it (it);
5515 eassert (it->sp > 0
5516 || (NILP (it->string)
5517 && it->method == GET_FROM_BUFFER
5518 && it->stop_charpos >= BEGV
5519 && it->stop_charpos <= it->end_charpos));
5520 it->current.overlay_string_index = -1;
5521 it->n_overlay_strings = 0;
5522 it->overlay_strings_charpos = -1;
5523 /* If there's an empty display string on the stack, pop the
5524 stack, to resync the bidi iterator with IT's position. Such
5525 empty strings are pushed onto the stack in
5526 get_overlay_strings_1. */
5527 if (it->sp > 0 && STRINGP (it->string) && !SCHARS (it->string))
5528 pop_it (it);
5529
5530 /* If we're at the end of the buffer, record that we have
5531 processed the overlay strings there already, so that
5532 next_element_from_buffer doesn't try it again. */
5533 if (NILP (it->string) && IT_CHARPOS (*it) >= it->end_charpos)
5534 it->overlay_strings_at_end_processed_p = true;
5535 }
5536 else
5537 {
5538 /* There are more overlay strings to process. If
5539 IT->current.overlay_string_index has advanced to a position
5540 where we must load IT->overlay_strings with more strings, do
5541 it. We must load at the IT->overlay_strings_charpos where
5542 IT->n_overlay_strings was originally computed; when invisible
5543 text is present, this might not be IT_CHARPOS (Bug#7016). */
5544 int i = it->current.overlay_string_index % OVERLAY_STRING_CHUNK_SIZE;
5545
5546 if (it->current.overlay_string_index && i == 0)
5547 load_overlay_strings (it, it->overlay_strings_charpos);
5548
5549 /* Initialize IT to deliver display elements from the overlay
5550 string. */
5551 it->string = it->overlay_strings[i];
5552 it->multibyte_p = STRING_MULTIBYTE (it->string);
5553 SET_TEXT_POS (it->current.string_pos, 0, 0);
5554 it->method = GET_FROM_STRING;
5555 it->stop_charpos = 0;
5556 it->end_charpos = SCHARS (it->string);
5557 if (it->cmp_it.stop_pos >= 0)
5558 it->cmp_it.stop_pos = 0;
5559 it->prev_stop = 0;
5560 it->base_level_stop = 0;
5561
5562 /* Set up the bidi iterator for this overlay string. */
5563 if (it->bidi_p)
5564 {
5565 it->bidi_it.string.lstring = it->string;
5566 it->bidi_it.string.s = NULL;
5567 it->bidi_it.string.schars = SCHARS (it->string);
5568 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
5569 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5570 it->bidi_it.string.unibyte = !it->multibyte_p;
5571 it->bidi_it.w = it->w;
5572 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5573 }
5574 }
5575
5576 CHECK_IT (it);
5577 }
5578
5579
5580 /* Compare two overlay_entry structures E1 and E2. Used as a
5581 comparison function for qsort in load_overlay_strings. Overlay
5582 strings for the same position are sorted so that
5583
5584 1. All after-strings come in front of before-strings, except
5585 when they come from the same overlay.
5586
5587 2. Within after-strings, strings are sorted so that overlay strings
5588 from overlays with higher priorities come first.
5589
5590 2. Within before-strings, strings are sorted so that overlay
5591 strings from overlays with higher priorities come last.
5592
5593 Value is analogous to strcmp. */
5594
5595
5596 static int
5597 compare_overlay_entries (const void *e1, const void *e2)
5598 {
5599 struct overlay_entry const *entry1 = e1;
5600 struct overlay_entry const *entry2 = e2;
5601 int result;
5602
5603 if (entry1->after_string_p != entry2->after_string_p)
5604 {
5605 /* Let after-strings appear in front of before-strings if
5606 they come from different overlays. */
5607 if (EQ (entry1->overlay, entry2->overlay))
5608 result = entry1->after_string_p ? 1 : -1;
5609 else
5610 result = entry1->after_string_p ? -1 : 1;
5611 }
5612 else if (entry1->priority != entry2->priority)
5613 {
5614 if (entry1->after_string_p)
5615 /* After-strings sorted in order of decreasing priority. */
5616 result = entry2->priority < entry1->priority ? -1 : 1;
5617 else
5618 /* Before-strings sorted in order of increasing priority. */
5619 result = entry1->priority < entry2->priority ? -1 : 1;
5620 }
5621 else
5622 result = 0;
5623
5624 return result;
5625 }
5626
5627
5628 /* Load the vector IT->overlay_strings with overlay strings from IT's
5629 current buffer position, or from CHARPOS if that is > 0. Set
5630 IT->n_overlays to the total number of overlay strings found.
5631
5632 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5633 a time. On entry into load_overlay_strings,
5634 IT->current.overlay_string_index gives the number of overlay
5635 strings that have already been loaded by previous calls to this
5636 function.
5637
5638 IT->add_overlay_start contains an additional overlay start
5639 position to consider for taking overlay strings from, if non-zero.
5640 This position comes into play when the overlay has an `invisible'
5641 property, and both before and after-strings. When we've skipped to
5642 the end of the overlay, because of its `invisible' property, we
5643 nevertheless want its before-string to appear.
5644 IT->add_overlay_start will contain the overlay start position
5645 in this case.
5646
5647 Overlay strings are sorted so that after-string strings come in
5648 front of before-string strings. Within before and after-strings,
5649 strings are sorted by overlay priority. See also function
5650 compare_overlay_entries. */
5651
5652 static void
5653 load_overlay_strings (struct it *it, ptrdiff_t charpos)
5654 {
5655 Lisp_Object overlay, window, str, invisible;
5656 struct Lisp_Overlay *ov;
5657 ptrdiff_t start, end;
5658 ptrdiff_t size = 20;
5659 ptrdiff_t n = 0, i, j;
5660 int invis_p;
5661 struct overlay_entry *entries = alloca (size * sizeof *entries);
5662 USE_SAFE_ALLOCA;
5663
5664 if (charpos <= 0)
5665 charpos = IT_CHARPOS (*it);
5666
5667 /* Append the overlay string STRING of overlay OVERLAY to vector
5668 `entries' which has size `size' and currently contains `n'
5669 elements. AFTER_P non-zero means STRING is an after-string of
5670 OVERLAY. */
5671 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5672 do \
5673 { \
5674 Lisp_Object priority; \
5675 \
5676 if (n == size) \
5677 { \
5678 struct overlay_entry *old = entries; \
5679 SAFE_NALLOCA (entries, 2, size); \
5680 memcpy (entries, old, size * sizeof *entries); \
5681 size *= 2; \
5682 } \
5683 \
5684 entries[n].string = (STRING); \
5685 entries[n].overlay = (OVERLAY); \
5686 priority = Foverlay_get ((OVERLAY), Qpriority); \
5687 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5688 entries[n].after_string_p = (AFTER_P); \
5689 ++n; \
5690 } \
5691 while (0)
5692
5693 /* Process overlay before the overlay center. */
5694 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5695 {
5696 XSETMISC (overlay, ov);
5697 eassert (OVERLAYP (overlay));
5698 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5699 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5700
5701 if (end < charpos)
5702 break;
5703
5704 /* Skip this overlay if it doesn't start or end at IT's current
5705 position. */
5706 if (end != charpos && start != charpos)
5707 continue;
5708
5709 /* Skip this overlay if it doesn't apply to IT->w. */
5710 window = Foverlay_get (overlay, Qwindow);
5711 if (WINDOWP (window) && XWINDOW (window) != it->w)
5712 continue;
5713
5714 /* If the text ``under'' the overlay is invisible, both before-
5715 and after-strings from this overlay are visible; start and
5716 end position are indistinguishable. */
5717 invisible = Foverlay_get (overlay, Qinvisible);
5718 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5719
5720 /* If overlay has a non-empty before-string, record it. */
5721 if ((start == charpos || (end == charpos && invis_p))
5722 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5723 && SCHARS (str))
5724 RECORD_OVERLAY_STRING (overlay, str, 0);
5725
5726 /* If overlay has a non-empty after-string, record it. */
5727 if ((end == charpos || (start == charpos && invis_p))
5728 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5729 && SCHARS (str))
5730 RECORD_OVERLAY_STRING (overlay, str, 1);
5731 }
5732
5733 /* Process overlays after the overlay center. */
5734 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5735 {
5736 XSETMISC (overlay, ov);
5737 eassert (OVERLAYP (overlay));
5738 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5739 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5740
5741 if (start > charpos)
5742 break;
5743
5744 /* Skip this overlay if it doesn't start or end at IT's current
5745 position. */
5746 if (end != charpos && start != charpos)
5747 continue;
5748
5749 /* Skip this overlay if it doesn't apply to IT->w. */
5750 window = Foverlay_get (overlay, Qwindow);
5751 if (WINDOWP (window) && XWINDOW (window) != it->w)
5752 continue;
5753
5754 /* If the text ``under'' the overlay is invisible, it has a zero
5755 dimension, and both before- and after-strings apply. */
5756 invisible = Foverlay_get (overlay, Qinvisible);
5757 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5758
5759 /* If overlay has a non-empty before-string, record it. */
5760 if ((start == charpos || (end == charpos && invis_p))
5761 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5762 && SCHARS (str))
5763 RECORD_OVERLAY_STRING (overlay, str, 0);
5764
5765 /* If overlay has a non-empty after-string, record it. */
5766 if ((end == charpos || (start == charpos && invis_p))
5767 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5768 && SCHARS (str))
5769 RECORD_OVERLAY_STRING (overlay, str, 1);
5770 }
5771
5772 #undef RECORD_OVERLAY_STRING
5773
5774 /* Sort entries. */
5775 if (n > 1)
5776 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5777
5778 /* Record number of overlay strings, and where we computed it. */
5779 it->n_overlay_strings = n;
5780 it->overlay_strings_charpos = charpos;
5781
5782 /* IT->current.overlay_string_index is the number of overlay strings
5783 that have already been consumed by IT. Copy some of the
5784 remaining overlay strings to IT->overlay_strings. */
5785 i = 0;
5786 j = it->current.overlay_string_index;
5787 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5788 {
5789 it->overlay_strings[i] = entries[j].string;
5790 it->string_overlays[i++] = entries[j++].overlay;
5791 }
5792
5793 CHECK_IT (it);
5794 SAFE_FREE ();
5795 }
5796
5797
5798 /* Get the first chunk of overlay strings at IT's current buffer
5799 position, or at CHARPOS if that is > 0. Value is non-zero if at
5800 least one overlay string was found. */
5801
5802 static int
5803 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, int compute_stop_p)
5804 {
5805 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5806 process. This fills IT->overlay_strings with strings, and sets
5807 IT->n_overlay_strings to the total number of strings to process.
5808 IT->pos.overlay_string_index has to be set temporarily to zero
5809 because load_overlay_strings needs this; it must be set to -1
5810 when no overlay strings are found because a zero value would
5811 indicate a position in the first overlay string. */
5812 it->current.overlay_string_index = 0;
5813 load_overlay_strings (it, charpos);
5814
5815 /* If we found overlay strings, set up IT to deliver display
5816 elements from the first one. Otherwise set up IT to deliver
5817 from current_buffer. */
5818 if (it->n_overlay_strings)
5819 {
5820 /* Make sure we know settings in current_buffer, so that we can
5821 restore meaningful values when we're done with the overlay
5822 strings. */
5823 if (compute_stop_p)
5824 compute_stop_pos (it);
5825 eassert (it->face_id >= 0);
5826
5827 /* Save IT's settings. They are restored after all overlay
5828 strings have been processed. */
5829 eassert (!compute_stop_p || it->sp == 0);
5830
5831 /* When called from handle_stop, there might be an empty display
5832 string loaded. In that case, don't bother saving it. But
5833 don't use this optimization with the bidi iterator, since we
5834 need the corresponding pop_it call to resync the bidi
5835 iterator's position with IT's position, after we are done
5836 with the overlay strings. (The corresponding call to pop_it
5837 in case of an empty display string is in
5838 next_overlay_string.) */
5839 if (!(!it->bidi_p
5840 && STRINGP (it->string) && !SCHARS (it->string)))
5841 push_it (it, NULL);
5842
5843 /* Set up IT to deliver display elements from the first overlay
5844 string. */
5845 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5846 it->string = it->overlay_strings[0];
5847 it->from_overlay = Qnil;
5848 it->stop_charpos = 0;
5849 eassert (STRINGP (it->string));
5850 it->end_charpos = SCHARS (it->string);
5851 it->prev_stop = 0;
5852 it->base_level_stop = 0;
5853 it->multibyte_p = STRING_MULTIBYTE (it->string);
5854 it->method = GET_FROM_STRING;
5855 it->from_disp_prop_p = 0;
5856
5857 /* Force paragraph direction to be that of the parent
5858 buffer. */
5859 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5860 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5861 else
5862 it->paragraph_embedding = L2R;
5863
5864 /* Set up the bidi iterator for this overlay string. */
5865 if (it->bidi_p)
5866 {
5867 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5868
5869 it->bidi_it.string.lstring = it->string;
5870 it->bidi_it.string.s = NULL;
5871 it->bidi_it.string.schars = SCHARS (it->string);
5872 it->bidi_it.string.bufpos = pos;
5873 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5874 it->bidi_it.string.unibyte = !it->multibyte_p;
5875 it->bidi_it.w = it->w;
5876 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5877 }
5878 return 1;
5879 }
5880
5881 it->current.overlay_string_index = -1;
5882 return 0;
5883 }
5884
5885 static int
5886 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5887 {
5888 it->string = Qnil;
5889 it->method = GET_FROM_BUFFER;
5890
5891 (void) get_overlay_strings_1 (it, charpos, 1);
5892
5893 CHECK_IT (it);
5894
5895 /* Value is non-zero if we found at least one overlay string. */
5896 return STRINGP (it->string);
5897 }
5898
5899
5900 \f
5901 /***********************************************************************
5902 Saving and restoring state
5903 ***********************************************************************/
5904
5905 /* Save current settings of IT on IT->stack. Called, for example,
5906 before setting up IT for an overlay string, to be able to restore
5907 IT's settings to what they were after the overlay string has been
5908 processed. If POSITION is non-NULL, it is the position to save on
5909 the stack instead of IT->position. */
5910
5911 static void
5912 push_it (struct it *it, struct text_pos *position)
5913 {
5914 struct iterator_stack_entry *p;
5915
5916 eassert (it->sp < IT_STACK_SIZE);
5917 p = it->stack + it->sp;
5918
5919 p->stop_charpos = it->stop_charpos;
5920 p->prev_stop = it->prev_stop;
5921 p->base_level_stop = it->base_level_stop;
5922 p->cmp_it = it->cmp_it;
5923 eassert (it->face_id >= 0);
5924 p->face_id = it->face_id;
5925 p->string = it->string;
5926 p->method = it->method;
5927 p->from_overlay = it->from_overlay;
5928 switch (p->method)
5929 {
5930 case GET_FROM_IMAGE:
5931 p->u.image.object = it->object;
5932 p->u.image.image_id = it->image_id;
5933 p->u.image.slice = it->slice;
5934 break;
5935 case GET_FROM_STRETCH:
5936 p->u.stretch.object = it->object;
5937 break;
5938 }
5939 p->position = position ? *position : it->position;
5940 p->current = it->current;
5941 p->end_charpos = it->end_charpos;
5942 p->string_nchars = it->string_nchars;
5943 p->area = it->area;
5944 p->multibyte_p = it->multibyte_p;
5945 p->avoid_cursor_p = it->avoid_cursor_p;
5946 p->space_width = it->space_width;
5947 p->font_height = it->font_height;
5948 p->voffset = it->voffset;
5949 p->string_from_display_prop_p = it->string_from_display_prop_p;
5950 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
5951 p->display_ellipsis_p = 0;
5952 p->line_wrap = it->line_wrap;
5953 p->bidi_p = it->bidi_p;
5954 p->paragraph_embedding = it->paragraph_embedding;
5955 p->from_disp_prop_p = it->from_disp_prop_p;
5956 ++it->sp;
5957
5958 /* Save the state of the bidi iterator as well. */
5959 if (it->bidi_p)
5960 bidi_push_it (&it->bidi_it);
5961 }
5962
5963 static void
5964 iterate_out_of_display_property (struct it *it)
5965 {
5966 int buffer_p = !STRINGP (it->string);
5967 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
5968 ptrdiff_t bob = (buffer_p ? BEGV : 0);
5969
5970 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
5971
5972 /* Maybe initialize paragraph direction. If we are at the beginning
5973 of a new paragraph, next_element_from_buffer may not have a
5974 chance to do that. */
5975 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
5976 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
5977 /* prev_stop can be zero, so check against BEGV as well. */
5978 while (it->bidi_it.charpos >= bob
5979 && it->prev_stop <= it->bidi_it.charpos
5980 && it->bidi_it.charpos < CHARPOS (it->position)
5981 && it->bidi_it.charpos < eob)
5982 bidi_move_to_visually_next (&it->bidi_it);
5983 /* Record the stop_pos we just crossed, for when we cross it
5984 back, maybe. */
5985 if (it->bidi_it.charpos > CHARPOS (it->position))
5986 it->prev_stop = CHARPOS (it->position);
5987 /* If we ended up not where pop_it put us, resync IT's
5988 positional members with the bidi iterator. */
5989 if (it->bidi_it.charpos != CHARPOS (it->position))
5990 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
5991 if (buffer_p)
5992 it->current.pos = it->position;
5993 else
5994 it->current.string_pos = it->position;
5995 }
5996
5997 /* Restore IT's settings from IT->stack. Called, for example, when no
5998 more overlay strings must be processed, and we return to delivering
5999 display elements from a buffer, or when the end of a string from a
6000 `display' property is reached and we return to delivering display
6001 elements from an overlay string, or from a buffer. */
6002
6003 static void
6004 pop_it (struct it *it)
6005 {
6006 struct iterator_stack_entry *p;
6007 int from_display_prop = it->from_disp_prop_p;
6008
6009 eassert (it->sp > 0);
6010 --it->sp;
6011 p = it->stack + it->sp;
6012 it->stop_charpos = p->stop_charpos;
6013 it->prev_stop = p->prev_stop;
6014 it->base_level_stop = p->base_level_stop;
6015 it->cmp_it = p->cmp_it;
6016 it->face_id = p->face_id;
6017 it->current = p->current;
6018 it->position = p->position;
6019 it->string = p->string;
6020 it->from_overlay = p->from_overlay;
6021 if (NILP (it->string))
6022 SET_TEXT_POS (it->current.string_pos, -1, -1);
6023 it->method = p->method;
6024 switch (it->method)
6025 {
6026 case GET_FROM_IMAGE:
6027 it->image_id = p->u.image.image_id;
6028 it->object = p->u.image.object;
6029 it->slice = p->u.image.slice;
6030 break;
6031 case GET_FROM_STRETCH:
6032 it->object = p->u.stretch.object;
6033 break;
6034 case GET_FROM_BUFFER:
6035 it->object = it->w->contents;
6036 break;
6037 case GET_FROM_STRING:
6038 {
6039 struct face *face = FACE_FROM_ID (it->f, it->face_id);
6040
6041 /* Restore the face_box_p flag, since it could have been
6042 overwritten by the face of the object that we just finished
6043 displaying. */
6044 if (face)
6045 it->face_box_p = face->box != FACE_NO_BOX;
6046 it->object = it->string;
6047 }
6048 break;
6049 case GET_FROM_DISPLAY_VECTOR:
6050 if (it->s)
6051 it->method = GET_FROM_C_STRING;
6052 else if (STRINGP (it->string))
6053 it->method = GET_FROM_STRING;
6054 else
6055 {
6056 it->method = GET_FROM_BUFFER;
6057 it->object = it->w->contents;
6058 }
6059 }
6060 it->end_charpos = p->end_charpos;
6061 it->string_nchars = p->string_nchars;
6062 it->area = p->area;
6063 it->multibyte_p = p->multibyte_p;
6064 it->avoid_cursor_p = p->avoid_cursor_p;
6065 it->space_width = p->space_width;
6066 it->font_height = p->font_height;
6067 it->voffset = p->voffset;
6068 it->string_from_display_prop_p = p->string_from_display_prop_p;
6069 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
6070 it->line_wrap = p->line_wrap;
6071 it->bidi_p = p->bidi_p;
6072 it->paragraph_embedding = p->paragraph_embedding;
6073 it->from_disp_prop_p = p->from_disp_prop_p;
6074 if (it->bidi_p)
6075 {
6076 bidi_pop_it (&it->bidi_it);
6077 /* Bidi-iterate until we get out of the portion of text, if any,
6078 covered by a `display' text property or by an overlay with
6079 `display' property. (We cannot just jump there, because the
6080 internal coherency of the bidi iterator state can not be
6081 preserved across such jumps.) We also must determine the
6082 paragraph base direction if the overlay we just processed is
6083 at the beginning of a new paragraph. */
6084 if (from_display_prop
6085 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
6086 iterate_out_of_display_property (it);
6087
6088 eassert ((BUFFERP (it->object)
6089 && IT_CHARPOS (*it) == it->bidi_it.charpos
6090 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
6091 || (STRINGP (it->object)
6092 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
6093 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
6094 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
6095 }
6096 }
6097
6098
6099 \f
6100 /***********************************************************************
6101 Moving over lines
6102 ***********************************************************************/
6103
6104 /* Set IT's current position to the previous line start. */
6105
6106 static void
6107 back_to_previous_line_start (struct it *it)
6108 {
6109 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
6110
6111 DEC_BOTH (cp, bp);
6112 IT_CHARPOS (*it) = find_newline_no_quit (cp, bp, -1, &IT_BYTEPOS (*it));
6113 }
6114
6115
6116 /* Move IT to the next line start.
6117
6118 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6119 we skipped over part of the text (as opposed to moving the iterator
6120 continuously over the text). Otherwise, don't change the value
6121 of *SKIPPED_P.
6122
6123 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6124 iterator on the newline, if it was found.
6125
6126 Newlines may come from buffer text, overlay strings, or strings
6127 displayed via the `display' property. That's the reason we can't
6128 simply use find_newline_no_quit.
6129
6130 Note that this function may not skip over invisible text that is so
6131 because of text properties and immediately follows a newline. If
6132 it would, function reseat_at_next_visible_line_start, when called
6133 from set_iterator_to_next, would effectively make invisible
6134 characters following a newline part of the wrong glyph row, which
6135 leads to wrong cursor motion. */
6136
6137 static int
6138 forward_to_next_line_start (struct it *it, int *skipped_p,
6139 struct bidi_it *bidi_it_prev)
6140 {
6141 ptrdiff_t old_selective;
6142 int newline_found_p, n;
6143 const int MAX_NEWLINE_DISTANCE = 500;
6144
6145 /* If already on a newline, just consume it to avoid unintended
6146 skipping over invisible text below. */
6147 if (it->what == IT_CHARACTER
6148 && it->c == '\n'
6149 && CHARPOS (it->position) == IT_CHARPOS (*it))
6150 {
6151 if (it->bidi_p && bidi_it_prev)
6152 *bidi_it_prev = it->bidi_it;
6153 set_iterator_to_next (it, 0);
6154 it->c = 0;
6155 return 1;
6156 }
6157
6158 /* Don't handle selective display in the following. It's (a)
6159 unnecessary because it's done by the caller, and (b) leads to an
6160 infinite recursion because next_element_from_ellipsis indirectly
6161 calls this function. */
6162 old_selective = it->selective;
6163 it->selective = 0;
6164
6165 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6166 from buffer text. */
6167 for (n = newline_found_p = 0;
6168 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
6169 n += STRINGP (it->string) ? 0 : 1)
6170 {
6171 if (!get_next_display_element (it))
6172 return 0;
6173 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
6174 if (newline_found_p && it->bidi_p && bidi_it_prev)
6175 *bidi_it_prev = it->bidi_it;
6176 set_iterator_to_next (it, 0);
6177 }
6178
6179 /* If we didn't find a newline near enough, see if we can use a
6180 short-cut. */
6181 if (!newline_found_p)
6182 {
6183 ptrdiff_t bytepos, start = IT_CHARPOS (*it);
6184 ptrdiff_t limit = find_newline_no_quit (start, IT_BYTEPOS (*it),
6185 1, &bytepos);
6186 Lisp_Object pos;
6187
6188 eassert (!STRINGP (it->string));
6189
6190 /* If there isn't any `display' property in sight, and no
6191 overlays, we can just use the position of the newline in
6192 buffer text. */
6193 if (it->stop_charpos >= limit
6194 || ((pos = Fnext_single_property_change (make_number (start),
6195 Qdisplay, Qnil,
6196 make_number (limit)),
6197 NILP (pos))
6198 && next_overlay_change (start) == ZV))
6199 {
6200 if (!it->bidi_p)
6201 {
6202 IT_CHARPOS (*it) = limit;
6203 IT_BYTEPOS (*it) = bytepos;
6204 }
6205 else
6206 {
6207 struct bidi_it bprev;
6208
6209 /* Help bidi.c avoid expensive searches for display
6210 properties and overlays, by telling it that there are
6211 none up to `limit'. */
6212 if (it->bidi_it.disp_pos < limit)
6213 {
6214 it->bidi_it.disp_pos = limit;
6215 it->bidi_it.disp_prop = 0;
6216 }
6217 do {
6218 bprev = it->bidi_it;
6219 bidi_move_to_visually_next (&it->bidi_it);
6220 } while (it->bidi_it.charpos != limit);
6221 IT_CHARPOS (*it) = limit;
6222 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6223 if (bidi_it_prev)
6224 *bidi_it_prev = bprev;
6225 }
6226 *skipped_p = newline_found_p = true;
6227 }
6228 else
6229 {
6230 while (get_next_display_element (it)
6231 && !newline_found_p)
6232 {
6233 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6234 if (newline_found_p && it->bidi_p && bidi_it_prev)
6235 *bidi_it_prev = it->bidi_it;
6236 set_iterator_to_next (it, 0);
6237 }
6238 }
6239 }
6240
6241 it->selective = old_selective;
6242 return newline_found_p;
6243 }
6244
6245
6246 /* Set IT's current position to the previous visible line start. Skip
6247 invisible text that is so either due to text properties or due to
6248 selective display. Caution: this does not change IT->current_x and
6249 IT->hpos. */
6250
6251 static void
6252 back_to_previous_visible_line_start (struct it *it)
6253 {
6254 while (IT_CHARPOS (*it) > BEGV)
6255 {
6256 back_to_previous_line_start (it);
6257
6258 if (IT_CHARPOS (*it) <= BEGV)
6259 break;
6260
6261 /* If selective > 0, then lines indented more than its value are
6262 invisible. */
6263 if (it->selective > 0
6264 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6265 it->selective))
6266 continue;
6267
6268 /* Check the newline before point for invisibility. */
6269 {
6270 Lisp_Object prop;
6271 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6272 Qinvisible, it->window);
6273 if (TEXT_PROP_MEANS_INVISIBLE (prop))
6274 continue;
6275 }
6276
6277 if (IT_CHARPOS (*it) <= BEGV)
6278 break;
6279
6280 {
6281 struct it it2;
6282 void *it2data = NULL;
6283 ptrdiff_t pos;
6284 ptrdiff_t beg, end;
6285 Lisp_Object val, overlay;
6286
6287 SAVE_IT (it2, *it, it2data);
6288
6289 /* If newline is part of a composition, continue from start of composition */
6290 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6291 && beg < IT_CHARPOS (*it))
6292 goto replaced;
6293
6294 /* If newline is replaced by a display property, find start of overlay
6295 or interval and continue search from that point. */
6296 pos = --IT_CHARPOS (it2);
6297 --IT_BYTEPOS (it2);
6298 it2.sp = 0;
6299 bidi_unshelve_cache (NULL, 0);
6300 it2.string_from_display_prop_p = 0;
6301 it2.from_disp_prop_p = 0;
6302 if (handle_display_prop (&it2) == HANDLED_RETURN
6303 && !NILP (val = get_char_property_and_overlay
6304 (make_number (pos), Qdisplay, Qnil, &overlay))
6305 && (OVERLAYP (overlay)
6306 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6307 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6308 {
6309 RESTORE_IT (it, it, it2data);
6310 goto replaced;
6311 }
6312
6313 /* Newline is not replaced by anything -- so we are done. */
6314 RESTORE_IT (it, it, it2data);
6315 break;
6316
6317 replaced:
6318 if (beg < BEGV)
6319 beg = BEGV;
6320 IT_CHARPOS (*it) = beg;
6321 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6322 }
6323 }
6324
6325 it->continuation_lines_width = 0;
6326
6327 eassert (IT_CHARPOS (*it) >= BEGV);
6328 eassert (IT_CHARPOS (*it) == BEGV
6329 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6330 CHECK_IT (it);
6331 }
6332
6333
6334 /* Reseat iterator IT at the previous visible line start. Skip
6335 invisible text that is so either due to text properties or due to
6336 selective display. At the end, update IT's overlay information,
6337 face information etc. */
6338
6339 void
6340 reseat_at_previous_visible_line_start (struct it *it)
6341 {
6342 back_to_previous_visible_line_start (it);
6343 reseat (it, it->current.pos, 1);
6344 CHECK_IT (it);
6345 }
6346
6347
6348 /* Reseat iterator IT on the next visible line start in the current
6349 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6350 preceding the line start. Skip over invisible text that is so
6351 because of selective display. Compute faces, overlays etc at the
6352 new position. Note that this function does not skip over text that
6353 is invisible because of text properties. */
6354
6355 static void
6356 reseat_at_next_visible_line_start (struct it *it, int on_newline_p)
6357 {
6358 int newline_found_p, skipped_p = 0;
6359 struct bidi_it bidi_it_prev;
6360
6361 newline_found_p = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6362
6363 /* Skip over lines that are invisible because they are indented
6364 more than the value of IT->selective. */
6365 if (it->selective > 0)
6366 while (IT_CHARPOS (*it) < ZV
6367 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6368 it->selective))
6369 {
6370 eassert (IT_BYTEPOS (*it) == BEGV
6371 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6372 newline_found_p =
6373 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6374 }
6375
6376 /* Position on the newline if that's what's requested. */
6377 if (on_newline_p && newline_found_p)
6378 {
6379 if (STRINGP (it->string))
6380 {
6381 if (IT_STRING_CHARPOS (*it) > 0)
6382 {
6383 if (!it->bidi_p)
6384 {
6385 --IT_STRING_CHARPOS (*it);
6386 --IT_STRING_BYTEPOS (*it);
6387 }
6388 else
6389 {
6390 /* We need to restore the bidi iterator to the state
6391 it had on the newline, and resync the IT's
6392 position with that. */
6393 it->bidi_it = bidi_it_prev;
6394 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6395 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6396 }
6397 }
6398 }
6399 else if (IT_CHARPOS (*it) > BEGV)
6400 {
6401 if (!it->bidi_p)
6402 {
6403 --IT_CHARPOS (*it);
6404 --IT_BYTEPOS (*it);
6405 }
6406 else
6407 {
6408 /* We need to restore the bidi iterator to the state it
6409 had on the newline and resync IT with that. */
6410 it->bidi_it = bidi_it_prev;
6411 IT_CHARPOS (*it) = it->bidi_it.charpos;
6412 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6413 }
6414 reseat (it, it->current.pos, 0);
6415 }
6416 }
6417 else if (skipped_p)
6418 reseat (it, it->current.pos, 0);
6419
6420 CHECK_IT (it);
6421 }
6422
6423
6424 \f
6425 /***********************************************************************
6426 Changing an iterator's position
6427 ***********************************************************************/
6428
6429 /* Change IT's current position to POS in current_buffer. If FORCE_P
6430 is non-zero, always check for text properties at the new position.
6431 Otherwise, text properties are only looked up if POS >=
6432 IT->check_charpos of a property. */
6433
6434 static void
6435 reseat (struct it *it, struct text_pos pos, int force_p)
6436 {
6437 ptrdiff_t original_pos = IT_CHARPOS (*it);
6438
6439 reseat_1 (it, pos, 0);
6440
6441 /* Determine where to check text properties. Avoid doing it
6442 where possible because text property lookup is very expensive. */
6443 if (force_p
6444 || CHARPOS (pos) > it->stop_charpos
6445 || CHARPOS (pos) < original_pos)
6446 {
6447 if (it->bidi_p)
6448 {
6449 /* For bidi iteration, we need to prime prev_stop and
6450 base_level_stop with our best estimations. */
6451 /* Implementation note: Of course, POS is not necessarily a
6452 stop position, so assigning prev_pos to it is a lie; we
6453 should have called compute_stop_backwards. However, if
6454 the current buffer does not include any R2L characters,
6455 that call would be a waste of cycles, because the
6456 iterator will never move back, and thus never cross this
6457 "fake" stop position. So we delay that backward search
6458 until the time we really need it, in next_element_from_buffer. */
6459 if (CHARPOS (pos) != it->prev_stop)
6460 it->prev_stop = CHARPOS (pos);
6461 if (CHARPOS (pos) < it->base_level_stop)
6462 it->base_level_stop = 0; /* meaning it's unknown */
6463 handle_stop (it);
6464 }
6465 else
6466 {
6467 handle_stop (it);
6468 it->prev_stop = it->base_level_stop = 0;
6469 }
6470
6471 }
6472
6473 CHECK_IT (it);
6474 }
6475
6476
6477 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6478 IT->stop_pos to POS, also. */
6479
6480 static void
6481 reseat_1 (struct it *it, struct text_pos pos, int set_stop_p)
6482 {
6483 /* Don't call this function when scanning a C string. */
6484 eassert (it->s == NULL);
6485
6486 /* POS must be a reasonable value. */
6487 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6488
6489 it->current.pos = it->position = pos;
6490 it->end_charpos = ZV;
6491 it->dpvec = NULL;
6492 it->current.dpvec_index = -1;
6493 it->current.overlay_string_index = -1;
6494 IT_STRING_CHARPOS (*it) = -1;
6495 IT_STRING_BYTEPOS (*it) = -1;
6496 it->string = Qnil;
6497 it->method = GET_FROM_BUFFER;
6498 it->object = it->w->contents;
6499 it->area = TEXT_AREA;
6500 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6501 it->sp = 0;
6502 it->string_from_display_prop_p = 0;
6503 it->string_from_prefix_prop_p = 0;
6504
6505 it->from_disp_prop_p = 0;
6506 it->face_before_selective_p = 0;
6507 if (it->bidi_p)
6508 {
6509 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6510 &it->bidi_it);
6511 bidi_unshelve_cache (NULL, 0);
6512 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6513 it->bidi_it.string.s = NULL;
6514 it->bidi_it.string.lstring = Qnil;
6515 it->bidi_it.string.bufpos = 0;
6516 it->bidi_it.string.from_disp_str = 0;
6517 it->bidi_it.string.unibyte = 0;
6518 it->bidi_it.w = it->w;
6519 }
6520
6521 if (set_stop_p)
6522 {
6523 it->stop_charpos = CHARPOS (pos);
6524 it->base_level_stop = CHARPOS (pos);
6525 }
6526 /* This make the information stored in it->cmp_it invalidate. */
6527 it->cmp_it.id = -1;
6528 }
6529
6530
6531 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6532 If S is non-null, it is a C string to iterate over. Otherwise,
6533 STRING gives a Lisp string to iterate over.
6534
6535 If PRECISION > 0, don't return more then PRECISION number of
6536 characters from the string.
6537
6538 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6539 characters have been returned. FIELD_WIDTH < 0 means an infinite
6540 field width.
6541
6542 MULTIBYTE = 0 means disable processing of multibyte characters,
6543 MULTIBYTE > 0 means enable it,
6544 MULTIBYTE < 0 means use IT->multibyte_p.
6545
6546 IT must be initialized via a prior call to init_iterator before
6547 calling this function. */
6548
6549 static void
6550 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6551 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6552 int multibyte)
6553 {
6554 /* No text property checks performed by default, but see below. */
6555 it->stop_charpos = -1;
6556
6557 /* Set iterator position and end position. */
6558 memset (&it->current, 0, sizeof it->current);
6559 it->current.overlay_string_index = -1;
6560 it->current.dpvec_index = -1;
6561 eassert (charpos >= 0);
6562
6563 /* If STRING is specified, use its multibyteness, otherwise use the
6564 setting of MULTIBYTE, if specified. */
6565 if (multibyte >= 0)
6566 it->multibyte_p = multibyte > 0;
6567
6568 /* Bidirectional reordering of strings is controlled by the default
6569 value of bidi-display-reordering. Don't try to reorder while
6570 loading loadup.el, as the necessary character property tables are
6571 not yet available. */
6572 it->bidi_p =
6573 NILP (Vpurify_flag)
6574 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6575
6576 if (s == NULL)
6577 {
6578 eassert (STRINGP (string));
6579 it->string = string;
6580 it->s = NULL;
6581 it->end_charpos = it->string_nchars = SCHARS (string);
6582 it->method = GET_FROM_STRING;
6583 it->current.string_pos = string_pos (charpos, string);
6584
6585 if (it->bidi_p)
6586 {
6587 it->bidi_it.string.lstring = string;
6588 it->bidi_it.string.s = NULL;
6589 it->bidi_it.string.schars = it->end_charpos;
6590 it->bidi_it.string.bufpos = 0;
6591 it->bidi_it.string.from_disp_str = 0;
6592 it->bidi_it.string.unibyte = !it->multibyte_p;
6593 it->bidi_it.w = it->w;
6594 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6595 FRAME_WINDOW_P (it->f), &it->bidi_it);
6596 }
6597 }
6598 else
6599 {
6600 it->s = (const unsigned char *) s;
6601 it->string = Qnil;
6602
6603 /* Note that we use IT->current.pos, not it->current.string_pos,
6604 for displaying C strings. */
6605 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6606 if (it->multibyte_p)
6607 {
6608 it->current.pos = c_string_pos (charpos, s, 1);
6609 it->end_charpos = it->string_nchars = number_of_chars (s, 1);
6610 }
6611 else
6612 {
6613 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6614 it->end_charpos = it->string_nchars = strlen (s);
6615 }
6616
6617 if (it->bidi_p)
6618 {
6619 it->bidi_it.string.lstring = Qnil;
6620 it->bidi_it.string.s = (const unsigned char *) s;
6621 it->bidi_it.string.schars = it->end_charpos;
6622 it->bidi_it.string.bufpos = 0;
6623 it->bidi_it.string.from_disp_str = 0;
6624 it->bidi_it.string.unibyte = !it->multibyte_p;
6625 it->bidi_it.w = it->w;
6626 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6627 &it->bidi_it);
6628 }
6629 it->method = GET_FROM_C_STRING;
6630 }
6631
6632 /* PRECISION > 0 means don't return more than PRECISION characters
6633 from the string. */
6634 if (precision > 0 && it->end_charpos - charpos > precision)
6635 {
6636 it->end_charpos = it->string_nchars = charpos + precision;
6637 if (it->bidi_p)
6638 it->bidi_it.string.schars = it->end_charpos;
6639 }
6640
6641 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6642 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6643 FIELD_WIDTH < 0 means infinite field width. This is useful for
6644 padding with `-' at the end of a mode line. */
6645 if (field_width < 0)
6646 field_width = INFINITY;
6647 /* Implementation note: We deliberately don't enlarge
6648 it->bidi_it.string.schars here to fit it->end_charpos, because
6649 the bidi iterator cannot produce characters out of thin air. */
6650 if (field_width > it->end_charpos - charpos)
6651 it->end_charpos = charpos + field_width;
6652
6653 /* Use the standard display table for displaying strings. */
6654 if (DISP_TABLE_P (Vstandard_display_table))
6655 it->dp = XCHAR_TABLE (Vstandard_display_table);
6656
6657 it->stop_charpos = charpos;
6658 it->prev_stop = charpos;
6659 it->base_level_stop = 0;
6660 if (it->bidi_p)
6661 {
6662 it->bidi_it.first_elt = 1;
6663 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6664 it->bidi_it.disp_pos = -1;
6665 }
6666 if (s == NULL && it->multibyte_p)
6667 {
6668 ptrdiff_t endpos = SCHARS (it->string);
6669 if (endpos > it->end_charpos)
6670 endpos = it->end_charpos;
6671 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6672 it->string);
6673 }
6674 CHECK_IT (it);
6675 }
6676
6677
6678 \f
6679 /***********************************************************************
6680 Iteration
6681 ***********************************************************************/
6682
6683 /* Map enum it_method value to corresponding next_element_from_* function. */
6684
6685 static int (* get_next_element[NUM_IT_METHODS]) (struct it *it) =
6686 {
6687 next_element_from_buffer,
6688 next_element_from_display_vector,
6689 next_element_from_string,
6690 next_element_from_c_string,
6691 next_element_from_image,
6692 next_element_from_stretch
6693 };
6694
6695 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6696
6697
6698 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6699 (possibly with the following characters). */
6700
6701 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6702 ((IT)->cmp_it.id >= 0 \
6703 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6704 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6705 END_CHARPOS, (IT)->w, \
6706 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6707 (IT)->string)))
6708
6709
6710 /* Lookup the char-table Vglyphless_char_display for character C (-1
6711 if we want information for no-font case), and return the display
6712 method symbol. By side-effect, update it->what and
6713 it->glyphless_method. This function is called from
6714 get_next_display_element for each character element, and from
6715 x_produce_glyphs when no suitable font was found. */
6716
6717 Lisp_Object
6718 lookup_glyphless_char_display (int c, struct it *it)
6719 {
6720 Lisp_Object glyphless_method = Qnil;
6721
6722 if (CHAR_TABLE_P (Vglyphless_char_display)
6723 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6724 {
6725 if (c >= 0)
6726 {
6727 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6728 if (CONSP (glyphless_method))
6729 glyphless_method = FRAME_WINDOW_P (it->f)
6730 ? XCAR (glyphless_method)
6731 : XCDR (glyphless_method);
6732 }
6733 else
6734 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6735 }
6736
6737 retry:
6738 if (NILP (glyphless_method))
6739 {
6740 if (c >= 0)
6741 /* The default is to display the character by a proper font. */
6742 return Qnil;
6743 /* The default for the no-font case is to display an empty box. */
6744 glyphless_method = Qempty_box;
6745 }
6746 if (EQ (glyphless_method, Qzero_width))
6747 {
6748 if (c >= 0)
6749 return glyphless_method;
6750 /* This method can't be used for the no-font case. */
6751 glyphless_method = Qempty_box;
6752 }
6753 if (EQ (glyphless_method, Qthin_space))
6754 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6755 else if (EQ (glyphless_method, Qempty_box))
6756 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6757 else if (EQ (glyphless_method, Qhex_code))
6758 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6759 else if (STRINGP (glyphless_method))
6760 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6761 else
6762 {
6763 /* Invalid value. We use the default method. */
6764 glyphless_method = Qnil;
6765 goto retry;
6766 }
6767 it->what = IT_GLYPHLESS;
6768 return glyphless_method;
6769 }
6770
6771 /* Merge escape glyph face and cache the result. */
6772
6773 static struct frame *last_escape_glyph_frame = NULL;
6774 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6775 static int last_escape_glyph_merged_face_id = 0;
6776
6777 static int
6778 merge_escape_glyph_face (struct it *it)
6779 {
6780 int face_id;
6781
6782 if (it->f == last_escape_glyph_frame
6783 && it->face_id == last_escape_glyph_face_id)
6784 face_id = last_escape_glyph_merged_face_id;
6785 else
6786 {
6787 /* Merge the `escape-glyph' face into the current face. */
6788 face_id = merge_faces (it->f, Qescape_glyph, 0, it->face_id);
6789 last_escape_glyph_frame = it->f;
6790 last_escape_glyph_face_id = it->face_id;
6791 last_escape_glyph_merged_face_id = face_id;
6792 }
6793 return face_id;
6794 }
6795
6796 /* Likewise for glyphless glyph face. */
6797
6798 static struct frame *last_glyphless_glyph_frame = NULL;
6799 static int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6800 static int last_glyphless_glyph_merged_face_id = 0;
6801
6802 int
6803 merge_glyphless_glyph_face (struct it *it)
6804 {
6805 int face_id;
6806
6807 if (it->f == last_glyphless_glyph_frame
6808 && it->face_id == last_glyphless_glyph_face_id)
6809 face_id = last_glyphless_glyph_merged_face_id;
6810 else
6811 {
6812 /* Merge the `glyphless-char' face into the current face. */
6813 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
6814 last_glyphless_glyph_frame = it->f;
6815 last_glyphless_glyph_face_id = it->face_id;
6816 last_glyphless_glyph_merged_face_id = face_id;
6817 }
6818 return face_id;
6819 }
6820
6821 /* Load IT's display element fields with information about the next
6822 display element from the current position of IT. Value is zero if
6823 end of buffer (or C string) is reached. */
6824
6825 static int
6826 get_next_display_element (struct it *it)
6827 {
6828 /* Non-zero means that we found a display element. Zero means that
6829 we hit the end of what we iterate over. Performance note: the
6830 function pointer `method' used here turns out to be faster than
6831 using a sequence of if-statements. */
6832 int success_p;
6833
6834 get_next:
6835 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6836
6837 if (it->what == IT_CHARACTER)
6838 {
6839 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6840 and only if (a) the resolved directionality of that character
6841 is R..." */
6842 /* FIXME: Do we need an exception for characters from display
6843 tables? */
6844 if (it->bidi_p && it->bidi_it.type == STRONG_R)
6845 it->c = bidi_mirror_char (it->c);
6846 /* Map via display table or translate control characters.
6847 IT->c, IT->len etc. have been set to the next character by
6848 the function call above. If we have a display table, and it
6849 contains an entry for IT->c, translate it. Don't do this if
6850 IT->c itself comes from a display table, otherwise we could
6851 end up in an infinite recursion. (An alternative could be to
6852 count the recursion depth of this function and signal an
6853 error when a certain maximum depth is reached.) Is it worth
6854 it? */
6855 if (success_p && it->dpvec == NULL)
6856 {
6857 Lisp_Object dv;
6858 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6859 int nonascii_space_p = 0;
6860 int nonascii_hyphen_p = 0;
6861 int c = it->c; /* This is the character to display. */
6862
6863 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6864 {
6865 eassert (SINGLE_BYTE_CHAR_P (c));
6866 if (unibyte_display_via_language_environment)
6867 {
6868 c = DECODE_CHAR (unibyte, c);
6869 if (c < 0)
6870 c = BYTE8_TO_CHAR (it->c);
6871 }
6872 else
6873 c = BYTE8_TO_CHAR (it->c);
6874 }
6875
6876 if (it->dp
6877 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6878 VECTORP (dv)))
6879 {
6880 struct Lisp_Vector *v = XVECTOR (dv);
6881
6882 /* Return the first character from the display table
6883 entry, if not empty. If empty, don't display the
6884 current character. */
6885 if (v->header.size)
6886 {
6887 it->dpvec_char_len = it->len;
6888 it->dpvec = v->contents;
6889 it->dpend = v->contents + v->header.size;
6890 it->current.dpvec_index = 0;
6891 it->dpvec_face_id = -1;
6892 it->saved_face_id = it->face_id;
6893 it->method = GET_FROM_DISPLAY_VECTOR;
6894 it->ellipsis_p = 0;
6895 }
6896 else
6897 {
6898 set_iterator_to_next (it, 0);
6899 }
6900 goto get_next;
6901 }
6902
6903 if (! NILP (lookup_glyphless_char_display (c, it)))
6904 {
6905 if (it->what == IT_GLYPHLESS)
6906 goto done;
6907 /* Don't display this character. */
6908 set_iterator_to_next (it, 0);
6909 goto get_next;
6910 }
6911
6912 /* If `nobreak-char-display' is non-nil, we display
6913 non-ASCII spaces and hyphens specially. */
6914 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
6915 {
6916 if (c == 0xA0)
6917 nonascii_space_p = true;
6918 else if (c == 0xAD || c == 0x2010 || c == 0x2011)
6919 nonascii_hyphen_p = true;
6920 }
6921
6922 /* Translate control characters into `\003' or `^C' form.
6923 Control characters coming from a display table entry are
6924 currently not translated because we use IT->dpvec to hold
6925 the translation. This could easily be changed but I
6926 don't believe that it is worth doing.
6927
6928 The characters handled by `nobreak-char-display' must be
6929 translated too.
6930
6931 Non-printable characters and raw-byte characters are also
6932 translated to octal form. */
6933 if (((c < ' ' || c == 127) /* ASCII control chars. */
6934 ? (it->area != TEXT_AREA
6935 /* In mode line, treat \n, \t like other crl chars. */
6936 || (c != '\t'
6937 && it->glyph_row
6938 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
6939 || (c != '\n' && c != '\t'))
6940 : (nonascii_space_p
6941 || nonascii_hyphen_p
6942 || CHAR_BYTE8_P (c)
6943 || ! CHAR_PRINTABLE_P (c))))
6944 {
6945 /* C is a control character, non-ASCII space/hyphen,
6946 raw-byte, or a non-printable character which must be
6947 displayed either as '\003' or as `^C' where the '\\'
6948 and '^' can be defined in the display table. Fill
6949 IT->ctl_chars with glyphs for what we have to
6950 display. Then, set IT->dpvec to these glyphs. */
6951 Lisp_Object gc;
6952 int ctl_len;
6953 int face_id;
6954 int lface_id = 0;
6955 int escape_glyph;
6956
6957 /* Handle control characters with ^. */
6958
6959 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
6960 {
6961 int g;
6962
6963 g = '^'; /* default glyph for Control */
6964 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6965 if (it->dp
6966 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
6967 {
6968 g = GLYPH_CODE_CHAR (gc);
6969 lface_id = GLYPH_CODE_FACE (gc);
6970 }
6971
6972 face_id = (lface_id
6973 ? merge_faces (it->f, Qt, lface_id, it->face_id)
6974 : merge_escape_glyph_face (it));
6975
6976 XSETINT (it->ctl_chars[0], g);
6977 XSETINT (it->ctl_chars[1], c ^ 0100);
6978 ctl_len = 2;
6979 goto display_control;
6980 }
6981
6982 /* Handle non-ascii space in the mode where it only gets
6983 highlighting. */
6984
6985 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
6986 {
6987 /* Merge `nobreak-space' into the current face. */
6988 face_id = merge_faces (it->f, Qnobreak_space, 0,
6989 it->face_id);
6990 XSETINT (it->ctl_chars[0], ' ');
6991 ctl_len = 1;
6992 goto display_control;
6993 }
6994
6995 /* Handle sequences that start with the "escape glyph". */
6996
6997 /* the default escape glyph is \. */
6998 escape_glyph = '\\';
6999
7000 if (it->dp
7001 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7002 {
7003 escape_glyph = GLYPH_CODE_CHAR (gc);
7004 lface_id = GLYPH_CODE_FACE (gc);
7005 }
7006
7007 face_id = (lface_id
7008 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7009 : merge_escape_glyph_face (it));
7010
7011 /* Draw non-ASCII hyphen with just highlighting: */
7012
7013 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
7014 {
7015 XSETINT (it->ctl_chars[0], '-');
7016 ctl_len = 1;
7017 goto display_control;
7018 }
7019
7020 /* Draw non-ASCII space/hyphen with escape glyph: */
7021
7022 if (nonascii_space_p || nonascii_hyphen_p)
7023 {
7024 XSETINT (it->ctl_chars[0], escape_glyph);
7025 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
7026 ctl_len = 2;
7027 goto display_control;
7028 }
7029
7030 {
7031 char str[10];
7032 int len, i;
7033
7034 if (CHAR_BYTE8_P (c))
7035 /* Display \200 instead of \17777600. */
7036 c = CHAR_TO_BYTE8 (c);
7037 len = sprintf (str, "%03o", c);
7038
7039 XSETINT (it->ctl_chars[0], escape_glyph);
7040 for (i = 0; i < len; i++)
7041 XSETINT (it->ctl_chars[i + 1], str[i]);
7042 ctl_len = len + 1;
7043 }
7044
7045 display_control:
7046 /* Set up IT->dpvec and return first character from it. */
7047 it->dpvec_char_len = it->len;
7048 it->dpvec = it->ctl_chars;
7049 it->dpend = it->dpvec + ctl_len;
7050 it->current.dpvec_index = 0;
7051 it->dpvec_face_id = face_id;
7052 it->saved_face_id = it->face_id;
7053 it->method = GET_FROM_DISPLAY_VECTOR;
7054 it->ellipsis_p = 0;
7055 goto get_next;
7056 }
7057 it->char_to_display = c;
7058 }
7059 else if (success_p)
7060 {
7061 it->char_to_display = it->c;
7062 }
7063 }
7064
7065 #ifdef HAVE_WINDOW_SYSTEM
7066 /* Adjust face id for a multibyte character. There are no multibyte
7067 character in unibyte text. */
7068 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
7069 && it->multibyte_p
7070 && success_p
7071 && FRAME_WINDOW_P (it->f))
7072 {
7073 struct face *face = FACE_FROM_ID (it->f, it->face_id);
7074
7075 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
7076 {
7077 /* Automatic composition with glyph-string. */
7078 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
7079
7080 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
7081 }
7082 else
7083 {
7084 ptrdiff_t pos = (it->s ? -1
7085 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
7086 : IT_CHARPOS (*it));
7087 int c;
7088
7089 if (it->what == IT_CHARACTER)
7090 c = it->char_to_display;
7091 else
7092 {
7093 struct composition *cmp = composition_table[it->cmp_it.id];
7094 int i;
7095
7096 c = ' ';
7097 for (i = 0; i < cmp->glyph_len; i++)
7098 /* TAB in a composition means display glyphs with
7099 padding space on the left or right. */
7100 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
7101 break;
7102 }
7103 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
7104 }
7105 }
7106 #endif /* HAVE_WINDOW_SYSTEM */
7107
7108 done:
7109 /* Is this character the last one of a run of characters with
7110 box? If yes, set IT->end_of_box_run_p to 1. */
7111 if (it->face_box_p
7112 && it->s == NULL)
7113 {
7114 if (it->method == GET_FROM_STRING && it->sp)
7115 {
7116 int face_id = underlying_face_id (it);
7117 struct face *face = FACE_FROM_ID (it->f, face_id);
7118
7119 if (face)
7120 {
7121 if (face->box == FACE_NO_BOX)
7122 {
7123 /* If the box comes from face properties in a
7124 display string, check faces in that string. */
7125 int string_face_id = face_after_it_pos (it);
7126 it->end_of_box_run_p
7127 = (FACE_FROM_ID (it->f, string_face_id)->box
7128 == FACE_NO_BOX);
7129 }
7130 /* Otherwise, the box comes from the underlying face.
7131 If this is the last string character displayed, check
7132 the next buffer location. */
7133 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
7134 /* n_overlay_strings is unreliable unless
7135 overlay_string_index is non-negative. */
7136 && ((it->current.overlay_string_index >= 0
7137 && (it->current.overlay_string_index
7138 == it->n_overlay_strings - 1))
7139 /* A string from display property. */
7140 || it->from_disp_prop_p))
7141 {
7142 ptrdiff_t ignore;
7143 int next_face_id;
7144 struct text_pos pos = it->current.pos;
7145
7146 /* For a string from a display property, the next
7147 buffer position is stored in the 'position'
7148 member of the iteration stack slot below the
7149 current one, see handle_single_display_spec. By
7150 contrast, it->current.pos was is not yet updated
7151 to point to that buffer position; that will
7152 happen in pop_it, after we finish displaying the
7153 current string. Note that we already checked
7154 above that it->sp is positive, so subtracting one
7155 from it is safe. */
7156 if (it->from_disp_prop_p)
7157 pos = (it->stack + it->sp - 1)->position;
7158 else
7159 INC_TEXT_POS (pos, it->multibyte_p);
7160
7161 if (CHARPOS (pos) >= ZV)
7162 it->end_of_box_run_p = true;
7163 else
7164 {
7165 next_face_id = face_at_buffer_position
7166 (it->w, CHARPOS (pos), &ignore,
7167 CHARPOS (pos) + TEXT_PROP_DISTANCE_LIMIT, 0, -1);
7168 it->end_of_box_run_p
7169 = (FACE_FROM_ID (it->f, next_face_id)->box
7170 == FACE_NO_BOX);
7171 }
7172 }
7173 }
7174 }
7175 /* next_element_from_display_vector sets this flag according to
7176 faces of the display vector glyphs, see there. */
7177 else if (it->method != GET_FROM_DISPLAY_VECTOR)
7178 {
7179 int face_id = face_after_it_pos (it);
7180 it->end_of_box_run_p
7181 = (face_id != it->face_id
7182 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
7183 }
7184 }
7185 /* If we reached the end of the object we've been iterating (e.g., a
7186 display string or an overlay string), and there's something on
7187 IT->stack, proceed with what's on the stack. It doesn't make
7188 sense to return zero if there's unprocessed stuff on the stack,
7189 because otherwise that stuff will never be displayed. */
7190 if (!success_p && it->sp > 0)
7191 {
7192 set_iterator_to_next (it, 0);
7193 success_p = get_next_display_element (it);
7194 }
7195
7196 /* Value is 0 if end of buffer or string reached. */
7197 return success_p;
7198 }
7199
7200
7201 /* Move IT to the next display element.
7202
7203 RESEAT_P non-zero means if called on a newline in buffer text,
7204 skip to the next visible line start.
7205
7206 Functions get_next_display_element and set_iterator_to_next are
7207 separate because I find this arrangement easier to handle than a
7208 get_next_display_element function that also increments IT's
7209 position. The way it is we can first look at an iterator's current
7210 display element, decide whether it fits on a line, and if it does,
7211 increment the iterator position. The other way around we probably
7212 would either need a flag indicating whether the iterator has to be
7213 incremented the next time, or we would have to implement a
7214 decrement position function which would not be easy to write. */
7215
7216 void
7217 set_iterator_to_next (struct it *it, int reseat_p)
7218 {
7219 /* Reset flags indicating start and end of a sequence of characters
7220 with box. Reset them at the start of this function because
7221 moving the iterator to a new position might set them. */
7222 it->start_of_box_run_p = it->end_of_box_run_p = 0;
7223
7224 switch (it->method)
7225 {
7226 case GET_FROM_BUFFER:
7227 /* The current display element of IT is a character from
7228 current_buffer. Advance in the buffer, and maybe skip over
7229 invisible lines that are so because of selective display. */
7230 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
7231 reseat_at_next_visible_line_start (it, 0);
7232 else if (it->cmp_it.id >= 0)
7233 {
7234 /* We are currently getting glyphs from a composition. */
7235 int i;
7236
7237 if (! it->bidi_p)
7238 {
7239 IT_CHARPOS (*it) += it->cmp_it.nchars;
7240 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
7241 if (it->cmp_it.to < it->cmp_it.nglyphs)
7242 {
7243 it->cmp_it.from = it->cmp_it.to;
7244 }
7245 else
7246 {
7247 it->cmp_it.id = -1;
7248 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7249 IT_BYTEPOS (*it),
7250 it->end_charpos, Qnil);
7251 }
7252 }
7253 else if (! it->cmp_it.reversed_p)
7254 {
7255 /* Composition created while scanning forward. */
7256 /* Update IT's char/byte positions to point to the first
7257 character of the next grapheme cluster, or to the
7258 character visually after the current composition. */
7259 for (i = 0; i < it->cmp_it.nchars; i++)
7260 bidi_move_to_visually_next (&it->bidi_it);
7261 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7262 IT_CHARPOS (*it) = it->bidi_it.charpos;
7263
7264 if (it->cmp_it.to < it->cmp_it.nglyphs)
7265 {
7266 /* Proceed to the next grapheme cluster. */
7267 it->cmp_it.from = it->cmp_it.to;
7268 }
7269 else
7270 {
7271 /* No more grapheme clusters in this composition.
7272 Find the next stop position. */
7273 ptrdiff_t stop = it->end_charpos;
7274 if (it->bidi_it.scan_dir < 0)
7275 /* Now we are scanning backward and don't know
7276 where to stop. */
7277 stop = -1;
7278 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7279 IT_BYTEPOS (*it), stop, Qnil);
7280 }
7281 }
7282 else
7283 {
7284 /* Composition created while scanning backward. */
7285 /* Update IT's char/byte positions to point to the last
7286 character of the previous grapheme cluster, or the
7287 character visually after the current composition. */
7288 for (i = 0; i < it->cmp_it.nchars; i++)
7289 bidi_move_to_visually_next (&it->bidi_it);
7290 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7291 IT_CHARPOS (*it) = it->bidi_it.charpos;
7292 if (it->cmp_it.from > 0)
7293 {
7294 /* Proceed to the previous grapheme cluster. */
7295 it->cmp_it.to = it->cmp_it.from;
7296 }
7297 else
7298 {
7299 /* No more grapheme clusters in this composition.
7300 Find the next stop position. */
7301 ptrdiff_t stop = it->end_charpos;
7302 if (it->bidi_it.scan_dir < 0)
7303 /* Now we are scanning backward and don't know
7304 where to stop. */
7305 stop = -1;
7306 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7307 IT_BYTEPOS (*it), stop, Qnil);
7308 }
7309 }
7310 }
7311 else
7312 {
7313 eassert (it->len != 0);
7314
7315 if (!it->bidi_p)
7316 {
7317 IT_BYTEPOS (*it) += it->len;
7318 IT_CHARPOS (*it) += 1;
7319 }
7320 else
7321 {
7322 int prev_scan_dir = it->bidi_it.scan_dir;
7323 /* If this is a new paragraph, determine its base
7324 direction (a.k.a. its base embedding level). */
7325 if (it->bidi_it.new_paragraph)
7326 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
7327 bidi_move_to_visually_next (&it->bidi_it);
7328 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7329 IT_CHARPOS (*it) = it->bidi_it.charpos;
7330 if (prev_scan_dir != it->bidi_it.scan_dir)
7331 {
7332 /* As the scan direction was changed, we must
7333 re-compute the stop position for composition. */
7334 ptrdiff_t stop = it->end_charpos;
7335 if (it->bidi_it.scan_dir < 0)
7336 stop = -1;
7337 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7338 IT_BYTEPOS (*it), stop, Qnil);
7339 }
7340 }
7341 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7342 }
7343 break;
7344
7345 case GET_FROM_C_STRING:
7346 /* Current display element of IT is from a C string. */
7347 if (!it->bidi_p
7348 /* If the string position is beyond string's end, it means
7349 next_element_from_c_string is padding the string with
7350 blanks, in which case we bypass the bidi iterator,
7351 because it cannot deal with such virtual characters. */
7352 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7353 {
7354 IT_BYTEPOS (*it) += it->len;
7355 IT_CHARPOS (*it) += 1;
7356 }
7357 else
7358 {
7359 bidi_move_to_visually_next (&it->bidi_it);
7360 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7361 IT_CHARPOS (*it) = it->bidi_it.charpos;
7362 }
7363 break;
7364
7365 case GET_FROM_DISPLAY_VECTOR:
7366 /* Current display element of IT is from a display table entry.
7367 Advance in the display table definition. Reset it to null if
7368 end reached, and continue with characters from buffers/
7369 strings. */
7370 ++it->current.dpvec_index;
7371
7372 /* Restore face of the iterator to what they were before the
7373 display vector entry (these entries may contain faces). */
7374 it->face_id = it->saved_face_id;
7375
7376 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7377 {
7378 int recheck_faces = it->ellipsis_p;
7379
7380 if (it->s)
7381 it->method = GET_FROM_C_STRING;
7382 else if (STRINGP (it->string))
7383 it->method = GET_FROM_STRING;
7384 else
7385 {
7386 it->method = GET_FROM_BUFFER;
7387 it->object = it->w->contents;
7388 }
7389
7390 it->dpvec = NULL;
7391 it->current.dpvec_index = -1;
7392
7393 /* Skip over characters which were displayed via IT->dpvec. */
7394 if (it->dpvec_char_len < 0)
7395 reseat_at_next_visible_line_start (it, 1);
7396 else if (it->dpvec_char_len > 0)
7397 {
7398 if (it->method == GET_FROM_STRING
7399 && it->current.overlay_string_index >= 0
7400 && it->n_overlay_strings > 0)
7401 it->ignore_overlay_strings_at_pos_p = true;
7402 it->len = it->dpvec_char_len;
7403 set_iterator_to_next (it, reseat_p);
7404 }
7405
7406 /* Maybe recheck faces after display vector. */
7407 if (recheck_faces)
7408 it->stop_charpos = IT_CHARPOS (*it);
7409 }
7410 break;
7411
7412 case GET_FROM_STRING:
7413 /* Current display element is a character from a Lisp string. */
7414 eassert (it->s == NULL && STRINGP (it->string));
7415 /* Don't advance past string end. These conditions are true
7416 when set_iterator_to_next is called at the end of
7417 get_next_display_element, in which case the Lisp string is
7418 already exhausted, and all we want is pop the iterator
7419 stack. */
7420 if (it->current.overlay_string_index >= 0)
7421 {
7422 /* This is an overlay string, so there's no padding with
7423 spaces, and the number of characters in the string is
7424 where the string ends. */
7425 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7426 goto consider_string_end;
7427 }
7428 else
7429 {
7430 /* Not an overlay string. There could be padding, so test
7431 against it->end_charpos. */
7432 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7433 goto consider_string_end;
7434 }
7435 if (it->cmp_it.id >= 0)
7436 {
7437 int i;
7438
7439 if (! it->bidi_p)
7440 {
7441 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7442 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7443 if (it->cmp_it.to < it->cmp_it.nglyphs)
7444 it->cmp_it.from = it->cmp_it.to;
7445 else
7446 {
7447 it->cmp_it.id = -1;
7448 composition_compute_stop_pos (&it->cmp_it,
7449 IT_STRING_CHARPOS (*it),
7450 IT_STRING_BYTEPOS (*it),
7451 it->end_charpos, it->string);
7452 }
7453 }
7454 else if (! it->cmp_it.reversed_p)
7455 {
7456 for (i = 0; i < it->cmp_it.nchars; i++)
7457 bidi_move_to_visually_next (&it->bidi_it);
7458 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7459 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7460
7461 if (it->cmp_it.to < it->cmp_it.nglyphs)
7462 it->cmp_it.from = it->cmp_it.to;
7463 else
7464 {
7465 ptrdiff_t stop = it->end_charpos;
7466 if (it->bidi_it.scan_dir < 0)
7467 stop = -1;
7468 composition_compute_stop_pos (&it->cmp_it,
7469 IT_STRING_CHARPOS (*it),
7470 IT_STRING_BYTEPOS (*it), stop,
7471 it->string);
7472 }
7473 }
7474 else
7475 {
7476 for (i = 0; i < it->cmp_it.nchars; i++)
7477 bidi_move_to_visually_next (&it->bidi_it);
7478 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7479 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7480 if (it->cmp_it.from > 0)
7481 it->cmp_it.to = it->cmp_it.from;
7482 else
7483 {
7484 ptrdiff_t stop = it->end_charpos;
7485 if (it->bidi_it.scan_dir < 0)
7486 stop = -1;
7487 composition_compute_stop_pos (&it->cmp_it,
7488 IT_STRING_CHARPOS (*it),
7489 IT_STRING_BYTEPOS (*it), stop,
7490 it->string);
7491 }
7492 }
7493 }
7494 else
7495 {
7496 if (!it->bidi_p
7497 /* If the string position is beyond string's end, it
7498 means next_element_from_string is padding the string
7499 with blanks, in which case we bypass the bidi
7500 iterator, because it cannot deal with such virtual
7501 characters. */
7502 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7503 {
7504 IT_STRING_BYTEPOS (*it) += it->len;
7505 IT_STRING_CHARPOS (*it) += 1;
7506 }
7507 else
7508 {
7509 int prev_scan_dir = it->bidi_it.scan_dir;
7510
7511 bidi_move_to_visually_next (&it->bidi_it);
7512 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7513 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7514 if (prev_scan_dir != it->bidi_it.scan_dir)
7515 {
7516 ptrdiff_t stop = it->end_charpos;
7517
7518 if (it->bidi_it.scan_dir < 0)
7519 stop = -1;
7520 composition_compute_stop_pos (&it->cmp_it,
7521 IT_STRING_CHARPOS (*it),
7522 IT_STRING_BYTEPOS (*it), stop,
7523 it->string);
7524 }
7525 }
7526 }
7527
7528 consider_string_end:
7529
7530 if (it->current.overlay_string_index >= 0)
7531 {
7532 /* IT->string is an overlay string. Advance to the
7533 next, if there is one. */
7534 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7535 {
7536 it->ellipsis_p = 0;
7537 next_overlay_string (it);
7538 if (it->ellipsis_p)
7539 setup_for_ellipsis (it, 0);
7540 }
7541 }
7542 else
7543 {
7544 /* IT->string is not an overlay string. If we reached
7545 its end, and there is something on IT->stack, proceed
7546 with what is on the stack. This can be either another
7547 string, this time an overlay string, or a buffer. */
7548 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7549 && it->sp > 0)
7550 {
7551 pop_it (it);
7552 if (it->method == GET_FROM_STRING)
7553 goto consider_string_end;
7554 }
7555 }
7556 break;
7557
7558 case GET_FROM_IMAGE:
7559 case GET_FROM_STRETCH:
7560 /* The position etc with which we have to proceed are on
7561 the stack. The position may be at the end of a string,
7562 if the `display' property takes up the whole string. */
7563 eassert (it->sp > 0);
7564 pop_it (it);
7565 if (it->method == GET_FROM_STRING)
7566 goto consider_string_end;
7567 break;
7568
7569 default:
7570 /* There are no other methods defined, so this should be a bug. */
7571 emacs_abort ();
7572 }
7573
7574 eassert (it->method != GET_FROM_STRING
7575 || (STRINGP (it->string)
7576 && IT_STRING_CHARPOS (*it) >= 0));
7577 }
7578
7579 /* Load IT's display element fields with information about the next
7580 display element which comes from a display table entry or from the
7581 result of translating a control character to one of the forms `^C'
7582 or `\003'.
7583
7584 IT->dpvec holds the glyphs to return as characters.
7585 IT->saved_face_id holds the face id before the display vector--it
7586 is restored into IT->face_id in set_iterator_to_next. */
7587
7588 static int
7589 next_element_from_display_vector (struct it *it)
7590 {
7591 Lisp_Object gc;
7592 int prev_face_id = it->face_id;
7593 int next_face_id;
7594
7595 /* Precondition. */
7596 eassert (it->dpvec && it->current.dpvec_index >= 0);
7597
7598 it->face_id = it->saved_face_id;
7599
7600 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7601 That seemed totally bogus - so I changed it... */
7602 gc = it->dpvec[it->current.dpvec_index];
7603
7604 if (GLYPH_CODE_P (gc))
7605 {
7606 struct face *this_face, *prev_face, *next_face;
7607
7608 it->c = GLYPH_CODE_CHAR (gc);
7609 it->len = CHAR_BYTES (it->c);
7610
7611 /* The entry may contain a face id to use. Such a face id is
7612 the id of a Lisp face, not a realized face. A face id of
7613 zero means no face is specified. */
7614 if (it->dpvec_face_id >= 0)
7615 it->face_id = it->dpvec_face_id;
7616 else
7617 {
7618 int lface_id = GLYPH_CODE_FACE (gc);
7619 if (lface_id > 0)
7620 it->face_id = merge_faces (it->f, Qt, lface_id,
7621 it->saved_face_id);
7622 }
7623
7624 /* Glyphs in the display vector could have the box face, so we
7625 need to set the related flags in the iterator, as
7626 appropriate. */
7627 this_face = FACE_FROM_ID (it->f, it->face_id);
7628 prev_face = FACE_FROM_ID (it->f, prev_face_id);
7629
7630 /* Is this character the first character of a box-face run? */
7631 it->start_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7632 && (!prev_face
7633 || prev_face->box == FACE_NO_BOX));
7634
7635 /* For the last character of the box-face run, we need to look
7636 either at the next glyph from the display vector, or at the
7637 face we saw before the display vector. */
7638 next_face_id = it->saved_face_id;
7639 if (it->current.dpvec_index < it->dpend - it->dpvec - 1)
7640 {
7641 if (it->dpvec_face_id >= 0)
7642 next_face_id = it->dpvec_face_id;
7643 else
7644 {
7645 int lface_id =
7646 GLYPH_CODE_FACE (it->dpvec[it->current.dpvec_index + 1]);
7647
7648 if (lface_id > 0)
7649 next_face_id = merge_faces (it->f, Qt, lface_id,
7650 it->saved_face_id);
7651 }
7652 }
7653 next_face = FACE_FROM_ID (it->f, next_face_id);
7654 it->end_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7655 && (!next_face
7656 || next_face->box == FACE_NO_BOX));
7657 it->face_box_p = this_face && this_face->box != FACE_NO_BOX;
7658 }
7659 else
7660 /* Display table entry is invalid. Return a space. */
7661 it->c = ' ', it->len = 1;
7662
7663 /* Don't change position and object of the iterator here. They are
7664 still the values of the character that had this display table
7665 entry or was translated, and that's what we want. */
7666 it->what = IT_CHARACTER;
7667 return 1;
7668 }
7669
7670 /* Get the first element of string/buffer in the visual order, after
7671 being reseated to a new position in a string or a buffer. */
7672 static void
7673 get_visually_first_element (struct it *it)
7674 {
7675 int string_p = STRINGP (it->string) || it->s;
7676 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7677 ptrdiff_t bob = (string_p ? 0 : BEGV);
7678
7679 if (STRINGP (it->string))
7680 {
7681 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7682 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7683 }
7684 else
7685 {
7686 it->bidi_it.charpos = IT_CHARPOS (*it);
7687 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7688 }
7689
7690 if (it->bidi_it.charpos == eob)
7691 {
7692 /* Nothing to do, but reset the FIRST_ELT flag, like
7693 bidi_paragraph_init does, because we are not going to
7694 call it. */
7695 it->bidi_it.first_elt = 0;
7696 }
7697 else if (it->bidi_it.charpos == bob
7698 || (!string_p
7699 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7700 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7701 {
7702 /* If we are at the beginning of a line/string, we can produce
7703 the next element right away. */
7704 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7705 bidi_move_to_visually_next (&it->bidi_it);
7706 }
7707 else
7708 {
7709 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7710
7711 /* We need to prime the bidi iterator starting at the line's or
7712 string's beginning, before we will be able to produce the
7713 next element. */
7714 if (string_p)
7715 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7716 else
7717 it->bidi_it.charpos = find_newline_no_quit (IT_CHARPOS (*it),
7718 IT_BYTEPOS (*it), -1,
7719 &it->bidi_it.bytepos);
7720 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7721 do
7722 {
7723 /* Now return to buffer/string position where we were asked
7724 to get the next display element, and produce that. */
7725 bidi_move_to_visually_next (&it->bidi_it);
7726 }
7727 while (it->bidi_it.bytepos != orig_bytepos
7728 && it->bidi_it.charpos < eob);
7729 }
7730
7731 /* Adjust IT's position information to where we ended up. */
7732 if (STRINGP (it->string))
7733 {
7734 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7735 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7736 }
7737 else
7738 {
7739 IT_CHARPOS (*it) = it->bidi_it.charpos;
7740 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7741 }
7742
7743 if (STRINGP (it->string) || !it->s)
7744 {
7745 ptrdiff_t stop, charpos, bytepos;
7746
7747 if (STRINGP (it->string))
7748 {
7749 eassert (!it->s);
7750 stop = SCHARS (it->string);
7751 if (stop > it->end_charpos)
7752 stop = it->end_charpos;
7753 charpos = IT_STRING_CHARPOS (*it);
7754 bytepos = IT_STRING_BYTEPOS (*it);
7755 }
7756 else
7757 {
7758 stop = it->end_charpos;
7759 charpos = IT_CHARPOS (*it);
7760 bytepos = IT_BYTEPOS (*it);
7761 }
7762 if (it->bidi_it.scan_dir < 0)
7763 stop = -1;
7764 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7765 it->string);
7766 }
7767 }
7768
7769 /* Load IT with the next display element from Lisp string IT->string.
7770 IT->current.string_pos is the current position within the string.
7771 If IT->current.overlay_string_index >= 0, the Lisp string is an
7772 overlay string. */
7773
7774 static int
7775 next_element_from_string (struct it *it)
7776 {
7777 struct text_pos position;
7778
7779 eassert (STRINGP (it->string));
7780 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7781 eassert (IT_STRING_CHARPOS (*it) >= 0);
7782 position = it->current.string_pos;
7783
7784 /* With bidi reordering, the character to display might not be the
7785 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7786 that we were reseat()ed to a new string, whose paragraph
7787 direction is not known. */
7788 if (it->bidi_p && it->bidi_it.first_elt)
7789 {
7790 get_visually_first_element (it);
7791 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7792 }
7793
7794 /* Time to check for invisible text? */
7795 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7796 {
7797 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7798 {
7799 if (!(!it->bidi_p
7800 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7801 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7802 {
7803 /* With bidi non-linear iteration, we could find
7804 ourselves far beyond the last computed stop_charpos,
7805 with several other stop positions in between that we
7806 missed. Scan them all now, in buffer's logical
7807 order, until we find and handle the last stop_charpos
7808 that precedes our current position. */
7809 handle_stop_backwards (it, it->stop_charpos);
7810 return GET_NEXT_DISPLAY_ELEMENT (it);
7811 }
7812 else
7813 {
7814 if (it->bidi_p)
7815 {
7816 /* Take note of the stop position we just moved
7817 across, for when we will move back across it. */
7818 it->prev_stop = it->stop_charpos;
7819 /* If we are at base paragraph embedding level, take
7820 note of the last stop position seen at this
7821 level. */
7822 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7823 it->base_level_stop = it->stop_charpos;
7824 }
7825 handle_stop (it);
7826
7827 /* Since a handler may have changed IT->method, we must
7828 recurse here. */
7829 return GET_NEXT_DISPLAY_ELEMENT (it);
7830 }
7831 }
7832 else if (it->bidi_p
7833 /* If we are before prev_stop, we may have overstepped
7834 on our way backwards a stop_pos, and if so, we need
7835 to handle that stop_pos. */
7836 && IT_STRING_CHARPOS (*it) < it->prev_stop
7837 /* We can sometimes back up for reasons that have nothing
7838 to do with bidi reordering. E.g., compositions. The
7839 code below is only needed when we are above the base
7840 embedding level, so test for that explicitly. */
7841 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7842 {
7843 /* If we lost track of base_level_stop, we have no better
7844 place for handle_stop_backwards to start from than string
7845 beginning. This happens, e.g., when we were reseated to
7846 the previous screenful of text by vertical-motion. */
7847 if (it->base_level_stop <= 0
7848 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7849 it->base_level_stop = 0;
7850 handle_stop_backwards (it, it->base_level_stop);
7851 return GET_NEXT_DISPLAY_ELEMENT (it);
7852 }
7853 }
7854
7855 if (it->current.overlay_string_index >= 0)
7856 {
7857 /* Get the next character from an overlay string. In overlay
7858 strings, there is no field width or padding with spaces to
7859 do. */
7860 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7861 {
7862 it->what = IT_EOB;
7863 return 0;
7864 }
7865 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7866 IT_STRING_BYTEPOS (*it),
7867 it->bidi_it.scan_dir < 0
7868 ? -1
7869 : SCHARS (it->string))
7870 && next_element_from_composition (it))
7871 {
7872 return 1;
7873 }
7874 else if (STRING_MULTIBYTE (it->string))
7875 {
7876 const unsigned char *s = (SDATA (it->string)
7877 + IT_STRING_BYTEPOS (*it));
7878 it->c = string_char_and_length (s, &it->len);
7879 }
7880 else
7881 {
7882 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7883 it->len = 1;
7884 }
7885 }
7886 else
7887 {
7888 /* Get the next character from a Lisp string that is not an
7889 overlay string. Such strings come from the mode line, for
7890 example. We may have to pad with spaces, or truncate the
7891 string. See also next_element_from_c_string. */
7892 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7893 {
7894 it->what = IT_EOB;
7895 return 0;
7896 }
7897 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
7898 {
7899 /* Pad with spaces. */
7900 it->c = ' ', it->len = 1;
7901 CHARPOS (position) = BYTEPOS (position) = -1;
7902 }
7903 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7904 IT_STRING_BYTEPOS (*it),
7905 it->bidi_it.scan_dir < 0
7906 ? -1
7907 : it->string_nchars)
7908 && next_element_from_composition (it))
7909 {
7910 return 1;
7911 }
7912 else if (STRING_MULTIBYTE (it->string))
7913 {
7914 const unsigned char *s = (SDATA (it->string)
7915 + IT_STRING_BYTEPOS (*it));
7916 it->c = string_char_and_length (s, &it->len);
7917 }
7918 else
7919 {
7920 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7921 it->len = 1;
7922 }
7923 }
7924
7925 /* Record what we have and where it came from. */
7926 it->what = IT_CHARACTER;
7927 it->object = it->string;
7928 it->position = position;
7929 return 1;
7930 }
7931
7932
7933 /* Load IT with next display element from C string IT->s.
7934 IT->string_nchars is the maximum number of characters to return
7935 from the string. IT->end_charpos may be greater than
7936 IT->string_nchars when this function is called, in which case we
7937 may have to return padding spaces. Value is zero if end of string
7938 reached, including padding spaces. */
7939
7940 static int
7941 next_element_from_c_string (struct it *it)
7942 {
7943 bool success_p = true;
7944
7945 eassert (it->s);
7946 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
7947 it->what = IT_CHARACTER;
7948 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
7949 it->object = Qnil;
7950
7951 /* With bidi reordering, the character to display might not be the
7952 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7953 we were reseated to a new string, whose paragraph direction is
7954 not known. */
7955 if (it->bidi_p && it->bidi_it.first_elt)
7956 get_visually_first_element (it);
7957
7958 /* IT's position can be greater than IT->string_nchars in case a
7959 field width or precision has been specified when the iterator was
7960 initialized. */
7961 if (IT_CHARPOS (*it) >= it->end_charpos)
7962 {
7963 /* End of the game. */
7964 it->what = IT_EOB;
7965 success_p = 0;
7966 }
7967 else if (IT_CHARPOS (*it) >= it->string_nchars)
7968 {
7969 /* Pad with spaces. */
7970 it->c = ' ', it->len = 1;
7971 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
7972 }
7973 else if (it->multibyte_p)
7974 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
7975 else
7976 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
7977
7978 return success_p;
7979 }
7980
7981
7982 /* Set up IT to return characters from an ellipsis, if appropriate.
7983 The definition of the ellipsis glyphs may come from a display table
7984 entry. This function fills IT with the first glyph from the
7985 ellipsis if an ellipsis is to be displayed. */
7986
7987 static int
7988 next_element_from_ellipsis (struct it *it)
7989 {
7990 if (it->selective_display_ellipsis_p)
7991 setup_for_ellipsis (it, it->len);
7992 else
7993 {
7994 /* The face at the current position may be different from the
7995 face we find after the invisible text. Remember what it
7996 was in IT->saved_face_id, and signal that it's there by
7997 setting face_before_selective_p. */
7998 it->saved_face_id = it->face_id;
7999 it->method = GET_FROM_BUFFER;
8000 it->object = it->w->contents;
8001 reseat_at_next_visible_line_start (it, 1);
8002 it->face_before_selective_p = true;
8003 }
8004
8005 return GET_NEXT_DISPLAY_ELEMENT (it);
8006 }
8007
8008
8009 /* Deliver an image display element. The iterator IT is already
8010 filled with image information (done in handle_display_prop). Value
8011 is always 1. */
8012
8013
8014 static int
8015 next_element_from_image (struct it *it)
8016 {
8017 it->what = IT_IMAGE;
8018 it->ignore_overlay_strings_at_pos_p = 0;
8019 return 1;
8020 }
8021
8022
8023 /* Fill iterator IT with next display element from a stretch glyph
8024 property. IT->object is the value of the text property. Value is
8025 always 1. */
8026
8027 static int
8028 next_element_from_stretch (struct it *it)
8029 {
8030 it->what = IT_STRETCH;
8031 return 1;
8032 }
8033
8034 /* Scan backwards from IT's current position until we find a stop
8035 position, or until BEGV. This is called when we find ourself
8036 before both the last known prev_stop and base_level_stop while
8037 reordering bidirectional text. */
8038
8039 static void
8040 compute_stop_pos_backwards (struct it *it)
8041 {
8042 const int SCAN_BACK_LIMIT = 1000;
8043 struct text_pos pos;
8044 struct display_pos save_current = it->current;
8045 struct text_pos save_position = it->position;
8046 ptrdiff_t charpos = IT_CHARPOS (*it);
8047 ptrdiff_t where_we_are = charpos;
8048 ptrdiff_t save_stop_pos = it->stop_charpos;
8049 ptrdiff_t save_end_pos = it->end_charpos;
8050
8051 eassert (NILP (it->string) && !it->s);
8052 eassert (it->bidi_p);
8053 it->bidi_p = 0;
8054 do
8055 {
8056 it->end_charpos = min (charpos + 1, ZV);
8057 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
8058 SET_TEXT_POS (pos, charpos, CHAR_TO_BYTE (charpos));
8059 reseat_1 (it, pos, 0);
8060 compute_stop_pos (it);
8061 /* We must advance forward, right? */
8062 if (it->stop_charpos <= charpos)
8063 emacs_abort ();
8064 }
8065 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
8066
8067 if (it->stop_charpos <= where_we_are)
8068 it->prev_stop = it->stop_charpos;
8069 else
8070 it->prev_stop = BEGV;
8071 it->bidi_p = true;
8072 it->current = save_current;
8073 it->position = save_position;
8074 it->stop_charpos = save_stop_pos;
8075 it->end_charpos = save_end_pos;
8076 }
8077
8078 /* Scan forward from CHARPOS in the current buffer/string, until we
8079 find a stop position > current IT's position. Then handle the stop
8080 position before that. This is called when we bump into a stop
8081 position while reordering bidirectional text. CHARPOS should be
8082 the last previously processed stop_pos (or BEGV/0, if none were
8083 processed yet) whose position is less that IT's current
8084 position. */
8085
8086 static void
8087 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
8088 {
8089 int bufp = !STRINGP (it->string);
8090 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
8091 struct display_pos save_current = it->current;
8092 struct text_pos save_position = it->position;
8093 struct text_pos pos1;
8094 ptrdiff_t next_stop;
8095
8096 /* Scan in strict logical order. */
8097 eassert (it->bidi_p);
8098 it->bidi_p = 0;
8099 do
8100 {
8101 it->prev_stop = charpos;
8102 if (bufp)
8103 {
8104 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
8105 reseat_1 (it, pos1, 0);
8106 }
8107 else
8108 it->current.string_pos = string_pos (charpos, it->string);
8109 compute_stop_pos (it);
8110 /* We must advance forward, right? */
8111 if (it->stop_charpos <= it->prev_stop)
8112 emacs_abort ();
8113 charpos = it->stop_charpos;
8114 }
8115 while (charpos <= where_we_are);
8116
8117 it->bidi_p = true;
8118 it->current = save_current;
8119 it->position = save_position;
8120 next_stop = it->stop_charpos;
8121 it->stop_charpos = it->prev_stop;
8122 handle_stop (it);
8123 it->stop_charpos = next_stop;
8124 }
8125
8126 /* Load IT with the next display element from current_buffer. Value
8127 is zero if end of buffer reached. IT->stop_charpos is the next
8128 position at which to stop and check for text properties or buffer
8129 end. */
8130
8131 static int
8132 next_element_from_buffer (struct it *it)
8133 {
8134 bool success_p = true;
8135
8136 eassert (IT_CHARPOS (*it) >= BEGV);
8137 eassert (NILP (it->string) && !it->s);
8138 eassert (!it->bidi_p
8139 || (EQ (it->bidi_it.string.lstring, Qnil)
8140 && it->bidi_it.string.s == NULL));
8141
8142 /* With bidi reordering, the character to display might not be the
8143 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8144 we were reseat()ed to a new buffer position, which is potentially
8145 a different paragraph. */
8146 if (it->bidi_p && it->bidi_it.first_elt)
8147 {
8148 get_visually_first_element (it);
8149 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8150 }
8151
8152 if (IT_CHARPOS (*it) >= it->stop_charpos)
8153 {
8154 if (IT_CHARPOS (*it) >= it->end_charpos)
8155 {
8156 int overlay_strings_follow_p;
8157
8158 /* End of the game, except when overlay strings follow that
8159 haven't been returned yet. */
8160 if (it->overlay_strings_at_end_processed_p)
8161 overlay_strings_follow_p = 0;
8162 else
8163 {
8164 it->overlay_strings_at_end_processed_p = true;
8165 overlay_strings_follow_p = get_overlay_strings (it, 0);
8166 }
8167
8168 if (overlay_strings_follow_p)
8169 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
8170 else
8171 {
8172 it->what = IT_EOB;
8173 it->position = it->current.pos;
8174 success_p = 0;
8175 }
8176 }
8177 else if (!(!it->bidi_p
8178 || BIDI_AT_BASE_LEVEL (it->bidi_it)
8179 || IT_CHARPOS (*it) == it->stop_charpos))
8180 {
8181 /* With bidi non-linear iteration, we could find ourselves
8182 far beyond the last computed stop_charpos, with several
8183 other stop positions in between that we missed. Scan
8184 them all now, in buffer's logical order, until we find
8185 and handle the last stop_charpos that precedes our
8186 current position. */
8187 handle_stop_backwards (it, it->stop_charpos);
8188 return GET_NEXT_DISPLAY_ELEMENT (it);
8189 }
8190 else
8191 {
8192 if (it->bidi_p)
8193 {
8194 /* Take note of the stop position we just moved across,
8195 for when we will move back across it. */
8196 it->prev_stop = it->stop_charpos;
8197 /* If we are at base paragraph embedding level, take
8198 note of the last stop position seen at this
8199 level. */
8200 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
8201 it->base_level_stop = it->stop_charpos;
8202 }
8203 handle_stop (it);
8204 return GET_NEXT_DISPLAY_ELEMENT (it);
8205 }
8206 }
8207 else if (it->bidi_p
8208 /* If we are before prev_stop, we may have overstepped on
8209 our way backwards a stop_pos, and if so, we need to
8210 handle that stop_pos. */
8211 && IT_CHARPOS (*it) < it->prev_stop
8212 /* We can sometimes back up for reasons that have nothing
8213 to do with bidi reordering. E.g., compositions. The
8214 code below is only needed when we are above the base
8215 embedding level, so test for that explicitly. */
8216 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
8217 {
8218 if (it->base_level_stop <= 0
8219 || IT_CHARPOS (*it) < it->base_level_stop)
8220 {
8221 /* If we lost track of base_level_stop, we need to find
8222 prev_stop by looking backwards. This happens, e.g., when
8223 we were reseated to the previous screenful of text by
8224 vertical-motion. */
8225 it->base_level_stop = BEGV;
8226 compute_stop_pos_backwards (it);
8227 handle_stop_backwards (it, it->prev_stop);
8228 }
8229 else
8230 handle_stop_backwards (it, it->base_level_stop);
8231 return GET_NEXT_DISPLAY_ELEMENT (it);
8232 }
8233 else
8234 {
8235 /* No face changes, overlays etc. in sight, so just return a
8236 character from current_buffer. */
8237 unsigned char *p;
8238 ptrdiff_t stop;
8239
8240 /* Maybe run the redisplay end trigger hook. Performance note:
8241 This doesn't seem to cost measurable time. */
8242 if (it->redisplay_end_trigger_charpos
8243 && it->glyph_row
8244 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
8245 run_redisplay_end_trigger_hook (it);
8246
8247 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
8248 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
8249 stop)
8250 && next_element_from_composition (it))
8251 {
8252 return 1;
8253 }
8254
8255 /* Get the next character, maybe multibyte. */
8256 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
8257 if (it->multibyte_p && !ASCII_BYTE_P (*p))
8258 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
8259 else
8260 it->c = *p, it->len = 1;
8261
8262 /* Record what we have and where it came from. */
8263 it->what = IT_CHARACTER;
8264 it->object = it->w->contents;
8265 it->position = it->current.pos;
8266
8267 /* Normally we return the character found above, except when we
8268 really want to return an ellipsis for selective display. */
8269 if (it->selective)
8270 {
8271 if (it->c == '\n')
8272 {
8273 /* A value of selective > 0 means hide lines indented more
8274 than that number of columns. */
8275 if (it->selective > 0
8276 && IT_CHARPOS (*it) + 1 < ZV
8277 && indented_beyond_p (IT_CHARPOS (*it) + 1,
8278 IT_BYTEPOS (*it) + 1,
8279 it->selective))
8280 {
8281 success_p = next_element_from_ellipsis (it);
8282 it->dpvec_char_len = -1;
8283 }
8284 }
8285 else if (it->c == '\r' && it->selective == -1)
8286 {
8287 /* A value of selective == -1 means that everything from the
8288 CR to the end of the line is invisible, with maybe an
8289 ellipsis displayed for it. */
8290 success_p = next_element_from_ellipsis (it);
8291 it->dpvec_char_len = -1;
8292 }
8293 }
8294 }
8295
8296 /* Value is zero if end of buffer reached. */
8297 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8298 return success_p;
8299 }
8300
8301
8302 /* Run the redisplay end trigger hook for IT. */
8303
8304 static void
8305 run_redisplay_end_trigger_hook (struct it *it)
8306 {
8307 Lisp_Object args[3];
8308
8309 /* IT->glyph_row should be non-null, i.e. we should be actually
8310 displaying something, or otherwise we should not run the hook. */
8311 eassert (it->glyph_row);
8312
8313 /* Set up hook arguments. */
8314 args[0] = Qredisplay_end_trigger_functions;
8315 args[1] = it->window;
8316 XSETINT (args[2], it->redisplay_end_trigger_charpos);
8317 it->redisplay_end_trigger_charpos = 0;
8318
8319 /* Since we are *trying* to run these functions, don't try to run
8320 them again, even if they get an error. */
8321 wset_redisplay_end_trigger (it->w, Qnil);
8322 Frun_hook_with_args (3, args);
8323
8324 /* Notice if it changed the face of the character we are on. */
8325 handle_face_prop (it);
8326 }
8327
8328
8329 /* Deliver a composition display element. Unlike the other
8330 next_element_from_XXX, this function is not registered in the array
8331 get_next_element[]. It is called from next_element_from_buffer and
8332 next_element_from_string when necessary. */
8333
8334 static int
8335 next_element_from_composition (struct it *it)
8336 {
8337 it->what = IT_COMPOSITION;
8338 it->len = it->cmp_it.nbytes;
8339 if (STRINGP (it->string))
8340 {
8341 if (it->c < 0)
8342 {
8343 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8344 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8345 return 0;
8346 }
8347 it->position = it->current.string_pos;
8348 it->object = it->string;
8349 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8350 IT_STRING_BYTEPOS (*it), it->string);
8351 }
8352 else
8353 {
8354 if (it->c < 0)
8355 {
8356 IT_CHARPOS (*it) += it->cmp_it.nchars;
8357 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8358 if (it->bidi_p)
8359 {
8360 if (it->bidi_it.new_paragraph)
8361 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
8362 /* Resync the bidi iterator with IT's new position.
8363 FIXME: this doesn't support bidirectional text. */
8364 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8365 bidi_move_to_visually_next (&it->bidi_it);
8366 }
8367 return 0;
8368 }
8369 it->position = it->current.pos;
8370 it->object = it->w->contents;
8371 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8372 IT_BYTEPOS (*it), Qnil);
8373 }
8374 return 1;
8375 }
8376
8377
8378 \f
8379 /***********************************************************************
8380 Moving an iterator without producing glyphs
8381 ***********************************************************************/
8382
8383 /* Check if iterator is at a position corresponding to a valid buffer
8384 position after some move_it_ call. */
8385
8386 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8387 ((it)->method == GET_FROM_STRING \
8388 ? IT_STRING_CHARPOS (*it) == 0 \
8389 : 1)
8390
8391
8392 /* Move iterator IT to a specified buffer or X position within one
8393 line on the display without producing glyphs.
8394
8395 OP should be a bit mask including some or all of these bits:
8396 MOVE_TO_X: Stop upon reaching x-position TO_X.
8397 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8398 Regardless of OP's value, stop upon reaching the end of the display line.
8399
8400 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8401 This means, in particular, that TO_X includes window's horizontal
8402 scroll amount.
8403
8404 The return value has several possible values that
8405 say what condition caused the scan to stop:
8406
8407 MOVE_POS_MATCH_OR_ZV
8408 - when TO_POS or ZV was reached.
8409
8410 MOVE_X_REACHED
8411 -when TO_X was reached before TO_POS or ZV were reached.
8412
8413 MOVE_LINE_CONTINUED
8414 - when we reached the end of the display area and the line must
8415 be continued.
8416
8417 MOVE_LINE_TRUNCATED
8418 - when we reached the end of the display area and the line is
8419 truncated.
8420
8421 MOVE_NEWLINE_OR_CR
8422 - when we stopped at a line end, i.e. a newline or a CR and selective
8423 display is on. */
8424
8425 static enum move_it_result
8426 move_it_in_display_line_to (struct it *it,
8427 ptrdiff_t to_charpos, int to_x,
8428 enum move_operation_enum op)
8429 {
8430 enum move_it_result result = MOVE_UNDEFINED;
8431 struct glyph_row *saved_glyph_row;
8432 struct it wrap_it, atpos_it, atx_it, ppos_it;
8433 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8434 void *ppos_data = NULL;
8435 int may_wrap = 0;
8436 enum it_method prev_method = it->method;
8437 ptrdiff_t closest_pos IF_LINT (= 0), prev_pos = IT_CHARPOS (*it);
8438 int saw_smaller_pos = prev_pos < to_charpos;
8439
8440 /* Don't produce glyphs in produce_glyphs. */
8441 saved_glyph_row = it->glyph_row;
8442 it->glyph_row = NULL;
8443
8444 /* Use wrap_it to save a copy of IT wherever a word wrap could
8445 occur. Use atpos_it to save a copy of IT at the desired buffer
8446 position, if found, so that we can scan ahead and check if the
8447 word later overshoots the window edge. Use atx_it similarly, for
8448 pixel positions. */
8449 wrap_it.sp = -1;
8450 atpos_it.sp = -1;
8451 atx_it.sp = -1;
8452
8453 /* Use ppos_it under bidi reordering to save a copy of IT for the
8454 initial position. We restore that position in IT when we have
8455 scanned the entire display line without finding a match for
8456 TO_CHARPOS and all the character positions are greater than
8457 TO_CHARPOS. We then restart the scan from the initial position,
8458 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8459 the closest to TO_CHARPOS. */
8460 if (it->bidi_p)
8461 {
8462 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8463 {
8464 SAVE_IT (ppos_it, *it, ppos_data);
8465 closest_pos = IT_CHARPOS (*it);
8466 }
8467 else
8468 closest_pos = ZV;
8469 }
8470
8471 #define BUFFER_POS_REACHED_P() \
8472 ((op & MOVE_TO_POS) != 0 \
8473 && BUFFERP (it->object) \
8474 && (IT_CHARPOS (*it) == to_charpos \
8475 || ((!it->bidi_p \
8476 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8477 && IT_CHARPOS (*it) > to_charpos) \
8478 || (it->what == IT_COMPOSITION \
8479 && ((IT_CHARPOS (*it) > to_charpos \
8480 && to_charpos >= it->cmp_it.charpos) \
8481 || (IT_CHARPOS (*it) < to_charpos \
8482 && to_charpos <= it->cmp_it.charpos)))) \
8483 && (it->method == GET_FROM_BUFFER \
8484 || (it->method == GET_FROM_DISPLAY_VECTOR \
8485 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8486
8487 /* If there's a line-/wrap-prefix, handle it. */
8488 if (it->hpos == 0 && it->method == GET_FROM_BUFFER
8489 && it->current_y < it->last_visible_y)
8490 handle_line_prefix (it);
8491
8492 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8493 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8494
8495 while (1)
8496 {
8497 int x, i, ascent = 0, descent = 0;
8498
8499 /* Utility macro to reset an iterator with x, ascent, and descent. */
8500 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8501 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8502 (IT)->max_descent = descent)
8503
8504 /* Stop if we move beyond TO_CHARPOS (after an image or a
8505 display string or stretch glyph). */
8506 if ((op & MOVE_TO_POS) != 0
8507 && BUFFERP (it->object)
8508 && it->method == GET_FROM_BUFFER
8509 && (((!it->bidi_p
8510 /* When the iterator is at base embedding level, we
8511 are guaranteed that characters are delivered for
8512 display in strictly increasing order of their
8513 buffer positions. */
8514 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8515 && IT_CHARPOS (*it) > to_charpos)
8516 || (it->bidi_p
8517 && (prev_method == GET_FROM_IMAGE
8518 || prev_method == GET_FROM_STRETCH
8519 || prev_method == GET_FROM_STRING)
8520 /* Passed TO_CHARPOS from left to right. */
8521 && ((prev_pos < to_charpos
8522 && IT_CHARPOS (*it) > to_charpos)
8523 /* Passed TO_CHARPOS from right to left. */
8524 || (prev_pos > to_charpos
8525 && IT_CHARPOS (*it) < to_charpos)))))
8526 {
8527 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8528 {
8529 result = MOVE_POS_MATCH_OR_ZV;
8530 break;
8531 }
8532 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8533 /* If wrap_it is valid, the current position might be in a
8534 word that is wrapped. So, save the iterator in
8535 atpos_it and continue to see if wrapping happens. */
8536 SAVE_IT (atpos_it, *it, atpos_data);
8537 }
8538
8539 /* Stop when ZV reached.
8540 We used to stop here when TO_CHARPOS reached as well, but that is
8541 too soon if this glyph does not fit on this line. So we handle it
8542 explicitly below. */
8543 if (!get_next_display_element (it))
8544 {
8545 result = MOVE_POS_MATCH_OR_ZV;
8546 break;
8547 }
8548
8549 if (it->line_wrap == TRUNCATE)
8550 {
8551 if (BUFFER_POS_REACHED_P ())
8552 {
8553 result = MOVE_POS_MATCH_OR_ZV;
8554 break;
8555 }
8556 }
8557 else
8558 {
8559 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
8560 {
8561 if (IT_DISPLAYING_WHITESPACE (it))
8562 may_wrap = 1;
8563 else if (may_wrap)
8564 {
8565 /* We have reached a glyph that follows one or more
8566 whitespace characters. If the position is
8567 already found, we are done. */
8568 if (atpos_it.sp >= 0)
8569 {
8570 RESTORE_IT (it, &atpos_it, atpos_data);
8571 result = MOVE_POS_MATCH_OR_ZV;
8572 goto done;
8573 }
8574 if (atx_it.sp >= 0)
8575 {
8576 RESTORE_IT (it, &atx_it, atx_data);
8577 result = MOVE_X_REACHED;
8578 goto done;
8579 }
8580 /* Otherwise, we can wrap here. */
8581 SAVE_IT (wrap_it, *it, wrap_data);
8582 may_wrap = 0;
8583 }
8584 }
8585 }
8586
8587 /* Remember the line height for the current line, in case
8588 the next element doesn't fit on the line. */
8589 ascent = it->max_ascent;
8590 descent = it->max_descent;
8591
8592 /* The call to produce_glyphs will get the metrics of the
8593 display element IT is loaded with. Record the x-position
8594 before this display element, in case it doesn't fit on the
8595 line. */
8596 x = it->current_x;
8597
8598 PRODUCE_GLYPHS (it);
8599
8600 if (it->area != TEXT_AREA)
8601 {
8602 prev_method = it->method;
8603 if (it->method == GET_FROM_BUFFER)
8604 prev_pos = IT_CHARPOS (*it);
8605 set_iterator_to_next (it, 1);
8606 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8607 SET_TEXT_POS (this_line_min_pos,
8608 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8609 if (it->bidi_p
8610 && (op & MOVE_TO_POS)
8611 && IT_CHARPOS (*it) > to_charpos
8612 && IT_CHARPOS (*it) < closest_pos)
8613 closest_pos = IT_CHARPOS (*it);
8614 continue;
8615 }
8616
8617 /* The number of glyphs we get back in IT->nglyphs will normally
8618 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8619 character on a terminal frame, or (iii) a line end. For the
8620 second case, IT->nglyphs - 1 padding glyphs will be present.
8621 (On X frames, there is only one glyph produced for a
8622 composite character.)
8623
8624 The behavior implemented below means, for continuation lines,
8625 that as many spaces of a TAB as fit on the current line are
8626 displayed there. For terminal frames, as many glyphs of a
8627 multi-glyph character are displayed in the current line, too.
8628 This is what the old redisplay code did, and we keep it that
8629 way. Under X, the whole shape of a complex character must
8630 fit on the line or it will be completely displayed in the
8631 next line.
8632
8633 Note that both for tabs and padding glyphs, all glyphs have
8634 the same width. */
8635 if (it->nglyphs)
8636 {
8637 /* More than one glyph or glyph doesn't fit on line. All
8638 glyphs have the same width. */
8639 int single_glyph_width = it->pixel_width / it->nglyphs;
8640 int new_x;
8641 int x_before_this_char = x;
8642 int hpos_before_this_char = it->hpos;
8643
8644 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8645 {
8646 new_x = x + single_glyph_width;
8647
8648 /* We want to leave anything reaching TO_X to the caller. */
8649 if ((op & MOVE_TO_X) && new_x > to_x)
8650 {
8651 if (BUFFER_POS_REACHED_P ())
8652 {
8653 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8654 goto buffer_pos_reached;
8655 if (atpos_it.sp < 0)
8656 {
8657 SAVE_IT (atpos_it, *it, atpos_data);
8658 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8659 }
8660 }
8661 else
8662 {
8663 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8664 {
8665 it->current_x = x;
8666 result = MOVE_X_REACHED;
8667 break;
8668 }
8669 if (atx_it.sp < 0)
8670 {
8671 SAVE_IT (atx_it, *it, atx_data);
8672 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8673 }
8674 }
8675 }
8676
8677 if (/* Lines are continued. */
8678 it->line_wrap != TRUNCATE
8679 && (/* And glyph doesn't fit on the line. */
8680 new_x > it->last_visible_x
8681 /* Or it fits exactly and we're on a window
8682 system frame. */
8683 || (new_x == it->last_visible_x
8684 && FRAME_WINDOW_P (it->f)
8685 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8686 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8687 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8688 {
8689 if (/* IT->hpos == 0 means the very first glyph
8690 doesn't fit on the line, e.g. a wide image. */
8691 it->hpos == 0
8692 || (new_x == it->last_visible_x
8693 && FRAME_WINDOW_P (it->f)
8694 /* When word-wrap is ON and we have a valid
8695 wrap point, we don't allow the last glyph
8696 to "just barely fit" on the line. */
8697 && (it->line_wrap != WORD_WRAP
8698 || wrap_it.sp < 0)))
8699 {
8700 ++it->hpos;
8701 it->current_x = new_x;
8702
8703 /* The character's last glyph just barely fits
8704 in this row. */
8705 if (i == it->nglyphs - 1)
8706 {
8707 /* If this is the destination position,
8708 return a position *before* it in this row,
8709 now that we know it fits in this row. */
8710 if (BUFFER_POS_REACHED_P ())
8711 {
8712 if (it->line_wrap != WORD_WRAP
8713 || wrap_it.sp < 0)
8714 {
8715 it->hpos = hpos_before_this_char;
8716 it->current_x = x_before_this_char;
8717 result = MOVE_POS_MATCH_OR_ZV;
8718 break;
8719 }
8720 if (it->line_wrap == WORD_WRAP
8721 && atpos_it.sp < 0)
8722 {
8723 SAVE_IT (atpos_it, *it, atpos_data);
8724 atpos_it.current_x = x_before_this_char;
8725 atpos_it.hpos = hpos_before_this_char;
8726 }
8727 }
8728
8729 prev_method = it->method;
8730 if (it->method == GET_FROM_BUFFER)
8731 prev_pos = IT_CHARPOS (*it);
8732 set_iterator_to_next (it, 1);
8733 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8734 SET_TEXT_POS (this_line_min_pos,
8735 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8736 /* On graphical terminals, newlines may
8737 "overflow" into the fringe if
8738 overflow-newline-into-fringe is non-nil.
8739 On text terminals, and on graphical
8740 terminals with no right margin, newlines
8741 may overflow into the last glyph on the
8742 display line.*/
8743 if (!FRAME_WINDOW_P (it->f)
8744 || ((it->bidi_p
8745 && it->bidi_it.paragraph_dir == R2L)
8746 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8747 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8748 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8749 {
8750 if (!get_next_display_element (it))
8751 {
8752 result = MOVE_POS_MATCH_OR_ZV;
8753 break;
8754 }
8755 if (BUFFER_POS_REACHED_P ())
8756 {
8757 if (ITERATOR_AT_END_OF_LINE_P (it))
8758 result = MOVE_POS_MATCH_OR_ZV;
8759 else
8760 result = MOVE_LINE_CONTINUED;
8761 break;
8762 }
8763 if (ITERATOR_AT_END_OF_LINE_P (it)
8764 && (it->line_wrap != WORD_WRAP
8765 || wrap_it.sp < 0))
8766 {
8767 result = MOVE_NEWLINE_OR_CR;
8768 break;
8769 }
8770 }
8771 }
8772 }
8773 else
8774 IT_RESET_X_ASCENT_DESCENT (it);
8775
8776 if (wrap_it.sp >= 0)
8777 {
8778 RESTORE_IT (it, &wrap_it, wrap_data);
8779 atpos_it.sp = -1;
8780 atx_it.sp = -1;
8781 }
8782
8783 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8784 IT_CHARPOS (*it)));
8785 result = MOVE_LINE_CONTINUED;
8786 break;
8787 }
8788
8789 if (BUFFER_POS_REACHED_P ())
8790 {
8791 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8792 goto buffer_pos_reached;
8793 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8794 {
8795 SAVE_IT (atpos_it, *it, atpos_data);
8796 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8797 }
8798 }
8799
8800 if (new_x > it->first_visible_x)
8801 {
8802 /* Glyph is visible. Increment number of glyphs that
8803 would be displayed. */
8804 ++it->hpos;
8805 }
8806 }
8807
8808 if (result != MOVE_UNDEFINED)
8809 break;
8810 }
8811 else if (BUFFER_POS_REACHED_P ())
8812 {
8813 buffer_pos_reached:
8814 IT_RESET_X_ASCENT_DESCENT (it);
8815 result = MOVE_POS_MATCH_OR_ZV;
8816 break;
8817 }
8818 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8819 {
8820 /* Stop when TO_X specified and reached. This check is
8821 necessary here because of lines consisting of a line end,
8822 only. The line end will not produce any glyphs and we
8823 would never get MOVE_X_REACHED. */
8824 eassert (it->nglyphs == 0);
8825 result = MOVE_X_REACHED;
8826 break;
8827 }
8828
8829 /* Is this a line end? If yes, we're done. */
8830 if (ITERATOR_AT_END_OF_LINE_P (it))
8831 {
8832 /* If we are past TO_CHARPOS, but never saw any character
8833 positions smaller than TO_CHARPOS, return
8834 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8835 did. */
8836 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
8837 {
8838 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
8839 {
8840 if (closest_pos < ZV)
8841 {
8842 RESTORE_IT (it, &ppos_it, ppos_data);
8843 /* Don't recurse if closest_pos is equal to
8844 to_charpos, since we have just tried that. */
8845 if (closest_pos != to_charpos)
8846 move_it_in_display_line_to (it, closest_pos, -1,
8847 MOVE_TO_POS);
8848 result = MOVE_POS_MATCH_OR_ZV;
8849 }
8850 else
8851 goto buffer_pos_reached;
8852 }
8853 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
8854 && IT_CHARPOS (*it) > to_charpos)
8855 goto buffer_pos_reached;
8856 else
8857 result = MOVE_NEWLINE_OR_CR;
8858 }
8859 else
8860 result = MOVE_NEWLINE_OR_CR;
8861 break;
8862 }
8863
8864 prev_method = it->method;
8865 if (it->method == GET_FROM_BUFFER)
8866 prev_pos = IT_CHARPOS (*it);
8867 /* The current display element has been consumed. Advance
8868 to the next. */
8869 set_iterator_to_next (it, 1);
8870 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8871 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8872 if (IT_CHARPOS (*it) < to_charpos)
8873 saw_smaller_pos = 1;
8874 if (it->bidi_p
8875 && (op & MOVE_TO_POS)
8876 && IT_CHARPOS (*it) >= to_charpos
8877 && IT_CHARPOS (*it) < closest_pos)
8878 closest_pos = IT_CHARPOS (*it);
8879
8880 /* Stop if lines are truncated and IT's current x-position is
8881 past the right edge of the window now. */
8882 if (it->line_wrap == TRUNCATE
8883 && it->current_x >= it->last_visible_x)
8884 {
8885 if (!FRAME_WINDOW_P (it->f)
8886 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8887 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8888 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8889 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8890 {
8891 int at_eob_p = 0;
8892
8893 if ((at_eob_p = !get_next_display_element (it))
8894 || BUFFER_POS_REACHED_P ()
8895 /* If we are past TO_CHARPOS, but never saw any
8896 character positions smaller than TO_CHARPOS,
8897 return MOVE_POS_MATCH_OR_ZV, like the
8898 unidirectional display did. */
8899 || (it->bidi_p && (op & MOVE_TO_POS) != 0
8900 && !saw_smaller_pos
8901 && IT_CHARPOS (*it) > to_charpos))
8902 {
8903 if (it->bidi_p
8904 && !BUFFER_POS_REACHED_P ()
8905 && !at_eob_p && closest_pos < ZV)
8906 {
8907 RESTORE_IT (it, &ppos_it, ppos_data);
8908 if (closest_pos != to_charpos)
8909 move_it_in_display_line_to (it, closest_pos, -1,
8910 MOVE_TO_POS);
8911 }
8912 result = MOVE_POS_MATCH_OR_ZV;
8913 break;
8914 }
8915 if (ITERATOR_AT_END_OF_LINE_P (it))
8916 {
8917 result = MOVE_NEWLINE_OR_CR;
8918 break;
8919 }
8920 }
8921 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
8922 && !saw_smaller_pos
8923 && IT_CHARPOS (*it) > to_charpos)
8924 {
8925 if (closest_pos < ZV)
8926 {
8927 RESTORE_IT (it, &ppos_it, ppos_data);
8928 if (closest_pos != to_charpos)
8929 move_it_in_display_line_to (it, closest_pos, -1,
8930 MOVE_TO_POS);
8931 }
8932 result = MOVE_POS_MATCH_OR_ZV;
8933 break;
8934 }
8935 result = MOVE_LINE_TRUNCATED;
8936 break;
8937 }
8938 #undef IT_RESET_X_ASCENT_DESCENT
8939 }
8940
8941 #undef BUFFER_POS_REACHED_P
8942
8943 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8944 restore the saved iterator. */
8945 if (atpos_it.sp >= 0)
8946 RESTORE_IT (it, &atpos_it, atpos_data);
8947 else if (atx_it.sp >= 0)
8948 RESTORE_IT (it, &atx_it, atx_data);
8949
8950 done:
8951
8952 if (atpos_data)
8953 bidi_unshelve_cache (atpos_data, 1);
8954 if (atx_data)
8955 bidi_unshelve_cache (atx_data, 1);
8956 if (wrap_data)
8957 bidi_unshelve_cache (wrap_data, 1);
8958 if (ppos_data)
8959 bidi_unshelve_cache (ppos_data, 1);
8960
8961 /* Restore the iterator settings altered at the beginning of this
8962 function. */
8963 it->glyph_row = saved_glyph_row;
8964 return result;
8965 }
8966
8967 /* For external use. */
8968 void
8969 move_it_in_display_line (struct it *it,
8970 ptrdiff_t to_charpos, int to_x,
8971 enum move_operation_enum op)
8972 {
8973 if (it->line_wrap == WORD_WRAP
8974 && (op & MOVE_TO_X))
8975 {
8976 struct it save_it;
8977 void *save_data = NULL;
8978 int skip;
8979
8980 SAVE_IT (save_it, *it, save_data);
8981 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
8982 /* When word-wrap is on, TO_X may lie past the end
8983 of a wrapped line. Then it->current is the
8984 character on the next line, so backtrack to the
8985 space before the wrap point. */
8986 if (skip == MOVE_LINE_CONTINUED)
8987 {
8988 int prev_x = max (it->current_x - 1, 0);
8989 RESTORE_IT (it, &save_it, save_data);
8990 move_it_in_display_line_to
8991 (it, -1, prev_x, MOVE_TO_X);
8992 }
8993 else
8994 bidi_unshelve_cache (save_data, 1);
8995 }
8996 else
8997 move_it_in_display_line_to (it, to_charpos, to_x, op);
8998 }
8999
9000
9001 /* Move IT forward until it satisfies one or more of the criteria in
9002 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9003
9004 OP is a bit-mask that specifies where to stop, and in particular,
9005 which of those four position arguments makes a difference. See the
9006 description of enum move_operation_enum.
9007
9008 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9009 screen line, this function will set IT to the next position that is
9010 displayed to the right of TO_CHARPOS on the screen.
9011
9012 Return the maximum pixel length of any line scanned but never more
9013 than it.last_visible_x. */
9014
9015 int
9016 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
9017 {
9018 enum move_it_result skip, skip2 = MOVE_X_REACHED;
9019 int line_height, line_start_x = 0, reached = 0;
9020 int max_current_x = 0;
9021 void *backup_data = NULL;
9022
9023 for (;;)
9024 {
9025 if (op & MOVE_TO_VPOS)
9026 {
9027 /* If no TO_CHARPOS and no TO_X specified, stop at the
9028 start of the line TO_VPOS. */
9029 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
9030 {
9031 if (it->vpos == to_vpos)
9032 {
9033 reached = 1;
9034 break;
9035 }
9036 else
9037 skip = move_it_in_display_line_to (it, -1, -1, 0);
9038 }
9039 else
9040 {
9041 /* TO_VPOS >= 0 means stop at TO_X in the line at
9042 TO_VPOS, or at TO_POS, whichever comes first. */
9043 if (it->vpos == to_vpos)
9044 {
9045 reached = 2;
9046 break;
9047 }
9048
9049 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9050
9051 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
9052 {
9053 reached = 3;
9054 break;
9055 }
9056 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
9057 {
9058 /* We have reached TO_X but not in the line we want. */
9059 skip = move_it_in_display_line_to (it, to_charpos,
9060 -1, MOVE_TO_POS);
9061 if (skip == MOVE_POS_MATCH_OR_ZV)
9062 {
9063 reached = 4;
9064 break;
9065 }
9066 }
9067 }
9068 }
9069 else if (op & MOVE_TO_Y)
9070 {
9071 struct it it_backup;
9072
9073 if (it->line_wrap == WORD_WRAP)
9074 SAVE_IT (it_backup, *it, backup_data);
9075
9076 /* TO_Y specified means stop at TO_X in the line containing
9077 TO_Y---or at TO_CHARPOS if this is reached first. The
9078 problem is that we can't really tell whether the line
9079 contains TO_Y before we have completely scanned it, and
9080 this may skip past TO_X. What we do is to first scan to
9081 TO_X.
9082
9083 If TO_X is not specified, use a TO_X of zero. The reason
9084 is to make the outcome of this function more predictable.
9085 If we didn't use TO_X == 0, we would stop at the end of
9086 the line which is probably not what a caller would expect
9087 to happen. */
9088 skip = move_it_in_display_line_to
9089 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
9090 (MOVE_TO_X | (op & MOVE_TO_POS)));
9091
9092 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9093 if (skip == MOVE_POS_MATCH_OR_ZV)
9094 reached = 5;
9095 else if (skip == MOVE_X_REACHED)
9096 {
9097 /* If TO_X was reached, we want to know whether TO_Y is
9098 in the line. We know this is the case if the already
9099 scanned glyphs make the line tall enough. Otherwise,
9100 we must check by scanning the rest of the line. */
9101 line_height = it->max_ascent + it->max_descent;
9102 if (to_y >= it->current_y
9103 && to_y < it->current_y + line_height)
9104 {
9105 reached = 6;
9106 break;
9107 }
9108 SAVE_IT (it_backup, *it, backup_data);
9109 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
9110 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
9111 op & MOVE_TO_POS);
9112 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
9113 line_height = it->max_ascent + it->max_descent;
9114 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9115
9116 if (to_y >= it->current_y
9117 && to_y < it->current_y + line_height)
9118 {
9119 /* If TO_Y is in this line and TO_X was reached
9120 above, we scanned too far. We have to restore
9121 IT's settings to the ones before skipping. But
9122 keep the more accurate values of max_ascent and
9123 max_descent we've found while skipping the rest
9124 of the line, for the sake of callers, such as
9125 pos_visible_p, that need to know the line
9126 height. */
9127 int max_ascent = it->max_ascent;
9128 int max_descent = it->max_descent;
9129
9130 RESTORE_IT (it, &it_backup, backup_data);
9131 it->max_ascent = max_ascent;
9132 it->max_descent = max_descent;
9133 reached = 6;
9134 }
9135 else
9136 {
9137 skip = skip2;
9138 if (skip == MOVE_POS_MATCH_OR_ZV)
9139 reached = 7;
9140 }
9141 }
9142 else
9143 {
9144 /* Check whether TO_Y is in this line. */
9145 line_height = it->max_ascent + it->max_descent;
9146 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9147
9148 if (to_y >= it->current_y
9149 && to_y < it->current_y + line_height)
9150 {
9151 if (to_y > it->current_y)
9152 max_current_x = max (it->current_x, max_current_x);
9153
9154 /* When word-wrap is on, TO_X may lie past the end
9155 of a wrapped line. Then it->current is the
9156 character on the next line, so backtrack to the
9157 space before the wrap point. */
9158 if (skip == MOVE_LINE_CONTINUED
9159 && it->line_wrap == WORD_WRAP)
9160 {
9161 int prev_x = max (it->current_x - 1, 0);
9162 RESTORE_IT (it, &it_backup, backup_data);
9163 skip = move_it_in_display_line_to
9164 (it, -1, prev_x, MOVE_TO_X);
9165 }
9166
9167 reached = 6;
9168 }
9169 }
9170
9171 if (reached)
9172 {
9173 max_current_x = max (it->current_x, max_current_x);
9174 break;
9175 }
9176 }
9177 else if (BUFFERP (it->object)
9178 && (it->method == GET_FROM_BUFFER
9179 || it->method == GET_FROM_STRETCH)
9180 && IT_CHARPOS (*it) >= to_charpos
9181 /* Under bidi iteration, a call to set_iterator_to_next
9182 can scan far beyond to_charpos if the initial
9183 portion of the next line needs to be reordered. In
9184 that case, give move_it_in_display_line_to another
9185 chance below. */
9186 && !(it->bidi_p
9187 && it->bidi_it.scan_dir == -1))
9188 skip = MOVE_POS_MATCH_OR_ZV;
9189 else
9190 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
9191
9192 switch (skip)
9193 {
9194 case MOVE_POS_MATCH_OR_ZV:
9195 max_current_x = max (it->current_x, max_current_x);
9196 reached = 8;
9197 goto out;
9198
9199 case MOVE_NEWLINE_OR_CR:
9200 max_current_x = max (it->current_x, max_current_x);
9201 set_iterator_to_next (it, 1);
9202 it->continuation_lines_width = 0;
9203 break;
9204
9205 case MOVE_LINE_TRUNCATED:
9206 max_current_x = it->last_visible_x;
9207 it->continuation_lines_width = 0;
9208 reseat_at_next_visible_line_start (it, 0);
9209 if ((op & MOVE_TO_POS) != 0
9210 && IT_CHARPOS (*it) > to_charpos)
9211 {
9212 reached = 9;
9213 goto out;
9214 }
9215 break;
9216
9217 case MOVE_LINE_CONTINUED:
9218 max_current_x = it->last_visible_x;
9219 /* For continued lines ending in a tab, some of the glyphs
9220 associated with the tab are displayed on the current
9221 line. Since it->current_x does not include these glyphs,
9222 we use it->last_visible_x instead. */
9223 if (it->c == '\t')
9224 {
9225 it->continuation_lines_width += it->last_visible_x;
9226 /* When moving by vpos, ensure that the iterator really
9227 advances to the next line (bug#847, bug#969). Fixme:
9228 do we need to do this in other circumstances? */
9229 if (it->current_x != it->last_visible_x
9230 && (op & MOVE_TO_VPOS)
9231 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
9232 {
9233 line_start_x = it->current_x + it->pixel_width
9234 - it->last_visible_x;
9235 set_iterator_to_next (it, 0);
9236 }
9237 }
9238 else
9239 it->continuation_lines_width += it->current_x;
9240 break;
9241
9242 default:
9243 emacs_abort ();
9244 }
9245
9246 /* Reset/increment for the next run. */
9247 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
9248 it->current_x = line_start_x;
9249 line_start_x = 0;
9250 it->hpos = 0;
9251 it->current_y += it->max_ascent + it->max_descent;
9252 ++it->vpos;
9253 last_height = it->max_ascent + it->max_descent;
9254 it->max_ascent = it->max_descent = 0;
9255 }
9256
9257 out:
9258
9259 /* On text terminals, we may stop at the end of a line in the middle
9260 of a multi-character glyph. If the glyph itself is continued,
9261 i.e. it is actually displayed on the next line, don't treat this
9262 stopping point as valid; move to the next line instead (unless
9263 that brings us offscreen). */
9264 if (!FRAME_WINDOW_P (it->f)
9265 && op & MOVE_TO_POS
9266 && IT_CHARPOS (*it) == to_charpos
9267 && it->what == IT_CHARACTER
9268 && it->nglyphs > 1
9269 && it->line_wrap == WINDOW_WRAP
9270 && it->current_x == it->last_visible_x - 1
9271 && it->c != '\n'
9272 && it->c != '\t'
9273 && it->vpos < it->w->window_end_vpos)
9274 {
9275 it->continuation_lines_width += it->current_x;
9276 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
9277 it->current_y += it->max_ascent + it->max_descent;
9278 ++it->vpos;
9279 last_height = it->max_ascent + it->max_descent;
9280 }
9281
9282 if (backup_data)
9283 bidi_unshelve_cache (backup_data, 1);
9284
9285 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
9286
9287 return max_current_x;
9288 }
9289
9290
9291 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9292
9293 If DY > 0, move IT backward at least that many pixels. DY = 0
9294 means move IT backward to the preceding line start or BEGV. This
9295 function may move over more than DY pixels if IT->current_y - DY
9296 ends up in the middle of a line; in this case IT->current_y will be
9297 set to the top of the line moved to. */
9298
9299 void
9300 move_it_vertically_backward (struct it *it, int dy)
9301 {
9302 int nlines, h;
9303 struct it it2, it3;
9304 void *it2data = NULL, *it3data = NULL;
9305 ptrdiff_t start_pos;
9306 int nchars_per_row
9307 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9308 ptrdiff_t pos_limit;
9309
9310 move_further_back:
9311 eassert (dy >= 0);
9312
9313 start_pos = IT_CHARPOS (*it);
9314
9315 /* Estimate how many newlines we must move back. */
9316 nlines = max (1, dy / default_line_pixel_height (it->w));
9317 if (it->line_wrap == TRUNCATE)
9318 pos_limit = BEGV;
9319 else
9320 pos_limit = max (start_pos - nlines * nchars_per_row, BEGV);
9321
9322 /* Set the iterator's position that many lines back. But don't go
9323 back more than NLINES full screen lines -- this wins a day with
9324 buffers which have very long lines. */
9325 while (nlines-- && IT_CHARPOS (*it) > pos_limit)
9326 back_to_previous_visible_line_start (it);
9327
9328 /* Reseat the iterator here. When moving backward, we don't want
9329 reseat to skip forward over invisible text, set up the iterator
9330 to deliver from overlay strings at the new position etc. So,
9331 use reseat_1 here. */
9332 reseat_1 (it, it->current.pos, 1);
9333
9334 /* We are now surely at a line start. */
9335 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
9336 reordering is in effect. */
9337 it->continuation_lines_width = 0;
9338
9339 /* Move forward and see what y-distance we moved. First move to the
9340 start of the next line so that we get its height. We need this
9341 height to be able to tell whether we reached the specified
9342 y-distance. */
9343 SAVE_IT (it2, *it, it2data);
9344 it2.max_ascent = it2.max_descent = 0;
9345 do
9346 {
9347 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
9348 MOVE_TO_POS | MOVE_TO_VPOS);
9349 }
9350 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9351 /* If we are in a display string which starts at START_POS,
9352 and that display string includes a newline, and we are
9353 right after that newline (i.e. at the beginning of a
9354 display line), exit the loop, because otherwise we will
9355 infloop, since move_it_to will see that it is already at
9356 START_POS and will not move. */
9357 || (it2.method == GET_FROM_STRING
9358 && IT_CHARPOS (it2) == start_pos
9359 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9360 eassert (IT_CHARPOS (*it) >= BEGV);
9361 SAVE_IT (it3, it2, it3data);
9362
9363 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9364 eassert (IT_CHARPOS (*it) >= BEGV);
9365 /* H is the actual vertical distance from the position in *IT
9366 and the starting position. */
9367 h = it2.current_y - it->current_y;
9368 /* NLINES is the distance in number of lines. */
9369 nlines = it2.vpos - it->vpos;
9370
9371 /* Correct IT's y and vpos position
9372 so that they are relative to the starting point. */
9373 it->vpos -= nlines;
9374 it->current_y -= h;
9375
9376 if (dy == 0)
9377 {
9378 /* DY == 0 means move to the start of the screen line. The
9379 value of nlines is > 0 if continuation lines were involved,
9380 or if the original IT position was at start of a line. */
9381 RESTORE_IT (it, it, it2data);
9382 if (nlines > 0)
9383 move_it_by_lines (it, nlines);
9384 /* The above code moves us to some position NLINES down,
9385 usually to its first glyph (leftmost in an L2R line), but
9386 that's not necessarily the start of the line, under bidi
9387 reordering. We want to get to the character position
9388 that is immediately after the newline of the previous
9389 line. */
9390 if (it->bidi_p
9391 && !it->continuation_lines_width
9392 && !STRINGP (it->string)
9393 && IT_CHARPOS (*it) > BEGV
9394 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9395 {
9396 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
9397
9398 DEC_BOTH (cp, bp);
9399 cp = find_newline_no_quit (cp, bp, -1, NULL);
9400 move_it_to (it, cp, -1, -1, -1, MOVE_TO_POS);
9401 }
9402 bidi_unshelve_cache (it3data, 1);
9403 }
9404 else
9405 {
9406 /* The y-position we try to reach, relative to *IT.
9407 Note that H has been subtracted in front of the if-statement. */
9408 int target_y = it->current_y + h - dy;
9409 int y0 = it3.current_y;
9410 int y1;
9411 int line_height;
9412
9413 RESTORE_IT (&it3, &it3, it3data);
9414 y1 = line_bottom_y (&it3);
9415 line_height = y1 - y0;
9416 RESTORE_IT (it, it, it2data);
9417 /* If we did not reach target_y, try to move further backward if
9418 we can. If we moved too far backward, try to move forward. */
9419 if (target_y < it->current_y
9420 /* This is heuristic. In a window that's 3 lines high, with
9421 a line height of 13 pixels each, recentering with point
9422 on the bottom line will try to move -39/2 = 19 pixels
9423 backward. Try to avoid moving into the first line. */
9424 && (it->current_y - target_y
9425 > min (window_box_height (it->w), line_height * 2 / 3))
9426 && IT_CHARPOS (*it) > BEGV)
9427 {
9428 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9429 target_y - it->current_y));
9430 dy = it->current_y - target_y;
9431 goto move_further_back;
9432 }
9433 else if (target_y >= it->current_y + line_height
9434 && IT_CHARPOS (*it) < ZV)
9435 {
9436 /* Should move forward by at least one line, maybe more.
9437
9438 Note: Calling move_it_by_lines can be expensive on
9439 terminal frames, where compute_motion is used (via
9440 vmotion) to do the job, when there are very long lines
9441 and truncate-lines is nil. That's the reason for
9442 treating terminal frames specially here. */
9443
9444 if (!FRAME_WINDOW_P (it->f))
9445 move_it_vertically (it, target_y - (it->current_y + line_height));
9446 else
9447 {
9448 do
9449 {
9450 move_it_by_lines (it, 1);
9451 }
9452 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9453 }
9454 }
9455 }
9456 }
9457
9458
9459 /* Move IT by a specified amount of pixel lines DY. DY negative means
9460 move backwards. DY = 0 means move to start of screen line. At the
9461 end, IT will be on the start of a screen line. */
9462
9463 void
9464 move_it_vertically (struct it *it, int dy)
9465 {
9466 if (dy <= 0)
9467 move_it_vertically_backward (it, -dy);
9468 else
9469 {
9470 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9471 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9472 MOVE_TO_POS | MOVE_TO_Y);
9473 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9474
9475 /* If buffer ends in ZV without a newline, move to the start of
9476 the line to satisfy the post-condition. */
9477 if (IT_CHARPOS (*it) == ZV
9478 && ZV > BEGV
9479 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9480 move_it_by_lines (it, 0);
9481 }
9482 }
9483
9484
9485 /* Move iterator IT past the end of the text line it is in. */
9486
9487 void
9488 move_it_past_eol (struct it *it)
9489 {
9490 enum move_it_result rc;
9491
9492 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9493 if (rc == MOVE_NEWLINE_OR_CR)
9494 set_iterator_to_next (it, 0);
9495 }
9496
9497
9498 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9499 negative means move up. DVPOS == 0 means move to the start of the
9500 screen line.
9501
9502 Optimization idea: If we would know that IT->f doesn't use
9503 a face with proportional font, we could be faster for
9504 truncate-lines nil. */
9505
9506 void
9507 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9508 {
9509
9510 /* The commented-out optimization uses vmotion on terminals. This
9511 gives bad results, because elements like it->what, on which
9512 callers such as pos_visible_p rely, aren't updated. */
9513 /* struct position pos;
9514 if (!FRAME_WINDOW_P (it->f))
9515 {
9516 struct text_pos textpos;
9517
9518 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9519 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9520 reseat (it, textpos, 1);
9521 it->vpos += pos.vpos;
9522 it->current_y += pos.vpos;
9523 }
9524 else */
9525
9526 if (dvpos == 0)
9527 {
9528 /* DVPOS == 0 means move to the start of the screen line. */
9529 move_it_vertically_backward (it, 0);
9530 /* Let next call to line_bottom_y calculate real line height. */
9531 last_height = 0;
9532 }
9533 else if (dvpos > 0)
9534 {
9535 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9536 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9537 {
9538 /* Only move to the next buffer position if we ended up in a
9539 string from display property, not in an overlay string
9540 (before-string or after-string). That is because the
9541 latter don't conceal the underlying buffer position, so
9542 we can ask to move the iterator to the exact position we
9543 are interested in. Note that, even if we are already at
9544 IT_CHARPOS (*it), the call below is not a no-op, as it
9545 will detect that we are at the end of the string, pop the
9546 iterator, and compute it->current_x and it->hpos
9547 correctly. */
9548 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9549 -1, -1, -1, MOVE_TO_POS);
9550 }
9551 }
9552 else
9553 {
9554 struct it it2;
9555 void *it2data = NULL;
9556 ptrdiff_t start_charpos, i;
9557 int nchars_per_row
9558 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9559 bool hit_pos_limit = false;
9560 ptrdiff_t pos_limit;
9561
9562 /* Start at the beginning of the screen line containing IT's
9563 position. This may actually move vertically backwards,
9564 in case of overlays, so adjust dvpos accordingly. */
9565 dvpos += it->vpos;
9566 move_it_vertically_backward (it, 0);
9567 dvpos -= it->vpos;
9568
9569 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9570 screen lines, and reseat the iterator there. */
9571 start_charpos = IT_CHARPOS (*it);
9572 if (it->line_wrap == TRUNCATE)
9573 pos_limit = BEGV;
9574 else
9575 pos_limit = max (start_charpos + dvpos * nchars_per_row, BEGV);
9576
9577 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > pos_limit; --i)
9578 back_to_previous_visible_line_start (it);
9579 if (i > 0 && IT_CHARPOS (*it) <= pos_limit)
9580 hit_pos_limit = true;
9581 reseat (it, it->current.pos, 1);
9582
9583 /* Move further back if we end up in a string or an image. */
9584 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9585 {
9586 /* First try to move to start of display line. */
9587 dvpos += it->vpos;
9588 move_it_vertically_backward (it, 0);
9589 dvpos -= it->vpos;
9590 if (IT_POS_VALID_AFTER_MOVE_P (it))
9591 break;
9592 /* If start of line is still in string or image,
9593 move further back. */
9594 back_to_previous_visible_line_start (it);
9595 reseat (it, it->current.pos, 1);
9596 dvpos--;
9597 }
9598
9599 it->current_x = it->hpos = 0;
9600
9601 /* Above call may have moved too far if continuation lines
9602 are involved. Scan forward and see if it did. */
9603 SAVE_IT (it2, *it, it2data);
9604 it2.vpos = it2.current_y = 0;
9605 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9606 it->vpos -= it2.vpos;
9607 it->current_y -= it2.current_y;
9608 it->current_x = it->hpos = 0;
9609
9610 /* If we moved too far back, move IT some lines forward. */
9611 if (it2.vpos > -dvpos)
9612 {
9613 int delta = it2.vpos + dvpos;
9614
9615 RESTORE_IT (&it2, &it2, it2data);
9616 SAVE_IT (it2, *it, it2data);
9617 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9618 /* Move back again if we got too far ahead. */
9619 if (IT_CHARPOS (*it) >= start_charpos)
9620 RESTORE_IT (it, &it2, it2data);
9621 else
9622 bidi_unshelve_cache (it2data, 1);
9623 }
9624 else if (hit_pos_limit && pos_limit > BEGV
9625 && dvpos < 0 && it2.vpos < -dvpos)
9626 {
9627 /* If we hit the limit, but still didn't make it far enough
9628 back, that means there's a display string with a newline
9629 covering a large chunk of text, and that caused
9630 back_to_previous_visible_line_start try to go too far.
9631 Punish those who commit such atrocities by going back
9632 until we've reached DVPOS, after lifting the limit, which
9633 could make it slow for very long lines. "If it hurts,
9634 don't do that!" */
9635 dvpos += it2.vpos;
9636 RESTORE_IT (it, it, it2data);
9637 for (i = -dvpos; i > 0; --i)
9638 {
9639 back_to_previous_visible_line_start (it);
9640 it->vpos--;
9641 }
9642 }
9643 else
9644 RESTORE_IT (it, it, it2data);
9645 }
9646 }
9647
9648 /* Return true if IT points into the middle of a display vector. */
9649
9650 bool
9651 in_display_vector_p (struct it *it)
9652 {
9653 return (it->method == GET_FROM_DISPLAY_VECTOR
9654 && it->current.dpvec_index > 0
9655 && it->dpvec + it->current.dpvec_index != it->dpend);
9656 }
9657
9658 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9659 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9660 WINDOW must be a live window and defaults to the selected one. The
9661 return value is a cons of the maximum pixel-width of any text line and
9662 the maximum pixel-height of all text lines.
9663
9664 The optional argument FROM, if non-nil, specifies the first text
9665 position and defaults to the minimum accessible position of the buffer.
9666 If FROM is t, use the minimum accessible position that is not a newline
9667 character. TO, if non-nil, specifies the last text position and
9668 defaults to the maximum accessible position of the buffer. If TO is t,
9669 use the maximum accessible position that is not a newline character.
9670
9671 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9672 width that can be returned. X-LIMIT nil or omitted, means to use the
9673 pixel-width of WINDOW's body; use this if you do not intend to change
9674 the width of WINDOW. Use the maximum width WINDOW may assume if you
9675 intend to change WINDOW's width. In any case, text whose x-coordinate
9676 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9677 can take some time, it's always a good idea to make this argument as
9678 small as possible; in particular, if the buffer contains long lines that
9679 shall be truncated anyway.
9680
9681 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9682 height that can be returned. Text lines whose y-coordinate is beyond
9683 Y-LIMIT are ignored. Since calculating the text height of a large
9684 buffer can take some time, it makes sense to specify this argument if
9685 the size of the buffer is unknown.
9686
9687 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9688 include the height of the mode- or header-line of WINDOW in the return
9689 value. If it is either the symbol `mode-line' or `header-line', include
9690 only the height of that line, if present, in the return value. If t,
9691 include the height of both, if present, in the return value. */)
9692 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit, Lisp_Object y_limit,
9693 Lisp_Object mode_and_header_line)
9694 {
9695 struct window *w = decode_live_window (window);
9696 Lisp_Object buf;
9697 struct buffer *b;
9698 struct it it;
9699 struct buffer *old_buffer = NULL;
9700 ptrdiff_t start, end, pos;
9701 struct text_pos startp;
9702 void *itdata = NULL;
9703 int c, max_y = -1, x = 0, y = 0;
9704
9705 buf = w->contents;
9706 CHECK_BUFFER (buf);
9707 b = XBUFFER (buf);
9708
9709 if (b != current_buffer)
9710 {
9711 old_buffer = current_buffer;
9712 set_buffer_internal (b);
9713 }
9714
9715 if (NILP (from))
9716 start = BEGV;
9717 else if (EQ (from, Qt))
9718 {
9719 start = pos = BEGV;
9720 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9721 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9722 start = pos;
9723 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9724 start = pos;
9725 }
9726 else
9727 {
9728 CHECK_NUMBER_COERCE_MARKER (from);
9729 start = min (max (XINT (from), BEGV), ZV);
9730 }
9731
9732 if (NILP (to))
9733 end = ZV;
9734 else if (EQ (to, Qt))
9735 {
9736 end = pos = ZV;
9737 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9738 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9739 end = pos;
9740 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9741 end = pos;
9742 }
9743 else
9744 {
9745 CHECK_NUMBER_COERCE_MARKER (to);
9746 end = max (start, min (XINT (to), ZV));
9747 }
9748
9749 if (!NILP (y_limit))
9750 {
9751 CHECK_NUMBER (y_limit);
9752 max_y = min (XINT (y_limit), INT_MAX);
9753 }
9754
9755 itdata = bidi_shelve_cache ();
9756 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9757 start_display (&it, w, startp);
9758
9759 if (NILP (x_limit))
9760 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9761 else
9762 {
9763 CHECK_NUMBER (x_limit);
9764 it.last_visible_x = min (XINT (x_limit), INFINITY);
9765 /* Actually, we never want move_it_to stop at to_x. But to make
9766 sure that move_it_in_display_line_to always moves far enough,
9767 we set it to INT_MAX and specify MOVE_TO_X. */
9768 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9769 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9770 }
9771
9772 y = it.current_y + it.max_ascent + it.max_descent;
9773
9774 if (!EQ (mode_and_header_line, Qheader_line)
9775 && !EQ (mode_and_header_line, Qt))
9776 /* Do not count the header-line which was counted automatically by
9777 start_display. */
9778 y = y - WINDOW_HEADER_LINE_HEIGHT (w);
9779
9780 if (EQ (mode_and_header_line, Qmode_line)
9781 || EQ (mode_and_header_line, Qt))
9782 /* Do count the mode-line which is not included automatically by
9783 start_display. */
9784 y = y + WINDOW_MODE_LINE_HEIGHT (w);
9785
9786 bidi_unshelve_cache (itdata, 0);
9787
9788 if (old_buffer)
9789 set_buffer_internal (old_buffer);
9790
9791 return Fcons (make_number (x), make_number (y));
9792 }
9793 \f
9794 /***********************************************************************
9795 Messages
9796 ***********************************************************************/
9797
9798
9799 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9800 to *Messages*. */
9801
9802 void
9803 add_to_log (const char *format, Lisp_Object arg1, Lisp_Object arg2)
9804 {
9805 Lisp_Object args[3];
9806 Lisp_Object msg, fmt;
9807 char *buffer;
9808 ptrdiff_t len;
9809 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9810 USE_SAFE_ALLOCA;
9811
9812 fmt = msg = Qnil;
9813 GCPRO4 (fmt, msg, arg1, arg2);
9814
9815 args[0] = fmt = build_string (format);
9816 args[1] = arg1;
9817 args[2] = arg2;
9818 msg = Fformat (3, args);
9819
9820 len = SBYTES (msg) + 1;
9821 buffer = SAFE_ALLOCA (len);
9822 memcpy (buffer, SDATA (msg), len);
9823
9824 message_dolog (buffer, len - 1, 1, 0);
9825 SAFE_FREE ();
9826
9827 UNGCPRO;
9828 }
9829
9830
9831 /* Output a newline in the *Messages* buffer if "needs" one. */
9832
9833 void
9834 message_log_maybe_newline (void)
9835 {
9836 if (message_log_need_newline)
9837 message_dolog ("", 0, 1, 0);
9838 }
9839
9840
9841 /* Add a string M of length NBYTES to the message log, optionally
9842 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9843 true, means interpret the contents of M as multibyte. This
9844 function calls low-level routines in order to bypass text property
9845 hooks, etc. which might not be safe to run.
9846
9847 This may GC (insert may run before/after change hooks),
9848 so the buffer M must NOT point to a Lisp string. */
9849
9850 void
9851 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
9852 {
9853 const unsigned char *msg = (const unsigned char *) m;
9854
9855 if (!NILP (Vmemory_full))
9856 return;
9857
9858 if (!NILP (Vmessage_log_max))
9859 {
9860 struct buffer *oldbuf;
9861 Lisp_Object oldpoint, oldbegv, oldzv;
9862 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9863 ptrdiff_t point_at_end = 0;
9864 ptrdiff_t zv_at_end = 0;
9865 Lisp_Object old_deactivate_mark;
9866 struct gcpro gcpro1;
9867
9868 old_deactivate_mark = Vdeactivate_mark;
9869 oldbuf = current_buffer;
9870
9871 /* Ensure the Messages buffer exists, and switch to it.
9872 If we created it, set the major-mode. */
9873 {
9874 int newbuffer = 0;
9875 if (NILP (Fget_buffer (Vmessages_buffer_name))) newbuffer = 1;
9876
9877 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9878
9879 if (newbuffer
9880 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9881 call0 (intern ("messages-buffer-mode"));
9882 }
9883
9884 bset_undo_list (current_buffer, Qt);
9885 bset_cache_long_scans (current_buffer, Qnil);
9886
9887 oldpoint = message_dolog_marker1;
9888 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
9889 oldbegv = message_dolog_marker2;
9890 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
9891 oldzv = message_dolog_marker3;
9892 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
9893 GCPRO1 (old_deactivate_mark);
9894
9895 if (PT == Z)
9896 point_at_end = 1;
9897 if (ZV == Z)
9898 zv_at_end = 1;
9899
9900 BEGV = BEG;
9901 BEGV_BYTE = BEG_BYTE;
9902 ZV = Z;
9903 ZV_BYTE = Z_BYTE;
9904 TEMP_SET_PT_BOTH (Z, Z_BYTE);
9905
9906 /* Insert the string--maybe converting multibyte to single byte
9907 or vice versa, so that all the text fits the buffer. */
9908 if (multibyte
9909 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
9910 {
9911 ptrdiff_t i;
9912 int c, char_bytes;
9913 char work[1];
9914
9915 /* Convert a multibyte string to single-byte
9916 for the *Message* buffer. */
9917 for (i = 0; i < nbytes; i += char_bytes)
9918 {
9919 c = string_char_and_length (msg + i, &char_bytes);
9920 work[0] = (ASCII_CHAR_P (c)
9921 ? c
9922 : multibyte_char_to_unibyte (c));
9923 insert_1_both (work, 1, 1, 1, 0, 0);
9924 }
9925 }
9926 else if (! multibyte
9927 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
9928 {
9929 ptrdiff_t i;
9930 int c, char_bytes;
9931 unsigned char str[MAX_MULTIBYTE_LENGTH];
9932 /* Convert a single-byte string to multibyte
9933 for the *Message* buffer. */
9934 for (i = 0; i < nbytes; i++)
9935 {
9936 c = msg[i];
9937 MAKE_CHAR_MULTIBYTE (c);
9938 char_bytes = CHAR_STRING (c, str);
9939 insert_1_both ((char *) str, 1, char_bytes, 1, 0, 0);
9940 }
9941 }
9942 else if (nbytes)
9943 insert_1_both (m, chars_in_text (msg, nbytes), nbytes, 1, 0, 0);
9944
9945 if (nlflag)
9946 {
9947 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
9948 printmax_t dups;
9949
9950 insert_1_both ("\n", 1, 1, 1, 0, 0);
9951
9952 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, 0);
9953 this_bol = PT;
9954 this_bol_byte = PT_BYTE;
9955
9956 /* See if this line duplicates the previous one.
9957 If so, combine duplicates. */
9958 if (this_bol > BEG)
9959 {
9960 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, 0);
9961 prev_bol = PT;
9962 prev_bol_byte = PT_BYTE;
9963
9964 dups = message_log_check_duplicate (prev_bol_byte,
9965 this_bol_byte);
9966 if (dups)
9967 {
9968 del_range_both (prev_bol, prev_bol_byte,
9969 this_bol, this_bol_byte, 0);
9970 if (dups > 1)
9971 {
9972 char dupstr[sizeof " [ times]"
9973 + INT_STRLEN_BOUND (printmax_t)];
9974
9975 /* If you change this format, don't forget to also
9976 change message_log_check_duplicate. */
9977 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
9978 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
9979 insert_1_both (dupstr, duplen, duplen, 1, 0, 1);
9980 }
9981 }
9982 }
9983
9984 /* If we have more than the desired maximum number of lines
9985 in the *Messages* buffer now, delete the oldest ones.
9986 This is safe because we don't have undo in this buffer. */
9987
9988 if (NATNUMP (Vmessage_log_max))
9989 {
9990 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
9991 -XFASTINT (Vmessage_log_max) - 1, 0);
9992 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, 0);
9993 }
9994 }
9995 BEGV = marker_position (oldbegv);
9996 BEGV_BYTE = marker_byte_position (oldbegv);
9997
9998 if (zv_at_end)
9999 {
10000 ZV = Z;
10001 ZV_BYTE = Z_BYTE;
10002 }
10003 else
10004 {
10005 ZV = marker_position (oldzv);
10006 ZV_BYTE = marker_byte_position (oldzv);
10007 }
10008
10009 if (point_at_end)
10010 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10011 else
10012 /* We can't do Fgoto_char (oldpoint) because it will run some
10013 Lisp code. */
10014 TEMP_SET_PT_BOTH (marker_position (oldpoint),
10015 marker_byte_position (oldpoint));
10016
10017 UNGCPRO;
10018 unchain_marker (XMARKER (oldpoint));
10019 unchain_marker (XMARKER (oldbegv));
10020 unchain_marker (XMARKER (oldzv));
10021
10022 /* We called insert_1_both above with its 5th argument (PREPARE)
10023 zero, which prevents insert_1_both from calling
10024 prepare_to_modify_buffer, which in turns prevents us from
10025 incrementing windows_or_buffers_changed even if *Messages* is
10026 shown in some window. So we must manually set
10027 windows_or_buffers_changed here to make up for that. */
10028 windows_or_buffers_changed = old_windows_or_buffers_changed;
10029 bset_redisplay (current_buffer);
10030
10031 set_buffer_internal (oldbuf);
10032
10033 message_log_need_newline = !nlflag;
10034 Vdeactivate_mark = old_deactivate_mark;
10035 }
10036 }
10037
10038
10039 /* We are at the end of the buffer after just having inserted a newline.
10040 (Note: We depend on the fact we won't be crossing the gap.)
10041 Check to see if the most recent message looks a lot like the previous one.
10042 Return 0 if different, 1 if the new one should just replace it, or a
10043 value N > 1 if we should also append " [N times]". */
10044
10045 static intmax_t
10046 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
10047 {
10048 ptrdiff_t i;
10049 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
10050 int seen_dots = 0;
10051 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
10052 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
10053
10054 for (i = 0; i < len; i++)
10055 {
10056 if (i >= 3 && p1[i - 3] == '.' && p1[i - 2] == '.' && p1[i - 1] == '.')
10057 seen_dots = 1;
10058 if (p1[i] != p2[i])
10059 return seen_dots;
10060 }
10061 p1 += len;
10062 if (*p1 == '\n')
10063 return 2;
10064 if (*p1++ == ' ' && *p1++ == '[')
10065 {
10066 char *pend;
10067 intmax_t n = strtoimax ((char *) p1, &pend, 10);
10068 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
10069 return n + 1;
10070 }
10071 return 0;
10072 }
10073 \f
10074
10075 /* Display an echo area message M with a specified length of NBYTES
10076 bytes. The string may include null characters. If M is not a
10077 string, clear out any existing message, and let the mini-buffer
10078 text show through.
10079
10080 This function cancels echoing. */
10081
10082 void
10083 message3 (Lisp_Object m)
10084 {
10085 struct gcpro gcpro1;
10086
10087 GCPRO1 (m);
10088 clear_message (true, true);
10089 cancel_echoing ();
10090
10091 /* First flush out any partial line written with print. */
10092 message_log_maybe_newline ();
10093 if (STRINGP (m))
10094 {
10095 ptrdiff_t nbytes = SBYTES (m);
10096 bool multibyte = STRING_MULTIBYTE (m);
10097 USE_SAFE_ALLOCA;
10098 char *buffer = SAFE_ALLOCA (nbytes);
10099 memcpy (buffer, SDATA (m), nbytes);
10100 message_dolog (buffer, nbytes, 1, multibyte);
10101 SAFE_FREE ();
10102 }
10103 message3_nolog (m);
10104
10105 UNGCPRO;
10106 }
10107
10108
10109 /* The non-logging version of message3.
10110 This does not cancel echoing, because it is used for echoing.
10111 Perhaps we need to make a separate function for echoing
10112 and make this cancel echoing. */
10113
10114 void
10115 message3_nolog (Lisp_Object m)
10116 {
10117 struct frame *sf = SELECTED_FRAME ();
10118
10119 if (FRAME_INITIAL_P (sf))
10120 {
10121 if (noninteractive_need_newline)
10122 putc ('\n', stderr);
10123 noninteractive_need_newline = 0;
10124 if (STRINGP (m))
10125 {
10126 Lisp_Object s = ENCODE_SYSTEM (m);
10127
10128 fwrite (SDATA (s), SBYTES (s), 1, stderr);
10129 }
10130 if (cursor_in_echo_area == 0)
10131 fprintf (stderr, "\n");
10132 fflush (stderr);
10133 }
10134 /* Error messages get reported properly by cmd_error, so this must be just an
10135 informative message; if the frame hasn't really been initialized yet, just
10136 toss it. */
10137 else if (INTERACTIVE && sf->glyphs_initialized_p)
10138 {
10139 /* Get the frame containing the mini-buffer
10140 that the selected frame is using. */
10141 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
10142 Lisp_Object frame = XWINDOW (mini_window)->frame;
10143 struct frame *f = XFRAME (frame);
10144
10145 if (FRAME_VISIBLE_P (sf) && !FRAME_VISIBLE_P (f))
10146 Fmake_frame_visible (frame);
10147
10148 if (STRINGP (m) && SCHARS (m) > 0)
10149 {
10150 set_message (m);
10151 if (minibuffer_auto_raise)
10152 Fraise_frame (frame);
10153 /* Assume we are not echoing.
10154 (If we are, echo_now will override this.) */
10155 echo_message_buffer = Qnil;
10156 }
10157 else
10158 clear_message (true, true);
10159
10160 do_pending_window_change (0);
10161 echo_area_display (1);
10162 do_pending_window_change (0);
10163 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
10164 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
10165 }
10166 }
10167
10168
10169 /* Display a null-terminated echo area message M. If M is 0, clear
10170 out any existing message, and let the mini-buffer text show through.
10171
10172 The buffer M must continue to exist until after the echo area gets
10173 cleared or some other message gets displayed there. Do not pass
10174 text that is stored in a Lisp string. Do not pass text in a buffer
10175 that was alloca'd. */
10176
10177 void
10178 message1 (const char *m)
10179 {
10180 message3 (m ? build_unibyte_string (m) : Qnil);
10181 }
10182
10183
10184 /* The non-logging counterpart of message1. */
10185
10186 void
10187 message1_nolog (const char *m)
10188 {
10189 message3_nolog (m ? build_unibyte_string (m) : Qnil);
10190 }
10191
10192 /* Display a message M which contains a single %s
10193 which gets replaced with STRING. */
10194
10195 void
10196 message_with_string (const char *m, Lisp_Object string, int log)
10197 {
10198 CHECK_STRING (string);
10199
10200 if (noninteractive)
10201 {
10202 if (m)
10203 {
10204 /* ENCODE_SYSTEM below can GC and/or relocate the
10205 Lisp data, so make sure we don't use it here. */
10206 eassert (relocatable_string_data_p (m) != 1);
10207
10208 if (noninteractive_need_newline)
10209 putc ('\n', stderr);
10210 noninteractive_need_newline = 0;
10211 fprintf (stderr, m, SDATA (ENCODE_SYSTEM (string)));
10212 if (!cursor_in_echo_area)
10213 fprintf (stderr, "\n");
10214 fflush (stderr);
10215 }
10216 }
10217 else if (INTERACTIVE)
10218 {
10219 /* The frame whose minibuffer we're going to display the message on.
10220 It may be larger than the selected frame, so we need
10221 to use its buffer, not the selected frame's buffer. */
10222 Lisp_Object mini_window;
10223 struct frame *f, *sf = SELECTED_FRAME ();
10224
10225 /* Get the frame containing the minibuffer
10226 that the selected frame is using. */
10227 mini_window = FRAME_MINIBUF_WINDOW (sf);
10228 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10229
10230 /* Error messages get reported properly by cmd_error, so this must be
10231 just an informative message; if the frame hasn't really been
10232 initialized yet, just toss it. */
10233 if (f->glyphs_initialized_p)
10234 {
10235 Lisp_Object args[2], msg;
10236 struct gcpro gcpro1, gcpro2;
10237
10238 args[0] = build_string (m);
10239 args[1] = msg = string;
10240 GCPRO2 (args[0], msg);
10241 gcpro1.nvars = 2;
10242
10243 msg = Fformat (2, args);
10244
10245 if (log)
10246 message3 (msg);
10247 else
10248 message3_nolog (msg);
10249
10250 UNGCPRO;
10251
10252 /* Print should start at the beginning of the message
10253 buffer next time. */
10254 message_buf_print = 0;
10255 }
10256 }
10257 }
10258
10259
10260 /* Dump an informative message to the minibuf. If M is 0, clear out
10261 any existing message, and let the mini-buffer text show through. */
10262
10263 static void
10264 vmessage (const char *m, va_list ap)
10265 {
10266 if (noninteractive)
10267 {
10268 if (m)
10269 {
10270 if (noninteractive_need_newline)
10271 putc ('\n', stderr);
10272 noninteractive_need_newline = 0;
10273 vfprintf (stderr, m, ap);
10274 if (cursor_in_echo_area == 0)
10275 fprintf (stderr, "\n");
10276 fflush (stderr);
10277 }
10278 }
10279 else if (INTERACTIVE)
10280 {
10281 /* The frame whose mini-buffer we're going to display the message
10282 on. It may be larger than the selected frame, so we need to
10283 use its buffer, not the selected frame's buffer. */
10284 Lisp_Object mini_window;
10285 struct frame *f, *sf = SELECTED_FRAME ();
10286
10287 /* Get the frame containing the mini-buffer
10288 that the selected frame is using. */
10289 mini_window = FRAME_MINIBUF_WINDOW (sf);
10290 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10291
10292 /* Error messages get reported properly by cmd_error, so this must be
10293 just an informative message; if the frame hasn't really been
10294 initialized yet, just toss it. */
10295 if (f->glyphs_initialized_p)
10296 {
10297 if (m)
10298 {
10299 ptrdiff_t len;
10300 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10301 char *message_buf = alloca (maxsize + 1);
10302
10303 len = doprnt (message_buf, maxsize, m, 0, ap);
10304
10305 message3 (make_string (message_buf, len));
10306 }
10307 else
10308 message1 (0);
10309
10310 /* Print should start at the beginning of the message
10311 buffer next time. */
10312 message_buf_print = 0;
10313 }
10314 }
10315 }
10316
10317 void
10318 message (const char *m, ...)
10319 {
10320 va_list ap;
10321 va_start (ap, m);
10322 vmessage (m, ap);
10323 va_end (ap);
10324 }
10325
10326
10327 #if 0
10328 /* The non-logging version of message. */
10329
10330 void
10331 message_nolog (const char *m, ...)
10332 {
10333 Lisp_Object old_log_max;
10334 va_list ap;
10335 va_start (ap, m);
10336 old_log_max = Vmessage_log_max;
10337 Vmessage_log_max = Qnil;
10338 vmessage (m, ap);
10339 Vmessage_log_max = old_log_max;
10340 va_end (ap);
10341 }
10342 #endif
10343
10344
10345 /* Display the current message in the current mini-buffer. This is
10346 only called from error handlers in process.c, and is not time
10347 critical. */
10348
10349 void
10350 update_echo_area (void)
10351 {
10352 if (!NILP (echo_area_buffer[0]))
10353 {
10354 Lisp_Object string;
10355 string = Fcurrent_message ();
10356 message3 (string);
10357 }
10358 }
10359
10360
10361 /* Make sure echo area buffers in `echo_buffers' are live.
10362 If they aren't, make new ones. */
10363
10364 static void
10365 ensure_echo_area_buffers (void)
10366 {
10367 int i;
10368
10369 for (i = 0; i < 2; ++i)
10370 if (!BUFFERP (echo_buffer[i])
10371 || !BUFFER_LIVE_P (XBUFFER (echo_buffer[i])))
10372 {
10373 char name[30];
10374 Lisp_Object old_buffer;
10375 int j;
10376
10377 old_buffer = echo_buffer[i];
10378 echo_buffer[i] = Fget_buffer_create
10379 (make_formatted_string (name, " *Echo Area %d*", i));
10380 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
10381 /* to force word wrap in echo area -
10382 it was decided to postpone this*/
10383 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10384
10385 for (j = 0; j < 2; ++j)
10386 if (EQ (old_buffer, echo_area_buffer[j]))
10387 echo_area_buffer[j] = echo_buffer[i];
10388 }
10389 }
10390
10391
10392 /* Call FN with args A1..A2 with either the current or last displayed
10393 echo_area_buffer as current buffer.
10394
10395 WHICH zero means use the current message buffer
10396 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10397 from echo_buffer[] and clear it.
10398
10399 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10400 suitable buffer from echo_buffer[] and clear it.
10401
10402 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10403 that the current message becomes the last displayed one, make
10404 choose a suitable buffer for echo_area_buffer[0], and clear it.
10405
10406 Value is what FN returns. */
10407
10408 static int
10409 with_echo_area_buffer (struct window *w, int which,
10410 int (*fn) (ptrdiff_t, Lisp_Object),
10411 ptrdiff_t a1, Lisp_Object a2)
10412 {
10413 Lisp_Object buffer;
10414 int this_one, the_other, clear_buffer_p, rc;
10415 ptrdiff_t count = SPECPDL_INDEX ();
10416
10417 /* If buffers aren't live, make new ones. */
10418 ensure_echo_area_buffers ();
10419
10420 clear_buffer_p = 0;
10421
10422 if (which == 0)
10423 this_one = 0, the_other = 1;
10424 else if (which > 0)
10425 this_one = 1, the_other = 0;
10426 else
10427 {
10428 this_one = 0, the_other = 1;
10429 clear_buffer_p = true;
10430
10431 /* We need a fresh one in case the current echo buffer equals
10432 the one containing the last displayed echo area message. */
10433 if (!NILP (echo_area_buffer[this_one])
10434 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
10435 echo_area_buffer[this_one] = Qnil;
10436 }
10437
10438 /* Choose a suitable buffer from echo_buffer[] is we don't
10439 have one. */
10440 if (NILP (echo_area_buffer[this_one]))
10441 {
10442 echo_area_buffer[this_one]
10443 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
10444 ? echo_buffer[the_other]
10445 : echo_buffer[this_one]);
10446 clear_buffer_p = true;
10447 }
10448
10449 buffer = echo_area_buffer[this_one];
10450
10451 /* Don't get confused by reusing the buffer used for echoing
10452 for a different purpose. */
10453 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
10454 cancel_echoing ();
10455
10456 record_unwind_protect (unwind_with_echo_area_buffer,
10457 with_echo_area_buffer_unwind_data (w));
10458
10459 /* Make the echo area buffer current. Note that for display
10460 purposes, it is not necessary that the displayed window's buffer
10461 == current_buffer, except for text property lookup. So, let's
10462 only set that buffer temporarily here without doing a full
10463 Fset_window_buffer. We must also change w->pointm, though,
10464 because otherwise an assertions in unshow_buffer fails, and Emacs
10465 aborts. */
10466 set_buffer_internal_1 (XBUFFER (buffer));
10467 if (w)
10468 {
10469 wset_buffer (w, buffer);
10470 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10471 }
10472
10473 bset_undo_list (current_buffer, Qt);
10474 bset_read_only (current_buffer, Qnil);
10475 specbind (Qinhibit_read_only, Qt);
10476 specbind (Qinhibit_modification_hooks, Qt);
10477
10478 if (clear_buffer_p && Z > BEG)
10479 del_range (BEG, Z);
10480
10481 eassert (BEGV >= BEG);
10482 eassert (ZV <= Z && ZV >= BEGV);
10483
10484 rc = fn (a1, a2);
10485
10486 eassert (BEGV >= BEG);
10487 eassert (ZV <= Z && ZV >= BEGV);
10488
10489 unbind_to (count, Qnil);
10490 return rc;
10491 }
10492
10493
10494 /* Save state that should be preserved around the call to the function
10495 FN called in with_echo_area_buffer. */
10496
10497 static Lisp_Object
10498 with_echo_area_buffer_unwind_data (struct window *w)
10499 {
10500 int i = 0;
10501 Lisp_Object vector, tmp;
10502
10503 /* Reduce consing by keeping one vector in
10504 Vwith_echo_area_save_vector. */
10505 vector = Vwith_echo_area_save_vector;
10506 Vwith_echo_area_save_vector = Qnil;
10507
10508 if (NILP (vector))
10509 vector = Fmake_vector (make_number (9), Qnil);
10510
10511 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10512 ASET (vector, i, Vdeactivate_mark); ++i;
10513 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10514
10515 if (w)
10516 {
10517 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10518 ASET (vector, i, w->contents); ++i;
10519 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10520 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10521 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10522 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10523 }
10524 else
10525 {
10526 int end = i + 6;
10527 for (; i < end; ++i)
10528 ASET (vector, i, Qnil);
10529 }
10530
10531 eassert (i == ASIZE (vector));
10532 return vector;
10533 }
10534
10535
10536 /* Restore global state from VECTOR which was created by
10537 with_echo_area_buffer_unwind_data. */
10538
10539 static void
10540 unwind_with_echo_area_buffer (Lisp_Object vector)
10541 {
10542 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10543 Vdeactivate_mark = AREF (vector, 1);
10544 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10545
10546 if (WINDOWP (AREF (vector, 3)))
10547 {
10548 struct window *w;
10549 Lisp_Object buffer;
10550
10551 w = XWINDOW (AREF (vector, 3));
10552 buffer = AREF (vector, 4);
10553
10554 wset_buffer (w, buffer);
10555 set_marker_both (w->pointm, buffer,
10556 XFASTINT (AREF (vector, 5)),
10557 XFASTINT (AREF (vector, 6)));
10558 set_marker_both (w->start, buffer,
10559 XFASTINT (AREF (vector, 7)),
10560 XFASTINT (AREF (vector, 8)));
10561 }
10562
10563 Vwith_echo_area_save_vector = vector;
10564 }
10565
10566
10567 /* Set up the echo area for use by print functions. MULTIBYTE_P
10568 non-zero means we will print multibyte. */
10569
10570 void
10571 setup_echo_area_for_printing (int multibyte_p)
10572 {
10573 /* If we can't find an echo area any more, exit. */
10574 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10575 Fkill_emacs (Qnil);
10576
10577 ensure_echo_area_buffers ();
10578
10579 if (!message_buf_print)
10580 {
10581 /* A message has been output since the last time we printed.
10582 Choose a fresh echo area buffer. */
10583 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10584 echo_area_buffer[0] = echo_buffer[1];
10585 else
10586 echo_area_buffer[0] = echo_buffer[0];
10587
10588 /* Switch to that buffer and clear it. */
10589 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10590 bset_truncate_lines (current_buffer, Qnil);
10591
10592 if (Z > BEG)
10593 {
10594 ptrdiff_t count = SPECPDL_INDEX ();
10595 specbind (Qinhibit_read_only, Qt);
10596 /* Note that undo recording is always disabled. */
10597 del_range (BEG, Z);
10598 unbind_to (count, Qnil);
10599 }
10600 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10601
10602 /* Set up the buffer for the multibyteness we need. */
10603 if (multibyte_p
10604 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10605 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10606
10607 /* Raise the frame containing the echo area. */
10608 if (minibuffer_auto_raise)
10609 {
10610 struct frame *sf = SELECTED_FRAME ();
10611 Lisp_Object mini_window;
10612 mini_window = FRAME_MINIBUF_WINDOW (sf);
10613 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10614 }
10615
10616 message_log_maybe_newline ();
10617 message_buf_print = 1;
10618 }
10619 else
10620 {
10621 if (NILP (echo_area_buffer[0]))
10622 {
10623 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10624 echo_area_buffer[0] = echo_buffer[1];
10625 else
10626 echo_area_buffer[0] = echo_buffer[0];
10627 }
10628
10629 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10630 {
10631 /* Someone switched buffers between print requests. */
10632 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10633 bset_truncate_lines (current_buffer, Qnil);
10634 }
10635 }
10636 }
10637
10638
10639 /* Display an echo area message in window W. Value is non-zero if W's
10640 height is changed. If display_last_displayed_message_p is
10641 non-zero, display the message that was last displayed, otherwise
10642 display the current message. */
10643
10644 static int
10645 display_echo_area (struct window *w)
10646 {
10647 int i, no_message_p, window_height_changed_p;
10648
10649 /* Temporarily disable garbage collections while displaying the echo
10650 area. This is done because a GC can print a message itself.
10651 That message would modify the echo area buffer's contents while a
10652 redisplay of the buffer is going on, and seriously confuse
10653 redisplay. */
10654 ptrdiff_t count = inhibit_garbage_collection ();
10655
10656 /* If there is no message, we must call display_echo_area_1
10657 nevertheless because it resizes the window. But we will have to
10658 reset the echo_area_buffer in question to nil at the end because
10659 with_echo_area_buffer will sets it to an empty buffer. */
10660 i = display_last_displayed_message_p ? 1 : 0;
10661 no_message_p = NILP (echo_area_buffer[i]);
10662
10663 window_height_changed_p
10664 = with_echo_area_buffer (w, display_last_displayed_message_p,
10665 display_echo_area_1,
10666 (intptr_t) w, Qnil);
10667
10668 if (no_message_p)
10669 echo_area_buffer[i] = Qnil;
10670
10671 unbind_to (count, Qnil);
10672 return window_height_changed_p;
10673 }
10674
10675
10676 /* Helper for display_echo_area. Display the current buffer which
10677 contains the current echo area message in window W, a mini-window,
10678 a pointer to which is passed in A1. A2..A4 are currently not used.
10679 Change the height of W so that all of the message is displayed.
10680 Value is non-zero if height of W was changed. */
10681
10682 static int
10683 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10684 {
10685 intptr_t i1 = a1;
10686 struct window *w = (struct window *) i1;
10687 Lisp_Object window;
10688 struct text_pos start;
10689 int window_height_changed_p = 0;
10690
10691 /* Do this before displaying, so that we have a large enough glyph
10692 matrix for the display. If we can't get enough space for the
10693 whole text, display the last N lines. That works by setting w->start. */
10694 window_height_changed_p = resize_mini_window (w, 0);
10695
10696 /* Use the starting position chosen by resize_mini_window. */
10697 SET_TEXT_POS_FROM_MARKER (start, w->start);
10698
10699 /* Display. */
10700 clear_glyph_matrix (w->desired_matrix);
10701 XSETWINDOW (window, w);
10702 try_window (window, start, 0);
10703
10704 return window_height_changed_p;
10705 }
10706
10707
10708 /* Resize the echo area window to exactly the size needed for the
10709 currently displayed message, if there is one. If a mini-buffer
10710 is active, don't shrink it. */
10711
10712 void
10713 resize_echo_area_exactly (void)
10714 {
10715 if (BUFFERP (echo_area_buffer[0])
10716 && WINDOWP (echo_area_window))
10717 {
10718 struct window *w = XWINDOW (echo_area_window);
10719 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10720 int resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10721 (intptr_t) w, resize_exactly);
10722 if (resized_p)
10723 {
10724 windows_or_buffers_changed = 42;
10725 update_mode_lines = 30;
10726 redisplay_internal ();
10727 }
10728 }
10729 }
10730
10731
10732 /* Callback function for with_echo_area_buffer, when used from
10733 resize_echo_area_exactly. A1 contains a pointer to the window to
10734 resize, EXACTLY non-nil means resize the mini-window exactly to the
10735 size of the text displayed. A3 and A4 are not used. Value is what
10736 resize_mini_window returns. */
10737
10738 static int
10739 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10740 {
10741 intptr_t i1 = a1;
10742 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10743 }
10744
10745
10746 /* Resize mini-window W to fit the size of its contents. EXACT_P
10747 means size the window exactly to the size needed. Otherwise, it's
10748 only enlarged until W's buffer is empty.
10749
10750 Set W->start to the right place to begin display. If the whole
10751 contents fit, start at the beginning. Otherwise, start so as
10752 to make the end of the contents appear. This is particularly
10753 important for y-or-n-p, but seems desirable generally.
10754
10755 Value is non-zero if the window height has been changed. */
10756
10757 int
10758 resize_mini_window (struct window *w, int exact_p)
10759 {
10760 struct frame *f = XFRAME (w->frame);
10761 int window_height_changed_p = 0;
10762
10763 eassert (MINI_WINDOW_P (w));
10764
10765 /* By default, start display at the beginning. */
10766 set_marker_both (w->start, w->contents,
10767 BUF_BEGV (XBUFFER (w->contents)),
10768 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10769
10770 /* Don't resize windows while redisplaying a window; it would
10771 confuse redisplay functions when the size of the window they are
10772 displaying changes from under them. Such a resizing can happen,
10773 for instance, when which-func prints a long message while
10774 we are running fontification-functions. We're running these
10775 functions with safe_call which binds inhibit-redisplay to t. */
10776 if (!NILP (Vinhibit_redisplay))
10777 return 0;
10778
10779 /* Nil means don't try to resize. */
10780 if (NILP (Vresize_mini_windows)
10781 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10782 return 0;
10783
10784 if (!FRAME_MINIBUF_ONLY_P (f))
10785 {
10786 struct it it;
10787 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
10788 + WINDOW_PIXEL_HEIGHT (w));
10789 int unit = FRAME_LINE_HEIGHT (f);
10790 int height, max_height;
10791 struct text_pos start;
10792 struct buffer *old_current_buffer = NULL;
10793
10794 if (current_buffer != XBUFFER (w->contents))
10795 {
10796 old_current_buffer = current_buffer;
10797 set_buffer_internal (XBUFFER (w->contents));
10798 }
10799
10800 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10801
10802 /* Compute the max. number of lines specified by the user. */
10803 if (FLOATP (Vmax_mini_window_height))
10804 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
10805 else if (INTEGERP (Vmax_mini_window_height))
10806 max_height = XINT (Vmax_mini_window_height) * unit;
10807 else
10808 max_height = total_height / 4;
10809
10810 /* Correct that max. height if it's bogus. */
10811 max_height = clip_to_bounds (unit, max_height, total_height);
10812
10813 /* Find out the height of the text in the window. */
10814 if (it.line_wrap == TRUNCATE)
10815 height = unit;
10816 else
10817 {
10818 last_height = 0;
10819 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10820 if (it.max_ascent == 0 && it.max_descent == 0)
10821 height = it.current_y + last_height;
10822 else
10823 height = it.current_y + it.max_ascent + it.max_descent;
10824 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10825 }
10826
10827 /* Compute a suitable window start. */
10828 if (height > max_height)
10829 {
10830 height = (max_height / unit) * unit;
10831 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10832 move_it_vertically_backward (&it, height - unit);
10833 start = it.current.pos;
10834 }
10835 else
10836 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10837 SET_MARKER_FROM_TEXT_POS (w->start, start);
10838
10839 if (EQ (Vresize_mini_windows, Qgrow_only))
10840 {
10841 /* Let it grow only, until we display an empty message, in which
10842 case the window shrinks again. */
10843 if (height > WINDOW_PIXEL_HEIGHT (w))
10844 {
10845 int old_height = WINDOW_PIXEL_HEIGHT (w);
10846
10847 FRAME_WINDOWS_FROZEN (f) = 1;
10848 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10849 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10850 }
10851 else if (height < WINDOW_PIXEL_HEIGHT (w)
10852 && (exact_p || BEGV == ZV))
10853 {
10854 int old_height = WINDOW_PIXEL_HEIGHT (w);
10855
10856 FRAME_WINDOWS_FROZEN (f) = 0;
10857 shrink_mini_window (w, 1);
10858 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10859 }
10860 }
10861 else
10862 {
10863 /* Always resize to exact size needed. */
10864 if (height > WINDOW_PIXEL_HEIGHT (w))
10865 {
10866 int old_height = WINDOW_PIXEL_HEIGHT (w);
10867
10868 FRAME_WINDOWS_FROZEN (f) = 1;
10869 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10870 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10871 }
10872 else if (height < WINDOW_PIXEL_HEIGHT (w))
10873 {
10874 int old_height = WINDOW_PIXEL_HEIGHT (w);
10875
10876 FRAME_WINDOWS_FROZEN (f) = 0;
10877 shrink_mini_window (w, 1);
10878
10879 if (height)
10880 {
10881 FRAME_WINDOWS_FROZEN (f) = 1;
10882 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10883 }
10884
10885 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10886 }
10887 }
10888
10889 if (old_current_buffer)
10890 set_buffer_internal (old_current_buffer);
10891 }
10892
10893 return window_height_changed_p;
10894 }
10895
10896
10897 /* Value is the current message, a string, or nil if there is no
10898 current message. */
10899
10900 Lisp_Object
10901 current_message (void)
10902 {
10903 Lisp_Object msg;
10904
10905 if (!BUFFERP (echo_area_buffer[0]))
10906 msg = Qnil;
10907 else
10908 {
10909 with_echo_area_buffer (0, 0, current_message_1,
10910 (intptr_t) &msg, Qnil);
10911 if (NILP (msg))
10912 echo_area_buffer[0] = Qnil;
10913 }
10914
10915 return msg;
10916 }
10917
10918
10919 static int
10920 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
10921 {
10922 intptr_t i1 = a1;
10923 Lisp_Object *msg = (Lisp_Object *) i1;
10924
10925 if (Z > BEG)
10926 *msg = make_buffer_string (BEG, Z, 1);
10927 else
10928 *msg = Qnil;
10929 return 0;
10930 }
10931
10932
10933 /* Push the current message on Vmessage_stack for later restoration
10934 by restore_message. Value is non-zero if the current message isn't
10935 empty. This is a relatively infrequent operation, so it's not
10936 worth optimizing. */
10937
10938 bool
10939 push_message (void)
10940 {
10941 Lisp_Object msg = current_message ();
10942 Vmessage_stack = Fcons (msg, Vmessage_stack);
10943 return STRINGP (msg);
10944 }
10945
10946
10947 /* Restore message display from the top of Vmessage_stack. */
10948
10949 void
10950 restore_message (void)
10951 {
10952 eassert (CONSP (Vmessage_stack));
10953 message3_nolog (XCAR (Vmessage_stack));
10954 }
10955
10956
10957 /* Handler for unwind-protect calling pop_message. */
10958
10959 void
10960 pop_message_unwind (void)
10961 {
10962 /* Pop the top-most entry off Vmessage_stack. */
10963 eassert (CONSP (Vmessage_stack));
10964 Vmessage_stack = XCDR (Vmessage_stack);
10965 }
10966
10967
10968 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10969 exits. If the stack is not empty, we have a missing pop_message
10970 somewhere. */
10971
10972 void
10973 check_message_stack (void)
10974 {
10975 if (!NILP (Vmessage_stack))
10976 emacs_abort ();
10977 }
10978
10979
10980 /* Truncate to NCHARS what will be displayed in the echo area the next
10981 time we display it---but don't redisplay it now. */
10982
10983 void
10984 truncate_echo_area (ptrdiff_t nchars)
10985 {
10986 if (nchars == 0)
10987 echo_area_buffer[0] = Qnil;
10988 else if (!noninteractive
10989 && INTERACTIVE
10990 && !NILP (echo_area_buffer[0]))
10991 {
10992 struct frame *sf = SELECTED_FRAME ();
10993 /* Error messages get reported properly by cmd_error, so this must be
10994 just an informative message; if the frame hasn't really been
10995 initialized yet, just toss it. */
10996 if (sf->glyphs_initialized_p)
10997 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
10998 }
10999 }
11000
11001
11002 /* Helper function for truncate_echo_area. Truncate the current
11003 message to at most NCHARS characters. */
11004
11005 static int
11006 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11007 {
11008 if (BEG + nchars < Z)
11009 del_range (BEG + nchars, Z);
11010 if (Z == BEG)
11011 echo_area_buffer[0] = Qnil;
11012 return 0;
11013 }
11014
11015 /* Set the current message to STRING. */
11016
11017 static void
11018 set_message (Lisp_Object string)
11019 {
11020 eassert (STRINGP (string));
11021
11022 message_enable_multibyte = STRING_MULTIBYTE (string);
11023
11024 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11025 message_buf_print = 0;
11026 help_echo_showing_p = 0;
11027
11028 if (STRINGP (Vdebug_on_message)
11029 && STRINGP (string)
11030 && fast_string_match (Vdebug_on_message, string) >= 0)
11031 call_debugger (list2 (Qerror, string));
11032 }
11033
11034
11035 /* Helper function for set_message. First argument is ignored and second
11036 argument has the same meaning as for set_message.
11037 This function is called with the echo area buffer being current. */
11038
11039 static int
11040 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11041 {
11042 eassert (STRINGP (string));
11043
11044 /* Change multibyteness of the echo buffer appropriately. */
11045 if (message_enable_multibyte
11046 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11047 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11048
11049 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11050 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11051 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11052
11053 /* Insert new message at BEG. */
11054 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11055
11056 /* This function takes care of single/multibyte conversion.
11057 We just have to ensure that the echo area buffer has the right
11058 setting of enable_multibyte_characters. */
11059 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 1);
11060
11061 return 0;
11062 }
11063
11064
11065 /* Clear messages. CURRENT_P non-zero means clear the current
11066 message. LAST_DISPLAYED_P non-zero means clear the message
11067 last displayed. */
11068
11069 void
11070 clear_message (bool current_p, bool last_displayed_p)
11071 {
11072 if (current_p)
11073 {
11074 echo_area_buffer[0] = Qnil;
11075 message_cleared_p = true;
11076 }
11077
11078 if (last_displayed_p)
11079 echo_area_buffer[1] = Qnil;
11080
11081 message_buf_print = 0;
11082 }
11083
11084 /* Clear garbaged frames.
11085
11086 This function is used where the old redisplay called
11087 redraw_garbaged_frames which in turn called redraw_frame which in
11088 turn called clear_frame. The call to clear_frame was a source of
11089 flickering. I believe a clear_frame is not necessary. It should
11090 suffice in the new redisplay to invalidate all current matrices,
11091 and ensure a complete redisplay of all windows. */
11092
11093 static void
11094 clear_garbaged_frames (void)
11095 {
11096 if (frame_garbaged)
11097 {
11098 Lisp_Object tail, frame;
11099
11100 FOR_EACH_FRAME (tail, frame)
11101 {
11102 struct frame *f = XFRAME (frame);
11103
11104 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11105 {
11106 if (f->resized_p)
11107 redraw_frame (f);
11108 else
11109 clear_current_matrices (f);
11110 fset_redisplay (f);
11111 f->garbaged = false;
11112 f->resized_p = false;
11113 }
11114 }
11115
11116 frame_garbaged = false;
11117 }
11118 }
11119
11120
11121 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11122 is non-zero update selected_frame. Value is non-zero if the
11123 mini-windows height has been changed. */
11124
11125 static int
11126 echo_area_display (int update_frame_p)
11127 {
11128 Lisp_Object mini_window;
11129 struct window *w;
11130 struct frame *f;
11131 int window_height_changed_p = 0;
11132 struct frame *sf = SELECTED_FRAME ();
11133
11134 mini_window = FRAME_MINIBUF_WINDOW (sf);
11135 w = XWINDOW (mini_window);
11136 f = XFRAME (WINDOW_FRAME (w));
11137
11138 /* Don't display if frame is invisible or not yet initialized. */
11139 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11140 return 0;
11141
11142 #ifdef HAVE_WINDOW_SYSTEM
11143 /* When Emacs starts, selected_frame may be the initial terminal
11144 frame. If we let this through, a message would be displayed on
11145 the terminal. */
11146 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11147 return 0;
11148 #endif /* HAVE_WINDOW_SYSTEM */
11149
11150 /* Redraw garbaged frames. */
11151 clear_garbaged_frames ();
11152
11153 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11154 {
11155 echo_area_window = mini_window;
11156 window_height_changed_p = display_echo_area (w);
11157 w->must_be_updated_p = true;
11158
11159 /* Update the display, unless called from redisplay_internal.
11160 Also don't update the screen during redisplay itself. The
11161 update will happen at the end of redisplay, and an update
11162 here could cause confusion. */
11163 if (update_frame_p && !redisplaying_p)
11164 {
11165 int n = 0;
11166
11167 /* If the display update has been interrupted by pending
11168 input, update mode lines in the frame. Due to the
11169 pending input, it might have been that redisplay hasn't
11170 been called, so that mode lines above the echo area are
11171 garbaged. This looks odd, so we prevent it here. */
11172 if (!display_completed)
11173 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11174
11175 if (window_height_changed_p
11176 /* Don't do this if Emacs is shutting down. Redisplay
11177 needs to run hooks. */
11178 && !NILP (Vrun_hooks))
11179 {
11180 /* Must update other windows. Likewise as in other
11181 cases, don't let this update be interrupted by
11182 pending input. */
11183 ptrdiff_t count = SPECPDL_INDEX ();
11184 specbind (Qredisplay_dont_pause, Qt);
11185 windows_or_buffers_changed = 44;
11186 redisplay_internal ();
11187 unbind_to (count, Qnil);
11188 }
11189 else if (FRAME_WINDOW_P (f) && n == 0)
11190 {
11191 /* Window configuration is the same as before.
11192 Can do with a display update of the echo area,
11193 unless we displayed some mode lines. */
11194 update_single_window (w, 1);
11195 flush_frame (f);
11196 }
11197 else
11198 update_frame (f, 1, 1);
11199
11200 /* If cursor is in the echo area, make sure that the next
11201 redisplay displays the minibuffer, so that the cursor will
11202 be replaced with what the minibuffer wants. */
11203 if (cursor_in_echo_area)
11204 wset_redisplay (XWINDOW (mini_window));
11205 }
11206 }
11207 else if (!EQ (mini_window, selected_window))
11208 wset_redisplay (XWINDOW (mini_window));
11209
11210 /* Last displayed message is now the current message. */
11211 echo_area_buffer[1] = echo_area_buffer[0];
11212 /* Inform read_char that we're not echoing. */
11213 echo_message_buffer = Qnil;
11214
11215 /* Prevent redisplay optimization in redisplay_internal by resetting
11216 this_line_start_pos. This is done because the mini-buffer now
11217 displays the message instead of its buffer text. */
11218 if (EQ (mini_window, selected_window))
11219 CHARPOS (this_line_start_pos) = 0;
11220
11221 return window_height_changed_p;
11222 }
11223
11224 /* Nonzero if W's buffer was changed but not saved. */
11225
11226 static int
11227 window_buffer_changed (struct window *w)
11228 {
11229 struct buffer *b = XBUFFER (w->contents);
11230
11231 eassert (BUFFER_LIVE_P (b));
11232
11233 return (((BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star));
11234 }
11235
11236 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11237
11238 static int
11239 mode_line_update_needed (struct window *w)
11240 {
11241 return (w->column_number_displayed != -1
11242 && !(PT == w->last_point && !window_outdated (w))
11243 && (w->column_number_displayed != current_column ()));
11244 }
11245
11246 /* Nonzero if window start of W is frozen and may not be changed during
11247 redisplay. */
11248
11249 static bool
11250 window_frozen_p (struct window *w)
11251 {
11252 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11253 {
11254 Lisp_Object window;
11255
11256 XSETWINDOW (window, w);
11257 if (MINI_WINDOW_P (w))
11258 return 0;
11259 else if (EQ (window, selected_window))
11260 return 0;
11261 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11262 && EQ (window, Vminibuf_scroll_window))
11263 /* This special window can't be frozen too. */
11264 return 0;
11265 else
11266 return 1;
11267 }
11268 return 0;
11269 }
11270
11271 /***********************************************************************
11272 Mode Lines and Frame Titles
11273 ***********************************************************************/
11274
11275 /* A buffer for constructing non-propertized mode-line strings and
11276 frame titles in it; allocated from the heap in init_xdisp and
11277 resized as needed in store_mode_line_noprop_char. */
11278
11279 static char *mode_line_noprop_buf;
11280
11281 /* The buffer's end, and a current output position in it. */
11282
11283 static char *mode_line_noprop_buf_end;
11284 static char *mode_line_noprop_ptr;
11285
11286 #define MODE_LINE_NOPROP_LEN(start) \
11287 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11288
11289 static enum {
11290 MODE_LINE_DISPLAY = 0,
11291 MODE_LINE_TITLE,
11292 MODE_LINE_NOPROP,
11293 MODE_LINE_STRING
11294 } mode_line_target;
11295
11296 /* Alist that caches the results of :propertize.
11297 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11298 static Lisp_Object mode_line_proptrans_alist;
11299
11300 /* List of strings making up the mode-line. */
11301 static Lisp_Object mode_line_string_list;
11302
11303 /* Base face property when building propertized mode line string. */
11304 static Lisp_Object mode_line_string_face;
11305 static Lisp_Object mode_line_string_face_prop;
11306
11307
11308 /* Unwind data for mode line strings */
11309
11310 static Lisp_Object Vmode_line_unwind_vector;
11311
11312 static Lisp_Object
11313 format_mode_line_unwind_data (struct frame *target_frame,
11314 struct buffer *obuf,
11315 Lisp_Object owin,
11316 int save_proptrans)
11317 {
11318 Lisp_Object vector, tmp;
11319
11320 /* Reduce consing by keeping one vector in
11321 Vwith_echo_area_save_vector. */
11322 vector = Vmode_line_unwind_vector;
11323 Vmode_line_unwind_vector = Qnil;
11324
11325 if (NILP (vector))
11326 vector = Fmake_vector (make_number (10), Qnil);
11327
11328 ASET (vector, 0, make_number (mode_line_target));
11329 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11330 ASET (vector, 2, mode_line_string_list);
11331 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11332 ASET (vector, 4, mode_line_string_face);
11333 ASET (vector, 5, mode_line_string_face_prop);
11334
11335 if (obuf)
11336 XSETBUFFER (tmp, obuf);
11337 else
11338 tmp = Qnil;
11339 ASET (vector, 6, tmp);
11340 ASET (vector, 7, owin);
11341 if (target_frame)
11342 {
11343 /* Similarly to `with-selected-window', if the operation selects
11344 a window on another frame, we must restore that frame's
11345 selected window, and (for a tty) the top-frame. */
11346 ASET (vector, 8, target_frame->selected_window);
11347 if (FRAME_TERMCAP_P (target_frame))
11348 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11349 }
11350
11351 return vector;
11352 }
11353
11354 static void
11355 unwind_format_mode_line (Lisp_Object vector)
11356 {
11357 Lisp_Object old_window = AREF (vector, 7);
11358 Lisp_Object target_frame_window = AREF (vector, 8);
11359 Lisp_Object old_top_frame = AREF (vector, 9);
11360
11361 mode_line_target = XINT (AREF (vector, 0));
11362 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11363 mode_line_string_list = AREF (vector, 2);
11364 if (! EQ (AREF (vector, 3), Qt))
11365 mode_line_proptrans_alist = AREF (vector, 3);
11366 mode_line_string_face = AREF (vector, 4);
11367 mode_line_string_face_prop = AREF (vector, 5);
11368
11369 /* Select window before buffer, since it may change the buffer. */
11370 if (!NILP (old_window))
11371 {
11372 /* If the operation that we are unwinding had selected a window
11373 on a different frame, reset its frame-selected-window. For a
11374 text terminal, reset its top-frame if necessary. */
11375 if (!NILP (target_frame_window))
11376 {
11377 Lisp_Object frame
11378 = WINDOW_FRAME (XWINDOW (target_frame_window));
11379
11380 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11381 Fselect_window (target_frame_window, Qt);
11382
11383 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11384 Fselect_frame (old_top_frame, Qt);
11385 }
11386
11387 Fselect_window (old_window, Qt);
11388 }
11389
11390 if (!NILP (AREF (vector, 6)))
11391 {
11392 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11393 ASET (vector, 6, Qnil);
11394 }
11395
11396 Vmode_line_unwind_vector = vector;
11397 }
11398
11399
11400 /* Store a single character C for the frame title in mode_line_noprop_buf.
11401 Re-allocate mode_line_noprop_buf if necessary. */
11402
11403 static void
11404 store_mode_line_noprop_char (char c)
11405 {
11406 /* If output position has reached the end of the allocated buffer,
11407 increase the buffer's size. */
11408 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11409 {
11410 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11411 ptrdiff_t size = len;
11412 mode_line_noprop_buf =
11413 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11414 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11415 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11416 }
11417
11418 *mode_line_noprop_ptr++ = c;
11419 }
11420
11421
11422 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11423 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11424 characters that yield more columns than PRECISION; PRECISION <= 0
11425 means copy the whole string. Pad with spaces until FIELD_WIDTH
11426 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11427 pad. Called from display_mode_element when it is used to build a
11428 frame title. */
11429
11430 static int
11431 store_mode_line_noprop (const char *string, int field_width, int precision)
11432 {
11433 const unsigned char *str = (const unsigned char *) string;
11434 int n = 0;
11435 ptrdiff_t dummy, nbytes;
11436
11437 /* Copy at most PRECISION chars from STR. */
11438 nbytes = strlen (string);
11439 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11440 while (nbytes--)
11441 store_mode_line_noprop_char (*str++);
11442
11443 /* Fill up with spaces until FIELD_WIDTH reached. */
11444 while (field_width > 0
11445 && n < field_width)
11446 {
11447 store_mode_line_noprop_char (' ');
11448 ++n;
11449 }
11450
11451 return n;
11452 }
11453
11454 /***********************************************************************
11455 Frame Titles
11456 ***********************************************************************/
11457
11458 #ifdef HAVE_WINDOW_SYSTEM
11459
11460 /* Set the title of FRAME, if it has changed. The title format is
11461 Vicon_title_format if FRAME is iconified, otherwise it is
11462 frame_title_format. */
11463
11464 static void
11465 x_consider_frame_title (Lisp_Object frame)
11466 {
11467 struct frame *f = XFRAME (frame);
11468
11469 if (FRAME_WINDOW_P (f)
11470 || FRAME_MINIBUF_ONLY_P (f)
11471 || f->explicit_name)
11472 {
11473 /* Do we have more than one visible frame on this X display? */
11474 Lisp_Object tail, other_frame, fmt;
11475 ptrdiff_t title_start;
11476 char *title;
11477 ptrdiff_t len;
11478 struct it it;
11479 ptrdiff_t count = SPECPDL_INDEX ();
11480
11481 FOR_EACH_FRAME (tail, other_frame)
11482 {
11483 struct frame *tf = XFRAME (other_frame);
11484
11485 if (tf != f
11486 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11487 && !FRAME_MINIBUF_ONLY_P (tf)
11488 && !EQ (other_frame, tip_frame)
11489 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11490 break;
11491 }
11492
11493 /* Set global variable indicating that multiple frames exist. */
11494 multiple_frames = CONSP (tail);
11495
11496 /* Switch to the buffer of selected window of the frame. Set up
11497 mode_line_target so that display_mode_element will output into
11498 mode_line_noprop_buf; then display the title. */
11499 record_unwind_protect (unwind_format_mode_line,
11500 format_mode_line_unwind_data
11501 (f, current_buffer, selected_window, 0));
11502
11503 Fselect_window (f->selected_window, Qt);
11504 set_buffer_internal_1
11505 (XBUFFER (XWINDOW (f->selected_window)->contents));
11506 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11507
11508 mode_line_target = MODE_LINE_TITLE;
11509 title_start = MODE_LINE_NOPROP_LEN (0);
11510 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11511 NULL, DEFAULT_FACE_ID);
11512 display_mode_element (&it, 0, -1, -1, fmt, Qnil, 0);
11513 len = MODE_LINE_NOPROP_LEN (title_start);
11514 title = mode_line_noprop_buf + title_start;
11515 unbind_to (count, Qnil);
11516
11517 /* Set the title only if it's changed. This avoids consing in
11518 the common case where it hasn't. (If it turns out that we've
11519 already wasted too much time by walking through the list with
11520 display_mode_element, then we might need to optimize at a
11521 higher level than this.) */
11522 if (! STRINGP (f->name)
11523 || SBYTES (f->name) != len
11524 || memcmp (title, SDATA (f->name), len) != 0)
11525 x_implicitly_set_name (f, make_string (title, len), Qnil);
11526 }
11527 }
11528
11529 #endif /* not HAVE_WINDOW_SYSTEM */
11530
11531 \f
11532 /***********************************************************************
11533 Menu Bars
11534 ***********************************************************************/
11535
11536 /* Non-zero if we will not redisplay all visible windows. */
11537 #define REDISPLAY_SOME_P() \
11538 ((windows_or_buffers_changed == 0 \
11539 || windows_or_buffers_changed == REDISPLAY_SOME) \
11540 && (update_mode_lines == 0 \
11541 || update_mode_lines == REDISPLAY_SOME))
11542
11543 /* Prepare for redisplay by updating menu-bar item lists when
11544 appropriate. This can call eval. */
11545
11546 static void
11547 prepare_menu_bars (void)
11548 {
11549 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11550 bool some_windows = REDISPLAY_SOME_P ();
11551 struct gcpro gcpro1, gcpro2;
11552 Lisp_Object tooltip_frame;
11553
11554 #ifdef HAVE_WINDOW_SYSTEM
11555 tooltip_frame = tip_frame;
11556 #else
11557 tooltip_frame = Qnil;
11558 #endif
11559
11560 if (FUNCTIONP (Vpre_redisplay_function))
11561 {
11562 Lisp_Object windows = all_windows ? Qt : Qnil;
11563 if (all_windows && some_windows)
11564 {
11565 Lisp_Object ws = window_list ();
11566 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11567 {
11568 Lisp_Object this = XCAR (ws);
11569 struct window *w = XWINDOW (this);
11570 if (w->redisplay
11571 || XFRAME (w->frame)->redisplay
11572 || XBUFFER (w->contents)->text->redisplay)
11573 {
11574 windows = Fcons (this, windows);
11575 }
11576 }
11577 }
11578 safe__call1 (true, Vpre_redisplay_function, windows);
11579 }
11580
11581 /* Update all frame titles based on their buffer names, etc. We do
11582 this before the menu bars so that the buffer-menu will show the
11583 up-to-date frame titles. */
11584 #ifdef HAVE_WINDOW_SYSTEM
11585 if (all_windows)
11586 {
11587 Lisp_Object tail, frame;
11588
11589 FOR_EACH_FRAME (tail, frame)
11590 {
11591 struct frame *f = XFRAME (frame);
11592 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11593 if (some_windows
11594 && !f->redisplay
11595 && !w->redisplay
11596 && !XBUFFER (w->contents)->text->redisplay)
11597 continue;
11598
11599 if (!EQ (frame, tooltip_frame)
11600 && (FRAME_ICONIFIED_P (f)
11601 || FRAME_VISIBLE_P (f) == 1
11602 /* Exclude TTY frames that are obscured because they
11603 are not the top frame on their console. This is
11604 because x_consider_frame_title actually switches
11605 to the frame, which for TTY frames means it is
11606 marked as garbaged, and will be completely
11607 redrawn on the next redisplay cycle. This causes
11608 TTY frames to be completely redrawn, when there
11609 are more than one of them, even though nothing
11610 should be changed on display. */
11611 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11612 x_consider_frame_title (frame);
11613 }
11614 }
11615 #endif /* HAVE_WINDOW_SYSTEM */
11616
11617 /* Update the menu bar item lists, if appropriate. This has to be
11618 done before any actual redisplay or generation of display lines. */
11619
11620 if (all_windows)
11621 {
11622 Lisp_Object tail, frame;
11623 ptrdiff_t count = SPECPDL_INDEX ();
11624 /* 1 means that update_menu_bar has run its hooks
11625 so any further calls to update_menu_bar shouldn't do so again. */
11626 int menu_bar_hooks_run = 0;
11627
11628 record_unwind_save_match_data ();
11629
11630 FOR_EACH_FRAME (tail, frame)
11631 {
11632 struct frame *f = XFRAME (frame);
11633 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11634
11635 /* Ignore tooltip frame. */
11636 if (EQ (frame, tooltip_frame))
11637 continue;
11638
11639 if (some_windows
11640 && !f->redisplay
11641 && !w->redisplay
11642 && !XBUFFER (w->contents)->text->redisplay)
11643 continue;
11644
11645 /* If a window on this frame changed size, report that to
11646 the user and clear the size-change flag. */
11647 if (FRAME_WINDOW_SIZES_CHANGED (f))
11648 {
11649 Lisp_Object functions;
11650
11651 /* Clear flag first in case we get an error below. */
11652 FRAME_WINDOW_SIZES_CHANGED (f) = 0;
11653 functions = Vwindow_size_change_functions;
11654 GCPRO2 (tail, functions);
11655
11656 while (CONSP (functions))
11657 {
11658 if (!EQ (XCAR (functions), Qt))
11659 call1 (XCAR (functions), frame);
11660 functions = XCDR (functions);
11661 }
11662 UNGCPRO;
11663 }
11664
11665 GCPRO1 (tail);
11666 menu_bar_hooks_run = update_menu_bar (f, 0, menu_bar_hooks_run);
11667 #ifdef HAVE_WINDOW_SYSTEM
11668 update_tool_bar (f, 0);
11669 #endif
11670 #ifdef HAVE_NS
11671 if (windows_or_buffers_changed
11672 && FRAME_NS_P (f))
11673 ns_set_doc_edited
11674 (f, Fbuffer_modified_p (XWINDOW (f->selected_window)->contents));
11675 #endif
11676 UNGCPRO;
11677 }
11678
11679 unbind_to (count, Qnil);
11680 }
11681 else
11682 {
11683 struct frame *sf = SELECTED_FRAME ();
11684 update_menu_bar (sf, 1, 0);
11685 #ifdef HAVE_WINDOW_SYSTEM
11686 update_tool_bar (sf, 1);
11687 #endif
11688 }
11689 }
11690
11691
11692 /* Update the menu bar item list for frame F. This has to be done
11693 before we start to fill in any display lines, because it can call
11694 eval.
11695
11696 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11697
11698 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11699 already ran the menu bar hooks for this redisplay, so there
11700 is no need to run them again. The return value is the
11701 updated value of this flag, to pass to the next call. */
11702
11703 static int
11704 update_menu_bar (struct frame *f, int save_match_data, int hooks_run)
11705 {
11706 Lisp_Object window;
11707 register struct window *w;
11708
11709 /* If called recursively during a menu update, do nothing. This can
11710 happen when, for instance, an activate-menubar-hook causes a
11711 redisplay. */
11712 if (inhibit_menubar_update)
11713 return hooks_run;
11714
11715 window = FRAME_SELECTED_WINDOW (f);
11716 w = XWINDOW (window);
11717
11718 if (FRAME_WINDOW_P (f)
11719 ?
11720 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11721 || defined (HAVE_NS) || defined (USE_GTK)
11722 FRAME_EXTERNAL_MENU_BAR (f)
11723 #else
11724 FRAME_MENU_BAR_LINES (f) > 0
11725 #endif
11726 : FRAME_MENU_BAR_LINES (f) > 0)
11727 {
11728 /* If the user has switched buffers or windows, we need to
11729 recompute to reflect the new bindings. But we'll
11730 recompute when update_mode_lines is set too; that means
11731 that people can use force-mode-line-update to request
11732 that the menu bar be recomputed. The adverse effect on
11733 the rest of the redisplay algorithm is about the same as
11734 windows_or_buffers_changed anyway. */
11735 if (windows_or_buffers_changed
11736 /* This used to test w->update_mode_line, but we believe
11737 there is no need to recompute the menu in that case. */
11738 || update_mode_lines
11739 || window_buffer_changed (w))
11740 {
11741 struct buffer *prev = current_buffer;
11742 ptrdiff_t count = SPECPDL_INDEX ();
11743
11744 specbind (Qinhibit_menubar_update, Qt);
11745
11746 set_buffer_internal_1 (XBUFFER (w->contents));
11747 if (save_match_data)
11748 record_unwind_save_match_data ();
11749 if (NILP (Voverriding_local_map_menu_flag))
11750 {
11751 specbind (Qoverriding_terminal_local_map, Qnil);
11752 specbind (Qoverriding_local_map, Qnil);
11753 }
11754
11755 if (!hooks_run)
11756 {
11757 /* Run the Lucid hook. */
11758 safe_run_hooks (Qactivate_menubar_hook);
11759
11760 /* If it has changed current-menubar from previous value,
11761 really recompute the menu-bar from the value. */
11762 if (! NILP (Vlucid_menu_bar_dirty_flag))
11763 call0 (Qrecompute_lucid_menubar);
11764
11765 safe_run_hooks (Qmenu_bar_update_hook);
11766
11767 hooks_run = 1;
11768 }
11769
11770 XSETFRAME (Vmenu_updating_frame, f);
11771 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11772
11773 /* Redisplay the menu bar in case we changed it. */
11774 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11775 || defined (HAVE_NS) || defined (USE_GTK)
11776 if (FRAME_WINDOW_P (f))
11777 {
11778 #if defined (HAVE_NS)
11779 /* All frames on Mac OS share the same menubar. So only
11780 the selected frame should be allowed to set it. */
11781 if (f == SELECTED_FRAME ())
11782 #endif
11783 set_frame_menubar (f, 0, 0);
11784 }
11785 else
11786 /* On a terminal screen, the menu bar is an ordinary screen
11787 line, and this makes it get updated. */
11788 w->update_mode_line = 1;
11789 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11790 /* In the non-toolkit version, the menu bar is an ordinary screen
11791 line, and this makes it get updated. */
11792 w->update_mode_line = 1;
11793 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11794
11795 unbind_to (count, Qnil);
11796 set_buffer_internal_1 (prev);
11797 }
11798 }
11799
11800 return hooks_run;
11801 }
11802
11803 /***********************************************************************
11804 Tool-bars
11805 ***********************************************************************/
11806
11807 #ifdef HAVE_WINDOW_SYSTEM
11808
11809 /* Select `frame' temporarily without running all the code in
11810 do_switch_frame.
11811 FIXME: Maybe do_switch_frame should be trimmed down similarly
11812 when `norecord' is set. */
11813 static void
11814 fast_set_selected_frame (Lisp_Object frame)
11815 {
11816 if (!EQ (selected_frame, frame))
11817 {
11818 selected_frame = frame;
11819 selected_window = XFRAME (frame)->selected_window;
11820 }
11821 }
11822
11823 /* Update the tool-bar item list for frame F. This has to be done
11824 before we start to fill in any display lines. Called from
11825 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11826 and restore it here. */
11827
11828 static void
11829 update_tool_bar (struct frame *f, int save_match_data)
11830 {
11831 #if defined (USE_GTK) || defined (HAVE_NS)
11832 int do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11833 #else
11834 int do_update = (WINDOWP (f->tool_bar_window)
11835 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0);
11836 #endif
11837
11838 if (do_update)
11839 {
11840 Lisp_Object window;
11841 struct window *w;
11842
11843 window = FRAME_SELECTED_WINDOW (f);
11844 w = XWINDOW (window);
11845
11846 /* If the user has switched buffers or windows, we need to
11847 recompute to reflect the new bindings. But we'll
11848 recompute when update_mode_lines is set too; that means
11849 that people can use force-mode-line-update to request
11850 that the menu bar be recomputed. The adverse effect on
11851 the rest of the redisplay algorithm is about the same as
11852 windows_or_buffers_changed anyway. */
11853 if (windows_or_buffers_changed
11854 || w->update_mode_line
11855 || update_mode_lines
11856 || window_buffer_changed (w))
11857 {
11858 struct buffer *prev = current_buffer;
11859 ptrdiff_t count = SPECPDL_INDEX ();
11860 Lisp_Object frame, new_tool_bar;
11861 int new_n_tool_bar;
11862 struct gcpro gcpro1;
11863
11864 /* Set current_buffer to the buffer of the selected
11865 window of the frame, so that we get the right local
11866 keymaps. */
11867 set_buffer_internal_1 (XBUFFER (w->contents));
11868
11869 /* Save match data, if we must. */
11870 if (save_match_data)
11871 record_unwind_save_match_data ();
11872
11873 /* Make sure that we don't accidentally use bogus keymaps. */
11874 if (NILP (Voverriding_local_map_menu_flag))
11875 {
11876 specbind (Qoverriding_terminal_local_map, Qnil);
11877 specbind (Qoverriding_local_map, Qnil);
11878 }
11879
11880 GCPRO1 (new_tool_bar);
11881
11882 /* We must temporarily set the selected frame to this frame
11883 before calling tool_bar_items, because the calculation of
11884 the tool-bar keymap uses the selected frame (see
11885 `tool-bar-make-keymap' in tool-bar.el). */
11886 eassert (EQ (selected_window,
11887 /* Since we only explicitly preserve selected_frame,
11888 check that selected_window would be redundant. */
11889 XFRAME (selected_frame)->selected_window));
11890 record_unwind_protect (fast_set_selected_frame, selected_frame);
11891 XSETFRAME (frame, f);
11892 fast_set_selected_frame (frame);
11893
11894 /* Build desired tool-bar items from keymaps. */
11895 new_tool_bar
11896 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
11897 &new_n_tool_bar);
11898
11899 /* Redisplay the tool-bar if we changed it. */
11900 if (new_n_tool_bar != f->n_tool_bar_items
11901 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
11902 {
11903 /* Redisplay that happens asynchronously due to an expose event
11904 may access f->tool_bar_items. Make sure we update both
11905 variables within BLOCK_INPUT so no such event interrupts. */
11906 block_input ();
11907 fset_tool_bar_items (f, new_tool_bar);
11908 f->n_tool_bar_items = new_n_tool_bar;
11909 w->update_mode_line = 1;
11910 unblock_input ();
11911 }
11912
11913 UNGCPRO;
11914
11915 unbind_to (count, Qnil);
11916 set_buffer_internal_1 (prev);
11917 }
11918 }
11919 }
11920
11921 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11922
11923 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11924 F's desired tool-bar contents. F->tool_bar_items must have
11925 been set up previously by calling prepare_menu_bars. */
11926
11927 static void
11928 build_desired_tool_bar_string (struct frame *f)
11929 {
11930 int i, size, size_needed;
11931 struct gcpro gcpro1, gcpro2, gcpro3;
11932 Lisp_Object image, plist, props;
11933
11934 image = plist = props = Qnil;
11935 GCPRO3 (image, plist, props);
11936
11937 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11938 Otherwise, make a new string. */
11939
11940 /* The size of the string we might be able to reuse. */
11941 size = (STRINGP (f->desired_tool_bar_string)
11942 ? SCHARS (f->desired_tool_bar_string)
11943 : 0);
11944
11945 /* We need one space in the string for each image. */
11946 size_needed = f->n_tool_bar_items;
11947
11948 /* Reuse f->desired_tool_bar_string, if possible. */
11949 if (size < size_needed || NILP (f->desired_tool_bar_string))
11950 fset_desired_tool_bar_string
11951 (f, Fmake_string (make_number (size_needed), make_number (' ')));
11952 else
11953 {
11954 props = list4 (Qdisplay, Qnil, Qmenu_item, Qnil);
11955 Fremove_text_properties (make_number (0), make_number (size),
11956 props, f->desired_tool_bar_string);
11957 }
11958
11959 /* Put a `display' property on the string for the images to display,
11960 put a `menu_item' property on tool-bar items with a value that
11961 is the index of the item in F's tool-bar item vector. */
11962 for (i = 0; i < f->n_tool_bar_items; ++i)
11963 {
11964 #define PROP(IDX) \
11965 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11966
11967 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
11968 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
11969 int hmargin, vmargin, relief, idx, end;
11970
11971 /* If image is a vector, choose the image according to the
11972 button state. */
11973 image = PROP (TOOL_BAR_ITEM_IMAGES);
11974 if (VECTORP (image))
11975 {
11976 if (enabled_p)
11977 idx = (selected_p
11978 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11979 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
11980 else
11981 idx = (selected_p
11982 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11983 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
11984
11985 eassert (ASIZE (image) >= idx);
11986 image = AREF (image, idx);
11987 }
11988 else
11989 idx = -1;
11990
11991 /* Ignore invalid image specifications. */
11992 if (!valid_image_p (image))
11993 continue;
11994
11995 /* Display the tool-bar button pressed, or depressed. */
11996 plist = Fcopy_sequence (XCDR (image));
11997
11998 /* Compute margin and relief to draw. */
11999 relief = (tool_bar_button_relief >= 0
12000 ? tool_bar_button_relief
12001 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12002 hmargin = vmargin = relief;
12003
12004 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12005 INT_MAX - max (hmargin, vmargin)))
12006 {
12007 hmargin += XFASTINT (Vtool_bar_button_margin);
12008 vmargin += XFASTINT (Vtool_bar_button_margin);
12009 }
12010 else if (CONSP (Vtool_bar_button_margin))
12011 {
12012 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12013 INT_MAX - hmargin))
12014 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12015
12016 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12017 INT_MAX - vmargin))
12018 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12019 }
12020
12021 if (auto_raise_tool_bar_buttons_p)
12022 {
12023 /* Add a `:relief' property to the image spec if the item is
12024 selected. */
12025 if (selected_p)
12026 {
12027 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12028 hmargin -= relief;
12029 vmargin -= relief;
12030 }
12031 }
12032 else
12033 {
12034 /* If image is selected, display it pressed, i.e. with a
12035 negative relief. If it's not selected, display it with a
12036 raised relief. */
12037 plist = Fplist_put (plist, QCrelief,
12038 (selected_p
12039 ? make_number (-relief)
12040 : make_number (relief)));
12041 hmargin -= relief;
12042 vmargin -= relief;
12043 }
12044
12045 /* Put a margin around the image. */
12046 if (hmargin || vmargin)
12047 {
12048 if (hmargin == vmargin)
12049 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12050 else
12051 plist = Fplist_put (plist, QCmargin,
12052 Fcons (make_number (hmargin),
12053 make_number (vmargin)));
12054 }
12055
12056 /* If button is not enabled, and we don't have special images
12057 for the disabled state, make the image appear disabled by
12058 applying an appropriate algorithm to it. */
12059 if (!enabled_p && idx < 0)
12060 plist = Fplist_put (plist, QCconversion, Qdisabled);
12061
12062 /* Put a `display' text property on the string for the image to
12063 display. Put a `menu-item' property on the string that gives
12064 the start of this item's properties in the tool-bar items
12065 vector. */
12066 image = Fcons (Qimage, plist);
12067 props = list4 (Qdisplay, image,
12068 Qmenu_item, make_number (i * TOOL_BAR_ITEM_NSLOTS));
12069
12070 /* Let the last image hide all remaining spaces in the tool bar
12071 string. The string can be longer than needed when we reuse a
12072 previous string. */
12073 if (i + 1 == f->n_tool_bar_items)
12074 end = SCHARS (f->desired_tool_bar_string);
12075 else
12076 end = i + 1;
12077 Fadd_text_properties (make_number (i), make_number (end),
12078 props, f->desired_tool_bar_string);
12079 #undef PROP
12080 }
12081
12082 UNGCPRO;
12083 }
12084
12085
12086 /* Display one line of the tool-bar of frame IT->f.
12087
12088 HEIGHT specifies the desired height of the tool-bar line.
12089 If the actual height of the glyph row is less than HEIGHT, the
12090 row's height is increased to HEIGHT, and the icons are centered
12091 vertically in the new height.
12092
12093 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12094 count a final empty row in case the tool-bar width exactly matches
12095 the window width.
12096 */
12097
12098 static void
12099 display_tool_bar_line (struct it *it, int height)
12100 {
12101 struct glyph_row *row = it->glyph_row;
12102 int max_x = it->last_visible_x;
12103 struct glyph *last;
12104
12105 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12106 clear_glyph_row (row);
12107 row->enabled_p = true;
12108 row->y = it->current_y;
12109
12110 /* Note that this isn't made use of if the face hasn't a box,
12111 so there's no need to check the face here. */
12112 it->start_of_box_run_p = 1;
12113
12114 while (it->current_x < max_x)
12115 {
12116 int x, n_glyphs_before, i, nglyphs;
12117 struct it it_before;
12118
12119 /* Get the next display element. */
12120 if (!get_next_display_element (it))
12121 {
12122 /* Don't count empty row if we are counting needed tool-bar lines. */
12123 if (height < 0 && !it->hpos)
12124 return;
12125 break;
12126 }
12127
12128 /* Produce glyphs. */
12129 n_glyphs_before = row->used[TEXT_AREA];
12130 it_before = *it;
12131
12132 PRODUCE_GLYPHS (it);
12133
12134 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12135 i = 0;
12136 x = it_before.current_x;
12137 while (i < nglyphs)
12138 {
12139 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12140
12141 if (x + glyph->pixel_width > max_x)
12142 {
12143 /* Glyph doesn't fit on line. Backtrack. */
12144 row->used[TEXT_AREA] = n_glyphs_before;
12145 *it = it_before;
12146 /* If this is the only glyph on this line, it will never fit on the
12147 tool-bar, so skip it. But ensure there is at least one glyph,
12148 so we don't accidentally disable the tool-bar. */
12149 if (n_glyphs_before == 0
12150 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12151 break;
12152 goto out;
12153 }
12154
12155 ++it->hpos;
12156 x += glyph->pixel_width;
12157 ++i;
12158 }
12159
12160 /* Stop at line end. */
12161 if (ITERATOR_AT_END_OF_LINE_P (it))
12162 break;
12163
12164 set_iterator_to_next (it, 1);
12165 }
12166
12167 out:;
12168
12169 row->displays_text_p = row->used[TEXT_AREA] != 0;
12170
12171 /* Use default face for the border below the tool bar.
12172
12173 FIXME: When auto-resize-tool-bars is grow-only, there is
12174 no additional border below the possibly empty tool-bar lines.
12175 So to make the extra empty lines look "normal", we have to
12176 use the tool-bar face for the border too. */
12177 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12178 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12179 it->face_id = DEFAULT_FACE_ID;
12180
12181 extend_face_to_end_of_line (it);
12182 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12183 last->right_box_line_p = 1;
12184 if (last == row->glyphs[TEXT_AREA])
12185 last->left_box_line_p = 1;
12186
12187 /* Make line the desired height and center it vertically. */
12188 if ((height -= it->max_ascent + it->max_descent) > 0)
12189 {
12190 /* Don't add more than one line height. */
12191 height %= FRAME_LINE_HEIGHT (it->f);
12192 it->max_ascent += height / 2;
12193 it->max_descent += (height + 1) / 2;
12194 }
12195
12196 compute_line_metrics (it);
12197
12198 /* If line is empty, make it occupy the rest of the tool-bar. */
12199 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12200 {
12201 row->height = row->phys_height = it->last_visible_y - row->y;
12202 row->visible_height = row->height;
12203 row->ascent = row->phys_ascent = 0;
12204 row->extra_line_spacing = 0;
12205 }
12206
12207 row->full_width_p = 1;
12208 row->continued_p = 0;
12209 row->truncated_on_left_p = 0;
12210 row->truncated_on_right_p = 0;
12211
12212 it->current_x = it->hpos = 0;
12213 it->current_y += row->height;
12214 ++it->vpos;
12215 ++it->glyph_row;
12216 }
12217
12218
12219 /* Max tool-bar height. Basically, this is what makes all other windows
12220 disappear when the frame gets too small. Rethink this! */
12221
12222 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12223 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12224
12225 /* Value is the number of pixels needed to make all tool-bar items of
12226 frame F visible. The actual number of glyph rows needed is
12227 returned in *N_ROWS if non-NULL. */
12228
12229 static int
12230 tool_bar_height (struct frame *f, int *n_rows, bool pixelwise)
12231 {
12232 struct window *w = XWINDOW (f->tool_bar_window);
12233 struct it it;
12234 /* tool_bar_height is called from redisplay_tool_bar after building
12235 the desired matrix, so use (unused) mode-line row as temporary row to
12236 avoid destroying the first tool-bar row. */
12237 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
12238
12239 /* Initialize an iterator for iteration over
12240 F->desired_tool_bar_string in the tool-bar window of frame F. */
12241 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
12242 it.first_visible_x = 0;
12243 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12244 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12245 it.paragraph_embedding = L2R;
12246
12247 while (!ITERATOR_AT_END_P (&it))
12248 {
12249 clear_glyph_row (temp_row);
12250 it.glyph_row = temp_row;
12251 display_tool_bar_line (&it, -1);
12252 }
12253 clear_glyph_row (temp_row);
12254
12255 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12256 if (n_rows)
12257 *n_rows = it.vpos > 0 ? it.vpos : -1;
12258
12259 if (pixelwise)
12260 return it.current_y;
12261 else
12262 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12263 }
12264
12265 #endif /* !USE_GTK && !HAVE_NS */
12266
12267 #if defined USE_GTK || defined HAVE_NS
12268 EXFUN (Ftool_bar_height, 2) ATTRIBUTE_CONST;
12269 EXFUN (Ftool_bar_lines_needed, 1) ATTRIBUTE_CONST;
12270 #endif
12271
12272 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12273 0, 2, 0,
12274 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12275 If FRAME is nil or omitted, use the selected frame. Optional argument
12276 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12277 (Lisp_Object frame, Lisp_Object pixelwise)
12278 {
12279 int height = 0;
12280
12281 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12282 struct frame *f = decode_any_frame (frame);
12283
12284 if (WINDOWP (f->tool_bar_window)
12285 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12286 {
12287 update_tool_bar (f, 1);
12288 if (f->n_tool_bar_items)
12289 {
12290 build_desired_tool_bar_string (f);
12291 height = tool_bar_height (f, NULL, NILP (pixelwise) ? 0 : 1);
12292 }
12293 }
12294 #endif
12295
12296 return make_number (height);
12297 }
12298
12299
12300 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12301 height should be changed. */
12302
12303 static int
12304 redisplay_tool_bar (struct frame *f)
12305 {
12306 #if defined (USE_GTK) || defined (HAVE_NS)
12307
12308 if (FRAME_EXTERNAL_TOOL_BAR (f))
12309 update_frame_tool_bar (f);
12310 return 0;
12311
12312 #else /* !USE_GTK && !HAVE_NS */
12313
12314 struct window *w;
12315 struct it it;
12316 struct glyph_row *row;
12317
12318 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12319 do anything. This means you must start with tool-bar-lines
12320 non-zero to get the auto-sizing effect. Or in other words, you
12321 can turn off tool-bars by specifying tool-bar-lines zero. */
12322 if (!WINDOWP (f->tool_bar_window)
12323 || (w = XWINDOW (f->tool_bar_window),
12324 WINDOW_PIXEL_HEIGHT (w) == 0))
12325 return 0;
12326
12327 /* Set up an iterator for the tool-bar window. */
12328 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12329 it.first_visible_x = 0;
12330 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12331 row = it.glyph_row;
12332
12333 /* Build a string that represents the contents of the tool-bar. */
12334 build_desired_tool_bar_string (f);
12335 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12336 /* FIXME: This should be controlled by a user option. But it
12337 doesn't make sense to have an R2L tool bar if the menu bar cannot
12338 be drawn also R2L, and making the menu bar R2L is tricky due
12339 toolkit-specific code that implements it. If an R2L tool bar is
12340 ever supported, display_tool_bar_line should also be augmented to
12341 call unproduce_glyphs like display_line and display_string
12342 do. */
12343 it.paragraph_embedding = L2R;
12344
12345 if (f->n_tool_bar_rows == 0)
12346 {
12347 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, 1);
12348
12349 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12350 {
12351 Lisp_Object frame;
12352 int new_lines = ((new_height + FRAME_LINE_HEIGHT (f) - 1)
12353 / FRAME_LINE_HEIGHT (f));
12354
12355 XSETFRAME (frame, f);
12356 Fmodify_frame_parameters (frame,
12357 list1 (Fcons (Qtool_bar_lines,
12358 make_number (new_lines))));
12359 /* Always do that now. */
12360 clear_glyph_matrix (w->desired_matrix);
12361 f->fonts_changed = 1;
12362 return 1;
12363 }
12364 }
12365
12366 /* Display as many lines as needed to display all tool-bar items. */
12367
12368 if (f->n_tool_bar_rows > 0)
12369 {
12370 int border, rows, height, extra;
12371
12372 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12373 border = XINT (Vtool_bar_border);
12374 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12375 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12376 else if (EQ (Vtool_bar_border, Qborder_width))
12377 border = f->border_width;
12378 else
12379 border = 0;
12380 if (border < 0)
12381 border = 0;
12382
12383 rows = f->n_tool_bar_rows;
12384 height = max (1, (it.last_visible_y - border) / rows);
12385 extra = it.last_visible_y - border - height * rows;
12386
12387 while (it.current_y < it.last_visible_y)
12388 {
12389 int h = 0;
12390 if (extra > 0 && rows-- > 0)
12391 {
12392 h = (extra + rows - 1) / rows;
12393 extra -= h;
12394 }
12395 display_tool_bar_line (&it, height + h);
12396 }
12397 }
12398 else
12399 {
12400 while (it.current_y < it.last_visible_y)
12401 display_tool_bar_line (&it, 0);
12402 }
12403
12404 /* It doesn't make much sense to try scrolling in the tool-bar
12405 window, so don't do it. */
12406 w->desired_matrix->no_scrolling_p = 1;
12407 w->must_be_updated_p = 1;
12408
12409 if (!NILP (Vauto_resize_tool_bars))
12410 {
12411 /* Do we really allow the toolbar to occupy the whole frame? */
12412 int max_tool_bar_height = MAX_FRAME_TOOL_BAR_HEIGHT (f);
12413 int change_height_p = 0;
12414
12415 /* If we couldn't display everything, change the tool-bar's
12416 height if there is room for more. */
12417 if (IT_STRING_CHARPOS (it) < it.end_charpos
12418 && it.current_y < max_tool_bar_height)
12419 change_height_p = 1;
12420
12421 /* We subtract 1 because display_tool_bar_line advances the
12422 glyph_row pointer before returning to its caller. We want to
12423 examine the last glyph row produced by
12424 display_tool_bar_line. */
12425 row = it.glyph_row - 1;
12426
12427 /* If there are blank lines at the end, except for a partially
12428 visible blank line at the end that is smaller than
12429 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12430 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12431 && row->height >= FRAME_LINE_HEIGHT (f))
12432 change_height_p = 1;
12433
12434 /* If row displays tool-bar items, but is partially visible,
12435 change the tool-bar's height. */
12436 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12437 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y
12438 && MATRIX_ROW_BOTTOM_Y (row) < max_tool_bar_height)
12439 change_height_p = 1;
12440
12441 /* Resize windows as needed by changing the `tool-bar-lines'
12442 frame parameter. */
12443 if (change_height_p)
12444 {
12445 Lisp_Object frame;
12446 int nrows;
12447 int new_height = tool_bar_height (f, &nrows, 1);
12448
12449 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12450 && !f->minimize_tool_bar_window_p)
12451 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12452 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12453 f->minimize_tool_bar_window_p = 0;
12454
12455 if (change_height_p)
12456 {
12457 /* Current size of the tool-bar window in canonical line
12458 units. */
12459 int old_lines = WINDOW_TOTAL_LINES (w);
12460 /* Required size of the tool-bar window in canonical
12461 line units. */
12462 int new_lines = ((new_height + FRAME_LINE_HEIGHT (f) - 1)
12463 / FRAME_LINE_HEIGHT (f));
12464 /* Maximum size of the tool-bar window in canonical line
12465 units that this frame can allow. */
12466 int max_lines =
12467 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f))) - 1;
12468
12469 /* Don't try to change the tool-bar window size and set
12470 the fonts_changed flag unless really necessary. That
12471 flag causes redisplay to give up and retry
12472 redisplaying the frame from scratch, so setting it
12473 unnecessarily can lead to nasty redisplay loops. */
12474 if (new_lines <= max_lines
12475 && eabs (new_lines - old_lines) >= 1)
12476 {
12477 XSETFRAME (frame, f);
12478 Fmodify_frame_parameters (frame,
12479 list1 (Fcons (Qtool_bar_lines,
12480 make_number (new_lines))));
12481 clear_glyph_matrix (w->desired_matrix);
12482 f->n_tool_bar_rows = nrows;
12483 f->fonts_changed = 1;
12484 return 1;
12485 }
12486 }
12487 }
12488 }
12489
12490 f->minimize_tool_bar_window_p = 0;
12491 return 0;
12492
12493 #endif /* USE_GTK || HAVE_NS */
12494 }
12495
12496 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12497
12498 /* Get information about the tool-bar item which is displayed in GLYPH
12499 on frame F. Return in *PROP_IDX the index where tool-bar item
12500 properties start in F->tool_bar_items. Value is zero if
12501 GLYPH doesn't display a tool-bar item. */
12502
12503 static int
12504 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12505 {
12506 Lisp_Object prop;
12507 int success_p;
12508 int charpos;
12509
12510 /* This function can be called asynchronously, which means we must
12511 exclude any possibility that Fget_text_property signals an
12512 error. */
12513 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12514 charpos = max (0, charpos);
12515
12516 /* Get the text property `menu-item' at pos. The value of that
12517 property is the start index of this item's properties in
12518 F->tool_bar_items. */
12519 prop = Fget_text_property (make_number (charpos),
12520 Qmenu_item, f->current_tool_bar_string);
12521 if (INTEGERP (prop))
12522 {
12523 *prop_idx = XINT (prop);
12524 success_p = 1;
12525 }
12526 else
12527 success_p = 0;
12528
12529 return success_p;
12530 }
12531
12532 \f
12533 /* Get information about the tool-bar item at position X/Y on frame F.
12534 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12535 the current matrix of the tool-bar window of F, or NULL if not
12536 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12537 item in F->tool_bar_items. Value is
12538
12539 -1 if X/Y is not on a tool-bar item
12540 0 if X/Y is on the same item that was highlighted before.
12541 1 otherwise. */
12542
12543 static int
12544 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12545 int *hpos, int *vpos, int *prop_idx)
12546 {
12547 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12548 struct window *w = XWINDOW (f->tool_bar_window);
12549 int area;
12550
12551 /* Find the glyph under X/Y. */
12552 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12553 if (*glyph == NULL)
12554 return -1;
12555
12556 /* Get the start of this tool-bar item's properties in
12557 f->tool_bar_items. */
12558 if (!tool_bar_item_info (f, *glyph, prop_idx))
12559 return -1;
12560
12561 /* Is mouse on the highlighted item? */
12562 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12563 && *vpos >= hlinfo->mouse_face_beg_row
12564 && *vpos <= hlinfo->mouse_face_end_row
12565 && (*vpos > hlinfo->mouse_face_beg_row
12566 || *hpos >= hlinfo->mouse_face_beg_col)
12567 && (*vpos < hlinfo->mouse_face_end_row
12568 || *hpos < hlinfo->mouse_face_end_col
12569 || hlinfo->mouse_face_past_end))
12570 return 0;
12571
12572 return 1;
12573 }
12574
12575
12576 /* EXPORT:
12577 Handle mouse button event on the tool-bar of frame F, at
12578 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12579 0 for button release. MODIFIERS is event modifiers for button
12580 release. */
12581
12582 void
12583 handle_tool_bar_click (struct frame *f, int x, int y, int down_p,
12584 int modifiers)
12585 {
12586 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12587 struct window *w = XWINDOW (f->tool_bar_window);
12588 int hpos, vpos, prop_idx;
12589 struct glyph *glyph;
12590 Lisp_Object enabled_p;
12591 int ts;
12592
12593 /* If not on the highlighted tool-bar item, and mouse-highlight is
12594 non-nil, return. This is so we generate the tool-bar button
12595 click only when the mouse button is released on the same item as
12596 where it was pressed. However, when mouse-highlight is disabled,
12597 generate the click when the button is released regardless of the
12598 highlight, since tool-bar items are not highlighted in that
12599 case. */
12600 frame_to_window_pixel_xy (w, &x, &y);
12601 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12602 if (ts == -1
12603 || (ts != 0 && !NILP (Vmouse_highlight)))
12604 return;
12605
12606 /* When mouse-highlight is off, generate the click for the item
12607 where the button was pressed, disregarding where it was
12608 released. */
12609 if (NILP (Vmouse_highlight) && !down_p)
12610 prop_idx = f->last_tool_bar_item;
12611
12612 /* If item is disabled, do nothing. */
12613 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12614 if (NILP (enabled_p))
12615 return;
12616
12617 if (down_p)
12618 {
12619 /* Show item in pressed state. */
12620 if (!NILP (Vmouse_highlight))
12621 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12622 f->last_tool_bar_item = prop_idx;
12623 }
12624 else
12625 {
12626 Lisp_Object key, frame;
12627 struct input_event event;
12628 EVENT_INIT (event);
12629
12630 /* Show item in released state. */
12631 if (!NILP (Vmouse_highlight))
12632 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12633
12634 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12635
12636 XSETFRAME (frame, f);
12637 event.kind = TOOL_BAR_EVENT;
12638 event.frame_or_window = frame;
12639 event.arg = frame;
12640 kbd_buffer_store_event (&event);
12641
12642 event.kind = TOOL_BAR_EVENT;
12643 event.frame_or_window = frame;
12644 event.arg = key;
12645 event.modifiers = modifiers;
12646 kbd_buffer_store_event (&event);
12647 f->last_tool_bar_item = -1;
12648 }
12649 }
12650
12651
12652 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12653 tool-bar window-relative coordinates X/Y. Called from
12654 note_mouse_highlight. */
12655
12656 static void
12657 note_tool_bar_highlight (struct frame *f, int x, int y)
12658 {
12659 Lisp_Object window = f->tool_bar_window;
12660 struct window *w = XWINDOW (window);
12661 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12662 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12663 int hpos, vpos;
12664 struct glyph *glyph;
12665 struct glyph_row *row;
12666 int i;
12667 Lisp_Object enabled_p;
12668 int prop_idx;
12669 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12670 int mouse_down_p, rc;
12671
12672 /* Function note_mouse_highlight is called with negative X/Y
12673 values when mouse moves outside of the frame. */
12674 if (x <= 0 || y <= 0)
12675 {
12676 clear_mouse_face (hlinfo);
12677 return;
12678 }
12679
12680 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12681 if (rc < 0)
12682 {
12683 /* Not on tool-bar item. */
12684 clear_mouse_face (hlinfo);
12685 return;
12686 }
12687 else if (rc == 0)
12688 /* On same tool-bar item as before. */
12689 goto set_help_echo;
12690
12691 clear_mouse_face (hlinfo);
12692
12693 /* Mouse is down, but on different tool-bar item? */
12694 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12695 && f == dpyinfo->last_mouse_frame);
12696
12697 if (mouse_down_p && f->last_tool_bar_item != prop_idx)
12698 return;
12699
12700 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12701
12702 /* If tool-bar item is not enabled, don't highlight it. */
12703 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12704 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12705 {
12706 /* Compute the x-position of the glyph. In front and past the
12707 image is a space. We include this in the highlighted area. */
12708 row = MATRIX_ROW (w->current_matrix, vpos);
12709 for (i = x = 0; i < hpos; ++i)
12710 x += row->glyphs[TEXT_AREA][i].pixel_width;
12711
12712 /* Record this as the current active region. */
12713 hlinfo->mouse_face_beg_col = hpos;
12714 hlinfo->mouse_face_beg_row = vpos;
12715 hlinfo->mouse_face_beg_x = x;
12716 hlinfo->mouse_face_past_end = 0;
12717
12718 hlinfo->mouse_face_end_col = hpos + 1;
12719 hlinfo->mouse_face_end_row = vpos;
12720 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12721 hlinfo->mouse_face_window = window;
12722 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12723
12724 /* Display it as active. */
12725 show_mouse_face (hlinfo, draw);
12726 }
12727
12728 set_help_echo:
12729
12730 /* Set help_echo_string to a help string to display for this tool-bar item.
12731 XTread_socket does the rest. */
12732 help_echo_object = help_echo_window = Qnil;
12733 help_echo_pos = -1;
12734 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12735 if (NILP (help_echo_string))
12736 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12737 }
12738
12739 #endif /* !USE_GTK && !HAVE_NS */
12740
12741 #endif /* HAVE_WINDOW_SYSTEM */
12742
12743
12744 \f
12745 /************************************************************************
12746 Horizontal scrolling
12747 ************************************************************************/
12748
12749 static int hscroll_window_tree (Lisp_Object);
12750 static int hscroll_windows (Lisp_Object);
12751
12752 /* For all leaf windows in the window tree rooted at WINDOW, set their
12753 hscroll value so that PT is (i) visible in the window, and (ii) so
12754 that it is not within a certain margin at the window's left and
12755 right border. Value is non-zero if any window's hscroll has been
12756 changed. */
12757
12758 static int
12759 hscroll_window_tree (Lisp_Object window)
12760 {
12761 int hscrolled_p = 0;
12762 int hscroll_relative_p = FLOATP (Vhscroll_step);
12763 int hscroll_step_abs = 0;
12764 double hscroll_step_rel = 0;
12765
12766 if (hscroll_relative_p)
12767 {
12768 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12769 if (hscroll_step_rel < 0)
12770 {
12771 hscroll_relative_p = 0;
12772 hscroll_step_abs = 0;
12773 }
12774 }
12775 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12776 {
12777 hscroll_step_abs = XINT (Vhscroll_step);
12778 if (hscroll_step_abs < 0)
12779 hscroll_step_abs = 0;
12780 }
12781 else
12782 hscroll_step_abs = 0;
12783
12784 while (WINDOWP (window))
12785 {
12786 struct window *w = XWINDOW (window);
12787
12788 if (WINDOWP (w->contents))
12789 hscrolled_p |= hscroll_window_tree (w->contents);
12790 else if (w->cursor.vpos >= 0)
12791 {
12792 int h_margin;
12793 int text_area_width;
12794 struct glyph_row *cursor_row;
12795 struct glyph_row *bottom_row;
12796 int row_r2l_p;
12797
12798 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12799 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12800 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12801 else
12802 cursor_row = bottom_row - 1;
12803
12804 if (!cursor_row->enabled_p)
12805 {
12806 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12807 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12808 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12809 else
12810 cursor_row = bottom_row - 1;
12811 }
12812 row_r2l_p = cursor_row->reversed_p;
12813
12814 text_area_width = window_box_width (w, TEXT_AREA);
12815
12816 /* Scroll when cursor is inside this scroll margin. */
12817 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12818
12819 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12820 /* For left-to-right rows, hscroll when cursor is either
12821 (i) inside the right hscroll margin, or (ii) if it is
12822 inside the left margin and the window is already
12823 hscrolled. */
12824 && ((!row_r2l_p
12825 && ((w->hscroll
12826 && w->cursor.x <= h_margin)
12827 || (cursor_row->enabled_p
12828 && cursor_row->truncated_on_right_p
12829 && (w->cursor.x >= text_area_width - h_margin))))
12830 /* For right-to-left rows, the logic is similar,
12831 except that rules for scrolling to left and right
12832 are reversed. E.g., if cursor.x <= h_margin, we
12833 need to hscroll "to the right" unconditionally,
12834 and that will scroll the screen to the left so as
12835 to reveal the next portion of the row. */
12836 || (row_r2l_p
12837 && ((cursor_row->enabled_p
12838 /* FIXME: It is confusing to set the
12839 truncated_on_right_p flag when R2L rows
12840 are actually truncated on the left. */
12841 && cursor_row->truncated_on_right_p
12842 && w->cursor.x <= h_margin)
12843 || (w->hscroll
12844 && (w->cursor.x >= text_area_width - h_margin))))))
12845 {
12846 struct it it;
12847 ptrdiff_t hscroll;
12848 struct buffer *saved_current_buffer;
12849 ptrdiff_t pt;
12850 int wanted_x;
12851
12852 /* Find point in a display of infinite width. */
12853 saved_current_buffer = current_buffer;
12854 current_buffer = XBUFFER (w->contents);
12855
12856 if (w == XWINDOW (selected_window))
12857 pt = PT;
12858 else
12859 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
12860
12861 /* Move iterator to pt starting at cursor_row->start in
12862 a line with infinite width. */
12863 init_to_row_start (&it, w, cursor_row);
12864 it.last_visible_x = INFINITY;
12865 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12866 current_buffer = saved_current_buffer;
12867
12868 /* Position cursor in window. */
12869 if (!hscroll_relative_p && hscroll_step_abs == 0)
12870 hscroll = max (0, (it.current_x
12871 - (ITERATOR_AT_END_OF_LINE_P (&it)
12872 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12873 : (text_area_width / 2))))
12874 / FRAME_COLUMN_WIDTH (it.f);
12875 else if ((!row_r2l_p
12876 && w->cursor.x >= text_area_width - h_margin)
12877 || (row_r2l_p && w->cursor.x <= h_margin))
12878 {
12879 if (hscroll_relative_p)
12880 wanted_x = text_area_width * (1 - hscroll_step_rel)
12881 - h_margin;
12882 else
12883 wanted_x = text_area_width
12884 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12885 - h_margin;
12886 hscroll
12887 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12888 }
12889 else
12890 {
12891 if (hscroll_relative_p)
12892 wanted_x = text_area_width * hscroll_step_rel
12893 + h_margin;
12894 else
12895 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12896 + h_margin;
12897 hscroll
12898 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12899 }
12900 hscroll = max (hscroll, w->min_hscroll);
12901
12902 /* Don't prevent redisplay optimizations if hscroll
12903 hasn't changed, as it will unnecessarily slow down
12904 redisplay. */
12905 if (w->hscroll != hscroll)
12906 {
12907 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
12908 w->hscroll = hscroll;
12909 hscrolled_p = 1;
12910 }
12911 }
12912 }
12913
12914 window = w->next;
12915 }
12916
12917 /* Value is non-zero if hscroll of any leaf window has been changed. */
12918 return hscrolled_p;
12919 }
12920
12921
12922 /* Set hscroll so that cursor is visible and not inside horizontal
12923 scroll margins for all windows in the tree rooted at WINDOW. See
12924 also hscroll_window_tree above. Value is non-zero if any window's
12925 hscroll has been changed. If it has, desired matrices on the frame
12926 of WINDOW are cleared. */
12927
12928 static int
12929 hscroll_windows (Lisp_Object window)
12930 {
12931 int hscrolled_p = hscroll_window_tree (window);
12932 if (hscrolled_p)
12933 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
12934 return hscrolled_p;
12935 }
12936
12937
12938 \f
12939 /************************************************************************
12940 Redisplay
12941 ************************************************************************/
12942
12943 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12944 to a non-zero value. This is sometimes handy to have in a debugger
12945 session. */
12946
12947 #ifdef GLYPH_DEBUG
12948
12949 /* First and last unchanged row for try_window_id. */
12950
12951 static int debug_first_unchanged_at_end_vpos;
12952 static int debug_last_unchanged_at_beg_vpos;
12953
12954 /* Delta vpos and y. */
12955
12956 static int debug_dvpos, debug_dy;
12957
12958 /* Delta in characters and bytes for try_window_id. */
12959
12960 static ptrdiff_t debug_delta, debug_delta_bytes;
12961
12962 /* Values of window_end_pos and window_end_vpos at the end of
12963 try_window_id. */
12964
12965 static ptrdiff_t debug_end_vpos;
12966
12967 /* Append a string to W->desired_matrix->method. FMT is a printf
12968 format string. If trace_redisplay_p is true also printf the
12969 resulting string to stderr. */
12970
12971 static void debug_method_add (struct window *, char const *, ...)
12972 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12973
12974 static void
12975 debug_method_add (struct window *w, char const *fmt, ...)
12976 {
12977 void *ptr = w;
12978 char *method = w->desired_matrix->method;
12979 int len = strlen (method);
12980 int size = sizeof w->desired_matrix->method;
12981 int remaining = size - len - 1;
12982 va_list ap;
12983
12984 if (len && remaining)
12985 {
12986 method[len] = '|';
12987 --remaining, ++len;
12988 }
12989
12990 va_start (ap, fmt);
12991 vsnprintf (method + len, remaining + 1, fmt, ap);
12992 va_end (ap);
12993
12994 if (trace_redisplay_p)
12995 fprintf (stderr, "%p (%s): %s\n",
12996 ptr,
12997 ((BUFFERP (w->contents)
12998 && STRINGP (BVAR (XBUFFER (w->contents), name)))
12999 ? SSDATA (BVAR (XBUFFER (w->contents), name))
13000 : "no buffer"),
13001 method + len);
13002 }
13003
13004 #endif /* GLYPH_DEBUG */
13005
13006
13007 /* Value is non-zero if all changes in window W, which displays
13008 current_buffer, are in the text between START and END. START is a
13009 buffer position, END is given as a distance from Z. Used in
13010 redisplay_internal for display optimization. */
13011
13012 static int
13013 text_outside_line_unchanged_p (struct window *w,
13014 ptrdiff_t start, ptrdiff_t end)
13015 {
13016 int unchanged_p = 1;
13017
13018 /* If text or overlays have changed, see where. */
13019 if (window_outdated (w))
13020 {
13021 /* Gap in the line? */
13022 if (GPT < start || Z - GPT < end)
13023 unchanged_p = 0;
13024
13025 /* Changes start in front of the line, or end after it? */
13026 if (unchanged_p
13027 && (BEG_UNCHANGED < start - 1
13028 || END_UNCHANGED < end))
13029 unchanged_p = 0;
13030
13031 /* If selective display, can't optimize if changes start at the
13032 beginning of the line. */
13033 if (unchanged_p
13034 && INTEGERP (BVAR (current_buffer, selective_display))
13035 && XINT (BVAR (current_buffer, selective_display)) > 0
13036 && (BEG_UNCHANGED < start || GPT <= start))
13037 unchanged_p = 0;
13038
13039 /* If there are overlays at the start or end of the line, these
13040 may have overlay strings with newlines in them. A change at
13041 START, for instance, may actually concern the display of such
13042 overlay strings as well, and they are displayed on different
13043 lines. So, quickly rule out this case. (For the future, it
13044 might be desirable to implement something more telling than
13045 just BEG/END_UNCHANGED.) */
13046 if (unchanged_p)
13047 {
13048 if (BEG + BEG_UNCHANGED == start
13049 && overlay_touches_p (start))
13050 unchanged_p = 0;
13051 if (END_UNCHANGED == end
13052 && overlay_touches_p (Z - end))
13053 unchanged_p = 0;
13054 }
13055
13056 /* Under bidi reordering, adding or deleting a character in the
13057 beginning of a paragraph, before the first strong directional
13058 character, can change the base direction of the paragraph (unless
13059 the buffer specifies a fixed paragraph direction), which will
13060 require to redisplay the whole paragraph. It might be worthwhile
13061 to find the paragraph limits and widen the range of redisplayed
13062 lines to that, but for now just give up this optimization. */
13063 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13064 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13065 unchanged_p = 0;
13066 }
13067
13068 return unchanged_p;
13069 }
13070
13071
13072 /* Do a frame update, taking possible shortcuts into account. This is
13073 the main external entry point for redisplay.
13074
13075 If the last redisplay displayed an echo area message and that message
13076 is no longer requested, we clear the echo area or bring back the
13077 mini-buffer if that is in use. */
13078
13079 void
13080 redisplay (void)
13081 {
13082 redisplay_internal ();
13083 }
13084
13085
13086 static Lisp_Object
13087 overlay_arrow_string_or_property (Lisp_Object var)
13088 {
13089 Lisp_Object val;
13090
13091 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13092 return val;
13093
13094 return Voverlay_arrow_string;
13095 }
13096
13097 /* Return 1 if there are any overlay-arrows in current_buffer. */
13098 static int
13099 overlay_arrow_in_current_buffer_p (void)
13100 {
13101 Lisp_Object vlist;
13102
13103 for (vlist = Voverlay_arrow_variable_list;
13104 CONSP (vlist);
13105 vlist = XCDR (vlist))
13106 {
13107 Lisp_Object var = XCAR (vlist);
13108 Lisp_Object val;
13109
13110 if (!SYMBOLP (var))
13111 continue;
13112 val = find_symbol_value (var);
13113 if (MARKERP (val)
13114 && current_buffer == XMARKER (val)->buffer)
13115 return 1;
13116 }
13117 return 0;
13118 }
13119
13120
13121 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13122 has changed. */
13123
13124 static int
13125 overlay_arrows_changed_p (void)
13126 {
13127 Lisp_Object vlist;
13128
13129 for (vlist = Voverlay_arrow_variable_list;
13130 CONSP (vlist);
13131 vlist = XCDR (vlist))
13132 {
13133 Lisp_Object var = XCAR (vlist);
13134 Lisp_Object val, pstr;
13135
13136 if (!SYMBOLP (var))
13137 continue;
13138 val = find_symbol_value (var);
13139 if (!MARKERP (val))
13140 continue;
13141 if (! EQ (COERCE_MARKER (val),
13142 Fget (var, Qlast_arrow_position))
13143 || ! (pstr = overlay_arrow_string_or_property (var),
13144 EQ (pstr, Fget (var, Qlast_arrow_string))))
13145 return 1;
13146 }
13147 return 0;
13148 }
13149
13150 /* Mark overlay arrows to be updated on next redisplay. */
13151
13152 static void
13153 update_overlay_arrows (int up_to_date)
13154 {
13155 Lisp_Object vlist;
13156
13157 for (vlist = Voverlay_arrow_variable_list;
13158 CONSP (vlist);
13159 vlist = XCDR (vlist))
13160 {
13161 Lisp_Object var = XCAR (vlist);
13162
13163 if (!SYMBOLP (var))
13164 continue;
13165
13166 if (up_to_date > 0)
13167 {
13168 Lisp_Object val = find_symbol_value (var);
13169 Fput (var, Qlast_arrow_position,
13170 COERCE_MARKER (val));
13171 Fput (var, Qlast_arrow_string,
13172 overlay_arrow_string_or_property (var));
13173 }
13174 else if (up_to_date < 0
13175 || !NILP (Fget (var, Qlast_arrow_position)))
13176 {
13177 Fput (var, Qlast_arrow_position, Qt);
13178 Fput (var, Qlast_arrow_string, Qt);
13179 }
13180 }
13181 }
13182
13183
13184 /* Return overlay arrow string to display at row.
13185 Return integer (bitmap number) for arrow bitmap in left fringe.
13186 Return nil if no overlay arrow. */
13187
13188 static Lisp_Object
13189 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13190 {
13191 Lisp_Object vlist;
13192
13193 for (vlist = Voverlay_arrow_variable_list;
13194 CONSP (vlist);
13195 vlist = XCDR (vlist))
13196 {
13197 Lisp_Object var = XCAR (vlist);
13198 Lisp_Object val;
13199
13200 if (!SYMBOLP (var))
13201 continue;
13202
13203 val = find_symbol_value (var);
13204
13205 if (MARKERP (val)
13206 && current_buffer == XMARKER (val)->buffer
13207 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13208 {
13209 if (FRAME_WINDOW_P (it->f)
13210 /* FIXME: if ROW->reversed_p is set, this should test
13211 the right fringe, not the left one. */
13212 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13213 {
13214 #ifdef HAVE_WINDOW_SYSTEM
13215 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13216 {
13217 int fringe_bitmap;
13218 if ((fringe_bitmap = lookup_fringe_bitmap (val)) != 0)
13219 return make_number (fringe_bitmap);
13220 }
13221 #endif
13222 return make_number (-1); /* Use default arrow bitmap. */
13223 }
13224 return overlay_arrow_string_or_property (var);
13225 }
13226 }
13227
13228 return Qnil;
13229 }
13230
13231 /* Return 1 if point moved out of or into a composition. Otherwise
13232 return 0. PREV_BUF and PREV_PT are the last point buffer and
13233 position. BUF and PT are the current point buffer and position. */
13234
13235 static int
13236 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13237 struct buffer *buf, ptrdiff_t pt)
13238 {
13239 ptrdiff_t start, end;
13240 Lisp_Object prop;
13241 Lisp_Object buffer;
13242
13243 XSETBUFFER (buffer, buf);
13244 /* Check a composition at the last point if point moved within the
13245 same buffer. */
13246 if (prev_buf == buf)
13247 {
13248 if (prev_pt == pt)
13249 /* Point didn't move. */
13250 return 0;
13251
13252 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13253 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13254 && composition_valid_p (start, end, prop)
13255 && start < prev_pt && end > prev_pt)
13256 /* The last point was within the composition. Return 1 iff
13257 point moved out of the composition. */
13258 return (pt <= start || pt >= end);
13259 }
13260
13261 /* Check a composition at the current point. */
13262 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13263 && find_composition (pt, -1, &start, &end, &prop, buffer)
13264 && composition_valid_p (start, end, prop)
13265 && start < pt && end > pt);
13266 }
13267
13268 /* Reconsider the clip changes of buffer which is displayed in W. */
13269
13270 static void
13271 reconsider_clip_changes (struct window *w)
13272 {
13273 struct buffer *b = XBUFFER (w->contents);
13274
13275 if (b->clip_changed
13276 && w->window_end_valid
13277 && w->current_matrix->buffer == b
13278 && w->current_matrix->zv == BUF_ZV (b)
13279 && w->current_matrix->begv == BUF_BEGV (b))
13280 b->clip_changed = 0;
13281
13282 /* If display wasn't paused, and W is not a tool bar window, see if
13283 point has been moved into or out of a composition. In that case,
13284 we set b->clip_changed to 1 to force updating the screen. If
13285 b->clip_changed has already been set to 1, we can skip this
13286 check. */
13287 if (!b->clip_changed && w->window_end_valid)
13288 {
13289 ptrdiff_t pt = (w == XWINDOW (selected_window)
13290 ? PT : marker_position (w->pointm));
13291
13292 if ((w->current_matrix->buffer != b || pt != w->last_point)
13293 && check_point_in_composition (w->current_matrix->buffer,
13294 w->last_point, b, pt))
13295 b->clip_changed = 1;
13296 }
13297 }
13298
13299 static void
13300 propagate_buffer_redisplay (void)
13301 { /* Resetting b->text->redisplay is problematic!
13302 We can't just reset it in the case that some window that displays
13303 it has not been redisplayed; and such a window can stay
13304 unredisplayed for a long time if it's currently invisible.
13305 But we do want to reset it at the end of redisplay otherwise
13306 its displayed windows will keep being redisplayed over and over
13307 again.
13308 So we copy all b->text->redisplay flags up to their windows here,
13309 such that mark_window_display_accurate can safely reset
13310 b->text->redisplay. */
13311 Lisp_Object ws = window_list ();
13312 for (; CONSP (ws); ws = XCDR (ws))
13313 {
13314 struct window *thisw = XWINDOW (XCAR (ws));
13315 struct buffer *thisb = XBUFFER (thisw->contents);
13316 if (thisb->text->redisplay)
13317 thisw->redisplay = true;
13318 }
13319 }
13320
13321 #define STOP_POLLING \
13322 do { if (! polling_stopped_here) stop_polling (); \
13323 polling_stopped_here = 1; } while (0)
13324
13325 #define RESUME_POLLING \
13326 do { if (polling_stopped_here) start_polling (); \
13327 polling_stopped_here = 0; } while (0)
13328
13329
13330 /* Perhaps in the future avoid recentering windows if it
13331 is not necessary; currently that causes some problems. */
13332
13333 static void
13334 redisplay_internal (void)
13335 {
13336 struct window *w = XWINDOW (selected_window);
13337 struct window *sw;
13338 struct frame *fr;
13339 int pending;
13340 bool must_finish = 0, match_p;
13341 struct text_pos tlbufpos, tlendpos;
13342 int number_of_visible_frames;
13343 ptrdiff_t count;
13344 struct frame *sf;
13345 int polling_stopped_here = 0;
13346 Lisp_Object tail, frame;
13347
13348 /* True means redisplay has to consider all windows on all
13349 frames. False, only selected_window is considered. */
13350 bool consider_all_windows_p;
13351
13352 /* True means redisplay has to redisplay the miniwindow. */
13353 bool update_miniwindow_p = false;
13354
13355 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13356
13357 /* No redisplay if running in batch mode or frame is not yet fully
13358 initialized, or redisplay is explicitly turned off by setting
13359 Vinhibit_redisplay. */
13360 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13361 || !NILP (Vinhibit_redisplay))
13362 return;
13363
13364 /* Don't examine these until after testing Vinhibit_redisplay.
13365 When Emacs is shutting down, perhaps because its connection to
13366 X has dropped, we should not look at them at all. */
13367 fr = XFRAME (w->frame);
13368 sf = SELECTED_FRAME ();
13369
13370 if (!fr->glyphs_initialized_p)
13371 return;
13372
13373 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13374 if (popup_activated ())
13375 return;
13376 #endif
13377
13378 /* I don't think this happens but let's be paranoid. */
13379 if (redisplaying_p)
13380 return;
13381
13382 /* Record a function that clears redisplaying_p
13383 when we leave this function. */
13384 count = SPECPDL_INDEX ();
13385 record_unwind_protect_void (unwind_redisplay);
13386 redisplaying_p = 1;
13387 specbind (Qinhibit_free_realized_faces, Qnil);
13388
13389 /* Record this function, so it appears on the profiler's backtraces. */
13390 record_in_backtrace (Qredisplay_internal, &Qnil, 0);
13391
13392 FOR_EACH_FRAME (tail, frame)
13393 XFRAME (frame)->already_hscrolled_p = 0;
13394
13395 retry:
13396 /* Remember the currently selected window. */
13397 sw = w;
13398
13399 pending = 0;
13400 last_escape_glyph_frame = NULL;
13401 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
13402 last_glyphless_glyph_frame = NULL;
13403 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
13404
13405 /* If face_change_count is non-zero, init_iterator will free all
13406 realized faces, which includes the faces referenced from current
13407 matrices. So, we can't reuse current matrices in this case. */
13408 if (face_change_count)
13409 windows_or_buffers_changed = 47;
13410
13411 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13412 && FRAME_TTY (sf)->previous_frame != sf)
13413 {
13414 /* Since frames on a single ASCII terminal share the same
13415 display area, displaying a different frame means redisplay
13416 the whole thing. */
13417 SET_FRAME_GARBAGED (sf);
13418 #ifndef DOS_NT
13419 set_tty_color_mode (FRAME_TTY (sf), sf);
13420 #endif
13421 FRAME_TTY (sf)->previous_frame = sf;
13422 }
13423
13424 /* Set the visible flags for all frames. Do this before checking for
13425 resized or garbaged frames; they want to know if their frames are
13426 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13427 number_of_visible_frames = 0;
13428
13429 FOR_EACH_FRAME (tail, frame)
13430 {
13431 struct frame *f = XFRAME (frame);
13432
13433 if (FRAME_VISIBLE_P (f))
13434 {
13435 ++number_of_visible_frames;
13436 /* Adjust matrices for visible frames only. */
13437 if (f->fonts_changed)
13438 {
13439 adjust_frame_glyphs (f);
13440 f->fonts_changed = 0;
13441 }
13442 /* If cursor type has been changed on the frame
13443 other than selected, consider all frames. */
13444 if (f != sf && f->cursor_type_changed)
13445 update_mode_lines = 31;
13446 }
13447 clear_desired_matrices (f);
13448 }
13449
13450 /* Notice any pending interrupt request to change frame size. */
13451 do_pending_window_change (1);
13452
13453 /* do_pending_window_change could change the selected_window due to
13454 frame resizing which makes the selected window too small. */
13455 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13456 sw = w;
13457
13458 /* Clear frames marked as garbaged. */
13459 clear_garbaged_frames ();
13460
13461 /* Build menubar and tool-bar items. */
13462 if (NILP (Vmemory_full))
13463 prepare_menu_bars ();
13464
13465 reconsider_clip_changes (w);
13466
13467 /* In most cases selected window displays current buffer. */
13468 match_p = XBUFFER (w->contents) == current_buffer;
13469 if (match_p)
13470 {
13471 /* Detect case that we need to write or remove a star in the mode line. */
13472 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13473 w->update_mode_line = 1;
13474
13475 if (mode_line_update_needed (w))
13476 w->update_mode_line = 1;
13477 }
13478
13479 /* Normally the message* functions will have already displayed and
13480 updated the echo area, but the frame may have been trashed, or
13481 the update may have been preempted, so display the echo area
13482 again here. Checking message_cleared_p captures the case that
13483 the echo area should be cleared. */
13484 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13485 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13486 || (message_cleared_p
13487 && minibuf_level == 0
13488 /* If the mini-window is currently selected, this means the
13489 echo-area doesn't show through. */
13490 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13491 {
13492 int window_height_changed_p = echo_area_display (0);
13493
13494 if (message_cleared_p)
13495 update_miniwindow_p = true;
13496
13497 must_finish = 1;
13498
13499 /* If we don't display the current message, don't clear the
13500 message_cleared_p flag, because, if we did, we wouldn't clear
13501 the echo area in the next redisplay which doesn't preserve
13502 the echo area. */
13503 if (!display_last_displayed_message_p)
13504 message_cleared_p = 0;
13505
13506 if (window_height_changed_p)
13507 {
13508 windows_or_buffers_changed = 50;
13509
13510 /* If window configuration was changed, frames may have been
13511 marked garbaged. Clear them or we will experience
13512 surprises wrt scrolling. */
13513 clear_garbaged_frames ();
13514 }
13515 }
13516 else if (EQ (selected_window, minibuf_window)
13517 && (current_buffer->clip_changed || window_outdated (w))
13518 && resize_mini_window (w, 0))
13519 {
13520 /* Resized active mini-window to fit the size of what it is
13521 showing if its contents might have changed. */
13522 must_finish = 1;
13523
13524 /* If window configuration was changed, frames may have been
13525 marked garbaged. Clear them or we will experience
13526 surprises wrt scrolling. */
13527 clear_garbaged_frames ();
13528 }
13529
13530 if (windows_or_buffers_changed && !update_mode_lines)
13531 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13532 only the windows's contents needs to be refreshed, or whether the
13533 mode-lines also need a refresh. */
13534 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13535 ? REDISPLAY_SOME : 32);
13536
13537 /* If specs for an arrow have changed, do thorough redisplay
13538 to ensure we remove any arrow that should no longer exist. */
13539 if (overlay_arrows_changed_p ())
13540 /* Apparently, this is the only case where we update other windows,
13541 without updating other mode-lines. */
13542 windows_or_buffers_changed = 49;
13543
13544 consider_all_windows_p = (update_mode_lines
13545 || windows_or_buffers_changed);
13546
13547 #define AINC(a,i) \
13548 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13549 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13550
13551 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13552 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13553
13554 /* Optimize the case that only the line containing the cursor in the
13555 selected window has changed. Variables starting with this_ are
13556 set in display_line and record information about the line
13557 containing the cursor. */
13558 tlbufpos = this_line_start_pos;
13559 tlendpos = this_line_end_pos;
13560 if (!consider_all_windows_p
13561 && CHARPOS (tlbufpos) > 0
13562 && !w->update_mode_line
13563 && !current_buffer->clip_changed
13564 && !current_buffer->prevent_redisplay_optimizations_p
13565 && FRAME_VISIBLE_P (XFRAME (w->frame))
13566 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13567 && !XFRAME (w->frame)->cursor_type_changed
13568 /* Make sure recorded data applies to current buffer, etc. */
13569 && this_line_buffer == current_buffer
13570 && match_p
13571 && !w->force_start
13572 && !w->optional_new_start
13573 /* Point must be on the line that we have info recorded about. */
13574 && PT >= CHARPOS (tlbufpos)
13575 && PT <= Z - CHARPOS (tlendpos)
13576 /* All text outside that line, including its final newline,
13577 must be unchanged. */
13578 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13579 CHARPOS (tlendpos)))
13580 {
13581 if (CHARPOS (tlbufpos) > BEGV
13582 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13583 && (CHARPOS (tlbufpos) == ZV
13584 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13585 /* Former continuation line has disappeared by becoming empty. */
13586 goto cancel;
13587 else if (window_outdated (w) || MINI_WINDOW_P (w))
13588 {
13589 /* We have to handle the case of continuation around a
13590 wide-column character (see the comment in indent.c around
13591 line 1340).
13592
13593 For instance, in the following case:
13594
13595 -------- Insert --------
13596 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13597 J_I_ ==> J_I_ `^^' are cursors.
13598 ^^ ^^
13599 -------- --------
13600
13601 As we have to redraw the line above, we cannot use this
13602 optimization. */
13603
13604 struct it it;
13605 int line_height_before = this_line_pixel_height;
13606
13607 /* Note that start_display will handle the case that the
13608 line starting at tlbufpos is a continuation line. */
13609 start_display (&it, w, tlbufpos);
13610
13611 /* Implementation note: It this still necessary? */
13612 if (it.current_x != this_line_start_x)
13613 goto cancel;
13614
13615 TRACE ((stderr, "trying display optimization 1\n"));
13616 w->cursor.vpos = -1;
13617 overlay_arrow_seen = 0;
13618 it.vpos = this_line_vpos;
13619 it.current_y = this_line_y;
13620 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13621 display_line (&it);
13622
13623 /* If line contains point, is not continued,
13624 and ends at same distance from eob as before, we win. */
13625 if (w->cursor.vpos >= 0
13626 /* Line is not continued, otherwise this_line_start_pos
13627 would have been set to 0 in display_line. */
13628 && CHARPOS (this_line_start_pos)
13629 /* Line ends as before. */
13630 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13631 /* Line has same height as before. Otherwise other lines
13632 would have to be shifted up or down. */
13633 && this_line_pixel_height == line_height_before)
13634 {
13635 /* If this is not the window's last line, we must adjust
13636 the charstarts of the lines below. */
13637 if (it.current_y < it.last_visible_y)
13638 {
13639 struct glyph_row *row
13640 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13641 ptrdiff_t delta, delta_bytes;
13642
13643 /* We used to distinguish between two cases here,
13644 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13645 when the line ends in a newline or the end of the
13646 buffer's accessible portion. But both cases did
13647 the same, so they were collapsed. */
13648 delta = (Z
13649 - CHARPOS (tlendpos)
13650 - MATRIX_ROW_START_CHARPOS (row));
13651 delta_bytes = (Z_BYTE
13652 - BYTEPOS (tlendpos)
13653 - MATRIX_ROW_START_BYTEPOS (row));
13654
13655 increment_matrix_positions (w->current_matrix,
13656 this_line_vpos + 1,
13657 w->current_matrix->nrows,
13658 delta, delta_bytes);
13659 }
13660
13661 /* If this row displays text now but previously didn't,
13662 or vice versa, w->window_end_vpos may have to be
13663 adjusted. */
13664 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13665 {
13666 if (w->window_end_vpos < this_line_vpos)
13667 w->window_end_vpos = this_line_vpos;
13668 }
13669 else if (w->window_end_vpos == this_line_vpos
13670 && this_line_vpos > 0)
13671 w->window_end_vpos = this_line_vpos - 1;
13672 w->window_end_valid = 0;
13673
13674 /* Update hint: No need to try to scroll in update_window. */
13675 w->desired_matrix->no_scrolling_p = 1;
13676
13677 #ifdef GLYPH_DEBUG
13678 *w->desired_matrix->method = 0;
13679 debug_method_add (w, "optimization 1");
13680 #endif
13681 #ifdef HAVE_WINDOW_SYSTEM
13682 update_window_fringes (w, 0);
13683 #endif
13684 goto update;
13685 }
13686 else
13687 goto cancel;
13688 }
13689 else if (/* Cursor position hasn't changed. */
13690 PT == w->last_point
13691 /* Make sure the cursor was last displayed
13692 in this window. Otherwise we have to reposition it. */
13693
13694 /* PXW: Must be converted to pixels, probably. */
13695 && 0 <= w->cursor.vpos
13696 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13697 {
13698 if (!must_finish)
13699 {
13700 do_pending_window_change (1);
13701 /* If selected_window changed, redisplay again. */
13702 if (WINDOWP (selected_window)
13703 && (w = XWINDOW (selected_window)) != sw)
13704 goto retry;
13705
13706 /* We used to always goto end_of_redisplay here, but this
13707 isn't enough if we have a blinking cursor. */
13708 if (w->cursor_off_p == w->last_cursor_off_p)
13709 goto end_of_redisplay;
13710 }
13711 goto update;
13712 }
13713 /* If highlighting the region, or if the cursor is in the echo area,
13714 then we can't just move the cursor. */
13715 else if (NILP (Vshow_trailing_whitespace)
13716 && !cursor_in_echo_area)
13717 {
13718 struct it it;
13719 struct glyph_row *row;
13720
13721 /* Skip from tlbufpos to PT and see where it is. Note that
13722 PT may be in invisible text. If so, we will end at the
13723 next visible position. */
13724 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13725 NULL, DEFAULT_FACE_ID);
13726 it.current_x = this_line_start_x;
13727 it.current_y = this_line_y;
13728 it.vpos = this_line_vpos;
13729
13730 /* The call to move_it_to stops in front of PT, but
13731 moves over before-strings. */
13732 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13733
13734 if (it.vpos == this_line_vpos
13735 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13736 row->enabled_p))
13737 {
13738 eassert (this_line_vpos == it.vpos);
13739 eassert (this_line_y == it.current_y);
13740 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13741 #ifdef GLYPH_DEBUG
13742 *w->desired_matrix->method = 0;
13743 debug_method_add (w, "optimization 3");
13744 #endif
13745 goto update;
13746 }
13747 else
13748 goto cancel;
13749 }
13750
13751 cancel:
13752 /* Text changed drastically or point moved off of line. */
13753 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13754 }
13755
13756 CHARPOS (this_line_start_pos) = 0;
13757 ++clear_face_cache_count;
13758 #ifdef HAVE_WINDOW_SYSTEM
13759 ++clear_image_cache_count;
13760 #endif
13761
13762 /* Build desired matrices, and update the display. If
13763 consider_all_windows_p is non-zero, do it for all windows on all
13764 frames. Otherwise do it for selected_window, only. */
13765
13766 if (consider_all_windows_p)
13767 {
13768 FOR_EACH_FRAME (tail, frame)
13769 XFRAME (frame)->updated_p = 0;
13770
13771 propagate_buffer_redisplay ();
13772
13773 FOR_EACH_FRAME (tail, frame)
13774 {
13775 struct frame *f = XFRAME (frame);
13776
13777 /* We don't have to do anything for unselected terminal
13778 frames. */
13779 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13780 && !EQ (FRAME_TTY (f)->top_frame, frame))
13781 continue;
13782
13783 retry_frame:
13784
13785 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13786 {
13787 bool gcscrollbars
13788 /* Only GC scrollbars when we redisplay the whole frame. */
13789 = f->redisplay || !REDISPLAY_SOME_P ();
13790 /* Mark all the scroll bars to be removed; we'll redeem
13791 the ones we want when we redisplay their windows. */
13792 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13793 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13794
13795 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13796 redisplay_windows (FRAME_ROOT_WINDOW (f));
13797 /* Remember that the invisible frames need to be redisplayed next
13798 time they're visible. */
13799 else if (!REDISPLAY_SOME_P ())
13800 f->redisplay = true;
13801
13802 /* The X error handler may have deleted that frame. */
13803 if (!FRAME_LIVE_P (f))
13804 continue;
13805
13806 /* Any scroll bars which redisplay_windows should have
13807 nuked should now go away. */
13808 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13809 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13810
13811 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13812 {
13813 /* If fonts changed on visible frame, display again. */
13814 if (f->fonts_changed)
13815 {
13816 adjust_frame_glyphs (f);
13817 f->fonts_changed = 0;
13818 goto retry_frame;
13819 }
13820
13821 /* See if we have to hscroll. */
13822 if (!f->already_hscrolled_p)
13823 {
13824 f->already_hscrolled_p = 1;
13825 if (hscroll_windows (f->root_window))
13826 goto retry_frame;
13827 }
13828
13829 /* Prevent various kinds of signals during display
13830 update. stdio is not robust about handling
13831 signals, which can cause an apparent I/O error. */
13832 if (interrupt_input)
13833 unrequest_sigio ();
13834 STOP_POLLING;
13835
13836 pending |= update_frame (f, 0, 0);
13837 f->cursor_type_changed = 0;
13838 f->updated_p = 1;
13839 }
13840 }
13841 }
13842
13843 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
13844
13845 if (!pending)
13846 {
13847 /* Do the mark_window_display_accurate after all windows have
13848 been redisplayed because this call resets flags in buffers
13849 which are needed for proper redisplay. */
13850 FOR_EACH_FRAME (tail, frame)
13851 {
13852 struct frame *f = XFRAME (frame);
13853 if (f->updated_p)
13854 {
13855 f->redisplay = false;
13856 mark_window_display_accurate (f->root_window, 1);
13857 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13858 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13859 }
13860 }
13861 }
13862 }
13863 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13864 {
13865 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13866 struct frame *mini_frame;
13867
13868 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
13869 /* Use list_of_error, not Qerror, so that
13870 we catch only errors and don't run the debugger. */
13871 internal_condition_case_1 (redisplay_window_1, selected_window,
13872 list_of_error,
13873 redisplay_window_error);
13874 if (update_miniwindow_p)
13875 internal_condition_case_1 (redisplay_window_1, mini_window,
13876 list_of_error,
13877 redisplay_window_error);
13878
13879 /* Compare desired and current matrices, perform output. */
13880
13881 update:
13882 /* If fonts changed, display again. */
13883 if (sf->fonts_changed)
13884 goto retry;
13885
13886 /* Prevent various kinds of signals during display update.
13887 stdio is not robust about handling signals,
13888 which can cause an apparent I/O error. */
13889 if (interrupt_input)
13890 unrequest_sigio ();
13891 STOP_POLLING;
13892
13893 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13894 {
13895 if (hscroll_windows (selected_window))
13896 goto retry;
13897
13898 XWINDOW (selected_window)->must_be_updated_p = true;
13899 pending = update_frame (sf, 0, 0);
13900 sf->cursor_type_changed = 0;
13901 }
13902
13903 /* We may have called echo_area_display at the top of this
13904 function. If the echo area is on another frame, that may
13905 have put text on a frame other than the selected one, so the
13906 above call to update_frame would not have caught it. Catch
13907 it here. */
13908 mini_window = FRAME_MINIBUF_WINDOW (sf);
13909 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
13910
13911 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
13912 {
13913 XWINDOW (mini_window)->must_be_updated_p = true;
13914 pending |= update_frame (mini_frame, 0, 0);
13915 mini_frame->cursor_type_changed = 0;
13916 if (!pending && hscroll_windows (mini_window))
13917 goto retry;
13918 }
13919 }
13920
13921 /* If display was paused because of pending input, make sure we do a
13922 thorough update the next time. */
13923 if (pending)
13924 {
13925 /* Prevent the optimization at the beginning of
13926 redisplay_internal that tries a single-line update of the
13927 line containing the cursor in the selected window. */
13928 CHARPOS (this_line_start_pos) = 0;
13929
13930 /* Let the overlay arrow be updated the next time. */
13931 update_overlay_arrows (0);
13932
13933 /* If we pause after scrolling, some rows in the current
13934 matrices of some windows are not valid. */
13935 if (!WINDOW_FULL_WIDTH_P (w)
13936 && !FRAME_WINDOW_P (XFRAME (w->frame)))
13937 update_mode_lines = 36;
13938 }
13939 else
13940 {
13941 if (!consider_all_windows_p)
13942 {
13943 /* This has already been done above if
13944 consider_all_windows_p is set. */
13945 if (XBUFFER (w->contents)->text->redisplay
13946 && buffer_window_count (XBUFFER (w->contents)) > 1)
13947 /* This can happen if b->text->redisplay was set during
13948 jit-lock. */
13949 propagate_buffer_redisplay ();
13950 mark_window_display_accurate_1 (w, 1);
13951
13952 /* Say overlay arrows are up to date. */
13953 update_overlay_arrows (1);
13954
13955 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
13956 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
13957 }
13958
13959 update_mode_lines = 0;
13960 windows_or_buffers_changed = 0;
13961 }
13962
13963 /* Start SIGIO interrupts coming again. Having them off during the
13964 code above makes it less likely one will discard output, but not
13965 impossible, since there might be stuff in the system buffer here.
13966 But it is much hairier to try to do anything about that. */
13967 if (interrupt_input)
13968 request_sigio ();
13969 RESUME_POLLING;
13970
13971 /* If a frame has become visible which was not before, redisplay
13972 again, so that we display it. Expose events for such a frame
13973 (which it gets when becoming visible) don't call the parts of
13974 redisplay constructing glyphs, so simply exposing a frame won't
13975 display anything in this case. So, we have to display these
13976 frames here explicitly. */
13977 if (!pending)
13978 {
13979 int new_count = 0;
13980
13981 FOR_EACH_FRAME (tail, frame)
13982 {
13983 if (XFRAME (frame)->visible)
13984 new_count++;
13985 }
13986
13987 if (new_count != number_of_visible_frames)
13988 windows_or_buffers_changed = 52;
13989 }
13990
13991 /* Change frame size now if a change is pending. */
13992 do_pending_window_change (1);
13993
13994 /* If we just did a pending size change, or have additional
13995 visible frames, or selected_window changed, redisplay again. */
13996 if ((windows_or_buffers_changed && !pending)
13997 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
13998 goto retry;
13999
14000 /* Clear the face and image caches.
14001
14002 We used to do this only if consider_all_windows_p. But the cache
14003 needs to be cleared if a timer creates images in the current
14004 buffer (e.g. the test case in Bug#6230). */
14005
14006 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14007 {
14008 clear_face_cache (0);
14009 clear_face_cache_count = 0;
14010 }
14011
14012 #ifdef HAVE_WINDOW_SYSTEM
14013 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14014 {
14015 clear_image_caches (Qnil);
14016 clear_image_cache_count = 0;
14017 }
14018 #endif /* HAVE_WINDOW_SYSTEM */
14019
14020 end_of_redisplay:
14021 if (interrupt_input && interrupts_deferred)
14022 request_sigio ();
14023
14024 unbind_to (count, Qnil);
14025 RESUME_POLLING;
14026 }
14027
14028
14029 /* Redisplay, but leave alone any recent echo area message unless
14030 another message has been requested in its place.
14031
14032 This is useful in situations where you need to redisplay but no
14033 user action has occurred, making it inappropriate for the message
14034 area to be cleared. See tracking_off and
14035 wait_reading_process_output for examples of these situations.
14036
14037 FROM_WHERE is an integer saying from where this function was
14038 called. This is useful for debugging. */
14039
14040 void
14041 redisplay_preserve_echo_area (int from_where)
14042 {
14043 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14044
14045 if (!NILP (echo_area_buffer[1]))
14046 {
14047 /* We have a previously displayed message, but no current
14048 message. Redisplay the previous message. */
14049 display_last_displayed_message_p = 1;
14050 redisplay_internal ();
14051 display_last_displayed_message_p = 0;
14052 }
14053 else
14054 redisplay_internal ();
14055
14056 flush_frame (SELECTED_FRAME ());
14057 }
14058
14059
14060 /* Function registered with record_unwind_protect in redisplay_internal. */
14061
14062 static void
14063 unwind_redisplay (void)
14064 {
14065 redisplaying_p = 0;
14066 }
14067
14068
14069 /* Mark the display of leaf window W as accurate or inaccurate.
14070 If ACCURATE_P is non-zero mark display of W as accurate. If
14071 ACCURATE_P is zero, arrange for W to be redisplayed the next
14072 time redisplay_internal is called. */
14073
14074 static void
14075 mark_window_display_accurate_1 (struct window *w, int accurate_p)
14076 {
14077 struct buffer *b = XBUFFER (w->contents);
14078
14079 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14080 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14081 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14082
14083 if (accurate_p)
14084 {
14085 b->clip_changed = false;
14086 b->prevent_redisplay_optimizations_p = false;
14087 eassert (buffer_window_count (b) > 0);
14088 /* Resetting b->text->redisplay is problematic!
14089 In order to make it safer to do it here, redisplay_internal must
14090 have copied all b->text->redisplay to their respective windows. */
14091 b->text->redisplay = false;
14092
14093 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14094 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14095 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14096 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14097
14098 w->current_matrix->buffer = b;
14099 w->current_matrix->begv = BUF_BEGV (b);
14100 w->current_matrix->zv = BUF_ZV (b);
14101
14102 w->last_cursor_vpos = w->cursor.vpos;
14103 w->last_cursor_off_p = w->cursor_off_p;
14104
14105 if (w == XWINDOW (selected_window))
14106 w->last_point = BUF_PT (b);
14107 else
14108 w->last_point = marker_position (w->pointm);
14109
14110 w->window_end_valid = true;
14111 w->update_mode_line = false;
14112 }
14113
14114 w->redisplay = !accurate_p;
14115 }
14116
14117
14118 /* Mark the display of windows in the window tree rooted at WINDOW as
14119 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14120 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14121 be redisplayed the next time redisplay_internal is called. */
14122
14123 void
14124 mark_window_display_accurate (Lisp_Object window, int accurate_p)
14125 {
14126 struct window *w;
14127
14128 for (; !NILP (window); window = w->next)
14129 {
14130 w = XWINDOW (window);
14131 if (WINDOWP (w->contents))
14132 mark_window_display_accurate (w->contents, accurate_p);
14133 else
14134 mark_window_display_accurate_1 (w, accurate_p);
14135 }
14136
14137 if (accurate_p)
14138 update_overlay_arrows (1);
14139 else
14140 /* Force a thorough redisplay the next time by setting
14141 last_arrow_position and last_arrow_string to t, which is
14142 unequal to any useful value of Voverlay_arrow_... */
14143 update_overlay_arrows (-1);
14144 }
14145
14146
14147 /* Return value in display table DP (Lisp_Char_Table *) for character
14148 C. Since a display table doesn't have any parent, we don't have to
14149 follow parent. Do not call this function directly but use the
14150 macro DISP_CHAR_VECTOR. */
14151
14152 Lisp_Object
14153 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14154 {
14155 Lisp_Object val;
14156
14157 if (ASCII_CHAR_P (c))
14158 {
14159 val = dp->ascii;
14160 if (SUB_CHAR_TABLE_P (val))
14161 val = XSUB_CHAR_TABLE (val)->contents[c];
14162 }
14163 else
14164 {
14165 Lisp_Object table;
14166
14167 XSETCHAR_TABLE (table, dp);
14168 val = char_table_ref (table, c);
14169 }
14170 if (NILP (val))
14171 val = dp->defalt;
14172 return val;
14173 }
14174
14175
14176 \f
14177 /***********************************************************************
14178 Window Redisplay
14179 ***********************************************************************/
14180
14181 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14182
14183 static void
14184 redisplay_windows (Lisp_Object window)
14185 {
14186 while (!NILP (window))
14187 {
14188 struct window *w = XWINDOW (window);
14189
14190 if (WINDOWP (w->contents))
14191 redisplay_windows (w->contents);
14192 else if (BUFFERP (w->contents))
14193 {
14194 displayed_buffer = XBUFFER (w->contents);
14195 /* Use list_of_error, not Qerror, so that
14196 we catch only errors and don't run the debugger. */
14197 internal_condition_case_1 (redisplay_window_0, window,
14198 list_of_error,
14199 redisplay_window_error);
14200 }
14201
14202 window = w->next;
14203 }
14204 }
14205
14206 static Lisp_Object
14207 redisplay_window_error (Lisp_Object ignore)
14208 {
14209 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14210 return Qnil;
14211 }
14212
14213 static Lisp_Object
14214 redisplay_window_0 (Lisp_Object window)
14215 {
14216 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14217 redisplay_window (window, false);
14218 return Qnil;
14219 }
14220
14221 static Lisp_Object
14222 redisplay_window_1 (Lisp_Object window)
14223 {
14224 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14225 redisplay_window (window, true);
14226 return Qnil;
14227 }
14228 \f
14229
14230 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14231 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14232 which positions recorded in ROW differ from current buffer
14233 positions.
14234
14235 Return 0 if cursor is not on this row, 1 otherwise. */
14236
14237 static int
14238 set_cursor_from_row (struct window *w, struct glyph_row *row,
14239 struct glyph_matrix *matrix,
14240 ptrdiff_t delta, ptrdiff_t delta_bytes,
14241 int dy, int dvpos)
14242 {
14243 struct glyph *glyph = row->glyphs[TEXT_AREA];
14244 struct glyph *end = glyph + row->used[TEXT_AREA];
14245 struct glyph *cursor = NULL;
14246 /* The last known character position in row. */
14247 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14248 int x = row->x;
14249 ptrdiff_t pt_old = PT - delta;
14250 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14251 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14252 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14253 /* A glyph beyond the edge of TEXT_AREA which we should never
14254 touch. */
14255 struct glyph *glyphs_end = end;
14256 /* Non-zero means we've found a match for cursor position, but that
14257 glyph has the avoid_cursor_p flag set. */
14258 int match_with_avoid_cursor = 0;
14259 /* Non-zero means we've seen at least one glyph that came from a
14260 display string. */
14261 int string_seen = 0;
14262 /* Largest and smallest buffer positions seen so far during scan of
14263 glyph row. */
14264 ptrdiff_t bpos_max = pos_before;
14265 ptrdiff_t bpos_min = pos_after;
14266 /* Last buffer position covered by an overlay string with an integer
14267 `cursor' property. */
14268 ptrdiff_t bpos_covered = 0;
14269 /* Non-zero means the display string on which to display the cursor
14270 comes from a text property, not from an overlay. */
14271 int string_from_text_prop = 0;
14272
14273 /* Don't even try doing anything if called for a mode-line or
14274 header-line row, since the rest of the code isn't prepared to
14275 deal with such calamities. */
14276 eassert (!row->mode_line_p);
14277 if (row->mode_line_p)
14278 return 0;
14279
14280 /* Skip over glyphs not having an object at the start and the end of
14281 the row. These are special glyphs like truncation marks on
14282 terminal frames. */
14283 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14284 {
14285 if (!row->reversed_p)
14286 {
14287 while (glyph < end
14288 && INTEGERP (glyph->object)
14289 && glyph->charpos < 0)
14290 {
14291 x += glyph->pixel_width;
14292 ++glyph;
14293 }
14294 while (end > glyph
14295 && INTEGERP ((end - 1)->object)
14296 /* CHARPOS is zero for blanks and stretch glyphs
14297 inserted by extend_face_to_end_of_line. */
14298 && (end - 1)->charpos <= 0)
14299 --end;
14300 glyph_before = glyph - 1;
14301 glyph_after = end;
14302 }
14303 else
14304 {
14305 struct glyph *g;
14306
14307 /* If the glyph row is reversed, we need to process it from back
14308 to front, so swap the edge pointers. */
14309 glyphs_end = end = glyph - 1;
14310 glyph += row->used[TEXT_AREA] - 1;
14311
14312 while (glyph > end + 1
14313 && INTEGERP (glyph->object)
14314 && glyph->charpos < 0)
14315 {
14316 --glyph;
14317 x -= glyph->pixel_width;
14318 }
14319 if (INTEGERP (glyph->object) && glyph->charpos < 0)
14320 --glyph;
14321 /* By default, in reversed rows we put the cursor on the
14322 rightmost (first in the reading order) glyph. */
14323 for (g = end + 1; g < glyph; g++)
14324 x += g->pixel_width;
14325 while (end < glyph
14326 && INTEGERP ((end + 1)->object)
14327 && (end + 1)->charpos <= 0)
14328 ++end;
14329 glyph_before = glyph + 1;
14330 glyph_after = end;
14331 }
14332 }
14333 else if (row->reversed_p)
14334 {
14335 /* In R2L rows that don't display text, put the cursor on the
14336 rightmost glyph. Case in point: an empty last line that is
14337 part of an R2L paragraph. */
14338 cursor = end - 1;
14339 /* Avoid placing the cursor on the last glyph of the row, where
14340 on terminal frames we hold the vertical border between
14341 adjacent windows. */
14342 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14343 && !WINDOW_RIGHTMOST_P (w)
14344 && cursor == row->glyphs[LAST_AREA] - 1)
14345 cursor--;
14346 x = -1; /* will be computed below, at label compute_x */
14347 }
14348
14349 /* Step 1: Try to find the glyph whose character position
14350 corresponds to point. If that's not possible, find 2 glyphs
14351 whose character positions are the closest to point, one before
14352 point, the other after it. */
14353 if (!row->reversed_p)
14354 while (/* not marched to end of glyph row */
14355 glyph < end
14356 /* glyph was not inserted by redisplay for internal purposes */
14357 && !INTEGERP (glyph->object))
14358 {
14359 if (BUFFERP (glyph->object))
14360 {
14361 ptrdiff_t dpos = glyph->charpos - pt_old;
14362
14363 if (glyph->charpos > bpos_max)
14364 bpos_max = glyph->charpos;
14365 if (glyph->charpos < bpos_min)
14366 bpos_min = glyph->charpos;
14367 if (!glyph->avoid_cursor_p)
14368 {
14369 /* If we hit point, we've found the glyph on which to
14370 display the cursor. */
14371 if (dpos == 0)
14372 {
14373 match_with_avoid_cursor = 0;
14374 break;
14375 }
14376 /* See if we've found a better approximation to
14377 POS_BEFORE or to POS_AFTER. */
14378 if (0 > dpos && dpos > pos_before - pt_old)
14379 {
14380 pos_before = glyph->charpos;
14381 glyph_before = glyph;
14382 }
14383 else if (0 < dpos && dpos < pos_after - pt_old)
14384 {
14385 pos_after = glyph->charpos;
14386 glyph_after = glyph;
14387 }
14388 }
14389 else if (dpos == 0)
14390 match_with_avoid_cursor = 1;
14391 }
14392 else if (STRINGP (glyph->object))
14393 {
14394 Lisp_Object chprop;
14395 ptrdiff_t glyph_pos = glyph->charpos;
14396
14397 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14398 glyph->object);
14399 if (!NILP (chprop))
14400 {
14401 /* If the string came from a `display' text property,
14402 look up the buffer position of that property and
14403 use that position to update bpos_max, as if we
14404 actually saw such a position in one of the row's
14405 glyphs. This helps with supporting integer values
14406 of `cursor' property on the display string in
14407 situations where most or all of the row's buffer
14408 text is completely covered by display properties,
14409 so that no glyph with valid buffer positions is
14410 ever seen in the row. */
14411 ptrdiff_t prop_pos =
14412 string_buffer_position_lim (glyph->object, pos_before,
14413 pos_after, 0);
14414
14415 if (prop_pos >= pos_before)
14416 bpos_max = prop_pos;
14417 }
14418 if (INTEGERP (chprop))
14419 {
14420 bpos_covered = bpos_max + XINT (chprop);
14421 /* If the `cursor' property covers buffer positions up
14422 to and including point, we should display cursor on
14423 this glyph. Note that, if a `cursor' property on one
14424 of the string's characters has an integer value, we
14425 will break out of the loop below _before_ we get to
14426 the position match above. IOW, integer values of
14427 the `cursor' property override the "exact match for
14428 point" strategy of positioning the cursor. */
14429 /* Implementation note: bpos_max == pt_old when, e.g.,
14430 we are in an empty line, where bpos_max is set to
14431 MATRIX_ROW_START_CHARPOS, see above. */
14432 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14433 {
14434 cursor = glyph;
14435 break;
14436 }
14437 }
14438
14439 string_seen = 1;
14440 }
14441 x += glyph->pixel_width;
14442 ++glyph;
14443 }
14444 else if (glyph > end) /* row is reversed */
14445 while (!INTEGERP (glyph->object))
14446 {
14447 if (BUFFERP (glyph->object))
14448 {
14449 ptrdiff_t dpos = glyph->charpos - pt_old;
14450
14451 if (glyph->charpos > bpos_max)
14452 bpos_max = glyph->charpos;
14453 if (glyph->charpos < bpos_min)
14454 bpos_min = glyph->charpos;
14455 if (!glyph->avoid_cursor_p)
14456 {
14457 if (dpos == 0)
14458 {
14459 match_with_avoid_cursor = 0;
14460 break;
14461 }
14462 if (0 > dpos && dpos > pos_before - pt_old)
14463 {
14464 pos_before = glyph->charpos;
14465 glyph_before = glyph;
14466 }
14467 else if (0 < dpos && dpos < pos_after - pt_old)
14468 {
14469 pos_after = glyph->charpos;
14470 glyph_after = glyph;
14471 }
14472 }
14473 else if (dpos == 0)
14474 match_with_avoid_cursor = 1;
14475 }
14476 else if (STRINGP (glyph->object))
14477 {
14478 Lisp_Object chprop;
14479 ptrdiff_t glyph_pos = glyph->charpos;
14480
14481 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14482 glyph->object);
14483 if (!NILP (chprop))
14484 {
14485 ptrdiff_t prop_pos =
14486 string_buffer_position_lim (glyph->object, pos_before,
14487 pos_after, 0);
14488
14489 if (prop_pos >= pos_before)
14490 bpos_max = prop_pos;
14491 }
14492 if (INTEGERP (chprop))
14493 {
14494 bpos_covered = bpos_max + XINT (chprop);
14495 /* If the `cursor' property covers buffer positions up
14496 to and including point, we should display cursor on
14497 this glyph. */
14498 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14499 {
14500 cursor = glyph;
14501 break;
14502 }
14503 }
14504 string_seen = 1;
14505 }
14506 --glyph;
14507 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14508 {
14509 x--; /* can't use any pixel_width */
14510 break;
14511 }
14512 x -= glyph->pixel_width;
14513 }
14514
14515 /* Step 2: If we didn't find an exact match for point, we need to
14516 look for a proper place to put the cursor among glyphs between
14517 GLYPH_BEFORE and GLYPH_AFTER. */
14518 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14519 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14520 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14521 {
14522 /* An empty line has a single glyph whose OBJECT is zero and
14523 whose CHARPOS is the position of a newline on that line.
14524 Note that on a TTY, there are more glyphs after that, which
14525 were produced by extend_face_to_end_of_line, but their
14526 CHARPOS is zero or negative. */
14527 int empty_line_p =
14528 (row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14529 && INTEGERP (glyph->object) && glyph->charpos > 0
14530 /* On a TTY, continued and truncated rows also have a glyph at
14531 their end whose OBJECT is zero and whose CHARPOS is
14532 positive (the continuation and truncation glyphs), but such
14533 rows are obviously not "empty". */
14534 && !(row->continued_p || row->truncated_on_right_p);
14535
14536 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14537 {
14538 ptrdiff_t ellipsis_pos;
14539
14540 /* Scan back over the ellipsis glyphs. */
14541 if (!row->reversed_p)
14542 {
14543 ellipsis_pos = (glyph - 1)->charpos;
14544 while (glyph > row->glyphs[TEXT_AREA]
14545 && (glyph - 1)->charpos == ellipsis_pos)
14546 glyph--, x -= glyph->pixel_width;
14547 /* That loop always goes one position too far, including
14548 the glyph before the ellipsis. So scan forward over
14549 that one. */
14550 x += glyph->pixel_width;
14551 glyph++;
14552 }
14553 else /* row is reversed */
14554 {
14555 ellipsis_pos = (glyph + 1)->charpos;
14556 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14557 && (glyph + 1)->charpos == ellipsis_pos)
14558 glyph++, x += glyph->pixel_width;
14559 x -= glyph->pixel_width;
14560 glyph--;
14561 }
14562 }
14563 else if (match_with_avoid_cursor)
14564 {
14565 cursor = glyph_after;
14566 x = -1;
14567 }
14568 else if (string_seen)
14569 {
14570 int incr = row->reversed_p ? -1 : +1;
14571
14572 /* Need to find the glyph that came out of a string which is
14573 present at point. That glyph is somewhere between
14574 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14575 positioned between POS_BEFORE and POS_AFTER in the
14576 buffer. */
14577 struct glyph *start, *stop;
14578 ptrdiff_t pos = pos_before;
14579
14580 x = -1;
14581
14582 /* If the row ends in a newline from a display string,
14583 reordering could have moved the glyphs belonging to the
14584 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14585 in this case we extend the search to the last glyph in
14586 the row that was not inserted by redisplay. */
14587 if (row->ends_in_newline_from_string_p)
14588 {
14589 glyph_after = end;
14590 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14591 }
14592
14593 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14594 correspond to POS_BEFORE and POS_AFTER, respectively. We
14595 need START and STOP in the order that corresponds to the
14596 row's direction as given by its reversed_p flag. If the
14597 directionality of characters between POS_BEFORE and
14598 POS_AFTER is the opposite of the row's base direction,
14599 these characters will have been reordered for display,
14600 and we need to reverse START and STOP. */
14601 if (!row->reversed_p)
14602 {
14603 start = min (glyph_before, glyph_after);
14604 stop = max (glyph_before, glyph_after);
14605 }
14606 else
14607 {
14608 start = max (glyph_before, glyph_after);
14609 stop = min (glyph_before, glyph_after);
14610 }
14611 for (glyph = start + incr;
14612 row->reversed_p ? glyph > stop : glyph < stop; )
14613 {
14614
14615 /* Any glyphs that come from the buffer are here because
14616 of bidi reordering. Skip them, and only pay
14617 attention to glyphs that came from some string. */
14618 if (STRINGP (glyph->object))
14619 {
14620 Lisp_Object str;
14621 ptrdiff_t tem;
14622 /* If the display property covers the newline, we
14623 need to search for it one position farther. */
14624 ptrdiff_t lim = pos_after
14625 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14626
14627 string_from_text_prop = 0;
14628 str = glyph->object;
14629 tem = string_buffer_position_lim (str, pos, lim, 0);
14630 if (tem == 0 /* from overlay */
14631 || pos <= tem)
14632 {
14633 /* If the string from which this glyph came is
14634 found in the buffer at point, or at position
14635 that is closer to point than pos_after, then
14636 we've found the glyph we've been looking for.
14637 If it comes from an overlay (tem == 0), and
14638 it has the `cursor' property on one of its
14639 glyphs, record that glyph as a candidate for
14640 displaying the cursor. (As in the
14641 unidirectional version, we will display the
14642 cursor on the last candidate we find.) */
14643 if (tem == 0
14644 || tem == pt_old
14645 || (tem - pt_old > 0 && tem < pos_after))
14646 {
14647 /* The glyphs from this string could have
14648 been reordered. Find the one with the
14649 smallest string position. Or there could
14650 be a character in the string with the
14651 `cursor' property, which means display
14652 cursor on that character's glyph. */
14653 ptrdiff_t strpos = glyph->charpos;
14654
14655 if (tem)
14656 {
14657 cursor = glyph;
14658 string_from_text_prop = 1;
14659 }
14660 for ( ;
14661 (row->reversed_p ? glyph > stop : glyph < stop)
14662 && EQ (glyph->object, str);
14663 glyph += incr)
14664 {
14665 Lisp_Object cprop;
14666 ptrdiff_t gpos = glyph->charpos;
14667
14668 cprop = Fget_char_property (make_number (gpos),
14669 Qcursor,
14670 glyph->object);
14671 if (!NILP (cprop))
14672 {
14673 cursor = glyph;
14674 break;
14675 }
14676 if (tem && glyph->charpos < strpos)
14677 {
14678 strpos = glyph->charpos;
14679 cursor = glyph;
14680 }
14681 }
14682
14683 if (tem == pt_old
14684 || (tem - pt_old > 0 && tem < pos_after))
14685 goto compute_x;
14686 }
14687 if (tem)
14688 pos = tem + 1; /* don't find previous instances */
14689 }
14690 /* This string is not what we want; skip all of the
14691 glyphs that came from it. */
14692 while ((row->reversed_p ? glyph > stop : glyph < stop)
14693 && EQ (glyph->object, str))
14694 glyph += incr;
14695 }
14696 else
14697 glyph += incr;
14698 }
14699
14700 /* If we reached the end of the line, and END was from a string,
14701 the cursor is not on this line. */
14702 if (cursor == NULL
14703 && (row->reversed_p ? glyph <= end : glyph >= end)
14704 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14705 && STRINGP (end->object)
14706 && row->continued_p)
14707 return 0;
14708 }
14709 /* A truncated row may not include PT among its character positions.
14710 Setting the cursor inside the scroll margin will trigger
14711 recalculation of hscroll in hscroll_window_tree. But if a
14712 display string covers point, defer to the string-handling
14713 code below to figure this out. */
14714 else if (row->truncated_on_left_p && pt_old < bpos_min)
14715 {
14716 cursor = glyph_before;
14717 x = -1;
14718 }
14719 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14720 /* Zero-width characters produce no glyphs. */
14721 || (!empty_line_p
14722 && (row->reversed_p
14723 ? glyph_after > glyphs_end
14724 : glyph_after < glyphs_end)))
14725 {
14726 cursor = glyph_after;
14727 x = -1;
14728 }
14729 }
14730
14731 compute_x:
14732 if (cursor != NULL)
14733 glyph = cursor;
14734 else if (glyph == glyphs_end
14735 && pos_before == pos_after
14736 && STRINGP ((row->reversed_p
14737 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14738 : row->glyphs[TEXT_AREA])->object))
14739 {
14740 /* If all the glyphs of this row came from strings, put the
14741 cursor on the first glyph of the row. This avoids having the
14742 cursor outside of the text area in this very rare and hard
14743 use case. */
14744 glyph =
14745 row->reversed_p
14746 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14747 : row->glyphs[TEXT_AREA];
14748 }
14749 if (x < 0)
14750 {
14751 struct glyph *g;
14752
14753 /* Need to compute x that corresponds to GLYPH. */
14754 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14755 {
14756 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14757 emacs_abort ();
14758 x += g->pixel_width;
14759 }
14760 }
14761
14762 /* ROW could be part of a continued line, which, under bidi
14763 reordering, might have other rows whose start and end charpos
14764 occlude point. Only set w->cursor if we found a better
14765 approximation to the cursor position than we have from previously
14766 examined candidate rows belonging to the same continued line. */
14767 if (/* We already have a candidate row. */
14768 w->cursor.vpos >= 0
14769 /* That candidate is not the row we are processing. */
14770 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14771 /* Make sure cursor.vpos specifies a row whose start and end
14772 charpos occlude point, and it is valid candidate for being a
14773 cursor-row. This is because some callers of this function
14774 leave cursor.vpos at the row where the cursor was displayed
14775 during the last redisplay cycle. */
14776 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14777 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14778 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14779 {
14780 struct glyph *g1
14781 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14782
14783 /* Don't consider glyphs that are outside TEXT_AREA. */
14784 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14785 return 0;
14786 /* Keep the candidate whose buffer position is the closest to
14787 point or has the `cursor' property. */
14788 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14789 w->cursor.hpos >= 0
14790 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14791 && ((BUFFERP (g1->object)
14792 && (g1->charpos == pt_old /* An exact match always wins. */
14793 || (BUFFERP (glyph->object)
14794 && eabs (g1->charpos - pt_old)
14795 < eabs (glyph->charpos - pt_old))))
14796 /* Previous candidate is a glyph from a string that has
14797 a non-nil `cursor' property. */
14798 || (STRINGP (g1->object)
14799 && (!NILP (Fget_char_property (make_number (g1->charpos),
14800 Qcursor, g1->object))
14801 /* Previous candidate is from the same display
14802 string as this one, and the display string
14803 came from a text property. */
14804 || (EQ (g1->object, glyph->object)
14805 && string_from_text_prop)
14806 /* this candidate is from newline and its
14807 position is not an exact match */
14808 || (INTEGERP (glyph->object)
14809 && glyph->charpos != pt_old)))))
14810 return 0;
14811 /* If this candidate gives an exact match, use that. */
14812 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14813 /* If this candidate is a glyph created for the
14814 terminating newline of a line, and point is on that
14815 newline, it wins because it's an exact match. */
14816 || (!row->continued_p
14817 && INTEGERP (glyph->object)
14818 && glyph->charpos == 0
14819 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14820 /* Otherwise, keep the candidate that comes from a row
14821 spanning less buffer positions. This may win when one or
14822 both candidate positions are on glyphs that came from
14823 display strings, for which we cannot compare buffer
14824 positions. */
14825 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14826 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14827 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14828 return 0;
14829 }
14830 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14831 w->cursor.x = x;
14832 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14833 w->cursor.y = row->y + dy;
14834
14835 if (w == XWINDOW (selected_window))
14836 {
14837 if (!row->continued_p
14838 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14839 && row->x == 0)
14840 {
14841 this_line_buffer = XBUFFER (w->contents);
14842
14843 CHARPOS (this_line_start_pos)
14844 = MATRIX_ROW_START_CHARPOS (row) + delta;
14845 BYTEPOS (this_line_start_pos)
14846 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14847
14848 CHARPOS (this_line_end_pos)
14849 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14850 BYTEPOS (this_line_end_pos)
14851 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14852
14853 this_line_y = w->cursor.y;
14854 this_line_pixel_height = row->height;
14855 this_line_vpos = w->cursor.vpos;
14856 this_line_start_x = row->x;
14857 }
14858 else
14859 CHARPOS (this_line_start_pos) = 0;
14860 }
14861
14862 return 1;
14863 }
14864
14865
14866 /* Run window scroll functions, if any, for WINDOW with new window
14867 start STARTP. Sets the window start of WINDOW to that position.
14868
14869 We assume that the window's buffer is really current. */
14870
14871 static struct text_pos
14872 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
14873 {
14874 struct window *w = XWINDOW (window);
14875 SET_MARKER_FROM_TEXT_POS (w->start, startp);
14876
14877 eassert (current_buffer == XBUFFER (w->contents));
14878
14879 if (!NILP (Vwindow_scroll_functions))
14880 {
14881 run_hook_with_args_2 (Qwindow_scroll_functions, window,
14882 make_number (CHARPOS (startp)));
14883 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14884 /* In case the hook functions switch buffers. */
14885 set_buffer_internal (XBUFFER (w->contents));
14886 }
14887
14888 return startp;
14889 }
14890
14891
14892 /* Make sure the line containing the cursor is fully visible.
14893 A value of 1 means there is nothing to be done.
14894 (Either the line is fully visible, or it cannot be made so,
14895 or we cannot tell.)
14896
14897 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14898 is higher than window.
14899
14900 A value of 0 means the caller should do scrolling
14901 as if point had gone off the screen. */
14902
14903 static int
14904 cursor_row_fully_visible_p (struct window *w, int force_p, int current_matrix_p)
14905 {
14906 struct glyph_matrix *matrix;
14907 struct glyph_row *row;
14908 int window_height;
14909
14910 if (!make_cursor_line_fully_visible_p)
14911 return 1;
14912
14913 /* It's not always possible to find the cursor, e.g, when a window
14914 is full of overlay strings. Don't do anything in that case. */
14915 if (w->cursor.vpos < 0)
14916 return 1;
14917
14918 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
14919 row = MATRIX_ROW (matrix, w->cursor.vpos);
14920
14921 /* If the cursor row is not partially visible, there's nothing to do. */
14922 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
14923 return 1;
14924
14925 /* If the row the cursor is in is taller than the window's height,
14926 it's not clear what to do, so do nothing. */
14927 window_height = window_box_height (w);
14928 if (row->height >= window_height)
14929 {
14930 if (!force_p || MINI_WINDOW_P (w)
14931 || w->vscroll || w->cursor.vpos == 0)
14932 return 1;
14933 }
14934 return 0;
14935 }
14936
14937
14938 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14939 non-zero means only WINDOW is redisplayed in redisplay_internal.
14940 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14941 in redisplay_window to bring a partially visible line into view in
14942 the case that only the cursor has moved.
14943
14944 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14945 last screen line's vertical height extends past the end of the screen.
14946
14947 Value is
14948
14949 1 if scrolling succeeded
14950
14951 0 if scrolling didn't find point.
14952
14953 -1 if new fonts have been loaded so that we must interrupt
14954 redisplay, adjust glyph matrices, and try again. */
14955
14956 enum
14957 {
14958 SCROLLING_SUCCESS,
14959 SCROLLING_FAILED,
14960 SCROLLING_NEED_LARGER_MATRICES
14961 };
14962
14963 /* If scroll-conservatively is more than this, never recenter.
14964
14965 If you change this, don't forget to update the doc string of
14966 `scroll-conservatively' and the Emacs manual. */
14967 #define SCROLL_LIMIT 100
14968
14969 static int
14970 try_scrolling (Lisp_Object window, int just_this_one_p,
14971 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
14972 int temp_scroll_step, int last_line_misfit)
14973 {
14974 struct window *w = XWINDOW (window);
14975 struct frame *f = XFRAME (w->frame);
14976 struct text_pos pos, startp;
14977 struct it it;
14978 int this_scroll_margin, scroll_max, rc, height;
14979 int dy = 0, amount_to_scroll = 0, scroll_down_p = 0;
14980 int extra_scroll_margin_lines = last_line_misfit ? 1 : 0;
14981 Lisp_Object aggressive;
14982 /* We will never try scrolling more than this number of lines. */
14983 int scroll_limit = SCROLL_LIMIT;
14984 int frame_line_height = default_line_pixel_height (w);
14985 int window_total_lines
14986 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
14987
14988 #ifdef GLYPH_DEBUG
14989 debug_method_add (w, "try_scrolling");
14990 #endif
14991
14992 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14993
14994 /* Compute scroll margin height in pixels. We scroll when point is
14995 within this distance from the top or bottom of the window. */
14996 if (scroll_margin > 0)
14997 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
14998 * frame_line_height;
14999 else
15000 this_scroll_margin = 0;
15001
15002 /* Force arg_scroll_conservatively to have a reasonable value, to
15003 avoid scrolling too far away with slow move_it_* functions. Note
15004 that the user can supply scroll-conservatively equal to
15005 `most-positive-fixnum', which can be larger than INT_MAX. */
15006 if (arg_scroll_conservatively > scroll_limit)
15007 {
15008 arg_scroll_conservatively = scroll_limit + 1;
15009 scroll_max = scroll_limit * frame_line_height;
15010 }
15011 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15012 /* Compute how much we should try to scroll maximally to bring
15013 point into view. */
15014 scroll_max = (max (scroll_step,
15015 max (arg_scroll_conservatively, temp_scroll_step))
15016 * frame_line_height);
15017 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15018 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15019 /* We're trying to scroll because of aggressive scrolling but no
15020 scroll_step is set. Choose an arbitrary one. */
15021 scroll_max = 10 * frame_line_height;
15022 else
15023 scroll_max = 0;
15024
15025 too_near_end:
15026
15027 /* Decide whether to scroll down. */
15028 if (PT > CHARPOS (startp))
15029 {
15030 int scroll_margin_y;
15031
15032 /* Compute the pixel ypos of the scroll margin, then move IT to
15033 either that ypos or PT, whichever comes first. */
15034 start_display (&it, w, startp);
15035 scroll_margin_y = it.last_visible_y - this_scroll_margin
15036 - frame_line_height * extra_scroll_margin_lines;
15037 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15038 (MOVE_TO_POS | MOVE_TO_Y));
15039
15040 if (PT > CHARPOS (it.current.pos))
15041 {
15042 int y0 = line_bottom_y (&it);
15043 /* Compute how many pixels below window bottom to stop searching
15044 for PT. This avoids costly search for PT that is far away if
15045 the user limited scrolling by a small number of lines, but
15046 always finds PT if scroll_conservatively is set to a large
15047 number, such as most-positive-fixnum. */
15048 int slack = max (scroll_max, 10 * frame_line_height);
15049 int y_to_move = it.last_visible_y + slack;
15050
15051 /* Compute the distance from the scroll margin to PT or to
15052 the scroll limit, whichever comes first. This should
15053 include the height of the cursor line, to make that line
15054 fully visible. */
15055 move_it_to (&it, PT, -1, y_to_move,
15056 -1, MOVE_TO_POS | MOVE_TO_Y);
15057 dy = line_bottom_y (&it) - y0;
15058
15059 if (dy > scroll_max)
15060 return SCROLLING_FAILED;
15061
15062 if (dy > 0)
15063 scroll_down_p = 1;
15064 }
15065 }
15066
15067 if (scroll_down_p)
15068 {
15069 /* Point is in or below the bottom scroll margin, so move the
15070 window start down. If scrolling conservatively, move it just
15071 enough down to make point visible. If scroll_step is set,
15072 move it down by scroll_step. */
15073 if (arg_scroll_conservatively)
15074 amount_to_scroll
15075 = min (max (dy, frame_line_height),
15076 frame_line_height * arg_scroll_conservatively);
15077 else if (scroll_step || temp_scroll_step)
15078 amount_to_scroll = scroll_max;
15079 else
15080 {
15081 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15082 height = WINDOW_BOX_TEXT_HEIGHT (w);
15083 if (NUMBERP (aggressive))
15084 {
15085 double float_amount = XFLOATINT (aggressive) * height;
15086 int aggressive_scroll = float_amount;
15087 if (aggressive_scroll == 0 && float_amount > 0)
15088 aggressive_scroll = 1;
15089 /* Don't let point enter the scroll margin near top of
15090 the window. This could happen if the value of
15091 scroll_up_aggressively is too large and there are
15092 non-zero margins, because scroll_up_aggressively
15093 means put point that fraction of window height
15094 _from_the_bottom_margin_. */
15095 if (aggressive_scroll + 2*this_scroll_margin > height)
15096 aggressive_scroll = height - 2*this_scroll_margin;
15097 amount_to_scroll = dy + aggressive_scroll;
15098 }
15099 }
15100
15101 if (amount_to_scroll <= 0)
15102 return SCROLLING_FAILED;
15103
15104 start_display (&it, w, startp);
15105 if (arg_scroll_conservatively <= scroll_limit)
15106 move_it_vertically (&it, amount_to_scroll);
15107 else
15108 {
15109 /* Extra precision for users who set scroll-conservatively
15110 to a large number: make sure the amount we scroll
15111 the window start is never less than amount_to_scroll,
15112 which was computed as distance from window bottom to
15113 point. This matters when lines at window top and lines
15114 below window bottom have different height. */
15115 struct it it1;
15116 void *it1data = NULL;
15117 /* We use a temporary it1 because line_bottom_y can modify
15118 its argument, if it moves one line down; see there. */
15119 int start_y;
15120
15121 SAVE_IT (it1, it, it1data);
15122 start_y = line_bottom_y (&it1);
15123 do {
15124 RESTORE_IT (&it, &it, it1data);
15125 move_it_by_lines (&it, 1);
15126 SAVE_IT (it1, it, it1data);
15127 } while (line_bottom_y (&it1) - start_y < amount_to_scroll);
15128 }
15129
15130 /* If STARTP is unchanged, move it down another screen line. */
15131 if (CHARPOS (it.current.pos) == CHARPOS (startp))
15132 move_it_by_lines (&it, 1);
15133 startp = it.current.pos;
15134 }
15135 else
15136 {
15137 struct text_pos scroll_margin_pos = startp;
15138 int y_offset = 0;
15139
15140 /* See if point is inside the scroll margin at the top of the
15141 window. */
15142 if (this_scroll_margin)
15143 {
15144 int y_start;
15145
15146 start_display (&it, w, startp);
15147 y_start = it.current_y;
15148 move_it_vertically (&it, this_scroll_margin);
15149 scroll_margin_pos = it.current.pos;
15150 /* If we didn't move enough before hitting ZV, request
15151 additional amount of scroll, to move point out of the
15152 scroll margin. */
15153 if (IT_CHARPOS (it) == ZV
15154 && it.current_y - y_start < this_scroll_margin)
15155 y_offset = this_scroll_margin - (it.current_y - y_start);
15156 }
15157
15158 if (PT < CHARPOS (scroll_margin_pos))
15159 {
15160 /* Point is in the scroll margin at the top of the window or
15161 above what is displayed in the window. */
15162 int y0, y_to_move;
15163
15164 /* Compute the vertical distance from PT to the scroll
15165 margin position. Move as far as scroll_max allows, or
15166 one screenful, or 10 screen lines, whichever is largest.
15167 Give up if distance is greater than scroll_max or if we
15168 didn't reach the scroll margin position. */
15169 SET_TEXT_POS (pos, PT, PT_BYTE);
15170 start_display (&it, w, pos);
15171 y0 = it.current_y;
15172 y_to_move = max (it.last_visible_y,
15173 max (scroll_max, 10 * frame_line_height));
15174 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15175 y_to_move, -1,
15176 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15177 dy = it.current_y - y0;
15178 if (dy > scroll_max
15179 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15180 return SCROLLING_FAILED;
15181
15182 /* Additional scroll for when ZV was too close to point. */
15183 dy += y_offset;
15184
15185 /* Compute new window start. */
15186 start_display (&it, w, startp);
15187
15188 if (arg_scroll_conservatively)
15189 amount_to_scroll = max (dy, frame_line_height *
15190 max (scroll_step, temp_scroll_step));
15191 else if (scroll_step || temp_scroll_step)
15192 amount_to_scroll = scroll_max;
15193 else
15194 {
15195 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15196 height = WINDOW_BOX_TEXT_HEIGHT (w);
15197 if (NUMBERP (aggressive))
15198 {
15199 double float_amount = XFLOATINT (aggressive) * height;
15200 int aggressive_scroll = float_amount;
15201 if (aggressive_scroll == 0 && float_amount > 0)
15202 aggressive_scroll = 1;
15203 /* Don't let point enter the scroll margin near
15204 bottom of the window, if the value of
15205 scroll_down_aggressively happens to be too
15206 large. */
15207 if (aggressive_scroll + 2*this_scroll_margin > height)
15208 aggressive_scroll = height - 2*this_scroll_margin;
15209 amount_to_scroll = dy + aggressive_scroll;
15210 }
15211 }
15212
15213 if (amount_to_scroll <= 0)
15214 return SCROLLING_FAILED;
15215
15216 move_it_vertically_backward (&it, amount_to_scroll);
15217 startp = it.current.pos;
15218 }
15219 }
15220
15221 /* Run window scroll functions. */
15222 startp = run_window_scroll_functions (window, startp);
15223
15224 /* Display the window. Give up if new fonts are loaded, or if point
15225 doesn't appear. */
15226 if (!try_window (window, startp, 0))
15227 rc = SCROLLING_NEED_LARGER_MATRICES;
15228 else if (w->cursor.vpos < 0)
15229 {
15230 clear_glyph_matrix (w->desired_matrix);
15231 rc = SCROLLING_FAILED;
15232 }
15233 else
15234 {
15235 /* Maybe forget recorded base line for line number display. */
15236 if (!just_this_one_p
15237 || current_buffer->clip_changed
15238 || BEG_UNCHANGED < CHARPOS (startp))
15239 w->base_line_number = 0;
15240
15241 /* If cursor ends up on a partially visible line,
15242 treat that as being off the bottom of the screen. */
15243 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1, 0)
15244 /* It's possible that the cursor is on the first line of the
15245 buffer, which is partially obscured due to a vscroll
15246 (Bug#7537). In that case, avoid looping forever. */
15247 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15248 {
15249 clear_glyph_matrix (w->desired_matrix);
15250 ++extra_scroll_margin_lines;
15251 goto too_near_end;
15252 }
15253 rc = SCROLLING_SUCCESS;
15254 }
15255
15256 return rc;
15257 }
15258
15259
15260 /* Compute a suitable window start for window W if display of W starts
15261 on a continuation line. Value is non-zero if a new window start
15262 was computed.
15263
15264 The new window start will be computed, based on W's width, starting
15265 from the start of the continued line. It is the start of the
15266 screen line with the minimum distance from the old start W->start. */
15267
15268 static int
15269 compute_window_start_on_continuation_line (struct window *w)
15270 {
15271 struct text_pos pos, start_pos;
15272 int window_start_changed_p = 0;
15273
15274 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15275
15276 /* If window start is on a continuation line... Window start may be
15277 < BEGV in case there's invisible text at the start of the
15278 buffer (M-x rmail, for example). */
15279 if (CHARPOS (start_pos) > BEGV
15280 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15281 {
15282 struct it it;
15283 struct glyph_row *row;
15284
15285 /* Handle the case that the window start is out of range. */
15286 if (CHARPOS (start_pos) < BEGV)
15287 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15288 else if (CHARPOS (start_pos) > ZV)
15289 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15290
15291 /* Find the start of the continued line. This should be fast
15292 because find_newline is fast (newline cache). */
15293 row = w->desired_matrix->rows + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0);
15294 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15295 row, DEFAULT_FACE_ID);
15296 reseat_at_previous_visible_line_start (&it);
15297
15298 /* If the line start is "too far" away from the window start,
15299 say it takes too much time to compute a new window start. */
15300 if (CHARPOS (start_pos) - IT_CHARPOS (it)
15301 /* PXW: Do we need upper bounds here? */
15302 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
15303 {
15304 int min_distance, distance;
15305
15306 /* Move forward by display lines to find the new window
15307 start. If window width was enlarged, the new start can
15308 be expected to be > the old start. If window width was
15309 decreased, the new window start will be < the old start.
15310 So, we're looking for the display line start with the
15311 minimum distance from the old window start. */
15312 pos = it.current.pos;
15313 min_distance = INFINITY;
15314 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15315 distance < min_distance)
15316 {
15317 min_distance = distance;
15318 pos = it.current.pos;
15319 if (it.line_wrap == WORD_WRAP)
15320 {
15321 /* Under WORD_WRAP, move_it_by_lines is likely to
15322 overshoot and stop not at the first, but the
15323 second character from the left margin. So in
15324 that case, we need a more tight control on the X
15325 coordinate of the iterator than move_it_by_lines
15326 promises in its contract. The method is to first
15327 go to the last (rightmost) visible character of a
15328 line, then move to the leftmost character on the
15329 next line in a separate call. */
15330 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15331 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15332 move_it_to (&it, ZV, 0,
15333 it.current_y + it.max_ascent + it.max_descent, -1,
15334 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15335 }
15336 else
15337 move_it_by_lines (&it, 1);
15338 }
15339
15340 /* Set the window start there. */
15341 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15342 window_start_changed_p = 1;
15343 }
15344 }
15345
15346 return window_start_changed_p;
15347 }
15348
15349
15350 /* Try cursor movement in case text has not changed in window WINDOW,
15351 with window start STARTP. Value is
15352
15353 CURSOR_MOVEMENT_SUCCESS if successful
15354
15355 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15356
15357 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15358 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15359 we want to scroll as if scroll-step were set to 1. See the code.
15360
15361 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15362 which case we have to abort this redisplay, and adjust matrices
15363 first. */
15364
15365 enum
15366 {
15367 CURSOR_MOVEMENT_SUCCESS,
15368 CURSOR_MOVEMENT_CANNOT_BE_USED,
15369 CURSOR_MOVEMENT_MUST_SCROLL,
15370 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15371 };
15372
15373 static int
15374 try_cursor_movement (Lisp_Object window, struct text_pos startp, int *scroll_step)
15375 {
15376 struct window *w = XWINDOW (window);
15377 struct frame *f = XFRAME (w->frame);
15378 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15379
15380 #ifdef GLYPH_DEBUG
15381 if (inhibit_try_cursor_movement)
15382 return rc;
15383 #endif
15384
15385 /* Previously, there was a check for Lisp integer in the
15386 if-statement below. Now, this field is converted to
15387 ptrdiff_t, thus zero means invalid position in a buffer. */
15388 eassert (w->last_point > 0);
15389 /* Likewise there was a check whether window_end_vpos is nil or larger
15390 than the window. Now window_end_vpos is int and so never nil, but
15391 let's leave eassert to check whether it fits in the window. */
15392 eassert (w->window_end_vpos < w->current_matrix->nrows);
15393
15394 /* Handle case where text has not changed, only point, and it has
15395 not moved off the frame. */
15396 if (/* Point may be in this window. */
15397 PT >= CHARPOS (startp)
15398 /* Selective display hasn't changed. */
15399 && !current_buffer->clip_changed
15400 /* Function force-mode-line-update is used to force a thorough
15401 redisplay. It sets either windows_or_buffers_changed or
15402 update_mode_lines. So don't take a shortcut here for these
15403 cases. */
15404 && !update_mode_lines
15405 && !windows_or_buffers_changed
15406 && !f->cursor_type_changed
15407 && NILP (Vshow_trailing_whitespace)
15408 /* This code is not used for mini-buffer for the sake of the case
15409 of redisplaying to replace an echo area message; since in
15410 that case the mini-buffer contents per se are usually
15411 unchanged. This code is of no real use in the mini-buffer
15412 since the handling of this_line_start_pos, etc., in redisplay
15413 handles the same cases. */
15414 && !EQ (window, minibuf_window)
15415 && (FRAME_WINDOW_P (f)
15416 || !overlay_arrow_in_current_buffer_p ()))
15417 {
15418 int this_scroll_margin, top_scroll_margin;
15419 struct glyph_row *row = NULL;
15420 int frame_line_height = default_line_pixel_height (w);
15421 int window_total_lines
15422 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15423
15424 #ifdef GLYPH_DEBUG
15425 debug_method_add (w, "cursor movement");
15426 #endif
15427
15428 /* Scroll if point within this distance from the top or bottom
15429 of the window. This is a pixel value. */
15430 if (scroll_margin > 0)
15431 {
15432 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15433 this_scroll_margin *= frame_line_height;
15434 }
15435 else
15436 this_scroll_margin = 0;
15437
15438 top_scroll_margin = this_scroll_margin;
15439 if (WINDOW_WANTS_HEADER_LINE_P (w))
15440 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15441
15442 /* Start with the row the cursor was displayed during the last
15443 not paused redisplay. Give up if that row is not valid. */
15444 if (w->last_cursor_vpos < 0
15445 || w->last_cursor_vpos >= w->current_matrix->nrows)
15446 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15447 else
15448 {
15449 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15450 if (row->mode_line_p)
15451 ++row;
15452 if (!row->enabled_p)
15453 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15454 }
15455
15456 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15457 {
15458 int scroll_p = 0, must_scroll = 0;
15459 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15460
15461 if (PT > w->last_point)
15462 {
15463 /* Point has moved forward. */
15464 while (MATRIX_ROW_END_CHARPOS (row) < PT
15465 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15466 {
15467 eassert (row->enabled_p);
15468 ++row;
15469 }
15470
15471 /* If the end position of a row equals the start
15472 position of the next row, and PT is at that position,
15473 we would rather display cursor in the next line. */
15474 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15475 && MATRIX_ROW_END_CHARPOS (row) == PT
15476 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15477 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15478 && !cursor_row_p (row))
15479 ++row;
15480
15481 /* If within the scroll margin, scroll. Note that
15482 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15483 the next line would be drawn, and that
15484 this_scroll_margin can be zero. */
15485 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15486 || PT > MATRIX_ROW_END_CHARPOS (row)
15487 /* Line is completely visible last line in window
15488 and PT is to be set in the next line. */
15489 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15490 && PT == MATRIX_ROW_END_CHARPOS (row)
15491 && !row->ends_at_zv_p
15492 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15493 scroll_p = 1;
15494 }
15495 else if (PT < w->last_point)
15496 {
15497 /* Cursor has to be moved backward. Note that PT >=
15498 CHARPOS (startp) because of the outer if-statement. */
15499 while (!row->mode_line_p
15500 && (MATRIX_ROW_START_CHARPOS (row) > PT
15501 || (MATRIX_ROW_START_CHARPOS (row) == PT
15502 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15503 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15504 row > w->current_matrix->rows
15505 && (row-1)->ends_in_newline_from_string_p))))
15506 && (row->y > top_scroll_margin
15507 || CHARPOS (startp) == BEGV))
15508 {
15509 eassert (row->enabled_p);
15510 --row;
15511 }
15512
15513 /* Consider the following case: Window starts at BEGV,
15514 there is invisible, intangible text at BEGV, so that
15515 display starts at some point START > BEGV. It can
15516 happen that we are called with PT somewhere between
15517 BEGV and START. Try to handle that case. */
15518 if (row < w->current_matrix->rows
15519 || row->mode_line_p)
15520 {
15521 row = w->current_matrix->rows;
15522 if (row->mode_line_p)
15523 ++row;
15524 }
15525
15526 /* Due to newlines in overlay strings, we may have to
15527 skip forward over overlay strings. */
15528 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15529 && MATRIX_ROW_END_CHARPOS (row) == PT
15530 && !cursor_row_p (row))
15531 ++row;
15532
15533 /* If within the scroll margin, scroll. */
15534 if (row->y < top_scroll_margin
15535 && CHARPOS (startp) != BEGV)
15536 scroll_p = 1;
15537 }
15538 else
15539 {
15540 /* Cursor did not move. So don't scroll even if cursor line
15541 is partially visible, as it was so before. */
15542 rc = CURSOR_MOVEMENT_SUCCESS;
15543 }
15544
15545 if (PT < MATRIX_ROW_START_CHARPOS (row)
15546 || PT > MATRIX_ROW_END_CHARPOS (row))
15547 {
15548 /* if PT is not in the glyph row, give up. */
15549 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15550 must_scroll = 1;
15551 }
15552 else if (rc != CURSOR_MOVEMENT_SUCCESS
15553 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15554 {
15555 struct glyph_row *row1;
15556
15557 /* If rows are bidi-reordered and point moved, back up
15558 until we find a row that does not belong to a
15559 continuation line. This is because we must consider
15560 all rows of a continued line as candidates for the
15561 new cursor positioning, since row start and end
15562 positions change non-linearly with vertical position
15563 in such rows. */
15564 /* FIXME: Revisit this when glyph ``spilling'' in
15565 continuation lines' rows is implemented for
15566 bidi-reordered rows. */
15567 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15568 MATRIX_ROW_CONTINUATION_LINE_P (row);
15569 --row)
15570 {
15571 /* If we hit the beginning of the displayed portion
15572 without finding the first row of a continued
15573 line, give up. */
15574 if (row <= row1)
15575 {
15576 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15577 break;
15578 }
15579 eassert (row->enabled_p);
15580 }
15581 }
15582 if (must_scroll)
15583 ;
15584 else if (rc != CURSOR_MOVEMENT_SUCCESS
15585 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15586 /* Make sure this isn't a header line by any chance, since
15587 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15588 && !row->mode_line_p
15589 && make_cursor_line_fully_visible_p)
15590 {
15591 if (PT == MATRIX_ROW_END_CHARPOS (row)
15592 && !row->ends_at_zv_p
15593 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15594 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15595 else if (row->height > window_box_height (w))
15596 {
15597 /* If we end up in a partially visible line, let's
15598 make it fully visible, except when it's taller
15599 than the window, in which case we can't do much
15600 about it. */
15601 *scroll_step = 1;
15602 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15603 }
15604 else
15605 {
15606 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15607 if (!cursor_row_fully_visible_p (w, 0, 1))
15608 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15609 else
15610 rc = CURSOR_MOVEMENT_SUCCESS;
15611 }
15612 }
15613 else if (scroll_p)
15614 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15615 else if (rc != CURSOR_MOVEMENT_SUCCESS
15616 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15617 {
15618 /* With bidi-reordered rows, there could be more than
15619 one candidate row whose start and end positions
15620 occlude point. We need to let set_cursor_from_row
15621 find the best candidate. */
15622 /* FIXME: Revisit this when glyph ``spilling'' in
15623 continuation lines' rows is implemented for
15624 bidi-reordered rows. */
15625 int rv = 0;
15626
15627 do
15628 {
15629 int at_zv_p = 0, exact_match_p = 0;
15630
15631 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15632 && PT <= MATRIX_ROW_END_CHARPOS (row)
15633 && cursor_row_p (row))
15634 rv |= set_cursor_from_row (w, row, w->current_matrix,
15635 0, 0, 0, 0);
15636 /* As soon as we've found the exact match for point,
15637 or the first suitable row whose ends_at_zv_p flag
15638 is set, we are done. */
15639 if (rv)
15640 {
15641 at_zv_p = MATRIX_ROW (w->current_matrix,
15642 w->cursor.vpos)->ends_at_zv_p;
15643 if (!at_zv_p
15644 && w->cursor.hpos >= 0
15645 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15646 w->cursor.vpos))
15647 {
15648 struct glyph_row *candidate =
15649 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15650 struct glyph *g =
15651 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15652 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15653
15654 exact_match_p =
15655 (BUFFERP (g->object) && g->charpos == PT)
15656 || (INTEGERP (g->object)
15657 && (g->charpos == PT
15658 || (g->charpos == 0 && endpos - 1 == PT)));
15659 }
15660 if (at_zv_p || exact_match_p)
15661 {
15662 rc = CURSOR_MOVEMENT_SUCCESS;
15663 break;
15664 }
15665 }
15666 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15667 break;
15668 ++row;
15669 }
15670 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15671 || row->continued_p)
15672 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15673 || (MATRIX_ROW_START_CHARPOS (row) == PT
15674 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15675 /* If we didn't find any candidate rows, or exited the
15676 loop before all the candidates were examined, signal
15677 to the caller that this method failed. */
15678 if (rc != CURSOR_MOVEMENT_SUCCESS
15679 && !(rv
15680 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15681 && !row->continued_p))
15682 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15683 else if (rv)
15684 rc = CURSOR_MOVEMENT_SUCCESS;
15685 }
15686 else
15687 {
15688 do
15689 {
15690 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15691 {
15692 rc = CURSOR_MOVEMENT_SUCCESS;
15693 break;
15694 }
15695 ++row;
15696 }
15697 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15698 && MATRIX_ROW_START_CHARPOS (row) == PT
15699 && cursor_row_p (row));
15700 }
15701 }
15702 }
15703
15704 return rc;
15705 }
15706
15707 void
15708 set_vertical_scroll_bar (struct window *w)
15709 {
15710 ptrdiff_t start, end, whole;
15711
15712 /* Calculate the start and end positions for the current window.
15713 At some point, it would be nice to choose between scrollbars
15714 which reflect the whole buffer size, with special markers
15715 indicating narrowing, and scrollbars which reflect only the
15716 visible region.
15717
15718 Note that mini-buffers sometimes aren't displaying any text. */
15719 if (!MINI_WINDOW_P (w)
15720 || (w == XWINDOW (minibuf_window)
15721 && NILP (echo_area_buffer[0])))
15722 {
15723 struct buffer *buf = XBUFFER (w->contents);
15724 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15725 start = marker_position (w->start) - BUF_BEGV (buf);
15726 /* I don't think this is guaranteed to be right. For the
15727 moment, we'll pretend it is. */
15728 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15729
15730 if (end < start)
15731 end = start;
15732 if (whole < (end - start))
15733 whole = end - start;
15734 }
15735 else
15736 start = end = whole = 0;
15737
15738 /* Indicate what this scroll bar ought to be displaying now. */
15739 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15740 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15741 (w, end - start, whole, start);
15742 }
15743
15744
15745 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15746 selected_window is redisplayed.
15747
15748 We can return without actually redisplaying the window if fonts has been
15749 changed on window's frame. In that case, redisplay_internal will retry. */
15750
15751 static void
15752 redisplay_window (Lisp_Object window, bool just_this_one_p)
15753 {
15754 struct window *w = XWINDOW (window);
15755 struct frame *f = XFRAME (w->frame);
15756 struct buffer *buffer = XBUFFER (w->contents);
15757 struct buffer *old = current_buffer;
15758 struct text_pos lpoint, opoint, startp;
15759 int update_mode_line;
15760 int tem;
15761 struct it it;
15762 /* Record it now because it's overwritten. */
15763 bool current_matrix_up_to_date_p = false;
15764 bool used_current_matrix_p = false;
15765 /* This is less strict than current_matrix_up_to_date_p.
15766 It indicates that the buffer contents and narrowing are unchanged. */
15767 bool buffer_unchanged_p = false;
15768 int temp_scroll_step = 0;
15769 ptrdiff_t count = SPECPDL_INDEX ();
15770 int rc;
15771 int centering_position = -1;
15772 int last_line_misfit = 0;
15773 ptrdiff_t beg_unchanged, end_unchanged;
15774 int frame_line_height;
15775
15776 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15777 opoint = lpoint;
15778
15779 #ifdef GLYPH_DEBUG
15780 *w->desired_matrix->method = 0;
15781 #endif
15782
15783 if (!just_this_one_p
15784 && REDISPLAY_SOME_P ()
15785 && !w->redisplay
15786 && !f->redisplay
15787 && !buffer->text->redisplay
15788 && BUF_PT (buffer) == w->last_point)
15789 return;
15790
15791 /* Make sure that both W's markers are valid. */
15792 eassert (XMARKER (w->start)->buffer == buffer);
15793 eassert (XMARKER (w->pointm)->buffer == buffer);
15794
15795 restart:
15796 reconsider_clip_changes (w);
15797 frame_line_height = default_line_pixel_height (w);
15798
15799 /* Has the mode line to be updated? */
15800 update_mode_line = (w->update_mode_line
15801 || update_mode_lines
15802 || buffer->clip_changed
15803 || buffer->prevent_redisplay_optimizations_p);
15804
15805 if (!just_this_one_p)
15806 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15807 cleverly elsewhere. */
15808 w->must_be_updated_p = true;
15809
15810 if (MINI_WINDOW_P (w))
15811 {
15812 if (w == XWINDOW (echo_area_window)
15813 && !NILP (echo_area_buffer[0]))
15814 {
15815 if (update_mode_line)
15816 /* We may have to update a tty frame's menu bar or a
15817 tool-bar. Example `M-x C-h C-h C-g'. */
15818 goto finish_menu_bars;
15819 else
15820 /* We've already displayed the echo area glyphs in this window. */
15821 goto finish_scroll_bars;
15822 }
15823 else if ((w != XWINDOW (minibuf_window)
15824 || minibuf_level == 0)
15825 /* When buffer is nonempty, redisplay window normally. */
15826 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
15827 /* Quail displays non-mini buffers in minibuffer window.
15828 In that case, redisplay the window normally. */
15829 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
15830 {
15831 /* W is a mini-buffer window, but it's not active, so clear
15832 it. */
15833 int yb = window_text_bottom_y (w);
15834 struct glyph_row *row;
15835 int y;
15836
15837 for (y = 0, row = w->desired_matrix->rows;
15838 y < yb;
15839 y += row->height, ++row)
15840 blank_row (w, row, y);
15841 goto finish_scroll_bars;
15842 }
15843
15844 clear_glyph_matrix (w->desired_matrix);
15845 }
15846
15847 /* Otherwise set up data on this window; select its buffer and point
15848 value. */
15849 /* Really select the buffer, for the sake of buffer-local
15850 variables. */
15851 set_buffer_internal_1 (XBUFFER (w->contents));
15852
15853 current_matrix_up_to_date_p
15854 = (w->window_end_valid
15855 && !current_buffer->clip_changed
15856 && !current_buffer->prevent_redisplay_optimizations_p
15857 && !window_outdated (w));
15858
15859 /* Run the window-bottom-change-functions
15860 if it is possible that the text on the screen has changed
15861 (either due to modification of the text, or any other reason). */
15862 if (!current_matrix_up_to_date_p
15863 && !NILP (Vwindow_text_change_functions))
15864 {
15865 safe_run_hooks (Qwindow_text_change_functions);
15866 goto restart;
15867 }
15868
15869 beg_unchanged = BEG_UNCHANGED;
15870 end_unchanged = END_UNCHANGED;
15871
15872 SET_TEXT_POS (opoint, PT, PT_BYTE);
15873
15874 specbind (Qinhibit_point_motion_hooks, Qt);
15875
15876 buffer_unchanged_p
15877 = (w->window_end_valid
15878 && !current_buffer->clip_changed
15879 && !window_outdated (w));
15880
15881 /* When windows_or_buffers_changed is non-zero, we can't rely
15882 on the window end being valid, so set it to zero there. */
15883 if (windows_or_buffers_changed)
15884 {
15885 /* If window starts on a continuation line, maybe adjust the
15886 window start in case the window's width changed. */
15887 if (XMARKER (w->start)->buffer == current_buffer)
15888 compute_window_start_on_continuation_line (w);
15889
15890 w->window_end_valid = false;
15891 /* If so, we also can't rely on current matrix
15892 and should not fool try_cursor_movement below. */
15893 current_matrix_up_to_date_p = false;
15894 }
15895
15896 /* Some sanity checks. */
15897 CHECK_WINDOW_END (w);
15898 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
15899 emacs_abort ();
15900 if (BYTEPOS (opoint) < CHARPOS (opoint))
15901 emacs_abort ();
15902
15903 if (mode_line_update_needed (w))
15904 update_mode_line = 1;
15905
15906 /* Point refers normally to the selected window. For any other
15907 window, set up appropriate value. */
15908 if (!EQ (window, selected_window))
15909 {
15910 ptrdiff_t new_pt = marker_position (w->pointm);
15911 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
15912 if (new_pt < BEGV)
15913 {
15914 new_pt = BEGV;
15915 new_pt_byte = BEGV_BYTE;
15916 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
15917 }
15918 else if (new_pt > (ZV - 1))
15919 {
15920 new_pt = ZV;
15921 new_pt_byte = ZV_BYTE;
15922 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
15923 }
15924
15925 /* We don't use SET_PT so that the point-motion hooks don't run. */
15926 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
15927 }
15928
15929 /* If any of the character widths specified in the display table
15930 have changed, invalidate the width run cache. It's true that
15931 this may be a bit late to catch such changes, but the rest of
15932 redisplay goes (non-fatally) haywire when the display table is
15933 changed, so why should we worry about doing any better? */
15934 if (current_buffer->width_run_cache
15935 || (current_buffer->base_buffer
15936 && current_buffer->base_buffer->width_run_cache))
15937 {
15938 struct Lisp_Char_Table *disptab = buffer_display_table ();
15939
15940 if (! disptab_matches_widthtab
15941 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
15942 {
15943 struct buffer *buf = current_buffer;
15944
15945 if (buf->base_buffer)
15946 buf = buf->base_buffer;
15947 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
15948 recompute_width_table (current_buffer, disptab);
15949 }
15950 }
15951
15952 /* If window-start is screwed up, choose a new one. */
15953 if (XMARKER (w->start)->buffer != current_buffer)
15954 goto recenter;
15955
15956 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15957
15958 /* If someone specified a new starting point but did not insist,
15959 check whether it can be used. */
15960 if (w->optional_new_start
15961 && CHARPOS (startp) >= BEGV
15962 && CHARPOS (startp) <= ZV)
15963 {
15964 w->optional_new_start = 0;
15965 start_display (&it, w, startp);
15966 move_it_to (&it, PT, 0, it.last_visible_y, -1,
15967 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15968 if (IT_CHARPOS (it) == PT)
15969 w->force_start = 1;
15970 /* IT may overshoot PT if text at PT is invisible. */
15971 else if (IT_CHARPOS (it) > PT && CHARPOS (startp) <= PT)
15972 w->force_start = 1;
15973 }
15974
15975 force_start:
15976
15977 /* Handle case where place to start displaying has been specified,
15978 unless the specified location is outside the accessible range. */
15979 if (w->force_start || window_frozen_p (w))
15980 {
15981 /* We set this later on if we have to adjust point. */
15982 int new_vpos = -1;
15983
15984 w->force_start = 0;
15985 w->vscroll = 0;
15986 w->window_end_valid = 0;
15987
15988 /* Forget any recorded base line for line number display. */
15989 if (!buffer_unchanged_p)
15990 w->base_line_number = 0;
15991
15992 /* Redisplay the mode line. Select the buffer properly for that.
15993 Also, run the hook window-scroll-functions
15994 because we have scrolled. */
15995 /* Note, we do this after clearing force_start because
15996 if there's an error, it is better to forget about force_start
15997 than to get into an infinite loop calling the hook functions
15998 and having them get more errors. */
15999 if (!update_mode_line
16000 || ! NILP (Vwindow_scroll_functions))
16001 {
16002 update_mode_line = 1;
16003 w->update_mode_line = 1;
16004 startp = run_window_scroll_functions (window, startp);
16005 }
16006
16007 if (CHARPOS (startp) < BEGV)
16008 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16009 else if (CHARPOS (startp) > ZV)
16010 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16011
16012 /* Redisplay, then check if cursor has been set during the
16013 redisplay. Give up if new fonts were loaded. */
16014 /* We used to issue a CHECK_MARGINS argument to try_window here,
16015 but this causes scrolling to fail when point begins inside
16016 the scroll margin (bug#148) -- cyd */
16017 if (!try_window (window, startp, 0))
16018 {
16019 w->force_start = 1;
16020 clear_glyph_matrix (w->desired_matrix);
16021 goto need_larger_matrices;
16022 }
16023
16024 if (w->cursor.vpos < 0 && !window_frozen_p (w))
16025 {
16026 /* If point does not appear, try to move point so it does
16027 appear. The desired matrix has been built above, so we
16028 can use it here. */
16029 new_vpos = window_box_height (w) / 2;
16030 }
16031
16032 if (!cursor_row_fully_visible_p (w, 0, 0))
16033 {
16034 /* Point does appear, but on a line partly visible at end of window.
16035 Move it back to a fully-visible line. */
16036 new_vpos = window_box_height (w);
16037 }
16038 else if (w->cursor.vpos >= 0)
16039 {
16040 /* Some people insist on not letting point enter the scroll
16041 margin, even though this part handles windows that didn't
16042 scroll at all. */
16043 int window_total_lines
16044 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16045 int margin = min (scroll_margin, window_total_lines / 4);
16046 int pixel_margin = margin * frame_line_height;
16047 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16048
16049 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16050 below, which finds the row to move point to, advances by
16051 the Y coordinate of the _next_ row, see the definition of
16052 MATRIX_ROW_BOTTOM_Y. */
16053 if (w->cursor.vpos < margin + header_line)
16054 {
16055 w->cursor.vpos = -1;
16056 clear_glyph_matrix (w->desired_matrix);
16057 goto try_to_scroll;
16058 }
16059 else
16060 {
16061 int window_height = window_box_height (w);
16062
16063 if (header_line)
16064 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16065 if (w->cursor.y >= window_height - pixel_margin)
16066 {
16067 w->cursor.vpos = -1;
16068 clear_glyph_matrix (w->desired_matrix);
16069 goto try_to_scroll;
16070 }
16071 }
16072 }
16073
16074 /* If we need to move point for either of the above reasons,
16075 now actually do it. */
16076 if (new_vpos >= 0)
16077 {
16078 struct glyph_row *row;
16079
16080 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16081 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16082 ++row;
16083
16084 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16085 MATRIX_ROW_START_BYTEPOS (row));
16086
16087 if (w != XWINDOW (selected_window))
16088 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16089 else if (current_buffer == old)
16090 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16091
16092 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16093
16094 /* If we are highlighting the region, then we just changed
16095 the region, so redisplay to show it. */
16096 /* FIXME: We need to (re)run pre-redisplay-function! */
16097 /* if (markpos_of_region () >= 0)
16098 {
16099 clear_glyph_matrix (w->desired_matrix);
16100 if (!try_window (window, startp, 0))
16101 goto need_larger_matrices;
16102 }
16103 */
16104 }
16105
16106 #ifdef GLYPH_DEBUG
16107 debug_method_add (w, "forced window start");
16108 #endif
16109 goto done;
16110 }
16111
16112 /* Handle case where text has not changed, only point, and it has
16113 not moved off the frame, and we are not retrying after hscroll.
16114 (current_matrix_up_to_date_p is nonzero when retrying.) */
16115 if (current_matrix_up_to_date_p
16116 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16117 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16118 {
16119 switch (rc)
16120 {
16121 case CURSOR_MOVEMENT_SUCCESS:
16122 used_current_matrix_p = 1;
16123 goto done;
16124
16125 case CURSOR_MOVEMENT_MUST_SCROLL:
16126 goto try_to_scroll;
16127
16128 default:
16129 emacs_abort ();
16130 }
16131 }
16132 /* If current starting point was originally the beginning of a line
16133 but no longer is, find a new starting point. */
16134 else if (w->start_at_line_beg
16135 && !(CHARPOS (startp) <= BEGV
16136 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16137 {
16138 #ifdef GLYPH_DEBUG
16139 debug_method_add (w, "recenter 1");
16140 #endif
16141 goto recenter;
16142 }
16143
16144 /* Try scrolling with try_window_id. Value is > 0 if update has
16145 been done, it is -1 if we know that the same window start will
16146 not work. It is 0 if unsuccessful for some other reason. */
16147 else if ((tem = try_window_id (w)) != 0)
16148 {
16149 #ifdef GLYPH_DEBUG
16150 debug_method_add (w, "try_window_id %d", tem);
16151 #endif
16152
16153 if (f->fonts_changed)
16154 goto need_larger_matrices;
16155 if (tem > 0)
16156 goto done;
16157
16158 /* Otherwise try_window_id has returned -1 which means that we
16159 don't want the alternative below this comment to execute. */
16160 }
16161 else if (CHARPOS (startp) >= BEGV
16162 && CHARPOS (startp) <= ZV
16163 && PT >= CHARPOS (startp)
16164 && (CHARPOS (startp) < ZV
16165 /* Avoid starting at end of buffer. */
16166 || CHARPOS (startp) == BEGV
16167 || !window_outdated (w)))
16168 {
16169 int d1, d2, d3, d4, d5, d6;
16170
16171 /* If first window line is a continuation line, and window start
16172 is inside the modified region, but the first change is before
16173 current window start, we must select a new window start.
16174
16175 However, if this is the result of a down-mouse event (e.g. by
16176 extending the mouse-drag-overlay), we don't want to select a
16177 new window start, since that would change the position under
16178 the mouse, resulting in an unwanted mouse-movement rather
16179 than a simple mouse-click. */
16180 if (!w->start_at_line_beg
16181 && NILP (do_mouse_tracking)
16182 && CHARPOS (startp) > BEGV
16183 && CHARPOS (startp) > BEG + beg_unchanged
16184 && CHARPOS (startp) <= Z - end_unchanged
16185 /* Even if w->start_at_line_beg is nil, a new window may
16186 start at a line_beg, since that's how set_buffer_window
16187 sets it. So, we need to check the return value of
16188 compute_window_start_on_continuation_line. (See also
16189 bug#197). */
16190 && XMARKER (w->start)->buffer == current_buffer
16191 && compute_window_start_on_continuation_line (w)
16192 /* It doesn't make sense to force the window start like we
16193 do at label force_start if it is already known that point
16194 will not be visible in the resulting window, because
16195 doing so will move point from its correct position
16196 instead of scrolling the window to bring point into view.
16197 See bug#9324. */
16198 && pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &d6))
16199 {
16200 w->force_start = 1;
16201 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16202 goto force_start;
16203 }
16204
16205 #ifdef GLYPH_DEBUG
16206 debug_method_add (w, "same window start");
16207 #endif
16208
16209 /* Try to redisplay starting at same place as before.
16210 If point has not moved off frame, accept the results. */
16211 if (!current_matrix_up_to_date_p
16212 /* Don't use try_window_reusing_current_matrix in this case
16213 because a window scroll function can have changed the
16214 buffer. */
16215 || !NILP (Vwindow_scroll_functions)
16216 || MINI_WINDOW_P (w)
16217 || !(used_current_matrix_p
16218 = try_window_reusing_current_matrix (w)))
16219 {
16220 IF_DEBUG (debug_method_add (w, "1"));
16221 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16222 /* -1 means we need to scroll.
16223 0 means we need new matrices, but fonts_changed
16224 is set in that case, so we will detect it below. */
16225 goto try_to_scroll;
16226 }
16227
16228 if (f->fonts_changed)
16229 goto need_larger_matrices;
16230
16231 if (w->cursor.vpos >= 0)
16232 {
16233 if (!just_this_one_p
16234 || current_buffer->clip_changed
16235 || BEG_UNCHANGED < CHARPOS (startp))
16236 /* Forget any recorded base line for line number display. */
16237 w->base_line_number = 0;
16238
16239 if (!cursor_row_fully_visible_p (w, 1, 0))
16240 {
16241 clear_glyph_matrix (w->desired_matrix);
16242 last_line_misfit = 1;
16243 }
16244 /* Drop through and scroll. */
16245 else
16246 goto done;
16247 }
16248 else
16249 clear_glyph_matrix (w->desired_matrix);
16250 }
16251
16252 try_to_scroll:
16253
16254 /* Redisplay the mode line. Select the buffer properly for that. */
16255 if (!update_mode_line)
16256 {
16257 update_mode_line = 1;
16258 w->update_mode_line = 1;
16259 }
16260
16261 /* Try to scroll by specified few lines. */
16262 if ((scroll_conservatively
16263 || emacs_scroll_step
16264 || temp_scroll_step
16265 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16266 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16267 && CHARPOS (startp) >= BEGV
16268 && CHARPOS (startp) <= ZV)
16269 {
16270 /* The function returns -1 if new fonts were loaded, 1 if
16271 successful, 0 if not successful. */
16272 int ss = try_scrolling (window, just_this_one_p,
16273 scroll_conservatively,
16274 emacs_scroll_step,
16275 temp_scroll_step, last_line_misfit);
16276 switch (ss)
16277 {
16278 case SCROLLING_SUCCESS:
16279 goto done;
16280
16281 case SCROLLING_NEED_LARGER_MATRICES:
16282 goto need_larger_matrices;
16283
16284 case SCROLLING_FAILED:
16285 break;
16286
16287 default:
16288 emacs_abort ();
16289 }
16290 }
16291
16292 /* Finally, just choose a place to start which positions point
16293 according to user preferences. */
16294
16295 recenter:
16296
16297 #ifdef GLYPH_DEBUG
16298 debug_method_add (w, "recenter");
16299 #endif
16300
16301 /* Forget any previously recorded base line for line number display. */
16302 if (!buffer_unchanged_p)
16303 w->base_line_number = 0;
16304
16305 /* Determine the window start relative to point. */
16306 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16307 it.current_y = it.last_visible_y;
16308 if (centering_position < 0)
16309 {
16310 int window_total_lines
16311 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16312 int margin =
16313 scroll_margin > 0
16314 ? min (scroll_margin, window_total_lines / 4)
16315 : 0;
16316 ptrdiff_t margin_pos = CHARPOS (startp);
16317 Lisp_Object aggressive;
16318 int scrolling_up;
16319
16320 /* If there is a scroll margin at the top of the window, find
16321 its character position. */
16322 if (margin
16323 /* Cannot call start_display if startp is not in the
16324 accessible region of the buffer. This can happen when we
16325 have just switched to a different buffer and/or changed
16326 its restriction. In that case, startp is initialized to
16327 the character position 1 (BEGV) because we did not yet
16328 have chance to display the buffer even once. */
16329 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16330 {
16331 struct it it1;
16332 void *it1data = NULL;
16333
16334 SAVE_IT (it1, it, it1data);
16335 start_display (&it1, w, startp);
16336 move_it_vertically (&it1, margin * frame_line_height);
16337 margin_pos = IT_CHARPOS (it1);
16338 RESTORE_IT (&it, &it, it1data);
16339 }
16340 scrolling_up = PT > margin_pos;
16341 aggressive =
16342 scrolling_up
16343 ? BVAR (current_buffer, scroll_up_aggressively)
16344 : BVAR (current_buffer, scroll_down_aggressively);
16345
16346 if (!MINI_WINDOW_P (w)
16347 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16348 {
16349 int pt_offset = 0;
16350
16351 /* Setting scroll-conservatively overrides
16352 scroll-*-aggressively. */
16353 if (!scroll_conservatively && NUMBERP (aggressive))
16354 {
16355 double float_amount = XFLOATINT (aggressive);
16356
16357 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16358 if (pt_offset == 0 && float_amount > 0)
16359 pt_offset = 1;
16360 if (pt_offset && margin > 0)
16361 margin -= 1;
16362 }
16363 /* Compute how much to move the window start backward from
16364 point so that point will be displayed where the user
16365 wants it. */
16366 if (scrolling_up)
16367 {
16368 centering_position = it.last_visible_y;
16369 if (pt_offset)
16370 centering_position -= pt_offset;
16371 centering_position -=
16372 frame_line_height * (1 + margin + (last_line_misfit != 0))
16373 + WINDOW_HEADER_LINE_HEIGHT (w);
16374 /* Don't let point enter the scroll margin near top of
16375 the window. */
16376 if (centering_position < margin * frame_line_height)
16377 centering_position = margin * frame_line_height;
16378 }
16379 else
16380 centering_position = margin * frame_line_height + pt_offset;
16381 }
16382 else
16383 /* Set the window start half the height of the window backward
16384 from point. */
16385 centering_position = window_box_height (w) / 2;
16386 }
16387 move_it_vertically_backward (&it, centering_position);
16388
16389 eassert (IT_CHARPOS (it) >= BEGV);
16390
16391 /* The function move_it_vertically_backward may move over more
16392 than the specified y-distance. If it->w is small, e.g. a
16393 mini-buffer window, we may end up in front of the window's
16394 display area. Start displaying at the start of the line
16395 containing PT in this case. */
16396 if (it.current_y <= 0)
16397 {
16398 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16399 move_it_vertically_backward (&it, 0);
16400 it.current_y = 0;
16401 }
16402
16403 it.current_x = it.hpos = 0;
16404
16405 /* Set the window start position here explicitly, to avoid an
16406 infinite loop in case the functions in window-scroll-functions
16407 get errors. */
16408 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16409
16410 /* Run scroll hooks. */
16411 startp = run_window_scroll_functions (window, it.current.pos);
16412
16413 /* Redisplay the window. */
16414 if (!current_matrix_up_to_date_p
16415 || windows_or_buffers_changed
16416 || f->cursor_type_changed
16417 /* Don't use try_window_reusing_current_matrix in this case
16418 because it can have changed the buffer. */
16419 || !NILP (Vwindow_scroll_functions)
16420 || !just_this_one_p
16421 || MINI_WINDOW_P (w)
16422 || !(used_current_matrix_p
16423 = try_window_reusing_current_matrix (w)))
16424 try_window (window, startp, 0);
16425
16426 /* If new fonts have been loaded (due to fontsets), give up. We
16427 have to start a new redisplay since we need to re-adjust glyph
16428 matrices. */
16429 if (f->fonts_changed)
16430 goto need_larger_matrices;
16431
16432 /* If cursor did not appear assume that the middle of the window is
16433 in the first line of the window. Do it again with the next line.
16434 (Imagine a window of height 100, displaying two lines of height
16435 60. Moving back 50 from it->last_visible_y will end in the first
16436 line.) */
16437 if (w->cursor.vpos < 0)
16438 {
16439 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16440 {
16441 clear_glyph_matrix (w->desired_matrix);
16442 move_it_by_lines (&it, 1);
16443 try_window (window, it.current.pos, 0);
16444 }
16445 else if (PT < IT_CHARPOS (it))
16446 {
16447 clear_glyph_matrix (w->desired_matrix);
16448 move_it_by_lines (&it, -1);
16449 try_window (window, it.current.pos, 0);
16450 }
16451 else
16452 {
16453 /* Not much we can do about it. */
16454 }
16455 }
16456
16457 /* Consider the following case: Window starts at BEGV, there is
16458 invisible, intangible text at BEGV, so that display starts at
16459 some point START > BEGV. It can happen that we are called with
16460 PT somewhere between BEGV and START. Try to handle that case,
16461 and similar ones. */
16462 if (w->cursor.vpos < 0)
16463 {
16464 /* First, try locating the proper glyph row for PT. */
16465 struct glyph_row *row =
16466 row_containing_pos (w, PT, w->current_matrix->rows, NULL, 0);
16467
16468 /* Sometimes point is at the beginning of invisible text that is
16469 before the 1st character displayed in the row. In that case,
16470 row_containing_pos fails to find the row, because no glyphs
16471 with appropriate buffer positions are present in the row.
16472 Therefore, we next try to find the row which shows the 1st
16473 position after the invisible text. */
16474 if (!row)
16475 {
16476 Lisp_Object val =
16477 get_char_property_and_overlay (make_number (PT), Qinvisible,
16478 Qnil, NULL);
16479
16480 if (TEXT_PROP_MEANS_INVISIBLE (val))
16481 {
16482 ptrdiff_t alt_pos;
16483 Lisp_Object invis_end =
16484 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16485 Qnil, Qnil);
16486
16487 if (NATNUMP (invis_end))
16488 alt_pos = XFASTINT (invis_end);
16489 else
16490 alt_pos = ZV;
16491 row = row_containing_pos (w, alt_pos, w->current_matrix->rows,
16492 NULL, 0);
16493 }
16494 }
16495 /* Finally, fall back on the first row of the window after the
16496 header line (if any). This is slightly better than not
16497 displaying the cursor at all. */
16498 if (!row)
16499 {
16500 row = w->current_matrix->rows;
16501 if (row->mode_line_p)
16502 ++row;
16503 }
16504 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16505 }
16506
16507 if (!cursor_row_fully_visible_p (w, 0, 0))
16508 {
16509 /* If vscroll is enabled, disable it and try again. */
16510 if (w->vscroll)
16511 {
16512 w->vscroll = 0;
16513 clear_glyph_matrix (w->desired_matrix);
16514 goto recenter;
16515 }
16516
16517 /* Users who set scroll-conservatively to a large number want
16518 point just above/below the scroll margin. If we ended up
16519 with point's row partially visible, move the window start to
16520 make that row fully visible and out of the margin. */
16521 if (scroll_conservatively > SCROLL_LIMIT)
16522 {
16523 int window_total_lines
16524 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) * frame_line_height;
16525 int margin =
16526 scroll_margin > 0
16527 ? min (scroll_margin, window_total_lines / 4)
16528 : 0;
16529 int move_down = w->cursor.vpos >= window_total_lines / 2;
16530
16531 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16532 clear_glyph_matrix (w->desired_matrix);
16533 if (1 == try_window (window, it.current.pos,
16534 TRY_WINDOW_CHECK_MARGINS))
16535 goto done;
16536 }
16537
16538 /* If centering point failed to make the whole line visible,
16539 put point at the top instead. That has to make the whole line
16540 visible, if it can be done. */
16541 if (centering_position == 0)
16542 goto done;
16543
16544 clear_glyph_matrix (w->desired_matrix);
16545 centering_position = 0;
16546 goto recenter;
16547 }
16548
16549 done:
16550
16551 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16552 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16553 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16554
16555 /* Display the mode line, if we must. */
16556 if ((update_mode_line
16557 /* If window not full width, must redo its mode line
16558 if (a) the window to its side is being redone and
16559 (b) we do a frame-based redisplay. This is a consequence
16560 of how inverted lines are drawn in frame-based redisplay. */
16561 || (!just_this_one_p
16562 && !FRAME_WINDOW_P (f)
16563 && !WINDOW_FULL_WIDTH_P (w))
16564 /* Line number to display. */
16565 || w->base_line_pos > 0
16566 /* Column number is displayed and different from the one displayed. */
16567 || (w->column_number_displayed != -1
16568 && (w->column_number_displayed != current_column ())))
16569 /* This means that the window has a mode line. */
16570 && (WINDOW_WANTS_MODELINE_P (w)
16571 || WINDOW_WANTS_HEADER_LINE_P (w)))
16572 {
16573
16574 display_mode_lines (w);
16575
16576 /* If mode line height has changed, arrange for a thorough
16577 immediate redisplay using the correct mode line height. */
16578 if (WINDOW_WANTS_MODELINE_P (w)
16579 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16580 {
16581 f->fonts_changed = 1;
16582 w->mode_line_height = -1;
16583 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16584 = DESIRED_MODE_LINE_HEIGHT (w);
16585 }
16586
16587 /* If header line height has changed, arrange for a thorough
16588 immediate redisplay using the correct header line height. */
16589 if (WINDOW_WANTS_HEADER_LINE_P (w)
16590 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16591 {
16592 f->fonts_changed = 1;
16593 w->header_line_height = -1;
16594 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16595 = DESIRED_HEADER_LINE_HEIGHT (w);
16596 }
16597
16598 if (f->fonts_changed)
16599 goto need_larger_matrices;
16600 }
16601
16602 if (!line_number_displayed && w->base_line_pos != -1)
16603 {
16604 w->base_line_pos = 0;
16605 w->base_line_number = 0;
16606 }
16607
16608 finish_menu_bars:
16609
16610 /* When we reach a frame's selected window, redo the frame's menu bar. */
16611 if (update_mode_line
16612 && EQ (FRAME_SELECTED_WINDOW (f), window))
16613 {
16614 int redisplay_menu_p = 0;
16615
16616 if (FRAME_WINDOW_P (f))
16617 {
16618 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16619 || defined (HAVE_NS) || defined (USE_GTK)
16620 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16621 #else
16622 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16623 #endif
16624 }
16625 else
16626 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16627
16628 if (redisplay_menu_p)
16629 display_menu_bar (w);
16630
16631 #ifdef HAVE_WINDOW_SYSTEM
16632 if (FRAME_WINDOW_P (f))
16633 {
16634 #if defined (USE_GTK) || defined (HAVE_NS)
16635 if (FRAME_EXTERNAL_TOOL_BAR (f))
16636 redisplay_tool_bar (f);
16637 #else
16638 if (WINDOWP (f->tool_bar_window)
16639 && (FRAME_TOOL_BAR_HEIGHT (f) > 0
16640 || !NILP (Vauto_resize_tool_bars))
16641 && redisplay_tool_bar (f))
16642 ignore_mouse_drag_p = 1;
16643 #endif
16644 }
16645 #endif
16646 }
16647
16648 #ifdef HAVE_WINDOW_SYSTEM
16649 if (FRAME_WINDOW_P (f)
16650 && update_window_fringes (w, (just_this_one_p
16651 || (!used_current_matrix_p && !overlay_arrow_seen)
16652 || w->pseudo_window_p)))
16653 {
16654 update_begin (f);
16655 block_input ();
16656 if (draw_window_fringes (w, 1))
16657 {
16658 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
16659 x_draw_right_divider (w);
16660 else
16661 x_draw_vertical_border (w);
16662 }
16663 unblock_input ();
16664 update_end (f);
16665 }
16666
16667 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
16668 x_draw_bottom_divider (w);
16669 #endif /* HAVE_WINDOW_SYSTEM */
16670
16671 /* We go to this label, with fonts_changed set, if it is
16672 necessary to try again using larger glyph matrices.
16673 We have to redeem the scroll bar even in this case,
16674 because the loop in redisplay_internal expects that. */
16675 need_larger_matrices:
16676 ;
16677 finish_scroll_bars:
16678
16679 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16680 {
16681 /* Set the thumb's position and size. */
16682 set_vertical_scroll_bar (w);
16683
16684 /* Note that we actually used the scroll bar attached to this
16685 window, so it shouldn't be deleted at the end of redisplay. */
16686 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16687 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16688 }
16689
16690 /* Restore current_buffer and value of point in it. The window
16691 update may have changed the buffer, so first make sure `opoint'
16692 is still valid (Bug#6177). */
16693 if (CHARPOS (opoint) < BEGV)
16694 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16695 else if (CHARPOS (opoint) > ZV)
16696 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16697 else
16698 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16699
16700 set_buffer_internal_1 (old);
16701 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16702 shorter. This can be caused by log truncation in *Messages*. */
16703 if (CHARPOS (lpoint) <= ZV)
16704 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16705
16706 unbind_to (count, Qnil);
16707 }
16708
16709
16710 /* Build the complete desired matrix of WINDOW with a window start
16711 buffer position POS.
16712
16713 Value is 1 if successful. It is zero if fonts were loaded during
16714 redisplay which makes re-adjusting glyph matrices necessary, and -1
16715 if point would appear in the scroll margins.
16716 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16717 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16718 set in FLAGS.) */
16719
16720 int
16721 try_window (Lisp_Object window, struct text_pos pos, int flags)
16722 {
16723 struct window *w = XWINDOW (window);
16724 struct it it;
16725 struct glyph_row *last_text_row = NULL;
16726 struct frame *f = XFRAME (w->frame);
16727 int frame_line_height = default_line_pixel_height (w);
16728
16729 /* Make POS the new window start. */
16730 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
16731
16732 /* Mark cursor position as unknown. No overlay arrow seen. */
16733 w->cursor.vpos = -1;
16734 overlay_arrow_seen = 0;
16735
16736 /* Initialize iterator and info to start at POS. */
16737 start_display (&it, w, pos);
16738
16739 /* Display all lines of W. */
16740 while (it.current_y < it.last_visible_y)
16741 {
16742 if (display_line (&it))
16743 last_text_row = it.glyph_row - 1;
16744 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
16745 return 0;
16746 }
16747
16748 /* Don't let the cursor end in the scroll margins. */
16749 if ((flags & TRY_WINDOW_CHECK_MARGINS)
16750 && !MINI_WINDOW_P (w))
16751 {
16752 int this_scroll_margin;
16753 int window_total_lines
16754 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16755
16756 if (scroll_margin > 0)
16757 {
16758 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
16759 this_scroll_margin *= frame_line_height;
16760 }
16761 else
16762 this_scroll_margin = 0;
16763
16764 if ((w->cursor.y >= 0 /* not vscrolled */
16765 && w->cursor.y < this_scroll_margin
16766 && CHARPOS (pos) > BEGV
16767 && IT_CHARPOS (it) < ZV)
16768 /* rms: considering make_cursor_line_fully_visible_p here
16769 seems to give wrong results. We don't want to recenter
16770 when the last line is partly visible, we want to allow
16771 that case to be handled in the usual way. */
16772 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
16773 {
16774 w->cursor.vpos = -1;
16775 clear_glyph_matrix (w->desired_matrix);
16776 return -1;
16777 }
16778 }
16779
16780 /* If bottom moved off end of frame, change mode line percentage. */
16781 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
16782 w->update_mode_line = 1;
16783
16784 /* Set window_end_pos to the offset of the last character displayed
16785 on the window from the end of current_buffer. Set
16786 window_end_vpos to its row number. */
16787 if (last_text_row)
16788 {
16789 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
16790 adjust_window_ends (w, last_text_row, 0);
16791 eassert
16792 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
16793 w->window_end_vpos)));
16794 }
16795 else
16796 {
16797 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
16798 w->window_end_pos = Z - ZV;
16799 w->window_end_vpos = 0;
16800 }
16801
16802 /* But that is not valid info until redisplay finishes. */
16803 w->window_end_valid = 0;
16804 return 1;
16805 }
16806
16807
16808 \f
16809 /************************************************************************
16810 Window redisplay reusing current matrix when buffer has not changed
16811 ************************************************************************/
16812
16813 /* Try redisplay of window W showing an unchanged buffer with a
16814 different window start than the last time it was displayed by
16815 reusing its current matrix. Value is non-zero if successful.
16816 W->start is the new window start. */
16817
16818 static int
16819 try_window_reusing_current_matrix (struct window *w)
16820 {
16821 struct frame *f = XFRAME (w->frame);
16822 struct glyph_row *bottom_row;
16823 struct it it;
16824 struct run run;
16825 struct text_pos start, new_start;
16826 int nrows_scrolled, i;
16827 struct glyph_row *last_text_row;
16828 struct glyph_row *last_reused_text_row;
16829 struct glyph_row *start_row;
16830 int start_vpos, min_y, max_y;
16831
16832 #ifdef GLYPH_DEBUG
16833 if (inhibit_try_window_reusing)
16834 return 0;
16835 #endif
16836
16837 if (/* This function doesn't handle terminal frames. */
16838 !FRAME_WINDOW_P (f)
16839 /* Don't try to reuse the display if windows have been split
16840 or such. */
16841 || windows_or_buffers_changed
16842 || f->cursor_type_changed)
16843 return 0;
16844
16845 /* Can't do this if showing trailing whitespace. */
16846 if (!NILP (Vshow_trailing_whitespace))
16847 return 0;
16848
16849 /* If top-line visibility has changed, give up. */
16850 if (WINDOW_WANTS_HEADER_LINE_P (w)
16851 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
16852 return 0;
16853
16854 /* Give up if old or new display is scrolled vertically. We could
16855 make this function handle this, but right now it doesn't. */
16856 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
16857 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
16858 return 0;
16859
16860 /* The variable new_start now holds the new window start. The old
16861 start `start' can be determined from the current matrix. */
16862 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
16863 start = start_row->minpos;
16864 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
16865
16866 /* Clear the desired matrix for the display below. */
16867 clear_glyph_matrix (w->desired_matrix);
16868
16869 if (CHARPOS (new_start) <= CHARPOS (start))
16870 {
16871 /* Don't use this method if the display starts with an ellipsis
16872 displayed for invisible text. It's not easy to handle that case
16873 below, and it's certainly not worth the effort since this is
16874 not a frequent case. */
16875 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
16876 return 0;
16877
16878 IF_DEBUG (debug_method_add (w, "twu1"));
16879
16880 /* Display up to a row that can be reused. The variable
16881 last_text_row is set to the last row displayed that displays
16882 text. Note that it.vpos == 0 if or if not there is a
16883 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16884 start_display (&it, w, new_start);
16885 w->cursor.vpos = -1;
16886 last_text_row = last_reused_text_row = NULL;
16887
16888 while (it.current_y < it.last_visible_y && !f->fonts_changed)
16889 {
16890 /* If we have reached into the characters in the START row,
16891 that means the line boundaries have changed. So we
16892 can't start copying with the row START. Maybe it will
16893 work to start copying with the following row. */
16894 while (IT_CHARPOS (it) > CHARPOS (start))
16895 {
16896 /* Advance to the next row as the "start". */
16897 start_row++;
16898 start = start_row->minpos;
16899 /* If there are no more rows to try, or just one, give up. */
16900 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
16901 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
16902 || CHARPOS (start) == ZV)
16903 {
16904 clear_glyph_matrix (w->desired_matrix);
16905 return 0;
16906 }
16907
16908 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
16909 }
16910 /* If we have reached alignment, we can copy the rest of the
16911 rows. */
16912 if (IT_CHARPOS (it) == CHARPOS (start)
16913 /* Don't accept "alignment" inside a display vector,
16914 since start_row could have started in the middle of
16915 that same display vector (thus their character
16916 positions match), and we have no way of telling if
16917 that is the case. */
16918 && it.current.dpvec_index < 0)
16919 break;
16920
16921 if (display_line (&it))
16922 last_text_row = it.glyph_row - 1;
16923
16924 }
16925
16926 /* A value of current_y < last_visible_y means that we stopped
16927 at the previous window start, which in turn means that we
16928 have at least one reusable row. */
16929 if (it.current_y < it.last_visible_y)
16930 {
16931 struct glyph_row *row;
16932
16933 /* IT.vpos always starts from 0; it counts text lines. */
16934 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
16935
16936 /* Find PT if not already found in the lines displayed. */
16937 if (w->cursor.vpos < 0)
16938 {
16939 int dy = it.current_y - start_row->y;
16940
16941 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
16942 row = row_containing_pos (w, PT, row, NULL, dy);
16943 if (row)
16944 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
16945 dy, nrows_scrolled);
16946 else
16947 {
16948 clear_glyph_matrix (w->desired_matrix);
16949 return 0;
16950 }
16951 }
16952
16953 /* Scroll the display. Do it before the current matrix is
16954 changed. The problem here is that update has not yet
16955 run, i.e. part of the current matrix is not up to date.
16956 scroll_run_hook will clear the cursor, and use the
16957 current matrix to get the height of the row the cursor is
16958 in. */
16959 run.current_y = start_row->y;
16960 run.desired_y = it.current_y;
16961 run.height = it.last_visible_y - it.current_y;
16962
16963 if (run.height > 0 && run.current_y != run.desired_y)
16964 {
16965 update_begin (f);
16966 FRAME_RIF (f)->update_window_begin_hook (w);
16967 FRAME_RIF (f)->clear_window_mouse_face (w);
16968 FRAME_RIF (f)->scroll_run_hook (w, &run);
16969 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
16970 update_end (f);
16971 }
16972
16973 /* Shift current matrix down by nrows_scrolled lines. */
16974 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
16975 rotate_matrix (w->current_matrix,
16976 start_vpos,
16977 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
16978 nrows_scrolled);
16979
16980 /* Disable lines that must be updated. */
16981 for (i = 0; i < nrows_scrolled; ++i)
16982 (start_row + i)->enabled_p = false;
16983
16984 /* Re-compute Y positions. */
16985 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
16986 max_y = it.last_visible_y;
16987 for (row = start_row + nrows_scrolled;
16988 row < bottom_row;
16989 ++row)
16990 {
16991 row->y = it.current_y;
16992 row->visible_height = row->height;
16993
16994 if (row->y < min_y)
16995 row->visible_height -= min_y - row->y;
16996 if (row->y + row->height > max_y)
16997 row->visible_height -= row->y + row->height - max_y;
16998 if (row->fringe_bitmap_periodic_p)
16999 row->redraw_fringe_bitmaps_p = 1;
17000
17001 it.current_y += row->height;
17002
17003 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17004 last_reused_text_row = row;
17005 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17006 break;
17007 }
17008
17009 /* Disable lines in the current matrix which are now
17010 below the window. */
17011 for (++row; row < bottom_row; ++row)
17012 row->enabled_p = row->mode_line_p = 0;
17013 }
17014
17015 /* Update window_end_pos etc.; last_reused_text_row is the last
17016 reused row from the current matrix containing text, if any.
17017 The value of last_text_row is the last displayed line
17018 containing text. */
17019 if (last_reused_text_row)
17020 adjust_window_ends (w, last_reused_text_row, 1);
17021 else if (last_text_row)
17022 adjust_window_ends (w, last_text_row, 0);
17023 else
17024 {
17025 /* This window must be completely empty. */
17026 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17027 w->window_end_pos = Z - ZV;
17028 w->window_end_vpos = 0;
17029 }
17030 w->window_end_valid = 0;
17031
17032 /* Update hint: don't try scrolling again in update_window. */
17033 w->desired_matrix->no_scrolling_p = 1;
17034
17035 #ifdef GLYPH_DEBUG
17036 debug_method_add (w, "try_window_reusing_current_matrix 1");
17037 #endif
17038 return 1;
17039 }
17040 else if (CHARPOS (new_start) > CHARPOS (start))
17041 {
17042 struct glyph_row *pt_row, *row;
17043 struct glyph_row *first_reusable_row;
17044 struct glyph_row *first_row_to_display;
17045 int dy;
17046 int yb = window_text_bottom_y (w);
17047
17048 /* Find the row starting at new_start, if there is one. Don't
17049 reuse a partially visible line at the end. */
17050 first_reusable_row = start_row;
17051 while (first_reusable_row->enabled_p
17052 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17053 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17054 < CHARPOS (new_start)))
17055 ++first_reusable_row;
17056
17057 /* Give up if there is no row to reuse. */
17058 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17059 || !first_reusable_row->enabled_p
17060 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17061 != CHARPOS (new_start)))
17062 return 0;
17063
17064 /* We can reuse fully visible rows beginning with
17065 first_reusable_row to the end of the window. Set
17066 first_row_to_display to the first row that cannot be reused.
17067 Set pt_row to the row containing point, if there is any. */
17068 pt_row = NULL;
17069 for (first_row_to_display = first_reusable_row;
17070 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17071 ++first_row_to_display)
17072 {
17073 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17074 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17075 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17076 && first_row_to_display->ends_at_zv_p
17077 && pt_row == NULL)))
17078 pt_row = first_row_to_display;
17079 }
17080
17081 /* Start displaying at the start of first_row_to_display. */
17082 eassert (first_row_to_display->y < yb);
17083 init_to_row_start (&it, w, first_row_to_display);
17084
17085 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17086 - start_vpos);
17087 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17088 - nrows_scrolled);
17089 it.current_y = (first_row_to_display->y - first_reusable_row->y
17090 + WINDOW_HEADER_LINE_HEIGHT (w));
17091
17092 /* Display lines beginning with first_row_to_display in the
17093 desired matrix. Set last_text_row to the last row displayed
17094 that displays text. */
17095 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17096 if (pt_row == NULL)
17097 w->cursor.vpos = -1;
17098 last_text_row = NULL;
17099 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17100 if (display_line (&it))
17101 last_text_row = it.glyph_row - 1;
17102
17103 /* If point is in a reused row, adjust y and vpos of the cursor
17104 position. */
17105 if (pt_row)
17106 {
17107 w->cursor.vpos -= nrows_scrolled;
17108 w->cursor.y -= first_reusable_row->y - start_row->y;
17109 }
17110
17111 /* Give up if point isn't in a row displayed or reused. (This
17112 also handles the case where w->cursor.vpos < nrows_scrolled
17113 after the calls to display_line, which can happen with scroll
17114 margins. See bug#1295.) */
17115 if (w->cursor.vpos < 0)
17116 {
17117 clear_glyph_matrix (w->desired_matrix);
17118 return 0;
17119 }
17120
17121 /* Scroll the display. */
17122 run.current_y = first_reusable_row->y;
17123 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17124 run.height = it.last_visible_y - run.current_y;
17125 dy = run.current_y - run.desired_y;
17126
17127 if (run.height)
17128 {
17129 update_begin (f);
17130 FRAME_RIF (f)->update_window_begin_hook (w);
17131 FRAME_RIF (f)->clear_window_mouse_face (w);
17132 FRAME_RIF (f)->scroll_run_hook (w, &run);
17133 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17134 update_end (f);
17135 }
17136
17137 /* Adjust Y positions of reused rows. */
17138 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17139 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17140 max_y = it.last_visible_y;
17141 for (row = first_reusable_row; row < first_row_to_display; ++row)
17142 {
17143 row->y -= dy;
17144 row->visible_height = row->height;
17145 if (row->y < min_y)
17146 row->visible_height -= min_y - row->y;
17147 if (row->y + row->height > max_y)
17148 row->visible_height -= row->y + row->height - max_y;
17149 if (row->fringe_bitmap_periodic_p)
17150 row->redraw_fringe_bitmaps_p = 1;
17151 }
17152
17153 /* Scroll the current matrix. */
17154 eassert (nrows_scrolled > 0);
17155 rotate_matrix (w->current_matrix,
17156 start_vpos,
17157 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17158 -nrows_scrolled);
17159
17160 /* Disable rows not reused. */
17161 for (row -= nrows_scrolled; row < bottom_row; ++row)
17162 row->enabled_p = false;
17163
17164 /* Point may have moved to a different line, so we cannot assume that
17165 the previous cursor position is valid; locate the correct row. */
17166 if (pt_row)
17167 {
17168 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17169 row < bottom_row
17170 && PT >= MATRIX_ROW_END_CHARPOS (row)
17171 && !row->ends_at_zv_p;
17172 row++)
17173 {
17174 w->cursor.vpos++;
17175 w->cursor.y = row->y;
17176 }
17177 if (row < bottom_row)
17178 {
17179 /* Can't simply scan the row for point with
17180 bidi-reordered glyph rows. Let set_cursor_from_row
17181 figure out where to put the cursor, and if it fails,
17182 give up. */
17183 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17184 {
17185 if (!set_cursor_from_row (w, row, w->current_matrix,
17186 0, 0, 0, 0))
17187 {
17188 clear_glyph_matrix (w->desired_matrix);
17189 return 0;
17190 }
17191 }
17192 else
17193 {
17194 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17195 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17196
17197 for (; glyph < end
17198 && (!BUFFERP (glyph->object)
17199 || glyph->charpos < PT);
17200 glyph++)
17201 {
17202 w->cursor.hpos++;
17203 w->cursor.x += glyph->pixel_width;
17204 }
17205 }
17206 }
17207 }
17208
17209 /* Adjust window end. A null value of last_text_row means that
17210 the window end is in reused rows which in turn means that
17211 only its vpos can have changed. */
17212 if (last_text_row)
17213 adjust_window_ends (w, last_text_row, 0);
17214 else
17215 w->window_end_vpos -= nrows_scrolled;
17216
17217 w->window_end_valid = 0;
17218 w->desired_matrix->no_scrolling_p = 1;
17219
17220 #ifdef GLYPH_DEBUG
17221 debug_method_add (w, "try_window_reusing_current_matrix 2");
17222 #endif
17223 return 1;
17224 }
17225
17226 return 0;
17227 }
17228
17229
17230 \f
17231 /************************************************************************
17232 Window redisplay reusing current matrix when buffer has changed
17233 ************************************************************************/
17234
17235 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17236 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17237 ptrdiff_t *, ptrdiff_t *);
17238 static struct glyph_row *
17239 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17240 struct glyph_row *);
17241
17242
17243 /* Return the last row in MATRIX displaying text. If row START is
17244 non-null, start searching with that row. IT gives the dimensions
17245 of the display. Value is null if matrix is empty; otherwise it is
17246 a pointer to the row found. */
17247
17248 static struct glyph_row *
17249 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17250 struct glyph_row *start)
17251 {
17252 struct glyph_row *row, *row_found;
17253
17254 /* Set row_found to the last row in IT->w's current matrix
17255 displaying text. The loop looks funny but think of partially
17256 visible lines. */
17257 row_found = NULL;
17258 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17259 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17260 {
17261 eassert (row->enabled_p);
17262 row_found = row;
17263 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17264 break;
17265 ++row;
17266 }
17267
17268 return row_found;
17269 }
17270
17271
17272 /* Return the last row in the current matrix of W that is not affected
17273 by changes at the start of current_buffer that occurred since W's
17274 current matrix was built. Value is null if no such row exists.
17275
17276 BEG_UNCHANGED us the number of characters unchanged at the start of
17277 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17278 first changed character in current_buffer. Characters at positions <
17279 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17280 when the current matrix was built. */
17281
17282 static struct glyph_row *
17283 find_last_unchanged_at_beg_row (struct window *w)
17284 {
17285 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17286 struct glyph_row *row;
17287 struct glyph_row *row_found = NULL;
17288 int yb = window_text_bottom_y (w);
17289
17290 /* Find the last row displaying unchanged text. */
17291 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17292 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17293 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17294 ++row)
17295 {
17296 if (/* If row ends before first_changed_pos, it is unchanged,
17297 except in some case. */
17298 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17299 /* When row ends in ZV and we write at ZV it is not
17300 unchanged. */
17301 && !row->ends_at_zv_p
17302 /* When first_changed_pos is the end of a continued line,
17303 row is not unchanged because it may be no longer
17304 continued. */
17305 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17306 && (row->continued_p
17307 || row->exact_window_width_line_p))
17308 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17309 needs to be recomputed, so don't consider this row as
17310 unchanged. This happens when the last line was
17311 bidi-reordered and was killed immediately before this
17312 redisplay cycle. In that case, ROW->end stores the
17313 buffer position of the first visual-order character of
17314 the killed text, which is now beyond ZV. */
17315 && CHARPOS (row->end.pos) <= ZV)
17316 row_found = row;
17317
17318 /* Stop if last visible row. */
17319 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17320 break;
17321 }
17322
17323 return row_found;
17324 }
17325
17326
17327 /* Find the first glyph row in the current matrix of W that is not
17328 affected by changes at the end of current_buffer since the
17329 time W's current matrix was built.
17330
17331 Return in *DELTA the number of chars by which buffer positions in
17332 unchanged text at the end of current_buffer must be adjusted.
17333
17334 Return in *DELTA_BYTES the corresponding number of bytes.
17335
17336 Value is null if no such row exists, i.e. all rows are affected by
17337 changes. */
17338
17339 static struct glyph_row *
17340 find_first_unchanged_at_end_row (struct window *w,
17341 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17342 {
17343 struct glyph_row *row;
17344 struct glyph_row *row_found = NULL;
17345
17346 *delta = *delta_bytes = 0;
17347
17348 /* Display must not have been paused, otherwise the current matrix
17349 is not up to date. */
17350 eassert (w->window_end_valid);
17351
17352 /* A value of window_end_pos >= END_UNCHANGED means that the window
17353 end is in the range of changed text. If so, there is no
17354 unchanged row at the end of W's current matrix. */
17355 if (w->window_end_pos >= END_UNCHANGED)
17356 return NULL;
17357
17358 /* Set row to the last row in W's current matrix displaying text. */
17359 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17360
17361 /* If matrix is entirely empty, no unchanged row exists. */
17362 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17363 {
17364 /* The value of row is the last glyph row in the matrix having a
17365 meaningful buffer position in it. The end position of row
17366 corresponds to window_end_pos. This allows us to translate
17367 buffer positions in the current matrix to current buffer
17368 positions for characters not in changed text. */
17369 ptrdiff_t Z_old =
17370 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17371 ptrdiff_t Z_BYTE_old =
17372 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17373 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17374 struct glyph_row *first_text_row
17375 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17376
17377 *delta = Z - Z_old;
17378 *delta_bytes = Z_BYTE - Z_BYTE_old;
17379
17380 /* Set last_unchanged_pos to the buffer position of the last
17381 character in the buffer that has not been changed. Z is the
17382 index + 1 of the last character in current_buffer, i.e. by
17383 subtracting END_UNCHANGED we get the index of the last
17384 unchanged character, and we have to add BEG to get its buffer
17385 position. */
17386 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17387 last_unchanged_pos_old = last_unchanged_pos - *delta;
17388
17389 /* Search backward from ROW for a row displaying a line that
17390 starts at a minimum position >= last_unchanged_pos_old. */
17391 for (; row > first_text_row; --row)
17392 {
17393 /* This used to abort, but it can happen.
17394 It is ok to just stop the search instead here. KFS. */
17395 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17396 break;
17397
17398 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17399 row_found = row;
17400 }
17401 }
17402
17403 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17404
17405 return row_found;
17406 }
17407
17408
17409 /* Make sure that glyph rows in the current matrix of window W
17410 reference the same glyph memory as corresponding rows in the
17411 frame's frame matrix. This function is called after scrolling W's
17412 current matrix on a terminal frame in try_window_id and
17413 try_window_reusing_current_matrix. */
17414
17415 static void
17416 sync_frame_with_window_matrix_rows (struct window *w)
17417 {
17418 struct frame *f = XFRAME (w->frame);
17419 struct glyph_row *window_row, *window_row_end, *frame_row;
17420
17421 /* Preconditions: W must be a leaf window and full-width. Its frame
17422 must have a frame matrix. */
17423 eassert (BUFFERP (w->contents));
17424 eassert (WINDOW_FULL_WIDTH_P (w));
17425 eassert (!FRAME_WINDOW_P (f));
17426
17427 /* If W is a full-width window, glyph pointers in W's current matrix
17428 have, by definition, to be the same as glyph pointers in the
17429 corresponding frame matrix. Note that frame matrices have no
17430 marginal areas (see build_frame_matrix). */
17431 window_row = w->current_matrix->rows;
17432 window_row_end = window_row + w->current_matrix->nrows;
17433 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17434 while (window_row < window_row_end)
17435 {
17436 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17437 struct glyph *end = window_row->glyphs[LAST_AREA];
17438
17439 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17440 frame_row->glyphs[TEXT_AREA] = start;
17441 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17442 frame_row->glyphs[LAST_AREA] = end;
17443
17444 /* Disable frame rows whose corresponding window rows have
17445 been disabled in try_window_id. */
17446 if (!window_row->enabled_p)
17447 frame_row->enabled_p = false;
17448
17449 ++window_row, ++frame_row;
17450 }
17451 }
17452
17453
17454 /* Find the glyph row in window W containing CHARPOS. Consider all
17455 rows between START and END (not inclusive). END null means search
17456 all rows to the end of the display area of W. Value is the row
17457 containing CHARPOS or null. */
17458
17459 struct glyph_row *
17460 row_containing_pos (struct window *w, ptrdiff_t charpos,
17461 struct glyph_row *start, struct glyph_row *end, int dy)
17462 {
17463 struct glyph_row *row = start;
17464 struct glyph_row *best_row = NULL;
17465 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17466 int last_y;
17467
17468 /* If we happen to start on a header-line, skip that. */
17469 if (row->mode_line_p)
17470 ++row;
17471
17472 if ((end && row >= end) || !row->enabled_p)
17473 return NULL;
17474
17475 last_y = window_text_bottom_y (w) - dy;
17476
17477 while (1)
17478 {
17479 /* Give up if we have gone too far. */
17480 if (end && row >= end)
17481 return NULL;
17482 /* This formerly returned if they were equal.
17483 I think that both quantities are of a "last plus one" type;
17484 if so, when they are equal, the row is within the screen. -- rms. */
17485 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17486 return NULL;
17487
17488 /* If it is in this row, return this row. */
17489 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17490 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17491 /* The end position of a row equals the start
17492 position of the next row. If CHARPOS is there, we
17493 would rather consider it displayed in the next
17494 line, except when this line ends in ZV. */
17495 && !row_for_charpos_p (row, charpos)))
17496 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17497 {
17498 struct glyph *g;
17499
17500 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17501 || (!best_row && !row->continued_p))
17502 return row;
17503 /* In bidi-reordered rows, there could be several rows whose
17504 edges surround CHARPOS, all of these rows belonging to
17505 the same continued line. We need to find the row which
17506 fits CHARPOS the best. */
17507 for (g = row->glyphs[TEXT_AREA];
17508 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17509 g++)
17510 {
17511 if (!STRINGP (g->object))
17512 {
17513 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17514 {
17515 mindif = eabs (g->charpos - charpos);
17516 best_row = row;
17517 /* Exact match always wins. */
17518 if (mindif == 0)
17519 return best_row;
17520 }
17521 }
17522 }
17523 }
17524 else if (best_row && !row->continued_p)
17525 return best_row;
17526 ++row;
17527 }
17528 }
17529
17530
17531 /* Try to redisplay window W by reusing its existing display. W's
17532 current matrix must be up to date when this function is called,
17533 i.e. window_end_valid must be nonzero.
17534
17535 Value is
17536
17537 >= 1 if successful, i.e. display has been updated
17538 specifically:
17539 1 means the changes were in front of a newline that precedes
17540 the window start, and the whole current matrix was reused
17541 2 means the changes were after the last position displayed
17542 in the window, and the whole current matrix was reused
17543 3 means portions of the current matrix were reused, while
17544 some of the screen lines were redrawn
17545 -1 if redisplay with same window start is known not to succeed
17546 0 if otherwise unsuccessful
17547
17548 The following steps are performed:
17549
17550 1. Find the last row in the current matrix of W that is not
17551 affected by changes at the start of current_buffer. If no such row
17552 is found, give up.
17553
17554 2. Find the first row in W's current matrix that is not affected by
17555 changes at the end of current_buffer. Maybe there is no such row.
17556
17557 3. Display lines beginning with the row + 1 found in step 1 to the
17558 row found in step 2 or, if step 2 didn't find a row, to the end of
17559 the window.
17560
17561 4. If cursor is not known to appear on the window, give up.
17562
17563 5. If display stopped at the row found in step 2, scroll the
17564 display and current matrix as needed.
17565
17566 6. Maybe display some lines at the end of W, if we must. This can
17567 happen under various circumstances, like a partially visible line
17568 becoming fully visible, or because newly displayed lines are displayed
17569 in smaller font sizes.
17570
17571 7. Update W's window end information. */
17572
17573 static int
17574 try_window_id (struct window *w)
17575 {
17576 struct frame *f = XFRAME (w->frame);
17577 struct glyph_matrix *current_matrix = w->current_matrix;
17578 struct glyph_matrix *desired_matrix = w->desired_matrix;
17579 struct glyph_row *last_unchanged_at_beg_row;
17580 struct glyph_row *first_unchanged_at_end_row;
17581 struct glyph_row *row;
17582 struct glyph_row *bottom_row;
17583 int bottom_vpos;
17584 struct it it;
17585 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17586 int dvpos, dy;
17587 struct text_pos start_pos;
17588 struct run run;
17589 int first_unchanged_at_end_vpos = 0;
17590 struct glyph_row *last_text_row, *last_text_row_at_end;
17591 struct text_pos start;
17592 ptrdiff_t first_changed_charpos, last_changed_charpos;
17593
17594 #ifdef GLYPH_DEBUG
17595 if (inhibit_try_window_id)
17596 return 0;
17597 #endif
17598
17599 /* This is handy for debugging. */
17600 #if 0
17601 #define GIVE_UP(X) \
17602 do { \
17603 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17604 return 0; \
17605 } while (0)
17606 #else
17607 #define GIVE_UP(X) return 0
17608 #endif
17609
17610 SET_TEXT_POS_FROM_MARKER (start, w->start);
17611
17612 /* Don't use this for mini-windows because these can show
17613 messages and mini-buffers, and we don't handle that here. */
17614 if (MINI_WINDOW_P (w))
17615 GIVE_UP (1);
17616
17617 /* This flag is used to prevent redisplay optimizations. */
17618 if (windows_or_buffers_changed || f->cursor_type_changed)
17619 GIVE_UP (2);
17620
17621 /* This function's optimizations cannot be used if overlays have
17622 changed in the buffer displayed by the window, so give up if they
17623 have. */
17624 if (w->last_overlay_modified != OVERLAY_MODIFF)
17625 GIVE_UP (21);
17626
17627 /* Verify that narrowing has not changed.
17628 Also verify that we were not told to prevent redisplay optimizations.
17629 It would be nice to further
17630 reduce the number of cases where this prevents try_window_id. */
17631 if (current_buffer->clip_changed
17632 || current_buffer->prevent_redisplay_optimizations_p)
17633 GIVE_UP (3);
17634
17635 /* Window must either use window-based redisplay or be full width. */
17636 if (!FRAME_WINDOW_P (f)
17637 && (!FRAME_LINE_INS_DEL_OK (f)
17638 || !WINDOW_FULL_WIDTH_P (w)))
17639 GIVE_UP (4);
17640
17641 /* Give up if point is known NOT to appear in W. */
17642 if (PT < CHARPOS (start))
17643 GIVE_UP (5);
17644
17645 /* Another way to prevent redisplay optimizations. */
17646 if (w->last_modified == 0)
17647 GIVE_UP (6);
17648
17649 /* Verify that window is not hscrolled. */
17650 if (w->hscroll != 0)
17651 GIVE_UP (7);
17652
17653 /* Verify that display wasn't paused. */
17654 if (!w->window_end_valid)
17655 GIVE_UP (8);
17656
17657 /* Likewise if highlighting trailing whitespace. */
17658 if (!NILP (Vshow_trailing_whitespace))
17659 GIVE_UP (11);
17660
17661 /* Can't use this if overlay arrow position and/or string have
17662 changed. */
17663 if (overlay_arrows_changed_p ())
17664 GIVE_UP (12);
17665
17666 /* When word-wrap is on, adding a space to the first word of a
17667 wrapped line can change the wrap position, altering the line
17668 above it. It might be worthwhile to handle this more
17669 intelligently, but for now just redisplay from scratch. */
17670 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
17671 GIVE_UP (21);
17672
17673 /* Under bidi reordering, adding or deleting a character in the
17674 beginning of a paragraph, before the first strong directional
17675 character, can change the base direction of the paragraph (unless
17676 the buffer specifies a fixed paragraph direction), which will
17677 require to redisplay the whole paragraph. It might be worthwhile
17678 to find the paragraph limits and widen the range of redisplayed
17679 lines to that, but for now just give up this optimization and
17680 redisplay from scratch. */
17681 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17682 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
17683 GIVE_UP (22);
17684
17685 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17686 only if buffer has really changed. The reason is that the gap is
17687 initially at Z for freshly visited files. The code below would
17688 set end_unchanged to 0 in that case. */
17689 if (MODIFF > SAVE_MODIFF
17690 /* This seems to happen sometimes after saving a buffer. */
17691 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17692 {
17693 if (GPT - BEG < BEG_UNCHANGED)
17694 BEG_UNCHANGED = GPT - BEG;
17695 if (Z - GPT < END_UNCHANGED)
17696 END_UNCHANGED = Z - GPT;
17697 }
17698
17699 /* The position of the first and last character that has been changed. */
17700 first_changed_charpos = BEG + BEG_UNCHANGED;
17701 last_changed_charpos = Z - END_UNCHANGED;
17702
17703 /* If window starts after a line end, and the last change is in
17704 front of that newline, then changes don't affect the display.
17705 This case happens with stealth-fontification. Note that although
17706 the display is unchanged, glyph positions in the matrix have to
17707 be adjusted, of course. */
17708 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17709 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17710 && ((last_changed_charpos < CHARPOS (start)
17711 && CHARPOS (start) == BEGV)
17712 || (last_changed_charpos < CHARPOS (start) - 1
17713 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17714 {
17715 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17716 struct glyph_row *r0;
17717
17718 /* Compute how many chars/bytes have been added to or removed
17719 from the buffer. */
17720 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17721 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17722 Z_delta = Z - Z_old;
17723 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
17724
17725 /* Give up if PT is not in the window. Note that it already has
17726 been checked at the start of try_window_id that PT is not in
17727 front of the window start. */
17728 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
17729 GIVE_UP (13);
17730
17731 /* If window start is unchanged, we can reuse the whole matrix
17732 as is, after adjusting glyph positions. No need to compute
17733 the window end again, since its offset from Z hasn't changed. */
17734 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17735 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
17736 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
17737 /* PT must not be in a partially visible line. */
17738 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
17739 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17740 {
17741 /* Adjust positions in the glyph matrix. */
17742 if (Z_delta || Z_delta_bytes)
17743 {
17744 struct glyph_row *r1
17745 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17746 increment_matrix_positions (w->current_matrix,
17747 MATRIX_ROW_VPOS (r0, current_matrix),
17748 MATRIX_ROW_VPOS (r1, current_matrix),
17749 Z_delta, Z_delta_bytes);
17750 }
17751
17752 /* Set the cursor. */
17753 row = row_containing_pos (w, PT, r0, NULL, 0);
17754 if (row)
17755 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17756 return 1;
17757 }
17758 }
17759
17760 /* Handle the case that changes are all below what is displayed in
17761 the window, and that PT is in the window. This shortcut cannot
17762 be taken if ZV is visible in the window, and text has been added
17763 there that is visible in the window. */
17764 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
17765 /* ZV is not visible in the window, or there are no
17766 changes at ZV, actually. */
17767 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
17768 || first_changed_charpos == last_changed_charpos))
17769 {
17770 struct glyph_row *r0;
17771
17772 /* Give up if PT is not in the window. Note that it already has
17773 been checked at the start of try_window_id that PT is not in
17774 front of the window start. */
17775 if (PT >= MATRIX_ROW_END_CHARPOS (row))
17776 GIVE_UP (14);
17777
17778 /* If window start is unchanged, we can reuse the whole matrix
17779 as is, without changing glyph positions since no text has
17780 been added/removed in front of the window end. */
17781 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17782 if (TEXT_POS_EQUAL_P (start, r0->minpos)
17783 /* PT must not be in a partially visible line. */
17784 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
17785 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17786 {
17787 /* We have to compute the window end anew since text
17788 could have been added/removed after it. */
17789 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
17790 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
17791
17792 /* Set the cursor. */
17793 row = row_containing_pos (w, PT, r0, NULL, 0);
17794 if (row)
17795 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17796 return 2;
17797 }
17798 }
17799
17800 /* Give up if window start is in the changed area.
17801
17802 The condition used to read
17803
17804 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17805
17806 but why that was tested escapes me at the moment. */
17807 if (CHARPOS (start) >= first_changed_charpos
17808 && CHARPOS (start) <= last_changed_charpos)
17809 GIVE_UP (15);
17810
17811 /* Check that window start agrees with the start of the first glyph
17812 row in its current matrix. Check this after we know the window
17813 start is not in changed text, otherwise positions would not be
17814 comparable. */
17815 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
17816 if (!TEXT_POS_EQUAL_P (start, row->minpos))
17817 GIVE_UP (16);
17818
17819 /* Give up if the window ends in strings. Overlay strings
17820 at the end are difficult to handle, so don't try. */
17821 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
17822 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
17823 GIVE_UP (20);
17824
17825 /* Compute the position at which we have to start displaying new
17826 lines. Some of the lines at the top of the window might be
17827 reusable because they are not displaying changed text. Find the
17828 last row in W's current matrix not affected by changes at the
17829 start of current_buffer. Value is null if changes start in the
17830 first line of window. */
17831 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
17832 if (last_unchanged_at_beg_row)
17833 {
17834 /* Avoid starting to display in the middle of a character, a TAB
17835 for instance. This is easier than to set up the iterator
17836 exactly, and it's not a frequent case, so the additional
17837 effort wouldn't really pay off. */
17838 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
17839 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
17840 && last_unchanged_at_beg_row > w->current_matrix->rows)
17841 --last_unchanged_at_beg_row;
17842
17843 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
17844 GIVE_UP (17);
17845
17846 if (init_to_row_end (&it, w, last_unchanged_at_beg_row) == 0)
17847 GIVE_UP (18);
17848 start_pos = it.current.pos;
17849
17850 /* Start displaying new lines in the desired matrix at the same
17851 vpos we would use in the current matrix, i.e. below
17852 last_unchanged_at_beg_row. */
17853 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
17854 current_matrix);
17855 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
17856 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
17857
17858 eassert (it.hpos == 0 && it.current_x == 0);
17859 }
17860 else
17861 {
17862 /* There are no reusable lines at the start of the window.
17863 Start displaying in the first text line. */
17864 start_display (&it, w, start);
17865 it.vpos = it.first_vpos;
17866 start_pos = it.current.pos;
17867 }
17868
17869 /* Find the first row that is not affected by changes at the end of
17870 the buffer. Value will be null if there is no unchanged row, in
17871 which case we must redisplay to the end of the window. delta
17872 will be set to the value by which buffer positions beginning with
17873 first_unchanged_at_end_row have to be adjusted due to text
17874 changes. */
17875 first_unchanged_at_end_row
17876 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
17877 IF_DEBUG (debug_delta = delta);
17878 IF_DEBUG (debug_delta_bytes = delta_bytes);
17879
17880 /* Set stop_pos to the buffer position up to which we will have to
17881 display new lines. If first_unchanged_at_end_row != NULL, this
17882 is the buffer position of the start of the line displayed in that
17883 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17884 that we don't stop at a buffer position. */
17885 stop_pos = 0;
17886 if (first_unchanged_at_end_row)
17887 {
17888 eassert (last_unchanged_at_beg_row == NULL
17889 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
17890
17891 /* If this is a continuation line, move forward to the next one
17892 that isn't. Changes in lines above affect this line.
17893 Caution: this may move first_unchanged_at_end_row to a row
17894 not displaying text. */
17895 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
17896 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
17897 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
17898 < it.last_visible_y))
17899 ++first_unchanged_at_end_row;
17900
17901 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
17902 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
17903 >= it.last_visible_y))
17904 first_unchanged_at_end_row = NULL;
17905 else
17906 {
17907 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
17908 + delta);
17909 first_unchanged_at_end_vpos
17910 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
17911 eassert (stop_pos >= Z - END_UNCHANGED);
17912 }
17913 }
17914 else if (last_unchanged_at_beg_row == NULL)
17915 GIVE_UP (19);
17916
17917
17918 #ifdef GLYPH_DEBUG
17919
17920 /* Either there is no unchanged row at the end, or the one we have
17921 now displays text. This is a necessary condition for the window
17922 end pos calculation at the end of this function. */
17923 eassert (first_unchanged_at_end_row == NULL
17924 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
17925
17926 debug_last_unchanged_at_beg_vpos
17927 = (last_unchanged_at_beg_row
17928 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
17929 : -1);
17930 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
17931
17932 #endif /* GLYPH_DEBUG */
17933
17934
17935 /* Display new lines. Set last_text_row to the last new line
17936 displayed which has text on it, i.e. might end up as being the
17937 line where the window_end_vpos is. */
17938 w->cursor.vpos = -1;
17939 last_text_row = NULL;
17940 overlay_arrow_seen = 0;
17941 while (it.current_y < it.last_visible_y
17942 && !f->fonts_changed
17943 && (first_unchanged_at_end_row == NULL
17944 || IT_CHARPOS (it) < stop_pos))
17945 {
17946 if (display_line (&it))
17947 last_text_row = it.glyph_row - 1;
17948 }
17949
17950 if (f->fonts_changed)
17951 return -1;
17952
17953
17954 /* Compute differences in buffer positions, y-positions etc. for
17955 lines reused at the bottom of the window. Compute what we can
17956 scroll. */
17957 if (first_unchanged_at_end_row
17958 /* No lines reused because we displayed everything up to the
17959 bottom of the window. */
17960 && it.current_y < it.last_visible_y)
17961 {
17962 dvpos = (it.vpos
17963 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
17964 current_matrix));
17965 dy = it.current_y - first_unchanged_at_end_row->y;
17966 run.current_y = first_unchanged_at_end_row->y;
17967 run.desired_y = run.current_y + dy;
17968 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
17969 }
17970 else
17971 {
17972 delta = delta_bytes = dvpos = dy
17973 = run.current_y = run.desired_y = run.height = 0;
17974 first_unchanged_at_end_row = NULL;
17975 }
17976 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
17977
17978
17979 /* Find the cursor if not already found. We have to decide whether
17980 PT will appear on this window (it sometimes doesn't, but this is
17981 not a very frequent case.) This decision has to be made before
17982 the current matrix is altered. A value of cursor.vpos < 0 means
17983 that PT is either in one of the lines beginning at
17984 first_unchanged_at_end_row or below the window. Don't care for
17985 lines that might be displayed later at the window end; as
17986 mentioned, this is not a frequent case. */
17987 if (w->cursor.vpos < 0)
17988 {
17989 /* Cursor in unchanged rows at the top? */
17990 if (PT < CHARPOS (start_pos)
17991 && last_unchanged_at_beg_row)
17992 {
17993 row = row_containing_pos (w, PT,
17994 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
17995 last_unchanged_at_beg_row + 1, 0);
17996 if (row)
17997 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
17998 }
17999
18000 /* Start from first_unchanged_at_end_row looking for PT. */
18001 else if (first_unchanged_at_end_row)
18002 {
18003 row = row_containing_pos (w, PT - delta,
18004 first_unchanged_at_end_row, NULL, 0);
18005 if (row)
18006 set_cursor_from_row (w, row, w->current_matrix, delta,
18007 delta_bytes, dy, dvpos);
18008 }
18009
18010 /* Give up if cursor was not found. */
18011 if (w->cursor.vpos < 0)
18012 {
18013 clear_glyph_matrix (w->desired_matrix);
18014 return -1;
18015 }
18016 }
18017
18018 /* Don't let the cursor end in the scroll margins. */
18019 {
18020 int this_scroll_margin, cursor_height;
18021 int frame_line_height = default_line_pixel_height (w);
18022 int window_total_lines
18023 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18024
18025 this_scroll_margin =
18026 max (0, min (scroll_margin, window_total_lines / 4));
18027 this_scroll_margin *= frame_line_height;
18028 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18029
18030 if ((w->cursor.y < this_scroll_margin
18031 && CHARPOS (start) > BEGV)
18032 /* Old redisplay didn't take scroll margin into account at the bottom,
18033 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18034 || (w->cursor.y + (make_cursor_line_fully_visible_p
18035 ? cursor_height + this_scroll_margin
18036 : 1)) > it.last_visible_y)
18037 {
18038 w->cursor.vpos = -1;
18039 clear_glyph_matrix (w->desired_matrix);
18040 return -1;
18041 }
18042 }
18043
18044 /* Scroll the display. Do it before changing the current matrix so
18045 that xterm.c doesn't get confused about where the cursor glyph is
18046 found. */
18047 if (dy && run.height)
18048 {
18049 update_begin (f);
18050
18051 if (FRAME_WINDOW_P (f))
18052 {
18053 FRAME_RIF (f)->update_window_begin_hook (w);
18054 FRAME_RIF (f)->clear_window_mouse_face (w);
18055 FRAME_RIF (f)->scroll_run_hook (w, &run);
18056 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
18057 }
18058 else
18059 {
18060 /* Terminal frame. In this case, dvpos gives the number of
18061 lines to scroll by; dvpos < 0 means scroll up. */
18062 int from_vpos
18063 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18064 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18065 int end = (WINDOW_TOP_EDGE_LINE (w)
18066 + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0)
18067 + window_internal_height (w));
18068
18069 #if defined (HAVE_GPM) || defined (MSDOS)
18070 x_clear_window_mouse_face (w);
18071 #endif
18072 /* Perform the operation on the screen. */
18073 if (dvpos > 0)
18074 {
18075 /* Scroll last_unchanged_at_beg_row to the end of the
18076 window down dvpos lines. */
18077 set_terminal_window (f, end);
18078
18079 /* On dumb terminals delete dvpos lines at the end
18080 before inserting dvpos empty lines. */
18081 if (!FRAME_SCROLL_REGION_OK (f))
18082 ins_del_lines (f, end - dvpos, -dvpos);
18083
18084 /* Insert dvpos empty lines in front of
18085 last_unchanged_at_beg_row. */
18086 ins_del_lines (f, from, dvpos);
18087 }
18088 else if (dvpos < 0)
18089 {
18090 /* Scroll up last_unchanged_at_beg_vpos to the end of
18091 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18092 set_terminal_window (f, end);
18093
18094 /* Delete dvpos lines in front of
18095 last_unchanged_at_beg_vpos. ins_del_lines will set
18096 the cursor to the given vpos and emit |dvpos| delete
18097 line sequences. */
18098 ins_del_lines (f, from + dvpos, dvpos);
18099
18100 /* On a dumb terminal insert dvpos empty lines at the
18101 end. */
18102 if (!FRAME_SCROLL_REGION_OK (f))
18103 ins_del_lines (f, end + dvpos, -dvpos);
18104 }
18105
18106 set_terminal_window (f, 0);
18107 }
18108
18109 update_end (f);
18110 }
18111
18112 /* Shift reused rows of the current matrix to the right position.
18113 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18114 text. */
18115 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18116 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18117 if (dvpos < 0)
18118 {
18119 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18120 bottom_vpos, dvpos);
18121 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18122 bottom_vpos);
18123 }
18124 else if (dvpos > 0)
18125 {
18126 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18127 bottom_vpos, dvpos);
18128 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18129 first_unchanged_at_end_vpos + dvpos);
18130 }
18131
18132 /* For frame-based redisplay, make sure that current frame and window
18133 matrix are in sync with respect to glyph memory. */
18134 if (!FRAME_WINDOW_P (f))
18135 sync_frame_with_window_matrix_rows (w);
18136
18137 /* Adjust buffer positions in reused rows. */
18138 if (delta || delta_bytes)
18139 increment_matrix_positions (current_matrix,
18140 first_unchanged_at_end_vpos + dvpos,
18141 bottom_vpos, delta, delta_bytes);
18142
18143 /* Adjust Y positions. */
18144 if (dy)
18145 shift_glyph_matrix (w, current_matrix,
18146 first_unchanged_at_end_vpos + dvpos,
18147 bottom_vpos, dy);
18148
18149 if (first_unchanged_at_end_row)
18150 {
18151 first_unchanged_at_end_row += dvpos;
18152 if (first_unchanged_at_end_row->y >= it.last_visible_y
18153 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18154 first_unchanged_at_end_row = NULL;
18155 }
18156
18157 /* If scrolling up, there may be some lines to display at the end of
18158 the window. */
18159 last_text_row_at_end = NULL;
18160 if (dy < 0)
18161 {
18162 /* Scrolling up can leave for example a partially visible line
18163 at the end of the window to be redisplayed. */
18164 /* Set last_row to the glyph row in the current matrix where the
18165 window end line is found. It has been moved up or down in
18166 the matrix by dvpos. */
18167 int last_vpos = w->window_end_vpos + dvpos;
18168 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18169
18170 /* If last_row is the window end line, it should display text. */
18171 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18172
18173 /* If window end line was partially visible before, begin
18174 displaying at that line. Otherwise begin displaying with the
18175 line following it. */
18176 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18177 {
18178 init_to_row_start (&it, w, last_row);
18179 it.vpos = last_vpos;
18180 it.current_y = last_row->y;
18181 }
18182 else
18183 {
18184 init_to_row_end (&it, w, last_row);
18185 it.vpos = 1 + last_vpos;
18186 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18187 ++last_row;
18188 }
18189
18190 /* We may start in a continuation line. If so, we have to
18191 get the right continuation_lines_width and current_x. */
18192 it.continuation_lines_width = last_row->continuation_lines_width;
18193 it.hpos = it.current_x = 0;
18194
18195 /* Display the rest of the lines at the window end. */
18196 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18197 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18198 {
18199 /* Is it always sure that the display agrees with lines in
18200 the current matrix? I don't think so, so we mark rows
18201 displayed invalid in the current matrix by setting their
18202 enabled_p flag to zero. */
18203 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18204 if (display_line (&it))
18205 last_text_row_at_end = it.glyph_row - 1;
18206 }
18207 }
18208
18209 /* Update window_end_pos and window_end_vpos. */
18210 if (first_unchanged_at_end_row && !last_text_row_at_end)
18211 {
18212 /* Window end line if one of the preserved rows from the current
18213 matrix. Set row to the last row displaying text in current
18214 matrix starting at first_unchanged_at_end_row, after
18215 scrolling. */
18216 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18217 row = find_last_row_displaying_text (w->current_matrix, &it,
18218 first_unchanged_at_end_row);
18219 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18220 adjust_window_ends (w, row, 1);
18221 eassert (w->window_end_bytepos >= 0);
18222 IF_DEBUG (debug_method_add (w, "A"));
18223 }
18224 else if (last_text_row_at_end)
18225 {
18226 adjust_window_ends (w, last_text_row_at_end, 0);
18227 eassert (w->window_end_bytepos >= 0);
18228 IF_DEBUG (debug_method_add (w, "B"));
18229 }
18230 else if (last_text_row)
18231 {
18232 /* We have displayed either to the end of the window or at the
18233 end of the window, i.e. the last row with text is to be found
18234 in the desired matrix. */
18235 adjust_window_ends (w, last_text_row, 0);
18236 eassert (w->window_end_bytepos >= 0);
18237 }
18238 else if (first_unchanged_at_end_row == NULL
18239 && last_text_row == NULL
18240 && last_text_row_at_end == NULL)
18241 {
18242 /* Displayed to end of window, but no line containing text was
18243 displayed. Lines were deleted at the end of the window. */
18244 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
18245 int vpos = w->window_end_vpos;
18246 struct glyph_row *current_row = current_matrix->rows + vpos;
18247 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18248
18249 for (row = NULL;
18250 row == NULL && vpos >= first_vpos;
18251 --vpos, --current_row, --desired_row)
18252 {
18253 if (desired_row->enabled_p)
18254 {
18255 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18256 row = desired_row;
18257 }
18258 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18259 row = current_row;
18260 }
18261
18262 eassert (row != NULL);
18263 w->window_end_vpos = vpos + 1;
18264 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18265 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18266 eassert (w->window_end_bytepos >= 0);
18267 IF_DEBUG (debug_method_add (w, "C"));
18268 }
18269 else
18270 emacs_abort ();
18271
18272 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18273 debug_end_vpos = w->window_end_vpos));
18274
18275 /* Record that display has not been completed. */
18276 w->window_end_valid = 0;
18277 w->desired_matrix->no_scrolling_p = 1;
18278 return 3;
18279
18280 #undef GIVE_UP
18281 }
18282
18283
18284 \f
18285 /***********************************************************************
18286 More debugging support
18287 ***********************************************************************/
18288
18289 #ifdef GLYPH_DEBUG
18290
18291 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18292 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18293 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18294
18295
18296 /* Dump the contents of glyph matrix MATRIX on stderr.
18297
18298 GLYPHS 0 means don't show glyph contents.
18299 GLYPHS 1 means show glyphs in short form
18300 GLYPHS > 1 means show glyphs in long form. */
18301
18302 void
18303 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18304 {
18305 int i;
18306 for (i = 0; i < matrix->nrows; ++i)
18307 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18308 }
18309
18310
18311 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18312 the glyph row and area where the glyph comes from. */
18313
18314 void
18315 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18316 {
18317 if (glyph->type == CHAR_GLYPH
18318 || glyph->type == GLYPHLESS_GLYPH)
18319 {
18320 fprintf (stderr,
18321 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18322 glyph - row->glyphs[TEXT_AREA],
18323 (glyph->type == CHAR_GLYPH
18324 ? 'C'
18325 : 'G'),
18326 glyph->charpos,
18327 (BUFFERP (glyph->object)
18328 ? 'B'
18329 : (STRINGP (glyph->object)
18330 ? 'S'
18331 : (INTEGERP (glyph->object)
18332 ? '0'
18333 : '-'))),
18334 glyph->pixel_width,
18335 glyph->u.ch,
18336 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18337 ? glyph->u.ch
18338 : '.'),
18339 glyph->face_id,
18340 glyph->left_box_line_p,
18341 glyph->right_box_line_p);
18342 }
18343 else if (glyph->type == STRETCH_GLYPH)
18344 {
18345 fprintf (stderr,
18346 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18347 glyph - row->glyphs[TEXT_AREA],
18348 'S',
18349 glyph->charpos,
18350 (BUFFERP (glyph->object)
18351 ? 'B'
18352 : (STRINGP (glyph->object)
18353 ? 'S'
18354 : (INTEGERP (glyph->object)
18355 ? '0'
18356 : '-'))),
18357 glyph->pixel_width,
18358 0,
18359 ' ',
18360 glyph->face_id,
18361 glyph->left_box_line_p,
18362 glyph->right_box_line_p);
18363 }
18364 else if (glyph->type == IMAGE_GLYPH)
18365 {
18366 fprintf (stderr,
18367 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18368 glyph - row->glyphs[TEXT_AREA],
18369 'I',
18370 glyph->charpos,
18371 (BUFFERP (glyph->object)
18372 ? 'B'
18373 : (STRINGP (glyph->object)
18374 ? 'S'
18375 : (INTEGERP (glyph->object)
18376 ? '0'
18377 : '-'))),
18378 glyph->pixel_width,
18379 glyph->u.img_id,
18380 '.',
18381 glyph->face_id,
18382 glyph->left_box_line_p,
18383 glyph->right_box_line_p);
18384 }
18385 else if (glyph->type == COMPOSITE_GLYPH)
18386 {
18387 fprintf (stderr,
18388 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18389 glyph - row->glyphs[TEXT_AREA],
18390 '+',
18391 glyph->charpos,
18392 (BUFFERP (glyph->object)
18393 ? 'B'
18394 : (STRINGP (glyph->object)
18395 ? 'S'
18396 : (INTEGERP (glyph->object)
18397 ? '0'
18398 : '-'))),
18399 glyph->pixel_width,
18400 glyph->u.cmp.id);
18401 if (glyph->u.cmp.automatic)
18402 fprintf (stderr,
18403 "[%d-%d]",
18404 glyph->slice.cmp.from, glyph->slice.cmp.to);
18405 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18406 glyph->face_id,
18407 glyph->left_box_line_p,
18408 glyph->right_box_line_p);
18409 }
18410 }
18411
18412
18413 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18414 GLYPHS 0 means don't show glyph contents.
18415 GLYPHS 1 means show glyphs in short form
18416 GLYPHS > 1 means show glyphs in long form. */
18417
18418 void
18419 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18420 {
18421 if (glyphs != 1)
18422 {
18423 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18424 fprintf (stderr, "==============================================================================\n");
18425
18426 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18427 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18428 vpos,
18429 MATRIX_ROW_START_CHARPOS (row),
18430 MATRIX_ROW_END_CHARPOS (row),
18431 row->used[TEXT_AREA],
18432 row->contains_overlapping_glyphs_p,
18433 row->enabled_p,
18434 row->truncated_on_left_p,
18435 row->truncated_on_right_p,
18436 row->continued_p,
18437 MATRIX_ROW_CONTINUATION_LINE_P (row),
18438 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18439 row->ends_at_zv_p,
18440 row->fill_line_p,
18441 row->ends_in_middle_of_char_p,
18442 row->starts_in_middle_of_char_p,
18443 row->mouse_face_p,
18444 row->x,
18445 row->y,
18446 row->pixel_width,
18447 row->height,
18448 row->visible_height,
18449 row->ascent,
18450 row->phys_ascent);
18451 /* The next 3 lines should align to "Start" in the header. */
18452 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18453 row->end.overlay_string_index,
18454 row->continuation_lines_width);
18455 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18456 CHARPOS (row->start.string_pos),
18457 CHARPOS (row->end.string_pos));
18458 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18459 row->end.dpvec_index);
18460 }
18461
18462 if (glyphs > 1)
18463 {
18464 int area;
18465
18466 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18467 {
18468 struct glyph *glyph = row->glyphs[area];
18469 struct glyph *glyph_end = glyph + row->used[area];
18470
18471 /* Glyph for a line end in text. */
18472 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18473 ++glyph_end;
18474
18475 if (glyph < glyph_end)
18476 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
18477
18478 for (; glyph < glyph_end; ++glyph)
18479 dump_glyph (row, glyph, area);
18480 }
18481 }
18482 else if (glyphs == 1)
18483 {
18484 int area;
18485
18486 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18487 {
18488 char *s = alloca (row->used[area] + 4);
18489 int i;
18490
18491 for (i = 0; i < row->used[area]; ++i)
18492 {
18493 struct glyph *glyph = row->glyphs[area] + i;
18494 if (i == row->used[area] - 1
18495 && area == TEXT_AREA
18496 && INTEGERP (glyph->object)
18497 && glyph->type == CHAR_GLYPH
18498 && glyph->u.ch == ' ')
18499 {
18500 strcpy (&s[i], "[\\n]");
18501 i += 4;
18502 }
18503 else if (glyph->type == CHAR_GLYPH
18504 && glyph->u.ch < 0x80
18505 && glyph->u.ch >= ' ')
18506 s[i] = glyph->u.ch;
18507 else
18508 s[i] = '.';
18509 }
18510
18511 s[i] = '\0';
18512 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18513 }
18514 }
18515 }
18516
18517
18518 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18519 Sdump_glyph_matrix, 0, 1, "p",
18520 doc: /* Dump the current matrix of the selected window to stderr.
18521 Shows contents of glyph row structures. With non-nil
18522 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18523 glyphs in short form, otherwise show glyphs in long form. */)
18524 (Lisp_Object glyphs)
18525 {
18526 struct window *w = XWINDOW (selected_window);
18527 struct buffer *buffer = XBUFFER (w->contents);
18528
18529 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18530 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18531 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18532 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18533 fprintf (stderr, "=============================================\n");
18534 dump_glyph_matrix (w->current_matrix,
18535 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18536 return Qnil;
18537 }
18538
18539
18540 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18541 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* */)
18542 (void)
18543 {
18544 struct frame *f = XFRAME (selected_frame);
18545 dump_glyph_matrix (f->current_matrix, 1);
18546 return Qnil;
18547 }
18548
18549
18550 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18551 doc: /* Dump glyph row ROW to stderr.
18552 GLYPH 0 means don't dump glyphs.
18553 GLYPH 1 means dump glyphs in short form.
18554 GLYPH > 1 or omitted means dump glyphs in long form. */)
18555 (Lisp_Object row, Lisp_Object glyphs)
18556 {
18557 struct glyph_matrix *matrix;
18558 EMACS_INT vpos;
18559
18560 CHECK_NUMBER (row);
18561 matrix = XWINDOW (selected_window)->current_matrix;
18562 vpos = XINT (row);
18563 if (vpos >= 0 && vpos < matrix->nrows)
18564 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18565 vpos,
18566 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18567 return Qnil;
18568 }
18569
18570
18571 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18572 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18573 GLYPH 0 means don't dump glyphs.
18574 GLYPH 1 means dump glyphs in short form.
18575 GLYPH > 1 or omitted means dump glyphs in long form.
18576
18577 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18578 do nothing. */)
18579 (Lisp_Object row, Lisp_Object glyphs)
18580 {
18581 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18582 struct frame *sf = SELECTED_FRAME ();
18583 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18584 EMACS_INT vpos;
18585
18586 CHECK_NUMBER (row);
18587 vpos = XINT (row);
18588 if (vpos >= 0 && vpos < m->nrows)
18589 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18590 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18591 #endif
18592 return Qnil;
18593 }
18594
18595
18596 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18597 doc: /* Toggle tracing of redisplay.
18598 With ARG, turn tracing on if and only if ARG is positive. */)
18599 (Lisp_Object arg)
18600 {
18601 if (NILP (arg))
18602 trace_redisplay_p = !trace_redisplay_p;
18603 else
18604 {
18605 arg = Fprefix_numeric_value (arg);
18606 trace_redisplay_p = XINT (arg) > 0;
18607 }
18608
18609 return Qnil;
18610 }
18611
18612
18613 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18614 doc: /* Like `format', but print result to stderr.
18615 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18616 (ptrdiff_t nargs, Lisp_Object *args)
18617 {
18618 Lisp_Object s = Fformat (nargs, args);
18619 fprintf (stderr, "%s", SDATA (s));
18620 return Qnil;
18621 }
18622
18623 #endif /* GLYPH_DEBUG */
18624
18625
18626 \f
18627 /***********************************************************************
18628 Building Desired Matrix Rows
18629 ***********************************************************************/
18630
18631 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18632 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18633
18634 static struct glyph_row *
18635 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18636 {
18637 struct frame *f = XFRAME (WINDOW_FRAME (w));
18638 struct buffer *buffer = XBUFFER (w->contents);
18639 struct buffer *old = current_buffer;
18640 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18641 int arrow_len = SCHARS (overlay_arrow_string);
18642 const unsigned char *arrow_end = arrow_string + arrow_len;
18643 const unsigned char *p;
18644 struct it it;
18645 bool multibyte_p;
18646 int n_glyphs_before;
18647
18648 set_buffer_temp (buffer);
18649 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18650 it.glyph_row->used[TEXT_AREA] = 0;
18651 SET_TEXT_POS (it.position, 0, 0);
18652
18653 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18654 p = arrow_string;
18655 while (p < arrow_end)
18656 {
18657 Lisp_Object face, ilisp;
18658
18659 /* Get the next character. */
18660 if (multibyte_p)
18661 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18662 else
18663 {
18664 it.c = it.char_to_display = *p, it.len = 1;
18665 if (! ASCII_CHAR_P (it.c))
18666 it.char_to_display = BYTE8_TO_CHAR (it.c);
18667 }
18668 p += it.len;
18669
18670 /* Get its face. */
18671 ilisp = make_number (p - arrow_string);
18672 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18673 it.face_id = compute_char_face (f, it.char_to_display, face);
18674
18675 /* Compute its width, get its glyphs. */
18676 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18677 SET_TEXT_POS (it.position, -1, -1);
18678 PRODUCE_GLYPHS (&it);
18679
18680 /* If this character doesn't fit any more in the line, we have
18681 to remove some glyphs. */
18682 if (it.current_x > it.last_visible_x)
18683 {
18684 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18685 break;
18686 }
18687 }
18688
18689 set_buffer_temp (old);
18690 return it.glyph_row;
18691 }
18692
18693
18694 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18695 glyphs to insert is determined by produce_special_glyphs. */
18696
18697 static void
18698 insert_left_trunc_glyphs (struct it *it)
18699 {
18700 struct it truncate_it;
18701 struct glyph *from, *end, *to, *toend;
18702
18703 eassert (!FRAME_WINDOW_P (it->f)
18704 || (!it->glyph_row->reversed_p
18705 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18706 || (it->glyph_row->reversed_p
18707 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
18708
18709 /* Get the truncation glyphs. */
18710 truncate_it = *it;
18711 truncate_it.current_x = 0;
18712 truncate_it.face_id = DEFAULT_FACE_ID;
18713 truncate_it.glyph_row = &scratch_glyph_row;
18714 truncate_it.area = TEXT_AREA;
18715 truncate_it.glyph_row->used[TEXT_AREA] = 0;
18716 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
18717 truncate_it.object = make_number (0);
18718 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
18719
18720 /* Overwrite glyphs from IT with truncation glyphs. */
18721 if (!it->glyph_row->reversed_p)
18722 {
18723 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18724
18725 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18726 end = from + tused;
18727 to = it->glyph_row->glyphs[TEXT_AREA];
18728 toend = to + it->glyph_row->used[TEXT_AREA];
18729 if (FRAME_WINDOW_P (it->f))
18730 {
18731 /* On GUI frames, when variable-size fonts are displayed,
18732 the truncation glyphs may need more pixels than the row's
18733 glyphs they overwrite. We overwrite more glyphs to free
18734 enough screen real estate, and enlarge the stretch glyph
18735 on the right (see display_line), if there is one, to
18736 preserve the screen position of the truncation glyphs on
18737 the right. */
18738 int w = 0;
18739 struct glyph *g = to;
18740 short used;
18741
18742 /* The first glyph could be partially visible, in which case
18743 it->glyph_row->x will be negative. But we want the left
18744 truncation glyphs to be aligned at the left margin of the
18745 window, so we override the x coordinate at which the row
18746 will begin. */
18747 it->glyph_row->x = 0;
18748 while (g < toend && w < it->truncation_pixel_width)
18749 {
18750 w += g->pixel_width;
18751 ++g;
18752 }
18753 if (g - to - tused > 0)
18754 {
18755 memmove (to + tused, g, (toend - g) * sizeof(*g));
18756 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
18757 }
18758 used = it->glyph_row->used[TEXT_AREA];
18759 if (it->glyph_row->truncated_on_right_p
18760 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
18761 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
18762 == STRETCH_GLYPH)
18763 {
18764 int extra = w - it->truncation_pixel_width;
18765
18766 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
18767 }
18768 }
18769
18770 while (from < end)
18771 *to++ = *from++;
18772
18773 /* There may be padding glyphs left over. Overwrite them too. */
18774 if (!FRAME_WINDOW_P (it->f))
18775 {
18776 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
18777 {
18778 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18779 while (from < end)
18780 *to++ = *from++;
18781 }
18782 }
18783
18784 if (to > toend)
18785 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
18786 }
18787 else
18788 {
18789 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18790
18791 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18792 that back to front. */
18793 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
18794 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
18795 toend = it->glyph_row->glyphs[TEXT_AREA];
18796 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
18797 if (FRAME_WINDOW_P (it->f))
18798 {
18799 int w = 0;
18800 struct glyph *g = to;
18801
18802 while (g >= toend && w < it->truncation_pixel_width)
18803 {
18804 w += g->pixel_width;
18805 --g;
18806 }
18807 if (to - g - tused > 0)
18808 to = g + tused;
18809 if (it->glyph_row->truncated_on_right_p
18810 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
18811 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
18812 {
18813 int extra = w - it->truncation_pixel_width;
18814
18815 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
18816 }
18817 }
18818
18819 while (from >= end && to >= toend)
18820 *to-- = *from--;
18821 if (!FRAME_WINDOW_P (it->f))
18822 {
18823 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
18824 {
18825 from =
18826 truncate_it.glyph_row->glyphs[TEXT_AREA]
18827 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
18828 while (from >= end && to >= toend)
18829 *to-- = *from--;
18830 }
18831 }
18832 if (from >= end)
18833 {
18834 /* Need to free some room before prepending additional
18835 glyphs. */
18836 int move_by = from - end + 1;
18837 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
18838 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
18839
18840 for ( ; g >= g0; g--)
18841 g[move_by] = *g;
18842 while (from >= end)
18843 *to-- = *from--;
18844 it->glyph_row->used[TEXT_AREA] += move_by;
18845 }
18846 }
18847 }
18848
18849 /* Compute the hash code for ROW. */
18850 unsigned
18851 row_hash (struct glyph_row *row)
18852 {
18853 int area, k;
18854 unsigned hashval = 0;
18855
18856 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18857 for (k = 0; k < row->used[area]; ++k)
18858 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
18859 + row->glyphs[area][k].u.val
18860 + row->glyphs[area][k].face_id
18861 + row->glyphs[area][k].padding_p
18862 + (row->glyphs[area][k].type << 2));
18863
18864 return hashval;
18865 }
18866
18867 /* Compute the pixel height and width of IT->glyph_row.
18868
18869 Most of the time, ascent and height of a display line will be equal
18870 to the max_ascent and max_height values of the display iterator
18871 structure. This is not the case if
18872
18873 1. We hit ZV without displaying anything. In this case, max_ascent
18874 and max_height will be zero.
18875
18876 2. We have some glyphs that don't contribute to the line height.
18877 (The glyph row flag contributes_to_line_height_p is for future
18878 pixmap extensions).
18879
18880 The first case is easily covered by using default values because in
18881 these cases, the line height does not really matter, except that it
18882 must not be zero. */
18883
18884 static void
18885 compute_line_metrics (struct it *it)
18886 {
18887 struct glyph_row *row = it->glyph_row;
18888
18889 if (FRAME_WINDOW_P (it->f))
18890 {
18891 int i, min_y, max_y;
18892
18893 /* The line may consist of one space only, that was added to
18894 place the cursor on it. If so, the row's height hasn't been
18895 computed yet. */
18896 if (row->height == 0)
18897 {
18898 if (it->max_ascent + it->max_descent == 0)
18899 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
18900 row->ascent = it->max_ascent;
18901 row->height = it->max_ascent + it->max_descent;
18902 row->phys_ascent = it->max_phys_ascent;
18903 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
18904 row->extra_line_spacing = it->max_extra_line_spacing;
18905 }
18906
18907 /* Compute the width of this line. */
18908 row->pixel_width = row->x;
18909 for (i = 0; i < row->used[TEXT_AREA]; ++i)
18910 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
18911
18912 eassert (row->pixel_width >= 0);
18913 eassert (row->ascent >= 0 && row->height > 0);
18914
18915 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
18916 || MATRIX_ROW_OVERLAPS_PRED_P (row));
18917
18918 /* If first line's physical ascent is larger than its logical
18919 ascent, use the physical ascent, and make the row taller.
18920 This makes accented characters fully visible. */
18921 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
18922 && row->phys_ascent > row->ascent)
18923 {
18924 row->height += row->phys_ascent - row->ascent;
18925 row->ascent = row->phys_ascent;
18926 }
18927
18928 /* Compute how much of the line is visible. */
18929 row->visible_height = row->height;
18930
18931 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
18932 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
18933
18934 if (row->y < min_y)
18935 row->visible_height -= min_y - row->y;
18936 if (row->y + row->height > max_y)
18937 row->visible_height -= row->y + row->height - max_y;
18938 }
18939 else
18940 {
18941 row->pixel_width = row->used[TEXT_AREA];
18942 if (row->continued_p)
18943 row->pixel_width -= it->continuation_pixel_width;
18944 else if (row->truncated_on_right_p)
18945 row->pixel_width -= it->truncation_pixel_width;
18946 row->ascent = row->phys_ascent = 0;
18947 row->height = row->phys_height = row->visible_height = 1;
18948 row->extra_line_spacing = 0;
18949 }
18950
18951 /* Compute a hash code for this row. */
18952 row->hash = row_hash (row);
18953
18954 it->max_ascent = it->max_descent = 0;
18955 it->max_phys_ascent = it->max_phys_descent = 0;
18956 }
18957
18958
18959 /* Append one space to the glyph row of iterator IT if doing a
18960 window-based redisplay. The space has the same face as
18961 IT->face_id. Value is non-zero if a space was added.
18962
18963 This function is called to make sure that there is always one glyph
18964 at the end of a glyph row that the cursor can be set on under
18965 window-systems. (If there weren't such a glyph we would not know
18966 how wide and tall a box cursor should be displayed).
18967
18968 At the same time this space let's a nicely handle clearing to the
18969 end of the line if the row ends in italic text. */
18970
18971 static int
18972 append_space_for_newline (struct it *it, int default_face_p)
18973 {
18974 if (FRAME_WINDOW_P (it->f))
18975 {
18976 int n = it->glyph_row->used[TEXT_AREA];
18977
18978 if (it->glyph_row->glyphs[TEXT_AREA] + n
18979 < it->glyph_row->glyphs[1 + TEXT_AREA])
18980 {
18981 /* Save some values that must not be changed.
18982 Must save IT->c and IT->len because otherwise
18983 ITERATOR_AT_END_P wouldn't work anymore after
18984 append_space_for_newline has been called. */
18985 enum display_element_type saved_what = it->what;
18986 int saved_c = it->c, saved_len = it->len;
18987 int saved_char_to_display = it->char_to_display;
18988 int saved_x = it->current_x;
18989 int saved_face_id = it->face_id;
18990 int saved_box_end = it->end_of_box_run_p;
18991 struct text_pos saved_pos;
18992 Lisp_Object saved_object;
18993 struct face *face;
18994
18995 saved_object = it->object;
18996 saved_pos = it->position;
18997
18998 it->what = IT_CHARACTER;
18999 memset (&it->position, 0, sizeof it->position);
19000 it->object = make_number (0);
19001 it->c = it->char_to_display = ' ';
19002 it->len = 1;
19003
19004 /* If the default face was remapped, be sure to use the
19005 remapped face for the appended newline. */
19006 if (default_face_p)
19007 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19008 else if (it->face_before_selective_p)
19009 it->face_id = it->saved_face_id;
19010 face = FACE_FROM_ID (it->f, it->face_id);
19011 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19012 /* In R2L rows, we will prepend a stretch glyph that will
19013 have the end_of_box_run_p flag set for it, so there's no
19014 need for the appended newline glyph to have that flag
19015 set. */
19016 if (it->glyph_row->reversed_p
19017 /* But if the appended newline glyph goes all the way to
19018 the end of the row, there will be no stretch glyph,
19019 so leave the box flag set. */
19020 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19021 it->end_of_box_run_p = 0;
19022
19023 PRODUCE_GLYPHS (it);
19024
19025 it->override_ascent = -1;
19026 it->constrain_row_ascent_descent_p = 0;
19027 it->current_x = saved_x;
19028 it->object = saved_object;
19029 it->position = saved_pos;
19030 it->what = saved_what;
19031 it->face_id = saved_face_id;
19032 it->len = saved_len;
19033 it->c = saved_c;
19034 it->char_to_display = saved_char_to_display;
19035 it->end_of_box_run_p = saved_box_end;
19036 return 1;
19037 }
19038 }
19039
19040 return 0;
19041 }
19042
19043
19044 /* Extend the face of the last glyph in the text area of IT->glyph_row
19045 to the end of the display line. Called from display_line. If the
19046 glyph row is empty, add a space glyph to it so that we know the
19047 face to draw. Set the glyph row flag fill_line_p. If the glyph
19048 row is R2L, prepend a stretch glyph to cover the empty space to the
19049 left of the leftmost glyph. */
19050
19051 static void
19052 extend_face_to_end_of_line (struct it *it)
19053 {
19054 struct face *face, *default_face;
19055 struct frame *f = it->f;
19056
19057 /* If line is already filled, do nothing. Non window-system frames
19058 get a grace of one more ``pixel'' because their characters are
19059 1-``pixel'' wide, so they hit the equality too early. This grace
19060 is needed only for R2L rows that are not continued, to produce
19061 one extra blank where we could display the cursor. */
19062 if ((it->current_x >= it->last_visible_x
19063 + (!FRAME_WINDOW_P (f)
19064 && it->glyph_row->reversed_p
19065 && !it->glyph_row->continued_p))
19066 /* If the window has display margins, we will need to extend
19067 their face even if the text area is filled. */
19068 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19069 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19070 return;
19071
19072 /* The default face, possibly remapped. */
19073 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
19074
19075 /* Face extension extends the background and box of IT->face_id
19076 to the end of the line. If the background equals the background
19077 of the frame, we don't have to do anything. */
19078 if (it->face_before_selective_p)
19079 face = FACE_FROM_ID (f, it->saved_face_id);
19080 else
19081 face = FACE_FROM_ID (f, it->face_id);
19082
19083 if (FRAME_WINDOW_P (f)
19084 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19085 && face->box == FACE_NO_BOX
19086 && face->background == FRAME_BACKGROUND_PIXEL (f)
19087 #ifdef HAVE_WINDOW_SYSTEM
19088 && !face->stipple
19089 #endif
19090 && !it->glyph_row->reversed_p)
19091 return;
19092
19093 /* Set the glyph row flag indicating that the face of the last glyph
19094 in the text area has to be drawn to the end of the text area. */
19095 it->glyph_row->fill_line_p = 1;
19096
19097 /* If current character of IT is not ASCII, make sure we have the
19098 ASCII face. This will be automatically undone the next time
19099 get_next_display_element returns a multibyte character. Note
19100 that the character will always be single byte in unibyte
19101 text. */
19102 if (!ASCII_CHAR_P (it->c))
19103 {
19104 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19105 }
19106
19107 if (FRAME_WINDOW_P (f))
19108 {
19109 /* If the row is empty, add a space with the current face of IT,
19110 so that we know which face to draw. */
19111 if (it->glyph_row->used[TEXT_AREA] == 0)
19112 {
19113 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19114 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19115 it->glyph_row->used[TEXT_AREA] = 1;
19116 }
19117 /* Mode line and the header line don't have margins, and
19118 likewise the frame's tool-bar window, if there is any. */
19119 if (!(it->glyph_row->mode_line_p
19120 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19121 || (WINDOWP (f->tool_bar_window)
19122 && it->w == XWINDOW (f->tool_bar_window))
19123 #endif
19124 ))
19125 {
19126 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19127 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19128 {
19129 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19130 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19131 default_face->id;
19132 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19133 }
19134 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19135 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19136 {
19137 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19138 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19139 default_face->id;
19140 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19141 }
19142 }
19143 #ifdef HAVE_WINDOW_SYSTEM
19144 if (it->glyph_row->reversed_p)
19145 {
19146 /* Prepend a stretch glyph to the row, such that the
19147 rightmost glyph will be drawn flushed all the way to the
19148 right margin of the window. The stretch glyph that will
19149 occupy the empty space, if any, to the left of the
19150 glyphs. */
19151 struct font *font = face->font ? face->font : FRAME_FONT (f);
19152 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19153 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19154 struct glyph *g;
19155 int row_width, stretch_ascent, stretch_width;
19156 struct text_pos saved_pos;
19157 int saved_face_id, saved_avoid_cursor, saved_box_start;
19158
19159 for (row_width = 0, g = row_start; g < row_end; g++)
19160 row_width += g->pixel_width;
19161 stretch_width = window_box_width (it->w, TEXT_AREA) - row_width;
19162 if (stretch_width > 0)
19163 {
19164 stretch_ascent =
19165 (((it->ascent + it->descent)
19166 * FONT_BASE (font)) / FONT_HEIGHT (font));
19167 saved_pos = it->position;
19168 memset (&it->position, 0, sizeof it->position);
19169 saved_avoid_cursor = it->avoid_cursor_p;
19170 it->avoid_cursor_p = 1;
19171 saved_face_id = it->face_id;
19172 saved_box_start = it->start_of_box_run_p;
19173 /* The last row's stretch glyph should get the default
19174 face, to avoid painting the rest of the window with
19175 the region face, if the region ends at ZV. */
19176 if (it->glyph_row->ends_at_zv_p)
19177 it->face_id = default_face->id;
19178 else
19179 it->face_id = face->id;
19180 it->start_of_box_run_p = 0;
19181 append_stretch_glyph (it, make_number (0), stretch_width,
19182 it->ascent + it->descent, stretch_ascent);
19183 it->position = saved_pos;
19184 it->avoid_cursor_p = saved_avoid_cursor;
19185 it->face_id = saved_face_id;
19186 it->start_of_box_run_p = saved_box_start;
19187 }
19188 }
19189 #endif /* HAVE_WINDOW_SYSTEM */
19190 }
19191 else
19192 {
19193 /* Save some values that must not be changed. */
19194 int saved_x = it->current_x;
19195 struct text_pos saved_pos;
19196 Lisp_Object saved_object;
19197 enum display_element_type saved_what = it->what;
19198 int saved_face_id = it->face_id;
19199
19200 saved_object = it->object;
19201 saved_pos = it->position;
19202
19203 it->what = IT_CHARACTER;
19204 memset (&it->position, 0, sizeof it->position);
19205 it->object = make_number (0);
19206 it->c = it->char_to_display = ' ';
19207 it->len = 1;
19208
19209 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19210 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19211 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19212 && !it->glyph_row->mode_line_p
19213 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19214 {
19215 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19216 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19217
19218 for (it->current_x = 0; g < e; g++)
19219 it->current_x += g->pixel_width;
19220
19221 it->area = LEFT_MARGIN_AREA;
19222 it->face_id = default_face->id;
19223 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19224 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19225 {
19226 PRODUCE_GLYPHS (it);
19227 /* term.c:produce_glyphs advances it->current_x only for
19228 TEXT_AREA. */
19229 it->current_x += it->pixel_width;
19230 }
19231
19232 it->current_x = saved_x;
19233 it->area = TEXT_AREA;
19234 }
19235
19236 /* The last row's blank glyphs should get the default face, to
19237 avoid painting the rest of the window with the region face,
19238 if the region ends at ZV. */
19239 if (it->glyph_row->ends_at_zv_p)
19240 it->face_id = default_face->id;
19241 else
19242 it->face_id = face->id;
19243 PRODUCE_GLYPHS (it);
19244
19245 while (it->current_x <= it->last_visible_x)
19246 PRODUCE_GLYPHS (it);
19247
19248 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19249 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19250 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19251 && !it->glyph_row->mode_line_p
19252 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19253 {
19254 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19255 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19256
19257 for ( ; g < e; g++)
19258 it->current_x += g->pixel_width;
19259
19260 it->area = RIGHT_MARGIN_AREA;
19261 it->face_id = default_face->id;
19262 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19263 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19264 {
19265 PRODUCE_GLYPHS (it);
19266 it->current_x += it->pixel_width;
19267 }
19268
19269 it->area = TEXT_AREA;
19270 }
19271
19272 /* Don't count these blanks really. It would let us insert a left
19273 truncation glyph below and make us set the cursor on them, maybe. */
19274 it->current_x = saved_x;
19275 it->object = saved_object;
19276 it->position = saved_pos;
19277 it->what = saved_what;
19278 it->face_id = saved_face_id;
19279 }
19280 }
19281
19282
19283 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19284 trailing whitespace. */
19285
19286 static int
19287 trailing_whitespace_p (ptrdiff_t charpos)
19288 {
19289 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19290 int c = 0;
19291
19292 while (bytepos < ZV_BYTE
19293 && (c = FETCH_CHAR (bytepos),
19294 c == ' ' || c == '\t'))
19295 ++bytepos;
19296
19297 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19298 {
19299 if (bytepos != PT_BYTE)
19300 return 1;
19301 }
19302 return 0;
19303 }
19304
19305
19306 /* Highlight trailing whitespace, if any, in ROW. */
19307
19308 static void
19309 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19310 {
19311 int used = row->used[TEXT_AREA];
19312
19313 if (used)
19314 {
19315 struct glyph *start = row->glyphs[TEXT_AREA];
19316 struct glyph *glyph = start + used - 1;
19317
19318 if (row->reversed_p)
19319 {
19320 /* Right-to-left rows need to be processed in the opposite
19321 direction, so swap the edge pointers. */
19322 glyph = start;
19323 start = row->glyphs[TEXT_AREA] + used - 1;
19324 }
19325
19326 /* Skip over glyphs inserted to display the cursor at the
19327 end of a line, for extending the face of the last glyph
19328 to the end of the line on terminals, and for truncation
19329 and continuation glyphs. */
19330 if (!row->reversed_p)
19331 {
19332 while (glyph >= start
19333 && glyph->type == CHAR_GLYPH
19334 && INTEGERP (glyph->object))
19335 --glyph;
19336 }
19337 else
19338 {
19339 while (glyph <= start
19340 && glyph->type == CHAR_GLYPH
19341 && INTEGERP (glyph->object))
19342 ++glyph;
19343 }
19344
19345 /* If last glyph is a space or stretch, and it's trailing
19346 whitespace, set the face of all trailing whitespace glyphs in
19347 IT->glyph_row to `trailing-whitespace'. */
19348 if ((row->reversed_p ? glyph <= start : glyph >= start)
19349 && BUFFERP (glyph->object)
19350 && (glyph->type == STRETCH_GLYPH
19351 || (glyph->type == CHAR_GLYPH
19352 && glyph->u.ch == ' '))
19353 && trailing_whitespace_p (glyph->charpos))
19354 {
19355 int face_id = lookup_named_face (f, Qtrailing_whitespace, 0);
19356 if (face_id < 0)
19357 return;
19358
19359 if (!row->reversed_p)
19360 {
19361 while (glyph >= start
19362 && BUFFERP (glyph->object)
19363 && (glyph->type == STRETCH_GLYPH
19364 || (glyph->type == CHAR_GLYPH
19365 && glyph->u.ch == ' ')))
19366 (glyph--)->face_id = face_id;
19367 }
19368 else
19369 {
19370 while (glyph <= start
19371 && BUFFERP (glyph->object)
19372 && (glyph->type == STRETCH_GLYPH
19373 || (glyph->type == CHAR_GLYPH
19374 && glyph->u.ch == ' ')))
19375 (glyph++)->face_id = face_id;
19376 }
19377 }
19378 }
19379 }
19380
19381
19382 /* Value is non-zero if glyph row ROW should be
19383 considered to hold the buffer position CHARPOS. */
19384
19385 static int
19386 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
19387 {
19388 int result = 1;
19389
19390 if (charpos == CHARPOS (row->end.pos)
19391 || charpos == MATRIX_ROW_END_CHARPOS (row))
19392 {
19393 /* Suppose the row ends on a string.
19394 Unless the row is continued, that means it ends on a newline
19395 in the string. If it's anything other than a display string
19396 (e.g., a before-string from an overlay), we don't want the
19397 cursor there. (This heuristic seems to give the optimal
19398 behavior for the various types of multi-line strings.)
19399 One exception: if the string has `cursor' property on one of
19400 its characters, we _do_ want the cursor there. */
19401 if (CHARPOS (row->end.string_pos) >= 0)
19402 {
19403 if (row->continued_p)
19404 result = 1;
19405 else
19406 {
19407 /* Check for `display' property. */
19408 struct glyph *beg = row->glyphs[TEXT_AREA];
19409 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
19410 struct glyph *glyph;
19411
19412 result = 0;
19413 for (glyph = end; glyph >= beg; --glyph)
19414 if (STRINGP (glyph->object))
19415 {
19416 Lisp_Object prop
19417 = Fget_char_property (make_number (charpos),
19418 Qdisplay, Qnil);
19419 result =
19420 (!NILP (prop)
19421 && display_prop_string_p (prop, glyph->object));
19422 /* If there's a `cursor' property on one of the
19423 string's characters, this row is a cursor row,
19424 even though this is not a display string. */
19425 if (!result)
19426 {
19427 Lisp_Object s = glyph->object;
19428
19429 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
19430 {
19431 ptrdiff_t gpos = glyph->charpos;
19432
19433 if (!NILP (Fget_char_property (make_number (gpos),
19434 Qcursor, s)))
19435 {
19436 result = 1;
19437 break;
19438 }
19439 }
19440 }
19441 break;
19442 }
19443 }
19444 }
19445 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
19446 {
19447 /* If the row ends in middle of a real character,
19448 and the line is continued, we want the cursor here.
19449 That's because CHARPOS (ROW->end.pos) would equal
19450 PT if PT is before the character. */
19451 if (!row->ends_in_ellipsis_p)
19452 result = row->continued_p;
19453 else
19454 /* If the row ends in an ellipsis, then
19455 CHARPOS (ROW->end.pos) will equal point after the
19456 invisible text. We want that position to be displayed
19457 after the ellipsis. */
19458 result = 0;
19459 }
19460 /* If the row ends at ZV, display the cursor at the end of that
19461 row instead of at the start of the row below. */
19462 else if (row->ends_at_zv_p)
19463 result = 1;
19464 else
19465 result = 0;
19466 }
19467
19468 return result;
19469 }
19470
19471 /* Value is non-zero if glyph row ROW should be
19472 used to hold the cursor. */
19473
19474 static int
19475 cursor_row_p (struct glyph_row *row)
19476 {
19477 return row_for_charpos_p (row, PT);
19478 }
19479
19480 \f
19481
19482 /* Push the property PROP so that it will be rendered at the current
19483 position in IT. Return 1 if PROP was successfully pushed, 0
19484 otherwise. Called from handle_line_prefix to handle the
19485 `line-prefix' and `wrap-prefix' properties. */
19486
19487 static int
19488 push_prefix_prop (struct it *it, Lisp_Object prop)
19489 {
19490 struct text_pos pos =
19491 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
19492
19493 eassert (it->method == GET_FROM_BUFFER
19494 || it->method == GET_FROM_DISPLAY_VECTOR
19495 || it->method == GET_FROM_STRING);
19496
19497 /* We need to save the current buffer/string position, so it will be
19498 restored by pop_it, because iterate_out_of_display_property
19499 depends on that being set correctly, but some situations leave
19500 it->position not yet set when this function is called. */
19501 push_it (it, &pos);
19502
19503 if (STRINGP (prop))
19504 {
19505 if (SCHARS (prop) == 0)
19506 {
19507 pop_it (it);
19508 return 0;
19509 }
19510
19511 it->string = prop;
19512 it->string_from_prefix_prop_p = 1;
19513 it->multibyte_p = STRING_MULTIBYTE (it->string);
19514 it->current.overlay_string_index = -1;
19515 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
19516 it->end_charpos = it->string_nchars = SCHARS (it->string);
19517 it->method = GET_FROM_STRING;
19518 it->stop_charpos = 0;
19519 it->prev_stop = 0;
19520 it->base_level_stop = 0;
19521
19522 /* Force paragraph direction to be that of the parent
19523 buffer/string. */
19524 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
19525 it->paragraph_embedding = it->bidi_it.paragraph_dir;
19526 else
19527 it->paragraph_embedding = L2R;
19528
19529 /* Set up the bidi iterator for this display string. */
19530 if (it->bidi_p)
19531 {
19532 it->bidi_it.string.lstring = it->string;
19533 it->bidi_it.string.s = NULL;
19534 it->bidi_it.string.schars = it->end_charpos;
19535 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19536 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19537 it->bidi_it.string.unibyte = !it->multibyte_p;
19538 it->bidi_it.w = it->w;
19539 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19540 }
19541 }
19542 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19543 {
19544 it->method = GET_FROM_STRETCH;
19545 it->object = prop;
19546 }
19547 #ifdef HAVE_WINDOW_SYSTEM
19548 else if (IMAGEP (prop))
19549 {
19550 it->what = IT_IMAGE;
19551 it->image_id = lookup_image (it->f, prop);
19552 it->method = GET_FROM_IMAGE;
19553 }
19554 #endif /* HAVE_WINDOW_SYSTEM */
19555 else
19556 {
19557 pop_it (it); /* bogus display property, give up */
19558 return 0;
19559 }
19560
19561 return 1;
19562 }
19563
19564 /* Return the character-property PROP at the current position in IT. */
19565
19566 static Lisp_Object
19567 get_it_property (struct it *it, Lisp_Object prop)
19568 {
19569 Lisp_Object position, object = it->object;
19570
19571 if (STRINGP (object))
19572 position = make_number (IT_STRING_CHARPOS (*it));
19573 else if (BUFFERP (object))
19574 {
19575 position = make_number (IT_CHARPOS (*it));
19576 object = it->window;
19577 }
19578 else
19579 return Qnil;
19580
19581 return Fget_char_property (position, prop, object);
19582 }
19583
19584 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19585
19586 static void
19587 handle_line_prefix (struct it *it)
19588 {
19589 Lisp_Object prefix;
19590
19591 if (it->continuation_lines_width > 0)
19592 {
19593 prefix = get_it_property (it, Qwrap_prefix);
19594 if (NILP (prefix))
19595 prefix = Vwrap_prefix;
19596 }
19597 else
19598 {
19599 prefix = get_it_property (it, Qline_prefix);
19600 if (NILP (prefix))
19601 prefix = Vline_prefix;
19602 }
19603 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19604 {
19605 /* If the prefix is wider than the window, and we try to wrap
19606 it, it would acquire its own wrap prefix, and so on till the
19607 iterator stack overflows. So, don't wrap the prefix. */
19608 it->line_wrap = TRUNCATE;
19609 it->avoid_cursor_p = 1;
19610 }
19611 }
19612
19613 \f
19614
19615 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19616 only for R2L lines from display_line and display_string, when they
19617 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19618 the line/string needs to be continued on the next glyph row. */
19619 static void
19620 unproduce_glyphs (struct it *it, int n)
19621 {
19622 struct glyph *glyph, *end;
19623
19624 eassert (it->glyph_row);
19625 eassert (it->glyph_row->reversed_p);
19626 eassert (it->area == TEXT_AREA);
19627 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19628
19629 if (n > it->glyph_row->used[TEXT_AREA])
19630 n = it->glyph_row->used[TEXT_AREA];
19631 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19632 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19633 for ( ; glyph < end; glyph++)
19634 glyph[-n] = *glyph;
19635 }
19636
19637 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19638 and ROW->maxpos. */
19639 static void
19640 find_row_edges (struct it *it, struct glyph_row *row,
19641 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19642 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19643 {
19644 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19645 lines' rows is implemented for bidi-reordered rows. */
19646
19647 /* ROW->minpos is the value of min_pos, the minimal buffer position
19648 we have in ROW, or ROW->start.pos if that is smaller. */
19649 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19650 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19651 else
19652 /* We didn't find buffer positions smaller than ROW->start, or
19653 didn't find _any_ valid buffer positions in any of the glyphs,
19654 so we must trust the iterator's computed positions. */
19655 row->minpos = row->start.pos;
19656 if (max_pos <= 0)
19657 {
19658 max_pos = CHARPOS (it->current.pos);
19659 max_bpos = BYTEPOS (it->current.pos);
19660 }
19661
19662 /* Here are the various use-cases for ending the row, and the
19663 corresponding values for ROW->maxpos:
19664
19665 Line ends in a newline from buffer eol_pos + 1
19666 Line is continued from buffer max_pos + 1
19667 Line is truncated on right it->current.pos
19668 Line ends in a newline from string max_pos + 1(*)
19669 (*) + 1 only when line ends in a forward scan
19670 Line is continued from string max_pos
19671 Line is continued from display vector max_pos
19672 Line is entirely from a string min_pos == max_pos
19673 Line is entirely from a display vector min_pos == max_pos
19674 Line that ends at ZV ZV
19675
19676 If you discover other use-cases, please add them here as
19677 appropriate. */
19678 if (row->ends_at_zv_p)
19679 row->maxpos = it->current.pos;
19680 else if (row->used[TEXT_AREA])
19681 {
19682 int seen_this_string = 0;
19683 struct glyph_row *r1 = row - 1;
19684
19685 /* Did we see the same display string on the previous row? */
19686 if (STRINGP (it->object)
19687 /* this is not the first row */
19688 && row > it->w->desired_matrix->rows
19689 /* previous row is not the header line */
19690 && !r1->mode_line_p
19691 /* previous row also ends in a newline from a string */
19692 && r1->ends_in_newline_from_string_p)
19693 {
19694 struct glyph *start, *end;
19695
19696 /* Search for the last glyph of the previous row that came
19697 from buffer or string. Depending on whether the row is
19698 L2R or R2L, we need to process it front to back or the
19699 other way round. */
19700 if (!r1->reversed_p)
19701 {
19702 start = r1->glyphs[TEXT_AREA];
19703 end = start + r1->used[TEXT_AREA];
19704 /* Glyphs inserted by redisplay have an integer (zero)
19705 as their object. */
19706 while (end > start
19707 && INTEGERP ((end - 1)->object)
19708 && (end - 1)->charpos <= 0)
19709 --end;
19710 if (end > start)
19711 {
19712 if (EQ ((end - 1)->object, it->object))
19713 seen_this_string = 1;
19714 }
19715 else
19716 /* If all the glyphs of the previous row were inserted
19717 by redisplay, it means the previous row was
19718 produced from a single newline, which is only
19719 possible if that newline came from the same string
19720 as the one which produced this ROW. */
19721 seen_this_string = 1;
19722 }
19723 else
19724 {
19725 end = r1->glyphs[TEXT_AREA] - 1;
19726 start = end + r1->used[TEXT_AREA];
19727 while (end < start
19728 && INTEGERP ((end + 1)->object)
19729 && (end + 1)->charpos <= 0)
19730 ++end;
19731 if (end < start)
19732 {
19733 if (EQ ((end + 1)->object, it->object))
19734 seen_this_string = 1;
19735 }
19736 else
19737 seen_this_string = 1;
19738 }
19739 }
19740 /* Take note of each display string that covers a newline only
19741 once, the first time we see it. This is for when a display
19742 string includes more than one newline in it. */
19743 if (row->ends_in_newline_from_string_p && !seen_this_string)
19744 {
19745 /* If we were scanning the buffer forward when we displayed
19746 the string, we want to account for at least one buffer
19747 position that belongs to this row (position covered by
19748 the display string), so that cursor positioning will
19749 consider this row as a candidate when point is at the end
19750 of the visual line represented by this row. This is not
19751 required when scanning back, because max_pos will already
19752 have a much larger value. */
19753 if (CHARPOS (row->end.pos) > max_pos)
19754 INC_BOTH (max_pos, max_bpos);
19755 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19756 }
19757 else if (CHARPOS (it->eol_pos) > 0)
19758 SET_TEXT_POS (row->maxpos,
19759 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
19760 else if (row->continued_p)
19761 {
19762 /* If max_pos is different from IT's current position, it
19763 means IT->method does not belong to the display element
19764 at max_pos. However, it also means that the display
19765 element at max_pos was displayed in its entirety on this
19766 line, which is equivalent to saying that the next line
19767 starts at the next buffer position. */
19768 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
19769 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19770 else
19771 {
19772 INC_BOTH (max_pos, max_bpos);
19773 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19774 }
19775 }
19776 else if (row->truncated_on_right_p)
19777 /* display_line already called reseat_at_next_visible_line_start,
19778 which puts the iterator at the beginning of the next line, in
19779 the logical order. */
19780 row->maxpos = it->current.pos;
19781 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
19782 /* A line that is entirely from a string/image/stretch... */
19783 row->maxpos = row->minpos;
19784 else
19785 emacs_abort ();
19786 }
19787 else
19788 row->maxpos = it->current.pos;
19789 }
19790
19791 /* Construct the glyph row IT->glyph_row in the desired matrix of
19792 IT->w from text at the current position of IT. See dispextern.h
19793 for an overview of struct it. Value is non-zero if
19794 IT->glyph_row displays text, as opposed to a line displaying ZV
19795 only. */
19796
19797 static int
19798 display_line (struct it *it)
19799 {
19800 struct glyph_row *row = it->glyph_row;
19801 Lisp_Object overlay_arrow_string;
19802 struct it wrap_it;
19803 void *wrap_data = NULL;
19804 int may_wrap = 0, wrap_x IF_LINT (= 0);
19805 int wrap_row_used = -1;
19806 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
19807 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
19808 int wrap_row_extra_line_spacing IF_LINT (= 0);
19809 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
19810 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
19811 int cvpos;
19812 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
19813 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
19814
19815 /* We always start displaying at hpos zero even if hscrolled. */
19816 eassert (it->hpos == 0 && it->current_x == 0);
19817
19818 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
19819 >= it->w->desired_matrix->nrows)
19820 {
19821 it->w->nrows_scale_factor++;
19822 it->f->fonts_changed = 1;
19823 return 0;
19824 }
19825
19826 /* Clear the result glyph row and enable it. */
19827 prepare_desired_row (row);
19828
19829 row->y = it->current_y;
19830 row->start = it->start;
19831 row->continuation_lines_width = it->continuation_lines_width;
19832 row->displays_text_p = 1;
19833 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
19834 it->starts_in_middle_of_char_p = 0;
19835
19836 /* Arrange the overlays nicely for our purposes. Usually, we call
19837 display_line on only one line at a time, in which case this
19838 can't really hurt too much, or we call it on lines which appear
19839 one after another in the buffer, in which case all calls to
19840 recenter_overlay_lists but the first will be pretty cheap. */
19841 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
19842
19843 /* Move over display elements that are not visible because we are
19844 hscrolled. This may stop at an x-position < IT->first_visible_x
19845 if the first glyph is partially visible or if we hit a line end. */
19846 if (it->current_x < it->first_visible_x)
19847 {
19848 enum move_it_result move_result;
19849
19850 this_line_min_pos = row->start.pos;
19851 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
19852 MOVE_TO_POS | MOVE_TO_X);
19853 /* If we are under a large hscroll, move_it_in_display_line_to
19854 could hit the end of the line without reaching
19855 it->first_visible_x. Pretend that we did reach it. This is
19856 especially important on a TTY, where we will call
19857 extend_face_to_end_of_line, which needs to know how many
19858 blank glyphs to produce. */
19859 if (it->current_x < it->first_visible_x
19860 && (move_result == MOVE_NEWLINE_OR_CR
19861 || move_result == MOVE_POS_MATCH_OR_ZV))
19862 it->current_x = it->first_visible_x;
19863
19864 /* Record the smallest positions seen while we moved over
19865 display elements that are not visible. This is needed by
19866 redisplay_internal for optimizing the case where the cursor
19867 stays inside the same line. The rest of this function only
19868 considers positions that are actually displayed, so
19869 RECORD_MAX_MIN_POS will not otherwise record positions that
19870 are hscrolled to the left of the left edge of the window. */
19871 min_pos = CHARPOS (this_line_min_pos);
19872 min_bpos = BYTEPOS (this_line_min_pos);
19873 }
19874 else
19875 {
19876 /* We only do this when not calling `move_it_in_display_line_to'
19877 above, because move_it_in_display_line_to calls
19878 handle_line_prefix itself. */
19879 handle_line_prefix (it);
19880 }
19881
19882 /* Get the initial row height. This is either the height of the
19883 text hscrolled, if there is any, or zero. */
19884 row->ascent = it->max_ascent;
19885 row->height = it->max_ascent + it->max_descent;
19886 row->phys_ascent = it->max_phys_ascent;
19887 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19888 row->extra_line_spacing = it->max_extra_line_spacing;
19889
19890 /* Utility macro to record max and min buffer positions seen until now. */
19891 #define RECORD_MAX_MIN_POS(IT) \
19892 do \
19893 { \
19894 int composition_p = !STRINGP ((IT)->string) \
19895 && ((IT)->what == IT_COMPOSITION); \
19896 ptrdiff_t current_pos = \
19897 composition_p ? (IT)->cmp_it.charpos \
19898 : IT_CHARPOS (*(IT)); \
19899 ptrdiff_t current_bpos = \
19900 composition_p ? CHAR_TO_BYTE (current_pos) \
19901 : IT_BYTEPOS (*(IT)); \
19902 if (current_pos < min_pos) \
19903 { \
19904 min_pos = current_pos; \
19905 min_bpos = current_bpos; \
19906 } \
19907 if (IT_CHARPOS (*it) > max_pos) \
19908 { \
19909 max_pos = IT_CHARPOS (*it); \
19910 max_bpos = IT_BYTEPOS (*it); \
19911 } \
19912 } \
19913 while (0)
19914
19915 /* Loop generating characters. The loop is left with IT on the next
19916 character to display. */
19917 while (1)
19918 {
19919 int n_glyphs_before, hpos_before, x_before;
19920 int x, nglyphs;
19921 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
19922
19923 /* Retrieve the next thing to display. Value is zero if end of
19924 buffer reached. */
19925 if (!get_next_display_element (it))
19926 {
19927 /* Maybe add a space at the end of this line that is used to
19928 display the cursor there under X. Set the charpos of the
19929 first glyph of blank lines not corresponding to any text
19930 to -1. */
19931 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
19932 row->exact_window_width_line_p = 1;
19933 else if ((append_space_for_newline (it, 1) && row->used[TEXT_AREA] == 1)
19934 || row->used[TEXT_AREA] == 0)
19935 {
19936 row->glyphs[TEXT_AREA]->charpos = -1;
19937 row->displays_text_p = 0;
19938
19939 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
19940 && (!MINI_WINDOW_P (it->w)
19941 || (minibuf_level && EQ (it->window, minibuf_window))))
19942 row->indicate_empty_line_p = 1;
19943 }
19944
19945 it->continuation_lines_width = 0;
19946 row->ends_at_zv_p = 1;
19947 /* A row that displays right-to-left text must always have
19948 its last face extended all the way to the end of line,
19949 even if this row ends in ZV, because we still write to
19950 the screen left to right. We also need to extend the
19951 last face if the default face is remapped to some
19952 different face, otherwise the functions that clear
19953 portions of the screen will clear with the default face's
19954 background color. */
19955 if (row->reversed_p
19956 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
19957 extend_face_to_end_of_line (it);
19958 break;
19959 }
19960
19961 /* Now, get the metrics of what we want to display. This also
19962 generates glyphs in `row' (which is IT->glyph_row). */
19963 n_glyphs_before = row->used[TEXT_AREA];
19964 x = it->current_x;
19965
19966 /* Remember the line height so far in case the next element doesn't
19967 fit on the line. */
19968 if (it->line_wrap != TRUNCATE)
19969 {
19970 ascent = it->max_ascent;
19971 descent = it->max_descent;
19972 phys_ascent = it->max_phys_ascent;
19973 phys_descent = it->max_phys_descent;
19974
19975 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
19976 {
19977 if (IT_DISPLAYING_WHITESPACE (it))
19978 may_wrap = 1;
19979 else if (may_wrap)
19980 {
19981 SAVE_IT (wrap_it, *it, wrap_data);
19982 wrap_x = x;
19983 wrap_row_used = row->used[TEXT_AREA];
19984 wrap_row_ascent = row->ascent;
19985 wrap_row_height = row->height;
19986 wrap_row_phys_ascent = row->phys_ascent;
19987 wrap_row_phys_height = row->phys_height;
19988 wrap_row_extra_line_spacing = row->extra_line_spacing;
19989 wrap_row_min_pos = min_pos;
19990 wrap_row_min_bpos = min_bpos;
19991 wrap_row_max_pos = max_pos;
19992 wrap_row_max_bpos = max_bpos;
19993 may_wrap = 0;
19994 }
19995 }
19996 }
19997
19998 PRODUCE_GLYPHS (it);
19999
20000 /* If this display element was in marginal areas, continue with
20001 the next one. */
20002 if (it->area != TEXT_AREA)
20003 {
20004 row->ascent = max (row->ascent, it->max_ascent);
20005 row->height = max (row->height, it->max_ascent + it->max_descent);
20006 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20007 row->phys_height = max (row->phys_height,
20008 it->max_phys_ascent + it->max_phys_descent);
20009 row->extra_line_spacing = max (row->extra_line_spacing,
20010 it->max_extra_line_spacing);
20011 set_iterator_to_next (it, 1);
20012 continue;
20013 }
20014
20015 /* Does the display element fit on the line? If we truncate
20016 lines, we should draw past the right edge of the window. If
20017 we don't truncate, we want to stop so that we can display the
20018 continuation glyph before the right margin. If lines are
20019 continued, there are two possible strategies for characters
20020 resulting in more than 1 glyph (e.g. tabs): Display as many
20021 glyphs as possible in this line and leave the rest for the
20022 continuation line, or display the whole element in the next
20023 line. Original redisplay did the former, so we do it also. */
20024 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20025 hpos_before = it->hpos;
20026 x_before = x;
20027
20028 if (/* Not a newline. */
20029 nglyphs > 0
20030 /* Glyphs produced fit entirely in the line. */
20031 && it->current_x < it->last_visible_x)
20032 {
20033 it->hpos += nglyphs;
20034 row->ascent = max (row->ascent, it->max_ascent);
20035 row->height = max (row->height, it->max_ascent + it->max_descent);
20036 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20037 row->phys_height = max (row->phys_height,
20038 it->max_phys_ascent + it->max_phys_descent);
20039 row->extra_line_spacing = max (row->extra_line_spacing,
20040 it->max_extra_line_spacing);
20041 if (it->current_x - it->pixel_width < it->first_visible_x)
20042 row->x = x - it->first_visible_x;
20043 /* Record the maximum and minimum buffer positions seen so
20044 far in glyphs that will be displayed by this row. */
20045 if (it->bidi_p)
20046 RECORD_MAX_MIN_POS (it);
20047 }
20048 else
20049 {
20050 int i, new_x;
20051 struct glyph *glyph;
20052
20053 for (i = 0; i < nglyphs; ++i, x = new_x)
20054 {
20055 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20056 new_x = x + glyph->pixel_width;
20057
20058 if (/* Lines are continued. */
20059 it->line_wrap != TRUNCATE
20060 && (/* Glyph doesn't fit on the line. */
20061 new_x > it->last_visible_x
20062 /* Or it fits exactly on a window system frame. */
20063 || (new_x == it->last_visible_x
20064 && FRAME_WINDOW_P (it->f)
20065 && (row->reversed_p
20066 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20067 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20068 {
20069 /* End of a continued line. */
20070
20071 if (it->hpos == 0
20072 || (new_x == it->last_visible_x
20073 && FRAME_WINDOW_P (it->f)
20074 && (row->reversed_p
20075 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20076 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20077 {
20078 /* Current glyph is the only one on the line or
20079 fits exactly on the line. We must continue
20080 the line because we can't draw the cursor
20081 after the glyph. */
20082 row->continued_p = 1;
20083 it->current_x = new_x;
20084 it->continuation_lines_width += new_x;
20085 ++it->hpos;
20086 if (i == nglyphs - 1)
20087 {
20088 /* If line-wrap is on, check if a previous
20089 wrap point was found. */
20090 if (wrap_row_used > 0
20091 /* Even if there is a previous wrap
20092 point, continue the line here as
20093 usual, if (i) the previous character
20094 was a space or tab AND (ii) the
20095 current character is not. */
20096 && (!may_wrap
20097 || IT_DISPLAYING_WHITESPACE (it)))
20098 goto back_to_wrap;
20099
20100 /* Record the maximum and minimum buffer
20101 positions seen so far in glyphs that will be
20102 displayed by this row. */
20103 if (it->bidi_p)
20104 RECORD_MAX_MIN_POS (it);
20105 set_iterator_to_next (it, 1);
20106 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20107 {
20108 if (!get_next_display_element (it))
20109 {
20110 row->exact_window_width_line_p = 1;
20111 it->continuation_lines_width = 0;
20112 row->continued_p = 0;
20113 row->ends_at_zv_p = 1;
20114 }
20115 else if (ITERATOR_AT_END_OF_LINE_P (it))
20116 {
20117 row->continued_p = 0;
20118 row->exact_window_width_line_p = 1;
20119 }
20120 }
20121 }
20122 else if (it->bidi_p)
20123 RECORD_MAX_MIN_POS (it);
20124 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20125 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20126 extend_face_to_end_of_line (it);
20127 }
20128 else if (CHAR_GLYPH_PADDING_P (*glyph)
20129 && !FRAME_WINDOW_P (it->f))
20130 {
20131 /* A padding glyph that doesn't fit on this line.
20132 This means the whole character doesn't fit
20133 on the line. */
20134 if (row->reversed_p)
20135 unproduce_glyphs (it, row->used[TEXT_AREA]
20136 - n_glyphs_before);
20137 row->used[TEXT_AREA] = n_glyphs_before;
20138
20139 /* Fill the rest of the row with continuation
20140 glyphs like in 20.x. */
20141 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20142 < row->glyphs[1 + TEXT_AREA])
20143 produce_special_glyphs (it, IT_CONTINUATION);
20144
20145 row->continued_p = 1;
20146 it->current_x = x_before;
20147 it->continuation_lines_width += x_before;
20148
20149 /* Restore the height to what it was before the
20150 element not fitting on the line. */
20151 it->max_ascent = ascent;
20152 it->max_descent = descent;
20153 it->max_phys_ascent = phys_ascent;
20154 it->max_phys_descent = phys_descent;
20155 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20156 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20157 extend_face_to_end_of_line (it);
20158 }
20159 else if (wrap_row_used > 0)
20160 {
20161 back_to_wrap:
20162 if (row->reversed_p)
20163 unproduce_glyphs (it,
20164 row->used[TEXT_AREA] - wrap_row_used);
20165 RESTORE_IT (it, &wrap_it, wrap_data);
20166 it->continuation_lines_width += wrap_x;
20167 row->used[TEXT_AREA] = wrap_row_used;
20168 row->ascent = wrap_row_ascent;
20169 row->height = wrap_row_height;
20170 row->phys_ascent = wrap_row_phys_ascent;
20171 row->phys_height = wrap_row_phys_height;
20172 row->extra_line_spacing = wrap_row_extra_line_spacing;
20173 min_pos = wrap_row_min_pos;
20174 min_bpos = wrap_row_min_bpos;
20175 max_pos = wrap_row_max_pos;
20176 max_bpos = wrap_row_max_bpos;
20177 row->continued_p = 1;
20178 row->ends_at_zv_p = 0;
20179 row->exact_window_width_line_p = 0;
20180 it->continuation_lines_width += x;
20181
20182 /* Make sure that a non-default face is extended
20183 up to the right margin of the window. */
20184 extend_face_to_end_of_line (it);
20185 }
20186 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20187 {
20188 /* A TAB that extends past the right edge of the
20189 window. This produces a single glyph on
20190 window system frames. We leave the glyph in
20191 this row and let it fill the row, but don't
20192 consume the TAB. */
20193 if ((row->reversed_p
20194 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20195 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20196 produce_special_glyphs (it, IT_CONTINUATION);
20197 it->continuation_lines_width += it->last_visible_x;
20198 row->ends_in_middle_of_char_p = 1;
20199 row->continued_p = 1;
20200 glyph->pixel_width = it->last_visible_x - x;
20201 it->starts_in_middle_of_char_p = 1;
20202 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20203 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20204 extend_face_to_end_of_line (it);
20205 }
20206 else
20207 {
20208 /* Something other than a TAB that draws past
20209 the right edge of the window. Restore
20210 positions to values before the element. */
20211 if (row->reversed_p)
20212 unproduce_glyphs (it, row->used[TEXT_AREA]
20213 - (n_glyphs_before + i));
20214 row->used[TEXT_AREA] = n_glyphs_before + i;
20215
20216 /* Display continuation glyphs. */
20217 it->current_x = x_before;
20218 it->continuation_lines_width += x;
20219 if (!FRAME_WINDOW_P (it->f)
20220 || (row->reversed_p
20221 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20222 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20223 produce_special_glyphs (it, IT_CONTINUATION);
20224 row->continued_p = 1;
20225
20226 extend_face_to_end_of_line (it);
20227
20228 if (nglyphs > 1 && i > 0)
20229 {
20230 row->ends_in_middle_of_char_p = 1;
20231 it->starts_in_middle_of_char_p = 1;
20232 }
20233
20234 /* Restore the height to what it was before the
20235 element not fitting on the line. */
20236 it->max_ascent = ascent;
20237 it->max_descent = descent;
20238 it->max_phys_ascent = phys_ascent;
20239 it->max_phys_descent = phys_descent;
20240 }
20241
20242 break;
20243 }
20244 else if (new_x > it->first_visible_x)
20245 {
20246 /* Increment number of glyphs actually displayed. */
20247 ++it->hpos;
20248
20249 /* Record the maximum and minimum buffer positions
20250 seen so far in glyphs that will be displayed by
20251 this row. */
20252 if (it->bidi_p)
20253 RECORD_MAX_MIN_POS (it);
20254
20255 if (x < it->first_visible_x)
20256 /* Glyph is partially visible, i.e. row starts at
20257 negative X position. */
20258 row->x = x - it->first_visible_x;
20259 }
20260 else
20261 {
20262 /* Glyph is completely off the left margin of the
20263 window. This should not happen because of the
20264 move_it_in_display_line at the start of this
20265 function, unless the text display area of the
20266 window is empty. */
20267 eassert (it->first_visible_x <= it->last_visible_x);
20268 }
20269 }
20270 /* Even if this display element produced no glyphs at all,
20271 we want to record its position. */
20272 if (it->bidi_p && nglyphs == 0)
20273 RECORD_MAX_MIN_POS (it);
20274
20275 row->ascent = max (row->ascent, it->max_ascent);
20276 row->height = max (row->height, it->max_ascent + it->max_descent);
20277 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20278 row->phys_height = max (row->phys_height,
20279 it->max_phys_ascent + it->max_phys_descent);
20280 row->extra_line_spacing = max (row->extra_line_spacing,
20281 it->max_extra_line_spacing);
20282
20283 /* End of this display line if row is continued. */
20284 if (row->continued_p || row->ends_at_zv_p)
20285 break;
20286 }
20287
20288 at_end_of_line:
20289 /* Is this a line end? If yes, we're also done, after making
20290 sure that a non-default face is extended up to the right
20291 margin of the window. */
20292 if (ITERATOR_AT_END_OF_LINE_P (it))
20293 {
20294 int used_before = row->used[TEXT_AREA];
20295
20296 row->ends_in_newline_from_string_p = STRINGP (it->object);
20297
20298 /* Add a space at the end of the line that is used to
20299 display the cursor there. */
20300 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20301 append_space_for_newline (it, 0);
20302
20303 /* Extend the face to the end of the line. */
20304 extend_face_to_end_of_line (it);
20305
20306 /* Make sure we have the position. */
20307 if (used_before == 0)
20308 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
20309
20310 /* Record the position of the newline, for use in
20311 find_row_edges. */
20312 it->eol_pos = it->current.pos;
20313
20314 /* Consume the line end. This skips over invisible lines. */
20315 set_iterator_to_next (it, 1);
20316 it->continuation_lines_width = 0;
20317 break;
20318 }
20319
20320 /* Proceed with next display element. Note that this skips
20321 over lines invisible because of selective display. */
20322 set_iterator_to_next (it, 1);
20323
20324 /* If we truncate lines, we are done when the last displayed
20325 glyphs reach past the right margin of the window. */
20326 if (it->line_wrap == TRUNCATE
20327 && ((FRAME_WINDOW_P (it->f)
20328 /* Images are preprocessed in produce_image_glyph such
20329 that they are cropped at the right edge of the
20330 window, so an image glyph will always end exactly at
20331 last_visible_x, even if there's no right fringe. */
20332 && (WINDOW_RIGHT_FRINGE_WIDTH (it->w) || it->what == IT_IMAGE))
20333 ? (it->current_x >= it->last_visible_x)
20334 : (it->current_x > it->last_visible_x)))
20335 {
20336 /* Maybe add truncation glyphs. */
20337 if (!FRAME_WINDOW_P (it->f)
20338 || (row->reversed_p
20339 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20340 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20341 {
20342 int i, n;
20343
20344 if (!row->reversed_p)
20345 {
20346 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
20347 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20348 break;
20349 }
20350 else
20351 {
20352 for (i = 0; i < row->used[TEXT_AREA]; i++)
20353 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20354 break;
20355 /* Remove any padding glyphs at the front of ROW, to
20356 make room for the truncation glyphs we will be
20357 adding below. The loop below always inserts at
20358 least one truncation glyph, so also remove the
20359 last glyph added to ROW. */
20360 unproduce_glyphs (it, i + 1);
20361 /* Adjust i for the loop below. */
20362 i = row->used[TEXT_AREA] - (i + 1);
20363 }
20364
20365 /* produce_special_glyphs overwrites the last glyph, so
20366 we don't want that if we want to keep that last
20367 glyph, which means it's an image. */
20368 if (it->current_x > it->last_visible_x)
20369 {
20370 it->current_x = x_before;
20371 if (!FRAME_WINDOW_P (it->f))
20372 {
20373 for (n = row->used[TEXT_AREA]; i < n; ++i)
20374 {
20375 row->used[TEXT_AREA] = i;
20376 produce_special_glyphs (it, IT_TRUNCATION);
20377 }
20378 }
20379 else
20380 {
20381 row->used[TEXT_AREA] = i;
20382 produce_special_glyphs (it, IT_TRUNCATION);
20383 }
20384 it->hpos = hpos_before;
20385 }
20386 }
20387 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20388 {
20389 /* Don't truncate if we can overflow newline into fringe. */
20390 if (!get_next_display_element (it))
20391 {
20392 it->continuation_lines_width = 0;
20393 row->ends_at_zv_p = 1;
20394 row->exact_window_width_line_p = 1;
20395 break;
20396 }
20397 if (ITERATOR_AT_END_OF_LINE_P (it))
20398 {
20399 row->exact_window_width_line_p = 1;
20400 goto at_end_of_line;
20401 }
20402 it->current_x = x_before;
20403 it->hpos = hpos_before;
20404 }
20405
20406 row->truncated_on_right_p = 1;
20407 it->continuation_lines_width = 0;
20408 reseat_at_next_visible_line_start (it, 0);
20409 row->ends_at_zv_p = FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n';
20410 break;
20411 }
20412 }
20413
20414 if (wrap_data)
20415 bidi_unshelve_cache (wrap_data, 1);
20416
20417 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20418 at the left window margin. */
20419 if (it->first_visible_x
20420 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
20421 {
20422 if (!FRAME_WINDOW_P (it->f)
20423 || (((row->reversed_p
20424 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
20425 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
20426 /* Don't let insert_left_trunc_glyphs overwrite the
20427 first glyph of the row if it is an image. */
20428 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
20429 insert_left_trunc_glyphs (it);
20430 row->truncated_on_left_p = 1;
20431 }
20432
20433 /* Remember the position at which this line ends.
20434
20435 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20436 cannot be before the call to find_row_edges below, since that is
20437 where these positions are determined. */
20438 row->end = it->current;
20439 if (!it->bidi_p)
20440 {
20441 row->minpos = row->start.pos;
20442 row->maxpos = row->end.pos;
20443 }
20444 else
20445 {
20446 /* ROW->minpos and ROW->maxpos must be the smallest and
20447 `1 + the largest' buffer positions in ROW. But if ROW was
20448 bidi-reordered, these two positions can be anywhere in the
20449 row, so we must determine them now. */
20450 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
20451 }
20452
20453 /* If the start of this line is the overlay arrow-position, then
20454 mark this glyph row as the one containing the overlay arrow.
20455 This is clearly a mess with variable size fonts. It would be
20456 better to let it be displayed like cursors under X. */
20457 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
20458 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
20459 !NILP (overlay_arrow_string)))
20460 {
20461 /* Overlay arrow in window redisplay is a fringe bitmap. */
20462 if (STRINGP (overlay_arrow_string))
20463 {
20464 struct glyph_row *arrow_row
20465 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
20466 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
20467 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
20468 struct glyph *p = row->glyphs[TEXT_AREA];
20469 struct glyph *p2, *end;
20470
20471 /* Copy the arrow glyphs. */
20472 while (glyph < arrow_end)
20473 *p++ = *glyph++;
20474
20475 /* Throw away padding glyphs. */
20476 p2 = p;
20477 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
20478 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
20479 ++p2;
20480 if (p2 > p)
20481 {
20482 while (p2 < end)
20483 *p++ = *p2++;
20484 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
20485 }
20486 }
20487 else
20488 {
20489 eassert (INTEGERP (overlay_arrow_string));
20490 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
20491 }
20492 overlay_arrow_seen = 1;
20493 }
20494
20495 /* Highlight trailing whitespace. */
20496 if (!NILP (Vshow_trailing_whitespace))
20497 highlight_trailing_whitespace (it->f, it->glyph_row);
20498
20499 /* Compute pixel dimensions of this line. */
20500 compute_line_metrics (it);
20501
20502 /* Implementation note: No changes in the glyphs of ROW or in their
20503 faces can be done past this point, because compute_line_metrics
20504 computes ROW's hash value and stores it within the glyph_row
20505 structure. */
20506
20507 /* Record whether this row ends inside an ellipsis. */
20508 row->ends_in_ellipsis_p
20509 = (it->method == GET_FROM_DISPLAY_VECTOR
20510 && it->ellipsis_p);
20511
20512 /* Save fringe bitmaps in this row. */
20513 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
20514 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
20515 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
20516 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
20517
20518 it->left_user_fringe_bitmap = 0;
20519 it->left_user_fringe_face_id = 0;
20520 it->right_user_fringe_bitmap = 0;
20521 it->right_user_fringe_face_id = 0;
20522
20523 /* Maybe set the cursor. */
20524 cvpos = it->w->cursor.vpos;
20525 if ((cvpos < 0
20526 /* In bidi-reordered rows, keep checking for proper cursor
20527 position even if one has been found already, because buffer
20528 positions in such rows change non-linearly with ROW->VPOS,
20529 when a line is continued. One exception: when we are at ZV,
20530 display cursor on the first suitable glyph row, since all
20531 the empty rows after that also have their position set to ZV. */
20532 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20533 lines' rows is implemented for bidi-reordered rows. */
20534 || (it->bidi_p
20535 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
20536 && PT >= MATRIX_ROW_START_CHARPOS (row)
20537 && PT <= MATRIX_ROW_END_CHARPOS (row)
20538 && cursor_row_p (row))
20539 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
20540
20541 /* Prepare for the next line. This line starts horizontally at (X
20542 HPOS) = (0 0). Vertical positions are incremented. As a
20543 convenience for the caller, IT->glyph_row is set to the next
20544 row to be used. */
20545 it->current_x = it->hpos = 0;
20546 it->current_y += row->height;
20547 SET_TEXT_POS (it->eol_pos, 0, 0);
20548 ++it->vpos;
20549 ++it->glyph_row;
20550 /* The next row should by default use the same value of the
20551 reversed_p flag as this one. set_iterator_to_next decides when
20552 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20553 the flag accordingly. */
20554 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20555 it->glyph_row->reversed_p = row->reversed_p;
20556 it->start = row->end;
20557 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
20558
20559 #undef RECORD_MAX_MIN_POS
20560 }
20561
20562 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20563 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20564 doc: /* Return paragraph direction at point in BUFFER.
20565 Value is either `left-to-right' or `right-to-left'.
20566 If BUFFER is omitted or nil, it defaults to the current buffer.
20567
20568 Paragraph direction determines how the text in the paragraph is displayed.
20569 In left-to-right paragraphs, text begins at the left margin of the window
20570 and the reading direction is generally left to right. In right-to-left
20571 paragraphs, text begins at the right margin and is read from right to left.
20572
20573 See also `bidi-paragraph-direction'. */)
20574 (Lisp_Object buffer)
20575 {
20576 struct buffer *buf = current_buffer;
20577 struct buffer *old = buf;
20578
20579 if (! NILP (buffer))
20580 {
20581 CHECK_BUFFER (buffer);
20582 buf = XBUFFER (buffer);
20583 }
20584
20585 if (NILP (BVAR (buf, bidi_display_reordering))
20586 || NILP (BVAR (buf, enable_multibyte_characters))
20587 /* When we are loading loadup.el, the character property tables
20588 needed for bidi iteration are not yet available. */
20589 || !NILP (Vpurify_flag))
20590 return Qleft_to_right;
20591 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
20592 return BVAR (buf, bidi_paragraph_direction);
20593 else
20594 {
20595 /* Determine the direction from buffer text. We could try to
20596 use current_matrix if it is up to date, but this seems fast
20597 enough as it is. */
20598 struct bidi_it itb;
20599 ptrdiff_t pos = BUF_PT (buf);
20600 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
20601 int c;
20602 void *itb_data = bidi_shelve_cache ();
20603
20604 set_buffer_temp (buf);
20605 /* bidi_paragraph_init finds the base direction of the paragraph
20606 by searching forward from paragraph start. We need the base
20607 direction of the current or _previous_ paragraph, so we need
20608 to make sure we are within that paragraph. To that end, find
20609 the previous non-empty line. */
20610 if (pos >= ZV && pos > BEGV)
20611 DEC_BOTH (pos, bytepos);
20612 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20613 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
20614 {
20615 while ((c = FETCH_BYTE (bytepos)) == '\n'
20616 || c == ' ' || c == '\t' || c == '\f')
20617 {
20618 if (bytepos <= BEGV_BYTE)
20619 break;
20620 bytepos--;
20621 pos--;
20622 }
20623 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
20624 bytepos--;
20625 }
20626 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
20627 itb.paragraph_dir = NEUTRAL_DIR;
20628 itb.string.s = NULL;
20629 itb.string.lstring = Qnil;
20630 itb.string.bufpos = 0;
20631 itb.string.from_disp_str = 0;
20632 itb.string.unibyte = 0;
20633 /* We have no window to use here for ignoring window-specific
20634 overlays. Using NULL for window pointer will cause
20635 compute_display_string_pos to use the current buffer. */
20636 itb.w = NULL;
20637 bidi_paragraph_init (NEUTRAL_DIR, &itb, 1);
20638 bidi_unshelve_cache (itb_data, 0);
20639 set_buffer_temp (old);
20640 switch (itb.paragraph_dir)
20641 {
20642 case L2R:
20643 return Qleft_to_right;
20644 break;
20645 case R2L:
20646 return Qright_to_left;
20647 break;
20648 default:
20649 emacs_abort ();
20650 }
20651 }
20652 }
20653
20654 DEFUN ("move-point-visually", Fmove_point_visually,
20655 Smove_point_visually, 1, 1, 0,
20656 doc: /* Move point in the visual order in the specified DIRECTION.
20657 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20658 left.
20659
20660 Value is the new character position of point. */)
20661 (Lisp_Object direction)
20662 {
20663 struct window *w = XWINDOW (selected_window);
20664 struct buffer *b = XBUFFER (w->contents);
20665 struct glyph_row *row;
20666 int dir;
20667 Lisp_Object paragraph_dir;
20668
20669 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20670 (!(ROW)->continued_p \
20671 && INTEGERP ((GLYPH)->object) \
20672 && (GLYPH)->type == CHAR_GLYPH \
20673 && (GLYPH)->u.ch == ' ' \
20674 && (GLYPH)->charpos >= 0 \
20675 && !(GLYPH)->avoid_cursor_p)
20676
20677 CHECK_NUMBER (direction);
20678 dir = XINT (direction);
20679 if (dir > 0)
20680 dir = 1;
20681 else
20682 dir = -1;
20683
20684 /* If current matrix is up-to-date, we can use the information
20685 recorded in the glyphs, at least as long as the goal is on the
20686 screen. */
20687 if (w->window_end_valid
20688 && !windows_or_buffers_changed
20689 && b
20690 && !b->clip_changed
20691 && !b->prevent_redisplay_optimizations_p
20692 && !window_outdated (w)
20693 && w->cursor.vpos >= 0
20694 && w->cursor.vpos < w->current_matrix->nrows
20695 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
20696 {
20697 struct glyph *g = row->glyphs[TEXT_AREA];
20698 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
20699 struct glyph *gpt = g + w->cursor.hpos;
20700
20701 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
20702 {
20703 if (BUFFERP (g->object) && g->charpos != PT)
20704 {
20705 SET_PT (g->charpos);
20706 w->cursor.vpos = -1;
20707 return make_number (PT);
20708 }
20709 else if (!INTEGERP (g->object) && !EQ (g->object, gpt->object))
20710 {
20711 ptrdiff_t new_pos;
20712
20713 if (BUFFERP (gpt->object))
20714 {
20715 new_pos = PT;
20716 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
20717 new_pos += (row->reversed_p ? -dir : dir);
20718 else
20719 new_pos -= (row->reversed_p ? -dir : dir);;
20720 }
20721 else if (BUFFERP (g->object))
20722 new_pos = g->charpos;
20723 else
20724 break;
20725 SET_PT (new_pos);
20726 w->cursor.vpos = -1;
20727 return make_number (PT);
20728 }
20729 else if (ROW_GLYPH_NEWLINE_P (row, g))
20730 {
20731 /* Glyphs inserted at the end of a non-empty line for
20732 positioning the cursor have zero charpos, so we must
20733 deduce the value of point by other means. */
20734 if (g->charpos > 0)
20735 SET_PT (g->charpos);
20736 else if (row->ends_at_zv_p && PT != ZV)
20737 SET_PT (ZV);
20738 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
20739 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
20740 else
20741 break;
20742 w->cursor.vpos = -1;
20743 return make_number (PT);
20744 }
20745 }
20746 if (g == e || INTEGERP (g->object))
20747 {
20748 if (row->truncated_on_left_p || row->truncated_on_right_p)
20749 goto simulate_display;
20750 if (!row->reversed_p)
20751 row += dir;
20752 else
20753 row -= dir;
20754 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
20755 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
20756 goto simulate_display;
20757
20758 if (dir > 0)
20759 {
20760 if (row->reversed_p && !row->continued_p)
20761 {
20762 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
20763 w->cursor.vpos = -1;
20764 return make_number (PT);
20765 }
20766 g = row->glyphs[TEXT_AREA];
20767 e = g + row->used[TEXT_AREA];
20768 for ( ; g < e; g++)
20769 {
20770 if (BUFFERP (g->object)
20771 /* Empty lines have only one glyph, which stands
20772 for the newline, and whose charpos is the
20773 buffer position of the newline. */
20774 || ROW_GLYPH_NEWLINE_P (row, g)
20775 /* When the buffer ends in a newline, the line at
20776 EOB also has one glyph, but its charpos is -1. */
20777 || (row->ends_at_zv_p
20778 && !row->reversed_p
20779 && INTEGERP (g->object)
20780 && g->type == CHAR_GLYPH
20781 && g->u.ch == ' '))
20782 {
20783 if (g->charpos > 0)
20784 SET_PT (g->charpos);
20785 else if (!row->reversed_p
20786 && row->ends_at_zv_p
20787 && PT != ZV)
20788 SET_PT (ZV);
20789 else
20790 continue;
20791 w->cursor.vpos = -1;
20792 return make_number (PT);
20793 }
20794 }
20795 }
20796 else
20797 {
20798 if (!row->reversed_p && !row->continued_p)
20799 {
20800 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
20801 w->cursor.vpos = -1;
20802 return make_number (PT);
20803 }
20804 e = row->glyphs[TEXT_AREA];
20805 g = e + row->used[TEXT_AREA] - 1;
20806 for ( ; g >= e; g--)
20807 {
20808 if (BUFFERP (g->object)
20809 || (ROW_GLYPH_NEWLINE_P (row, g)
20810 && g->charpos > 0)
20811 /* Empty R2L lines on GUI frames have the buffer
20812 position of the newline stored in the stretch
20813 glyph. */
20814 || g->type == STRETCH_GLYPH
20815 || (row->ends_at_zv_p
20816 && row->reversed_p
20817 && INTEGERP (g->object)
20818 && g->type == CHAR_GLYPH
20819 && g->u.ch == ' '))
20820 {
20821 if (g->charpos > 0)
20822 SET_PT (g->charpos);
20823 else if (row->reversed_p
20824 && row->ends_at_zv_p
20825 && PT != ZV)
20826 SET_PT (ZV);
20827 else
20828 continue;
20829 w->cursor.vpos = -1;
20830 return make_number (PT);
20831 }
20832 }
20833 }
20834 }
20835 }
20836
20837 simulate_display:
20838
20839 /* If we wind up here, we failed to move by using the glyphs, so we
20840 need to simulate display instead. */
20841
20842 if (b)
20843 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
20844 else
20845 paragraph_dir = Qleft_to_right;
20846 if (EQ (paragraph_dir, Qright_to_left))
20847 dir = -dir;
20848 if (PT <= BEGV && dir < 0)
20849 xsignal0 (Qbeginning_of_buffer);
20850 else if (PT >= ZV && dir > 0)
20851 xsignal0 (Qend_of_buffer);
20852 else
20853 {
20854 struct text_pos pt;
20855 struct it it;
20856 int pt_x, target_x, pixel_width, pt_vpos;
20857 bool at_eol_p;
20858 bool overshoot_expected = false;
20859 bool target_is_eol_p = false;
20860
20861 /* Setup the arena. */
20862 SET_TEXT_POS (pt, PT, PT_BYTE);
20863 start_display (&it, w, pt);
20864
20865 if (it.cmp_it.id < 0
20866 && it.method == GET_FROM_STRING
20867 && it.area == TEXT_AREA
20868 && it.string_from_display_prop_p
20869 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
20870 overshoot_expected = true;
20871
20872 /* Find the X coordinate of point. We start from the beginning
20873 of this or previous line to make sure we are before point in
20874 the logical order (since the move_it_* functions can only
20875 move forward). */
20876 reseat:
20877 reseat_at_previous_visible_line_start (&it);
20878 it.current_x = it.hpos = it.current_y = it.vpos = 0;
20879 if (IT_CHARPOS (it) != PT)
20880 {
20881 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
20882 -1, -1, -1, MOVE_TO_POS);
20883 /* If we missed point because the character there is
20884 displayed out of a display vector that has more than one
20885 glyph, retry expecting overshoot. */
20886 if (it.method == GET_FROM_DISPLAY_VECTOR
20887 && it.current.dpvec_index > 0
20888 && !overshoot_expected)
20889 {
20890 overshoot_expected = true;
20891 goto reseat;
20892 }
20893 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
20894 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
20895 }
20896 pt_x = it.current_x;
20897 pt_vpos = it.vpos;
20898 if (dir > 0 || overshoot_expected)
20899 {
20900 struct glyph_row *row = it.glyph_row;
20901
20902 /* When point is at beginning of line, we don't have
20903 information about the glyph there loaded into struct
20904 it. Calling get_next_display_element fixes that. */
20905 if (pt_x == 0)
20906 get_next_display_element (&it);
20907 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
20908 it.glyph_row = NULL;
20909 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
20910 it.glyph_row = row;
20911 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
20912 it, lest it will become out of sync with it's buffer
20913 position. */
20914 it.current_x = pt_x;
20915 }
20916 else
20917 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
20918 pixel_width = it.pixel_width;
20919 if (overshoot_expected && at_eol_p)
20920 pixel_width = 0;
20921 else if (pixel_width <= 0)
20922 pixel_width = 1;
20923
20924 /* If there's a display string (or something similar) at point,
20925 we are actually at the glyph to the left of point, so we need
20926 to correct the X coordinate. */
20927 if (overshoot_expected)
20928 {
20929 if (it.bidi_p)
20930 pt_x += pixel_width * it.bidi_it.scan_dir;
20931 else
20932 pt_x += pixel_width;
20933 }
20934
20935 /* Compute target X coordinate, either to the left or to the
20936 right of point. On TTY frames, all characters have the same
20937 pixel width of 1, so we can use that. On GUI frames we don't
20938 have an easy way of getting at the pixel width of the
20939 character to the left of point, so we use a different method
20940 of getting to that place. */
20941 if (dir > 0)
20942 target_x = pt_x + pixel_width;
20943 else
20944 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
20945
20946 /* Target X coordinate could be one line above or below the line
20947 of point, in which case we need to adjust the target X
20948 coordinate. Also, if moving to the left, we need to begin at
20949 the left edge of the point's screen line. */
20950 if (dir < 0)
20951 {
20952 if (pt_x > 0)
20953 {
20954 start_display (&it, w, pt);
20955 reseat_at_previous_visible_line_start (&it);
20956 it.current_x = it.current_y = it.hpos = 0;
20957 if (pt_vpos != 0)
20958 move_it_by_lines (&it, pt_vpos);
20959 }
20960 else
20961 {
20962 move_it_by_lines (&it, -1);
20963 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
20964 target_is_eol_p = true;
20965 /* Under word-wrap, we don't know the x coordinate of
20966 the last character displayed on the previous line,
20967 which immediately precedes the wrap point. To find
20968 out its x coordinate, we try moving to the right
20969 margin of the window, which will stop at the wrap
20970 point, and then reset target_x to point at the
20971 character that precedes the wrap point. This is not
20972 needed on GUI frames, because (see below) there we
20973 move from the left margin one grapheme cluster at a
20974 time, and stop when we hit the wrap point. */
20975 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
20976 {
20977 void *it_data = NULL;
20978 struct it it2;
20979
20980 SAVE_IT (it2, it, it_data);
20981 move_it_in_display_line_to (&it, ZV, target_x,
20982 MOVE_TO_POS | MOVE_TO_X);
20983 /* If we arrived at target_x, that _is_ the last
20984 character on the previous line. */
20985 if (it.current_x != target_x)
20986 target_x = it.current_x - 1;
20987 RESTORE_IT (&it, &it2, it_data);
20988 }
20989 }
20990 }
20991 else
20992 {
20993 if (at_eol_p
20994 || (target_x >= it.last_visible_x
20995 && it.line_wrap != TRUNCATE))
20996 {
20997 if (pt_x > 0)
20998 move_it_by_lines (&it, 0);
20999 move_it_by_lines (&it, 1);
21000 target_x = 0;
21001 }
21002 }
21003
21004 /* Move to the target X coordinate. */
21005 #ifdef HAVE_WINDOW_SYSTEM
21006 /* On GUI frames, as we don't know the X coordinate of the
21007 character to the left of point, moving point to the left
21008 requires walking, one grapheme cluster at a time, until we
21009 find ourself at a place immediately to the left of the
21010 character at point. */
21011 if (FRAME_WINDOW_P (it.f) && dir < 0)
21012 {
21013 struct text_pos new_pos;
21014 enum move_it_result rc = MOVE_X_REACHED;
21015
21016 if (it.current_x == 0)
21017 get_next_display_element (&it);
21018 if (it.what == IT_COMPOSITION)
21019 {
21020 new_pos.charpos = it.cmp_it.charpos;
21021 new_pos.bytepos = -1;
21022 }
21023 else
21024 new_pos = it.current.pos;
21025
21026 while (it.current_x + it.pixel_width <= target_x
21027 && (rc == MOVE_X_REACHED
21028 /* Under word-wrap, move_it_in_display_line_to
21029 stops at correct coordinates, but sometimes
21030 returns MOVE_POS_MATCH_OR_ZV. */
21031 || (it.line_wrap == WORD_WRAP
21032 && rc == MOVE_POS_MATCH_OR_ZV)))
21033 {
21034 int new_x = it.current_x + it.pixel_width;
21035
21036 /* For composed characters, we want the position of the
21037 first character in the grapheme cluster (usually, the
21038 composition's base character), whereas it.current
21039 might give us the position of the _last_ one, e.g. if
21040 the composition is rendered in reverse due to bidi
21041 reordering. */
21042 if (it.what == IT_COMPOSITION)
21043 {
21044 new_pos.charpos = it.cmp_it.charpos;
21045 new_pos.bytepos = -1;
21046 }
21047 else
21048 new_pos = it.current.pos;
21049 if (new_x == it.current_x)
21050 new_x++;
21051 rc = move_it_in_display_line_to (&it, ZV, new_x,
21052 MOVE_TO_POS | MOVE_TO_X);
21053 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21054 break;
21055 }
21056 /* The previous position we saw in the loop is the one we
21057 want. */
21058 if (new_pos.bytepos == -1)
21059 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21060 it.current.pos = new_pos;
21061 }
21062 else
21063 #endif
21064 if (it.current_x != target_x)
21065 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21066
21067 /* When lines are truncated, the above loop will stop at the
21068 window edge. But we want to get to the end of line, even if
21069 it is beyond the window edge; automatic hscroll will then
21070 scroll the window to show point as appropriate. */
21071 if (target_is_eol_p && it.line_wrap == TRUNCATE
21072 && get_next_display_element (&it))
21073 {
21074 struct text_pos new_pos = it.current.pos;
21075
21076 while (!ITERATOR_AT_END_OF_LINE_P (&it))
21077 {
21078 set_iterator_to_next (&it, 0);
21079 if (it.method == GET_FROM_BUFFER)
21080 new_pos = it.current.pos;
21081 if (!get_next_display_element (&it))
21082 break;
21083 }
21084
21085 it.current.pos = new_pos;
21086 }
21087
21088 /* If we ended up in a display string that covers point, move to
21089 buffer position to the right in the visual order. */
21090 if (dir > 0)
21091 {
21092 while (IT_CHARPOS (it) == PT)
21093 {
21094 set_iterator_to_next (&it, 0);
21095 if (!get_next_display_element (&it))
21096 break;
21097 }
21098 }
21099
21100 /* Move point to that position. */
21101 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21102 }
21103
21104 return make_number (PT);
21105
21106 #undef ROW_GLYPH_NEWLINE_P
21107 }
21108
21109 \f
21110 /***********************************************************************
21111 Menu Bar
21112 ***********************************************************************/
21113
21114 /* Redisplay the menu bar in the frame for window W.
21115
21116 The menu bar of X frames that don't have X toolkit support is
21117 displayed in a special window W->frame->menu_bar_window.
21118
21119 The menu bar of terminal frames is treated specially as far as
21120 glyph matrices are concerned. Menu bar lines are not part of
21121 windows, so the update is done directly on the frame matrix rows
21122 for the menu bar. */
21123
21124 static void
21125 display_menu_bar (struct window *w)
21126 {
21127 struct frame *f = XFRAME (WINDOW_FRAME (w));
21128 struct it it;
21129 Lisp_Object items;
21130 int i;
21131
21132 /* Don't do all this for graphical frames. */
21133 #ifdef HAVE_NTGUI
21134 if (FRAME_W32_P (f))
21135 return;
21136 #endif
21137 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21138 if (FRAME_X_P (f))
21139 return;
21140 #endif
21141
21142 #ifdef HAVE_NS
21143 if (FRAME_NS_P (f))
21144 return;
21145 #endif /* HAVE_NS */
21146
21147 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21148 eassert (!FRAME_WINDOW_P (f));
21149 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
21150 it.first_visible_x = 0;
21151 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21152 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21153 if (FRAME_WINDOW_P (f))
21154 {
21155 /* Menu bar lines are displayed in the desired matrix of the
21156 dummy window menu_bar_window. */
21157 struct window *menu_w;
21158 menu_w = XWINDOW (f->menu_bar_window);
21159 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
21160 MENU_FACE_ID);
21161 it.first_visible_x = 0;
21162 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21163 }
21164 else
21165 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21166 {
21167 /* This is a TTY frame, i.e. character hpos/vpos are used as
21168 pixel x/y. */
21169 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
21170 MENU_FACE_ID);
21171 it.first_visible_x = 0;
21172 it.last_visible_x = FRAME_COLS (f);
21173 }
21174
21175 /* FIXME: This should be controlled by a user option. See the
21176 comments in redisplay_tool_bar and display_mode_line about
21177 this. */
21178 it.paragraph_embedding = L2R;
21179
21180 /* Clear all rows of the menu bar. */
21181 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
21182 {
21183 struct glyph_row *row = it.glyph_row + i;
21184 clear_glyph_row (row);
21185 row->enabled_p = true;
21186 row->full_width_p = 1;
21187 }
21188
21189 /* Display all items of the menu bar. */
21190 items = FRAME_MENU_BAR_ITEMS (it.f);
21191 for (i = 0; i < ASIZE (items); i += 4)
21192 {
21193 Lisp_Object string;
21194
21195 /* Stop at nil string. */
21196 string = AREF (items, i + 1);
21197 if (NILP (string))
21198 break;
21199
21200 /* Remember where item was displayed. */
21201 ASET (items, i + 3, make_number (it.hpos));
21202
21203 /* Display the item, pad with one space. */
21204 if (it.current_x < it.last_visible_x)
21205 display_string (NULL, string, Qnil, 0, 0, &it,
21206 SCHARS (string) + 1, 0, 0, -1);
21207 }
21208
21209 /* Fill out the line with spaces. */
21210 if (it.current_x < it.last_visible_x)
21211 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
21212
21213 /* Compute the total height of the lines. */
21214 compute_line_metrics (&it);
21215 }
21216
21217 /* Deep copy of a glyph row, including the glyphs. */
21218 static void
21219 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
21220 {
21221 struct glyph *pointers[1 + LAST_AREA];
21222 int to_used = to->used[TEXT_AREA];
21223
21224 /* Save glyph pointers of TO. */
21225 memcpy (pointers, to->glyphs, sizeof to->glyphs);
21226
21227 /* Do a structure assignment. */
21228 *to = *from;
21229
21230 /* Restore original glyph pointers of TO. */
21231 memcpy (to->glyphs, pointers, sizeof to->glyphs);
21232
21233 /* Copy the glyphs. */
21234 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
21235 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
21236
21237 /* If we filled only part of the TO row, fill the rest with
21238 space_glyph (which will display as empty space). */
21239 if (to_used > from->used[TEXT_AREA])
21240 fill_up_frame_row_with_spaces (to, to_used);
21241 }
21242
21243 /* Display one menu item on a TTY, by overwriting the glyphs in the
21244 frame F's desired glyph matrix with glyphs produced from the menu
21245 item text. Called from term.c to display TTY drop-down menus one
21246 item at a time.
21247
21248 ITEM_TEXT is the menu item text as a C string.
21249
21250 FACE_ID is the face ID to be used for this menu item. FACE_ID
21251 could specify one of 3 faces: a face for an enabled item, a face
21252 for a disabled item, or a face for a selected item.
21253
21254 X and Y are coordinates of the first glyph in the frame's desired
21255 matrix to be overwritten by the menu item. Since this is a TTY, Y
21256 is the zero-based number of the glyph row and X is the zero-based
21257 glyph number in the row, starting from left, where to start
21258 displaying the item.
21259
21260 SUBMENU non-zero means this menu item drops down a submenu, which
21261 should be indicated by displaying a proper visual cue after the
21262 item text. */
21263
21264 void
21265 display_tty_menu_item (const char *item_text, int width, int face_id,
21266 int x, int y, int submenu)
21267 {
21268 struct it it;
21269 struct frame *f = SELECTED_FRAME ();
21270 struct window *w = XWINDOW (f->selected_window);
21271 int saved_used, saved_truncated, saved_width, saved_reversed;
21272 struct glyph_row *row;
21273 size_t item_len = strlen (item_text);
21274
21275 eassert (FRAME_TERMCAP_P (f));
21276
21277 /* Don't write beyond the matrix's last row. This can happen for
21278 TTY screens that are not high enough to show the entire menu.
21279 (This is actually a bit of defensive programming, as
21280 tty_menu_display already limits the number of menu items to one
21281 less than the number of screen lines.) */
21282 if (y >= f->desired_matrix->nrows)
21283 return;
21284
21285 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
21286 it.first_visible_x = 0;
21287 it.last_visible_x = FRAME_COLS (f) - 1;
21288 row = it.glyph_row;
21289 /* Start with the row contents from the current matrix. */
21290 deep_copy_glyph_row (row, f->current_matrix->rows + y);
21291 saved_width = row->full_width_p;
21292 row->full_width_p = 1;
21293 saved_reversed = row->reversed_p;
21294 row->reversed_p = 0;
21295 row->enabled_p = true;
21296
21297 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21298 desired face. */
21299 eassert (x < f->desired_matrix->matrix_w);
21300 it.current_x = it.hpos = x;
21301 it.current_y = it.vpos = y;
21302 saved_used = row->used[TEXT_AREA];
21303 saved_truncated = row->truncated_on_right_p;
21304 row->used[TEXT_AREA] = x;
21305 it.face_id = face_id;
21306 it.line_wrap = TRUNCATE;
21307
21308 /* FIXME: This should be controlled by a user option. See the
21309 comments in redisplay_tool_bar and display_mode_line about this.
21310 Also, if paragraph_embedding could ever be R2L, changes will be
21311 needed to avoid shifting to the right the row characters in
21312 term.c:append_glyph. */
21313 it.paragraph_embedding = L2R;
21314
21315 /* Pad with a space on the left. */
21316 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
21317 width--;
21318 /* Display the menu item, pad with spaces to WIDTH. */
21319 if (submenu)
21320 {
21321 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21322 item_len, 0, FRAME_COLS (f) - 1, -1);
21323 width -= item_len;
21324 /* Indicate with " >" that there's a submenu. */
21325 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
21326 FRAME_COLS (f) - 1, -1);
21327 }
21328 else
21329 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21330 width, 0, FRAME_COLS (f) - 1, -1);
21331
21332 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
21333 row->truncated_on_right_p = saved_truncated;
21334 row->hash = row_hash (row);
21335 row->full_width_p = saved_width;
21336 row->reversed_p = saved_reversed;
21337 }
21338 \f
21339 /***********************************************************************
21340 Mode Line
21341 ***********************************************************************/
21342
21343 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21344 FORCE is non-zero, redisplay mode lines unconditionally.
21345 Otherwise, redisplay only mode lines that are garbaged. Value is
21346 the number of windows whose mode lines were redisplayed. */
21347
21348 static int
21349 redisplay_mode_lines (Lisp_Object window, bool force)
21350 {
21351 int nwindows = 0;
21352
21353 while (!NILP (window))
21354 {
21355 struct window *w = XWINDOW (window);
21356
21357 if (WINDOWP (w->contents))
21358 nwindows += redisplay_mode_lines (w->contents, force);
21359 else if (force
21360 || FRAME_GARBAGED_P (XFRAME (w->frame))
21361 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
21362 {
21363 struct text_pos lpoint;
21364 struct buffer *old = current_buffer;
21365
21366 /* Set the window's buffer for the mode line display. */
21367 SET_TEXT_POS (lpoint, PT, PT_BYTE);
21368 set_buffer_internal_1 (XBUFFER (w->contents));
21369
21370 /* Point refers normally to the selected window. For any
21371 other window, set up appropriate value. */
21372 if (!EQ (window, selected_window))
21373 {
21374 struct text_pos pt;
21375
21376 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
21377 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
21378 }
21379
21380 /* Display mode lines. */
21381 clear_glyph_matrix (w->desired_matrix);
21382 if (display_mode_lines (w))
21383 ++nwindows;
21384
21385 /* Restore old settings. */
21386 set_buffer_internal_1 (old);
21387 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
21388 }
21389
21390 window = w->next;
21391 }
21392
21393 return nwindows;
21394 }
21395
21396
21397 /* Display the mode and/or header line of window W. Value is the
21398 sum number of mode lines and header lines displayed. */
21399
21400 static int
21401 display_mode_lines (struct window *w)
21402 {
21403 Lisp_Object old_selected_window = selected_window;
21404 Lisp_Object old_selected_frame = selected_frame;
21405 Lisp_Object new_frame = w->frame;
21406 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
21407 int n = 0;
21408
21409 selected_frame = new_frame;
21410 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21411 or window's point, then we'd need select_window_1 here as well. */
21412 XSETWINDOW (selected_window, w);
21413 XFRAME (new_frame)->selected_window = selected_window;
21414
21415 /* These will be set while the mode line specs are processed. */
21416 line_number_displayed = 0;
21417 w->column_number_displayed = -1;
21418
21419 if (WINDOW_WANTS_MODELINE_P (w))
21420 {
21421 struct window *sel_w = XWINDOW (old_selected_window);
21422
21423 /* Select mode line face based on the real selected window. */
21424 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
21425 BVAR (current_buffer, mode_line_format));
21426 ++n;
21427 }
21428
21429 if (WINDOW_WANTS_HEADER_LINE_P (w))
21430 {
21431 display_mode_line (w, HEADER_LINE_FACE_ID,
21432 BVAR (current_buffer, header_line_format));
21433 ++n;
21434 }
21435
21436 XFRAME (new_frame)->selected_window = old_frame_selected_window;
21437 selected_frame = old_selected_frame;
21438 selected_window = old_selected_window;
21439 if (n > 0)
21440 w->must_be_updated_p = true;
21441 return n;
21442 }
21443
21444
21445 /* Display mode or header line of window W. FACE_ID specifies which
21446 line to display; it is either MODE_LINE_FACE_ID or
21447 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21448 display. Value is the pixel height of the mode/header line
21449 displayed. */
21450
21451 static int
21452 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
21453 {
21454 struct it it;
21455 struct face *face;
21456 ptrdiff_t count = SPECPDL_INDEX ();
21457
21458 init_iterator (&it, w, -1, -1, NULL, face_id);
21459 /* Don't extend on a previously drawn mode-line.
21460 This may happen if called from pos_visible_p. */
21461 it.glyph_row->enabled_p = false;
21462 prepare_desired_row (it.glyph_row);
21463
21464 it.glyph_row->mode_line_p = 1;
21465
21466 /* FIXME: This should be controlled by a user option. But
21467 supporting such an option is not trivial, since the mode line is
21468 made up of many separate strings. */
21469 it.paragraph_embedding = L2R;
21470
21471 record_unwind_protect (unwind_format_mode_line,
21472 format_mode_line_unwind_data (NULL, NULL, Qnil, 0));
21473
21474 mode_line_target = MODE_LINE_DISPLAY;
21475
21476 /* Temporarily make frame's keyboard the current kboard so that
21477 kboard-local variables in the mode_line_format will get the right
21478 values. */
21479 push_kboard (FRAME_KBOARD (it.f));
21480 record_unwind_save_match_data ();
21481 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
21482 pop_kboard ();
21483
21484 unbind_to (count, Qnil);
21485
21486 /* Fill up with spaces. */
21487 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
21488
21489 compute_line_metrics (&it);
21490 it.glyph_row->full_width_p = 1;
21491 it.glyph_row->continued_p = 0;
21492 it.glyph_row->truncated_on_left_p = 0;
21493 it.glyph_row->truncated_on_right_p = 0;
21494
21495 /* Make a 3D mode-line have a shadow at its right end. */
21496 face = FACE_FROM_ID (it.f, face_id);
21497 extend_face_to_end_of_line (&it);
21498 if (face->box != FACE_NO_BOX)
21499 {
21500 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
21501 + it.glyph_row->used[TEXT_AREA] - 1);
21502 last->right_box_line_p = 1;
21503 }
21504
21505 return it.glyph_row->height;
21506 }
21507
21508 /* Move element ELT in LIST to the front of LIST.
21509 Return the updated list. */
21510
21511 static Lisp_Object
21512 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
21513 {
21514 register Lisp_Object tail, prev;
21515 register Lisp_Object tem;
21516
21517 tail = list;
21518 prev = Qnil;
21519 while (CONSP (tail))
21520 {
21521 tem = XCAR (tail);
21522
21523 if (EQ (elt, tem))
21524 {
21525 /* Splice out the link TAIL. */
21526 if (NILP (prev))
21527 list = XCDR (tail);
21528 else
21529 Fsetcdr (prev, XCDR (tail));
21530
21531 /* Now make it the first. */
21532 Fsetcdr (tail, list);
21533 return tail;
21534 }
21535 else
21536 prev = tail;
21537 tail = XCDR (tail);
21538 QUIT;
21539 }
21540
21541 /* Not found--return unchanged LIST. */
21542 return list;
21543 }
21544
21545 /* Contribute ELT to the mode line for window IT->w. How it
21546 translates into text depends on its data type.
21547
21548 IT describes the display environment in which we display, as usual.
21549
21550 DEPTH is the depth in recursion. It is used to prevent
21551 infinite recursion here.
21552
21553 FIELD_WIDTH is the number of characters the display of ELT should
21554 occupy in the mode line, and PRECISION is the maximum number of
21555 characters to display from ELT's representation. See
21556 display_string for details.
21557
21558 Returns the hpos of the end of the text generated by ELT.
21559
21560 PROPS is a property list to add to any string we encounter.
21561
21562 If RISKY is nonzero, remove (disregard) any properties in any string
21563 we encounter, and ignore :eval and :propertize.
21564
21565 The global variable `mode_line_target' determines whether the
21566 output is passed to `store_mode_line_noprop',
21567 `store_mode_line_string', or `display_string'. */
21568
21569 static int
21570 display_mode_element (struct it *it, int depth, int field_width, int precision,
21571 Lisp_Object elt, Lisp_Object props, int risky)
21572 {
21573 int n = 0, field, prec;
21574 int literal = 0;
21575
21576 tail_recurse:
21577 if (depth > 100)
21578 elt = build_string ("*too-deep*");
21579
21580 depth++;
21581
21582 switch (XTYPE (elt))
21583 {
21584 case Lisp_String:
21585 {
21586 /* A string: output it and check for %-constructs within it. */
21587 unsigned char c;
21588 ptrdiff_t offset = 0;
21589
21590 if (SCHARS (elt) > 0
21591 && (!NILP (props) || risky))
21592 {
21593 Lisp_Object oprops, aelt;
21594 oprops = Ftext_properties_at (make_number (0), elt);
21595
21596 /* If the starting string's properties are not what
21597 we want, translate the string. Also, if the string
21598 is risky, do that anyway. */
21599
21600 if (NILP (Fequal (props, oprops)) || risky)
21601 {
21602 /* If the starting string has properties,
21603 merge the specified ones onto the existing ones. */
21604 if (! NILP (oprops) && !risky)
21605 {
21606 Lisp_Object tem;
21607
21608 oprops = Fcopy_sequence (oprops);
21609 tem = props;
21610 while (CONSP (tem))
21611 {
21612 oprops = Fplist_put (oprops, XCAR (tem),
21613 XCAR (XCDR (tem)));
21614 tem = XCDR (XCDR (tem));
21615 }
21616 props = oprops;
21617 }
21618
21619 aelt = Fassoc (elt, mode_line_proptrans_alist);
21620 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
21621 {
21622 /* AELT is what we want. Move it to the front
21623 without consing. */
21624 elt = XCAR (aelt);
21625 mode_line_proptrans_alist
21626 = move_elt_to_front (aelt, mode_line_proptrans_alist);
21627 }
21628 else
21629 {
21630 Lisp_Object tem;
21631
21632 /* If AELT has the wrong props, it is useless.
21633 so get rid of it. */
21634 if (! NILP (aelt))
21635 mode_line_proptrans_alist
21636 = Fdelq (aelt, mode_line_proptrans_alist);
21637
21638 elt = Fcopy_sequence (elt);
21639 Fset_text_properties (make_number (0), Flength (elt),
21640 props, elt);
21641 /* Add this item to mode_line_proptrans_alist. */
21642 mode_line_proptrans_alist
21643 = Fcons (Fcons (elt, props),
21644 mode_line_proptrans_alist);
21645 /* Truncate mode_line_proptrans_alist
21646 to at most 50 elements. */
21647 tem = Fnthcdr (make_number (50),
21648 mode_line_proptrans_alist);
21649 if (! NILP (tem))
21650 XSETCDR (tem, Qnil);
21651 }
21652 }
21653 }
21654
21655 offset = 0;
21656
21657 if (literal)
21658 {
21659 prec = precision - n;
21660 switch (mode_line_target)
21661 {
21662 case MODE_LINE_NOPROP:
21663 case MODE_LINE_TITLE:
21664 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
21665 break;
21666 case MODE_LINE_STRING:
21667 n += store_mode_line_string (NULL, elt, 1, 0, prec, Qnil);
21668 break;
21669 case MODE_LINE_DISPLAY:
21670 n += display_string (NULL, elt, Qnil, 0, 0, it,
21671 0, prec, 0, STRING_MULTIBYTE (elt));
21672 break;
21673 }
21674
21675 break;
21676 }
21677
21678 /* Handle the non-literal case. */
21679
21680 while ((precision <= 0 || n < precision)
21681 && SREF (elt, offset) != 0
21682 && (mode_line_target != MODE_LINE_DISPLAY
21683 || it->current_x < it->last_visible_x))
21684 {
21685 ptrdiff_t last_offset = offset;
21686
21687 /* Advance to end of string or next format specifier. */
21688 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
21689 ;
21690
21691 if (offset - 1 != last_offset)
21692 {
21693 ptrdiff_t nchars, nbytes;
21694
21695 /* Output to end of string or up to '%'. Field width
21696 is length of string. Don't output more than
21697 PRECISION allows us. */
21698 offset--;
21699
21700 prec = c_string_width (SDATA (elt) + last_offset,
21701 offset - last_offset, precision - n,
21702 &nchars, &nbytes);
21703
21704 switch (mode_line_target)
21705 {
21706 case MODE_LINE_NOPROP:
21707 case MODE_LINE_TITLE:
21708 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
21709 break;
21710 case MODE_LINE_STRING:
21711 {
21712 ptrdiff_t bytepos = last_offset;
21713 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
21714 ptrdiff_t endpos = (precision <= 0
21715 ? string_byte_to_char (elt, offset)
21716 : charpos + nchars);
21717
21718 n += store_mode_line_string (NULL,
21719 Fsubstring (elt, make_number (charpos),
21720 make_number (endpos)),
21721 0, 0, 0, Qnil);
21722 }
21723 break;
21724 case MODE_LINE_DISPLAY:
21725 {
21726 ptrdiff_t bytepos = last_offset;
21727 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
21728
21729 if (precision <= 0)
21730 nchars = string_byte_to_char (elt, offset) - charpos;
21731 n += display_string (NULL, elt, Qnil, 0, charpos,
21732 it, 0, nchars, 0,
21733 STRING_MULTIBYTE (elt));
21734 }
21735 break;
21736 }
21737 }
21738 else /* c == '%' */
21739 {
21740 ptrdiff_t percent_position = offset;
21741
21742 /* Get the specified minimum width. Zero means
21743 don't pad. */
21744 field = 0;
21745 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
21746 field = field * 10 + c - '0';
21747
21748 /* Don't pad beyond the total padding allowed. */
21749 if (field_width - n > 0 && field > field_width - n)
21750 field = field_width - n;
21751
21752 /* Note that either PRECISION <= 0 or N < PRECISION. */
21753 prec = precision - n;
21754
21755 if (c == 'M')
21756 n += display_mode_element (it, depth, field, prec,
21757 Vglobal_mode_string, props,
21758 risky);
21759 else if (c != 0)
21760 {
21761 bool multibyte;
21762 ptrdiff_t bytepos, charpos;
21763 const char *spec;
21764 Lisp_Object string;
21765
21766 bytepos = percent_position;
21767 charpos = (STRING_MULTIBYTE (elt)
21768 ? string_byte_to_char (elt, bytepos)
21769 : bytepos);
21770 spec = decode_mode_spec (it->w, c, field, &string);
21771 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
21772
21773 switch (mode_line_target)
21774 {
21775 case MODE_LINE_NOPROP:
21776 case MODE_LINE_TITLE:
21777 n += store_mode_line_noprop (spec, field, prec);
21778 break;
21779 case MODE_LINE_STRING:
21780 {
21781 Lisp_Object tem = build_string (spec);
21782 props = Ftext_properties_at (make_number (charpos), elt);
21783 /* Should only keep face property in props */
21784 n += store_mode_line_string (NULL, tem, 0, field, prec, props);
21785 }
21786 break;
21787 case MODE_LINE_DISPLAY:
21788 {
21789 int nglyphs_before, nwritten;
21790
21791 nglyphs_before = it->glyph_row->used[TEXT_AREA];
21792 nwritten = display_string (spec, string, elt,
21793 charpos, 0, it,
21794 field, prec, 0,
21795 multibyte);
21796
21797 /* Assign to the glyphs written above the
21798 string where the `%x' came from, position
21799 of the `%'. */
21800 if (nwritten > 0)
21801 {
21802 struct glyph *glyph
21803 = (it->glyph_row->glyphs[TEXT_AREA]
21804 + nglyphs_before);
21805 int i;
21806
21807 for (i = 0; i < nwritten; ++i)
21808 {
21809 glyph[i].object = elt;
21810 glyph[i].charpos = charpos;
21811 }
21812
21813 n += nwritten;
21814 }
21815 }
21816 break;
21817 }
21818 }
21819 else /* c == 0 */
21820 break;
21821 }
21822 }
21823 }
21824 break;
21825
21826 case Lisp_Symbol:
21827 /* A symbol: process the value of the symbol recursively
21828 as if it appeared here directly. Avoid error if symbol void.
21829 Special case: if value of symbol is a string, output the string
21830 literally. */
21831 {
21832 register Lisp_Object tem;
21833
21834 /* If the variable is not marked as risky to set
21835 then its contents are risky to use. */
21836 if (NILP (Fget (elt, Qrisky_local_variable)))
21837 risky = 1;
21838
21839 tem = Fboundp (elt);
21840 if (!NILP (tem))
21841 {
21842 tem = Fsymbol_value (elt);
21843 /* If value is a string, output that string literally:
21844 don't check for % within it. */
21845 if (STRINGP (tem))
21846 literal = 1;
21847
21848 if (!EQ (tem, elt))
21849 {
21850 /* Give up right away for nil or t. */
21851 elt = tem;
21852 goto tail_recurse;
21853 }
21854 }
21855 }
21856 break;
21857
21858 case Lisp_Cons:
21859 {
21860 register Lisp_Object car, tem;
21861
21862 /* A cons cell: five distinct cases.
21863 If first element is :eval or :propertize, do something special.
21864 If first element is a string or a cons, process all the elements
21865 and effectively concatenate them.
21866 If first element is a negative number, truncate displaying cdr to
21867 at most that many characters. If positive, pad (with spaces)
21868 to at least that many characters.
21869 If first element is a symbol, process the cadr or caddr recursively
21870 according to whether the symbol's value is non-nil or nil. */
21871 car = XCAR (elt);
21872 if (EQ (car, QCeval))
21873 {
21874 /* An element of the form (:eval FORM) means evaluate FORM
21875 and use the result as mode line elements. */
21876
21877 if (risky)
21878 break;
21879
21880 if (CONSP (XCDR (elt)))
21881 {
21882 Lisp_Object spec;
21883 spec = safe__eval (true, XCAR (XCDR (elt)));
21884 n += display_mode_element (it, depth, field_width - n,
21885 precision - n, spec, props,
21886 risky);
21887 }
21888 }
21889 else if (EQ (car, QCpropertize))
21890 {
21891 /* An element of the form (:propertize ELT PROPS...)
21892 means display ELT but applying properties PROPS. */
21893
21894 if (risky)
21895 break;
21896
21897 if (CONSP (XCDR (elt)))
21898 n += display_mode_element (it, depth, field_width - n,
21899 precision - n, XCAR (XCDR (elt)),
21900 XCDR (XCDR (elt)), risky);
21901 }
21902 else if (SYMBOLP (car))
21903 {
21904 tem = Fboundp (car);
21905 elt = XCDR (elt);
21906 if (!CONSP (elt))
21907 goto invalid;
21908 /* elt is now the cdr, and we know it is a cons cell.
21909 Use its car if CAR has a non-nil value. */
21910 if (!NILP (tem))
21911 {
21912 tem = Fsymbol_value (car);
21913 if (!NILP (tem))
21914 {
21915 elt = XCAR (elt);
21916 goto tail_recurse;
21917 }
21918 }
21919 /* Symbol's value is nil (or symbol is unbound)
21920 Get the cddr of the original list
21921 and if possible find the caddr and use that. */
21922 elt = XCDR (elt);
21923 if (NILP (elt))
21924 break;
21925 else if (!CONSP (elt))
21926 goto invalid;
21927 elt = XCAR (elt);
21928 goto tail_recurse;
21929 }
21930 else if (INTEGERP (car))
21931 {
21932 register int lim = XINT (car);
21933 elt = XCDR (elt);
21934 if (lim < 0)
21935 {
21936 /* Negative int means reduce maximum width. */
21937 if (precision <= 0)
21938 precision = -lim;
21939 else
21940 precision = min (precision, -lim);
21941 }
21942 else if (lim > 0)
21943 {
21944 /* Padding specified. Don't let it be more than
21945 current maximum. */
21946 if (precision > 0)
21947 lim = min (precision, lim);
21948
21949 /* If that's more padding than already wanted, queue it.
21950 But don't reduce padding already specified even if
21951 that is beyond the current truncation point. */
21952 field_width = max (lim, field_width);
21953 }
21954 goto tail_recurse;
21955 }
21956 else if (STRINGP (car) || CONSP (car))
21957 {
21958 Lisp_Object halftail = elt;
21959 int len = 0;
21960
21961 while (CONSP (elt)
21962 && (precision <= 0 || n < precision))
21963 {
21964 n += display_mode_element (it, depth,
21965 /* Do padding only after the last
21966 element in the list. */
21967 (! CONSP (XCDR (elt))
21968 ? field_width - n
21969 : 0),
21970 precision - n, XCAR (elt),
21971 props, risky);
21972 elt = XCDR (elt);
21973 len++;
21974 if ((len & 1) == 0)
21975 halftail = XCDR (halftail);
21976 /* Check for cycle. */
21977 if (EQ (halftail, elt))
21978 break;
21979 }
21980 }
21981 }
21982 break;
21983
21984 default:
21985 invalid:
21986 elt = build_string ("*invalid*");
21987 goto tail_recurse;
21988 }
21989
21990 /* Pad to FIELD_WIDTH. */
21991 if (field_width > 0 && n < field_width)
21992 {
21993 switch (mode_line_target)
21994 {
21995 case MODE_LINE_NOPROP:
21996 case MODE_LINE_TITLE:
21997 n += store_mode_line_noprop ("", field_width - n, 0);
21998 break;
21999 case MODE_LINE_STRING:
22000 n += store_mode_line_string ("", Qnil, 0, field_width - n, 0, Qnil);
22001 break;
22002 case MODE_LINE_DISPLAY:
22003 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22004 0, 0, 0);
22005 break;
22006 }
22007 }
22008
22009 return n;
22010 }
22011
22012 /* Store a mode-line string element in mode_line_string_list.
22013
22014 If STRING is non-null, display that C string. Otherwise, the Lisp
22015 string LISP_STRING is displayed.
22016
22017 FIELD_WIDTH is the minimum number of output glyphs to produce.
22018 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22019 with spaces. FIELD_WIDTH <= 0 means don't pad.
22020
22021 PRECISION is the maximum number of characters to output from
22022 STRING. PRECISION <= 0 means don't truncate the string.
22023
22024 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22025 properties to the string.
22026
22027 PROPS are the properties to add to the string.
22028 The mode_line_string_face face property is always added to the string.
22029 */
22030
22031 static int
22032 store_mode_line_string (const char *string, Lisp_Object lisp_string, int copy_string,
22033 int field_width, int precision, Lisp_Object props)
22034 {
22035 ptrdiff_t len;
22036 int n = 0;
22037
22038 if (string != NULL)
22039 {
22040 len = strlen (string);
22041 if (precision > 0 && len > precision)
22042 len = precision;
22043 lisp_string = make_string (string, len);
22044 if (NILP (props))
22045 props = mode_line_string_face_prop;
22046 else if (!NILP (mode_line_string_face))
22047 {
22048 Lisp_Object face = Fplist_get (props, Qface);
22049 props = Fcopy_sequence (props);
22050 if (NILP (face))
22051 face = mode_line_string_face;
22052 else
22053 face = list2 (face, mode_line_string_face);
22054 props = Fplist_put (props, Qface, face);
22055 }
22056 Fadd_text_properties (make_number (0), make_number (len),
22057 props, lisp_string);
22058 }
22059 else
22060 {
22061 len = XFASTINT (Flength (lisp_string));
22062 if (precision > 0 && len > precision)
22063 {
22064 len = precision;
22065 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
22066 precision = -1;
22067 }
22068 if (!NILP (mode_line_string_face))
22069 {
22070 Lisp_Object face;
22071 if (NILP (props))
22072 props = Ftext_properties_at (make_number (0), lisp_string);
22073 face = Fplist_get (props, Qface);
22074 if (NILP (face))
22075 face = mode_line_string_face;
22076 else
22077 face = list2 (face, mode_line_string_face);
22078 props = list2 (Qface, face);
22079 if (copy_string)
22080 lisp_string = Fcopy_sequence (lisp_string);
22081 }
22082 if (!NILP (props))
22083 Fadd_text_properties (make_number (0), make_number (len),
22084 props, lisp_string);
22085 }
22086
22087 if (len > 0)
22088 {
22089 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22090 n += len;
22091 }
22092
22093 if (field_width > len)
22094 {
22095 field_width -= len;
22096 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
22097 if (!NILP (props))
22098 Fadd_text_properties (make_number (0), make_number (field_width),
22099 props, lisp_string);
22100 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22101 n += field_width;
22102 }
22103
22104 return n;
22105 }
22106
22107
22108 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
22109 1, 4, 0,
22110 doc: /* Format a string out of a mode line format specification.
22111 First arg FORMAT specifies the mode line format (see `mode-line-format'
22112 for details) to use.
22113
22114 By default, the format is evaluated for the currently selected window.
22115
22116 Optional second arg FACE specifies the face property to put on all
22117 characters for which no face is specified. The value nil means the
22118 default face. The value t means whatever face the window's mode line
22119 currently uses (either `mode-line' or `mode-line-inactive',
22120 depending on whether the window is the selected window or not).
22121 An integer value means the value string has no text
22122 properties.
22123
22124 Optional third and fourth args WINDOW and BUFFER specify the window
22125 and buffer to use as the context for the formatting (defaults
22126 are the selected window and the WINDOW's buffer). */)
22127 (Lisp_Object format, Lisp_Object face,
22128 Lisp_Object window, Lisp_Object buffer)
22129 {
22130 struct it it;
22131 int len;
22132 struct window *w;
22133 struct buffer *old_buffer = NULL;
22134 int face_id;
22135 int no_props = INTEGERP (face);
22136 ptrdiff_t count = SPECPDL_INDEX ();
22137 Lisp_Object str;
22138 int string_start = 0;
22139
22140 w = decode_any_window (window);
22141 XSETWINDOW (window, w);
22142
22143 if (NILP (buffer))
22144 buffer = w->contents;
22145 CHECK_BUFFER (buffer);
22146
22147 /* Make formatting the modeline a non-op when noninteractive, otherwise
22148 there will be problems later caused by a partially initialized frame. */
22149 if (NILP (format) || noninteractive)
22150 return empty_unibyte_string;
22151
22152 if (no_props)
22153 face = Qnil;
22154
22155 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
22156 : EQ (face, Qt) ? (EQ (window, selected_window)
22157 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
22158 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
22159 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
22160 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
22161 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
22162 : DEFAULT_FACE_ID;
22163
22164 old_buffer = current_buffer;
22165
22166 /* Save things including mode_line_proptrans_alist,
22167 and set that to nil so that we don't alter the outer value. */
22168 record_unwind_protect (unwind_format_mode_line,
22169 format_mode_line_unwind_data
22170 (XFRAME (WINDOW_FRAME (w)),
22171 old_buffer, selected_window, 1));
22172 mode_line_proptrans_alist = Qnil;
22173
22174 Fselect_window (window, Qt);
22175 set_buffer_internal_1 (XBUFFER (buffer));
22176
22177 init_iterator (&it, w, -1, -1, NULL, face_id);
22178
22179 if (no_props)
22180 {
22181 mode_line_target = MODE_LINE_NOPROP;
22182 mode_line_string_face_prop = Qnil;
22183 mode_line_string_list = Qnil;
22184 string_start = MODE_LINE_NOPROP_LEN (0);
22185 }
22186 else
22187 {
22188 mode_line_target = MODE_LINE_STRING;
22189 mode_line_string_list = Qnil;
22190 mode_line_string_face = face;
22191 mode_line_string_face_prop
22192 = NILP (face) ? Qnil : list2 (Qface, face);
22193 }
22194
22195 push_kboard (FRAME_KBOARD (it.f));
22196 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
22197 pop_kboard ();
22198
22199 if (no_props)
22200 {
22201 len = MODE_LINE_NOPROP_LEN (string_start);
22202 str = make_string (mode_line_noprop_buf + string_start, len);
22203 }
22204 else
22205 {
22206 mode_line_string_list = Fnreverse (mode_line_string_list);
22207 str = Fmapconcat (intern ("identity"), mode_line_string_list,
22208 empty_unibyte_string);
22209 }
22210
22211 unbind_to (count, Qnil);
22212 return str;
22213 }
22214
22215 /* Write a null-terminated, right justified decimal representation of
22216 the positive integer D to BUF using a minimal field width WIDTH. */
22217
22218 static void
22219 pint2str (register char *buf, register int width, register ptrdiff_t d)
22220 {
22221 register char *p = buf;
22222
22223 if (d <= 0)
22224 *p++ = '0';
22225 else
22226 {
22227 while (d > 0)
22228 {
22229 *p++ = d % 10 + '0';
22230 d /= 10;
22231 }
22232 }
22233
22234 for (width -= (int) (p - buf); width > 0; --width)
22235 *p++ = ' ';
22236 *p-- = '\0';
22237 while (p > buf)
22238 {
22239 d = *buf;
22240 *buf++ = *p;
22241 *p-- = d;
22242 }
22243 }
22244
22245 /* Write a null-terminated, right justified decimal and "human
22246 readable" representation of the nonnegative integer D to BUF using
22247 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22248
22249 static const char power_letter[] =
22250 {
22251 0, /* no letter */
22252 'k', /* kilo */
22253 'M', /* mega */
22254 'G', /* giga */
22255 'T', /* tera */
22256 'P', /* peta */
22257 'E', /* exa */
22258 'Z', /* zetta */
22259 'Y' /* yotta */
22260 };
22261
22262 static void
22263 pint2hrstr (char *buf, int width, ptrdiff_t d)
22264 {
22265 /* We aim to represent the nonnegative integer D as
22266 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22267 ptrdiff_t quotient = d;
22268 int remainder = 0;
22269 /* -1 means: do not use TENTHS. */
22270 int tenths = -1;
22271 int exponent = 0;
22272
22273 /* Length of QUOTIENT.TENTHS as a string. */
22274 int length;
22275
22276 char * psuffix;
22277 char * p;
22278
22279 if (quotient >= 1000)
22280 {
22281 /* Scale to the appropriate EXPONENT. */
22282 do
22283 {
22284 remainder = quotient % 1000;
22285 quotient /= 1000;
22286 exponent++;
22287 }
22288 while (quotient >= 1000);
22289
22290 /* Round to nearest and decide whether to use TENTHS or not. */
22291 if (quotient <= 9)
22292 {
22293 tenths = remainder / 100;
22294 if (remainder % 100 >= 50)
22295 {
22296 if (tenths < 9)
22297 tenths++;
22298 else
22299 {
22300 quotient++;
22301 if (quotient == 10)
22302 tenths = -1;
22303 else
22304 tenths = 0;
22305 }
22306 }
22307 }
22308 else
22309 if (remainder >= 500)
22310 {
22311 if (quotient < 999)
22312 quotient++;
22313 else
22314 {
22315 quotient = 1;
22316 exponent++;
22317 tenths = 0;
22318 }
22319 }
22320 }
22321
22322 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22323 if (tenths == -1 && quotient <= 99)
22324 if (quotient <= 9)
22325 length = 1;
22326 else
22327 length = 2;
22328 else
22329 length = 3;
22330 p = psuffix = buf + max (width, length);
22331
22332 /* Print EXPONENT. */
22333 *psuffix++ = power_letter[exponent];
22334 *psuffix = '\0';
22335
22336 /* Print TENTHS. */
22337 if (tenths >= 0)
22338 {
22339 *--p = '0' + tenths;
22340 *--p = '.';
22341 }
22342
22343 /* Print QUOTIENT. */
22344 do
22345 {
22346 int digit = quotient % 10;
22347 *--p = '0' + digit;
22348 }
22349 while ((quotient /= 10) != 0);
22350
22351 /* Print leading spaces. */
22352 while (buf < p)
22353 *--p = ' ';
22354 }
22355
22356 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22357 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22358 type of CODING_SYSTEM. Return updated pointer into BUF. */
22359
22360 static unsigned char invalid_eol_type[] = "(*invalid*)";
22361
22362 static char *
22363 decode_mode_spec_coding (Lisp_Object coding_system, register char *buf, int eol_flag)
22364 {
22365 Lisp_Object val;
22366 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
22367 const unsigned char *eol_str;
22368 int eol_str_len;
22369 /* The EOL conversion we are using. */
22370 Lisp_Object eoltype;
22371
22372 val = CODING_SYSTEM_SPEC (coding_system);
22373 eoltype = Qnil;
22374
22375 if (!VECTORP (val)) /* Not yet decided. */
22376 {
22377 *buf++ = multibyte ? '-' : ' ';
22378 if (eol_flag)
22379 eoltype = eol_mnemonic_undecided;
22380 /* Don't mention EOL conversion if it isn't decided. */
22381 }
22382 else
22383 {
22384 Lisp_Object attrs;
22385 Lisp_Object eolvalue;
22386
22387 attrs = AREF (val, 0);
22388 eolvalue = AREF (val, 2);
22389
22390 *buf++ = multibyte
22391 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
22392 : ' ';
22393
22394 if (eol_flag)
22395 {
22396 /* The EOL conversion that is normal on this system. */
22397
22398 if (NILP (eolvalue)) /* Not yet decided. */
22399 eoltype = eol_mnemonic_undecided;
22400 else if (VECTORP (eolvalue)) /* Not yet decided. */
22401 eoltype = eol_mnemonic_undecided;
22402 else /* eolvalue is Qunix, Qdos, or Qmac. */
22403 eoltype = (EQ (eolvalue, Qunix)
22404 ? eol_mnemonic_unix
22405 : (EQ (eolvalue, Qdos) == 1
22406 ? eol_mnemonic_dos : eol_mnemonic_mac));
22407 }
22408 }
22409
22410 if (eol_flag)
22411 {
22412 /* Mention the EOL conversion if it is not the usual one. */
22413 if (STRINGP (eoltype))
22414 {
22415 eol_str = SDATA (eoltype);
22416 eol_str_len = SBYTES (eoltype);
22417 }
22418 else if (CHARACTERP (eoltype))
22419 {
22420 unsigned char *tmp = alloca (MAX_MULTIBYTE_LENGTH);
22421 int c = XFASTINT (eoltype);
22422 eol_str_len = CHAR_STRING (c, tmp);
22423 eol_str = tmp;
22424 }
22425 else
22426 {
22427 eol_str = invalid_eol_type;
22428 eol_str_len = sizeof (invalid_eol_type) - 1;
22429 }
22430 memcpy (buf, eol_str, eol_str_len);
22431 buf += eol_str_len;
22432 }
22433
22434 return buf;
22435 }
22436
22437 /* Return a string for the output of a mode line %-spec for window W,
22438 generated by character C. FIELD_WIDTH > 0 means pad the string
22439 returned with spaces to that value. Return a Lisp string in
22440 *STRING if the resulting string is taken from that Lisp string.
22441
22442 Note we operate on the current buffer for most purposes. */
22443
22444 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22445
22446 static const char *
22447 decode_mode_spec (struct window *w, register int c, int field_width,
22448 Lisp_Object *string)
22449 {
22450 Lisp_Object obj;
22451 struct frame *f = XFRAME (WINDOW_FRAME (w));
22452 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
22453 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22454 produce strings from numerical values, so limit preposterously
22455 large values of FIELD_WIDTH to avoid overrunning the buffer's
22456 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22457 bytes plus the terminating null. */
22458 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
22459 struct buffer *b = current_buffer;
22460
22461 obj = Qnil;
22462 *string = Qnil;
22463
22464 switch (c)
22465 {
22466 case '*':
22467 if (!NILP (BVAR (b, read_only)))
22468 return "%";
22469 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22470 return "*";
22471 return "-";
22472
22473 case '+':
22474 /* This differs from %* only for a modified read-only buffer. */
22475 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22476 return "*";
22477 if (!NILP (BVAR (b, read_only)))
22478 return "%";
22479 return "-";
22480
22481 case '&':
22482 /* This differs from %* in ignoring read-only-ness. */
22483 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22484 return "*";
22485 return "-";
22486
22487 case '%':
22488 return "%";
22489
22490 case '[':
22491 {
22492 int i;
22493 char *p;
22494
22495 if (command_loop_level > 5)
22496 return "[[[... ";
22497 p = decode_mode_spec_buf;
22498 for (i = 0; i < command_loop_level; i++)
22499 *p++ = '[';
22500 *p = 0;
22501 return decode_mode_spec_buf;
22502 }
22503
22504 case ']':
22505 {
22506 int i;
22507 char *p;
22508
22509 if (command_loop_level > 5)
22510 return " ...]]]";
22511 p = decode_mode_spec_buf;
22512 for (i = 0; i < command_loop_level; i++)
22513 *p++ = ']';
22514 *p = 0;
22515 return decode_mode_spec_buf;
22516 }
22517
22518 case '-':
22519 {
22520 register int i;
22521
22522 /* Let lots_of_dashes be a string of infinite length. */
22523 if (mode_line_target == MODE_LINE_NOPROP
22524 || mode_line_target == MODE_LINE_STRING)
22525 return "--";
22526 if (field_width <= 0
22527 || field_width > sizeof (lots_of_dashes))
22528 {
22529 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
22530 decode_mode_spec_buf[i] = '-';
22531 decode_mode_spec_buf[i] = '\0';
22532 return decode_mode_spec_buf;
22533 }
22534 else
22535 return lots_of_dashes;
22536 }
22537
22538 case 'b':
22539 obj = BVAR (b, name);
22540 break;
22541
22542 case 'c':
22543 /* %c and %l are ignored in `frame-title-format'.
22544 (In redisplay_internal, the frame title is drawn _before_ the
22545 windows are updated, so the stuff which depends on actual
22546 window contents (such as %l) may fail to render properly, or
22547 even crash emacs.) */
22548 if (mode_line_target == MODE_LINE_TITLE)
22549 return "";
22550 else
22551 {
22552 ptrdiff_t col = current_column ();
22553 w->column_number_displayed = col;
22554 pint2str (decode_mode_spec_buf, width, col);
22555 return decode_mode_spec_buf;
22556 }
22557
22558 case 'e':
22559 #ifndef SYSTEM_MALLOC
22560 {
22561 if (NILP (Vmemory_full))
22562 return "";
22563 else
22564 return "!MEM FULL! ";
22565 }
22566 #else
22567 return "";
22568 #endif
22569
22570 case 'F':
22571 /* %F displays the frame name. */
22572 if (!NILP (f->title))
22573 return SSDATA (f->title);
22574 if (f->explicit_name || ! FRAME_WINDOW_P (f))
22575 return SSDATA (f->name);
22576 return "Emacs";
22577
22578 case 'f':
22579 obj = BVAR (b, filename);
22580 break;
22581
22582 case 'i':
22583 {
22584 ptrdiff_t size = ZV - BEGV;
22585 pint2str (decode_mode_spec_buf, width, size);
22586 return decode_mode_spec_buf;
22587 }
22588
22589 case 'I':
22590 {
22591 ptrdiff_t size = ZV - BEGV;
22592 pint2hrstr (decode_mode_spec_buf, width, size);
22593 return decode_mode_spec_buf;
22594 }
22595
22596 case 'l':
22597 {
22598 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
22599 ptrdiff_t topline, nlines, height;
22600 ptrdiff_t junk;
22601
22602 /* %c and %l are ignored in `frame-title-format'. */
22603 if (mode_line_target == MODE_LINE_TITLE)
22604 return "";
22605
22606 startpos = marker_position (w->start);
22607 startpos_byte = marker_byte_position (w->start);
22608 height = WINDOW_TOTAL_LINES (w);
22609
22610 /* If we decided that this buffer isn't suitable for line numbers,
22611 don't forget that too fast. */
22612 if (w->base_line_pos == -1)
22613 goto no_value;
22614
22615 /* If the buffer is very big, don't waste time. */
22616 if (INTEGERP (Vline_number_display_limit)
22617 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
22618 {
22619 w->base_line_pos = 0;
22620 w->base_line_number = 0;
22621 goto no_value;
22622 }
22623
22624 if (w->base_line_number > 0
22625 && w->base_line_pos > 0
22626 && w->base_line_pos <= startpos)
22627 {
22628 line = w->base_line_number;
22629 linepos = w->base_line_pos;
22630 linepos_byte = buf_charpos_to_bytepos (b, linepos);
22631 }
22632 else
22633 {
22634 line = 1;
22635 linepos = BUF_BEGV (b);
22636 linepos_byte = BUF_BEGV_BYTE (b);
22637 }
22638
22639 /* Count lines from base line to window start position. */
22640 nlines = display_count_lines (linepos_byte,
22641 startpos_byte,
22642 startpos, &junk);
22643
22644 topline = nlines + line;
22645
22646 /* Determine a new base line, if the old one is too close
22647 or too far away, or if we did not have one.
22648 "Too close" means it's plausible a scroll-down would
22649 go back past it. */
22650 if (startpos == BUF_BEGV (b))
22651 {
22652 w->base_line_number = topline;
22653 w->base_line_pos = BUF_BEGV (b);
22654 }
22655 else if (nlines < height + 25 || nlines > height * 3 + 50
22656 || linepos == BUF_BEGV (b))
22657 {
22658 ptrdiff_t limit = BUF_BEGV (b);
22659 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
22660 ptrdiff_t position;
22661 ptrdiff_t distance =
22662 (height * 2 + 30) * line_number_display_limit_width;
22663
22664 if (startpos - distance > limit)
22665 {
22666 limit = startpos - distance;
22667 limit_byte = CHAR_TO_BYTE (limit);
22668 }
22669
22670 nlines = display_count_lines (startpos_byte,
22671 limit_byte,
22672 - (height * 2 + 30),
22673 &position);
22674 /* If we couldn't find the lines we wanted within
22675 line_number_display_limit_width chars per line,
22676 give up on line numbers for this window. */
22677 if (position == limit_byte && limit == startpos - distance)
22678 {
22679 w->base_line_pos = -1;
22680 w->base_line_number = 0;
22681 goto no_value;
22682 }
22683
22684 w->base_line_number = topline - nlines;
22685 w->base_line_pos = BYTE_TO_CHAR (position);
22686 }
22687
22688 /* Now count lines from the start pos to point. */
22689 nlines = display_count_lines (startpos_byte,
22690 PT_BYTE, PT, &junk);
22691
22692 /* Record that we did display the line number. */
22693 line_number_displayed = 1;
22694
22695 /* Make the string to show. */
22696 pint2str (decode_mode_spec_buf, width, topline + nlines);
22697 return decode_mode_spec_buf;
22698 no_value:
22699 {
22700 char *p = decode_mode_spec_buf;
22701 int pad = width - 2;
22702 while (pad-- > 0)
22703 *p++ = ' ';
22704 *p++ = '?';
22705 *p++ = '?';
22706 *p = '\0';
22707 return decode_mode_spec_buf;
22708 }
22709 }
22710 break;
22711
22712 case 'm':
22713 obj = BVAR (b, mode_name);
22714 break;
22715
22716 case 'n':
22717 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
22718 return " Narrow";
22719 break;
22720
22721 case 'p':
22722 {
22723 ptrdiff_t pos = marker_position (w->start);
22724 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
22725
22726 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
22727 {
22728 if (pos <= BUF_BEGV (b))
22729 return "All";
22730 else
22731 return "Bottom";
22732 }
22733 else if (pos <= BUF_BEGV (b))
22734 return "Top";
22735 else
22736 {
22737 if (total > 1000000)
22738 /* Do it differently for a large value, to avoid overflow. */
22739 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
22740 else
22741 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
22742 /* We can't normally display a 3-digit number,
22743 so get us a 2-digit number that is close. */
22744 if (total == 100)
22745 total = 99;
22746 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
22747 return decode_mode_spec_buf;
22748 }
22749 }
22750
22751 /* Display percentage of size above the bottom of the screen. */
22752 case 'P':
22753 {
22754 ptrdiff_t toppos = marker_position (w->start);
22755 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
22756 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
22757
22758 if (botpos >= BUF_ZV (b))
22759 {
22760 if (toppos <= BUF_BEGV (b))
22761 return "All";
22762 else
22763 return "Bottom";
22764 }
22765 else
22766 {
22767 if (total > 1000000)
22768 /* Do it differently for a large value, to avoid overflow. */
22769 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
22770 else
22771 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
22772 /* We can't normally display a 3-digit number,
22773 so get us a 2-digit number that is close. */
22774 if (total == 100)
22775 total = 99;
22776 if (toppos <= BUF_BEGV (b))
22777 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
22778 else
22779 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
22780 return decode_mode_spec_buf;
22781 }
22782 }
22783
22784 case 's':
22785 /* status of process */
22786 obj = Fget_buffer_process (Fcurrent_buffer ());
22787 if (NILP (obj))
22788 return "no process";
22789 #ifndef MSDOS
22790 obj = Fsymbol_name (Fprocess_status (obj));
22791 #endif
22792 break;
22793
22794 case '@':
22795 {
22796 ptrdiff_t count = inhibit_garbage_collection ();
22797 Lisp_Object val = call1 (intern ("file-remote-p"),
22798 BVAR (current_buffer, directory));
22799 unbind_to (count, Qnil);
22800
22801 if (NILP (val))
22802 return "-";
22803 else
22804 return "@";
22805 }
22806
22807 case 'z':
22808 /* coding-system (not including end-of-line format) */
22809 case 'Z':
22810 /* coding-system (including end-of-line type) */
22811 {
22812 int eol_flag = (c == 'Z');
22813 char *p = decode_mode_spec_buf;
22814
22815 if (! FRAME_WINDOW_P (f))
22816 {
22817 /* No need to mention EOL here--the terminal never needs
22818 to do EOL conversion. */
22819 p = decode_mode_spec_coding (CODING_ID_NAME
22820 (FRAME_KEYBOARD_CODING (f)->id),
22821 p, 0);
22822 p = decode_mode_spec_coding (CODING_ID_NAME
22823 (FRAME_TERMINAL_CODING (f)->id),
22824 p, 0);
22825 }
22826 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
22827 p, eol_flag);
22828
22829 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22830 #ifdef subprocesses
22831 obj = Fget_buffer_process (Fcurrent_buffer ());
22832 if (PROCESSP (obj))
22833 {
22834 p = decode_mode_spec_coding
22835 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
22836 p = decode_mode_spec_coding
22837 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
22838 }
22839 #endif /* subprocesses */
22840 #endif /* 0 */
22841 *p = 0;
22842 return decode_mode_spec_buf;
22843 }
22844 }
22845
22846 if (STRINGP (obj))
22847 {
22848 *string = obj;
22849 return SSDATA (obj);
22850 }
22851 else
22852 return "";
22853 }
22854
22855
22856 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22857 means count lines back from START_BYTE. But don't go beyond
22858 LIMIT_BYTE. Return the number of lines thus found (always
22859 nonnegative).
22860
22861 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22862 either the position COUNT lines after/before START_BYTE, if we
22863 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22864 COUNT lines. */
22865
22866 static ptrdiff_t
22867 display_count_lines (ptrdiff_t start_byte,
22868 ptrdiff_t limit_byte, ptrdiff_t count,
22869 ptrdiff_t *byte_pos_ptr)
22870 {
22871 register unsigned char *cursor;
22872 unsigned char *base;
22873
22874 register ptrdiff_t ceiling;
22875 register unsigned char *ceiling_addr;
22876 ptrdiff_t orig_count = count;
22877
22878 /* If we are not in selective display mode,
22879 check only for newlines. */
22880 int selective_display = (!NILP (BVAR (current_buffer, selective_display))
22881 && !INTEGERP (BVAR (current_buffer, selective_display)));
22882
22883 if (count > 0)
22884 {
22885 while (start_byte < limit_byte)
22886 {
22887 ceiling = BUFFER_CEILING_OF (start_byte);
22888 ceiling = min (limit_byte - 1, ceiling);
22889 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
22890 base = (cursor = BYTE_POS_ADDR (start_byte));
22891
22892 do
22893 {
22894 if (selective_display)
22895 {
22896 while (*cursor != '\n' && *cursor != 015
22897 && ++cursor != ceiling_addr)
22898 continue;
22899 if (cursor == ceiling_addr)
22900 break;
22901 }
22902 else
22903 {
22904 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
22905 if (! cursor)
22906 break;
22907 }
22908
22909 cursor++;
22910
22911 if (--count == 0)
22912 {
22913 start_byte += cursor - base;
22914 *byte_pos_ptr = start_byte;
22915 return orig_count;
22916 }
22917 }
22918 while (cursor < ceiling_addr);
22919
22920 start_byte += ceiling_addr - base;
22921 }
22922 }
22923 else
22924 {
22925 while (start_byte > limit_byte)
22926 {
22927 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
22928 ceiling = max (limit_byte, ceiling);
22929 ceiling_addr = BYTE_POS_ADDR (ceiling);
22930 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
22931 while (1)
22932 {
22933 if (selective_display)
22934 {
22935 while (--cursor >= ceiling_addr
22936 && *cursor != '\n' && *cursor != 015)
22937 continue;
22938 if (cursor < ceiling_addr)
22939 break;
22940 }
22941 else
22942 {
22943 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
22944 if (! cursor)
22945 break;
22946 }
22947
22948 if (++count == 0)
22949 {
22950 start_byte += cursor - base + 1;
22951 *byte_pos_ptr = start_byte;
22952 /* When scanning backwards, we should
22953 not count the newline posterior to which we stop. */
22954 return - orig_count - 1;
22955 }
22956 }
22957 start_byte += ceiling_addr - base;
22958 }
22959 }
22960
22961 *byte_pos_ptr = limit_byte;
22962
22963 if (count < 0)
22964 return - orig_count + count;
22965 return orig_count - count;
22966
22967 }
22968
22969
22970 \f
22971 /***********************************************************************
22972 Displaying strings
22973 ***********************************************************************/
22974
22975 /* Display a NUL-terminated string, starting with index START.
22976
22977 If STRING is non-null, display that C string. Otherwise, the Lisp
22978 string LISP_STRING is displayed. There's a case that STRING is
22979 non-null and LISP_STRING is not nil. It means STRING is a string
22980 data of LISP_STRING. In that case, we display LISP_STRING while
22981 ignoring its text properties.
22982
22983 If FACE_STRING is not nil, FACE_STRING_POS is a position in
22984 FACE_STRING. Display STRING or LISP_STRING with the face at
22985 FACE_STRING_POS in FACE_STRING:
22986
22987 Display the string in the environment given by IT, but use the
22988 standard display table, temporarily.
22989
22990 FIELD_WIDTH is the minimum number of output glyphs to produce.
22991 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22992 with spaces. If STRING has more characters, more than FIELD_WIDTH
22993 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
22994
22995 PRECISION is the maximum number of characters to output from
22996 STRING. PRECISION < 0 means don't truncate the string.
22997
22998 This is roughly equivalent to printf format specifiers:
22999
23000 FIELD_WIDTH PRECISION PRINTF
23001 ----------------------------------------
23002 -1 -1 %s
23003 -1 10 %.10s
23004 10 -1 %10s
23005 20 10 %20.10s
23006
23007 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23008 display them, and < 0 means obey the current buffer's value of
23009 enable_multibyte_characters.
23010
23011 Value is the number of columns displayed. */
23012
23013 static int
23014 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23015 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23016 int field_width, int precision, int max_x, int multibyte)
23017 {
23018 int hpos_at_start = it->hpos;
23019 int saved_face_id = it->face_id;
23020 struct glyph_row *row = it->glyph_row;
23021 ptrdiff_t it_charpos;
23022
23023 /* Initialize the iterator IT for iteration over STRING beginning
23024 with index START. */
23025 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23026 precision, field_width, multibyte);
23027 if (string && STRINGP (lisp_string))
23028 /* LISP_STRING is the one returned by decode_mode_spec. We should
23029 ignore its text properties. */
23030 it->stop_charpos = it->end_charpos;
23031
23032 /* If displaying STRING, set up the face of the iterator from
23033 FACE_STRING, if that's given. */
23034 if (STRINGP (face_string))
23035 {
23036 ptrdiff_t endptr;
23037 struct face *face;
23038
23039 it->face_id
23040 = face_at_string_position (it->w, face_string, face_string_pos,
23041 0, &endptr, it->base_face_id, 0);
23042 face = FACE_FROM_ID (it->f, it->face_id);
23043 it->face_box_p = face->box != FACE_NO_BOX;
23044 }
23045
23046 /* Set max_x to the maximum allowed X position. Don't let it go
23047 beyond the right edge of the window. */
23048 if (max_x <= 0)
23049 max_x = it->last_visible_x;
23050 else
23051 max_x = min (max_x, it->last_visible_x);
23052
23053 /* Skip over display elements that are not visible. because IT->w is
23054 hscrolled. */
23055 if (it->current_x < it->first_visible_x)
23056 move_it_in_display_line_to (it, 100000, it->first_visible_x,
23057 MOVE_TO_POS | MOVE_TO_X);
23058
23059 row->ascent = it->max_ascent;
23060 row->height = it->max_ascent + it->max_descent;
23061 row->phys_ascent = it->max_phys_ascent;
23062 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
23063 row->extra_line_spacing = it->max_extra_line_spacing;
23064
23065 if (STRINGP (it->string))
23066 it_charpos = IT_STRING_CHARPOS (*it);
23067 else
23068 it_charpos = IT_CHARPOS (*it);
23069
23070 /* This condition is for the case that we are called with current_x
23071 past last_visible_x. */
23072 while (it->current_x < max_x)
23073 {
23074 int x_before, x, n_glyphs_before, i, nglyphs;
23075
23076 /* Get the next display element. */
23077 if (!get_next_display_element (it))
23078 break;
23079
23080 /* Produce glyphs. */
23081 x_before = it->current_x;
23082 n_glyphs_before = row->used[TEXT_AREA];
23083 PRODUCE_GLYPHS (it);
23084
23085 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
23086 i = 0;
23087 x = x_before;
23088 while (i < nglyphs)
23089 {
23090 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
23091
23092 if (it->line_wrap != TRUNCATE
23093 && x + glyph->pixel_width > max_x)
23094 {
23095 /* End of continued line or max_x reached. */
23096 if (CHAR_GLYPH_PADDING_P (*glyph))
23097 {
23098 /* A wide character is unbreakable. */
23099 if (row->reversed_p)
23100 unproduce_glyphs (it, row->used[TEXT_AREA]
23101 - n_glyphs_before);
23102 row->used[TEXT_AREA] = n_glyphs_before;
23103 it->current_x = x_before;
23104 }
23105 else
23106 {
23107 if (row->reversed_p)
23108 unproduce_glyphs (it, row->used[TEXT_AREA]
23109 - (n_glyphs_before + i));
23110 row->used[TEXT_AREA] = n_glyphs_before + i;
23111 it->current_x = x;
23112 }
23113 break;
23114 }
23115 else if (x + glyph->pixel_width >= it->first_visible_x)
23116 {
23117 /* Glyph is at least partially visible. */
23118 ++it->hpos;
23119 if (x < it->first_visible_x)
23120 row->x = x - it->first_visible_x;
23121 }
23122 else
23123 {
23124 /* Glyph is off the left margin of the display area.
23125 Should not happen. */
23126 emacs_abort ();
23127 }
23128
23129 row->ascent = max (row->ascent, it->max_ascent);
23130 row->height = max (row->height, it->max_ascent + it->max_descent);
23131 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
23132 row->phys_height = max (row->phys_height,
23133 it->max_phys_ascent + it->max_phys_descent);
23134 row->extra_line_spacing = max (row->extra_line_spacing,
23135 it->max_extra_line_spacing);
23136 x += glyph->pixel_width;
23137 ++i;
23138 }
23139
23140 /* Stop if max_x reached. */
23141 if (i < nglyphs)
23142 break;
23143
23144 /* Stop at line ends. */
23145 if (ITERATOR_AT_END_OF_LINE_P (it))
23146 {
23147 it->continuation_lines_width = 0;
23148 break;
23149 }
23150
23151 set_iterator_to_next (it, 1);
23152 if (STRINGP (it->string))
23153 it_charpos = IT_STRING_CHARPOS (*it);
23154 else
23155 it_charpos = IT_CHARPOS (*it);
23156
23157 /* Stop if truncating at the right edge. */
23158 if (it->line_wrap == TRUNCATE
23159 && it->current_x >= it->last_visible_x)
23160 {
23161 /* Add truncation mark, but don't do it if the line is
23162 truncated at a padding space. */
23163 if (it_charpos < it->string_nchars)
23164 {
23165 if (!FRAME_WINDOW_P (it->f))
23166 {
23167 int ii, n;
23168
23169 if (it->current_x > it->last_visible_x)
23170 {
23171 if (!row->reversed_p)
23172 {
23173 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
23174 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23175 break;
23176 }
23177 else
23178 {
23179 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
23180 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23181 break;
23182 unproduce_glyphs (it, ii + 1);
23183 ii = row->used[TEXT_AREA] - (ii + 1);
23184 }
23185 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
23186 {
23187 row->used[TEXT_AREA] = ii;
23188 produce_special_glyphs (it, IT_TRUNCATION);
23189 }
23190 }
23191 produce_special_glyphs (it, IT_TRUNCATION);
23192 }
23193 row->truncated_on_right_p = 1;
23194 }
23195 break;
23196 }
23197 }
23198
23199 /* Maybe insert a truncation at the left. */
23200 if (it->first_visible_x
23201 && it_charpos > 0)
23202 {
23203 if (!FRAME_WINDOW_P (it->f)
23204 || (row->reversed_p
23205 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23206 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
23207 insert_left_trunc_glyphs (it);
23208 row->truncated_on_left_p = 1;
23209 }
23210
23211 it->face_id = saved_face_id;
23212
23213 /* Value is number of columns displayed. */
23214 return it->hpos - hpos_at_start;
23215 }
23216
23217
23218 \f
23219 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23220 appears as an element of LIST or as the car of an element of LIST.
23221 If PROPVAL is a list, compare each element against LIST in that
23222 way, and return 1/2 if any element of PROPVAL is found in LIST.
23223 Otherwise return 0. This function cannot quit.
23224 The return value is 2 if the text is invisible but with an ellipsis
23225 and 1 if it's invisible and without an ellipsis. */
23226
23227 int
23228 invisible_p (register Lisp_Object propval, Lisp_Object list)
23229 {
23230 register Lisp_Object tail, proptail;
23231
23232 for (tail = list; CONSP (tail); tail = XCDR (tail))
23233 {
23234 register Lisp_Object tem;
23235 tem = XCAR (tail);
23236 if (EQ (propval, tem))
23237 return 1;
23238 if (CONSP (tem) && EQ (propval, XCAR (tem)))
23239 return NILP (XCDR (tem)) ? 1 : 2;
23240 }
23241
23242 if (CONSP (propval))
23243 {
23244 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
23245 {
23246 Lisp_Object propelt;
23247 propelt = XCAR (proptail);
23248 for (tail = list; CONSP (tail); tail = XCDR (tail))
23249 {
23250 register Lisp_Object tem;
23251 tem = XCAR (tail);
23252 if (EQ (propelt, tem))
23253 return 1;
23254 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
23255 return NILP (XCDR (tem)) ? 1 : 2;
23256 }
23257 }
23258 }
23259
23260 return 0;
23261 }
23262
23263 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
23264 doc: /* Non-nil if the property makes the text invisible.
23265 POS-OR-PROP can be a marker or number, in which case it is taken to be
23266 a position in the current buffer and the value of the `invisible' property
23267 is checked; or it can be some other value, which is then presumed to be the
23268 value of the `invisible' property of the text of interest.
23269 The non-nil value returned can be t for truly invisible text or something
23270 else if the text is replaced by an ellipsis. */)
23271 (Lisp_Object pos_or_prop)
23272 {
23273 Lisp_Object prop
23274 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
23275 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
23276 : pos_or_prop);
23277 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
23278 return (invis == 0 ? Qnil
23279 : invis == 1 ? Qt
23280 : make_number (invis));
23281 }
23282
23283 /* Calculate a width or height in pixels from a specification using
23284 the following elements:
23285
23286 SPEC ::=
23287 NUM - a (fractional) multiple of the default font width/height
23288 (NUM) - specifies exactly NUM pixels
23289 UNIT - a fixed number of pixels, see below.
23290 ELEMENT - size of a display element in pixels, see below.
23291 (NUM . SPEC) - equals NUM * SPEC
23292 (+ SPEC SPEC ...) - add pixel values
23293 (- SPEC SPEC ...) - subtract pixel values
23294 (- SPEC) - negate pixel value
23295
23296 NUM ::=
23297 INT or FLOAT - a number constant
23298 SYMBOL - use symbol's (buffer local) variable binding.
23299
23300 UNIT ::=
23301 in - pixels per inch *)
23302 mm - pixels per 1/1000 meter *)
23303 cm - pixels per 1/100 meter *)
23304 width - width of current font in pixels.
23305 height - height of current font in pixels.
23306
23307 *) using the ratio(s) defined in display-pixels-per-inch.
23308
23309 ELEMENT ::=
23310
23311 left-fringe - left fringe width in pixels
23312 right-fringe - right fringe width in pixels
23313
23314 left-margin - left margin width in pixels
23315 right-margin - right margin width in pixels
23316
23317 scroll-bar - scroll-bar area width in pixels
23318
23319 Examples:
23320
23321 Pixels corresponding to 5 inches:
23322 (5 . in)
23323
23324 Total width of non-text areas on left side of window (if scroll-bar is on left):
23325 '(space :width (+ left-fringe left-margin scroll-bar))
23326
23327 Align to first text column (in header line):
23328 '(space :align-to 0)
23329
23330 Align to middle of text area minus half the width of variable `my-image'
23331 containing a loaded image:
23332 '(space :align-to (0.5 . (- text my-image)))
23333
23334 Width of left margin minus width of 1 character in the default font:
23335 '(space :width (- left-margin 1))
23336
23337 Width of left margin minus width of 2 characters in the current font:
23338 '(space :width (- left-margin (2 . width)))
23339
23340 Center 1 character over left-margin (in header line):
23341 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23342
23343 Different ways to express width of left fringe plus left margin minus one pixel:
23344 '(space :width (- (+ left-fringe left-margin) (1)))
23345 '(space :width (+ left-fringe left-margin (- (1))))
23346 '(space :width (+ left-fringe left-margin (-1)))
23347
23348 */
23349
23350 static int
23351 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
23352 struct font *font, int width_p, int *align_to)
23353 {
23354 double pixels;
23355
23356 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23357 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23358
23359 if (NILP (prop))
23360 return OK_PIXELS (0);
23361
23362 eassert (FRAME_LIVE_P (it->f));
23363
23364 if (SYMBOLP (prop))
23365 {
23366 if (SCHARS (SYMBOL_NAME (prop)) == 2)
23367 {
23368 char *unit = SSDATA (SYMBOL_NAME (prop));
23369
23370 if (unit[0] == 'i' && unit[1] == 'n')
23371 pixels = 1.0;
23372 else if (unit[0] == 'm' && unit[1] == 'm')
23373 pixels = 25.4;
23374 else if (unit[0] == 'c' && unit[1] == 'm')
23375 pixels = 2.54;
23376 else
23377 pixels = 0;
23378 if (pixels > 0)
23379 {
23380 double ppi = (width_p ? FRAME_RES_X (it->f)
23381 : FRAME_RES_Y (it->f));
23382
23383 if (ppi > 0)
23384 return OK_PIXELS (ppi / pixels);
23385 return 0;
23386 }
23387 }
23388
23389 #ifdef HAVE_WINDOW_SYSTEM
23390 if (EQ (prop, Qheight))
23391 return OK_PIXELS (font ? FONT_HEIGHT (font) : FRAME_LINE_HEIGHT (it->f));
23392 if (EQ (prop, Qwidth))
23393 return OK_PIXELS (font ? FONT_WIDTH (font) : FRAME_COLUMN_WIDTH (it->f));
23394 #else
23395 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
23396 return OK_PIXELS (1);
23397 #endif
23398
23399 if (EQ (prop, Qtext))
23400 return OK_PIXELS (width_p
23401 ? window_box_width (it->w, TEXT_AREA)
23402 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
23403
23404 if (align_to && *align_to < 0)
23405 {
23406 *res = 0;
23407 if (EQ (prop, Qleft))
23408 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
23409 if (EQ (prop, Qright))
23410 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
23411 if (EQ (prop, Qcenter))
23412 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
23413 + window_box_width (it->w, TEXT_AREA) / 2);
23414 if (EQ (prop, Qleft_fringe))
23415 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23416 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
23417 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
23418 if (EQ (prop, Qright_fringe))
23419 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23420 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23421 : window_box_right_offset (it->w, TEXT_AREA));
23422 if (EQ (prop, Qleft_margin))
23423 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
23424 if (EQ (prop, Qright_margin))
23425 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
23426 if (EQ (prop, Qscroll_bar))
23427 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
23428 ? 0
23429 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23430 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23431 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23432 : 0)));
23433 }
23434 else
23435 {
23436 if (EQ (prop, Qleft_fringe))
23437 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
23438 if (EQ (prop, Qright_fringe))
23439 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
23440 if (EQ (prop, Qleft_margin))
23441 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
23442 if (EQ (prop, Qright_margin))
23443 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
23444 if (EQ (prop, Qscroll_bar))
23445 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
23446 }
23447
23448 prop = buffer_local_value (prop, it->w->contents);
23449 if (EQ (prop, Qunbound))
23450 prop = Qnil;
23451 }
23452
23453 if (INTEGERP (prop) || FLOATP (prop))
23454 {
23455 int base_unit = (width_p
23456 ? FRAME_COLUMN_WIDTH (it->f)
23457 : FRAME_LINE_HEIGHT (it->f));
23458 return OK_PIXELS (XFLOATINT (prop) * base_unit);
23459 }
23460
23461 if (CONSP (prop))
23462 {
23463 Lisp_Object car = XCAR (prop);
23464 Lisp_Object cdr = XCDR (prop);
23465
23466 if (SYMBOLP (car))
23467 {
23468 #ifdef HAVE_WINDOW_SYSTEM
23469 if (FRAME_WINDOW_P (it->f)
23470 && valid_image_p (prop))
23471 {
23472 ptrdiff_t id = lookup_image (it->f, prop);
23473 struct image *img = IMAGE_FROM_ID (it->f, id);
23474
23475 return OK_PIXELS (width_p ? img->width : img->height);
23476 }
23477 #endif
23478 if (EQ (car, Qplus) || EQ (car, Qminus))
23479 {
23480 int first = 1;
23481 double px;
23482
23483 pixels = 0;
23484 while (CONSP (cdr))
23485 {
23486 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
23487 font, width_p, align_to))
23488 return 0;
23489 if (first)
23490 pixels = (EQ (car, Qplus) ? px : -px), first = 0;
23491 else
23492 pixels += px;
23493 cdr = XCDR (cdr);
23494 }
23495 if (EQ (car, Qminus))
23496 pixels = -pixels;
23497 return OK_PIXELS (pixels);
23498 }
23499
23500 car = buffer_local_value (car, it->w->contents);
23501 if (EQ (car, Qunbound))
23502 car = Qnil;
23503 }
23504
23505 if (INTEGERP (car) || FLOATP (car))
23506 {
23507 double fact;
23508 pixels = XFLOATINT (car);
23509 if (NILP (cdr))
23510 return OK_PIXELS (pixels);
23511 if (calc_pixel_width_or_height (&fact, it, cdr,
23512 font, width_p, align_to))
23513 return OK_PIXELS (pixels * fact);
23514 return 0;
23515 }
23516
23517 return 0;
23518 }
23519
23520 return 0;
23521 }
23522
23523 \f
23524 /***********************************************************************
23525 Glyph Display
23526 ***********************************************************************/
23527
23528 #ifdef HAVE_WINDOW_SYSTEM
23529
23530 #ifdef GLYPH_DEBUG
23531
23532 void
23533 dump_glyph_string (struct glyph_string *s)
23534 {
23535 fprintf (stderr, "glyph string\n");
23536 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
23537 s->x, s->y, s->width, s->height);
23538 fprintf (stderr, " ybase = %d\n", s->ybase);
23539 fprintf (stderr, " hl = %d\n", s->hl);
23540 fprintf (stderr, " left overhang = %d, right = %d\n",
23541 s->left_overhang, s->right_overhang);
23542 fprintf (stderr, " nchars = %d\n", s->nchars);
23543 fprintf (stderr, " extends to end of line = %d\n",
23544 s->extends_to_end_of_line_p);
23545 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
23546 fprintf (stderr, " bg width = %d\n", s->background_width);
23547 }
23548
23549 #endif /* GLYPH_DEBUG */
23550
23551 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23552 of XChar2b structures for S; it can't be allocated in
23553 init_glyph_string because it must be allocated via `alloca'. W
23554 is the window on which S is drawn. ROW and AREA are the glyph row
23555 and area within the row from which S is constructed. START is the
23556 index of the first glyph structure covered by S. HL is a
23557 face-override for drawing S. */
23558
23559 #ifdef HAVE_NTGUI
23560 #define OPTIONAL_HDC(hdc) HDC hdc,
23561 #define DECLARE_HDC(hdc) HDC hdc;
23562 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23563 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23564 #endif
23565
23566 #ifndef OPTIONAL_HDC
23567 #define OPTIONAL_HDC(hdc)
23568 #define DECLARE_HDC(hdc)
23569 #define ALLOCATE_HDC(hdc, f)
23570 #define RELEASE_HDC(hdc, f)
23571 #endif
23572
23573 static void
23574 init_glyph_string (struct glyph_string *s,
23575 OPTIONAL_HDC (hdc)
23576 XChar2b *char2b, struct window *w, struct glyph_row *row,
23577 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
23578 {
23579 memset (s, 0, sizeof *s);
23580 s->w = w;
23581 s->f = XFRAME (w->frame);
23582 #ifdef HAVE_NTGUI
23583 s->hdc = hdc;
23584 #endif
23585 s->display = FRAME_X_DISPLAY (s->f);
23586 s->window = FRAME_X_WINDOW (s->f);
23587 s->char2b = char2b;
23588 s->hl = hl;
23589 s->row = row;
23590 s->area = area;
23591 s->first_glyph = row->glyphs[area] + start;
23592 s->height = row->height;
23593 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
23594 s->ybase = s->y + row->ascent;
23595 }
23596
23597
23598 /* Append the list of glyph strings with head H and tail T to the list
23599 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23600
23601 static void
23602 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
23603 struct glyph_string *h, struct glyph_string *t)
23604 {
23605 if (h)
23606 {
23607 if (*head)
23608 (*tail)->next = h;
23609 else
23610 *head = h;
23611 h->prev = *tail;
23612 *tail = t;
23613 }
23614 }
23615
23616
23617 /* Prepend the list of glyph strings with head H and tail T to the
23618 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23619 result. */
23620
23621 static void
23622 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
23623 struct glyph_string *h, struct glyph_string *t)
23624 {
23625 if (h)
23626 {
23627 if (*head)
23628 (*head)->prev = t;
23629 else
23630 *tail = t;
23631 t->next = *head;
23632 *head = h;
23633 }
23634 }
23635
23636
23637 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23638 Set *HEAD and *TAIL to the resulting list. */
23639
23640 static void
23641 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
23642 struct glyph_string *s)
23643 {
23644 s->next = s->prev = NULL;
23645 append_glyph_string_lists (head, tail, s, s);
23646 }
23647
23648
23649 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23650 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23651 make sure that X resources for the face returned are allocated.
23652 Value is a pointer to a realized face that is ready for display if
23653 DISPLAY_P is non-zero. */
23654
23655 static struct face *
23656 get_char_face_and_encoding (struct frame *f, int c, int face_id,
23657 XChar2b *char2b, int display_p)
23658 {
23659 struct face *face = FACE_FROM_ID (f, face_id);
23660 unsigned code = 0;
23661
23662 if (face->font)
23663 {
23664 code = face->font->driver->encode_char (face->font, c);
23665
23666 if (code == FONT_INVALID_CODE)
23667 code = 0;
23668 }
23669 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
23670
23671 /* Make sure X resources of the face are allocated. */
23672 #ifdef HAVE_X_WINDOWS
23673 if (display_p)
23674 #endif
23675 {
23676 eassert (face != NULL);
23677 prepare_face_for_display (f, face);
23678 }
23679
23680 return face;
23681 }
23682
23683
23684 /* Get face and two-byte form of character glyph GLYPH on frame F.
23685 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23686 a pointer to a realized face that is ready for display. */
23687
23688 static struct face *
23689 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
23690 XChar2b *char2b, int *two_byte_p)
23691 {
23692 struct face *face;
23693 unsigned code = 0;
23694
23695 eassert (glyph->type == CHAR_GLYPH);
23696 face = FACE_FROM_ID (f, glyph->face_id);
23697
23698 /* Make sure X resources of the face are allocated. */
23699 eassert (face != NULL);
23700 prepare_face_for_display (f, face);
23701
23702 if (two_byte_p)
23703 *two_byte_p = 0;
23704
23705 if (face->font)
23706 {
23707 if (CHAR_BYTE8_P (glyph->u.ch))
23708 code = CHAR_TO_BYTE8 (glyph->u.ch);
23709 else
23710 code = face->font->driver->encode_char (face->font, glyph->u.ch);
23711
23712 if (code == FONT_INVALID_CODE)
23713 code = 0;
23714 }
23715
23716 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
23717 return face;
23718 }
23719
23720
23721 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23722 Return 1 if FONT has a glyph for C, otherwise return 0. */
23723
23724 static int
23725 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
23726 {
23727 unsigned code;
23728
23729 if (CHAR_BYTE8_P (c))
23730 code = CHAR_TO_BYTE8 (c);
23731 else
23732 code = font->driver->encode_char (font, c);
23733
23734 if (code == FONT_INVALID_CODE)
23735 return 0;
23736 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
23737 return 1;
23738 }
23739
23740
23741 /* Fill glyph string S with composition components specified by S->cmp.
23742
23743 BASE_FACE is the base face of the composition.
23744 S->cmp_from is the index of the first component for S.
23745
23746 OVERLAPS non-zero means S should draw the foreground only, and use
23747 its physical height for clipping. See also draw_glyphs.
23748
23749 Value is the index of a component not in S. */
23750
23751 static int
23752 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
23753 int overlaps)
23754 {
23755 int i;
23756 /* For all glyphs of this composition, starting at the offset
23757 S->cmp_from, until we reach the end of the definition or encounter a
23758 glyph that requires the different face, add it to S. */
23759 struct face *face;
23760
23761 eassert (s);
23762
23763 s->for_overlaps = overlaps;
23764 s->face = NULL;
23765 s->font = NULL;
23766 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
23767 {
23768 int c = COMPOSITION_GLYPH (s->cmp, i);
23769
23770 /* TAB in a composition means display glyphs with padding space
23771 on the left or right. */
23772 if (c != '\t')
23773 {
23774 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
23775 -1, Qnil);
23776
23777 face = get_char_face_and_encoding (s->f, c, face_id,
23778 s->char2b + i, 1);
23779 if (face)
23780 {
23781 if (! s->face)
23782 {
23783 s->face = face;
23784 s->font = s->face->font;
23785 }
23786 else if (s->face != face)
23787 break;
23788 }
23789 }
23790 ++s->nchars;
23791 }
23792 s->cmp_to = i;
23793
23794 if (s->face == NULL)
23795 {
23796 s->face = base_face->ascii_face;
23797 s->font = s->face->font;
23798 }
23799
23800 /* All glyph strings for the same composition has the same width,
23801 i.e. the width set for the first component of the composition. */
23802 s->width = s->first_glyph->pixel_width;
23803
23804 /* If the specified font could not be loaded, use the frame's
23805 default font, but record the fact that we couldn't load it in
23806 the glyph string so that we can draw rectangles for the
23807 characters of the glyph string. */
23808 if (s->font == NULL)
23809 {
23810 s->font_not_found_p = 1;
23811 s->font = FRAME_FONT (s->f);
23812 }
23813
23814 /* Adjust base line for subscript/superscript text. */
23815 s->ybase += s->first_glyph->voffset;
23816
23817 /* This glyph string must always be drawn with 16-bit functions. */
23818 s->two_byte_p = 1;
23819
23820 return s->cmp_to;
23821 }
23822
23823 static int
23824 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
23825 int start, int end, int overlaps)
23826 {
23827 struct glyph *glyph, *last;
23828 Lisp_Object lgstring;
23829 int i;
23830
23831 s->for_overlaps = overlaps;
23832 glyph = s->row->glyphs[s->area] + start;
23833 last = s->row->glyphs[s->area] + end;
23834 s->cmp_id = glyph->u.cmp.id;
23835 s->cmp_from = glyph->slice.cmp.from;
23836 s->cmp_to = glyph->slice.cmp.to + 1;
23837 s->face = FACE_FROM_ID (s->f, face_id);
23838 lgstring = composition_gstring_from_id (s->cmp_id);
23839 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
23840 glyph++;
23841 while (glyph < last
23842 && glyph->u.cmp.automatic
23843 && glyph->u.cmp.id == s->cmp_id
23844 && s->cmp_to == glyph->slice.cmp.from)
23845 s->cmp_to = (glyph++)->slice.cmp.to + 1;
23846
23847 for (i = s->cmp_from; i < s->cmp_to; i++)
23848 {
23849 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
23850 unsigned code = LGLYPH_CODE (lglyph);
23851
23852 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
23853 }
23854 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
23855 return glyph - s->row->glyphs[s->area];
23856 }
23857
23858
23859 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23860 See the comment of fill_glyph_string for arguments.
23861 Value is the index of the first glyph not in S. */
23862
23863
23864 static int
23865 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
23866 int start, int end, int overlaps)
23867 {
23868 struct glyph *glyph, *last;
23869 int voffset;
23870
23871 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
23872 s->for_overlaps = overlaps;
23873 glyph = s->row->glyphs[s->area] + start;
23874 last = s->row->glyphs[s->area] + end;
23875 voffset = glyph->voffset;
23876 s->face = FACE_FROM_ID (s->f, face_id);
23877 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
23878 s->nchars = 1;
23879 s->width = glyph->pixel_width;
23880 glyph++;
23881 while (glyph < last
23882 && glyph->type == GLYPHLESS_GLYPH
23883 && glyph->voffset == voffset
23884 && glyph->face_id == face_id)
23885 {
23886 s->nchars++;
23887 s->width += glyph->pixel_width;
23888 glyph++;
23889 }
23890 s->ybase += voffset;
23891 return glyph - s->row->glyphs[s->area];
23892 }
23893
23894
23895 /* Fill glyph string S from a sequence of character glyphs.
23896
23897 FACE_ID is the face id of the string. START is the index of the
23898 first glyph to consider, END is the index of the last + 1.
23899 OVERLAPS non-zero means S should draw the foreground only, and use
23900 its physical height for clipping. See also draw_glyphs.
23901
23902 Value is the index of the first glyph not in S. */
23903
23904 static int
23905 fill_glyph_string (struct glyph_string *s, int face_id,
23906 int start, int end, int overlaps)
23907 {
23908 struct glyph *glyph, *last;
23909 int voffset;
23910 int glyph_not_available_p;
23911
23912 eassert (s->f == XFRAME (s->w->frame));
23913 eassert (s->nchars == 0);
23914 eassert (start >= 0 && end > start);
23915
23916 s->for_overlaps = overlaps;
23917 glyph = s->row->glyphs[s->area] + start;
23918 last = s->row->glyphs[s->area] + end;
23919 voffset = glyph->voffset;
23920 s->padding_p = glyph->padding_p;
23921 glyph_not_available_p = glyph->glyph_not_available_p;
23922
23923 while (glyph < last
23924 && glyph->type == CHAR_GLYPH
23925 && glyph->voffset == voffset
23926 /* Same face id implies same font, nowadays. */
23927 && glyph->face_id == face_id
23928 && glyph->glyph_not_available_p == glyph_not_available_p)
23929 {
23930 int two_byte_p;
23931
23932 s->face = get_glyph_face_and_encoding (s->f, glyph,
23933 s->char2b + s->nchars,
23934 &two_byte_p);
23935 s->two_byte_p = two_byte_p;
23936 ++s->nchars;
23937 eassert (s->nchars <= end - start);
23938 s->width += glyph->pixel_width;
23939 if (glyph++->padding_p != s->padding_p)
23940 break;
23941 }
23942
23943 s->font = s->face->font;
23944
23945 /* If the specified font could not be loaded, use the frame's font,
23946 but record the fact that we couldn't load it in
23947 S->font_not_found_p so that we can draw rectangles for the
23948 characters of the glyph string. */
23949 if (s->font == NULL || glyph_not_available_p)
23950 {
23951 s->font_not_found_p = 1;
23952 s->font = FRAME_FONT (s->f);
23953 }
23954
23955 /* Adjust base line for subscript/superscript text. */
23956 s->ybase += voffset;
23957
23958 eassert (s->face && s->face->gc);
23959 return glyph - s->row->glyphs[s->area];
23960 }
23961
23962
23963 /* Fill glyph string S from image glyph S->first_glyph. */
23964
23965 static void
23966 fill_image_glyph_string (struct glyph_string *s)
23967 {
23968 eassert (s->first_glyph->type == IMAGE_GLYPH);
23969 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
23970 eassert (s->img);
23971 s->slice = s->first_glyph->slice.img;
23972 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
23973 s->font = s->face->font;
23974 s->width = s->first_glyph->pixel_width;
23975
23976 /* Adjust base line for subscript/superscript text. */
23977 s->ybase += s->first_glyph->voffset;
23978 }
23979
23980
23981 /* Fill glyph string S from a sequence of stretch glyphs.
23982
23983 START is the index of the first glyph to consider,
23984 END is the index of the last + 1.
23985
23986 Value is the index of the first glyph not in S. */
23987
23988 static int
23989 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
23990 {
23991 struct glyph *glyph, *last;
23992 int voffset, face_id;
23993
23994 eassert (s->first_glyph->type == STRETCH_GLYPH);
23995
23996 glyph = s->row->glyphs[s->area] + start;
23997 last = s->row->glyphs[s->area] + end;
23998 face_id = glyph->face_id;
23999 s->face = FACE_FROM_ID (s->f, face_id);
24000 s->font = s->face->font;
24001 s->width = glyph->pixel_width;
24002 s->nchars = 1;
24003 voffset = glyph->voffset;
24004
24005 for (++glyph;
24006 (glyph < last
24007 && glyph->type == STRETCH_GLYPH
24008 && glyph->voffset == voffset
24009 && glyph->face_id == face_id);
24010 ++glyph)
24011 s->width += glyph->pixel_width;
24012
24013 /* Adjust base line for subscript/superscript text. */
24014 s->ybase += voffset;
24015
24016 /* The case that face->gc == 0 is handled when drawing the glyph
24017 string by calling prepare_face_for_display. */
24018 eassert (s->face);
24019 return glyph - s->row->glyphs[s->area];
24020 }
24021
24022 static struct font_metrics *
24023 get_per_char_metric (struct font *font, XChar2b *char2b)
24024 {
24025 static struct font_metrics metrics;
24026 unsigned code;
24027
24028 if (! font)
24029 return NULL;
24030 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24031 if (code == FONT_INVALID_CODE)
24032 return NULL;
24033 font->driver->text_extents (font, &code, 1, &metrics);
24034 return &metrics;
24035 }
24036
24037 /* EXPORT for RIF:
24038 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24039 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24040 assumed to be zero. */
24041
24042 void
24043 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
24044 {
24045 *left = *right = 0;
24046
24047 if (glyph->type == CHAR_GLYPH)
24048 {
24049 struct face *face;
24050 XChar2b char2b;
24051 struct font_metrics *pcm;
24052
24053 face = get_glyph_face_and_encoding (f, glyph, &char2b, NULL);
24054 if (face->font && (pcm = get_per_char_metric (face->font, &char2b)))
24055 {
24056 if (pcm->rbearing > pcm->width)
24057 *right = pcm->rbearing - pcm->width;
24058 if (pcm->lbearing < 0)
24059 *left = -pcm->lbearing;
24060 }
24061 }
24062 else if (glyph->type == COMPOSITE_GLYPH)
24063 {
24064 if (! glyph->u.cmp.automatic)
24065 {
24066 struct composition *cmp = composition_table[glyph->u.cmp.id];
24067
24068 if (cmp->rbearing > cmp->pixel_width)
24069 *right = cmp->rbearing - cmp->pixel_width;
24070 if (cmp->lbearing < 0)
24071 *left = - cmp->lbearing;
24072 }
24073 else
24074 {
24075 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
24076 struct font_metrics metrics;
24077
24078 composition_gstring_width (gstring, glyph->slice.cmp.from,
24079 glyph->slice.cmp.to + 1, &metrics);
24080 if (metrics.rbearing > metrics.width)
24081 *right = metrics.rbearing - metrics.width;
24082 if (metrics.lbearing < 0)
24083 *left = - metrics.lbearing;
24084 }
24085 }
24086 }
24087
24088
24089 /* Return the index of the first glyph preceding glyph string S that
24090 is overwritten by S because of S's left overhang. Value is -1
24091 if no glyphs are overwritten. */
24092
24093 static int
24094 left_overwritten (struct glyph_string *s)
24095 {
24096 int k;
24097
24098 if (s->left_overhang)
24099 {
24100 int x = 0, i;
24101 struct glyph *glyphs = s->row->glyphs[s->area];
24102 int first = s->first_glyph - glyphs;
24103
24104 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
24105 x -= glyphs[i].pixel_width;
24106
24107 k = i + 1;
24108 }
24109 else
24110 k = -1;
24111
24112 return k;
24113 }
24114
24115
24116 /* Return the index of the first glyph preceding glyph string S that
24117 is overwriting S because of its right overhang. Value is -1 if no
24118 glyph in front of S overwrites S. */
24119
24120 static int
24121 left_overwriting (struct glyph_string *s)
24122 {
24123 int i, k, x;
24124 struct glyph *glyphs = s->row->glyphs[s->area];
24125 int first = s->first_glyph - glyphs;
24126
24127 k = -1;
24128 x = 0;
24129 for (i = first - 1; i >= 0; --i)
24130 {
24131 int left, right;
24132 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24133 if (x + right > 0)
24134 k = i;
24135 x -= glyphs[i].pixel_width;
24136 }
24137
24138 return k;
24139 }
24140
24141
24142 /* Return the index of the last glyph following glyph string S that is
24143 overwritten by S because of S's right overhang. Value is -1 if
24144 no such glyph is found. */
24145
24146 static int
24147 right_overwritten (struct glyph_string *s)
24148 {
24149 int k = -1;
24150
24151 if (s->right_overhang)
24152 {
24153 int x = 0, i;
24154 struct glyph *glyphs = s->row->glyphs[s->area];
24155 int first = (s->first_glyph - glyphs
24156 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24157 int end = s->row->used[s->area];
24158
24159 for (i = first; i < end && s->right_overhang > x; ++i)
24160 x += glyphs[i].pixel_width;
24161
24162 k = i;
24163 }
24164
24165 return k;
24166 }
24167
24168
24169 /* Return the index of the last glyph following glyph string S that
24170 overwrites S because of its left overhang. Value is negative
24171 if no such glyph is found. */
24172
24173 static int
24174 right_overwriting (struct glyph_string *s)
24175 {
24176 int i, k, x;
24177 int end = s->row->used[s->area];
24178 struct glyph *glyphs = s->row->glyphs[s->area];
24179 int first = (s->first_glyph - glyphs
24180 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24181
24182 k = -1;
24183 x = 0;
24184 for (i = first; i < end; ++i)
24185 {
24186 int left, right;
24187 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24188 if (x - left < 0)
24189 k = i;
24190 x += glyphs[i].pixel_width;
24191 }
24192
24193 return k;
24194 }
24195
24196
24197 /* Set background width of glyph string S. START is the index of the
24198 first glyph following S. LAST_X is the right-most x-position + 1
24199 in the drawing area. */
24200
24201 static void
24202 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
24203 {
24204 /* If the face of this glyph string has to be drawn to the end of
24205 the drawing area, set S->extends_to_end_of_line_p. */
24206
24207 if (start == s->row->used[s->area]
24208 && ((s->row->fill_line_p
24209 && (s->hl == DRAW_NORMAL_TEXT
24210 || s->hl == DRAW_IMAGE_RAISED
24211 || s->hl == DRAW_IMAGE_SUNKEN))
24212 || s->hl == DRAW_MOUSE_FACE))
24213 s->extends_to_end_of_line_p = 1;
24214
24215 /* If S extends its face to the end of the line, set its
24216 background_width to the distance to the right edge of the drawing
24217 area. */
24218 if (s->extends_to_end_of_line_p)
24219 s->background_width = last_x - s->x + 1;
24220 else
24221 s->background_width = s->width;
24222 }
24223
24224
24225 /* Compute overhangs and x-positions for glyph string S and its
24226 predecessors, or successors. X is the starting x-position for S.
24227 BACKWARD_P non-zero means process predecessors. */
24228
24229 static void
24230 compute_overhangs_and_x (struct glyph_string *s, int x, int backward_p)
24231 {
24232 if (backward_p)
24233 {
24234 while (s)
24235 {
24236 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24237 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24238 x -= s->width;
24239 s->x = x;
24240 s = s->prev;
24241 }
24242 }
24243 else
24244 {
24245 while (s)
24246 {
24247 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24248 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24249 s->x = x;
24250 x += s->width;
24251 s = s->next;
24252 }
24253 }
24254 }
24255
24256
24257
24258 /* The following macros are only called from draw_glyphs below.
24259 They reference the following parameters of that function directly:
24260 `w', `row', `area', and `overlap_p'
24261 as well as the following local variables:
24262 `s', `f', and `hdc' (in W32) */
24263
24264 #ifdef HAVE_NTGUI
24265 /* On W32, silently add local `hdc' variable to argument list of
24266 init_glyph_string. */
24267 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24268 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24269 #else
24270 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24271 init_glyph_string (s, char2b, w, row, area, start, hl)
24272 #endif
24273
24274 /* Add a glyph string for a stretch glyph to the list of strings
24275 between HEAD and TAIL. START is the index of the stretch glyph in
24276 row area AREA of glyph row ROW. END is the index of the last glyph
24277 in that glyph row area. X is the current output position assigned
24278 to the new glyph string constructed. HL overrides that face of the
24279 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24280 is the right-most x-position of the drawing area. */
24281
24282 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24283 and below -- keep them on one line. */
24284 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24285 do \
24286 { \
24287 s = alloca (sizeof *s); \
24288 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24289 START = fill_stretch_glyph_string (s, START, END); \
24290 append_glyph_string (&HEAD, &TAIL, s); \
24291 s->x = (X); \
24292 } \
24293 while (0)
24294
24295
24296 /* Add a glyph string for an image glyph to the list of strings
24297 between HEAD and TAIL. START is the index of the image glyph in
24298 row area AREA of glyph row ROW. END is the index of the last glyph
24299 in that glyph row area. X is the current output position assigned
24300 to the new glyph string constructed. HL overrides that face of the
24301 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24302 is the right-most x-position of the drawing area. */
24303
24304 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24305 do \
24306 { \
24307 s = alloca (sizeof *s); \
24308 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24309 fill_image_glyph_string (s); \
24310 append_glyph_string (&HEAD, &TAIL, s); \
24311 ++START; \
24312 s->x = (X); \
24313 } \
24314 while (0)
24315
24316
24317 /* Add a glyph string for a sequence of character glyphs to the list
24318 of strings between HEAD and TAIL. START is the index of the first
24319 glyph in row area AREA of glyph row ROW that is part of the new
24320 glyph string. END is the index of the last glyph in that glyph row
24321 area. X is the current output position assigned to the new glyph
24322 string constructed. HL overrides that face of the glyph; e.g. it
24323 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24324 right-most x-position of the drawing area. */
24325
24326 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24327 do \
24328 { \
24329 int face_id; \
24330 XChar2b *char2b; \
24331 \
24332 face_id = (row)->glyphs[area][START].face_id; \
24333 \
24334 s = alloca (sizeof *s); \
24335 char2b = alloca ((END - START) * sizeof *char2b); \
24336 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24337 append_glyph_string (&HEAD, &TAIL, s); \
24338 s->x = (X); \
24339 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24340 } \
24341 while (0)
24342
24343
24344 /* Add a glyph string for a composite sequence to the list of strings
24345 between HEAD and TAIL. START is the index of the first glyph in
24346 row area AREA of glyph row ROW that is part of the new glyph
24347 string. END is the index of the last glyph in that glyph row area.
24348 X is the current output position assigned to the new glyph string
24349 constructed. HL overrides that face of the glyph; e.g. it is
24350 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24351 x-position of the drawing area. */
24352
24353 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24354 do { \
24355 int face_id = (row)->glyphs[area][START].face_id; \
24356 struct face *base_face = FACE_FROM_ID (f, face_id); \
24357 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24358 struct composition *cmp = composition_table[cmp_id]; \
24359 XChar2b *char2b; \
24360 struct glyph_string *first_s = NULL; \
24361 int n; \
24362 \
24363 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24364 \
24365 /* Make glyph_strings for each glyph sequence that is drawable by \
24366 the same face, and append them to HEAD/TAIL. */ \
24367 for (n = 0; n < cmp->glyph_len;) \
24368 { \
24369 s = alloca (sizeof *s); \
24370 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24371 append_glyph_string (&(HEAD), &(TAIL), s); \
24372 s->cmp = cmp; \
24373 s->cmp_from = n; \
24374 s->x = (X); \
24375 if (n == 0) \
24376 first_s = s; \
24377 n = fill_composite_glyph_string (s, base_face, overlaps); \
24378 } \
24379 \
24380 ++START; \
24381 s = first_s; \
24382 } while (0)
24383
24384
24385 /* Add a glyph string for a glyph-string sequence to the list of strings
24386 between HEAD and TAIL. */
24387
24388 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24389 do { \
24390 int face_id; \
24391 XChar2b *char2b; \
24392 Lisp_Object gstring; \
24393 \
24394 face_id = (row)->glyphs[area][START].face_id; \
24395 gstring = (composition_gstring_from_id \
24396 ((row)->glyphs[area][START].u.cmp.id)); \
24397 s = alloca (sizeof *s); \
24398 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24399 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24400 append_glyph_string (&(HEAD), &(TAIL), s); \
24401 s->x = (X); \
24402 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24403 } while (0)
24404
24405
24406 /* Add a glyph string for a sequence of glyphless character's glyphs
24407 to the list of strings between HEAD and TAIL. The meanings of
24408 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24409
24410 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24411 do \
24412 { \
24413 int face_id; \
24414 \
24415 face_id = (row)->glyphs[area][START].face_id; \
24416 \
24417 s = alloca (sizeof *s); \
24418 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24419 append_glyph_string (&HEAD, &TAIL, s); \
24420 s->x = (X); \
24421 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24422 overlaps); \
24423 } \
24424 while (0)
24425
24426
24427 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24428 of AREA of glyph row ROW on window W between indices START and END.
24429 HL overrides the face for drawing glyph strings, e.g. it is
24430 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24431 x-positions of the drawing area.
24432
24433 This is an ugly monster macro construct because we must use alloca
24434 to allocate glyph strings (because draw_glyphs can be called
24435 asynchronously). */
24436
24437 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24438 do \
24439 { \
24440 HEAD = TAIL = NULL; \
24441 while (START < END) \
24442 { \
24443 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24444 switch (first_glyph->type) \
24445 { \
24446 case CHAR_GLYPH: \
24447 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24448 HL, X, LAST_X); \
24449 break; \
24450 \
24451 case COMPOSITE_GLYPH: \
24452 if (first_glyph->u.cmp.automatic) \
24453 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24454 HL, X, LAST_X); \
24455 else \
24456 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24457 HL, X, LAST_X); \
24458 break; \
24459 \
24460 case STRETCH_GLYPH: \
24461 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24462 HL, X, LAST_X); \
24463 break; \
24464 \
24465 case IMAGE_GLYPH: \
24466 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24467 HL, X, LAST_X); \
24468 break; \
24469 \
24470 case GLYPHLESS_GLYPH: \
24471 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24472 HL, X, LAST_X); \
24473 break; \
24474 \
24475 default: \
24476 emacs_abort (); \
24477 } \
24478 \
24479 if (s) \
24480 { \
24481 set_glyph_string_background_width (s, START, LAST_X); \
24482 (X) += s->width; \
24483 } \
24484 } \
24485 } while (0)
24486
24487
24488 /* Draw glyphs between START and END in AREA of ROW on window W,
24489 starting at x-position X. X is relative to AREA in W. HL is a
24490 face-override with the following meaning:
24491
24492 DRAW_NORMAL_TEXT draw normally
24493 DRAW_CURSOR draw in cursor face
24494 DRAW_MOUSE_FACE draw in mouse face.
24495 DRAW_INVERSE_VIDEO draw in mode line face
24496 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24497 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24498
24499 If OVERLAPS is non-zero, draw only the foreground of characters and
24500 clip to the physical height of ROW. Non-zero value also defines
24501 the overlapping part to be drawn:
24502
24503 OVERLAPS_PRED overlap with preceding rows
24504 OVERLAPS_SUCC overlap with succeeding rows
24505 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24506 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24507
24508 Value is the x-position reached, relative to AREA of W. */
24509
24510 static int
24511 draw_glyphs (struct window *w, int x, struct glyph_row *row,
24512 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
24513 enum draw_glyphs_face hl, int overlaps)
24514 {
24515 struct glyph_string *head, *tail;
24516 struct glyph_string *s;
24517 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
24518 int i, j, x_reached, last_x, area_left = 0;
24519 struct frame *f = XFRAME (WINDOW_FRAME (w));
24520 DECLARE_HDC (hdc);
24521
24522 ALLOCATE_HDC (hdc, f);
24523
24524 /* Let's rather be paranoid than getting a SEGV. */
24525 end = min (end, row->used[area]);
24526 start = clip_to_bounds (0, start, end);
24527
24528 /* Translate X to frame coordinates. Set last_x to the right
24529 end of the drawing area. */
24530 if (row->full_width_p)
24531 {
24532 /* X is relative to the left edge of W, without scroll bars
24533 or fringes. */
24534 area_left = WINDOW_LEFT_EDGE_X (w);
24535 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
24536 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
24537 }
24538 else
24539 {
24540 area_left = window_box_left (w, area);
24541 last_x = area_left + window_box_width (w, area);
24542 }
24543 x += area_left;
24544
24545 /* Build a doubly-linked list of glyph_string structures between
24546 head and tail from what we have to draw. Note that the macro
24547 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24548 the reason we use a separate variable `i'. */
24549 i = start;
24550 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
24551 if (tail)
24552 x_reached = tail->x + tail->background_width;
24553 else
24554 x_reached = x;
24555
24556 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24557 the row, redraw some glyphs in front or following the glyph
24558 strings built above. */
24559 if (head && !overlaps && row->contains_overlapping_glyphs_p)
24560 {
24561 struct glyph_string *h, *t;
24562 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
24563 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
24564 int check_mouse_face = 0;
24565 int dummy_x = 0;
24566
24567 /* If mouse highlighting is on, we may need to draw adjacent
24568 glyphs using mouse-face highlighting. */
24569 if (area == TEXT_AREA && row->mouse_face_p
24570 && hlinfo->mouse_face_beg_row >= 0
24571 && hlinfo->mouse_face_end_row >= 0)
24572 {
24573 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
24574
24575 if (row_vpos >= hlinfo->mouse_face_beg_row
24576 && row_vpos <= hlinfo->mouse_face_end_row)
24577 {
24578 check_mouse_face = 1;
24579 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
24580 ? hlinfo->mouse_face_beg_col : 0;
24581 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
24582 ? hlinfo->mouse_face_end_col
24583 : row->used[TEXT_AREA];
24584 }
24585 }
24586
24587 /* Compute overhangs for all glyph strings. */
24588 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
24589 for (s = head; s; s = s->next)
24590 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
24591
24592 /* Prepend glyph strings for glyphs in front of the first glyph
24593 string that are overwritten because of the first glyph
24594 string's left overhang. The background of all strings
24595 prepended must be drawn because the first glyph string
24596 draws over it. */
24597 i = left_overwritten (head);
24598 if (i >= 0)
24599 {
24600 enum draw_glyphs_face overlap_hl;
24601
24602 /* If this row contains mouse highlighting, attempt to draw
24603 the overlapped glyphs with the correct highlight. This
24604 code fails if the overlap encompasses more than one glyph
24605 and mouse-highlight spans only some of these glyphs.
24606 However, making it work perfectly involves a lot more
24607 code, and I don't know if the pathological case occurs in
24608 practice, so we'll stick to this for now. --- cyd */
24609 if (check_mouse_face
24610 && mouse_beg_col < start && mouse_end_col > i)
24611 overlap_hl = DRAW_MOUSE_FACE;
24612 else
24613 overlap_hl = DRAW_NORMAL_TEXT;
24614
24615 if (hl != overlap_hl)
24616 clip_head = head;
24617 j = i;
24618 BUILD_GLYPH_STRINGS (j, start, h, t,
24619 overlap_hl, dummy_x, last_x);
24620 start = i;
24621 compute_overhangs_and_x (t, head->x, 1);
24622 prepend_glyph_string_lists (&head, &tail, h, t);
24623 if (clip_head == NULL)
24624 clip_head = head;
24625 }
24626
24627 /* Prepend glyph strings for glyphs in front of the first glyph
24628 string that overwrite that glyph string because of their
24629 right overhang. For these strings, only the foreground must
24630 be drawn, because it draws over the glyph string at `head'.
24631 The background must not be drawn because this would overwrite
24632 right overhangs of preceding glyphs for which no glyph
24633 strings exist. */
24634 i = left_overwriting (head);
24635 if (i >= 0)
24636 {
24637 enum draw_glyphs_face overlap_hl;
24638
24639 if (check_mouse_face
24640 && mouse_beg_col < start && mouse_end_col > i)
24641 overlap_hl = DRAW_MOUSE_FACE;
24642 else
24643 overlap_hl = DRAW_NORMAL_TEXT;
24644
24645 if (hl == overlap_hl || clip_head == NULL)
24646 clip_head = head;
24647 BUILD_GLYPH_STRINGS (i, start, h, t,
24648 overlap_hl, dummy_x, last_x);
24649 for (s = h; s; s = s->next)
24650 s->background_filled_p = 1;
24651 compute_overhangs_and_x (t, head->x, 1);
24652 prepend_glyph_string_lists (&head, &tail, h, t);
24653 }
24654
24655 /* Append glyphs strings for glyphs following the last glyph
24656 string tail that are overwritten by tail. The background of
24657 these strings has to be drawn because tail's foreground draws
24658 over it. */
24659 i = right_overwritten (tail);
24660 if (i >= 0)
24661 {
24662 enum draw_glyphs_face overlap_hl;
24663
24664 if (check_mouse_face
24665 && mouse_beg_col < i && mouse_end_col > end)
24666 overlap_hl = DRAW_MOUSE_FACE;
24667 else
24668 overlap_hl = DRAW_NORMAL_TEXT;
24669
24670 if (hl != overlap_hl)
24671 clip_tail = tail;
24672 BUILD_GLYPH_STRINGS (end, i, h, t,
24673 overlap_hl, x, last_x);
24674 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24675 we don't have `end = i;' here. */
24676 compute_overhangs_and_x (h, tail->x + tail->width, 0);
24677 append_glyph_string_lists (&head, &tail, h, t);
24678 if (clip_tail == NULL)
24679 clip_tail = tail;
24680 }
24681
24682 /* Append glyph strings for glyphs following the last glyph
24683 string tail that overwrite tail. The foreground of such
24684 glyphs has to be drawn because it writes into the background
24685 of tail. The background must not be drawn because it could
24686 paint over the foreground of following glyphs. */
24687 i = right_overwriting (tail);
24688 if (i >= 0)
24689 {
24690 enum draw_glyphs_face overlap_hl;
24691 if (check_mouse_face
24692 && mouse_beg_col < i && mouse_end_col > end)
24693 overlap_hl = DRAW_MOUSE_FACE;
24694 else
24695 overlap_hl = DRAW_NORMAL_TEXT;
24696
24697 if (hl == overlap_hl || clip_tail == NULL)
24698 clip_tail = tail;
24699 i++; /* We must include the Ith glyph. */
24700 BUILD_GLYPH_STRINGS (end, i, h, t,
24701 overlap_hl, x, last_x);
24702 for (s = h; s; s = s->next)
24703 s->background_filled_p = 1;
24704 compute_overhangs_and_x (h, tail->x + tail->width, 0);
24705 append_glyph_string_lists (&head, &tail, h, t);
24706 }
24707 if (clip_head || clip_tail)
24708 for (s = head; s; s = s->next)
24709 {
24710 s->clip_head = clip_head;
24711 s->clip_tail = clip_tail;
24712 }
24713 }
24714
24715 /* Draw all strings. */
24716 for (s = head; s; s = s->next)
24717 FRAME_RIF (f)->draw_glyph_string (s);
24718
24719 #ifndef HAVE_NS
24720 /* When focus a sole frame and move horizontally, this sets on_p to 0
24721 causing a failure to erase prev cursor position. */
24722 if (area == TEXT_AREA
24723 && !row->full_width_p
24724 /* When drawing overlapping rows, only the glyph strings'
24725 foreground is drawn, which doesn't erase a cursor
24726 completely. */
24727 && !overlaps)
24728 {
24729 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
24730 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
24731 : (tail ? tail->x + tail->background_width : x));
24732 x0 -= area_left;
24733 x1 -= area_left;
24734
24735 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
24736 row->y, MATRIX_ROW_BOTTOM_Y (row));
24737 }
24738 #endif
24739
24740 /* Value is the x-position up to which drawn, relative to AREA of W.
24741 This doesn't include parts drawn because of overhangs. */
24742 if (row->full_width_p)
24743 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
24744 else
24745 x_reached -= area_left;
24746
24747 RELEASE_HDC (hdc, f);
24748
24749 return x_reached;
24750 }
24751
24752 /* Expand row matrix if too narrow. Don't expand if area
24753 is not present. */
24754
24755 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24756 { \
24757 if (!it->f->fonts_changed \
24758 && (it->glyph_row->glyphs[area] \
24759 < it->glyph_row->glyphs[area + 1])) \
24760 { \
24761 it->w->ncols_scale_factor++; \
24762 it->f->fonts_changed = 1; \
24763 } \
24764 }
24765
24766 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24767 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24768
24769 static void
24770 append_glyph (struct it *it)
24771 {
24772 struct glyph *glyph;
24773 enum glyph_row_area area = it->area;
24774
24775 eassert (it->glyph_row);
24776 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
24777
24778 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
24779 if (glyph < it->glyph_row->glyphs[area + 1])
24780 {
24781 /* If the glyph row is reversed, we need to prepend the glyph
24782 rather than append it. */
24783 if (it->glyph_row->reversed_p && area == TEXT_AREA)
24784 {
24785 struct glyph *g;
24786
24787 /* Make room for the additional glyph. */
24788 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
24789 g[1] = *g;
24790 glyph = it->glyph_row->glyphs[area];
24791 }
24792 glyph->charpos = CHARPOS (it->position);
24793 glyph->object = it->object;
24794 if (it->pixel_width > 0)
24795 {
24796 glyph->pixel_width = it->pixel_width;
24797 glyph->padding_p = 0;
24798 }
24799 else
24800 {
24801 /* Assure at least 1-pixel width. Otherwise, cursor can't
24802 be displayed correctly. */
24803 glyph->pixel_width = 1;
24804 glyph->padding_p = 1;
24805 }
24806 glyph->ascent = it->ascent;
24807 glyph->descent = it->descent;
24808 glyph->voffset = it->voffset;
24809 glyph->type = CHAR_GLYPH;
24810 glyph->avoid_cursor_p = it->avoid_cursor_p;
24811 glyph->multibyte_p = it->multibyte_p;
24812 if (it->glyph_row->reversed_p && area == TEXT_AREA)
24813 {
24814 /* In R2L rows, the left and the right box edges need to be
24815 drawn in reverse direction. */
24816 glyph->right_box_line_p = it->start_of_box_run_p;
24817 glyph->left_box_line_p = it->end_of_box_run_p;
24818 }
24819 else
24820 {
24821 glyph->left_box_line_p = it->start_of_box_run_p;
24822 glyph->right_box_line_p = it->end_of_box_run_p;
24823 }
24824 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
24825 || it->phys_descent > it->descent);
24826 glyph->glyph_not_available_p = it->glyph_not_available_p;
24827 glyph->face_id = it->face_id;
24828 glyph->u.ch = it->char_to_display;
24829 glyph->slice.img = null_glyph_slice;
24830 glyph->font_type = FONT_TYPE_UNKNOWN;
24831 if (it->bidi_p)
24832 {
24833 glyph->resolved_level = it->bidi_it.resolved_level;
24834 if ((it->bidi_it.type & 7) != it->bidi_it.type)
24835 emacs_abort ();
24836 glyph->bidi_type = it->bidi_it.type;
24837 }
24838 else
24839 {
24840 glyph->resolved_level = 0;
24841 glyph->bidi_type = UNKNOWN_BT;
24842 }
24843 ++it->glyph_row->used[area];
24844 }
24845 else
24846 IT_EXPAND_MATRIX_WIDTH (it, area);
24847 }
24848
24849 /* Store one glyph for the composition IT->cmp_it.id in
24850 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24851 non-null. */
24852
24853 static void
24854 append_composite_glyph (struct it *it)
24855 {
24856 struct glyph *glyph;
24857 enum glyph_row_area area = it->area;
24858
24859 eassert (it->glyph_row);
24860
24861 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
24862 if (glyph < it->glyph_row->glyphs[area + 1])
24863 {
24864 /* If the glyph row is reversed, we need to prepend the glyph
24865 rather than append it. */
24866 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
24867 {
24868 struct glyph *g;
24869
24870 /* Make room for the new glyph. */
24871 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
24872 g[1] = *g;
24873 glyph = it->glyph_row->glyphs[it->area];
24874 }
24875 glyph->charpos = it->cmp_it.charpos;
24876 glyph->object = it->object;
24877 glyph->pixel_width = it->pixel_width;
24878 glyph->ascent = it->ascent;
24879 glyph->descent = it->descent;
24880 glyph->voffset = it->voffset;
24881 glyph->type = COMPOSITE_GLYPH;
24882 if (it->cmp_it.ch < 0)
24883 {
24884 glyph->u.cmp.automatic = 0;
24885 glyph->u.cmp.id = it->cmp_it.id;
24886 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
24887 }
24888 else
24889 {
24890 glyph->u.cmp.automatic = 1;
24891 glyph->u.cmp.id = it->cmp_it.id;
24892 glyph->slice.cmp.from = it->cmp_it.from;
24893 glyph->slice.cmp.to = it->cmp_it.to - 1;
24894 }
24895 glyph->avoid_cursor_p = it->avoid_cursor_p;
24896 glyph->multibyte_p = it->multibyte_p;
24897 if (it->glyph_row->reversed_p && area == TEXT_AREA)
24898 {
24899 /* In R2L rows, the left and the right box edges need to be
24900 drawn in reverse direction. */
24901 glyph->right_box_line_p = it->start_of_box_run_p;
24902 glyph->left_box_line_p = it->end_of_box_run_p;
24903 }
24904 else
24905 {
24906 glyph->left_box_line_p = it->start_of_box_run_p;
24907 glyph->right_box_line_p = it->end_of_box_run_p;
24908 }
24909 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
24910 || it->phys_descent > it->descent);
24911 glyph->padding_p = 0;
24912 glyph->glyph_not_available_p = 0;
24913 glyph->face_id = it->face_id;
24914 glyph->font_type = FONT_TYPE_UNKNOWN;
24915 if (it->bidi_p)
24916 {
24917 glyph->resolved_level = it->bidi_it.resolved_level;
24918 if ((it->bidi_it.type & 7) != it->bidi_it.type)
24919 emacs_abort ();
24920 glyph->bidi_type = it->bidi_it.type;
24921 }
24922 ++it->glyph_row->used[area];
24923 }
24924 else
24925 IT_EXPAND_MATRIX_WIDTH (it, area);
24926 }
24927
24928
24929 /* Change IT->ascent and IT->height according to the setting of
24930 IT->voffset. */
24931
24932 static void
24933 take_vertical_position_into_account (struct it *it)
24934 {
24935 if (it->voffset)
24936 {
24937 if (it->voffset < 0)
24938 /* Increase the ascent so that we can display the text higher
24939 in the line. */
24940 it->ascent -= it->voffset;
24941 else
24942 /* Increase the descent so that we can display the text lower
24943 in the line. */
24944 it->descent += it->voffset;
24945 }
24946 }
24947
24948
24949 /* Produce glyphs/get display metrics for the image IT is loaded with.
24950 See the description of struct display_iterator in dispextern.h for
24951 an overview of struct display_iterator. */
24952
24953 static void
24954 produce_image_glyph (struct it *it)
24955 {
24956 struct image *img;
24957 struct face *face;
24958 int glyph_ascent, crop;
24959 struct glyph_slice slice;
24960
24961 eassert (it->what == IT_IMAGE);
24962
24963 face = FACE_FROM_ID (it->f, it->face_id);
24964 eassert (face);
24965 /* Make sure X resources of the face is loaded. */
24966 prepare_face_for_display (it->f, face);
24967
24968 if (it->image_id < 0)
24969 {
24970 /* Fringe bitmap. */
24971 it->ascent = it->phys_ascent = 0;
24972 it->descent = it->phys_descent = 0;
24973 it->pixel_width = 0;
24974 it->nglyphs = 0;
24975 return;
24976 }
24977
24978 img = IMAGE_FROM_ID (it->f, it->image_id);
24979 eassert (img);
24980 /* Make sure X resources of the image is loaded. */
24981 prepare_image_for_display (it->f, img);
24982
24983 slice.x = slice.y = 0;
24984 slice.width = img->width;
24985 slice.height = img->height;
24986
24987 if (INTEGERP (it->slice.x))
24988 slice.x = XINT (it->slice.x);
24989 else if (FLOATP (it->slice.x))
24990 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
24991
24992 if (INTEGERP (it->slice.y))
24993 slice.y = XINT (it->slice.y);
24994 else if (FLOATP (it->slice.y))
24995 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
24996
24997 if (INTEGERP (it->slice.width))
24998 slice.width = XINT (it->slice.width);
24999 else if (FLOATP (it->slice.width))
25000 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
25001
25002 if (INTEGERP (it->slice.height))
25003 slice.height = XINT (it->slice.height);
25004 else if (FLOATP (it->slice.height))
25005 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
25006
25007 if (slice.x >= img->width)
25008 slice.x = img->width;
25009 if (slice.y >= img->height)
25010 slice.y = img->height;
25011 if (slice.x + slice.width >= img->width)
25012 slice.width = img->width - slice.x;
25013 if (slice.y + slice.height > img->height)
25014 slice.height = img->height - slice.y;
25015
25016 if (slice.width == 0 || slice.height == 0)
25017 return;
25018
25019 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
25020
25021 it->descent = slice.height - glyph_ascent;
25022 if (slice.y == 0)
25023 it->descent += img->vmargin;
25024 if (slice.y + slice.height == img->height)
25025 it->descent += img->vmargin;
25026 it->phys_descent = it->descent;
25027
25028 it->pixel_width = slice.width;
25029 if (slice.x == 0)
25030 it->pixel_width += img->hmargin;
25031 if (slice.x + slice.width == img->width)
25032 it->pixel_width += img->hmargin;
25033
25034 /* It's quite possible for images to have an ascent greater than
25035 their height, so don't get confused in that case. */
25036 if (it->descent < 0)
25037 it->descent = 0;
25038
25039 it->nglyphs = 1;
25040
25041 if (face->box != FACE_NO_BOX)
25042 {
25043 if (face->box_line_width > 0)
25044 {
25045 if (slice.y == 0)
25046 it->ascent += face->box_line_width;
25047 if (slice.y + slice.height == img->height)
25048 it->descent += face->box_line_width;
25049 }
25050
25051 if (it->start_of_box_run_p && slice.x == 0)
25052 it->pixel_width += eabs (face->box_line_width);
25053 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
25054 it->pixel_width += eabs (face->box_line_width);
25055 }
25056
25057 take_vertical_position_into_account (it);
25058
25059 /* Automatically crop wide image glyphs at right edge so we can
25060 draw the cursor on same display row. */
25061 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
25062 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
25063 {
25064 it->pixel_width -= crop;
25065 slice.width -= crop;
25066 }
25067
25068 if (it->glyph_row)
25069 {
25070 struct glyph *glyph;
25071 enum glyph_row_area area = it->area;
25072
25073 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25074 if (glyph < it->glyph_row->glyphs[area + 1])
25075 {
25076 glyph->charpos = CHARPOS (it->position);
25077 glyph->object = it->object;
25078 glyph->pixel_width = it->pixel_width;
25079 glyph->ascent = glyph_ascent;
25080 glyph->descent = it->descent;
25081 glyph->voffset = it->voffset;
25082 glyph->type = IMAGE_GLYPH;
25083 glyph->avoid_cursor_p = it->avoid_cursor_p;
25084 glyph->multibyte_p = it->multibyte_p;
25085 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25086 {
25087 /* In R2L rows, the left and the right box edges need to be
25088 drawn in reverse direction. */
25089 glyph->right_box_line_p = it->start_of_box_run_p;
25090 glyph->left_box_line_p = it->end_of_box_run_p;
25091 }
25092 else
25093 {
25094 glyph->left_box_line_p = it->start_of_box_run_p;
25095 glyph->right_box_line_p = it->end_of_box_run_p;
25096 }
25097 glyph->overlaps_vertically_p = 0;
25098 glyph->padding_p = 0;
25099 glyph->glyph_not_available_p = 0;
25100 glyph->face_id = it->face_id;
25101 glyph->u.img_id = img->id;
25102 glyph->slice.img = slice;
25103 glyph->font_type = FONT_TYPE_UNKNOWN;
25104 if (it->bidi_p)
25105 {
25106 glyph->resolved_level = it->bidi_it.resolved_level;
25107 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25108 emacs_abort ();
25109 glyph->bidi_type = it->bidi_it.type;
25110 }
25111 ++it->glyph_row->used[area];
25112 }
25113 else
25114 IT_EXPAND_MATRIX_WIDTH (it, area);
25115 }
25116 }
25117
25118
25119 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25120 of the glyph, WIDTH and HEIGHT are the width and height of the
25121 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25122
25123 static void
25124 append_stretch_glyph (struct it *it, Lisp_Object object,
25125 int width, int height, int ascent)
25126 {
25127 struct glyph *glyph;
25128 enum glyph_row_area area = it->area;
25129
25130 eassert (ascent >= 0 && ascent <= height);
25131
25132 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25133 if (glyph < it->glyph_row->glyphs[area + 1])
25134 {
25135 /* If the glyph row is reversed, we need to prepend the glyph
25136 rather than append it. */
25137 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25138 {
25139 struct glyph *g;
25140
25141 /* Make room for the additional glyph. */
25142 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25143 g[1] = *g;
25144 glyph = it->glyph_row->glyphs[area];
25145 }
25146 glyph->charpos = CHARPOS (it->position);
25147 glyph->object = object;
25148 glyph->pixel_width = width;
25149 glyph->ascent = ascent;
25150 glyph->descent = height - ascent;
25151 glyph->voffset = it->voffset;
25152 glyph->type = STRETCH_GLYPH;
25153 glyph->avoid_cursor_p = it->avoid_cursor_p;
25154 glyph->multibyte_p = it->multibyte_p;
25155 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25156 {
25157 /* In R2L rows, the left and the right box edges need to be
25158 drawn in reverse direction. */
25159 glyph->right_box_line_p = it->start_of_box_run_p;
25160 glyph->left_box_line_p = it->end_of_box_run_p;
25161 }
25162 else
25163 {
25164 glyph->left_box_line_p = it->start_of_box_run_p;
25165 glyph->right_box_line_p = it->end_of_box_run_p;
25166 }
25167 glyph->overlaps_vertically_p = 0;
25168 glyph->padding_p = 0;
25169 glyph->glyph_not_available_p = 0;
25170 glyph->face_id = it->face_id;
25171 glyph->u.stretch.ascent = ascent;
25172 glyph->u.stretch.height = height;
25173 glyph->slice.img = null_glyph_slice;
25174 glyph->font_type = FONT_TYPE_UNKNOWN;
25175 if (it->bidi_p)
25176 {
25177 glyph->resolved_level = it->bidi_it.resolved_level;
25178 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25179 emacs_abort ();
25180 glyph->bidi_type = it->bidi_it.type;
25181 }
25182 else
25183 {
25184 glyph->resolved_level = 0;
25185 glyph->bidi_type = UNKNOWN_BT;
25186 }
25187 ++it->glyph_row->used[area];
25188 }
25189 else
25190 IT_EXPAND_MATRIX_WIDTH (it, area);
25191 }
25192
25193 #endif /* HAVE_WINDOW_SYSTEM */
25194
25195 /* Produce a stretch glyph for iterator IT. IT->object is the value
25196 of the glyph property displayed. The value must be a list
25197 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25198 being recognized:
25199
25200 1. `:width WIDTH' specifies that the space should be WIDTH *
25201 canonical char width wide. WIDTH may be an integer or floating
25202 point number.
25203
25204 2. `:relative-width FACTOR' specifies that the width of the stretch
25205 should be computed from the width of the first character having the
25206 `glyph' property, and should be FACTOR times that width.
25207
25208 3. `:align-to HPOS' specifies that the space should be wide enough
25209 to reach HPOS, a value in canonical character units.
25210
25211 Exactly one of the above pairs must be present.
25212
25213 4. `:height HEIGHT' specifies that the height of the stretch produced
25214 should be HEIGHT, measured in canonical character units.
25215
25216 5. `:relative-height FACTOR' specifies that the height of the
25217 stretch should be FACTOR times the height of the characters having
25218 the glyph property.
25219
25220 Either none or exactly one of 4 or 5 must be present.
25221
25222 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25223 of the stretch should be used for the ascent of the stretch.
25224 ASCENT must be in the range 0 <= ASCENT <= 100. */
25225
25226 void
25227 produce_stretch_glyph (struct it *it)
25228 {
25229 /* (space :width WIDTH :height HEIGHT ...) */
25230 Lisp_Object prop, plist;
25231 int width = 0, height = 0, align_to = -1;
25232 int zero_width_ok_p = 0;
25233 double tem;
25234 struct font *font = NULL;
25235
25236 #ifdef HAVE_WINDOW_SYSTEM
25237 int ascent = 0;
25238 int zero_height_ok_p = 0;
25239
25240 if (FRAME_WINDOW_P (it->f))
25241 {
25242 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25243 font = face->font ? face->font : FRAME_FONT (it->f);
25244 prepare_face_for_display (it->f, face);
25245 }
25246 #endif
25247
25248 /* List should start with `space'. */
25249 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
25250 plist = XCDR (it->object);
25251
25252 /* Compute the width of the stretch. */
25253 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
25254 && calc_pixel_width_or_height (&tem, it, prop, font, 1, 0))
25255 {
25256 /* Absolute width `:width WIDTH' specified and valid. */
25257 zero_width_ok_p = 1;
25258 width = (int)tem;
25259 }
25260 #ifdef HAVE_WINDOW_SYSTEM
25261 else if (FRAME_WINDOW_P (it->f)
25262 && (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0))
25263 {
25264 /* Relative width `:relative-width FACTOR' specified and valid.
25265 Compute the width of the characters having the `glyph'
25266 property. */
25267 struct it it2;
25268 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
25269
25270 it2 = *it;
25271 if (it->multibyte_p)
25272 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
25273 else
25274 {
25275 it2.c = it2.char_to_display = *p, it2.len = 1;
25276 if (! ASCII_CHAR_P (it2.c))
25277 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
25278 }
25279
25280 it2.glyph_row = NULL;
25281 it2.what = IT_CHARACTER;
25282 x_produce_glyphs (&it2);
25283 width = NUMVAL (prop) * it2.pixel_width;
25284 }
25285 #endif /* HAVE_WINDOW_SYSTEM */
25286 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
25287 && calc_pixel_width_or_height (&tem, it, prop, font, 1, &align_to))
25288 {
25289 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
25290 align_to = (align_to < 0
25291 ? 0
25292 : align_to - window_box_left_offset (it->w, TEXT_AREA));
25293 else if (align_to < 0)
25294 align_to = window_box_left_offset (it->w, TEXT_AREA);
25295 width = max (0, (int)tem + align_to - it->current_x);
25296 zero_width_ok_p = 1;
25297 }
25298 else
25299 /* Nothing specified -> width defaults to canonical char width. */
25300 width = FRAME_COLUMN_WIDTH (it->f);
25301
25302 if (width <= 0 && (width < 0 || !zero_width_ok_p))
25303 width = 1;
25304
25305 #ifdef HAVE_WINDOW_SYSTEM
25306 /* Compute height. */
25307 if (FRAME_WINDOW_P (it->f))
25308 {
25309 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
25310 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25311 {
25312 height = (int)tem;
25313 zero_height_ok_p = 1;
25314 }
25315 else if (prop = Fplist_get (plist, QCrelative_height),
25316 NUMVAL (prop) > 0)
25317 height = FONT_HEIGHT (font) * NUMVAL (prop);
25318 else
25319 height = FONT_HEIGHT (font);
25320
25321 if (height <= 0 && (height < 0 || !zero_height_ok_p))
25322 height = 1;
25323
25324 /* Compute percentage of height used for ascent. If
25325 `:ascent ASCENT' is present and valid, use that. Otherwise,
25326 derive the ascent from the font in use. */
25327 if (prop = Fplist_get (plist, QCascent),
25328 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
25329 ascent = height * NUMVAL (prop) / 100.0;
25330 else if (!NILP (prop)
25331 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25332 ascent = min (max (0, (int)tem), height);
25333 else
25334 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
25335 }
25336 else
25337 #endif /* HAVE_WINDOW_SYSTEM */
25338 height = 1;
25339
25340 if (width > 0 && it->line_wrap != TRUNCATE
25341 && it->current_x + width > it->last_visible_x)
25342 {
25343 width = it->last_visible_x - it->current_x;
25344 #ifdef HAVE_WINDOW_SYSTEM
25345 /* Subtract one more pixel from the stretch width, but only on
25346 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25347 width -= FRAME_WINDOW_P (it->f);
25348 #endif
25349 }
25350
25351 if (width > 0 && height > 0 && it->glyph_row)
25352 {
25353 Lisp_Object o_object = it->object;
25354 Lisp_Object object = it->stack[it->sp - 1].string;
25355 int n = width;
25356
25357 if (!STRINGP (object))
25358 object = it->w->contents;
25359 #ifdef HAVE_WINDOW_SYSTEM
25360 if (FRAME_WINDOW_P (it->f))
25361 append_stretch_glyph (it, object, width, height, ascent);
25362 else
25363 #endif
25364 {
25365 it->object = object;
25366 it->char_to_display = ' ';
25367 it->pixel_width = it->len = 1;
25368 while (n--)
25369 tty_append_glyph (it);
25370 it->object = o_object;
25371 }
25372 }
25373
25374 it->pixel_width = width;
25375 #ifdef HAVE_WINDOW_SYSTEM
25376 if (FRAME_WINDOW_P (it->f))
25377 {
25378 it->ascent = it->phys_ascent = ascent;
25379 it->descent = it->phys_descent = height - it->ascent;
25380 it->nglyphs = width > 0 && height > 0 ? 1 : 0;
25381 take_vertical_position_into_account (it);
25382 }
25383 else
25384 #endif
25385 it->nglyphs = width;
25386 }
25387
25388 /* Get information about special display element WHAT in an
25389 environment described by IT. WHAT is one of IT_TRUNCATION or
25390 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25391 non-null glyph_row member. This function ensures that fields like
25392 face_id, c, len of IT are left untouched. */
25393
25394 static void
25395 produce_special_glyphs (struct it *it, enum display_element_type what)
25396 {
25397 struct it temp_it;
25398 Lisp_Object gc;
25399 GLYPH glyph;
25400
25401 temp_it = *it;
25402 temp_it.object = make_number (0);
25403 memset (&temp_it.current, 0, sizeof temp_it.current);
25404
25405 if (what == IT_CONTINUATION)
25406 {
25407 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25408 if (it->bidi_it.paragraph_dir == R2L)
25409 SET_GLYPH_FROM_CHAR (glyph, '/');
25410 else
25411 SET_GLYPH_FROM_CHAR (glyph, '\\');
25412 if (it->dp
25413 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25414 {
25415 /* FIXME: Should we mirror GC for R2L lines? */
25416 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25417 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25418 }
25419 }
25420 else if (what == IT_TRUNCATION)
25421 {
25422 /* Truncation glyph. */
25423 SET_GLYPH_FROM_CHAR (glyph, '$');
25424 if (it->dp
25425 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25426 {
25427 /* FIXME: Should we mirror GC for R2L lines? */
25428 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25429 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25430 }
25431 }
25432 else
25433 emacs_abort ();
25434
25435 #ifdef HAVE_WINDOW_SYSTEM
25436 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25437 is turned off, we precede the truncation/continuation glyphs by a
25438 stretch glyph whose width is computed such that these special
25439 glyphs are aligned at the window margin, even when very different
25440 fonts are used in different glyph rows. */
25441 if (FRAME_WINDOW_P (temp_it.f)
25442 /* init_iterator calls this with it->glyph_row == NULL, and it
25443 wants only the pixel width of the truncation/continuation
25444 glyphs. */
25445 && temp_it.glyph_row
25446 /* insert_left_trunc_glyphs calls us at the beginning of the
25447 row, and it has its own calculation of the stretch glyph
25448 width. */
25449 && temp_it.glyph_row->used[TEXT_AREA] > 0
25450 && (temp_it.glyph_row->reversed_p
25451 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
25452 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
25453 {
25454 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
25455
25456 if (stretch_width > 0)
25457 {
25458 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
25459 struct font *font =
25460 face->font ? face->font : FRAME_FONT (temp_it.f);
25461 int stretch_ascent =
25462 (((temp_it.ascent + temp_it.descent)
25463 * FONT_BASE (font)) / FONT_HEIGHT (font));
25464
25465 append_stretch_glyph (&temp_it, make_number (0), stretch_width,
25466 temp_it.ascent + temp_it.descent,
25467 stretch_ascent);
25468 }
25469 }
25470 #endif
25471
25472 temp_it.dp = NULL;
25473 temp_it.what = IT_CHARACTER;
25474 temp_it.len = 1;
25475 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
25476 temp_it.face_id = GLYPH_FACE (glyph);
25477 temp_it.len = CHAR_BYTES (temp_it.c);
25478
25479 PRODUCE_GLYPHS (&temp_it);
25480 it->pixel_width = temp_it.pixel_width;
25481 it->nglyphs = temp_it.pixel_width;
25482 }
25483
25484 #ifdef HAVE_WINDOW_SYSTEM
25485
25486 /* Calculate line-height and line-spacing properties.
25487 An integer value specifies explicit pixel value.
25488 A float value specifies relative value to current face height.
25489 A cons (float . face-name) specifies relative value to
25490 height of specified face font.
25491
25492 Returns height in pixels, or nil. */
25493
25494
25495 static Lisp_Object
25496 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
25497 int boff, int override)
25498 {
25499 Lisp_Object face_name = Qnil;
25500 int ascent, descent, height;
25501
25502 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
25503 return val;
25504
25505 if (CONSP (val))
25506 {
25507 face_name = XCAR (val);
25508 val = XCDR (val);
25509 if (!NUMBERP (val))
25510 val = make_number (1);
25511 if (NILP (face_name))
25512 {
25513 height = it->ascent + it->descent;
25514 goto scale;
25515 }
25516 }
25517
25518 if (NILP (face_name))
25519 {
25520 font = FRAME_FONT (it->f);
25521 boff = FRAME_BASELINE_OFFSET (it->f);
25522 }
25523 else if (EQ (face_name, Qt))
25524 {
25525 override = 0;
25526 }
25527 else
25528 {
25529 int face_id;
25530 struct face *face;
25531
25532 face_id = lookup_named_face (it->f, face_name, 0);
25533 if (face_id < 0)
25534 return make_number (-1);
25535
25536 face = FACE_FROM_ID (it->f, face_id);
25537 font = face->font;
25538 if (font == NULL)
25539 return make_number (-1);
25540 boff = font->baseline_offset;
25541 if (font->vertical_centering)
25542 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
25543 }
25544
25545 ascent = FONT_BASE (font) + boff;
25546 descent = FONT_DESCENT (font) - boff;
25547
25548 if (override)
25549 {
25550 it->override_ascent = ascent;
25551 it->override_descent = descent;
25552 it->override_boff = boff;
25553 }
25554
25555 height = ascent + descent;
25556
25557 scale:
25558 if (FLOATP (val))
25559 height = (int)(XFLOAT_DATA (val) * height);
25560 else if (INTEGERP (val))
25561 height *= XINT (val);
25562
25563 return make_number (height);
25564 }
25565
25566
25567 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25568 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25569 and only if this is for a character for which no font was found.
25570
25571 If the display method (it->glyphless_method) is
25572 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25573 length of the acronym or the hexadecimal string, UPPER_XOFF and
25574 UPPER_YOFF are pixel offsets for the upper part of the string,
25575 LOWER_XOFF and LOWER_YOFF are for the lower part.
25576
25577 For the other display methods, LEN through LOWER_YOFF are zero. */
25578
25579 static void
25580 append_glyphless_glyph (struct it *it, int face_id, int for_no_font, int len,
25581 short upper_xoff, short upper_yoff,
25582 short lower_xoff, short lower_yoff)
25583 {
25584 struct glyph *glyph;
25585 enum glyph_row_area area = it->area;
25586
25587 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25588 if (glyph < it->glyph_row->glyphs[area + 1])
25589 {
25590 /* If the glyph row is reversed, we need to prepend the glyph
25591 rather than append it. */
25592 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25593 {
25594 struct glyph *g;
25595
25596 /* Make room for the additional glyph. */
25597 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25598 g[1] = *g;
25599 glyph = it->glyph_row->glyphs[area];
25600 }
25601 glyph->charpos = CHARPOS (it->position);
25602 glyph->object = it->object;
25603 glyph->pixel_width = it->pixel_width;
25604 glyph->ascent = it->ascent;
25605 glyph->descent = it->descent;
25606 glyph->voffset = it->voffset;
25607 glyph->type = GLYPHLESS_GLYPH;
25608 glyph->u.glyphless.method = it->glyphless_method;
25609 glyph->u.glyphless.for_no_font = for_no_font;
25610 glyph->u.glyphless.len = len;
25611 glyph->u.glyphless.ch = it->c;
25612 glyph->slice.glyphless.upper_xoff = upper_xoff;
25613 glyph->slice.glyphless.upper_yoff = upper_yoff;
25614 glyph->slice.glyphless.lower_xoff = lower_xoff;
25615 glyph->slice.glyphless.lower_yoff = lower_yoff;
25616 glyph->avoid_cursor_p = it->avoid_cursor_p;
25617 glyph->multibyte_p = it->multibyte_p;
25618 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25619 {
25620 /* In R2L rows, the left and the right box edges need to be
25621 drawn in reverse direction. */
25622 glyph->right_box_line_p = it->start_of_box_run_p;
25623 glyph->left_box_line_p = it->end_of_box_run_p;
25624 }
25625 else
25626 {
25627 glyph->left_box_line_p = it->start_of_box_run_p;
25628 glyph->right_box_line_p = it->end_of_box_run_p;
25629 }
25630 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25631 || it->phys_descent > it->descent);
25632 glyph->padding_p = 0;
25633 glyph->glyph_not_available_p = 0;
25634 glyph->face_id = face_id;
25635 glyph->font_type = FONT_TYPE_UNKNOWN;
25636 if (it->bidi_p)
25637 {
25638 glyph->resolved_level = it->bidi_it.resolved_level;
25639 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25640 emacs_abort ();
25641 glyph->bidi_type = it->bidi_it.type;
25642 }
25643 ++it->glyph_row->used[area];
25644 }
25645 else
25646 IT_EXPAND_MATRIX_WIDTH (it, area);
25647 }
25648
25649
25650 /* Produce a glyph for a glyphless character for iterator IT.
25651 IT->glyphless_method specifies which method to use for displaying
25652 the character. See the description of enum
25653 glyphless_display_method in dispextern.h for the detail.
25654
25655 FOR_NO_FONT is nonzero if and only if this is for a character for
25656 which no font was found. ACRONYM, if non-nil, is an acronym string
25657 for the character. */
25658
25659 static void
25660 produce_glyphless_glyph (struct it *it, int for_no_font, Lisp_Object acronym)
25661 {
25662 int face_id;
25663 struct face *face;
25664 struct font *font;
25665 int base_width, base_height, width, height;
25666 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
25667 int len;
25668
25669 /* Get the metrics of the base font. We always refer to the current
25670 ASCII face. */
25671 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
25672 font = face->font ? face->font : FRAME_FONT (it->f);
25673 it->ascent = FONT_BASE (font) + font->baseline_offset;
25674 it->descent = FONT_DESCENT (font) - font->baseline_offset;
25675 base_height = it->ascent + it->descent;
25676 base_width = font->average_width;
25677
25678 face_id = merge_glyphless_glyph_face (it);
25679
25680 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
25681 {
25682 it->pixel_width = THIN_SPACE_WIDTH;
25683 len = 0;
25684 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
25685 }
25686 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
25687 {
25688 width = CHAR_WIDTH (it->c);
25689 if (width == 0)
25690 width = 1;
25691 else if (width > 4)
25692 width = 4;
25693 it->pixel_width = base_width * width;
25694 len = 0;
25695 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
25696 }
25697 else
25698 {
25699 char buf[7];
25700 const char *str;
25701 unsigned int code[6];
25702 int upper_len;
25703 int ascent, descent;
25704 struct font_metrics metrics_upper, metrics_lower;
25705
25706 face = FACE_FROM_ID (it->f, face_id);
25707 font = face->font ? face->font : FRAME_FONT (it->f);
25708 prepare_face_for_display (it->f, face);
25709
25710 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
25711 {
25712 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
25713 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
25714 if (CONSP (acronym))
25715 acronym = XCAR (acronym);
25716 str = STRINGP (acronym) ? SSDATA (acronym) : "";
25717 }
25718 else
25719 {
25720 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
25721 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c);
25722 str = buf;
25723 }
25724 for (len = 0; str[len] && ASCII_BYTE_P (str[len]) && len < 6; len++)
25725 code[len] = font->driver->encode_char (font, str[len]);
25726 upper_len = (len + 1) / 2;
25727 font->driver->text_extents (font, code, upper_len,
25728 &metrics_upper);
25729 font->driver->text_extents (font, code + upper_len, len - upper_len,
25730 &metrics_lower);
25731
25732
25733
25734 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25735 width = max (metrics_upper.width, metrics_lower.width) + 4;
25736 upper_xoff = upper_yoff = 2; /* the typical case */
25737 if (base_width >= width)
25738 {
25739 /* Align the upper to the left, the lower to the right. */
25740 it->pixel_width = base_width;
25741 lower_xoff = base_width - 2 - metrics_lower.width;
25742 }
25743 else
25744 {
25745 /* Center the shorter one. */
25746 it->pixel_width = width;
25747 if (metrics_upper.width >= metrics_lower.width)
25748 lower_xoff = (width - metrics_lower.width) / 2;
25749 else
25750 {
25751 /* FIXME: This code doesn't look right. It formerly was
25752 missing the "lower_xoff = 0;", which couldn't have
25753 been right since it left lower_xoff uninitialized. */
25754 lower_xoff = 0;
25755 upper_xoff = (width - metrics_upper.width) / 2;
25756 }
25757 }
25758
25759 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25760 top, bottom, and between upper and lower strings. */
25761 height = (metrics_upper.ascent + metrics_upper.descent
25762 + metrics_lower.ascent + metrics_lower.descent) + 5;
25763 /* Center vertically.
25764 H:base_height, D:base_descent
25765 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25766
25767 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25768 descent = D - H/2 + h/2;
25769 lower_yoff = descent - 2 - ld;
25770 upper_yoff = lower_yoff - la - 1 - ud; */
25771 ascent = - (it->descent - (base_height + height + 1) / 2);
25772 descent = it->descent - (base_height - height) / 2;
25773 lower_yoff = descent - 2 - metrics_lower.descent;
25774 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
25775 - metrics_upper.descent);
25776 /* Don't make the height shorter than the base height. */
25777 if (height > base_height)
25778 {
25779 it->ascent = ascent;
25780 it->descent = descent;
25781 }
25782 }
25783
25784 it->phys_ascent = it->ascent;
25785 it->phys_descent = it->descent;
25786 if (it->glyph_row)
25787 append_glyphless_glyph (it, face_id, for_no_font, len,
25788 upper_xoff, upper_yoff,
25789 lower_xoff, lower_yoff);
25790 it->nglyphs = 1;
25791 take_vertical_position_into_account (it);
25792 }
25793
25794
25795 /* RIF:
25796 Produce glyphs/get display metrics for the display element IT is
25797 loaded with. See the description of struct it in dispextern.h
25798 for an overview of struct it. */
25799
25800 void
25801 x_produce_glyphs (struct it *it)
25802 {
25803 int extra_line_spacing = it->extra_line_spacing;
25804
25805 it->glyph_not_available_p = 0;
25806
25807 if (it->what == IT_CHARACTER)
25808 {
25809 XChar2b char2b;
25810 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25811 struct font *font = face->font;
25812 struct font_metrics *pcm = NULL;
25813 int boff; /* Baseline offset. */
25814
25815 if (font == NULL)
25816 {
25817 /* When no suitable font is found, display this character by
25818 the method specified in the first extra slot of
25819 Vglyphless_char_display. */
25820 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
25821
25822 eassert (it->what == IT_GLYPHLESS);
25823 produce_glyphless_glyph (it, 1, STRINGP (acronym) ? acronym : Qnil);
25824 goto done;
25825 }
25826
25827 boff = font->baseline_offset;
25828 if (font->vertical_centering)
25829 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
25830
25831 if (it->char_to_display != '\n' && it->char_to_display != '\t')
25832 {
25833 int stretched_p;
25834
25835 it->nglyphs = 1;
25836
25837 if (it->override_ascent >= 0)
25838 {
25839 it->ascent = it->override_ascent;
25840 it->descent = it->override_descent;
25841 boff = it->override_boff;
25842 }
25843 else
25844 {
25845 it->ascent = FONT_BASE (font) + boff;
25846 it->descent = FONT_DESCENT (font) - boff;
25847 }
25848
25849 if (get_char_glyph_code (it->char_to_display, font, &char2b))
25850 {
25851 pcm = get_per_char_metric (font, &char2b);
25852 if (pcm->width == 0
25853 && pcm->rbearing == 0 && pcm->lbearing == 0)
25854 pcm = NULL;
25855 }
25856
25857 if (pcm)
25858 {
25859 it->phys_ascent = pcm->ascent + boff;
25860 it->phys_descent = pcm->descent - boff;
25861 it->pixel_width = pcm->width;
25862 }
25863 else
25864 {
25865 it->glyph_not_available_p = 1;
25866 it->phys_ascent = it->ascent;
25867 it->phys_descent = it->descent;
25868 it->pixel_width = font->space_width;
25869 }
25870
25871 if (it->constrain_row_ascent_descent_p)
25872 {
25873 if (it->descent > it->max_descent)
25874 {
25875 it->ascent += it->descent - it->max_descent;
25876 it->descent = it->max_descent;
25877 }
25878 if (it->ascent > it->max_ascent)
25879 {
25880 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
25881 it->ascent = it->max_ascent;
25882 }
25883 it->phys_ascent = min (it->phys_ascent, it->ascent);
25884 it->phys_descent = min (it->phys_descent, it->descent);
25885 extra_line_spacing = 0;
25886 }
25887
25888 /* If this is a space inside a region of text with
25889 `space-width' property, change its width. */
25890 stretched_p = it->char_to_display == ' ' && !NILP (it->space_width);
25891 if (stretched_p)
25892 it->pixel_width *= XFLOATINT (it->space_width);
25893
25894 /* If face has a box, add the box thickness to the character
25895 height. If character has a box line to the left and/or
25896 right, add the box line width to the character's width. */
25897 if (face->box != FACE_NO_BOX)
25898 {
25899 int thick = face->box_line_width;
25900
25901 if (thick > 0)
25902 {
25903 it->ascent += thick;
25904 it->descent += thick;
25905 }
25906 else
25907 thick = -thick;
25908
25909 if (it->start_of_box_run_p)
25910 it->pixel_width += thick;
25911 if (it->end_of_box_run_p)
25912 it->pixel_width += thick;
25913 }
25914
25915 /* If face has an overline, add the height of the overline
25916 (1 pixel) and a 1 pixel margin to the character height. */
25917 if (face->overline_p)
25918 it->ascent += overline_margin;
25919
25920 if (it->constrain_row_ascent_descent_p)
25921 {
25922 if (it->ascent > it->max_ascent)
25923 it->ascent = it->max_ascent;
25924 if (it->descent > it->max_descent)
25925 it->descent = it->max_descent;
25926 }
25927
25928 take_vertical_position_into_account (it);
25929
25930 /* If we have to actually produce glyphs, do it. */
25931 if (it->glyph_row)
25932 {
25933 if (stretched_p)
25934 {
25935 /* Translate a space with a `space-width' property
25936 into a stretch glyph. */
25937 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
25938 / FONT_HEIGHT (font));
25939 append_stretch_glyph (it, it->object, it->pixel_width,
25940 it->ascent + it->descent, ascent);
25941 }
25942 else
25943 append_glyph (it);
25944
25945 /* If characters with lbearing or rbearing are displayed
25946 in this line, record that fact in a flag of the
25947 glyph row. This is used to optimize X output code. */
25948 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
25949 it->glyph_row->contains_overlapping_glyphs_p = 1;
25950 }
25951 if (! stretched_p && it->pixel_width == 0)
25952 /* We assure that all visible glyphs have at least 1-pixel
25953 width. */
25954 it->pixel_width = 1;
25955 }
25956 else if (it->char_to_display == '\n')
25957 {
25958 /* A newline has no width, but we need the height of the
25959 line. But if previous part of the line sets a height,
25960 don't increase that height. */
25961
25962 Lisp_Object height;
25963 Lisp_Object total_height = Qnil;
25964
25965 it->override_ascent = -1;
25966 it->pixel_width = 0;
25967 it->nglyphs = 0;
25968
25969 height = get_it_property (it, Qline_height);
25970 /* Split (line-height total-height) list. */
25971 if (CONSP (height)
25972 && CONSP (XCDR (height))
25973 && NILP (XCDR (XCDR (height))))
25974 {
25975 total_height = XCAR (XCDR (height));
25976 height = XCAR (height);
25977 }
25978 height = calc_line_height_property (it, height, font, boff, 1);
25979
25980 if (it->override_ascent >= 0)
25981 {
25982 it->ascent = it->override_ascent;
25983 it->descent = it->override_descent;
25984 boff = it->override_boff;
25985 }
25986 else
25987 {
25988 it->ascent = FONT_BASE (font) + boff;
25989 it->descent = FONT_DESCENT (font) - boff;
25990 }
25991
25992 if (EQ (height, Qt))
25993 {
25994 if (it->descent > it->max_descent)
25995 {
25996 it->ascent += it->descent - it->max_descent;
25997 it->descent = it->max_descent;
25998 }
25999 if (it->ascent > it->max_ascent)
26000 {
26001 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26002 it->ascent = it->max_ascent;
26003 }
26004 it->phys_ascent = min (it->phys_ascent, it->ascent);
26005 it->phys_descent = min (it->phys_descent, it->descent);
26006 it->constrain_row_ascent_descent_p = 1;
26007 extra_line_spacing = 0;
26008 }
26009 else
26010 {
26011 Lisp_Object spacing;
26012
26013 it->phys_ascent = it->ascent;
26014 it->phys_descent = it->descent;
26015
26016 if ((it->max_ascent > 0 || it->max_descent > 0)
26017 && face->box != FACE_NO_BOX
26018 && face->box_line_width > 0)
26019 {
26020 it->ascent += face->box_line_width;
26021 it->descent += face->box_line_width;
26022 }
26023 if (!NILP (height)
26024 && XINT (height) > it->ascent + it->descent)
26025 it->ascent = XINT (height) - it->descent;
26026
26027 if (!NILP (total_height))
26028 spacing = calc_line_height_property (it, total_height, font, boff, 0);
26029 else
26030 {
26031 spacing = get_it_property (it, Qline_spacing);
26032 spacing = calc_line_height_property (it, spacing, font, boff, 0);
26033 }
26034 if (INTEGERP (spacing))
26035 {
26036 extra_line_spacing = XINT (spacing);
26037 if (!NILP (total_height))
26038 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
26039 }
26040 }
26041 }
26042 else /* i.e. (it->char_to_display == '\t') */
26043 {
26044 if (font->space_width > 0)
26045 {
26046 int tab_width = it->tab_width * font->space_width;
26047 int x = it->current_x + it->continuation_lines_width;
26048 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
26049
26050 /* If the distance from the current position to the next tab
26051 stop is less than a space character width, use the
26052 tab stop after that. */
26053 if (next_tab_x - x < font->space_width)
26054 next_tab_x += tab_width;
26055
26056 it->pixel_width = next_tab_x - x;
26057 it->nglyphs = 1;
26058 it->ascent = it->phys_ascent = FONT_BASE (font) + boff;
26059 it->descent = it->phys_descent = FONT_DESCENT (font) - boff;
26060
26061 if (it->glyph_row)
26062 {
26063 append_stretch_glyph (it, it->object, it->pixel_width,
26064 it->ascent + it->descent, it->ascent);
26065 }
26066 }
26067 else
26068 {
26069 it->pixel_width = 0;
26070 it->nglyphs = 1;
26071 }
26072 }
26073 }
26074 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
26075 {
26076 /* A static composition.
26077
26078 Note: A composition is represented as one glyph in the
26079 glyph matrix. There are no padding glyphs.
26080
26081 Important note: pixel_width, ascent, and descent are the
26082 values of what is drawn by draw_glyphs (i.e. the values of
26083 the overall glyphs composed). */
26084 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26085 int boff; /* baseline offset */
26086 struct composition *cmp = composition_table[it->cmp_it.id];
26087 int glyph_len = cmp->glyph_len;
26088 struct font *font = face->font;
26089
26090 it->nglyphs = 1;
26091
26092 /* If we have not yet calculated pixel size data of glyphs of
26093 the composition for the current face font, calculate them
26094 now. Theoretically, we have to check all fonts for the
26095 glyphs, but that requires much time and memory space. So,
26096 here we check only the font of the first glyph. This may
26097 lead to incorrect display, but it's very rare, and C-l
26098 (recenter-top-bottom) can correct the display anyway. */
26099 if (! cmp->font || cmp->font != font)
26100 {
26101 /* Ascent and descent of the font of the first character
26102 of this composition (adjusted by baseline offset).
26103 Ascent and descent of overall glyphs should not be less
26104 than these, respectively. */
26105 int font_ascent, font_descent, font_height;
26106 /* Bounding box of the overall glyphs. */
26107 int leftmost, rightmost, lowest, highest;
26108 int lbearing, rbearing;
26109 int i, width, ascent, descent;
26110 int left_padded = 0, right_padded = 0;
26111 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26112 XChar2b char2b;
26113 struct font_metrics *pcm;
26114 int font_not_found_p;
26115 ptrdiff_t pos;
26116
26117 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
26118 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
26119 break;
26120 if (glyph_len < cmp->glyph_len)
26121 right_padded = 1;
26122 for (i = 0; i < glyph_len; i++)
26123 {
26124 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
26125 break;
26126 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26127 }
26128 if (i > 0)
26129 left_padded = 1;
26130
26131 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
26132 : IT_CHARPOS (*it));
26133 /* If no suitable font is found, use the default font. */
26134 font_not_found_p = font == NULL;
26135 if (font_not_found_p)
26136 {
26137 face = face->ascii_face;
26138 font = face->font;
26139 }
26140 boff = font->baseline_offset;
26141 if (font->vertical_centering)
26142 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26143 font_ascent = FONT_BASE (font) + boff;
26144 font_descent = FONT_DESCENT (font) - boff;
26145 font_height = FONT_HEIGHT (font);
26146
26147 cmp->font = font;
26148
26149 pcm = NULL;
26150 if (! font_not_found_p)
26151 {
26152 get_char_face_and_encoding (it->f, c, it->face_id,
26153 &char2b, 0);
26154 pcm = get_per_char_metric (font, &char2b);
26155 }
26156
26157 /* Initialize the bounding box. */
26158 if (pcm)
26159 {
26160 width = cmp->glyph_len > 0 ? pcm->width : 0;
26161 ascent = pcm->ascent;
26162 descent = pcm->descent;
26163 lbearing = pcm->lbearing;
26164 rbearing = pcm->rbearing;
26165 }
26166 else
26167 {
26168 width = cmp->glyph_len > 0 ? font->space_width : 0;
26169 ascent = FONT_BASE (font);
26170 descent = FONT_DESCENT (font);
26171 lbearing = 0;
26172 rbearing = width;
26173 }
26174
26175 rightmost = width;
26176 leftmost = 0;
26177 lowest = - descent + boff;
26178 highest = ascent + boff;
26179
26180 if (! font_not_found_p
26181 && font->default_ascent
26182 && CHAR_TABLE_P (Vuse_default_ascent)
26183 && !NILP (Faref (Vuse_default_ascent,
26184 make_number (it->char_to_display))))
26185 highest = font->default_ascent + boff;
26186
26187 /* Draw the first glyph at the normal position. It may be
26188 shifted to right later if some other glyphs are drawn
26189 at the left. */
26190 cmp->offsets[i * 2] = 0;
26191 cmp->offsets[i * 2 + 1] = boff;
26192 cmp->lbearing = lbearing;
26193 cmp->rbearing = rbearing;
26194
26195 /* Set cmp->offsets for the remaining glyphs. */
26196 for (i++; i < glyph_len; i++)
26197 {
26198 int left, right, btm, top;
26199 int ch = COMPOSITION_GLYPH (cmp, i);
26200 int face_id;
26201 struct face *this_face;
26202
26203 if (ch == '\t')
26204 ch = ' ';
26205 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
26206 this_face = FACE_FROM_ID (it->f, face_id);
26207 font = this_face->font;
26208
26209 if (font == NULL)
26210 pcm = NULL;
26211 else
26212 {
26213 get_char_face_and_encoding (it->f, ch, face_id,
26214 &char2b, 0);
26215 pcm = get_per_char_metric (font, &char2b);
26216 }
26217 if (! pcm)
26218 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26219 else
26220 {
26221 width = pcm->width;
26222 ascent = pcm->ascent;
26223 descent = pcm->descent;
26224 lbearing = pcm->lbearing;
26225 rbearing = pcm->rbearing;
26226 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
26227 {
26228 /* Relative composition with or without
26229 alternate chars. */
26230 left = (leftmost + rightmost - width) / 2;
26231 btm = - descent + boff;
26232 if (font->relative_compose
26233 && (! CHAR_TABLE_P (Vignore_relative_composition)
26234 || NILP (Faref (Vignore_relative_composition,
26235 make_number (ch)))))
26236 {
26237
26238 if (- descent >= font->relative_compose)
26239 /* One extra pixel between two glyphs. */
26240 btm = highest + 1;
26241 else if (ascent <= 0)
26242 /* One extra pixel between two glyphs. */
26243 btm = lowest - 1 - ascent - descent;
26244 }
26245 }
26246 else
26247 {
26248 /* A composition rule is specified by an integer
26249 value that encodes global and new reference
26250 points (GREF and NREF). GREF and NREF are
26251 specified by numbers as below:
26252
26253 0---1---2 -- ascent
26254 | |
26255 | |
26256 | |
26257 9--10--11 -- center
26258 | |
26259 ---3---4---5--- baseline
26260 | |
26261 6---7---8 -- descent
26262 */
26263 int rule = COMPOSITION_RULE (cmp, i);
26264 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
26265
26266 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
26267 grefx = gref % 3, nrefx = nref % 3;
26268 grefy = gref / 3, nrefy = nref / 3;
26269 if (xoff)
26270 xoff = font_height * (xoff - 128) / 256;
26271 if (yoff)
26272 yoff = font_height * (yoff - 128) / 256;
26273
26274 left = (leftmost
26275 + grefx * (rightmost - leftmost) / 2
26276 - nrefx * width / 2
26277 + xoff);
26278
26279 btm = ((grefy == 0 ? highest
26280 : grefy == 1 ? 0
26281 : grefy == 2 ? lowest
26282 : (highest + lowest) / 2)
26283 - (nrefy == 0 ? ascent + descent
26284 : nrefy == 1 ? descent - boff
26285 : nrefy == 2 ? 0
26286 : (ascent + descent) / 2)
26287 + yoff);
26288 }
26289
26290 cmp->offsets[i * 2] = left;
26291 cmp->offsets[i * 2 + 1] = btm + descent;
26292
26293 /* Update the bounding box of the overall glyphs. */
26294 if (width > 0)
26295 {
26296 right = left + width;
26297 if (left < leftmost)
26298 leftmost = left;
26299 if (right > rightmost)
26300 rightmost = right;
26301 }
26302 top = btm + descent + ascent;
26303 if (top > highest)
26304 highest = top;
26305 if (btm < lowest)
26306 lowest = btm;
26307
26308 if (cmp->lbearing > left + lbearing)
26309 cmp->lbearing = left + lbearing;
26310 if (cmp->rbearing < left + rbearing)
26311 cmp->rbearing = left + rbearing;
26312 }
26313 }
26314
26315 /* If there are glyphs whose x-offsets are negative,
26316 shift all glyphs to the right and make all x-offsets
26317 non-negative. */
26318 if (leftmost < 0)
26319 {
26320 for (i = 0; i < cmp->glyph_len; i++)
26321 cmp->offsets[i * 2] -= leftmost;
26322 rightmost -= leftmost;
26323 cmp->lbearing -= leftmost;
26324 cmp->rbearing -= leftmost;
26325 }
26326
26327 if (left_padded && cmp->lbearing < 0)
26328 {
26329 for (i = 0; i < cmp->glyph_len; i++)
26330 cmp->offsets[i * 2] -= cmp->lbearing;
26331 rightmost -= cmp->lbearing;
26332 cmp->rbearing -= cmp->lbearing;
26333 cmp->lbearing = 0;
26334 }
26335 if (right_padded && rightmost < cmp->rbearing)
26336 {
26337 rightmost = cmp->rbearing;
26338 }
26339
26340 cmp->pixel_width = rightmost;
26341 cmp->ascent = highest;
26342 cmp->descent = - lowest;
26343 if (cmp->ascent < font_ascent)
26344 cmp->ascent = font_ascent;
26345 if (cmp->descent < font_descent)
26346 cmp->descent = font_descent;
26347 }
26348
26349 if (it->glyph_row
26350 && (cmp->lbearing < 0
26351 || cmp->rbearing > cmp->pixel_width))
26352 it->glyph_row->contains_overlapping_glyphs_p = 1;
26353
26354 it->pixel_width = cmp->pixel_width;
26355 it->ascent = it->phys_ascent = cmp->ascent;
26356 it->descent = it->phys_descent = cmp->descent;
26357 if (face->box != FACE_NO_BOX)
26358 {
26359 int thick = face->box_line_width;
26360
26361 if (thick > 0)
26362 {
26363 it->ascent += thick;
26364 it->descent += thick;
26365 }
26366 else
26367 thick = - thick;
26368
26369 if (it->start_of_box_run_p)
26370 it->pixel_width += thick;
26371 if (it->end_of_box_run_p)
26372 it->pixel_width += thick;
26373 }
26374
26375 /* If face has an overline, add the height of the overline
26376 (1 pixel) and a 1 pixel margin to the character height. */
26377 if (face->overline_p)
26378 it->ascent += overline_margin;
26379
26380 take_vertical_position_into_account (it);
26381 if (it->ascent < 0)
26382 it->ascent = 0;
26383 if (it->descent < 0)
26384 it->descent = 0;
26385
26386 if (it->glyph_row && cmp->glyph_len > 0)
26387 append_composite_glyph (it);
26388 }
26389 else if (it->what == IT_COMPOSITION)
26390 {
26391 /* A dynamic (automatic) composition. */
26392 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26393 Lisp_Object gstring;
26394 struct font_metrics metrics;
26395
26396 it->nglyphs = 1;
26397
26398 gstring = composition_gstring_from_id (it->cmp_it.id);
26399 it->pixel_width
26400 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
26401 &metrics);
26402 if (it->glyph_row
26403 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
26404 it->glyph_row->contains_overlapping_glyphs_p = 1;
26405 it->ascent = it->phys_ascent = metrics.ascent;
26406 it->descent = it->phys_descent = metrics.descent;
26407 if (face->box != FACE_NO_BOX)
26408 {
26409 int thick = face->box_line_width;
26410
26411 if (thick > 0)
26412 {
26413 it->ascent += thick;
26414 it->descent += thick;
26415 }
26416 else
26417 thick = - thick;
26418
26419 if (it->start_of_box_run_p)
26420 it->pixel_width += thick;
26421 if (it->end_of_box_run_p)
26422 it->pixel_width += thick;
26423 }
26424 /* If face has an overline, add the height of the overline
26425 (1 pixel) and a 1 pixel margin to the character height. */
26426 if (face->overline_p)
26427 it->ascent += overline_margin;
26428 take_vertical_position_into_account (it);
26429 if (it->ascent < 0)
26430 it->ascent = 0;
26431 if (it->descent < 0)
26432 it->descent = 0;
26433
26434 if (it->glyph_row)
26435 append_composite_glyph (it);
26436 }
26437 else if (it->what == IT_GLYPHLESS)
26438 produce_glyphless_glyph (it, 0, Qnil);
26439 else if (it->what == IT_IMAGE)
26440 produce_image_glyph (it);
26441 else if (it->what == IT_STRETCH)
26442 produce_stretch_glyph (it);
26443
26444 done:
26445 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26446 because this isn't true for images with `:ascent 100'. */
26447 eassert (it->ascent >= 0 && it->descent >= 0);
26448 if (it->area == TEXT_AREA)
26449 it->current_x += it->pixel_width;
26450
26451 if (extra_line_spacing > 0)
26452 {
26453 it->descent += extra_line_spacing;
26454 if (extra_line_spacing > it->max_extra_line_spacing)
26455 it->max_extra_line_spacing = extra_line_spacing;
26456 }
26457
26458 it->max_ascent = max (it->max_ascent, it->ascent);
26459 it->max_descent = max (it->max_descent, it->descent);
26460 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
26461 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
26462 }
26463
26464 /* EXPORT for RIF:
26465 Output LEN glyphs starting at START at the nominal cursor position.
26466 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26467 being updated, and UPDATED_AREA is the area of that row being updated. */
26468
26469 void
26470 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
26471 struct glyph *start, enum glyph_row_area updated_area, int len)
26472 {
26473 int x, hpos, chpos = w->phys_cursor.hpos;
26474
26475 eassert (updated_row);
26476 /* When the window is hscrolled, cursor hpos can legitimately be out
26477 of bounds, but we draw the cursor at the corresponding window
26478 margin in that case. */
26479 if (!updated_row->reversed_p && chpos < 0)
26480 chpos = 0;
26481 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
26482 chpos = updated_row->used[TEXT_AREA] - 1;
26483
26484 block_input ();
26485
26486 /* Write glyphs. */
26487
26488 hpos = start - updated_row->glyphs[updated_area];
26489 x = draw_glyphs (w, w->output_cursor.x,
26490 updated_row, updated_area,
26491 hpos, hpos + len,
26492 DRAW_NORMAL_TEXT, 0);
26493
26494 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26495 if (updated_area == TEXT_AREA
26496 && w->phys_cursor_on_p
26497 && w->phys_cursor.vpos == w->output_cursor.vpos
26498 && chpos >= hpos
26499 && chpos < hpos + len)
26500 w->phys_cursor_on_p = 0;
26501
26502 unblock_input ();
26503
26504 /* Advance the output cursor. */
26505 w->output_cursor.hpos += len;
26506 w->output_cursor.x = x;
26507 }
26508
26509
26510 /* EXPORT for RIF:
26511 Insert LEN glyphs from START at the nominal cursor position. */
26512
26513 void
26514 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
26515 struct glyph *start, enum glyph_row_area updated_area, int len)
26516 {
26517 struct frame *f;
26518 int line_height, shift_by_width, shifted_region_width;
26519 struct glyph_row *row;
26520 struct glyph *glyph;
26521 int frame_x, frame_y;
26522 ptrdiff_t hpos;
26523
26524 eassert (updated_row);
26525 block_input ();
26526 f = XFRAME (WINDOW_FRAME (w));
26527
26528 /* Get the height of the line we are in. */
26529 row = updated_row;
26530 line_height = row->height;
26531
26532 /* Get the width of the glyphs to insert. */
26533 shift_by_width = 0;
26534 for (glyph = start; glyph < start + len; ++glyph)
26535 shift_by_width += glyph->pixel_width;
26536
26537 /* Get the width of the region to shift right. */
26538 shifted_region_width = (window_box_width (w, updated_area)
26539 - w->output_cursor.x
26540 - shift_by_width);
26541
26542 /* Shift right. */
26543 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
26544 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
26545
26546 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
26547 line_height, shift_by_width);
26548
26549 /* Write the glyphs. */
26550 hpos = start - row->glyphs[updated_area];
26551 draw_glyphs (w, w->output_cursor.x, row, updated_area,
26552 hpos, hpos + len,
26553 DRAW_NORMAL_TEXT, 0);
26554
26555 /* Advance the output cursor. */
26556 w->output_cursor.hpos += len;
26557 w->output_cursor.x += shift_by_width;
26558 unblock_input ();
26559 }
26560
26561
26562 /* EXPORT for RIF:
26563 Erase the current text line from the nominal cursor position
26564 (inclusive) to pixel column TO_X (exclusive). The idea is that
26565 everything from TO_X onward is already erased.
26566
26567 TO_X is a pixel position relative to UPDATED_AREA of currently
26568 updated window W. TO_X == -1 means clear to the end of this area. */
26569
26570 void
26571 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
26572 enum glyph_row_area updated_area, int to_x)
26573 {
26574 struct frame *f;
26575 int max_x, min_y, max_y;
26576 int from_x, from_y, to_y;
26577
26578 eassert (updated_row);
26579 f = XFRAME (w->frame);
26580
26581 if (updated_row->full_width_p)
26582 max_x = (WINDOW_PIXEL_WIDTH (w)
26583 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
26584 else
26585 max_x = window_box_width (w, updated_area);
26586 max_y = window_text_bottom_y (w);
26587
26588 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26589 of window. For TO_X > 0, truncate to end of drawing area. */
26590 if (to_x == 0)
26591 return;
26592 else if (to_x < 0)
26593 to_x = max_x;
26594 else
26595 to_x = min (to_x, max_x);
26596
26597 to_y = min (max_y, w->output_cursor.y + updated_row->height);
26598
26599 /* Notice if the cursor will be cleared by this operation. */
26600 if (!updated_row->full_width_p)
26601 notice_overwritten_cursor (w, updated_area,
26602 w->output_cursor.x, -1,
26603 updated_row->y,
26604 MATRIX_ROW_BOTTOM_Y (updated_row));
26605
26606 from_x = w->output_cursor.x;
26607
26608 /* Translate to frame coordinates. */
26609 if (updated_row->full_width_p)
26610 {
26611 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
26612 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
26613 }
26614 else
26615 {
26616 int area_left = window_box_left (w, updated_area);
26617 from_x += area_left;
26618 to_x += area_left;
26619 }
26620
26621 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
26622 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
26623 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
26624
26625 /* Prevent inadvertently clearing to end of the X window. */
26626 if (to_x > from_x && to_y > from_y)
26627 {
26628 block_input ();
26629 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
26630 to_x - from_x, to_y - from_y);
26631 unblock_input ();
26632 }
26633 }
26634
26635 #endif /* HAVE_WINDOW_SYSTEM */
26636
26637
26638 \f
26639 /***********************************************************************
26640 Cursor types
26641 ***********************************************************************/
26642
26643 /* Value is the internal representation of the specified cursor type
26644 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26645 of the bar cursor. */
26646
26647 static enum text_cursor_kinds
26648 get_specified_cursor_type (Lisp_Object arg, int *width)
26649 {
26650 enum text_cursor_kinds type;
26651
26652 if (NILP (arg))
26653 return NO_CURSOR;
26654
26655 if (EQ (arg, Qbox))
26656 return FILLED_BOX_CURSOR;
26657
26658 if (EQ (arg, Qhollow))
26659 return HOLLOW_BOX_CURSOR;
26660
26661 if (EQ (arg, Qbar))
26662 {
26663 *width = 2;
26664 return BAR_CURSOR;
26665 }
26666
26667 if (CONSP (arg)
26668 && EQ (XCAR (arg), Qbar)
26669 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
26670 {
26671 *width = XINT (XCDR (arg));
26672 return BAR_CURSOR;
26673 }
26674
26675 if (EQ (arg, Qhbar))
26676 {
26677 *width = 2;
26678 return HBAR_CURSOR;
26679 }
26680
26681 if (CONSP (arg)
26682 && EQ (XCAR (arg), Qhbar)
26683 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
26684 {
26685 *width = XINT (XCDR (arg));
26686 return HBAR_CURSOR;
26687 }
26688
26689 /* Treat anything unknown as "hollow box cursor".
26690 It was bad to signal an error; people have trouble fixing
26691 .Xdefaults with Emacs, when it has something bad in it. */
26692 type = HOLLOW_BOX_CURSOR;
26693
26694 return type;
26695 }
26696
26697 /* Set the default cursor types for specified frame. */
26698 void
26699 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
26700 {
26701 int width = 1;
26702 Lisp_Object tem;
26703
26704 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
26705 FRAME_CURSOR_WIDTH (f) = width;
26706
26707 /* By default, set up the blink-off state depending on the on-state. */
26708
26709 tem = Fassoc (arg, Vblink_cursor_alist);
26710 if (!NILP (tem))
26711 {
26712 FRAME_BLINK_OFF_CURSOR (f)
26713 = get_specified_cursor_type (XCDR (tem), &width);
26714 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
26715 }
26716 else
26717 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
26718
26719 /* Make sure the cursor gets redrawn. */
26720 f->cursor_type_changed = 1;
26721 }
26722
26723
26724 #ifdef HAVE_WINDOW_SYSTEM
26725
26726 /* Return the cursor we want to be displayed in window W. Return
26727 width of bar/hbar cursor through WIDTH arg. Return with
26728 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26729 (i.e. if the `system caret' should track this cursor).
26730
26731 In a mini-buffer window, we want the cursor only to appear if we
26732 are reading input from this window. For the selected window, we
26733 want the cursor type given by the frame parameter or buffer local
26734 setting of cursor-type. If explicitly marked off, draw no cursor.
26735 In all other cases, we want a hollow box cursor. */
26736
26737 static enum text_cursor_kinds
26738 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
26739 int *active_cursor)
26740 {
26741 struct frame *f = XFRAME (w->frame);
26742 struct buffer *b = XBUFFER (w->contents);
26743 int cursor_type = DEFAULT_CURSOR;
26744 Lisp_Object alt_cursor;
26745 int non_selected = 0;
26746
26747 *active_cursor = 1;
26748
26749 /* Echo area */
26750 if (cursor_in_echo_area
26751 && FRAME_HAS_MINIBUF_P (f)
26752 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
26753 {
26754 if (w == XWINDOW (echo_area_window))
26755 {
26756 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
26757 {
26758 *width = FRAME_CURSOR_WIDTH (f);
26759 return FRAME_DESIRED_CURSOR (f);
26760 }
26761 else
26762 return get_specified_cursor_type (BVAR (b, cursor_type), width);
26763 }
26764
26765 *active_cursor = 0;
26766 non_selected = 1;
26767 }
26768
26769 /* Detect a nonselected window or nonselected frame. */
26770 else if (w != XWINDOW (f->selected_window)
26771 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
26772 {
26773 *active_cursor = 0;
26774
26775 if (MINI_WINDOW_P (w) && minibuf_level == 0)
26776 return NO_CURSOR;
26777
26778 non_selected = 1;
26779 }
26780
26781 /* Never display a cursor in a window in which cursor-type is nil. */
26782 if (NILP (BVAR (b, cursor_type)))
26783 return NO_CURSOR;
26784
26785 /* Get the normal cursor type for this window. */
26786 if (EQ (BVAR (b, cursor_type), Qt))
26787 {
26788 cursor_type = FRAME_DESIRED_CURSOR (f);
26789 *width = FRAME_CURSOR_WIDTH (f);
26790 }
26791 else
26792 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
26793
26794 /* Use cursor-in-non-selected-windows instead
26795 for non-selected window or frame. */
26796 if (non_selected)
26797 {
26798 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
26799 if (!EQ (Qt, alt_cursor))
26800 return get_specified_cursor_type (alt_cursor, width);
26801 /* t means modify the normal cursor type. */
26802 if (cursor_type == FILLED_BOX_CURSOR)
26803 cursor_type = HOLLOW_BOX_CURSOR;
26804 else if (cursor_type == BAR_CURSOR && *width > 1)
26805 --*width;
26806 return cursor_type;
26807 }
26808
26809 /* Use normal cursor if not blinked off. */
26810 if (!w->cursor_off_p)
26811 {
26812 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
26813 {
26814 if (cursor_type == FILLED_BOX_CURSOR)
26815 {
26816 /* Using a block cursor on large images can be very annoying.
26817 So use a hollow cursor for "large" images.
26818 If image is not transparent (no mask), also use hollow cursor. */
26819 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
26820 if (img != NULL && IMAGEP (img->spec))
26821 {
26822 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26823 where N = size of default frame font size.
26824 This should cover most of the "tiny" icons people may use. */
26825 if (!img->mask
26826 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
26827 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
26828 cursor_type = HOLLOW_BOX_CURSOR;
26829 }
26830 }
26831 else if (cursor_type != NO_CURSOR)
26832 {
26833 /* Display current only supports BOX and HOLLOW cursors for images.
26834 So for now, unconditionally use a HOLLOW cursor when cursor is
26835 not a solid box cursor. */
26836 cursor_type = HOLLOW_BOX_CURSOR;
26837 }
26838 }
26839 return cursor_type;
26840 }
26841
26842 /* Cursor is blinked off, so determine how to "toggle" it. */
26843
26844 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26845 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
26846 return get_specified_cursor_type (XCDR (alt_cursor), width);
26847
26848 /* Then see if frame has specified a specific blink off cursor type. */
26849 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
26850 {
26851 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
26852 return FRAME_BLINK_OFF_CURSOR (f);
26853 }
26854
26855 #if 0
26856 /* Some people liked having a permanently visible blinking cursor,
26857 while others had very strong opinions against it. So it was
26858 decided to remove it. KFS 2003-09-03 */
26859
26860 /* Finally perform built-in cursor blinking:
26861 filled box <-> hollow box
26862 wide [h]bar <-> narrow [h]bar
26863 narrow [h]bar <-> no cursor
26864 other type <-> no cursor */
26865
26866 if (cursor_type == FILLED_BOX_CURSOR)
26867 return HOLLOW_BOX_CURSOR;
26868
26869 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
26870 {
26871 *width = 1;
26872 return cursor_type;
26873 }
26874 #endif
26875
26876 return NO_CURSOR;
26877 }
26878
26879
26880 /* Notice when the text cursor of window W has been completely
26881 overwritten by a drawing operation that outputs glyphs in AREA
26882 starting at X0 and ending at X1 in the line starting at Y0 and
26883 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26884 the rest of the line after X0 has been written. Y coordinates
26885 are window-relative. */
26886
26887 static void
26888 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
26889 int x0, int x1, int y0, int y1)
26890 {
26891 int cx0, cx1, cy0, cy1;
26892 struct glyph_row *row;
26893
26894 if (!w->phys_cursor_on_p)
26895 return;
26896 if (area != TEXT_AREA)
26897 return;
26898
26899 if (w->phys_cursor.vpos < 0
26900 || w->phys_cursor.vpos >= w->current_matrix->nrows
26901 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
26902 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
26903 return;
26904
26905 if (row->cursor_in_fringe_p)
26906 {
26907 row->cursor_in_fringe_p = 0;
26908 draw_fringe_bitmap (w, row, row->reversed_p);
26909 w->phys_cursor_on_p = 0;
26910 return;
26911 }
26912
26913 cx0 = w->phys_cursor.x;
26914 cx1 = cx0 + w->phys_cursor_width;
26915 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
26916 return;
26917
26918 /* The cursor image will be completely removed from the
26919 screen if the output area intersects the cursor area in
26920 y-direction. When we draw in [y0 y1[, and some part of
26921 the cursor is at y < y0, that part must have been drawn
26922 before. When scrolling, the cursor is erased before
26923 actually scrolling, so we don't come here. When not
26924 scrolling, the rows above the old cursor row must have
26925 changed, and in this case these rows must have written
26926 over the cursor image.
26927
26928 Likewise if part of the cursor is below y1, with the
26929 exception of the cursor being in the first blank row at
26930 the buffer and window end because update_text_area
26931 doesn't draw that row. (Except when it does, but
26932 that's handled in update_text_area.) */
26933
26934 cy0 = w->phys_cursor.y;
26935 cy1 = cy0 + w->phys_cursor_height;
26936 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
26937 return;
26938
26939 w->phys_cursor_on_p = 0;
26940 }
26941
26942 #endif /* HAVE_WINDOW_SYSTEM */
26943
26944 \f
26945 /************************************************************************
26946 Mouse Face
26947 ************************************************************************/
26948
26949 #ifdef HAVE_WINDOW_SYSTEM
26950
26951 /* EXPORT for RIF:
26952 Fix the display of area AREA of overlapping row ROW in window W
26953 with respect to the overlapping part OVERLAPS. */
26954
26955 void
26956 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
26957 enum glyph_row_area area, int overlaps)
26958 {
26959 int i, x;
26960
26961 block_input ();
26962
26963 x = 0;
26964 for (i = 0; i < row->used[area];)
26965 {
26966 if (row->glyphs[area][i].overlaps_vertically_p)
26967 {
26968 int start = i, start_x = x;
26969
26970 do
26971 {
26972 x += row->glyphs[area][i].pixel_width;
26973 ++i;
26974 }
26975 while (i < row->used[area]
26976 && row->glyphs[area][i].overlaps_vertically_p);
26977
26978 draw_glyphs (w, start_x, row, area,
26979 start, i,
26980 DRAW_NORMAL_TEXT, overlaps);
26981 }
26982 else
26983 {
26984 x += row->glyphs[area][i].pixel_width;
26985 ++i;
26986 }
26987 }
26988
26989 unblock_input ();
26990 }
26991
26992
26993 /* EXPORT:
26994 Draw the cursor glyph of window W in glyph row ROW. See the
26995 comment of draw_glyphs for the meaning of HL. */
26996
26997 void
26998 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
26999 enum draw_glyphs_face hl)
27000 {
27001 /* If cursor hpos is out of bounds, don't draw garbage. This can
27002 happen in mini-buffer windows when switching between echo area
27003 glyphs and mini-buffer. */
27004 if ((row->reversed_p
27005 ? (w->phys_cursor.hpos >= 0)
27006 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
27007 {
27008 int on_p = w->phys_cursor_on_p;
27009 int x1;
27010 int hpos = w->phys_cursor.hpos;
27011
27012 /* When the window is hscrolled, cursor hpos can legitimately be
27013 out of bounds, but we draw the cursor at the corresponding
27014 window margin in that case. */
27015 if (!row->reversed_p && hpos < 0)
27016 hpos = 0;
27017 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27018 hpos = row->used[TEXT_AREA] - 1;
27019
27020 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
27021 hl, 0);
27022 w->phys_cursor_on_p = on_p;
27023
27024 if (hl == DRAW_CURSOR)
27025 w->phys_cursor_width = x1 - w->phys_cursor.x;
27026 /* When we erase the cursor, and ROW is overlapped by other
27027 rows, make sure that these overlapping parts of other rows
27028 are redrawn. */
27029 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
27030 {
27031 w->phys_cursor_width = x1 - w->phys_cursor.x;
27032
27033 if (row > w->current_matrix->rows
27034 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
27035 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
27036 OVERLAPS_ERASED_CURSOR);
27037
27038 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
27039 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
27040 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
27041 OVERLAPS_ERASED_CURSOR);
27042 }
27043 }
27044 }
27045
27046
27047 /* Erase the image of a cursor of window W from the screen. */
27048
27049 void
27050 erase_phys_cursor (struct window *w)
27051 {
27052 struct frame *f = XFRAME (w->frame);
27053 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27054 int hpos = w->phys_cursor.hpos;
27055 int vpos = w->phys_cursor.vpos;
27056 int mouse_face_here_p = 0;
27057 struct glyph_matrix *active_glyphs = w->current_matrix;
27058 struct glyph_row *cursor_row;
27059 struct glyph *cursor_glyph;
27060 enum draw_glyphs_face hl;
27061
27062 /* No cursor displayed or row invalidated => nothing to do on the
27063 screen. */
27064 if (w->phys_cursor_type == NO_CURSOR)
27065 goto mark_cursor_off;
27066
27067 /* VPOS >= active_glyphs->nrows means that window has been resized.
27068 Don't bother to erase the cursor. */
27069 if (vpos >= active_glyphs->nrows)
27070 goto mark_cursor_off;
27071
27072 /* If row containing cursor is marked invalid, there is nothing we
27073 can do. */
27074 cursor_row = MATRIX_ROW (active_glyphs, vpos);
27075 if (!cursor_row->enabled_p)
27076 goto mark_cursor_off;
27077
27078 /* If line spacing is > 0, old cursor may only be partially visible in
27079 window after split-window. So adjust visible height. */
27080 cursor_row->visible_height = min (cursor_row->visible_height,
27081 window_text_bottom_y (w) - cursor_row->y);
27082
27083 /* If row is completely invisible, don't attempt to delete a cursor which
27084 isn't there. This can happen if cursor is at top of a window, and
27085 we switch to a buffer with a header line in that window. */
27086 if (cursor_row->visible_height <= 0)
27087 goto mark_cursor_off;
27088
27089 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27090 if (cursor_row->cursor_in_fringe_p)
27091 {
27092 cursor_row->cursor_in_fringe_p = 0;
27093 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
27094 goto mark_cursor_off;
27095 }
27096
27097 /* This can happen when the new row is shorter than the old one.
27098 In this case, either draw_glyphs or clear_end_of_line
27099 should have cleared the cursor. Note that we wouldn't be
27100 able to erase the cursor in this case because we don't have a
27101 cursor glyph at hand. */
27102 if ((cursor_row->reversed_p
27103 ? (w->phys_cursor.hpos < 0)
27104 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
27105 goto mark_cursor_off;
27106
27107 /* When the window is hscrolled, cursor hpos can legitimately be out
27108 of bounds, but we draw the cursor at the corresponding window
27109 margin in that case. */
27110 if (!cursor_row->reversed_p && hpos < 0)
27111 hpos = 0;
27112 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
27113 hpos = cursor_row->used[TEXT_AREA] - 1;
27114
27115 /* If the cursor is in the mouse face area, redisplay that when
27116 we clear the cursor. */
27117 if (! NILP (hlinfo->mouse_face_window)
27118 && coords_in_mouse_face_p (w, hpos, vpos)
27119 /* Don't redraw the cursor's spot in mouse face if it is at the
27120 end of a line (on a newline). The cursor appears there, but
27121 mouse highlighting does not. */
27122 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
27123 mouse_face_here_p = 1;
27124
27125 /* Maybe clear the display under the cursor. */
27126 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
27127 {
27128 int x, y, left_x;
27129 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
27130 int width;
27131
27132 cursor_glyph = get_phys_cursor_glyph (w);
27133 if (cursor_glyph == NULL)
27134 goto mark_cursor_off;
27135
27136 width = cursor_glyph->pixel_width;
27137 left_x = window_box_left_offset (w, TEXT_AREA);
27138 x = w->phys_cursor.x;
27139 if (x < left_x)
27140 width -= left_x - x;
27141 width = min (width, window_box_width (w, TEXT_AREA) - x);
27142 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
27143 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, max (x, left_x));
27144
27145 if (width > 0)
27146 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
27147 }
27148
27149 /* Erase the cursor by redrawing the character underneath it. */
27150 if (mouse_face_here_p)
27151 hl = DRAW_MOUSE_FACE;
27152 else
27153 hl = DRAW_NORMAL_TEXT;
27154 draw_phys_cursor_glyph (w, cursor_row, hl);
27155
27156 mark_cursor_off:
27157 w->phys_cursor_on_p = 0;
27158 w->phys_cursor_type = NO_CURSOR;
27159 }
27160
27161
27162 /* EXPORT:
27163 Display or clear cursor of window W. If ON is zero, clear the
27164 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27165 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27166
27167 void
27168 display_and_set_cursor (struct window *w, bool on,
27169 int hpos, int vpos, int x, int y)
27170 {
27171 struct frame *f = XFRAME (w->frame);
27172 int new_cursor_type;
27173 int new_cursor_width;
27174 int active_cursor;
27175 struct glyph_row *glyph_row;
27176 struct glyph *glyph;
27177
27178 /* This is pointless on invisible frames, and dangerous on garbaged
27179 windows and frames; in the latter case, the frame or window may
27180 be in the midst of changing its size, and x and y may be off the
27181 window. */
27182 if (! FRAME_VISIBLE_P (f)
27183 || FRAME_GARBAGED_P (f)
27184 || vpos >= w->current_matrix->nrows
27185 || hpos >= w->current_matrix->matrix_w)
27186 return;
27187
27188 /* If cursor is off and we want it off, return quickly. */
27189 if (!on && !w->phys_cursor_on_p)
27190 return;
27191
27192 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
27193 /* If cursor row is not enabled, we don't really know where to
27194 display the cursor. */
27195 if (!glyph_row->enabled_p)
27196 {
27197 w->phys_cursor_on_p = 0;
27198 return;
27199 }
27200
27201 glyph = NULL;
27202 if (!glyph_row->exact_window_width_line_p
27203 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
27204 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
27205
27206 eassert (input_blocked_p ());
27207
27208 /* Set new_cursor_type to the cursor we want to be displayed. */
27209 new_cursor_type = get_window_cursor_type (w, glyph,
27210 &new_cursor_width, &active_cursor);
27211
27212 /* If cursor is currently being shown and we don't want it to be or
27213 it is in the wrong place, or the cursor type is not what we want,
27214 erase it. */
27215 if (w->phys_cursor_on_p
27216 && (!on
27217 || w->phys_cursor.x != x
27218 || w->phys_cursor.y != y
27219 || new_cursor_type != w->phys_cursor_type
27220 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
27221 && new_cursor_width != w->phys_cursor_width)))
27222 erase_phys_cursor (w);
27223
27224 /* Don't check phys_cursor_on_p here because that flag is only set
27225 to zero in some cases where we know that the cursor has been
27226 completely erased, to avoid the extra work of erasing the cursor
27227 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27228 still not be visible, or it has only been partly erased. */
27229 if (on)
27230 {
27231 w->phys_cursor_ascent = glyph_row->ascent;
27232 w->phys_cursor_height = glyph_row->height;
27233
27234 /* Set phys_cursor_.* before x_draw_.* is called because some
27235 of them may need the information. */
27236 w->phys_cursor.x = x;
27237 w->phys_cursor.y = glyph_row->y;
27238 w->phys_cursor.hpos = hpos;
27239 w->phys_cursor.vpos = vpos;
27240 }
27241
27242 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
27243 new_cursor_type, new_cursor_width,
27244 on, active_cursor);
27245 }
27246
27247
27248 /* Switch the display of W's cursor on or off, according to the value
27249 of ON. */
27250
27251 static void
27252 update_window_cursor (struct window *w, bool on)
27253 {
27254 /* Don't update cursor in windows whose frame is in the process
27255 of being deleted. */
27256 if (w->current_matrix)
27257 {
27258 int hpos = w->phys_cursor.hpos;
27259 int vpos = w->phys_cursor.vpos;
27260 struct glyph_row *row;
27261
27262 if (vpos >= w->current_matrix->nrows
27263 || hpos >= w->current_matrix->matrix_w)
27264 return;
27265
27266 row = MATRIX_ROW (w->current_matrix, vpos);
27267
27268 /* When the window is hscrolled, cursor hpos can legitimately be
27269 out of bounds, but we draw the cursor at the corresponding
27270 window margin in that case. */
27271 if (!row->reversed_p && hpos < 0)
27272 hpos = 0;
27273 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27274 hpos = row->used[TEXT_AREA] - 1;
27275
27276 block_input ();
27277 display_and_set_cursor (w, on, hpos, vpos,
27278 w->phys_cursor.x, w->phys_cursor.y);
27279 unblock_input ();
27280 }
27281 }
27282
27283
27284 /* Call update_window_cursor with parameter ON_P on all leaf windows
27285 in the window tree rooted at W. */
27286
27287 static void
27288 update_cursor_in_window_tree (struct window *w, bool on_p)
27289 {
27290 while (w)
27291 {
27292 if (WINDOWP (w->contents))
27293 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
27294 else
27295 update_window_cursor (w, on_p);
27296
27297 w = NILP (w->next) ? 0 : XWINDOW (w->next);
27298 }
27299 }
27300
27301
27302 /* EXPORT:
27303 Display the cursor on window W, or clear it, according to ON_P.
27304 Don't change the cursor's position. */
27305
27306 void
27307 x_update_cursor (struct frame *f, bool on_p)
27308 {
27309 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
27310 }
27311
27312
27313 /* EXPORT:
27314 Clear the cursor of window W to background color, and mark the
27315 cursor as not shown. This is used when the text where the cursor
27316 is about to be rewritten. */
27317
27318 void
27319 x_clear_cursor (struct window *w)
27320 {
27321 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
27322 update_window_cursor (w, 0);
27323 }
27324
27325 #endif /* HAVE_WINDOW_SYSTEM */
27326
27327 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27328 and MSDOS. */
27329 static void
27330 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
27331 int start_hpos, int end_hpos,
27332 enum draw_glyphs_face draw)
27333 {
27334 #ifdef HAVE_WINDOW_SYSTEM
27335 if (FRAME_WINDOW_P (XFRAME (w->frame)))
27336 {
27337 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
27338 return;
27339 }
27340 #endif
27341 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27342 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
27343 #endif
27344 }
27345
27346 /* Display the active region described by mouse_face_* according to DRAW. */
27347
27348 static void
27349 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
27350 {
27351 struct window *w = XWINDOW (hlinfo->mouse_face_window);
27352 struct frame *f = XFRAME (WINDOW_FRAME (w));
27353
27354 if (/* If window is in the process of being destroyed, don't bother
27355 to do anything. */
27356 w->current_matrix != NULL
27357 /* Don't update mouse highlight if hidden. */
27358 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
27359 /* Recognize when we are called to operate on rows that don't exist
27360 anymore. This can happen when a window is split. */
27361 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
27362 {
27363 int phys_cursor_on_p = w->phys_cursor_on_p;
27364 struct glyph_row *row, *first, *last;
27365
27366 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
27367 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
27368
27369 for (row = first; row <= last && row->enabled_p; ++row)
27370 {
27371 int start_hpos, end_hpos, start_x;
27372
27373 /* For all but the first row, the highlight starts at column 0. */
27374 if (row == first)
27375 {
27376 /* R2L rows have BEG and END in reversed order, but the
27377 screen drawing geometry is always left to right. So
27378 we need to mirror the beginning and end of the
27379 highlighted area in R2L rows. */
27380 if (!row->reversed_p)
27381 {
27382 start_hpos = hlinfo->mouse_face_beg_col;
27383 start_x = hlinfo->mouse_face_beg_x;
27384 }
27385 else if (row == last)
27386 {
27387 start_hpos = hlinfo->mouse_face_end_col;
27388 start_x = hlinfo->mouse_face_end_x;
27389 }
27390 else
27391 {
27392 start_hpos = 0;
27393 start_x = 0;
27394 }
27395 }
27396 else if (row->reversed_p && row == last)
27397 {
27398 start_hpos = hlinfo->mouse_face_end_col;
27399 start_x = hlinfo->mouse_face_end_x;
27400 }
27401 else
27402 {
27403 start_hpos = 0;
27404 start_x = 0;
27405 }
27406
27407 if (row == last)
27408 {
27409 if (!row->reversed_p)
27410 end_hpos = hlinfo->mouse_face_end_col;
27411 else if (row == first)
27412 end_hpos = hlinfo->mouse_face_beg_col;
27413 else
27414 {
27415 end_hpos = row->used[TEXT_AREA];
27416 if (draw == DRAW_NORMAL_TEXT)
27417 row->fill_line_p = 1; /* Clear to end of line */
27418 }
27419 }
27420 else if (row->reversed_p && row == first)
27421 end_hpos = hlinfo->mouse_face_beg_col;
27422 else
27423 {
27424 end_hpos = row->used[TEXT_AREA];
27425 if (draw == DRAW_NORMAL_TEXT)
27426 row->fill_line_p = 1; /* Clear to end of line */
27427 }
27428
27429 if (end_hpos > start_hpos)
27430 {
27431 draw_row_with_mouse_face (w, start_x, row,
27432 start_hpos, end_hpos, draw);
27433
27434 row->mouse_face_p
27435 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
27436 }
27437 }
27438
27439 #ifdef HAVE_WINDOW_SYSTEM
27440 /* When we've written over the cursor, arrange for it to
27441 be displayed again. */
27442 if (FRAME_WINDOW_P (f)
27443 && phys_cursor_on_p && !w->phys_cursor_on_p)
27444 {
27445 int hpos = w->phys_cursor.hpos;
27446
27447 /* When the window is hscrolled, cursor hpos can legitimately be
27448 out of bounds, but we draw the cursor at the corresponding
27449 window margin in that case. */
27450 if (!row->reversed_p && hpos < 0)
27451 hpos = 0;
27452 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27453 hpos = row->used[TEXT_AREA] - 1;
27454
27455 block_input ();
27456 display_and_set_cursor (w, 1, hpos, w->phys_cursor.vpos,
27457 w->phys_cursor.x, w->phys_cursor.y);
27458 unblock_input ();
27459 }
27460 #endif /* HAVE_WINDOW_SYSTEM */
27461 }
27462
27463 #ifdef HAVE_WINDOW_SYSTEM
27464 /* Change the mouse cursor. */
27465 if (FRAME_WINDOW_P (f))
27466 {
27467 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27468 if (draw == DRAW_NORMAL_TEXT
27469 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
27470 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
27471 else
27472 #endif
27473 if (draw == DRAW_MOUSE_FACE)
27474 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
27475 else
27476 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
27477 }
27478 #endif /* HAVE_WINDOW_SYSTEM */
27479 }
27480
27481 /* EXPORT:
27482 Clear out the mouse-highlighted active region.
27483 Redraw it un-highlighted first. Value is non-zero if mouse
27484 face was actually drawn unhighlighted. */
27485
27486 int
27487 clear_mouse_face (Mouse_HLInfo *hlinfo)
27488 {
27489 int cleared = 0;
27490
27491 if (!hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window))
27492 {
27493 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
27494 cleared = 1;
27495 }
27496
27497 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
27498 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
27499 hlinfo->mouse_face_window = Qnil;
27500 hlinfo->mouse_face_overlay = Qnil;
27501 return cleared;
27502 }
27503
27504 /* Return true if the coordinates HPOS and VPOS on windows W are
27505 within the mouse face on that window. */
27506 static bool
27507 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
27508 {
27509 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
27510
27511 /* Quickly resolve the easy cases. */
27512 if (!(WINDOWP (hlinfo->mouse_face_window)
27513 && XWINDOW (hlinfo->mouse_face_window) == w))
27514 return false;
27515 if (vpos < hlinfo->mouse_face_beg_row
27516 || vpos > hlinfo->mouse_face_end_row)
27517 return false;
27518 if (vpos > hlinfo->mouse_face_beg_row
27519 && vpos < hlinfo->mouse_face_end_row)
27520 return true;
27521
27522 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
27523 {
27524 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
27525 {
27526 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
27527 return true;
27528 }
27529 else if ((vpos == hlinfo->mouse_face_beg_row
27530 && hpos >= hlinfo->mouse_face_beg_col)
27531 || (vpos == hlinfo->mouse_face_end_row
27532 && hpos < hlinfo->mouse_face_end_col))
27533 return true;
27534 }
27535 else
27536 {
27537 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
27538 {
27539 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
27540 return true;
27541 }
27542 else if ((vpos == hlinfo->mouse_face_beg_row
27543 && hpos <= hlinfo->mouse_face_beg_col)
27544 || (vpos == hlinfo->mouse_face_end_row
27545 && hpos > hlinfo->mouse_face_end_col))
27546 return true;
27547 }
27548 return false;
27549 }
27550
27551
27552 /* EXPORT:
27553 True if physical cursor of window W is within mouse face. */
27554
27555 bool
27556 cursor_in_mouse_face_p (struct window *w)
27557 {
27558 int hpos = w->phys_cursor.hpos;
27559 int vpos = w->phys_cursor.vpos;
27560 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
27561
27562 /* When the window is hscrolled, cursor hpos can legitimately be out
27563 of bounds, but we draw the cursor at the corresponding window
27564 margin in that case. */
27565 if (!row->reversed_p && hpos < 0)
27566 hpos = 0;
27567 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27568 hpos = row->used[TEXT_AREA] - 1;
27569
27570 return coords_in_mouse_face_p (w, hpos, vpos);
27571 }
27572
27573
27574 \f
27575 /* Find the glyph rows START_ROW and END_ROW of window W that display
27576 characters between buffer positions START_CHARPOS and END_CHARPOS
27577 (excluding END_CHARPOS). DISP_STRING is a display string that
27578 covers these buffer positions. This is similar to
27579 row_containing_pos, but is more accurate when bidi reordering makes
27580 buffer positions change non-linearly with glyph rows. */
27581 static void
27582 rows_from_pos_range (struct window *w,
27583 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
27584 Lisp_Object disp_string,
27585 struct glyph_row **start, struct glyph_row **end)
27586 {
27587 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
27588 int last_y = window_text_bottom_y (w);
27589 struct glyph_row *row;
27590
27591 *start = NULL;
27592 *end = NULL;
27593
27594 while (!first->enabled_p
27595 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
27596 first++;
27597
27598 /* Find the START row. */
27599 for (row = first;
27600 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
27601 row++)
27602 {
27603 /* A row can potentially be the START row if the range of the
27604 characters it displays intersects the range
27605 [START_CHARPOS..END_CHARPOS). */
27606 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
27607 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
27608 /* See the commentary in row_containing_pos, for the
27609 explanation of the complicated way to check whether
27610 some position is beyond the end of the characters
27611 displayed by a row. */
27612 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
27613 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
27614 && !row->ends_at_zv_p
27615 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
27616 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
27617 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
27618 && !row->ends_at_zv_p
27619 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
27620 {
27621 /* Found a candidate row. Now make sure at least one of the
27622 glyphs it displays has a charpos from the range
27623 [START_CHARPOS..END_CHARPOS).
27624
27625 This is not obvious because bidi reordering could make
27626 buffer positions of a row be 1,2,3,102,101,100, and if we
27627 want to highlight characters in [50..60), we don't want
27628 this row, even though [50..60) does intersect [1..103),
27629 the range of character positions given by the row's start
27630 and end positions. */
27631 struct glyph *g = row->glyphs[TEXT_AREA];
27632 struct glyph *e = g + row->used[TEXT_AREA];
27633
27634 while (g < e)
27635 {
27636 if (((BUFFERP (g->object) || INTEGERP (g->object))
27637 && start_charpos <= g->charpos && g->charpos < end_charpos)
27638 /* A glyph that comes from DISP_STRING is by
27639 definition to be highlighted. */
27640 || EQ (g->object, disp_string))
27641 *start = row;
27642 g++;
27643 }
27644 if (*start)
27645 break;
27646 }
27647 }
27648
27649 /* Find the END row. */
27650 if (!*start
27651 /* If the last row is partially visible, start looking for END
27652 from that row, instead of starting from FIRST. */
27653 && !(row->enabled_p
27654 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
27655 row = first;
27656 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
27657 {
27658 struct glyph_row *next = row + 1;
27659 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
27660
27661 if (!next->enabled_p
27662 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
27663 /* The first row >= START whose range of displayed characters
27664 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27665 is the row END + 1. */
27666 || (start_charpos < next_start
27667 && end_charpos < next_start)
27668 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
27669 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
27670 && !next->ends_at_zv_p
27671 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
27672 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
27673 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
27674 && !next->ends_at_zv_p
27675 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
27676 {
27677 *end = row;
27678 break;
27679 }
27680 else
27681 {
27682 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27683 but none of the characters it displays are in the range, it is
27684 also END + 1. */
27685 struct glyph *g = next->glyphs[TEXT_AREA];
27686 struct glyph *s = g;
27687 struct glyph *e = g + next->used[TEXT_AREA];
27688
27689 while (g < e)
27690 {
27691 if (((BUFFERP (g->object) || INTEGERP (g->object))
27692 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
27693 /* If the buffer position of the first glyph in
27694 the row is equal to END_CHARPOS, it means
27695 the last character to be highlighted is the
27696 newline of ROW, and we must consider NEXT as
27697 END, not END+1. */
27698 || (((!next->reversed_p && g == s)
27699 || (next->reversed_p && g == e - 1))
27700 && (g->charpos == end_charpos
27701 /* Special case for when NEXT is an
27702 empty line at ZV. */
27703 || (g->charpos == -1
27704 && !row->ends_at_zv_p
27705 && next_start == end_charpos)))))
27706 /* A glyph that comes from DISP_STRING is by
27707 definition to be highlighted. */
27708 || EQ (g->object, disp_string))
27709 break;
27710 g++;
27711 }
27712 if (g == e)
27713 {
27714 *end = row;
27715 break;
27716 }
27717 /* The first row that ends at ZV must be the last to be
27718 highlighted. */
27719 else if (next->ends_at_zv_p)
27720 {
27721 *end = next;
27722 break;
27723 }
27724 }
27725 }
27726 }
27727
27728 /* This function sets the mouse_face_* elements of HLINFO, assuming
27729 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27730 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27731 for the overlay or run of text properties specifying the mouse
27732 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27733 before-string and after-string that must also be highlighted.
27734 DISP_STRING, if non-nil, is a display string that may cover some
27735 or all of the highlighted text. */
27736
27737 static void
27738 mouse_face_from_buffer_pos (Lisp_Object window,
27739 Mouse_HLInfo *hlinfo,
27740 ptrdiff_t mouse_charpos,
27741 ptrdiff_t start_charpos,
27742 ptrdiff_t end_charpos,
27743 Lisp_Object before_string,
27744 Lisp_Object after_string,
27745 Lisp_Object disp_string)
27746 {
27747 struct window *w = XWINDOW (window);
27748 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
27749 struct glyph_row *r1, *r2;
27750 struct glyph *glyph, *end;
27751 ptrdiff_t ignore, pos;
27752 int x;
27753
27754 eassert (NILP (disp_string) || STRINGP (disp_string));
27755 eassert (NILP (before_string) || STRINGP (before_string));
27756 eassert (NILP (after_string) || STRINGP (after_string));
27757
27758 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27759 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
27760 if (r1 == NULL)
27761 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
27762 /* If the before-string or display-string contains newlines,
27763 rows_from_pos_range skips to its last row. Move back. */
27764 if (!NILP (before_string) || !NILP (disp_string))
27765 {
27766 struct glyph_row *prev;
27767 while ((prev = r1 - 1, prev >= first)
27768 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
27769 && prev->used[TEXT_AREA] > 0)
27770 {
27771 struct glyph *beg = prev->glyphs[TEXT_AREA];
27772 glyph = beg + prev->used[TEXT_AREA];
27773 while (--glyph >= beg && INTEGERP (glyph->object));
27774 if (glyph < beg
27775 || !(EQ (glyph->object, before_string)
27776 || EQ (glyph->object, disp_string)))
27777 break;
27778 r1 = prev;
27779 }
27780 }
27781 if (r2 == NULL)
27782 {
27783 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
27784 hlinfo->mouse_face_past_end = 1;
27785 }
27786 else if (!NILP (after_string))
27787 {
27788 /* If the after-string has newlines, advance to its last row. */
27789 struct glyph_row *next;
27790 struct glyph_row *last
27791 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
27792
27793 for (next = r2 + 1;
27794 next <= last
27795 && next->used[TEXT_AREA] > 0
27796 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
27797 ++next)
27798 r2 = next;
27799 }
27800 /* The rest of the display engine assumes that mouse_face_beg_row is
27801 either above mouse_face_end_row or identical to it. But with
27802 bidi-reordered continued lines, the row for START_CHARPOS could
27803 be below the row for END_CHARPOS. If so, swap the rows and store
27804 them in correct order. */
27805 if (r1->y > r2->y)
27806 {
27807 struct glyph_row *tem = r2;
27808
27809 r2 = r1;
27810 r1 = tem;
27811 }
27812
27813 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
27814 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
27815
27816 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27817 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27818 could be anywhere in the row and in any order. The strategy
27819 below is to find the leftmost and the rightmost glyph that
27820 belongs to either of these 3 strings, or whose position is
27821 between START_CHARPOS and END_CHARPOS, and highlight all the
27822 glyphs between those two. This may cover more than just the text
27823 between START_CHARPOS and END_CHARPOS if the range of characters
27824 strides the bidi level boundary, e.g. if the beginning is in R2L
27825 text while the end is in L2R text or vice versa. */
27826 if (!r1->reversed_p)
27827 {
27828 /* This row is in a left to right paragraph. Scan it left to
27829 right. */
27830 glyph = r1->glyphs[TEXT_AREA];
27831 end = glyph + r1->used[TEXT_AREA];
27832 x = r1->x;
27833
27834 /* Skip truncation glyphs at the start of the glyph row. */
27835 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
27836 for (; glyph < end
27837 && INTEGERP (glyph->object)
27838 && glyph->charpos < 0;
27839 ++glyph)
27840 x += glyph->pixel_width;
27841
27842 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27843 or DISP_STRING, and the first glyph from buffer whose
27844 position is between START_CHARPOS and END_CHARPOS. */
27845 for (; glyph < end
27846 && !INTEGERP (glyph->object)
27847 && !EQ (glyph->object, disp_string)
27848 && !(BUFFERP (glyph->object)
27849 && (glyph->charpos >= start_charpos
27850 && glyph->charpos < end_charpos));
27851 ++glyph)
27852 {
27853 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27854 are present at buffer positions between START_CHARPOS and
27855 END_CHARPOS, or if they come from an overlay. */
27856 if (EQ (glyph->object, before_string))
27857 {
27858 pos = string_buffer_position (before_string,
27859 start_charpos);
27860 /* If pos == 0, it means before_string came from an
27861 overlay, not from a buffer position. */
27862 if (!pos || (pos >= start_charpos && pos < end_charpos))
27863 break;
27864 }
27865 else if (EQ (glyph->object, after_string))
27866 {
27867 pos = string_buffer_position (after_string, end_charpos);
27868 if (!pos || (pos >= start_charpos && pos < end_charpos))
27869 break;
27870 }
27871 x += glyph->pixel_width;
27872 }
27873 hlinfo->mouse_face_beg_x = x;
27874 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
27875 }
27876 else
27877 {
27878 /* This row is in a right to left paragraph. Scan it right to
27879 left. */
27880 struct glyph *g;
27881
27882 end = r1->glyphs[TEXT_AREA] - 1;
27883 glyph = end + r1->used[TEXT_AREA];
27884
27885 /* Skip truncation glyphs at the start of the glyph row. */
27886 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
27887 for (; glyph > end
27888 && INTEGERP (glyph->object)
27889 && glyph->charpos < 0;
27890 --glyph)
27891 ;
27892
27893 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27894 or DISP_STRING, and the first glyph from buffer whose
27895 position is between START_CHARPOS and END_CHARPOS. */
27896 for (; glyph > end
27897 && !INTEGERP (glyph->object)
27898 && !EQ (glyph->object, disp_string)
27899 && !(BUFFERP (glyph->object)
27900 && (glyph->charpos >= start_charpos
27901 && glyph->charpos < end_charpos));
27902 --glyph)
27903 {
27904 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27905 are present at buffer positions between START_CHARPOS and
27906 END_CHARPOS, or if they come from an overlay. */
27907 if (EQ (glyph->object, before_string))
27908 {
27909 pos = string_buffer_position (before_string, start_charpos);
27910 /* If pos == 0, it means before_string came from an
27911 overlay, not from a buffer position. */
27912 if (!pos || (pos >= start_charpos && pos < end_charpos))
27913 break;
27914 }
27915 else if (EQ (glyph->object, after_string))
27916 {
27917 pos = string_buffer_position (after_string, end_charpos);
27918 if (!pos || (pos >= start_charpos && pos < end_charpos))
27919 break;
27920 }
27921 }
27922
27923 glyph++; /* first glyph to the right of the highlighted area */
27924 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
27925 x += g->pixel_width;
27926 hlinfo->mouse_face_beg_x = x;
27927 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
27928 }
27929
27930 /* If the highlight ends in a different row, compute GLYPH and END
27931 for the end row. Otherwise, reuse the values computed above for
27932 the row where the highlight begins. */
27933 if (r2 != r1)
27934 {
27935 if (!r2->reversed_p)
27936 {
27937 glyph = r2->glyphs[TEXT_AREA];
27938 end = glyph + r2->used[TEXT_AREA];
27939 x = r2->x;
27940 }
27941 else
27942 {
27943 end = r2->glyphs[TEXT_AREA] - 1;
27944 glyph = end + r2->used[TEXT_AREA];
27945 }
27946 }
27947
27948 if (!r2->reversed_p)
27949 {
27950 /* Skip truncation and continuation glyphs near the end of the
27951 row, and also blanks and stretch glyphs inserted by
27952 extend_face_to_end_of_line. */
27953 while (end > glyph
27954 && INTEGERP ((end - 1)->object))
27955 --end;
27956 /* Scan the rest of the glyph row from the end, looking for the
27957 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27958 DISP_STRING, or whose position is between START_CHARPOS
27959 and END_CHARPOS */
27960 for (--end;
27961 end > glyph
27962 && !INTEGERP (end->object)
27963 && !EQ (end->object, disp_string)
27964 && !(BUFFERP (end->object)
27965 && (end->charpos >= start_charpos
27966 && end->charpos < end_charpos));
27967 --end)
27968 {
27969 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27970 are present at buffer positions between START_CHARPOS and
27971 END_CHARPOS, or if they come from an overlay. */
27972 if (EQ (end->object, before_string))
27973 {
27974 pos = string_buffer_position (before_string, start_charpos);
27975 if (!pos || (pos >= start_charpos && pos < end_charpos))
27976 break;
27977 }
27978 else if (EQ (end->object, after_string))
27979 {
27980 pos = string_buffer_position (after_string, end_charpos);
27981 if (!pos || (pos >= start_charpos && pos < end_charpos))
27982 break;
27983 }
27984 }
27985 /* Find the X coordinate of the last glyph to be highlighted. */
27986 for (; glyph <= end; ++glyph)
27987 x += glyph->pixel_width;
27988
27989 hlinfo->mouse_face_end_x = x;
27990 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
27991 }
27992 else
27993 {
27994 /* Skip truncation and continuation glyphs near the end of the
27995 row, and also blanks and stretch glyphs inserted by
27996 extend_face_to_end_of_line. */
27997 x = r2->x;
27998 end++;
27999 while (end < glyph
28000 && INTEGERP (end->object))
28001 {
28002 x += end->pixel_width;
28003 ++end;
28004 }
28005 /* Scan the rest of the glyph row from the end, looking for the
28006 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28007 DISP_STRING, or whose position is between START_CHARPOS
28008 and END_CHARPOS */
28009 for ( ;
28010 end < glyph
28011 && !INTEGERP (end->object)
28012 && !EQ (end->object, disp_string)
28013 && !(BUFFERP (end->object)
28014 && (end->charpos >= start_charpos
28015 && end->charpos < end_charpos));
28016 ++end)
28017 {
28018 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28019 are present at buffer positions between START_CHARPOS and
28020 END_CHARPOS, or if they come from an overlay. */
28021 if (EQ (end->object, before_string))
28022 {
28023 pos = string_buffer_position (before_string, start_charpos);
28024 if (!pos || (pos >= start_charpos && pos < end_charpos))
28025 break;
28026 }
28027 else if (EQ (end->object, after_string))
28028 {
28029 pos = string_buffer_position (after_string, end_charpos);
28030 if (!pos || (pos >= start_charpos && pos < end_charpos))
28031 break;
28032 }
28033 x += end->pixel_width;
28034 }
28035 /* If we exited the above loop because we arrived at the last
28036 glyph of the row, and its buffer position is still not in
28037 range, it means the last character in range is the preceding
28038 newline. Bump the end column and x values to get past the
28039 last glyph. */
28040 if (end == glyph
28041 && BUFFERP (end->object)
28042 && (end->charpos < start_charpos
28043 || end->charpos >= end_charpos))
28044 {
28045 x += end->pixel_width;
28046 ++end;
28047 }
28048 hlinfo->mouse_face_end_x = x;
28049 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
28050 }
28051
28052 hlinfo->mouse_face_window = window;
28053 hlinfo->mouse_face_face_id
28054 = face_at_buffer_position (w, mouse_charpos, &ignore,
28055 mouse_charpos + 1,
28056 !hlinfo->mouse_face_hidden, -1);
28057 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28058 }
28059
28060 /* The following function is not used anymore (replaced with
28061 mouse_face_from_string_pos), but I leave it here for the time
28062 being, in case someone would. */
28063
28064 #if 0 /* not used */
28065
28066 /* Find the position of the glyph for position POS in OBJECT in
28067 window W's current matrix, and return in *X, *Y the pixel
28068 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28069
28070 RIGHT_P non-zero means return the position of the right edge of the
28071 glyph, RIGHT_P zero means return the left edge position.
28072
28073 If no glyph for POS exists in the matrix, return the position of
28074 the glyph with the next smaller position that is in the matrix, if
28075 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28076 exists in the matrix, return the position of the glyph with the
28077 next larger position in OBJECT.
28078
28079 Value is non-zero if a glyph was found. */
28080
28081 static int
28082 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
28083 int *hpos, int *vpos, int *x, int *y, int right_p)
28084 {
28085 int yb = window_text_bottom_y (w);
28086 struct glyph_row *r;
28087 struct glyph *best_glyph = NULL;
28088 struct glyph_row *best_row = NULL;
28089 int best_x = 0;
28090
28091 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28092 r->enabled_p && r->y < yb;
28093 ++r)
28094 {
28095 struct glyph *g = r->glyphs[TEXT_AREA];
28096 struct glyph *e = g + r->used[TEXT_AREA];
28097 int gx;
28098
28099 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28100 if (EQ (g->object, object))
28101 {
28102 if (g->charpos == pos)
28103 {
28104 best_glyph = g;
28105 best_x = gx;
28106 best_row = r;
28107 goto found;
28108 }
28109 else if (best_glyph == NULL
28110 || ((eabs (g->charpos - pos)
28111 < eabs (best_glyph->charpos - pos))
28112 && (right_p
28113 ? g->charpos < pos
28114 : g->charpos > pos)))
28115 {
28116 best_glyph = g;
28117 best_x = gx;
28118 best_row = r;
28119 }
28120 }
28121 }
28122
28123 found:
28124
28125 if (best_glyph)
28126 {
28127 *x = best_x;
28128 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
28129
28130 if (right_p)
28131 {
28132 *x += best_glyph->pixel_width;
28133 ++*hpos;
28134 }
28135
28136 *y = best_row->y;
28137 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
28138 }
28139
28140 return best_glyph != NULL;
28141 }
28142 #endif /* not used */
28143
28144 /* Find the positions of the first and the last glyphs in window W's
28145 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28146 (assumed to be a string), and return in HLINFO's mouse_face_*
28147 members the pixel and column/row coordinates of those glyphs. */
28148
28149 static void
28150 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
28151 Lisp_Object object,
28152 ptrdiff_t startpos, ptrdiff_t endpos)
28153 {
28154 int yb = window_text_bottom_y (w);
28155 struct glyph_row *r;
28156 struct glyph *g, *e;
28157 int gx;
28158 int found = 0;
28159
28160 /* Find the glyph row with at least one position in the range
28161 [STARTPOS..ENDPOS), and the first glyph in that row whose
28162 position belongs to that range. */
28163 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28164 r->enabled_p && r->y < yb;
28165 ++r)
28166 {
28167 if (!r->reversed_p)
28168 {
28169 g = r->glyphs[TEXT_AREA];
28170 e = g + r->used[TEXT_AREA];
28171 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28172 if (EQ (g->object, object)
28173 && startpos <= g->charpos && g->charpos < endpos)
28174 {
28175 hlinfo->mouse_face_beg_row
28176 = MATRIX_ROW_VPOS (r, w->current_matrix);
28177 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28178 hlinfo->mouse_face_beg_x = gx;
28179 found = 1;
28180 break;
28181 }
28182 }
28183 else
28184 {
28185 struct glyph *g1;
28186
28187 e = r->glyphs[TEXT_AREA];
28188 g = e + r->used[TEXT_AREA];
28189 for ( ; g > e; --g)
28190 if (EQ ((g-1)->object, object)
28191 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
28192 {
28193 hlinfo->mouse_face_beg_row
28194 = MATRIX_ROW_VPOS (r, w->current_matrix);
28195 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28196 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
28197 gx += g1->pixel_width;
28198 hlinfo->mouse_face_beg_x = gx;
28199 found = 1;
28200 break;
28201 }
28202 }
28203 if (found)
28204 break;
28205 }
28206
28207 if (!found)
28208 return;
28209
28210 /* Starting with the next row, look for the first row which does NOT
28211 include any glyphs whose positions are in the range. */
28212 for (++r; r->enabled_p && r->y < yb; ++r)
28213 {
28214 g = r->glyphs[TEXT_AREA];
28215 e = g + r->used[TEXT_AREA];
28216 found = 0;
28217 for ( ; g < e; ++g)
28218 if (EQ (g->object, object)
28219 && startpos <= g->charpos && g->charpos < endpos)
28220 {
28221 found = 1;
28222 break;
28223 }
28224 if (!found)
28225 break;
28226 }
28227
28228 /* The highlighted region ends on the previous row. */
28229 r--;
28230
28231 /* Set the end row. */
28232 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
28233
28234 /* Compute and set the end column and the end column's horizontal
28235 pixel coordinate. */
28236 if (!r->reversed_p)
28237 {
28238 g = r->glyphs[TEXT_AREA];
28239 e = g + r->used[TEXT_AREA];
28240 for ( ; e > g; --e)
28241 if (EQ ((e-1)->object, object)
28242 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
28243 break;
28244 hlinfo->mouse_face_end_col = e - g;
28245
28246 for (gx = r->x; g < e; ++g)
28247 gx += g->pixel_width;
28248 hlinfo->mouse_face_end_x = gx;
28249 }
28250 else
28251 {
28252 e = r->glyphs[TEXT_AREA];
28253 g = e + r->used[TEXT_AREA];
28254 for (gx = r->x ; e < g; ++e)
28255 {
28256 if (EQ (e->object, object)
28257 && startpos <= e->charpos && e->charpos < endpos)
28258 break;
28259 gx += e->pixel_width;
28260 }
28261 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
28262 hlinfo->mouse_face_end_x = gx;
28263 }
28264 }
28265
28266 #ifdef HAVE_WINDOW_SYSTEM
28267
28268 /* See if position X, Y is within a hot-spot of an image. */
28269
28270 static int
28271 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
28272 {
28273 if (!CONSP (hot_spot))
28274 return 0;
28275
28276 if (EQ (XCAR (hot_spot), Qrect))
28277 {
28278 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28279 Lisp_Object rect = XCDR (hot_spot);
28280 Lisp_Object tem;
28281 if (!CONSP (rect))
28282 return 0;
28283 if (!CONSP (XCAR (rect)))
28284 return 0;
28285 if (!CONSP (XCDR (rect)))
28286 return 0;
28287 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
28288 return 0;
28289 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
28290 return 0;
28291 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
28292 return 0;
28293 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
28294 return 0;
28295 return 1;
28296 }
28297 else if (EQ (XCAR (hot_spot), Qcircle))
28298 {
28299 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28300 Lisp_Object circ = XCDR (hot_spot);
28301 Lisp_Object lr, lx0, ly0;
28302 if (CONSP (circ)
28303 && CONSP (XCAR (circ))
28304 && (lr = XCDR (circ), INTEGERP (lr) || FLOATP (lr))
28305 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
28306 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
28307 {
28308 double r = XFLOATINT (lr);
28309 double dx = XINT (lx0) - x;
28310 double dy = XINT (ly0) - y;
28311 return (dx * dx + dy * dy <= r * r);
28312 }
28313 }
28314 else if (EQ (XCAR (hot_spot), Qpoly))
28315 {
28316 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28317 if (VECTORP (XCDR (hot_spot)))
28318 {
28319 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
28320 Lisp_Object *poly = v->contents;
28321 ptrdiff_t n = v->header.size;
28322 ptrdiff_t i;
28323 int inside = 0;
28324 Lisp_Object lx, ly;
28325 int x0, y0;
28326
28327 /* Need an even number of coordinates, and at least 3 edges. */
28328 if (n < 6 || n & 1)
28329 return 0;
28330
28331 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28332 If count is odd, we are inside polygon. Pixels on edges
28333 may or may not be included depending on actual geometry of the
28334 polygon. */
28335 if ((lx = poly[n-2], !INTEGERP (lx))
28336 || (ly = poly[n-1], !INTEGERP (lx)))
28337 return 0;
28338 x0 = XINT (lx), y0 = XINT (ly);
28339 for (i = 0; i < n; i += 2)
28340 {
28341 int x1 = x0, y1 = y0;
28342 if ((lx = poly[i], !INTEGERP (lx))
28343 || (ly = poly[i+1], !INTEGERP (ly)))
28344 return 0;
28345 x0 = XINT (lx), y0 = XINT (ly);
28346
28347 /* Does this segment cross the X line? */
28348 if (x0 >= x)
28349 {
28350 if (x1 >= x)
28351 continue;
28352 }
28353 else if (x1 < x)
28354 continue;
28355 if (y > y0 && y > y1)
28356 continue;
28357 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
28358 inside = !inside;
28359 }
28360 return inside;
28361 }
28362 }
28363 return 0;
28364 }
28365
28366 Lisp_Object
28367 find_hot_spot (Lisp_Object map, int x, int y)
28368 {
28369 while (CONSP (map))
28370 {
28371 if (CONSP (XCAR (map))
28372 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
28373 return XCAR (map);
28374 map = XCDR (map);
28375 }
28376
28377 return Qnil;
28378 }
28379
28380 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
28381 3, 3, 0,
28382 doc: /* Lookup in image map MAP coordinates X and Y.
28383 An image map is an alist where each element has the format (AREA ID PLIST).
28384 An AREA is specified as either a rectangle, a circle, or a polygon:
28385 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28386 pixel coordinates of the upper left and bottom right corners.
28387 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28388 and the radius of the circle; r may be a float or integer.
28389 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28390 vector describes one corner in the polygon.
28391 Returns the alist element for the first matching AREA in MAP. */)
28392 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
28393 {
28394 if (NILP (map))
28395 return Qnil;
28396
28397 CHECK_NUMBER (x);
28398 CHECK_NUMBER (y);
28399
28400 return find_hot_spot (map,
28401 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
28402 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
28403 }
28404
28405
28406 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28407 static void
28408 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
28409 {
28410 /* Do not change cursor shape while dragging mouse. */
28411 if (!NILP (do_mouse_tracking))
28412 return;
28413
28414 if (!NILP (pointer))
28415 {
28416 if (EQ (pointer, Qarrow))
28417 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28418 else if (EQ (pointer, Qhand))
28419 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
28420 else if (EQ (pointer, Qtext))
28421 cursor = FRAME_X_OUTPUT (f)->text_cursor;
28422 else if (EQ (pointer, intern ("hdrag")))
28423 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
28424 else if (EQ (pointer, intern ("nhdrag")))
28425 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
28426 #ifdef HAVE_X_WINDOWS
28427 else if (EQ (pointer, intern ("vdrag")))
28428 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28429 #endif
28430 else if (EQ (pointer, intern ("hourglass")))
28431 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
28432 else if (EQ (pointer, Qmodeline))
28433 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
28434 else
28435 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28436 }
28437
28438 if (cursor != No_Cursor)
28439 FRAME_RIF (f)->define_frame_cursor (f, cursor);
28440 }
28441
28442 #endif /* HAVE_WINDOW_SYSTEM */
28443
28444 /* Take proper action when mouse has moved to the mode or header line
28445 or marginal area AREA of window W, x-position X and y-position Y.
28446 X is relative to the start of the text display area of W, so the
28447 width of bitmap areas and scroll bars must be subtracted to get a
28448 position relative to the start of the mode line. */
28449
28450 static void
28451 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
28452 enum window_part area)
28453 {
28454 struct window *w = XWINDOW (window);
28455 struct frame *f = XFRAME (w->frame);
28456 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28457 #ifdef HAVE_WINDOW_SYSTEM
28458 Display_Info *dpyinfo;
28459 #endif
28460 Cursor cursor = No_Cursor;
28461 Lisp_Object pointer = Qnil;
28462 int dx, dy, width, height;
28463 ptrdiff_t charpos;
28464 Lisp_Object string, object = Qnil;
28465 Lisp_Object pos IF_LINT (= Qnil), help;
28466
28467 Lisp_Object mouse_face;
28468 int original_x_pixel = x;
28469 struct glyph * glyph = NULL, * row_start_glyph = NULL;
28470 struct glyph_row *row IF_LINT (= 0);
28471
28472 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
28473 {
28474 int x0;
28475 struct glyph *end;
28476
28477 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28478 returns them in row/column units! */
28479 string = mode_line_string (w, area, &x, &y, &charpos,
28480 &object, &dx, &dy, &width, &height);
28481
28482 row = (area == ON_MODE_LINE
28483 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
28484 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
28485
28486 /* Find the glyph under the mouse pointer. */
28487 if (row->mode_line_p && row->enabled_p)
28488 {
28489 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
28490 end = glyph + row->used[TEXT_AREA];
28491
28492 for (x0 = original_x_pixel;
28493 glyph < end && x0 >= glyph->pixel_width;
28494 ++glyph)
28495 x0 -= glyph->pixel_width;
28496
28497 if (glyph >= end)
28498 glyph = NULL;
28499 }
28500 }
28501 else
28502 {
28503 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
28504 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28505 returns them in row/column units! */
28506 string = marginal_area_string (w, area, &x, &y, &charpos,
28507 &object, &dx, &dy, &width, &height);
28508 }
28509
28510 help = Qnil;
28511
28512 #ifdef HAVE_WINDOW_SYSTEM
28513 if (IMAGEP (object))
28514 {
28515 Lisp_Object image_map, hotspot;
28516 if ((image_map = Fplist_get (XCDR (object), QCmap),
28517 !NILP (image_map))
28518 && (hotspot = find_hot_spot (image_map, dx, dy),
28519 CONSP (hotspot))
28520 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
28521 {
28522 Lisp_Object plist;
28523
28524 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28525 If so, we could look for mouse-enter, mouse-leave
28526 properties in PLIST (and do something...). */
28527 hotspot = XCDR (hotspot);
28528 if (CONSP (hotspot)
28529 && (plist = XCAR (hotspot), CONSP (plist)))
28530 {
28531 pointer = Fplist_get (plist, Qpointer);
28532 if (NILP (pointer))
28533 pointer = Qhand;
28534 help = Fplist_get (plist, Qhelp_echo);
28535 if (!NILP (help))
28536 {
28537 help_echo_string = help;
28538 XSETWINDOW (help_echo_window, w);
28539 help_echo_object = w->contents;
28540 help_echo_pos = charpos;
28541 }
28542 }
28543 }
28544 if (NILP (pointer))
28545 pointer = Fplist_get (XCDR (object), QCpointer);
28546 }
28547 #endif /* HAVE_WINDOW_SYSTEM */
28548
28549 if (STRINGP (string))
28550 pos = make_number (charpos);
28551
28552 /* Set the help text and mouse pointer. If the mouse is on a part
28553 of the mode line without any text (e.g. past the right edge of
28554 the mode line text), use the default help text and pointer. */
28555 if (STRINGP (string) || area == ON_MODE_LINE)
28556 {
28557 /* Arrange to display the help by setting the global variables
28558 help_echo_string, help_echo_object, and help_echo_pos. */
28559 if (NILP (help))
28560 {
28561 if (STRINGP (string))
28562 help = Fget_text_property (pos, Qhelp_echo, string);
28563
28564 if (!NILP (help))
28565 {
28566 help_echo_string = help;
28567 XSETWINDOW (help_echo_window, w);
28568 help_echo_object = string;
28569 help_echo_pos = charpos;
28570 }
28571 else if (area == ON_MODE_LINE)
28572 {
28573 Lisp_Object default_help
28574 = buffer_local_value (Qmode_line_default_help_echo,
28575 w->contents);
28576
28577 if (STRINGP (default_help))
28578 {
28579 help_echo_string = default_help;
28580 XSETWINDOW (help_echo_window, w);
28581 help_echo_object = Qnil;
28582 help_echo_pos = -1;
28583 }
28584 }
28585 }
28586
28587 #ifdef HAVE_WINDOW_SYSTEM
28588 /* Change the mouse pointer according to what is under it. */
28589 if (FRAME_WINDOW_P (f))
28590 {
28591 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
28592 || minibuf_level
28593 || NILP (Vresize_mini_windows));
28594
28595 dpyinfo = FRAME_DISPLAY_INFO (f);
28596 if (STRINGP (string))
28597 {
28598 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28599
28600 if (NILP (pointer))
28601 pointer = Fget_text_property (pos, Qpointer, string);
28602
28603 /* Change the mouse pointer according to what is under X/Y. */
28604 if (NILP (pointer)
28605 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
28606 {
28607 Lisp_Object map;
28608 map = Fget_text_property (pos, Qlocal_map, string);
28609 if (!KEYMAPP (map))
28610 map = Fget_text_property (pos, Qkeymap, string);
28611 if (!KEYMAPP (map) && draggable)
28612 cursor = dpyinfo->vertical_scroll_bar_cursor;
28613 }
28614 }
28615 else if (draggable)
28616 /* Default mode-line pointer. */
28617 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28618 }
28619 #endif
28620 }
28621
28622 /* Change the mouse face according to what is under X/Y. */
28623 if (STRINGP (string))
28624 {
28625 mouse_face = Fget_text_property (pos, Qmouse_face, string);
28626 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
28627 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
28628 && glyph)
28629 {
28630 Lisp_Object b, e;
28631
28632 struct glyph * tmp_glyph;
28633
28634 int gpos;
28635 int gseq_length;
28636 int total_pixel_width;
28637 ptrdiff_t begpos, endpos, ignore;
28638
28639 int vpos, hpos;
28640
28641 b = Fprevious_single_property_change (make_number (charpos + 1),
28642 Qmouse_face, string, Qnil);
28643 if (NILP (b))
28644 begpos = 0;
28645 else
28646 begpos = XINT (b);
28647
28648 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
28649 if (NILP (e))
28650 endpos = SCHARS (string);
28651 else
28652 endpos = XINT (e);
28653
28654 /* Calculate the glyph position GPOS of GLYPH in the
28655 displayed string, relative to the beginning of the
28656 highlighted part of the string.
28657
28658 Note: GPOS is different from CHARPOS. CHARPOS is the
28659 position of GLYPH in the internal string object. A mode
28660 line string format has structures which are converted to
28661 a flattened string by the Emacs Lisp interpreter. The
28662 internal string is an element of those structures. The
28663 displayed string is the flattened string. */
28664 tmp_glyph = row_start_glyph;
28665 while (tmp_glyph < glyph
28666 && (!(EQ (tmp_glyph->object, glyph->object)
28667 && begpos <= tmp_glyph->charpos
28668 && tmp_glyph->charpos < endpos)))
28669 tmp_glyph++;
28670 gpos = glyph - tmp_glyph;
28671
28672 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28673 the highlighted part of the displayed string to which
28674 GLYPH belongs. Note: GSEQ_LENGTH is different from
28675 SCHARS (STRING), because the latter returns the length of
28676 the internal string. */
28677 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
28678 tmp_glyph > glyph
28679 && (!(EQ (tmp_glyph->object, glyph->object)
28680 && begpos <= tmp_glyph->charpos
28681 && tmp_glyph->charpos < endpos));
28682 tmp_glyph--)
28683 ;
28684 gseq_length = gpos + (tmp_glyph - glyph) + 1;
28685
28686 /* Calculate the total pixel width of all the glyphs between
28687 the beginning of the highlighted area and GLYPH. */
28688 total_pixel_width = 0;
28689 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
28690 total_pixel_width += tmp_glyph->pixel_width;
28691
28692 /* Pre calculation of re-rendering position. Note: X is in
28693 column units here, after the call to mode_line_string or
28694 marginal_area_string. */
28695 hpos = x - gpos;
28696 vpos = (area == ON_MODE_LINE
28697 ? (w->current_matrix)->nrows - 1
28698 : 0);
28699
28700 /* If GLYPH's position is included in the region that is
28701 already drawn in mouse face, we have nothing to do. */
28702 if ( EQ (window, hlinfo->mouse_face_window)
28703 && (!row->reversed_p
28704 ? (hlinfo->mouse_face_beg_col <= hpos
28705 && hpos < hlinfo->mouse_face_end_col)
28706 /* In R2L rows we swap BEG and END, see below. */
28707 : (hlinfo->mouse_face_end_col <= hpos
28708 && hpos < hlinfo->mouse_face_beg_col))
28709 && hlinfo->mouse_face_beg_row == vpos )
28710 return;
28711
28712 if (clear_mouse_face (hlinfo))
28713 cursor = No_Cursor;
28714
28715 if (!row->reversed_p)
28716 {
28717 hlinfo->mouse_face_beg_col = hpos;
28718 hlinfo->mouse_face_beg_x = original_x_pixel
28719 - (total_pixel_width + dx);
28720 hlinfo->mouse_face_end_col = hpos + gseq_length;
28721 hlinfo->mouse_face_end_x = 0;
28722 }
28723 else
28724 {
28725 /* In R2L rows, show_mouse_face expects BEG and END
28726 coordinates to be swapped. */
28727 hlinfo->mouse_face_end_col = hpos;
28728 hlinfo->mouse_face_end_x = original_x_pixel
28729 - (total_pixel_width + dx);
28730 hlinfo->mouse_face_beg_col = hpos + gseq_length;
28731 hlinfo->mouse_face_beg_x = 0;
28732 }
28733
28734 hlinfo->mouse_face_beg_row = vpos;
28735 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
28736 hlinfo->mouse_face_past_end = 0;
28737 hlinfo->mouse_face_window = window;
28738
28739 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
28740 charpos,
28741 0, &ignore,
28742 glyph->face_id,
28743 1);
28744 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28745
28746 if (NILP (pointer))
28747 pointer = Qhand;
28748 }
28749 else if ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
28750 clear_mouse_face (hlinfo);
28751 }
28752 #ifdef HAVE_WINDOW_SYSTEM
28753 if (FRAME_WINDOW_P (f))
28754 define_frame_cursor1 (f, cursor, pointer);
28755 #endif
28756 }
28757
28758
28759 /* EXPORT:
28760 Take proper action when the mouse has moved to position X, Y on
28761 frame F with regards to highlighting portions of display that have
28762 mouse-face properties. Also de-highlight portions of display where
28763 the mouse was before, set the mouse pointer shape as appropriate
28764 for the mouse coordinates, and activate help echo (tooltips).
28765 X and Y can be negative or out of range. */
28766
28767 void
28768 note_mouse_highlight (struct frame *f, int x, int y)
28769 {
28770 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28771 enum window_part part = ON_NOTHING;
28772 Lisp_Object window;
28773 struct window *w;
28774 Cursor cursor = No_Cursor;
28775 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
28776 struct buffer *b;
28777
28778 /* When a menu is active, don't highlight because this looks odd. */
28779 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28780 if (popup_activated ())
28781 return;
28782 #endif
28783
28784 if (!f->glyphs_initialized_p
28785 || f->pointer_invisible)
28786 return;
28787
28788 hlinfo->mouse_face_mouse_x = x;
28789 hlinfo->mouse_face_mouse_y = y;
28790 hlinfo->mouse_face_mouse_frame = f;
28791
28792 if (hlinfo->mouse_face_defer)
28793 return;
28794
28795 /* Which window is that in? */
28796 window = window_from_coordinates (f, x, y, &part, 1);
28797
28798 /* If displaying active text in another window, clear that. */
28799 if (! EQ (window, hlinfo->mouse_face_window)
28800 /* Also clear if we move out of text area in same window. */
28801 || (!NILP (hlinfo->mouse_face_window)
28802 && !NILP (window)
28803 && part != ON_TEXT
28804 && part != ON_MODE_LINE
28805 && part != ON_HEADER_LINE))
28806 clear_mouse_face (hlinfo);
28807
28808 /* Not on a window -> return. */
28809 if (!WINDOWP (window))
28810 return;
28811
28812 /* Reset help_echo_string. It will get recomputed below. */
28813 help_echo_string = Qnil;
28814
28815 /* Convert to window-relative pixel coordinates. */
28816 w = XWINDOW (window);
28817 frame_to_window_pixel_xy (w, &x, &y);
28818
28819 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28820 /* Handle tool-bar window differently since it doesn't display a
28821 buffer. */
28822 if (EQ (window, f->tool_bar_window))
28823 {
28824 note_tool_bar_highlight (f, x, y);
28825 return;
28826 }
28827 #endif
28828
28829 /* Mouse is on the mode, header line or margin? */
28830 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
28831 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
28832 {
28833 note_mode_line_or_margin_highlight (window, x, y, part);
28834
28835 #ifdef HAVE_WINDOW_SYSTEM
28836 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
28837 {
28838 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28839 /* Show non-text cursor (Bug#16647). */
28840 goto set_cursor;
28841 }
28842 else
28843 #endif
28844 return;
28845 }
28846
28847 #ifdef HAVE_WINDOW_SYSTEM
28848 if (part == ON_VERTICAL_BORDER)
28849 {
28850 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
28851 help_echo_string = build_string ("drag-mouse-1: resize");
28852 }
28853 else if (part == ON_RIGHT_DIVIDER)
28854 {
28855 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
28856 help_echo_string = build_string ("drag-mouse-1: resize");
28857 }
28858 else if (part == ON_BOTTOM_DIVIDER)
28859 if (! WINDOW_BOTTOMMOST_P (w)
28860 || minibuf_level
28861 || NILP (Vresize_mini_windows))
28862 {
28863 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
28864 help_echo_string = build_string ("drag-mouse-1: resize");
28865 }
28866 else
28867 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28868 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
28869 || part == ON_SCROLL_BAR)
28870 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28871 else
28872 cursor = FRAME_X_OUTPUT (f)->text_cursor;
28873 #endif
28874
28875 /* Are we in a window whose display is up to date?
28876 And verify the buffer's text has not changed. */
28877 b = XBUFFER (w->contents);
28878 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
28879 {
28880 int hpos, vpos, dx, dy, area = LAST_AREA;
28881 ptrdiff_t pos;
28882 struct glyph *glyph;
28883 Lisp_Object object;
28884 Lisp_Object mouse_face = Qnil, position;
28885 Lisp_Object *overlay_vec = NULL;
28886 ptrdiff_t i, noverlays;
28887 struct buffer *obuf;
28888 ptrdiff_t obegv, ozv;
28889 int same_region;
28890
28891 /* Find the glyph under X/Y. */
28892 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
28893
28894 #ifdef HAVE_WINDOW_SYSTEM
28895 /* Look for :pointer property on image. */
28896 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
28897 {
28898 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
28899 if (img != NULL && IMAGEP (img->spec))
28900 {
28901 Lisp_Object image_map, hotspot;
28902 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
28903 !NILP (image_map))
28904 && (hotspot = find_hot_spot (image_map,
28905 glyph->slice.img.x + dx,
28906 glyph->slice.img.y + dy),
28907 CONSP (hotspot))
28908 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
28909 {
28910 Lisp_Object plist;
28911
28912 /* Could check XCAR (hotspot) to see if we enter/leave
28913 this hot-spot.
28914 If so, we could look for mouse-enter, mouse-leave
28915 properties in PLIST (and do something...). */
28916 hotspot = XCDR (hotspot);
28917 if (CONSP (hotspot)
28918 && (plist = XCAR (hotspot), CONSP (plist)))
28919 {
28920 pointer = Fplist_get (plist, Qpointer);
28921 if (NILP (pointer))
28922 pointer = Qhand;
28923 help_echo_string = Fplist_get (plist, Qhelp_echo);
28924 if (!NILP (help_echo_string))
28925 {
28926 help_echo_window = window;
28927 help_echo_object = glyph->object;
28928 help_echo_pos = glyph->charpos;
28929 }
28930 }
28931 }
28932 if (NILP (pointer))
28933 pointer = Fplist_get (XCDR (img->spec), QCpointer);
28934 }
28935 }
28936 #endif /* HAVE_WINDOW_SYSTEM */
28937
28938 /* Clear mouse face if X/Y not over text. */
28939 if (glyph == NULL
28940 || area != TEXT_AREA
28941 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
28942 /* Glyph's OBJECT is an integer for glyphs inserted by the
28943 display engine for its internal purposes, like truncation
28944 and continuation glyphs and blanks beyond the end of
28945 line's text on text terminals. If we are over such a
28946 glyph, we are not over any text. */
28947 || INTEGERP (glyph->object)
28948 /* R2L rows have a stretch glyph at their front, which
28949 stands for no text, whereas L2R rows have no glyphs at
28950 all beyond the end of text. Treat such stretch glyphs
28951 like we do with NULL glyphs in L2R rows. */
28952 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
28953 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
28954 && glyph->type == STRETCH_GLYPH
28955 && glyph->avoid_cursor_p))
28956 {
28957 if (clear_mouse_face (hlinfo))
28958 cursor = No_Cursor;
28959 #ifdef HAVE_WINDOW_SYSTEM
28960 if (FRAME_WINDOW_P (f) && NILP (pointer))
28961 {
28962 if (area != TEXT_AREA)
28963 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28964 else
28965 pointer = Vvoid_text_area_pointer;
28966 }
28967 #endif
28968 goto set_cursor;
28969 }
28970
28971 pos = glyph->charpos;
28972 object = glyph->object;
28973 if (!STRINGP (object) && !BUFFERP (object))
28974 goto set_cursor;
28975
28976 /* If we get an out-of-range value, return now; avoid an error. */
28977 if (BUFFERP (object) && pos > BUF_Z (b))
28978 goto set_cursor;
28979
28980 /* Make the window's buffer temporarily current for
28981 overlays_at and compute_char_face. */
28982 obuf = current_buffer;
28983 current_buffer = b;
28984 obegv = BEGV;
28985 ozv = ZV;
28986 BEGV = BEG;
28987 ZV = Z;
28988
28989 /* Is this char mouse-active or does it have help-echo? */
28990 position = make_number (pos);
28991
28992 if (BUFFERP (object))
28993 {
28994 /* Put all the overlays we want in a vector in overlay_vec. */
28995 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, 0);
28996 /* Sort overlays into increasing priority order. */
28997 noverlays = sort_overlays (overlay_vec, noverlays, w);
28998 }
28999 else
29000 noverlays = 0;
29001
29002 if (NILP (Vmouse_highlight))
29003 {
29004 clear_mouse_face (hlinfo);
29005 goto check_help_echo;
29006 }
29007
29008 same_region = coords_in_mouse_face_p (w, hpos, vpos);
29009
29010 if (same_region)
29011 cursor = No_Cursor;
29012
29013 /* Check mouse-face highlighting. */
29014 if (! same_region
29015 /* If there exists an overlay with mouse-face overlapping
29016 the one we are currently highlighting, we have to
29017 check if we enter the overlapping overlay, and then
29018 highlight only that. */
29019 || (OVERLAYP (hlinfo->mouse_face_overlay)
29020 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
29021 {
29022 /* Find the highest priority overlay with a mouse-face. */
29023 Lisp_Object overlay = Qnil;
29024 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
29025 {
29026 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
29027 if (!NILP (mouse_face))
29028 overlay = overlay_vec[i];
29029 }
29030
29031 /* If we're highlighting the same overlay as before, there's
29032 no need to do that again. */
29033 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
29034 goto check_help_echo;
29035 hlinfo->mouse_face_overlay = overlay;
29036
29037 /* Clear the display of the old active region, if any. */
29038 if (clear_mouse_face (hlinfo))
29039 cursor = No_Cursor;
29040
29041 /* If no overlay applies, get a text property. */
29042 if (NILP (overlay))
29043 mouse_face = Fget_text_property (position, Qmouse_face, object);
29044
29045 /* Next, compute the bounds of the mouse highlighting and
29046 display it. */
29047 if (!NILP (mouse_face) && STRINGP (object))
29048 {
29049 /* The mouse-highlighting comes from a display string
29050 with a mouse-face. */
29051 Lisp_Object s, e;
29052 ptrdiff_t ignore;
29053
29054 s = Fprevious_single_property_change
29055 (make_number (pos + 1), Qmouse_face, object, Qnil);
29056 e = Fnext_single_property_change
29057 (position, Qmouse_face, object, Qnil);
29058 if (NILP (s))
29059 s = make_number (0);
29060 if (NILP (e))
29061 e = make_number (SCHARS (object));
29062 mouse_face_from_string_pos (w, hlinfo, object,
29063 XINT (s), XINT (e));
29064 hlinfo->mouse_face_past_end = 0;
29065 hlinfo->mouse_face_window = window;
29066 hlinfo->mouse_face_face_id
29067 = face_at_string_position (w, object, pos, 0, &ignore,
29068 glyph->face_id, 1);
29069 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29070 cursor = No_Cursor;
29071 }
29072 else
29073 {
29074 /* The mouse-highlighting, if any, comes from an overlay
29075 or text property in the buffer. */
29076 Lisp_Object buffer IF_LINT (= Qnil);
29077 Lisp_Object disp_string IF_LINT (= Qnil);
29078
29079 if (STRINGP (object))
29080 {
29081 /* If we are on a display string with no mouse-face,
29082 check if the text under it has one. */
29083 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
29084 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29085 pos = string_buffer_position (object, start);
29086 if (pos > 0)
29087 {
29088 mouse_face = get_char_property_and_overlay
29089 (make_number (pos), Qmouse_face, w->contents, &overlay);
29090 buffer = w->contents;
29091 disp_string = object;
29092 }
29093 }
29094 else
29095 {
29096 buffer = object;
29097 disp_string = Qnil;
29098 }
29099
29100 if (!NILP (mouse_face))
29101 {
29102 Lisp_Object before, after;
29103 Lisp_Object before_string, after_string;
29104 /* To correctly find the limits of mouse highlight
29105 in a bidi-reordered buffer, we must not use the
29106 optimization of limiting the search in
29107 previous-single-property-change and
29108 next-single-property-change, because
29109 rows_from_pos_range needs the real start and end
29110 positions to DTRT in this case. That's because
29111 the first row visible in a window does not
29112 necessarily display the character whose position
29113 is the smallest. */
29114 Lisp_Object lim1
29115 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29116 ? Fmarker_position (w->start)
29117 : Qnil;
29118 Lisp_Object lim2
29119 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29120 ? make_number (BUF_Z (XBUFFER (buffer))
29121 - w->window_end_pos)
29122 : Qnil;
29123
29124 if (NILP (overlay))
29125 {
29126 /* Handle the text property case. */
29127 before = Fprevious_single_property_change
29128 (make_number (pos + 1), Qmouse_face, buffer, lim1);
29129 after = Fnext_single_property_change
29130 (make_number (pos), Qmouse_face, buffer, lim2);
29131 before_string = after_string = Qnil;
29132 }
29133 else
29134 {
29135 /* Handle the overlay case. */
29136 before = Foverlay_start (overlay);
29137 after = Foverlay_end (overlay);
29138 before_string = Foverlay_get (overlay, Qbefore_string);
29139 after_string = Foverlay_get (overlay, Qafter_string);
29140
29141 if (!STRINGP (before_string)) before_string = Qnil;
29142 if (!STRINGP (after_string)) after_string = Qnil;
29143 }
29144
29145 mouse_face_from_buffer_pos (window, hlinfo, pos,
29146 NILP (before)
29147 ? 1
29148 : XFASTINT (before),
29149 NILP (after)
29150 ? BUF_Z (XBUFFER (buffer))
29151 : XFASTINT (after),
29152 before_string, after_string,
29153 disp_string);
29154 cursor = No_Cursor;
29155 }
29156 }
29157 }
29158
29159 check_help_echo:
29160
29161 /* Look for a `help-echo' property. */
29162 if (NILP (help_echo_string)) {
29163 Lisp_Object help, overlay;
29164
29165 /* Check overlays first. */
29166 help = overlay = Qnil;
29167 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
29168 {
29169 overlay = overlay_vec[i];
29170 help = Foverlay_get (overlay, Qhelp_echo);
29171 }
29172
29173 if (!NILP (help))
29174 {
29175 help_echo_string = help;
29176 help_echo_window = window;
29177 help_echo_object = overlay;
29178 help_echo_pos = pos;
29179 }
29180 else
29181 {
29182 Lisp_Object obj = glyph->object;
29183 ptrdiff_t charpos = glyph->charpos;
29184
29185 /* Try text properties. */
29186 if (STRINGP (obj)
29187 && charpos >= 0
29188 && charpos < SCHARS (obj))
29189 {
29190 help = Fget_text_property (make_number (charpos),
29191 Qhelp_echo, obj);
29192 if (NILP (help))
29193 {
29194 /* If the string itself doesn't specify a help-echo,
29195 see if the buffer text ``under'' it does. */
29196 struct glyph_row *r
29197 = MATRIX_ROW (w->current_matrix, vpos);
29198 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29199 ptrdiff_t p = string_buffer_position (obj, start);
29200 if (p > 0)
29201 {
29202 help = Fget_char_property (make_number (p),
29203 Qhelp_echo, w->contents);
29204 if (!NILP (help))
29205 {
29206 charpos = p;
29207 obj = w->contents;
29208 }
29209 }
29210 }
29211 }
29212 else if (BUFFERP (obj)
29213 && charpos >= BEGV
29214 && charpos < ZV)
29215 help = Fget_text_property (make_number (charpos), Qhelp_echo,
29216 obj);
29217
29218 if (!NILP (help))
29219 {
29220 help_echo_string = help;
29221 help_echo_window = window;
29222 help_echo_object = obj;
29223 help_echo_pos = charpos;
29224 }
29225 }
29226 }
29227
29228 #ifdef HAVE_WINDOW_SYSTEM
29229 /* Look for a `pointer' property. */
29230 if (FRAME_WINDOW_P (f) && NILP (pointer))
29231 {
29232 /* Check overlays first. */
29233 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
29234 pointer = Foverlay_get (overlay_vec[i], Qpointer);
29235
29236 if (NILP (pointer))
29237 {
29238 Lisp_Object obj = glyph->object;
29239 ptrdiff_t charpos = glyph->charpos;
29240
29241 /* Try text properties. */
29242 if (STRINGP (obj)
29243 && charpos >= 0
29244 && charpos < SCHARS (obj))
29245 {
29246 pointer = Fget_text_property (make_number (charpos),
29247 Qpointer, obj);
29248 if (NILP (pointer))
29249 {
29250 /* If the string itself doesn't specify a pointer,
29251 see if the buffer text ``under'' it does. */
29252 struct glyph_row *r
29253 = MATRIX_ROW (w->current_matrix, vpos);
29254 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29255 ptrdiff_t p = string_buffer_position (obj, start);
29256 if (p > 0)
29257 pointer = Fget_char_property (make_number (p),
29258 Qpointer, w->contents);
29259 }
29260 }
29261 else if (BUFFERP (obj)
29262 && charpos >= BEGV
29263 && charpos < ZV)
29264 pointer = Fget_text_property (make_number (charpos),
29265 Qpointer, obj);
29266 }
29267 }
29268 #endif /* HAVE_WINDOW_SYSTEM */
29269
29270 BEGV = obegv;
29271 ZV = ozv;
29272 current_buffer = obuf;
29273 }
29274
29275 set_cursor:
29276
29277 #ifdef HAVE_WINDOW_SYSTEM
29278 if (FRAME_WINDOW_P (f))
29279 define_frame_cursor1 (f, cursor, pointer);
29280 #else
29281 /* This is here to prevent a compiler error, about "label at end of
29282 compound statement". */
29283 return;
29284 #endif
29285 }
29286
29287
29288 /* EXPORT for RIF:
29289 Clear any mouse-face on window W. This function is part of the
29290 redisplay interface, and is called from try_window_id and similar
29291 functions to ensure the mouse-highlight is off. */
29292
29293 void
29294 x_clear_window_mouse_face (struct window *w)
29295 {
29296 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
29297 Lisp_Object window;
29298
29299 block_input ();
29300 XSETWINDOW (window, w);
29301 if (EQ (window, hlinfo->mouse_face_window))
29302 clear_mouse_face (hlinfo);
29303 unblock_input ();
29304 }
29305
29306
29307 /* EXPORT:
29308 Just discard the mouse face information for frame F, if any.
29309 This is used when the size of F is changed. */
29310
29311 void
29312 cancel_mouse_face (struct frame *f)
29313 {
29314 Lisp_Object window;
29315 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29316
29317 window = hlinfo->mouse_face_window;
29318 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
29319 reset_mouse_highlight (hlinfo);
29320 }
29321
29322
29323 \f
29324 /***********************************************************************
29325 Exposure Events
29326 ***********************************************************************/
29327
29328 #ifdef HAVE_WINDOW_SYSTEM
29329
29330 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29331 which intersects rectangle R. R is in window-relative coordinates. */
29332
29333 static void
29334 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
29335 enum glyph_row_area area)
29336 {
29337 struct glyph *first = row->glyphs[area];
29338 struct glyph *end = row->glyphs[area] + row->used[area];
29339 struct glyph *last;
29340 int first_x, start_x, x;
29341
29342 if (area == TEXT_AREA && row->fill_line_p)
29343 /* If row extends face to end of line write the whole line. */
29344 draw_glyphs (w, 0, row, area,
29345 0, row->used[area],
29346 DRAW_NORMAL_TEXT, 0);
29347 else
29348 {
29349 /* Set START_X to the window-relative start position for drawing glyphs of
29350 AREA. The first glyph of the text area can be partially visible.
29351 The first glyphs of other areas cannot. */
29352 start_x = window_box_left_offset (w, area);
29353 x = start_x;
29354 if (area == TEXT_AREA)
29355 x += row->x;
29356
29357 /* Find the first glyph that must be redrawn. */
29358 while (first < end
29359 && x + first->pixel_width < r->x)
29360 {
29361 x += first->pixel_width;
29362 ++first;
29363 }
29364
29365 /* Find the last one. */
29366 last = first;
29367 first_x = x;
29368 while (last < end
29369 && x < r->x + r->width)
29370 {
29371 x += last->pixel_width;
29372 ++last;
29373 }
29374
29375 /* Repaint. */
29376 if (last > first)
29377 draw_glyphs (w, first_x - start_x, row, area,
29378 first - row->glyphs[area], last - row->glyphs[area],
29379 DRAW_NORMAL_TEXT, 0);
29380 }
29381 }
29382
29383
29384 /* Redraw the parts of the glyph row ROW on window W intersecting
29385 rectangle R. R is in window-relative coordinates. Value is
29386 non-zero if mouse-face was overwritten. */
29387
29388 static int
29389 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
29390 {
29391 eassert (row->enabled_p);
29392
29393 if (row->mode_line_p || w->pseudo_window_p)
29394 draw_glyphs (w, 0, row, TEXT_AREA,
29395 0, row->used[TEXT_AREA],
29396 DRAW_NORMAL_TEXT, 0);
29397 else
29398 {
29399 if (row->used[LEFT_MARGIN_AREA])
29400 expose_area (w, row, r, LEFT_MARGIN_AREA);
29401 if (row->used[TEXT_AREA])
29402 expose_area (w, row, r, TEXT_AREA);
29403 if (row->used[RIGHT_MARGIN_AREA])
29404 expose_area (w, row, r, RIGHT_MARGIN_AREA);
29405 draw_row_fringe_bitmaps (w, row);
29406 }
29407
29408 return row->mouse_face_p;
29409 }
29410
29411
29412 /* Redraw those parts of glyphs rows during expose event handling that
29413 overlap other rows. Redrawing of an exposed line writes over parts
29414 of lines overlapping that exposed line; this function fixes that.
29415
29416 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29417 row in W's current matrix that is exposed and overlaps other rows.
29418 LAST_OVERLAPPING_ROW is the last such row. */
29419
29420 static void
29421 expose_overlaps (struct window *w,
29422 struct glyph_row *first_overlapping_row,
29423 struct glyph_row *last_overlapping_row,
29424 XRectangle *r)
29425 {
29426 struct glyph_row *row;
29427
29428 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
29429 if (row->overlapping_p)
29430 {
29431 eassert (row->enabled_p && !row->mode_line_p);
29432
29433 row->clip = r;
29434 if (row->used[LEFT_MARGIN_AREA])
29435 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
29436
29437 if (row->used[TEXT_AREA])
29438 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
29439
29440 if (row->used[RIGHT_MARGIN_AREA])
29441 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
29442 row->clip = NULL;
29443 }
29444 }
29445
29446
29447 /* Return non-zero if W's cursor intersects rectangle R. */
29448
29449 static int
29450 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
29451 {
29452 XRectangle cr, result;
29453 struct glyph *cursor_glyph;
29454 struct glyph_row *row;
29455
29456 if (w->phys_cursor.vpos >= 0
29457 && w->phys_cursor.vpos < w->current_matrix->nrows
29458 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
29459 row->enabled_p)
29460 && row->cursor_in_fringe_p)
29461 {
29462 /* Cursor is in the fringe. */
29463 cr.x = window_box_right_offset (w,
29464 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
29465 ? RIGHT_MARGIN_AREA
29466 : TEXT_AREA));
29467 cr.y = row->y;
29468 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
29469 cr.height = row->height;
29470 return x_intersect_rectangles (&cr, r, &result);
29471 }
29472
29473 cursor_glyph = get_phys_cursor_glyph (w);
29474 if (cursor_glyph)
29475 {
29476 /* r is relative to W's box, but w->phys_cursor.x is relative
29477 to left edge of W's TEXT area. Adjust it. */
29478 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
29479 cr.y = w->phys_cursor.y;
29480 cr.width = cursor_glyph->pixel_width;
29481 cr.height = w->phys_cursor_height;
29482 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29483 I assume the effect is the same -- and this is portable. */
29484 return x_intersect_rectangles (&cr, r, &result);
29485 }
29486 /* If we don't understand the format, pretend we're not in the hot-spot. */
29487 return 0;
29488 }
29489
29490
29491 /* EXPORT:
29492 Draw a vertical window border to the right of window W if W doesn't
29493 have vertical scroll bars. */
29494
29495 void
29496 x_draw_vertical_border (struct window *w)
29497 {
29498 struct frame *f = XFRAME (WINDOW_FRAME (w));
29499
29500 /* We could do better, if we knew what type of scroll-bar the adjacent
29501 windows (on either side) have... But we don't :-(
29502 However, I think this works ok. ++KFS 2003-04-25 */
29503
29504 /* Redraw borders between horizontally adjacent windows. Don't
29505 do it for frames with vertical scroll bars because either the
29506 right scroll bar of a window, or the left scroll bar of its
29507 neighbor will suffice as a border. */
29508 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
29509 return;
29510
29511 /* Note: It is necessary to redraw both the left and the right
29512 borders, for when only this single window W is being
29513 redisplayed. */
29514 if (!WINDOW_RIGHTMOST_P (w)
29515 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
29516 {
29517 int x0, x1, y0, y1;
29518
29519 window_box_edges (w, &x0, &y0, &x1, &y1);
29520 y1 -= 1;
29521
29522 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
29523 x1 -= 1;
29524
29525 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
29526 }
29527
29528 if (!WINDOW_LEFTMOST_P (w)
29529 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
29530 {
29531 int x0, x1, y0, y1;
29532
29533 window_box_edges (w, &x0, &y0, &x1, &y1);
29534 y1 -= 1;
29535
29536 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
29537 x0 -= 1;
29538
29539 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
29540 }
29541 }
29542
29543
29544 /* Draw window dividers for window W. */
29545
29546 void
29547 x_draw_right_divider (struct window *w)
29548 {
29549 struct frame *f = WINDOW_XFRAME (w);
29550
29551 if (w->mini || w->pseudo_window_p)
29552 return;
29553 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
29554 {
29555 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
29556 int x1 = WINDOW_RIGHT_EDGE_X (w);
29557 int y0 = WINDOW_TOP_EDGE_Y (w);
29558 /* The bottom divider prevails. */
29559 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
29560
29561 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
29562 }
29563 }
29564
29565 static void
29566 x_draw_bottom_divider (struct window *w)
29567 {
29568 struct frame *f = XFRAME (WINDOW_FRAME (w));
29569
29570 if (w->mini || w->pseudo_window_p)
29571 return;
29572 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
29573 {
29574 int x0 = WINDOW_LEFT_EDGE_X (w);
29575 int x1 = WINDOW_RIGHT_EDGE_X (w);
29576 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
29577 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
29578
29579 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
29580 }
29581 }
29582
29583 /* Redraw the part of window W intersection rectangle FR. Pixel
29584 coordinates in FR are frame-relative. Call this function with
29585 input blocked. Value is non-zero if the exposure overwrites
29586 mouse-face. */
29587
29588 static int
29589 expose_window (struct window *w, XRectangle *fr)
29590 {
29591 struct frame *f = XFRAME (w->frame);
29592 XRectangle wr, r;
29593 int mouse_face_overwritten_p = 0;
29594
29595 /* If window is not yet fully initialized, do nothing. This can
29596 happen when toolkit scroll bars are used and a window is split.
29597 Reconfiguring the scroll bar will generate an expose for a newly
29598 created window. */
29599 if (w->current_matrix == NULL)
29600 return 0;
29601
29602 /* When we're currently updating the window, display and current
29603 matrix usually don't agree. Arrange for a thorough display
29604 later. */
29605 if (w->must_be_updated_p)
29606 {
29607 SET_FRAME_GARBAGED (f);
29608 return 0;
29609 }
29610
29611 /* Frame-relative pixel rectangle of W. */
29612 wr.x = WINDOW_LEFT_EDGE_X (w);
29613 wr.y = WINDOW_TOP_EDGE_Y (w);
29614 wr.width = WINDOW_PIXEL_WIDTH (w);
29615 wr.height = WINDOW_PIXEL_HEIGHT (w);
29616
29617 if (x_intersect_rectangles (fr, &wr, &r))
29618 {
29619 int yb = window_text_bottom_y (w);
29620 struct glyph_row *row;
29621 int cursor_cleared_p, phys_cursor_on_p;
29622 struct glyph_row *first_overlapping_row, *last_overlapping_row;
29623
29624 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
29625 r.x, r.y, r.width, r.height));
29626
29627 /* Convert to window coordinates. */
29628 r.x -= WINDOW_LEFT_EDGE_X (w);
29629 r.y -= WINDOW_TOP_EDGE_Y (w);
29630
29631 /* Turn off the cursor. */
29632 if (!w->pseudo_window_p
29633 && phys_cursor_in_rect_p (w, &r))
29634 {
29635 x_clear_cursor (w);
29636 cursor_cleared_p = 1;
29637 }
29638 else
29639 cursor_cleared_p = 0;
29640
29641 /* If the row containing the cursor extends face to end of line,
29642 then expose_area might overwrite the cursor outside the
29643 rectangle and thus notice_overwritten_cursor might clear
29644 w->phys_cursor_on_p. We remember the original value and
29645 check later if it is changed. */
29646 phys_cursor_on_p = w->phys_cursor_on_p;
29647
29648 /* Update lines intersecting rectangle R. */
29649 first_overlapping_row = last_overlapping_row = NULL;
29650 for (row = w->current_matrix->rows;
29651 row->enabled_p;
29652 ++row)
29653 {
29654 int y0 = row->y;
29655 int y1 = MATRIX_ROW_BOTTOM_Y (row);
29656
29657 if ((y0 >= r.y && y0 < r.y + r.height)
29658 || (y1 > r.y && y1 < r.y + r.height)
29659 || (r.y >= y0 && r.y < y1)
29660 || (r.y + r.height > y0 && r.y + r.height < y1))
29661 {
29662 /* A header line may be overlapping, but there is no need
29663 to fix overlapping areas for them. KFS 2005-02-12 */
29664 if (row->overlapping_p && !row->mode_line_p)
29665 {
29666 if (first_overlapping_row == NULL)
29667 first_overlapping_row = row;
29668 last_overlapping_row = row;
29669 }
29670
29671 row->clip = fr;
29672 if (expose_line (w, row, &r))
29673 mouse_face_overwritten_p = 1;
29674 row->clip = NULL;
29675 }
29676 else if (row->overlapping_p)
29677 {
29678 /* We must redraw a row overlapping the exposed area. */
29679 if (y0 < r.y
29680 ? y0 + row->phys_height > r.y
29681 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
29682 {
29683 if (first_overlapping_row == NULL)
29684 first_overlapping_row = row;
29685 last_overlapping_row = row;
29686 }
29687 }
29688
29689 if (y1 >= yb)
29690 break;
29691 }
29692
29693 /* Display the mode line if there is one. */
29694 if (WINDOW_WANTS_MODELINE_P (w)
29695 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
29696 row->enabled_p)
29697 && row->y < r.y + r.height)
29698 {
29699 if (expose_line (w, row, &r))
29700 mouse_face_overwritten_p = 1;
29701 }
29702
29703 if (!w->pseudo_window_p)
29704 {
29705 /* Fix the display of overlapping rows. */
29706 if (first_overlapping_row)
29707 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
29708 fr);
29709
29710 /* Draw border between windows. */
29711 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
29712 x_draw_right_divider (w);
29713 else
29714 x_draw_vertical_border (w);
29715
29716 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
29717 x_draw_bottom_divider (w);
29718
29719 /* Turn the cursor on again. */
29720 if (cursor_cleared_p
29721 || (phys_cursor_on_p && !w->phys_cursor_on_p))
29722 update_window_cursor (w, 1);
29723 }
29724 }
29725
29726 return mouse_face_overwritten_p;
29727 }
29728
29729
29730
29731 /* Redraw (parts) of all windows in the window tree rooted at W that
29732 intersect R. R contains frame pixel coordinates. Value is
29733 non-zero if the exposure overwrites mouse-face. */
29734
29735 static int
29736 expose_window_tree (struct window *w, XRectangle *r)
29737 {
29738 struct frame *f = XFRAME (w->frame);
29739 int mouse_face_overwritten_p = 0;
29740
29741 while (w && !FRAME_GARBAGED_P (f))
29742 {
29743 if (WINDOWP (w->contents))
29744 mouse_face_overwritten_p
29745 |= expose_window_tree (XWINDOW (w->contents), r);
29746 else
29747 mouse_face_overwritten_p |= expose_window (w, r);
29748
29749 w = NILP (w->next) ? NULL : XWINDOW (w->next);
29750 }
29751
29752 return mouse_face_overwritten_p;
29753 }
29754
29755
29756 /* EXPORT:
29757 Redisplay an exposed area of frame F. X and Y are the upper-left
29758 corner of the exposed rectangle. W and H are width and height of
29759 the exposed area. All are pixel values. W or H zero means redraw
29760 the entire frame. */
29761
29762 void
29763 expose_frame (struct frame *f, int x, int y, int w, int h)
29764 {
29765 XRectangle r;
29766 int mouse_face_overwritten_p = 0;
29767
29768 TRACE ((stderr, "expose_frame "));
29769
29770 /* No need to redraw if frame will be redrawn soon. */
29771 if (FRAME_GARBAGED_P (f))
29772 {
29773 TRACE ((stderr, " garbaged\n"));
29774 return;
29775 }
29776
29777 /* If basic faces haven't been realized yet, there is no point in
29778 trying to redraw anything. This can happen when we get an expose
29779 event while Emacs is starting, e.g. by moving another window. */
29780 if (FRAME_FACE_CACHE (f) == NULL
29781 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
29782 {
29783 TRACE ((stderr, " no faces\n"));
29784 return;
29785 }
29786
29787 if (w == 0 || h == 0)
29788 {
29789 r.x = r.y = 0;
29790 r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f);
29791 r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f);
29792 }
29793 else
29794 {
29795 r.x = x;
29796 r.y = y;
29797 r.width = w;
29798 r.height = h;
29799 }
29800
29801 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
29802 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
29803
29804 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29805 if (WINDOWP (f->tool_bar_window))
29806 mouse_face_overwritten_p
29807 |= expose_window (XWINDOW (f->tool_bar_window), &r);
29808 #endif
29809
29810 #ifdef HAVE_X_WINDOWS
29811 #ifndef MSDOS
29812 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29813 if (WINDOWP (f->menu_bar_window))
29814 mouse_face_overwritten_p
29815 |= expose_window (XWINDOW (f->menu_bar_window), &r);
29816 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29817 #endif
29818 #endif
29819
29820 /* Some window managers support a focus-follows-mouse style with
29821 delayed raising of frames. Imagine a partially obscured frame,
29822 and moving the mouse into partially obscured mouse-face on that
29823 frame. The visible part of the mouse-face will be highlighted,
29824 then the WM raises the obscured frame. With at least one WM, KDE
29825 2.1, Emacs is not getting any event for the raising of the frame
29826 (even tried with SubstructureRedirectMask), only Expose events.
29827 These expose events will draw text normally, i.e. not
29828 highlighted. Which means we must redo the highlight here.
29829 Subsume it under ``we love X''. --gerd 2001-08-15 */
29830 /* Included in Windows version because Windows most likely does not
29831 do the right thing if any third party tool offers
29832 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29833 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
29834 {
29835 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29836 if (f == hlinfo->mouse_face_mouse_frame)
29837 {
29838 int mouse_x = hlinfo->mouse_face_mouse_x;
29839 int mouse_y = hlinfo->mouse_face_mouse_y;
29840 clear_mouse_face (hlinfo);
29841 note_mouse_highlight (f, mouse_x, mouse_y);
29842 }
29843 }
29844 }
29845
29846
29847 /* EXPORT:
29848 Determine the intersection of two rectangles R1 and R2. Return
29849 the intersection in *RESULT. Value is non-zero if RESULT is not
29850 empty. */
29851
29852 int
29853 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
29854 {
29855 XRectangle *left, *right;
29856 XRectangle *upper, *lower;
29857 int intersection_p = 0;
29858
29859 /* Rearrange so that R1 is the left-most rectangle. */
29860 if (r1->x < r2->x)
29861 left = r1, right = r2;
29862 else
29863 left = r2, right = r1;
29864
29865 /* X0 of the intersection is right.x0, if this is inside R1,
29866 otherwise there is no intersection. */
29867 if (right->x <= left->x + left->width)
29868 {
29869 result->x = right->x;
29870
29871 /* The right end of the intersection is the minimum of
29872 the right ends of left and right. */
29873 result->width = (min (left->x + left->width, right->x + right->width)
29874 - result->x);
29875
29876 /* Same game for Y. */
29877 if (r1->y < r2->y)
29878 upper = r1, lower = r2;
29879 else
29880 upper = r2, lower = r1;
29881
29882 /* The upper end of the intersection is lower.y0, if this is inside
29883 of upper. Otherwise, there is no intersection. */
29884 if (lower->y <= upper->y + upper->height)
29885 {
29886 result->y = lower->y;
29887
29888 /* The lower end of the intersection is the minimum of the lower
29889 ends of upper and lower. */
29890 result->height = (min (lower->y + lower->height,
29891 upper->y + upper->height)
29892 - result->y);
29893 intersection_p = 1;
29894 }
29895 }
29896
29897 return intersection_p;
29898 }
29899
29900 #endif /* HAVE_WINDOW_SYSTEM */
29901
29902 \f
29903 /***********************************************************************
29904 Initialization
29905 ***********************************************************************/
29906
29907 void
29908 syms_of_xdisp (void)
29909 {
29910 Vwith_echo_area_save_vector = Qnil;
29911 staticpro (&Vwith_echo_area_save_vector);
29912
29913 Vmessage_stack = Qnil;
29914 staticpro (&Vmessage_stack);
29915
29916 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
29917 DEFSYM (Qredisplay_internal, "redisplay_internal (C function)");
29918
29919 message_dolog_marker1 = Fmake_marker ();
29920 staticpro (&message_dolog_marker1);
29921 message_dolog_marker2 = Fmake_marker ();
29922 staticpro (&message_dolog_marker2);
29923 message_dolog_marker3 = Fmake_marker ();
29924 staticpro (&message_dolog_marker3);
29925
29926 #ifdef GLYPH_DEBUG
29927 defsubr (&Sdump_frame_glyph_matrix);
29928 defsubr (&Sdump_glyph_matrix);
29929 defsubr (&Sdump_glyph_row);
29930 defsubr (&Sdump_tool_bar_row);
29931 defsubr (&Strace_redisplay);
29932 defsubr (&Strace_to_stderr);
29933 #endif
29934 #ifdef HAVE_WINDOW_SYSTEM
29935 defsubr (&Stool_bar_height);
29936 defsubr (&Slookup_image_map);
29937 #endif
29938 defsubr (&Sline_pixel_height);
29939 defsubr (&Sformat_mode_line);
29940 defsubr (&Sinvisible_p);
29941 defsubr (&Scurrent_bidi_paragraph_direction);
29942 defsubr (&Swindow_text_pixel_size);
29943 defsubr (&Smove_point_visually);
29944
29945 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
29946 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
29947 DEFSYM (Qoverriding_local_map, "overriding-local-map");
29948 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
29949 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
29950 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
29951 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
29952 DEFSYM (Qeval, "eval");
29953 DEFSYM (QCdata, ":data");
29954 DEFSYM (Qdisplay, "display");
29955 DEFSYM (Qspace_width, "space-width");
29956 DEFSYM (Qraise, "raise");
29957 DEFSYM (Qslice, "slice");
29958 DEFSYM (Qspace, "space");
29959 DEFSYM (Qmargin, "margin");
29960 DEFSYM (Qpointer, "pointer");
29961 DEFSYM (Qleft_margin, "left-margin");
29962 DEFSYM (Qright_margin, "right-margin");
29963 DEFSYM (Qcenter, "center");
29964 DEFSYM (Qline_height, "line-height");
29965 DEFSYM (QCalign_to, ":align-to");
29966 DEFSYM (QCrelative_width, ":relative-width");
29967 DEFSYM (QCrelative_height, ":relative-height");
29968 DEFSYM (QCeval, ":eval");
29969 DEFSYM (QCpropertize, ":propertize");
29970 DEFSYM (QCfile, ":file");
29971 DEFSYM (Qfontified, "fontified");
29972 DEFSYM (Qfontification_functions, "fontification-functions");
29973 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
29974 DEFSYM (Qescape_glyph, "escape-glyph");
29975 DEFSYM (Qnobreak_space, "nobreak-space");
29976 DEFSYM (Qimage, "image");
29977 DEFSYM (Qtext, "text");
29978 DEFSYM (Qboth, "both");
29979 DEFSYM (Qboth_horiz, "both-horiz");
29980 DEFSYM (Qtext_image_horiz, "text-image-horiz");
29981 DEFSYM (QCmap, ":map");
29982 DEFSYM (QCpointer, ":pointer");
29983 DEFSYM (Qrect, "rect");
29984 DEFSYM (Qcircle, "circle");
29985 DEFSYM (Qpoly, "poly");
29986 DEFSYM (Qmessage_truncate_lines, "message-truncate-lines");
29987 DEFSYM (Qgrow_only, "grow-only");
29988 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
29989 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
29990 DEFSYM (Qposition, "position");
29991 DEFSYM (Qbuffer_position, "buffer-position");
29992 DEFSYM (Qobject, "object");
29993 DEFSYM (Qbar, "bar");
29994 DEFSYM (Qhbar, "hbar");
29995 DEFSYM (Qbox, "box");
29996 DEFSYM (Qhollow, "hollow");
29997 DEFSYM (Qhand, "hand");
29998 DEFSYM (Qarrow, "arrow");
29999 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
30000
30001 list_of_error = list1 (list2 (intern_c_string ("error"),
30002 intern_c_string ("void-variable")));
30003 staticpro (&list_of_error);
30004
30005 DEFSYM (Qlast_arrow_position, "last-arrow-position");
30006 DEFSYM (Qlast_arrow_string, "last-arrow-string");
30007 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
30008 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
30009
30010 echo_buffer[0] = echo_buffer[1] = Qnil;
30011 staticpro (&echo_buffer[0]);
30012 staticpro (&echo_buffer[1]);
30013
30014 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
30015 staticpro (&echo_area_buffer[0]);
30016 staticpro (&echo_area_buffer[1]);
30017
30018 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
30019 staticpro (&Vmessages_buffer_name);
30020
30021 mode_line_proptrans_alist = Qnil;
30022 staticpro (&mode_line_proptrans_alist);
30023 mode_line_string_list = Qnil;
30024 staticpro (&mode_line_string_list);
30025 mode_line_string_face = Qnil;
30026 staticpro (&mode_line_string_face);
30027 mode_line_string_face_prop = Qnil;
30028 staticpro (&mode_line_string_face_prop);
30029 Vmode_line_unwind_vector = Qnil;
30030 staticpro (&Vmode_line_unwind_vector);
30031
30032 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
30033
30034 help_echo_string = Qnil;
30035 staticpro (&help_echo_string);
30036 help_echo_object = Qnil;
30037 staticpro (&help_echo_object);
30038 help_echo_window = Qnil;
30039 staticpro (&help_echo_window);
30040 previous_help_echo_string = Qnil;
30041 staticpro (&previous_help_echo_string);
30042 help_echo_pos = -1;
30043
30044 DEFSYM (Qright_to_left, "right-to-left");
30045 DEFSYM (Qleft_to_right, "left-to-right");
30046
30047 #ifdef HAVE_WINDOW_SYSTEM
30048 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
30049 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
30050 For example, if a block cursor is over a tab, it will be drawn as
30051 wide as that tab on the display. */);
30052 x_stretch_cursor_p = 0;
30053 #endif
30054
30055 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
30056 doc: /* Non-nil means highlight trailing whitespace.
30057 The face used for trailing whitespace is `trailing-whitespace'. */);
30058 Vshow_trailing_whitespace = Qnil;
30059
30060 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
30061 doc: /* Control highlighting of non-ASCII space and hyphen chars.
30062 If the value is t, Emacs highlights non-ASCII chars which have the
30063 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30064 or `escape-glyph' face respectively.
30065
30066 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30067 U+2011 (non-breaking hyphen) are affected.
30068
30069 Any other non-nil value means to display these characters as a escape
30070 glyph followed by an ordinary space or hyphen.
30071
30072 A value of nil means no special handling of these characters. */);
30073 Vnobreak_char_display = Qt;
30074
30075 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
30076 doc: /* The pointer shape to show in void text areas.
30077 A value of nil means to show the text pointer. Other options are `arrow',
30078 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30079 Vvoid_text_area_pointer = Qarrow;
30080
30081 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
30082 doc: /* Non-nil means don't actually do any redisplay.
30083 This is used for internal purposes. */);
30084 Vinhibit_redisplay = Qnil;
30085
30086 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
30087 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30088 Vglobal_mode_string = Qnil;
30089
30090 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
30091 doc: /* Marker for where to display an arrow on top of the buffer text.
30092 This must be the beginning of a line in order to work.
30093 See also `overlay-arrow-string'. */);
30094 Voverlay_arrow_position = Qnil;
30095
30096 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
30097 doc: /* String to display as an arrow in non-window frames.
30098 See also `overlay-arrow-position'. */);
30099 Voverlay_arrow_string = build_pure_c_string ("=>");
30100
30101 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
30102 doc: /* List of variables (symbols) which hold markers for overlay arrows.
30103 The symbols on this list are examined during redisplay to determine
30104 where to display overlay arrows. */);
30105 Voverlay_arrow_variable_list
30106 = list1 (intern_c_string ("overlay-arrow-position"));
30107
30108 DEFVAR_INT ("scroll-step", emacs_scroll_step,
30109 doc: /* The number of lines to try scrolling a window by when point moves out.
30110 If that fails to bring point back on frame, point is centered instead.
30111 If this is zero, point is always centered after it moves off frame.
30112 If you want scrolling to always be a line at a time, you should set
30113 `scroll-conservatively' to a large value rather than set this to 1. */);
30114
30115 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
30116 doc: /* Scroll up to this many lines, to bring point back on screen.
30117 If point moves off-screen, redisplay will scroll by up to
30118 `scroll-conservatively' lines in order to bring point just barely
30119 onto the screen again. If that cannot be done, then redisplay
30120 recenters point as usual.
30121
30122 If the value is greater than 100, redisplay will never recenter point,
30123 but will always scroll just enough text to bring point into view, even
30124 if you move far away.
30125
30126 A value of zero means always recenter point if it moves off screen. */);
30127 scroll_conservatively = 0;
30128
30129 DEFVAR_INT ("scroll-margin", scroll_margin,
30130 doc: /* Number of lines of margin at the top and bottom of a window.
30131 Recenter the window whenever point gets within this many lines
30132 of the top or bottom of the window. */);
30133 scroll_margin = 0;
30134
30135 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
30136 doc: /* Pixels per inch value for non-window system displays.
30137 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30138 Vdisplay_pixels_per_inch = make_float (72.0);
30139
30140 #ifdef GLYPH_DEBUG
30141 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
30142 #endif
30143
30144 DEFVAR_LISP ("truncate-partial-width-windows",
30145 Vtruncate_partial_width_windows,
30146 doc: /* Non-nil means truncate lines in windows narrower than the frame.
30147 For an integer value, truncate lines in each window narrower than the
30148 full frame width, provided the window width is less than that integer;
30149 otherwise, respect the value of `truncate-lines'.
30150
30151 For any other non-nil value, truncate lines in all windows that do
30152 not span the full frame width.
30153
30154 A value of nil means to respect the value of `truncate-lines'.
30155
30156 If `word-wrap' is enabled, you might want to reduce this. */);
30157 Vtruncate_partial_width_windows = make_number (50);
30158
30159 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
30160 doc: /* Maximum buffer size for which line number should be displayed.
30161 If the buffer is bigger than this, the line number does not appear
30162 in the mode line. A value of nil means no limit. */);
30163 Vline_number_display_limit = Qnil;
30164
30165 DEFVAR_INT ("line-number-display-limit-width",
30166 line_number_display_limit_width,
30167 doc: /* Maximum line width (in characters) for line number display.
30168 If the average length of the lines near point is bigger than this, then the
30169 line number may be omitted from the mode line. */);
30170 line_number_display_limit_width = 200;
30171
30172 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
30173 doc: /* Non-nil means highlight region even in nonselected windows. */);
30174 highlight_nonselected_windows = 0;
30175
30176 DEFVAR_BOOL ("multiple-frames", multiple_frames,
30177 doc: /* Non-nil if more than one frame is visible on this display.
30178 Minibuffer-only frames don't count, but iconified frames do.
30179 This variable is not guaranteed to be accurate except while processing
30180 `frame-title-format' and `icon-title-format'. */);
30181
30182 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
30183 doc: /* Template for displaying the title bar of visible frames.
30184 \(Assuming the window manager supports this feature.)
30185
30186 This variable has the same structure as `mode-line-format', except that
30187 the %c and %l constructs are ignored. It is used only on frames for
30188 which no explicit name has been set \(see `modify-frame-parameters'). */);
30189
30190 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
30191 doc: /* Template for displaying the title bar of an iconified frame.
30192 \(Assuming the window manager supports this feature.)
30193 This variable has the same structure as `mode-line-format' (which see),
30194 and is used only on frames for which no explicit name has been set
30195 \(see `modify-frame-parameters'). */);
30196 Vicon_title_format
30197 = Vframe_title_format
30198 = listn (CONSTYPE_PURE, 3,
30199 intern_c_string ("multiple-frames"),
30200 build_pure_c_string ("%b"),
30201 listn (CONSTYPE_PURE, 4,
30202 empty_unibyte_string,
30203 intern_c_string ("invocation-name"),
30204 build_pure_c_string ("@"),
30205 intern_c_string ("system-name")));
30206
30207 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
30208 doc: /* Maximum number of lines to keep in the message log buffer.
30209 If nil, disable message logging. If t, log messages but don't truncate
30210 the buffer when it becomes large. */);
30211 Vmessage_log_max = make_number (1000);
30212
30213 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
30214 doc: /* Functions called before redisplay, if window sizes have changed.
30215 The value should be a list of functions that take one argument.
30216 Just before redisplay, for each frame, if any of its windows have changed
30217 size since the last redisplay, or have been split or deleted,
30218 all the functions in the list are called, with the frame as argument. */);
30219 Vwindow_size_change_functions = Qnil;
30220
30221 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
30222 doc: /* List of functions to call before redisplaying a window with scrolling.
30223 Each function is called with two arguments, the window and its new
30224 display-start position. Note that these functions are also called by
30225 `set-window-buffer'. Also note that the value of `window-end' is not
30226 valid when these functions are called.
30227
30228 Warning: Do not use this feature to alter the way the window
30229 is scrolled. It is not designed for that, and such use probably won't
30230 work. */);
30231 Vwindow_scroll_functions = Qnil;
30232
30233 DEFVAR_LISP ("window-text-change-functions",
30234 Vwindow_text_change_functions,
30235 doc: /* Functions to call in redisplay when text in the window might change. */);
30236 Vwindow_text_change_functions = Qnil;
30237
30238 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
30239 doc: /* Functions called when redisplay of a window reaches the end trigger.
30240 Each function is called with two arguments, the window and the end trigger value.
30241 See `set-window-redisplay-end-trigger'. */);
30242 Vredisplay_end_trigger_functions = Qnil;
30243
30244 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
30245 doc: /* Non-nil means autoselect window with mouse pointer.
30246 If nil, do not autoselect windows.
30247 A positive number means delay autoselection by that many seconds: a
30248 window is autoselected only after the mouse has remained in that
30249 window for the duration of the delay.
30250 A negative number has a similar effect, but causes windows to be
30251 autoselected only after the mouse has stopped moving. \(Because of
30252 the way Emacs compares mouse events, you will occasionally wait twice
30253 that time before the window gets selected.\)
30254 Any other value means to autoselect window instantaneously when the
30255 mouse pointer enters it.
30256
30257 Autoselection selects the minibuffer only if it is active, and never
30258 unselects the minibuffer if it is active.
30259
30260 When customizing this variable make sure that the actual value of
30261 `focus-follows-mouse' matches the behavior of your window manager. */);
30262 Vmouse_autoselect_window = Qnil;
30263
30264 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
30265 doc: /* Non-nil means automatically resize tool-bars.
30266 This dynamically changes the tool-bar's height to the minimum height
30267 that is needed to make all tool-bar items visible.
30268 If value is `grow-only', the tool-bar's height is only increased
30269 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30270 Vauto_resize_tool_bars = Qt;
30271
30272 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
30273 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30274 auto_raise_tool_bar_buttons_p = 1;
30275
30276 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
30277 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30278 make_cursor_line_fully_visible_p = 1;
30279
30280 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
30281 doc: /* Border below tool-bar in pixels.
30282 If an integer, use it as the height of the border.
30283 If it is one of `internal-border-width' or `border-width', use the
30284 value of the corresponding frame parameter.
30285 Otherwise, no border is added below the tool-bar. */);
30286 Vtool_bar_border = Qinternal_border_width;
30287
30288 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
30289 doc: /* Margin around tool-bar buttons in pixels.
30290 If an integer, use that for both horizontal and vertical margins.
30291 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30292 HORZ specifying the horizontal margin, and VERT specifying the
30293 vertical margin. */);
30294 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
30295
30296 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
30297 doc: /* Relief thickness of tool-bar buttons. */);
30298 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
30299
30300 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
30301 doc: /* Tool bar style to use.
30302 It can be one of
30303 image - show images only
30304 text - show text only
30305 both - show both, text below image
30306 both-horiz - show text to the right of the image
30307 text-image-horiz - show text to the left of the image
30308 any other - use system default or image if no system default.
30309
30310 This variable only affects the GTK+ toolkit version of Emacs. */);
30311 Vtool_bar_style = Qnil;
30312
30313 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
30314 doc: /* Maximum number of characters a label can have to be shown.
30315 The tool bar style must also show labels for this to have any effect, see
30316 `tool-bar-style'. */);
30317 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
30318
30319 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
30320 doc: /* List of functions to call to fontify regions of text.
30321 Each function is called with one argument POS. Functions must
30322 fontify a region starting at POS in the current buffer, and give
30323 fontified regions the property `fontified'. */);
30324 Vfontification_functions = Qnil;
30325 Fmake_variable_buffer_local (Qfontification_functions);
30326
30327 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30328 unibyte_display_via_language_environment,
30329 doc: /* Non-nil means display unibyte text according to language environment.
30330 Specifically, this means that raw bytes in the range 160-255 decimal
30331 are displayed by converting them to the equivalent multibyte characters
30332 according to the current language environment. As a result, they are
30333 displayed according to the current fontset.
30334
30335 Note that this variable affects only how these bytes are displayed,
30336 but does not change the fact they are interpreted as raw bytes. */);
30337 unibyte_display_via_language_environment = 0;
30338
30339 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
30340 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30341 If a float, it specifies a fraction of the mini-window frame's height.
30342 If an integer, it specifies a number of lines. */);
30343 Vmax_mini_window_height = make_float (0.25);
30344
30345 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
30346 doc: /* How to resize mini-windows (the minibuffer and the echo area).
30347 A value of nil means don't automatically resize mini-windows.
30348 A value of t means resize them to fit the text displayed in them.
30349 A value of `grow-only', the default, means let mini-windows grow only;
30350 they return to their normal size when the minibuffer is closed, or the
30351 echo area becomes empty. */);
30352 Vresize_mini_windows = Qgrow_only;
30353
30354 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
30355 doc: /* Alist specifying how to blink the cursor off.
30356 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30357 `cursor-type' frame-parameter or variable equals ON-STATE,
30358 comparing using `equal', Emacs uses OFF-STATE to specify
30359 how to blink it off. ON-STATE and OFF-STATE are values for
30360 the `cursor-type' frame parameter.
30361
30362 If a frame's ON-STATE has no entry in this list,
30363 the frame's other specifications determine how to blink the cursor off. */);
30364 Vblink_cursor_alist = Qnil;
30365
30366 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
30367 doc: /* Allow or disallow automatic horizontal scrolling of windows.
30368 If non-nil, windows are automatically scrolled horizontally to make
30369 point visible. */);
30370 automatic_hscrolling_p = 1;
30371 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
30372
30373 DEFVAR_INT ("hscroll-margin", hscroll_margin,
30374 doc: /* How many columns away from the window edge point is allowed to get
30375 before automatic hscrolling will horizontally scroll the window. */);
30376 hscroll_margin = 5;
30377
30378 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
30379 doc: /* How many columns to scroll the window when point gets too close to the edge.
30380 When point is less than `hscroll-margin' columns from the window
30381 edge, automatic hscrolling will scroll the window by the amount of columns
30382 determined by this variable. If its value is a positive integer, scroll that
30383 many columns. If it's a positive floating-point number, it specifies the
30384 fraction of the window's width to scroll. If it's nil or zero, point will be
30385 centered horizontally after the scroll. Any other value, including negative
30386 numbers, are treated as if the value were zero.
30387
30388 Automatic hscrolling always moves point outside the scroll margin, so if
30389 point was more than scroll step columns inside the margin, the window will
30390 scroll more than the value given by the scroll step.
30391
30392 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30393 and `scroll-right' overrides this variable's effect. */);
30394 Vhscroll_step = make_number (0);
30395
30396 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
30397 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
30398 Bind this around calls to `message' to let it take effect. */);
30399 message_truncate_lines = 0;
30400
30401 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
30402 doc: /* Normal hook run to update the menu bar definitions.
30403 Redisplay runs this hook before it redisplays the menu bar.
30404 This is used to update menus such as Buffers, whose contents depend on
30405 various data. */);
30406 Vmenu_bar_update_hook = Qnil;
30407
30408 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
30409 doc: /* Frame for which we are updating a menu.
30410 The enable predicate for a menu binding should check this variable. */);
30411 Vmenu_updating_frame = Qnil;
30412
30413 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
30414 doc: /* Non-nil means don't update menu bars. Internal use only. */);
30415 inhibit_menubar_update = 0;
30416
30417 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
30418 doc: /* Prefix prepended to all continuation lines at display time.
30419 The value may be a string, an image, or a stretch-glyph; it is
30420 interpreted in the same way as the value of a `display' text property.
30421
30422 This variable is overridden by any `wrap-prefix' text or overlay
30423 property.
30424
30425 To add a prefix to non-continuation lines, use `line-prefix'. */);
30426 Vwrap_prefix = Qnil;
30427 DEFSYM (Qwrap_prefix, "wrap-prefix");
30428 Fmake_variable_buffer_local (Qwrap_prefix);
30429
30430 DEFVAR_LISP ("line-prefix", Vline_prefix,
30431 doc: /* Prefix prepended to all non-continuation lines at display time.
30432 The value may be a string, an image, or a stretch-glyph; it is
30433 interpreted in the same way as the value of a `display' text property.
30434
30435 This variable is overridden by any `line-prefix' text or overlay
30436 property.
30437
30438 To add a prefix to continuation lines, use `wrap-prefix'. */);
30439 Vline_prefix = Qnil;
30440 DEFSYM (Qline_prefix, "line-prefix");
30441 Fmake_variable_buffer_local (Qline_prefix);
30442
30443 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
30444 doc: /* Non-nil means don't eval Lisp during redisplay. */);
30445 inhibit_eval_during_redisplay = 0;
30446
30447 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
30448 doc: /* Non-nil means don't free realized faces. Internal use only. */);
30449 inhibit_free_realized_faces = 0;
30450
30451 #ifdef GLYPH_DEBUG
30452 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
30453 doc: /* Inhibit try_window_id display optimization. */);
30454 inhibit_try_window_id = 0;
30455
30456 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
30457 doc: /* Inhibit try_window_reusing display optimization. */);
30458 inhibit_try_window_reusing = 0;
30459
30460 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
30461 doc: /* Inhibit try_cursor_movement display optimization. */);
30462 inhibit_try_cursor_movement = 0;
30463 #endif /* GLYPH_DEBUG */
30464
30465 DEFVAR_INT ("overline-margin", overline_margin,
30466 doc: /* Space between overline and text, in pixels.
30467 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30468 margin to the character height. */);
30469 overline_margin = 2;
30470
30471 DEFVAR_INT ("underline-minimum-offset",
30472 underline_minimum_offset,
30473 doc: /* Minimum distance between baseline and underline.
30474 This can improve legibility of underlined text at small font sizes,
30475 particularly when using variable `x-use-underline-position-properties'
30476 with fonts that specify an UNDERLINE_POSITION relatively close to the
30477 baseline. The default value is 1. */);
30478 underline_minimum_offset = 1;
30479
30480 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
30481 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30482 This feature only works when on a window system that can change
30483 cursor shapes. */);
30484 display_hourglass_p = 1;
30485
30486 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
30487 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30488 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
30489
30490 #ifdef HAVE_WINDOW_SYSTEM
30491 hourglass_atimer = NULL;
30492 hourglass_shown_p = 0;
30493 #endif /* HAVE_WINDOW_SYSTEM */
30494
30495 DEFSYM (Qglyphless_char, "glyphless-char");
30496 DEFSYM (Qhex_code, "hex-code");
30497 DEFSYM (Qempty_box, "empty-box");
30498 DEFSYM (Qthin_space, "thin-space");
30499 DEFSYM (Qzero_width, "zero-width");
30500
30501 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
30502 doc: /* Function run just before redisplay.
30503 It is called with one argument, which is the set of windows that are to
30504 be redisplayed. This set can be nil (meaning, only the selected window),
30505 or t (meaning all windows). */);
30506 Vpre_redisplay_function = intern ("ignore");
30507
30508 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
30509 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
30510
30511 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
30512 doc: /* Char-table defining glyphless characters.
30513 Each element, if non-nil, should be one of the following:
30514 an ASCII acronym string: display this string in a box
30515 `hex-code': display the hexadecimal code of a character in a box
30516 `empty-box': display as an empty box
30517 `thin-space': display as 1-pixel width space
30518 `zero-width': don't display
30519 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30520 display method for graphical terminals and text terminals respectively.
30521 GRAPHICAL and TEXT should each have one of the values listed above.
30522
30523 The char-table has one extra slot to control the display of a character for
30524 which no font is found. This slot only takes effect on graphical terminals.
30525 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30526 `thin-space'. The default is `empty-box'.
30527
30528 If a character has a non-nil entry in an active display table, the
30529 display table takes effect; in this case, Emacs does not consult
30530 `glyphless-char-display' at all. */);
30531 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
30532 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
30533 Qempty_box);
30534
30535 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
30536 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
30537 Vdebug_on_message = Qnil;
30538
30539 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
30540 doc: /* */);
30541 Vredisplay__all_windows_cause
30542 = Fmake_vector (make_number (100), make_number (0));
30543
30544 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
30545 doc: /* */);
30546 Vredisplay__mode_lines_cause
30547 = Fmake_vector (make_number (100), make_number (0));
30548 }
30549
30550
30551 /* Initialize this module when Emacs starts. */
30552
30553 void
30554 init_xdisp (void)
30555 {
30556 CHARPOS (this_line_start_pos) = 0;
30557
30558 if (!noninteractive)
30559 {
30560 struct window *m = XWINDOW (minibuf_window);
30561 Lisp_Object frame = m->frame;
30562 struct frame *f = XFRAME (frame);
30563 Lisp_Object root = FRAME_ROOT_WINDOW (f);
30564 struct window *r = XWINDOW (root);
30565 int i;
30566
30567 echo_area_window = minibuf_window;
30568
30569 r->top_line = FRAME_TOP_MARGIN (f);
30570 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
30571 r->total_cols = FRAME_COLS (f);
30572 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
30573 r->total_lines = FRAME_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
30574 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
30575
30576 m->top_line = FRAME_LINES (f) - 1;
30577 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
30578 m->total_cols = FRAME_COLS (f);
30579 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
30580 m->total_lines = 1;
30581 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
30582
30583 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
30584 scratch_glyph_row.glyphs[TEXT_AREA + 1]
30585 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
30586
30587 /* The default ellipsis glyphs `...'. */
30588 for (i = 0; i < 3; ++i)
30589 default_invis_vector[i] = make_number ('.');
30590 }
30591
30592 {
30593 /* Allocate the buffer for frame titles.
30594 Also used for `format-mode-line'. */
30595 int size = 100;
30596 mode_line_noprop_buf = xmalloc (size);
30597 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
30598 mode_line_noprop_ptr = mode_line_noprop_buf;
30599 mode_line_target = MODE_LINE_DISPLAY;
30600 }
30601
30602 help_echo_showing_p = 0;
30603 }
30604
30605 #ifdef HAVE_WINDOW_SYSTEM
30606
30607 /* Platform-independent portion of hourglass implementation. */
30608
30609 /* Cancel a currently active hourglass timer, and start a new one. */
30610 void
30611 start_hourglass (void)
30612 {
30613 struct timespec delay;
30614
30615 cancel_hourglass ();
30616
30617 if (INTEGERP (Vhourglass_delay)
30618 && XINT (Vhourglass_delay) > 0)
30619 delay = make_timespec (min (XINT (Vhourglass_delay),
30620 TYPE_MAXIMUM (time_t)),
30621 0);
30622 else if (FLOATP (Vhourglass_delay)
30623 && XFLOAT_DATA (Vhourglass_delay) > 0)
30624 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
30625 else
30626 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
30627
30628 #ifdef HAVE_NTGUI
30629 {
30630 extern void w32_note_current_window (void);
30631 w32_note_current_window ();
30632 }
30633 #endif /* HAVE_NTGUI */
30634
30635 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
30636 show_hourglass, NULL);
30637 }
30638
30639
30640 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30641 shown. */
30642 void
30643 cancel_hourglass (void)
30644 {
30645 if (hourglass_atimer)
30646 {
30647 cancel_atimer (hourglass_atimer);
30648 hourglass_atimer = NULL;
30649 }
30650
30651 if (hourglass_shown_p)
30652 hide_hourglass ();
30653 }
30654
30655 #endif /* HAVE_WINDOW_SYSTEM */