shr typo fix from recent check-in
[emacs.git] / src / xdisp.c
blob2cdbade3062a6843644004a417f8d901a498a7f6
1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
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.
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.
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/>. */
21 /* New redisplay written by Gerd Moellmann <gerd@gnu.org>.
23 Redisplay.
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.
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.
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.
46 +--------------+ redisplay +----------------+
47 | Lisp machine |---------------->| Redisplay code |<--+
48 +--------------+ (xdisp.c) +----------------+ |
49 ^ | |
50 +----------------------------------+ |
51 Don't use this path when called |
52 asynchronously! |
54 expose_window (asynchronous) |
56 X expose events -----+
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.
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.
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.
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:
85 . try_cursor_movement
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.
91 . try_window_reusing_current_matrix
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).
97 . try_window_id
99 This function attempts to redisplay a window by reusing parts of
100 its existing display. It finds and reuses the part that was not
101 changed, and redraws the rest. (The "id" part in the function's
102 name stands for "insert/delete", not for "identification" or
103 somesuch.)
105 . try_window
107 This function performs the full redisplay of a single window
108 assuming that its fonts were not changed and that the cursor
109 will not end up in the scroll margins. (Loading fonts requires
110 re-adjustment of dimensions of glyph matrices, which makes this
111 method impossible to use.)
113 These optimizations are tried in sequence (some can be skipped if
114 it is known that they are not applicable). If none of the
115 optimizations were successful, redisplay calls redisplay_windows,
116 which performs a full redisplay of all windows.
118 Note that there's one more important optimization up Emacs's
119 sleeve, but it is related to actually redrawing the potentially
120 changed portions of the window/frame, not to reproducing the
121 desired matrices of those potentially changed portions. Namely,
122 the function update_frame and its subroutines, which you will find
123 in dispnew.c, compare the desired matrices with the current
124 matrices, and only redraw the portions that changed. So it could
125 happen that the functions in this file for some reason decide that
126 the entire desired matrix needs to be regenerated from scratch, and
127 still only parts of the Emacs display, or even nothing at all, will
128 be actually delivered to the glass, because update_frame has found
129 that the new and the old screen contents are similar or identical.
131 Desired matrices.
133 Desired matrices are always built per Emacs window. The function
134 `display_line' is the central function to look at if you are
135 interested. It constructs one row in a desired matrix given an
136 iterator structure containing both a buffer position and a
137 description of the environment in which the text is to be
138 displayed. But this is too early, read on.
140 Characters and pixmaps displayed for a range of buffer text depend
141 on various settings of buffers and windows, on overlays and text
142 properties, on display tables, on selective display. The good news
143 is that all this hairy stuff is hidden behind a small set of
144 interface functions taking an iterator structure (struct it)
145 argument.
147 Iteration over things to be displayed is then simple. It is
148 started by initializing an iterator with a call to init_iterator,
149 passing it the buffer position where to start iteration. For
150 iteration over strings, pass -1 as the position to init_iterator,
151 and call reseat_to_string when the string is ready, to initialize
152 the iterator for that string. Thereafter, calls to
153 get_next_display_element fill the iterator structure with relevant
154 information about the next thing to display. Calls to
155 set_iterator_to_next move the iterator to the next thing.
157 Besides this, an iterator also contains information about the
158 display environment in which glyphs for display elements are to be
159 produced. It has fields for the width and height of the display,
160 the information whether long lines are truncated or continued, a
161 current X and Y position, and lots of other stuff you can better
162 see in dispextern.h.
164 Glyphs in a desired matrix are normally constructed in a loop
165 calling get_next_display_element and then PRODUCE_GLYPHS. The call
166 to PRODUCE_GLYPHS will fill the iterator structure with pixel
167 information about the element being displayed and at the same time
168 produce glyphs for it. If the display element fits on the line
169 being displayed, set_iterator_to_next is called next, otherwise the
170 glyphs produced are discarded. The function display_line is the
171 workhorse of filling glyph rows in the desired matrix with glyphs.
172 In addition to producing glyphs, it also handles line truncation
173 and continuation, word wrap, and cursor positioning (for the
174 latter, see also set_cursor_from_row).
176 Frame matrices.
178 That just couldn't be all, could it? What about terminal types not
179 supporting operations on sub-windows of the screen? To update the
180 display on such a terminal, window-based glyph matrices are not
181 well suited. To be able to reuse part of the display (scrolling
182 lines up and down), we must instead have a view of the whole
183 screen. This is what `frame matrices' are for. They are a trick.
185 Frames on terminals like above have a glyph pool. Windows on such
186 a frame sub-allocate their glyph memory from their frame's glyph
187 pool. The frame itself is given its own glyph matrices. By
188 coincidence---or maybe something else---rows in window glyph
189 matrices are slices of corresponding rows in frame matrices. Thus
190 writing to window matrices implicitly updates a frame matrix which
191 provides us with the view of the whole screen that we originally
192 wanted to have without having to move many bytes around. To be
193 honest, there is a little bit more done, but not much more. If you
194 plan to extend that code, take a look at dispnew.c. The function
195 build_frame_matrix is a good starting point.
197 Bidirectional display.
199 Bidirectional display adds quite some hair to this already complex
200 design. The good news are that a large portion of that hairy stuff
201 is hidden in bidi.c behind only 3 interfaces. bidi.c implements a
202 reordering engine which is called by set_iterator_to_next and
203 returns the next character to display in the visual order. See
204 commentary on bidi.c for more details. As far as redisplay is
205 concerned, the effect of calling bidi_move_to_visually_next, the
206 main interface of the reordering engine, is that the iterator gets
207 magically placed on the buffer or string position that is to be
208 displayed next. In other words, a linear iteration through the
209 buffer/string is replaced with a non-linear one. All the rest of
210 the redisplay is oblivious to the bidi reordering.
212 Well, almost oblivious---there are still complications, most of
213 them due to the fact that buffer and string positions no longer
214 change monotonously with glyph indices in a glyph row. Moreover,
215 for continued lines, the buffer positions may not even be
216 monotonously changing with vertical positions. Also, accounting
217 for face changes, overlays, etc. becomes more complex because
218 non-linear iteration could potentially skip many positions with
219 changes, and then cross them again on the way back...
221 One other prominent effect of bidirectional display is that some
222 paragraphs of text need to be displayed starting at the right
223 margin of the window---the so-called right-to-left, or R2L
224 paragraphs. R2L paragraphs are displayed with R2L glyph rows,
225 which have their reversed_p flag set. The bidi reordering engine
226 produces characters in such rows starting from the character which
227 should be the rightmost on display. PRODUCE_GLYPHS then reverses
228 the order, when it fills up the glyph row whose reversed_p flag is
229 set, by prepending each new glyph to what is already there, instead
230 of appending it. When the glyph row is complete, the function
231 extend_face_to_end_of_line fills the empty space to the left of the
232 leftmost character with special glyphs, which will display as,
233 well, empty. On text terminals, these special glyphs are simply
234 blank characters. On graphics terminals, there's a single stretch
235 glyph of a suitably computed width. Both the blanks and the
236 stretch glyph are given the face of the background of the line.
237 This way, the terminal-specific back-end can still draw the glyphs
238 left to right, even for R2L lines.
240 Bidirectional display and character compositions
242 Some scripts cannot be displayed by drawing each character
243 individually, because adjacent characters change each other's shape
244 on display. For example, Arabic and Indic scripts belong to this
245 category.
247 Emacs display supports this by providing "character compositions",
248 most of which is implemented in composite.c. During the buffer
249 scan that delivers characters to PRODUCE_GLYPHS, if the next
250 character to be delivered is a composed character, the iteration
251 calls composition_reseat_it and next_element_from_composition. If
252 they succeed to compose the character with one or more of the
253 following characters, the whole sequence of characters that where
254 composed is recorded in the `struct composition_it' object that is
255 part of the buffer iterator. The composed sequence could produce
256 one or more font glyphs (called "grapheme clusters") on the screen.
257 Each of these grapheme clusters is then delivered to PRODUCE_GLYPHS
258 in the direction corresponding to the current bidi scan direction
259 (recorded in the scan_dir member of the `struct bidi_it' object
260 that is part of the buffer iterator). In particular, if the bidi
261 iterator currently scans the buffer backwards, the grapheme
262 clusters are delivered back to front. This reorders the grapheme
263 clusters as appropriate for the current bidi context. Note that
264 this means that the grapheme clusters are always stored in the
265 LGSTRING object (see composite.c) in the logical order.
267 Moving an iterator in bidirectional text
268 without producing glyphs
270 Note one important detail mentioned above: that the bidi reordering
271 engine, driven by the iterator, produces characters in R2L rows
272 starting at the character that will be the rightmost on display.
273 As far as the iterator is concerned, the geometry of such rows is
274 still left to right, i.e. the iterator "thinks" the first character
275 is at the leftmost pixel position. The iterator does not know that
276 PRODUCE_GLYPHS reverses the order of the glyphs that the iterator
277 delivers. This is important when functions from the move_it_*
278 family are used to get to certain screen position or to match
279 screen coordinates with buffer coordinates: these functions use the
280 iterator geometry, which is left to right even in R2L paragraphs.
281 This works well with most callers of move_it_*, because they need
282 to get to a specific column, and columns are still numbered in the
283 reading order, i.e. the rightmost character in a R2L paragraph is
284 still column zero. But some callers do not get well with this; a
285 notable example is mouse clicks that need to find the character
286 that corresponds to certain pixel coordinates. See
287 buffer_posn_from_coords in dispnew.c for how this is handled. */
289 #include <config.h>
290 #include <stdio.h>
291 #include <limits.h>
293 #include "lisp.h"
294 #include "atimer.h"
295 #include "keyboard.h"
296 #include "frame.h"
297 #include "window.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
301 #include "buffer.h"
302 #include "charset.h"
303 #include "indent.h"
304 #include "commands.h"
305 #include "keymap.h"
306 #include "macros.h"
307 #include "disptab.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
311 #include "coding.h"
312 #include "process.h"
313 #include "region-cache.h"
314 #include "font.h"
315 #include "fontset.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
318 #include TERM_HEADER
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
323 #endif
325 #define INFINITY 10000000
327 Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;
328 Lisp_Object Qwindow_scroll_functions;
329 static Lisp_Object Qwindow_text_change_functions;
330 static Lisp_Object Qredisplay_end_trigger_functions;
331 Lisp_Object Qinhibit_point_motion_hooks;
332 static Lisp_Object QCeval, QCpropertize;
333 Lisp_Object QCfile, QCdata;
334 static Lisp_Object Qfontified;
335 static Lisp_Object Qgrow_only;
336 static Lisp_Object Qinhibit_eval_during_redisplay;
337 static Lisp_Object Qbuffer_position, Qposition, Qobject;
338 static Lisp_Object Qright_to_left, Qleft_to_right;
340 /* Cursor shapes. */
341 Lisp_Object Qbar, Qhbar, Qbox, Qhollow;
343 /* Pointer shapes. */
344 static Lisp_Object Qarrow, Qhand;
345 Lisp_Object Qtext;
347 /* Holds the list (error). */
348 static Lisp_Object list_of_error;
350 static Lisp_Object Qfontification_functions;
352 static Lisp_Object Qwrap_prefix;
353 static Lisp_Object Qline_prefix;
354 static Lisp_Object Qredisplay_internal;
356 /* Non-nil means don't actually do any redisplay. */
358 Lisp_Object Qinhibit_redisplay;
360 /* Names of text properties relevant for redisplay. */
362 Lisp_Object Qdisplay;
364 Lisp_Object Qspace, QCalign_to;
365 static Lisp_Object QCrelative_width, QCrelative_height;
366 Lisp_Object Qleft_margin, Qright_margin;
367 static Lisp_Object Qspace_width, Qraise;
368 static Lisp_Object Qslice;
369 Lisp_Object Qcenter;
370 static Lisp_Object Qmargin, Qpointer;
371 static Lisp_Object Qline_height;
373 #ifdef HAVE_WINDOW_SYSTEM
375 /* Test if overflow newline into fringe. Called with iterator IT
376 at or past right window margin, and with IT->current_x set. */
378 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(IT) \
379 (!NILP (Voverflow_newline_into_fringe) \
380 && FRAME_WINDOW_P ((IT)->f) \
381 && ((IT)->bidi_it.paragraph_dir == R2L \
382 ? (WINDOW_LEFT_FRINGE_WIDTH ((IT)->w) > 0) \
383 : (WINDOW_RIGHT_FRINGE_WIDTH ((IT)->w) > 0)) \
384 && (IT)->current_x == (IT)->last_visible_x)
386 #else /* !HAVE_WINDOW_SYSTEM */
387 #define IT_OVERFLOW_NEWLINE_INTO_FRINGE(it) 0
388 #endif /* HAVE_WINDOW_SYSTEM */
390 /* Test if the display element loaded in IT, or the underlying buffer
391 or string character, is a space or a TAB character. This is used
392 to determine where word wrapping can occur. */
394 #define IT_DISPLAYING_WHITESPACE(it) \
395 ((it->what == IT_CHARACTER && (it->c == ' ' || it->c == '\t')) \
396 || ((STRINGP (it->string) \
397 && (SREF (it->string, IT_STRING_BYTEPOS (*it)) == ' ' \
398 || SREF (it->string, IT_STRING_BYTEPOS (*it)) == '\t')) \
399 || (it->s \
400 && (it->s[IT_BYTEPOS (*it)] == ' ' \
401 || it->s[IT_BYTEPOS (*it)] == '\t')) \
402 || (IT_BYTEPOS (*it) < ZV_BYTE \
403 && (*BYTE_POS_ADDR (IT_BYTEPOS (*it)) == ' ' \
404 || *BYTE_POS_ADDR (IT_BYTEPOS (*it)) == '\t')))) \
406 /* Name of the face used to highlight trailing whitespace. */
408 static Lisp_Object Qtrailing_whitespace;
410 /* Name and number of the face used to highlight escape glyphs. */
412 static Lisp_Object Qescape_glyph;
414 /* Name and number of the face used to highlight non-breaking spaces. */
416 static Lisp_Object Qnobreak_space;
418 /* The symbol `image' which is the car of the lists used to represent
419 images in Lisp. Also a tool bar style. */
421 Lisp_Object Qimage;
423 /* The image map types. */
424 Lisp_Object QCmap;
425 static Lisp_Object QCpointer;
426 static Lisp_Object Qrect, Qcircle, Qpoly;
428 /* Tool bar styles */
429 Lisp_Object Qboth, Qboth_horiz, Qtext_image_horiz;
431 /* Non-zero means print newline to stdout before next mini-buffer
432 message. */
434 bool noninteractive_need_newline;
436 /* Non-zero means print newline to message log before next message. */
438 static bool message_log_need_newline;
440 /* Three markers that message_dolog uses.
441 It could allocate them itself, but that causes trouble
442 in handling memory-full errors. */
443 static Lisp_Object message_dolog_marker1;
444 static Lisp_Object message_dolog_marker2;
445 static Lisp_Object message_dolog_marker3;
447 /* The buffer position of the first character appearing entirely or
448 partially on the line of the selected window which contains the
449 cursor; <= 0 if not known. Set by set_cursor_from_row, used for
450 redisplay optimization in redisplay_internal. */
452 static struct text_pos this_line_start_pos;
454 /* Number of characters past the end of the line above, including the
455 terminating newline. */
457 static struct text_pos this_line_end_pos;
459 /* The vertical positions and the height of this line. */
461 static int this_line_vpos;
462 static int this_line_y;
463 static int this_line_pixel_height;
465 /* X position at which this display line starts. Usually zero;
466 negative if first character is partially visible. */
468 static int this_line_start_x;
470 /* The smallest character position seen by move_it_* functions as they
471 move across display lines. Used to set MATRIX_ROW_START_CHARPOS of
472 hscrolled lines, see display_line. */
474 static struct text_pos this_line_min_pos;
476 /* Buffer that this_line_.* variables are referring to. */
478 static struct buffer *this_line_buffer;
481 /* Values of those variables at last redisplay are stored as
482 properties on `overlay-arrow-position' symbol. However, if
483 Voverlay_arrow_position is a marker, last-arrow-position is its
484 numerical position. */
486 static Lisp_Object Qlast_arrow_position, Qlast_arrow_string;
488 /* Alternative overlay-arrow-string and overlay-arrow-bitmap
489 properties on a symbol in overlay-arrow-variable-list. */
491 static Lisp_Object Qoverlay_arrow_string, Qoverlay_arrow_bitmap;
493 Lisp_Object Qmenu_bar_update_hook;
495 /* Nonzero if an overlay arrow has been displayed in this window. */
497 static bool overlay_arrow_seen;
499 /* Vector containing glyphs for an ellipsis `...'. */
501 static Lisp_Object default_invis_vector[3];
503 /* This is the window where the echo area message was displayed. It
504 is always a mini-buffer window, but it may not be the same window
505 currently active as a mini-buffer. */
507 Lisp_Object echo_area_window;
509 /* List of pairs (MESSAGE . MULTIBYTE). The function save_message
510 pushes the current message and the value of
511 message_enable_multibyte on the stack, the function restore_message
512 pops the stack and displays MESSAGE again. */
514 static Lisp_Object Vmessage_stack;
516 /* Nonzero means multibyte characters were enabled when the echo area
517 message was specified. */
519 static bool message_enable_multibyte;
521 /* Nonzero if we should redraw the mode lines on the next redisplay.
522 If it has value REDISPLAY_SOME, then only redisplay the mode lines where
523 the `redisplay' bit has been set. Otherwise, redisplay all mode lines
524 (the number used is then only used to track down the cause for this
525 full-redisplay). */
527 int update_mode_lines;
529 /* Nonzero if window sizes or contents other than selected-window have changed
530 since last redisplay that finished.
531 If it has value REDISPLAY_SOME, then only redisplay the windows where
532 the `redisplay' bit has been set. Otherwise, redisplay all windows
533 (the number used is then only used to track down the cause for this
534 full-redisplay). */
536 int windows_or_buffers_changed;
538 /* Nonzero after display_mode_line if %l was used and it displayed a
539 line number. */
541 static bool line_number_displayed;
543 /* The name of the *Messages* buffer, a string. */
545 static Lisp_Object Vmessages_buffer_name;
547 /* Current, index 0, and last displayed echo area message. Either
548 buffers from echo_buffers, or nil to indicate no message. */
550 Lisp_Object echo_area_buffer[2];
552 /* The buffers referenced from echo_area_buffer. */
554 static Lisp_Object echo_buffer[2];
556 /* A vector saved used in with_area_buffer to reduce consing. */
558 static Lisp_Object Vwith_echo_area_save_vector;
560 /* Non-zero means display_echo_area should display the last echo area
561 message again. Set by redisplay_preserve_echo_area. */
563 static bool display_last_displayed_message_p;
565 /* Nonzero if echo area is being used by print; zero if being used by
566 message. */
568 static bool message_buf_print;
570 /* The symbol `inhibit-menubar-update' and its DEFVAR_BOOL variable. */
572 static Lisp_Object Qinhibit_menubar_update;
573 static Lisp_Object Qmessage_truncate_lines;
575 /* Set to 1 in clear_message to make redisplay_internal aware
576 of an emptied echo area. */
578 static bool message_cleared_p;
580 /* A scratch glyph row with contents used for generating truncation
581 glyphs. Also used in direct_output_for_insert. */
583 #define MAX_SCRATCH_GLYPHS 100
584 static struct glyph_row scratch_glyph_row;
585 static struct glyph scratch_glyphs[MAX_SCRATCH_GLYPHS];
587 /* Ascent and height of the last line processed by move_it_to. */
589 static int last_height;
591 /* Non-zero if there's a help-echo in the echo area. */
593 bool help_echo_showing_p;
595 /* The maximum distance to look ahead for text properties. Values
596 that are too small let us call compute_char_face and similar
597 functions too often which is expensive. Values that are too large
598 let us call compute_char_face and alike too often because we
599 might not be interested in text properties that far away. */
601 #define TEXT_PROP_DISTANCE_LIMIT 100
603 /* SAVE_IT and RESTORE_IT are called when we save a snapshot of the
604 iterator state and later restore it. This is needed because the
605 bidi iterator on bidi.c keeps a stacked cache of its states, which
606 is really a singleton. When we use scratch iterator objects to
607 move around the buffer, we can cause the bidi cache to be pushed or
608 popped, and therefore we need to restore the cache state when we
609 return to the original iterator. */
610 #define SAVE_IT(ITCOPY,ITORIG,CACHE) \
611 do { \
612 if (CACHE) \
613 bidi_unshelve_cache (CACHE, 1); \
614 ITCOPY = ITORIG; \
615 CACHE = bidi_shelve_cache (); \
616 } while (0)
618 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
619 do { \
620 if (pITORIG != pITCOPY) \
621 *(pITORIG) = *(pITCOPY); \
622 bidi_unshelve_cache (CACHE, 0); \
623 CACHE = NULL; \
624 } while (0)
626 /* Functions to mark elements as needing redisplay. */
627 enum { REDISPLAY_SOME = 2}; /* Arbitrary choice. */
629 void
630 redisplay_other_windows (void)
632 if (!windows_or_buffers_changed)
633 windows_or_buffers_changed = REDISPLAY_SOME;
636 void
637 wset_redisplay (struct window *w)
639 /* Beware: selected_window can be nil during early stages. */
640 if (!EQ (make_lisp_ptr (w, Lisp_Vectorlike), selected_window))
641 redisplay_other_windows ();
642 w->redisplay = true;
645 void
646 fset_redisplay (struct frame *f)
648 redisplay_other_windows ();
649 f->redisplay = true;
652 void
653 bset_redisplay (struct buffer *b)
655 int count = buffer_window_count (b);
656 if (count > 0)
658 /* ... it's visible in other window than selected, */
659 if (count > 1 || b != XBUFFER (XWINDOW (selected_window)->contents))
660 redisplay_other_windows ();
661 /* Even if we don't set windows_or_buffers_changed, do set `redisplay'
662 so that if we later set windows_or_buffers_changed, this buffer will
663 not be omitted. */
664 b->text->redisplay = true;
668 void
669 bset_update_mode_line (struct buffer *b)
671 if (!update_mode_lines)
672 update_mode_lines = REDISPLAY_SOME;
673 b->text->redisplay = true;
676 #ifdef GLYPH_DEBUG
678 /* Non-zero means print traces of redisplay if compiled with
679 GLYPH_DEBUG defined. */
681 bool trace_redisplay_p;
683 #endif /* GLYPH_DEBUG */
685 #ifdef DEBUG_TRACE_MOVE
686 /* Non-zero means trace with TRACE_MOVE to stderr. */
687 int trace_move;
689 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
690 #else
691 #define TRACE_MOVE(x) (void) 0
692 #endif
694 static Lisp_Object Qauto_hscroll_mode;
696 /* Buffer being redisplayed -- for redisplay_window_error. */
698 static struct buffer *displayed_buffer;
700 /* Value returned from text property handlers (see below). */
702 enum prop_handled
704 HANDLED_NORMALLY,
705 HANDLED_RECOMPUTE_PROPS,
706 HANDLED_OVERLAY_STRING_CONSUMED,
707 HANDLED_RETURN
710 /* A description of text properties that redisplay is interested
711 in. */
713 struct props
715 /* The name of the property. */
716 Lisp_Object *name;
718 /* A unique index for the property. */
719 enum prop_idx idx;
721 /* A handler function called to set up iterator IT from the property
722 at IT's current position. Value is used to steer handle_stop. */
723 enum prop_handled (*handler) (struct it *it);
726 static enum prop_handled handle_face_prop (struct it *);
727 static enum prop_handled handle_invisible_prop (struct it *);
728 static enum prop_handled handle_display_prop (struct it *);
729 static enum prop_handled handle_composition_prop (struct it *);
730 static enum prop_handled handle_overlay_change (struct it *);
731 static enum prop_handled handle_fontified_prop (struct it *);
733 /* Properties handled by iterators. */
735 static struct props it_props[] =
737 {&Qfontified, FONTIFIED_PROP_IDX, handle_fontified_prop},
738 /* Handle `face' before `display' because some sub-properties of
739 `display' need to know the face. */
740 {&Qface, FACE_PROP_IDX, handle_face_prop},
741 {&Qdisplay, DISPLAY_PROP_IDX, handle_display_prop},
742 {&Qinvisible, INVISIBLE_PROP_IDX, handle_invisible_prop},
743 {&Qcomposition, COMPOSITION_PROP_IDX, handle_composition_prop},
744 {NULL, 0, NULL}
747 /* Value is the position described by X. If X is a marker, value is
748 the marker_position of X. Otherwise, value is X. */
750 #define COERCE_MARKER(X) (MARKERP ((X)) ? Fmarker_position (X) : (X))
752 /* Enumeration returned by some move_it_.* functions internally. */
754 enum move_it_result
756 /* Not used. Undefined value. */
757 MOVE_UNDEFINED,
759 /* Move ended at the requested buffer position or ZV. */
760 MOVE_POS_MATCH_OR_ZV,
762 /* Move ended at the requested X pixel position. */
763 MOVE_X_REACHED,
765 /* Move within a line ended at the end of a line that must be
766 continued. */
767 MOVE_LINE_CONTINUED,
769 /* Move within a line ended at the end of a line that would
770 be displayed truncated. */
771 MOVE_LINE_TRUNCATED,
773 /* Move within a line ended at a line end. */
774 MOVE_NEWLINE_OR_CR
777 /* This counter is used to clear the face cache every once in a while
778 in redisplay_internal. It is incremented for each redisplay.
779 Every CLEAR_FACE_CACHE_COUNT full redisplays, the face cache is
780 cleared. */
782 #define CLEAR_FACE_CACHE_COUNT 500
783 static int clear_face_cache_count;
785 /* Similarly for the image cache. */
787 #ifdef HAVE_WINDOW_SYSTEM
788 #define CLEAR_IMAGE_CACHE_COUNT 101
789 static int clear_image_cache_count;
791 /* Null glyph slice */
792 static struct glyph_slice null_glyph_slice = { 0, 0, 0, 0 };
793 #endif
795 /* True while redisplay_internal is in progress. */
797 bool redisplaying_p;
799 static Lisp_Object Qinhibit_free_realized_faces;
800 static Lisp_Object Qmode_line_default_help_echo;
802 /* If a string, XTread_socket generates an event to display that string.
803 (The display is done in read_char.) */
805 Lisp_Object help_echo_string;
806 Lisp_Object help_echo_window;
807 Lisp_Object help_echo_object;
808 ptrdiff_t help_echo_pos;
810 /* Temporary variable for XTread_socket. */
812 Lisp_Object previous_help_echo_string;
814 /* Platform-independent portion of hourglass implementation. */
816 #ifdef HAVE_WINDOW_SYSTEM
818 /* Non-zero means an hourglass cursor is currently shown. */
819 static bool hourglass_shown_p;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 static struct atimer *hourglass_atimer;
825 #endif /* HAVE_WINDOW_SYSTEM */
827 /* Name of the face used to display glyphless characters. */
828 static Lisp_Object Qglyphless_char;
830 /* Symbol for the purpose of Vglyphless_char_display. */
831 static Lisp_Object Qglyphless_char_display;
833 /* Method symbols for Vglyphless_char_display. */
834 static Lisp_Object Qhex_code, Qempty_box, Qthin_space, Qzero_width;
836 /* Default number of seconds to wait before displaying an hourglass
837 cursor. */
838 #define DEFAULT_HOURGLASS_DELAY 1
840 #ifdef HAVE_WINDOW_SYSTEM
842 /* Default pixel width of `thin-space' display method. */
843 #define THIN_SPACE_WIDTH 1
845 #endif /* HAVE_WINDOW_SYSTEM */
847 /* Function prototypes. */
849 static void setup_for_ellipsis (struct it *, int);
850 static void set_iterator_to_next (struct it *, int);
851 static void mark_window_display_accurate_1 (struct window *, int);
852 static int single_display_spec_string_p (Lisp_Object, Lisp_Object);
853 static int display_prop_string_p (Lisp_Object, Lisp_Object);
854 static int row_for_charpos_p (struct glyph_row *, ptrdiff_t);
855 static int cursor_row_p (struct glyph_row *);
856 static int redisplay_mode_lines (Lisp_Object, bool);
857 static char *decode_mode_spec_coding (Lisp_Object, char *, int);
859 static Lisp_Object get_it_property (struct it *it, Lisp_Object prop);
861 static void handle_line_prefix (struct it *);
863 static void pint2str (char *, int, ptrdiff_t);
864 static void pint2hrstr (char *, int, ptrdiff_t);
865 static struct text_pos run_window_scroll_functions (Lisp_Object,
866 struct text_pos);
867 static int text_outside_line_unchanged_p (struct window *,
868 ptrdiff_t, ptrdiff_t);
869 static void store_mode_line_noprop_char (char);
870 static int store_mode_line_noprop (const char *, int, int);
871 static void handle_stop (struct it *);
872 static void handle_stop_backwards (struct it *, ptrdiff_t);
873 static void vmessage (const char *, va_list) ATTRIBUTE_FORMAT_PRINTF (1, 0);
874 static void ensure_echo_area_buffers (void);
875 static void unwind_with_echo_area_buffer (Lisp_Object);
876 static Lisp_Object with_echo_area_buffer_unwind_data (struct window *);
877 static int with_echo_area_buffer (struct window *, int,
878 int (*) (ptrdiff_t, Lisp_Object),
879 ptrdiff_t, Lisp_Object);
880 static void clear_garbaged_frames (void);
881 static int current_message_1 (ptrdiff_t, Lisp_Object);
882 static int truncate_message_1 (ptrdiff_t, Lisp_Object);
883 static void set_message (Lisp_Object);
884 static int set_message_1 (ptrdiff_t, Lisp_Object);
885 static int display_echo_area (struct window *);
886 static int display_echo_area_1 (ptrdiff_t, Lisp_Object);
887 static int resize_mini_window_1 (ptrdiff_t, Lisp_Object);
888 static void unwind_redisplay (void);
889 static int string_char_and_length (const unsigned char *, int *);
890 static struct text_pos display_prop_end (struct it *, Lisp_Object,
891 struct text_pos);
892 static int compute_window_start_on_continuation_line (struct window *);
893 static void insert_left_trunc_glyphs (struct it *);
894 static struct glyph_row *get_overlay_arrow_glyph_row (struct window *,
895 Lisp_Object);
896 static void extend_face_to_end_of_line (struct it *);
897 static int append_space_for_newline (struct it *, int);
898 static int cursor_row_fully_visible_p (struct window *, int, int);
899 static int try_scrolling (Lisp_Object, int, ptrdiff_t, ptrdiff_t, int, int);
900 static int try_cursor_movement (Lisp_Object, struct text_pos, int *);
901 static int trailing_whitespace_p (ptrdiff_t);
902 static intmax_t message_log_check_duplicate (ptrdiff_t, ptrdiff_t);
903 static void push_it (struct it *, struct text_pos *);
904 static void iterate_out_of_display_property (struct it *);
905 static void pop_it (struct it *);
906 static void sync_frame_with_window_matrix_rows (struct window *);
907 static void redisplay_internal (void);
908 static int echo_area_display (int);
909 static void redisplay_windows (Lisp_Object);
910 static void redisplay_window (Lisp_Object, bool);
911 static Lisp_Object redisplay_window_error (Lisp_Object);
912 static Lisp_Object redisplay_window_0 (Lisp_Object);
913 static Lisp_Object redisplay_window_1 (Lisp_Object);
914 static int set_cursor_from_row (struct window *, struct glyph_row *,
915 struct glyph_matrix *, ptrdiff_t, ptrdiff_t,
916 int, int);
917 static int update_menu_bar (struct frame *, int, int);
918 static int try_window_reusing_current_matrix (struct window *);
919 static int try_window_id (struct window *);
920 static int display_line (struct it *);
921 static int display_mode_lines (struct window *);
922 static int display_mode_line (struct window *, enum face_id, Lisp_Object);
923 static int display_mode_element (struct it *, int, int, int, Lisp_Object, Lisp_Object, int);
924 static int store_mode_line_string (const char *, Lisp_Object, int, int, int, Lisp_Object);
925 static const char *decode_mode_spec (struct window *, int, int, Lisp_Object *);
926 static void display_menu_bar (struct window *);
927 static ptrdiff_t display_count_lines (ptrdiff_t, ptrdiff_t, ptrdiff_t,
928 ptrdiff_t *);
929 static int display_string (const char *, Lisp_Object, Lisp_Object,
930 ptrdiff_t, ptrdiff_t, struct it *, int, int, int, int);
931 static void compute_line_metrics (struct it *);
932 static void run_redisplay_end_trigger_hook (struct it *);
933 static int get_overlay_strings (struct it *, ptrdiff_t);
934 static int get_overlay_strings_1 (struct it *, ptrdiff_t, int);
935 static void next_overlay_string (struct it *);
936 static void reseat (struct it *, struct text_pos, int);
937 static void reseat_1 (struct it *, struct text_pos, int);
938 static void back_to_previous_visible_line_start (struct it *);
939 static void reseat_at_next_visible_line_start (struct it *, int);
940 static int next_element_from_ellipsis (struct it *);
941 static int next_element_from_display_vector (struct it *);
942 static int next_element_from_string (struct it *);
943 static int next_element_from_c_string (struct it *);
944 static int next_element_from_buffer (struct it *);
945 static int next_element_from_composition (struct it *);
946 static int next_element_from_image (struct it *);
947 static int next_element_from_stretch (struct it *);
948 static void load_overlay_strings (struct it *, ptrdiff_t);
949 static int init_from_display_pos (struct it *, struct window *,
950 struct display_pos *);
951 static void reseat_to_string (struct it *, const char *,
952 Lisp_Object, ptrdiff_t, ptrdiff_t, int, int);
953 static int get_next_display_element (struct it *);
954 static enum move_it_result
955 move_it_in_display_line_to (struct it *, ptrdiff_t, int,
956 enum move_operation_enum);
957 static void get_visually_first_element (struct it *);
958 static void init_to_row_start (struct it *, struct window *,
959 struct glyph_row *);
960 static int init_to_row_end (struct it *, struct window *,
961 struct glyph_row *);
962 static void back_to_previous_line_start (struct it *);
963 static int forward_to_next_line_start (struct it *, int *, struct bidi_it *);
964 static struct text_pos string_pos_nchars_ahead (struct text_pos,
965 Lisp_Object, ptrdiff_t);
966 static struct text_pos string_pos (ptrdiff_t, Lisp_Object);
967 static struct text_pos c_string_pos (ptrdiff_t, const char *, bool);
968 static ptrdiff_t number_of_chars (const char *, bool);
969 static void compute_stop_pos (struct it *);
970 static void compute_string_pos (struct text_pos *, struct text_pos,
971 Lisp_Object);
972 static int face_before_or_after_it_pos (struct it *, int);
973 static ptrdiff_t next_overlay_change (ptrdiff_t);
974 static int handle_display_spec (struct it *, Lisp_Object, Lisp_Object,
975 Lisp_Object, struct text_pos *, ptrdiff_t, int);
976 static int handle_single_display_spec (struct it *, Lisp_Object,
977 Lisp_Object, Lisp_Object,
978 struct text_pos *, ptrdiff_t, int, int);
979 static int underlying_face_id (struct it *);
980 static int in_ellipses_for_invisible_text_p (struct display_pos *,
981 struct window *);
983 #define face_before_it_pos(IT) face_before_or_after_it_pos ((IT), 1)
984 #define face_after_it_pos(IT) face_before_or_after_it_pos ((IT), 0)
986 #ifdef HAVE_WINDOW_SYSTEM
988 static void x_consider_frame_title (Lisp_Object);
989 static void update_tool_bar (struct frame *, int);
990 static int redisplay_tool_bar (struct frame *);
991 static void x_draw_bottom_divider (struct window *w);
992 static void notice_overwritten_cursor (struct window *,
993 enum glyph_row_area,
994 int, int, int, int);
995 static void append_stretch_glyph (struct it *, Lisp_Object,
996 int, int, int);
999 #endif /* HAVE_WINDOW_SYSTEM */
1001 static void produce_special_glyphs (struct it *, enum display_element_type);
1002 static void show_mouse_face (Mouse_HLInfo *, enum draw_glyphs_face);
1003 static bool coords_in_mouse_face_p (struct window *, int, int);
1007 /***********************************************************************
1008 Window display dimensions
1009 ***********************************************************************/
1011 /* Return the bottom boundary y-position for text lines in window W.
1012 This is the first y position at which a line cannot start.
1013 It is relative to the top of the window.
1015 This is the height of W minus the height of a mode line, if any. */
1018 window_text_bottom_y (struct window *w)
1020 int height = WINDOW_PIXEL_HEIGHT (w);
1022 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
1024 if (WINDOW_WANTS_MODELINE_P (w))
1025 height -= CURRENT_MODE_LINE_HEIGHT (w);
1027 height -= WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
1029 return height;
1032 /* Return the pixel width of display area AREA of window W.
1033 ANY_AREA means return the total width of W, not including
1034 fringes to the left and right of the window. */
1037 window_box_width (struct window *w, enum glyph_row_area area)
1039 int width = w->pixel_width;
1041 if (!w->pseudo_window_p)
1043 width -= WINDOW_SCROLL_BAR_AREA_WIDTH (w);
1044 width -= WINDOW_RIGHT_DIVIDER_WIDTH (w);
1046 if (area == TEXT_AREA)
1047 width -= (WINDOW_MARGINS_WIDTH (w)
1048 + WINDOW_FRINGES_WIDTH (w));
1049 else if (area == LEFT_MARGIN_AREA)
1050 width = WINDOW_LEFT_MARGIN_WIDTH (w);
1051 else if (area == RIGHT_MARGIN_AREA)
1052 width = WINDOW_RIGHT_MARGIN_WIDTH (w);
1055 /* With wide margins, fringes, etc. we might end up with a negative
1056 width, correct that here. */
1057 return max (0, width);
1061 /* Return the pixel height of the display area of window W, not
1062 including mode lines of W, if any. */
1065 window_box_height (struct window *w)
1067 struct frame *f = XFRAME (w->frame);
1068 int height = WINDOW_PIXEL_HEIGHT (w);
1070 eassert (height >= 0);
1072 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
1073 height -= WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
1075 /* Note: the code below that determines the mode-line/header-line
1076 height is essentially the same as that contained in the macro
1077 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1078 the appropriate glyph row has its `mode_line_p' flag set,
1079 and if it doesn't, uses estimate_mode_line_height instead. */
1081 if (WINDOW_WANTS_MODELINE_P (w))
1083 struct glyph_row *ml_row
1084 = (w->current_matrix && w->current_matrix->rows
1085 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
1086 : 0);
1087 if (ml_row && ml_row->mode_line_p)
1088 height -= ml_row->height;
1089 else
1090 height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
1093 if (WINDOW_WANTS_HEADER_LINE_P (w))
1095 struct glyph_row *hl_row
1096 = (w->current_matrix && w->current_matrix->rows
1097 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
1098 : 0);
1099 if (hl_row && hl_row->mode_line_p)
1100 height -= hl_row->height;
1101 else
1102 height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
1105 /* With a very small font and a mode-line that's taller than
1106 default, we might end up with a negative height. */
1107 return max (0, height);
1110 /* Return the window-relative coordinate of the left edge of display
1111 area AREA of window W. ANY_AREA means return the left edge of the
1112 whole window, to the right of the left fringe of W. */
1115 window_box_left_offset (struct window *w, enum glyph_row_area area)
1117 int x;
1119 if (w->pseudo_window_p)
1120 return 0;
1122 x = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
1124 if (area == TEXT_AREA)
1125 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1126 + window_box_width (w, LEFT_MARGIN_AREA));
1127 else if (area == RIGHT_MARGIN_AREA)
1128 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1129 + window_box_width (w, LEFT_MARGIN_AREA)
1130 + window_box_width (w, TEXT_AREA)
1131 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1133 : WINDOW_RIGHT_FRINGE_WIDTH (w)));
1134 else if (area == LEFT_MARGIN_AREA
1135 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1136 x += WINDOW_LEFT_FRINGE_WIDTH (w);
1138 /* Don't return more than the window's pixel width. */
1139 return min (x, w->pixel_width);
1143 /* Return the window-relative coordinate of the right edge of display
1144 area AREA of window W. ANY_AREA means return the right edge of the
1145 whole window, to the left of the right fringe of W. */
1147 static int
1148 window_box_right_offset (struct window *w, enum glyph_row_area area)
1150 /* Don't return more than the window's pixel width. */
1151 return min (window_box_left_offset (w, area) + window_box_width (w, area),
1152 w->pixel_width);
1155 /* Return the frame-relative coordinate of the left edge of display
1156 area AREA of window W. ANY_AREA means return the left edge of the
1157 whole window, to the right of the left fringe of W. */
1160 window_box_left (struct window *w, enum glyph_row_area area)
1162 struct frame *f = XFRAME (w->frame);
1163 int x;
1165 if (w->pseudo_window_p)
1166 return FRAME_INTERNAL_BORDER_WIDTH (f);
1168 x = (WINDOW_LEFT_EDGE_X (w)
1169 + window_box_left_offset (w, area));
1171 return x;
1175 /* Return the frame-relative coordinate of the right edge of display
1176 area AREA of window W. ANY_AREA means return the right edge of the
1177 whole window, to the left of the right fringe of W. */
1180 window_box_right (struct window *w, enum glyph_row_area area)
1182 return window_box_left (w, area) + window_box_width (w, area);
1185 /* Get the bounding box of the display area AREA of window W, without
1186 mode lines, in frame-relative coordinates. ANY_AREA means the
1187 whole window, not including the left and right fringes of
1188 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1189 coordinates of the upper-left corner of the box. Return in
1190 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1192 void
1193 window_box (struct window *w, enum glyph_row_area area, int *box_x,
1194 int *box_y, int *box_width, int *box_height)
1196 if (box_width)
1197 *box_width = window_box_width (w, area);
1198 if (box_height)
1199 *box_height = window_box_height (w);
1200 if (box_x)
1201 *box_x = window_box_left (w, area);
1202 if (box_y)
1204 *box_y = WINDOW_TOP_EDGE_Y (w);
1205 if (WINDOW_WANTS_HEADER_LINE_P (w))
1206 *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
1210 #ifdef HAVE_WINDOW_SYSTEM
1212 /* Get the bounding box of the display area AREA of window W, without
1213 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1214 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1215 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1216 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1217 box. */
1219 static void
1220 window_box_edges (struct window *w, int *top_left_x, int *top_left_y,
1221 int *bottom_right_x, int *bottom_right_y)
1223 window_box (w, ANY_AREA, top_left_x, top_left_y,
1224 bottom_right_x, bottom_right_y);
1225 *bottom_right_x += *top_left_x;
1226 *bottom_right_y += *top_left_y;
1229 #endif /* HAVE_WINDOW_SYSTEM */
1231 /***********************************************************************
1232 Utilities
1233 ***********************************************************************/
1235 /* Return the bottom y-position of the line the iterator IT is in.
1236 This can modify IT's settings. */
1239 line_bottom_y (struct it *it)
1241 int line_height = it->max_ascent + it->max_descent;
1242 int line_top_y = it->current_y;
1244 if (line_height == 0)
1246 if (last_height)
1247 line_height = last_height;
1248 else if (IT_CHARPOS (*it) < ZV)
1250 move_it_by_lines (it, 1);
1251 line_height = (it->max_ascent || it->max_descent
1252 ? it->max_ascent + it->max_descent
1253 : last_height);
1255 else
1257 struct glyph_row *row = it->glyph_row;
1259 /* Use the default character height. */
1260 it->glyph_row = NULL;
1261 it->what = IT_CHARACTER;
1262 it->c = ' ';
1263 it->len = 1;
1264 PRODUCE_GLYPHS (it);
1265 line_height = it->ascent + it->descent;
1266 it->glyph_row = row;
1270 return line_top_y + line_height;
1273 DEFUN ("line-pixel-height", Fline_pixel_height,
1274 Sline_pixel_height, 0, 0, 0,
1275 doc: /* Return height in pixels of text line in the selected window.
1277 Value is the height in pixels of the line at point. */)
1278 (void)
1280 struct it it;
1281 struct text_pos pt;
1282 struct window *w = XWINDOW (selected_window);
1283 struct buffer *old_buffer = NULL;
1284 Lisp_Object result;
1286 if (XBUFFER (w->contents) != current_buffer)
1288 old_buffer = current_buffer;
1289 set_buffer_internal_1 (XBUFFER (w->contents));
1291 SET_TEXT_POS (pt, PT, PT_BYTE);
1292 start_display (&it, w, pt);
1293 it.vpos = it.current_y = 0;
1294 last_height = 0;
1295 result = make_number (line_bottom_y (&it));
1296 if (old_buffer)
1297 set_buffer_internal_1 (old_buffer);
1299 return result;
1302 /* Return the default pixel height of text lines in window W. The
1303 value is the canonical height of the W frame's default font, plus
1304 any extra space required by the line-spacing variable or frame
1305 parameter.
1307 Implementation note: this ignores any line-spacing text properties
1308 put on the newline characters. This is because those properties
1309 only affect the _screen_ line ending in the newline (i.e., in a
1310 continued line, only the last screen line will be affected), which
1311 means only a small number of lines in a buffer can ever use this
1312 feature. Since this function is used to compute the default pixel
1313 equivalent of text lines in a window, we can safely ignore those
1314 few lines. For the same reasons, we ignore the line-height
1315 properties. */
1317 default_line_pixel_height (struct window *w)
1319 struct frame *f = WINDOW_XFRAME (w);
1320 int height = FRAME_LINE_HEIGHT (f);
1322 if (!FRAME_INITIAL_P (f) && BUFFERP (w->contents))
1324 struct buffer *b = XBUFFER (w->contents);
1325 Lisp_Object val = BVAR (b, extra_line_spacing);
1327 if (NILP (val))
1328 val = BVAR (&buffer_defaults, extra_line_spacing);
1329 if (!NILP (val))
1331 if (RANGED_INTEGERP (0, val, INT_MAX))
1332 height += XFASTINT (val);
1333 else if (FLOATP (val))
1335 int addon = XFLOAT_DATA (val) * height + 0.5;
1337 if (addon >= 0)
1338 height += addon;
1341 else
1342 height += f->extra_line_spacing;
1345 return height;
1348 /* Subroutine of pos_visible_p below. Extracts a display string, if
1349 any, from the display spec given as its argument. */
1350 static Lisp_Object
1351 string_from_display_spec (Lisp_Object spec)
1353 if (CONSP (spec))
1355 while (CONSP (spec))
1357 if (STRINGP (XCAR (spec)))
1358 return XCAR (spec);
1359 spec = XCDR (spec);
1362 else if (VECTORP (spec))
1364 ptrdiff_t i;
1366 for (i = 0; i < ASIZE (spec); i++)
1368 if (STRINGP (AREF (spec, i)))
1369 return AREF (spec, i);
1371 return Qnil;
1374 return spec;
1378 /* Limit insanely large values of W->hscroll on frame F to the largest
1379 value that will still prevent first_visible_x and last_visible_x of
1380 'struct it' from overflowing an int. */
1381 static int
1382 window_hscroll_limited (struct window *w, struct frame *f)
1384 ptrdiff_t window_hscroll = w->hscroll;
1385 int window_text_width = window_box_width (w, TEXT_AREA);
1386 int colwidth = FRAME_COLUMN_WIDTH (f);
1388 if (window_hscroll > (INT_MAX - window_text_width) / colwidth - 1)
1389 window_hscroll = (INT_MAX - window_text_width) / colwidth - 1;
1391 return window_hscroll;
1394 /* Return 1 if position CHARPOS is visible in window W.
1395 CHARPOS < 0 means return info about WINDOW_END position.
1396 If visible, set *X and *Y to pixel coordinates of top left corner.
1397 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1398 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1401 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1402 int *rtop, int *rbot, int *rowh, int *vpos)
1404 struct it it;
1405 void *itdata = bidi_shelve_cache ();
1406 struct text_pos top;
1407 int visible_p = 0;
1408 struct buffer *old_buffer = NULL;
1410 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1411 return visible_p;
1413 if (XBUFFER (w->contents) != current_buffer)
1415 old_buffer = current_buffer;
1416 set_buffer_internal_1 (XBUFFER (w->contents));
1419 SET_TEXT_POS_FROM_MARKER (top, w->start);
1420 /* Scrolling a minibuffer window via scroll bar when the echo area
1421 shows long text sometimes resets the minibuffer contents behind
1422 our backs. */
1423 if (CHARPOS (top) > ZV)
1424 SET_TEXT_POS (top, BEGV, BEGV_BYTE);
1426 /* Compute exact mode line heights. */
1427 if (WINDOW_WANTS_MODELINE_P (w))
1428 w->mode_line_height
1429 = display_mode_line (w, CURRENT_MODE_LINE_FACE_ID (w),
1430 BVAR (current_buffer, mode_line_format));
1432 if (WINDOW_WANTS_HEADER_LINE_P (w))
1433 w->header_line_height
1434 = display_mode_line (w, HEADER_LINE_FACE_ID,
1435 BVAR (current_buffer, header_line_format));
1437 start_display (&it, w, top);
1438 move_it_to (&it, charpos, -1, it.last_visible_y - 1, -1,
1439 (charpos >= 0 ? MOVE_TO_POS : 0) | MOVE_TO_Y);
1441 if (charpos >= 0
1442 && (((!it.bidi_p || it.bidi_it.scan_dir != -1)
1443 && IT_CHARPOS (it) >= charpos)
1444 /* When scanning backwards under bidi iteration, move_it_to
1445 stops at or _before_ CHARPOS, because it stops at or to
1446 the _right_ of the character at CHARPOS. */
1447 || (it.bidi_p && it.bidi_it.scan_dir == -1
1448 && IT_CHARPOS (it) <= charpos)))
1450 /* We have reached CHARPOS, or passed it. How the call to
1451 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1452 or covered by a display property, move_it_to stops at the end
1453 of the invisible text, to the right of CHARPOS. (ii) If
1454 CHARPOS is in a display vector, move_it_to stops on its last
1455 glyph. */
1456 int top_x = it.current_x;
1457 int top_y = it.current_y;
1458 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1459 int bottom_y;
1460 struct it save_it;
1461 void *save_it_data = NULL;
1463 /* Calling line_bottom_y may change it.method, it.position, etc. */
1464 SAVE_IT (save_it, it, save_it_data);
1465 last_height = 0;
1466 bottom_y = line_bottom_y (&it);
1467 if (top_y < window_top_y)
1468 visible_p = bottom_y > window_top_y;
1469 else if (top_y < it.last_visible_y)
1470 visible_p = 1;
1471 if (bottom_y >= it.last_visible_y
1472 && it.bidi_p && it.bidi_it.scan_dir == -1
1473 && IT_CHARPOS (it) < charpos)
1475 /* When the last line of the window is scanned backwards
1476 under bidi iteration, we could be duped into thinking
1477 that we have passed CHARPOS, when in fact move_it_to
1478 simply stopped short of CHARPOS because it reached
1479 last_visible_y. To see if that's what happened, we call
1480 move_it_to again with a slightly larger vertical limit,
1481 and see if it actually moved vertically; if it did, we
1482 didn't really reach CHARPOS, which is beyond window end. */
1483 /* Why 10? because we don't know how many canonical lines
1484 will the height of the next line(s) be. So we guess. */
1485 int ten_more_lines = 10 * default_line_pixel_height (w);
1487 move_it_to (&it, charpos, -1, bottom_y + ten_more_lines, -1,
1488 MOVE_TO_POS | MOVE_TO_Y);
1489 if (it.current_y > top_y)
1490 visible_p = 0;
1493 RESTORE_IT (&it, &save_it, save_it_data);
1494 if (visible_p)
1496 if (it.method == GET_FROM_DISPLAY_VECTOR)
1498 /* We stopped on the last glyph of a display vector.
1499 Try and recompute. Hack alert! */
1500 if (charpos < 2 || top.charpos >= charpos)
1501 top_x = it.glyph_row->x;
1502 else
1504 struct it it2, it2_prev;
1505 /* The idea is to get to the previous buffer
1506 position, consume the character there, and use
1507 the pixel coordinates we get after that. But if
1508 the previous buffer position is also displayed
1509 from a display vector, we need to consume all of
1510 the glyphs from that display vector. */
1511 start_display (&it2, w, top);
1512 move_it_to (&it2, charpos - 1, -1, -1, -1, MOVE_TO_POS);
1513 /* If we didn't get to CHARPOS - 1, there's some
1514 replacing display property at that position, and
1515 we stopped after it. That is exactly the place
1516 whose coordinates we want. */
1517 if (IT_CHARPOS (it2) != charpos - 1)
1518 it2_prev = it2;
1519 else
1521 /* Iterate until we get out of the display
1522 vector that displays the character at
1523 CHARPOS - 1. */
1524 do {
1525 get_next_display_element (&it2);
1526 PRODUCE_GLYPHS (&it2);
1527 it2_prev = it2;
1528 set_iterator_to_next (&it2, 1);
1529 } while (it2.method == GET_FROM_DISPLAY_VECTOR
1530 && IT_CHARPOS (it2) < charpos);
1532 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev)
1533 || it2_prev.current_x > it2_prev.last_visible_x)
1534 top_x = it.glyph_row->x;
1535 else
1537 top_x = it2_prev.current_x;
1538 top_y = it2_prev.current_y;
1542 else if (IT_CHARPOS (it) != charpos)
1544 Lisp_Object cpos = make_number (charpos);
1545 Lisp_Object spec = Fget_char_property (cpos, Qdisplay, Qnil);
1546 Lisp_Object string = string_from_display_spec (spec);
1547 struct text_pos tpos;
1548 int replacing_spec_p;
1549 bool newline_in_string
1550 = (STRINGP (string)
1551 && memchr (SDATA (string), '\n', SBYTES (string)));
1553 SET_TEXT_POS (tpos, charpos, CHAR_TO_BYTE (charpos));
1554 replacing_spec_p
1555 = (!NILP (spec)
1556 && handle_display_spec (NULL, spec, Qnil, Qnil, &tpos,
1557 charpos, FRAME_WINDOW_P (it.f)));
1558 /* The tricky code below is needed because there's a
1559 discrepancy between move_it_to and how we set cursor
1560 when PT is at the beginning of a portion of text
1561 covered by a display property or an overlay with a
1562 display property, or the display line ends in a
1563 newline from a display string. move_it_to will stop
1564 _after_ such display strings, whereas
1565 set_cursor_from_row conspires with cursor_row_p to
1566 place the cursor on the first glyph produced from the
1567 display string. */
1569 /* We have overshoot PT because it is covered by a
1570 display property that replaces the text it covers.
1571 If the string includes embedded newlines, we are also
1572 in the wrong display line. Backtrack to the correct
1573 line, where the display property begins. */
1574 if (replacing_spec_p)
1576 Lisp_Object startpos, endpos;
1577 EMACS_INT start, end;
1578 struct it it3;
1579 int it3_moved;
1581 /* Find the first and the last buffer positions
1582 covered by the display string. */
1583 endpos =
1584 Fnext_single_char_property_change (cpos, Qdisplay,
1585 Qnil, Qnil);
1586 startpos =
1587 Fprevious_single_char_property_change (endpos, Qdisplay,
1588 Qnil, Qnil);
1589 start = XFASTINT (startpos);
1590 end = XFASTINT (endpos);
1591 /* Move to the last buffer position before the
1592 display property. */
1593 start_display (&it3, w, top);
1594 if (start > CHARPOS (top))
1595 move_it_to (&it3, start - 1, -1, -1, -1, MOVE_TO_POS);
1596 /* Move forward one more line if the position before
1597 the display string is a newline or if it is the
1598 rightmost character on a line that is
1599 continued or word-wrapped. */
1600 if (it3.method == GET_FROM_BUFFER
1601 && (it3.c == '\n'
1602 || FETCH_BYTE (IT_BYTEPOS (it3)) == '\n'))
1603 move_it_by_lines (&it3, 1);
1604 else if (move_it_in_display_line_to (&it3, -1,
1605 it3.current_x
1606 + it3.pixel_width,
1607 MOVE_TO_X)
1608 == MOVE_LINE_CONTINUED)
1610 move_it_by_lines (&it3, 1);
1611 /* When we are under word-wrap, the #$@%!
1612 move_it_by_lines moves 2 lines, so we need to
1613 fix that up. */
1614 if (it3.line_wrap == WORD_WRAP)
1615 move_it_by_lines (&it3, -1);
1618 /* Record the vertical coordinate of the display
1619 line where we wound up. */
1620 top_y = it3.current_y;
1621 if (it3.bidi_p)
1623 /* When characters are reordered for display,
1624 the character displayed to the left of the
1625 display string could be _after_ the display
1626 property in the logical order. Use the
1627 smallest vertical position of these two. */
1628 start_display (&it3, w, top);
1629 move_it_to (&it3, end + 1, -1, -1, -1, MOVE_TO_POS);
1630 if (it3.current_y < top_y)
1631 top_y = it3.current_y;
1633 /* Move from the top of the window to the beginning
1634 of the display line where the display string
1635 begins. */
1636 start_display (&it3, w, top);
1637 move_it_to (&it3, -1, 0, top_y, -1, MOVE_TO_X | MOVE_TO_Y);
1638 /* If it3_moved stays zero after the 'while' loop
1639 below, that means we already were at a newline
1640 before the loop (e.g., the display string begins
1641 with a newline), so we don't need to (and cannot)
1642 inspect the glyphs of it3.glyph_row, because
1643 PRODUCE_GLYPHS will not produce anything for a
1644 newline, and thus it3.glyph_row stays at its
1645 stale content it got at top of the window. */
1646 it3_moved = 0;
1647 /* Finally, advance the iterator until we hit the
1648 first display element whose character position is
1649 CHARPOS, or until the first newline from the
1650 display string, which signals the end of the
1651 display line. */
1652 while (get_next_display_element (&it3))
1654 PRODUCE_GLYPHS (&it3);
1655 if (IT_CHARPOS (it3) == charpos
1656 || ITERATOR_AT_END_OF_LINE_P (&it3))
1657 break;
1658 it3_moved = 1;
1659 set_iterator_to_next (&it3, 0);
1661 top_x = it3.current_x - it3.pixel_width;
1662 /* Normally, we would exit the above loop because we
1663 found the display element whose character
1664 position is CHARPOS. For the contingency that we
1665 didn't, and stopped at the first newline from the
1666 display string, move back over the glyphs
1667 produced from the string, until we find the
1668 rightmost glyph not from the string. */
1669 if (it3_moved
1670 && newline_in_string
1671 && IT_CHARPOS (it3) != charpos && EQ (it3.object, string))
1673 struct glyph *g = it3.glyph_row->glyphs[TEXT_AREA]
1674 + it3.glyph_row->used[TEXT_AREA];
1676 while (EQ ((g - 1)->object, string))
1678 --g;
1679 top_x -= g->pixel_width;
1681 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1682 + it3.glyph_row->used[TEXT_AREA]);
1687 *x = top_x;
1688 *y = max (top_y + max (0, it.max_ascent - it.ascent), window_top_y);
1689 *rtop = max (0, window_top_y - top_y);
1690 *rbot = max (0, bottom_y - it.last_visible_y);
1691 *rowh = max (0, (min (bottom_y, it.last_visible_y)
1692 - max (top_y, window_top_y)));
1693 *vpos = it.vpos;
1696 else
1698 /* Either we were asked to provide info about WINDOW_END, or
1699 CHARPOS is in the partially visible glyph row at end of
1700 window. */
1701 struct it it2;
1702 void *it2data = NULL;
1704 SAVE_IT (it2, it, it2data);
1705 if (IT_CHARPOS (it) < ZV && FETCH_BYTE (IT_BYTEPOS (it)) != '\n')
1706 move_it_by_lines (&it, 1);
1707 if (charpos < IT_CHARPOS (it)
1708 || (it.what == IT_EOB && charpos == IT_CHARPOS (it)))
1710 visible_p = true;
1711 RESTORE_IT (&it2, &it2, it2data);
1712 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1713 *x = it2.current_x;
1714 *y = it2.current_y + it2.max_ascent - it2.ascent;
1715 *rtop = max (0, -it2.current_y);
1716 *rbot = max (0, ((it2.current_y + it2.max_ascent + it2.max_descent)
1717 - it.last_visible_y));
1718 *rowh = max (0, (min (it2.current_y + it2.max_ascent + it2.max_descent,
1719 it.last_visible_y)
1720 - max (it2.current_y,
1721 WINDOW_HEADER_LINE_HEIGHT (w))));
1722 *vpos = it2.vpos;
1724 else
1725 bidi_unshelve_cache (it2data, 1);
1727 bidi_unshelve_cache (itdata, 0);
1729 if (old_buffer)
1730 set_buffer_internal_1 (old_buffer);
1732 if (visible_p && w->hscroll > 0)
1733 *x -=
1734 window_hscroll_limited (w, WINDOW_XFRAME (w))
1735 * WINDOW_FRAME_COLUMN_WIDTH (w);
1737 #if 0
1738 /* Debugging code. */
1739 if (visible_p)
1740 fprintf (stderr, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1741 charpos, w->vscroll, *x, *y, *rtop, *rbot, *rowh, *vpos);
1742 else
1743 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1744 #endif
1746 return visible_p;
1750 /* Return the next character from STR. Return in *LEN the length of
1751 the character. This is like STRING_CHAR_AND_LENGTH but never
1752 returns an invalid character. If we find one, we return a `?', but
1753 with the length of the invalid character. */
1755 static int
1756 string_char_and_length (const unsigned char *str, int *len)
1758 int c;
1760 c = STRING_CHAR_AND_LENGTH (str, *len);
1761 if (!CHAR_VALID_P (c))
1762 /* We may not change the length here because other places in Emacs
1763 don't use this function, i.e. they silently accept invalid
1764 characters. */
1765 c = '?';
1767 return c;
1772 /* Given a position POS containing a valid character and byte position
1773 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1775 static struct text_pos
1776 string_pos_nchars_ahead (struct text_pos pos, Lisp_Object string, ptrdiff_t nchars)
1778 eassert (STRINGP (string) && nchars >= 0);
1780 if (STRING_MULTIBYTE (string))
1782 const unsigned char *p = SDATA (string) + BYTEPOS (pos);
1783 int len;
1785 while (nchars--)
1787 string_char_and_length (p, &len);
1788 p += len;
1789 CHARPOS (pos) += 1;
1790 BYTEPOS (pos) += len;
1793 else
1794 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1796 return pos;
1800 /* Value is the text position, i.e. character and byte position,
1801 for character position CHARPOS in STRING. */
1803 static struct text_pos
1804 string_pos (ptrdiff_t charpos, Lisp_Object string)
1806 struct text_pos pos;
1807 eassert (STRINGP (string));
1808 eassert (charpos >= 0);
1809 SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
1810 return pos;
1814 /* Value is a text position, i.e. character and byte position, for
1815 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1816 means recognize multibyte characters. */
1818 static struct text_pos
1819 c_string_pos (ptrdiff_t charpos, const char *s, bool multibyte_p)
1821 struct text_pos pos;
1823 eassert (s != NULL);
1824 eassert (charpos >= 0);
1826 if (multibyte_p)
1828 int len;
1830 SET_TEXT_POS (pos, 0, 0);
1831 while (charpos--)
1833 string_char_and_length ((const unsigned char *) s, &len);
1834 s += len;
1835 CHARPOS (pos) += 1;
1836 BYTEPOS (pos) += len;
1839 else
1840 SET_TEXT_POS (pos, charpos, charpos);
1842 return pos;
1846 /* Value is the number of characters in C string S. MULTIBYTE_P
1847 non-zero means recognize multibyte characters. */
1849 static ptrdiff_t
1850 number_of_chars (const char *s, bool multibyte_p)
1852 ptrdiff_t nchars;
1854 if (multibyte_p)
1856 ptrdiff_t rest = strlen (s);
1857 int len;
1858 const unsigned char *p = (const unsigned char *) s;
1860 for (nchars = 0; rest > 0; ++nchars)
1862 string_char_and_length (p, &len);
1863 rest -= len, p += len;
1866 else
1867 nchars = strlen (s);
1869 return nchars;
1873 /* Compute byte position NEWPOS->bytepos corresponding to
1874 NEWPOS->charpos. POS is a known position in string STRING.
1875 NEWPOS->charpos must be >= POS.charpos. */
1877 static void
1878 compute_string_pos (struct text_pos *newpos, struct text_pos pos, Lisp_Object string)
1880 eassert (STRINGP (string));
1881 eassert (CHARPOS (*newpos) >= CHARPOS (pos));
1883 if (STRING_MULTIBYTE (string))
1884 *newpos = string_pos_nchars_ahead (pos, string,
1885 CHARPOS (*newpos) - CHARPOS (pos));
1886 else
1887 BYTEPOS (*newpos) = CHARPOS (*newpos);
1890 /* EXPORT:
1891 Return an estimation of the pixel height of mode or header lines on
1892 frame F. FACE_ID specifies what line's height to estimate. */
1895 estimate_mode_line_height (struct frame *f, enum face_id face_id)
1897 #ifdef HAVE_WINDOW_SYSTEM
1898 if (FRAME_WINDOW_P (f))
1900 int height = FONT_HEIGHT (FRAME_FONT (f));
1902 /* This function is called so early when Emacs starts that the face
1903 cache and mode line face are not yet initialized. */
1904 if (FRAME_FACE_CACHE (f))
1906 struct face *face = FACE_FROM_ID (f, face_id);
1907 if (face)
1909 if (face->font)
1910 height = FONT_HEIGHT (face->font);
1911 if (face->box_line_width > 0)
1912 height += 2 * face->box_line_width;
1916 return height;
1918 #endif
1920 return 1;
1923 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1924 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1925 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1926 not force the value into range. */
1928 void
1929 pixel_to_glyph_coords (struct frame *f, register int pix_x, register int pix_y,
1930 int *x, int *y, NativeRectangle *bounds, int noclip)
1933 #ifdef HAVE_WINDOW_SYSTEM
1934 if (FRAME_WINDOW_P (f))
1936 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1937 even for negative values. */
1938 if (pix_x < 0)
1939 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1940 if (pix_y < 0)
1941 pix_y -= FRAME_LINE_HEIGHT (f) - 1;
1943 pix_x = FRAME_PIXEL_X_TO_COL (f, pix_x);
1944 pix_y = FRAME_PIXEL_Y_TO_LINE (f, pix_y);
1946 if (bounds)
1947 STORE_NATIVE_RECT (*bounds,
1948 FRAME_COL_TO_PIXEL_X (f, pix_x),
1949 FRAME_LINE_TO_PIXEL_Y (f, pix_y),
1950 FRAME_COLUMN_WIDTH (f) - 1,
1951 FRAME_LINE_HEIGHT (f) - 1);
1953 /* PXW: Should we clip pixels before converting to columns/lines? */
1954 if (!noclip)
1956 if (pix_x < 0)
1957 pix_x = 0;
1958 else if (pix_x > FRAME_TOTAL_COLS (f))
1959 pix_x = FRAME_TOTAL_COLS (f);
1961 if (pix_y < 0)
1962 pix_y = 0;
1963 else if (pix_y > FRAME_TOTAL_LINES (f))
1964 pix_y = FRAME_TOTAL_LINES (f);
1967 #endif
1969 *x = pix_x;
1970 *y = pix_y;
1974 /* Find the glyph under window-relative coordinates X/Y in window W.
1975 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1976 strings. Return in *HPOS and *VPOS the row and column number of
1977 the glyph found. Return in *AREA the glyph area containing X.
1978 Value is a pointer to the glyph found or null if X/Y is not on
1979 text, or we can't tell because W's current matrix is not up to
1980 date. */
1982 static struct glyph *
1983 x_y_to_hpos_vpos (struct window *w, int x, int y, int *hpos, int *vpos,
1984 int *dx, int *dy, int *area)
1986 struct glyph *glyph, *end;
1987 struct glyph_row *row = NULL;
1988 int x0, i;
1990 /* Find row containing Y. Give up if some row is not enabled. */
1991 for (i = 0; i < w->current_matrix->nrows; ++i)
1993 row = MATRIX_ROW (w->current_matrix, i);
1994 if (!row->enabled_p)
1995 return NULL;
1996 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1997 break;
2000 *vpos = i;
2001 *hpos = 0;
2003 /* Give up if Y is not in the window. */
2004 if (i == w->current_matrix->nrows)
2005 return NULL;
2007 /* Get the glyph area containing X. */
2008 if (w->pseudo_window_p)
2010 *area = TEXT_AREA;
2011 x0 = 0;
2013 else
2015 if (x < window_box_left_offset (w, TEXT_AREA))
2017 *area = LEFT_MARGIN_AREA;
2018 x0 = window_box_left_offset (w, LEFT_MARGIN_AREA);
2020 else if (x < window_box_right_offset (w, TEXT_AREA))
2022 *area = TEXT_AREA;
2023 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
2025 else
2027 *area = RIGHT_MARGIN_AREA;
2028 x0 = window_box_left_offset (w, RIGHT_MARGIN_AREA);
2032 /* Find glyph containing X. */
2033 glyph = row->glyphs[*area];
2034 end = glyph + row->used[*area];
2035 x -= x0;
2036 while (glyph < end && x >= glyph->pixel_width)
2038 x -= glyph->pixel_width;
2039 ++glyph;
2042 if (glyph == end)
2043 return NULL;
2045 if (dx)
2047 *dx = x;
2048 *dy = y - (row->y + row->ascent - glyph->ascent);
2051 *hpos = glyph - row->glyphs[*area];
2052 return glyph;
2055 /* Convert frame-relative x/y to coordinates relative to window W.
2056 Takes pseudo-windows into account. */
2058 static void
2059 frame_to_window_pixel_xy (struct window *w, int *x, int *y)
2061 if (w->pseudo_window_p)
2063 /* A pseudo-window is always full-width, and starts at the
2064 left edge of the frame, plus a frame border. */
2065 struct frame *f = XFRAME (w->frame);
2066 *x -= FRAME_INTERNAL_BORDER_WIDTH (f);
2067 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
2069 else
2071 *x -= WINDOW_LEFT_EDGE_X (w);
2072 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
2076 #ifdef HAVE_WINDOW_SYSTEM
2078 /* EXPORT:
2079 Return in RECTS[] at most N clipping rectangles for glyph string S.
2080 Return the number of stored rectangles. */
2083 get_glyph_string_clip_rects (struct glyph_string *s, NativeRectangle *rects, int n)
2085 XRectangle r;
2087 if (n <= 0)
2088 return 0;
2090 if (s->row->full_width_p)
2092 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2093 r.x = WINDOW_LEFT_EDGE_X (s->w);
2094 if (s->row->mode_line_p)
2095 r.width = WINDOW_PIXEL_WIDTH (s->w) - WINDOW_RIGHT_DIVIDER_WIDTH (s->w);
2096 else
2097 r.width = WINDOW_PIXEL_WIDTH (s->w);
2099 /* Unless displaying a mode or menu bar line, which are always
2100 fully visible, clip to the visible part of the row. */
2101 if (s->w->pseudo_window_p)
2102 r.height = s->row->visible_height;
2103 else
2104 r.height = s->height;
2106 else
2108 /* This is a text line that may be partially visible. */
2109 r.x = window_box_left (s->w, s->area);
2110 r.width = window_box_width (s->w, s->area);
2111 r.height = s->row->visible_height;
2114 if (s->clip_head)
2115 if (r.x < s->clip_head->x)
2117 if (r.width >= s->clip_head->x - r.x)
2118 r.width -= s->clip_head->x - r.x;
2119 else
2120 r.width = 0;
2121 r.x = s->clip_head->x;
2123 if (s->clip_tail)
2124 if (r.x + r.width > s->clip_tail->x + s->clip_tail->background_width)
2126 if (s->clip_tail->x + s->clip_tail->background_width >= r.x)
2127 r.width = s->clip_tail->x + s->clip_tail->background_width - r.x;
2128 else
2129 r.width = 0;
2132 /* If S draws overlapping rows, it's sufficient to use the top and
2133 bottom of the window for clipping because this glyph string
2134 intentionally draws over other lines. */
2135 if (s->for_overlaps)
2137 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2138 r.height = window_text_bottom_y (s->w) - r.y;
2140 /* Alas, the above simple strategy does not work for the
2141 environments with anti-aliased text: if the same text is
2142 drawn onto the same place multiple times, it gets thicker.
2143 If the overlap we are processing is for the erased cursor, we
2144 take the intersection with the rectangle of the cursor. */
2145 if (s->for_overlaps & OVERLAPS_ERASED_CURSOR)
2147 XRectangle rc, r_save = r;
2149 rc.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (s->w, s->w->phys_cursor.x);
2150 rc.y = s->w->phys_cursor.y;
2151 rc.width = s->w->phys_cursor_width;
2152 rc.height = s->w->phys_cursor_height;
2154 x_intersect_rectangles (&r_save, &rc, &r);
2157 else
2159 /* Don't use S->y for clipping because it doesn't take partially
2160 visible lines into account. For example, it can be negative for
2161 partially visible lines at the top of a window. */
2162 if (!s->row->full_width_p
2163 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s->w, s->row))
2164 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2165 else
2166 r.y = max (0, s->row->y);
2169 r.y = WINDOW_TO_FRAME_PIXEL_Y (s->w, r.y);
2171 /* If drawing the cursor, don't let glyph draw outside its
2172 advertised boundaries. Cleartype does this under some circumstances. */
2173 if (s->hl == DRAW_CURSOR)
2175 struct glyph *glyph = s->first_glyph;
2176 int height, max_y;
2178 if (s->x > r.x)
2180 if (r.width >= s->x - r.x)
2181 r.width -= s->x - r.x;
2182 else /* R2L hscrolled row with cursor outside text area */
2183 r.width = 0;
2184 r.x = s->x;
2186 r.width = min (r.width, glyph->pixel_width);
2188 /* If r.y is below window bottom, ensure that we still see a cursor. */
2189 height = min (glyph->ascent + glyph->descent,
2190 min (FRAME_LINE_HEIGHT (s->f), s->row->visible_height));
2191 max_y = window_text_bottom_y (s->w) - height;
2192 max_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, max_y);
2193 if (s->ybase - glyph->ascent > max_y)
2195 r.y = max_y;
2196 r.height = height;
2198 else
2200 /* Don't draw cursor glyph taller than our actual glyph. */
2201 height = max (FRAME_LINE_HEIGHT (s->f), glyph->ascent + glyph->descent);
2202 if (height < r.height)
2204 max_y = r.y + r.height;
2205 r.y = min (max_y, max (r.y, s->ybase + glyph->descent - height));
2206 r.height = min (max_y - r.y, height);
2211 if (s->row->clip)
2213 XRectangle r_save = r;
2215 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2216 r.width = 0;
2219 if ((s->for_overlaps & OVERLAPS_BOTH) == 0
2220 || ((s->for_overlaps & OVERLAPS_BOTH) == OVERLAPS_BOTH && n == 1))
2222 #ifdef CONVERT_FROM_XRECT
2223 CONVERT_FROM_XRECT (r, *rects);
2224 #else
2225 *rects = r;
2226 #endif
2227 return 1;
2229 else
2231 /* If we are processing overlapping and allowed to return
2232 multiple clipping rectangles, we exclude the row of the glyph
2233 string from the clipping rectangle. This is to avoid drawing
2234 the same text on the environment with anti-aliasing. */
2235 #ifdef CONVERT_FROM_XRECT
2236 XRectangle rs[2];
2237 #else
2238 XRectangle *rs = rects;
2239 #endif
2240 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2242 if (s->for_overlaps & OVERLAPS_PRED)
2244 rs[i] = r;
2245 if (r.y + r.height > row_y)
2247 if (r.y < row_y)
2248 rs[i].height = row_y - r.y;
2249 else
2250 rs[i].height = 0;
2252 i++;
2254 if (s->for_overlaps & OVERLAPS_SUCC)
2256 rs[i] = r;
2257 if (r.y < row_y + s->row->visible_height)
2259 if (r.y + r.height > row_y + s->row->visible_height)
2261 rs[i].y = row_y + s->row->visible_height;
2262 rs[i].height = r.y + r.height - rs[i].y;
2264 else
2265 rs[i].height = 0;
2267 i++;
2270 n = i;
2271 #ifdef CONVERT_FROM_XRECT
2272 for (i = 0; i < n; i++)
2273 CONVERT_FROM_XRECT (rs[i], rects[i]);
2274 #endif
2275 return n;
2279 /* EXPORT:
2280 Return in *NR the clipping rectangle for glyph string S. */
2282 void
2283 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2285 get_glyph_string_clip_rects (s, nr, 1);
2289 /* EXPORT:
2290 Return the position and height of the phys cursor in window W.
2291 Set w->phys_cursor_width to width of phys cursor.
2294 void
2295 get_phys_cursor_geometry (struct window *w, struct glyph_row *row,
2296 struct glyph *glyph, int *xp, int *yp, int *heightp)
2298 struct frame *f = XFRAME (WINDOW_FRAME (w));
2299 int x, y, wd, h, h0, y0;
2301 /* Compute the width of the rectangle to draw. If on a stretch
2302 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2303 rectangle as wide as the glyph, but use a canonical character
2304 width instead. */
2305 wd = glyph->pixel_width;
2307 x = w->phys_cursor.x;
2308 if (x < 0)
2310 wd += x;
2311 x = 0;
2314 if (glyph->type == STRETCH_GLYPH
2315 && !x_stretch_cursor_p)
2316 wd = min (FRAME_COLUMN_WIDTH (f), wd);
2317 w->phys_cursor_width = wd;
2319 y = w->phys_cursor.y + row->ascent - glyph->ascent;
2321 /* If y is below window bottom, ensure that we still see a cursor. */
2322 h0 = min (FRAME_LINE_HEIGHT (f), row->visible_height);
2324 h = max (h0, glyph->ascent + glyph->descent);
2325 h0 = min (h0, glyph->ascent + glyph->descent);
2327 y0 = WINDOW_HEADER_LINE_HEIGHT (w);
2328 if (y < y0)
2330 h = max (h - (y0 - y) + 1, h0);
2331 y = y0 - 1;
2333 else
2335 y0 = window_text_bottom_y (w) - h0;
2336 if (y > y0)
2338 h += y - y0;
2339 y = y0;
2343 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2344 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2345 *heightp = h;
2349 * Remember which glyph the mouse is over.
2352 void
2353 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2355 Lisp_Object window;
2356 struct window *w;
2357 struct glyph_row *r, *gr, *end_row;
2358 enum window_part part;
2359 enum glyph_row_area area;
2360 int x, y, width, height;
2362 /* Try to determine frame pixel position and size of the glyph under
2363 frame pixel coordinates X/Y on frame F. */
2365 if (window_resize_pixelwise)
2367 width = height = 1;
2368 goto virtual_glyph;
2370 else if (!f->glyphs_initialized_p
2371 || (window = window_from_coordinates (f, gx, gy, &part, 0),
2372 NILP (window)))
2374 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2375 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2376 goto virtual_glyph;
2379 w = XWINDOW (window);
2380 width = WINDOW_FRAME_COLUMN_WIDTH (w);
2381 height = WINDOW_FRAME_LINE_HEIGHT (w);
2383 x = window_relative_x_coord (w, part, gx);
2384 y = gy - WINDOW_TOP_EDGE_Y (w);
2386 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
2387 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
2389 if (w->pseudo_window_p)
2391 area = TEXT_AREA;
2392 part = ON_MODE_LINE; /* Don't adjust margin. */
2393 goto text_glyph;
2396 switch (part)
2398 case ON_LEFT_MARGIN:
2399 area = LEFT_MARGIN_AREA;
2400 goto text_glyph;
2402 case ON_RIGHT_MARGIN:
2403 area = RIGHT_MARGIN_AREA;
2404 goto text_glyph;
2406 case ON_HEADER_LINE:
2407 case ON_MODE_LINE:
2408 gr = (part == ON_HEADER_LINE
2409 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2410 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2411 gy = gr->y;
2412 area = TEXT_AREA;
2413 goto text_glyph_row_found;
2415 case ON_TEXT:
2416 area = TEXT_AREA;
2418 text_glyph:
2419 gr = 0; gy = 0;
2420 for (; r <= end_row && r->enabled_p; ++r)
2421 if (r->y + r->height > y)
2423 gr = r; gy = r->y;
2424 break;
2427 text_glyph_row_found:
2428 if (gr && gy <= y)
2430 struct glyph *g = gr->glyphs[area];
2431 struct glyph *end = g + gr->used[area];
2433 height = gr->height;
2434 for (gx = gr->x; g < end; gx += g->pixel_width, ++g)
2435 if (gx + g->pixel_width > x)
2436 break;
2438 if (g < end)
2440 if (g->type == IMAGE_GLYPH)
2442 /* Don't remember when mouse is over image, as
2443 image may have hot-spots. */
2444 STORE_NATIVE_RECT (*rect, 0, 0, 0, 0);
2445 return;
2447 width = g->pixel_width;
2449 else
2451 /* Use nominal char spacing at end of line. */
2452 x -= gx;
2453 gx += (x / width) * width;
2456 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2458 gx += window_box_left_offset (w, area);
2459 /* Don't expand over the modeline to make sure the vertical
2460 drag cursor is shown early enough. */
2461 height = min (height,
2462 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2465 else
2467 /* Use nominal line height at end of window. */
2468 gx = (x / width) * width;
2469 y -= gy;
2470 gy += (y / height) * height;
2471 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2472 /* See comment above. */
2473 height = min (height,
2474 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2476 break;
2478 case ON_LEFT_FRINGE:
2479 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2480 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2481 : window_box_right_offset (w, LEFT_MARGIN_AREA));
2482 width = WINDOW_LEFT_FRINGE_WIDTH (w);
2483 goto row_glyph;
2485 case ON_RIGHT_FRINGE:
2486 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2487 ? window_box_right_offset (w, RIGHT_MARGIN_AREA)
2488 : window_box_right_offset (w, TEXT_AREA));
2489 if (WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
2490 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
2491 && !WINDOW_RIGHTMOST_P (w))
2492 if (gx < WINDOW_PIXEL_WIDTH (w) - width)
2493 /* Make sure the vertical border can get her own glyph to the
2494 right of the one we build here. */
2495 width = WINDOW_RIGHT_FRINGE_WIDTH (w) - width;
2496 else
2497 width = WINDOW_PIXEL_WIDTH (w) - gx;
2498 else
2499 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2501 goto row_glyph;
2503 case ON_VERTICAL_BORDER:
2504 gx = WINDOW_PIXEL_WIDTH (w) - width;
2505 goto row_glyph;
2507 case ON_VERTICAL_SCROLL_BAR:
2508 gx = (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
2510 : (window_box_right_offset (w, RIGHT_MARGIN_AREA)
2511 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2512 ? WINDOW_RIGHT_FRINGE_WIDTH (w)
2513 : 0)));
2514 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2516 row_glyph:
2517 gr = 0, gy = 0;
2518 for (; r <= end_row && r->enabled_p; ++r)
2519 if (r->y + r->height > y)
2521 gr = r; gy = r->y;
2522 break;
2525 if (gr && gy <= y)
2526 height = gr->height;
2527 else
2529 /* Use nominal line height at end of window. */
2530 y -= gy;
2531 gy += (y / height) * height;
2533 break;
2535 case ON_RIGHT_DIVIDER:
2536 gx = WINDOW_PIXEL_WIDTH (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
2537 width = WINDOW_RIGHT_DIVIDER_WIDTH (w);
2538 gy = 0;
2539 /* The bottom divider prevails. */
2540 height = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2541 goto add_edge;
2543 case ON_BOTTOM_DIVIDER:
2544 gx = 0;
2545 width = WINDOW_PIXEL_WIDTH (w);
2546 gy = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2547 height = WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2548 goto add_edge;
2550 default:
2552 virtual_glyph:
2553 /* If there is no glyph under the mouse, then we divide the screen
2554 into a grid of the smallest glyph in the frame, and use that
2555 as our "glyph". */
2557 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2558 round down even for negative values. */
2559 if (gx < 0)
2560 gx -= width - 1;
2561 if (gy < 0)
2562 gy -= height - 1;
2564 gx = (gx / width) * width;
2565 gy = (gy / height) * height;
2567 goto store_rect;
2570 add_edge:
2571 gx += WINDOW_LEFT_EDGE_X (w);
2572 gy += WINDOW_TOP_EDGE_Y (w);
2574 store_rect:
2575 STORE_NATIVE_RECT (*rect, gx, gy, width, height);
2577 /* Visible feedback for debugging. */
2578 #if 0
2579 #if HAVE_X_WINDOWS
2580 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2581 f->output_data.x->normal_gc,
2582 gx, gy, width, height);
2583 #endif
2584 #endif
2588 #endif /* HAVE_WINDOW_SYSTEM */
2590 static void
2591 adjust_window_ends (struct window *w, struct glyph_row *row, bool current)
2593 eassert (w);
2594 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
2595 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
2596 w->window_end_vpos
2597 = MATRIX_ROW_VPOS (row, current ? w->current_matrix : w->desired_matrix);
2600 /***********************************************************************
2601 Lisp form evaluation
2602 ***********************************************************************/
2604 /* Error handler for safe_eval and safe_call. */
2606 static Lisp_Object
2607 safe_eval_handler (Lisp_Object arg, ptrdiff_t nargs, Lisp_Object *args)
2609 add_to_log ("Error during redisplay: %S signaled %S",
2610 Flist (nargs, args), arg);
2611 return Qnil;
2614 /* Call function FUNC with the rest of NARGS - 1 arguments
2615 following. Return the result, or nil if something went
2616 wrong. Prevent redisplay during the evaluation. */
2618 static Lisp_Object
2619 safe__call (bool inhibit_quit, ptrdiff_t nargs, Lisp_Object func, va_list ap)
2621 Lisp_Object val;
2623 if (inhibit_eval_during_redisplay)
2624 val = Qnil;
2625 else
2627 ptrdiff_t i;
2628 ptrdiff_t count = SPECPDL_INDEX ();
2629 Lisp_Object *args;
2630 USE_SAFE_ALLOCA;
2631 SAFE_ALLOCA_LISP (args, nargs);
2633 args[0] = func;
2634 for (i = 1; i < nargs; i++)
2635 args[i] = va_arg (ap, Lisp_Object);
2637 specbind (Qinhibit_redisplay, Qt);
2638 if (inhibit_quit)
2639 specbind (Qinhibit_quit, Qt);
2640 /* Use Qt to ensure debugger does not run,
2641 so there is no possibility of wanting to redisplay. */
2642 val = internal_condition_case_n (Ffuncall, nargs, args, Qt,
2643 safe_eval_handler);
2644 SAFE_FREE ();
2645 val = unbind_to (count, val);
2648 return val;
2651 Lisp_Object
2652 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2654 Lisp_Object retval;
2655 va_list ap;
2657 va_start (ap, func);
2658 retval = safe__call (false, nargs, func, ap);
2659 va_end (ap);
2660 return retval;
2663 /* Call function FN with one argument ARG.
2664 Return the result, or nil if something went wrong. */
2666 Lisp_Object
2667 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2669 return safe_call (2, fn, arg);
2672 static Lisp_Object
2673 safe__call1 (bool inhibit_quit, Lisp_Object fn, ...)
2675 Lisp_Object retval;
2676 va_list ap;
2678 va_start (ap, fn);
2679 retval = safe__call (inhibit_quit, 2, fn, ap);
2680 va_end (ap);
2681 return retval;
2684 static Lisp_Object Qeval;
2686 Lisp_Object
2687 safe_eval (Lisp_Object sexpr)
2689 return safe__call1 (false, Qeval, sexpr);
2692 static Lisp_Object
2693 safe__eval (bool inhibit_quit, Lisp_Object sexpr)
2695 return safe__call1 (inhibit_quit, Qeval, sexpr);
2698 /* Call function FN with two arguments ARG1 and ARG2.
2699 Return the result, or nil if something went wrong. */
2701 Lisp_Object
2702 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2704 return safe_call (3, fn, arg1, arg2);
2709 /***********************************************************************
2710 Debugging
2711 ***********************************************************************/
2713 #if 0
2715 /* Define CHECK_IT to perform sanity checks on iterators.
2716 This is for debugging. It is too slow to do unconditionally. */
2718 static void
2719 check_it (struct it *it)
2721 if (it->method == GET_FROM_STRING)
2723 eassert (STRINGP (it->string));
2724 eassert (IT_STRING_CHARPOS (*it) >= 0);
2726 else
2728 eassert (IT_STRING_CHARPOS (*it) < 0);
2729 if (it->method == GET_FROM_BUFFER)
2731 /* Check that character and byte positions agree. */
2732 eassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
2736 if (it->dpvec)
2737 eassert (it->current.dpvec_index >= 0);
2738 else
2739 eassert (it->current.dpvec_index < 0);
2742 #define CHECK_IT(IT) check_it ((IT))
2744 #else /* not 0 */
2746 #define CHECK_IT(IT) (void) 0
2748 #endif /* not 0 */
2751 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2753 /* Check that the window end of window W is what we expect it
2754 to be---the last row in the current matrix displaying text. */
2756 static void
2757 check_window_end (struct window *w)
2759 if (!MINI_WINDOW_P (w) && w->window_end_valid)
2761 struct glyph_row *row;
2762 eassert ((row = MATRIX_ROW (w->current_matrix, w->window_end_vpos),
2763 !row->enabled_p
2764 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2765 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2769 #define CHECK_WINDOW_END(W) check_window_end ((W))
2771 #else
2773 #define CHECK_WINDOW_END(W) (void) 0
2775 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2777 /***********************************************************************
2778 Iterator initialization
2779 ***********************************************************************/
2781 /* Initialize IT for displaying current_buffer in window W, starting
2782 at character position CHARPOS. CHARPOS < 0 means that no buffer
2783 position is specified which is useful when the iterator is assigned
2784 a position later. BYTEPOS is the byte position corresponding to
2785 CHARPOS.
2787 If ROW is not null, calls to produce_glyphs with IT as parameter
2788 will produce glyphs in that row.
2790 BASE_FACE_ID is the id of a base face to use. It must be one of
2791 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2792 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2793 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2795 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2796 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2797 will be initialized to use the corresponding mode line glyph row of
2798 the desired matrix of W. */
2800 void
2801 init_iterator (struct it *it, struct window *w,
2802 ptrdiff_t charpos, ptrdiff_t bytepos,
2803 struct glyph_row *row, enum face_id base_face_id)
2805 enum face_id remapped_base_face_id = base_face_id;
2807 /* Some precondition checks. */
2808 eassert (w != NULL && it != NULL);
2809 eassert (charpos < 0 || (charpos >= BUF_BEG (current_buffer)
2810 && charpos <= ZV));
2812 /* If face attributes have been changed since the last redisplay,
2813 free realized faces now because they depend on face definitions
2814 that might have changed. Don't free faces while there might be
2815 desired matrices pending which reference these faces. */
2816 if (face_change_count && !inhibit_free_realized_faces)
2818 face_change_count = 0;
2819 free_all_realized_faces (Qnil);
2822 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2823 if (! NILP (Vface_remapping_alist))
2824 remapped_base_face_id
2825 = lookup_basic_face (XFRAME (w->frame), base_face_id);
2827 /* Use one of the mode line rows of W's desired matrix if
2828 appropriate. */
2829 if (row == NULL)
2831 if (base_face_id == MODE_LINE_FACE_ID
2832 || base_face_id == MODE_LINE_INACTIVE_FACE_ID)
2833 row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
2834 else if (base_face_id == HEADER_LINE_FACE_ID)
2835 row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
2838 /* Clear IT. */
2839 memset (it, 0, sizeof *it);
2840 it->current.overlay_string_index = -1;
2841 it->current.dpvec_index = -1;
2842 it->base_face_id = remapped_base_face_id;
2843 it->string = Qnil;
2844 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
2845 it->paragraph_embedding = L2R;
2846 it->bidi_it.string.lstring = Qnil;
2847 it->bidi_it.string.s = NULL;
2848 it->bidi_it.string.bufpos = 0;
2849 it->bidi_it.w = w;
2851 /* The window in which we iterate over current_buffer: */
2852 XSETWINDOW (it->window, w);
2853 it->w = w;
2854 it->f = XFRAME (w->frame);
2856 it->cmp_it.id = -1;
2858 /* Extra space between lines (on window systems only). */
2859 if (base_face_id == DEFAULT_FACE_ID
2860 && FRAME_WINDOW_P (it->f))
2862 if (NATNUMP (BVAR (current_buffer, extra_line_spacing)))
2863 it->extra_line_spacing = XFASTINT (BVAR (current_buffer, extra_line_spacing));
2864 else if (FLOATP (BVAR (current_buffer, extra_line_spacing)))
2865 it->extra_line_spacing = (XFLOAT_DATA (BVAR (current_buffer, extra_line_spacing))
2866 * FRAME_LINE_HEIGHT (it->f));
2867 else if (it->f->extra_line_spacing > 0)
2868 it->extra_line_spacing = it->f->extra_line_spacing;
2869 it->max_extra_line_spacing = 0;
2872 /* If realized faces have been removed, e.g. because of face
2873 attribute changes of named faces, recompute them. When running
2874 in batch mode, the face cache of the initial frame is null. If
2875 we happen to get called, make a dummy face cache. */
2876 if (FRAME_FACE_CACHE (it->f) == NULL)
2877 init_frame_faces (it->f);
2878 if (FRAME_FACE_CACHE (it->f)->used == 0)
2879 recompute_basic_faces (it->f);
2881 /* Current value of the `slice', `space-width', and 'height' properties. */
2882 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
2883 it->space_width = Qnil;
2884 it->font_height = Qnil;
2885 it->override_ascent = -1;
2887 /* Are control characters displayed as `^C'? */
2888 it->ctl_arrow_p = !NILP (BVAR (current_buffer, ctl_arrow));
2890 /* -1 means everything between a CR and the following line end
2891 is invisible. >0 means lines indented more than this value are
2892 invisible. */
2893 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2894 ? (clip_to_bounds
2895 (-1, XINT (BVAR (current_buffer, selective_display)),
2896 PTRDIFF_MAX))
2897 : (!NILP (BVAR (current_buffer, selective_display))
2898 ? -1 : 0));
2899 it->selective_display_ellipsis_p
2900 = !NILP (BVAR (current_buffer, selective_display_ellipses));
2902 /* Display table to use. */
2903 it->dp = window_display_table (w);
2905 /* Are multibyte characters enabled in current_buffer? */
2906 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2908 /* Get the position at which the redisplay_end_trigger hook should
2909 be run, if it is to be run at all. */
2910 if (MARKERP (w->redisplay_end_trigger)
2911 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
2912 it->redisplay_end_trigger_charpos
2913 = marker_position (w->redisplay_end_trigger);
2914 else if (INTEGERP (w->redisplay_end_trigger))
2915 it->redisplay_end_trigger_charpos
2916 = clip_to_bounds (PTRDIFF_MIN, XINT (w->redisplay_end_trigger),
2917 PTRDIFF_MAX);
2919 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2921 /* Are lines in the display truncated? */
2922 if (base_face_id != DEFAULT_FACE_ID
2923 || it->w->hscroll
2924 || (! WINDOW_FULL_WIDTH_P (it->w)
2925 && ((!NILP (Vtruncate_partial_width_windows)
2926 && !INTEGERP (Vtruncate_partial_width_windows))
2927 || (INTEGERP (Vtruncate_partial_width_windows)
2928 /* PXW: Shall we do something about this? */
2929 && (WINDOW_TOTAL_COLS (it->w)
2930 < XINT (Vtruncate_partial_width_windows))))))
2931 it->line_wrap = TRUNCATE;
2932 else if (NILP (BVAR (current_buffer, truncate_lines)))
2933 it->line_wrap = NILP (BVAR (current_buffer, word_wrap))
2934 ? WINDOW_WRAP : WORD_WRAP;
2935 else
2936 it->line_wrap = TRUNCATE;
2938 /* Get dimensions of truncation and continuation glyphs. These are
2939 displayed as fringe bitmaps under X, but we need them for such
2940 frames when the fringes are turned off. But leave the dimensions
2941 zero for tooltip frames, as these glyphs look ugly there and also
2942 sabotage calculations of tooltip dimensions in x-show-tip. */
2943 #ifdef HAVE_WINDOW_SYSTEM
2944 if (!(FRAME_WINDOW_P (it->f)
2945 && FRAMEP (tip_frame)
2946 && it->f == XFRAME (tip_frame)))
2947 #endif
2949 if (it->line_wrap == TRUNCATE)
2951 /* We will need the truncation glyph. */
2952 eassert (it->glyph_row == NULL);
2953 produce_special_glyphs (it, IT_TRUNCATION);
2954 it->truncation_pixel_width = it->pixel_width;
2956 else
2958 /* We will need the continuation glyph. */
2959 eassert (it->glyph_row == NULL);
2960 produce_special_glyphs (it, IT_CONTINUATION);
2961 it->continuation_pixel_width = it->pixel_width;
2965 /* Reset these values to zero because the produce_special_glyphs
2966 above has changed them. */
2967 it->pixel_width = it->ascent = it->descent = 0;
2968 it->phys_ascent = it->phys_descent = 0;
2970 /* Set this after getting the dimensions of truncation and
2971 continuation glyphs, so that we don't produce glyphs when calling
2972 produce_special_glyphs, above. */
2973 it->glyph_row = row;
2974 it->area = TEXT_AREA;
2976 /* Get the dimensions of the display area. The display area
2977 consists of the visible window area plus a horizontally scrolled
2978 part to the left of the window. All x-values are relative to the
2979 start of this total display area. */
2980 if (base_face_id != DEFAULT_FACE_ID)
2982 /* Mode lines, menu bar in terminal frames. */
2983 it->first_visible_x = 0;
2984 it->last_visible_x = WINDOW_PIXEL_WIDTH (w);
2986 else
2988 it->first_visible_x
2989 = window_hscroll_limited (it->w, it->f) * FRAME_COLUMN_WIDTH (it->f);
2990 it->last_visible_x = (it->first_visible_x
2991 + window_box_width (w, TEXT_AREA));
2993 /* If we truncate lines, leave room for the truncation glyph(s) at
2994 the right margin. Otherwise, leave room for the continuation
2995 glyph(s). Done only if the window has no right fringe. */
2996 if (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
2998 if (it->line_wrap == TRUNCATE)
2999 it->last_visible_x -= it->truncation_pixel_width;
3000 else
3001 it->last_visible_x -= it->continuation_pixel_width;
3004 it->header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
3005 it->current_y = WINDOW_HEADER_LINE_HEIGHT (w) + w->vscroll;
3008 /* Leave room for a border glyph. */
3009 if (!FRAME_WINDOW_P (it->f)
3010 && !WINDOW_RIGHTMOST_P (it->w))
3011 it->last_visible_x -= 1;
3013 it->last_visible_y = window_text_bottom_y (w);
3015 /* For mode lines and alike, arrange for the first glyph having a
3016 left box line if the face specifies a box. */
3017 if (base_face_id != DEFAULT_FACE_ID)
3019 struct face *face;
3021 it->face_id = remapped_base_face_id;
3023 /* If we have a boxed mode line, make the first character appear
3024 with a left box line. */
3025 face = FACE_FROM_ID (it->f, remapped_base_face_id);
3026 if (face && face->box != FACE_NO_BOX)
3027 it->start_of_box_run_p = true;
3030 /* If a buffer position was specified, set the iterator there,
3031 getting overlays and face properties from that position. */
3032 if (charpos >= BUF_BEG (current_buffer))
3034 it->stop_charpos = charpos;
3035 it->end_charpos = ZV;
3036 eassert (charpos == BYTE_TO_CHAR (bytepos));
3037 IT_CHARPOS (*it) = charpos;
3038 IT_BYTEPOS (*it) = bytepos;
3040 /* We will rely on `reseat' to set this up properly, via
3041 handle_face_prop. */
3042 it->face_id = it->base_face_id;
3044 it->start = it->current;
3045 /* Do we need to reorder bidirectional text? Not if this is a
3046 unibyte buffer: by definition, none of the single-byte
3047 characters are strong R2L, so no reordering is needed. And
3048 bidi.c doesn't support unibyte buffers anyway. Also, don't
3049 reorder while we are loading loadup.el, since the tables of
3050 character properties needed for reordering are not yet
3051 available. */
3052 it->bidi_p =
3053 NILP (Vpurify_flag)
3054 && !NILP (BVAR (current_buffer, bidi_display_reordering))
3055 && it->multibyte_p;
3057 /* If we are to reorder bidirectional text, init the bidi
3058 iterator. */
3059 if (it->bidi_p)
3061 /* Since we don't know at this point whether there will be
3062 any R2L lines in the window, we reserve space for
3063 truncation/continuation glyphs even if only the left
3064 fringe is absent. */
3065 if (base_face_id == DEFAULT_FACE_ID
3066 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
3067 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
3069 if (it->line_wrap == TRUNCATE)
3070 it->last_visible_x -= it->truncation_pixel_width;
3071 else
3072 it->last_visible_x -= it->continuation_pixel_width;
3074 /* Note the paragraph direction that this buffer wants to
3075 use. */
3076 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
3077 Qleft_to_right))
3078 it->paragraph_embedding = L2R;
3079 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
3080 Qright_to_left))
3081 it->paragraph_embedding = R2L;
3082 else
3083 it->paragraph_embedding = NEUTRAL_DIR;
3084 bidi_unshelve_cache (NULL, 0);
3085 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
3086 &it->bidi_it);
3089 /* Compute faces etc. */
3090 reseat (it, it->current.pos, 1);
3093 CHECK_IT (it);
3097 /* Initialize IT for the display of window W with window start POS. */
3099 void
3100 start_display (struct it *it, struct window *w, struct text_pos pos)
3102 struct glyph_row *row;
3103 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
3105 row = w->desired_matrix->rows + first_vpos;
3106 init_iterator (it, w, CHARPOS (pos), BYTEPOS (pos), row, DEFAULT_FACE_ID);
3107 it->first_vpos = first_vpos;
3109 /* Don't reseat to previous visible line start if current start
3110 position is in a string or image. */
3111 if (it->method == GET_FROM_BUFFER && it->line_wrap != TRUNCATE)
3113 int start_at_line_beg_p;
3114 int first_y = it->current_y;
3116 /* If window start is not at a line start, skip forward to POS to
3117 get the correct continuation lines width. */
3118 start_at_line_beg_p = (CHARPOS (pos) == BEGV
3119 || FETCH_BYTE (BYTEPOS (pos) - 1) == '\n');
3120 if (!start_at_line_beg_p)
3122 int new_x;
3124 reseat_at_previous_visible_line_start (it);
3125 move_it_to (it, CHARPOS (pos), -1, -1, -1, MOVE_TO_POS);
3127 new_x = it->current_x + it->pixel_width;
3129 /* If lines are continued, this line may end in the middle
3130 of a multi-glyph character (e.g. a control character
3131 displayed as \003, or in the middle of an overlay
3132 string). In this case move_it_to above will not have
3133 taken us to the start of the continuation line but to the
3134 end of the continued line. */
3135 if (it->current_x > 0
3136 && it->line_wrap != TRUNCATE /* Lines are continued. */
3137 && (/* And glyph doesn't fit on the line. */
3138 new_x > it->last_visible_x
3139 /* Or it fits exactly and we're on a window
3140 system frame. */
3141 || (new_x == it->last_visible_x
3142 && FRAME_WINDOW_P (it->f)
3143 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
3144 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
3145 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
3147 if ((it->current.dpvec_index >= 0
3148 || it->current.overlay_string_index >= 0)
3149 /* If we are on a newline from a display vector or
3150 overlay string, then we are already at the end of
3151 a screen line; no need to go to the next line in
3152 that case, as this line is not really continued.
3153 (If we do go to the next line, C-e will not DTRT.) */
3154 && it->c != '\n')
3156 set_iterator_to_next (it, 1);
3157 move_it_in_display_line_to (it, -1, -1, 0);
3160 it->continuation_lines_width += it->current_x;
3162 /* If the character at POS is displayed via a display
3163 vector, move_it_to above stops at the final glyph of
3164 IT->dpvec. To make the caller redisplay that character
3165 again (a.k.a. start at POS), we need to reset the
3166 dpvec_index to the beginning of IT->dpvec. */
3167 else if (it->current.dpvec_index >= 0)
3168 it->current.dpvec_index = 0;
3170 /* We're starting a new display line, not affected by the
3171 height of the continued line, so clear the appropriate
3172 fields in the iterator structure. */
3173 it->max_ascent = it->max_descent = 0;
3174 it->max_phys_ascent = it->max_phys_descent = 0;
3176 it->current_y = first_y;
3177 it->vpos = 0;
3178 it->current_x = it->hpos = 0;
3184 /* Return 1 if POS is a position in ellipses displayed for invisible
3185 text. W is the window we display, for text property lookup. */
3187 static int
3188 in_ellipses_for_invisible_text_p (struct display_pos *pos, struct window *w)
3190 Lisp_Object prop, window;
3191 int ellipses_p = 0;
3192 ptrdiff_t charpos = CHARPOS (pos->pos);
3194 /* If POS specifies a position in a display vector, this might
3195 be for an ellipsis displayed for invisible text. We won't
3196 get the iterator set up for delivering that ellipsis unless
3197 we make sure that it gets aware of the invisible text. */
3198 if (pos->dpvec_index >= 0
3199 && pos->overlay_string_index < 0
3200 && CHARPOS (pos->string_pos) < 0
3201 && charpos > BEGV
3202 && (XSETWINDOW (window, w),
3203 prop = Fget_char_property (make_number (charpos),
3204 Qinvisible, window),
3205 !TEXT_PROP_MEANS_INVISIBLE (prop)))
3207 prop = Fget_char_property (make_number (charpos - 1), Qinvisible,
3208 window);
3209 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3212 return ellipses_p;
3216 /* Initialize IT for stepping through current_buffer in window W,
3217 starting at position POS that includes overlay string and display
3218 vector/ control character translation position information. Value
3219 is zero if there are overlay strings with newlines at POS. */
3221 static int
3222 init_from_display_pos (struct it *it, struct window *w, struct display_pos *pos)
3224 ptrdiff_t charpos = CHARPOS (pos->pos), bytepos = BYTEPOS (pos->pos);
3225 int i, overlay_strings_with_newlines = 0;
3227 /* If POS specifies a position in a display vector, this might
3228 be for an ellipsis displayed for invisible text. We won't
3229 get the iterator set up for delivering that ellipsis unless
3230 we make sure that it gets aware of the invisible text. */
3231 if (in_ellipses_for_invisible_text_p (pos, w))
3233 --charpos;
3234 bytepos = 0;
3237 /* Keep in mind: the call to reseat in init_iterator skips invisible
3238 text, so we might end up at a position different from POS. This
3239 is only a problem when POS is a row start after a newline and an
3240 overlay starts there with an after-string, and the overlay has an
3241 invisible property. Since we don't skip invisible text in
3242 display_line and elsewhere immediately after consuming the
3243 newline before the row start, such a POS will not be in a string,
3244 but the call to init_iterator below will move us to the
3245 after-string. */
3246 init_iterator (it, w, charpos, bytepos, NULL, DEFAULT_FACE_ID);
3248 /* This only scans the current chunk -- it should scan all chunks.
3249 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3250 to 16 in 22.1 to make this a lesser problem. */
3251 for (i = 0; i < it->n_overlay_strings && i < OVERLAY_STRING_CHUNK_SIZE; ++i)
3253 const char *s = SSDATA (it->overlay_strings[i]);
3254 const char *e = s + SBYTES (it->overlay_strings[i]);
3256 while (s < e && *s != '\n')
3257 ++s;
3259 if (s < e)
3261 overlay_strings_with_newlines = 1;
3262 break;
3266 /* If position is within an overlay string, set up IT to the right
3267 overlay string. */
3268 if (pos->overlay_string_index >= 0)
3270 int relative_index;
3272 /* If the first overlay string happens to have a `display'
3273 property for an image, the iterator will be set up for that
3274 image, and we have to undo that setup first before we can
3275 correct the overlay string index. */
3276 if (it->method == GET_FROM_IMAGE)
3277 pop_it (it);
3279 /* We already have the first chunk of overlay strings in
3280 IT->overlay_strings. Load more until the one for
3281 pos->overlay_string_index is in IT->overlay_strings. */
3282 if (pos->overlay_string_index >= OVERLAY_STRING_CHUNK_SIZE)
3284 ptrdiff_t n = pos->overlay_string_index / OVERLAY_STRING_CHUNK_SIZE;
3285 it->current.overlay_string_index = 0;
3286 while (n--)
3288 load_overlay_strings (it, 0);
3289 it->current.overlay_string_index += OVERLAY_STRING_CHUNK_SIZE;
3293 it->current.overlay_string_index = pos->overlay_string_index;
3294 relative_index = (it->current.overlay_string_index
3295 % OVERLAY_STRING_CHUNK_SIZE);
3296 it->string = it->overlay_strings[relative_index];
3297 eassert (STRINGP (it->string));
3298 it->current.string_pos = pos->string_pos;
3299 it->method = GET_FROM_STRING;
3300 it->end_charpos = SCHARS (it->string);
3301 /* Set up the bidi iterator for this overlay string. */
3302 if (it->bidi_p)
3304 it->bidi_it.string.lstring = it->string;
3305 it->bidi_it.string.s = NULL;
3306 it->bidi_it.string.schars = SCHARS (it->string);
3307 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
3308 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
3309 it->bidi_it.string.unibyte = !it->multibyte_p;
3310 it->bidi_it.w = it->w;
3311 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3312 FRAME_WINDOW_P (it->f), &it->bidi_it);
3314 /* Synchronize the state of the bidi iterator with
3315 pos->string_pos. For any string position other than
3316 zero, this will be done automagically when we resume
3317 iteration over the string and get_visually_first_element
3318 is called. But if string_pos is zero, and the string is
3319 to be reordered for display, we need to resync manually,
3320 since it could be that the iteration state recorded in
3321 pos ended at string_pos of 0 moving backwards in string. */
3322 if (CHARPOS (pos->string_pos) == 0)
3324 get_visually_first_element (it);
3325 if (IT_STRING_CHARPOS (*it) != 0)
3326 do {
3327 /* Paranoia. */
3328 eassert (it->bidi_it.charpos < it->bidi_it.string.schars);
3329 bidi_move_to_visually_next (&it->bidi_it);
3330 } while (it->bidi_it.charpos != 0);
3332 eassert (IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
3333 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos);
3337 if (CHARPOS (pos->string_pos) >= 0)
3339 /* Recorded position is not in an overlay string, but in another
3340 string. This can only be a string from a `display' property.
3341 IT should already be filled with that string. */
3342 it->current.string_pos = pos->string_pos;
3343 eassert (STRINGP (it->string));
3344 if (it->bidi_p)
3345 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3346 FRAME_WINDOW_P (it->f), &it->bidi_it);
3349 /* Restore position in display vector translations, control
3350 character translations or ellipses. */
3351 if (pos->dpvec_index >= 0)
3353 if (it->dpvec == NULL)
3354 get_next_display_element (it);
3355 eassert (it->dpvec && it->current.dpvec_index == 0);
3356 it->current.dpvec_index = pos->dpvec_index;
3359 CHECK_IT (it);
3360 return !overlay_strings_with_newlines;
3364 /* Initialize IT for stepping through current_buffer in window W
3365 starting at ROW->start. */
3367 static void
3368 init_to_row_start (struct it *it, struct window *w, struct glyph_row *row)
3370 init_from_display_pos (it, w, &row->start);
3371 it->start = row->start;
3372 it->continuation_lines_width = row->continuation_lines_width;
3373 CHECK_IT (it);
3377 /* Initialize IT for stepping through current_buffer in window W
3378 starting in the line following ROW, i.e. starting at ROW->end.
3379 Value is zero if there are overlay strings with newlines at ROW's
3380 end position. */
3382 static int
3383 init_to_row_end (struct it *it, struct window *w, struct glyph_row *row)
3385 int success = 0;
3387 if (init_from_display_pos (it, w, &row->end))
3389 if (row->continued_p)
3390 it->continuation_lines_width
3391 = row->continuation_lines_width + row->pixel_width;
3392 CHECK_IT (it);
3393 success = 1;
3396 return success;
3402 /***********************************************************************
3403 Text properties
3404 ***********************************************************************/
3406 /* Called when IT reaches IT->stop_charpos. Handle text property and
3407 overlay changes. Set IT->stop_charpos to the next position where
3408 to stop. */
3410 static void
3411 handle_stop (struct it *it)
3413 enum prop_handled handled;
3414 int handle_overlay_change_p;
3415 struct props *p;
3417 it->dpvec = NULL;
3418 it->current.dpvec_index = -1;
3419 handle_overlay_change_p = !it->ignore_overlay_strings_at_pos_p;
3420 it->ignore_overlay_strings_at_pos_p = 0;
3421 it->ellipsis_p = 0;
3423 /* Use face of preceding text for ellipsis (if invisible) */
3424 if (it->selective_display_ellipsis_p)
3425 it->saved_face_id = it->face_id;
3427 /* Here's the description of the semantics of, and the logic behind,
3428 the various HANDLED_* statuses:
3430 HANDLED_NORMALLY means the handler did its job, and the loop
3431 should proceed to calling the next handler in order.
3433 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3434 change in the properties and overlays at current position, so the
3435 loop should be restarted, to re-invoke the handlers that were
3436 already called. This happens when fontification-functions were
3437 called by handle_fontified_prop, and actually fontified
3438 something. Another case where HANDLED_RECOMPUTE_PROPS is
3439 returned is when we discover overlay strings that need to be
3440 displayed right away. The loop below will continue for as long
3441 as the status is HANDLED_RECOMPUTE_PROPS.
3443 HANDLED_RETURN means return immediately to the caller, to
3444 continue iteration without calling any further handlers. This is
3445 used when we need to act on some property right away, for example
3446 when we need to display the ellipsis or a replacing display
3447 property, such as display string or image.
3449 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3450 consumed, and the handler switched to the next overlay string.
3451 This signals the loop below to refrain from looking for more
3452 overlays before all the overlay strings of the current overlay
3453 are processed.
3455 Some of the handlers called by the loop push the iterator state
3456 onto the stack (see 'push_it'), and arrange for the iteration to
3457 continue with another object, such as an image, a display string,
3458 or an overlay string. In most such cases, it->stop_charpos is
3459 set to the first character of the string, so that when the
3460 iteration resumes, this function will immediately be called
3461 again, to examine the properties at the beginning of the string.
3463 When a display or overlay string is exhausted, the iterator state
3464 is popped (see 'pop_it'), and iteration continues with the
3465 previous object. Again, in many such cases this function is
3466 called again to find the next position where properties might
3467 change. */
3471 handled = HANDLED_NORMALLY;
3473 /* Call text property handlers. */
3474 for (p = it_props; p->handler; ++p)
3476 handled = p->handler (it);
3478 if (handled == HANDLED_RECOMPUTE_PROPS)
3479 break;
3480 else if (handled == HANDLED_RETURN)
3482 /* We still want to show before and after strings from
3483 overlays even if the actual buffer text is replaced. */
3484 if (!handle_overlay_change_p
3485 || it->sp > 1
3486 /* Don't call get_overlay_strings_1 if we already
3487 have overlay strings loaded, because doing so
3488 will load them again and push the iterator state
3489 onto the stack one more time, which is not
3490 expected by the rest of the code that processes
3491 overlay strings. */
3492 || (it->current.overlay_string_index < 0
3493 ? !get_overlay_strings_1 (it, 0, 0)
3494 : 0))
3496 if (it->ellipsis_p)
3497 setup_for_ellipsis (it, 0);
3498 /* When handling a display spec, we might load an
3499 empty string. In that case, discard it here. We
3500 used to discard it in handle_single_display_spec,
3501 but that causes get_overlay_strings_1, above, to
3502 ignore overlay strings that we must check. */
3503 if (STRINGP (it->string) && !SCHARS (it->string))
3504 pop_it (it);
3505 return;
3507 else if (STRINGP (it->string) && !SCHARS (it->string))
3508 pop_it (it);
3509 else
3511 it->ignore_overlay_strings_at_pos_p = true;
3512 it->string_from_display_prop_p = 0;
3513 it->from_disp_prop_p = 0;
3514 handle_overlay_change_p = 0;
3516 handled = HANDLED_RECOMPUTE_PROPS;
3517 break;
3519 else if (handled == HANDLED_OVERLAY_STRING_CONSUMED)
3520 handle_overlay_change_p = 0;
3523 if (handled != HANDLED_RECOMPUTE_PROPS)
3525 /* Don't check for overlay strings below when set to deliver
3526 characters from a display vector. */
3527 if (it->method == GET_FROM_DISPLAY_VECTOR)
3528 handle_overlay_change_p = 0;
3530 /* Handle overlay changes.
3531 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3532 if it finds overlays. */
3533 if (handle_overlay_change_p)
3534 handled = handle_overlay_change (it);
3537 if (it->ellipsis_p)
3539 setup_for_ellipsis (it, 0);
3540 break;
3543 while (handled == HANDLED_RECOMPUTE_PROPS);
3545 /* Determine where to stop next. */
3546 if (handled == HANDLED_NORMALLY)
3547 compute_stop_pos (it);
3551 /* Compute IT->stop_charpos from text property and overlay change
3552 information for IT's current position. */
3554 static void
3555 compute_stop_pos (struct it *it)
3557 register INTERVAL iv, next_iv;
3558 Lisp_Object object, limit, position;
3559 ptrdiff_t charpos, bytepos;
3561 if (STRINGP (it->string))
3563 /* Strings are usually short, so don't limit the search for
3564 properties. */
3565 it->stop_charpos = it->end_charpos;
3566 object = it->string;
3567 limit = Qnil;
3568 charpos = IT_STRING_CHARPOS (*it);
3569 bytepos = IT_STRING_BYTEPOS (*it);
3571 else
3573 ptrdiff_t pos;
3575 /* If end_charpos is out of range for some reason, such as a
3576 misbehaving display function, rationalize it (Bug#5984). */
3577 if (it->end_charpos > ZV)
3578 it->end_charpos = ZV;
3579 it->stop_charpos = it->end_charpos;
3581 /* If next overlay change is in front of the current stop pos
3582 (which is IT->end_charpos), stop there. Note: value of
3583 next_overlay_change is point-max if no overlay change
3584 follows. */
3585 charpos = IT_CHARPOS (*it);
3586 bytepos = IT_BYTEPOS (*it);
3587 pos = next_overlay_change (charpos);
3588 if (pos < it->stop_charpos)
3589 it->stop_charpos = pos;
3591 /* Set up variables for computing the stop position from text
3592 property changes. */
3593 XSETBUFFER (object, current_buffer);
3594 limit = make_number (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT);
3597 /* Get the interval containing IT's position. Value is a null
3598 interval if there isn't such an interval. */
3599 position = make_number (charpos);
3600 iv = validate_interval_range (object, &position, &position, 0);
3601 if (iv)
3603 Lisp_Object values_here[LAST_PROP_IDX];
3604 struct props *p;
3606 /* Get properties here. */
3607 for (p = it_props; p->handler; ++p)
3608 values_here[p->idx] = textget (iv->plist, *p->name);
3610 /* Look for an interval following iv that has different
3611 properties. */
3612 for (next_iv = next_interval (iv);
3613 (next_iv
3614 && (NILP (limit)
3615 || XFASTINT (limit) > next_iv->position));
3616 next_iv = next_interval (next_iv))
3618 for (p = it_props; p->handler; ++p)
3620 Lisp_Object new_value;
3622 new_value = textget (next_iv->plist, *p->name);
3623 if (!EQ (values_here[p->idx], new_value))
3624 break;
3627 if (p->handler)
3628 break;
3631 if (next_iv)
3633 if (INTEGERP (limit)
3634 && next_iv->position >= XFASTINT (limit))
3635 /* No text property change up to limit. */
3636 it->stop_charpos = min (XFASTINT (limit), it->stop_charpos);
3637 else
3638 /* Text properties change in next_iv. */
3639 it->stop_charpos = min (it->stop_charpos, next_iv->position);
3643 if (it->cmp_it.id < 0)
3645 ptrdiff_t stoppos = it->end_charpos;
3647 if (it->bidi_p && it->bidi_it.scan_dir < 0)
3648 stoppos = -1;
3649 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos,
3650 stoppos, it->string);
3653 eassert (STRINGP (it->string)
3654 || (it->stop_charpos >= BEGV
3655 && it->stop_charpos >= IT_CHARPOS (*it)));
3659 /* Return the position of the next overlay change after POS in
3660 current_buffer. Value is point-max if no overlay change
3661 follows. This is like `next-overlay-change' but doesn't use
3662 xmalloc. */
3664 static ptrdiff_t
3665 next_overlay_change (ptrdiff_t pos)
3667 ptrdiff_t i, noverlays;
3668 ptrdiff_t endpos;
3669 Lisp_Object *overlays;
3670 USE_SAFE_ALLOCA;
3672 /* Get all overlays at the given position. */
3673 GET_OVERLAYS_AT (pos, overlays, noverlays, &endpos, 1);
3675 /* If any of these overlays ends before endpos,
3676 use its ending point instead. */
3677 for (i = 0; i < noverlays; ++i)
3679 Lisp_Object oend;
3680 ptrdiff_t oendpos;
3682 oend = OVERLAY_END (overlays[i]);
3683 oendpos = OVERLAY_POSITION (oend);
3684 endpos = min (endpos, oendpos);
3687 SAFE_FREE ();
3688 return endpos;
3691 /* How many characters forward to search for a display property or
3692 display string. Searching too far forward makes the bidi display
3693 sluggish, especially in small windows. */
3694 #define MAX_DISP_SCAN 250
3696 /* Return the character position of a display string at or after
3697 position specified by POSITION. If no display string exists at or
3698 after POSITION, return ZV. A display string is either an overlay
3699 with `display' property whose value is a string, or a `display'
3700 text property whose value is a string. STRING is data about the
3701 string to iterate; if STRING->lstring is nil, we are iterating a
3702 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3703 on a GUI frame. DISP_PROP is set to zero if we searched
3704 MAX_DISP_SCAN characters forward without finding any display
3705 strings, non-zero otherwise. It is set to 2 if the display string
3706 uses any kind of `(space ...)' spec that will produce a stretch of
3707 white space in the text area. */
3708 ptrdiff_t
3709 compute_display_string_pos (struct text_pos *position,
3710 struct bidi_string_data *string,
3711 struct window *w,
3712 int frame_window_p, int *disp_prop)
3714 /* OBJECT = nil means current buffer. */
3715 Lisp_Object object, object1;
3716 Lisp_Object pos, spec, limpos;
3717 int string_p = (string && (STRINGP (string->lstring) || string->s));
3718 ptrdiff_t eob = string_p ? string->schars : ZV;
3719 ptrdiff_t begb = string_p ? 0 : BEGV;
3720 ptrdiff_t bufpos, charpos = CHARPOS (*position);
3721 ptrdiff_t lim =
3722 (charpos < eob - MAX_DISP_SCAN) ? charpos + MAX_DISP_SCAN : eob;
3723 struct text_pos tpos;
3724 int rv = 0;
3726 if (string && STRINGP (string->lstring))
3727 object1 = object = string->lstring;
3728 else if (w && !string_p)
3730 XSETWINDOW (object, w);
3731 object1 = Qnil;
3733 else
3734 object1 = object = Qnil;
3736 *disp_prop = 1;
3738 if (charpos >= eob
3739 /* We don't support display properties whose values are strings
3740 that have display string properties. */
3741 || string->from_disp_str
3742 /* C strings cannot have display properties. */
3743 || (string->s && !STRINGP (object)))
3745 *disp_prop = 0;
3746 return eob;
3749 /* If the character at CHARPOS is where the display string begins,
3750 return CHARPOS. */
3751 pos = make_number (charpos);
3752 if (STRINGP (object))
3753 bufpos = string->bufpos;
3754 else
3755 bufpos = charpos;
3756 tpos = *position;
3757 if (!NILP (spec = Fget_char_property (pos, Qdisplay, object))
3758 && (charpos <= begb
3759 || !EQ (Fget_char_property (make_number (charpos - 1), Qdisplay,
3760 object),
3761 spec))
3762 && (rv = handle_display_spec (NULL, spec, object, Qnil, &tpos, bufpos,
3763 frame_window_p)))
3765 if (rv == 2)
3766 *disp_prop = 2;
3767 return charpos;
3770 /* Look forward for the first character with a `display' property
3771 that will replace the underlying text when displayed. */
3772 limpos = make_number (lim);
3773 do {
3774 pos = Fnext_single_char_property_change (pos, Qdisplay, object1, limpos);
3775 CHARPOS (tpos) = XFASTINT (pos);
3776 if (CHARPOS (tpos) >= lim)
3778 *disp_prop = 0;
3779 break;
3781 if (STRINGP (object))
3782 BYTEPOS (tpos) = string_char_to_byte (object, CHARPOS (tpos));
3783 else
3784 BYTEPOS (tpos) = CHAR_TO_BYTE (CHARPOS (tpos));
3785 spec = Fget_char_property (pos, Qdisplay, object);
3786 if (!STRINGP (object))
3787 bufpos = CHARPOS (tpos);
3788 } while (NILP (spec)
3789 || !(rv = handle_display_spec (NULL, spec, object, Qnil, &tpos,
3790 bufpos, frame_window_p)));
3791 if (rv == 2)
3792 *disp_prop = 2;
3794 return CHARPOS (tpos);
3797 /* Return the character position of the end of the display string that
3798 started at CHARPOS. If there's no display string at CHARPOS,
3799 return -1. A display string is either an overlay with `display'
3800 property whose value is a string or a `display' text property whose
3801 value is a string. */
3802 ptrdiff_t
3803 compute_display_string_end (ptrdiff_t charpos, struct bidi_string_data *string)
3805 /* OBJECT = nil means current buffer. */
3806 Lisp_Object object =
3807 (string && STRINGP (string->lstring)) ? string->lstring : Qnil;
3808 Lisp_Object pos = make_number (charpos);
3809 ptrdiff_t eob =
3810 (STRINGP (object) || (string && string->s)) ? string->schars : ZV;
3812 if (charpos >= eob || (string->s && !STRINGP (object)))
3813 return eob;
3815 /* It could happen that the display property or overlay was removed
3816 since we found it in compute_display_string_pos above. One way
3817 this can happen is if JIT font-lock was called (through
3818 handle_fontified_prop), and jit-lock-functions remove text
3819 properties or overlays from the portion of buffer that includes
3820 CHARPOS. Muse mode is known to do that, for example. In this
3821 case, we return -1 to the caller, to signal that no display
3822 string is actually present at CHARPOS. See bidi_fetch_char for
3823 how this is handled.
3825 An alternative would be to never look for display properties past
3826 it->stop_charpos. But neither compute_display_string_pos nor
3827 bidi_fetch_char that calls it know or care where the next
3828 stop_charpos is. */
3829 if (NILP (Fget_char_property (pos, Qdisplay, object)))
3830 return -1;
3832 /* Look forward for the first character where the `display' property
3833 changes. */
3834 pos = Fnext_single_char_property_change (pos, Qdisplay, object, Qnil);
3836 return XFASTINT (pos);
3841 /***********************************************************************
3842 Fontification
3843 ***********************************************************************/
3845 /* Handle changes in the `fontified' property of the current buffer by
3846 calling hook functions from Qfontification_functions to fontify
3847 regions of text. */
3849 static enum prop_handled
3850 handle_fontified_prop (struct it *it)
3852 Lisp_Object prop, pos;
3853 enum prop_handled handled = HANDLED_NORMALLY;
3855 if (!NILP (Vmemory_full))
3856 return handled;
3858 /* Get the value of the `fontified' property at IT's current buffer
3859 position. (The `fontified' property doesn't have a special
3860 meaning in strings.) If the value is nil, call functions from
3861 Qfontification_functions. */
3862 if (!STRINGP (it->string)
3863 && it->s == NULL
3864 && !NILP (Vfontification_functions)
3865 && !NILP (Vrun_hooks)
3866 && (pos = make_number (IT_CHARPOS (*it)),
3867 prop = Fget_char_property (pos, Qfontified, Qnil),
3868 /* Ignore the special cased nil value always present at EOB since
3869 no amount of fontifying will be able to change it. */
3870 NILP (prop) && IT_CHARPOS (*it) < Z))
3872 ptrdiff_t count = SPECPDL_INDEX ();
3873 Lisp_Object val;
3874 struct buffer *obuf = current_buffer;
3875 ptrdiff_t begv = BEGV, zv = ZV;
3876 bool old_clip_changed = current_buffer->clip_changed;
3878 val = Vfontification_functions;
3879 specbind (Qfontification_functions, Qnil);
3881 eassert (it->end_charpos == ZV);
3883 if (!CONSP (val) || EQ (XCAR (val), Qlambda))
3884 safe_call1 (val, pos);
3885 else
3887 Lisp_Object fns, fn;
3888 struct gcpro gcpro1, gcpro2;
3890 fns = Qnil;
3891 GCPRO2 (val, fns);
3893 for (; CONSP (val); val = XCDR (val))
3895 fn = XCAR (val);
3897 if (EQ (fn, Qt))
3899 /* A value of t indicates this hook has a local
3900 binding; it means to run the global binding too.
3901 In a global value, t should not occur. If it
3902 does, we must ignore it to avoid an endless
3903 loop. */
3904 for (fns = Fdefault_value (Qfontification_functions);
3905 CONSP (fns);
3906 fns = XCDR (fns))
3908 fn = XCAR (fns);
3909 if (!EQ (fn, Qt))
3910 safe_call1 (fn, pos);
3913 else
3914 safe_call1 (fn, pos);
3917 UNGCPRO;
3920 unbind_to (count, Qnil);
3922 /* Fontification functions routinely call `save-restriction'.
3923 Normally, this tags clip_changed, which can confuse redisplay
3924 (see discussion in Bug#6671). Since we don't perform any
3925 special handling of fontification changes in the case where
3926 `save-restriction' isn't called, there's no point doing so in
3927 this case either. So, if the buffer's restrictions are
3928 actually left unchanged, reset clip_changed. */
3929 if (obuf == current_buffer)
3931 if (begv == BEGV && zv == ZV)
3932 current_buffer->clip_changed = old_clip_changed;
3934 /* There isn't much we can reasonably do to protect against
3935 misbehaving fontification, but here's a fig leaf. */
3936 else if (BUFFER_LIVE_P (obuf))
3937 set_buffer_internal_1 (obuf);
3939 /* The fontification code may have added/removed text.
3940 It could do even a lot worse, but let's at least protect against
3941 the most obvious case where only the text past `pos' gets changed',
3942 as is/was done in grep.el where some escapes sequences are turned
3943 into face properties (bug#7876). */
3944 it->end_charpos = ZV;
3946 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3947 something. This avoids an endless loop if they failed to
3948 fontify the text for which reason ever. */
3949 if (!NILP (Fget_char_property (pos, Qfontified, Qnil)))
3950 handled = HANDLED_RECOMPUTE_PROPS;
3953 return handled;
3958 /***********************************************************************
3959 Faces
3960 ***********************************************************************/
3962 /* Set up iterator IT from face properties at its current position.
3963 Called from handle_stop. */
3965 static enum prop_handled
3966 handle_face_prop (struct it *it)
3968 int new_face_id;
3969 ptrdiff_t next_stop;
3971 if (!STRINGP (it->string))
3973 new_face_id
3974 = face_at_buffer_position (it->w,
3975 IT_CHARPOS (*it),
3976 &next_stop,
3977 (IT_CHARPOS (*it)
3978 + TEXT_PROP_DISTANCE_LIMIT),
3979 0, it->base_face_id);
3981 /* Is this a start of a run of characters with box face?
3982 Caveat: this can be called for a freshly initialized
3983 iterator; face_id is -1 in this case. We know that the new
3984 face will not change until limit, i.e. if the new face has a
3985 box, all characters up to limit will have one. But, as
3986 usual, we don't know whether limit is really the end. */
3987 if (new_face_id != it->face_id)
3989 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
3990 /* If it->face_id is -1, old_face below will be NULL, see
3991 the definition of FACE_FROM_ID. This will happen if this
3992 is the initial call that gets the face. */
3993 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
3995 /* If the value of face_id of the iterator is -1, we have to
3996 look in front of IT's position and see whether there is a
3997 face there that's different from new_face_id. */
3998 if (!old_face && IT_CHARPOS (*it) > BEG)
4000 int prev_face_id = face_before_it_pos (it);
4002 old_face = FACE_FROM_ID (it->f, prev_face_id);
4005 /* If the new face has a box, but the old face does not,
4006 this is the start of a run of characters with box face,
4007 i.e. this character has a shadow on the left side. */
4008 it->start_of_box_run_p = (new_face->box != FACE_NO_BOX
4009 && (old_face == NULL || !old_face->box));
4010 it->face_box_p = new_face->box != FACE_NO_BOX;
4013 else
4015 int base_face_id;
4016 ptrdiff_t bufpos;
4017 int i;
4018 Lisp_Object from_overlay
4019 = (it->current.overlay_string_index >= 0
4020 ? it->string_overlays[it->current.overlay_string_index
4021 % OVERLAY_STRING_CHUNK_SIZE]
4022 : Qnil);
4024 /* See if we got to this string directly or indirectly from
4025 an overlay property. That includes the before-string or
4026 after-string of an overlay, strings in display properties
4027 provided by an overlay, their text properties, etc.
4029 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4030 if (! NILP (from_overlay))
4031 for (i = it->sp - 1; i >= 0; i--)
4033 if (it->stack[i].current.overlay_string_index >= 0)
4034 from_overlay
4035 = it->string_overlays[it->stack[i].current.overlay_string_index
4036 % OVERLAY_STRING_CHUNK_SIZE];
4037 else if (! NILP (it->stack[i].from_overlay))
4038 from_overlay = it->stack[i].from_overlay;
4040 if (!NILP (from_overlay))
4041 break;
4044 if (! NILP (from_overlay))
4046 bufpos = IT_CHARPOS (*it);
4047 /* For a string from an overlay, the base face depends
4048 only on text properties and ignores overlays. */
4049 base_face_id
4050 = face_for_overlay_string (it->w,
4051 IT_CHARPOS (*it),
4052 &next_stop,
4053 (IT_CHARPOS (*it)
4054 + TEXT_PROP_DISTANCE_LIMIT),
4056 from_overlay);
4058 else
4060 bufpos = 0;
4062 /* For strings from a `display' property, use the face at
4063 IT's current buffer position as the base face to merge
4064 with, so that overlay strings appear in the same face as
4065 surrounding text, unless they specify their own faces.
4066 For strings from wrap-prefix and line-prefix properties,
4067 use the default face, possibly remapped via
4068 Vface_remapping_alist. */
4069 /* Note that the fact that we use the face at _buffer_
4070 position means that a 'display' property on an overlay
4071 string will not inherit the face of that overlay string,
4072 but will instead revert to the face of buffer text
4073 covered by the overlay. This is visible, e.g., when the
4074 overlay specifies a box face, but neither the buffer nor
4075 the display string do. This sounds like a design bug,
4076 but Emacs always did that since v21.1, so changing that
4077 might be a big deal. */
4078 base_face_id = it->string_from_prefix_prop_p
4079 ? (!NILP (Vface_remapping_alist)
4080 ? lookup_basic_face (it->f, DEFAULT_FACE_ID)
4081 : DEFAULT_FACE_ID)
4082 : underlying_face_id (it);
4085 new_face_id = face_at_string_position (it->w,
4086 it->string,
4087 IT_STRING_CHARPOS (*it),
4088 bufpos,
4089 &next_stop,
4090 base_face_id, 0);
4092 /* Is this a start of a run of characters with box? Caveat:
4093 this can be called for a freshly allocated iterator; face_id
4094 is -1 is this case. We know that the new face will not
4095 change until the next check pos, i.e. if the new face has a
4096 box, all characters up to that position will have a
4097 box. But, as usual, we don't know whether that position
4098 is really the end. */
4099 if (new_face_id != it->face_id)
4101 struct face *new_face = FACE_FROM_ID (it->f, new_face_id);
4102 struct face *old_face = FACE_FROM_ID (it->f, it->face_id);
4104 /* If new face has a box but old face hasn't, this is the
4105 start of a run of characters with box, i.e. it has a
4106 shadow on the left side. */
4107 it->start_of_box_run_p
4108 = new_face->box && (old_face == NULL || !old_face->box);
4109 it->face_box_p = new_face->box != FACE_NO_BOX;
4113 it->face_id = new_face_id;
4114 return HANDLED_NORMALLY;
4118 /* Return the ID of the face ``underlying'' IT's current position,
4119 which is in a string. If the iterator is associated with a
4120 buffer, return the face at IT's current buffer position.
4121 Otherwise, use the iterator's base_face_id. */
4123 static int
4124 underlying_face_id (struct it *it)
4126 int face_id = it->base_face_id, i;
4128 eassert (STRINGP (it->string));
4130 for (i = it->sp - 1; i >= 0; --i)
4131 if (NILP (it->stack[i].string))
4132 face_id = it->stack[i].face_id;
4134 return face_id;
4138 /* Compute the face one character before or after the current position
4139 of IT, in the visual order. BEFORE_P non-zero means get the face
4140 in front (to the left in L2R paragraphs, to the right in R2L
4141 paragraphs) of IT's screen position. Value is the ID of the face. */
4143 static int
4144 face_before_or_after_it_pos (struct it *it, int before_p)
4146 int face_id, limit;
4147 ptrdiff_t next_check_charpos;
4148 struct it it_copy;
4149 void *it_copy_data = NULL;
4151 eassert (it->s == NULL);
4153 if (STRINGP (it->string))
4155 ptrdiff_t bufpos, charpos;
4156 int base_face_id;
4158 /* No face change past the end of the string (for the case
4159 we are padding with spaces). No face change before the
4160 string start. */
4161 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string)
4162 || (IT_STRING_CHARPOS (*it) == 0 && before_p))
4163 return it->face_id;
4165 if (!it->bidi_p)
4167 /* Set charpos to the position before or after IT's current
4168 position, in the logical order, which in the non-bidi
4169 case is the same as the visual order. */
4170 if (before_p)
4171 charpos = IT_STRING_CHARPOS (*it) - 1;
4172 else if (it->what == IT_COMPOSITION)
4173 /* For composition, we must check the character after the
4174 composition. */
4175 charpos = IT_STRING_CHARPOS (*it) + it->cmp_it.nchars;
4176 else
4177 charpos = IT_STRING_CHARPOS (*it) + 1;
4179 else
4181 if (before_p)
4183 /* With bidi iteration, the character before the current
4184 in the visual order cannot be found by simple
4185 iteration, because "reverse" reordering is not
4186 supported. Instead, we need to use the move_it_*
4187 family of functions. */
4188 /* Ignore face changes before the first visible
4189 character on this display line. */
4190 if (it->current_x <= it->first_visible_x)
4191 return it->face_id;
4192 SAVE_IT (it_copy, *it, it_copy_data);
4193 /* Implementation note: Since move_it_in_display_line
4194 works in the iterator geometry, and thinks the first
4195 character is always the leftmost, even in R2L lines,
4196 we don't need to distinguish between the R2L and L2R
4197 cases here. */
4198 move_it_in_display_line (&it_copy, SCHARS (it_copy.string),
4199 it_copy.current_x - 1, MOVE_TO_X);
4200 charpos = IT_STRING_CHARPOS (it_copy);
4201 RESTORE_IT (it, it, it_copy_data);
4203 else
4205 /* Set charpos to the string position of the character
4206 that comes after IT's current position in the visual
4207 order. */
4208 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4210 it_copy = *it;
4211 while (n--)
4212 bidi_move_to_visually_next (&it_copy.bidi_it);
4214 charpos = it_copy.bidi_it.charpos;
4217 eassert (0 <= charpos && charpos <= SCHARS (it->string));
4219 if (it->current.overlay_string_index >= 0)
4220 bufpos = IT_CHARPOS (*it);
4221 else
4222 bufpos = 0;
4224 base_face_id = underlying_face_id (it);
4226 /* Get the face for ASCII, or unibyte. */
4227 face_id = face_at_string_position (it->w,
4228 it->string,
4229 charpos,
4230 bufpos,
4231 &next_check_charpos,
4232 base_face_id, 0);
4234 /* Correct the face for charsets different from ASCII. Do it
4235 for the multibyte case only. The face returned above is
4236 suitable for unibyte text if IT->string is unibyte. */
4237 if (STRING_MULTIBYTE (it->string))
4239 struct text_pos pos1 = string_pos (charpos, it->string);
4240 const unsigned char *p = SDATA (it->string) + BYTEPOS (pos1);
4241 int c, len;
4242 struct face *face = FACE_FROM_ID (it->f, face_id);
4244 c = string_char_and_length (p, &len);
4245 face_id = FACE_FOR_CHAR (it->f, face, c, charpos, it->string);
4248 else
4250 struct text_pos pos;
4252 if ((IT_CHARPOS (*it) >= ZV && !before_p)
4253 || (IT_CHARPOS (*it) <= BEGV && before_p))
4254 return it->face_id;
4256 limit = IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT;
4257 pos = it->current.pos;
4259 if (!it->bidi_p)
4261 if (before_p)
4262 DEC_TEXT_POS (pos, it->multibyte_p);
4263 else
4265 if (it->what == IT_COMPOSITION)
4267 /* For composition, we must check the position after
4268 the composition. */
4269 pos.charpos += it->cmp_it.nchars;
4270 pos.bytepos += it->len;
4272 else
4273 INC_TEXT_POS (pos, it->multibyte_p);
4276 else
4278 if (before_p)
4280 /* With bidi iteration, the character before the current
4281 in the visual order cannot be found by simple
4282 iteration, because "reverse" reordering is not
4283 supported. Instead, we need to use the move_it_*
4284 family of functions. */
4285 /* Ignore face changes before the first visible
4286 character on this display line. */
4287 if (it->current_x <= it->first_visible_x)
4288 return it->face_id;
4289 SAVE_IT (it_copy, *it, it_copy_data);
4290 /* Implementation note: Since move_it_in_display_line
4291 works in the iterator geometry, and thinks the first
4292 character is always the leftmost, even in R2L lines,
4293 we don't need to distinguish between the R2L and L2R
4294 cases here. */
4295 move_it_in_display_line (&it_copy, ZV,
4296 it_copy.current_x - 1, MOVE_TO_X);
4297 pos = it_copy.current.pos;
4298 RESTORE_IT (it, it, it_copy_data);
4300 else
4302 /* Set charpos to the buffer position of the character
4303 that comes after IT's current position in the visual
4304 order. */
4305 int n = (it->what == IT_COMPOSITION ? it->cmp_it.nchars : 1);
4307 it_copy = *it;
4308 while (n--)
4309 bidi_move_to_visually_next (&it_copy.bidi_it);
4311 SET_TEXT_POS (pos,
4312 it_copy.bidi_it.charpos, it_copy.bidi_it.bytepos);
4315 eassert (BEGV <= CHARPOS (pos) && CHARPOS (pos) <= ZV);
4317 /* Determine face for CHARSET_ASCII, or unibyte. */
4318 face_id = face_at_buffer_position (it->w,
4319 CHARPOS (pos),
4320 &next_check_charpos,
4321 limit, 0, -1);
4323 /* Correct the face for charsets different from ASCII. Do it
4324 for the multibyte case only. The face returned above is
4325 suitable for unibyte text if current_buffer is unibyte. */
4326 if (it->multibyte_p)
4328 int c = FETCH_MULTIBYTE_CHAR (BYTEPOS (pos));
4329 struct face *face = FACE_FROM_ID (it->f, face_id);
4330 face_id = FACE_FOR_CHAR (it->f, face, c, CHARPOS (pos), Qnil);
4334 return face_id;
4339 /***********************************************************************
4340 Invisible text
4341 ***********************************************************************/
4343 /* Set up iterator IT from invisible properties at its current
4344 position. Called from handle_stop. */
4346 static enum prop_handled
4347 handle_invisible_prop (struct it *it)
4349 enum prop_handled handled = HANDLED_NORMALLY;
4350 int invis_p;
4351 Lisp_Object prop;
4353 if (STRINGP (it->string))
4355 Lisp_Object end_charpos, limit, charpos;
4357 /* Get the value of the invisible text property at the
4358 current position. Value will be nil if there is no such
4359 property. */
4360 charpos = make_number (IT_STRING_CHARPOS (*it));
4361 prop = Fget_text_property (charpos, Qinvisible, it->string);
4362 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4364 if (invis_p && IT_STRING_CHARPOS (*it) < it->end_charpos)
4366 /* Record whether we have to display an ellipsis for the
4367 invisible text. */
4368 int display_ellipsis_p = (invis_p == 2);
4369 ptrdiff_t len, endpos;
4371 handled = HANDLED_RECOMPUTE_PROPS;
4373 /* Get the position at which the next visible text can be
4374 found in IT->string, if any. */
4375 endpos = len = SCHARS (it->string);
4376 XSETINT (limit, len);
4379 end_charpos = Fnext_single_property_change (charpos, Qinvisible,
4380 it->string, limit);
4381 if (INTEGERP (end_charpos))
4383 endpos = XFASTINT (end_charpos);
4384 prop = Fget_text_property (end_charpos, Qinvisible, it->string);
4385 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4386 if (invis_p == 2)
4387 display_ellipsis_p = true;
4390 while (invis_p && endpos < len);
4392 if (display_ellipsis_p)
4393 it->ellipsis_p = true;
4395 if (endpos < len)
4397 /* Text at END_CHARPOS is visible. Move IT there. */
4398 struct text_pos old;
4399 ptrdiff_t oldpos;
4401 old = it->current.string_pos;
4402 oldpos = CHARPOS (old);
4403 if (it->bidi_p)
4405 if (it->bidi_it.first_elt
4406 && it->bidi_it.charpos < SCHARS (it->string))
4407 bidi_paragraph_init (it->paragraph_embedding,
4408 &it->bidi_it, 1);
4409 /* Bidi-iterate out of the invisible text. */
4412 bidi_move_to_visually_next (&it->bidi_it);
4414 while (oldpos <= it->bidi_it.charpos
4415 && it->bidi_it.charpos < endpos);
4417 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
4418 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
4419 if (IT_CHARPOS (*it) >= endpos)
4420 it->prev_stop = endpos;
4422 else
4424 IT_STRING_CHARPOS (*it) = XFASTINT (end_charpos);
4425 compute_string_pos (&it->current.string_pos, old, it->string);
4428 else
4430 /* The rest of the string is invisible. If this is an
4431 overlay string, proceed with the next overlay string
4432 or whatever comes and return a character from there. */
4433 if (it->current.overlay_string_index >= 0
4434 && !display_ellipsis_p)
4436 next_overlay_string (it);
4437 /* Don't check for overlay strings when we just
4438 finished processing them. */
4439 handled = HANDLED_OVERLAY_STRING_CONSUMED;
4441 else
4443 IT_STRING_CHARPOS (*it) = SCHARS (it->string);
4444 IT_STRING_BYTEPOS (*it) = SBYTES (it->string);
4449 else
4451 ptrdiff_t newpos, next_stop, start_charpos, tem;
4452 Lisp_Object pos, overlay;
4454 /* First of all, is there invisible text at this position? */
4455 tem = start_charpos = IT_CHARPOS (*it);
4456 pos = make_number (tem);
4457 prop = get_char_property_and_overlay (pos, Qinvisible, it->window,
4458 &overlay);
4459 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4461 /* If we are on invisible text, skip over it. */
4462 if (invis_p && start_charpos < it->end_charpos)
4464 /* Record whether we have to display an ellipsis for the
4465 invisible text. */
4466 int display_ellipsis_p = invis_p == 2;
4468 handled = HANDLED_RECOMPUTE_PROPS;
4470 /* Loop skipping over invisible text. The loop is left at
4471 ZV or with IT on the first char being visible again. */
4474 /* Try to skip some invisible text. Return value is the
4475 position reached which can be equal to where we start
4476 if there is nothing invisible there. This skips both
4477 over invisible text properties and overlays with
4478 invisible property. */
4479 newpos = skip_invisible (tem, &next_stop, ZV, it->window);
4481 /* If we skipped nothing at all we weren't at invisible
4482 text in the first place. If everything to the end of
4483 the buffer was skipped, end the loop. */
4484 if (newpos == tem || newpos >= ZV)
4485 invis_p = 0;
4486 else
4488 /* We skipped some characters but not necessarily
4489 all there are. Check if we ended up on visible
4490 text. Fget_char_property returns the property of
4491 the char before the given position, i.e. if we
4492 get invis_p = 0, this means that the char at
4493 newpos is visible. */
4494 pos = make_number (newpos);
4495 prop = Fget_char_property (pos, Qinvisible, it->window);
4496 invis_p = TEXT_PROP_MEANS_INVISIBLE (prop);
4499 /* If we ended up on invisible text, proceed to
4500 skip starting with next_stop. */
4501 if (invis_p)
4502 tem = next_stop;
4504 /* If there are adjacent invisible texts, don't lose the
4505 second one's ellipsis. */
4506 if (invis_p == 2)
4507 display_ellipsis_p = true;
4509 while (invis_p);
4511 /* The position newpos is now either ZV or on visible text. */
4512 if (it->bidi_p)
4514 ptrdiff_t bpos = CHAR_TO_BYTE (newpos);
4515 int on_newline
4516 = bpos == ZV_BYTE || FETCH_BYTE (bpos) == '\n';
4517 int after_newline
4518 = newpos <= BEGV || FETCH_BYTE (bpos - 1) == '\n';
4520 /* If the invisible text ends on a newline or on a
4521 character after a newline, we can avoid the costly,
4522 character by character, bidi iteration to NEWPOS, and
4523 instead simply reseat the iterator there. That's
4524 because all bidi reordering information is tossed at
4525 the newline. This is a big win for modes that hide
4526 complete lines, like Outline, Org, etc. */
4527 if (on_newline || after_newline)
4529 struct text_pos tpos;
4530 bidi_dir_t pdir = it->bidi_it.paragraph_dir;
4532 SET_TEXT_POS (tpos, newpos, bpos);
4533 reseat_1 (it, tpos, 0);
4534 /* If we reseat on a newline/ZV, we need to prep the
4535 bidi iterator for advancing to the next character
4536 after the newline/EOB, keeping the current paragraph
4537 direction (so that PRODUCE_GLYPHS does TRT wrt
4538 prepending/appending glyphs to a glyph row). */
4539 if (on_newline)
4541 it->bidi_it.first_elt = 0;
4542 it->bidi_it.paragraph_dir = pdir;
4543 it->bidi_it.ch = (bpos == ZV_BYTE) ? -1 : '\n';
4544 it->bidi_it.nchars = 1;
4545 it->bidi_it.ch_len = 1;
4548 else /* Must use the slow method. */
4550 /* With bidi iteration, the region of invisible text
4551 could start and/or end in the middle of a
4552 non-base embedding level. Therefore, we need to
4553 skip invisible text using the bidi iterator,
4554 starting at IT's current position, until we find
4555 ourselves outside of the invisible text.
4556 Skipping invisible text _after_ bidi iteration
4557 avoids affecting the visual order of the
4558 displayed text when invisible properties are
4559 added or removed. */
4560 if (it->bidi_it.first_elt && it->bidi_it.charpos < ZV)
4562 /* If we were `reseat'ed to a new paragraph,
4563 determine the paragraph base direction. We
4564 need to do it now because
4565 next_element_from_buffer may not have a
4566 chance to do it, if we are going to skip any
4567 text at the beginning, which resets the
4568 FIRST_ELT flag. */
4569 bidi_paragraph_init (it->paragraph_embedding,
4570 &it->bidi_it, 1);
4574 bidi_move_to_visually_next (&it->bidi_it);
4576 while (it->stop_charpos <= it->bidi_it.charpos
4577 && it->bidi_it.charpos < newpos);
4578 IT_CHARPOS (*it) = it->bidi_it.charpos;
4579 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
4580 /* If we overstepped NEWPOS, record its position in
4581 the iterator, so that we skip invisible text if
4582 later the bidi iteration lands us in the
4583 invisible region again. */
4584 if (IT_CHARPOS (*it) >= newpos)
4585 it->prev_stop = newpos;
4588 else
4590 IT_CHARPOS (*it) = newpos;
4591 IT_BYTEPOS (*it) = CHAR_TO_BYTE (newpos);
4594 /* If there are before-strings at the start of invisible
4595 text, and the text is invisible because of a text
4596 property, arrange to show before-strings because 20.x did
4597 it that way. (If the text is invisible because of an
4598 overlay property instead of a text property, this is
4599 already handled in the overlay code.) */
4600 if (NILP (overlay)
4601 && get_overlay_strings (it, it->stop_charpos))
4603 handled = HANDLED_RECOMPUTE_PROPS;
4604 if (it->sp > 0)
4606 it->stack[it->sp - 1].display_ellipsis_p = display_ellipsis_p;
4607 /* The call to get_overlay_strings above recomputes
4608 it->stop_charpos, but it only considers changes
4609 in properties and overlays beyond iterator's
4610 current position. This causes us to miss changes
4611 that happen exactly where the invisible property
4612 ended. So we play it safe here and force the
4613 iterator to check for potential stop positions
4614 immediately after the invisible text. Note that
4615 if get_overlay_strings returns non-zero, it
4616 normally also pushed the iterator stack, so we
4617 need to update the stop position in the slot
4618 below the current one. */
4619 it->stack[it->sp - 1].stop_charpos
4620 = CHARPOS (it->stack[it->sp - 1].current.pos);
4623 else if (display_ellipsis_p)
4625 /* Make sure that the glyphs of the ellipsis will get
4626 correct `charpos' values. If we would not update
4627 it->position here, the glyphs would belong to the
4628 last visible character _before_ the invisible
4629 text, which confuses `set_cursor_from_row'.
4631 We use the last invisible position instead of the
4632 first because this way the cursor is always drawn on
4633 the first "." of the ellipsis, whenever PT is inside
4634 the invisible text. Otherwise the cursor would be
4635 placed _after_ the ellipsis when the point is after the
4636 first invisible character. */
4637 if (!STRINGP (it->object))
4639 it->position.charpos = newpos - 1;
4640 it->position.bytepos = CHAR_TO_BYTE (it->position.charpos);
4642 it->ellipsis_p = true;
4643 /* Let the ellipsis display before
4644 considering any properties of the following char.
4645 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4646 handled = HANDLED_RETURN;
4651 return handled;
4655 /* Make iterator IT return `...' next.
4656 Replaces LEN characters from buffer. */
4658 static void
4659 setup_for_ellipsis (struct it *it, int len)
4661 /* Use the display table definition for `...'. Invalid glyphs
4662 will be handled by the method returning elements from dpvec. */
4663 if (it->dp && VECTORP (DISP_INVIS_VECTOR (it->dp)))
4665 struct Lisp_Vector *v = XVECTOR (DISP_INVIS_VECTOR (it->dp));
4666 it->dpvec = v->contents;
4667 it->dpend = v->contents + v->header.size;
4669 else
4671 /* Default `...'. */
4672 it->dpvec = default_invis_vector;
4673 it->dpend = default_invis_vector + 3;
4676 it->dpvec_char_len = len;
4677 it->current.dpvec_index = 0;
4678 it->dpvec_face_id = -1;
4680 /* Remember the current face id in case glyphs specify faces.
4681 IT's face is restored in set_iterator_to_next.
4682 saved_face_id was set to preceding char's face in handle_stop. */
4683 if (it->saved_face_id < 0 || it->saved_face_id != it->face_id)
4684 it->saved_face_id = it->face_id = DEFAULT_FACE_ID;
4686 it->method = GET_FROM_DISPLAY_VECTOR;
4687 it->ellipsis_p = true;
4692 /***********************************************************************
4693 'display' property
4694 ***********************************************************************/
4696 /* Set up iterator IT from `display' property at its current position.
4697 Called from handle_stop.
4698 We return HANDLED_RETURN if some part of the display property
4699 overrides the display of the buffer text itself.
4700 Otherwise we return HANDLED_NORMALLY. */
4702 static enum prop_handled
4703 handle_display_prop (struct it *it)
4705 Lisp_Object propval, object, overlay;
4706 struct text_pos *position;
4707 ptrdiff_t bufpos;
4708 /* Nonzero if some property replaces the display of the text itself. */
4709 int display_replaced_p = 0;
4711 if (STRINGP (it->string))
4713 object = it->string;
4714 position = &it->current.string_pos;
4715 bufpos = CHARPOS (it->current.pos);
4717 else
4719 XSETWINDOW (object, it->w);
4720 position = &it->current.pos;
4721 bufpos = CHARPOS (*position);
4724 /* Reset those iterator values set from display property values. */
4725 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
4726 it->space_width = Qnil;
4727 it->font_height = Qnil;
4728 it->voffset = 0;
4730 /* We don't support recursive `display' properties, i.e. string
4731 values that have a string `display' property, that have a string
4732 `display' property etc. */
4733 if (!it->string_from_display_prop_p)
4734 it->area = TEXT_AREA;
4736 propval = get_char_property_and_overlay (make_number (position->charpos),
4737 Qdisplay, object, &overlay);
4738 if (NILP (propval))
4739 return HANDLED_NORMALLY;
4740 /* Now OVERLAY is the overlay that gave us this property, or nil
4741 if it was a text property. */
4743 if (!STRINGP (it->string))
4744 object = it->w->contents;
4746 display_replaced_p = handle_display_spec (it, propval, object, overlay,
4747 position, bufpos,
4748 FRAME_WINDOW_P (it->f));
4750 return display_replaced_p ? HANDLED_RETURN : HANDLED_NORMALLY;
4753 /* Subroutine of handle_display_prop. Returns non-zero if the display
4754 specification in SPEC is a replacing specification, i.e. it would
4755 replace the text covered by `display' property with something else,
4756 such as an image or a display string. If SPEC includes any kind or
4757 `(space ...) specification, the value is 2; this is used by
4758 compute_display_string_pos, which see.
4760 See handle_single_display_spec for documentation of arguments.
4761 frame_window_p is non-zero if the window being redisplayed is on a
4762 GUI frame; this argument is used only if IT is NULL, see below.
4764 IT can be NULL, if this is called by the bidi reordering code
4765 through compute_display_string_pos, which see. In that case, this
4766 function only examines SPEC, but does not otherwise "handle" it, in
4767 the sense that it doesn't set up members of IT from the display
4768 spec. */
4769 static int
4770 handle_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4771 Lisp_Object overlay, struct text_pos *position,
4772 ptrdiff_t bufpos, int frame_window_p)
4774 int replacing_p = 0;
4775 int rv;
4777 if (CONSP (spec)
4778 /* Simple specifications. */
4779 && !EQ (XCAR (spec), Qimage)
4780 && !EQ (XCAR (spec), Qspace)
4781 && !EQ (XCAR (spec), Qwhen)
4782 && !EQ (XCAR (spec), Qslice)
4783 && !EQ (XCAR (spec), Qspace_width)
4784 && !EQ (XCAR (spec), Qheight)
4785 && !EQ (XCAR (spec), Qraise)
4786 /* Marginal area specifications. */
4787 && !(CONSP (XCAR (spec)) && EQ (XCAR (XCAR (spec)), Qmargin))
4788 && !EQ (XCAR (spec), Qleft_fringe)
4789 && !EQ (XCAR (spec), Qright_fringe)
4790 && !NILP (XCAR (spec)))
4792 for (; CONSP (spec); spec = XCDR (spec))
4794 if ((rv = handle_single_display_spec (it, XCAR (spec), object,
4795 overlay, position, bufpos,
4796 replacing_p, frame_window_p)))
4798 replacing_p = rv;
4799 /* If some text in a string is replaced, `position' no
4800 longer points to the position of `object'. */
4801 if (!it || STRINGP (object))
4802 break;
4806 else if (VECTORP (spec))
4808 ptrdiff_t i;
4809 for (i = 0; i < ASIZE (spec); ++i)
4810 if ((rv = handle_single_display_spec (it, AREF (spec, i), object,
4811 overlay, position, bufpos,
4812 replacing_p, frame_window_p)))
4814 replacing_p = rv;
4815 /* If some text in a string is replaced, `position' no
4816 longer points to the position of `object'. */
4817 if (!it || STRINGP (object))
4818 break;
4821 else
4823 if ((rv = handle_single_display_spec (it, spec, object, overlay,
4824 position, bufpos, 0,
4825 frame_window_p)))
4826 replacing_p = rv;
4829 return replacing_p;
4832 /* Value is the position of the end of the `display' property starting
4833 at START_POS in OBJECT. */
4835 static struct text_pos
4836 display_prop_end (struct it *it, Lisp_Object object, struct text_pos start_pos)
4838 Lisp_Object end;
4839 struct text_pos end_pos;
4841 end = Fnext_single_char_property_change (make_number (CHARPOS (start_pos)),
4842 Qdisplay, object, Qnil);
4843 CHARPOS (end_pos) = XFASTINT (end);
4844 if (STRINGP (object))
4845 compute_string_pos (&end_pos, start_pos, it->string);
4846 else
4847 BYTEPOS (end_pos) = CHAR_TO_BYTE (XFASTINT (end));
4849 return end_pos;
4853 /* Set up IT from a single `display' property specification SPEC. OBJECT
4854 is the object in which the `display' property was found. *POSITION
4855 is the position in OBJECT at which the `display' property was found.
4856 BUFPOS is the buffer position of OBJECT (different from POSITION if
4857 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4858 previously saw a display specification which already replaced text
4859 display with something else, for example an image; we ignore such
4860 properties after the first one has been processed.
4862 OVERLAY is the overlay this `display' property came from,
4863 or nil if it was a text property.
4865 If SPEC is a `space' or `image' specification, and in some other
4866 cases too, set *POSITION to the position where the `display'
4867 property ends.
4869 If IT is NULL, only examine the property specification in SPEC, but
4870 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4871 is intended to be displayed in a window on a GUI frame.
4873 Value is non-zero if something was found which replaces the display
4874 of buffer or string text. */
4876 static int
4877 handle_single_display_spec (struct it *it, Lisp_Object spec, Lisp_Object object,
4878 Lisp_Object overlay, struct text_pos *position,
4879 ptrdiff_t bufpos, int display_replaced_p,
4880 int frame_window_p)
4882 Lisp_Object form;
4883 Lisp_Object location, value;
4884 struct text_pos start_pos = *position;
4885 int valid_p;
4887 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4888 If the result is non-nil, use VALUE instead of SPEC. */
4889 form = Qt;
4890 if (CONSP (spec) && EQ (XCAR (spec), Qwhen))
4892 spec = XCDR (spec);
4893 if (!CONSP (spec))
4894 return 0;
4895 form = XCAR (spec);
4896 spec = XCDR (spec);
4899 if (!NILP (form) && !EQ (form, Qt))
4901 ptrdiff_t count = SPECPDL_INDEX ();
4902 struct gcpro gcpro1;
4904 /* Bind `object' to the object having the `display' property, a
4905 buffer or string. Bind `position' to the position in the
4906 object where the property was found, and `buffer-position'
4907 to the current position in the buffer. */
4909 if (NILP (object))
4910 XSETBUFFER (object, current_buffer);
4911 specbind (Qobject, object);
4912 specbind (Qposition, make_number (CHARPOS (*position)));
4913 specbind (Qbuffer_position, make_number (bufpos));
4914 GCPRO1 (form);
4915 form = safe_eval (form);
4916 UNGCPRO;
4917 unbind_to (count, Qnil);
4920 if (NILP (form))
4921 return 0;
4923 /* Handle `(height HEIGHT)' specifications. */
4924 if (CONSP (spec)
4925 && EQ (XCAR (spec), Qheight)
4926 && CONSP (XCDR (spec)))
4928 if (it)
4930 if (!FRAME_WINDOW_P (it->f))
4931 return 0;
4933 it->font_height = XCAR (XCDR (spec));
4934 if (!NILP (it->font_height))
4936 struct face *face = FACE_FROM_ID (it->f, it->face_id);
4937 int new_height = -1;
4939 if (CONSP (it->font_height)
4940 && (EQ (XCAR (it->font_height), Qplus)
4941 || EQ (XCAR (it->font_height), Qminus))
4942 && CONSP (XCDR (it->font_height))
4943 && RANGED_INTEGERP (0, XCAR (XCDR (it->font_height)), INT_MAX))
4945 /* `(+ N)' or `(- N)' where N is an integer. */
4946 int steps = XINT (XCAR (XCDR (it->font_height)));
4947 if (EQ (XCAR (it->font_height), Qplus))
4948 steps = - steps;
4949 it->face_id = smaller_face (it->f, it->face_id, steps);
4951 else if (FUNCTIONP (it->font_height))
4953 /* Call function with current height as argument.
4954 Value is the new height. */
4955 Lisp_Object height;
4956 height = safe_call1 (it->font_height,
4957 face->lface[LFACE_HEIGHT_INDEX]);
4958 if (NUMBERP (height))
4959 new_height = XFLOATINT (height);
4961 else if (NUMBERP (it->font_height))
4963 /* Value is a multiple of the canonical char height. */
4964 struct face *f;
4966 f = FACE_FROM_ID (it->f,
4967 lookup_basic_face (it->f, DEFAULT_FACE_ID));
4968 new_height = (XFLOATINT (it->font_height)
4969 * XINT (f->lface[LFACE_HEIGHT_INDEX]));
4971 else
4973 /* Evaluate IT->font_height with `height' bound to the
4974 current specified height to get the new height. */
4975 ptrdiff_t count = SPECPDL_INDEX ();
4977 specbind (Qheight, face->lface[LFACE_HEIGHT_INDEX]);
4978 value = safe_eval (it->font_height);
4979 unbind_to (count, Qnil);
4981 if (NUMBERP (value))
4982 new_height = XFLOATINT (value);
4985 if (new_height > 0)
4986 it->face_id = face_with_height (it->f, it->face_id, new_height);
4990 return 0;
4993 /* Handle `(space-width WIDTH)'. */
4994 if (CONSP (spec)
4995 && EQ (XCAR (spec), Qspace_width)
4996 && CONSP (XCDR (spec)))
4998 if (it)
5000 if (!FRAME_WINDOW_P (it->f))
5001 return 0;
5003 value = XCAR (XCDR (spec));
5004 if (NUMBERP (value) && XFLOATINT (value) > 0)
5005 it->space_width = value;
5008 return 0;
5011 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5012 if (CONSP (spec)
5013 && EQ (XCAR (spec), Qslice))
5015 Lisp_Object tem;
5017 if (it)
5019 if (!FRAME_WINDOW_P (it->f))
5020 return 0;
5022 if (tem = XCDR (spec), CONSP (tem))
5024 it->slice.x = XCAR (tem);
5025 if (tem = XCDR (tem), CONSP (tem))
5027 it->slice.y = XCAR (tem);
5028 if (tem = XCDR (tem), CONSP (tem))
5030 it->slice.width = XCAR (tem);
5031 if (tem = XCDR (tem), CONSP (tem))
5032 it->slice.height = XCAR (tem);
5038 return 0;
5041 /* Handle `(raise FACTOR)'. */
5042 if (CONSP (spec)
5043 && EQ (XCAR (spec), Qraise)
5044 && CONSP (XCDR (spec)))
5046 if (it)
5048 if (!FRAME_WINDOW_P (it->f))
5049 return 0;
5051 #ifdef HAVE_WINDOW_SYSTEM
5052 value = XCAR (XCDR (spec));
5053 if (NUMBERP (value))
5055 struct face *face = FACE_FROM_ID (it->f, it->face_id);
5056 it->voffset = - (XFLOATINT (value)
5057 * (FONT_HEIGHT (face->font)));
5059 #endif /* HAVE_WINDOW_SYSTEM */
5062 return 0;
5065 /* Don't handle the other kinds of display specifications
5066 inside a string that we got from a `display' property. */
5067 if (it && it->string_from_display_prop_p)
5068 return 0;
5070 /* Characters having this form of property are not displayed, so
5071 we have to find the end of the property. */
5072 if (it)
5074 start_pos = *position;
5075 *position = display_prop_end (it, object, start_pos);
5077 value = Qnil;
5079 /* Stop the scan at that end position--we assume that all
5080 text properties change there. */
5081 if (it)
5082 it->stop_charpos = position->charpos;
5084 /* Handle `(left-fringe BITMAP [FACE])'
5085 and `(right-fringe BITMAP [FACE])'. */
5086 if (CONSP (spec)
5087 && (EQ (XCAR (spec), Qleft_fringe)
5088 || EQ (XCAR (spec), Qright_fringe))
5089 && CONSP (XCDR (spec)))
5091 int fringe_bitmap;
5093 if (it)
5095 if (!FRAME_WINDOW_P (it->f))
5096 /* If we return here, POSITION has been advanced
5097 across the text with this property. */
5099 /* Synchronize the bidi iterator with POSITION. This is
5100 needed because we are not going to push the iterator
5101 on behalf of this display property, so there will be
5102 no pop_it call to do this synchronization for us. */
5103 if (it->bidi_p)
5105 it->position = *position;
5106 iterate_out_of_display_property (it);
5107 *position = it->position;
5109 return 1;
5112 else if (!frame_window_p)
5113 return 1;
5115 #ifdef HAVE_WINDOW_SYSTEM
5116 value = XCAR (XCDR (spec));
5117 if (!SYMBOLP (value)
5118 || !(fringe_bitmap = lookup_fringe_bitmap (value)))
5119 /* If we return here, POSITION has been advanced
5120 across the text with this property. */
5122 if (it && it->bidi_p)
5124 it->position = *position;
5125 iterate_out_of_display_property (it);
5126 *position = it->position;
5128 return 1;
5131 if (it)
5133 int face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
5135 if (CONSP (XCDR (XCDR (spec))))
5137 Lisp_Object face_name = XCAR (XCDR (XCDR (spec)));
5138 int face_id2 = lookup_derived_face (it->f, face_name,
5139 FRINGE_FACE_ID, 0);
5140 if (face_id2 >= 0)
5141 face_id = face_id2;
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);
5148 it->area = TEXT_AREA;
5149 it->what = IT_IMAGE;
5150 it->image_id = -1; /* no image */
5151 it->position = start_pos;
5152 it->object = NILP (object) ? it->w->contents : object;
5153 it->method = GET_FROM_IMAGE;
5154 it->from_overlay = Qnil;
5155 it->face_id = face_id;
5156 it->from_disp_prop_p = true;
5158 /* Say that we haven't consumed the characters with
5159 `display' property yet. The call to pop_it in
5160 set_iterator_to_next will clean this up. */
5161 *position = start_pos;
5163 if (EQ (XCAR (spec), Qleft_fringe))
5165 it->left_user_fringe_bitmap = fringe_bitmap;
5166 it->left_user_fringe_face_id = face_id;
5168 else
5170 it->right_user_fringe_bitmap = fringe_bitmap;
5171 it->right_user_fringe_face_id = face_id;
5174 #endif /* HAVE_WINDOW_SYSTEM */
5175 return 1;
5178 /* Prepare to handle `((margin left-margin) ...)',
5179 `((margin right-margin) ...)' and `((margin nil) ...)'
5180 prefixes for display specifications. */
5181 location = Qunbound;
5182 if (CONSP (spec) && CONSP (XCAR (spec)))
5184 Lisp_Object tem;
5186 value = XCDR (spec);
5187 if (CONSP (value))
5188 value = XCAR (value);
5190 tem = XCAR (spec);
5191 if (EQ (XCAR (tem), Qmargin)
5192 && (tem = XCDR (tem),
5193 tem = CONSP (tem) ? XCAR (tem) : Qnil,
5194 (NILP (tem)
5195 || EQ (tem, Qleft_margin)
5196 || EQ (tem, Qright_margin))))
5197 location = tem;
5200 if (EQ (location, Qunbound))
5202 location = Qnil;
5203 value = spec;
5206 /* After this point, VALUE is the property after any
5207 margin prefix has been stripped. It must be a string,
5208 an image specification, or `(space ...)'.
5210 LOCATION specifies where to display: `left-margin',
5211 `right-margin' or nil. */
5213 valid_p = (STRINGP (value)
5214 #ifdef HAVE_WINDOW_SYSTEM
5215 || ((it ? FRAME_WINDOW_P (it->f) : frame_window_p)
5216 && valid_image_p (value))
5217 #endif /* not HAVE_WINDOW_SYSTEM */
5218 || (CONSP (value) && EQ (XCAR (value), Qspace)));
5220 if (valid_p && !display_replaced_p)
5222 int retval = 1;
5224 if (!it)
5226 /* Callers need to know whether the display spec is any kind
5227 of `(space ...)' spec that is about to affect text-area
5228 display. */
5229 if (CONSP (value) && EQ (XCAR (value), Qspace) && NILP (location))
5230 retval = 2;
5231 return retval;
5234 /* Save current settings of IT so that we can restore them
5235 when we are finished with the glyph property value. */
5236 push_it (it, position);
5237 it->from_overlay = overlay;
5238 it->from_disp_prop_p = true;
5240 if (NILP (location))
5241 it->area = TEXT_AREA;
5242 else if (EQ (location, Qleft_margin))
5243 it->area = LEFT_MARGIN_AREA;
5244 else
5245 it->area = RIGHT_MARGIN_AREA;
5247 if (STRINGP (value))
5249 it->string = value;
5250 it->multibyte_p = STRING_MULTIBYTE (it->string);
5251 it->current.overlay_string_index = -1;
5252 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5253 it->end_charpos = it->string_nchars = SCHARS (it->string);
5254 it->method = GET_FROM_STRING;
5255 it->stop_charpos = 0;
5256 it->prev_stop = 0;
5257 it->base_level_stop = 0;
5258 it->string_from_display_prop_p = true;
5259 /* Say that we haven't consumed the characters with
5260 `display' property yet. The call to pop_it in
5261 set_iterator_to_next will clean this up. */
5262 if (BUFFERP (object))
5263 *position = start_pos;
5265 /* Force paragraph direction to be that of the parent
5266 object. If the parent object's paragraph direction is
5267 not yet determined, default to L2R. */
5268 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5269 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5270 else
5271 it->paragraph_embedding = L2R;
5273 /* Set up the bidi iterator for this display string. */
5274 if (it->bidi_p)
5276 it->bidi_it.string.lstring = it->string;
5277 it->bidi_it.string.s = NULL;
5278 it->bidi_it.string.schars = it->end_charpos;
5279 it->bidi_it.string.bufpos = bufpos;
5280 it->bidi_it.string.from_disp_str = 1;
5281 it->bidi_it.string.unibyte = !it->multibyte_p;
5282 it->bidi_it.w = it->w;
5283 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5286 else if (CONSP (value) && EQ (XCAR (value), Qspace))
5288 it->method = GET_FROM_STRETCH;
5289 it->object = value;
5290 *position = it->position = start_pos;
5291 retval = 1 + (it->area == TEXT_AREA);
5293 #ifdef HAVE_WINDOW_SYSTEM
5294 else
5296 it->what = IT_IMAGE;
5297 it->image_id = lookup_image (it->f, value);
5298 it->position = start_pos;
5299 it->object = NILP (object) ? it->w->contents : object;
5300 it->method = GET_FROM_IMAGE;
5302 /* Say that we haven't consumed the characters with
5303 `display' property yet. The call to pop_it in
5304 set_iterator_to_next will clean this up. */
5305 *position = start_pos;
5307 #endif /* HAVE_WINDOW_SYSTEM */
5309 return retval;
5312 /* Invalid property or property not supported. Restore
5313 POSITION to what it was before. */
5314 *position = start_pos;
5315 return 0;
5318 /* Check if PROP is a display property value whose text should be
5319 treated as intangible. OVERLAY is the overlay from which PROP
5320 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5321 specify the buffer position covered by PROP. */
5324 display_prop_intangible_p (Lisp_Object prop, Lisp_Object overlay,
5325 ptrdiff_t charpos, ptrdiff_t bytepos)
5327 int frame_window_p = FRAME_WINDOW_P (XFRAME (selected_frame));
5328 struct text_pos position;
5330 SET_TEXT_POS (position, charpos, bytepos);
5331 return handle_display_spec (NULL, prop, Qnil, overlay,
5332 &position, charpos, frame_window_p);
5336 /* Return 1 if PROP is a display sub-property value containing STRING.
5338 Implementation note: this and the following function are really
5339 special cases of handle_display_spec and
5340 handle_single_display_spec, and should ideally use the same code.
5341 Until they do, these two pairs must be consistent and must be
5342 modified in sync. */
5344 static int
5345 single_display_spec_string_p (Lisp_Object prop, Lisp_Object string)
5347 if (EQ (string, prop))
5348 return 1;
5350 /* Skip over `when FORM'. */
5351 if (CONSP (prop) && EQ (XCAR (prop), Qwhen))
5353 prop = XCDR (prop);
5354 if (!CONSP (prop))
5355 return 0;
5356 /* Actually, the condition following `when' should be eval'ed,
5357 like handle_single_display_spec does, and we should return
5358 zero if it evaluates to nil. However, this function is
5359 called only when the buffer was already displayed and some
5360 glyph in the glyph matrix was found to come from a display
5361 string. Therefore, the condition was already evaluated, and
5362 the result was non-nil, otherwise the display string wouldn't
5363 have been displayed and we would have never been called for
5364 this property. Thus, we can skip the evaluation and assume
5365 its result is non-nil. */
5366 prop = XCDR (prop);
5369 if (CONSP (prop))
5370 /* Skip over `margin LOCATION'. */
5371 if (EQ (XCAR (prop), Qmargin))
5373 prop = XCDR (prop);
5374 if (!CONSP (prop))
5375 return 0;
5377 prop = XCDR (prop);
5378 if (!CONSP (prop))
5379 return 0;
5382 return EQ (prop, string) || (CONSP (prop) && EQ (XCAR (prop), string));
5386 /* Return 1 if STRING appears in the `display' property PROP. */
5388 static int
5389 display_prop_string_p (Lisp_Object prop, Lisp_Object string)
5391 if (CONSP (prop)
5392 && !EQ (XCAR (prop), Qwhen)
5393 && !(CONSP (XCAR (prop)) && EQ (Qmargin, XCAR (XCAR (prop)))))
5395 /* A list of sub-properties. */
5396 while (CONSP (prop))
5398 if (single_display_spec_string_p (XCAR (prop), string))
5399 return 1;
5400 prop = XCDR (prop);
5403 else if (VECTORP (prop))
5405 /* A vector of sub-properties. */
5406 ptrdiff_t i;
5407 for (i = 0; i < ASIZE (prop); ++i)
5408 if (single_display_spec_string_p (AREF (prop, i), string))
5409 return 1;
5411 else
5412 return single_display_spec_string_p (prop, string);
5414 return 0;
5417 /* Look for STRING in overlays and text properties in the current
5418 buffer, between character positions FROM and TO (excluding TO).
5419 BACK_P non-zero means look back (in this case, TO is supposed to be
5420 less than FROM).
5421 Value is the first character position where STRING was found, or
5422 zero if it wasn't found before hitting TO.
5424 This function may only use code that doesn't eval because it is
5425 called asynchronously from note_mouse_highlight. */
5427 static ptrdiff_t
5428 string_buffer_position_lim (Lisp_Object string,
5429 ptrdiff_t from, ptrdiff_t to, int back_p)
5431 Lisp_Object limit, prop, pos;
5432 int found = 0;
5434 pos = make_number (max (from, BEGV));
5436 if (!back_p) /* looking forward */
5438 limit = make_number (min (to, ZV));
5439 while (!found && !EQ (pos, limit))
5441 prop = Fget_char_property (pos, Qdisplay, Qnil);
5442 if (!NILP (prop) && display_prop_string_p (prop, string))
5443 found = 1;
5444 else
5445 pos = Fnext_single_char_property_change (pos, Qdisplay, Qnil,
5446 limit);
5449 else /* looking back */
5451 limit = make_number (max (to, BEGV));
5452 while (!found && !EQ (pos, limit))
5454 prop = Fget_char_property (pos, Qdisplay, Qnil);
5455 if (!NILP (prop) && display_prop_string_p (prop, string))
5456 found = 1;
5457 else
5458 pos = Fprevious_single_char_property_change (pos, Qdisplay, Qnil,
5459 limit);
5463 return found ? XINT (pos) : 0;
5466 /* Determine which buffer position in current buffer STRING comes from.
5467 AROUND_CHARPOS is an approximate position where it could come from.
5468 Value is the buffer position or 0 if it couldn't be determined.
5470 This function is necessary because we don't record buffer positions
5471 in glyphs generated from strings (to keep struct glyph small).
5472 This function may only use code that doesn't eval because it is
5473 called asynchronously from note_mouse_highlight. */
5475 static ptrdiff_t
5476 string_buffer_position (Lisp_Object string, ptrdiff_t around_charpos)
5478 const int MAX_DISTANCE = 1000;
5479 ptrdiff_t found = string_buffer_position_lim (string, around_charpos,
5480 around_charpos + MAX_DISTANCE,
5483 if (!found)
5484 found = string_buffer_position_lim (string, around_charpos,
5485 around_charpos - MAX_DISTANCE, 1);
5486 return found;
5491 /***********************************************************************
5492 `composition' property
5493 ***********************************************************************/
5495 /* Set up iterator IT from `composition' property at its current
5496 position. Called from handle_stop. */
5498 static enum prop_handled
5499 handle_composition_prop (struct it *it)
5501 Lisp_Object prop, string;
5502 ptrdiff_t pos, pos_byte, start, end;
5504 if (STRINGP (it->string))
5506 unsigned char *s;
5508 pos = IT_STRING_CHARPOS (*it);
5509 pos_byte = IT_STRING_BYTEPOS (*it);
5510 string = it->string;
5511 s = SDATA (string) + pos_byte;
5512 it->c = STRING_CHAR (s);
5514 else
5516 pos = IT_CHARPOS (*it);
5517 pos_byte = IT_BYTEPOS (*it);
5518 string = Qnil;
5519 it->c = FETCH_CHAR (pos_byte);
5522 /* If there's a valid composition and point is not inside of the
5523 composition (in the case that the composition is from the current
5524 buffer), draw a glyph composed from the composition components. */
5525 if (find_composition (pos, -1, &start, &end, &prop, string)
5526 && composition_valid_p (start, end, prop)
5527 && (STRINGP (it->string) || (PT <= start || PT >= end)))
5529 if (start < pos)
5530 /* As we can't handle this situation (perhaps font-lock added
5531 a new composition), we just return here hoping that next
5532 redisplay will detect this composition much earlier. */
5533 return HANDLED_NORMALLY;
5534 if (start != pos)
5536 if (STRINGP (it->string))
5537 pos_byte = string_char_to_byte (it->string, start);
5538 else
5539 pos_byte = CHAR_TO_BYTE (start);
5541 it->cmp_it.id = get_composition_id (start, pos_byte, end - start,
5542 prop, string);
5544 if (it->cmp_it.id >= 0)
5546 it->cmp_it.ch = -1;
5547 it->cmp_it.nchars = COMPOSITION_LENGTH (prop);
5548 it->cmp_it.nglyphs = -1;
5552 return HANDLED_NORMALLY;
5557 /***********************************************************************
5558 Overlay strings
5559 ***********************************************************************/
5561 /* The following structure is used to record overlay strings for
5562 later sorting in load_overlay_strings. */
5564 struct overlay_entry
5566 Lisp_Object overlay;
5567 Lisp_Object string;
5568 EMACS_INT priority;
5569 int after_string_p;
5573 /* Set up iterator IT from overlay strings at its current position.
5574 Called from handle_stop. */
5576 static enum prop_handled
5577 handle_overlay_change (struct it *it)
5579 if (!STRINGP (it->string) && get_overlay_strings (it, 0))
5580 return HANDLED_RECOMPUTE_PROPS;
5581 else
5582 return HANDLED_NORMALLY;
5586 /* Set up the next overlay string for delivery by IT, if there is an
5587 overlay string to deliver. Called by set_iterator_to_next when the
5588 end of the current overlay string is reached. If there are more
5589 overlay strings to display, IT->string and
5590 IT->current.overlay_string_index are set appropriately here.
5591 Otherwise IT->string is set to nil. */
5593 static void
5594 next_overlay_string (struct it *it)
5596 ++it->current.overlay_string_index;
5597 if (it->current.overlay_string_index == it->n_overlay_strings)
5599 /* No more overlay strings. Restore IT's settings to what
5600 they were before overlay strings were processed, and
5601 continue to deliver from current_buffer. */
5603 it->ellipsis_p = (it->stack[it->sp - 1].display_ellipsis_p != 0);
5604 pop_it (it);
5605 eassert (it->sp > 0
5606 || (NILP (it->string)
5607 && it->method == GET_FROM_BUFFER
5608 && it->stop_charpos >= BEGV
5609 && it->stop_charpos <= it->end_charpos));
5610 it->current.overlay_string_index = -1;
5611 it->n_overlay_strings = 0;
5612 it->overlay_strings_charpos = -1;
5613 /* If there's an empty display string on the stack, pop the
5614 stack, to resync the bidi iterator with IT's position. Such
5615 empty strings are pushed onto the stack in
5616 get_overlay_strings_1. */
5617 if (it->sp > 0 && STRINGP (it->string) && !SCHARS (it->string))
5618 pop_it (it);
5620 /* If we're at the end of the buffer, record that we have
5621 processed the overlay strings there already, so that
5622 next_element_from_buffer doesn't try it again. */
5623 if (NILP (it->string) && IT_CHARPOS (*it) >= it->end_charpos)
5624 it->overlay_strings_at_end_processed_p = true;
5626 else
5628 /* There are more overlay strings to process. If
5629 IT->current.overlay_string_index has advanced to a position
5630 where we must load IT->overlay_strings with more strings, do
5631 it. We must load at the IT->overlay_strings_charpos where
5632 IT->n_overlay_strings was originally computed; when invisible
5633 text is present, this might not be IT_CHARPOS (Bug#7016). */
5634 int i = it->current.overlay_string_index % OVERLAY_STRING_CHUNK_SIZE;
5636 if (it->current.overlay_string_index && i == 0)
5637 load_overlay_strings (it, it->overlay_strings_charpos);
5639 /* Initialize IT to deliver display elements from the overlay
5640 string. */
5641 it->string = it->overlay_strings[i];
5642 it->multibyte_p = STRING_MULTIBYTE (it->string);
5643 SET_TEXT_POS (it->current.string_pos, 0, 0);
5644 it->method = GET_FROM_STRING;
5645 it->stop_charpos = 0;
5646 it->end_charpos = SCHARS (it->string);
5647 if (it->cmp_it.stop_pos >= 0)
5648 it->cmp_it.stop_pos = 0;
5649 it->prev_stop = 0;
5650 it->base_level_stop = 0;
5652 /* Set up the bidi iterator for this overlay string. */
5653 if (it->bidi_p)
5655 it->bidi_it.string.lstring = it->string;
5656 it->bidi_it.string.s = NULL;
5657 it->bidi_it.string.schars = SCHARS (it->string);
5658 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
5659 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5660 it->bidi_it.string.unibyte = !it->multibyte_p;
5661 it->bidi_it.w = it->w;
5662 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5666 CHECK_IT (it);
5670 /* Compare two overlay_entry structures E1 and E2. Used as a
5671 comparison function for qsort in load_overlay_strings. Overlay
5672 strings for the same position are sorted so that
5674 1. All after-strings come in front of before-strings, except
5675 when they come from the same overlay.
5677 2. Within after-strings, strings are sorted so that overlay strings
5678 from overlays with higher priorities come first.
5680 2. Within before-strings, strings are sorted so that overlay
5681 strings from overlays with higher priorities come last.
5683 Value is analogous to strcmp. */
5686 static int
5687 compare_overlay_entries (const void *e1, const void *e2)
5689 struct overlay_entry const *entry1 = e1;
5690 struct overlay_entry const *entry2 = e2;
5691 int result;
5693 if (entry1->after_string_p != entry2->after_string_p)
5695 /* Let after-strings appear in front of before-strings if
5696 they come from different overlays. */
5697 if (EQ (entry1->overlay, entry2->overlay))
5698 result = entry1->after_string_p ? 1 : -1;
5699 else
5700 result = entry1->after_string_p ? -1 : 1;
5702 else if (entry1->priority != entry2->priority)
5704 if (entry1->after_string_p)
5705 /* After-strings sorted in order of decreasing priority. */
5706 result = entry2->priority < entry1->priority ? -1 : 1;
5707 else
5708 /* Before-strings sorted in order of increasing priority. */
5709 result = entry1->priority < entry2->priority ? -1 : 1;
5711 else
5712 result = 0;
5714 return result;
5718 /* Load the vector IT->overlay_strings with overlay strings from IT's
5719 current buffer position, or from CHARPOS if that is > 0. Set
5720 IT->n_overlays to the total number of overlay strings found.
5722 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5723 a time. On entry into load_overlay_strings,
5724 IT->current.overlay_string_index gives the number of overlay
5725 strings that have already been loaded by previous calls to this
5726 function.
5728 IT->add_overlay_start contains an additional overlay start
5729 position to consider for taking overlay strings from, if non-zero.
5730 This position comes into play when the overlay has an `invisible'
5731 property, and both before and after-strings. When we've skipped to
5732 the end of the overlay, because of its `invisible' property, we
5733 nevertheless want its before-string to appear.
5734 IT->add_overlay_start will contain the overlay start position
5735 in this case.
5737 Overlay strings are sorted so that after-string strings come in
5738 front of before-string strings. Within before and after-strings,
5739 strings are sorted by overlay priority. See also function
5740 compare_overlay_entries. */
5742 static void
5743 load_overlay_strings (struct it *it, ptrdiff_t charpos)
5745 Lisp_Object overlay, window, str, invisible;
5746 struct Lisp_Overlay *ov;
5747 ptrdiff_t start, end;
5748 ptrdiff_t n = 0, i, j;
5749 int invis_p;
5750 struct overlay_entry entriesbuf[20];
5751 ptrdiff_t size = ARRAYELTS (entriesbuf);
5752 struct overlay_entry *entries = entriesbuf;
5753 USE_SAFE_ALLOCA;
5755 if (charpos <= 0)
5756 charpos = IT_CHARPOS (*it);
5758 /* Append the overlay string STRING of overlay OVERLAY to vector
5759 `entries' which has size `size' and currently contains `n'
5760 elements. AFTER_P non-zero means STRING is an after-string of
5761 OVERLAY. */
5762 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5763 do \
5765 Lisp_Object priority; \
5767 if (n == size) \
5769 struct overlay_entry *old = entries; \
5770 SAFE_NALLOCA (entries, 2, size); \
5771 memcpy (entries, old, size * sizeof *entries); \
5772 size *= 2; \
5775 entries[n].string = (STRING); \
5776 entries[n].overlay = (OVERLAY); \
5777 priority = Foverlay_get ((OVERLAY), Qpriority); \
5778 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5779 entries[n].after_string_p = (AFTER_P); \
5780 ++n; \
5782 while (0)
5784 /* Process overlay before the overlay center. */
5785 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5787 XSETMISC (overlay, ov);
5788 eassert (OVERLAYP (overlay));
5789 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5790 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5792 if (end < charpos)
5793 break;
5795 /* Skip this overlay if it doesn't start or end at IT's current
5796 position. */
5797 if (end != charpos && start != charpos)
5798 continue;
5800 /* Skip this overlay if it doesn't apply to IT->w. */
5801 window = Foverlay_get (overlay, Qwindow);
5802 if (WINDOWP (window) && XWINDOW (window) != it->w)
5803 continue;
5805 /* If the text ``under'' the overlay is invisible, both before-
5806 and after-strings from this overlay are visible; start and
5807 end position are indistinguishable. */
5808 invisible = Foverlay_get (overlay, Qinvisible);
5809 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5811 /* If overlay has a non-empty before-string, record it. */
5812 if ((start == charpos || (end == charpos && invis_p))
5813 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5814 && SCHARS (str))
5815 RECORD_OVERLAY_STRING (overlay, str, 0);
5817 /* If overlay has a non-empty after-string, record it. */
5818 if ((end == charpos || (start == charpos && invis_p))
5819 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5820 && SCHARS (str))
5821 RECORD_OVERLAY_STRING (overlay, str, 1);
5824 /* Process overlays after the overlay center. */
5825 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5827 XSETMISC (overlay, ov);
5828 eassert (OVERLAYP (overlay));
5829 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5830 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5832 if (start > charpos)
5833 break;
5835 /* Skip this overlay if it doesn't start or end at IT's current
5836 position. */
5837 if (end != charpos && start != charpos)
5838 continue;
5840 /* Skip this overlay if it doesn't apply to IT->w. */
5841 window = Foverlay_get (overlay, Qwindow);
5842 if (WINDOWP (window) && XWINDOW (window) != it->w)
5843 continue;
5845 /* If the text ``under'' the overlay is invisible, it has a zero
5846 dimension, and both before- and after-strings apply. */
5847 invisible = Foverlay_get (overlay, Qinvisible);
5848 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5850 /* If overlay has a non-empty before-string, record it. */
5851 if ((start == charpos || (end == charpos && invis_p))
5852 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5853 && SCHARS (str))
5854 RECORD_OVERLAY_STRING (overlay, str, 0);
5856 /* If overlay has a non-empty after-string, record it. */
5857 if ((end == charpos || (start == charpos && invis_p))
5858 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5859 && SCHARS (str))
5860 RECORD_OVERLAY_STRING (overlay, str, 1);
5863 #undef RECORD_OVERLAY_STRING
5865 /* Sort entries. */
5866 if (n > 1)
5867 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5869 /* Record number of overlay strings, and where we computed it. */
5870 it->n_overlay_strings = n;
5871 it->overlay_strings_charpos = charpos;
5873 /* IT->current.overlay_string_index is the number of overlay strings
5874 that have already been consumed by IT. Copy some of the
5875 remaining overlay strings to IT->overlay_strings. */
5876 i = 0;
5877 j = it->current.overlay_string_index;
5878 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5880 it->overlay_strings[i] = entries[j].string;
5881 it->string_overlays[i++] = entries[j++].overlay;
5884 CHECK_IT (it);
5885 SAFE_FREE ();
5889 /* Get the first chunk of overlay strings at IT's current buffer
5890 position, or at CHARPOS if that is > 0. Value is non-zero if at
5891 least one overlay string was found. */
5893 static int
5894 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, int compute_stop_p)
5896 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5897 process. This fills IT->overlay_strings with strings, and sets
5898 IT->n_overlay_strings to the total number of strings to process.
5899 IT->pos.overlay_string_index has to be set temporarily to zero
5900 because load_overlay_strings needs this; it must be set to -1
5901 when no overlay strings are found because a zero value would
5902 indicate a position in the first overlay string. */
5903 it->current.overlay_string_index = 0;
5904 load_overlay_strings (it, charpos);
5906 /* If we found overlay strings, set up IT to deliver display
5907 elements from the first one. Otherwise set up IT to deliver
5908 from current_buffer. */
5909 if (it->n_overlay_strings)
5911 /* Make sure we know settings in current_buffer, so that we can
5912 restore meaningful values when we're done with the overlay
5913 strings. */
5914 if (compute_stop_p)
5915 compute_stop_pos (it);
5916 eassert (it->face_id >= 0);
5918 /* Save IT's settings. They are restored after all overlay
5919 strings have been processed. */
5920 eassert (!compute_stop_p || it->sp == 0);
5922 /* When called from handle_stop, there might be an empty display
5923 string loaded. In that case, don't bother saving it. But
5924 don't use this optimization with the bidi iterator, since we
5925 need the corresponding pop_it call to resync the bidi
5926 iterator's position with IT's position, after we are done
5927 with the overlay strings. (The corresponding call to pop_it
5928 in case of an empty display string is in
5929 next_overlay_string.) */
5930 if (!(!it->bidi_p
5931 && STRINGP (it->string) && !SCHARS (it->string)))
5932 push_it (it, NULL);
5934 /* Set up IT to deliver display elements from the first overlay
5935 string. */
5936 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5937 it->string = it->overlay_strings[0];
5938 it->from_overlay = Qnil;
5939 it->stop_charpos = 0;
5940 eassert (STRINGP (it->string));
5941 it->end_charpos = SCHARS (it->string);
5942 it->prev_stop = 0;
5943 it->base_level_stop = 0;
5944 it->multibyte_p = STRING_MULTIBYTE (it->string);
5945 it->method = GET_FROM_STRING;
5946 it->from_disp_prop_p = 0;
5948 /* Force paragraph direction to be that of the parent
5949 buffer. */
5950 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5951 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5952 else
5953 it->paragraph_embedding = L2R;
5955 /* Set up the bidi iterator for this overlay string. */
5956 if (it->bidi_p)
5958 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5960 it->bidi_it.string.lstring = it->string;
5961 it->bidi_it.string.s = NULL;
5962 it->bidi_it.string.schars = SCHARS (it->string);
5963 it->bidi_it.string.bufpos = pos;
5964 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5965 it->bidi_it.string.unibyte = !it->multibyte_p;
5966 it->bidi_it.w = it->w;
5967 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5969 return 1;
5972 it->current.overlay_string_index = -1;
5973 return 0;
5976 static int
5977 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5979 it->string = Qnil;
5980 it->method = GET_FROM_BUFFER;
5982 (void) get_overlay_strings_1 (it, charpos, 1);
5984 CHECK_IT (it);
5986 /* Value is non-zero if we found at least one overlay string. */
5987 return STRINGP (it->string);
5992 /***********************************************************************
5993 Saving and restoring state
5994 ***********************************************************************/
5996 /* Save current settings of IT on IT->stack. Called, for example,
5997 before setting up IT for an overlay string, to be able to restore
5998 IT's settings to what they were after the overlay string has been
5999 processed. If POSITION is non-NULL, it is the position to save on
6000 the stack instead of IT->position. */
6002 static void
6003 push_it (struct it *it, struct text_pos *position)
6005 struct iterator_stack_entry *p;
6007 eassert (it->sp < IT_STACK_SIZE);
6008 p = it->stack + it->sp;
6010 p->stop_charpos = it->stop_charpos;
6011 p->prev_stop = it->prev_stop;
6012 p->base_level_stop = it->base_level_stop;
6013 p->cmp_it = it->cmp_it;
6014 eassert (it->face_id >= 0);
6015 p->face_id = it->face_id;
6016 p->string = it->string;
6017 p->method = it->method;
6018 p->from_overlay = it->from_overlay;
6019 switch (p->method)
6021 case GET_FROM_IMAGE:
6022 p->u.image.object = it->object;
6023 p->u.image.image_id = it->image_id;
6024 p->u.image.slice = it->slice;
6025 break;
6026 case GET_FROM_STRETCH:
6027 p->u.stretch.object = it->object;
6028 break;
6030 p->position = position ? *position : it->position;
6031 p->current = it->current;
6032 p->end_charpos = it->end_charpos;
6033 p->string_nchars = it->string_nchars;
6034 p->area = it->area;
6035 p->multibyte_p = it->multibyte_p;
6036 p->avoid_cursor_p = it->avoid_cursor_p;
6037 p->space_width = it->space_width;
6038 p->font_height = it->font_height;
6039 p->voffset = it->voffset;
6040 p->string_from_display_prop_p = it->string_from_display_prop_p;
6041 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
6042 p->display_ellipsis_p = 0;
6043 p->line_wrap = it->line_wrap;
6044 p->bidi_p = it->bidi_p;
6045 p->paragraph_embedding = it->paragraph_embedding;
6046 p->from_disp_prop_p = it->from_disp_prop_p;
6047 ++it->sp;
6049 /* Save the state of the bidi iterator as well. */
6050 if (it->bidi_p)
6051 bidi_push_it (&it->bidi_it);
6054 static void
6055 iterate_out_of_display_property (struct it *it)
6057 int buffer_p = !STRINGP (it->string);
6058 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
6059 ptrdiff_t bob = (buffer_p ? BEGV : 0);
6061 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
6063 /* Maybe initialize paragraph direction. If we are at the beginning
6064 of a new paragraph, next_element_from_buffer may not have a
6065 chance to do that. */
6066 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
6067 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
6068 /* prev_stop can be zero, so check against BEGV as well. */
6069 while (it->bidi_it.charpos >= bob
6070 && it->prev_stop <= it->bidi_it.charpos
6071 && it->bidi_it.charpos < CHARPOS (it->position)
6072 && it->bidi_it.charpos < eob)
6073 bidi_move_to_visually_next (&it->bidi_it);
6074 /* Record the stop_pos we just crossed, for when we cross it
6075 back, maybe. */
6076 if (it->bidi_it.charpos > CHARPOS (it->position))
6077 it->prev_stop = CHARPOS (it->position);
6078 /* If we ended up not where pop_it put us, resync IT's
6079 positional members with the bidi iterator. */
6080 if (it->bidi_it.charpos != CHARPOS (it->position))
6081 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
6082 if (buffer_p)
6083 it->current.pos = it->position;
6084 else
6085 it->current.string_pos = it->position;
6088 /* Restore IT's settings from IT->stack. Called, for example, when no
6089 more overlay strings must be processed, and we return to delivering
6090 display elements from a buffer, or when the end of a string from a
6091 `display' property is reached and we return to delivering display
6092 elements from an overlay string, or from a buffer. */
6094 static void
6095 pop_it (struct it *it)
6097 struct iterator_stack_entry *p;
6098 int from_display_prop = it->from_disp_prop_p;
6100 eassert (it->sp > 0);
6101 --it->sp;
6102 p = it->stack + it->sp;
6103 it->stop_charpos = p->stop_charpos;
6104 it->prev_stop = p->prev_stop;
6105 it->base_level_stop = p->base_level_stop;
6106 it->cmp_it = p->cmp_it;
6107 it->face_id = p->face_id;
6108 it->current = p->current;
6109 it->position = p->position;
6110 it->string = p->string;
6111 it->from_overlay = p->from_overlay;
6112 if (NILP (it->string))
6113 SET_TEXT_POS (it->current.string_pos, -1, -1);
6114 it->method = p->method;
6115 switch (it->method)
6117 case GET_FROM_IMAGE:
6118 it->image_id = p->u.image.image_id;
6119 it->object = p->u.image.object;
6120 it->slice = p->u.image.slice;
6121 break;
6122 case GET_FROM_STRETCH:
6123 it->object = p->u.stretch.object;
6124 break;
6125 case GET_FROM_BUFFER:
6126 it->object = it->w->contents;
6127 break;
6128 case GET_FROM_STRING:
6130 struct face *face = FACE_FROM_ID (it->f, it->face_id);
6132 /* Restore the face_box_p flag, since it could have been
6133 overwritten by the face of the object that we just finished
6134 displaying. */
6135 if (face)
6136 it->face_box_p = face->box != FACE_NO_BOX;
6137 it->object = it->string;
6139 break;
6140 case GET_FROM_DISPLAY_VECTOR:
6141 if (it->s)
6142 it->method = GET_FROM_C_STRING;
6143 else if (STRINGP (it->string))
6144 it->method = GET_FROM_STRING;
6145 else
6147 it->method = GET_FROM_BUFFER;
6148 it->object = it->w->contents;
6151 it->end_charpos = p->end_charpos;
6152 it->string_nchars = p->string_nchars;
6153 it->area = p->area;
6154 it->multibyte_p = p->multibyte_p;
6155 it->avoid_cursor_p = p->avoid_cursor_p;
6156 it->space_width = p->space_width;
6157 it->font_height = p->font_height;
6158 it->voffset = p->voffset;
6159 it->string_from_display_prop_p = p->string_from_display_prop_p;
6160 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
6161 it->line_wrap = p->line_wrap;
6162 it->bidi_p = p->bidi_p;
6163 it->paragraph_embedding = p->paragraph_embedding;
6164 it->from_disp_prop_p = p->from_disp_prop_p;
6165 if (it->bidi_p)
6167 bidi_pop_it (&it->bidi_it);
6168 /* Bidi-iterate until we get out of the portion of text, if any,
6169 covered by a `display' text property or by an overlay with
6170 `display' property. (We cannot just jump there, because the
6171 internal coherency of the bidi iterator state can not be
6172 preserved across such jumps.) We also must determine the
6173 paragraph base direction if the overlay we just processed is
6174 at the beginning of a new paragraph. */
6175 if (from_display_prop
6176 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
6177 iterate_out_of_display_property (it);
6179 eassert ((BUFFERP (it->object)
6180 && IT_CHARPOS (*it) == it->bidi_it.charpos
6181 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
6182 || (STRINGP (it->object)
6183 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
6184 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
6185 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
6191 /***********************************************************************
6192 Moving over lines
6193 ***********************************************************************/
6195 /* Set IT's current position to the previous line start. */
6197 static void
6198 back_to_previous_line_start (struct it *it)
6200 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
6202 DEC_BOTH (cp, bp);
6203 IT_CHARPOS (*it) = find_newline_no_quit (cp, bp, -1, &IT_BYTEPOS (*it));
6207 /* Move IT to the next line start.
6209 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6210 we skipped over part of the text (as opposed to moving the iterator
6211 continuously over the text). Otherwise, don't change the value
6212 of *SKIPPED_P.
6214 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6215 iterator on the newline, if it was found.
6217 Newlines may come from buffer text, overlay strings, or strings
6218 displayed via the `display' property. That's the reason we can't
6219 simply use find_newline_no_quit.
6221 Note that this function may not skip over invisible text that is so
6222 because of text properties and immediately follows a newline. If
6223 it would, function reseat_at_next_visible_line_start, when called
6224 from set_iterator_to_next, would effectively make invisible
6225 characters following a newline part of the wrong glyph row, which
6226 leads to wrong cursor motion. */
6228 static int
6229 forward_to_next_line_start (struct it *it, int *skipped_p,
6230 struct bidi_it *bidi_it_prev)
6232 ptrdiff_t old_selective;
6233 int newline_found_p, n;
6234 const int MAX_NEWLINE_DISTANCE = 500;
6236 /* If already on a newline, just consume it to avoid unintended
6237 skipping over invisible text below. */
6238 if (it->what == IT_CHARACTER
6239 && it->c == '\n'
6240 && CHARPOS (it->position) == IT_CHARPOS (*it))
6242 if (it->bidi_p && bidi_it_prev)
6243 *bidi_it_prev = it->bidi_it;
6244 set_iterator_to_next (it, 0);
6245 it->c = 0;
6246 return 1;
6249 /* Don't handle selective display in the following. It's (a)
6250 unnecessary because it's done by the caller, and (b) leads to an
6251 infinite recursion because next_element_from_ellipsis indirectly
6252 calls this function. */
6253 old_selective = it->selective;
6254 it->selective = 0;
6256 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6257 from buffer text. */
6258 for (n = newline_found_p = 0;
6259 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
6260 n += STRINGP (it->string) ? 0 : 1)
6262 if (!get_next_display_element (it))
6263 return 0;
6264 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
6265 if (newline_found_p && it->bidi_p && bidi_it_prev)
6266 *bidi_it_prev = it->bidi_it;
6267 set_iterator_to_next (it, 0);
6270 /* If we didn't find a newline near enough, see if we can use a
6271 short-cut. */
6272 if (!newline_found_p)
6274 ptrdiff_t bytepos, start = IT_CHARPOS (*it);
6275 ptrdiff_t limit = find_newline_no_quit (start, IT_BYTEPOS (*it),
6276 1, &bytepos);
6277 Lisp_Object pos;
6279 eassert (!STRINGP (it->string));
6281 /* If there isn't any `display' property in sight, and no
6282 overlays, we can just use the position of the newline in
6283 buffer text. */
6284 if (it->stop_charpos >= limit
6285 || ((pos = Fnext_single_property_change (make_number (start),
6286 Qdisplay, Qnil,
6287 make_number (limit)),
6288 NILP (pos))
6289 && next_overlay_change (start) == ZV))
6291 if (!it->bidi_p)
6293 IT_CHARPOS (*it) = limit;
6294 IT_BYTEPOS (*it) = bytepos;
6296 else
6298 struct bidi_it bprev;
6300 /* Help bidi.c avoid expensive searches for display
6301 properties and overlays, by telling it that there are
6302 none up to `limit'. */
6303 if (it->bidi_it.disp_pos < limit)
6305 it->bidi_it.disp_pos = limit;
6306 it->bidi_it.disp_prop = 0;
6308 do {
6309 bprev = it->bidi_it;
6310 bidi_move_to_visually_next (&it->bidi_it);
6311 } while (it->bidi_it.charpos != limit);
6312 IT_CHARPOS (*it) = limit;
6313 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6314 if (bidi_it_prev)
6315 *bidi_it_prev = bprev;
6317 *skipped_p = newline_found_p = true;
6319 else
6321 while (get_next_display_element (it)
6322 && !newline_found_p)
6324 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6325 if (newline_found_p && it->bidi_p && bidi_it_prev)
6326 *bidi_it_prev = it->bidi_it;
6327 set_iterator_to_next (it, 0);
6332 it->selective = old_selective;
6333 return newline_found_p;
6337 /* Set IT's current position to the previous visible line start. Skip
6338 invisible text that is so either due to text properties or due to
6339 selective display. Caution: this does not change IT->current_x and
6340 IT->hpos. */
6342 static void
6343 back_to_previous_visible_line_start (struct it *it)
6345 while (IT_CHARPOS (*it) > BEGV)
6347 back_to_previous_line_start (it);
6349 if (IT_CHARPOS (*it) <= BEGV)
6350 break;
6352 /* If selective > 0, then lines indented more than its value are
6353 invisible. */
6354 if (it->selective > 0
6355 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6356 it->selective))
6357 continue;
6359 /* Check the newline before point for invisibility. */
6361 Lisp_Object prop;
6362 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6363 Qinvisible, it->window);
6364 if (TEXT_PROP_MEANS_INVISIBLE (prop))
6365 continue;
6368 if (IT_CHARPOS (*it) <= BEGV)
6369 break;
6372 struct it it2;
6373 void *it2data = NULL;
6374 ptrdiff_t pos;
6375 ptrdiff_t beg, end;
6376 Lisp_Object val, overlay;
6378 SAVE_IT (it2, *it, it2data);
6380 /* If newline is part of a composition, continue from start of composition */
6381 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6382 && beg < IT_CHARPOS (*it))
6383 goto replaced;
6385 /* If newline is replaced by a display property, find start of overlay
6386 or interval and continue search from that point. */
6387 pos = --IT_CHARPOS (it2);
6388 --IT_BYTEPOS (it2);
6389 it2.sp = 0;
6390 bidi_unshelve_cache (NULL, 0);
6391 it2.string_from_display_prop_p = 0;
6392 it2.from_disp_prop_p = 0;
6393 if (handle_display_prop (&it2) == HANDLED_RETURN
6394 && !NILP (val = get_char_property_and_overlay
6395 (make_number (pos), Qdisplay, Qnil, &overlay))
6396 && (OVERLAYP (overlay)
6397 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6398 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6400 RESTORE_IT (it, it, it2data);
6401 goto replaced;
6404 /* Newline is not replaced by anything -- so we are done. */
6405 RESTORE_IT (it, it, it2data);
6406 break;
6408 replaced:
6409 if (beg < BEGV)
6410 beg = BEGV;
6411 IT_CHARPOS (*it) = beg;
6412 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6416 it->continuation_lines_width = 0;
6418 eassert (IT_CHARPOS (*it) >= BEGV);
6419 eassert (IT_CHARPOS (*it) == BEGV
6420 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6421 CHECK_IT (it);
6425 /* Reseat iterator IT at the previous visible line start. Skip
6426 invisible text that is so either due to text properties or due to
6427 selective display. At the end, update IT's overlay information,
6428 face information etc. */
6430 void
6431 reseat_at_previous_visible_line_start (struct it *it)
6433 back_to_previous_visible_line_start (it);
6434 reseat (it, it->current.pos, 1);
6435 CHECK_IT (it);
6439 /* Reseat iterator IT on the next visible line start in the current
6440 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6441 preceding the line start. Skip over invisible text that is so
6442 because of selective display. Compute faces, overlays etc at the
6443 new position. Note that this function does not skip over text that
6444 is invisible because of text properties. */
6446 static void
6447 reseat_at_next_visible_line_start (struct it *it, int on_newline_p)
6449 int newline_found_p, skipped_p = 0;
6450 struct bidi_it bidi_it_prev;
6452 newline_found_p = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6454 /* Skip over lines that are invisible because they are indented
6455 more than the value of IT->selective. */
6456 if (it->selective > 0)
6457 while (IT_CHARPOS (*it) < ZV
6458 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6459 it->selective))
6461 eassert (IT_BYTEPOS (*it) == BEGV
6462 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6463 newline_found_p =
6464 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6467 /* Position on the newline if that's what's requested. */
6468 if (on_newline_p && newline_found_p)
6470 if (STRINGP (it->string))
6472 if (IT_STRING_CHARPOS (*it) > 0)
6474 if (!it->bidi_p)
6476 --IT_STRING_CHARPOS (*it);
6477 --IT_STRING_BYTEPOS (*it);
6479 else
6481 /* We need to restore the bidi iterator to the state
6482 it had on the newline, and resync the IT's
6483 position with that. */
6484 it->bidi_it = bidi_it_prev;
6485 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6486 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6490 else if (IT_CHARPOS (*it) > BEGV)
6492 if (!it->bidi_p)
6494 --IT_CHARPOS (*it);
6495 --IT_BYTEPOS (*it);
6497 else
6499 /* We need to restore the bidi iterator to the state it
6500 had on the newline and resync IT with that. */
6501 it->bidi_it = bidi_it_prev;
6502 IT_CHARPOS (*it) = it->bidi_it.charpos;
6503 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6505 reseat (it, it->current.pos, 0);
6508 else if (skipped_p)
6509 reseat (it, it->current.pos, 0);
6511 CHECK_IT (it);
6516 /***********************************************************************
6517 Changing an iterator's position
6518 ***********************************************************************/
6520 /* Change IT's current position to POS in current_buffer. If FORCE_P
6521 is non-zero, always check for text properties at the new position.
6522 Otherwise, text properties are only looked up if POS >=
6523 IT->check_charpos of a property. */
6525 static void
6526 reseat (struct it *it, struct text_pos pos, int force_p)
6528 ptrdiff_t original_pos = IT_CHARPOS (*it);
6530 reseat_1 (it, pos, 0);
6532 /* Determine where to check text properties. Avoid doing it
6533 where possible because text property lookup is very expensive. */
6534 if (force_p
6535 || CHARPOS (pos) > it->stop_charpos
6536 || CHARPOS (pos) < original_pos)
6538 if (it->bidi_p)
6540 /* For bidi iteration, we need to prime prev_stop and
6541 base_level_stop with our best estimations. */
6542 /* Implementation note: Of course, POS is not necessarily a
6543 stop position, so assigning prev_pos to it is a lie; we
6544 should have called compute_stop_backwards. However, if
6545 the current buffer does not include any R2L characters,
6546 that call would be a waste of cycles, because the
6547 iterator will never move back, and thus never cross this
6548 "fake" stop position. So we delay that backward search
6549 until the time we really need it, in next_element_from_buffer. */
6550 if (CHARPOS (pos) != it->prev_stop)
6551 it->prev_stop = CHARPOS (pos);
6552 if (CHARPOS (pos) < it->base_level_stop)
6553 it->base_level_stop = 0; /* meaning it's unknown */
6554 handle_stop (it);
6556 else
6558 handle_stop (it);
6559 it->prev_stop = it->base_level_stop = 0;
6564 CHECK_IT (it);
6568 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6569 IT->stop_pos to POS, also. */
6571 static void
6572 reseat_1 (struct it *it, struct text_pos pos, int set_stop_p)
6574 /* Don't call this function when scanning a C string. */
6575 eassert (it->s == NULL);
6577 /* POS must be a reasonable value. */
6578 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6580 it->current.pos = it->position = pos;
6581 it->end_charpos = ZV;
6582 it->dpvec = NULL;
6583 it->current.dpvec_index = -1;
6584 it->current.overlay_string_index = -1;
6585 IT_STRING_CHARPOS (*it) = -1;
6586 IT_STRING_BYTEPOS (*it) = -1;
6587 it->string = Qnil;
6588 it->method = GET_FROM_BUFFER;
6589 it->object = it->w->contents;
6590 it->area = TEXT_AREA;
6591 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6592 it->sp = 0;
6593 it->string_from_display_prop_p = 0;
6594 it->string_from_prefix_prop_p = 0;
6596 it->from_disp_prop_p = 0;
6597 it->face_before_selective_p = 0;
6598 if (it->bidi_p)
6600 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6601 &it->bidi_it);
6602 bidi_unshelve_cache (NULL, 0);
6603 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6604 it->bidi_it.string.s = NULL;
6605 it->bidi_it.string.lstring = Qnil;
6606 it->bidi_it.string.bufpos = 0;
6607 it->bidi_it.string.from_disp_str = 0;
6608 it->bidi_it.string.unibyte = 0;
6609 it->bidi_it.w = it->w;
6612 if (set_stop_p)
6614 it->stop_charpos = CHARPOS (pos);
6615 it->base_level_stop = CHARPOS (pos);
6617 /* This make the information stored in it->cmp_it invalidate. */
6618 it->cmp_it.id = -1;
6622 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6623 If S is non-null, it is a C string to iterate over. Otherwise,
6624 STRING gives a Lisp string to iterate over.
6626 If PRECISION > 0, don't return more then PRECISION number of
6627 characters from the string.
6629 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6630 characters have been returned. FIELD_WIDTH < 0 means an infinite
6631 field width.
6633 MULTIBYTE = 0 means disable processing of multibyte characters,
6634 MULTIBYTE > 0 means enable it,
6635 MULTIBYTE < 0 means use IT->multibyte_p.
6637 IT must be initialized via a prior call to init_iterator before
6638 calling this function. */
6640 static void
6641 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6642 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6643 int multibyte)
6645 /* No text property checks performed by default, but see below. */
6646 it->stop_charpos = -1;
6648 /* Set iterator position and end position. */
6649 memset (&it->current, 0, sizeof it->current);
6650 it->current.overlay_string_index = -1;
6651 it->current.dpvec_index = -1;
6652 eassert (charpos >= 0);
6654 /* If STRING is specified, use its multibyteness, otherwise use the
6655 setting of MULTIBYTE, if specified. */
6656 if (multibyte >= 0)
6657 it->multibyte_p = multibyte > 0;
6659 /* Bidirectional reordering of strings is controlled by the default
6660 value of bidi-display-reordering. Don't try to reorder while
6661 loading loadup.el, as the necessary character property tables are
6662 not yet available. */
6663 it->bidi_p =
6664 NILP (Vpurify_flag)
6665 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6667 if (s == NULL)
6669 eassert (STRINGP (string));
6670 it->string = string;
6671 it->s = NULL;
6672 it->end_charpos = it->string_nchars = SCHARS (string);
6673 it->method = GET_FROM_STRING;
6674 it->current.string_pos = string_pos (charpos, string);
6676 if (it->bidi_p)
6678 it->bidi_it.string.lstring = string;
6679 it->bidi_it.string.s = NULL;
6680 it->bidi_it.string.schars = it->end_charpos;
6681 it->bidi_it.string.bufpos = 0;
6682 it->bidi_it.string.from_disp_str = 0;
6683 it->bidi_it.string.unibyte = !it->multibyte_p;
6684 it->bidi_it.w = it->w;
6685 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6686 FRAME_WINDOW_P (it->f), &it->bidi_it);
6689 else
6691 it->s = (const unsigned char *) s;
6692 it->string = Qnil;
6694 /* Note that we use IT->current.pos, not it->current.string_pos,
6695 for displaying C strings. */
6696 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6697 if (it->multibyte_p)
6699 it->current.pos = c_string_pos (charpos, s, 1);
6700 it->end_charpos = it->string_nchars = number_of_chars (s, 1);
6702 else
6704 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6705 it->end_charpos = it->string_nchars = strlen (s);
6708 if (it->bidi_p)
6710 it->bidi_it.string.lstring = Qnil;
6711 it->bidi_it.string.s = (const unsigned char *) s;
6712 it->bidi_it.string.schars = it->end_charpos;
6713 it->bidi_it.string.bufpos = 0;
6714 it->bidi_it.string.from_disp_str = 0;
6715 it->bidi_it.string.unibyte = !it->multibyte_p;
6716 it->bidi_it.w = it->w;
6717 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6718 &it->bidi_it);
6720 it->method = GET_FROM_C_STRING;
6723 /* PRECISION > 0 means don't return more than PRECISION characters
6724 from the string. */
6725 if (precision > 0 && it->end_charpos - charpos > precision)
6727 it->end_charpos = it->string_nchars = charpos + precision;
6728 if (it->bidi_p)
6729 it->bidi_it.string.schars = it->end_charpos;
6732 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6733 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6734 FIELD_WIDTH < 0 means infinite field width. This is useful for
6735 padding with `-' at the end of a mode line. */
6736 if (field_width < 0)
6737 field_width = INFINITY;
6738 /* Implementation note: We deliberately don't enlarge
6739 it->bidi_it.string.schars here to fit it->end_charpos, because
6740 the bidi iterator cannot produce characters out of thin air. */
6741 if (field_width > it->end_charpos - charpos)
6742 it->end_charpos = charpos + field_width;
6744 /* Use the standard display table for displaying strings. */
6745 if (DISP_TABLE_P (Vstandard_display_table))
6746 it->dp = XCHAR_TABLE (Vstandard_display_table);
6748 it->stop_charpos = charpos;
6749 it->prev_stop = charpos;
6750 it->base_level_stop = 0;
6751 if (it->bidi_p)
6753 it->bidi_it.first_elt = 1;
6754 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6755 it->bidi_it.disp_pos = -1;
6757 if (s == NULL && it->multibyte_p)
6759 ptrdiff_t endpos = SCHARS (it->string);
6760 if (endpos > it->end_charpos)
6761 endpos = it->end_charpos;
6762 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6763 it->string);
6765 CHECK_IT (it);
6770 /***********************************************************************
6771 Iteration
6772 ***********************************************************************/
6774 /* Map enum it_method value to corresponding next_element_from_* function. */
6776 static int (* get_next_element[NUM_IT_METHODS]) (struct it *it) =
6778 next_element_from_buffer,
6779 next_element_from_display_vector,
6780 next_element_from_string,
6781 next_element_from_c_string,
6782 next_element_from_image,
6783 next_element_from_stretch
6786 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6789 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6790 (possibly with the following characters). */
6792 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6793 ((IT)->cmp_it.id >= 0 \
6794 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6795 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6796 END_CHARPOS, (IT)->w, \
6797 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6798 (IT)->string)))
6801 /* Lookup the char-table Vglyphless_char_display for character C (-1
6802 if we want information for no-font case), and return the display
6803 method symbol. By side-effect, update it->what and
6804 it->glyphless_method. This function is called from
6805 get_next_display_element for each character element, and from
6806 x_produce_glyphs when no suitable font was found. */
6808 Lisp_Object
6809 lookup_glyphless_char_display (int c, struct it *it)
6811 Lisp_Object glyphless_method = Qnil;
6813 if (CHAR_TABLE_P (Vglyphless_char_display)
6814 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6816 if (c >= 0)
6818 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6819 if (CONSP (glyphless_method))
6820 glyphless_method = FRAME_WINDOW_P (it->f)
6821 ? XCAR (glyphless_method)
6822 : XCDR (glyphless_method);
6824 else
6825 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6828 retry:
6829 if (NILP (glyphless_method))
6831 if (c >= 0)
6832 /* The default is to display the character by a proper font. */
6833 return Qnil;
6834 /* The default for the no-font case is to display an empty box. */
6835 glyphless_method = Qempty_box;
6837 if (EQ (glyphless_method, Qzero_width))
6839 if (c >= 0)
6840 return glyphless_method;
6841 /* This method can't be used for the no-font case. */
6842 glyphless_method = Qempty_box;
6844 if (EQ (glyphless_method, Qthin_space))
6845 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6846 else if (EQ (glyphless_method, Qempty_box))
6847 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6848 else if (EQ (glyphless_method, Qhex_code))
6849 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6850 else if (STRINGP (glyphless_method))
6851 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6852 else
6854 /* Invalid value. We use the default method. */
6855 glyphless_method = Qnil;
6856 goto retry;
6858 it->what = IT_GLYPHLESS;
6859 return glyphless_method;
6862 /* Merge escape glyph face and cache the result. */
6864 static struct frame *last_escape_glyph_frame = NULL;
6865 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6866 static int last_escape_glyph_merged_face_id = 0;
6868 static int
6869 merge_escape_glyph_face (struct it *it)
6871 int face_id;
6873 if (it->f == last_escape_glyph_frame
6874 && it->face_id == last_escape_glyph_face_id)
6875 face_id = last_escape_glyph_merged_face_id;
6876 else
6878 /* Merge the `escape-glyph' face into the current face. */
6879 face_id = merge_faces (it->f, Qescape_glyph, 0, it->face_id);
6880 last_escape_glyph_frame = it->f;
6881 last_escape_glyph_face_id = it->face_id;
6882 last_escape_glyph_merged_face_id = face_id;
6884 return face_id;
6887 /* Likewise for glyphless glyph face. */
6889 static struct frame *last_glyphless_glyph_frame = NULL;
6890 static int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6891 static int last_glyphless_glyph_merged_face_id = 0;
6894 merge_glyphless_glyph_face (struct it *it)
6896 int face_id;
6898 if (it->f == last_glyphless_glyph_frame
6899 && it->face_id == last_glyphless_glyph_face_id)
6900 face_id = last_glyphless_glyph_merged_face_id;
6901 else
6903 /* Merge the `glyphless-char' face into the current face. */
6904 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
6905 last_glyphless_glyph_frame = it->f;
6906 last_glyphless_glyph_face_id = it->face_id;
6907 last_glyphless_glyph_merged_face_id = face_id;
6909 return face_id;
6912 /* Load IT's display element fields with information about the next
6913 display element from the current position of IT. Value is zero if
6914 end of buffer (or C string) is reached. */
6916 static int
6917 get_next_display_element (struct it *it)
6919 /* Non-zero means that we found a display element. Zero means that
6920 we hit the end of what we iterate over. Performance note: the
6921 function pointer `method' used here turns out to be faster than
6922 using a sequence of if-statements. */
6923 int success_p;
6925 get_next:
6926 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6928 if (it->what == IT_CHARACTER)
6930 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6931 and only if (a) the resolved directionality of that character
6932 is R..." */
6933 /* FIXME: Do we need an exception for characters from display
6934 tables? */
6935 if (it->bidi_p && it->bidi_it.type == STRONG_R
6936 && !inhibit_bidi_mirroring)
6937 it->c = bidi_mirror_char (it->c);
6938 /* Map via display table or translate control characters.
6939 IT->c, IT->len etc. have been set to the next character by
6940 the function call above. If we have a display table, and it
6941 contains an entry for IT->c, translate it. Don't do this if
6942 IT->c itself comes from a display table, otherwise we could
6943 end up in an infinite recursion. (An alternative could be to
6944 count the recursion depth of this function and signal an
6945 error when a certain maximum depth is reached.) Is it worth
6946 it? */
6947 if (success_p && it->dpvec == NULL)
6949 Lisp_Object dv;
6950 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6951 int nonascii_space_p = 0;
6952 int nonascii_hyphen_p = 0;
6953 int c = it->c; /* This is the character to display. */
6955 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6957 eassert (SINGLE_BYTE_CHAR_P (c));
6958 if (unibyte_display_via_language_environment)
6960 c = DECODE_CHAR (unibyte, c);
6961 if (c < 0)
6962 c = BYTE8_TO_CHAR (it->c);
6964 else
6965 c = BYTE8_TO_CHAR (it->c);
6968 if (it->dp
6969 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6970 VECTORP (dv)))
6972 struct Lisp_Vector *v = XVECTOR (dv);
6974 /* Return the first character from the display table
6975 entry, if not empty. If empty, don't display the
6976 current character. */
6977 if (v->header.size)
6979 it->dpvec_char_len = it->len;
6980 it->dpvec = v->contents;
6981 it->dpend = v->contents + v->header.size;
6982 it->current.dpvec_index = 0;
6983 it->dpvec_face_id = -1;
6984 it->saved_face_id = it->face_id;
6985 it->method = GET_FROM_DISPLAY_VECTOR;
6986 it->ellipsis_p = 0;
6988 else
6990 set_iterator_to_next (it, 0);
6992 goto get_next;
6995 if (! NILP (lookup_glyphless_char_display (c, it)))
6997 if (it->what == IT_GLYPHLESS)
6998 goto done;
6999 /* Don't display this character. */
7000 set_iterator_to_next (it, 0);
7001 goto get_next;
7004 /* If `nobreak-char-display' is non-nil, we display
7005 non-ASCII spaces and hyphens specially. */
7006 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
7008 if (c == 0xA0)
7009 nonascii_space_p = true;
7010 else if (c == 0xAD || c == 0x2010 || c == 0x2011)
7011 nonascii_hyphen_p = true;
7014 /* Translate control characters into `\003' or `^C' form.
7015 Control characters coming from a display table entry are
7016 currently not translated because we use IT->dpvec to hold
7017 the translation. This could easily be changed but I
7018 don't believe that it is worth doing.
7020 The characters handled by `nobreak-char-display' must be
7021 translated too.
7023 Non-printable characters and raw-byte characters are also
7024 translated to octal form. */
7025 if (((c < ' ' || c == 127) /* ASCII control chars. */
7026 ? (it->area != TEXT_AREA
7027 /* In mode line, treat \n, \t like other crl chars. */
7028 || (c != '\t'
7029 && it->glyph_row
7030 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
7031 || (c != '\n' && c != '\t'))
7032 : (nonascii_space_p
7033 || nonascii_hyphen_p
7034 || CHAR_BYTE8_P (c)
7035 || ! CHAR_PRINTABLE_P (c))))
7037 /* C is a control character, non-ASCII space/hyphen,
7038 raw-byte, or a non-printable character which must be
7039 displayed either as '\003' or as `^C' where the '\\'
7040 and '^' can be defined in the display table. Fill
7041 IT->ctl_chars with glyphs for what we have to
7042 display. Then, set IT->dpvec to these glyphs. */
7043 Lisp_Object gc;
7044 int ctl_len;
7045 int face_id;
7046 int lface_id = 0;
7047 int escape_glyph;
7049 /* Handle control characters with ^. */
7051 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
7053 int g;
7055 g = '^'; /* default glyph for Control */
7056 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7057 if (it->dp
7058 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7060 g = GLYPH_CODE_CHAR (gc);
7061 lface_id = GLYPH_CODE_FACE (gc);
7064 face_id = (lface_id
7065 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7066 : merge_escape_glyph_face (it));
7068 XSETINT (it->ctl_chars[0], g);
7069 XSETINT (it->ctl_chars[1], c ^ 0100);
7070 ctl_len = 2;
7071 goto display_control;
7074 /* Handle non-ascii space in the mode where it only gets
7075 highlighting. */
7077 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
7079 /* Merge `nobreak-space' into the current face. */
7080 face_id = merge_faces (it->f, Qnobreak_space, 0,
7081 it->face_id);
7082 XSETINT (it->ctl_chars[0], ' ');
7083 ctl_len = 1;
7084 goto display_control;
7087 /* Handle sequences that start with the "escape glyph". */
7089 /* the default escape glyph is \. */
7090 escape_glyph = '\\';
7092 if (it->dp
7093 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7095 escape_glyph = GLYPH_CODE_CHAR (gc);
7096 lface_id = GLYPH_CODE_FACE (gc);
7099 face_id = (lface_id
7100 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7101 : merge_escape_glyph_face (it));
7103 /* Draw non-ASCII hyphen with just highlighting: */
7105 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
7107 XSETINT (it->ctl_chars[0], '-');
7108 ctl_len = 1;
7109 goto display_control;
7112 /* Draw non-ASCII space/hyphen with escape glyph: */
7114 if (nonascii_space_p || nonascii_hyphen_p)
7116 XSETINT (it->ctl_chars[0], escape_glyph);
7117 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
7118 ctl_len = 2;
7119 goto display_control;
7123 char str[10];
7124 int len, i;
7126 if (CHAR_BYTE8_P (c))
7127 /* Display \200 instead of \17777600. */
7128 c = CHAR_TO_BYTE8 (c);
7129 len = sprintf (str, "%03o", c);
7131 XSETINT (it->ctl_chars[0], escape_glyph);
7132 for (i = 0; i < len; i++)
7133 XSETINT (it->ctl_chars[i + 1], str[i]);
7134 ctl_len = len + 1;
7137 display_control:
7138 /* Set up IT->dpvec and return first character from it. */
7139 it->dpvec_char_len = it->len;
7140 it->dpvec = it->ctl_chars;
7141 it->dpend = it->dpvec + ctl_len;
7142 it->current.dpvec_index = 0;
7143 it->dpvec_face_id = face_id;
7144 it->saved_face_id = it->face_id;
7145 it->method = GET_FROM_DISPLAY_VECTOR;
7146 it->ellipsis_p = 0;
7147 goto get_next;
7149 it->char_to_display = c;
7151 else if (success_p)
7153 it->char_to_display = it->c;
7157 #ifdef HAVE_WINDOW_SYSTEM
7158 /* Adjust face id for a multibyte character. There are no multibyte
7159 character in unibyte text. */
7160 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
7161 && it->multibyte_p
7162 && success_p
7163 && FRAME_WINDOW_P (it->f))
7165 struct face *face = FACE_FROM_ID (it->f, it->face_id);
7167 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
7169 /* Automatic composition with glyph-string. */
7170 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
7172 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
7174 else
7176 ptrdiff_t pos = (it->s ? -1
7177 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
7178 : IT_CHARPOS (*it));
7179 int c;
7181 if (it->what == IT_CHARACTER)
7182 c = it->char_to_display;
7183 else
7185 struct composition *cmp = composition_table[it->cmp_it.id];
7186 int i;
7188 c = ' ';
7189 for (i = 0; i < cmp->glyph_len; i++)
7190 /* TAB in a composition means display glyphs with
7191 padding space on the left or right. */
7192 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
7193 break;
7195 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
7198 #endif /* HAVE_WINDOW_SYSTEM */
7200 done:
7201 /* Is this character the last one of a run of characters with
7202 box? If yes, set IT->end_of_box_run_p to 1. */
7203 if (it->face_box_p
7204 && it->s == NULL)
7206 if (it->method == GET_FROM_STRING && it->sp)
7208 int face_id = underlying_face_id (it);
7209 struct face *face = FACE_FROM_ID (it->f, face_id);
7211 if (face)
7213 if (face->box == FACE_NO_BOX)
7215 /* If the box comes from face properties in a
7216 display string, check faces in that string. */
7217 int string_face_id = face_after_it_pos (it);
7218 it->end_of_box_run_p
7219 = (FACE_FROM_ID (it->f, string_face_id)->box
7220 == FACE_NO_BOX);
7222 /* Otherwise, the box comes from the underlying face.
7223 If this is the last string character displayed, check
7224 the next buffer location. */
7225 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
7226 /* n_overlay_strings is unreliable unless
7227 overlay_string_index is non-negative. */
7228 && ((it->current.overlay_string_index >= 0
7229 && (it->current.overlay_string_index
7230 == it->n_overlay_strings - 1))
7231 /* A string from display property. */
7232 || it->from_disp_prop_p))
7234 ptrdiff_t ignore;
7235 int next_face_id;
7236 struct text_pos pos = it->current.pos;
7238 /* For a string from a display property, the next
7239 buffer position is stored in the 'position'
7240 member of the iteration stack slot below the
7241 current one, see handle_single_display_spec. By
7242 contrast, it->current.pos was is not yet updated
7243 to point to that buffer position; that will
7244 happen in pop_it, after we finish displaying the
7245 current string. Note that we already checked
7246 above that it->sp is positive, so subtracting one
7247 from it is safe. */
7248 if (it->from_disp_prop_p)
7249 pos = (it->stack + it->sp - 1)->position;
7250 else
7251 INC_TEXT_POS (pos, it->multibyte_p);
7253 if (CHARPOS (pos) >= ZV)
7254 it->end_of_box_run_p = true;
7255 else
7257 next_face_id = face_at_buffer_position
7258 (it->w, CHARPOS (pos), &ignore,
7259 CHARPOS (pos) + TEXT_PROP_DISTANCE_LIMIT, 0, -1);
7260 it->end_of_box_run_p
7261 = (FACE_FROM_ID (it->f, next_face_id)->box
7262 == FACE_NO_BOX);
7267 /* next_element_from_display_vector sets this flag according to
7268 faces of the display vector glyphs, see there. */
7269 else if (it->method != GET_FROM_DISPLAY_VECTOR)
7271 int face_id = face_after_it_pos (it);
7272 it->end_of_box_run_p
7273 = (face_id != it->face_id
7274 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
7277 /* If we reached the end of the object we've been iterating (e.g., a
7278 display string or an overlay string), and there's something on
7279 IT->stack, proceed with what's on the stack. It doesn't make
7280 sense to return zero if there's unprocessed stuff on the stack,
7281 because otherwise that stuff will never be displayed. */
7282 if (!success_p && it->sp > 0)
7284 set_iterator_to_next (it, 0);
7285 success_p = get_next_display_element (it);
7288 /* Value is 0 if end of buffer or string reached. */
7289 return success_p;
7293 /* Move IT to the next display element.
7295 RESEAT_P non-zero means if called on a newline in buffer text,
7296 skip to the next visible line start.
7298 Functions get_next_display_element and set_iterator_to_next are
7299 separate because I find this arrangement easier to handle than a
7300 get_next_display_element function that also increments IT's
7301 position. The way it is we can first look at an iterator's current
7302 display element, decide whether it fits on a line, and if it does,
7303 increment the iterator position. The other way around we probably
7304 would either need a flag indicating whether the iterator has to be
7305 incremented the next time, or we would have to implement a
7306 decrement position function which would not be easy to write. */
7308 void
7309 set_iterator_to_next (struct it *it, int reseat_p)
7311 /* Reset flags indicating start and end of a sequence of characters
7312 with box. Reset them at the start of this function because
7313 moving the iterator to a new position might set them. */
7314 it->start_of_box_run_p = it->end_of_box_run_p = 0;
7316 switch (it->method)
7318 case GET_FROM_BUFFER:
7319 /* The current display element of IT is a character from
7320 current_buffer. Advance in the buffer, and maybe skip over
7321 invisible lines that are so because of selective display. */
7322 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
7323 reseat_at_next_visible_line_start (it, 0);
7324 else if (it->cmp_it.id >= 0)
7326 /* We are currently getting glyphs from a composition. */
7327 int i;
7329 if (! it->bidi_p)
7331 IT_CHARPOS (*it) += it->cmp_it.nchars;
7332 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
7333 if (it->cmp_it.to < it->cmp_it.nglyphs)
7335 it->cmp_it.from = it->cmp_it.to;
7337 else
7339 it->cmp_it.id = -1;
7340 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7341 IT_BYTEPOS (*it),
7342 it->end_charpos, Qnil);
7345 else if (! it->cmp_it.reversed_p)
7347 /* Composition created while scanning forward. */
7348 /* Update IT's char/byte positions to point to the first
7349 character of the next grapheme cluster, or to the
7350 character visually after the current composition. */
7351 for (i = 0; i < it->cmp_it.nchars; i++)
7352 bidi_move_to_visually_next (&it->bidi_it);
7353 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7354 IT_CHARPOS (*it) = it->bidi_it.charpos;
7356 if (it->cmp_it.to < it->cmp_it.nglyphs)
7358 /* Proceed to the next grapheme cluster. */
7359 it->cmp_it.from = it->cmp_it.to;
7361 else
7363 /* No more grapheme clusters in this composition.
7364 Find the next stop position. */
7365 ptrdiff_t stop = it->end_charpos;
7366 if (it->bidi_it.scan_dir < 0)
7367 /* Now we are scanning backward and don't know
7368 where to stop. */
7369 stop = -1;
7370 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7371 IT_BYTEPOS (*it), stop, Qnil);
7374 else
7376 /* Composition created while scanning backward. */
7377 /* Update IT's char/byte positions to point to the last
7378 character of the previous grapheme cluster, or the
7379 character visually after the current composition. */
7380 for (i = 0; i < it->cmp_it.nchars; i++)
7381 bidi_move_to_visually_next (&it->bidi_it);
7382 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7383 IT_CHARPOS (*it) = it->bidi_it.charpos;
7384 if (it->cmp_it.from > 0)
7386 /* Proceed to the previous grapheme cluster. */
7387 it->cmp_it.to = it->cmp_it.from;
7389 else
7391 /* No more grapheme clusters in this composition.
7392 Find the next stop position. */
7393 ptrdiff_t stop = it->end_charpos;
7394 if (it->bidi_it.scan_dir < 0)
7395 /* Now we are scanning backward and don't know
7396 where to stop. */
7397 stop = -1;
7398 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7399 IT_BYTEPOS (*it), stop, Qnil);
7403 else
7405 eassert (it->len != 0);
7407 if (!it->bidi_p)
7409 IT_BYTEPOS (*it) += it->len;
7410 IT_CHARPOS (*it) += 1;
7412 else
7414 int prev_scan_dir = it->bidi_it.scan_dir;
7415 /* If this is a new paragraph, determine its base
7416 direction (a.k.a. its base embedding level). */
7417 if (it->bidi_it.new_paragraph)
7418 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
7419 bidi_move_to_visually_next (&it->bidi_it);
7420 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7421 IT_CHARPOS (*it) = it->bidi_it.charpos;
7422 if (prev_scan_dir != it->bidi_it.scan_dir)
7424 /* As the scan direction was changed, we must
7425 re-compute the stop position for composition. */
7426 ptrdiff_t stop = it->end_charpos;
7427 if (it->bidi_it.scan_dir < 0)
7428 stop = -1;
7429 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7430 IT_BYTEPOS (*it), stop, Qnil);
7433 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7435 break;
7437 case GET_FROM_C_STRING:
7438 /* Current display element of IT is from a C string. */
7439 if (!it->bidi_p
7440 /* If the string position is beyond string's end, it means
7441 next_element_from_c_string is padding the string with
7442 blanks, in which case we bypass the bidi iterator,
7443 because it cannot deal with such virtual characters. */
7444 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7446 IT_BYTEPOS (*it) += it->len;
7447 IT_CHARPOS (*it) += 1;
7449 else
7451 bidi_move_to_visually_next (&it->bidi_it);
7452 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7453 IT_CHARPOS (*it) = it->bidi_it.charpos;
7455 break;
7457 case GET_FROM_DISPLAY_VECTOR:
7458 /* Current display element of IT is from a display table entry.
7459 Advance in the display table definition. Reset it to null if
7460 end reached, and continue with characters from buffers/
7461 strings. */
7462 ++it->current.dpvec_index;
7464 /* Restore face of the iterator to what they were before the
7465 display vector entry (these entries may contain faces). */
7466 it->face_id = it->saved_face_id;
7468 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7470 int recheck_faces = it->ellipsis_p;
7472 if (it->s)
7473 it->method = GET_FROM_C_STRING;
7474 else if (STRINGP (it->string))
7475 it->method = GET_FROM_STRING;
7476 else
7478 it->method = GET_FROM_BUFFER;
7479 it->object = it->w->contents;
7482 it->dpvec = NULL;
7483 it->current.dpvec_index = -1;
7485 /* Skip over characters which were displayed via IT->dpvec. */
7486 if (it->dpvec_char_len < 0)
7487 reseat_at_next_visible_line_start (it, 1);
7488 else if (it->dpvec_char_len > 0)
7490 if (it->method == GET_FROM_STRING
7491 && it->current.overlay_string_index >= 0
7492 && it->n_overlay_strings > 0)
7493 it->ignore_overlay_strings_at_pos_p = true;
7494 it->len = it->dpvec_char_len;
7495 set_iterator_to_next (it, reseat_p);
7498 /* Maybe recheck faces after display vector. */
7499 if (recheck_faces)
7500 it->stop_charpos = IT_CHARPOS (*it);
7502 break;
7504 case GET_FROM_STRING:
7505 /* Current display element is a character from a Lisp string. */
7506 eassert (it->s == NULL && STRINGP (it->string));
7507 /* Don't advance past string end. These conditions are true
7508 when set_iterator_to_next is called at the end of
7509 get_next_display_element, in which case the Lisp string is
7510 already exhausted, and all we want is pop the iterator
7511 stack. */
7512 if (it->current.overlay_string_index >= 0)
7514 /* This is an overlay string, so there's no padding with
7515 spaces, and the number of characters in the string is
7516 where the string ends. */
7517 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7518 goto consider_string_end;
7520 else
7522 /* Not an overlay string. There could be padding, so test
7523 against it->end_charpos. */
7524 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7525 goto consider_string_end;
7527 if (it->cmp_it.id >= 0)
7529 int i;
7531 if (! it->bidi_p)
7533 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7534 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7535 if (it->cmp_it.to < it->cmp_it.nglyphs)
7536 it->cmp_it.from = it->cmp_it.to;
7537 else
7539 it->cmp_it.id = -1;
7540 composition_compute_stop_pos (&it->cmp_it,
7541 IT_STRING_CHARPOS (*it),
7542 IT_STRING_BYTEPOS (*it),
7543 it->end_charpos, it->string);
7546 else if (! it->cmp_it.reversed_p)
7548 for (i = 0; i < it->cmp_it.nchars; i++)
7549 bidi_move_to_visually_next (&it->bidi_it);
7550 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7551 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7553 if (it->cmp_it.to < it->cmp_it.nglyphs)
7554 it->cmp_it.from = it->cmp_it.to;
7555 else
7557 ptrdiff_t stop = it->end_charpos;
7558 if (it->bidi_it.scan_dir < 0)
7559 stop = -1;
7560 composition_compute_stop_pos (&it->cmp_it,
7561 IT_STRING_CHARPOS (*it),
7562 IT_STRING_BYTEPOS (*it), stop,
7563 it->string);
7566 else
7568 for (i = 0; i < it->cmp_it.nchars; i++)
7569 bidi_move_to_visually_next (&it->bidi_it);
7570 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7571 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7572 if (it->cmp_it.from > 0)
7573 it->cmp_it.to = it->cmp_it.from;
7574 else
7576 ptrdiff_t stop = it->end_charpos;
7577 if (it->bidi_it.scan_dir < 0)
7578 stop = -1;
7579 composition_compute_stop_pos (&it->cmp_it,
7580 IT_STRING_CHARPOS (*it),
7581 IT_STRING_BYTEPOS (*it), stop,
7582 it->string);
7586 else
7588 if (!it->bidi_p
7589 /* If the string position is beyond string's end, it
7590 means next_element_from_string is padding the string
7591 with blanks, in which case we bypass the bidi
7592 iterator, because it cannot deal with such virtual
7593 characters. */
7594 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7596 IT_STRING_BYTEPOS (*it) += it->len;
7597 IT_STRING_CHARPOS (*it) += 1;
7599 else
7601 int prev_scan_dir = it->bidi_it.scan_dir;
7603 bidi_move_to_visually_next (&it->bidi_it);
7604 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7605 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7606 if (prev_scan_dir != it->bidi_it.scan_dir)
7608 ptrdiff_t stop = it->end_charpos;
7610 if (it->bidi_it.scan_dir < 0)
7611 stop = -1;
7612 composition_compute_stop_pos (&it->cmp_it,
7613 IT_STRING_CHARPOS (*it),
7614 IT_STRING_BYTEPOS (*it), stop,
7615 it->string);
7620 consider_string_end:
7622 if (it->current.overlay_string_index >= 0)
7624 /* IT->string is an overlay string. Advance to the
7625 next, if there is one. */
7626 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7628 it->ellipsis_p = 0;
7629 next_overlay_string (it);
7630 if (it->ellipsis_p)
7631 setup_for_ellipsis (it, 0);
7634 else
7636 /* IT->string is not an overlay string. If we reached
7637 its end, and there is something on IT->stack, proceed
7638 with what is on the stack. This can be either another
7639 string, this time an overlay string, or a buffer. */
7640 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7641 && it->sp > 0)
7643 pop_it (it);
7644 if (it->method == GET_FROM_STRING)
7645 goto consider_string_end;
7648 break;
7650 case GET_FROM_IMAGE:
7651 case GET_FROM_STRETCH:
7652 /* The position etc with which we have to proceed are on
7653 the stack. The position may be at the end of a string,
7654 if the `display' property takes up the whole string. */
7655 eassert (it->sp > 0);
7656 pop_it (it);
7657 if (it->method == GET_FROM_STRING)
7658 goto consider_string_end;
7659 break;
7661 default:
7662 /* There are no other methods defined, so this should be a bug. */
7663 emacs_abort ();
7666 eassert (it->method != GET_FROM_STRING
7667 || (STRINGP (it->string)
7668 && IT_STRING_CHARPOS (*it) >= 0));
7671 /* Load IT's display element fields with information about the next
7672 display element which comes from a display table entry or from the
7673 result of translating a control character to one of the forms `^C'
7674 or `\003'.
7676 IT->dpvec holds the glyphs to return as characters.
7677 IT->saved_face_id holds the face id before the display vector--it
7678 is restored into IT->face_id in set_iterator_to_next. */
7680 static int
7681 next_element_from_display_vector (struct it *it)
7683 Lisp_Object gc;
7684 int prev_face_id = it->face_id;
7685 int next_face_id;
7687 /* Precondition. */
7688 eassert (it->dpvec && it->current.dpvec_index >= 0);
7690 it->face_id = it->saved_face_id;
7692 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7693 That seemed totally bogus - so I changed it... */
7694 gc = it->dpvec[it->current.dpvec_index];
7696 if (GLYPH_CODE_P (gc))
7698 struct face *this_face, *prev_face, *next_face;
7700 it->c = GLYPH_CODE_CHAR (gc);
7701 it->len = CHAR_BYTES (it->c);
7703 /* The entry may contain a face id to use. Such a face id is
7704 the id of a Lisp face, not a realized face. A face id of
7705 zero means no face is specified. */
7706 if (it->dpvec_face_id >= 0)
7707 it->face_id = it->dpvec_face_id;
7708 else
7710 int lface_id = GLYPH_CODE_FACE (gc);
7711 if (lface_id > 0)
7712 it->face_id = merge_faces (it->f, Qt, lface_id,
7713 it->saved_face_id);
7716 /* Glyphs in the display vector could have the box face, so we
7717 need to set the related flags in the iterator, as
7718 appropriate. */
7719 this_face = FACE_FROM_ID (it->f, it->face_id);
7720 prev_face = FACE_FROM_ID (it->f, prev_face_id);
7722 /* Is this character the first character of a box-face run? */
7723 it->start_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7724 && (!prev_face
7725 || prev_face->box == FACE_NO_BOX));
7727 /* For the last character of the box-face run, we need to look
7728 either at the next glyph from the display vector, or at the
7729 face we saw before the display vector. */
7730 next_face_id = it->saved_face_id;
7731 if (it->current.dpvec_index < it->dpend - it->dpvec - 1)
7733 if (it->dpvec_face_id >= 0)
7734 next_face_id = it->dpvec_face_id;
7735 else
7737 int lface_id =
7738 GLYPH_CODE_FACE (it->dpvec[it->current.dpvec_index + 1]);
7740 if (lface_id > 0)
7741 next_face_id = merge_faces (it->f, Qt, lface_id,
7742 it->saved_face_id);
7745 next_face = FACE_FROM_ID (it->f, next_face_id);
7746 it->end_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7747 && (!next_face
7748 || next_face->box == FACE_NO_BOX));
7749 it->face_box_p = this_face && this_face->box != FACE_NO_BOX;
7751 else
7752 /* Display table entry is invalid. Return a space. */
7753 it->c = ' ', it->len = 1;
7755 /* Don't change position and object of the iterator here. They are
7756 still the values of the character that had this display table
7757 entry or was translated, and that's what we want. */
7758 it->what = IT_CHARACTER;
7759 return 1;
7762 /* Get the first element of string/buffer in the visual order, after
7763 being reseated to a new position in a string or a buffer. */
7764 static void
7765 get_visually_first_element (struct it *it)
7767 int string_p = STRINGP (it->string) || it->s;
7768 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7769 ptrdiff_t bob = (string_p ? 0 : BEGV);
7771 if (STRINGP (it->string))
7773 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7774 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7776 else
7778 it->bidi_it.charpos = IT_CHARPOS (*it);
7779 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7782 if (it->bidi_it.charpos == eob)
7784 /* Nothing to do, but reset the FIRST_ELT flag, like
7785 bidi_paragraph_init does, because we are not going to
7786 call it. */
7787 it->bidi_it.first_elt = 0;
7789 else if (it->bidi_it.charpos == bob
7790 || (!string_p
7791 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7792 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7794 /* If we are at the beginning of a line/string, we can produce
7795 the next element right away. */
7796 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7797 bidi_move_to_visually_next (&it->bidi_it);
7799 else
7801 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7803 /* We need to prime the bidi iterator starting at the line's or
7804 string's beginning, before we will be able to produce the
7805 next element. */
7806 if (string_p)
7807 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7808 else
7809 it->bidi_it.charpos = find_newline_no_quit (IT_CHARPOS (*it),
7810 IT_BYTEPOS (*it), -1,
7811 &it->bidi_it.bytepos);
7812 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7815 /* Now return to buffer/string position where we were asked
7816 to get the next display element, and produce that. */
7817 bidi_move_to_visually_next (&it->bidi_it);
7819 while (it->bidi_it.bytepos != orig_bytepos
7820 && it->bidi_it.charpos < eob);
7823 /* Adjust IT's position information to where we ended up. */
7824 if (STRINGP (it->string))
7826 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7827 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7829 else
7831 IT_CHARPOS (*it) = it->bidi_it.charpos;
7832 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7835 if (STRINGP (it->string) || !it->s)
7837 ptrdiff_t stop, charpos, bytepos;
7839 if (STRINGP (it->string))
7841 eassert (!it->s);
7842 stop = SCHARS (it->string);
7843 if (stop > it->end_charpos)
7844 stop = it->end_charpos;
7845 charpos = IT_STRING_CHARPOS (*it);
7846 bytepos = IT_STRING_BYTEPOS (*it);
7848 else
7850 stop = it->end_charpos;
7851 charpos = IT_CHARPOS (*it);
7852 bytepos = IT_BYTEPOS (*it);
7854 if (it->bidi_it.scan_dir < 0)
7855 stop = -1;
7856 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7857 it->string);
7861 /* Load IT with the next display element from Lisp string IT->string.
7862 IT->current.string_pos is the current position within the string.
7863 If IT->current.overlay_string_index >= 0, the Lisp string is an
7864 overlay string. */
7866 static int
7867 next_element_from_string (struct it *it)
7869 struct text_pos position;
7871 eassert (STRINGP (it->string));
7872 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7873 eassert (IT_STRING_CHARPOS (*it) >= 0);
7874 position = it->current.string_pos;
7876 /* With bidi reordering, the character to display might not be the
7877 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7878 that we were reseat()ed to a new string, whose paragraph
7879 direction is not known. */
7880 if (it->bidi_p && it->bidi_it.first_elt)
7882 get_visually_first_element (it);
7883 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7886 /* Time to check for invisible text? */
7887 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7889 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7891 if (!(!it->bidi_p
7892 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7893 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7895 /* With bidi non-linear iteration, we could find
7896 ourselves far beyond the last computed stop_charpos,
7897 with several other stop positions in between that we
7898 missed. Scan them all now, in buffer's logical
7899 order, until we find and handle the last stop_charpos
7900 that precedes our current position. */
7901 handle_stop_backwards (it, it->stop_charpos);
7902 return GET_NEXT_DISPLAY_ELEMENT (it);
7904 else
7906 if (it->bidi_p)
7908 /* Take note of the stop position we just moved
7909 across, for when we will move back across it. */
7910 it->prev_stop = it->stop_charpos;
7911 /* If we are at base paragraph embedding level, take
7912 note of the last stop position seen at this
7913 level. */
7914 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7915 it->base_level_stop = it->stop_charpos;
7917 handle_stop (it);
7919 /* Since a handler may have changed IT->method, we must
7920 recurse here. */
7921 return GET_NEXT_DISPLAY_ELEMENT (it);
7924 else if (it->bidi_p
7925 /* If we are before prev_stop, we may have overstepped
7926 on our way backwards a stop_pos, and if so, we need
7927 to handle that stop_pos. */
7928 && IT_STRING_CHARPOS (*it) < it->prev_stop
7929 /* We can sometimes back up for reasons that have nothing
7930 to do with bidi reordering. E.g., compositions. The
7931 code below is only needed when we are above the base
7932 embedding level, so test for that explicitly. */
7933 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7935 /* If we lost track of base_level_stop, we have no better
7936 place for handle_stop_backwards to start from than string
7937 beginning. This happens, e.g., when we were reseated to
7938 the previous screenful of text by vertical-motion. */
7939 if (it->base_level_stop <= 0
7940 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7941 it->base_level_stop = 0;
7942 handle_stop_backwards (it, it->base_level_stop);
7943 return GET_NEXT_DISPLAY_ELEMENT (it);
7947 if (it->current.overlay_string_index >= 0)
7949 /* Get the next character from an overlay string. In overlay
7950 strings, there is no field width or padding with spaces to
7951 do. */
7952 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7954 it->what = IT_EOB;
7955 return 0;
7957 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7958 IT_STRING_BYTEPOS (*it),
7959 it->bidi_it.scan_dir < 0
7960 ? -1
7961 : SCHARS (it->string))
7962 && next_element_from_composition (it))
7964 return 1;
7966 else if (STRING_MULTIBYTE (it->string))
7968 const unsigned char *s = (SDATA (it->string)
7969 + IT_STRING_BYTEPOS (*it));
7970 it->c = string_char_and_length (s, &it->len);
7972 else
7974 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7975 it->len = 1;
7978 else
7980 /* Get the next character from a Lisp string that is not an
7981 overlay string. Such strings come from the mode line, for
7982 example. We may have to pad with spaces, or truncate the
7983 string. See also next_element_from_c_string. */
7984 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7986 it->what = IT_EOB;
7987 return 0;
7989 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
7991 /* Pad with spaces. */
7992 it->c = ' ', it->len = 1;
7993 CHARPOS (position) = BYTEPOS (position) = -1;
7995 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7996 IT_STRING_BYTEPOS (*it),
7997 it->bidi_it.scan_dir < 0
7998 ? -1
7999 : it->string_nchars)
8000 && next_element_from_composition (it))
8002 return 1;
8004 else if (STRING_MULTIBYTE (it->string))
8006 const unsigned char *s = (SDATA (it->string)
8007 + IT_STRING_BYTEPOS (*it));
8008 it->c = string_char_and_length (s, &it->len);
8010 else
8012 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
8013 it->len = 1;
8017 /* Record what we have and where it came from. */
8018 it->what = IT_CHARACTER;
8019 it->object = it->string;
8020 it->position = position;
8021 return 1;
8025 /* Load IT with next display element from C string IT->s.
8026 IT->string_nchars is the maximum number of characters to return
8027 from the string. IT->end_charpos may be greater than
8028 IT->string_nchars when this function is called, in which case we
8029 may have to return padding spaces. Value is zero if end of string
8030 reached, including padding spaces. */
8032 static int
8033 next_element_from_c_string (struct it *it)
8035 bool success_p = true;
8037 eassert (it->s);
8038 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
8039 it->what = IT_CHARACTER;
8040 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
8041 it->object = Qnil;
8043 /* With bidi reordering, the character to display might not be the
8044 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8045 we were reseated to a new string, whose paragraph direction is
8046 not known. */
8047 if (it->bidi_p && it->bidi_it.first_elt)
8048 get_visually_first_element (it);
8050 /* IT's position can be greater than IT->string_nchars in case a
8051 field width or precision has been specified when the iterator was
8052 initialized. */
8053 if (IT_CHARPOS (*it) >= it->end_charpos)
8055 /* End of the game. */
8056 it->what = IT_EOB;
8057 success_p = 0;
8059 else if (IT_CHARPOS (*it) >= it->string_nchars)
8061 /* Pad with spaces. */
8062 it->c = ' ', it->len = 1;
8063 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
8065 else if (it->multibyte_p)
8066 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
8067 else
8068 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
8070 return success_p;
8074 /* Set up IT to return characters from an ellipsis, if appropriate.
8075 The definition of the ellipsis glyphs may come from a display table
8076 entry. This function fills IT with the first glyph from the
8077 ellipsis if an ellipsis is to be displayed. */
8079 static int
8080 next_element_from_ellipsis (struct it *it)
8082 if (it->selective_display_ellipsis_p)
8083 setup_for_ellipsis (it, it->len);
8084 else
8086 /* The face at the current position may be different from the
8087 face we find after the invisible text. Remember what it
8088 was in IT->saved_face_id, and signal that it's there by
8089 setting face_before_selective_p. */
8090 it->saved_face_id = it->face_id;
8091 it->method = GET_FROM_BUFFER;
8092 it->object = it->w->contents;
8093 reseat_at_next_visible_line_start (it, 1);
8094 it->face_before_selective_p = true;
8097 return GET_NEXT_DISPLAY_ELEMENT (it);
8101 /* Deliver an image display element. The iterator IT is already
8102 filled with image information (done in handle_display_prop). Value
8103 is always 1. */
8106 static int
8107 next_element_from_image (struct it *it)
8109 it->what = IT_IMAGE;
8110 it->ignore_overlay_strings_at_pos_p = 0;
8111 return 1;
8115 /* Fill iterator IT with next display element from a stretch glyph
8116 property. IT->object is the value of the text property. Value is
8117 always 1. */
8119 static int
8120 next_element_from_stretch (struct it *it)
8122 it->what = IT_STRETCH;
8123 return 1;
8126 /* Scan backwards from IT's current position until we find a stop
8127 position, or until BEGV. This is called when we find ourself
8128 before both the last known prev_stop and base_level_stop while
8129 reordering bidirectional text. */
8131 static void
8132 compute_stop_pos_backwards (struct it *it)
8134 const int SCAN_BACK_LIMIT = 1000;
8135 struct text_pos pos;
8136 struct display_pos save_current = it->current;
8137 struct text_pos save_position = it->position;
8138 ptrdiff_t charpos = IT_CHARPOS (*it);
8139 ptrdiff_t where_we_are = charpos;
8140 ptrdiff_t save_stop_pos = it->stop_charpos;
8141 ptrdiff_t save_end_pos = it->end_charpos;
8143 eassert (NILP (it->string) && !it->s);
8144 eassert (it->bidi_p);
8145 it->bidi_p = 0;
8148 it->end_charpos = min (charpos + 1, ZV);
8149 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
8150 SET_TEXT_POS (pos, charpos, CHAR_TO_BYTE (charpos));
8151 reseat_1 (it, pos, 0);
8152 compute_stop_pos (it);
8153 /* We must advance forward, right? */
8154 if (it->stop_charpos <= charpos)
8155 emacs_abort ();
8157 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
8159 if (it->stop_charpos <= where_we_are)
8160 it->prev_stop = it->stop_charpos;
8161 else
8162 it->prev_stop = BEGV;
8163 it->bidi_p = true;
8164 it->current = save_current;
8165 it->position = save_position;
8166 it->stop_charpos = save_stop_pos;
8167 it->end_charpos = save_end_pos;
8170 /* Scan forward from CHARPOS in the current buffer/string, until we
8171 find a stop position > current IT's position. Then handle the stop
8172 position before that. This is called when we bump into a stop
8173 position while reordering bidirectional text. CHARPOS should be
8174 the last previously processed stop_pos (or BEGV/0, if none were
8175 processed yet) whose position is less that IT's current
8176 position. */
8178 static void
8179 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
8181 int bufp = !STRINGP (it->string);
8182 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
8183 struct display_pos save_current = it->current;
8184 struct text_pos save_position = it->position;
8185 struct text_pos pos1;
8186 ptrdiff_t next_stop;
8188 /* Scan in strict logical order. */
8189 eassert (it->bidi_p);
8190 it->bidi_p = 0;
8193 it->prev_stop = charpos;
8194 if (bufp)
8196 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
8197 reseat_1 (it, pos1, 0);
8199 else
8200 it->current.string_pos = string_pos (charpos, it->string);
8201 compute_stop_pos (it);
8202 /* We must advance forward, right? */
8203 if (it->stop_charpos <= it->prev_stop)
8204 emacs_abort ();
8205 charpos = it->stop_charpos;
8207 while (charpos <= where_we_are);
8209 it->bidi_p = true;
8210 it->current = save_current;
8211 it->position = save_position;
8212 next_stop = it->stop_charpos;
8213 it->stop_charpos = it->prev_stop;
8214 handle_stop (it);
8215 it->stop_charpos = next_stop;
8218 /* Load IT with the next display element from current_buffer. Value
8219 is zero if end of buffer reached. IT->stop_charpos is the next
8220 position at which to stop and check for text properties or buffer
8221 end. */
8223 static int
8224 next_element_from_buffer (struct it *it)
8226 bool success_p = true;
8228 eassert (IT_CHARPOS (*it) >= BEGV);
8229 eassert (NILP (it->string) && !it->s);
8230 eassert (!it->bidi_p
8231 || (EQ (it->bidi_it.string.lstring, Qnil)
8232 && it->bidi_it.string.s == NULL));
8234 /* With bidi reordering, the character to display might not be the
8235 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8236 we were reseat()ed to a new buffer position, which is potentially
8237 a different paragraph. */
8238 if (it->bidi_p && it->bidi_it.first_elt)
8240 get_visually_first_element (it);
8241 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8244 if (IT_CHARPOS (*it) >= it->stop_charpos)
8246 if (IT_CHARPOS (*it) >= it->end_charpos)
8248 int overlay_strings_follow_p;
8250 /* End of the game, except when overlay strings follow that
8251 haven't been returned yet. */
8252 if (it->overlay_strings_at_end_processed_p)
8253 overlay_strings_follow_p = 0;
8254 else
8256 it->overlay_strings_at_end_processed_p = true;
8257 overlay_strings_follow_p = get_overlay_strings (it, 0);
8260 if (overlay_strings_follow_p)
8261 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
8262 else
8264 it->what = IT_EOB;
8265 it->position = it->current.pos;
8266 success_p = 0;
8269 else if (!(!it->bidi_p
8270 || BIDI_AT_BASE_LEVEL (it->bidi_it)
8271 || IT_CHARPOS (*it) == it->stop_charpos))
8273 /* With bidi non-linear iteration, we could find ourselves
8274 far beyond the last computed stop_charpos, with several
8275 other stop positions in between that we missed. Scan
8276 them all now, in buffer's logical order, until we find
8277 and handle the last stop_charpos that precedes our
8278 current position. */
8279 handle_stop_backwards (it, it->stop_charpos);
8280 return GET_NEXT_DISPLAY_ELEMENT (it);
8282 else
8284 if (it->bidi_p)
8286 /* Take note of the stop position we just moved across,
8287 for when we will move back across it. */
8288 it->prev_stop = it->stop_charpos;
8289 /* If we are at base paragraph embedding level, take
8290 note of the last stop position seen at this
8291 level. */
8292 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
8293 it->base_level_stop = it->stop_charpos;
8295 handle_stop (it);
8296 return GET_NEXT_DISPLAY_ELEMENT (it);
8299 else if (it->bidi_p
8300 /* If we are before prev_stop, we may have overstepped on
8301 our way backwards a stop_pos, and if so, we need to
8302 handle that stop_pos. */
8303 && IT_CHARPOS (*it) < it->prev_stop
8304 /* We can sometimes back up for reasons that have nothing
8305 to do with bidi reordering. E.g., compositions. The
8306 code below is only needed when we are above the base
8307 embedding level, so test for that explicitly. */
8308 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
8310 if (it->base_level_stop <= 0
8311 || IT_CHARPOS (*it) < it->base_level_stop)
8313 /* If we lost track of base_level_stop, we need to find
8314 prev_stop by looking backwards. This happens, e.g., when
8315 we were reseated to the previous screenful of text by
8316 vertical-motion. */
8317 it->base_level_stop = BEGV;
8318 compute_stop_pos_backwards (it);
8319 handle_stop_backwards (it, it->prev_stop);
8321 else
8322 handle_stop_backwards (it, it->base_level_stop);
8323 return GET_NEXT_DISPLAY_ELEMENT (it);
8325 else
8327 /* No face changes, overlays etc. in sight, so just return a
8328 character from current_buffer. */
8329 unsigned char *p;
8330 ptrdiff_t stop;
8332 /* Maybe run the redisplay end trigger hook. Performance note:
8333 This doesn't seem to cost measurable time. */
8334 if (it->redisplay_end_trigger_charpos
8335 && it->glyph_row
8336 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
8337 run_redisplay_end_trigger_hook (it);
8339 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
8340 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
8341 stop)
8342 && next_element_from_composition (it))
8344 return 1;
8347 /* Get the next character, maybe multibyte. */
8348 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
8349 if (it->multibyte_p && !ASCII_CHAR_P (*p))
8350 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
8351 else
8352 it->c = *p, it->len = 1;
8354 /* Record what we have and where it came from. */
8355 it->what = IT_CHARACTER;
8356 it->object = it->w->contents;
8357 it->position = it->current.pos;
8359 /* Normally we return the character found above, except when we
8360 really want to return an ellipsis for selective display. */
8361 if (it->selective)
8363 if (it->c == '\n')
8365 /* A value of selective > 0 means hide lines indented more
8366 than that number of columns. */
8367 if (it->selective > 0
8368 && IT_CHARPOS (*it) + 1 < ZV
8369 && indented_beyond_p (IT_CHARPOS (*it) + 1,
8370 IT_BYTEPOS (*it) + 1,
8371 it->selective))
8373 success_p = next_element_from_ellipsis (it);
8374 it->dpvec_char_len = -1;
8377 else if (it->c == '\r' && it->selective == -1)
8379 /* A value of selective == -1 means that everything from the
8380 CR to the end of the line is invisible, with maybe an
8381 ellipsis displayed for it. */
8382 success_p = next_element_from_ellipsis (it);
8383 it->dpvec_char_len = -1;
8388 /* Value is zero if end of buffer reached. */
8389 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8390 return success_p;
8394 /* Run the redisplay end trigger hook for IT. */
8396 static void
8397 run_redisplay_end_trigger_hook (struct it *it)
8399 Lisp_Object args[3];
8401 /* IT->glyph_row should be non-null, i.e. we should be actually
8402 displaying something, or otherwise we should not run the hook. */
8403 eassert (it->glyph_row);
8405 /* Set up hook arguments. */
8406 args[0] = Qredisplay_end_trigger_functions;
8407 args[1] = it->window;
8408 XSETINT (args[2], it->redisplay_end_trigger_charpos);
8409 it->redisplay_end_trigger_charpos = 0;
8411 /* Since we are *trying* to run these functions, don't try to run
8412 them again, even if they get an error. */
8413 wset_redisplay_end_trigger (it->w, Qnil);
8414 Frun_hook_with_args (3, args);
8416 /* Notice if it changed the face of the character we are on. */
8417 handle_face_prop (it);
8421 /* Deliver a composition display element. Unlike the other
8422 next_element_from_XXX, this function is not registered in the array
8423 get_next_element[]. It is called from next_element_from_buffer and
8424 next_element_from_string when necessary. */
8426 static int
8427 next_element_from_composition (struct it *it)
8429 it->what = IT_COMPOSITION;
8430 it->len = it->cmp_it.nbytes;
8431 if (STRINGP (it->string))
8433 if (it->c < 0)
8435 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8436 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8437 return 0;
8439 it->position = it->current.string_pos;
8440 it->object = it->string;
8441 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8442 IT_STRING_BYTEPOS (*it), it->string);
8444 else
8446 if (it->c < 0)
8448 IT_CHARPOS (*it) += it->cmp_it.nchars;
8449 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8450 if (it->bidi_p)
8452 if (it->bidi_it.new_paragraph)
8453 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
8454 /* Resync the bidi iterator with IT's new position.
8455 FIXME: this doesn't support bidirectional text. */
8456 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8457 bidi_move_to_visually_next (&it->bidi_it);
8459 return 0;
8461 it->position = it->current.pos;
8462 it->object = it->w->contents;
8463 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8464 IT_BYTEPOS (*it), Qnil);
8466 return 1;
8471 /***********************************************************************
8472 Moving an iterator without producing glyphs
8473 ***********************************************************************/
8475 /* Check if iterator is at a position corresponding to a valid buffer
8476 position after some move_it_ call. */
8478 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8479 ((it)->method == GET_FROM_STRING \
8480 ? IT_STRING_CHARPOS (*it) == 0 \
8481 : 1)
8484 /* Move iterator IT to a specified buffer or X position within one
8485 line on the display without producing glyphs.
8487 OP should be a bit mask including some or all of these bits:
8488 MOVE_TO_X: Stop upon reaching x-position TO_X.
8489 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8490 Regardless of OP's value, stop upon reaching the end of the display line.
8492 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8493 This means, in particular, that TO_X includes window's horizontal
8494 scroll amount.
8496 The return value has several possible values that
8497 say what condition caused the scan to stop:
8499 MOVE_POS_MATCH_OR_ZV
8500 - when TO_POS or ZV was reached.
8502 MOVE_X_REACHED
8503 -when TO_X was reached before TO_POS or ZV were reached.
8505 MOVE_LINE_CONTINUED
8506 - when we reached the end of the display area and the line must
8507 be continued.
8509 MOVE_LINE_TRUNCATED
8510 - when we reached the end of the display area and the line is
8511 truncated.
8513 MOVE_NEWLINE_OR_CR
8514 - when we stopped at a line end, i.e. a newline or a CR and selective
8515 display is on. */
8517 static enum move_it_result
8518 move_it_in_display_line_to (struct it *it,
8519 ptrdiff_t to_charpos, int to_x,
8520 enum move_operation_enum op)
8522 enum move_it_result result = MOVE_UNDEFINED;
8523 struct glyph_row *saved_glyph_row;
8524 struct it wrap_it, atpos_it, atx_it, ppos_it;
8525 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8526 void *ppos_data = NULL;
8527 int may_wrap = 0;
8528 enum it_method prev_method = it->method;
8529 ptrdiff_t closest_pos IF_LINT (= 0), prev_pos = IT_CHARPOS (*it);
8530 int saw_smaller_pos = prev_pos < to_charpos;
8532 /* Don't produce glyphs in produce_glyphs. */
8533 saved_glyph_row = it->glyph_row;
8534 it->glyph_row = NULL;
8536 /* Use wrap_it to save a copy of IT wherever a word wrap could
8537 occur. Use atpos_it to save a copy of IT at the desired buffer
8538 position, if found, so that we can scan ahead and check if the
8539 word later overshoots the window edge. Use atx_it similarly, for
8540 pixel positions. */
8541 wrap_it.sp = -1;
8542 atpos_it.sp = -1;
8543 atx_it.sp = -1;
8545 /* Use ppos_it under bidi reordering to save a copy of IT for the
8546 initial position. We restore that position in IT when we have
8547 scanned the entire display line without finding a match for
8548 TO_CHARPOS and all the character positions are greater than
8549 TO_CHARPOS. We then restart the scan from the initial position,
8550 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8551 the closest to TO_CHARPOS. */
8552 if (it->bidi_p)
8554 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8556 SAVE_IT (ppos_it, *it, ppos_data);
8557 closest_pos = IT_CHARPOS (*it);
8559 else
8560 closest_pos = ZV;
8563 #define BUFFER_POS_REACHED_P() \
8564 ((op & MOVE_TO_POS) != 0 \
8565 && BUFFERP (it->object) \
8566 && (IT_CHARPOS (*it) == to_charpos \
8567 || ((!it->bidi_p \
8568 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8569 && IT_CHARPOS (*it) > to_charpos) \
8570 || (it->what == IT_COMPOSITION \
8571 && ((IT_CHARPOS (*it) > to_charpos \
8572 && to_charpos >= it->cmp_it.charpos) \
8573 || (IT_CHARPOS (*it) < to_charpos \
8574 && to_charpos <= it->cmp_it.charpos)))) \
8575 && (it->method == GET_FROM_BUFFER \
8576 || (it->method == GET_FROM_DISPLAY_VECTOR \
8577 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8579 /* If there's a line-/wrap-prefix, handle it. */
8580 if (it->hpos == 0 && it->method == GET_FROM_BUFFER
8581 && it->current_y < it->last_visible_y)
8582 handle_line_prefix (it);
8584 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8585 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8587 while (1)
8589 int x, i, ascent = 0, descent = 0;
8591 /* Utility macro to reset an iterator with x, ascent, and descent. */
8592 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8593 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8594 (IT)->max_descent = descent)
8596 /* Stop if we move beyond TO_CHARPOS (after an image or a
8597 display string or stretch glyph). */
8598 if ((op & MOVE_TO_POS) != 0
8599 && BUFFERP (it->object)
8600 && it->method == GET_FROM_BUFFER
8601 && (((!it->bidi_p
8602 /* When the iterator is at base embedding level, we
8603 are guaranteed that characters are delivered for
8604 display in strictly increasing order of their
8605 buffer positions. */
8606 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8607 && IT_CHARPOS (*it) > to_charpos)
8608 || (it->bidi_p
8609 && (prev_method == GET_FROM_IMAGE
8610 || prev_method == GET_FROM_STRETCH
8611 || prev_method == GET_FROM_STRING)
8612 /* Passed TO_CHARPOS from left to right. */
8613 && ((prev_pos < to_charpos
8614 && IT_CHARPOS (*it) > to_charpos)
8615 /* Passed TO_CHARPOS from right to left. */
8616 || (prev_pos > to_charpos
8617 && IT_CHARPOS (*it) < to_charpos)))))
8619 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8621 result = MOVE_POS_MATCH_OR_ZV;
8622 break;
8624 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8625 /* If wrap_it is valid, the current position might be in a
8626 word that is wrapped. So, save the iterator in
8627 atpos_it and continue to see if wrapping happens. */
8628 SAVE_IT (atpos_it, *it, atpos_data);
8631 /* Stop when ZV reached.
8632 We used to stop here when TO_CHARPOS reached as well, but that is
8633 too soon if this glyph does not fit on this line. So we handle it
8634 explicitly below. */
8635 if (!get_next_display_element (it))
8637 result = MOVE_POS_MATCH_OR_ZV;
8638 break;
8641 if (it->line_wrap == TRUNCATE)
8643 if (BUFFER_POS_REACHED_P ())
8645 result = MOVE_POS_MATCH_OR_ZV;
8646 break;
8649 else
8651 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
8653 if (IT_DISPLAYING_WHITESPACE (it))
8654 may_wrap = 1;
8655 else if (may_wrap)
8657 /* We have reached a glyph that follows one or more
8658 whitespace characters. If the position is
8659 already found, we are done. */
8660 if (atpos_it.sp >= 0)
8662 RESTORE_IT (it, &atpos_it, atpos_data);
8663 result = MOVE_POS_MATCH_OR_ZV;
8664 goto done;
8666 if (atx_it.sp >= 0)
8668 RESTORE_IT (it, &atx_it, atx_data);
8669 result = MOVE_X_REACHED;
8670 goto done;
8672 /* Otherwise, we can wrap here. */
8673 SAVE_IT (wrap_it, *it, wrap_data);
8674 may_wrap = 0;
8679 /* Remember the line height for the current line, in case
8680 the next element doesn't fit on the line. */
8681 ascent = it->max_ascent;
8682 descent = it->max_descent;
8684 /* The call to produce_glyphs will get the metrics of the
8685 display element IT is loaded with. Record the x-position
8686 before this display element, in case it doesn't fit on the
8687 line. */
8688 x = it->current_x;
8690 PRODUCE_GLYPHS (it);
8692 if (it->area != TEXT_AREA)
8694 prev_method = it->method;
8695 if (it->method == GET_FROM_BUFFER)
8696 prev_pos = IT_CHARPOS (*it);
8697 set_iterator_to_next (it, 1);
8698 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8699 SET_TEXT_POS (this_line_min_pos,
8700 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8701 if (it->bidi_p
8702 && (op & MOVE_TO_POS)
8703 && IT_CHARPOS (*it) > to_charpos
8704 && IT_CHARPOS (*it) < closest_pos)
8705 closest_pos = IT_CHARPOS (*it);
8706 continue;
8709 /* The number of glyphs we get back in IT->nglyphs will normally
8710 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8711 character on a terminal frame, or (iii) a line end. For the
8712 second case, IT->nglyphs - 1 padding glyphs will be present.
8713 (On X frames, there is only one glyph produced for a
8714 composite character.)
8716 The behavior implemented below means, for continuation lines,
8717 that as many spaces of a TAB as fit on the current line are
8718 displayed there. For terminal frames, as many glyphs of a
8719 multi-glyph character are displayed in the current line, too.
8720 This is what the old redisplay code did, and we keep it that
8721 way. Under X, the whole shape of a complex character must
8722 fit on the line or it will be completely displayed in the
8723 next line.
8725 Note that both for tabs and padding glyphs, all glyphs have
8726 the same width. */
8727 if (it->nglyphs)
8729 /* More than one glyph or glyph doesn't fit on line. All
8730 glyphs have the same width. */
8731 int single_glyph_width = it->pixel_width / it->nglyphs;
8732 int new_x;
8733 int x_before_this_char = x;
8734 int hpos_before_this_char = it->hpos;
8736 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8738 new_x = x + single_glyph_width;
8740 /* We want to leave anything reaching TO_X to the caller. */
8741 if ((op & MOVE_TO_X) && new_x > to_x)
8743 if (BUFFER_POS_REACHED_P ())
8745 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8746 goto buffer_pos_reached;
8747 if (atpos_it.sp < 0)
8749 SAVE_IT (atpos_it, *it, atpos_data);
8750 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8753 else
8755 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8757 it->current_x = x;
8758 result = MOVE_X_REACHED;
8759 break;
8761 if (atx_it.sp < 0)
8763 SAVE_IT (atx_it, *it, atx_data);
8764 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8769 if (/* Lines are continued. */
8770 it->line_wrap != TRUNCATE
8771 && (/* And glyph doesn't fit on the line. */
8772 new_x > it->last_visible_x
8773 /* Or it fits exactly and we're on a window
8774 system frame. */
8775 || (new_x == it->last_visible_x
8776 && FRAME_WINDOW_P (it->f)
8777 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8778 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8779 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8781 if (/* IT->hpos == 0 means the very first glyph
8782 doesn't fit on the line, e.g. a wide image. */
8783 it->hpos == 0
8784 || (new_x == it->last_visible_x
8785 && FRAME_WINDOW_P (it->f)
8786 /* When word-wrap is ON and we have a valid
8787 wrap point, we don't allow the last glyph
8788 to "just barely fit" on the line. */
8789 && (it->line_wrap != WORD_WRAP
8790 || wrap_it.sp < 0)))
8792 ++it->hpos;
8793 it->current_x = new_x;
8795 /* The character's last glyph just barely fits
8796 in this row. */
8797 if (i == it->nglyphs - 1)
8799 /* If this is the destination position,
8800 return a position *before* it in this row,
8801 now that we know it fits in this row. */
8802 if (BUFFER_POS_REACHED_P ())
8804 if (it->line_wrap != WORD_WRAP
8805 || wrap_it.sp < 0)
8807 it->hpos = hpos_before_this_char;
8808 it->current_x = x_before_this_char;
8809 result = MOVE_POS_MATCH_OR_ZV;
8810 break;
8812 if (it->line_wrap == WORD_WRAP
8813 && atpos_it.sp < 0)
8815 SAVE_IT (atpos_it, *it, atpos_data);
8816 atpos_it.current_x = x_before_this_char;
8817 atpos_it.hpos = hpos_before_this_char;
8821 prev_method = it->method;
8822 if (it->method == GET_FROM_BUFFER)
8823 prev_pos = IT_CHARPOS (*it);
8824 set_iterator_to_next (it, 1);
8825 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8826 SET_TEXT_POS (this_line_min_pos,
8827 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8828 /* On graphical terminals, newlines may
8829 "overflow" into the fringe if
8830 overflow-newline-into-fringe is non-nil.
8831 On text terminals, and on graphical
8832 terminals with no right margin, newlines
8833 may overflow into the last glyph on the
8834 display line.*/
8835 if (!FRAME_WINDOW_P (it->f)
8836 || ((it->bidi_p
8837 && it->bidi_it.paragraph_dir == R2L)
8838 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8839 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8840 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8842 if (!get_next_display_element (it))
8844 result = MOVE_POS_MATCH_OR_ZV;
8845 break;
8847 if (BUFFER_POS_REACHED_P ())
8849 if (ITERATOR_AT_END_OF_LINE_P (it))
8850 result = MOVE_POS_MATCH_OR_ZV;
8851 else
8852 result = MOVE_LINE_CONTINUED;
8853 break;
8855 if (ITERATOR_AT_END_OF_LINE_P (it)
8856 && (it->line_wrap != WORD_WRAP
8857 || wrap_it.sp < 0))
8859 result = MOVE_NEWLINE_OR_CR;
8860 break;
8865 else
8866 IT_RESET_X_ASCENT_DESCENT (it);
8868 if (wrap_it.sp >= 0)
8870 RESTORE_IT (it, &wrap_it, wrap_data);
8871 atpos_it.sp = -1;
8872 atx_it.sp = -1;
8875 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8876 IT_CHARPOS (*it)));
8877 result = MOVE_LINE_CONTINUED;
8878 break;
8881 if (BUFFER_POS_REACHED_P ())
8883 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8884 goto buffer_pos_reached;
8885 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8887 SAVE_IT (atpos_it, *it, atpos_data);
8888 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8892 if (new_x > it->first_visible_x)
8894 /* Glyph is visible. Increment number of glyphs that
8895 would be displayed. */
8896 ++it->hpos;
8900 if (result != MOVE_UNDEFINED)
8901 break;
8903 else if (BUFFER_POS_REACHED_P ())
8905 buffer_pos_reached:
8906 IT_RESET_X_ASCENT_DESCENT (it);
8907 result = MOVE_POS_MATCH_OR_ZV;
8908 break;
8910 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8912 /* Stop when TO_X specified and reached. This check is
8913 necessary here because of lines consisting of a line end,
8914 only. The line end will not produce any glyphs and we
8915 would never get MOVE_X_REACHED. */
8916 eassert (it->nglyphs == 0);
8917 result = MOVE_X_REACHED;
8918 break;
8921 /* Is this a line end? If yes, we're done. */
8922 if (ITERATOR_AT_END_OF_LINE_P (it))
8924 /* If we are past TO_CHARPOS, but never saw any character
8925 positions smaller than TO_CHARPOS, return
8926 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8927 did. */
8928 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
8930 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
8932 if (closest_pos < ZV)
8934 RESTORE_IT (it, &ppos_it, ppos_data);
8935 /* Don't recurse if closest_pos is equal to
8936 to_charpos, since we have just tried that. */
8937 if (closest_pos != to_charpos)
8938 move_it_in_display_line_to (it, closest_pos, -1,
8939 MOVE_TO_POS);
8940 result = MOVE_POS_MATCH_OR_ZV;
8942 else
8943 goto buffer_pos_reached;
8945 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
8946 && IT_CHARPOS (*it) > to_charpos)
8947 goto buffer_pos_reached;
8948 else
8949 result = MOVE_NEWLINE_OR_CR;
8951 else
8952 result = MOVE_NEWLINE_OR_CR;
8953 break;
8956 prev_method = it->method;
8957 if (it->method == GET_FROM_BUFFER)
8958 prev_pos = IT_CHARPOS (*it);
8959 /* The current display element has been consumed. Advance
8960 to the next. */
8961 set_iterator_to_next (it, 1);
8962 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8963 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8964 if (IT_CHARPOS (*it) < to_charpos)
8965 saw_smaller_pos = 1;
8966 if (it->bidi_p
8967 && (op & MOVE_TO_POS)
8968 && IT_CHARPOS (*it) >= to_charpos
8969 && IT_CHARPOS (*it) < closest_pos)
8970 closest_pos = IT_CHARPOS (*it);
8972 /* Stop if lines are truncated and IT's current x-position is
8973 past the right edge of the window now. */
8974 if (it->line_wrap == TRUNCATE
8975 && it->current_x >= it->last_visible_x)
8977 if (!FRAME_WINDOW_P (it->f)
8978 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8979 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8980 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8981 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8983 int at_eob_p = 0;
8985 if ((at_eob_p = !get_next_display_element (it))
8986 || BUFFER_POS_REACHED_P ()
8987 /* If we are past TO_CHARPOS, but never saw any
8988 character positions smaller than TO_CHARPOS,
8989 return MOVE_POS_MATCH_OR_ZV, like the
8990 unidirectional display did. */
8991 || (it->bidi_p && (op & MOVE_TO_POS) != 0
8992 && !saw_smaller_pos
8993 && IT_CHARPOS (*it) > to_charpos))
8995 if (it->bidi_p
8996 && !BUFFER_POS_REACHED_P ()
8997 && !at_eob_p && closest_pos < ZV)
8999 RESTORE_IT (it, &ppos_it, ppos_data);
9000 if (closest_pos != to_charpos)
9001 move_it_in_display_line_to (it, closest_pos, -1,
9002 MOVE_TO_POS);
9004 result = MOVE_POS_MATCH_OR_ZV;
9005 break;
9007 if (ITERATOR_AT_END_OF_LINE_P (it))
9009 result = MOVE_NEWLINE_OR_CR;
9010 break;
9013 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
9014 && !saw_smaller_pos
9015 && IT_CHARPOS (*it) > to_charpos)
9017 if (closest_pos < ZV)
9019 RESTORE_IT (it, &ppos_it, ppos_data);
9020 if (closest_pos != to_charpos)
9021 move_it_in_display_line_to (it, closest_pos, -1,
9022 MOVE_TO_POS);
9024 result = MOVE_POS_MATCH_OR_ZV;
9025 break;
9027 result = MOVE_LINE_TRUNCATED;
9028 break;
9030 #undef IT_RESET_X_ASCENT_DESCENT
9033 #undef BUFFER_POS_REACHED_P
9035 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9036 restore the saved iterator. */
9037 if (atpos_it.sp >= 0)
9038 RESTORE_IT (it, &atpos_it, atpos_data);
9039 else if (atx_it.sp >= 0)
9040 RESTORE_IT (it, &atx_it, atx_data);
9042 done:
9044 if (atpos_data)
9045 bidi_unshelve_cache (atpos_data, 1);
9046 if (atx_data)
9047 bidi_unshelve_cache (atx_data, 1);
9048 if (wrap_data)
9049 bidi_unshelve_cache (wrap_data, 1);
9050 if (ppos_data)
9051 bidi_unshelve_cache (ppos_data, 1);
9053 /* Restore the iterator settings altered at the beginning of this
9054 function. */
9055 it->glyph_row = saved_glyph_row;
9056 return result;
9059 /* For external use. */
9060 void
9061 move_it_in_display_line (struct it *it,
9062 ptrdiff_t to_charpos, int to_x,
9063 enum move_operation_enum op)
9065 if (it->line_wrap == WORD_WRAP
9066 && (op & MOVE_TO_X))
9068 struct it save_it;
9069 void *save_data = NULL;
9070 int skip;
9072 SAVE_IT (save_it, *it, save_data);
9073 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9074 /* When word-wrap is on, TO_X may lie past the end
9075 of a wrapped line. Then it->current is the
9076 character on the next line, so backtrack to the
9077 space before the wrap point. */
9078 if (skip == MOVE_LINE_CONTINUED)
9080 int prev_x = max (it->current_x - 1, 0);
9081 RESTORE_IT (it, &save_it, save_data);
9082 move_it_in_display_line_to
9083 (it, -1, prev_x, MOVE_TO_X);
9085 else
9086 bidi_unshelve_cache (save_data, 1);
9088 else
9089 move_it_in_display_line_to (it, to_charpos, to_x, op);
9093 /* Move IT forward until it satisfies one or more of the criteria in
9094 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9096 OP is a bit-mask that specifies where to stop, and in particular,
9097 which of those four position arguments makes a difference. See the
9098 description of enum move_operation_enum.
9100 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9101 screen line, this function will set IT to the next position that is
9102 displayed to the right of TO_CHARPOS on the screen.
9104 Return the maximum pixel length of any line scanned but never more
9105 than it.last_visible_x. */
9108 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
9110 enum move_it_result skip, skip2 = MOVE_X_REACHED;
9111 int line_height, line_start_x = 0, reached = 0;
9112 int max_current_x = 0;
9113 void *backup_data = NULL;
9115 for (;;)
9117 if (op & MOVE_TO_VPOS)
9119 /* If no TO_CHARPOS and no TO_X specified, stop at the
9120 start of the line TO_VPOS. */
9121 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
9123 if (it->vpos == to_vpos)
9125 reached = 1;
9126 break;
9128 else
9129 skip = move_it_in_display_line_to (it, -1, -1, 0);
9131 else
9133 /* TO_VPOS >= 0 means stop at TO_X in the line at
9134 TO_VPOS, or at TO_POS, whichever comes first. */
9135 if (it->vpos == to_vpos)
9137 reached = 2;
9138 break;
9141 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9143 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
9145 reached = 3;
9146 break;
9148 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
9150 /* We have reached TO_X but not in the line we want. */
9151 skip = move_it_in_display_line_to (it, to_charpos,
9152 -1, MOVE_TO_POS);
9153 if (skip == MOVE_POS_MATCH_OR_ZV)
9155 reached = 4;
9156 break;
9161 else if (op & MOVE_TO_Y)
9163 struct it it_backup;
9165 if (it->line_wrap == WORD_WRAP)
9166 SAVE_IT (it_backup, *it, backup_data);
9168 /* TO_Y specified means stop at TO_X in the line containing
9169 TO_Y---or at TO_CHARPOS if this is reached first. The
9170 problem is that we can't really tell whether the line
9171 contains TO_Y before we have completely scanned it, and
9172 this may skip past TO_X. What we do is to first scan to
9173 TO_X.
9175 If TO_X is not specified, use a TO_X of zero. The reason
9176 is to make the outcome of this function more predictable.
9177 If we didn't use TO_X == 0, we would stop at the end of
9178 the line which is probably not what a caller would expect
9179 to happen. */
9180 skip = move_it_in_display_line_to
9181 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
9182 (MOVE_TO_X | (op & MOVE_TO_POS)));
9184 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9185 if (skip == MOVE_POS_MATCH_OR_ZV)
9186 reached = 5;
9187 else if (skip == MOVE_X_REACHED)
9189 /* If TO_X was reached, we want to know whether TO_Y is
9190 in the line. We know this is the case if the already
9191 scanned glyphs make the line tall enough. Otherwise,
9192 we must check by scanning the rest of the line. */
9193 line_height = it->max_ascent + it->max_descent;
9194 if (to_y >= it->current_y
9195 && to_y < it->current_y + line_height)
9197 reached = 6;
9198 break;
9200 SAVE_IT (it_backup, *it, backup_data);
9201 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
9202 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
9203 op & MOVE_TO_POS);
9204 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
9205 line_height = it->max_ascent + it->max_descent;
9206 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9208 if (to_y >= it->current_y
9209 && to_y < it->current_y + line_height)
9211 /* If TO_Y is in this line and TO_X was reached
9212 above, we scanned too far. We have to restore
9213 IT's settings to the ones before skipping. But
9214 keep the more accurate values of max_ascent and
9215 max_descent we've found while skipping the rest
9216 of the line, for the sake of callers, such as
9217 pos_visible_p, that need to know the line
9218 height. */
9219 int max_ascent = it->max_ascent;
9220 int max_descent = it->max_descent;
9222 RESTORE_IT (it, &it_backup, backup_data);
9223 it->max_ascent = max_ascent;
9224 it->max_descent = max_descent;
9225 reached = 6;
9227 else
9229 skip = skip2;
9230 if (skip == MOVE_POS_MATCH_OR_ZV)
9231 reached = 7;
9234 else
9236 /* Check whether TO_Y is in this line. */
9237 line_height = it->max_ascent + it->max_descent;
9238 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9240 if (to_y >= it->current_y
9241 && to_y < it->current_y + line_height)
9243 if (to_y > it->current_y)
9244 max_current_x = max (it->current_x, max_current_x);
9246 /* When word-wrap is on, TO_X may lie past the end
9247 of a wrapped line. Then it->current is the
9248 character on the next line, so backtrack to the
9249 space before the wrap point. */
9250 if (skip == MOVE_LINE_CONTINUED
9251 && it->line_wrap == WORD_WRAP)
9253 int prev_x = max (it->current_x - 1, 0);
9254 RESTORE_IT (it, &it_backup, backup_data);
9255 skip = move_it_in_display_line_to
9256 (it, -1, prev_x, MOVE_TO_X);
9259 reached = 6;
9263 if (reached)
9265 max_current_x = max (it->current_x, max_current_x);
9266 break;
9269 else if (BUFFERP (it->object)
9270 && (it->method == GET_FROM_BUFFER
9271 || it->method == GET_FROM_STRETCH)
9272 && IT_CHARPOS (*it) >= to_charpos
9273 /* Under bidi iteration, a call to set_iterator_to_next
9274 can scan far beyond to_charpos if the initial
9275 portion of the next line needs to be reordered. In
9276 that case, give move_it_in_display_line_to another
9277 chance below. */
9278 && !(it->bidi_p
9279 && it->bidi_it.scan_dir == -1))
9280 skip = MOVE_POS_MATCH_OR_ZV;
9281 else
9282 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
9284 switch (skip)
9286 case MOVE_POS_MATCH_OR_ZV:
9287 max_current_x = max (it->current_x, max_current_x);
9288 reached = 8;
9289 goto out;
9291 case MOVE_NEWLINE_OR_CR:
9292 max_current_x = max (it->current_x, max_current_x);
9293 set_iterator_to_next (it, 1);
9294 it->continuation_lines_width = 0;
9295 break;
9297 case MOVE_LINE_TRUNCATED:
9298 max_current_x = it->last_visible_x;
9299 it->continuation_lines_width = 0;
9300 reseat_at_next_visible_line_start (it, 0);
9301 if ((op & MOVE_TO_POS) != 0
9302 && IT_CHARPOS (*it) > to_charpos)
9304 reached = 9;
9305 goto out;
9307 break;
9309 case MOVE_LINE_CONTINUED:
9310 max_current_x = it->last_visible_x;
9311 /* For continued lines ending in a tab, some of the glyphs
9312 associated with the tab are displayed on the current
9313 line. Since it->current_x does not include these glyphs,
9314 we use it->last_visible_x instead. */
9315 if (it->c == '\t')
9317 it->continuation_lines_width += it->last_visible_x;
9318 /* When moving by vpos, ensure that the iterator really
9319 advances to the next line (bug#847, bug#969). Fixme:
9320 do we need to do this in other circumstances? */
9321 if (it->current_x != it->last_visible_x
9322 && (op & MOVE_TO_VPOS)
9323 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
9325 line_start_x = it->current_x + it->pixel_width
9326 - it->last_visible_x;
9327 if (FRAME_WINDOW_P (it->f))
9329 struct face *face = FACE_FROM_ID (it->f, it->face_id);
9330 struct font *face_font = face->font;
9332 /* When display_line produces a continued line
9333 that ends in a TAB, it skips a tab stop that
9334 is closer than the font's space character
9335 width (see x_produce_glyphs where it produces
9336 the stretch glyph which represents a TAB).
9337 We need to reproduce the same logic here. */
9338 eassert (face_font);
9339 if (face_font)
9341 if (line_start_x < face_font->space_width)
9342 line_start_x
9343 += it->tab_width * face_font->space_width;
9346 set_iterator_to_next (it, 0);
9349 else
9350 it->continuation_lines_width += it->current_x;
9351 break;
9353 default:
9354 emacs_abort ();
9357 /* Reset/increment for the next run. */
9358 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
9359 it->current_x = line_start_x;
9360 line_start_x = 0;
9361 it->hpos = 0;
9362 it->current_y += it->max_ascent + it->max_descent;
9363 ++it->vpos;
9364 last_height = it->max_ascent + it->max_descent;
9365 it->max_ascent = it->max_descent = 0;
9368 out:
9370 /* On text terminals, we may stop at the end of a line in the middle
9371 of a multi-character glyph. If the glyph itself is continued,
9372 i.e. it is actually displayed on the next line, don't treat this
9373 stopping point as valid; move to the next line instead (unless
9374 that brings us offscreen). */
9375 if (!FRAME_WINDOW_P (it->f)
9376 && op & MOVE_TO_POS
9377 && IT_CHARPOS (*it) == to_charpos
9378 && it->what == IT_CHARACTER
9379 && it->nglyphs > 1
9380 && it->line_wrap == WINDOW_WRAP
9381 && it->current_x == it->last_visible_x - 1
9382 && it->c != '\n'
9383 && it->c != '\t'
9384 && it->vpos < it->w->window_end_vpos)
9386 it->continuation_lines_width += it->current_x;
9387 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
9388 it->current_y += it->max_ascent + it->max_descent;
9389 ++it->vpos;
9390 last_height = it->max_ascent + it->max_descent;
9393 if (backup_data)
9394 bidi_unshelve_cache (backup_data, 1);
9396 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
9398 return max_current_x;
9402 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9404 If DY > 0, move IT backward at least that many pixels. DY = 0
9405 means move IT backward to the preceding line start or BEGV. This
9406 function may move over more than DY pixels if IT->current_y - DY
9407 ends up in the middle of a line; in this case IT->current_y will be
9408 set to the top of the line moved to. */
9410 void
9411 move_it_vertically_backward (struct it *it, int dy)
9413 int nlines, h;
9414 struct it it2, it3;
9415 void *it2data = NULL, *it3data = NULL;
9416 ptrdiff_t start_pos;
9417 int nchars_per_row
9418 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9419 ptrdiff_t pos_limit;
9421 move_further_back:
9422 eassert (dy >= 0);
9424 start_pos = IT_CHARPOS (*it);
9426 /* Estimate how many newlines we must move back. */
9427 nlines = max (1, dy / default_line_pixel_height (it->w));
9428 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9429 pos_limit = BEGV;
9430 else
9431 pos_limit = max (start_pos - nlines * nchars_per_row, BEGV);
9433 /* Set the iterator's position that many lines back. But don't go
9434 back more than NLINES full screen lines -- this wins a day with
9435 buffers which have very long lines. */
9436 while (nlines-- && IT_CHARPOS (*it) > pos_limit)
9437 back_to_previous_visible_line_start (it);
9439 /* Reseat the iterator here. When moving backward, we don't want
9440 reseat to skip forward over invisible text, set up the iterator
9441 to deliver from overlay strings at the new position etc. So,
9442 use reseat_1 here. */
9443 reseat_1 (it, it->current.pos, 1);
9445 /* We are now surely at a line start. */
9446 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
9447 reordering is in effect. */
9448 it->continuation_lines_width = 0;
9450 /* Move forward and see what y-distance we moved. First move to the
9451 start of the next line so that we get its height. We need this
9452 height to be able to tell whether we reached the specified
9453 y-distance. */
9454 SAVE_IT (it2, *it, it2data);
9455 it2.max_ascent = it2.max_descent = 0;
9458 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
9459 MOVE_TO_POS | MOVE_TO_VPOS);
9461 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9462 /* If we are in a display string which starts at START_POS,
9463 and that display string includes a newline, and we are
9464 right after that newline (i.e. at the beginning of a
9465 display line), exit the loop, because otherwise we will
9466 infloop, since move_it_to will see that it is already at
9467 START_POS and will not move. */
9468 || (it2.method == GET_FROM_STRING
9469 && IT_CHARPOS (it2) == start_pos
9470 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9471 eassert (IT_CHARPOS (*it) >= BEGV);
9472 SAVE_IT (it3, it2, it3data);
9474 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9475 eassert (IT_CHARPOS (*it) >= BEGV);
9476 /* H is the actual vertical distance from the position in *IT
9477 and the starting position. */
9478 h = it2.current_y - it->current_y;
9479 /* NLINES is the distance in number of lines. */
9480 nlines = it2.vpos - it->vpos;
9482 /* Correct IT's y and vpos position
9483 so that they are relative to the starting point. */
9484 it->vpos -= nlines;
9485 it->current_y -= h;
9487 if (dy == 0)
9489 /* DY == 0 means move to the start of the screen line. The
9490 value of nlines is > 0 if continuation lines were involved,
9491 or if the original IT position was at start of a line. */
9492 RESTORE_IT (it, it, it2data);
9493 if (nlines > 0)
9494 move_it_by_lines (it, nlines);
9495 /* The above code moves us to some position NLINES down,
9496 usually to its first glyph (leftmost in an L2R line), but
9497 that's not necessarily the start of the line, under bidi
9498 reordering. We want to get to the character position
9499 that is immediately after the newline of the previous
9500 line. */
9501 if (it->bidi_p
9502 && !it->continuation_lines_width
9503 && !STRINGP (it->string)
9504 && IT_CHARPOS (*it) > BEGV
9505 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9507 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
9509 DEC_BOTH (cp, bp);
9510 cp = find_newline_no_quit (cp, bp, -1, NULL);
9511 move_it_to (it, cp, -1, -1, -1, MOVE_TO_POS);
9513 bidi_unshelve_cache (it3data, 1);
9515 else
9517 /* The y-position we try to reach, relative to *IT.
9518 Note that H has been subtracted in front of the if-statement. */
9519 int target_y = it->current_y + h - dy;
9520 int y0 = it3.current_y;
9521 int y1;
9522 int line_height;
9524 RESTORE_IT (&it3, &it3, it3data);
9525 y1 = line_bottom_y (&it3);
9526 line_height = y1 - y0;
9527 RESTORE_IT (it, it, it2data);
9528 /* If we did not reach target_y, try to move further backward if
9529 we can. If we moved too far backward, try to move forward. */
9530 if (target_y < it->current_y
9531 /* This is heuristic. In a window that's 3 lines high, with
9532 a line height of 13 pixels each, recentering with point
9533 on the bottom line will try to move -39/2 = 19 pixels
9534 backward. Try to avoid moving into the first line. */
9535 && (it->current_y - target_y
9536 > min (window_box_height (it->w), line_height * 2 / 3))
9537 && IT_CHARPOS (*it) > BEGV)
9539 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9540 target_y - it->current_y));
9541 dy = it->current_y - target_y;
9542 goto move_further_back;
9544 else if (target_y >= it->current_y + line_height
9545 && IT_CHARPOS (*it) < ZV)
9547 /* Should move forward by at least one line, maybe more.
9549 Note: Calling move_it_by_lines can be expensive on
9550 terminal frames, where compute_motion is used (via
9551 vmotion) to do the job, when there are very long lines
9552 and truncate-lines is nil. That's the reason for
9553 treating terminal frames specially here. */
9555 if (!FRAME_WINDOW_P (it->f))
9556 move_it_vertically (it, target_y - (it->current_y + line_height));
9557 else
9561 move_it_by_lines (it, 1);
9563 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9570 /* Move IT by a specified amount of pixel lines DY. DY negative means
9571 move backwards. DY = 0 means move to start of screen line. At the
9572 end, IT will be on the start of a screen line. */
9574 void
9575 move_it_vertically (struct it *it, int dy)
9577 if (dy <= 0)
9578 move_it_vertically_backward (it, -dy);
9579 else
9581 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9582 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9583 MOVE_TO_POS | MOVE_TO_Y);
9584 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9586 /* If buffer ends in ZV without a newline, move to the start of
9587 the line to satisfy the post-condition. */
9588 if (IT_CHARPOS (*it) == ZV
9589 && ZV > BEGV
9590 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9591 move_it_by_lines (it, 0);
9596 /* Move iterator IT past the end of the text line it is in. */
9598 void
9599 move_it_past_eol (struct it *it)
9601 enum move_it_result rc;
9603 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9604 if (rc == MOVE_NEWLINE_OR_CR)
9605 set_iterator_to_next (it, 0);
9609 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9610 negative means move up. DVPOS == 0 means move to the start of the
9611 screen line.
9613 Optimization idea: If we would know that IT->f doesn't use
9614 a face with proportional font, we could be faster for
9615 truncate-lines nil. */
9617 void
9618 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9621 /* The commented-out optimization uses vmotion on terminals. This
9622 gives bad results, because elements like it->what, on which
9623 callers such as pos_visible_p rely, aren't updated. */
9624 /* struct position pos;
9625 if (!FRAME_WINDOW_P (it->f))
9627 struct text_pos textpos;
9629 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9630 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9631 reseat (it, textpos, 1);
9632 it->vpos += pos.vpos;
9633 it->current_y += pos.vpos;
9635 else */
9637 if (dvpos == 0)
9639 /* DVPOS == 0 means move to the start of the screen line. */
9640 move_it_vertically_backward (it, 0);
9641 /* Let next call to line_bottom_y calculate real line height. */
9642 last_height = 0;
9644 else if (dvpos > 0)
9646 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9647 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9649 /* Only move to the next buffer position if we ended up in a
9650 string from display property, not in an overlay string
9651 (before-string or after-string). That is because the
9652 latter don't conceal the underlying buffer position, so
9653 we can ask to move the iterator to the exact position we
9654 are interested in. Note that, even if we are already at
9655 IT_CHARPOS (*it), the call below is not a no-op, as it
9656 will detect that we are at the end of the string, pop the
9657 iterator, and compute it->current_x and it->hpos
9658 correctly. */
9659 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9660 -1, -1, -1, MOVE_TO_POS);
9663 else
9665 struct it it2;
9666 void *it2data = NULL;
9667 ptrdiff_t start_charpos, i;
9668 int nchars_per_row
9669 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9670 bool hit_pos_limit = false;
9671 ptrdiff_t pos_limit;
9673 /* Start at the beginning of the screen line containing IT's
9674 position. This may actually move vertically backwards,
9675 in case of overlays, so adjust dvpos accordingly. */
9676 dvpos += it->vpos;
9677 move_it_vertically_backward (it, 0);
9678 dvpos -= it->vpos;
9680 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9681 screen lines, and reseat the iterator there. */
9682 start_charpos = IT_CHARPOS (*it);
9683 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9684 pos_limit = BEGV;
9685 else
9686 pos_limit = max (start_charpos + dvpos * nchars_per_row, BEGV);
9688 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > pos_limit; --i)
9689 back_to_previous_visible_line_start (it);
9690 if (i > 0 && IT_CHARPOS (*it) <= pos_limit)
9691 hit_pos_limit = true;
9692 reseat (it, it->current.pos, 1);
9694 /* Move further back if we end up in a string or an image. */
9695 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9697 /* First try to move to start of display line. */
9698 dvpos += it->vpos;
9699 move_it_vertically_backward (it, 0);
9700 dvpos -= it->vpos;
9701 if (IT_POS_VALID_AFTER_MOVE_P (it))
9702 break;
9703 /* If start of line is still in string or image,
9704 move further back. */
9705 back_to_previous_visible_line_start (it);
9706 reseat (it, it->current.pos, 1);
9707 dvpos--;
9710 it->current_x = it->hpos = 0;
9712 /* Above call may have moved too far if continuation lines
9713 are involved. Scan forward and see if it did. */
9714 SAVE_IT (it2, *it, it2data);
9715 it2.vpos = it2.current_y = 0;
9716 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9717 it->vpos -= it2.vpos;
9718 it->current_y -= it2.current_y;
9719 it->current_x = it->hpos = 0;
9721 /* If we moved too far back, move IT some lines forward. */
9722 if (it2.vpos > -dvpos)
9724 int delta = it2.vpos + dvpos;
9726 RESTORE_IT (&it2, &it2, it2data);
9727 SAVE_IT (it2, *it, it2data);
9728 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9729 /* Move back again if we got too far ahead. */
9730 if (IT_CHARPOS (*it) >= start_charpos)
9731 RESTORE_IT (it, &it2, it2data);
9732 else
9733 bidi_unshelve_cache (it2data, 1);
9735 else if (hit_pos_limit && pos_limit > BEGV
9736 && dvpos < 0 && it2.vpos < -dvpos)
9738 /* If we hit the limit, but still didn't make it far enough
9739 back, that means there's a display string with a newline
9740 covering a large chunk of text, and that caused
9741 back_to_previous_visible_line_start try to go too far.
9742 Punish those who commit such atrocities by going back
9743 until we've reached DVPOS, after lifting the limit, which
9744 could make it slow for very long lines. "If it hurts,
9745 don't do that!" */
9746 dvpos += it2.vpos;
9747 RESTORE_IT (it, it, it2data);
9748 for (i = -dvpos; i > 0; --i)
9750 back_to_previous_visible_line_start (it);
9751 it->vpos--;
9753 reseat_1 (it, it->current.pos, 1);
9755 else
9756 RESTORE_IT (it, it, it2data);
9760 /* Return true if IT points into the middle of a display vector. */
9762 bool
9763 in_display_vector_p (struct it *it)
9765 return (it->method == GET_FROM_DISPLAY_VECTOR
9766 && it->current.dpvec_index > 0
9767 && it->dpvec + it->current.dpvec_index != it->dpend);
9770 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9771 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9772 WINDOW must be a live window and defaults to the selected one. The
9773 return value is a cons of the maximum pixel-width of any text line and
9774 the maximum pixel-height of all text lines.
9776 The optional argument FROM, if non-nil, specifies the first text
9777 position and defaults to the minimum accessible position of the buffer.
9778 If FROM is t, use the minimum accessible position that is not a newline
9779 character. TO, if non-nil, specifies the last text position and
9780 defaults to the maximum accessible position of the buffer. If TO is t,
9781 use the maximum accessible position that is not a newline character.
9783 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9784 width that can be returned. X-LIMIT nil or omitted, means to use the
9785 pixel-width of WINDOW's body; use this if you do not intend to change
9786 the width of WINDOW. Use the maximum width WINDOW may assume if you
9787 intend to change WINDOW's width. In any case, text whose x-coordinate
9788 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9789 can take some time, it's always a good idea to make this argument as
9790 small as possible; in particular, if the buffer contains long lines that
9791 shall be truncated anyway.
9793 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9794 height that can be returned. Text lines whose y-coordinate is beyond
9795 Y-LIMIT are ignored. Since calculating the text height of a large
9796 buffer can take some time, it makes sense to specify this argument if
9797 the size of the buffer is unknown.
9799 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9800 include the height of the mode- or header-line of WINDOW in the return
9801 value. If it is either the symbol `mode-line' or `header-line', include
9802 only the height of that line, if present, in the return value. If t,
9803 include the height of both, if present, in the return value. */)
9804 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit, Lisp_Object y_limit,
9805 Lisp_Object mode_and_header_line)
9807 struct window *w = decode_live_window (window);
9808 Lisp_Object buf;
9809 struct buffer *b;
9810 struct it it;
9811 struct buffer *old_buffer = NULL;
9812 ptrdiff_t start, end, pos;
9813 struct text_pos startp;
9814 void *itdata = NULL;
9815 int c, max_y = -1, x = 0, y = 0;
9817 buf = w->contents;
9818 CHECK_BUFFER (buf);
9819 b = XBUFFER (buf);
9821 if (b != current_buffer)
9823 old_buffer = current_buffer;
9824 set_buffer_internal (b);
9827 if (NILP (from))
9828 start = BEGV;
9829 else if (EQ (from, Qt))
9831 start = pos = BEGV;
9832 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9833 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9834 start = pos;
9835 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9836 start = pos;
9838 else
9840 CHECK_NUMBER_COERCE_MARKER (from);
9841 start = min (max (XINT (from), BEGV), ZV);
9844 if (NILP (to))
9845 end = ZV;
9846 else if (EQ (to, Qt))
9848 end = pos = ZV;
9849 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9850 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9851 end = pos;
9852 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9853 end = pos;
9855 else
9857 CHECK_NUMBER_COERCE_MARKER (to);
9858 end = max (start, min (XINT (to), ZV));
9861 if (!NILP (y_limit))
9863 CHECK_NUMBER (y_limit);
9864 max_y = min (XINT (y_limit), INT_MAX);
9867 itdata = bidi_shelve_cache ();
9868 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9869 start_display (&it, w, startp);
9871 if (NILP (x_limit))
9872 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9873 else
9875 CHECK_NUMBER (x_limit);
9876 it.last_visible_x = min (XINT (x_limit), INFINITY);
9877 /* Actually, we never want move_it_to stop at to_x. But to make
9878 sure that move_it_in_display_line_to always moves far enough,
9879 we set it to INT_MAX and specify MOVE_TO_X. */
9880 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9881 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9884 y = it.current_y + it.max_ascent + it.max_descent;
9886 if (!EQ (mode_and_header_line, Qheader_line)
9887 && !EQ (mode_and_header_line, Qt))
9888 /* Do not count the header-line which was counted automatically by
9889 start_display. */
9890 y = y - WINDOW_HEADER_LINE_HEIGHT (w);
9892 if (EQ (mode_and_header_line, Qmode_line)
9893 || EQ (mode_and_header_line, Qt))
9894 /* Do count the mode-line which is not included automatically by
9895 start_display. */
9896 y = y + WINDOW_MODE_LINE_HEIGHT (w);
9898 bidi_unshelve_cache (itdata, 0);
9900 if (old_buffer)
9901 set_buffer_internal (old_buffer);
9903 return Fcons (make_number (x), make_number (y));
9906 /***********************************************************************
9907 Messages
9908 ***********************************************************************/
9911 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9912 to *Messages*. */
9914 void
9915 add_to_log (const char *format, Lisp_Object arg1, Lisp_Object arg2)
9917 Lisp_Object args[3];
9918 Lisp_Object msg, fmt;
9919 char *buffer;
9920 ptrdiff_t len;
9921 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9922 USE_SAFE_ALLOCA;
9924 fmt = msg = Qnil;
9925 GCPRO4 (fmt, msg, arg1, arg2);
9927 args[0] = fmt = build_string (format);
9928 args[1] = arg1;
9929 args[2] = arg2;
9930 msg = Fformat (3, args);
9932 len = SBYTES (msg) + 1;
9933 buffer = SAFE_ALLOCA (len);
9934 memcpy (buffer, SDATA (msg), len);
9936 message_dolog (buffer, len - 1, 1, 0);
9937 SAFE_FREE ();
9939 UNGCPRO;
9943 /* Output a newline in the *Messages* buffer if "needs" one. */
9945 void
9946 message_log_maybe_newline (void)
9948 if (message_log_need_newline)
9949 message_dolog ("", 0, 1, 0);
9953 /* Add a string M of length NBYTES to the message log, optionally
9954 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9955 true, means interpret the contents of M as multibyte. This
9956 function calls low-level routines in order to bypass text property
9957 hooks, etc. which might not be safe to run.
9959 This may GC (insert may run before/after change hooks),
9960 so the buffer M must NOT point to a Lisp string. */
9962 void
9963 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
9965 const unsigned char *msg = (const unsigned char *) m;
9967 if (!NILP (Vmemory_full))
9968 return;
9970 if (!NILP (Vmessage_log_max))
9972 struct buffer *oldbuf;
9973 Lisp_Object oldpoint, oldbegv, oldzv;
9974 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9975 ptrdiff_t point_at_end = 0;
9976 ptrdiff_t zv_at_end = 0;
9977 Lisp_Object old_deactivate_mark;
9978 struct gcpro gcpro1;
9980 old_deactivate_mark = Vdeactivate_mark;
9981 oldbuf = current_buffer;
9983 /* Ensure the Messages buffer exists, and switch to it.
9984 If we created it, set the major-mode. */
9986 int newbuffer = 0;
9987 if (NILP (Fget_buffer (Vmessages_buffer_name))) newbuffer = 1;
9989 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9991 if (newbuffer
9992 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9993 call0 (intern ("messages-buffer-mode"));
9996 bset_undo_list (current_buffer, Qt);
9997 bset_cache_long_scans (current_buffer, Qnil);
9999 oldpoint = message_dolog_marker1;
10000 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
10001 oldbegv = message_dolog_marker2;
10002 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
10003 oldzv = message_dolog_marker3;
10004 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
10005 GCPRO1 (old_deactivate_mark);
10007 if (PT == Z)
10008 point_at_end = 1;
10009 if (ZV == Z)
10010 zv_at_end = 1;
10012 BEGV = BEG;
10013 BEGV_BYTE = BEG_BYTE;
10014 ZV = Z;
10015 ZV_BYTE = Z_BYTE;
10016 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10018 /* Insert the string--maybe converting multibyte to single byte
10019 or vice versa, so that all the text fits the buffer. */
10020 if (multibyte
10021 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
10023 ptrdiff_t i;
10024 int c, char_bytes;
10025 char work[1];
10027 /* Convert a multibyte string to single-byte
10028 for the *Message* buffer. */
10029 for (i = 0; i < nbytes; i += char_bytes)
10031 c = string_char_and_length (msg + i, &char_bytes);
10032 work[0] = CHAR_TO_BYTE8 (c);
10033 insert_1_both (work, 1, 1, 1, 0, 0);
10036 else if (! multibyte
10037 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
10039 ptrdiff_t i;
10040 int c, char_bytes;
10041 unsigned char str[MAX_MULTIBYTE_LENGTH];
10042 /* Convert a single-byte string to multibyte
10043 for the *Message* buffer. */
10044 for (i = 0; i < nbytes; i++)
10046 c = msg[i];
10047 MAKE_CHAR_MULTIBYTE (c);
10048 char_bytes = CHAR_STRING (c, str);
10049 insert_1_both ((char *) str, 1, char_bytes, 1, 0, 0);
10052 else if (nbytes)
10053 insert_1_both (m, chars_in_text (msg, nbytes), nbytes, 1, 0, 0);
10055 if (nlflag)
10057 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
10058 printmax_t dups;
10060 insert_1_both ("\n", 1, 1, 1, 0, 0);
10062 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, 0);
10063 this_bol = PT;
10064 this_bol_byte = PT_BYTE;
10066 /* See if this line duplicates the previous one.
10067 If so, combine duplicates. */
10068 if (this_bol > BEG)
10070 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, 0);
10071 prev_bol = PT;
10072 prev_bol_byte = PT_BYTE;
10074 dups = message_log_check_duplicate (prev_bol_byte,
10075 this_bol_byte);
10076 if (dups)
10078 del_range_both (prev_bol, prev_bol_byte,
10079 this_bol, this_bol_byte, 0);
10080 if (dups > 1)
10082 char dupstr[sizeof " [ times]"
10083 + INT_STRLEN_BOUND (printmax_t)];
10085 /* If you change this format, don't forget to also
10086 change message_log_check_duplicate. */
10087 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
10088 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
10089 insert_1_both (dupstr, duplen, duplen, 1, 0, 1);
10094 /* If we have more than the desired maximum number of lines
10095 in the *Messages* buffer now, delete the oldest ones.
10096 This is safe because we don't have undo in this buffer. */
10098 if (NATNUMP (Vmessage_log_max))
10100 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
10101 -XFASTINT (Vmessage_log_max) - 1, 0);
10102 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, 0);
10105 BEGV = marker_position (oldbegv);
10106 BEGV_BYTE = marker_byte_position (oldbegv);
10108 if (zv_at_end)
10110 ZV = Z;
10111 ZV_BYTE = Z_BYTE;
10113 else
10115 ZV = marker_position (oldzv);
10116 ZV_BYTE = marker_byte_position (oldzv);
10119 if (point_at_end)
10120 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10121 else
10122 /* We can't do Fgoto_char (oldpoint) because it will run some
10123 Lisp code. */
10124 TEMP_SET_PT_BOTH (marker_position (oldpoint),
10125 marker_byte_position (oldpoint));
10127 UNGCPRO;
10128 unchain_marker (XMARKER (oldpoint));
10129 unchain_marker (XMARKER (oldbegv));
10130 unchain_marker (XMARKER (oldzv));
10132 /* We called insert_1_both above with its 5th argument (PREPARE)
10133 zero, which prevents insert_1_both from calling
10134 prepare_to_modify_buffer, which in turns prevents us from
10135 incrementing windows_or_buffers_changed even if *Messages* is
10136 shown in some window. So we must manually set
10137 windows_or_buffers_changed here to make up for that. */
10138 windows_or_buffers_changed = old_windows_or_buffers_changed;
10139 bset_redisplay (current_buffer);
10141 set_buffer_internal (oldbuf);
10143 message_log_need_newline = !nlflag;
10144 Vdeactivate_mark = old_deactivate_mark;
10149 /* We are at the end of the buffer after just having inserted a newline.
10150 (Note: We depend on the fact we won't be crossing the gap.)
10151 Check to see if the most recent message looks a lot like the previous one.
10152 Return 0 if different, 1 if the new one should just replace it, or a
10153 value N > 1 if we should also append " [N times]". */
10155 static intmax_t
10156 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
10158 ptrdiff_t i;
10159 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
10160 int seen_dots = 0;
10161 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
10162 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
10164 for (i = 0; i < len; i++)
10166 if (i >= 3 && p1[i - 3] == '.' && p1[i - 2] == '.' && p1[i - 1] == '.')
10167 seen_dots = 1;
10168 if (p1[i] != p2[i])
10169 return seen_dots;
10171 p1 += len;
10172 if (*p1 == '\n')
10173 return 2;
10174 if (*p1++ == ' ' && *p1++ == '[')
10176 char *pend;
10177 intmax_t n = strtoimax ((char *) p1, &pend, 10);
10178 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
10179 return n + 1;
10181 return 0;
10185 /* Display an echo area message M with a specified length of NBYTES
10186 bytes. The string may include null characters. If M is not a
10187 string, clear out any existing message, and let the mini-buffer
10188 text show through.
10190 This function cancels echoing. */
10192 void
10193 message3 (Lisp_Object m)
10195 struct gcpro gcpro1;
10197 GCPRO1 (m);
10198 clear_message (true, true);
10199 cancel_echoing ();
10201 /* First flush out any partial line written with print. */
10202 message_log_maybe_newline ();
10203 if (STRINGP (m))
10205 ptrdiff_t nbytes = SBYTES (m);
10206 bool multibyte = STRING_MULTIBYTE (m);
10207 char *buffer;
10208 USE_SAFE_ALLOCA;
10209 SAFE_ALLOCA_STRING (buffer, m);
10210 message_dolog (buffer, nbytes, 1, multibyte);
10211 SAFE_FREE ();
10213 message3_nolog (m);
10215 UNGCPRO;
10219 /* The non-logging version of message3.
10220 This does not cancel echoing, because it is used for echoing.
10221 Perhaps we need to make a separate function for echoing
10222 and make this cancel echoing. */
10224 void
10225 message3_nolog (Lisp_Object m)
10227 struct frame *sf = SELECTED_FRAME ();
10229 if (FRAME_INITIAL_P (sf))
10231 if (noninteractive_need_newline)
10232 putc ('\n', stderr);
10233 noninteractive_need_newline = 0;
10234 if (STRINGP (m))
10236 Lisp_Object s = ENCODE_SYSTEM (m);
10238 fwrite (SDATA (s), SBYTES (s), 1, stderr);
10240 if (cursor_in_echo_area == 0)
10241 fprintf (stderr, "\n");
10242 fflush (stderr);
10244 /* Error messages get reported properly by cmd_error, so this must be just an
10245 informative message; if the frame hasn't really been initialized yet, just
10246 toss it. */
10247 else if (INTERACTIVE && sf->glyphs_initialized_p)
10249 /* Get the frame containing the mini-buffer
10250 that the selected frame is using. */
10251 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
10252 Lisp_Object frame = XWINDOW (mini_window)->frame;
10253 struct frame *f = XFRAME (frame);
10255 if (FRAME_VISIBLE_P (sf) && !FRAME_VISIBLE_P (f))
10256 Fmake_frame_visible (frame);
10258 if (STRINGP (m) && SCHARS (m) > 0)
10260 set_message (m);
10261 if (minibuffer_auto_raise)
10262 Fraise_frame (frame);
10263 /* Assume we are not echoing.
10264 (If we are, echo_now will override this.) */
10265 echo_message_buffer = Qnil;
10267 else
10268 clear_message (true, true);
10270 do_pending_window_change (0);
10271 echo_area_display (1);
10272 do_pending_window_change (0);
10273 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
10274 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
10279 /* Display a null-terminated echo area message M. If M is 0, clear
10280 out any existing message, and let the mini-buffer text show through.
10282 The buffer M must continue to exist until after the echo area gets
10283 cleared or some other message gets displayed there. Do not pass
10284 text that is stored in a Lisp string. Do not pass text in a buffer
10285 that was alloca'd. */
10287 void
10288 message1 (const char *m)
10290 message3 (m ? build_unibyte_string (m) : Qnil);
10294 /* The non-logging counterpart of message1. */
10296 void
10297 message1_nolog (const char *m)
10299 message3_nolog (m ? build_unibyte_string (m) : Qnil);
10302 /* Display a message M which contains a single %s
10303 which gets replaced with STRING. */
10305 void
10306 message_with_string (const char *m, Lisp_Object string, int log)
10308 CHECK_STRING (string);
10310 if (noninteractive)
10312 if (m)
10314 /* ENCODE_SYSTEM below can GC and/or relocate the
10315 Lisp data, so make sure we don't use it here. */
10316 eassert (relocatable_string_data_p (m) != 1);
10318 if (noninteractive_need_newline)
10319 putc ('\n', stderr);
10320 noninteractive_need_newline = 0;
10321 fprintf (stderr, m, SDATA (ENCODE_SYSTEM (string)));
10322 if (!cursor_in_echo_area)
10323 fprintf (stderr, "\n");
10324 fflush (stderr);
10327 else if (INTERACTIVE)
10329 /* The frame whose minibuffer we're going to display the message on.
10330 It may be larger than the selected frame, so we need
10331 to use its buffer, not the selected frame's buffer. */
10332 Lisp_Object mini_window;
10333 struct frame *f, *sf = SELECTED_FRAME ();
10335 /* Get the frame containing the minibuffer
10336 that the selected frame is using. */
10337 mini_window = FRAME_MINIBUF_WINDOW (sf);
10338 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10340 /* Error messages get reported properly by cmd_error, so this must be
10341 just an informative message; if the frame hasn't really been
10342 initialized yet, just toss it. */
10343 if (f->glyphs_initialized_p)
10345 Lisp_Object args[2], msg;
10346 struct gcpro gcpro1, gcpro2;
10348 args[0] = build_string (m);
10349 args[1] = msg = string;
10350 GCPRO2 (args[0], msg);
10351 gcpro1.nvars = 2;
10353 msg = Fformat (2, args);
10355 if (log)
10356 message3 (msg);
10357 else
10358 message3_nolog (msg);
10360 UNGCPRO;
10362 /* Print should start at the beginning of the message
10363 buffer next time. */
10364 message_buf_print = 0;
10370 /* Dump an informative message to the minibuf. If M is 0, clear out
10371 any existing message, and let the mini-buffer text show through. */
10373 static void
10374 vmessage (const char *m, va_list ap)
10376 if (noninteractive)
10378 if (m)
10380 if (noninteractive_need_newline)
10381 putc ('\n', stderr);
10382 noninteractive_need_newline = 0;
10383 vfprintf (stderr, m, ap);
10384 if (cursor_in_echo_area == 0)
10385 fprintf (stderr, "\n");
10386 fflush (stderr);
10389 else if (INTERACTIVE)
10391 /* The frame whose mini-buffer we're going to display the message
10392 on. It may be larger than the selected frame, so we need to
10393 use its buffer, not the selected frame's buffer. */
10394 Lisp_Object mini_window;
10395 struct frame *f, *sf = SELECTED_FRAME ();
10397 /* Get the frame containing the mini-buffer
10398 that the selected frame is using. */
10399 mini_window = FRAME_MINIBUF_WINDOW (sf);
10400 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10402 /* Error messages get reported properly by cmd_error, so this must be
10403 just an informative message; if the frame hasn't really been
10404 initialized yet, just toss it. */
10405 if (f->glyphs_initialized_p)
10407 if (m)
10409 ptrdiff_t len;
10410 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10411 USE_SAFE_ALLOCA;
10412 char *message_buf = SAFE_ALLOCA (maxsize + 1);
10414 len = doprnt (message_buf, maxsize, m, 0, ap);
10416 message3 (make_string (message_buf, len));
10417 SAFE_FREE ();
10419 else
10420 message1 (0);
10422 /* Print should start at the beginning of the message
10423 buffer next time. */
10424 message_buf_print = 0;
10429 void
10430 message (const char *m, ...)
10432 va_list ap;
10433 va_start (ap, m);
10434 vmessage (m, ap);
10435 va_end (ap);
10439 #if 0
10440 /* The non-logging version of message. */
10442 void
10443 message_nolog (const char *m, ...)
10445 Lisp_Object old_log_max;
10446 va_list ap;
10447 va_start (ap, m);
10448 old_log_max = Vmessage_log_max;
10449 Vmessage_log_max = Qnil;
10450 vmessage (m, ap);
10451 Vmessage_log_max = old_log_max;
10452 va_end (ap);
10454 #endif
10457 /* Display the current message in the current mini-buffer. This is
10458 only called from error handlers in process.c, and is not time
10459 critical. */
10461 void
10462 update_echo_area (void)
10464 if (!NILP (echo_area_buffer[0]))
10466 Lisp_Object string;
10467 string = Fcurrent_message ();
10468 message3 (string);
10473 /* Make sure echo area buffers in `echo_buffers' are live.
10474 If they aren't, make new ones. */
10476 static void
10477 ensure_echo_area_buffers (void)
10479 int i;
10481 for (i = 0; i < 2; ++i)
10482 if (!BUFFERP (echo_buffer[i])
10483 || !BUFFER_LIVE_P (XBUFFER (echo_buffer[i])))
10485 char name[30];
10486 Lisp_Object old_buffer;
10487 int j;
10489 old_buffer = echo_buffer[i];
10490 echo_buffer[i] = Fget_buffer_create
10491 (make_formatted_string (name, " *Echo Area %d*", i));
10492 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
10493 /* to force word wrap in echo area -
10494 it was decided to postpone this*/
10495 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10497 for (j = 0; j < 2; ++j)
10498 if (EQ (old_buffer, echo_area_buffer[j]))
10499 echo_area_buffer[j] = echo_buffer[i];
10504 /* Call FN with args A1..A2 with either the current or last displayed
10505 echo_area_buffer as current buffer.
10507 WHICH zero means use the current message buffer
10508 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10509 from echo_buffer[] and clear it.
10511 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10512 suitable buffer from echo_buffer[] and clear it.
10514 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10515 that the current message becomes the last displayed one, make
10516 choose a suitable buffer for echo_area_buffer[0], and clear it.
10518 Value is what FN returns. */
10520 static int
10521 with_echo_area_buffer (struct window *w, int which,
10522 int (*fn) (ptrdiff_t, Lisp_Object),
10523 ptrdiff_t a1, Lisp_Object a2)
10525 Lisp_Object buffer;
10526 int this_one, the_other, clear_buffer_p, rc;
10527 ptrdiff_t count = SPECPDL_INDEX ();
10529 /* If buffers aren't live, make new ones. */
10530 ensure_echo_area_buffers ();
10532 clear_buffer_p = 0;
10534 if (which == 0)
10535 this_one = 0, the_other = 1;
10536 else if (which > 0)
10537 this_one = 1, the_other = 0;
10538 else
10540 this_one = 0, the_other = 1;
10541 clear_buffer_p = true;
10543 /* We need a fresh one in case the current echo buffer equals
10544 the one containing the last displayed echo area message. */
10545 if (!NILP (echo_area_buffer[this_one])
10546 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
10547 echo_area_buffer[this_one] = Qnil;
10550 /* Choose a suitable buffer from echo_buffer[] is we don't
10551 have one. */
10552 if (NILP (echo_area_buffer[this_one]))
10554 echo_area_buffer[this_one]
10555 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
10556 ? echo_buffer[the_other]
10557 : echo_buffer[this_one]);
10558 clear_buffer_p = true;
10561 buffer = echo_area_buffer[this_one];
10563 /* Don't get confused by reusing the buffer used for echoing
10564 for a different purpose. */
10565 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
10566 cancel_echoing ();
10568 record_unwind_protect (unwind_with_echo_area_buffer,
10569 with_echo_area_buffer_unwind_data (w));
10571 /* Make the echo area buffer current. Note that for display
10572 purposes, it is not necessary that the displayed window's buffer
10573 == current_buffer, except for text property lookup. So, let's
10574 only set that buffer temporarily here without doing a full
10575 Fset_window_buffer. We must also change w->pointm, though,
10576 because otherwise an assertions in unshow_buffer fails, and Emacs
10577 aborts. */
10578 set_buffer_internal_1 (XBUFFER (buffer));
10579 if (w)
10581 wset_buffer (w, buffer);
10582 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10583 set_marker_both (w->old_pointm, buffer, BEG, BEG_BYTE);
10586 bset_undo_list (current_buffer, Qt);
10587 bset_read_only (current_buffer, Qnil);
10588 specbind (Qinhibit_read_only, Qt);
10589 specbind (Qinhibit_modification_hooks, Qt);
10591 if (clear_buffer_p && Z > BEG)
10592 del_range (BEG, Z);
10594 eassert (BEGV >= BEG);
10595 eassert (ZV <= Z && ZV >= BEGV);
10597 rc = fn (a1, a2);
10599 eassert (BEGV >= BEG);
10600 eassert (ZV <= Z && ZV >= BEGV);
10602 unbind_to (count, Qnil);
10603 return rc;
10607 /* Save state that should be preserved around the call to the function
10608 FN called in with_echo_area_buffer. */
10610 static Lisp_Object
10611 with_echo_area_buffer_unwind_data (struct window *w)
10613 int i = 0;
10614 Lisp_Object vector, tmp;
10616 /* Reduce consing by keeping one vector in
10617 Vwith_echo_area_save_vector. */
10618 vector = Vwith_echo_area_save_vector;
10619 Vwith_echo_area_save_vector = Qnil;
10621 if (NILP (vector))
10622 vector = Fmake_vector (make_number (11), Qnil);
10624 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10625 ASET (vector, i, Vdeactivate_mark); ++i;
10626 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10628 if (w)
10630 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10631 ASET (vector, i, w->contents); ++i;
10632 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10633 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10634 ASET (vector, i, make_number (marker_position (w->old_pointm))); ++i;
10635 ASET (vector, i, make_number (marker_byte_position (w->old_pointm))); ++i;
10636 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10637 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10639 else
10641 int end = i + 8;
10642 for (; i < end; ++i)
10643 ASET (vector, i, Qnil);
10646 eassert (i == ASIZE (vector));
10647 return vector;
10651 /* Restore global state from VECTOR which was created by
10652 with_echo_area_buffer_unwind_data. */
10654 static void
10655 unwind_with_echo_area_buffer (Lisp_Object vector)
10657 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10658 Vdeactivate_mark = AREF (vector, 1);
10659 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10661 if (WINDOWP (AREF (vector, 3)))
10663 struct window *w;
10664 Lisp_Object buffer;
10666 w = XWINDOW (AREF (vector, 3));
10667 buffer = AREF (vector, 4);
10669 wset_buffer (w, buffer);
10670 set_marker_both (w->pointm, buffer,
10671 XFASTINT (AREF (vector, 5)),
10672 XFASTINT (AREF (vector, 6)));
10673 set_marker_both (w->old_pointm, buffer,
10674 XFASTINT (AREF (vector, 7)),
10675 XFASTINT (AREF (vector, 8)));
10676 set_marker_both (w->start, buffer,
10677 XFASTINT (AREF (vector, 9)),
10678 XFASTINT (AREF (vector, 10)));
10681 Vwith_echo_area_save_vector = vector;
10685 /* Set up the echo area for use by print functions. MULTIBYTE_P
10686 non-zero means we will print multibyte. */
10688 void
10689 setup_echo_area_for_printing (int multibyte_p)
10691 /* If we can't find an echo area any more, exit. */
10692 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10693 Fkill_emacs (Qnil);
10695 ensure_echo_area_buffers ();
10697 if (!message_buf_print)
10699 /* A message has been output since the last time we printed.
10700 Choose a fresh echo area buffer. */
10701 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10702 echo_area_buffer[0] = echo_buffer[1];
10703 else
10704 echo_area_buffer[0] = echo_buffer[0];
10706 /* Switch to that buffer and clear it. */
10707 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10708 bset_truncate_lines (current_buffer, Qnil);
10710 if (Z > BEG)
10712 ptrdiff_t count = SPECPDL_INDEX ();
10713 specbind (Qinhibit_read_only, Qt);
10714 /* Note that undo recording is always disabled. */
10715 del_range (BEG, Z);
10716 unbind_to (count, Qnil);
10718 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10720 /* Set up the buffer for the multibyteness we need. */
10721 if (multibyte_p
10722 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10723 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10725 /* Raise the frame containing the echo area. */
10726 if (minibuffer_auto_raise)
10728 struct frame *sf = SELECTED_FRAME ();
10729 Lisp_Object mini_window;
10730 mini_window = FRAME_MINIBUF_WINDOW (sf);
10731 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10734 message_log_maybe_newline ();
10735 message_buf_print = 1;
10737 else
10739 if (NILP (echo_area_buffer[0]))
10741 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10742 echo_area_buffer[0] = echo_buffer[1];
10743 else
10744 echo_area_buffer[0] = echo_buffer[0];
10747 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10749 /* Someone switched buffers between print requests. */
10750 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10751 bset_truncate_lines (current_buffer, Qnil);
10757 /* Display an echo area message in window W. Value is non-zero if W's
10758 height is changed. If display_last_displayed_message_p is
10759 non-zero, display the message that was last displayed, otherwise
10760 display the current message. */
10762 static int
10763 display_echo_area (struct window *w)
10765 int i, no_message_p, window_height_changed_p;
10767 /* Temporarily disable garbage collections while displaying the echo
10768 area. This is done because a GC can print a message itself.
10769 That message would modify the echo area buffer's contents while a
10770 redisplay of the buffer is going on, and seriously confuse
10771 redisplay. */
10772 ptrdiff_t count = inhibit_garbage_collection ();
10774 /* If there is no message, we must call display_echo_area_1
10775 nevertheless because it resizes the window. But we will have to
10776 reset the echo_area_buffer in question to nil at the end because
10777 with_echo_area_buffer will sets it to an empty buffer. */
10778 i = display_last_displayed_message_p ? 1 : 0;
10779 no_message_p = NILP (echo_area_buffer[i]);
10781 window_height_changed_p
10782 = with_echo_area_buffer (w, display_last_displayed_message_p,
10783 display_echo_area_1,
10784 (intptr_t) w, Qnil);
10786 if (no_message_p)
10787 echo_area_buffer[i] = Qnil;
10789 unbind_to (count, Qnil);
10790 return window_height_changed_p;
10794 /* Helper for display_echo_area. Display the current buffer which
10795 contains the current echo area message in window W, a mini-window,
10796 a pointer to which is passed in A1. A2..A4 are currently not used.
10797 Change the height of W so that all of the message is displayed.
10798 Value is non-zero if height of W was changed. */
10800 static int
10801 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10803 intptr_t i1 = a1;
10804 struct window *w = (struct window *) i1;
10805 Lisp_Object window;
10806 struct text_pos start;
10807 int window_height_changed_p = 0;
10809 /* Do this before displaying, so that we have a large enough glyph
10810 matrix for the display. If we can't get enough space for the
10811 whole text, display the last N lines. That works by setting w->start. */
10812 window_height_changed_p = resize_mini_window (w, 0);
10814 /* Use the starting position chosen by resize_mini_window. */
10815 SET_TEXT_POS_FROM_MARKER (start, w->start);
10817 /* Display. */
10818 clear_glyph_matrix (w->desired_matrix);
10819 XSETWINDOW (window, w);
10820 try_window (window, start, 0);
10822 return window_height_changed_p;
10826 /* Resize the echo area window to exactly the size needed for the
10827 currently displayed message, if there is one. If a mini-buffer
10828 is active, don't shrink it. */
10830 void
10831 resize_echo_area_exactly (void)
10833 if (BUFFERP (echo_area_buffer[0])
10834 && WINDOWP (echo_area_window))
10836 struct window *w = XWINDOW (echo_area_window);
10837 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10838 int resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10839 (intptr_t) w, resize_exactly);
10840 if (resized_p)
10842 windows_or_buffers_changed = 42;
10843 update_mode_lines = 30;
10844 redisplay_internal ();
10850 /* Callback function for with_echo_area_buffer, when used from
10851 resize_echo_area_exactly. A1 contains a pointer to the window to
10852 resize, EXACTLY non-nil means resize the mini-window exactly to the
10853 size of the text displayed. A3 and A4 are not used. Value is what
10854 resize_mini_window returns. */
10856 static int
10857 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10859 intptr_t i1 = a1;
10860 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10864 /* Resize mini-window W to fit the size of its contents. EXACT_P
10865 means size the window exactly to the size needed. Otherwise, it's
10866 only enlarged until W's buffer is empty.
10868 Set W->start to the right place to begin display. If the whole
10869 contents fit, start at the beginning. Otherwise, start so as
10870 to make the end of the contents appear. This is particularly
10871 important for y-or-n-p, but seems desirable generally.
10873 Value is non-zero if the window height has been changed. */
10876 resize_mini_window (struct window *w, int exact_p)
10878 struct frame *f = XFRAME (w->frame);
10879 int window_height_changed_p = 0;
10881 eassert (MINI_WINDOW_P (w));
10883 /* By default, start display at the beginning. */
10884 set_marker_both (w->start, w->contents,
10885 BUF_BEGV (XBUFFER (w->contents)),
10886 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10888 /* Don't resize windows while redisplaying a window; it would
10889 confuse redisplay functions when the size of the window they are
10890 displaying changes from under them. Such a resizing can happen,
10891 for instance, when which-func prints a long message while
10892 we are running fontification-functions. We're running these
10893 functions with safe_call which binds inhibit-redisplay to t. */
10894 if (!NILP (Vinhibit_redisplay))
10895 return 0;
10897 /* Nil means don't try to resize. */
10898 if (NILP (Vresize_mini_windows)
10899 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10900 return 0;
10902 if (!FRAME_MINIBUF_ONLY_P (f))
10904 struct it it;
10905 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
10906 + WINDOW_PIXEL_HEIGHT (w));
10907 int unit = FRAME_LINE_HEIGHT (f);
10908 int height, max_height;
10909 struct text_pos start;
10910 struct buffer *old_current_buffer = NULL;
10912 if (current_buffer != XBUFFER (w->contents))
10914 old_current_buffer = current_buffer;
10915 set_buffer_internal (XBUFFER (w->contents));
10918 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10920 /* Compute the max. number of lines specified by the user. */
10921 if (FLOATP (Vmax_mini_window_height))
10922 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
10923 else if (INTEGERP (Vmax_mini_window_height))
10924 max_height = XINT (Vmax_mini_window_height) * unit;
10925 else
10926 max_height = total_height / 4;
10928 /* Correct that max. height if it's bogus. */
10929 max_height = clip_to_bounds (unit, max_height, total_height);
10931 /* Find out the height of the text in the window. */
10932 if (it.line_wrap == TRUNCATE)
10933 height = unit;
10934 else
10936 last_height = 0;
10937 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10938 if (it.max_ascent == 0 && it.max_descent == 0)
10939 height = it.current_y + last_height;
10940 else
10941 height = it.current_y + it.max_ascent + it.max_descent;
10942 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10945 /* Compute a suitable window start. */
10946 if (height > max_height)
10948 height = (max_height / unit) * unit;
10949 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10950 move_it_vertically_backward (&it, height - unit);
10951 start = it.current.pos;
10953 else
10954 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10955 SET_MARKER_FROM_TEXT_POS (w->start, start);
10957 if (EQ (Vresize_mini_windows, Qgrow_only))
10959 /* Let it grow only, until we display an empty message, in which
10960 case the window shrinks again. */
10961 if (height > WINDOW_PIXEL_HEIGHT (w))
10963 int old_height = WINDOW_PIXEL_HEIGHT (w);
10965 FRAME_WINDOWS_FROZEN (f) = 1;
10966 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10967 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10969 else if (height < WINDOW_PIXEL_HEIGHT (w)
10970 && (exact_p || BEGV == ZV))
10972 int old_height = WINDOW_PIXEL_HEIGHT (w);
10974 FRAME_WINDOWS_FROZEN (f) = 0;
10975 shrink_mini_window (w, 1);
10976 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10979 else
10981 /* Always resize to exact size needed. */
10982 if (height > WINDOW_PIXEL_HEIGHT (w))
10984 int old_height = WINDOW_PIXEL_HEIGHT (w);
10986 FRAME_WINDOWS_FROZEN (f) = 1;
10987 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10988 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10990 else if (height < WINDOW_PIXEL_HEIGHT (w))
10992 int old_height = WINDOW_PIXEL_HEIGHT (w);
10994 FRAME_WINDOWS_FROZEN (f) = 0;
10995 shrink_mini_window (w, 1);
10997 if (height)
10999 FRAME_WINDOWS_FROZEN (f) = 1;
11000 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
11003 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11007 if (old_current_buffer)
11008 set_buffer_internal (old_current_buffer);
11011 return window_height_changed_p;
11015 /* Value is the current message, a string, or nil if there is no
11016 current message. */
11018 Lisp_Object
11019 current_message (void)
11021 Lisp_Object msg;
11023 if (!BUFFERP (echo_area_buffer[0]))
11024 msg = Qnil;
11025 else
11027 with_echo_area_buffer (0, 0, current_message_1,
11028 (intptr_t) &msg, Qnil);
11029 if (NILP (msg))
11030 echo_area_buffer[0] = Qnil;
11033 return msg;
11037 static int
11038 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
11040 intptr_t i1 = a1;
11041 Lisp_Object *msg = (Lisp_Object *) i1;
11043 if (Z > BEG)
11044 *msg = make_buffer_string (BEG, Z, 1);
11045 else
11046 *msg = Qnil;
11047 return 0;
11051 /* Push the current message on Vmessage_stack for later restoration
11052 by restore_message. Value is non-zero if the current message isn't
11053 empty. This is a relatively infrequent operation, so it's not
11054 worth optimizing. */
11056 bool
11057 push_message (void)
11059 Lisp_Object msg = current_message ();
11060 Vmessage_stack = Fcons (msg, Vmessage_stack);
11061 return STRINGP (msg);
11065 /* Restore message display from the top of Vmessage_stack. */
11067 void
11068 restore_message (void)
11070 eassert (CONSP (Vmessage_stack));
11071 message3_nolog (XCAR (Vmessage_stack));
11075 /* Handler for unwind-protect calling pop_message. */
11077 void
11078 pop_message_unwind (void)
11080 /* Pop the top-most entry off Vmessage_stack. */
11081 eassert (CONSP (Vmessage_stack));
11082 Vmessage_stack = XCDR (Vmessage_stack);
11086 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11087 exits. If the stack is not empty, we have a missing pop_message
11088 somewhere. */
11090 void
11091 check_message_stack (void)
11093 if (!NILP (Vmessage_stack))
11094 emacs_abort ();
11098 /* Truncate to NCHARS what will be displayed in the echo area the next
11099 time we display it---but don't redisplay it now. */
11101 void
11102 truncate_echo_area (ptrdiff_t nchars)
11104 if (nchars == 0)
11105 echo_area_buffer[0] = Qnil;
11106 else if (!noninteractive
11107 && INTERACTIVE
11108 && !NILP (echo_area_buffer[0]))
11110 struct frame *sf = SELECTED_FRAME ();
11111 /* Error messages get reported properly by cmd_error, so this must be
11112 just an informative message; if the frame hasn't really been
11113 initialized yet, just toss it. */
11114 if (sf->glyphs_initialized_p)
11115 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
11120 /* Helper function for truncate_echo_area. Truncate the current
11121 message to at most NCHARS characters. */
11123 static int
11124 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11126 if (BEG + nchars < Z)
11127 del_range (BEG + nchars, Z);
11128 if (Z == BEG)
11129 echo_area_buffer[0] = Qnil;
11130 return 0;
11133 /* Set the current message to STRING. */
11135 static void
11136 set_message (Lisp_Object string)
11138 eassert (STRINGP (string));
11140 message_enable_multibyte = STRING_MULTIBYTE (string);
11142 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11143 message_buf_print = 0;
11144 help_echo_showing_p = 0;
11146 if (STRINGP (Vdebug_on_message)
11147 && STRINGP (string)
11148 && fast_string_match (Vdebug_on_message, string) >= 0)
11149 call_debugger (list2 (Qerror, string));
11153 /* Helper function for set_message. First argument is ignored and second
11154 argument has the same meaning as for set_message.
11155 This function is called with the echo area buffer being current. */
11157 static int
11158 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11160 eassert (STRINGP (string));
11162 /* Change multibyteness of the echo buffer appropriately. */
11163 if (message_enable_multibyte
11164 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11165 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11167 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11168 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11169 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11171 /* Insert new message at BEG. */
11172 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11174 /* This function takes care of single/multibyte conversion.
11175 We just have to ensure that the echo area buffer has the right
11176 setting of enable_multibyte_characters. */
11177 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 1);
11179 return 0;
11183 /* Clear messages. CURRENT_P non-zero means clear the current
11184 message. LAST_DISPLAYED_P non-zero means clear the message
11185 last displayed. */
11187 void
11188 clear_message (bool current_p, bool last_displayed_p)
11190 if (current_p)
11192 echo_area_buffer[0] = Qnil;
11193 message_cleared_p = true;
11196 if (last_displayed_p)
11197 echo_area_buffer[1] = Qnil;
11199 message_buf_print = 0;
11202 /* Clear garbaged frames.
11204 This function is used where the old redisplay called
11205 redraw_garbaged_frames which in turn called redraw_frame which in
11206 turn called clear_frame. The call to clear_frame was a source of
11207 flickering. I believe a clear_frame is not necessary. It should
11208 suffice in the new redisplay to invalidate all current matrices,
11209 and ensure a complete redisplay of all windows. */
11211 static void
11212 clear_garbaged_frames (void)
11214 if (frame_garbaged)
11216 Lisp_Object tail, frame;
11218 FOR_EACH_FRAME (tail, frame)
11220 struct frame *f = XFRAME (frame);
11222 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11224 if (f->resized_p)
11225 redraw_frame (f);
11226 else
11227 clear_current_matrices (f);
11228 fset_redisplay (f);
11229 f->garbaged = false;
11230 f->resized_p = false;
11234 frame_garbaged = false;
11239 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11240 is non-zero update selected_frame. Value is non-zero if the
11241 mini-windows height has been changed. */
11243 static int
11244 echo_area_display (int update_frame_p)
11246 Lisp_Object mini_window;
11247 struct window *w;
11248 struct frame *f;
11249 int window_height_changed_p = 0;
11250 struct frame *sf = SELECTED_FRAME ();
11252 mini_window = FRAME_MINIBUF_WINDOW (sf);
11253 w = XWINDOW (mini_window);
11254 f = XFRAME (WINDOW_FRAME (w));
11256 /* Don't display if frame is invisible or not yet initialized. */
11257 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11258 return 0;
11260 #ifdef HAVE_WINDOW_SYSTEM
11261 /* When Emacs starts, selected_frame may be the initial terminal
11262 frame. If we let this through, a message would be displayed on
11263 the terminal. */
11264 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11265 return 0;
11266 #endif /* HAVE_WINDOW_SYSTEM */
11268 /* Redraw garbaged frames. */
11269 clear_garbaged_frames ();
11271 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11273 echo_area_window = mini_window;
11274 window_height_changed_p = display_echo_area (w);
11275 w->must_be_updated_p = true;
11277 /* Update the display, unless called from redisplay_internal.
11278 Also don't update the screen during redisplay itself. The
11279 update will happen at the end of redisplay, and an update
11280 here could cause confusion. */
11281 if (update_frame_p && !redisplaying_p)
11283 int n = 0;
11285 /* If the display update has been interrupted by pending
11286 input, update mode lines in the frame. Due to the
11287 pending input, it might have been that redisplay hasn't
11288 been called, so that mode lines above the echo area are
11289 garbaged. This looks odd, so we prevent it here. */
11290 if (!display_completed)
11291 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11293 if (window_height_changed_p
11294 /* Don't do this if Emacs is shutting down. Redisplay
11295 needs to run hooks. */
11296 && !NILP (Vrun_hooks))
11298 /* Must update other windows. Likewise as in other
11299 cases, don't let this update be interrupted by
11300 pending input. */
11301 ptrdiff_t count = SPECPDL_INDEX ();
11302 specbind (Qredisplay_dont_pause, Qt);
11303 windows_or_buffers_changed = 44;
11304 redisplay_internal ();
11305 unbind_to (count, Qnil);
11307 else if (FRAME_WINDOW_P (f) && n == 0)
11309 /* Window configuration is the same as before.
11310 Can do with a display update of the echo area,
11311 unless we displayed some mode lines. */
11312 update_single_window (w, 1);
11313 flush_frame (f);
11315 else
11316 update_frame (f, 1, 1);
11318 /* If cursor is in the echo area, make sure that the next
11319 redisplay displays the minibuffer, so that the cursor will
11320 be replaced with what the minibuffer wants. */
11321 if (cursor_in_echo_area)
11322 wset_redisplay (XWINDOW (mini_window));
11325 else if (!EQ (mini_window, selected_window))
11326 wset_redisplay (XWINDOW (mini_window));
11328 /* Last displayed message is now the current message. */
11329 echo_area_buffer[1] = echo_area_buffer[0];
11330 /* Inform read_char that we're not echoing. */
11331 echo_message_buffer = Qnil;
11333 /* Prevent redisplay optimization in redisplay_internal by resetting
11334 this_line_start_pos. This is done because the mini-buffer now
11335 displays the message instead of its buffer text. */
11336 if (EQ (mini_window, selected_window))
11337 CHARPOS (this_line_start_pos) = 0;
11339 return window_height_changed_p;
11342 /* Nonzero if W's buffer was changed but not saved. */
11344 static int
11345 window_buffer_changed (struct window *w)
11347 struct buffer *b = XBUFFER (w->contents);
11349 eassert (BUFFER_LIVE_P (b));
11351 return (((BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star));
11354 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11356 static int
11357 mode_line_update_needed (struct window *w)
11359 return (w->column_number_displayed != -1
11360 && !(PT == w->last_point && !window_outdated (w))
11361 && (w->column_number_displayed != current_column ()));
11364 /* Nonzero if window start of W is frozen and may not be changed during
11365 redisplay. */
11367 static bool
11368 window_frozen_p (struct window *w)
11370 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11372 Lisp_Object window;
11374 XSETWINDOW (window, w);
11375 if (MINI_WINDOW_P (w))
11376 return 0;
11377 else if (EQ (window, selected_window))
11378 return 0;
11379 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11380 && EQ (window, Vminibuf_scroll_window))
11381 /* This special window can't be frozen too. */
11382 return 0;
11383 else
11384 return 1;
11386 return 0;
11389 /***********************************************************************
11390 Mode Lines and Frame Titles
11391 ***********************************************************************/
11393 /* A buffer for constructing non-propertized mode-line strings and
11394 frame titles in it; allocated from the heap in init_xdisp and
11395 resized as needed in store_mode_line_noprop_char. */
11397 static char *mode_line_noprop_buf;
11399 /* The buffer's end, and a current output position in it. */
11401 static char *mode_line_noprop_buf_end;
11402 static char *mode_line_noprop_ptr;
11404 #define MODE_LINE_NOPROP_LEN(start) \
11405 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11407 static enum {
11408 MODE_LINE_DISPLAY = 0,
11409 MODE_LINE_TITLE,
11410 MODE_LINE_NOPROP,
11411 MODE_LINE_STRING
11412 } mode_line_target;
11414 /* Alist that caches the results of :propertize.
11415 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11416 static Lisp_Object mode_line_proptrans_alist;
11418 /* List of strings making up the mode-line. */
11419 static Lisp_Object mode_line_string_list;
11421 /* Base face property when building propertized mode line string. */
11422 static Lisp_Object mode_line_string_face;
11423 static Lisp_Object mode_line_string_face_prop;
11426 /* Unwind data for mode line strings */
11428 static Lisp_Object Vmode_line_unwind_vector;
11430 static Lisp_Object
11431 format_mode_line_unwind_data (struct frame *target_frame,
11432 struct buffer *obuf,
11433 Lisp_Object owin,
11434 int save_proptrans)
11436 Lisp_Object vector, tmp;
11438 /* Reduce consing by keeping one vector in
11439 Vwith_echo_area_save_vector. */
11440 vector = Vmode_line_unwind_vector;
11441 Vmode_line_unwind_vector = Qnil;
11443 if (NILP (vector))
11444 vector = Fmake_vector (make_number (10), Qnil);
11446 ASET (vector, 0, make_number (mode_line_target));
11447 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11448 ASET (vector, 2, mode_line_string_list);
11449 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11450 ASET (vector, 4, mode_line_string_face);
11451 ASET (vector, 5, mode_line_string_face_prop);
11453 if (obuf)
11454 XSETBUFFER (tmp, obuf);
11455 else
11456 tmp = Qnil;
11457 ASET (vector, 6, tmp);
11458 ASET (vector, 7, owin);
11459 if (target_frame)
11461 /* Similarly to `with-selected-window', if the operation selects
11462 a window on another frame, we must restore that frame's
11463 selected window, and (for a tty) the top-frame. */
11464 ASET (vector, 8, target_frame->selected_window);
11465 if (FRAME_TERMCAP_P (target_frame))
11466 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11469 return vector;
11472 static void
11473 unwind_format_mode_line (Lisp_Object vector)
11475 Lisp_Object old_window = AREF (vector, 7);
11476 Lisp_Object target_frame_window = AREF (vector, 8);
11477 Lisp_Object old_top_frame = AREF (vector, 9);
11479 mode_line_target = XINT (AREF (vector, 0));
11480 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11481 mode_line_string_list = AREF (vector, 2);
11482 if (! EQ (AREF (vector, 3), Qt))
11483 mode_line_proptrans_alist = AREF (vector, 3);
11484 mode_line_string_face = AREF (vector, 4);
11485 mode_line_string_face_prop = AREF (vector, 5);
11487 /* Select window before buffer, since it may change the buffer. */
11488 if (!NILP (old_window))
11490 /* If the operation that we are unwinding had selected a window
11491 on a different frame, reset its frame-selected-window. For a
11492 text terminal, reset its top-frame if necessary. */
11493 if (!NILP (target_frame_window))
11495 Lisp_Object frame
11496 = WINDOW_FRAME (XWINDOW (target_frame_window));
11498 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11499 Fselect_window (target_frame_window, Qt);
11501 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11502 Fselect_frame (old_top_frame, Qt);
11505 Fselect_window (old_window, Qt);
11508 if (!NILP (AREF (vector, 6)))
11510 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11511 ASET (vector, 6, Qnil);
11514 Vmode_line_unwind_vector = vector;
11518 /* Store a single character C for the frame title in mode_line_noprop_buf.
11519 Re-allocate mode_line_noprop_buf if necessary. */
11521 static void
11522 store_mode_line_noprop_char (char c)
11524 /* If output position has reached the end of the allocated buffer,
11525 increase the buffer's size. */
11526 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11528 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11529 ptrdiff_t size = len;
11530 mode_line_noprop_buf =
11531 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11532 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11533 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11536 *mode_line_noprop_ptr++ = c;
11540 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11541 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11542 characters that yield more columns than PRECISION; PRECISION <= 0
11543 means copy the whole string. Pad with spaces until FIELD_WIDTH
11544 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11545 pad. Called from display_mode_element when it is used to build a
11546 frame title. */
11548 static int
11549 store_mode_line_noprop (const char *string, int field_width, int precision)
11551 const unsigned char *str = (const unsigned char *) string;
11552 int n = 0;
11553 ptrdiff_t dummy, nbytes;
11555 /* Copy at most PRECISION chars from STR. */
11556 nbytes = strlen (string);
11557 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11558 while (nbytes--)
11559 store_mode_line_noprop_char (*str++);
11561 /* Fill up with spaces until FIELD_WIDTH reached. */
11562 while (field_width > 0
11563 && n < field_width)
11565 store_mode_line_noprop_char (' ');
11566 ++n;
11569 return n;
11572 /***********************************************************************
11573 Frame Titles
11574 ***********************************************************************/
11576 #ifdef HAVE_WINDOW_SYSTEM
11578 /* Set the title of FRAME, if it has changed. The title format is
11579 Vicon_title_format if FRAME is iconified, otherwise it is
11580 frame_title_format. */
11582 static void
11583 x_consider_frame_title (Lisp_Object frame)
11585 struct frame *f = XFRAME (frame);
11587 if (FRAME_WINDOW_P (f)
11588 || FRAME_MINIBUF_ONLY_P (f)
11589 || f->explicit_name)
11591 /* Do we have more than one visible frame on this X display? */
11592 Lisp_Object tail, other_frame, fmt;
11593 ptrdiff_t title_start;
11594 char *title;
11595 ptrdiff_t len;
11596 struct it it;
11597 ptrdiff_t count = SPECPDL_INDEX ();
11599 FOR_EACH_FRAME (tail, other_frame)
11601 struct frame *tf = XFRAME (other_frame);
11603 if (tf != f
11604 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11605 && !FRAME_MINIBUF_ONLY_P (tf)
11606 && !EQ (other_frame, tip_frame)
11607 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11608 break;
11611 /* Set global variable indicating that multiple frames exist. */
11612 multiple_frames = CONSP (tail);
11614 /* Switch to the buffer of selected window of the frame. Set up
11615 mode_line_target so that display_mode_element will output into
11616 mode_line_noprop_buf; then display the title. */
11617 record_unwind_protect (unwind_format_mode_line,
11618 format_mode_line_unwind_data
11619 (f, current_buffer, selected_window, 0));
11621 Fselect_window (f->selected_window, Qt);
11622 set_buffer_internal_1
11623 (XBUFFER (XWINDOW (f->selected_window)->contents));
11624 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11626 mode_line_target = MODE_LINE_TITLE;
11627 title_start = MODE_LINE_NOPROP_LEN (0);
11628 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11629 NULL, DEFAULT_FACE_ID);
11630 display_mode_element (&it, 0, -1, -1, fmt, Qnil, 0);
11631 len = MODE_LINE_NOPROP_LEN (title_start);
11632 title = mode_line_noprop_buf + title_start;
11633 unbind_to (count, Qnil);
11635 /* Set the title only if it's changed. This avoids consing in
11636 the common case where it hasn't. (If it turns out that we've
11637 already wasted too much time by walking through the list with
11638 display_mode_element, then we might need to optimize at a
11639 higher level than this.) */
11640 if (! STRINGP (f->name)
11641 || SBYTES (f->name) != len
11642 || memcmp (title, SDATA (f->name), len) != 0)
11643 x_implicitly_set_name (f, make_string (title, len), Qnil);
11647 #endif /* not HAVE_WINDOW_SYSTEM */
11650 /***********************************************************************
11651 Menu Bars
11652 ***********************************************************************/
11654 /* Non-zero if we will not redisplay all visible windows. */
11655 #define REDISPLAY_SOME_P() \
11656 ((windows_or_buffers_changed == 0 \
11657 || windows_or_buffers_changed == REDISPLAY_SOME) \
11658 && (update_mode_lines == 0 \
11659 || update_mode_lines == REDISPLAY_SOME))
11661 /* Prepare for redisplay by updating menu-bar item lists when
11662 appropriate. This can call eval. */
11664 static void
11665 prepare_menu_bars (void)
11667 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11668 bool some_windows = REDISPLAY_SOME_P ();
11669 struct gcpro gcpro1, gcpro2;
11670 Lisp_Object tooltip_frame;
11672 #ifdef HAVE_WINDOW_SYSTEM
11673 tooltip_frame = tip_frame;
11674 #else
11675 tooltip_frame = Qnil;
11676 #endif
11678 if (FUNCTIONP (Vpre_redisplay_function))
11680 Lisp_Object windows = all_windows ? Qt : Qnil;
11681 if (all_windows && some_windows)
11683 Lisp_Object ws = window_list ();
11684 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11686 Lisp_Object this = XCAR (ws);
11687 struct window *w = XWINDOW (this);
11688 if (w->redisplay
11689 || XFRAME (w->frame)->redisplay
11690 || XBUFFER (w->contents)->text->redisplay)
11692 windows = Fcons (this, windows);
11696 safe__call1 (true, Vpre_redisplay_function, windows);
11699 /* Update all frame titles based on their buffer names, etc. We do
11700 this before the menu bars so that the buffer-menu will show the
11701 up-to-date frame titles. */
11702 #ifdef HAVE_WINDOW_SYSTEM
11703 if (all_windows)
11705 Lisp_Object tail, frame;
11707 FOR_EACH_FRAME (tail, frame)
11709 struct frame *f = XFRAME (frame);
11710 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11711 if (some_windows
11712 && !f->redisplay
11713 && !w->redisplay
11714 && !XBUFFER (w->contents)->text->redisplay)
11715 continue;
11717 if (!EQ (frame, tooltip_frame)
11718 && (FRAME_ICONIFIED_P (f)
11719 || FRAME_VISIBLE_P (f) == 1
11720 /* Exclude TTY frames that are obscured because they
11721 are not the top frame on their console. This is
11722 because x_consider_frame_title actually switches
11723 to the frame, which for TTY frames means it is
11724 marked as garbaged, and will be completely
11725 redrawn on the next redisplay cycle. This causes
11726 TTY frames to be completely redrawn, when there
11727 are more than one of them, even though nothing
11728 should be changed on display. */
11729 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11730 x_consider_frame_title (frame);
11733 #endif /* HAVE_WINDOW_SYSTEM */
11735 /* Update the menu bar item lists, if appropriate. This has to be
11736 done before any actual redisplay or generation of display lines. */
11738 if (all_windows)
11740 Lisp_Object tail, frame;
11741 ptrdiff_t count = SPECPDL_INDEX ();
11742 /* 1 means that update_menu_bar has run its hooks
11743 so any further calls to update_menu_bar shouldn't do so again. */
11744 int menu_bar_hooks_run = 0;
11746 record_unwind_save_match_data ();
11748 FOR_EACH_FRAME (tail, frame)
11750 struct frame *f = XFRAME (frame);
11751 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11753 /* Ignore tooltip frame. */
11754 if (EQ (frame, tooltip_frame))
11755 continue;
11757 if (some_windows
11758 && !f->redisplay
11759 && !w->redisplay
11760 && !XBUFFER (w->contents)->text->redisplay)
11761 continue;
11763 /* If a window on this frame changed size, report that to
11764 the user and clear the size-change flag. */
11765 if (FRAME_WINDOW_SIZES_CHANGED (f))
11767 Lisp_Object functions;
11769 /* Clear flag first in case we get an error below. */
11770 FRAME_WINDOW_SIZES_CHANGED (f) = 0;
11771 functions = Vwindow_size_change_functions;
11772 GCPRO2 (tail, functions);
11774 while (CONSP (functions))
11776 if (!EQ (XCAR (functions), Qt))
11777 call1 (XCAR (functions), frame);
11778 functions = XCDR (functions);
11780 UNGCPRO;
11783 GCPRO1 (tail);
11784 menu_bar_hooks_run = update_menu_bar (f, 0, menu_bar_hooks_run);
11785 #ifdef HAVE_WINDOW_SYSTEM
11786 update_tool_bar (f, 0);
11787 #endif
11788 UNGCPRO;
11791 unbind_to (count, Qnil);
11793 else
11795 struct frame *sf = SELECTED_FRAME ();
11796 update_menu_bar (sf, 1, 0);
11797 #ifdef HAVE_WINDOW_SYSTEM
11798 update_tool_bar (sf, 1);
11799 #endif
11804 /* Update the menu bar item list for frame F. This has to be done
11805 before we start to fill in any display lines, because it can call
11806 eval.
11808 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11810 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11811 already ran the menu bar hooks for this redisplay, so there
11812 is no need to run them again. The return value is the
11813 updated value of this flag, to pass to the next call. */
11815 static int
11816 update_menu_bar (struct frame *f, int save_match_data, int hooks_run)
11818 Lisp_Object window;
11819 register struct window *w;
11821 /* If called recursively during a menu update, do nothing. This can
11822 happen when, for instance, an activate-menubar-hook causes a
11823 redisplay. */
11824 if (inhibit_menubar_update)
11825 return hooks_run;
11827 window = FRAME_SELECTED_WINDOW (f);
11828 w = XWINDOW (window);
11830 if (FRAME_WINDOW_P (f)
11832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11833 || defined (HAVE_NS) || defined (USE_GTK)
11834 FRAME_EXTERNAL_MENU_BAR (f)
11835 #else
11836 FRAME_MENU_BAR_LINES (f) > 0
11837 #endif
11838 : FRAME_MENU_BAR_LINES (f) > 0)
11840 /* If the user has switched buffers or windows, we need to
11841 recompute to reflect the new bindings. But we'll
11842 recompute when update_mode_lines is set too; that means
11843 that people can use force-mode-line-update to request
11844 that the menu bar be recomputed. The adverse effect on
11845 the rest of the redisplay algorithm is about the same as
11846 windows_or_buffers_changed anyway. */
11847 if (windows_or_buffers_changed
11848 /* This used to test w->update_mode_line, but we believe
11849 there is no need to recompute the menu in that case. */
11850 || update_mode_lines
11851 || window_buffer_changed (w))
11853 struct buffer *prev = current_buffer;
11854 ptrdiff_t count = SPECPDL_INDEX ();
11856 specbind (Qinhibit_menubar_update, Qt);
11858 set_buffer_internal_1 (XBUFFER (w->contents));
11859 if (save_match_data)
11860 record_unwind_save_match_data ();
11861 if (NILP (Voverriding_local_map_menu_flag))
11863 specbind (Qoverriding_terminal_local_map, Qnil);
11864 specbind (Qoverriding_local_map, Qnil);
11867 if (!hooks_run)
11869 /* Run the Lucid hook. */
11870 safe_run_hooks (Qactivate_menubar_hook);
11872 /* If it has changed current-menubar from previous value,
11873 really recompute the menu-bar from the value. */
11874 if (! NILP (Vlucid_menu_bar_dirty_flag))
11875 call0 (Qrecompute_lucid_menubar);
11877 safe_run_hooks (Qmenu_bar_update_hook);
11879 hooks_run = 1;
11882 XSETFRAME (Vmenu_updating_frame, f);
11883 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11885 /* Redisplay the menu bar in case we changed it. */
11886 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11887 || defined (HAVE_NS) || defined (USE_GTK)
11888 if (FRAME_WINDOW_P (f))
11890 #if defined (HAVE_NS)
11891 /* All frames on Mac OS share the same menubar. So only
11892 the selected frame should be allowed to set it. */
11893 if (f == SELECTED_FRAME ())
11894 #endif
11895 set_frame_menubar (f, 0, 0);
11897 else
11898 /* On a terminal screen, the menu bar is an ordinary screen
11899 line, and this makes it get updated. */
11900 w->update_mode_line = 1;
11901 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11902 /* In the non-toolkit version, the menu bar is an ordinary screen
11903 line, and this makes it get updated. */
11904 w->update_mode_line = 1;
11905 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11907 unbind_to (count, Qnil);
11908 set_buffer_internal_1 (prev);
11912 return hooks_run;
11915 /***********************************************************************
11916 Tool-bars
11917 ***********************************************************************/
11919 #ifdef HAVE_WINDOW_SYSTEM
11921 /* Select `frame' temporarily without running all the code in
11922 do_switch_frame.
11923 FIXME: Maybe do_switch_frame should be trimmed down similarly
11924 when `norecord' is set. */
11925 static void
11926 fast_set_selected_frame (Lisp_Object frame)
11928 if (!EQ (selected_frame, frame))
11930 selected_frame = frame;
11931 selected_window = XFRAME (frame)->selected_window;
11935 /* Update the tool-bar item list for frame F. This has to be done
11936 before we start to fill in any display lines. Called from
11937 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11938 and restore it here. */
11940 static void
11941 update_tool_bar (struct frame *f, int save_match_data)
11943 #if defined (USE_GTK) || defined (HAVE_NS)
11944 int do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11945 #else
11946 int do_update = (WINDOWP (f->tool_bar_window)
11947 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)) > 0);
11948 #endif
11950 if (do_update)
11952 Lisp_Object window;
11953 struct window *w;
11955 window = FRAME_SELECTED_WINDOW (f);
11956 w = XWINDOW (window);
11958 /* If the user has switched buffers or windows, we need to
11959 recompute to reflect the new bindings. But we'll
11960 recompute when update_mode_lines is set too; that means
11961 that people can use force-mode-line-update to request
11962 that the menu bar be recomputed. The adverse effect on
11963 the rest of the redisplay algorithm is about the same as
11964 windows_or_buffers_changed anyway. */
11965 if (windows_or_buffers_changed
11966 || w->update_mode_line
11967 || update_mode_lines
11968 || window_buffer_changed (w))
11970 struct buffer *prev = current_buffer;
11971 ptrdiff_t count = SPECPDL_INDEX ();
11972 Lisp_Object frame, new_tool_bar;
11973 int new_n_tool_bar;
11974 struct gcpro gcpro1;
11976 /* Set current_buffer to the buffer of the selected
11977 window of the frame, so that we get the right local
11978 keymaps. */
11979 set_buffer_internal_1 (XBUFFER (w->contents));
11981 /* Save match data, if we must. */
11982 if (save_match_data)
11983 record_unwind_save_match_data ();
11985 /* Make sure that we don't accidentally use bogus keymaps. */
11986 if (NILP (Voverriding_local_map_menu_flag))
11988 specbind (Qoverriding_terminal_local_map, Qnil);
11989 specbind (Qoverriding_local_map, Qnil);
11992 GCPRO1 (new_tool_bar);
11994 /* We must temporarily set the selected frame to this frame
11995 before calling tool_bar_items, because the calculation of
11996 the tool-bar keymap uses the selected frame (see
11997 `tool-bar-make-keymap' in tool-bar.el). */
11998 eassert (EQ (selected_window,
11999 /* Since we only explicitly preserve selected_frame,
12000 check that selected_window would be redundant. */
12001 XFRAME (selected_frame)->selected_window));
12002 record_unwind_protect (fast_set_selected_frame, selected_frame);
12003 XSETFRAME (frame, f);
12004 fast_set_selected_frame (frame);
12006 /* Build desired tool-bar items from keymaps. */
12007 new_tool_bar
12008 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
12009 &new_n_tool_bar);
12011 /* Redisplay the tool-bar if we changed it. */
12012 if (new_n_tool_bar != f->n_tool_bar_items
12013 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
12015 /* Redisplay that happens asynchronously due to an expose event
12016 may access f->tool_bar_items. Make sure we update both
12017 variables within BLOCK_INPUT so no such event interrupts. */
12018 block_input ();
12019 fset_tool_bar_items (f, new_tool_bar);
12020 f->n_tool_bar_items = new_n_tool_bar;
12021 w->update_mode_line = 1;
12022 unblock_input ();
12025 UNGCPRO;
12027 unbind_to (count, Qnil);
12028 set_buffer_internal_1 (prev);
12033 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12035 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12036 F's desired tool-bar contents. F->tool_bar_items must have
12037 been set up previously by calling prepare_menu_bars. */
12039 static void
12040 build_desired_tool_bar_string (struct frame *f)
12042 int i, size, size_needed;
12043 struct gcpro gcpro1, gcpro2;
12044 Lisp_Object image, plist;
12046 image = plist = Qnil;
12047 GCPRO2 (image, plist);
12049 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12050 Otherwise, make a new string. */
12052 /* The size of the string we might be able to reuse. */
12053 size = (STRINGP (f->desired_tool_bar_string)
12054 ? SCHARS (f->desired_tool_bar_string)
12055 : 0);
12057 /* We need one space in the string for each image. */
12058 size_needed = f->n_tool_bar_items;
12060 /* Reuse f->desired_tool_bar_string, if possible. */
12061 if (size < size_needed || NILP (f->desired_tool_bar_string))
12062 fset_desired_tool_bar_string
12063 (f, Fmake_string (make_number (size_needed), make_number (' ')));
12064 else
12066 AUTO_LIST4 (props, Qdisplay, Qnil, Qmenu_item, Qnil);
12067 struct gcpro gcpro1;
12068 GCPRO1 (props);
12069 Fremove_text_properties (make_number (0), make_number (size),
12070 props, f->desired_tool_bar_string);
12071 UNGCPRO;
12074 /* Put a `display' property on the string for the images to display,
12075 put a `menu_item' property on tool-bar items with a value that
12076 is the index of the item in F's tool-bar item vector. */
12077 for (i = 0; i < f->n_tool_bar_items; ++i)
12079 #define PROP(IDX) \
12080 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12082 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
12083 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
12084 int hmargin, vmargin, relief, idx, end;
12086 /* If image is a vector, choose the image according to the
12087 button state. */
12088 image = PROP (TOOL_BAR_ITEM_IMAGES);
12089 if (VECTORP (image))
12091 if (enabled_p)
12092 idx = (selected_p
12093 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12094 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
12095 else
12096 idx = (selected_p
12097 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12098 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
12100 eassert (ASIZE (image) >= idx);
12101 image = AREF (image, idx);
12103 else
12104 idx = -1;
12106 /* Ignore invalid image specifications. */
12107 if (!valid_image_p (image))
12108 continue;
12110 /* Display the tool-bar button pressed, or depressed. */
12111 plist = Fcopy_sequence (XCDR (image));
12113 /* Compute margin and relief to draw. */
12114 relief = (tool_bar_button_relief >= 0
12115 ? tool_bar_button_relief
12116 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12117 hmargin = vmargin = relief;
12119 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12120 INT_MAX - max (hmargin, vmargin)))
12122 hmargin += XFASTINT (Vtool_bar_button_margin);
12123 vmargin += XFASTINT (Vtool_bar_button_margin);
12125 else if (CONSP (Vtool_bar_button_margin))
12127 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12128 INT_MAX - hmargin))
12129 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12131 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12132 INT_MAX - vmargin))
12133 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12136 if (auto_raise_tool_bar_buttons_p)
12138 /* Add a `:relief' property to the image spec if the item is
12139 selected. */
12140 if (selected_p)
12142 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12143 hmargin -= relief;
12144 vmargin -= relief;
12147 else
12149 /* If image is selected, display it pressed, i.e. with a
12150 negative relief. If it's not selected, display it with a
12151 raised relief. */
12152 plist = Fplist_put (plist, QCrelief,
12153 (selected_p
12154 ? make_number (-relief)
12155 : make_number (relief)));
12156 hmargin -= relief;
12157 vmargin -= relief;
12160 /* Put a margin around the image. */
12161 if (hmargin || vmargin)
12163 if (hmargin == vmargin)
12164 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12165 else
12166 plist = Fplist_put (plist, QCmargin,
12167 Fcons (make_number (hmargin),
12168 make_number (vmargin)));
12171 /* If button is not enabled, and we don't have special images
12172 for the disabled state, make the image appear disabled by
12173 applying an appropriate algorithm to it. */
12174 if (!enabled_p && idx < 0)
12175 plist = Fplist_put (plist, QCconversion, Qdisabled);
12177 /* Put a `display' text property on the string for the image to
12178 display. Put a `menu-item' property on the string that gives
12179 the start of this item's properties in the tool-bar items
12180 vector. */
12181 image = Fcons (Qimage, plist);
12182 AUTO_LIST4 (props, Qdisplay, image, Qmenu_item,
12183 make_number (i * TOOL_BAR_ITEM_NSLOTS));
12184 struct gcpro gcpro1;
12185 GCPRO1 (props);
12187 /* Let the last image hide all remaining spaces in the tool bar
12188 string. The string can be longer than needed when we reuse a
12189 previous string. */
12190 if (i + 1 == f->n_tool_bar_items)
12191 end = SCHARS (f->desired_tool_bar_string);
12192 else
12193 end = i + 1;
12194 Fadd_text_properties (make_number (i), make_number (end),
12195 props, f->desired_tool_bar_string);
12196 UNGCPRO;
12197 #undef PROP
12200 UNGCPRO;
12204 /* Display one line of the tool-bar of frame IT->f.
12206 HEIGHT specifies the desired height of the tool-bar line.
12207 If the actual height of the glyph row is less than HEIGHT, the
12208 row's height is increased to HEIGHT, and the icons are centered
12209 vertically in the new height.
12211 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12212 count a final empty row in case the tool-bar width exactly matches
12213 the window width.
12216 static void
12217 display_tool_bar_line (struct it *it, int height)
12219 struct glyph_row *row = it->glyph_row;
12220 int max_x = it->last_visible_x;
12221 struct glyph *last;
12223 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12224 clear_glyph_row (row);
12225 row->enabled_p = true;
12226 row->y = it->current_y;
12228 /* Note that this isn't made use of if the face hasn't a box,
12229 so there's no need to check the face here. */
12230 it->start_of_box_run_p = 1;
12232 while (it->current_x < max_x)
12234 int x, n_glyphs_before, i, nglyphs;
12235 struct it it_before;
12237 /* Get the next display element. */
12238 if (!get_next_display_element (it))
12240 /* Don't count empty row if we are counting needed tool-bar lines. */
12241 if (height < 0 && !it->hpos)
12242 return;
12243 break;
12246 /* Produce glyphs. */
12247 n_glyphs_before = row->used[TEXT_AREA];
12248 it_before = *it;
12250 PRODUCE_GLYPHS (it);
12252 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12253 i = 0;
12254 x = it_before.current_x;
12255 while (i < nglyphs)
12257 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12259 if (x + glyph->pixel_width > max_x)
12261 /* Glyph doesn't fit on line. Backtrack. */
12262 row->used[TEXT_AREA] = n_glyphs_before;
12263 *it = it_before;
12264 /* If this is the only glyph on this line, it will never fit on the
12265 tool-bar, so skip it. But ensure there is at least one glyph,
12266 so we don't accidentally disable the tool-bar. */
12267 if (n_glyphs_before == 0
12268 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12269 break;
12270 goto out;
12273 ++it->hpos;
12274 x += glyph->pixel_width;
12275 ++i;
12278 /* Stop at line end. */
12279 if (ITERATOR_AT_END_OF_LINE_P (it))
12280 break;
12282 set_iterator_to_next (it, 1);
12285 out:;
12287 row->displays_text_p = row->used[TEXT_AREA] != 0;
12289 /* Use default face for the border below the tool bar.
12291 FIXME: When auto-resize-tool-bars is grow-only, there is
12292 no additional border below the possibly empty tool-bar lines.
12293 So to make the extra empty lines look "normal", we have to
12294 use the tool-bar face for the border too. */
12295 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12296 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12297 it->face_id = DEFAULT_FACE_ID;
12299 extend_face_to_end_of_line (it);
12300 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12301 last->right_box_line_p = 1;
12302 if (last == row->glyphs[TEXT_AREA])
12303 last->left_box_line_p = 1;
12305 /* Make line the desired height and center it vertically. */
12306 if ((height -= it->max_ascent + it->max_descent) > 0)
12308 /* Don't add more than one line height. */
12309 height %= FRAME_LINE_HEIGHT (it->f);
12310 it->max_ascent += height / 2;
12311 it->max_descent += (height + 1) / 2;
12314 compute_line_metrics (it);
12316 /* If line is empty, make it occupy the rest of the tool-bar. */
12317 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12319 row->height = row->phys_height = it->last_visible_y - row->y;
12320 row->visible_height = row->height;
12321 row->ascent = row->phys_ascent = 0;
12322 row->extra_line_spacing = 0;
12325 row->full_width_p = 1;
12326 row->continued_p = 0;
12327 row->truncated_on_left_p = 0;
12328 row->truncated_on_right_p = 0;
12330 it->current_x = it->hpos = 0;
12331 it->current_y += row->height;
12332 ++it->vpos;
12333 ++it->glyph_row;
12337 /* Value is the number of pixels needed to make all tool-bar items of
12338 frame F visible. The actual number of glyph rows needed is
12339 returned in *N_ROWS if non-NULL. */
12340 static int
12341 tool_bar_height (struct frame *f, int *n_rows, bool pixelwise)
12343 struct window *w = XWINDOW (f->tool_bar_window);
12344 struct it it;
12345 /* tool_bar_height is called from redisplay_tool_bar after building
12346 the desired matrix, so use (unused) mode-line row as temporary row to
12347 avoid destroying the first tool-bar row. */
12348 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
12350 /* Initialize an iterator for iteration over
12351 F->desired_tool_bar_string in the tool-bar window of frame F. */
12352 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
12353 temp_row->reversed_p = false;
12354 it.first_visible_x = 0;
12355 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12356 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12357 it.paragraph_embedding = L2R;
12359 while (!ITERATOR_AT_END_P (&it))
12361 clear_glyph_row (temp_row);
12362 it.glyph_row = temp_row;
12363 display_tool_bar_line (&it, -1);
12365 clear_glyph_row (temp_row);
12367 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12368 if (n_rows)
12369 *n_rows = it.vpos > 0 ? it.vpos : -1;
12371 if (pixelwise)
12372 return it.current_y;
12373 else
12374 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12377 #endif /* !USE_GTK && !HAVE_NS */
12379 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12380 0, 2, 0,
12381 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12382 If FRAME is nil or omitted, use the selected frame. Optional argument
12383 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12384 (Lisp_Object frame, Lisp_Object pixelwise)
12386 int height = 0;
12388 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12389 struct frame *f = decode_any_frame (frame);
12391 if (WINDOWP (f->tool_bar_window)
12392 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12394 update_tool_bar (f, 1);
12395 if (f->n_tool_bar_items)
12397 build_desired_tool_bar_string (f);
12398 height = tool_bar_height (f, NULL, NILP (pixelwise) ? 0 : 1);
12401 #endif
12403 return make_number (height);
12407 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12408 height should be changed. */
12409 static int
12410 redisplay_tool_bar (struct frame *f)
12412 #if defined (USE_GTK) || defined (HAVE_NS)
12414 if (FRAME_EXTERNAL_TOOL_BAR (f))
12415 update_frame_tool_bar (f);
12416 return 0;
12418 #else /* !USE_GTK && !HAVE_NS */
12420 struct window *w;
12421 struct it it;
12422 struct glyph_row *row;
12424 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12425 do anything. This means you must start with tool-bar-lines
12426 non-zero to get the auto-sizing effect. Or in other words, you
12427 can turn off tool-bars by specifying tool-bar-lines zero. */
12428 if (!WINDOWP (f->tool_bar_window)
12429 || (w = XWINDOW (f->tool_bar_window),
12430 WINDOW_TOTAL_LINES (w) == 0))
12431 return 0;
12433 /* Set up an iterator for the tool-bar window. */
12434 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12435 it.first_visible_x = 0;
12436 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12437 row = it.glyph_row;
12438 row->reversed_p = false;
12440 /* Build a string that represents the contents of the tool-bar. */
12441 build_desired_tool_bar_string (f);
12442 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12443 /* FIXME: This should be controlled by a user option. But it
12444 doesn't make sense to have an R2L tool bar if the menu bar cannot
12445 be drawn also R2L, and making the menu bar R2L is tricky due
12446 toolkit-specific code that implements it. If an R2L tool bar is
12447 ever supported, display_tool_bar_line should also be augmented to
12448 call unproduce_glyphs like display_line and display_string
12449 do. */
12450 it.paragraph_embedding = L2R;
12452 if (f->n_tool_bar_rows == 0)
12454 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, 1);
12456 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12458 x_change_tool_bar_height (f, new_height);
12459 /* Always do that now. */
12460 clear_glyph_matrix (w->desired_matrix);
12461 f->fonts_changed = 1;
12462 return 1;
12466 /* Display as many lines as needed to display all tool-bar items. */
12468 if (f->n_tool_bar_rows > 0)
12470 int border, rows, height, extra;
12472 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12473 border = XINT (Vtool_bar_border);
12474 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12475 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12476 else if (EQ (Vtool_bar_border, Qborder_width))
12477 border = f->border_width;
12478 else
12479 border = 0;
12480 if (border < 0)
12481 border = 0;
12483 rows = f->n_tool_bar_rows;
12484 height = max (1, (it.last_visible_y - border) / rows);
12485 extra = it.last_visible_y - border - height * rows;
12487 while (it.current_y < it.last_visible_y)
12489 int h = 0;
12490 if (extra > 0 && rows-- > 0)
12492 h = (extra + rows - 1) / rows;
12493 extra -= h;
12495 display_tool_bar_line (&it, height + h);
12498 else
12500 while (it.current_y < it.last_visible_y)
12501 display_tool_bar_line (&it, 0);
12504 /* It doesn't make much sense to try scrolling in the tool-bar
12505 window, so don't do it. */
12506 w->desired_matrix->no_scrolling_p = 1;
12507 w->must_be_updated_p = 1;
12509 if (!NILP (Vauto_resize_tool_bars))
12511 int change_height_p = 0;
12513 /* If we couldn't display everything, change the tool-bar's
12514 height if there is room for more. */
12515 if (IT_STRING_CHARPOS (it) < it.end_charpos)
12516 change_height_p = 1;
12518 /* We subtract 1 because display_tool_bar_line advances the
12519 glyph_row pointer before returning to its caller. We want to
12520 examine the last glyph row produced by
12521 display_tool_bar_line. */
12522 row = it.glyph_row - 1;
12524 /* If there are blank lines at the end, except for a partially
12525 visible blank line at the end that is smaller than
12526 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12527 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12528 && row->height >= FRAME_LINE_HEIGHT (f))
12529 change_height_p = 1;
12531 /* If row displays tool-bar items, but is partially visible,
12532 change the tool-bar's height. */
12533 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12534 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y)
12535 change_height_p = 1;
12537 /* Resize windows as needed by changing the `tool-bar-lines'
12538 frame parameter. */
12539 if (change_height_p)
12541 int nrows;
12542 int new_height = tool_bar_height (f, &nrows, 1);
12544 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12545 && !f->minimize_tool_bar_window_p)
12546 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12547 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12548 f->minimize_tool_bar_window_p = 0;
12550 if (change_height_p)
12552 x_change_tool_bar_height (f, new_height);
12553 clear_glyph_matrix (w->desired_matrix);
12554 f->n_tool_bar_rows = nrows;
12555 f->fonts_changed = 1;
12557 return 1;
12562 f->minimize_tool_bar_window_p = 0;
12563 return 0;
12565 #endif /* USE_GTK || HAVE_NS */
12568 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12570 /* Get information about the tool-bar item which is displayed in GLYPH
12571 on frame F. Return in *PROP_IDX the index where tool-bar item
12572 properties start in F->tool_bar_items. Value is zero if
12573 GLYPH doesn't display a tool-bar item. */
12575 static int
12576 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12578 Lisp_Object prop;
12579 int success_p;
12580 int charpos;
12582 /* This function can be called asynchronously, which means we must
12583 exclude any possibility that Fget_text_property signals an
12584 error. */
12585 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12586 charpos = max (0, charpos);
12588 /* Get the text property `menu-item' at pos. The value of that
12589 property is the start index of this item's properties in
12590 F->tool_bar_items. */
12591 prop = Fget_text_property (make_number (charpos),
12592 Qmenu_item, f->current_tool_bar_string);
12593 if (INTEGERP (prop))
12595 *prop_idx = XINT (prop);
12596 success_p = 1;
12598 else
12599 success_p = 0;
12601 return success_p;
12605 /* Get information about the tool-bar item at position X/Y on frame F.
12606 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12607 the current matrix of the tool-bar window of F, or NULL if not
12608 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12609 item in F->tool_bar_items. Value is
12611 -1 if X/Y is not on a tool-bar item
12612 0 if X/Y is on the same item that was highlighted before.
12613 1 otherwise. */
12615 static int
12616 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12617 int *hpos, int *vpos, int *prop_idx)
12619 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12620 struct window *w = XWINDOW (f->tool_bar_window);
12621 int area;
12623 /* Find the glyph under X/Y. */
12624 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12625 if (*glyph == NULL)
12626 return -1;
12628 /* Get the start of this tool-bar item's properties in
12629 f->tool_bar_items. */
12630 if (!tool_bar_item_info (f, *glyph, prop_idx))
12631 return -1;
12633 /* Is mouse on the highlighted item? */
12634 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12635 && *vpos >= hlinfo->mouse_face_beg_row
12636 && *vpos <= hlinfo->mouse_face_end_row
12637 && (*vpos > hlinfo->mouse_face_beg_row
12638 || *hpos >= hlinfo->mouse_face_beg_col)
12639 && (*vpos < hlinfo->mouse_face_end_row
12640 || *hpos < hlinfo->mouse_face_end_col
12641 || hlinfo->mouse_face_past_end))
12642 return 0;
12644 return 1;
12648 /* EXPORT:
12649 Handle mouse button event on the tool-bar of frame F, at
12650 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12651 0 for button release. MODIFIERS is event modifiers for button
12652 release. */
12654 void
12655 handle_tool_bar_click (struct frame *f, int x, int y, int down_p,
12656 int modifiers)
12658 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12659 struct window *w = XWINDOW (f->tool_bar_window);
12660 int hpos, vpos, prop_idx;
12661 struct glyph *glyph;
12662 Lisp_Object enabled_p;
12663 int ts;
12665 /* If not on the highlighted tool-bar item, and mouse-highlight is
12666 non-nil, return. This is so we generate the tool-bar button
12667 click only when the mouse button is released on the same item as
12668 where it was pressed. However, when mouse-highlight is disabled,
12669 generate the click when the button is released regardless of the
12670 highlight, since tool-bar items are not highlighted in that
12671 case. */
12672 frame_to_window_pixel_xy (w, &x, &y);
12673 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12674 if (ts == -1
12675 || (ts != 0 && !NILP (Vmouse_highlight)))
12676 return;
12678 /* When mouse-highlight is off, generate the click for the item
12679 where the button was pressed, disregarding where it was
12680 released. */
12681 if (NILP (Vmouse_highlight) && !down_p)
12682 prop_idx = f->last_tool_bar_item;
12684 /* If item is disabled, do nothing. */
12685 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12686 if (NILP (enabled_p))
12687 return;
12689 if (down_p)
12691 /* Show item in pressed state. */
12692 if (!NILP (Vmouse_highlight))
12693 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12694 f->last_tool_bar_item = prop_idx;
12696 else
12698 Lisp_Object key, frame;
12699 struct input_event event;
12700 EVENT_INIT (event);
12702 /* Show item in released state. */
12703 if (!NILP (Vmouse_highlight))
12704 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12706 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12708 XSETFRAME (frame, f);
12709 event.kind = TOOL_BAR_EVENT;
12710 event.frame_or_window = frame;
12711 event.arg = frame;
12712 kbd_buffer_store_event (&event);
12714 event.kind = TOOL_BAR_EVENT;
12715 event.frame_or_window = frame;
12716 event.arg = key;
12717 event.modifiers = modifiers;
12718 kbd_buffer_store_event (&event);
12719 f->last_tool_bar_item = -1;
12724 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12725 tool-bar window-relative coordinates X/Y. Called from
12726 note_mouse_highlight. */
12728 static void
12729 note_tool_bar_highlight (struct frame *f, int x, int y)
12731 Lisp_Object window = f->tool_bar_window;
12732 struct window *w = XWINDOW (window);
12733 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12734 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12735 int hpos, vpos;
12736 struct glyph *glyph;
12737 struct glyph_row *row;
12738 int i;
12739 Lisp_Object enabled_p;
12740 int prop_idx;
12741 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12742 int mouse_down_p, rc;
12744 /* Function note_mouse_highlight is called with negative X/Y
12745 values when mouse moves outside of the frame. */
12746 if (x <= 0 || y <= 0)
12748 clear_mouse_face (hlinfo);
12749 return;
12752 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12753 if (rc < 0)
12755 /* Not on tool-bar item. */
12756 clear_mouse_face (hlinfo);
12757 return;
12759 else if (rc == 0)
12760 /* On same tool-bar item as before. */
12761 goto set_help_echo;
12763 clear_mouse_face (hlinfo);
12765 /* Mouse is down, but on different tool-bar item? */
12766 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12767 && f == dpyinfo->last_mouse_frame);
12769 if (mouse_down_p && f->last_tool_bar_item != prop_idx)
12770 return;
12772 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12774 /* If tool-bar item is not enabled, don't highlight it. */
12775 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12776 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12778 /* Compute the x-position of the glyph. In front and past the
12779 image is a space. We include this in the highlighted area. */
12780 row = MATRIX_ROW (w->current_matrix, vpos);
12781 for (i = x = 0; i < hpos; ++i)
12782 x += row->glyphs[TEXT_AREA][i].pixel_width;
12784 /* Record this as the current active region. */
12785 hlinfo->mouse_face_beg_col = hpos;
12786 hlinfo->mouse_face_beg_row = vpos;
12787 hlinfo->mouse_face_beg_x = x;
12788 hlinfo->mouse_face_past_end = 0;
12790 hlinfo->mouse_face_end_col = hpos + 1;
12791 hlinfo->mouse_face_end_row = vpos;
12792 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12793 hlinfo->mouse_face_window = window;
12794 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12796 /* Display it as active. */
12797 show_mouse_face (hlinfo, draw);
12800 set_help_echo:
12802 /* Set help_echo_string to a help string to display for this tool-bar item.
12803 XTread_socket does the rest. */
12804 help_echo_object = help_echo_window = Qnil;
12805 help_echo_pos = -1;
12806 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12807 if (NILP (help_echo_string))
12808 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12811 #endif /* !USE_GTK && !HAVE_NS */
12813 #endif /* HAVE_WINDOW_SYSTEM */
12817 /************************************************************************
12818 Horizontal scrolling
12819 ************************************************************************/
12821 static int hscroll_window_tree (Lisp_Object);
12822 static int hscroll_windows (Lisp_Object);
12824 /* For all leaf windows in the window tree rooted at WINDOW, set their
12825 hscroll value so that PT is (i) visible in the window, and (ii) so
12826 that it is not within a certain margin at the window's left and
12827 right border. Value is non-zero if any window's hscroll has been
12828 changed. */
12830 static int
12831 hscroll_window_tree (Lisp_Object window)
12833 int hscrolled_p = 0;
12834 int hscroll_relative_p = FLOATP (Vhscroll_step);
12835 int hscroll_step_abs = 0;
12836 double hscroll_step_rel = 0;
12838 if (hscroll_relative_p)
12840 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12841 if (hscroll_step_rel < 0)
12843 hscroll_relative_p = 0;
12844 hscroll_step_abs = 0;
12847 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12849 hscroll_step_abs = XINT (Vhscroll_step);
12850 if (hscroll_step_abs < 0)
12851 hscroll_step_abs = 0;
12853 else
12854 hscroll_step_abs = 0;
12856 while (WINDOWP (window))
12858 struct window *w = XWINDOW (window);
12860 if (WINDOWP (w->contents))
12861 hscrolled_p |= hscroll_window_tree (w->contents);
12862 else if (w->cursor.vpos >= 0)
12864 int h_margin;
12865 int text_area_width;
12866 struct glyph_row *cursor_row;
12867 struct glyph_row *bottom_row;
12868 int row_r2l_p;
12870 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12871 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12872 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12873 else
12874 cursor_row = bottom_row - 1;
12876 if (!cursor_row->enabled_p)
12878 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12879 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12880 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12881 else
12882 cursor_row = bottom_row - 1;
12884 row_r2l_p = cursor_row->reversed_p;
12886 text_area_width = window_box_width (w, TEXT_AREA);
12888 /* Scroll when cursor is inside this scroll margin. */
12889 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12891 /* If the position of this window's point has explicitly
12892 changed, no more suspend auto hscrolling. */
12893 if (NILP (Fequal (Fwindow_point (window), Fwindow_old_point (window))))
12894 w->suspend_auto_hscroll = 0;
12896 /* Remember window point. */
12897 Fset_marker (w->old_pointm,
12898 ((w == XWINDOW (selected_window))
12899 ? make_number (BUF_PT (XBUFFER (w->contents)))
12900 : Fmarker_position (w->pointm)),
12901 w->contents);
12903 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12904 && w->suspend_auto_hscroll == 0
12905 /* In some pathological cases, like restoring a window
12906 configuration into a frame that is much smaller than
12907 the one from which the configuration was saved, we
12908 get glyph rows whose start and end have zero buffer
12909 positions, which we cannot handle below. Just skip
12910 such windows. */
12911 && CHARPOS (cursor_row->start.pos) >= BUF_BEG (w->contents)
12912 /* For left-to-right rows, hscroll when cursor is either
12913 (i) inside the right hscroll margin, or (ii) if it is
12914 inside the left margin and the window is already
12915 hscrolled. */
12916 && ((!row_r2l_p
12917 && ((w->hscroll && w->cursor.x <= h_margin)
12918 || (cursor_row->enabled_p
12919 && cursor_row->truncated_on_right_p
12920 && (w->cursor.x >= text_area_width - h_margin))))
12921 /* For right-to-left rows, the logic is similar,
12922 except that rules for scrolling to left and right
12923 are reversed. E.g., if cursor.x <= h_margin, we
12924 need to hscroll "to the right" unconditionally,
12925 and that will scroll the screen to the left so as
12926 to reveal the next portion of the row. */
12927 || (row_r2l_p
12928 && ((cursor_row->enabled_p
12929 /* FIXME: It is confusing to set the
12930 truncated_on_right_p flag when R2L rows
12931 are actually truncated on the left. */
12932 && cursor_row->truncated_on_right_p
12933 && w->cursor.x <= h_margin)
12934 || (w->hscroll
12935 && (w->cursor.x >= text_area_width - h_margin))))))
12937 struct it it;
12938 ptrdiff_t hscroll;
12939 struct buffer *saved_current_buffer;
12940 ptrdiff_t pt;
12941 int wanted_x;
12943 /* Find point in a display of infinite width. */
12944 saved_current_buffer = current_buffer;
12945 current_buffer = XBUFFER (w->contents);
12947 if (w == XWINDOW (selected_window))
12948 pt = PT;
12949 else
12950 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
12952 /* Move iterator to pt starting at cursor_row->start in
12953 a line with infinite width. */
12954 init_to_row_start (&it, w, cursor_row);
12955 it.last_visible_x = INFINITY;
12956 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12957 current_buffer = saved_current_buffer;
12959 /* Position cursor in window. */
12960 if (!hscroll_relative_p && hscroll_step_abs == 0)
12961 hscroll = max (0, (it.current_x
12962 - (ITERATOR_AT_END_OF_LINE_P (&it)
12963 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12964 : (text_area_width / 2))))
12965 / FRAME_COLUMN_WIDTH (it.f);
12966 else if ((!row_r2l_p
12967 && w->cursor.x >= text_area_width - h_margin)
12968 || (row_r2l_p && w->cursor.x <= h_margin))
12970 if (hscroll_relative_p)
12971 wanted_x = text_area_width * (1 - hscroll_step_rel)
12972 - h_margin;
12973 else
12974 wanted_x = text_area_width
12975 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12976 - h_margin;
12977 hscroll
12978 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12980 else
12982 if (hscroll_relative_p)
12983 wanted_x = text_area_width * hscroll_step_rel
12984 + h_margin;
12985 else
12986 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
12987 + h_margin;
12988 hscroll
12989 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
12991 hscroll = max (hscroll, w->min_hscroll);
12993 /* Don't prevent redisplay optimizations if hscroll
12994 hasn't changed, as it will unnecessarily slow down
12995 redisplay. */
12996 if (w->hscroll != hscroll)
12998 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
12999 w->hscroll = hscroll;
13000 hscrolled_p = 1;
13005 window = w->next;
13008 /* Value is non-zero if hscroll of any leaf window has been changed. */
13009 return hscrolled_p;
13013 /* Set hscroll so that cursor is visible and not inside horizontal
13014 scroll margins for all windows in the tree rooted at WINDOW. See
13015 also hscroll_window_tree above. Value is non-zero if any window's
13016 hscroll has been changed. If it has, desired matrices on the frame
13017 of WINDOW are cleared. */
13019 static int
13020 hscroll_windows (Lisp_Object window)
13022 int hscrolled_p = hscroll_window_tree (window);
13023 if (hscrolled_p)
13024 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
13025 return hscrolled_p;
13030 /************************************************************************
13031 Redisplay
13032 ************************************************************************/
13034 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13035 to a non-zero value. This is sometimes handy to have in a debugger
13036 session. */
13038 #ifdef GLYPH_DEBUG
13040 /* First and last unchanged row for try_window_id. */
13042 static int debug_first_unchanged_at_end_vpos;
13043 static int debug_last_unchanged_at_beg_vpos;
13045 /* Delta vpos and y. */
13047 static int debug_dvpos, debug_dy;
13049 /* Delta in characters and bytes for try_window_id. */
13051 static ptrdiff_t debug_delta, debug_delta_bytes;
13053 /* Values of window_end_pos and window_end_vpos at the end of
13054 try_window_id. */
13056 static ptrdiff_t debug_end_vpos;
13058 /* Append a string to W->desired_matrix->method. FMT is a printf
13059 format string. If trace_redisplay_p is true also printf the
13060 resulting string to stderr. */
13062 static void debug_method_add (struct window *, char const *, ...)
13063 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13065 static void
13066 debug_method_add (struct window *w, char const *fmt, ...)
13068 void *ptr = w;
13069 char *method = w->desired_matrix->method;
13070 int len = strlen (method);
13071 int size = sizeof w->desired_matrix->method;
13072 int remaining = size - len - 1;
13073 va_list ap;
13075 if (len && remaining)
13077 method[len] = '|';
13078 --remaining, ++len;
13081 va_start (ap, fmt);
13082 vsnprintf (method + len, remaining + 1, fmt, ap);
13083 va_end (ap);
13085 if (trace_redisplay_p)
13086 fprintf (stderr, "%p (%s): %s\n",
13087 ptr,
13088 ((BUFFERP (w->contents)
13089 && STRINGP (BVAR (XBUFFER (w->contents), name)))
13090 ? SSDATA (BVAR (XBUFFER (w->contents), name))
13091 : "no buffer"),
13092 method + len);
13095 #endif /* GLYPH_DEBUG */
13098 /* Value is non-zero if all changes in window W, which displays
13099 current_buffer, are in the text between START and END. START is a
13100 buffer position, END is given as a distance from Z. Used in
13101 redisplay_internal for display optimization. */
13103 static int
13104 text_outside_line_unchanged_p (struct window *w,
13105 ptrdiff_t start, ptrdiff_t end)
13107 int unchanged_p = 1;
13109 /* If text or overlays have changed, see where. */
13110 if (window_outdated (w))
13112 /* Gap in the line? */
13113 if (GPT < start || Z - GPT < end)
13114 unchanged_p = 0;
13116 /* Changes start in front of the line, or end after it? */
13117 if (unchanged_p
13118 && (BEG_UNCHANGED < start - 1
13119 || END_UNCHANGED < end))
13120 unchanged_p = 0;
13122 /* If selective display, can't optimize if changes start at the
13123 beginning of the line. */
13124 if (unchanged_p
13125 && INTEGERP (BVAR (current_buffer, selective_display))
13126 && XINT (BVAR (current_buffer, selective_display)) > 0
13127 && (BEG_UNCHANGED < start || GPT <= start))
13128 unchanged_p = 0;
13130 /* If there are overlays at the start or end of the line, these
13131 may have overlay strings with newlines in them. A change at
13132 START, for instance, may actually concern the display of such
13133 overlay strings as well, and they are displayed on different
13134 lines. So, quickly rule out this case. (For the future, it
13135 might be desirable to implement something more telling than
13136 just BEG/END_UNCHANGED.) */
13137 if (unchanged_p)
13139 if (BEG + BEG_UNCHANGED == start
13140 && overlay_touches_p (start))
13141 unchanged_p = 0;
13142 if (END_UNCHANGED == end
13143 && overlay_touches_p (Z - end))
13144 unchanged_p = 0;
13147 /* Under bidi reordering, adding or deleting a character in the
13148 beginning of a paragraph, before the first strong directional
13149 character, can change the base direction of the paragraph (unless
13150 the buffer specifies a fixed paragraph direction), which will
13151 require to redisplay the whole paragraph. It might be worthwhile
13152 to find the paragraph limits and widen the range of redisplayed
13153 lines to that, but for now just give up this optimization. */
13154 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13155 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13156 unchanged_p = 0;
13159 return unchanged_p;
13163 /* Do a frame update, taking possible shortcuts into account. This is
13164 the main external entry point for redisplay.
13166 If the last redisplay displayed an echo area message and that message
13167 is no longer requested, we clear the echo area or bring back the
13168 mini-buffer if that is in use. */
13170 void
13171 redisplay (void)
13173 redisplay_internal ();
13177 static Lisp_Object
13178 overlay_arrow_string_or_property (Lisp_Object var)
13180 Lisp_Object val;
13182 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13183 return val;
13185 return Voverlay_arrow_string;
13188 /* Return 1 if there are any overlay-arrows in current_buffer. */
13189 static int
13190 overlay_arrow_in_current_buffer_p (void)
13192 Lisp_Object vlist;
13194 for (vlist = Voverlay_arrow_variable_list;
13195 CONSP (vlist);
13196 vlist = XCDR (vlist))
13198 Lisp_Object var = XCAR (vlist);
13199 Lisp_Object val;
13201 if (!SYMBOLP (var))
13202 continue;
13203 val = find_symbol_value (var);
13204 if (MARKERP (val)
13205 && current_buffer == XMARKER (val)->buffer)
13206 return 1;
13208 return 0;
13212 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13213 has changed. */
13215 static int
13216 overlay_arrows_changed_p (void)
13218 Lisp_Object vlist;
13220 for (vlist = Voverlay_arrow_variable_list;
13221 CONSP (vlist);
13222 vlist = XCDR (vlist))
13224 Lisp_Object var = XCAR (vlist);
13225 Lisp_Object val, pstr;
13227 if (!SYMBOLP (var))
13228 continue;
13229 val = find_symbol_value (var);
13230 if (!MARKERP (val))
13231 continue;
13232 if (! EQ (COERCE_MARKER (val),
13233 Fget (var, Qlast_arrow_position))
13234 || ! (pstr = overlay_arrow_string_or_property (var),
13235 EQ (pstr, Fget (var, Qlast_arrow_string))))
13236 return 1;
13238 return 0;
13241 /* Mark overlay arrows to be updated on next redisplay. */
13243 static void
13244 update_overlay_arrows (int up_to_date)
13246 Lisp_Object vlist;
13248 for (vlist = Voverlay_arrow_variable_list;
13249 CONSP (vlist);
13250 vlist = XCDR (vlist))
13252 Lisp_Object var = XCAR (vlist);
13254 if (!SYMBOLP (var))
13255 continue;
13257 if (up_to_date > 0)
13259 Lisp_Object val = find_symbol_value (var);
13260 Fput (var, Qlast_arrow_position,
13261 COERCE_MARKER (val));
13262 Fput (var, Qlast_arrow_string,
13263 overlay_arrow_string_or_property (var));
13265 else if (up_to_date < 0
13266 || !NILP (Fget (var, Qlast_arrow_position)))
13268 Fput (var, Qlast_arrow_position, Qt);
13269 Fput (var, Qlast_arrow_string, Qt);
13275 /* Return overlay arrow string to display at row.
13276 Return integer (bitmap number) for arrow bitmap in left fringe.
13277 Return nil if no overlay arrow. */
13279 static Lisp_Object
13280 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13282 Lisp_Object vlist;
13284 for (vlist = Voverlay_arrow_variable_list;
13285 CONSP (vlist);
13286 vlist = XCDR (vlist))
13288 Lisp_Object var = XCAR (vlist);
13289 Lisp_Object val;
13291 if (!SYMBOLP (var))
13292 continue;
13294 val = find_symbol_value (var);
13296 if (MARKERP (val)
13297 && current_buffer == XMARKER (val)->buffer
13298 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13300 if (FRAME_WINDOW_P (it->f)
13301 /* FIXME: if ROW->reversed_p is set, this should test
13302 the right fringe, not the left one. */
13303 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13305 #ifdef HAVE_WINDOW_SYSTEM
13306 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13308 int fringe_bitmap;
13309 if ((fringe_bitmap = lookup_fringe_bitmap (val)) != 0)
13310 return make_number (fringe_bitmap);
13312 #endif
13313 return make_number (-1); /* Use default arrow bitmap. */
13315 return overlay_arrow_string_or_property (var);
13319 return Qnil;
13322 /* Return 1 if point moved out of or into a composition. Otherwise
13323 return 0. PREV_BUF and PREV_PT are the last point buffer and
13324 position. BUF and PT are the current point buffer and position. */
13326 static int
13327 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13328 struct buffer *buf, ptrdiff_t pt)
13330 ptrdiff_t start, end;
13331 Lisp_Object prop;
13332 Lisp_Object buffer;
13334 XSETBUFFER (buffer, buf);
13335 /* Check a composition at the last point if point moved within the
13336 same buffer. */
13337 if (prev_buf == buf)
13339 if (prev_pt == pt)
13340 /* Point didn't move. */
13341 return 0;
13343 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13344 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13345 && composition_valid_p (start, end, prop)
13346 && start < prev_pt && end > prev_pt)
13347 /* The last point was within the composition. Return 1 iff
13348 point moved out of the composition. */
13349 return (pt <= start || pt >= end);
13352 /* Check a composition at the current point. */
13353 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13354 && find_composition (pt, -1, &start, &end, &prop, buffer)
13355 && composition_valid_p (start, end, prop)
13356 && start < pt && end > pt);
13359 /* Reconsider the clip changes of buffer which is displayed in W. */
13361 static void
13362 reconsider_clip_changes (struct window *w)
13364 struct buffer *b = XBUFFER (w->contents);
13366 if (b->clip_changed
13367 && w->window_end_valid
13368 && w->current_matrix->buffer == b
13369 && w->current_matrix->zv == BUF_ZV (b)
13370 && w->current_matrix->begv == BUF_BEGV (b))
13371 b->clip_changed = 0;
13373 /* If display wasn't paused, and W is not a tool bar window, see if
13374 point has been moved into or out of a composition. In that case,
13375 we set b->clip_changed to 1 to force updating the screen. If
13376 b->clip_changed has already been set to 1, we can skip this
13377 check. */
13378 if (!b->clip_changed && w->window_end_valid)
13380 ptrdiff_t pt = (w == XWINDOW (selected_window)
13381 ? PT : marker_position (w->pointm));
13383 if ((w->current_matrix->buffer != b || pt != w->last_point)
13384 && check_point_in_composition (w->current_matrix->buffer,
13385 w->last_point, b, pt))
13386 b->clip_changed = 1;
13390 static void
13391 propagate_buffer_redisplay (void)
13392 { /* Resetting b->text->redisplay is problematic!
13393 We can't just reset it in the case that some window that displays
13394 it has not been redisplayed; and such a window can stay
13395 unredisplayed for a long time if it's currently invisible.
13396 But we do want to reset it at the end of redisplay otherwise
13397 its displayed windows will keep being redisplayed over and over
13398 again.
13399 So we copy all b->text->redisplay flags up to their windows here,
13400 such that mark_window_display_accurate can safely reset
13401 b->text->redisplay. */
13402 Lisp_Object ws = window_list ();
13403 for (; CONSP (ws); ws = XCDR (ws))
13405 struct window *thisw = XWINDOW (XCAR (ws));
13406 struct buffer *thisb = XBUFFER (thisw->contents);
13407 if (thisb->text->redisplay)
13408 thisw->redisplay = true;
13412 #define STOP_POLLING \
13413 do { if (! polling_stopped_here) stop_polling (); \
13414 polling_stopped_here = 1; } while (0)
13416 #define RESUME_POLLING \
13417 do { if (polling_stopped_here) start_polling (); \
13418 polling_stopped_here = 0; } while (0)
13421 /* Perhaps in the future avoid recentering windows if it
13422 is not necessary; currently that causes some problems. */
13424 static void
13425 redisplay_internal (void)
13427 struct window *w = XWINDOW (selected_window);
13428 struct window *sw;
13429 struct frame *fr;
13430 int pending;
13431 bool must_finish = 0, match_p;
13432 struct text_pos tlbufpos, tlendpos;
13433 int number_of_visible_frames;
13434 ptrdiff_t count;
13435 struct frame *sf;
13436 int polling_stopped_here = 0;
13437 Lisp_Object tail, frame;
13439 /* True means redisplay has to consider all windows on all
13440 frames. False, only selected_window is considered. */
13441 bool consider_all_windows_p;
13443 /* True means redisplay has to redisplay the miniwindow. */
13444 bool update_miniwindow_p = false;
13446 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13448 /* No redisplay if running in batch mode or frame is not yet fully
13449 initialized, or redisplay is explicitly turned off by setting
13450 Vinhibit_redisplay. */
13451 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13452 || !NILP (Vinhibit_redisplay))
13453 return;
13455 /* Don't examine these until after testing Vinhibit_redisplay.
13456 When Emacs is shutting down, perhaps because its connection to
13457 X has dropped, we should not look at them at all. */
13458 fr = XFRAME (w->frame);
13459 sf = SELECTED_FRAME ();
13461 if (!fr->glyphs_initialized_p)
13462 return;
13464 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13465 if (popup_activated ())
13466 return;
13467 #endif
13469 /* I don't think this happens but let's be paranoid. */
13470 if (redisplaying_p)
13471 return;
13473 /* Record a function that clears redisplaying_p
13474 when we leave this function. */
13475 count = SPECPDL_INDEX ();
13476 record_unwind_protect_void (unwind_redisplay);
13477 redisplaying_p = 1;
13478 specbind (Qinhibit_free_realized_faces, Qnil);
13480 /* Record this function, so it appears on the profiler's backtraces. */
13481 record_in_backtrace (Qredisplay_internal, &Qnil, 0);
13483 FOR_EACH_FRAME (tail, frame)
13484 XFRAME (frame)->already_hscrolled_p = 0;
13486 retry:
13487 /* Remember the currently selected window. */
13488 sw = w;
13490 pending = 0;
13491 last_escape_glyph_frame = NULL;
13492 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
13493 last_glyphless_glyph_frame = NULL;
13494 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
13496 /* If face_change_count is non-zero, init_iterator will free all
13497 realized faces, which includes the faces referenced from current
13498 matrices. So, we can't reuse current matrices in this case. */
13499 if (face_change_count)
13500 windows_or_buffers_changed = 47;
13502 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13503 && FRAME_TTY (sf)->previous_frame != sf)
13505 /* Since frames on a single ASCII terminal share the same
13506 display area, displaying a different frame means redisplay
13507 the whole thing. */
13508 SET_FRAME_GARBAGED (sf);
13509 #ifndef DOS_NT
13510 set_tty_color_mode (FRAME_TTY (sf), sf);
13511 #endif
13512 FRAME_TTY (sf)->previous_frame = sf;
13515 /* Set the visible flags for all frames. Do this before checking for
13516 resized or garbaged frames; they want to know if their frames are
13517 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13518 number_of_visible_frames = 0;
13520 FOR_EACH_FRAME (tail, frame)
13522 struct frame *f = XFRAME (frame);
13524 if (FRAME_VISIBLE_P (f))
13526 ++number_of_visible_frames;
13527 /* Adjust matrices for visible frames only. */
13528 if (f->fonts_changed)
13530 adjust_frame_glyphs (f);
13531 f->fonts_changed = 0;
13533 /* If cursor type has been changed on the frame
13534 other than selected, consider all frames. */
13535 if (f != sf && f->cursor_type_changed)
13536 update_mode_lines = 31;
13538 clear_desired_matrices (f);
13541 /* Notice any pending interrupt request to change frame size. */
13542 do_pending_window_change (1);
13544 /* do_pending_window_change could change the selected_window due to
13545 frame resizing which makes the selected window too small. */
13546 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13547 sw = w;
13549 /* Clear frames marked as garbaged. */
13550 clear_garbaged_frames ();
13552 /* Build menubar and tool-bar items. */
13553 if (NILP (Vmemory_full))
13554 prepare_menu_bars ();
13556 reconsider_clip_changes (w);
13558 /* In most cases selected window displays current buffer. */
13559 match_p = XBUFFER (w->contents) == current_buffer;
13560 if (match_p)
13562 /* Detect case that we need to write or remove a star in the mode line. */
13563 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13564 w->update_mode_line = 1;
13566 if (mode_line_update_needed (w))
13567 w->update_mode_line = 1;
13569 /* If reconsider_clip_changes above decided that the narrowing
13570 in the current buffer changed, make sure all other windows
13571 showing that buffer will be redisplayed. */
13572 if (current_buffer->clip_changed)
13573 bset_update_mode_line (current_buffer);
13576 /* Normally the message* functions will have already displayed and
13577 updated the echo area, but the frame may have been trashed, or
13578 the update may have been preempted, so display the echo area
13579 again here. Checking message_cleared_p captures the case that
13580 the echo area should be cleared. */
13581 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13582 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13583 || (message_cleared_p
13584 && minibuf_level == 0
13585 /* If the mini-window is currently selected, this means the
13586 echo-area doesn't show through. */
13587 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13589 int window_height_changed_p = echo_area_display (0);
13591 if (message_cleared_p)
13592 update_miniwindow_p = true;
13594 must_finish = 1;
13596 /* If we don't display the current message, don't clear the
13597 message_cleared_p flag, because, if we did, we wouldn't clear
13598 the echo area in the next redisplay which doesn't preserve
13599 the echo area. */
13600 if (!display_last_displayed_message_p)
13601 message_cleared_p = 0;
13603 if (window_height_changed_p)
13605 windows_or_buffers_changed = 50;
13607 /* If window configuration was changed, frames may have been
13608 marked garbaged. Clear them or we will experience
13609 surprises wrt scrolling. */
13610 clear_garbaged_frames ();
13613 else if (EQ (selected_window, minibuf_window)
13614 && (current_buffer->clip_changed || window_outdated (w))
13615 && resize_mini_window (w, 0))
13617 /* Resized active mini-window to fit the size of what it is
13618 showing if its contents might have changed. */
13619 must_finish = 1;
13621 /* If window configuration was changed, frames may have been
13622 marked garbaged. Clear them or we will experience
13623 surprises wrt scrolling. */
13624 clear_garbaged_frames ();
13627 if (windows_or_buffers_changed && !update_mode_lines)
13628 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13629 only the windows's contents needs to be refreshed, or whether the
13630 mode-lines also need a refresh. */
13631 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13632 ? REDISPLAY_SOME : 32);
13634 /* If specs for an arrow have changed, do thorough redisplay
13635 to ensure we remove any arrow that should no longer exist. */
13636 if (overlay_arrows_changed_p ())
13637 /* Apparently, this is the only case where we update other windows,
13638 without updating other mode-lines. */
13639 windows_or_buffers_changed = 49;
13641 consider_all_windows_p = (update_mode_lines
13642 || windows_or_buffers_changed);
13644 #define AINC(a,i) \
13645 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13646 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13648 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13649 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13651 /* Optimize the case that only the line containing the cursor in the
13652 selected window has changed. Variables starting with this_ are
13653 set in display_line and record information about the line
13654 containing the cursor. */
13655 tlbufpos = this_line_start_pos;
13656 tlendpos = this_line_end_pos;
13657 if (!consider_all_windows_p
13658 && CHARPOS (tlbufpos) > 0
13659 && !w->update_mode_line
13660 && !current_buffer->clip_changed
13661 && !current_buffer->prevent_redisplay_optimizations_p
13662 && FRAME_VISIBLE_P (XFRAME (w->frame))
13663 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13664 && !XFRAME (w->frame)->cursor_type_changed
13665 /* Make sure recorded data applies to current buffer, etc. */
13666 && this_line_buffer == current_buffer
13667 && match_p
13668 && !w->force_start
13669 && !w->optional_new_start
13670 /* Point must be on the line that we have info recorded about. */
13671 && PT >= CHARPOS (tlbufpos)
13672 && PT <= Z - CHARPOS (tlendpos)
13673 /* All text outside that line, including its final newline,
13674 must be unchanged. */
13675 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13676 CHARPOS (tlendpos)))
13678 if (CHARPOS (tlbufpos) > BEGV
13679 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13680 && (CHARPOS (tlbufpos) == ZV
13681 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13682 /* Former continuation line has disappeared by becoming empty. */
13683 goto cancel;
13684 else if (window_outdated (w) || MINI_WINDOW_P (w))
13686 /* We have to handle the case of continuation around a
13687 wide-column character (see the comment in indent.c around
13688 line 1340).
13690 For instance, in the following case:
13692 -------- Insert --------
13693 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13694 J_I_ ==> J_I_ `^^' are cursors.
13695 ^^ ^^
13696 -------- --------
13698 As we have to redraw the line above, we cannot use this
13699 optimization. */
13701 struct it it;
13702 int line_height_before = this_line_pixel_height;
13704 /* Note that start_display will handle the case that the
13705 line starting at tlbufpos is a continuation line. */
13706 start_display (&it, w, tlbufpos);
13708 /* Implementation note: It this still necessary? */
13709 if (it.current_x != this_line_start_x)
13710 goto cancel;
13712 TRACE ((stderr, "trying display optimization 1\n"));
13713 w->cursor.vpos = -1;
13714 overlay_arrow_seen = 0;
13715 it.vpos = this_line_vpos;
13716 it.current_y = this_line_y;
13717 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13718 display_line (&it);
13720 /* If line contains point, is not continued,
13721 and ends at same distance from eob as before, we win. */
13722 if (w->cursor.vpos >= 0
13723 /* Line is not continued, otherwise this_line_start_pos
13724 would have been set to 0 in display_line. */
13725 && CHARPOS (this_line_start_pos)
13726 /* Line ends as before. */
13727 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13728 /* Line has same height as before. Otherwise other lines
13729 would have to be shifted up or down. */
13730 && this_line_pixel_height == line_height_before)
13732 /* If this is not the window's last line, we must adjust
13733 the charstarts of the lines below. */
13734 if (it.current_y < it.last_visible_y)
13736 struct glyph_row *row
13737 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13738 ptrdiff_t delta, delta_bytes;
13740 /* We used to distinguish between two cases here,
13741 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13742 when the line ends in a newline or the end of the
13743 buffer's accessible portion. But both cases did
13744 the same, so they were collapsed. */
13745 delta = (Z
13746 - CHARPOS (tlendpos)
13747 - MATRIX_ROW_START_CHARPOS (row));
13748 delta_bytes = (Z_BYTE
13749 - BYTEPOS (tlendpos)
13750 - MATRIX_ROW_START_BYTEPOS (row));
13752 increment_matrix_positions (w->current_matrix,
13753 this_line_vpos + 1,
13754 w->current_matrix->nrows,
13755 delta, delta_bytes);
13758 /* If this row displays text now but previously didn't,
13759 or vice versa, w->window_end_vpos may have to be
13760 adjusted. */
13761 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13763 if (w->window_end_vpos < this_line_vpos)
13764 w->window_end_vpos = this_line_vpos;
13766 else if (w->window_end_vpos == this_line_vpos
13767 && this_line_vpos > 0)
13768 w->window_end_vpos = this_line_vpos - 1;
13769 w->window_end_valid = 0;
13771 /* Update hint: No need to try to scroll in update_window. */
13772 w->desired_matrix->no_scrolling_p = 1;
13774 #ifdef GLYPH_DEBUG
13775 *w->desired_matrix->method = 0;
13776 debug_method_add (w, "optimization 1");
13777 #endif
13778 #ifdef HAVE_WINDOW_SYSTEM
13779 update_window_fringes (w, 0);
13780 #endif
13781 goto update;
13783 else
13784 goto cancel;
13786 else if (/* Cursor position hasn't changed. */
13787 PT == w->last_point
13788 /* Make sure the cursor was last displayed
13789 in this window. Otherwise we have to reposition it. */
13791 /* PXW: Must be converted to pixels, probably. */
13792 && 0 <= w->cursor.vpos
13793 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13795 if (!must_finish)
13797 do_pending_window_change (1);
13798 /* If selected_window changed, redisplay again. */
13799 if (WINDOWP (selected_window)
13800 && (w = XWINDOW (selected_window)) != sw)
13801 goto retry;
13803 /* We used to always goto end_of_redisplay here, but this
13804 isn't enough if we have a blinking cursor. */
13805 if (w->cursor_off_p == w->last_cursor_off_p)
13806 goto end_of_redisplay;
13808 goto update;
13810 /* If highlighting the region, or if the cursor is in the echo area,
13811 then we can't just move the cursor. */
13812 else if (NILP (Vshow_trailing_whitespace)
13813 && !cursor_in_echo_area)
13815 struct it it;
13816 struct glyph_row *row;
13818 /* Skip from tlbufpos to PT and see where it is. Note that
13819 PT may be in invisible text. If so, we will end at the
13820 next visible position. */
13821 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13822 NULL, DEFAULT_FACE_ID);
13823 it.current_x = this_line_start_x;
13824 it.current_y = this_line_y;
13825 it.vpos = this_line_vpos;
13827 /* The call to move_it_to stops in front of PT, but
13828 moves over before-strings. */
13829 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13831 if (it.vpos == this_line_vpos
13832 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13833 row->enabled_p))
13835 eassert (this_line_vpos == it.vpos);
13836 eassert (this_line_y == it.current_y);
13837 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13838 #ifdef GLYPH_DEBUG
13839 *w->desired_matrix->method = 0;
13840 debug_method_add (w, "optimization 3");
13841 #endif
13842 goto update;
13844 else
13845 goto cancel;
13848 cancel:
13849 /* Text changed drastically or point moved off of line. */
13850 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13853 CHARPOS (this_line_start_pos) = 0;
13854 ++clear_face_cache_count;
13855 #ifdef HAVE_WINDOW_SYSTEM
13856 ++clear_image_cache_count;
13857 #endif
13859 /* Build desired matrices, and update the display. If
13860 consider_all_windows_p is non-zero, do it for all windows on all
13861 frames. Otherwise do it for selected_window, only. */
13863 if (consider_all_windows_p)
13865 FOR_EACH_FRAME (tail, frame)
13866 XFRAME (frame)->updated_p = 0;
13868 propagate_buffer_redisplay ();
13870 FOR_EACH_FRAME (tail, frame)
13872 struct frame *f = XFRAME (frame);
13874 /* We don't have to do anything for unselected terminal
13875 frames. */
13876 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13877 && !EQ (FRAME_TTY (f)->top_frame, frame))
13878 continue;
13880 retry_frame:
13882 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13884 bool gcscrollbars
13885 /* Only GC scrollbars when we redisplay the whole frame. */
13886 = f->redisplay || !REDISPLAY_SOME_P ();
13887 /* Mark all the scroll bars to be removed; we'll redeem
13888 the ones we want when we redisplay their windows. */
13889 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13890 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13892 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13893 redisplay_windows (FRAME_ROOT_WINDOW (f));
13894 /* Remember that the invisible frames need to be redisplayed next
13895 time they're visible. */
13896 else if (!REDISPLAY_SOME_P ())
13897 f->redisplay = true;
13899 /* The X error handler may have deleted that frame. */
13900 if (!FRAME_LIVE_P (f))
13901 continue;
13903 /* Any scroll bars which redisplay_windows should have
13904 nuked should now go away. */
13905 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13906 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13908 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13910 /* If fonts changed on visible frame, display again. */
13911 if (f->fonts_changed)
13913 adjust_frame_glyphs (f);
13914 f->fonts_changed = 0;
13915 goto retry_frame;
13918 /* See if we have to hscroll. */
13919 if (!f->already_hscrolled_p)
13921 f->already_hscrolled_p = 1;
13922 if (hscroll_windows (f->root_window))
13923 goto retry_frame;
13926 /* Prevent various kinds of signals during display
13927 update. stdio is not robust about handling
13928 signals, which can cause an apparent I/O error. */
13929 if (interrupt_input)
13930 unrequest_sigio ();
13931 STOP_POLLING;
13933 pending |= update_frame (f, 0, 0);
13934 f->cursor_type_changed = 0;
13935 f->updated_p = 1;
13940 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
13942 if (!pending)
13944 /* Do the mark_window_display_accurate after all windows have
13945 been redisplayed because this call resets flags in buffers
13946 which are needed for proper redisplay. */
13947 FOR_EACH_FRAME (tail, frame)
13949 struct frame *f = XFRAME (frame);
13950 if (f->updated_p)
13952 f->redisplay = false;
13953 mark_window_display_accurate (f->root_window, 1);
13954 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13955 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13960 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13962 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13963 struct frame *mini_frame;
13965 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
13966 /* Use list_of_error, not Qerror, so that
13967 we catch only errors and don't run the debugger. */
13968 internal_condition_case_1 (redisplay_window_1, selected_window,
13969 list_of_error,
13970 redisplay_window_error);
13971 if (update_miniwindow_p)
13972 internal_condition_case_1 (redisplay_window_1, mini_window,
13973 list_of_error,
13974 redisplay_window_error);
13976 /* Compare desired and current matrices, perform output. */
13978 update:
13979 /* If fonts changed, display again. */
13980 if (sf->fonts_changed)
13981 goto retry;
13983 /* Prevent various kinds of signals during display update.
13984 stdio is not robust about handling signals,
13985 which can cause an apparent I/O error. */
13986 if (interrupt_input)
13987 unrequest_sigio ();
13988 STOP_POLLING;
13990 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13992 if (hscroll_windows (selected_window))
13993 goto retry;
13995 XWINDOW (selected_window)->must_be_updated_p = true;
13996 pending = update_frame (sf, 0, 0);
13997 sf->cursor_type_changed = 0;
14000 /* We may have called echo_area_display at the top of this
14001 function. If the echo area is on another frame, that may
14002 have put text on a frame other than the selected one, so the
14003 above call to update_frame would not have caught it. Catch
14004 it here. */
14005 mini_window = FRAME_MINIBUF_WINDOW (sf);
14006 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
14008 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
14010 XWINDOW (mini_window)->must_be_updated_p = true;
14011 pending |= update_frame (mini_frame, 0, 0);
14012 mini_frame->cursor_type_changed = 0;
14013 if (!pending && hscroll_windows (mini_window))
14014 goto retry;
14018 /* If display was paused because of pending input, make sure we do a
14019 thorough update the next time. */
14020 if (pending)
14022 /* Prevent the optimization at the beginning of
14023 redisplay_internal that tries a single-line update of the
14024 line containing the cursor in the selected window. */
14025 CHARPOS (this_line_start_pos) = 0;
14027 /* Let the overlay arrow be updated the next time. */
14028 update_overlay_arrows (0);
14030 /* If we pause after scrolling, some rows in the current
14031 matrices of some windows are not valid. */
14032 if (!WINDOW_FULL_WIDTH_P (w)
14033 && !FRAME_WINDOW_P (XFRAME (w->frame)))
14034 update_mode_lines = 36;
14036 else
14038 if (!consider_all_windows_p)
14040 /* This has already been done above if
14041 consider_all_windows_p is set. */
14042 if (XBUFFER (w->contents)->text->redisplay
14043 && buffer_window_count (XBUFFER (w->contents)) > 1)
14044 /* This can happen if b->text->redisplay was set during
14045 jit-lock. */
14046 propagate_buffer_redisplay ();
14047 mark_window_display_accurate_1 (w, 1);
14049 /* Say overlay arrows are up to date. */
14050 update_overlay_arrows (1);
14052 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
14053 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
14056 update_mode_lines = 0;
14057 windows_or_buffers_changed = 0;
14060 /* Start SIGIO interrupts coming again. Having them off during the
14061 code above makes it less likely one will discard output, but not
14062 impossible, since there might be stuff in the system buffer here.
14063 But it is much hairier to try to do anything about that. */
14064 if (interrupt_input)
14065 request_sigio ();
14066 RESUME_POLLING;
14068 /* If a frame has become visible which was not before, redisplay
14069 again, so that we display it. Expose events for such a frame
14070 (which it gets when becoming visible) don't call the parts of
14071 redisplay constructing glyphs, so simply exposing a frame won't
14072 display anything in this case. So, we have to display these
14073 frames here explicitly. */
14074 if (!pending)
14076 int new_count = 0;
14078 FOR_EACH_FRAME (tail, frame)
14080 if (XFRAME (frame)->visible)
14081 new_count++;
14084 if (new_count != number_of_visible_frames)
14085 windows_or_buffers_changed = 52;
14088 /* Change frame size now if a change is pending. */
14089 do_pending_window_change (1);
14091 /* If we just did a pending size change, or have additional
14092 visible frames, or selected_window changed, redisplay again. */
14093 if ((windows_or_buffers_changed && !pending)
14094 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
14095 goto retry;
14097 /* Clear the face and image caches.
14099 We used to do this only if consider_all_windows_p. But the cache
14100 needs to be cleared if a timer creates images in the current
14101 buffer (e.g. the test case in Bug#6230). */
14103 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14105 clear_face_cache (0);
14106 clear_face_cache_count = 0;
14109 #ifdef HAVE_WINDOW_SYSTEM
14110 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14112 clear_image_caches (Qnil);
14113 clear_image_cache_count = 0;
14115 #endif /* HAVE_WINDOW_SYSTEM */
14117 end_of_redisplay:
14118 #ifdef HAVE_NS
14119 ns_set_doc_edited ();
14120 #endif
14121 if (interrupt_input && interrupts_deferred)
14122 request_sigio ();
14124 unbind_to (count, Qnil);
14125 RESUME_POLLING;
14129 /* Redisplay, but leave alone any recent echo area message unless
14130 another message has been requested in its place.
14132 This is useful in situations where you need to redisplay but no
14133 user action has occurred, making it inappropriate for the message
14134 area to be cleared. See tracking_off and
14135 wait_reading_process_output for examples of these situations.
14137 FROM_WHERE is an integer saying from where this function was
14138 called. This is useful for debugging. */
14140 void
14141 redisplay_preserve_echo_area (int from_where)
14143 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14145 if (!NILP (echo_area_buffer[1]))
14147 /* We have a previously displayed message, but no current
14148 message. Redisplay the previous message. */
14149 display_last_displayed_message_p = 1;
14150 redisplay_internal ();
14151 display_last_displayed_message_p = 0;
14153 else
14154 redisplay_internal ();
14156 flush_frame (SELECTED_FRAME ());
14160 /* Function registered with record_unwind_protect in redisplay_internal. */
14162 static void
14163 unwind_redisplay (void)
14165 redisplaying_p = 0;
14169 /* Mark the display of leaf window W as accurate or inaccurate.
14170 If ACCURATE_P is non-zero mark display of W as accurate. If
14171 ACCURATE_P is zero, arrange for W to be redisplayed the next
14172 time redisplay_internal is called. */
14174 static void
14175 mark_window_display_accurate_1 (struct window *w, int accurate_p)
14177 struct buffer *b = XBUFFER (w->contents);
14179 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14180 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14181 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14183 if (accurate_p)
14185 b->clip_changed = false;
14186 b->prevent_redisplay_optimizations_p = false;
14187 eassert (buffer_window_count (b) > 0);
14188 /* Resetting b->text->redisplay is problematic!
14189 In order to make it safer to do it here, redisplay_internal must
14190 have copied all b->text->redisplay to their respective windows. */
14191 b->text->redisplay = false;
14193 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14194 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14195 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14196 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14198 w->current_matrix->buffer = b;
14199 w->current_matrix->begv = BUF_BEGV (b);
14200 w->current_matrix->zv = BUF_ZV (b);
14202 w->last_cursor_vpos = w->cursor.vpos;
14203 w->last_cursor_off_p = w->cursor_off_p;
14205 if (w == XWINDOW (selected_window))
14206 w->last_point = BUF_PT (b);
14207 else
14208 w->last_point = marker_position (w->pointm);
14210 w->window_end_valid = true;
14211 w->update_mode_line = false;
14214 w->redisplay = !accurate_p;
14218 /* Mark the display of windows in the window tree rooted at WINDOW as
14219 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14220 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14221 be redisplayed the next time redisplay_internal is called. */
14223 void
14224 mark_window_display_accurate (Lisp_Object window, int accurate_p)
14226 struct window *w;
14228 for (; !NILP (window); window = w->next)
14230 w = XWINDOW (window);
14231 if (WINDOWP (w->contents))
14232 mark_window_display_accurate (w->contents, accurate_p);
14233 else
14234 mark_window_display_accurate_1 (w, accurate_p);
14237 if (accurate_p)
14238 update_overlay_arrows (1);
14239 else
14240 /* Force a thorough redisplay the next time by setting
14241 last_arrow_position and last_arrow_string to t, which is
14242 unequal to any useful value of Voverlay_arrow_... */
14243 update_overlay_arrows (-1);
14247 /* Return value in display table DP (Lisp_Char_Table *) for character
14248 C. Since a display table doesn't have any parent, we don't have to
14249 follow parent. Do not call this function directly but use the
14250 macro DISP_CHAR_VECTOR. */
14252 Lisp_Object
14253 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14255 Lisp_Object val;
14257 if (ASCII_CHAR_P (c))
14259 val = dp->ascii;
14260 if (SUB_CHAR_TABLE_P (val))
14261 val = XSUB_CHAR_TABLE (val)->contents[c];
14263 else
14265 Lisp_Object table;
14267 XSETCHAR_TABLE (table, dp);
14268 val = char_table_ref (table, c);
14270 if (NILP (val))
14271 val = dp->defalt;
14272 return val;
14277 /***********************************************************************
14278 Window Redisplay
14279 ***********************************************************************/
14281 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14283 static void
14284 redisplay_windows (Lisp_Object window)
14286 while (!NILP (window))
14288 struct window *w = XWINDOW (window);
14290 if (WINDOWP (w->contents))
14291 redisplay_windows (w->contents);
14292 else if (BUFFERP (w->contents))
14294 displayed_buffer = XBUFFER (w->contents);
14295 /* Use list_of_error, not Qerror, so that
14296 we catch only errors and don't run the debugger. */
14297 internal_condition_case_1 (redisplay_window_0, window,
14298 list_of_error,
14299 redisplay_window_error);
14302 window = w->next;
14306 static Lisp_Object
14307 redisplay_window_error (Lisp_Object ignore)
14309 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14310 return Qnil;
14313 static Lisp_Object
14314 redisplay_window_0 (Lisp_Object window)
14316 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14317 redisplay_window (window, false);
14318 return Qnil;
14321 static Lisp_Object
14322 redisplay_window_1 (Lisp_Object window)
14324 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14325 redisplay_window (window, true);
14326 return Qnil;
14330 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14331 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14332 which positions recorded in ROW differ from current buffer
14333 positions.
14335 Return 0 if cursor is not on this row, 1 otherwise. */
14337 static int
14338 set_cursor_from_row (struct window *w, struct glyph_row *row,
14339 struct glyph_matrix *matrix,
14340 ptrdiff_t delta, ptrdiff_t delta_bytes,
14341 int dy, int dvpos)
14343 struct glyph *glyph = row->glyphs[TEXT_AREA];
14344 struct glyph *end = glyph + row->used[TEXT_AREA];
14345 struct glyph *cursor = NULL;
14346 /* The last known character position in row. */
14347 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14348 int x = row->x;
14349 ptrdiff_t pt_old = PT - delta;
14350 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14351 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14352 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14353 /* A glyph beyond the edge of TEXT_AREA which we should never
14354 touch. */
14355 struct glyph *glyphs_end = end;
14356 /* Non-zero means we've found a match for cursor position, but that
14357 glyph has the avoid_cursor_p flag set. */
14358 int match_with_avoid_cursor = 0;
14359 /* Non-zero means we've seen at least one glyph that came from a
14360 display string. */
14361 int string_seen = 0;
14362 /* Largest and smallest buffer positions seen so far during scan of
14363 glyph row. */
14364 ptrdiff_t bpos_max = pos_before;
14365 ptrdiff_t bpos_min = pos_after;
14366 /* Last buffer position covered by an overlay string with an integer
14367 `cursor' property. */
14368 ptrdiff_t bpos_covered = 0;
14369 /* Non-zero means the display string on which to display the cursor
14370 comes from a text property, not from an overlay. */
14371 int string_from_text_prop = 0;
14373 /* Don't even try doing anything if called for a mode-line or
14374 header-line row, since the rest of the code isn't prepared to
14375 deal with such calamities. */
14376 eassert (!row->mode_line_p);
14377 if (row->mode_line_p)
14378 return 0;
14380 /* Skip over glyphs not having an object at the start and the end of
14381 the row. These are special glyphs like truncation marks on
14382 terminal frames. */
14383 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14385 if (!row->reversed_p)
14387 while (glyph < end
14388 && INTEGERP (glyph->object)
14389 && glyph->charpos < 0)
14391 x += glyph->pixel_width;
14392 ++glyph;
14394 while (end > glyph
14395 && INTEGERP ((end - 1)->object)
14396 /* CHARPOS is zero for blanks and stretch glyphs
14397 inserted by extend_face_to_end_of_line. */
14398 && (end - 1)->charpos <= 0)
14399 --end;
14400 glyph_before = glyph - 1;
14401 glyph_after = end;
14403 else
14405 struct glyph *g;
14407 /* If the glyph row is reversed, we need to process it from back
14408 to front, so swap the edge pointers. */
14409 glyphs_end = end = glyph - 1;
14410 glyph += row->used[TEXT_AREA] - 1;
14412 while (glyph > end + 1
14413 && INTEGERP (glyph->object)
14414 && glyph->charpos < 0)
14416 --glyph;
14417 x -= glyph->pixel_width;
14419 if (INTEGERP (glyph->object) && glyph->charpos < 0)
14420 --glyph;
14421 /* By default, in reversed rows we put the cursor on the
14422 rightmost (first in the reading order) glyph. */
14423 for (g = end + 1; g < glyph; g++)
14424 x += g->pixel_width;
14425 while (end < glyph
14426 && INTEGERP ((end + 1)->object)
14427 && (end + 1)->charpos <= 0)
14428 ++end;
14429 glyph_before = glyph + 1;
14430 glyph_after = end;
14433 else if (row->reversed_p)
14435 /* In R2L rows that don't display text, put the cursor on the
14436 rightmost glyph. Case in point: an empty last line that is
14437 part of an R2L paragraph. */
14438 cursor = end - 1;
14439 /* Avoid placing the cursor on the last glyph of the row, where
14440 on terminal frames we hold the vertical border between
14441 adjacent windows. */
14442 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14443 && !WINDOW_RIGHTMOST_P (w)
14444 && cursor == row->glyphs[LAST_AREA] - 1)
14445 cursor--;
14446 x = -1; /* will be computed below, at label compute_x */
14449 /* Step 1: Try to find the glyph whose character position
14450 corresponds to point. If that's not possible, find 2 glyphs
14451 whose character positions are the closest to point, one before
14452 point, the other after it. */
14453 if (!row->reversed_p)
14454 while (/* not marched to end of glyph row */
14455 glyph < end
14456 /* glyph was not inserted by redisplay for internal purposes */
14457 && !INTEGERP (glyph->object))
14459 if (BUFFERP (glyph->object))
14461 ptrdiff_t dpos = glyph->charpos - pt_old;
14463 if (glyph->charpos > bpos_max)
14464 bpos_max = glyph->charpos;
14465 if (glyph->charpos < bpos_min)
14466 bpos_min = glyph->charpos;
14467 if (!glyph->avoid_cursor_p)
14469 /* If we hit point, we've found the glyph on which to
14470 display the cursor. */
14471 if (dpos == 0)
14473 match_with_avoid_cursor = 0;
14474 break;
14476 /* See if we've found a better approximation to
14477 POS_BEFORE or to POS_AFTER. */
14478 if (0 > dpos && dpos > pos_before - pt_old)
14480 pos_before = glyph->charpos;
14481 glyph_before = glyph;
14483 else if (0 < dpos && dpos < pos_after - pt_old)
14485 pos_after = glyph->charpos;
14486 glyph_after = glyph;
14489 else if (dpos == 0)
14490 match_with_avoid_cursor = 1;
14492 else if (STRINGP (glyph->object))
14494 Lisp_Object chprop;
14495 ptrdiff_t glyph_pos = glyph->charpos;
14497 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14498 glyph->object);
14499 if (!NILP (chprop))
14501 /* If the string came from a `display' text property,
14502 look up the buffer position of that property and
14503 use that position to update bpos_max, as if we
14504 actually saw such a position in one of the row's
14505 glyphs. This helps with supporting integer values
14506 of `cursor' property on the display string in
14507 situations where most or all of the row's buffer
14508 text is completely covered by display properties,
14509 so that no glyph with valid buffer positions is
14510 ever seen in the row. */
14511 ptrdiff_t prop_pos =
14512 string_buffer_position_lim (glyph->object, pos_before,
14513 pos_after, 0);
14515 if (prop_pos >= pos_before)
14516 bpos_max = prop_pos;
14518 if (INTEGERP (chprop))
14520 bpos_covered = bpos_max + XINT (chprop);
14521 /* If the `cursor' property covers buffer positions up
14522 to and including point, we should display cursor on
14523 this glyph. Note that, if a `cursor' property on one
14524 of the string's characters has an integer value, we
14525 will break out of the loop below _before_ we get to
14526 the position match above. IOW, integer values of
14527 the `cursor' property override the "exact match for
14528 point" strategy of positioning the cursor. */
14529 /* Implementation note: bpos_max == pt_old when, e.g.,
14530 we are in an empty line, where bpos_max is set to
14531 MATRIX_ROW_START_CHARPOS, see above. */
14532 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14534 cursor = glyph;
14535 break;
14539 string_seen = 1;
14541 x += glyph->pixel_width;
14542 ++glyph;
14544 else if (glyph > end) /* row is reversed */
14545 while (!INTEGERP (glyph->object))
14547 if (BUFFERP (glyph->object))
14549 ptrdiff_t dpos = glyph->charpos - pt_old;
14551 if (glyph->charpos > bpos_max)
14552 bpos_max = glyph->charpos;
14553 if (glyph->charpos < bpos_min)
14554 bpos_min = glyph->charpos;
14555 if (!glyph->avoid_cursor_p)
14557 if (dpos == 0)
14559 match_with_avoid_cursor = 0;
14560 break;
14562 if (0 > dpos && dpos > pos_before - pt_old)
14564 pos_before = glyph->charpos;
14565 glyph_before = glyph;
14567 else if (0 < dpos && dpos < pos_after - pt_old)
14569 pos_after = glyph->charpos;
14570 glyph_after = glyph;
14573 else if (dpos == 0)
14574 match_with_avoid_cursor = 1;
14576 else if (STRINGP (glyph->object))
14578 Lisp_Object chprop;
14579 ptrdiff_t glyph_pos = glyph->charpos;
14581 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14582 glyph->object);
14583 if (!NILP (chprop))
14585 ptrdiff_t prop_pos =
14586 string_buffer_position_lim (glyph->object, pos_before,
14587 pos_after, 0);
14589 if (prop_pos >= pos_before)
14590 bpos_max = prop_pos;
14592 if (INTEGERP (chprop))
14594 bpos_covered = bpos_max + XINT (chprop);
14595 /* If the `cursor' property covers buffer positions up
14596 to and including point, we should display cursor on
14597 this glyph. */
14598 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14600 cursor = glyph;
14601 break;
14604 string_seen = 1;
14606 --glyph;
14607 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14609 x--; /* can't use any pixel_width */
14610 break;
14612 x -= glyph->pixel_width;
14615 /* Step 2: If we didn't find an exact match for point, we need to
14616 look for a proper place to put the cursor among glyphs between
14617 GLYPH_BEFORE and GLYPH_AFTER. */
14618 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14619 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14620 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14622 /* An empty line has a single glyph whose OBJECT is zero and
14623 whose CHARPOS is the position of a newline on that line.
14624 Note that on a TTY, there are more glyphs after that, which
14625 were produced by extend_face_to_end_of_line, but their
14626 CHARPOS is zero or negative. */
14627 int empty_line_p =
14628 (row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14629 && INTEGERP (glyph->object) && glyph->charpos > 0
14630 /* On a TTY, continued and truncated rows also have a glyph at
14631 their end whose OBJECT is zero and whose CHARPOS is
14632 positive (the continuation and truncation glyphs), but such
14633 rows are obviously not "empty". */
14634 && !(row->continued_p || row->truncated_on_right_p);
14636 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14638 ptrdiff_t ellipsis_pos;
14640 /* Scan back over the ellipsis glyphs. */
14641 if (!row->reversed_p)
14643 ellipsis_pos = (glyph - 1)->charpos;
14644 while (glyph > row->glyphs[TEXT_AREA]
14645 && (glyph - 1)->charpos == ellipsis_pos)
14646 glyph--, x -= glyph->pixel_width;
14647 /* That loop always goes one position too far, including
14648 the glyph before the ellipsis. So scan forward over
14649 that one. */
14650 x += glyph->pixel_width;
14651 glyph++;
14653 else /* row is reversed */
14655 ellipsis_pos = (glyph + 1)->charpos;
14656 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14657 && (glyph + 1)->charpos == ellipsis_pos)
14658 glyph++, x += glyph->pixel_width;
14659 x -= glyph->pixel_width;
14660 glyph--;
14663 else if (match_with_avoid_cursor)
14665 cursor = glyph_after;
14666 x = -1;
14668 else if (string_seen)
14670 int incr = row->reversed_p ? -1 : +1;
14672 /* Need to find the glyph that came out of a string which is
14673 present at point. That glyph is somewhere between
14674 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14675 positioned between POS_BEFORE and POS_AFTER in the
14676 buffer. */
14677 struct glyph *start, *stop;
14678 ptrdiff_t pos = pos_before;
14680 x = -1;
14682 /* If the row ends in a newline from a display string,
14683 reordering could have moved the glyphs belonging to the
14684 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14685 in this case we extend the search to the last glyph in
14686 the row that was not inserted by redisplay. */
14687 if (row->ends_in_newline_from_string_p)
14689 glyph_after = end;
14690 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14693 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14694 correspond to POS_BEFORE and POS_AFTER, respectively. We
14695 need START and STOP in the order that corresponds to the
14696 row's direction as given by its reversed_p flag. If the
14697 directionality of characters between POS_BEFORE and
14698 POS_AFTER is the opposite of the row's base direction,
14699 these characters will have been reordered for display,
14700 and we need to reverse START and STOP. */
14701 if (!row->reversed_p)
14703 start = min (glyph_before, glyph_after);
14704 stop = max (glyph_before, glyph_after);
14706 else
14708 start = max (glyph_before, glyph_after);
14709 stop = min (glyph_before, glyph_after);
14711 for (glyph = start + incr;
14712 row->reversed_p ? glyph > stop : glyph < stop; )
14715 /* Any glyphs that come from the buffer are here because
14716 of bidi reordering. Skip them, and only pay
14717 attention to glyphs that came from some string. */
14718 if (STRINGP (glyph->object))
14720 Lisp_Object str;
14721 ptrdiff_t tem;
14722 /* If the display property covers the newline, we
14723 need to search for it one position farther. */
14724 ptrdiff_t lim = pos_after
14725 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14727 string_from_text_prop = 0;
14728 str = glyph->object;
14729 tem = string_buffer_position_lim (str, pos, lim, 0);
14730 if (tem == 0 /* from overlay */
14731 || pos <= tem)
14733 /* If the string from which this glyph came is
14734 found in the buffer at point, or at position
14735 that is closer to point than pos_after, then
14736 we've found the glyph we've been looking for.
14737 If it comes from an overlay (tem == 0), and
14738 it has the `cursor' property on one of its
14739 glyphs, record that glyph as a candidate for
14740 displaying the cursor. (As in the
14741 unidirectional version, we will display the
14742 cursor on the last candidate we find.) */
14743 if (tem == 0
14744 || tem == pt_old
14745 || (tem - pt_old > 0 && tem < pos_after))
14747 /* The glyphs from this string could have
14748 been reordered. Find the one with the
14749 smallest string position. Or there could
14750 be a character in the string with the
14751 `cursor' property, which means display
14752 cursor on that character's glyph. */
14753 ptrdiff_t strpos = glyph->charpos;
14755 if (tem)
14757 cursor = glyph;
14758 string_from_text_prop = 1;
14760 for ( ;
14761 (row->reversed_p ? glyph > stop : glyph < stop)
14762 && EQ (glyph->object, str);
14763 glyph += incr)
14765 Lisp_Object cprop;
14766 ptrdiff_t gpos = glyph->charpos;
14768 cprop = Fget_char_property (make_number (gpos),
14769 Qcursor,
14770 glyph->object);
14771 if (!NILP (cprop))
14773 cursor = glyph;
14774 break;
14776 if (tem && glyph->charpos < strpos)
14778 strpos = glyph->charpos;
14779 cursor = glyph;
14783 if (tem == pt_old
14784 || (tem - pt_old > 0 && tem < pos_after))
14785 goto compute_x;
14787 if (tem)
14788 pos = tem + 1; /* don't find previous instances */
14790 /* This string is not what we want; skip all of the
14791 glyphs that came from it. */
14792 while ((row->reversed_p ? glyph > stop : glyph < stop)
14793 && EQ (glyph->object, str))
14794 glyph += incr;
14796 else
14797 glyph += incr;
14800 /* If we reached the end of the line, and END was from a string,
14801 the cursor is not on this line. */
14802 if (cursor == NULL
14803 && (row->reversed_p ? glyph <= end : glyph >= end)
14804 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14805 && STRINGP (end->object)
14806 && row->continued_p)
14807 return 0;
14809 /* A truncated row may not include PT among its character positions.
14810 Setting the cursor inside the scroll margin will trigger
14811 recalculation of hscroll in hscroll_window_tree. But if a
14812 display string covers point, defer to the string-handling
14813 code below to figure this out. */
14814 else if (row->truncated_on_left_p && pt_old < bpos_min)
14816 cursor = glyph_before;
14817 x = -1;
14819 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14820 /* Zero-width characters produce no glyphs. */
14821 || (!empty_line_p
14822 && (row->reversed_p
14823 ? glyph_after > glyphs_end
14824 : glyph_after < glyphs_end)))
14826 cursor = glyph_after;
14827 x = -1;
14831 compute_x:
14832 if (cursor != NULL)
14833 glyph = cursor;
14834 else if (glyph == glyphs_end
14835 && pos_before == pos_after
14836 && STRINGP ((row->reversed_p
14837 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14838 : row->glyphs[TEXT_AREA])->object))
14840 /* If all the glyphs of this row came from strings, put the
14841 cursor on the first glyph of the row. This avoids having the
14842 cursor outside of the text area in this very rare and hard
14843 use case. */
14844 glyph =
14845 row->reversed_p
14846 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14847 : row->glyphs[TEXT_AREA];
14849 if (x < 0)
14851 struct glyph *g;
14853 /* Need to compute x that corresponds to GLYPH. */
14854 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14856 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14857 emacs_abort ();
14858 x += g->pixel_width;
14862 /* ROW could be part of a continued line, which, under bidi
14863 reordering, might have other rows whose start and end charpos
14864 occlude point. Only set w->cursor if we found a better
14865 approximation to the cursor position than we have from previously
14866 examined candidate rows belonging to the same continued line. */
14867 if (/* We already have a candidate row. */
14868 w->cursor.vpos >= 0
14869 /* That candidate is not the row we are processing. */
14870 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14871 /* Make sure cursor.vpos specifies a row whose start and end
14872 charpos occlude point, and it is valid candidate for being a
14873 cursor-row. This is because some callers of this function
14874 leave cursor.vpos at the row where the cursor was displayed
14875 during the last redisplay cycle. */
14876 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14877 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14878 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14880 struct glyph *g1
14881 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14883 /* Don't consider glyphs that are outside TEXT_AREA. */
14884 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14885 return 0;
14886 /* Keep the candidate whose buffer position is the closest to
14887 point or has the `cursor' property. */
14888 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14889 w->cursor.hpos >= 0
14890 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14891 && ((BUFFERP (g1->object)
14892 && (g1->charpos == pt_old /* An exact match always wins. */
14893 || (BUFFERP (glyph->object)
14894 && eabs (g1->charpos - pt_old)
14895 < eabs (glyph->charpos - pt_old))))
14896 /* Previous candidate is a glyph from a string that has
14897 a non-nil `cursor' property. */
14898 || (STRINGP (g1->object)
14899 && (!NILP (Fget_char_property (make_number (g1->charpos),
14900 Qcursor, g1->object))
14901 /* Previous candidate is from the same display
14902 string as this one, and the display string
14903 came from a text property. */
14904 || (EQ (g1->object, glyph->object)
14905 && string_from_text_prop)
14906 /* this candidate is from newline and its
14907 position is not an exact match */
14908 || (INTEGERP (glyph->object)
14909 && glyph->charpos != pt_old)))))
14910 return 0;
14911 /* If this candidate gives an exact match, use that. */
14912 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14913 /* If this candidate is a glyph created for the
14914 terminating newline of a line, and point is on that
14915 newline, it wins because it's an exact match. */
14916 || (!row->continued_p
14917 && INTEGERP (glyph->object)
14918 && glyph->charpos == 0
14919 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14920 /* Otherwise, keep the candidate that comes from a row
14921 spanning less buffer positions. This may win when one or
14922 both candidate positions are on glyphs that came from
14923 display strings, for which we cannot compare buffer
14924 positions. */
14925 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14926 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14927 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14928 return 0;
14930 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14931 w->cursor.x = x;
14932 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14933 w->cursor.y = row->y + dy;
14935 if (w == XWINDOW (selected_window))
14937 if (!row->continued_p
14938 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14939 && row->x == 0)
14941 this_line_buffer = XBUFFER (w->contents);
14943 CHARPOS (this_line_start_pos)
14944 = MATRIX_ROW_START_CHARPOS (row) + delta;
14945 BYTEPOS (this_line_start_pos)
14946 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14948 CHARPOS (this_line_end_pos)
14949 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14950 BYTEPOS (this_line_end_pos)
14951 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14953 this_line_y = w->cursor.y;
14954 this_line_pixel_height = row->height;
14955 this_line_vpos = w->cursor.vpos;
14956 this_line_start_x = row->x;
14958 else
14959 CHARPOS (this_line_start_pos) = 0;
14962 return 1;
14966 /* Run window scroll functions, if any, for WINDOW with new window
14967 start STARTP. Sets the window start of WINDOW to that position.
14969 We assume that the window's buffer is really current. */
14971 static struct text_pos
14972 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
14974 struct window *w = XWINDOW (window);
14975 SET_MARKER_FROM_TEXT_POS (w->start, startp);
14977 eassert (current_buffer == XBUFFER (w->contents));
14979 if (!NILP (Vwindow_scroll_functions))
14981 run_hook_with_args_2 (Qwindow_scroll_functions, window,
14982 make_number (CHARPOS (startp)));
14983 SET_TEXT_POS_FROM_MARKER (startp, w->start);
14984 /* In case the hook functions switch buffers. */
14985 set_buffer_internal (XBUFFER (w->contents));
14988 return startp;
14992 /* Make sure the line containing the cursor is fully visible.
14993 A value of 1 means there is nothing to be done.
14994 (Either the line is fully visible, or it cannot be made so,
14995 or we cannot tell.)
14997 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14998 is higher than window.
15000 If CURRENT_MATRIX_P is non-zero, use the information from the
15001 window's current glyph matrix; otherwise use the desired glyph
15002 matrix.
15004 A value of 0 means the caller should do scrolling
15005 as if point had gone off the screen. */
15007 static int
15008 cursor_row_fully_visible_p (struct window *w, int force_p, int current_matrix_p)
15010 struct glyph_matrix *matrix;
15011 struct glyph_row *row;
15012 int window_height;
15014 if (!make_cursor_line_fully_visible_p)
15015 return 1;
15017 /* It's not always possible to find the cursor, e.g, when a window
15018 is full of overlay strings. Don't do anything in that case. */
15019 if (w->cursor.vpos < 0)
15020 return 1;
15022 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
15023 row = MATRIX_ROW (matrix, w->cursor.vpos);
15025 /* If the cursor row is not partially visible, there's nothing to do. */
15026 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
15027 return 1;
15029 /* If the row the cursor is in is taller than the window's height,
15030 it's not clear what to do, so do nothing. */
15031 window_height = window_box_height (w);
15032 if (row->height >= window_height)
15034 if (!force_p || MINI_WINDOW_P (w)
15035 || w->vscroll || w->cursor.vpos == 0)
15036 return 1;
15038 return 0;
15042 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15043 non-zero means only WINDOW is redisplayed in redisplay_internal.
15044 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15045 in redisplay_window to bring a partially visible line into view in
15046 the case that only the cursor has moved.
15048 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15049 last screen line's vertical height extends past the end of the screen.
15051 Value is
15053 1 if scrolling succeeded
15055 0 if scrolling didn't find point.
15057 -1 if new fonts have been loaded so that we must interrupt
15058 redisplay, adjust glyph matrices, and try again. */
15060 enum
15062 SCROLLING_SUCCESS,
15063 SCROLLING_FAILED,
15064 SCROLLING_NEED_LARGER_MATRICES
15067 /* If scroll-conservatively is more than this, never recenter.
15069 If you change this, don't forget to update the doc string of
15070 `scroll-conservatively' and the Emacs manual. */
15071 #define SCROLL_LIMIT 100
15073 static int
15074 try_scrolling (Lisp_Object window, int just_this_one_p,
15075 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
15076 int temp_scroll_step, int last_line_misfit)
15078 struct window *w = XWINDOW (window);
15079 struct frame *f = XFRAME (w->frame);
15080 struct text_pos pos, startp;
15081 struct it it;
15082 int this_scroll_margin, scroll_max, rc, height;
15083 int dy = 0, amount_to_scroll = 0, scroll_down_p = 0;
15084 int extra_scroll_margin_lines = last_line_misfit ? 1 : 0;
15085 Lisp_Object aggressive;
15086 /* We will never try scrolling more than this number of lines. */
15087 int scroll_limit = SCROLL_LIMIT;
15088 int frame_line_height = default_line_pixel_height (w);
15089 int window_total_lines
15090 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15092 #ifdef GLYPH_DEBUG
15093 debug_method_add (w, "try_scrolling");
15094 #endif
15096 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15098 /* Compute scroll margin height in pixels. We scroll when point is
15099 within this distance from the top or bottom of the window. */
15100 if (scroll_margin > 0)
15101 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
15102 * frame_line_height;
15103 else
15104 this_scroll_margin = 0;
15106 /* Force arg_scroll_conservatively to have a reasonable value, to
15107 avoid scrolling too far away with slow move_it_* functions. Note
15108 that the user can supply scroll-conservatively equal to
15109 `most-positive-fixnum', which can be larger than INT_MAX. */
15110 if (arg_scroll_conservatively > scroll_limit)
15112 arg_scroll_conservatively = scroll_limit + 1;
15113 scroll_max = scroll_limit * frame_line_height;
15115 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15116 /* Compute how much we should try to scroll maximally to bring
15117 point into view. */
15118 scroll_max = (max (scroll_step,
15119 max (arg_scroll_conservatively, temp_scroll_step))
15120 * frame_line_height);
15121 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15122 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15123 /* We're trying to scroll because of aggressive scrolling but no
15124 scroll_step is set. Choose an arbitrary one. */
15125 scroll_max = 10 * frame_line_height;
15126 else
15127 scroll_max = 0;
15129 too_near_end:
15131 /* Decide whether to scroll down. */
15132 if (PT > CHARPOS (startp))
15134 int scroll_margin_y;
15136 /* Compute the pixel ypos of the scroll margin, then move IT to
15137 either that ypos or PT, whichever comes first. */
15138 start_display (&it, w, startp);
15139 scroll_margin_y = it.last_visible_y - this_scroll_margin
15140 - frame_line_height * extra_scroll_margin_lines;
15141 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15142 (MOVE_TO_POS | MOVE_TO_Y));
15144 if (PT > CHARPOS (it.current.pos))
15146 int y0 = line_bottom_y (&it);
15147 /* Compute how many pixels below window bottom to stop searching
15148 for PT. This avoids costly search for PT that is far away if
15149 the user limited scrolling by a small number of lines, but
15150 always finds PT if scroll_conservatively is set to a large
15151 number, such as most-positive-fixnum. */
15152 int slack = max (scroll_max, 10 * frame_line_height);
15153 int y_to_move = it.last_visible_y + slack;
15155 /* Compute the distance from the scroll margin to PT or to
15156 the scroll limit, whichever comes first. This should
15157 include the height of the cursor line, to make that line
15158 fully visible. */
15159 move_it_to (&it, PT, -1, y_to_move,
15160 -1, MOVE_TO_POS | MOVE_TO_Y);
15161 dy = line_bottom_y (&it) - y0;
15163 if (dy > scroll_max)
15164 return SCROLLING_FAILED;
15166 if (dy > 0)
15167 scroll_down_p = 1;
15171 if (scroll_down_p)
15173 /* Point is in or below the bottom scroll margin, so move the
15174 window start down. If scrolling conservatively, move it just
15175 enough down to make point visible. If scroll_step is set,
15176 move it down by scroll_step. */
15177 if (arg_scroll_conservatively)
15178 amount_to_scroll
15179 = min (max (dy, frame_line_height),
15180 frame_line_height * arg_scroll_conservatively);
15181 else if (scroll_step || temp_scroll_step)
15182 amount_to_scroll = scroll_max;
15183 else
15185 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15186 height = WINDOW_BOX_TEXT_HEIGHT (w);
15187 if (NUMBERP (aggressive))
15189 double float_amount = XFLOATINT (aggressive) * height;
15190 int aggressive_scroll = float_amount;
15191 if (aggressive_scroll == 0 && float_amount > 0)
15192 aggressive_scroll = 1;
15193 /* Don't let point enter the scroll margin near top of
15194 the window. This could happen if the value of
15195 scroll_up_aggressively is too large and there are
15196 non-zero margins, because scroll_up_aggressively
15197 means put point that fraction of window height
15198 _from_the_bottom_margin_. */
15199 if (aggressive_scroll + 2*this_scroll_margin > height)
15200 aggressive_scroll = height - 2*this_scroll_margin;
15201 amount_to_scroll = dy + aggressive_scroll;
15205 if (amount_to_scroll <= 0)
15206 return SCROLLING_FAILED;
15208 start_display (&it, w, startp);
15209 if (arg_scroll_conservatively <= scroll_limit)
15210 move_it_vertically (&it, amount_to_scroll);
15211 else
15213 /* Extra precision for users who set scroll-conservatively
15214 to a large number: make sure the amount we scroll
15215 the window start is never less than amount_to_scroll,
15216 which was computed as distance from window bottom to
15217 point. This matters when lines at window top and lines
15218 below window bottom have different height. */
15219 struct it it1;
15220 void *it1data = NULL;
15221 /* We use a temporary it1 because line_bottom_y can modify
15222 its argument, if it moves one line down; see there. */
15223 int start_y;
15225 SAVE_IT (it1, it, it1data);
15226 start_y = line_bottom_y (&it1);
15227 do {
15228 RESTORE_IT (&it, &it, it1data);
15229 move_it_by_lines (&it, 1);
15230 SAVE_IT (it1, it, it1data);
15231 } while (line_bottom_y (&it1) - start_y < amount_to_scroll);
15234 /* If STARTP is unchanged, move it down another screen line. */
15235 if (CHARPOS (it.current.pos) == CHARPOS (startp))
15236 move_it_by_lines (&it, 1);
15237 startp = it.current.pos;
15239 else
15241 struct text_pos scroll_margin_pos = startp;
15242 int y_offset = 0;
15244 /* See if point is inside the scroll margin at the top of the
15245 window. */
15246 if (this_scroll_margin)
15248 int y_start;
15250 start_display (&it, w, startp);
15251 y_start = it.current_y;
15252 move_it_vertically (&it, this_scroll_margin);
15253 scroll_margin_pos = it.current.pos;
15254 /* If we didn't move enough before hitting ZV, request
15255 additional amount of scroll, to move point out of the
15256 scroll margin. */
15257 if (IT_CHARPOS (it) == ZV
15258 && it.current_y - y_start < this_scroll_margin)
15259 y_offset = this_scroll_margin - (it.current_y - y_start);
15262 if (PT < CHARPOS (scroll_margin_pos))
15264 /* Point is in the scroll margin at the top of the window or
15265 above what is displayed in the window. */
15266 int y0, y_to_move;
15268 /* Compute the vertical distance from PT to the scroll
15269 margin position. Move as far as scroll_max allows, or
15270 one screenful, or 10 screen lines, whichever is largest.
15271 Give up if distance is greater than scroll_max or if we
15272 didn't reach the scroll margin position. */
15273 SET_TEXT_POS (pos, PT, PT_BYTE);
15274 start_display (&it, w, pos);
15275 y0 = it.current_y;
15276 y_to_move = max (it.last_visible_y,
15277 max (scroll_max, 10 * frame_line_height));
15278 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15279 y_to_move, -1,
15280 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15281 dy = it.current_y - y0;
15282 if (dy > scroll_max
15283 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15284 return SCROLLING_FAILED;
15286 /* Additional scroll for when ZV was too close to point. */
15287 dy += y_offset;
15289 /* Compute new window start. */
15290 start_display (&it, w, startp);
15292 if (arg_scroll_conservatively)
15293 amount_to_scroll = max (dy, frame_line_height *
15294 max (scroll_step, temp_scroll_step));
15295 else if (scroll_step || temp_scroll_step)
15296 amount_to_scroll = scroll_max;
15297 else
15299 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15300 height = WINDOW_BOX_TEXT_HEIGHT (w);
15301 if (NUMBERP (aggressive))
15303 double float_amount = XFLOATINT (aggressive) * height;
15304 int aggressive_scroll = float_amount;
15305 if (aggressive_scroll == 0 && float_amount > 0)
15306 aggressive_scroll = 1;
15307 /* Don't let point enter the scroll margin near
15308 bottom of the window, if the value of
15309 scroll_down_aggressively happens to be too
15310 large. */
15311 if (aggressive_scroll + 2*this_scroll_margin > height)
15312 aggressive_scroll = height - 2*this_scroll_margin;
15313 amount_to_scroll = dy + aggressive_scroll;
15317 if (amount_to_scroll <= 0)
15318 return SCROLLING_FAILED;
15320 move_it_vertically_backward (&it, amount_to_scroll);
15321 startp = it.current.pos;
15325 /* Run window scroll functions. */
15326 startp = run_window_scroll_functions (window, startp);
15328 /* Display the window. Give up if new fonts are loaded, or if point
15329 doesn't appear. */
15330 if (!try_window (window, startp, 0))
15331 rc = SCROLLING_NEED_LARGER_MATRICES;
15332 else if (w->cursor.vpos < 0)
15334 clear_glyph_matrix (w->desired_matrix);
15335 rc = SCROLLING_FAILED;
15337 else
15339 /* Maybe forget recorded base line for line number display. */
15340 if (!just_this_one_p
15341 || current_buffer->clip_changed
15342 || BEG_UNCHANGED < CHARPOS (startp))
15343 w->base_line_number = 0;
15345 /* If cursor ends up on a partially visible line,
15346 treat that as being off the bottom of the screen. */
15347 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1, 0)
15348 /* It's possible that the cursor is on the first line of the
15349 buffer, which is partially obscured due to a vscroll
15350 (Bug#7537). In that case, avoid looping forever. */
15351 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15353 clear_glyph_matrix (w->desired_matrix);
15354 ++extra_scroll_margin_lines;
15355 goto too_near_end;
15357 rc = SCROLLING_SUCCESS;
15360 return rc;
15364 /* Compute a suitable window start for window W if display of W starts
15365 on a continuation line. Value is non-zero if a new window start
15366 was computed.
15368 The new window start will be computed, based on W's width, starting
15369 from the start of the continued line. It is the start of the
15370 screen line with the minimum distance from the old start W->start. */
15372 static int
15373 compute_window_start_on_continuation_line (struct window *w)
15375 struct text_pos pos, start_pos;
15376 int window_start_changed_p = 0;
15378 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15380 /* If window start is on a continuation line... Window start may be
15381 < BEGV in case there's invisible text at the start of the
15382 buffer (M-x rmail, for example). */
15383 if (CHARPOS (start_pos) > BEGV
15384 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15386 struct it it;
15387 struct glyph_row *row;
15389 /* Handle the case that the window start is out of range. */
15390 if (CHARPOS (start_pos) < BEGV)
15391 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15392 else if (CHARPOS (start_pos) > ZV)
15393 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15395 /* Find the start of the continued line. This should be fast
15396 because find_newline is fast (newline cache). */
15397 row = w->desired_matrix->rows + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0);
15398 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15399 row, DEFAULT_FACE_ID);
15400 reseat_at_previous_visible_line_start (&it);
15402 /* If the line start is "too far" away from the window start,
15403 say it takes too much time to compute a new window start. */
15404 if (CHARPOS (start_pos) - IT_CHARPOS (it)
15405 /* PXW: Do we need upper bounds here? */
15406 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
15408 int min_distance, distance;
15410 /* Move forward by display lines to find the new window
15411 start. If window width was enlarged, the new start can
15412 be expected to be > the old start. If window width was
15413 decreased, the new window start will be < the old start.
15414 So, we're looking for the display line start with the
15415 minimum distance from the old window start. */
15416 pos = it.current.pos;
15417 min_distance = INFINITY;
15418 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15419 distance < min_distance)
15421 min_distance = distance;
15422 pos = it.current.pos;
15423 if (it.line_wrap == WORD_WRAP)
15425 /* Under WORD_WRAP, move_it_by_lines is likely to
15426 overshoot and stop not at the first, but the
15427 second character from the left margin. So in
15428 that case, we need a more tight control on the X
15429 coordinate of the iterator than move_it_by_lines
15430 promises in its contract. The method is to first
15431 go to the last (rightmost) visible character of a
15432 line, then move to the leftmost character on the
15433 next line in a separate call. */
15434 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15435 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15436 move_it_to (&it, ZV, 0,
15437 it.current_y + it.max_ascent + it.max_descent, -1,
15438 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15440 else
15441 move_it_by_lines (&it, 1);
15444 /* Set the window start there. */
15445 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15446 window_start_changed_p = 1;
15450 return window_start_changed_p;
15454 /* Try cursor movement in case text has not changed in window WINDOW,
15455 with window start STARTP. Value is
15457 CURSOR_MOVEMENT_SUCCESS if successful
15459 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15461 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15462 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15463 we want to scroll as if scroll-step were set to 1. See the code.
15465 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15466 which case we have to abort this redisplay, and adjust matrices
15467 first. */
15469 enum
15471 CURSOR_MOVEMENT_SUCCESS,
15472 CURSOR_MOVEMENT_CANNOT_BE_USED,
15473 CURSOR_MOVEMENT_MUST_SCROLL,
15474 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15477 static int
15478 try_cursor_movement (Lisp_Object window, struct text_pos startp, int *scroll_step)
15480 struct window *w = XWINDOW (window);
15481 struct frame *f = XFRAME (w->frame);
15482 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15484 #ifdef GLYPH_DEBUG
15485 if (inhibit_try_cursor_movement)
15486 return rc;
15487 #endif
15489 /* Previously, there was a check for Lisp integer in the
15490 if-statement below. Now, this field is converted to
15491 ptrdiff_t, thus zero means invalid position in a buffer. */
15492 eassert (w->last_point > 0);
15493 /* Likewise there was a check whether window_end_vpos is nil or larger
15494 than the window. Now window_end_vpos is int and so never nil, but
15495 let's leave eassert to check whether it fits in the window. */
15496 eassert (w->window_end_vpos < w->current_matrix->nrows);
15498 /* Handle case where text has not changed, only point, and it has
15499 not moved off the frame. */
15500 if (/* Point may be in this window. */
15501 PT >= CHARPOS (startp)
15502 /* Selective display hasn't changed. */
15503 && !current_buffer->clip_changed
15504 /* Function force-mode-line-update is used to force a thorough
15505 redisplay. It sets either windows_or_buffers_changed or
15506 update_mode_lines. So don't take a shortcut here for these
15507 cases. */
15508 && !update_mode_lines
15509 && !windows_or_buffers_changed
15510 && !f->cursor_type_changed
15511 && NILP (Vshow_trailing_whitespace)
15512 /* This code is not used for mini-buffer for the sake of the case
15513 of redisplaying to replace an echo area message; since in
15514 that case the mini-buffer contents per se are usually
15515 unchanged. This code is of no real use in the mini-buffer
15516 since the handling of this_line_start_pos, etc., in redisplay
15517 handles the same cases. */
15518 && !EQ (window, minibuf_window)
15519 && (FRAME_WINDOW_P (f)
15520 || !overlay_arrow_in_current_buffer_p ()))
15522 int this_scroll_margin, top_scroll_margin;
15523 struct glyph_row *row = NULL;
15524 int frame_line_height = default_line_pixel_height (w);
15525 int window_total_lines
15526 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15528 #ifdef GLYPH_DEBUG
15529 debug_method_add (w, "cursor movement");
15530 #endif
15532 /* Scroll if point within this distance from the top or bottom
15533 of the window. This is a pixel value. */
15534 if (scroll_margin > 0)
15536 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15537 this_scroll_margin *= frame_line_height;
15539 else
15540 this_scroll_margin = 0;
15542 top_scroll_margin = this_scroll_margin;
15543 if (WINDOW_WANTS_HEADER_LINE_P (w))
15544 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15546 /* Start with the row the cursor was displayed during the last
15547 not paused redisplay. Give up if that row is not valid. */
15548 if (w->last_cursor_vpos < 0
15549 || w->last_cursor_vpos >= w->current_matrix->nrows)
15550 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15551 else
15553 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15554 if (row->mode_line_p)
15555 ++row;
15556 if (!row->enabled_p)
15557 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15560 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15562 int scroll_p = 0, must_scroll = 0;
15563 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15565 if (PT > w->last_point)
15567 /* Point has moved forward. */
15568 while (MATRIX_ROW_END_CHARPOS (row) < PT
15569 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15571 eassert (row->enabled_p);
15572 ++row;
15575 /* If the end position of a row equals the start
15576 position of the next row, and PT is at that position,
15577 we would rather display cursor in the next line. */
15578 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15579 && MATRIX_ROW_END_CHARPOS (row) == PT
15580 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15581 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15582 && !cursor_row_p (row))
15583 ++row;
15585 /* If within the scroll margin, scroll. Note that
15586 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15587 the next line would be drawn, and that
15588 this_scroll_margin can be zero. */
15589 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15590 || PT > MATRIX_ROW_END_CHARPOS (row)
15591 /* Line is completely visible last line in window
15592 and PT is to be set in the next line. */
15593 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15594 && PT == MATRIX_ROW_END_CHARPOS (row)
15595 && !row->ends_at_zv_p
15596 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15597 scroll_p = 1;
15599 else if (PT < w->last_point)
15601 /* Cursor has to be moved backward. Note that PT >=
15602 CHARPOS (startp) because of the outer if-statement. */
15603 while (!row->mode_line_p
15604 && (MATRIX_ROW_START_CHARPOS (row) > PT
15605 || (MATRIX_ROW_START_CHARPOS (row) == PT
15606 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15607 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15608 row > w->current_matrix->rows
15609 && (row-1)->ends_in_newline_from_string_p))))
15610 && (row->y > top_scroll_margin
15611 || CHARPOS (startp) == BEGV))
15613 eassert (row->enabled_p);
15614 --row;
15617 /* Consider the following case: Window starts at BEGV,
15618 there is invisible, intangible text at BEGV, so that
15619 display starts at some point START > BEGV. It can
15620 happen that we are called with PT somewhere between
15621 BEGV and START. Try to handle that case. */
15622 if (row < w->current_matrix->rows
15623 || row->mode_line_p)
15625 row = w->current_matrix->rows;
15626 if (row->mode_line_p)
15627 ++row;
15630 /* Due to newlines in overlay strings, we may have to
15631 skip forward over overlay strings. */
15632 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15633 && MATRIX_ROW_END_CHARPOS (row) == PT
15634 && !cursor_row_p (row))
15635 ++row;
15637 /* If within the scroll margin, scroll. */
15638 if (row->y < top_scroll_margin
15639 && CHARPOS (startp) != BEGV)
15640 scroll_p = 1;
15642 else
15644 /* Cursor did not move. So don't scroll even if cursor line
15645 is partially visible, as it was so before. */
15646 rc = CURSOR_MOVEMENT_SUCCESS;
15649 if (PT < MATRIX_ROW_START_CHARPOS (row)
15650 || PT > MATRIX_ROW_END_CHARPOS (row))
15652 /* if PT is not in the glyph row, give up. */
15653 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15654 must_scroll = 1;
15656 else if (rc != CURSOR_MOVEMENT_SUCCESS
15657 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15659 struct glyph_row *row1;
15661 /* If rows are bidi-reordered and point moved, back up
15662 until we find a row that does not belong to a
15663 continuation line. This is because we must consider
15664 all rows of a continued line as candidates for the
15665 new cursor positioning, since row start and end
15666 positions change non-linearly with vertical position
15667 in such rows. */
15668 /* FIXME: Revisit this when glyph ``spilling'' in
15669 continuation lines' rows is implemented for
15670 bidi-reordered rows. */
15671 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15672 MATRIX_ROW_CONTINUATION_LINE_P (row);
15673 --row)
15675 /* If we hit the beginning of the displayed portion
15676 without finding the first row of a continued
15677 line, give up. */
15678 if (row <= row1)
15680 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15681 break;
15683 eassert (row->enabled_p);
15686 if (must_scroll)
15688 else if (rc != CURSOR_MOVEMENT_SUCCESS
15689 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15690 /* Make sure this isn't a header line by any chance, since
15691 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15692 && !row->mode_line_p
15693 && make_cursor_line_fully_visible_p)
15695 if (PT == MATRIX_ROW_END_CHARPOS (row)
15696 && !row->ends_at_zv_p
15697 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15698 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15699 else if (row->height > window_box_height (w))
15701 /* If we end up in a partially visible line, let's
15702 make it fully visible, except when it's taller
15703 than the window, in which case we can't do much
15704 about it. */
15705 *scroll_step = 1;
15706 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15708 else
15710 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15711 if (!cursor_row_fully_visible_p (w, 0, 1))
15712 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15713 else
15714 rc = CURSOR_MOVEMENT_SUCCESS;
15717 else if (scroll_p)
15718 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15719 else if (rc != CURSOR_MOVEMENT_SUCCESS
15720 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15722 /* With bidi-reordered rows, there could be more than
15723 one candidate row whose start and end positions
15724 occlude point. We need to let set_cursor_from_row
15725 find the best candidate. */
15726 /* FIXME: Revisit this when glyph ``spilling'' in
15727 continuation lines' rows is implemented for
15728 bidi-reordered rows. */
15729 int rv = 0;
15733 int at_zv_p = 0, exact_match_p = 0;
15735 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15736 && PT <= MATRIX_ROW_END_CHARPOS (row)
15737 && cursor_row_p (row))
15738 rv |= set_cursor_from_row (w, row, w->current_matrix,
15739 0, 0, 0, 0);
15740 /* As soon as we've found the exact match for point,
15741 or the first suitable row whose ends_at_zv_p flag
15742 is set, we are done. */
15743 if (rv)
15745 at_zv_p = MATRIX_ROW (w->current_matrix,
15746 w->cursor.vpos)->ends_at_zv_p;
15747 if (!at_zv_p
15748 && w->cursor.hpos >= 0
15749 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15750 w->cursor.vpos))
15752 struct glyph_row *candidate =
15753 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15754 struct glyph *g =
15755 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15756 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15758 exact_match_p =
15759 (BUFFERP (g->object) && g->charpos == PT)
15760 || (INTEGERP (g->object)
15761 && (g->charpos == PT
15762 || (g->charpos == 0 && endpos - 1 == PT)));
15764 if (at_zv_p || exact_match_p)
15766 rc = CURSOR_MOVEMENT_SUCCESS;
15767 break;
15770 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15771 break;
15772 ++row;
15774 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15775 || row->continued_p)
15776 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15777 || (MATRIX_ROW_START_CHARPOS (row) == PT
15778 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15779 /* If we didn't find any candidate rows, or exited the
15780 loop before all the candidates were examined, signal
15781 to the caller that this method failed. */
15782 if (rc != CURSOR_MOVEMENT_SUCCESS
15783 && !(rv
15784 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15785 && !row->continued_p))
15786 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15787 else if (rv)
15788 rc = CURSOR_MOVEMENT_SUCCESS;
15790 else
15794 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15796 rc = CURSOR_MOVEMENT_SUCCESS;
15797 break;
15799 ++row;
15801 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15802 && MATRIX_ROW_START_CHARPOS (row) == PT
15803 && cursor_row_p (row));
15808 return rc;
15812 void
15813 set_vertical_scroll_bar (struct window *w)
15815 ptrdiff_t start, end, whole;
15817 /* Calculate the start and end positions for the current window.
15818 At some point, it would be nice to choose between scrollbars
15819 which reflect the whole buffer size, with special markers
15820 indicating narrowing, and scrollbars which reflect only the
15821 visible region.
15823 Note that mini-buffers sometimes aren't displaying any text. */
15824 if (!MINI_WINDOW_P (w)
15825 || (w == XWINDOW (minibuf_window)
15826 && NILP (echo_area_buffer[0])))
15828 struct buffer *buf = XBUFFER (w->contents);
15829 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15830 start = marker_position (w->start) - BUF_BEGV (buf);
15831 /* I don't think this is guaranteed to be right. For the
15832 moment, we'll pretend it is. */
15833 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15835 if (end < start)
15836 end = start;
15837 if (whole < (end - start))
15838 whole = end - start;
15840 else
15841 start = end = whole = 0;
15843 /* Indicate what this scroll bar ought to be displaying now. */
15844 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15845 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15846 (w, end - start, whole, start);
15850 void
15851 set_horizontal_scroll_bar (struct window *w)
15853 int start, end, whole, portion;
15855 if (!MINI_WINDOW_P (w)
15856 || (w == XWINDOW (minibuf_window)
15857 && NILP (echo_area_buffer[0])))
15859 struct buffer *b = XBUFFER (w->contents);
15860 struct buffer *old_buffer = NULL;
15861 struct it it;
15862 struct text_pos startp;
15864 if (b != current_buffer)
15866 old_buffer = current_buffer;
15867 set_buffer_internal (b);
15870 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15871 start_display (&it, w, startp);
15872 it.last_visible_x = INT_MAX;
15873 whole = move_it_to (&it, -1, INT_MAX, window_box_height (w), -1,
15874 MOVE_TO_X | MOVE_TO_Y);
15875 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15876 window_box_height (w), -1,
15877 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15879 start = w->hscroll * FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w));
15880 end = start + window_box_width (w, TEXT_AREA);
15881 portion = end - start;
15882 /* After enlarging a horizontally scrolled window such that it
15883 gets at least as wide as the text it contains, make sure that
15884 the thumb doesn't fill the entire scroll bar so we can still
15885 drag it back to see the entire text. */
15886 whole = max (whole, end);
15888 if (it.bidi_p)
15890 Lisp_Object pdir;
15892 pdir = Fcurrent_bidi_paragraph_direction (Qnil);
15893 if (EQ (pdir, Qright_to_left))
15895 start = whole - end;
15896 end = start + portion;
15900 if (old_buffer)
15901 set_buffer_internal (old_buffer);
15903 else
15904 start = end = whole = portion = 0;
15906 w->hscroll_whole = whole;
15908 /* Indicate what this scroll bar ought to be displaying now. */
15909 if (FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
15910 (*FRAME_TERMINAL (XFRAME (w->frame))->set_horizontal_scroll_bar_hook)
15911 (w, portion, whole, start);
15915 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15916 selected_window is redisplayed.
15918 We can return without actually redisplaying the window if fonts has been
15919 changed on window's frame. In that case, redisplay_internal will retry.
15921 As one of the important parts of redisplaying a window, we need to
15922 decide whether the previous window-start position (stored in the
15923 window's w->start marker position) is still valid, and if it isn't,
15924 recompute it. Some details about that:
15926 . The previous window-start could be in a continuation line, in
15927 which case we need to recompute it when the window width
15928 changes. See compute_window_start_on_continuation_line and its
15929 call below.
15931 . The text that changed since last redisplay could include the
15932 previous window-start position. In that case, we try to salvage
15933 what we can from the current glyph matrix by calling
15934 try_scrolling, which see.
15936 . Some Emacs command could force us to use a specific window-start
15937 position by setting the window's force_start flag, or gently
15938 propose doing that by setting the window's optional_new_start
15939 flag. In these cases, we try using the specified start point if
15940 that succeeds (i.e. the window desired matrix is successfully
15941 recomputed, and point location is within the window). In case
15942 of optional_new_start, we first check if the specified start
15943 position is feasible, i.e. if it will allow point to be
15944 displayed in the window. If using the specified start point
15945 fails, e.g., if new fonts are needed to be loaded, we abort the
15946 redisplay cycle and leave it up to the next cycle to figure out
15947 things.
15949 . Note that the window's force_start flag is sometimes set by
15950 redisplay itself, when it decides that the previous window start
15951 point is fine and should be kept. Search for "goto force_start"
15952 below to see the details. Like the values of window-start
15953 specified outside of redisplay, these internally-deduced values
15954 are tested for feasibility, and ignored if found to be
15955 unfeasible.
15957 . Note that the function try_window, used to completely redisplay
15958 a window, accepts the window's start point as its argument.
15959 This is used several times in the redisplay code to control
15960 where the window start will be, according to user options such
15961 as scroll-conservatively, and also to ensure the screen line
15962 showing point will be fully (as opposed to partially) visible on
15963 display. */
15965 static void
15966 redisplay_window (Lisp_Object window, bool just_this_one_p)
15968 struct window *w = XWINDOW (window);
15969 struct frame *f = XFRAME (w->frame);
15970 struct buffer *buffer = XBUFFER (w->contents);
15971 struct buffer *old = current_buffer;
15972 struct text_pos lpoint, opoint, startp;
15973 int update_mode_line;
15974 int tem;
15975 struct it it;
15976 /* Record it now because it's overwritten. */
15977 bool current_matrix_up_to_date_p = false;
15978 bool used_current_matrix_p = false;
15979 /* This is less strict than current_matrix_up_to_date_p.
15980 It indicates that the buffer contents and narrowing are unchanged. */
15981 bool buffer_unchanged_p = false;
15982 int temp_scroll_step = 0;
15983 ptrdiff_t count = SPECPDL_INDEX ();
15984 int rc;
15985 int centering_position = -1;
15986 int last_line_misfit = 0;
15987 ptrdiff_t beg_unchanged, end_unchanged;
15988 int frame_line_height;
15990 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15991 opoint = lpoint;
15993 #ifdef GLYPH_DEBUG
15994 *w->desired_matrix->method = 0;
15995 #endif
15997 if (!just_this_one_p
15998 && REDISPLAY_SOME_P ()
15999 && !w->redisplay
16000 && !f->redisplay
16001 && !buffer->text->redisplay
16002 && BUF_PT (buffer) == w->last_point)
16003 return;
16005 /* Make sure that both W's markers are valid. */
16006 eassert (XMARKER (w->start)->buffer == buffer);
16007 eassert (XMARKER (w->pointm)->buffer == buffer);
16009 /* We come here again if we need to run window-text-change-functions
16010 below. */
16011 restart:
16012 reconsider_clip_changes (w);
16013 frame_line_height = default_line_pixel_height (w);
16015 /* Has the mode line to be updated? */
16016 update_mode_line = (w->update_mode_line
16017 || update_mode_lines
16018 || buffer->clip_changed
16019 || buffer->prevent_redisplay_optimizations_p);
16021 if (!just_this_one_p)
16022 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16023 cleverly elsewhere. */
16024 w->must_be_updated_p = true;
16026 if (MINI_WINDOW_P (w))
16028 if (w == XWINDOW (echo_area_window)
16029 && !NILP (echo_area_buffer[0]))
16031 if (update_mode_line)
16032 /* We may have to update a tty frame's menu bar or a
16033 tool-bar. Example `M-x C-h C-h C-g'. */
16034 goto finish_menu_bars;
16035 else
16036 /* We've already displayed the echo area glyphs in this window. */
16037 goto finish_scroll_bars;
16039 else if ((w != XWINDOW (minibuf_window)
16040 || minibuf_level == 0)
16041 /* When buffer is nonempty, redisplay window normally. */
16042 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
16043 /* Quail displays non-mini buffers in minibuffer window.
16044 In that case, redisplay the window normally. */
16045 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
16047 /* W is a mini-buffer window, but it's not active, so clear
16048 it. */
16049 int yb = window_text_bottom_y (w);
16050 struct glyph_row *row;
16051 int y;
16053 for (y = 0, row = w->desired_matrix->rows;
16054 y < yb;
16055 y += row->height, ++row)
16056 blank_row (w, row, y);
16057 goto finish_scroll_bars;
16060 clear_glyph_matrix (w->desired_matrix);
16063 /* Otherwise set up data on this window; select its buffer and point
16064 value. */
16065 /* Really select the buffer, for the sake of buffer-local
16066 variables. */
16067 set_buffer_internal_1 (XBUFFER (w->contents));
16069 current_matrix_up_to_date_p
16070 = (w->window_end_valid
16071 && !current_buffer->clip_changed
16072 && !current_buffer->prevent_redisplay_optimizations_p
16073 && !window_outdated (w));
16075 /* Run the window-text-change-functions
16076 if it is possible that the text on the screen has changed
16077 (either due to modification of the text, or any other reason). */
16078 if (!current_matrix_up_to_date_p
16079 && !NILP (Vwindow_text_change_functions))
16081 safe_run_hooks (Qwindow_text_change_functions);
16082 goto restart;
16085 beg_unchanged = BEG_UNCHANGED;
16086 end_unchanged = END_UNCHANGED;
16088 SET_TEXT_POS (opoint, PT, PT_BYTE);
16090 specbind (Qinhibit_point_motion_hooks, Qt);
16092 buffer_unchanged_p
16093 = (w->window_end_valid
16094 && !current_buffer->clip_changed
16095 && !window_outdated (w));
16097 /* When windows_or_buffers_changed is non-zero, we can't rely
16098 on the window end being valid, so set it to zero there. */
16099 if (windows_or_buffers_changed)
16101 /* If window starts on a continuation line, maybe adjust the
16102 window start in case the window's width changed. */
16103 if (XMARKER (w->start)->buffer == current_buffer)
16104 compute_window_start_on_continuation_line (w);
16106 w->window_end_valid = false;
16107 /* If so, we also can't rely on current matrix
16108 and should not fool try_cursor_movement below. */
16109 current_matrix_up_to_date_p = false;
16112 /* Some sanity checks. */
16113 CHECK_WINDOW_END (w);
16114 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
16115 emacs_abort ();
16116 if (BYTEPOS (opoint) < CHARPOS (opoint))
16117 emacs_abort ();
16119 if (mode_line_update_needed (w))
16120 update_mode_line = 1;
16122 /* Point refers normally to the selected window. For any other
16123 window, set up appropriate value. */
16124 if (!EQ (window, selected_window))
16126 ptrdiff_t new_pt = marker_position (w->pointm);
16127 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
16129 if (new_pt < BEGV)
16131 new_pt = BEGV;
16132 new_pt_byte = BEGV_BYTE;
16133 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
16135 else if (new_pt > (ZV - 1))
16137 new_pt = ZV;
16138 new_pt_byte = ZV_BYTE;
16139 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
16142 /* We don't use SET_PT so that the point-motion hooks don't run. */
16143 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
16146 /* If any of the character widths specified in the display table
16147 have changed, invalidate the width run cache. It's true that
16148 this may be a bit late to catch such changes, but the rest of
16149 redisplay goes (non-fatally) haywire when the display table is
16150 changed, so why should we worry about doing any better? */
16151 if (current_buffer->width_run_cache
16152 || (current_buffer->base_buffer
16153 && current_buffer->base_buffer->width_run_cache))
16155 struct Lisp_Char_Table *disptab = buffer_display_table ();
16157 if (! disptab_matches_widthtab
16158 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
16160 struct buffer *buf = current_buffer;
16162 if (buf->base_buffer)
16163 buf = buf->base_buffer;
16164 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
16165 recompute_width_table (current_buffer, disptab);
16169 /* If window-start is screwed up, choose a new one. */
16170 if (XMARKER (w->start)->buffer != current_buffer)
16171 goto recenter;
16173 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16175 /* If someone specified a new starting point but did not insist,
16176 check whether it can be used. */
16177 if ((w->optional_new_start || window_frozen_p (w))
16178 && CHARPOS (startp) >= BEGV
16179 && CHARPOS (startp) <= ZV)
16181 ptrdiff_t it_charpos;
16183 w->optional_new_start = 0;
16184 start_display (&it, w, startp);
16185 move_it_to (&it, PT, 0, it.last_visible_y, -1,
16186 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
16187 /* Record IT's position now, since line_bottom_y might change
16188 that. */
16189 it_charpos = IT_CHARPOS (it);
16190 /* Make sure we set the force_start flag only if the cursor row
16191 will be fully visible. Otherwise, the code under force_start
16192 label below will try to move point back into view, which is
16193 not what the code which sets optional_new_start wants. */
16194 if ((it.current_y == 0 || line_bottom_y (&it) < it.last_visible_y)
16195 && !w->force_start)
16197 if (it_charpos == PT)
16198 w->force_start = 1;
16199 /* IT may overshoot PT if text at PT is invisible. */
16200 else if (it_charpos > PT && CHARPOS (startp) <= PT)
16201 w->force_start = 1;
16202 #ifdef GLYPH_DEBUG
16203 if (w->force_start)
16205 if (window_frozen_p (w))
16206 debug_method_add (w, "set force_start from frozen window start");
16207 else
16208 debug_method_add (w, "set force_start from optional_new_start");
16210 #endif
16214 force_start:
16216 /* Handle case where place to start displaying has been specified,
16217 unless the specified location is outside the accessible range. */
16218 if (w->force_start)
16220 /* We set this later on if we have to adjust point. */
16221 int new_vpos = -1;
16223 w->force_start = 0;
16224 w->vscroll = 0;
16225 w->window_end_valid = 0;
16227 /* Forget any recorded base line for line number display. */
16228 if (!buffer_unchanged_p)
16229 w->base_line_number = 0;
16231 /* Redisplay the mode line. Select the buffer properly for that.
16232 Also, run the hook window-scroll-functions
16233 because we have scrolled. */
16234 /* Note, we do this after clearing force_start because
16235 if there's an error, it is better to forget about force_start
16236 than to get into an infinite loop calling the hook functions
16237 and having them get more errors. */
16238 if (!update_mode_line
16239 || ! NILP (Vwindow_scroll_functions))
16241 update_mode_line = 1;
16242 w->update_mode_line = 1;
16243 startp = run_window_scroll_functions (window, startp);
16246 if (CHARPOS (startp) < BEGV)
16247 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16248 else if (CHARPOS (startp) > ZV)
16249 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16251 /* Redisplay, then check if cursor has been set during the
16252 redisplay. Give up if new fonts were loaded. */
16253 /* We used to issue a CHECK_MARGINS argument to try_window here,
16254 but this causes scrolling to fail when point begins inside
16255 the scroll margin (bug#148) -- cyd */
16256 if (!try_window (window, startp, 0))
16258 w->force_start = 1;
16259 clear_glyph_matrix (w->desired_matrix);
16260 goto need_larger_matrices;
16263 if (w->cursor.vpos < 0)
16265 /* If point does not appear, try to move point so it does
16266 appear. The desired matrix has been built above, so we
16267 can use it here. */
16268 new_vpos = window_box_height (w) / 2;
16271 if (!cursor_row_fully_visible_p (w, 0, 0))
16273 /* Point does appear, but on a line partly visible at end of window.
16274 Move it back to a fully-visible line. */
16275 new_vpos = window_box_height (w);
16276 /* But if window_box_height suggests a Y coordinate that is
16277 not less than we already have, that line will clearly not
16278 be fully visible, so give up and scroll the display.
16279 This can happen when the default face uses a font whose
16280 dimensions are different from the frame's default
16281 font. */
16282 if (new_vpos >= w->cursor.y)
16284 w->cursor.vpos = -1;
16285 clear_glyph_matrix (w->desired_matrix);
16286 goto try_to_scroll;
16289 else if (w->cursor.vpos >= 0)
16291 /* Some people insist on not letting point enter the scroll
16292 margin, even though this part handles windows that didn't
16293 scroll at all. */
16294 int window_total_lines
16295 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16296 int margin = min (scroll_margin, window_total_lines / 4);
16297 int pixel_margin = margin * frame_line_height;
16298 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16300 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16301 below, which finds the row to move point to, advances by
16302 the Y coordinate of the _next_ row, see the definition of
16303 MATRIX_ROW_BOTTOM_Y. */
16304 if (w->cursor.vpos < margin + header_line)
16306 w->cursor.vpos = -1;
16307 clear_glyph_matrix (w->desired_matrix);
16308 goto try_to_scroll;
16310 else
16312 int window_height = window_box_height (w);
16314 if (header_line)
16315 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16316 if (w->cursor.y >= window_height - pixel_margin)
16318 w->cursor.vpos = -1;
16319 clear_glyph_matrix (w->desired_matrix);
16320 goto try_to_scroll;
16325 /* If we need to move point for either of the above reasons,
16326 now actually do it. */
16327 if (new_vpos >= 0)
16329 struct glyph_row *row;
16331 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16332 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16333 ++row;
16335 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16336 MATRIX_ROW_START_BYTEPOS (row));
16338 if (w != XWINDOW (selected_window))
16339 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16340 else if (current_buffer == old)
16341 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16343 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16345 /* Re-run pre-redisplay-function so it can update the region
16346 according to the new position of point. */
16347 /* Other than the cursor, w's redisplay is done so we can set its
16348 redisplay to false. Also the buffer's redisplay can be set to
16349 false, since propagate_buffer_redisplay should have already
16350 propagated its info to `w' anyway. */
16351 w->redisplay = false;
16352 XBUFFER (w->contents)->text->redisplay = false;
16353 safe__call1 (true, Vpre_redisplay_function, Fcons (window, Qnil));
16355 if (w->redisplay || XBUFFER (w->contents)->text->redisplay)
16357 /* pre-redisplay-function made changes (e.g. move the region)
16358 that require another round of redisplay. */
16359 clear_glyph_matrix (w->desired_matrix);
16360 if (!try_window (window, startp, 0))
16361 goto need_larger_matrices;
16364 if (w->cursor.vpos < 0 || !cursor_row_fully_visible_p (w, 0, 0))
16366 clear_glyph_matrix (w->desired_matrix);
16367 goto try_to_scroll;
16370 #ifdef GLYPH_DEBUG
16371 debug_method_add (w, "forced window start");
16372 #endif
16373 goto done;
16376 /* Handle case where text has not changed, only point, and it has
16377 not moved off the frame, and we are not retrying after hscroll.
16378 (current_matrix_up_to_date_p is nonzero when retrying.) */
16379 if (current_matrix_up_to_date_p
16380 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16381 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16383 switch (rc)
16385 case CURSOR_MOVEMENT_SUCCESS:
16386 used_current_matrix_p = 1;
16387 goto done;
16389 case CURSOR_MOVEMENT_MUST_SCROLL:
16390 goto try_to_scroll;
16392 default:
16393 emacs_abort ();
16396 /* If current starting point was originally the beginning of a line
16397 but no longer is, find a new starting point. */
16398 else if (w->start_at_line_beg
16399 && !(CHARPOS (startp) <= BEGV
16400 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16402 #ifdef GLYPH_DEBUG
16403 debug_method_add (w, "recenter 1");
16404 #endif
16405 goto recenter;
16408 /* Try scrolling with try_window_id. Value is > 0 if update has
16409 been done, it is -1 if we know that the same window start will
16410 not work. It is 0 if unsuccessful for some other reason. */
16411 else if ((tem = try_window_id (w)) != 0)
16413 #ifdef GLYPH_DEBUG
16414 debug_method_add (w, "try_window_id %d", tem);
16415 #endif
16417 if (f->fonts_changed)
16418 goto need_larger_matrices;
16419 if (tem > 0)
16420 goto done;
16422 /* Otherwise try_window_id has returned -1 which means that we
16423 don't want the alternative below this comment to execute. */
16425 else if (CHARPOS (startp) >= BEGV
16426 && CHARPOS (startp) <= ZV
16427 && PT >= CHARPOS (startp)
16428 && (CHARPOS (startp) < ZV
16429 /* Avoid starting at end of buffer. */
16430 || CHARPOS (startp) == BEGV
16431 || !window_outdated (w)))
16433 int d1, d2, d5, d6;
16434 int rtop, rbot;
16436 /* If first window line is a continuation line, and window start
16437 is inside the modified region, but the first change is before
16438 current window start, we must select a new window start.
16440 However, if this is the result of a down-mouse event (e.g. by
16441 extending the mouse-drag-overlay), we don't want to select a
16442 new window start, since that would change the position under
16443 the mouse, resulting in an unwanted mouse-movement rather
16444 than a simple mouse-click. */
16445 if (!w->start_at_line_beg
16446 && NILP (do_mouse_tracking)
16447 && CHARPOS (startp) > BEGV
16448 && CHARPOS (startp) > BEG + beg_unchanged
16449 && CHARPOS (startp) <= Z - end_unchanged
16450 /* Even if w->start_at_line_beg is nil, a new window may
16451 start at a line_beg, since that's how set_buffer_window
16452 sets it. So, we need to check the return value of
16453 compute_window_start_on_continuation_line. (See also
16454 bug#197). */
16455 && XMARKER (w->start)->buffer == current_buffer
16456 && compute_window_start_on_continuation_line (w)
16457 /* It doesn't make sense to force the window start like we
16458 do at label force_start if it is already known that point
16459 will not be fully visible in the resulting window, because
16460 doing so will move point from its correct position
16461 instead of scrolling the window to bring point into view.
16462 See bug#9324. */
16463 && pos_visible_p (w, PT, &d1, &d2, &rtop, &rbot, &d5, &d6)
16464 /* A very tall row could need more than the window height,
16465 in which case we accept that it is partially visible. */
16466 && (rtop != 0) == (rbot != 0))
16468 w->force_start = 1;
16469 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16470 #ifdef GLYPH_DEBUG
16471 debug_method_add (w, "recomputed window start in continuation line");
16472 #endif
16473 goto force_start;
16476 #ifdef GLYPH_DEBUG
16477 debug_method_add (w, "same window start");
16478 #endif
16480 /* Try to redisplay starting at same place as before.
16481 If point has not moved off frame, accept the results. */
16482 if (!current_matrix_up_to_date_p
16483 /* Don't use try_window_reusing_current_matrix in this case
16484 because a window scroll function can have changed the
16485 buffer. */
16486 || !NILP (Vwindow_scroll_functions)
16487 || MINI_WINDOW_P (w)
16488 || !(used_current_matrix_p
16489 = try_window_reusing_current_matrix (w)))
16491 IF_DEBUG (debug_method_add (w, "1"));
16492 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16493 /* -1 means we need to scroll.
16494 0 means we need new matrices, but fonts_changed
16495 is set in that case, so we will detect it below. */
16496 goto try_to_scroll;
16499 if (f->fonts_changed)
16500 goto need_larger_matrices;
16502 if (w->cursor.vpos >= 0)
16504 if (!just_this_one_p
16505 || current_buffer->clip_changed
16506 || BEG_UNCHANGED < CHARPOS (startp))
16507 /* Forget any recorded base line for line number display. */
16508 w->base_line_number = 0;
16510 if (!cursor_row_fully_visible_p (w, 1, 0))
16512 clear_glyph_matrix (w->desired_matrix);
16513 last_line_misfit = 1;
16515 /* Drop through and scroll. */
16516 else
16517 goto done;
16519 else
16520 clear_glyph_matrix (w->desired_matrix);
16523 try_to_scroll:
16525 /* Redisplay the mode line. Select the buffer properly for that. */
16526 if (!update_mode_line)
16528 update_mode_line = 1;
16529 w->update_mode_line = 1;
16532 /* Try to scroll by specified few lines. */
16533 if ((scroll_conservatively
16534 || emacs_scroll_step
16535 || temp_scroll_step
16536 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16537 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16538 && CHARPOS (startp) >= BEGV
16539 && CHARPOS (startp) <= ZV)
16541 /* The function returns -1 if new fonts were loaded, 1 if
16542 successful, 0 if not successful. */
16543 int ss = try_scrolling (window, just_this_one_p,
16544 scroll_conservatively,
16545 emacs_scroll_step,
16546 temp_scroll_step, last_line_misfit);
16547 switch (ss)
16549 case SCROLLING_SUCCESS:
16550 goto done;
16552 case SCROLLING_NEED_LARGER_MATRICES:
16553 goto need_larger_matrices;
16555 case SCROLLING_FAILED:
16556 break;
16558 default:
16559 emacs_abort ();
16563 /* Finally, just choose a place to start which positions point
16564 according to user preferences. */
16566 recenter:
16568 #ifdef GLYPH_DEBUG
16569 debug_method_add (w, "recenter");
16570 #endif
16572 /* Forget any previously recorded base line for line number display. */
16573 if (!buffer_unchanged_p)
16574 w->base_line_number = 0;
16576 /* Determine the window start relative to point. */
16577 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16578 it.current_y = it.last_visible_y;
16579 if (centering_position < 0)
16581 int window_total_lines
16582 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16583 int margin =
16584 scroll_margin > 0
16585 ? min (scroll_margin, window_total_lines / 4)
16586 : 0;
16587 ptrdiff_t margin_pos = CHARPOS (startp);
16588 Lisp_Object aggressive;
16589 int scrolling_up;
16591 /* If there is a scroll margin at the top of the window, find
16592 its character position. */
16593 if (margin
16594 /* Cannot call start_display if startp is not in the
16595 accessible region of the buffer. This can happen when we
16596 have just switched to a different buffer and/or changed
16597 its restriction. In that case, startp is initialized to
16598 the character position 1 (BEGV) because we did not yet
16599 have chance to display the buffer even once. */
16600 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16602 struct it it1;
16603 void *it1data = NULL;
16605 SAVE_IT (it1, it, it1data);
16606 start_display (&it1, w, startp);
16607 move_it_vertically (&it1, margin * frame_line_height);
16608 margin_pos = IT_CHARPOS (it1);
16609 RESTORE_IT (&it, &it, it1data);
16611 scrolling_up = PT > margin_pos;
16612 aggressive =
16613 scrolling_up
16614 ? BVAR (current_buffer, scroll_up_aggressively)
16615 : BVAR (current_buffer, scroll_down_aggressively);
16617 if (!MINI_WINDOW_P (w)
16618 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16620 int pt_offset = 0;
16622 /* Setting scroll-conservatively overrides
16623 scroll-*-aggressively. */
16624 if (!scroll_conservatively && NUMBERP (aggressive))
16626 double float_amount = XFLOATINT (aggressive);
16628 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16629 if (pt_offset == 0 && float_amount > 0)
16630 pt_offset = 1;
16631 if (pt_offset && margin > 0)
16632 margin -= 1;
16634 /* Compute how much to move the window start backward from
16635 point so that point will be displayed where the user
16636 wants it. */
16637 if (scrolling_up)
16639 centering_position = it.last_visible_y;
16640 if (pt_offset)
16641 centering_position -= pt_offset;
16642 centering_position -=
16643 frame_line_height * (1 + margin + (last_line_misfit != 0))
16644 + WINDOW_HEADER_LINE_HEIGHT (w);
16645 /* Don't let point enter the scroll margin near top of
16646 the window. */
16647 if (centering_position < margin * frame_line_height)
16648 centering_position = margin * frame_line_height;
16650 else
16651 centering_position = margin * frame_line_height + pt_offset;
16653 else
16654 /* Set the window start half the height of the window backward
16655 from point. */
16656 centering_position = window_box_height (w) / 2;
16658 move_it_vertically_backward (&it, centering_position);
16660 eassert (IT_CHARPOS (it) >= BEGV);
16662 /* The function move_it_vertically_backward may move over more
16663 than the specified y-distance. If it->w is small, e.g. a
16664 mini-buffer window, we may end up in front of the window's
16665 display area. Start displaying at the start of the line
16666 containing PT in this case. */
16667 if (it.current_y <= 0)
16669 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16670 move_it_vertically_backward (&it, 0);
16671 it.current_y = 0;
16674 it.current_x = it.hpos = 0;
16676 /* Set the window start position here explicitly, to avoid an
16677 infinite loop in case the functions in window-scroll-functions
16678 get errors. */
16679 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16681 /* Run scroll hooks. */
16682 startp = run_window_scroll_functions (window, it.current.pos);
16684 /* Redisplay the window. */
16685 if (!current_matrix_up_to_date_p
16686 || windows_or_buffers_changed
16687 || f->cursor_type_changed
16688 /* Don't use try_window_reusing_current_matrix in this case
16689 because it can have changed the buffer. */
16690 || !NILP (Vwindow_scroll_functions)
16691 || !just_this_one_p
16692 || MINI_WINDOW_P (w)
16693 || !(used_current_matrix_p
16694 = try_window_reusing_current_matrix (w)))
16695 try_window (window, startp, 0);
16697 /* If new fonts have been loaded (due to fontsets), give up. We
16698 have to start a new redisplay since we need to re-adjust glyph
16699 matrices. */
16700 if (f->fonts_changed)
16701 goto need_larger_matrices;
16703 /* If cursor did not appear assume that the middle of the window is
16704 in the first line of the window. Do it again with the next line.
16705 (Imagine a window of height 100, displaying two lines of height
16706 60. Moving back 50 from it->last_visible_y will end in the first
16707 line.) */
16708 if (w->cursor.vpos < 0)
16710 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16712 clear_glyph_matrix (w->desired_matrix);
16713 move_it_by_lines (&it, 1);
16714 try_window (window, it.current.pos, 0);
16716 else if (PT < IT_CHARPOS (it))
16718 clear_glyph_matrix (w->desired_matrix);
16719 move_it_by_lines (&it, -1);
16720 try_window (window, it.current.pos, 0);
16722 else
16724 /* Not much we can do about it. */
16728 /* Consider the following case: Window starts at BEGV, there is
16729 invisible, intangible text at BEGV, so that display starts at
16730 some point START > BEGV. It can happen that we are called with
16731 PT somewhere between BEGV and START. Try to handle that case,
16732 and similar ones. */
16733 if (w->cursor.vpos < 0)
16735 /* First, try locating the proper glyph row for PT. */
16736 struct glyph_row *row =
16737 row_containing_pos (w, PT, w->current_matrix->rows, NULL, 0);
16739 /* Sometimes point is at the beginning of invisible text that is
16740 before the 1st character displayed in the row. In that case,
16741 row_containing_pos fails to find the row, because no glyphs
16742 with appropriate buffer positions are present in the row.
16743 Therefore, we next try to find the row which shows the 1st
16744 position after the invisible text. */
16745 if (!row)
16747 Lisp_Object val =
16748 get_char_property_and_overlay (make_number (PT), Qinvisible,
16749 Qnil, NULL);
16751 if (TEXT_PROP_MEANS_INVISIBLE (val))
16753 ptrdiff_t alt_pos;
16754 Lisp_Object invis_end =
16755 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16756 Qnil, Qnil);
16758 if (NATNUMP (invis_end))
16759 alt_pos = XFASTINT (invis_end);
16760 else
16761 alt_pos = ZV;
16762 row = row_containing_pos (w, alt_pos, w->current_matrix->rows,
16763 NULL, 0);
16766 /* Finally, fall back on the first row of the window after the
16767 header line (if any). This is slightly better than not
16768 displaying the cursor at all. */
16769 if (!row)
16771 row = w->current_matrix->rows;
16772 if (row->mode_line_p)
16773 ++row;
16775 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16778 if (!cursor_row_fully_visible_p (w, 0, 0))
16780 /* If vscroll is enabled, disable it and try again. */
16781 if (w->vscroll)
16783 w->vscroll = 0;
16784 clear_glyph_matrix (w->desired_matrix);
16785 goto recenter;
16788 /* Users who set scroll-conservatively to a large number want
16789 point just above/below the scroll margin. If we ended up
16790 with point's row partially visible, move the window start to
16791 make that row fully visible and out of the margin. */
16792 if (scroll_conservatively > SCROLL_LIMIT)
16794 int window_total_lines
16795 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) * frame_line_height;
16796 int margin =
16797 scroll_margin > 0
16798 ? min (scroll_margin, window_total_lines / 4)
16799 : 0;
16800 int move_down = w->cursor.vpos >= window_total_lines / 2;
16802 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16803 clear_glyph_matrix (w->desired_matrix);
16804 if (1 == try_window (window, it.current.pos,
16805 TRY_WINDOW_CHECK_MARGINS))
16806 goto done;
16809 /* If centering point failed to make the whole line visible,
16810 put point at the top instead. That has to make the whole line
16811 visible, if it can be done. */
16812 if (centering_position == 0)
16813 goto done;
16815 clear_glyph_matrix (w->desired_matrix);
16816 centering_position = 0;
16817 goto recenter;
16820 done:
16822 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16823 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16824 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16826 /* Display the mode line, if we must. */
16827 if ((update_mode_line
16828 /* If window not full width, must redo its mode line
16829 if (a) the window to its side is being redone and
16830 (b) we do a frame-based redisplay. This is a consequence
16831 of how inverted lines are drawn in frame-based redisplay. */
16832 || (!just_this_one_p
16833 && !FRAME_WINDOW_P (f)
16834 && !WINDOW_FULL_WIDTH_P (w))
16835 /* Line number to display. */
16836 || w->base_line_pos > 0
16837 /* Column number is displayed and different from the one displayed. */
16838 || (w->column_number_displayed != -1
16839 && (w->column_number_displayed != current_column ())))
16840 /* This means that the window has a mode line. */
16841 && (WINDOW_WANTS_MODELINE_P (w)
16842 || WINDOW_WANTS_HEADER_LINE_P (w)))
16845 display_mode_lines (w);
16847 /* If mode line height has changed, arrange for a thorough
16848 immediate redisplay using the correct mode line height. */
16849 if (WINDOW_WANTS_MODELINE_P (w)
16850 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16852 f->fonts_changed = 1;
16853 w->mode_line_height = -1;
16854 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16855 = DESIRED_MODE_LINE_HEIGHT (w);
16858 /* If header line height has changed, arrange for a thorough
16859 immediate redisplay using the correct header line height. */
16860 if (WINDOW_WANTS_HEADER_LINE_P (w)
16861 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16863 f->fonts_changed = 1;
16864 w->header_line_height = -1;
16865 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16866 = DESIRED_HEADER_LINE_HEIGHT (w);
16869 if (f->fonts_changed)
16870 goto need_larger_matrices;
16873 if (!line_number_displayed && w->base_line_pos != -1)
16875 w->base_line_pos = 0;
16876 w->base_line_number = 0;
16879 finish_menu_bars:
16881 /* When we reach a frame's selected window, redo the frame's menu bar. */
16882 if (update_mode_line
16883 && EQ (FRAME_SELECTED_WINDOW (f), window))
16885 int redisplay_menu_p = 0;
16887 if (FRAME_WINDOW_P (f))
16889 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16890 || defined (HAVE_NS) || defined (USE_GTK)
16891 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16892 #else
16893 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16894 #endif
16896 else
16897 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16899 if (redisplay_menu_p)
16900 display_menu_bar (w);
16902 #ifdef HAVE_WINDOW_SYSTEM
16903 if (FRAME_WINDOW_P (f))
16905 #if defined (USE_GTK) || defined (HAVE_NS)
16906 if (FRAME_EXTERNAL_TOOL_BAR (f))
16907 redisplay_tool_bar (f);
16908 #else
16909 if (WINDOWP (f->tool_bar_window)
16910 && (FRAME_TOOL_BAR_LINES (f) > 0
16911 || !NILP (Vauto_resize_tool_bars))
16912 && redisplay_tool_bar (f))
16913 ignore_mouse_drag_p = 1;
16914 #endif
16916 #endif
16919 #ifdef HAVE_WINDOW_SYSTEM
16920 if (FRAME_WINDOW_P (f)
16921 && update_window_fringes (w, (just_this_one_p
16922 || (!used_current_matrix_p && !overlay_arrow_seen)
16923 || w->pseudo_window_p)))
16925 update_begin (f);
16926 block_input ();
16927 if (draw_window_fringes (w, 1))
16929 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
16930 x_draw_right_divider (w);
16931 else
16932 x_draw_vertical_border (w);
16934 unblock_input ();
16935 update_end (f);
16938 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
16939 x_draw_bottom_divider (w);
16940 #endif /* HAVE_WINDOW_SYSTEM */
16942 /* We go to this label, with fonts_changed set, if it is
16943 necessary to try again using larger glyph matrices.
16944 We have to redeem the scroll bar even in this case,
16945 because the loop in redisplay_internal expects that. */
16946 need_larger_matrices:
16948 finish_scroll_bars:
16950 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
16952 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16953 /* Set the thumb's position and size. */
16954 set_vertical_scroll_bar (w);
16956 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
16957 /* Set the thumb's position and size. */
16958 set_horizontal_scroll_bar (w);
16960 /* Note that we actually used the scroll bar attached to this
16961 window, so it shouldn't be deleted at the end of redisplay. */
16962 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16963 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16966 /* Restore current_buffer and value of point in it. The window
16967 update may have changed the buffer, so first make sure `opoint'
16968 is still valid (Bug#6177). */
16969 if (CHARPOS (opoint) < BEGV)
16970 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16971 else if (CHARPOS (opoint) > ZV)
16972 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16973 else
16974 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16976 set_buffer_internal_1 (old);
16977 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16978 shorter. This can be caused by log truncation in *Messages*. */
16979 if (CHARPOS (lpoint) <= ZV)
16980 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16982 unbind_to (count, Qnil);
16986 /* Build the complete desired matrix of WINDOW with a window start
16987 buffer position POS.
16989 Value is 1 if successful. It is zero if fonts were loaded during
16990 redisplay which makes re-adjusting glyph matrices necessary, and -1
16991 if point would appear in the scroll margins.
16992 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16993 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16994 set in FLAGS.) */
16997 try_window (Lisp_Object window, struct text_pos pos, int flags)
16999 struct window *w = XWINDOW (window);
17000 struct it it;
17001 struct glyph_row *last_text_row = NULL;
17002 struct frame *f = XFRAME (w->frame);
17003 int frame_line_height = default_line_pixel_height (w);
17005 /* Make POS the new window start. */
17006 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
17008 /* Mark cursor position as unknown. No overlay arrow seen. */
17009 w->cursor.vpos = -1;
17010 overlay_arrow_seen = 0;
17012 /* Initialize iterator and info to start at POS. */
17013 start_display (&it, w, pos);
17014 it.glyph_row->reversed_p = false;
17016 /* Display all lines of W. */
17017 while (it.current_y < it.last_visible_y)
17019 if (display_line (&it))
17020 last_text_row = it.glyph_row - 1;
17021 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
17022 return 0;
17025 /* Don't let the cursor end in the scroll margins. */
17026 if ((flags & TRY_WINDOW_CHECK_MARGINS)
17027 && !MINI_WINDOW_P (w))
17029 int this_scroll_margin;
17030 int window_total_lines
17031 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
17033 if (scroll_margin > 0)
17035 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
17036 this_scroll_margin *= frame_line_height;
17038 else
17039 this_scroll_margin = 0;
17041 if ((w->cursor.y >= 0 /* not vscrolled */
17042 && w->cursor.y < this_scroll_margin
17043 && CHARPOS (pos) > BEGV
17044 && IT_CHARPOS (it) < ZV)
17045 /* rms: considering make_cursor_line_fully_visible_p here
17046 seems to give wrong results. We don't want to recenter
17047 when the last line is partly visible, we want to allow
17048 that case to be handled in the usual way. */
17049 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
17051 w->cursor.vpos = -1;
17052 clear_glyph_matrix (w->desired_matrix);
17053 return -1;
17057 /* If bottom moved off end of frame, change mode line percentage. */
17058 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
17059 w->update_mode_line = 1;
17061 /* Set window_end_pos to the offset of the last character displayed
17062 on the window from the end of current_buffer. Set
17063 window_end_vpos to its row number. */
17064 if (last_text_row)
17066 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
17067 adjust_window_ends (w, last_text_row, 0);
17068 eassert
17069 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
17070 w->window_end_vpos)));
17072 else
17074 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17075 w->window_end_pos = Z - ZV;
17076 w->window_end_vpos = 0;
17079 /* But that is not valid info until redisplay finishes. */
17080 w->window_end_valid = 0;
17081 return 1;
17086 /************************************************************************
17087 Window redisplay reusing current matrix when buffer has not changed
17088 ************************************************************************/
17090 /* Try redisplay of window W showing an unchanged buffer with a
17091 different window start than the last time it was displayed by
17092 reusing its current matrix. Value is non-zero if successful.
17093 W->start is the new window start. */
17095 static int
17096 try_window_reusing_current_matrix (struct window *w)
17098 struct frame *f = XFRAME (w->frame);
17099 struct glyph_row *bottom_row;
17100 struct it it;
17101 struct run run;
17102 struct text_pos start, new_start;
17103 int nrows_scrolled, i;
17104 struct glyph_row *last_text_row;
17105 struct glyph_row *last_reused_text_row;
17106 struct glyph_row *start_row;
17107 int start_vpos, min_y, max_y;
17109 #ifdef GLYPH_DEBUG
17110 if (inhibit_try_window_reusing)
17111 return 0;
17112 #endif
17114 if (/* This function doesn't handle terminal frames. */
17115 !FRAME_WINDOW_P (f)
17116 /* Don't try to reuse the display if windows have been split
17117 or such. */
17118 || windows_or_buffers_changed
17119 || f->cursor_type_changed)
17120 return 0;
17122 /* Can't do this if showing trailing whitespace. */
17123 if (!NILP (Vshow_trailing_whitespace))
17124 return 0;
17126 /* If top-line visibility has changed, give up. */
17127 if (WINDOW_WANTS_HEADER_LINE_P (w)
17128 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
17129 return 0;
17131 /* Give up if old or new display is scrolled vertically. We could
17132 make this function handle this, but right now it doesn't. */
17133 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17134 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
17135 return 0;
17137 /* The variable new_start now holds the new window start. The old
17138 start `start' can be determined from the current matrix. */
17139 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
17140 start = start_row->minpos;
17141 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17143 /* Clear the desired matrix for the display below. */
17144 clear_glyph_matrix (w->desired_matrix);
17146 if (CHARPOS (new_start) <= CHARPOS (start))
17148 /* Don't use this method if the display starts with an ellipsis
17149 displayed for invisible text. It's not easy to handle that case
17150 below, and it's certainly not worth the effort since this is
17151 not a frequent case. */
17152 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
17153 return 0;
17155 IF_DEBUG (debug_method_add (w, "twu1"));
17157 /* Display up to a row that can be reused. The variable
17158 last_text_row is set to the last row displayed that displays
17159 text. Note that it.vpos == 0 if or if not there is a
17160 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17161 start_display (&it, w, new_start);
17162 w->cursor.vpos = -1;
17163 last_text_row = last_reused_text_row = NULL;
17165 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17167 /* If we have reached into the characters in the START row,
17168 that means the line boundaries have changed. So we
17169 can't start copying with the row START. Maybe it will
17170 work to start copying with the following row. */
17171 while (IT_CHARPOS (it) > CHARPOS (start))
17173 /* Advance to the next row as the "start". */
17174 start_row++;
17175 start = start_row->minpos;
17176 /* If there are no more rows to try, or just one, give up. */
17177 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
17178 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
17179 || CHARPOS (start) == ZV)
17181 clear_glyph_matrix (w->desired_matrix);
17182 return 0;
17185 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17187 /* If we have reached alignment, we can copy the rest of the
17188 rows. */
17189 if (IT_CHARPOS (it) == CHARPOS (start)
17190 /* Don't accept "alignment" inside a display vector,
17191 since start_row could have started in the middle of
17192 that same display vector (thus their character
17193 positions match), and we have no way of telling if
17194 that is the case. */
17195 && it.current.dpvec_index < 0)
17196 break;
17198 it.glyph_row->reversed_p = false;
17199 if (display_line (&it))
17200 last_text_row = it.glyph_row - 1;
17204 /* A value of current_y < last_visible_y means that we stopped
17205 at the previous window start, which in turn means that we
17206 have at least one reusable row. */
17207 if (it.current_y < it.last_visible_y)
17209 struct glyph_row *row;
17211 /* IT.vpos always starts from 0; it counts text lines. */
17212 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
17214 /* Find PT if not already found in the lines displayed. */
17215 if (w->cursor.vpos < 0)
17217 int dy = it.current_y - start_row->y;
17219 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17220 row = row_containing_pos (w, PT, row, NULL, dy);
17221 if (row)
17222 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
17223 dy, nrows_scrolled);
17224 else
17226 clear_glyph_matrix (w->desired_matrix);
17227 return 0;
17231 /* Scroll the display. Do it before the current matrix is
17232 changed. The problem here is that update has not yet
17233 run, i.e. part of the current matrix is not up to date.
17234 scroll_run_hook will clear the cursor, and use the
17235 current matrix to get the height of the row the cursor is
17236 in. */
17237 run.current_y = start_row->y;
17238 run.desired_y = it.current_y;
17239 run.height = it.last_visible_y - it.current_y;
17241 if (run.height > 0 && run.current_y != run.desired_y)
17243 update_begin (f);
17244 FRAME_RIF (f)->update_window_begin_hook (w);
17245 FRAME_RIF (f)->clear_window_mouse_face (w);
17246 FRAME_RIF (f)->scroll_run_hook (w, &run);
17247 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17248 update_end (f);
17251 /* Shift current matrix down by nrows_scrolled lines. */
17252 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17253 rotate_matrix (w->current_matrix,
17254 start_vpos,
17255 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17256 nrows_scrolled);
17258 /* Disable lines that must be updated. */
17259 for (i = 0; i < nrows_scrolled; ++i)
17260 (start_row + i)->enabled_p = false;
17262 /* Re-compute Y positions. */
17263 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17264 max_y = it.last_visible_y;
17265 for (row = start_row + nrows_scrolled;
17266 row < bottom_row;
17267 ++row)
17269 row->y = it.current_y;
17270 row->visible_height = row->height;
17272 if (row->y < min_y)
17273 row->visible_height -= min_y - row->y;
17274 if (row->y + row->height > max_y)
17275 row->visible_height -= row->y + row->height - max_y;
17276 if (row->fringe_bitmap_periodic_p)
17277 row->redraw_fringe_bitmaps_p = 1;
17279 it.current_y += row->height;
17281 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17282 last_reused_text_row = row;
17283 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17284 break;
17287 /* Disable lines in the current matrix which are now
17288 below the window. */
17289 for (++row; row < bottom_row; ++row)
17290 row->enabled_p = row->mode_line_p = 0;
17293 /* Update window_end_pos etc.; last_reused_text_row is the last
17294 reused row from the current matrix containing text, if any.
17295 The value of last_text_row is the last displayed line
17296 containing text. */
17297 if (last_reused_text_row)
17298 adjust_window_ends (w, last_reused_text_row, 1);
17299 else if (last_text_row)
17300 adjust_window_ends (w, last_text_row, 0);
17301 else
17303 /* This window must be completely empty. */
17304 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17305 w->window_end_pos = Z - ZV;
17306 w->window_end_vpos = 0;
17308 w->window_end_valid = 0;
17310 /* Update hint: don't try scrolling again in update_window. */
17311 w->desired_matrix->no_scrolling_p = 1;
17313 #ifdef GLYPH_DEBUG
17314 debug_method_add (w, "try_window_reusing_current_matrix 1");
17315 #endif
17316 return 1;
17318 else if (CHARPOS (new_start) > CHARPOS (start))
17320 struct glyph_row *pt_row, *row;
17321 struct glyph_row *first_reusable_row;
17322 struct glyph_row *first_row_to_display;
17323 int dy;
17324 int yb = window_text_bottom_y (w);
17326 /* Find the row starting at new_start, if there is one. Don't
17327 reuse a partially visible line at the end. */
17328 first_reusable_row = start_row;
17329 while (first_reusable_row->enabled_p
17330 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17331 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17332 < CHARPOS (new_start)))
17333 ++first_reusable_row;
17335 /* Give up if there is no row to reuse. */
17336 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17337 || !first_reusable_row->enabled_p
17338 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17339 != CHARPOS (new_start)))
17340 return 0;
17342 /* We can reuse fully visible rows beginning with
17343 first_reusable_row to the end of the window. Set
17344 first_row_to_display to the first row that cannot be reused.
17345 Set pt_row to the row containing point, if there is any. */
17346 pt_row = NULL;
17347 for (first_row_to_display = first_reusable_row;
17348 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17349 ++first_row_to_display)
17351 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17352 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17353 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17354 && first_row_to_display->ends_at_zv_p
17355 && pt_row == NULL)))
17356 pt_row = first_row_to_display;
17359 /* Start displaying at the start of first_row_to_display. */
17360 eassert (first_row_to_display->y < yb);
17361 init_to_row_start (&it, w, first_row_to_display);
17363 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17364 - start_vpos);
17365 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17366 - nrows_scrolled);
17367 it.current_y = (first_row_to_display->y - first_reusable_row->y
17368 + WINDOW_HEADER_LINE_HEIGHT (w));
17370 /* Display lines beginning with first_row_to_display in the
17371 desired matrix. Set last_text_row to the last row displayed
17372 that displays text. */
17373 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17374 if (pt_row == NULL)
17375 w->cursor.vpos = -1;
17376 last_text_row = NULL;
17377 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17378 if (display_line (&it))
17379 last_text_row = it.glyph_row - 1;
17381 /* If point is in a reused row, adjust y and vpos of the cursor
17382 position. */
17383 if (pt_row)
17385 w->cursor.vpos -= nrows_scrolled;
17386 w->cursor.y -= first_reusable_row->y - start_row->y;
17389 /* Give up if point isn't in a row displayed or reused. (This
17390 also handles the case where w->cursor.vpos < nrows_scrolled
17391 after the calls to display_line, which can happen with scroll
17392 margins. See bug#1295.) */
17393 if (w->cursor.vpos < 0)
17395 clear_glyph_matrix (w->desired_matrix);
17396 return 0;
17399 /* Scroll the display. */
17400 run.current_y = first_reusable_row->y;
17401 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17402 run.height = it.last_visible_y - run.current_y;
17403 dy = run.current_y - run.desired_y;
17405 if (run.height)
17407 update_begin (f);
17408 FRAME_RIF (f)->update_window_begin_hook (w);
17409 FRAME_RIF (f)->clear_window_mouse_face (w);
17410 FRAME_RIF (f)->scroll_run_hook (w, &run);
17411 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17412 update_end (f);
17415 /* Adjust Y positions of reused rows. */
17416 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17417 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17418 max_y = it.last_visible_y;
17419 for (row = first_reusable_row; row < first_row_to_display; ++row)
17421 row->y -= dy;
17422 row->visible_height = row->height;
17423 if (row->y < min_y)
17424 row->visible_height -= min_y - row->y;
17425 if (row->y + row->height > max_y)
17426 row->visible_height -= row->y + row->height - max_y;
17427 if (row->fringe_bitmap_periodic_p)
17428 row->redraw_fringe_bitmaps_p = 1;
17431 /* Scroll the current matrix. */
17432 eassert (nrows_scrolled > 0);
17433 rotate_matrix (w->current_matrix,
17434 start_vpos,
17435 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17436 -nrows_scrolled);
17438 /* Disable rows not reused. */
17439 for (row -= nrows_scrolled; row < bottom_row; ++row)
17440 row->enabled_p = false;
17442 /* Point may have moved to a different line, so we cannot assume that
17443 the previous cursor position is valid; locate the correct row. */
17444 if (pt_row)
17446 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17447 row < bottom_row
17448 && PT >= MATRIX_ROW_END_CHARPOS (row)
17449 && !row->ends_at_zv_p;
17450 row++)
17452 w->cursor.vpos++;
17453 w->cursor.y = row->y;
17455 if (row < bottom_row)
17457 /* Can't simply scan the row for point with
17458 bidi-reordered glyph rows. Let set_cursor_from_row
17459 figure out where to put the cursor, and if it fails,
17460 give up. */
17461 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17463 if (!set_cursor_from_row (w, row, w->current_matrix,
17464 0, 0, 0, 0))
17466 clear_glyph_matrix (w->desired_matrix);
17467 return 0;
17470 else
17472 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17473 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17475 for (; glyph < end
17476 && (!BUFFERP (glyph->object)
17477 || glyph->charpos < PT);
17478 glyph++)
17480 w->cursor.hpos++;
17481 w->cursor.x += glyph->pixel_width;
17487 /* Adjust window end. A null value of last_text_row means that
17488 the window end is in reused rows which in turn means that
17489 only its vpos can have changed. */
17490 if (last_text_row)
17491 adjust_window_ends (w, last_text_row, 0);
17492 else
17493 w->window_end_vpos -= nrows_scrolled;
17495 w->window_end_valid = 0;
17496 w->desired_matrix->no_scrolling_p = 1;
17498 #ifdef GLYPH_DEBUG
17499 debug_method_add (w, "try_window_reusing_current_matrix 2");
17500 #endif
17501 return 1;
17504 return 0;
17509 /************************************************************************
17510 Window redisplay reusing current matrix when buffer has changed
17511 ************************************************************************/
17513 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17514 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17515 ptrdiff_t *, ptrdiff_t *);
17516 static struct glyph_row *
17517 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17518 struct glyph_row *);
17521 /* Return the last row in MATRIX displaying text. If row START is
17522 non-null, start searching with that row. IT gives the dimensions
17523 of the display. Value is null if matrix is empty; otherwise it is
17524 a pointer to the row found. */
17526 static struct glyph_row *
17527 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17528 struct glyph_row *start)
17530 struct glyph_row *row, *row_found;
17532 /* Set row_found to the last row in IT->w's current matrix
17533 displaying text. The loop looks funny but think of partially
17534 visible lines. */
17535 row_found = NULL;
17536 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17537 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17539 eassert (row->enabled_p);
17540 row_found = row;
17541 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17542 break;
17543 ++row;
17546 return row_found;
17550 /* Return the last row in the current matrix of W that is not affected
17551 by changes at the start of current_buffer that occurred since W's
17552 current matrix was built. Value is null if no such row exists.
17554 BEG_UNCHANGED us the number of characters unchanged at the start of
17555 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17556 first changed character in current_buffer. Characters at positions <
17557 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17558 when the current matrix was built. */
17560 static struct glyph_row *
17561 find_last_unchanged_at_beg_row (struct window *w)
17563 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17564 struct glyph_row *row;
17565 struct glyph_row *row_found = NULL;
17566 int yb = window_text_bottom_y (w);
17568 /* Find the last row displaying unchanged text. */
17569 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17570 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17571 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17572 ++row)
17574 if (/* If row ends before first_changed_pos, it is unchanged,
17575 except in some case. */
17576 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17577 /* When row ends in ZV and we write at ZV it is not
17578 unchanged. */
17579 && !row->ends_at_zv_p
17580 /* When first_changed_pos is the end of a continued line,
17581 row is not unchanged because it may be no longer
17582 continued. */
17583 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17584 && (row->continued_p
17585 || row->exact_window_width_line_p))
17586 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17587 needs to be recomputed, so don't consider this row as
17588 unchanged. This happens when the last line was
17589 bidi-reordered and was killed immediately before this
17590 redisplay cycle. In that case, ROW->end stores the
17591 buffer position of the first visual-order character of
17592 the killed text, which is now beyond ZV. */
17593 && CHARPOS (row->end.pos) <= ZV)
17594 row_found = row;
17596 /* Stop if last visible row. */
17597 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17598 break;
17601 return row_found;
17605 /* Find the first glyph row in the current matrix of W that is not
17606 affected by changes at the end of current_buffer since the
17607 time W's current matrix was built.
17609 Return in *DELTA the number of chars by which buffer positions in
17610 unchanged text at the end of current_buffer must be adjusted.
17612 Return in *DELTA_BYTES the corresponding number of bytes.
17614 Value is null if no such row exists, i.e. all rows are affected by
17615 changes. */
17617 static struct glyph_row *
17618 find_first_unchanged_at_end_row (struct window *w,
17619 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17621 struct glyph_row *row;
17622 struct glyph_row *row_found = NULL;
17624 *delta = *delta_bytes = 0;
17626 /* Display must not have been paused, otherwise the current matrix
17627 is not up to date. */
17628 eassert (w->window_end_valid);
17630 /* A value of window_end_pos >= END_UNCHANGED means that the window
17631 end is in the range of changed text. If so, there is no
17632 unchanged row at the end of W's current matrix. */
17633 if (w->window_end_pos >= END_UNCHANGED)
17634 return NULL;
17636 /* Set row to the last row in W's current matrix displaying text. */
17637 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17639 /* If matrix is entirely empty, no unchanged row exists. */
17640 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17642 /* The value of row is the last glyph row in the matrix having a
17643 meaningful buffer position in it. The end position of row
17644 corresponds to window_end_pos. This allows us to translate
17645 buffer positions in the current matrix to current buffer
17646 positions for characters not in changed text. */
17647 ptrdiff_t Z_old =
17648 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17649 ptrdiff_t Z_BYTE_old =
17650 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17651 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17652 struct glyph_row *first_text_row
17653 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17655 *delta = Z - Z_old;
17656 *delta_bytes = Z_BYTE - Z_BYTE_old;
17658 /* Set last_unchanged_pos to the buffer position of the last
17659 character in the buffer that has not been changed. Z is the
17660 index + 1 of the last character in current_buffer, i.e. by
17661 subtracting END_UNCHANGED we get the index of the last
17662 unchanged character, and we have to add BEG to get its buffer
17663 position. */
17664 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17665 last_unchanged_pos_old = last_unchanged_pos - *delta;
17667 /* Search backward from ROW for a row displaying a line that
17668 starts at a minimum position >= last_unchanged_pos_old. */
17669 for (; row > first_text_row; --row)
17671 /* This used to abort, but it can happen.
17672 It is ok to just stop the search instead here. KFS. */
17673 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17674 break;
17676 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17677 row_found = row;
17681 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17683 return row_found;
17687 /* Make sure that glyph rows in the current matrix of window W
17688 reference the same glyph memory as corresponding rows in the
17689 frame's frame matrix. This function is called after scrolling W's
17690 current matrix on a terminal frame in try_window_id and
17691 try_window_reusing_current_matrix. */
17693 static void
17694 sync_frame_with_window_matrix_rows (struct window *w)
17696 struct frame *f = XFRAME (w->frame);
17697 struct glyph_row *window_row, *window_row_end, *frame_row;
17699 /* Preconditions: W must be a leaf window and full-width. Its frame
17700 must have a frame matrix. */
17701 eassert (BUFFERP (w->contents));
17702 eassert (WINDOW_FULL_WIDTH_P (w));
17703 eassert (!FRAME_WINDOW_P (f));
17705 /* If W is a full-width window, glyph pointers in W's current matrix
17706 have, by definition, to be the same as glyph pointers in the
17707 corresponding frame matrix. Note that frame matrices have no
17708 marginal areas (see build_frame_matrix). */
17709 window_row = w->current_matrix->rows;
17710 window_row_end = window_row + w->current_matrix->nrows;
17711 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17712 while (window_row < window_row_end)
17714 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17715 struct glyph *end = window_row->glyphs[LAST_AREA];
17717 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17718 frame_row->glyphs[TEXT_AREA] = start;
17719 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17720 frame_row->glyphs[LAST_AREA] = end;
17722 /* Disable frame rows whose corresponding window rows have
17723 been disabled in try_window_id. */
17724 if (!window_row->enabled_p)
17725 frame_row->enabled_p = false;
17727 ++window_row, ++frame_row;
17732 /* Find the glyph row in window W containing CHARPOS. Consider all
17733 rows between START and END (not inclusive). END null means search
17734 all rows to the end of the display area of W. Value is the row
17735 containing CHARPOS or null. */
17737 struct glyph_row *
17738 row_containing_pos (struct window *w, ptrdiff_t charpos,
17739 struct glyph_row *start, struct glyph_row *end, int dy)
17741 struct glyph_row *row = start;
17742 struct glyph_row *best_row = NULL;
17743 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17744 int last_y;
17746 /* If we happen to start on a header-line, skip that. */
17747 if (row->mode_line_p)
17748 ++row;
17750 if ((end && row >= end) || !row->enabled_p)
17751 return NULL;
17753 last_y = window_text_bottom_y (w) - dy;
17755 while (1)
17757 /* Give up if we have gone too far. */
17758 if (end && row >= end)
17759 return NULL;
17760 /* This formerly returned if they were equal.
17761 I think that both quantities are of a "last plus one" type;
17762 if so, when they are equal, the row is within the screen. -- rms. */
17763 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17764 return NULL;
17766 /* If it is in this row, return this row. */
17767 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17768 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17769 /* The end position of a row equals the start
17770 position of the next row. If CHARPOS is there, we
17771 would rather consider it displayed in the next
17772 line, except when this line ends in ZV. */
17773 && !row_for_charpos_p (row, charpos)))
17774 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17776 struct glyph *g;
17778 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17779 || (!best_row && !row->continued_p))
17780 return row;
17781 /* In bidi-reordered rows, there could be several rows whose
17782 edges surround CHARPOS, all of these rows belonging to
17783 the same continued line. We need to find the row which
17784 fits CHARPOS the best. */
17785 for (g = row->glyphs[TEXT_AREA];
17786 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17787 g++)
17789 if (!STRINGP (g->object))
17791 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17793 mindif = eabs (g->charpos - charpos);
17794 best_row = row;
17795 /* Exact match always wins. */
17796 if (mindif == 0)
17797 return best_row;
17802 else if (best_row && !row->continued_p)
17803 return best_row;
17804 ++row;
17809 /* Try to redisplay window W by reusing its existing display. W's
17810 current matrix must be up to date when this function is called,
17811 i.e. window_end_valid must be nonzero.
17813 Value is
17815 >= 1 if successful, i.e. display has been updated
17816 specifically:
17817 1 means the changes were in front of a newline that precedes
17818 the window start, and the whole current matrix was reused
17819 2 means the changes were after the last position displayed
17820 in the window, and the whole current matrix was reused
17821 3 means portions of the current matrix were reused, while
17822 some of the screen lines were redrawn
17823 -1 if redisplay with same window start is known not to succeed
17824 0 if otherwise unsuccessful
17826 The following steps are performed:
17828 1. Find the last row in the current matrix of W that is not
17829 affected by changes at the start of current_buffer. If no such row
17830 is found, give up.
17832 2. Find the first row in W's current matrix that is not affected by
17833 changes at the end of current_buffer. Maybe there is no such row.
17835 3. Display lines beginning with the row + 1 found in step 1 to the
17836 row found in step 2 or, if step 2 didn't find a row, to the end of
17837 the window.
17839 4. If cursor is not known to appear on the window, give up.
17841 5. If display stopped at the row found in step 2, scroll the
17842 display and current matrix as needed.
17844 6. Maybe display some lines at the end of W, if we must. This can
17845 happen under various circumstances, like a partially visible line
17846 becoming fully visible, or because newly displayed lines are displayed
17847 in smaller font sizes.
17849 7. Update W's window end information. */
17851 static int
17852 try_window_id (struct window *w)
17854 struct frame *f = XFRAME (w->frame);
17855 struct glyph_matrix *current_matrix = w->current_matrix;
17856 struct glyph_matrix *desired_matrix = w->desired_matrix;
17857 struct glyph_row *last_unchanged_at_beg_row;
17858 struct glyph_row *first_unchanged_at_end_row;
17859 struct glyph_row *row;
17860 struct glyph_row *bottom_row;
17861 int bottom_vpos;
17862 struct it it;
17863 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17864 int dvpos, dy;
17865 struct text_pos start_pos;
17866 struct run run;
17867 int first_unchanged_at_end_vpos = 0;
17868 struct glyph_row *last_text_row, *last_text_row_at_end;
17869 struct text_pos start;
17870 ptrdiff_t first_changed_charpos, last_changed_charpos;
17872 #ifdef GLYPH_DEBUG
17873 if (inhibit_try_window_id)
17874 return 0;
17875 #endif
17877 /* This is handy for debugging. */
17878 #if 0
17879 #define GIVE_UP(X) \
17880 do { \
17881 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17882 return 0; \
17883 } while (0)
17884 #else
17885 #define GIVE_UP(X) return 0
17886 #endif
17888 SET_TEXT_POS_FROM_MARKER (start, w->start);
17890 /* Don't use this for mini-windows because these can show
17891 messages and mini-buffers, and we don't handle that here. */
17892 if (MINI_WINDOW_P (w))
17893 GIVE_UP (1);
17895 /* This flag is used to prevent redisplay optimizations. */
17896 if (windows_or_buffers_changed || f->cursor_type_changed)
17897 GIVE_UP (2);
17899 /* This function's optimizations cannot be used if overlays have
17900 changed in the buffer displayed by the window, so give up if they
17901 have. */
17902 if (w->last_overlay_modified != OVERLAY_MODIFF)
17903 GIVE_UP (21);
17905 /* Verify that narrowing has not changed.
17906 Also verify that we were not told to prevent redisplay optimizations.
17907 It would be nice to further
17908 reduce the number of cases where this prevents try_window_id. */
17909 if (current_buffer->clip_changed
17910 || current_buffer->prevent_redisplay_optimizations_p)
17911 GIVE_UP (3);
17913 /* Window must either use window-based redisplay or be full width. */
17914 if (!FRAME_WINDOW_P (f)
17915 && (!FRAME_LINE_INS_DEL_OK (f)
17916 || !WINDOW_FULL_WIDTH_P (w)))
17917 GIVE_UP (4);
17919 /* Give up if point is known NOT to appear in W. */
17920 if (PT < CHARPOS (start))
17921 GIVE_UP (5);
17923 /* Another way to prevent redisplay optimizations. */
17924 if (w->last_modified == 0)
17925 GIVE_UP (6);
17927 /* Verify that window is not hscrolled. */
17928 if (w->hscroll != 0)
17929 GIVE_UP (7);
17931 /* Verify that display wasn't paused. */
17932 if (!w->window_end_valid)
17933 GIVE_UP (8);
17935 /* Likewise if highlighting trailing whitespace. */
17936 if (!NILP (Vshow_trailing_whitespace))
17937 GIVE_UP (11);
17939 /* Can't use this if overlay arrow position and/or string have
17940 changed. */
17941 if (overlay_arrows_changed_p ())
17942 GIVE_UP (12);
17944 /* When word-wrap is on, adding a space to the first word of a
17945 wrapped line can change the wrap position, altering the line
17946 above it. It might be worthwhile to handle this more
17947 intelligently, but for now just redisplay from scratch. */
17948 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
17949 GIVE_UP (21);
17951 /* Under bidi reordering, adding or deleting a character in the
17952 beginning of a paragraph, before the first strong directional
17953 character, can change the base direction of the paragraph (unless
17954 the buffer specifies a fixed paragraph direction), which will
17955 require to redisplay the whole paragraph. It might be worthwhile
17956 to find the paragraph limits and widen the range of redisplayed
17957 lines to that, but for now just give up this optimization and
17958 redisplay from scratch. */
17959 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17960 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
17961 GIVE_UP (22);
17963 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17964 only if buffer has really changed. The reason is that the gap is
17965 initially at Z for freshly visited files. The code below would
17966 set end_unchanged to 0 in that case. */
17967 if (MODIFF > SAVE_MODIFF
17968 /* This seems to happen sometimes after saving a buffer. */
17969 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17971 if (GPT - BEG < BEG_UNCHANGED)
17972 BEG_UNCHANGED = GPT - BEG;
17973 if (Z - GPT < END_UNCHANGED)
17974 END_UNCHANGED = Z - GPT;
17977 /* The position of the first and last character that has been changed. */
17978 first_changed_charpos = BEG + BEG_UNCHANGED;
17979 last_changed_charpos = Z - END_UNCHANGED;
17981 /* If window starts after a line end, and the last change is in
17982 front of that newline, then changes don't affect the display.
17983 This case happens with stealth-fontification. Note that although
17984 the display is unchanged, glyph positions in the matrix have to
17985 be adjusted, of course. */
17986 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17987 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17988 && ((last_changed_charpos < CHARPOS (start)
17989 && CHARPOS (start) == BEGV)
17990 || (last_changed_charpos < CHARPOS (start) - 1
17991 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17993 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17994 struct glyph_row *r0;
17996 /* Compute how many chars/bytes have been added to or removed
17997 from the buffer. */
17998 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17999 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
18000 Z_delta = Z - Z_old;
18001 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
18003 /* Give up if PT is not in the window. Note that it already has
18004 been checked at the start of try_window_id that PT is not in
18005 front of the window start. */
18006 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
18007 GIVE_UP (13);
18009 /* If window start is unchanged, we can reuse the whole matrix
18010 as is, after adjusting glyph positions. No need to compute
18011 the window end again, since its offset from Z hasn't changed. */
18012 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
18013 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
18014 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
18015 /* PT must not be in a partially visible line. */
18016 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
18017 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
18019 /* Adjust positions in the glyph matrix. */
18020 if (Z_delta || Z_delta_bytes)
18022 struct glyph_row *r1
18023 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18024 increment_matrix_positions (w->current_matrix,
18025 MATRIX_ROW_VPOS (r0, current_matrix),
18026 MATRIX_ROW_VPOS (r1, current_matrix),
18027 Z_delta, Z_delta_bytes);
18030 /* Set the cursor. */
18031 row = row_containing_pos (w, PT, r0, NULL, 0);
18032 if (row)
18033 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
18034 return 1;
18038 /* Handle the case that changes are all below what is displayed in
18039 the window, and that PT is in the window. This shortcut cannot
18040 be taken if ZV is visible in the window, and text has been added
18041 there that is visible in the window. */
18042 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
18043 /* ZV is not visible in the window, or there are no
18044 changes at ZV, actually. */
18045 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
18046 || first_changed_charpos == last_changed_charpos))
18048 struct glyph_row *r0;
18050 /* Give up if PT is not in the window. Note that it already has
18051 been checked at the start of try_window_id that PT is not in
18052 front of the window start. */
18053 if (PT >= MATRIX_ROW_END_CHARPOS (row))
18054 GIVE_UP (14);
18056 /* If window start is unchanged, we can reuse the whole matrix
18057 as is, without changing glyph positions since no text has
18058 been added/removed in front of the window end. */
18059 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
18060 if (TEXT_POS_EQUAL_P (start, r0->minpos)
18061 /* PT must not be in a partially visible line. */
18062 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
18063 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
18065 /* We have to compute the window end anew since text
18066 could have been added/removed after it. */
18067 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18068 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18070 /* Set the cursor. */
18071 row = row_containing_pos (w, PT, r0, NULL, 0);
18072 if (row)
18073 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
18074 return 2;
18078 /* Give up if window start is in the changed area.
18080 The condition used to read
18082 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18084 but why that was tested escapes me at the moment. */
18085 if (CHARPOS (start) >= first_changed_charpos
18086 && CHARPOS (start) <= last_changed_charpos)
18087 GIVE_UP (15);
18089 /* Check that window start agrees with the start of the first glyph
18090 row in its current matrix. Check this after we know the window
18091 start is not in changed text, otherwise positions would not be
18092 comparable. */
18093 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
18094 if (!TEXT_POS_EQUAL_P (start, row->minpos))
18095 GIVE_UP (16);
18097 /* Give up if the window ends in strings. Overlay strings
18098 at the end are difficult to handle, so don't try. */
18099 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
18100 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
18101 GIVE_UP (20);
18103 /* Compute the position at which we have to start displaying new
18104 lines. Some of the lines at the top of the window might be
18105 reusable because they are not displaying changed text. Find the
18106 last row in W's current matrix not affected by changes at the
18107 start of current_buffer. Value is null if changes start in the
18108 first line of window. */
18109 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
18110 if (last_unchanged_at_beg_row)
18112 /* Avoid starting to display in the middle of a character, a TAB
18113 for instance. This is easier than to set up the iterator
18114 exactly, and it's not a frequent case, so the additional
18115 effort wouldn't really pay off. */
18116 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
18117 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
18118 && last_unchanged_at_beg_row > w->current_matrix->rows)
18119 --last_unchanged_at_beg_row;
18121 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
18122 GIVE_UP (17);
18124 if (init_to_row_end (&it, w, last_unchanged_at_beg_row) == 0)
18125 GIVE_UP (18);
18126 start_pos = it.current.pos;
18128 /* Start displaying new lines in the desired matrix at the same
18129 vpos we would use in the current matrix, i.e. below
18130 last_unchanged_at_beg_row. */
18131 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
18132 current_matrix);
18133 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18134 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
18136 eassert (it.hpos == 0 && it.current_x == 0);
18138 else
18140 /* There are no reusable lines at the start of the window.
18141 Start displaying in the first text line. */
18142 start_display (&it, w, start);
18143 it.vpos = it.first_vpos;
18144 start_pos = it.current.pos;
18147 /* Find the first row that is not affected by changes at the end of
18148 the buffer. Value will be null if there is no unchanged row, in
18149 which case we must redisplay to the end of the window. delta
18150 will be set to the value by which buffer positions beginning with
18151 first_unchanged_at_end_row have to be adjusted due to text
18152 changes. */
18153 first_unchanged_at_end_row
18154 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
18155 IF_DEBUG (debug_delta = delta);
18156 IF_DEBUG (debug_delta_bytes = delta_bytes);
18158 /* Set stop_pos to the buffer position up to which we will have to
18159 display new lines. If first_unchanged_at_end_row != NULL, this
18160 is the buffer position of the start of the line displayed in that
18161 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18162 that we don't stop at a buffer position. */
18163 stop_pos = 0;
18164 if (first_unchanged_at_end_row)
18166 eassert (last_unchanged_at_beg_row == NULL
18167 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
18169 /* If this is a continuation line, move forward to the next one
18170 that isn't. Changes in lines above affect this line.
18171 Caution: this may move first_unchanged_at_end_row to a row
18172 not displaying text. */
18173 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
18174 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18175 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18176 < it.last_visible_y))
18177 ++first_unchanged_at_end_row;
18179 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18180 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18181 >= it.last_visible_y))
18182 first_unchanged_at_end_row = NULL;
18183 else
18185 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
18186 + delta);
18187 first_unchanged_at_end_vpos
18188 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
18189 eassert (stop_pos >= Z - END_UNCHANGED);
18192 else if (last_unchanged_at_beg_row == NULL)
18193 GIVE_UP (19);
18196 #ifdef GLYPH_DEBUG
18198 /* Either there is no unchanged row at the end, or the one we have
18199 now displays text. This is a necessary condition for the window
18200 end pos calculation at the end of this function. */
18201 eassert (first_unchanged_at_end_row == NULL
18202 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18204 debug_last_unchanged_at_beg_vpos
18205 = (last_unchanged_at_beg_row
18206 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
18207 : -1);
18208 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
18210 #endif /* GLYPH_DEBUG */
18213 /* Display new lines. Set last_text_row to the last new line
18214 displayed which has text on it, i.e. might end up as being the
18215 line where the window_end_vpos is. */
18216 w->cursor.vpos = -1;
18217 last_text_row = NULL;
18218 overlay_arrow_seen = 0;
18219 if (it.current_y < it.last_visible_y
18220 && !f->fonts_changed
18221 && (first_unchanged_at_end_row == NULL
18222 || IT_CHARPOS (it) < stop_pos))
18223 it.glyph_row->reversed_p = false;
18224 while (it.current_y < it.last_visible_y
18225 && !f->fonts_changed
18226 && (first_unchanged_at_end_row == NULL
18227 || IT_CHARPOS (it) < stop_pos))
18229 if (display_line (&it))
18230 last_text_row = it.glyph_row - 1;
18233 if (f->fonts_changed)
18234 return -1;
18237 /* Compute differences in buffer positions, y-positions etc. for
18238 lines reused at the bottom of the window. Compute what we can
18239 scroll. */
18240 if (first_unchanged_at_end_row
18241 /* No lines reused because we displayed everything up to the
18242 bottom of the window. */
18243 && it.current_y < it.last_visible_y)
18245 dvpos = (it.vpos
18246 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
18247 current_matrix));
18248 dy = it.current_y - first_unchanged_at_end_row->y;
18249 run.current_y = first_unchanged_at_end_row->y;
18250 run.desired_y = run.current_y + dy;
18251 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
18253 else
18255 delta = delta_bytes = dvpos = dy
18256 = run.current_y = run.desired_y = run.height = 0;
18257 first_unchanged_at_end_row = NULL;
18259 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
18262 /* Find the cursor if not already found. We have to decide whether
18263 PT will appear on this window (it sometimes doesn't, but this is
18264 not a very frequent case.) This decision has to be made before
18265 the current matrix is altered. A value of cursor.vpos < 0 means
18266 that PT is either in one of the lines beginning at
18267 first_unchanged_at_end_row or below the window. Don't care for
18268 lines that might be displayed later at the window end; as
18269 mentioned, this is not a frequent case. */
18270 if (w->cursor.vpos < 0)
18272 /* Cursor in unchanged rows at the top? */
18273 if (PT < CHARPOS (start_pos)
18274 && last_unchanged_at_beg_row)
18276 row = row_containing_pos (w, PT,
18277 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
18278 last_unchanged_at_beg_row + 1, 0);
18279 if (row)
18280 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
18283 /* Start from first_unchanged_at_end_row looking for PT. */
18284 else if (first_unchanged_at_end_row)
18286 row = row_containing_pos (w, PT - delta,
18287 first_unchanged_at_end_row, NULL, 0);
18288 if (row)
18289 set_cursor_from_row (w, row, w->current_matrix, delta,
18290 delta_bytes, dy, dvpos);
18293 /* Give up if cursor was not found. */
18294 if (w->cursor.vpos < 0)
18296 clear_glyph_matrix (w->desired_matrix);
18297 return -1;
18301 /* Don't let the cursor end in the scroll margins. */
18303 int this_scroll_margin, cursor_height;
18304 int frame_line_height = default_line_pixel_height (w);
18305 int window_total_lines
18306 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18308 this_scroll_margin =
18309 max (0, min (scroll_margin, window_total_lines / 4));
18310 this_scroll_margin *= frame_line_height;
18311 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18313 if ((w->cursor.y < this_scroll_margin
18314 && CHARPOS (start) > BEGV)
18315 /* Old redisplay didn't take scroll margin into account at the bottom,
18316 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18317 || (w->cursor.y + (make_cursor_line_fully_visible_p
18318 ? cursor_height + this_scroll_margin
18319 : 1)) > it.last_visible_y)
18321 w->cursor.vpos = -1;
18322 clear_glyph_matrix (w->desired_matrix);
18323 return -1;
18327 /* Scroll the display. Do it before changing the current matrix so
18328 that xterm.c doesn't get confused about where the cursor glyph is
18329 found. */
18330 if (dy && run.height)
18332 update_begin (f);
18334 if (FRAME_WINDOW_P (f))
18336 FRAME_RIF (f)->update_window_begin_hook (w);
18337 FRAME_RIF (f)->clear_window_mouse_face (w);
18338 FRAME_RIF (f)->scroll_run_hook (w, &run);
18339 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
18341 else
18343 /* Terminal frame. In this case, dvpos gives the number of
18344 lines to scroll by; dvpos < 0 means scroll up. */
18345 int from_vpos
18346 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18347 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18348 int end = (WINDOW_TOP_EDGE_LINE (w)
18349 + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0)
18350 + window_internal_height (w));
18352 #if defined (HAVE_GPM) || defined (MSDOS)
18353 x_clear_window_mouse_face (w);
18354 #endif
18355 /* Perform the operation on the screen. */
18356 if (dvpos > 0)
18358 /* Scroll last_unchanged_at_beg_row to the end of the
18359 window down dvpos lines. */
18360 set_terminal_window (f, end);
18362 /* On dumb terminals delete dvpos lines at the end
18363 before inserting dvpos empty lines. */
18364 if (!FRAME_SCROLL_REGION_OK (f))
18365 ins_del_lines (f, end - dvpos, -dvpos);
18367 /* Insert dvpos empty lines in front of
18368 last_unchanged_at_beg_row. */
18369 ins_del_lines (f, from, dvpos);
18371 else if (dvpos < 0)
18373 /* Scroll up last_unchanged_at_beg_vpos to the end of
18374 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18375 set_terminal_window (f, end);
18377 /* Delete dvpos lines in front of
18378 last_unchanged_at_beg_vpos. ins_del_lines will set
18379 the cursor to the given vpos and emit |dvpos| delete
18380 line sequences. */
18381 ins_del_lines (f, from + dvpos, dvpos);
18383 /* On a dumb terminal insert dvpos empty lines at the
18384 end. */
18385 if (!FRAME_SCROLL_REGION_OK (f))
18386 ins_del_lines (f, end + dvpos, -dvpos);
18389 set_terminal_window (f, 0);
18392 update_end (f);
18395 /* Shift reused rows of the current matrix to the right position.
18396 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18397 text. */
18398 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18399 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18400 if (dvpos < 0)
18402 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18403 bottom_vpos, dvpos);
18404 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18405 bottom_vpos);
18407 else if (dvpos > 0)
18409 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18410 bottom_vpos, dvpos);
18411 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18412 first_unchanged_at_end_vpos + dvpos);
18415 /* For frame-based redisplay, make sure that current frame and window
18416 matrix are in sync with respect to glyph memory. */
18417 if (!FRAME_WINDOW_P (f))
18418 sync_frame_with_window_matrix_rows (w);
18420 /* Adjust buffer positions in reused rows. */
18421 if (delta || delta_bytes)
18422 increment_matrix_positions (current_matrix,
18423 first_unchanged_at_end_vpos + dvpos,
18424 bottom_vpos, delta, delta_bytes);
18426 /* Adjust Y positions. */
18427 if (dy)
18428 shift_glyph_matrix (w, current_matrix,
18429 first_unchanged_at_end_vpos + dvpos,
18430 bottom_vpos, dy);
18432 if (first_unchanged_at_end_row)
18434 first_unchanged_at_end_row += dvpos;
18435 if (first_unchanged_at_end_row->y >= it.last_visible_y
18436 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18437 first_unchanged_at_end_row = NULL;
18440 /* If scrolling up, there may be some lines to display at the end of
18441 the window. */
18442 last_text_row_at_end = NULL;
18443 if (dy < 0)
18445 /* Scrolling up can leave for example a partially visible line
18446 at the end of the window to be redisplayed. */
18447 /* Set last_row to the glyph row in the current matrix where the
18448 window end line is found. It has been moved up or down in
18449 the matrix by dvpos. */
18450 int last_vpos = w->window_end_vpos + dvpos;
18451 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18453 /* If last_row is the window end line, it should display text. */
18454 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18456 /* If window end line was partially visible before, begin
18457 displaying at that line. Otherwise begin displaying with the
18458 line following it. */
18459 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18461 init_to_row_start (&it, w, last_row);
18462 it.vpos = last_vpos;
18463 it.current_y = last_row->y;
18465 else
18467 init_to_row_end (&it, w, last_row);
18468 it.vpos = 1 + last_vpos;
18469 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18470 ++last_row;
18473 /* We may start in a continuation line. If so, we have to
18474 get the right continuation_lines_width and current_x. */
18475 it.continuation_lines_width = last_row->continuation_lines_width;
18476 it.hpos = it.current_x = 0;
18478 /* Display the rest of the lines at the window end. */
18479 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18480 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18482 /* Is it always sure that the display agrees with lines in
18483 the current matrix? I don't think so, so we mark rows
18484 displayed invalid in the current matrix by setting their
18485 enabled_p flag to zero. */
18486 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18487 if (display_line (&it))
18488 last_text_row_at_end = it.glyph_row - 1;
18492 /* Update window_end_pos and window_end_vpos. */
18493 if (first_unchanged_at_end_row && !last_text_row_at_end)
18495 /* Window end line if one of the preserved rows from the current
18496 matrix. Set row to the last row displaying text in current
18497 matrix starting at first_unchanged_at_end_row, after
18498 scrolling. */
18499 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18500 row = find_last_row_displaying_text (w->current_matrix, &it,
18501 first_unchanged_at_end_row);
18502 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18503 adjust_window_ends (w, row, 1);
18504 eassert (w->window_end_bytepos >= 0);
18505 IF_DEBUG (debug_method_add (w, "A"));
18507 else if (last_text_row_at_end)
18509 adjust_window_ends (w, last_text_row_at_end, 0);
18510 eassert (w->window_end_bytepos >= 0);
18511 IF_DEBUG (debug_method_add (w, "B"));
18513 else if (last_text_row)
18515 /* We have displayed either to the end of the window or at the
18516 end of the window, i.e. the last row with text is to be found
18517 in the desired matrix. */
18518 adjust_window_ends (w, last_text_row, 0);
18519 eassert (w->window_end_bytepos >= 0);
18521 else if (first_unchanged_at_end_row == NULL
18522 && last_text_row == NULL
18523 && last_text_row_at_end == NULL)
18525 /* Displayed to end of window, but no line containing text was
18526 displayed. Lines were deleted at the end of the window. */
18527 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
18528 int vpos = w->window_end_vpos;
18529 struct glyph_row *current_row = current_matrix->rows + vpos;
18530 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18532 for (row = NULL;
18533 row == NULL && vpos >= first_vpos;
18534 --vpos, --current_row, --desired_row)
18536 if (desired_row->enabled_p)
18538 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18539 row = desired_row;
18541 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18542 row = current_row;
18545 eassert (row != NULL);
18546 w->window_end_vpos = vpos + 1;
18547 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18548 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18549 eassert (w->window_end_bytepos >= 0);
18550 IF_DEBUG (debug_method_add (w, "C"));
18552 else
18553 emacs_abort ();
18555 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18556 debug_end_vpos = w->window_end_vpos));
18558 /* Record that display has not been completed. */
18559 w->window_end_valid = 0;
18560 w->desired_matrix->no_scrolling_p = 1;
18561 return 3;
18563 #undef GIVE_UP
18568 /***********************************************************************
18569 More debugging support
18570 ***********************************************************************/
18572 #ifdef GLYPH_DEBUG
18574 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18575 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18576 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18579 /* Dump the contents of glyph matrix MATRIX on stderr.
18581 GLYPHS 0 means don't show glyph contents.
18582 GLYPHS 1 means show glyphs in short form
18583 GLYPHS > 1 means show glyphs in long form. */
18585 void
18586 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18588 int i;
18589 for (i = 0; i < matrix->nrows; ++i)
18590 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18594 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18595 the glyph row and area where the glyph comes from. */
18597 void
18598 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18600 if (glyph->type == CHAR_GLYPH
18601 || glyph->type == GLYPHLESS_GLYPH)
18603 fprintf (stderr,
18604 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18605 glyph - row->glyphs[TEXT_AREA],
18606 (glyph->type == CHAR_GLYPH
18607 ? 'C'
18608 : 'G'),
18609 glyph->charpos,
18610 (BUFFERP (glyph->object)
18611 ? 'B'
18612 : (STRINGP (glyph->object)
18613 ? 'S'
18614 : (INTEGERP (glyph->object)
18615 ? '0'
18616 : '-'))),
18617 glyph->pixel_width,
18618 glyph->u.ch,
18619 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18620 ? glyph->u.ch
18621 : '.'),
18622 glyph->face_id,
18623 glyph->left_box_line_p,
18624 glyph->right_box_line_p);
18626 else if (glyph->type == STRETCH_GLYPH)
18628 fprintf (stderr,
18629 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18630 glyph - row->glyphs[TEXT_AREA],
18631 'S',
18632 glyph->charpos,
18633 (BUFFERP (glyph->object)
18634 ? 'B'
18635 : (STRINGP (glyph->object)
18636 ? 'S'
18637 : (INTEGERP (glyph->object)
18638 ? '0'
18639 : '-'))),
18640 glyph->pixel_width,
18642 ' ',
18643 glyph->face_id,
18644 glyph->left_box_line_p,
18645 glyph->right_box_line_p);
18647 else if (glyph->type == IMAGE_GLYPH)
18649 fprintf (stderr,
18650 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18651 glyph - row->glyphs[TEXT_AREA],
18652 'I',
18653 glyph->charpos,
18654 (BUFFERP (glyph->object)
18655 ? 'B'
18656 : (STRINGP (glyph->object)
18657 ? 'S'
18658 : (INTEGERP (glyph->object)
18659 ? '0'
18660 : '-'))),
18661 glyph->pixel_width,
18662 glyph->u.img_id,
18663 '.',
18664 glyph->face_id,
18665 glyph->left_box_line_p,
18666 glyph->right_box_line_p);
18668 else if (glyph->type == COMPOSITE_GLYPH)
18670 fprintf (stderr,
18671 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18672 glyph - row->glyphs[TEXT_AREA],
18673 '+',
18674 glyph->charpos,
18675 (BUFFERP (glyph->object)
18676 ? 'B'
18677 : (STRINGP (glyph->object)
18678 ? 'S'
18679 : (INTEGERP (glyph->object)
18680 ? '0'
18681 : '-'))),
18682 glyph->pixel_width,
18683 glyph->u.cmp.id);
18684 if (glyph->u.cmp.automatic)
18685 fprintf (stderr,
18686 "[%d-%d]",
18687 glyph->slice.cmp.from, glyph->slice.cmp.to);
18688 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18689 glyph->face_id,
18690 glyph->left_box_line_p,
18691 glyph->right_box_line_p);
18696 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18697 GLYPHS 0 means don't show glyph contents.
18698 GLYPHS 1 means show glyphs in short form
18699 GLYPHS > 1 means show glyphs in long form. */
18701 void
18702 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18704 if (glyphs != 1)
18706 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18707 fprintf (stderr, "==============================================================================\n");
18709 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18710 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18711 vpos,
18712 MATRIX_ROW_START_CHARPOS (row),
18713 MATRIX_ROW_END_CHARPOS (row),
18714 row->used[TEXT_AREA],
18715 row->contains_overlapping_glyphs_p,
18716 row->enabled_p,
18717 row->truncated_on_left_p,
18718 row->truncated_on_right_p,
18719 row->continued_p,
18720 MATRIX_ROW_CONTINUATION_LINE_P (row),
18721 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18722 row->ends_at_zv_p,
18723 row->fill_line_p,
18724 row->ends_in_middle_of_char_p,
18725 row->starts_in_middle_of_char_p,
18726 row->mouse_face_p,
18727 row->x,
18728 row->y,
18729 row->pixel_width,
18730 row->height,
18731 row->visible_height,
18732 row->ascent,
18733 row->phys_ascent);
18734 /* The next 3 lines should align to "Start" in the header. */
18735 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18736 row->end.overlay_string_index,
18737 row->continuation_lines_width);
18738 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18739 CHARPOS (row->start.string_pos),
18740 CHARPOS (row->end.string_pos));
18741 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18742 row->end.dpvec_index);
18745 if (glyphs > 1)
18747 int area;
18749 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18751 struct glyph *glyph = row->glyphs[area];
18752 struct glyph *glyph_end = glyph + row->used[area];
18754 /* Glyph for a line end in text. */
18755 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18756 ++glyph_end;
18758 if (glyph < glyph_end)
18759 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
18761 for (; glyph < glyph_end; ++glyph)
18762 dump_glyph (row, glyph, area);
18765 else if (glyphs == 1)
18767 int area;
18768 char s[SHRT_MAX + 4];
18770 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18772 int i;
18774 for (i = 0; i < row->used[area]; ++i)
18776 struct glyph *glyph = row->glyphs[area] + i;
18777 if (i == row->used[area] - 1
18778 && area == TEXT_AREA
18779 && INTEGERP (glyph->object)
18780 && glyph->type == CHAR_GLYPH
18781 && glyph->u.ch == ' ')
18783 strcpy (&s[i], "[\\n]");
18784 i += 4;
18786 else if (glyph->type == CHAR_GLYPH
18787 && glyph->u.ch < 0x80
18788 && glyph->u.ch >= ' ')
18789 s[i] = glyph->u.ch;
18790 else
18791 s[i] = '.';
18794 s[i] = '\0';
18795 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18801 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18802 Sdump_glyph_matrix, 0, 1, "p",
18803 doc: /* Dump the current matrix of the selected window to stderr.
18804 Shows contents of glyph row structures. With non-nil
18805 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18806 glyphs in short form, otherwise show glyphs in long form.
18808 Interactively, no argument means show glyphs in short form;
18809 with numeric argument, its value is passed as the GLYPHS flag. */)
18810 (Lisp_Object glyphs)
18812 struct window *w = XWINDOW (selected_window);
18813 struct buffer *buffer = XBUFFER (w->contents);
18815 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18816 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18817 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18818 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18819 fprintf (stderr, "=============================================\n");
18820 dump_glyph_matrix (w->current_matrix,
18821 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18822 return Qnil;
18826 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18827 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* Dump the current glyph matrix of the selected frame to stderr.
18828 Only text-mode frames have frame glyph matrices. */)
18829 (void)
18831 struct frame *f = XFRAME (selected_frame);
18833 if (f->current_matrix)
18834 dump_glyph_matrix (f->current_matrix, 1);
18835 else
18836 fprintf (stderr, "*** This frame doesn't have a frame glyph matrix ***\n");
18837 return Qnil;
18841 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18842 doc: /* Dump glyph row ROW to stderr.
18843 GLYPH 0 means don't dump glyphs.
18844 GLYPH 1 means dump glyphs in short form.
18845 GLYPH > 1 or omitted means dump glyphs in long form. */)
18846 (Lisp_Object row, Lisp_Object glyphs)
18848 struct glyph_matrix *matrix;
18849 EMACS_INT vpos;
18851 CHECK_NUMBER (row);
18852 matrix = XWINDOW (selected_window)->current_matrix;
18853 vpos = XINT (row);
18854 if (vpos >= 0 && vpos < matrix->nrows)
18855 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18856 vpos,
18857 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18858 return Qnil;
18862 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18863 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18864 GLYPH 0 means don't dump glyphs.
18865 GLYPH 1 means dump glyphs in short form.
18866 GLYPH > 1 or omitted means dump glyphs in long form.
18868 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18869 do nothing. */)
18870 (Lisp_Object row, Lisp_Object glyphs)
18872 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18873 struct frame *sf = SELECTED_FRAME ();
18874 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18875 EMACS_INT vpos;
18877 CHECK_NUMBER (row);
18878 vpos = XINT (row);
18879 if (vpos >= 0 && vpos < m->nrows)
18880 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18881 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18882 #endif
18883 return Qnil;
18887 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18888 doc: /* Toggle tracing of redisplay.
18889 With ARG, turn tracing on if and only if ARG is positive. */)
18890 (Lisp_Object arg)
18892 if (NILP (arg))
18893 trace_redisplay_p = !trace_redisplay_p;
18894 else
18896 arg = Fprefix_numeric_value (arg);
18897 trace_redisplay_p = XINT (arg) > 0;
18900 return Qnil;
18904 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18905 doc: /* Like `format', but print result to stderr.
18906 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18907 (ptrdiff_t nargs, Lisp_Object *args)
18909 Lisp_Object s = Fformat (nargs, args);
18910 fprintf (stderr, "%s", SDATA (s));
18911 return Qnil;
18914 #endif /* GLYPH_DEBUG */
18918 /***********************************************************************
18919 Building Desired Matrix Rows
18920 ***********************************************************************/
18922 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18923 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18925 static struct glyph_row *
18926 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18928 struct frame *f = XFRAME (WINDOW_FRAME (w));
18929 struct buffer *buffer = XBUFFER (w->contents);
18930 struct buffer *old = current_buffer;
18931 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18932 ptrdiff_t arrow_len = SCHARS (overlay_arrow_string);
18933 const unsigned char *arrow_end = arrow_string + arrow_len;
18934 const unsigned char *p;
18935 struct it it;
18936 bool multibyte_p;
18937 int n_glyphs_before;
18939 set_buffer_temp (buffer);
18940 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18941 scratch_glyph_row.reversed_p = false;
18942 it.glyph_row->used[TEXT_AREA] = 0;
18943 SET_TEXT_POS (it.position, 0, 0);
18945 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18946 p = arrow_string;
18947 while (p < arrow_end)
18949 Lisp_Object face, ilisp;
18951 /* Get the next character. */
18952 if (multibyte_p)
18953 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18954 else
18956 it.c = it.char_to_display = *p, it.len = 1;
18957 if (! ASCII_CHAR_P (it.c))
18958 it.char_to_display = BYTE8_TO_CHAR (it.c);
18960 p += it.len;
18962 /* Get its face. */
18963 ilisp = make_number (p - arrow_string);
18964 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18965 it.face_id = compute_char_face (f, it.char_to_display, face);
18967 /* Compute its width, get its glyphs. */
18968 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18969 SET_TEXT_POS (it.position, -1, -1);
18970 PRODUCE_GLYPHS (&it);
18972 /* If this character doesn't fit any more in the line, we have
18973 to remove some glyphs. */
18974 if (it.current_x > it.last_visible_x)
18976 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18977 break;
18981 set_buffer_temp (old);
18982 return it.glyph_row;
18986 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18987 glyphs to insert is determined by produce_special_glyphs. */
18989 static void
18990 insert_left_trunc_glyphs (struct it *it)
18992 struct it truncate_it;
18993 struct glyph *from, *end, *to, *toend;
18995 eassert (!FRAME_WINDOW_P (it->f)
18996 || (!it->glyph_row->reversed_p
18997 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18998 || (it->glyph_row->reversed_p
18999 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
19001 /* Get the truncation glyphs. */
19002 truncate_it = *it;
19003 truncate_it.current_x = 0;
19004 truncate_it.face_id = DEFAULT_FACE_ID;
19005 truncate_it.glyph_row = &scratch_glyph_row;
19006 truncate_it.area = TEXT_AREA;
19007 truncate_it.glyph_row->used[TEXT_AREA] = 0;
19008 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
19009 truncate_it.object = make_number (0);
19010 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
19012 /* Overwrite glyphs from IT with truncation glyphs. */
19013 if (!it->glyph_row->reversed_p)
19015 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19017 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19018 end = from + tused;
19019 to = it->glyph_row->glyphs[TEXT_AREA];
19020 toend = to + it->glyph_row->used[TEXT_AREA];
19021 if (FRAME_WINDOW_P (it->f))
19023 /* On GUI frames, when variable-size fonts are displayed,
19024 the truncation glyphs may need more pixels than the row's
19025 glyphs they overwrite. We overwrite more glyphs to free
19026 enough screen real estate, and enlarge the stretch glyph
19027 on the right (see display_line), if there is one, to
19028 preserve the screen position of the truncation glyphs on
19029 the right. */
19030 int w = 0;
19031 struct glyph *g = to;
19032 short used;
19034 /* The first glyph could be partially visible, in which case
19035 it->glyph_row->x will be negative. But we want the left
19036 truncation glyphs to be aligned at the left margin of the
19037 window, so we override the x coordinate at which the row
19038 will begin. */
19039 it->glyph_row->x = 0;
19040 while (g < toend && w < it->truncation_pixel_width)
19042 w += g->pixel_width;
19043 ++g;
19045 if (g - to - tused > 0)
19047 memmove (to + tused, g, (toend - g) * sizeof(*g));
19048 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
19050 used = it->glyph_row->used[TEXT_AREA];
19051 if (it->glyph_row->truncated_on_right_p
19052 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
19053 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
19054 == STRETCH_GLYPH)
19056 int extra = w - it->truncation_pixel_width;
19058 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
19062 while (from < end)
19063 *to++ = *from++;
19065 /* There may be padding glyphs left over. Overwrite them too. */
19066 if (!FRAME_WINDOW_P (it->f))
19068 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
19070 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19071 while (from < end)
19072 *to++ = *from++;
19076 if (to > toend)
19077 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
19079 else
19081 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19083 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19084 that back to front. */
19085 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
19086 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19087 toend = it->glyph_row->glyphs[TEXT_AREA];
19088 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
19089 if (FRAME_WINDOW_P (it->f))
19091 int w = 0;
19092 struct glyph *g = to;
19094 while (g >= toend && w < it->truncation_pixel_width)
19096 w += g->pixel_width;
19097 --g;
19099 if (to - g - tused > 0)
19100 to = g + tused;
19101 if (it->glyph_row->truncated_on_right_p
19102 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
19103 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
19105 int extra = w - it->truncation_pixel_width;
19107 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
19111 while (from >= end && to >= toend)
19112 *to-- = *from--;
19113 if (!FRAME_WINDOW_P (it->f))
19115 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
19117 from =
19118 truncate_it.glyph_row->glyphs[TEXT_AREA]
19119 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19120 while (from >= end && to >= toend)
19121 *to-- = *from--;
19124 if (from >= end)
19126 /* Need to free some room before prepending additional
19127 glyphs. */
19128 int move_by = from - end + 1;
19129 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
19130 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
19132 for ( ; g >= g0; g--)
19133 g[move_by] = *g;
19134 while (from >= end)
19135 *to-- = *from--;
19136 it->glyph_row->used[TEXT_AREA] += move_by;
19141 /* Compute the hash code for ROW. */
19142 unsigned
19143 row_hash (struct glyph_row *row)
19145 int area, k;
19146 unsigned hashval = 0;
19148 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19149 for (k = 0; k < row->used[area]; ++k)
19150 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
19151 + row->glyphs[area][k].u.val
19152 + row->glyphs[area][k].face_id
19153 + row->glyphs[area][k].padding_p
19154 + (row->glyphs[area][k].type << 2));
19156 return hashval;
19159 /* Compute the pixel height and width of IT->glyph_row.
19161 Most of the time, ascent and height of a display line will be equal
19162 to the max_ascent and max_height values of the display iterator
19163 structure. This is not the case if
19165 1. We hit ZV without displaying anything. In this case, max_ascent
19166 and max_height will be zero.
19168 2. We have some glyphs that don't contribute to the line height.
19169 (The glyph row flag contributes_to_line_height_p is for future
19170 pixmap extensions).
19172 The first case is easily covered by using default values because in
19173 these cases, the line height does not really matter, except that it
19174 must not be zero. */
19176 static void
19177 compute_line_metrics (struct it *it)
19179 struct glyph_row *row = it->glyph_row;
19181 if (FRAME_WINDOW_P (it->f))
19183 int i, min_y, max_y;
19185 /* The line may consist of one space only, that was added to
19186 place the cursor on it. If so, the row's height hasn't been
19187 computed yet. */
19188 if (row->height == 0)
19190 if (it->max_ascent + it->max_descent == 0)
19191 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
19192 row->ascent = it->max_ascent;
19193 row->height = it->max_ascent + it->max_descent;
19194 row->phys_ascent = it->max_phys_ascent;
19195 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19196 row->extra_line_spacing = it->max_extra_line_spacing;
19199 /* Compute the width of this line. */
19200 row->pixel_width = row->x;
19201 for (i = 0; i < row->used[TEXT_AREA]; ++i)
19202 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
19204 eassert (row->pixel_width >= 0);
19205 eassert (row->ascent >= 0 && row->height > 0);
19207 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
19208 || MATRIX_ROW_OVERLAPS_PRED_P (row));
19210 /* If first line's physical ascent is larger than its logical
19211 ascent, use the physical ascent, and make the row taller.
19212 This makes accented characters fully visible. */
19213 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
19214 && row->phys_ascent > row->ascent)
19216 row->height += row->phys_ascent - row->ascent;
19217 row->ascent = row->phys_ascent;
19220 /* Compute how much of the line is visible. */
19221 row->visible_height = row->height;
19223 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
19224 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
19226 if (row->y < min_y)
19227 row->visible_height -= min_y - row->y;
19228 if (row->y + row->height > max_y)
19229 row->visible_height -= row->y + row->height - max_y;
19231 else
19233 row->pixel_width = row->used[TEXT_AREA];
19234 if (row->continued_p)
19235 row->pixel_width -= it->continuation_pixel_width;
19236 else if (row->truncated_on_right_p)
19237 row->pixel_width -= it->truncation_pixel_width;
19238 row->ascent = row->phys_ascent = 0;
19239 row->height = row->phys_height = row->visible_height = 1;
19240 row->extra_line_spacing = 0;
19243 /* Compute a hash code for this row. */
19244 row->hash = row_hash (row);
19246 it->max_ascent = it->max_descent = 0;
19247 it->max_phys_ascent = it->max_phys_descent = 0;
19251 /* Append one space to the glyph row of iterator IT if doing a
19252 window-based redisplay. The space has the same face as
19253 IT->face_id. Value is non-zero if a space was added.
19255 This function is called to make sure that there is always one glyph
19256 at the end of a glyph row that the cursor can be set on under
19257 window-systems. (If there weren't such a glyph we would not know
19258 how wide and tall a box cursor should be displayed).
19260 At the same time this space let's a nicely handle clearing to the
19261 end of the line if the row ends in italic text. */
19263 static int
19264 append_space_for_newline (struct it *it, int default_face_p)
19266 if (FRAME_WINDOW_P (it->f))
19268 int n = it->glyph_row->used[TEXT_AREA];
19270 if (it->glyph_row->glyphs[TEXT_AREA] + n
19271 < it->glyph_row->glyphs[1 + TEXT_AREA])
19273 /* Save some values that must not be changed.
19274 Must save IT->c and IT->len because otherwise
19275 ITERATOR_AT_END_P wouldn't work anymore after
19276 append_space_for_newline has been called. */
19277 enum display_element_type saved_what = it->what;
19278 int saved_c = it->c, saved_len = it->len;
19279 int saved_char_to_display = it->char_to_display;
19280 int saved_x = it->current_x;
19281 int saved_face_id = it->face_id;
19282 int saved_box_end = it->end_of_box_run_p;
19283 struct text_pos saved_pos;
19284 Lisp_Object saved_object;
19285 struct face *face;
19287 saved_object = it->object;
19288 saved_pos = it->position;
19290 it->what = IT_CHARACTER;
19291 memset (&it->position, 0, sizeof it->position);
19292 it->object = make_number (0);
19293 it->c = it->char_to_display = ' ';
19294 it->len = 1;
19296 /* If the default face was remapped, be sure to use the
19297 remapped face for the appended newline. */
19298 if (default_face_p)
19299 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19300 else if (it->face_before_selective_p)
19301 it->face_id = it->saved_face_id;
19302 face = FACE_FROM_ID (it->f, it->face_id);
19303 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19304 /* In R2L rows, we will prepend a stretch glyph that will
19305 have the end_of_box_run_p flag set for it, so there's no
19306 need for the appended newline glyph to have that flag
19307 set. */
19308 if (it->glyph_row->reversed_p
19309 /* But if the appended newline glyph goes all the way to
19310 the end of the row, there will be no stretch glyph,
19311 so leave the box flag set. */
19312 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19313 it->end_of_box_run_p = 0;
19315 PRODUCE_GLYPHS (it);
19317 it->override_ascent = -1;
19318 it->constrain_row_ascent_descent_p = 0;
19319 it->current_x = saved_x;
19320 it->object = saved_object;
19321 it->position = saved_pos;
19322 it->what = saved_what;
19323 it->face_id = saved_face_id;
19324 it->len = saved_len;
19325 it->c = saved_c;
19326 it->char_to_display = saved_char_to_display;
19327 it->end_of_box_run_p = saved_box_end;
19328 return 1;
19332 return 0;
19336 /* Extend the face of the last glyph in the text area of IT->glyph_row
19337 to the end of the display line. Called from display_line. If the
19338 glyph row is empty, add a space glyph to it so that we know the
19339 face to draw. Set the glyph row flag fill_line_p. If the glyph
19340 row is R2L, prepend a stretch glyph to cover the empty space to the
19341 left of the leftmost glyph. */
19343 static void
19344 extend_face_to_end_of_line (struct it *it)
19346 struct face *face, *default_face;
19347 struct frame *f = it->f;
19349 /* If line is already filled, do nothing. Non window-system frames
19350 get a grace of one more ``pixel'' because their characters are
19351 1-``pixel'' wide, so they hit the equality too early. This grace
19352 is needed only for R2L rows that are not continued, to produce
19353 one extra blank where we could display the cursor. */
19354 if ((it->current_x >= it->last_visible_x
19355 + (!FRAME_WINDOW_P (f)
19356 && it->glyph_row->reversed_p
19357 && !it->glyph_row->continued_p))
19358 /* If the window has display margins, we will need to extend
19359 their face even if the text area is filled. */
19360 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19361 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19362 return;
19364 /* The default face, possibly remapped. */
19365 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
19367 /* Face extension extends the background and box of IT->face_id
19368 to the end of the line. If the background equals the background
19369 of the frame, we don't have to do anything. */
19370 if (it->face_before_selective_p)
19371 face = FACE_FROM_ID (f, it->saved_face_id);
19372 else
19373 face = FACE_FROM_ID (f, it->face_id);
19375 if (FRAME_WINDOW_P (f)
19376 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19377 && face->box == FACE_NO_BOX
19378 && face->background == FRAME_BACKGROUND_PIXEL (f)
19379 #ifdef HAVE_WINDOW_SYSTEM
19380 && !face->stipple
19381 #endif
19382 && !it->glyph_row->reversed_p)
19383 return;
19385 /* Set the glyph row flag indicating that the face of the last glyph
19386 in the text area has to be drawn to the end of the text area. */
19387 it->glyph_row->fill_line_p = 1;
19389 /* If current character of IT is not ASCII, make sure we have the
19390 ASCII face. This will be automatically undone the next time
19391 get_next_display_element returns a multibyte character. Note
19392 that the character will always be single byte in unibyte
19393 text. */
19394 if (!ASCII_CHAR_P (it->c))
19396 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19399 if (FRAME_WINDOW_P (f))
19401 /* If the row is empty, add a space with the current face of IT,
19402 so that we know which face to draw. */
19403 if (it->glyph_row->used[TEXT_AREA] == 0)
19405 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19406 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19407 it->glyph_row->used[TEXT_AREA] = 1;
19409 /* Mode line and the header line don't have margins, and
19410 likewise the frame's tool-bar window, if there is any. */
19411 if (!(it->glyph_row->mode_line_p
19412 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19413 || (WINDOWP (f->tool_bar_window)
19414 && it->w == XWINDOW (f->tool_bar_window))
19415 #endif
19418 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19419 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19421 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19422 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19423 default_face->id;
19424 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19426 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19427 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19429 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19430 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19431 default_face->id;
19432 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19435 #ifdef HAVE_WINDOW_SYSTEM
19436 if (it->glyph_row->reversed_p)
19438 /* Prepend a stretch glyph to the row, such that the
19439 rightmost glyph will be drawn flushed all the way to the
19440 right margin of the window. The stretch glyph that will
19441 occupy the empty space, if any, to the left of the
19442 glyphs. */
19443 struct font *font = face->font ? face->font : FRAME_FONT (f);
19444 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19445 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19446 struct glyph *g;
19447 int row_width, stretch_ascent, stretch_width;
19448 struct text_pos saved_pos;
19449 int saved_face_id, saved_avoid_cursor, saved_box_start;
19451 for (row_width = 0, g = row_start; g < row_end; g++)
19452 row_width += g->pixel_width;
19454 /* FIXME: There are various minor display glitches in R2L
19455 rows when only one of the fringes is missing. The
19456 strange condition below produces the least bad effect. */
19457 if ((WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19458 == (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
19459 || WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
19460 stretch_width = window_box_width (it->w, TEXT_AREA);
19461 else
19462 stretch_width = it->last_visible_x - it->first_visible_x;
19463 stretch_width -= row_width;
19465 if (stretch_width > 0)
19467 stretch_ascent =
19468 (((it->ascent + it->descent)
19469 * FONT_BASE (font)) / FONT_HEIGHT (font));
19470 saved_pos = it->position;
19471 memset (&it->position, 0, sizeof it->position);
19472 saved_avoid_cursor = it->avoid_cursor_p;
19473 it->avoid_cursor_p = 1;
19474 saved_face_id = it->face_id;
19475 saved_box_start = it->start_of_box_run_p;
19476 /* The last row's stretch glyph should get the default
19477 face, to avoid painting the rest of the window with
19478 the region face, if the region ends at ZV. */
19479 if (it->glyph_row->ends_at_zv_p)
19480 it->face_id = default_face->id;
19481 else
19482 it->face_id = face->id;
19483 it->start_of_box_run_p = 0;
19484 append_stretch_glyph (it, make_number (0), stretch_width,
19485 it->ascent + it->descent, stretch_ascent);
19486 it->position = saved_pos;
19487 it->avoid_cursor_p = saved_avoid_cursor;
19488 it->face_id = saved_face_id;
19489 it->start_of_box_run_p = saved_box_start;
19491 /* If stretch_width comes out negative, it means that the
19492 last glyph is only partially visible. In R2L rows, we
19493 want the leftmost glyph to be partially visible, so we
19494 need to give the row the corresponding left offset. */
19495 if (stretch_width < 0)
19496 it->glyph_row->x = stretch_width;
19498 #endif /* HAVE_WINDOW_SYSTEM */
19500 else
19502 /* Save some values that must not be changed. */
19503 int saved_x = it->current_x;
19504 struct text_pos saved_pos;
19505 Lisp_Object saved_object;
19506 enum display_element_type saved_what = it->what;
19507 int saved_face_id = it->face_id;
19509 saved_object = it->object;
19510 saved_pos = it->position;
19512 it->what = IT_CHARACTER;
19513 memset (&it->position, 0, sizeof it->position);
19514 it->object = make_number (0);
19515 it->c = it->char_to_display = ' ';
19516 it->len = 1;
19518 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19519 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19520 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19521 && !it->glyph_row->mode_line_p
19522 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19524 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19525 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19527 for (it->current_x = 0; g < e; g++)
19528 it->current_x += g->pixel_width;
19530 it->area = LEFT_MARGIN_AREA;
19531 it->face_id = default_face->id;
19532 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19533 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19535 PRODUCE_GLYPHS (it);
19536 /* term.c:produce_glyphs advances it->current_x only for
19537 TEXT_AREA. */
19538 it->current_x += it->pixel_width;
19541 it->current_x = saved_x;
19542 it->area = TEXT_AREA;
19545 /* The last row's blank glyphs should get the default face, to
19546 avoid painting the rest of the window with the region face,
19547 if the region ends at ZV. */
19548 if (it->glyph_row->ends_at_zv_p)
19549 it->face_id = default_face->id;
19550 else
19551 it->face_id = face->id;
19552 PRODUCE_GLYPHS (it);
19554 while (it->current_x <= it->last_visible_x)
19555 PRODUCE_GLYPHS (it);
19557 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19558 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19559 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19560 && !it->glyph_row->mode_line_p
19561 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19563 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19564 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19566 for ( ; g < e; g++)
19567 it->current_x += g->pixel_width;
19569 it->area = RIGHT_MARGIN_AREA;
19570 it->face_id = default_face->id;
19571 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19572 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19574 PRODUCE_GLYPHS (it);
19575 it->current_x += it->pixel_width;
19578 it->area = TEXT_AREA;
19581 /* Don't count these blanks really. It would let us insert a left
19582 truncation glyph below and make us set the cursor on them, maybe. */
19583 it->current_x = saved_x;
19584 it->object = saved_object;
19585 it->position = saved_pos;
19586 it->what = saved_what;
19587 it->face_id = saved_face_id;
19592 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19593 trailing whitespace. */
19595 static int
19596 trailing_whitespace_p (ptrdiff_t charpos)
19598 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19599 int c = 0;
19601 while (bytepos < ZV_BYTE
19602 && (c = FETCH_CHAR (bytepos),
19603 c == ' ' || c == '\t'))
19604 ++bytepos;
19606 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19608 if (bytepos != PT_BYTE)
19609 return 1;
19611 return 0;
19615 /* Highlight trailing whitespace, if any, in ROW. */
19617 static void
19618 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19620 int used = row->used[TEXT_AREA];
19622 if (used)
19624 struct glyph *start = row->glyphs[TEXT_AREA];
19625 struct glyph *glyph = start + used - 1;
19627 if (row->reversed_p)
19629 /* Right-to-left rows need to be processed in the opposite
19630 direction, so swap the edge pointers. */
19631 glyph = start;
19632 start = row->glyphs[TEXT_AREA] + used - 1;
19635 /* Skip over glyphs inserted to display the cursor at the
19636 end of a line, for extending the face of the last glyph
19637 to the end of the line on terminals, and for truncation
19638 and continuation glyphs. */
19639 if (!row->reversed_p)
19641 while (glyph >= start
19642 && glyph->type == CHAR_GLYPH
19643 && INTEGERP (glyph->object))
19644 --glyph;
19646 else
19648 while (glyph <= start
19649 && glyph->type == CHAR_GLYPH
19650 && INTEGERP (glyph->object))
19651 ++glyph;
19654 /* If last glyph is a space or stretch, and it's trailing
19655 whitespace, set the face of all trailing whitespace glyphs in
19656 IT->glyph_row to `trailing-whitespace'. */
19657 if ((row->reversed_p ? glyph <= start : glyph >= start)
19658 && BUFFERP (glyph->object)
19659 && (glyph->type == STRETCH_GLYPH
19660 || (glyph->type == CHAR_GLYPH
19661 && glyph->u.ch == ' '))
19662 && trailing_whitespace_p (glyph->charpos))
19664 int face_id = lookup_named_face (f, Qtrailing_whitespace, 0);
19665 if (face_id < 0)
19666 return;
19668 if (!row->reversed_p)
19670 while (glyph >= start
19671 && BUFFERP (glyph->object)
19672 && (glyph->type == STRETCH_GLYPH
19673 || (glyph->type == CHAR_GLYPH
19674 && glyph->u.ch == ' ')))
19675 (glyph--)->face_id = face_id;
19677 else
19679 while (glyph <= start
19680 && BUFFERP (glyph->object)
19681 && (glyph->type == STRETCH_GLYPH
19682 || (glyph->type == CHAR_GLYPH
19683 && glyph->u.ch == ' ')))
19684 (glyph++)->face_id = face_id;
19691 /* Value is non-zero if glyph row ROW should be
19692 considered to hold the buffer position CHARPOS. */
19694 static int
19695 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
19697 int result = 1;
19699 if (charpos == CHARPOS (row->end.pos)
19700 || charpos == MATRIX_ROW_END_CHARPOS (row))
19702 /* Suppose the row ends on a string.
19703 Unless the row is continued, that means it ends on a newline
19704 in the string. If it's anything other than a display string
19705 (e.g., a before-string from an overlay), we don't want the
19706 cursor there. (This heuristic seems to give the optimal
19707 behavior for the various types of multi-line strings.)
19708 One exception: if the string has `cursor' property on one of
19709 its characters, we _do_ want the cursor there. */
19710 if (CHARPOS (row->end.string_pos) >= 0)
19712 if (row->continued_p)
19713 result = 1;
19714 else
19716 /* Check for `display' property. */
19717 struct glyph *beg = row->glyphs[TEXT_AREA];
19718 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
19719 struct glyph *glyph;
19721 result = 0;
19722 for (glyph = end; glyph >= beg; --glyph)
19723 if (STRINGP (glyph->object))
19725 Lisp_Object prop
19726 = Fget_char_property (make_number (charpos),
19727 Qdisplay, Qnil);
19728 result =
19729 (!NILP (prop)
19730 && display_prop_string_p (prop, glyph->object));
19731 /* If there's a `cursor' property on one of the
19732 string's characters, this row is a cursor row,
19733 even though this is not a display string. */
19734 if (!result)
19736 Lisp_Object s = glyph->object;
19738 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
19740 ptrdiff_t gpos = glyph->charpos;
19742 if (!NILP (Fget_char_property (make_number (gpos),
19743 Qcursor, s)))
19745 result = 1;
19746 break;
19750 break;
19754 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
19756 /* If the row ends in middle of a real character,
19757 and the line is continued, we want the cursor here.
19758 That's because CHARPOS (ROW->end.pos) would equal
19759 PT if PT is before the character. */
19760 if (!row->ends_in_ellipsis_p)
19761 result = row->continued_p;
19762 else
19763 /* If the row ends in an ellipsis, then
19764 CHARPOS (ROW->end.pos) will equal point after the
19765 invisible text. We want that position to be displayed
19766 after the ellipsis. */
19767 result = 0;
19769 /* If the row ends at ZV, display the cursor at the end of that
19770 row instead of at the start of the row below. */
19771 else if (row->ends_at_zv_p)
19772 result = 1;
19773 else
19774 result = 0;
19777 return result;
19780 /* Value is non-zero if glyph row ROW should be
19781 used to hold the cursor. */
19783 static int
19784 cursor_row_p (struct glyph_row *row)
19786 return row_for_charpos_p (row, PT);
19791 /* Push the property PROP so that it will be rendered at the current
19792 position in IT. Return 1 if PROP was successfully pushed, 0
19793 otherwise. Called from handle_line_prefix to handle the
19794 `line-prefix' and `wrap-prefix' properties. */
19796 static int
19797 push_prefix_prop (struct it *it, Lisp_Object prop)
19799 struct text_pos pos =
19800 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
19802 eassert (it->method == GET_FROM_BUFFER
19803 || it->method == GET_FROM_DISPLAY_VECTOR
19804 || it->method == GET_FROM_STRING);
19806 /* We need to save the current buffer/string position, so it will be
19807 restored by pop_it, because iterate_out_of_display_property
19808 depends on that being set correctly, but some situations leave
19809 it->position not yet set when this function is called. */
19810 push_it (it, &pos);
19812 if (STRINGP (prop))
19814 if (SCHARS (prop) == 0)
19816 pop_it (it);
19817 return 0;
19820 it->string = prop;
19821 it->string_from_prefix_prop_p = 1;
19822 it->multibyte_p = STRING_MULTIBYTE (it->string);
19823 it->current.overlay_string_index = -1;
19824 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
19825 it->end_charpos = it->string_nchars = SCHARS (it->string);
19826 it->method = GET_FROM_STRING;
19827 it->stop_charpos = 0;
19828 it->prev_stop = 0;
19829 it->base_level_stop = 0;
19831 /* Force paragraph direction to be that of the parent
19832 buffer/string. */
19833 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
19834 it->paragraph_embedding = it->bidi_it.paragraph_dir;
19835 else
19836 it->paragraph_embedding = L2R;
19838 /* Set up the bidi iterator for this display string. */
19839 if (it->bidi_p)
19841 it->bidi_it.string.lstring = it->string;
19842 it->bidi_it.string.s = NULL;
19843 it->bidi_it.string.schars = it->end_charpos;
19844 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19845 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19846 it->bidi_it.string.unibyte = !it->multibyte_p;
19847 it->bidi_it.w = it->w;
19848 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19851 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19853 it->method = GET_FROM_STRETCH;
19854 it->object = prop;
19856 #ifdef HAVE_WINDOW_SYSTEM
19857 else if (IMAGEP (prop))
19859 it->what = IT_IMAGE;
19860 it->image_id = lookup_image (it->f, prop);
19861 it->method = GET_FROM_IMAGE;
19863 #endif /* HAVE_WINDOW_SYSTEM */
19864 else
19866 pop_it (it); /* bogus display property, give up */
19867 return 0;
19870 return 1;
19873 /* Return the character-property PROP at the current position in IT. */
19875 static Lisp_Object
19876 get_it_property (struct it *it, Lisp_Object prop)
19878 Lisp_Object position, object = it->object;
19880 if (STRINGP (object))
19881 position = make_number (IT_STRING_CHARPOS (*it));
19882 else if (BUFFERP (object))
19884 position = make_number (IT_CHARPOS (*it));
19885 object = it->window;
19887 else
19888 return Qnil;
19890 return Fget_char_property (position, prop, object);
19893 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19895 static void
19896 handle_line_prefix (struct it *it)
19898 Lisp_Object prefix;
19900 if (it->continuation_lines_width > 0)
19902 prefix = get_it_property (it, Qwrap_prefix);
19903 if (NILP (prefix))
19904 prefix = Vwrap_prefix;
19906 else
19908 prefix = get_it_property (it, Qline_prefix);
19909 if (NILP (prefix))
19910 prefix = Vline_prefix;
19912 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19914 /* If the prefix is wider than the window, and we try to wrap
19915 it, it would acquire its own wrap prefix, and so on till the
19916 iterator stack overflows. So, don't wrap the prefix. */
19917 it->line_wrap = TRUNCATE;
19918 it->avoid_cursor_p = 1;
19924 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19925 only for R2L lines from display_line and display_string, when they
19926 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19927 the line/string needs to be continued on the next glyph row. */
19928 static void
19929 unproduce_glyphs (struct it *it, int n)
19931 struct glyph *glyph, *end;
19933 eassert (it->glyph_row);
19934 eassert (it->glyph_row->reversed_p);
19935 eassert (it->area == TEXT_AREA);
19936 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19938 if (n > it->glyph_row->used[TEXT_AREA])
19939 n = it->glyph_row->used[TEXT_AREA];
19940 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19941 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19942 for ( ; glyph < end; glyph++)
19943 glyph[-n] = *glyph;
19946 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19947 and ROW->maxpos. */
19948 static void
19949 find_row_edges (struct it *it, struct glyph_row *row,
19950 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19951 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19953 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19954 lines' rows is implemented for bidi-reordered rows. */
19956 /* ROW->minpos is the value of min_pos, the minimal buffer position
19957 we have in ROW, or ROW->start.pos if that is smaller. */
19958 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19959 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19960 else
19961 /* We didn't find buffer positions smaller than ROW->start, or
19962 didn't find _any_ valid buffer positions in any of the glyphs,
19963 so we must trust the iterator's computed positions. */
19964 row->minpos = row->start.pos;
19965 if (max_pos <= 0)
19967 max_pos = CHARPOS (it->current.pos);
19968 max_bpos = BYTEPOS (it->current.pos);
19971 /* Here are the various use-cases for ending the row, and the
19972 corresponding values for ROW->maxpos:
19974 Line ends in a newline from buffer eol_pos + 1
19975 Line is continued from buffer max_pos + 1
19976 Line is truncated on right it->current.pos
19977 Line ends in a newline from string max_pos + 1(*)
19978 (*) + 1 only when line ends in a forward scan
19979 Line is continued from string max_pos
19980 Line is continued from display vector max_pos
19981 Line is entirely from a string min_pos == max_pos
19982 Line is entirely from a display vector min_pos == max_pos
19983 Line that ends at ZV ZV
19985 If you discover other use-cases, please add them here as
19986 appropriate. */
19987 if (row->ends_at_zv_p)
19988 row->maxpos = it->current.pos;
19989 else if (row->used[TEXT_AREA])
19991 int seen_this_string = 0;
19992 struct glyph_row *r1 = row - 1;
19994 /* Did we see the same display string on the previous row? */
19995 if (STRINGP (it->object)
19996 /* this is not the first row */
19997 && row > it->w->desired_matrix->rows
19998 /* previous row is not the header line */
19999 && !r1->mode_line_p
20000 /* previous row also ends in a newline from a string */
20001 && r1->ends_in_newline_from_string_p)
20003 struct glyph *start, *end;
20005 /* Search for the last glyph of the previous row that came
20006 from buffer or string. Depending on whether the row is
20007 L2R or R2L, we need to process it front to back or the
20008 other way round. */
20009 if (!r1->reversed_p)
20011 start = r1->glyphs[TEXT_AREA];
20012 end = start + r1->used[TEXT_AREA];
20013 /* Glyphs inserted by redisplay have an integer (zero)
20014 as their object. */
20015 while (end > start
20016 && INTEGERP ((end - 1)->object)
20017 && (end - 1)->charpos <= 0)
20018 --end;
20019 if (end > start)
20021 if (EQ ((end - 1)->object, it->object))
20022 seen_this_string = 1;
20024 else
20025 /* If all the glyphs of the previous row were inserted
20026 by redisplay, it means the previous row was
20027 produced from a single newline, which is only
20028 possible if that newline came from the same string
20029 as the one which produced this ROW. */
20030 seen_this_string = 1;
20032 else
20034 end = r1->glyphs[TEXT_AREA] - 1;
20035 start = end + r1->used[TEXT_AREA];
20036 while (end < start
20037 && INTEGERP ((end + 1)->object)
20038 && (end + 1)->charpos <= 0)
20039 ++end;
20040 if (end < start)
20042 if (EQ ((end + 1)->object, it->object))
20043 seen_this_string = 1;
20045 else
20046 seen_this_string = 1;
20049 /* Take note of each display string that covers a newline only
20050 once, the first time we see it. This is for when a display
20051 string includes more than one newline in it. */
20052 if (row->ends_in_newline_from_string_p && !seen_this_string)
20054 /* If we were scanning the buffer forward when we displayed
20055 the string, we want to account for at least one buffer
20056 position that belongs to this row (position covered by
20057 the display string), so that cursor positioning will
20058 consider this row as a candidate when point is at the end
20059 of the visual line represented by this row. This is not
20060 required when scanning back, because max_pos will already
20061 have a much larger value. */
20062 if (CHARPOS (row->end.pos) > max_pos)
20063 INC_BOTH (max_pos, max_bpos);
20064 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20066 else if (CHARPOS (it->eol_pos) > 0)
20067 SET_TEXT_POS (row->maxpos,
20068 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
20069 else if (row->continued_p)
20071 /* If max_pos is different from IT's current position, it
20072 means IT->method does not belong to the display element
20073 at max_pos. However, it also means that the display
20074 element at max_pos was displayed in its entirety on this
20075 line, which is equivalent to saying that the next line
20076 starts at the next buffer position. */
20077 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
20078 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20079 else
20081 INC_BOTH (max_pos, max_bpos);
20082 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20085 else if (row->truncated_on_right_p)
20086 /* display_line already called reseat_at_next_visible_line_start,
20087 which puts the iterator at the beginning of the next line, in
20088 the logical order. */
20089 row->maxpos = it->current.pos;
20090 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
20091 /* A line that is entirely from a string/image/stretch... */
20092 row->maxpos = row->minpos;
20093 else
20094 emacs_abort ();
20096 else
20097 row->maxpos = it->current.pos;
20100 /* Construct the glyph row IT->glyph_row in the desired matrix of
20101 IT->w from text at the current position of IT. See dispextern.h
20102 for an overview of struct it. Value is non-zero if
20103 IT->glyph_row displays text, as opposed to a line displaying ZV
20104 only. */
20106 static int
20107 display_line (struct it *it)
20109 struct glyph_row *row = it->glyph_row;
20110 Lisp_Object overlay_arrow_string;
20111 struct it wrap_it;
20112 void *wrap_data = NULL;
20113 int may_wrap = 0, wrap_x IF_LINT (= 0);
20114 int wrap_row_used = -1;
20115 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
20116 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
20117 int wrap_row_extra_line_spacing IF_LINT (= 0);
20118 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
20119 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
20120 int cvpos;
20121 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
20122 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
20123 bool pending_handle_line_prefix = false;
20125 /* We always start displaying at hpos zero even if hscrolled. */
20126 eassert (it->hpos == 0 && it->current_x == 0);
20128 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
20129 >= it->w->desired_matrix->nrows)
20131 it->w->nrows_scale_factor++;
20132 it->f->fonts_changed = 1;
20133 return 0;
20136 /* Clear the result glyph row and enable it. */
20137 prepare_desired_row (it->w, row, false);
20139 row->y = it->current_y;
20140 row->start = it->start;
20141 row->continuation_lines_width = it->continuation_lines_width;
20142 row->displays_text_p = 1;
20143 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
20144 it->starts_in_middle_of_char_p = 0;
20146 /* Arrange the overlays nicely for our purposes. Usually, we call
20147 display_line on only one line at a time, in which case this
20148 can't really hurt too much, or we call it on lines which appear
20149 one after another in the buffer, in which case all calls to
20150 recenter_overlay_lists but the first will be pretty cheap. */
20151 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
20153 /* Move over display elements that are not visible because we are
20154 hscrolled. This may stop at an x-position < IT->first_visible_x
20155 if the first glyph is partially visible or if we hit a line end. */
20156 if (it->current_x < it->first_visible_x)
20158 enum move_it_result move_result;
20160 this_line_min_pos = row->start.pos;
20161 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
20162 MOVE_TO_POS | MOVE_TO_X);
20163 /* If we are under a large hscroll, move_it_in_display_line_to
20164 could hit the end of the line without reaching
20165 it->first_visible_x. Pretend that we did reach it. This is
20166 especially important on a TTY, where we will call
20167 extend_face_to_end_of_line, which needs to know how many
20168 blank glyphs to produce. */
20169 if (it->current_x < it->first_visible_x
20170 && (move_result == MOVE_NEWLINE_OR_CR
20171 || move_result == MOVE_POS_MATCH_OR_ZV))
20172 it->current_x = it->first_visible_x;
20174 /* Record the smallest positions seen while we moved over
20175 display elements that are not visible. This is needed by
20176 redisplay_internal for optimizing the case where the cursor
20177 stays inside the same line. The rest of this function only
20178 considers positions that are actually displayed, so
20179 RECORD_MAX_MIN_POS will not otherwise record positions that
20180 are hscrolled to the left of the left edge of the window. */
20181 min_pos = CHARPOS (this_line_min_pos);
20182 min_bpos = BYTEPOS (this_line_min_pos);
20184 else if (it->area == TEXT_AREA)
20186 /* We only do this when not calling move_it_in_display_line_to
20187 above, because that function calls itself handle_line_prefix. */
20188 handle_line_prefix (it);
20190 else
20192 /* Line-prefix and wrap-prefix are always displayed in the text
20193 area. But if this is the first call to display_line after
20194 init_iterator, the iterator might have been set up to write
20195 into a marginal area, e.g. if the line begins with some
20196 display property that writes to the margins. So we need to
20197 wait with the call to handle_line_prefix until whatever
20198 writes to the margin has done its job. */
20199 pending_handle_line_prefix = true;
20202 /* Get the initial row height. This is either the height of the
20203 text hscrolled, if there is any, or zero. */
20204 row->ascent = it->max_ascent;
20205 row->height = it->max_ascent + it->max_descent;
20206 row->phys_ascent = it->max_phys_ascent;
20207 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
20208 row->extra_line_spacing = it->max_extra_line_spacing;
20210 /* Utility macro to record max and min buffer positions seen until now. */
20211 #define RECORD_MAX_MIN_POS(IT) \
20212 do \
20214 int composition_p = !STRINGP ((IT)->string) \
20215 && ((IT)->what == IT_COMPOSITION); \
20216 ptrdiff_t current_pos = \
20217 composition_p ? (IT)->cmp_it.charpos \
20218 : IT_CHARPOS (*(IT)); \
20219 ptrdiff_t current_bpos = \
20220 composition_p ? CHAR_TO_BYTE (current_pos) \
20221 : IT_BYTEPOS (*(IT)); \
20222 if (current_pos < min_pos) \
20224 min_pos = current_pos; \
20225 min_bpos = current_bpos; \
20227 if (IT_CHARPOS (*it) > max_pos) \
20229 max_pos = IT_CHARPOS (*it); \
20230 max_bpos = IT_BYTEPOS (*it); \
20233 while (0)
20235 /* Loop generating characters. The loop is left with IT on the next
20236 character to display. */
20237 while (1)
20239 int n_glyphs_before, hpos_before, x_before;
20240 int x, nglyphs;
20241 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
20243 /* Retrieve the next thing to display. Value is zero if end of
20244 buffer reached. */
20245 if (!get_next_display_element (it))
20247 /* Maybe add a space at the end of this line that is used to
20248 display the cursor there under X. Set the charpos of the
20249 first glyph of blank lines not corresponding to any text
20250 to -1. */
20251 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20252 row->exact_window_width_line_p = 1;
20253 else if ((append_space_for_newline (it, 1) && row->used[TEXT_AREA] == 1)
20254 || row->used[TEXT_AREA] == 0)
20256 row->glyphs[TEXT_AREA]->charpos = -1;
20257 row->displays_text_p = 0;
20259 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
20260 && (!MINI_WINDOW_P (it->w)
20261 || (minibuf_level && EQ (it->window, minibuf_window))))
20262 row->indicate_empty_line_p = 1;
20265 it->continuation_lines_width = 0;
20266 row->ends_at_zv_p = 1;
20267 /* A row that displays right-to-left text must always have
20268 its last face extended all the way to the end of line,
20269 even if this row ends in ZV, because we still write to
20270 the screen left to right. We also need to extend the
20271 last face if the default face is remapped to some
20272 different face, otherwise the functions that clear
20273 portions of the screen will clear with the default face's
20274 background color. */
20275 if (row->reversed_p
20276 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
20277 extend_face_to_end_of_line (it);
20278 break;
20281 /* Now, get the metrics of what we want to display. This also
20282 generates glyphs in `row' (which is IT->glyph_row). */
20283 n_glyphs_before = row->used[TEXT_AREA];
20284 x = it->current_x;
20286 /* Remember the line height so far in case the next element doesn't
20287 fit on the line. */
20288 if (it->line_wrap != TRUNCATE)
20290 ascent = it->max_ascent;
20291 descent = it->max_descent;
20292 phys_ascent = it->max_phys_ascent;
20293 phys_descent = it->max_phys_descent;
20295 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
20297 if (IT_DISPLAYING_WHITESPACE (it))
20298 may_wrap = 1;
20299 else if (may_wrap)
20301 SAVE_IT (wrap_it, *it, wrap_data);
20302 wrap_x = x;
20303 wrap_row_used = row->used[TEXT_AREA];
20304 wrap_row_ascent = row->ascent;
20305 wrap_row_height = row->height;
20306 wrap_row_phys_ascent = row->phys_ascent;
20307 wrap_row_phys_height = row->phys_height;
20308 wrap_row_extra_line_spacing = row->extra_line_spacing;
20309 wrap_row_min_pos = min_pos;
20310 wrap_row_min_bpos = min_bpos;
20311 wrap_row_max_pos = max_pos;
20312 wrap_row_max_bpos = max_bpos;
20313 may_wrap = 0;
20318 PRODUCE_GLYPHS (it);
20320 /* If this display element was in marginal areas, continue with
20321 the next one. */
20322 if (it->area != TEXT_AREA)
20324 row->ascent = max (row->ascent, it->max_ascent);
20325 row->height = max (row->height, it->max_ascent + it->max_descent);
20326 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20327 row->phys_height = max (row->phys_height,
20328 it->max_phys_ascent + it->max_phys_descent);
20329 row->extra_line_spacing = max (row->extra_line_spacing,
20330 it->max_extra_line_spacing);
20331 set_iterator_to_next (it, 1);
20332 /* If we didn't handle the line/wrap prefix above, and the
20333 call to set_iterator_to_next just switched to TEXT_AREA,
20334 process the prefix now. */
20335 if (it->area == TEXT_AREA && pending_handle_line_prefix)
20337 pending_handle_line_prefix = false;
20338 handle_line_prefix (it);
20340 continue;
20343 /* Does the display element fit on the line? If we truncate
20344 lines, we should draw past the right edge of the window. If
20345 we don't truncate, we want to stop so that we can display the
20346 continuation glyph before the right margin. If lines are
20347 continued, there are two possible strategies for characters
20348 resulting in more than 1 glyph (e.g. tabs): Display as many
20349 glyphs as possible in this line and leave the rest for the
20350 continuation line, or display the whole element in the next
20351 line. Original redisplay did the former, so we do it also. */
20352 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20353 hpos_before = it->hpos;
20354 x_before = x;
20356 if (/* Not a newline. */
20357 nglyphs > 0
20358 /* Glyphs produced fit entirely in the line. */
20359 && it->current_x < it->last_visible_x)
20361 it->hpos += nglyphs;
20362 row->ascent = max (row->ascent, it->max_ascent);
20363 row->height = max (row->height, it->max_ascent + it->max_descent);
20364 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20365 row->phys_height = max (row->phys_height,
20366 it->max_phys_ascent + it->max_phys_descent);
20367 row->extra_line_spacing = max (row->extra_line_spacing,
20368 it->max_extra_line_spacing);
20369 if (it->current_x - it->pixel_width < it->first_visible_x
20370 /* In R2L rows, we arrange in extend_face_to_end_of_line
20371 to add a right offset to the line, by a suitable
20372 change to the stretch glyph that is the leftmost
20373 glyph of the line. */
20374 && !row->reversed_p)
20375 row->x = x - it->first_visible_x;
20376 /* Record the maximum and minimum buffer positions seen so
20377 far in glyphs that will be displayed by this row. */
20378 if (it->bidi_p)
20379 RECORD_MAX_MIN_POS (it);
20381 else
20383 int i, new_x;
20384 struct glyph *glyph;
20386 for (i = 0; i < nglyphs; ++i, x = new_x)
20388 /* Identify the glyphs added by the last call to
20389 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20390 the previous glyphs. */
20391 if (!row->reversed_p)
20392 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20393 else
20394 glyph = row->glyphs[TEXT_AREA] + nglyphs - 1 - i;
20395 new_x = x + glyph->pixel_width;
20397 if (/* Lines are continued. */
20398 it->line_wrap != TRUNCATE
20399 && (/* Glyph doesn't fit on the line. */
20400 new_x > it->last_visible_x
20401 /* Or it fits exactly on a window system frame. */
20402 || (new_x == it->last_visible_x
20403 && FRAME_WINDOW_P (it->f)
20404 && (row->reversed_p
20405 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20406 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20408 /* End of a continued line. */
20410 if (it->hpos == 0
20411 || (new_x == it->last_visible_x
20412 && FRAME_WINDOW_P (it->f)
20413 && (row->reversed_p
20414 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20415 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20417 /* Current glyph is the only one on the line or
20418 fits exactly on the line. We must continue
20419 the line because we can't draw the cursor
20420 after the glyph. */
20421 row->continued_p = 1;
20422 it->current_x = new_x;
20423 it->continuation_lines_width += new_x;
20424 ++it->hpos;
20425 if (i == nglyphs - 1)
20427 /* If line-wrap is on, check if a previous
20428 wrap point was found. */
20429 if (wrap_row_used > 0
20430 /* Even if there is a previous wrap
20431 point, continue the line here as
20432 usual, if (i) the previous character
20433 was a space or tab AND (ii) the
20434 current character is not. */
20435 && (!may_wrap
20436 || IT_DISPLAYING_WHITESPACE (it)))
20437 goto back_to_wrap;
20439 /* Record the maximum and minimum buffer
20440 positions seen so far in glyphs that will be
20441 displayed by this row. */
20442 if (it->bidi_p)
20443 RECORD_MAX_MIN_POS (it);
20444 set_iterator_to_next (it, 1);
20445 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20447 if (!get_next_display_element (it))
20449 row->exact_window_width_line_p = 1;
20450 it->continuation_lines_width = 0;
20451 row->continued_p = 0;
20452 row->ends_at_zv_p = 1;
20454 else if (ITERATOR_AT_END_OF_LINE_P (it))
20456 row->continued_p = 0;
20457 row->exact_window_width_line_p = 1;
20461 else if (it->bidi_p)
20462 RECORD_MAX_MIN_POS (it);
20463 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20464 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20465 extend_face_to_end_of_line (it);
20467 else if (CHAR_GLYPH_PADDING_P (*glyph)
20468 && !FRAME_WINDOW_P (it->f))
20470 /* A padding glyph that doesn't fit on this line.
20471 This means the whole character doesn't fit
20472 on the line. */
20473 if (row->reversed_p)
20474 unproduce_glyphs (it, row->used[TEXT_AREA]
20475 - n_glyphs_before);
20476 row->used[TEXT_AREA] = n_glyphs_before;
20478 /* Fill the rest of the row with continuation
20479 glyphs like in 20.x. */
20480 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20481 < row->glyphs[1 + TEXT_AREA])
20482 produce_special_glyphs (it, IT_CONTINUATION);
20484 row->continued_p = 1;
20485 it->current_x = x_before;
20486 it->continuation_lines_width += x_before;
20488 /* Restore the height to what it was before the
20489 element not fitting on the line. */
20490 it->max_ascent = ascent;
20491 it->max_descent = descent;
20492 it->max_phys_ascent = phys_ascent;
20493 it->max_phys_descent = phys_descent;
20494 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20495 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20496 extend_face_to_end_of_line (it);
20498 else if (wrap_row_used > 0)
20500 back_to_wrap:
20501 if (row->reversed_p)
20502 unproduce_glyphs (it,
20503 row->used[TEXT_AREA] - wrap_row_used);
20504 RESTORE_IT (it, &wrap_it, wrap_data);
20505 it->continuation_lines_width += wrap_x;
20506 row->used[TEXT_AREA] = wrap_row_used;
20507 row->ascent = wrap_row_ascent;
20508 row->height = wrap_row_height;
20509 row->phys_ascent = wrap_row_phys_ascent;
20510 row->phys_height = wrap_row_phys_height;
20511 row->extra_line_spacing = wrap_row_extra_line_spacing;
20512 min_pos = wrap_row_min_pos;
20513 min_bpos = wrap_row_min_bpos;
20514 max_pos = wrap_row_max_pos;
20515 max_bpos = wrap_row_max_bpos;
20516 row->continued_p = 1;
20517 row->ends_at_zv_p = 0;
20518 row->exact_window_width_line_p = 0;
20519 it->continuation_lines_width += x;
20521 /* Make sure that a non-default face is extended
20522 up to the right margin of the window. */
20523 extend_face_to_end_of_line (it);
20525 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20527 /* A TAB that extends past the right edge of the
20528 window. This produces a single glyph on
20529 window system frames. We leave the glyph in
20530 this row and let it fill the row, but don't
20531 consume the TAB. */
20532 if ((row->reversed_p
20533 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20534 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20535 produce_special_glyphs (it, IT_CONTINUATION);
20536 it->continuation_lines_width += it->last_visible_x;
20537 row->ends_in_middle_of_char_p = 1;
20538 row->continued_p = 1;
20539 glyph->pixel_width = it->last_visible_x - x;
20540 it->starts_in_middle_of_char_p = 1;
20541 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20542 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20543 extend_face_to_end_of_line (it);
20545 else
20547 /* Something other than a TAB that draws past
20548 the right edge of the window. Restore
20549 positions to values before the element. */
20550 if (row->reversed_p)
20551 unproduce_glyphs (it, row->used[TEXT_AREA]
20552 - (n_glyphs_before + i));
20553 row->used[TEXT_AREA] = n_glyphs_before + i;
20555 /* Display continuation glyphs. */
20556 it->current_x = x_before;
20557 it->continuation_lines_width += x;
20558 if (!FRAME_WINDOW_P (it->f)
20559 || (row->reversed_p
20560 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20561 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20562 produce_special_glyphs (it, IT_CONTINUATION);
20563 row->continued_p = 1;
20565 extend_face_to_end_of_line (it);
20567 if (nglyphs > 1 && i > 0)
20569 row->ends_in_middle_of_char_p = 1;
20570 it->starts_in_middle_of_char_p = 1;
20573 /* Restore the height to what it was before the
20574 element not fitting on the line. */
20575 it->max_ascent = ascent;
20576 it->max_descent = descent;
20577 it->max_phys_ascent = phys_ascent;
20578 it->max_phys_descent = phys_descent;
20581 break;
20583 else if (new_x > it->first_visible_x)
20585 /* Increment number of glyphs actually displayed. */
20586 ++it->hpos;
20588 /* Record the maximum and minimum buffer positions
20589 seen so far in glyphs that will be displayed by
20590 this row. */
20591 if (it->bidi_p)
20592 RECORD_MAX_MIN_POS (it);
20594 if (x < it->first_visible_x && !row->reversed_p)
20595 /* Glyph is partially visible, i.e. row starts at
20596 negative X position. Don't do that in R2L
20597 rows, where we arrange to add a right offset to
20598 the line in extend_face_to_end_of_line, by a
20599 suitable change to the stretch glyph that is
20600 the leftmost glyph of the line. */
20601 row->x = x - it->first_visible_x;
20602 /* When the last glyph of an R2L row only fits
20603 partially on the line, we need to set row->x to a
20604 negative offset, so that the leftmost glyph is
20605 the one that is partially visible. But if we are
20606 going to produce the truncation glyph, this will
20607 be taken care of in produce_special_glyphs. */
20608 if (row->reversed_p
20609 && new_x > it->last_visible_x
20610 && !(it->line_wrap == TRUNCATE
20611 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
20613 eassert (FRAME_WINDOW_P (it->f));
20614 row->x = it->last_visible_x - new_x;
20617 else
20619 /* Glyph is completely off the left margin of the
20620 window. This should not happen because of the
20621 move_it_in_display_line at the start of this
20622 function, unless the text display area of the
20623 window is empty. */
20624 eassert (it->first_visible_x <= it->last_visible_x);
20627 /* Even if this display element produced no glyphs at all,
20628 we want to record its position. */
20629 if (it->bidi_p && nglyphs == 0)
20630 RECORD_MAX_MIN_POS (it);
20632 row->ascent = max (row->ascent, it->max_ascent);
20633 row->height = max (row->height, it->max_ascent + it->max_descent);
20634 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20635 row->phys_height = max (row->phys_height,
20636 it->max_phys_ascent + it->max_phys_descent);
20637 row->extra_line_spacing = max (row->extra_line_spacing,
20638 it->max_extra_line_spacing);
20640 /* End of this display line if row is continued. */
20641 if (row->continued_p || row->ends_at_zv_p)
20642 break;
20645 at_end_of_line:
20646 /* Is this a line end? If yes, we're also done, after making
20647 sure that a non-default face is extended up to the right
20648 margin of the window. */
20649 if (ITERATOR_AT_END_OF_LINE_P (it))
20651 int used_before = row->used[TEXT_AREA];
20653 row->ends_in_newline_from_string_p = STRINGP (it->object);
20655 /* Add a space at the end of the line that is used to
20656 display the cursor there. */
20657 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20658 append_space_for_newline (it, 0);
20660 /* Extend the face to the end of the line. */
20661 extend_face_to_end_of_line (it);
20663 /* Make sure we have the position. */
20664 if (used_before == 0)
20665 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
20667 /* Record the position of the newline, for use in
20668 find_row_edges. */
20669 it->eol_pos = it->current.pos;
20671 /* Consume the line end. This skips over invisible lines. */
20672 set_iterator_to_next (it, 1);
20673 it->continuation_lines_width = 0;
20674 break;
20677 /* Proceed with next display element. Note that this skips
20678 over lines invisible because of selective display. */
20679 set_iterator_to_next (it, 1);
20681 /* If we truncate lines, we are done when the last displayed
20682 glyphs reach past the right margin of the window. */
20683 if (it->line_wrap == TRUNCATE
20684 && ((FRAME_WINDOW_P (it->f)
20685 /* Images are preprocessed in produce_image_glyph such
20686 that they are cropped at the right edge of the
20687 window, so an image glyph will always end exactly at
20688 last_visible_x, even if there's no right fringe. */
20689 && ((row->reversed_p
20690 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20691 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))
20692 || it->what == IT_IMAGE))
20693 ? (it->current_x >= it->last_visible_x)
20694 : (it->current_x > it->last_visible_x)))
20696 /* Maybe add truncation glyphs. */
20697 if (!FRAME_WINDOW_P (it->f)
20698 || (row->reversed_p
20699 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20700 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20702 int i, n;
20704 if (!row->reversed_p)
20706 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
20707 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20708 break;
20710 else
20712 for (i = 0; i < row->used[TEXT_AREA]; i++)
20713 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20714 break;
20715 /* Remove any padding glyphs at the front of ROW, to
20716 make room for the truncation glyphs we will be
20717 adding below. The loop below always inserts at
20718 least one truncation glyph, so also remove the
20719 last glyph added to ROW. */
20720 unproduce_glyphs (it, i + 1);
20721 /* Adjust i for the loop below. */
20722 i = row->used[TEXT_AREA] - (i + 1);
20725 /* produce_special_glyphs overwrites the last glyph, so
20726 we don't want that if we want to keep that last
20727 glyph, which means it's an image. */
20728 if (it->current_x > it->last_visible_x)
20730 it->current_x = x_before;
20731 if (!FRAME_WINDOW_P (it->f))
20733 for (n = row->used[TEXT_AREA]; i < n; ++i)
20735 row->used[TEXT_AREA] = i;
20736 produce_special_glyphs (it, IT_TRUNCATION);
20739 else
20741 row->used[TEXT_AREA] = i;
20742 produce_special_glyphs (it, IT_TRUNCATION);
20744 it->hpos = hpos_before;
20747 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20749 /* Don't truncate if we can overflow newline into fringe. */
20750 if (!get_next_display_element (it))
20752 it->continuation_lines_width = 0;
20753 row->ends_at_zv_p = 1;
20754 row->exact_window_width_line_p = 1;
20755 break;
20757 if (ITERATOR_AT_END_OF_LINE_P (it))
20759 row->exact_window_width_line_p = 1;
20760 goto at_end_of_line;
20762 it->current_x = x_before;
20763 it->hpos = hpos_before;
20766 row->truncated_on_right_p = 1;
20767 it->continuation_lines_width = 0;
20768 reseat_at_next_visible_line_start (it, 0);
20769 /* We insist below that IT's position be at ZV because in
20770 bidi-reordered lines the character at visible line start
20771 might not be the character that follows the newline in
20772 the logical order. */
20773 if (IT_BYTEPOS (*it) > BEG_BYTE)
20774 row->ends_at_zv_p =
20775 IT_BYTEPOS (*it) >= ZV_BYTE && FETCH_BYTE (ZV_BYTE - 1) != '\n';
20776 else
20777 row->ends_at_zv_p = false;
20778 break;
20782 if (wrap_data)
20783 bidi_unshelve_cache (wrap_data, 1);
20785 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20786 at the left window margin. */
20787 if (it->first_visible_x
20788 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
20790 if (!FRAME_WINDOW_P (it->f)
20791 || (((row->reversed_p
20792 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
20793 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
20794 /* Don't let insert_left_trunc_glyphs overwrite the
20795 first glyph of the row if it is an image. */
20796 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
20797 insert_left_trunc_glyphs (it);
20798 row->truncated_on_left_p = 1;
20801 /* Remember the position at which this line ends.
20803 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20804 cannot be before the call to find_row_edges below, since that is
20805 where these positions are determined. */
20806 row->end = it->current;
20807 if (!it->bidi_p)
20809 row->minpos = row->start.pos;
20810 row->maxpos = row->end.pos;
20812 else
20814 /* ROW->minpos and ROW->maxpos must be the smallest and
20815 `1 + the largest' buffer positions in ROW. But if ROW was
20816 bidi-reordered, these two positions can be anywhere in the
20817 row, so we must determine them now. */
20818 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
20821 /* If the start of this line is the overlay arrow-position, then
20822 mark this glyph row as the one containing the overlay arrow.
20823 This is clearly a mess with variable size fonts. It would be
20824 better to let it be displayed like cursors under X. */
20825 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
20826 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
20827 !NILP (overlay_arrow_string)))
20829 /* Overlay arrow in window redisplay is a fringe bitmap. */
20830 if (STRINGP (overlay_arrow_string))
20832 struct glyph_row *arrow_row
20833 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
20834 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
20835 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
20836 struct glyph *p = row->glyphs[TEXT_AREA];
20837 struct glyph *p2, *end;
20839 /* Copy the arrow glyphs. */
20840 while (glyph < arrow_end)
20841 *p++ = *glyph++;
20843 /* Throw away padding glyphs. */
20844 p2 = p;
20845 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
20846 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
20847 ++p2;
20848 if (p2 > p)
20850 while (p2 < end)
20851 *p++ = *p2++;
20852 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
20855 else
20857 eassert (INTEGERP (overlay_arrow_string));
20858 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
20860 overlay_arrow_seen = 1;
20863 /* Highlight trailing whitespace. */
20864 if (!NILP (Vshow_trailing_whitespace))
20865 highlight_trailing_whitespace (it->f, it->glyph_row);
20867 /* Compute pixel dimensions of this line. */
20868 compute_line_metrics (it);
20870 /* Implementation note: No changes in the glyphs of ROW or in their
20871 faces can be done past this point, because compute_line_metrics
20872 computes ROW's hash value and stores it within the glyph_row
20873 structure. */
20875 /* Record whether this row ends inside an ellipsis. */
20876 row->ends_in_ellipsis_p
20877 = (it->method == GET_FROM_DISPLAY_VECTOR
20878 && it->ellipsis_p);
20880 /* Save fringe bitmaps in this row. */
20881 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
20882 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
20883 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
20884 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
20886 it->left_user_fringe_bitmap = 0;
20887 it->left_user_fringe_face_id = 0;
20888 it->right_user_fringe_bitmap = 0;
20889 it->right_user_fringe_face_id = 0;
20891 /* Maybe set the cursor. */
20892 cvpos = it->w->cursor.vpos;
20893 if ((cvpos < 0
20894 /* In bidi-reordered rows, keep checking for proper cursor
20895 position even if one has been found already, because buffer
20896 positions in such rows change non-linearly with ROW->VPOS,
20897 when a line is continued. One exception: when we are at ZV,
20898 display cursor on the first suitable glyph row, since all
20899 the empty rows after that also have their position set to ZV. */
20900 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20901 lines' rows is implemented for bidi-reordered rows. */
20902 || (it->bidi_p
20903 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
20904 && PT >= MATRIX_ROW_START_CHARPOS (row)
20905 && PT <= MATRIX_ROW_END_CHARPOS (row)
20906 && cursor_row_p (row))
20907 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
20909 /* Prepare for the next line. This line starts horizontally at (X
20910 HPOS) = (0 0). Vertical positions are incremented. As a
20911 convenience for the caller, IT->glyph_row is set to the next
20912 row to be used. */
20913 it->current_x = it->hpos = 0;
20914 it->current_y += row->height;
20915 SET_TEXT_POS (it->eol_pos, 0, 0);
20916 ++it->vpos;
20917 ++it->glyph_row;
20918 /* The next row should by default use the same value of the
20919 reversed_p flag as this one. set_iterator_to_next decides when
20920 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20921 the flag accordingly. */
20922 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20923 it->glyph_row->reversed_p = row->reversed_p;
20924 it->start = row->end;
20925 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
20927 #undef RECORD_MAX_MIN_POS
20930 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20931 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20932 doc: /* Return paragraph direction at point in BUFFER.
20933 Value is either `left-to-right' or `right-to-left'.
20934 If BUFFER is omitted or nil, it defaults to the current buffer.
20936 Paragraph direction determines how the text in the paragraph is displayed.
20937 In left-to-right paragraphs, text begins at the left margin of the window
20938 and the reading direction is generally left to right. In right-to-left
20939 paragraphs, text begins at the right margin and is read from right to left.
20941 See also `bidi-paragraph-direction'. */)
20942 (Lisp_Object buffer)
20944 struct buffer *buf = current_buffer;
20945 struct buffer *old = buf;
20947 if (! NILP (buffer))
20949 CHECK_BUFFER (buffer);
20950 buf = XBUFFER (buffer);
20953 if (NILP (BVAR (buf, bidi_display_reordering))
20954 || NILP (BVAR (buf, enable_multibyte_characters))
20955 /* When we are loading loadup.el, the character property tables
20956 needed for bidi iteration are not yet available. */
20957 || !NILP (Vpurify_flag))
20958 return Qleft_to_right;
20959 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
20960 return BVAR (buf, bidi_paragraph_direction);
20961 else
20963 /* Determine the direction from buffer text. We could try to
20964 use current_matrix if it is up to date, but this seems fast
20965 enough as it is. */
20966 struct bidi_it itb;
20967 ptrdiff_t pos = BUF_PT (buf);
20968 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
20969 int c;
20970 void *itb_data = bidi_shelve_cache ();
20972 set_buffer_temp (buf);
20973 /* bidi_paragraph_init finds the base direction of the paragraph
20974 by searching forward from paragraph start. We need the base
20975 direction of the current or _previous_ paragraph, so we need
20976 to make sure we are within that paragraph. To that end, find
20977 the previous non-empty line. */
20978 if (pos >= ZV && pos > BEGV)
20979 DEC_BOTH (pos, bytepos);
20980 AUTO_STRING (trailing_white_space, "[\f\t ]*\n");
20981 if (fast_looking_at (trailing_white_space,
20982 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
20984 while ((c = FETCH_BYTE (bytepos)) == '\n'
20985 || c == ' ' || c == '\t' || c == '\f')
20987 if (bytepos <= BEGV_BYTE)
20988 break;
20989 bytepos--;
20990 pos--;
20992 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
20993 bytepos--;
20995 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
20996 itb.paragraph_dir = NEUTRAL_DIR;
20997 itb.string.s = NULL;
20998 itb.string.lstring = Qnil;
20999 itb.string.bufpos = 0;
21000 itb.string.from_disp_str = 0;
21001 itb.string.unibyte = 0;
21002 /* We have no window to use here for ignoring window-specific
21003 overlays. Using NULL for window pointer will cause
21004 compute_display_string_pos to use the current buffer. */
21005 itb.w = NULL;
21006 bidi_paragraph_init (NEUTRAL_DIR, &itb, 1);
21007 bidi_unshelve_cache (itb_data, 0);
21008 set_buffer_temp (old);
21009 switch (itb.paragraph_dir)
21011 case L2R:
21012 return Qleft_to_right;
21013 break;
21014 case R2L:
21015 return Qright_to_left;
21016 break;
21017 default:
21018 emacs_abort ();
21023 DEFUN ("move-point-visually", Fmove_point_visually,
21024 Smove_point_visually, 1, 1, 0,
21025 doc: /* Move point in the visual order in the specified DIRECTION.
21026 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21027 left.
21029 Value is the new character position of point. */)
21030 (Lisp_Object direction)
21032 struct window *w = XWINDOW (selected_window);
21033 struct buffer *b = XBUFFER (w->contents);
21034 struct glyph_row *row;
21035 int dir;
21036 Lisp_Object paragraph_dir;
21038 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21039 (!(ROW)->continued_p \
21040 && INTEGERP ((GLYPH)->object) \
21041 && (GLYPH)->type == CHAR_GLYPH \
21042 && (GLYPH)->u.ch == ' ' \
21043 && (GLYPH)->charpos >= 0 \
21044 && !(GLYPH)->avoid_cursor_p)
21046 CHECK_NUMBER (direction);
21047 dir = XINT (direction);
21048 if (dir > 0)
21049 dir = 1;
21050 else
21051 dir = -1;
21053 /* If current matrix is up-to-date, we can use the information
21054 recorded in the glyphs, at least as long as the goal is on the
21055 screen. */
21056 if (w->window_end_valid
21057 && !windows_or_buffers_changed
21058 && b
21059 && !b->clip_changed
21060 && !b->prevent_redisplay_optimizations_p
21061 && !window_outdated (w)
21062 /* We rely below on the cursor coordinates to be up to date, but
21063 we cannot trust them if some command moved point since the
21064 last complete redisplay. */
21065 && w->last_point == BUF_PT (b)
21066 && w->cursor.vpos >= 0
21067 && w->cursor.vpos < w->current_matrix->nrows
21068 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
21070 struct glyph *g = row->glyphs[TEXT_AREA];
21071 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
21072 struct glyph *gpt = g + w->cursor.hpos;
21074 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
21076 if (BUFFERP (g->object) && g->charpos != PT)
21078 SET_PT (g->charpos);
21079 w->cursor.vpos = -1;
21080 return make_number (PT);
21082 else if (!INTEGERP (g->object) && !EQ (g->object, gpt->object))
21084 ptrdiff_t new_pos;
21086 if (BUFFERP (gpt->object))
21088 new_pos = PT;
21089 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
21090 new_pos += (row->reversed_p ? -dir : dir);
21091 else
21092 new_pos -= (row->reversed_p ? -dir : dir);
21094 else if (BUFFERP (g->object))
21095 new_pos = g->charpos;
21096 else
21097 break;
21098 SET_PT (new_pos);
21099 w->cursor.vpos = -1;
21100 return make_number (PT);
21102 else if (ROW_GLYPH_NEWLINE_P (row, g))
21104 /* Glyphs inserted at the end of a non-empty line for
21105 positioning the cursor have zero charpos, so we must
21106 deduce the value of point by other means. */
21107 if (g->charpos > 0)
21108 SET_PT (g->charpos);
21109 else if (row->ends_at_zv_p && PT != ZV)
21110 SET_PT (ZV);
21111 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
21112 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21113 else
21114 break;
21115 w->cursor.vpos = -1;
21116 return make_number (PT);
21119 if (g == e || INTEGERP (g->object))
21121 if (row->truncated_on_left_p || row->truncated_on_right_p)
21122 goto simulate_display;
21123 if (!row->reversed_p)
21124 row += dir;
21125 else
21126 row -= dir;
21127 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
21128 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
21129 goto simulate_display;
21131 if (dir > 0)
21133 if (row->reversed_p && !row->continued_p)
21135 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21136 w->cursor.vpos = -1;
21137 return make_number (PT);
21139 g = row->glyphs[TEXT_AREA];
21140 e = g + row->used[TEXT_AREA];
21141 for ( ; g < e; g++)
21143 if (BUFFERP (g->object)
21144 /* Empty lines have only one glyph, which stands
21145 for the newline, and whose charpos is the
21146 buffer position of the newline. */
21147 || ROW_GLYPH_NEWLINE_P (row, g)
21148 /* When the buffer ends in a newline, the line at
21149 EOB also has one glyph, but its charpos is -1. */
21150 || (row->ends_at_zv_p
21151 && !row->reversed_p
21152 && INTEGERP (g->object)
21153 && g->type == CHAR_GLYPH
21154 && g->u.ch == ' '))
21156 if (g->charpos > 0)
21157 SET_PT (g->charpos);
21158 else if (!row->reversed_p
21159 && row->ends_at_zv_p
21160 && PT != ZV)
21161 SET_PT (ZV);
21162 else
21163 continue;
21164 w->cursor.vpos = -1;
21165 return make_number (PT);
21169 else
21171 if (!row->reversed_p && !row->continued_p)
21173 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21174 w->cursor.vpos = -1;
21175 return make_number (PT);
21177 e = row->glyphs[TEXT_AREA];
21178 g = e + row->used[TEXT_AREA] - 1;
21179 for ( ; g >= e; g--)
21181 if (BUFFERP (g->object)
21182 || (ROW_GLYPH_NEWLINE_P (row, g)
21183 && g->charpos > 0)
21184 /* Empty R2L lines on GUI frames have the buffer
21185 position of the newline stored in the stretch
21186 glyph. */
21187 || g->type == STRETCH_GLYPH
21188 || (row->ends_at_zv_p
21189 && row->reversed_p
21190 && INTEGERP (g->object)
21191 && g->type == CHAR_GLYPH
21192 && g->u.ch == ' '))
21194 if (g->charpos > 0)
21195 SET_PT (g->charpos);
21196 else if (row->reversed_p
21197 && row->ends_at_zv_p
21198 && PT != ZV)
21199 SET_PT (ZV);
21200 else
21201 continue;
21202 w->cursor.vpos = -1;
21203 return make_number (PT);
21210 simulate_display:
21212 /* If we wind up here, we failed to move by using the glyphs, so we
21213 need to simulate display instead. */
21215 if (b)
21216 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
21217 else
21218 paragraph_dir = Qleft_to_right;
21219 if (EQ (paragraph_dir, Qright_to_left))
21220 dir = -dir;
21221 if (PT <= BEGV && dir < 0)
21222 xsignal0 (Qbeginning_of_buffer);
21223 else if (PT >= ZV && dir > 0)
21224 xsignal0 (Qend_of_buffer);
21225 else
21227 struct text_pos pt;
21228 struct it it;
21229 int pt_x, target_x, pixel_width, pt_vpos;
21230 bool at_eol_p;
21231 bool overshoot_expected = false;
21232 bool target_is_eol_p = false;
21234 /* Setup the arena. */
21235 SET_TEXT_POS (pt, PT, PT_BYTE);
21236 start_display (&it, w, pt);
21238 if (it.cmp_it.id < 0
21239 && it.method == GET_FROM_STRING
21240 && it.area == TEXT_AREA
21241 && it.string_from_display_prop_p
21242 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
21243 overshoot_expected = true;
21245 /* Find the X coordinate of point. We start from the beginning
21246 of this or previous line to make sure we are before point in
21247 the logical order (since the move_it_* functions can only
21248 move forward). */
21249 reseat:
21250 reseat_at_previous_visible_line_start (&it);
21251 it.current_x = it.hpos = it.current_y = it.vpos = 0;
21252 if (IT_CHARPOS (it) != PT)
21254 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
21255 -1, -1, -1, MOVE_TO_POS);
21256 /* If we missed point because the character there is
21257 displayed out of a display vector that has more than one
21258 glyph, retry expecting overshoot. */
21259 if (it.method == GET_FROM_DISPLAY_VECTOR
21260 && it.current.dpvec_index > 0
21261 && !overshoot_expected)
21263 overshoot_expected = true;
21264 goto reseat;
21266 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
21267 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
21269 pt_x = it.current_x;
21270 pt_vpos = it.vpos;
21271 if (dir > 0 || overshoot_expected)
21273 struct glyph_row *row = it.glyph_row;
21275 /* When point is at beginning of line, we don't have
21276 information about the glyph there loaded into struct
21277 it. Calling get_next_display_element fixes that. */
21278 if (pt_x == 0)
21279 get_next_display_element (&it);
21280 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21281 it.glyph_row = NULL;
21282 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
21283 it.glyph_row = row;
21284 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21285 it, lest it will become out of sync with it's buffer
21286 position. */
21287 it.current_x = pt_x;
21289 else
21290 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21291 pixel_width = it.pixel_width;
21292 if (overshoot_expected && at_eol_p)
21293 pixel_width = 0;
21294 else if (pixel_width <= 0)
21295 pixel_width = 1;
21297 /* If there's a display string (or something similar) at point,
21298 we are actually at the glyph to the left of point, so we need
21299 to correct the X coordinate. */
21300 if (overshoot_expected)
21302 if (it.bidi_p)
21303 pt_x += pixel_width * it.bidi_it.scan_dir;
21304 else
21305 pt_x += pixel_width;
21308 /* Compute target X coordinate, either to the left or to the
21309 right of point. On TTY frames, all characters have the same
21310 pixel width of 1, so we can use that. On GUI frames we don't
21311 have an easy way of getting at the pixel width of the
21312 character to the left of point, so we use a different method
21313 of getting to that place. */
21314 if (dir > 0)
21315 target_x = pt_x + pixel_width;
21316 else
21317 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
21319 /* Target X coordinate could be one line above or below the line
21320 of point, in which case we need to adjust the target X
21321 coordinate. Also, if moving to the left, we need to begin at
21322 the left edge of the point's screen line. */
21323 if (dir < 0)
21325 if (pt_x > 0)
21327 start_display (&it, w, pt);
21328 reseat_at_previous_visible_line_start (&it);
21329 it.current_x = it.current_y = it.hpos = 0;
21330 if (pt_vpos != 0)
21331 move_it_by_lines (&it, pt_vpos);
21333 else
21335 move_it_by_lines (&it, -1);
21336 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
21337 target_is_eol_p = true;
21338 /* Under word-wrap, we don't know the x coordinate of
21339 the last character displayed on the previous line,
21340 which immediately precedes the wrap point. To find
21341 out its x coordinate, we try moving to the right
21342 margin of the window, which will stop at the wrap
21343 point, and then reset target_x to point at the
21344 character that precedes the wrap point. This is not
21345 needed on GUI frames, because (see below) there we
21346 move from the left margin one grapheme cluster at a
21347 time, and stop when we hit the wrap point. */
21348 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
21350 void *it_data = NULL;
21351 struct it it2;
21353 SAVE_IT (it2, it, it_data);
21354 move_it_in_display_line_to (&it, ZV, target_x,
21355 MOVE_TO_POS | MOVE_TO_X);
21356 /* If we arrived at target_x, that _is_ the last
21357 character on the previous line. */
21358 if (it.current_x != target_x)
21359 target_x = it.current_x - 1;
21360 RESTORE_IT (&it, &it2, it_data);
21364 else
21366 if (at_eol_p
21367 || (target_x >= it.last_visible_x
21368 && it.line_wrap != TRUNCATE))
21370 if (pt_x > 0)
21371 move_it_by_lines (&it, 0);
21372 move_it_by_lines (&it, 1);
21373 target_x = 0;
21377 /* Move to the target X coordinate. */
21378 #ifdef HAVE_WINDOW_SYSTEM
21379 /* On GUI frames, as we don't know the X coordinate of the
21380 character to the left of point, moving point to the left
21381 requires walking, one grapheme cluster at a time, until we
21382 find ourself at a place immediately to the left of the
21383 character at point. */
21384 if (FRAME_WINDOW_P (it.f) && dir < 0)
21386 struct text_pos new_pos;
21387 enum move_it_result rc = MOVE_X_REACHED;
21389 if (it.current_x == 0)
21390 get_next_display_element (&it);
21391 if (it.what == IT_COMPOSITION)
21393 new_pos.charpos = it.cmp_it.charpos;
21394 new_pos.bytepos = -1;
21396 else
21397 new_pos = it.current.pos;
21399 while (it.current_x + it.pixel_width <= target_x
21400 && (rc == MOVE_X_REACHED
21401 /* Under word-wrap, move_it_in_display_line_to
21402 stops at correct coordinates, but sometimes
21403 returns MOVE_POS_MATCH_OR_ZV. */
21404 || (it.line_wrap == WORD_WRAP
21405 && rc == MOVE_POS_MATCH_OR_ZV)))
21407 int new_x = it.current_x + it.pixel_width;
21409 /* For composed characters, we want the position of the
21410 first character in the grapheme cluster (usually, the
21411 composition's base character), whereas it.current
21412 might give us the position of the _last_ one, e.g. if
21413 the composition is rendered in reverse due to bidi
21414 reordering. */
21415 if (it.what == IT_COMPOSITION)
21417 new_pos.charpos = it.cmp_it.charpos;
21418 new_pos.bytepos = -1;
21420 else
21421 new_pos = it.current.pos;
21422 if (new_x == it.current_x)
21423 new_x++;
21424 rc = move_it_in_display_line_to (&it, ZV, new_x,
21425 MOVE_TO_POS | MOVE_TO_X);
21426 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21427 break;
21429 /* The previous position we saw in the loop is the one we
21430 want. */
21431 if (new_pos.bytepos == -1)
21432 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21433 it.current.pos = new_pos;
21435 else
21436 #endif
21437 if (it.current_x != target_x)
21438 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21440 /* When lines are truncated, the above loop will stop at the
21441 window edge. But we want to get to the end of line, even if
21442 it is beyond the window edge; automatic hscroll will then
21443 scroll the window to show point as appropriate. */
21444 if (target_is_eol_p && it.line_wrap == TRUNCATE
21445 && get_next_display_element (&it))
21447 struct text_pos new_pos = it.current.pos;
21449 while (!ITERATOR_AT_END_OF_LINE_P (&it))
21451 set_iterator_to_next (&it, 0);
21452 if (it.method == GET_FROM_BUFFER)
21453 new_pos = it.current.pos;
21454 if (!get_next_display_element (&it))
21455 break;
21458 it.current.pos = new_pos;
21461 /* If we ended up in a display string that covers point, move to
21462 buffer position to the right in the visual order. */
21463 if (dir > 0)
21465 while (IT_CHARPOS (it) == PT)
21467 set_iterator_to_next (&it, 0);
21468 if (!get_next_display_element (&it))
21469 break;
21473 /* Move point to that position. */
21474 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21477 return make_number (PT);
21479 #undef ROW_GLYPH_NEWLINE_P
21482 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels,
21483 Sbidi_resolved_levels, 0, 1, 0,
21484 doc: /* Return the resolved bidirectional levels of characters at VPOS.
21486 The resolved levels are produced by the Emacs bidi reordering engine
21487 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21488 read the Unicode Standard Annex 9 (UAX#9) for background information
21489 about these levels.
21491 VPOS is the zero-based number of the current window's screen line
21492 for which to produce the resolved levels. If VPOS is nil or omitted,
21493 it defaults to the screen line of point. If the window displays a
21494 header line, VPOS of zero will report on the header line, and first
21495 line of text in the window will have VPOS of 1.
21497 Value is an array of resolved levels, indexed by glyph number.
21498 Glyphs are numbered from zero starting from the beginning of the
21499 screen line, i.e. the left edge of the window for left-to-right lines
21500 and from the right edge for right-to-left lines. The resolved levels
21501 are produced only for the window's text area; text in display margins
21502 is not included.
21504 If the selected window's display is not up-to-date, or if the specified
21505 screen line does not display text, this function returns nil. It is
21506 highly recommended to bind this function to some simple key, like F8,
21507 in order to avoid these problems.
21509 This function exists mainly for testing the correctness of the
21510 Emacs UBA implementation, in particular with the test suite. */)
21511 (Lisp_Object vpos)
21513 struct window *w = XWINDOW (selected_window);
21514 struct buffer *b = XBUFFER (w->contents);
21515 int nrow;
21516 struct glyph_row *row;
21518 if (NILP (vpos))
21520 int d1, d2, d3, d4, d5;
21522 pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &nrow);
21524 else
21526 CHECK_NUMBER_COERCE_MARKER (vpos);
21527 nrow = XINT (vpos);
21530 /* We require up-to-date glyph matrix for this window. */
21531 if (w->window_end_valid
21532 && !windows_or_buffers_changed
21533 && b
21534 && !b->clip_changed
21535 && !b->prevent_redisplay_optimizations_p
21536 && !window_outdated (w)
21537 && nrow >= 0
21538 && nrow < w->current_matrix->nrows
21539 && (row = MATRIX_ROW (w->current_matrix, nrow))->enabled_p
21540 && MATRIX_ROW_DISPLAYS_TEXT_P (row))
21542 struct glyph *g, *e, *g1;
21543 int nglyphs, i;
21544 Lisp_Object levels;
21546 if (!row->reversed_p) /* Left-to-right glyph row. */
21548 g = g1 = row->glyphs[TEXT_AREA];
21549 e = g + row->used[TEXT_AREA];
21551 /* Skip over glyphs at the start of the row that was
21552 generated by redisplay for its own needs. */
21553 while (g < e
21554 && INTEGERP (g->object)
21555 && g->charpos < 0)
21556 g++;
21557 g1 = g;
21559 /* Count the "interesting" glyphs in this row. */
21560 for (nglyphs = 0; g < e && !INTEGERP (g->object); g++)
21561 nglyphs++;
21563 /* Create and fill the array. */
21564 levels = make_uninit_vector (nglyphs);
21565 for (i = 0; g1 < g; i++, g1++)
21566 ASET (levels, i, make_number (g1->resolved_level));
21568 else /* Right-to-left glyph row. */
21570 g = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
21571 e = row->glyphs[TEXT_AREA] - 1;
21572 while (g > e
21573 && INTEGERP (g->object)
21574 && g->charpos < 0)
21575 g--;
21576 g1 = g;
21577 for (nglyphs = 0; g > e && !INTEGERP (g->object); g--)
21578 nglyphs++;
21579 levels = make_uninit_vector (nglyphs);
21580 for (i = 0; g1 > g; i++, g1--)
21581 ASET (levels, i, make_number (g1->resolved_level));
21583 return levels;
21585 else
21586 return Qnil;
21591 /***********************************************************************
21592 Menu Bar
21593 ***********************************************************************/
21595 /* Redisplay the menu bar in the frame for window W.
21597 The menu bar of X frames that don't have X toolkit support is
21598 displayed in a special window W->frame->menu_bar_window.
21600 The menu bar of terminal frames is treated specially as far as
21601 glyph matrices are concerned. Menu bar lines are not part of
21602 windows, so the update is done directly on the frame matrix rows
21603 for the menu bar. */
21605 static void
21606 display_menu_bar (struct window *w)
21608 struct frame *f = XFRAME (WINDOW_FRAME (w));
21609 struct it it;
21610 Lisp_Object items;
21611 int i;
21613 /* Don't do all this for graphical frames. */
21614 #ifdef HAVE_NTGUI
21615 if (FRAME_W32_P (f))
21616 return;
21617 #endif
21618 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21619 if (FRAME_X_P (f))
21620 return;
21621 #endif
21623 #ifdef HAVE_NS
21624 if (FRAME_NS_P (f))
21625 return;
21626 #endif /* HAVE_NS */
21628 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21629 eassert (!FRAME_WINDOW_P (f));
21630 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
21631 it.first_visible_x = 0;
21632 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21633 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21634 if (FRAME_WINDOW_P (f))
21636 /* Menu bar lines are displayed in the desired matrix of the
21637 dummy window menu_bar_window. */
21638 struct window *menu_w;
21639 menu_w = XWINDOW (f->menu_bar_window);
21640 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
21641 MENU_FACE_ID);
21642 it.first_visible_x = 0;
21643 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21645 else
21646 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21648 /* This is a TTY frame, i.e. character hpos/vpos are used as
21649 pixel x/y. */
21650 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
21651 MENU_FACE_ID);
21652 it.first_visible_x = 0;
21653 it.last_visible_x = FRAME_COLS (f);
21656 /* FIXME: This should be controlled by a user option. See the
21657 comments in redisplay_tool_bar and display_mode_line about
21658 this. */
21659 it.paragraph_embedding = L2R;
21661 /* Clear all rows of the menu bar. */
21662 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
21664 struct glyph_row *row = it.glyph_row + i;
21665 clear_glyph_row (row);
21666 row->enabled_p = true;
21667 row->full_width_p = 1;
21668 row->reversed_p = false;
21671 /* Display all items of the menu bar. */
21672 items = FRAME_MENU_BAR_ITEMS (it.f);
21673 for (i = 0; i < ASIZE (items); i += 4)
21675 Lisp_Object string;
21677 /* Stop at nil string. */
21678 string = AREF (items, i + 1);
21679 if (NILP (string))
21680 break;
21682 /* Remember where item was displayed. */
21683 ASET (items, i + 3, make_number (it.hpos));
21685 /* Display the item, pad with one space. */
21686 if (it.current_x < it.last_visible_x)
21687 display_string (NULL, string, Qnil, 0, 0, &it,
21688 SCHARS (string) + 1, 0, 0, -1);
21691 /* Fill out the line with spaces. */
21692 if (it.current_x < it.last_visible_x)
21693 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
21695 /* Compute the total height of the lines. */
21696 compute_line_metrics (&it);
21699 /* Deep copy of a glyph row, including the glyphs. */
21700 static void
21701 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
21703 struct glyph *pointers[1 + LAST_AREA];
21704 int to_used = to->used[TEXT_AREA];
21706 /* Save glyph pointers of TO. */
21707 memcpy (pointers, to->glyphs, sizeof to->glyphs);
21709 /* Do a structure assignment. */
21710 *to = *from;
21712 /* Restore original glyph pointers of TO. */
21713 memcpy (to->glyphs, pointers, sizeof to->glyphs);
21715 /* Copy the glyphs. */
21716 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
21717 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
21719 /* If we filled only part of the TO row, fill the rest with
21720 space_glyph (which will display as empty space). */
21721 if (to_used > from->used[TEXT_AREA])
21722 fill_up_frame_row_with_spaces (to, to_used);
21725 /* Display one menu item on a TTY, by overwriting the glyphs in the
21726 frame F's desired glyph matrix with glyphs produced from the menu
21727 item text. Called from term.c to display TTY drop-down menus one
21728 item at a time.
21730 ITEM_TEXT is the menu item text as a C string.
21732 FACE_ID is the face ID to be used for this menu item. FACE_ID
21733 could specify one of 3 faces: a face for an enabled item, a face
21734 for a disabled item, or a face for a selected item.
21736 X and Y are coordinates of the first glyph in the frame's desired
21737 matrix to be overwritten by the menu item. Since this is a TTY, Y
21738 is the zero-based number of the glyph row and X is the zero-based
21739 glyph number in the row, starting from left, where to start
21740 displaying the item.
21742 SUBMENU non-zero means this menu item drops down a submenu, which
21743 should be indicated by displaying a proper visual cue after the
21744 item text. */
21746 void
21747 display_tty_menu_item (const char *item_text, int width, int face_id,
21748 int x, int y, int submenu)
21750 struct it it;
21751 struct frame *f = SELECTED_FRAME ();
21752 struct window *w = XWINDOW (f->selected_window);
21753 int saved_used, saved_truncated, saved_width, saved_reversed;
21754 struct glyph_row *row;
21755 size_t item_len = strlen (item_text);
21757 eassert (FRAME_TERMCAP_P (f));
21759 /* Don't write beyond the matrix's last row. This can happen for
21760 TTY screens that are not high enough to show the entire menu.
21761 (This is actually a bit of defensive programming, as
21762 tty_menu_display already limits the number of menu items to one
21763 less than the number of screen lines.) */
21764 if (y >= f->desired_matrix->nrows)
21765 return;
21767 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
21768 it.first_visible_x = 0;
21769 it.last_visible_x = FRAME_COLS (f) - 1;
21770 row = it.glyph_row;
21771 /* Start with the row contents from the current matrix. */
21772 deep_copy_glyph_row (row, f->current_matrix->rows + y);
21773 saved_width = row->full_width_p;
21774 row->full_width_p = 1;
21775 saved_reversed = row->reversed_p;
21776 row->reversed_p = 0;
21777 row->enabled_p = true;
21779 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21780 desired face. */
21781 eassert (x < f->desired_matrix->matrix_w);
21782 it.current_x = it.hpos = x;
21783 it.current_y = it.vpos = y;
21784 saved_used = row->used[TEXT_AREA];
21785 saved_truncated = row->truncated_on_right_p;
21786 row->used[TEXT_AREA] = x;
21787 it.face_id = face_id;
21788 it.line_wrap = TRUNCATE;
21790 /* FIXME: This should be controlled by a user option. See the
21791 comments in redisplay_tool_bar and display_mode_line about this.
21792 Also, if paragraph_embedding could ever be R2L, changes will be
21793 needed to avoid shifting to the right the row characters in
21794 term.c:append_glyph. */
21795 it.paragraph_embedding = L2R;
21797 /* Pad with a space on the left. */
21798 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
21799 width--;
21800 /* Display the menu item, pad with spaces to WIDTH. */
21801 if (submenu)
21803 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21804 item_len, 0, FRAME_COLS (f) - 1, -1);
21805 width -= item_len;
21806 /* Indicate with " >" that there's a submenu. */
21807 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
21808 FRAME_COLS (f) - 1, -1);
21810 else
21811 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21812 width, 0, FRAME_COLS (f) - 1, -1);
21814 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
21815 row->truncated_on_right_p = saved_truncated;
21816 row->hash = row_hash (row);
21817 row->full_width_p = saved_width;
21818 row->reversed_p = saved_reversed;
21821 /***********************************************************************
21822 Mode Line
21823 ***********************************************************************/
21825 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21826 FORCE is non-zero, redisplay mode lines unconditionally.
21827 Otherwise, redisplay only mode lines that are garbaged. Value is
21828 the number of windows whose mode lines were redisplayed. */
21830 static int
21831 redisplay_mode_lines (Lisp_Object window, bool force)
21833 int nwindows = 0;
21835 while (!NILP (window))
21837 struct window *w = XWINDOW (window);
21839 if (WINDOWP (w->contents))
21840 nwindows += redisplay_mode_lines (w->contents, force);
21841 else if (force
21842 || FRAME_GARBAGED_P (XFRAME (w->frame))
21843 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
21845 struct text_pos lpoint;
21846 struct buffer *old = current_buffer;
21848 /* Set the window's buffer for the mode line display. */
21849 SET_TEXT_POS (lpoint, PT, PT_BYTE);
21850 set_buffer_internal_1 (XBUFFER (w->contents));
21852 /* Point refers normally to the selected window. For any
21853 other window, set up appropriate value. */
21854 if (!EQ (window, selected_window))
21856 struct text_pos pt;
21858 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
21859 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
21862 /* Display mode lines. */
21863 clear_glyph_matrix (w->desired_matrix);
21864 if (display_mode_lines (w))
21865 ++nwindows;
21867 /* Restore old settings. */
21868 set_buffer_internal_1 (old);
21869 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
21872 window = w->next;
21875 return nwindows;
21879 /* Display the mode and/or header line of window W. Value is the
21880 sum number of mode lines and header lines displayed. */
21882 static int
21883 display_mode_lines (struct window *w)
21885 Lisp_Object old_selected_window = selected_window;
21886 Lisp_Object old_selected_frame = selected_frame;
21887 Lisp_Object new_frame = w->frame;
21888 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
21889 int n = 0;
21891 selected_frame = new_frame;
21892 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21893 or window's point, then we'd need select_window_1 here as well. */
21894 XSETWINDOW (selected_window, w);
21895 XFRAME (new_frame)->selected_window = selected_window;
21897 /* These will be set while the mode line specs are processed. */
21898 line_number_displayed = 0;
21899 w->column_number_displayed = -1;
21901 if (WINDOW_WANTS_MODELINE_P (w))
21903 struct window *sel_w = XWINDOW (old_selected_window);
21905 /* Select mode line face based on the real selected window. */
21906 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
21907 BVAR (current_buffer, mode_line_format));
21908 ++n;
21911 if (WINDOW_WANTS_HEADER_LINE_P (w))
21913 display_mode_line (w, HEADER_LINE_FACE_ID,
21914 BVAR (current_buffer, header_line_format));
21915 ++n;
21918 XFRAME (new_frame)->selected_window = old_frame_selected_window;
21919 selected_frame = old_selected_frame;
21920 selected_window = old_selected_window;
21921 if (n > 0)
21922 w->must_be_updated_p = true;
21923 return n;
21927 /* Display mode or header line of window W. FACE_ID specifies which
21928 line to display; it is either MODE_LINE_FACE_ID or
21929 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21930 display. Value is the pixel height of the mode/header line
21931 displayed. */
21933 static int
21934 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
21936 struct it it;
21937 struct face *face;
21938 ptrdiff_t count = SPECPDL_INDEX ();
21940 init_iterator (&it, w, -1, -1, NULL, face_id);
21941 /* Don't extend on a previously drawn mode-line.
21942 This may happen if called from pos_visible_p. */
21943 it.glyph_row->enabled_p = false;
21944 prepare_desired_row (w, it.glyph_row, true);
21946 it.glyph_row->mode_line_p = 1;
21948 /* FIXME: This should be controlled by a user option. But
21949 supporting such an option is not trivial, since the mode line is
21950 made up of many separate strings. */
21951 it.paragraph_embedding = L2R;
21953 record_unwind_protect (unwind_format_mode_line,
21954 format_mode_line_unwind_data (NULL, NULL, Qnil, 0));
21956 mode_line_target = MODE_LINE_DISPLAY;
21958 /* Temporarily make frame's keyboard the current kboard so that
21959 kboard-local variables in the mode_line_format will get the right
21960 values. */
21961 push_kboard (FRAME_KBOARD (it.f));
21962 record_unwind_save_match_data ();
21963 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
21964 pop_kboard ();
21966 unbind_to (count, Qnil);
21968 /* Fill up with spaces. */
21969 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
21971 compute_line_metrics (&it);
21972 it.glyph_row->full_width_p = 1;
21973 it.glyph_row->continued_p = 0;
21974 it.glyph_row->truncated_on_left_p = 0;
21975 it.glyph_row->truncated_on_right_p = 0;
21977 /* Make a 3D mode-line have a shadow at its right end. */
21978 face = FACE_FROM_ID (it.f, face_id);
21979 extend_face_to_end_of_line (&it);
21980 if (face->box != FACE_NO_BOX)
21982 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
21983 + it.glyph_row->used[TEXT_AREA] - 1);
21984 last->right_box_line_p = 1;
21987 return it.glyph_row->height;
21990 /* Move element ELT in LIST to the front of LIST.
21991 Return the updated list. */
21993 static Lisp_Object
21994 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
21996 register Lisp_Object tail, prev;
21997 register Lisp_Object tem;
21999 tail = list;
22000 prev = Qnil;
22001 while (CONSP (tail))
22003 tem = XCAR (tail);
22005 if (EQ (elt, tem))
22007 /* Splice out the link TAIL. */
22008 if (NILP (prev))
22009 list = XCDR (tail);
22010 else
22011 Fsetcdr (prev, XCDR (tail));
22013 /* Now make it the first. */
22014 Fsetcdr (tail, list);
22015 return tail;
22017 else
22018 prev = tail;
22019 tail = XCDR (tail);
22020 QUIT;
22023 /* Not found--return unchanged LIST. */
22024 return list;
22027 /* Contribute ELT to the mode line for window IT->w. How it
22028 translates into text depends on its data type.
22030 IT describes the display environment in which we display, as usual.
22032 DEPTH is the depth in recursion. It is used to prevent
22033 infinite recursion here.
22035 FIELD_WIDTH is the number of characters the display of ELT should
22036 occupy in the mode line, and PRECISION is the maximum number of
22037 characters to display from ELT's representation. See
22038 display_string for details.
22040 Returns the hpos of the end of the text generated by ELT.
22042 PROPS is a property list to add to any string we encounter.
22044 If RISKY is nonzero, remove (disregard) any properties in any string
22045 we encounter, and ignore :eval and :propertize.
22047 The global variable `mode_line_target' determines whether the
22048 output is passed to `store_mode_line_noprop',
22049 `store_mode_line_string', or `display_string'. */
22051 static int
22052 display_mode_element (struct it *it, int depth, int field_width, int precision,
22053 Lisp_Object elt, Lisp_Object props, int risky)
22055 int n = 0, field, prec;
22056 int literal = 0;
22058 tail_recurse:
22059 if (depth > 100)
22060 elt = build_string ("*too-deep*");
22062 depth++;
22064 switch (XTYPE (elt))
22066 case Lisp_String:
22068 /* A string: output it and check for %-constructs within it. */
22069 unsigned char c;
22070 ptrdiff_t offset = 0;
22072 if (SCHARS (elt) > 0
22073 && (!NILP (props) || risky))
22075 Lisp_Object oprops, aelt;
22076 oprops = Ftext_properties_at (make_number (0), elt);
22078 /* If the starting string's properties are not what
22079 we want, translate the string. Also, if the string
22080 is risky, do that anyway. */
22082 if (NILP (Fequal (props, oprops)) || risky)
22084 /* If the starting string has properties,
22085 merge the specified ones onto the existing ones. */
22086 if (! NILP (oprops) && !risky)
22088 Lisp_Object tem;
22090 oprops = Fcopy_sequence (oprops);
22091 tem = props;
22092 while (CONSP (tem))
22094 oprops = Fplist_put (oprops, XCAR (tem),
22095 XCAR (XCDR (tem)));
22096 tem = XCDR (XCDR (tem));
22098 props = oprops;
22101 aelt = Fassoc (elt, mode_line_proptrans_alist);
22102 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
22104 /* AELT is what we want. Move it to the front
22105 without consing. */
22106 elt = XCAR (aelt);
22107 mode_line_proptrans_alist
22108 = move_elt_to_front (aelt, mode_line_proptrans_alist);
22110 else
22112 Lisp_Object tem;
22114 /* If AELT has the wrong props, it is useless.
22115 so get rid of it. */
22116 if (! NILP (aelt))
22117 mode_line_proptrans_alist
22118 = Fdelq (aelt, mode_line_proptrans_alist);
22120 elt = Fcopy_sequence (elt);
22121 Fset_text_properties (make_number (0), Flength (elt),
22122 props, elt);
22123 /* Add this item to mode_line_proptrans_alist. */
22124 mode_line_proptrans_alist
22125 = Fcons (Fcons (elt, props),
22126 mode_line_proptrans_alist);
22127 /* Truncate mode_line_proptrans_alist
22128 to at most 50 elements. */
22129 tem = Fnthcdr (make_number (50),
22130 mode_line_proptrans_alist);
22131 if (! NILP (tem))
22132 XSETCDR (tem, Qnil);
22137 offset = 0;
22139 if (literal)
22141 prec = precision - n;
22142 switch (mode_line_target)
22144 case MODE_LINE_NOPROP:
22145 case MODE_LINE_TITLE:
22146 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
22147 break;
22148 case MODE_LINE_STRING:
22149 n += store_mode_line_string (NULL, elt, 1, 0, prec, Qnil);
22150 break;
22151 case MODE_LINE_DISPLAY:
22152 n += display_string (NULL, elt, Qnil, 0, 0, it,
22153 0, prec, 0, STRING_MULTIBYTE (elt));
22154 break;
22157 break;
22160 /* Handle the non-literal case. */
22162 while ((precision <= 0 || n < precision)
22163 && SREF (elt, offset) != 0
22164 && (mode_line_target != MODE_LINE_DISPLAY
22165 || it->current_x < it->last_visible_x))
22167 ptrdiff_t last_offset = offset;
22169 /* Advance to end of string or next format specifier. */
22170 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
22173 if (offset - 1 != last_offset)
22175 ptrdiff_t nchars, nbytes;
22177 /* Output to end of string or up to '%'. Field width
22178 is length of string. Don't output more than
22179 PRECISION allows us. */
22180 offset--;
22182 prec = c_string_width (SDATA (elt) + last_offset,
22183 offset - last_offset, precision - n,
22184 &nchars, &nbytes);
22186 switch (mode_line_target)
22188 case MODE_LINE_NOPROP:
22189 case MODE_LINE_TITLE:
22190 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
22191 break;
22192 case MODE_LINE_STRING:
22194 ptrdiff_t bytepos = last_offset;
22195 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22196 ptrdiff_t endpos = (precision <= 0
22197 ? string_byte_to_char (elt, offset)
22198 : charpos + nchars);
22200 n += store_mode_line_string (NULL,
22201 Fsubstring (elt, make_number (charpos),
22202 make_number (endpos)),
22203 0, 0, 0, Qnil);
22205 break;
22206 case MODE_LINE_DISPLAY:
22208 ptrdiff_t bytepos = last_offset;
22209 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22211 if (precision <= 0)
22212 nchars = string_byte_to_char (elt, offset) - charpos;
22213 n += display_string (NULL, elt, Qnil, 0, charpos,
22214 it, 0, nchars, 0,
22215 STRING_MULTIBYTE (elt));
22217 break;
22220 else /* c == '%' */
22222 ptrdiff_t percent_position = offset;
22224 /* Get the specified minimum width. Zero means
22225 don't pad. */
22226 field = 0;
22227 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
22228 field = field * 10 + c - '0';
22230 /* Don't pad beyond the total padding allowed. */
22231 if (field_width - n > 0 && field > field_width - n)
22232 field = field_width - n;
22234 /* Note that either PRECISION <= 0 or N < PRECISION. */
22235 prec = precision - n;
22237 if (c == 'M')
22238 n += display_mode_element (it, depth, field, prec,
22239 Vglobal_mode_string, props,
22240 risky);
22241 else if (c != 0)
22243 bool multibyte;
22244 ptrdiff_t bytepos, charpos;
22245 const char *spec;
22246 Lisp_Object string;
22248 bytepos = percent_position;
22249 charpos = (STRING_MULTIBYTE (elt)
22250 ? string_byte_to_char (elt, bytepos)
22251 : bytepos);
22252 spec = decode_mode_spec (it->w, c, field, &string);
22253 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
22255 switch (mode_line_target)
22257 case MODE_LINE_NOPROP:
22258 case MODE_LINE_TITLE:
22259 n += store_mode_line_noprop (spec, field, prec);
22260 break;
22261 case MODE_LINE_STRING:
22263 Lisp_Object tem = build_string (spec);
22264 props = Ftext_properties_at (make_number (charpos), elt);
22265 /* Should only keep face property in props */
22266 n += store_mode_line_string (NULL, tem, 0, field, prec, props);
22268 break;
22269 case MODE_LINE_DISPLAY:
22271 int nglyphs_before, nwritten;
22273 nglyphs_before = it->glyph_row->used[TEXT_AREA];
22274 nwritten = display_string (spec, string, elt,
22275 charpos, 0, it,
22276 field, prec, 0,
22277 multibyte);
22279 /* Assign to the glyphs written above the
22280 string where the `%x' came from, position
22281 of the `%'. */
22282 if (nwritten > 0)
22284 struct glyph *glyph
22285 = (it->glyph_row->glyphs[TEXT_AREA]
22286 + nglyphs_before);
22287 int i;
22289 for (i = 0; i < nwritten; ++i)
22291 glyph[i].object = elt;
22292 glyph[i].charpos = charpos;
22295 n += nwritten;
22298 break;
22301 else /* c == 0 */
22302 break;
22306 break;
22308 case Lisp_Symbol:
22309 /* A symbol: process the value of the symbol recursively
22310 as if it appeared here directly. Avoid error if symbol void.
22311 Special case: if value of symbol is a string, output the string
22312 literally. */
22314 register Lisp_Object tem;
22316 /* If the variable is not marked as risky to set
22317 then its contents are risky to use. */
22318 if (NILP (Fget (elt, Qrisky_local_variable)))
22319 risky = 1;
22321 tem = Fboundp (elt);
22322 if (!NILP (tem))
22324 tem = Fsymbol_value (elt);
22325 /* If value is a string, output that string literally:
22326 don't check for % within it. */
22327 if (STRINGP (tem))
22328 literal = 1;
22330 if (!EQ (tem, elt))
22332 /* Give up right away for nil or t. */
22333 elt = tem;
22334 goto tail_recurse;
22338 break;
22340 case Lisp_Cons:
22342 register Lisp_Object car, tem;
22344 /* A cons cell: five distinct cases.
22345 If first element is :eval or :propertize, do something special.
22346 If first element is a string or a cons, process all the elements
22347 and effectively concatenate them.
22348 If first element is a negative number, truncate displaying cdr to
22349 at most that many characters. If positive, pad (with spaces)
22350 to at least that many characters.
22351 If first element is a symbol, process the cadr or caddr recursively
22352 according to whether the symbol's value is non-nil or nil. */
22353 car = XCAR (elt);
22354 if (EQ (car, QCeval))
22356 /* An element of the form (:eval FORM) means evaluate FORM
22357 and use the result as mode line elements. */
22359 if (risky)
22360 break;
22362 if (CONSP (XCDR (elt)))
22364 Lisp_Object spec;
22365 spec = safe__eval (true, XCAR (XCDR (elt)));
22366 n += display_mode_element (it, depth, field_width - n,
22367 precision - n, spec, props,
22368 risky);
22371 else if (EQ (car, QCpropertize))
22373 /* An element of the form (:propertize ELT PROPS...)
22374 means display ELT but applying properties PROPS. */
22376 if (risky)
22377 break;
22379 if (CONSP (XCDR (elt)))
22380 n += display_mode_element (it, depth, field_width - n,
22381 precision - n, XCAR (XCDR (elt)),
22382 XCDR (XCDR (elt)), risky);
22384 else if (SYMBOLP (car))
22386 tem = Fboundp (car);
22387 elt = XCDR (elt);
22388 if (!CONSP (elt))
22389 goto invalid;
22390 /* elt is now the cdr, and we know it is a cons cell.
22391 Use its car if CAR has a non-nil value. */
22392 if (!NILP (tem))
22394 tem = Fsymbol_value (car);
22395 if (!NILP (tem))
22397 elt = XCAR (elt);
22398 goto tail_recurse;
22401 /* Symbol's value is nil (or symbol is unbound)
22402 Get the cddr of the original list
22403 and if possible find the caddr and use that. */
22404 elt = XCDR (elt);
22405 if (NILP (elt))
22406 break;
22407 else if (!CONSP (elt))
22408 goto invalid;
22409 elt = XCAR (elt);
22410 goto tail_recurse;
22412 else if (INTEGERP (car))
22414 register int lim = XINT (car);
22415 elt = XCDR (elt);
22416 if (lim < 0)
22418 /* Negative int means reduce maximum width. */
22419 if (precision <= 0)
22420 precision = -lim;
22421 else
22422 precision = min (precision, -lim);
22424 else if (lim > 0)
22426 /* Padding specified. Don't let it be more than
22427 current maximum. */
22428 if (precision > 0)
22429 lim = min (precision, lim);
22431 /* If that's more padding than already wanted, queue it.
22432 But don't reduce padding already specified even if
22433 that is beyond the current truncation point. */
22434 field_width = max (lim, field_width);
22436 goto tail_recurse;
22438 else if (STRINGP (car) || CONSP (car))
22440 Lisp_Object halftail = elt;
22441 int len = 0;
22443 while (CONSP (elt)
22444 && (precision <= 0 || n < precision))
22446 n += display_mode_element (it, depth,
22447 /* Do padding only after the last
22448 element in the list. */
22449 (! CONSP (XCDR (elt))
22450 ? field_width - n
22451 : 0),
22452 precision - n, XCAR (elt),
22453 props, risky);
22454 elt = XCDR (elt);
22455 len++;
22456 if ((len & 1) == 0)
22457 halftail = XCDR (halftail);
22458 /* Check for cycle. */
22459 if (EQ (halftail, elt))
22460 break;
22464 break;
22466 default:
22467 invalid:
22468 elt = build_string ("*invalid*");
22469 goto tail_recurse;
22472 /* Pad to FIELD_WIDTH. */
22473 if (field_width > 0 && n < field_width)
22475 switch (mode_line_target)
22477 case MODE_LINE_NOPROP:
22478 case MODE_LINE_TITLE:
22479 n += store_mode_line_noprop ("", field_width - n, 0);
22480 break;
22481 case MODE_LINE_STRING:
22482 n += store_mode_line_string ("", Qnil, 0, field_width - n, 0, Qnil);
22483 break;
22484 case MODE_LINE_DISPLAY:
22485 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22486 0, 0, 0);
22487 break;
22491 return n;
22494 /* Store a mode-line string element in mode_line_string_list.
22496 If STRING is non-null, display that C string. Otherwise, the Lisp
22497 string LISP_STRING is displayed.
22499 FIELD_WIDTH is the minimum number of output glyphs to produce.
22500 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22501 with spaces. FIELD_WIDTH <= 0 means don't pad.
22503 PRECISION is the maximum number of characters to output from
22504 STRING. PRECISION <= 0 means don't truncate the string.
22506 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22507 properties to the string.
22509 PROPS are the properties to add to the string.
22510 The mode_line_string_face face property is always added to the string.
22513 static int
22514 store_mode_line_string (const char *string, Lisp_Object lisp_string, int copy_string,
22515 int field_width, int precision, Lisp_Object props)
22517 ptrdiff_t len;
22518 int n = 0;
22520 if (string != NULL)
22522 len = strlen (string);
22523 if (precision > 0 && len > precision)
22524 len = precision;
22525 lisp_string = make_string (string, len);
22526 if (NILP (props))
22527 props = mode_line_string_face_prop;
22528 else if (!NILP (mode_line_string_face))
22530 Lisp_Object face = Fplist_get (props, Qface);
22531 props = Fcopy_sequence (props);
22532 if (NILP (face))
22533 face = mode_line_string_face;
22534 else
22535 face = list2 (face, mode_line_string_face);
22536 props = Fplist_put (props, Qface, face);
22538 Fadd_text_properties (make_number (0), make_number (len),
22539 props, lisp_string);
22541 else
22543 len = XFASTINT (Flength (lisp_string));
22544 if (precision > 0 && len > precision)
22546 len = precision;
22547 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
22548 precision = -1;
22550 if (!NILP (mode_line_string_face))
22552 Lisp_Object face;
22553 if (NILP (props))
22554 props = Ftext_properties_at (make_number (0), lisp_string);
22555 face = Fplist_get (props, Qface);
22556 if (NILP (face))
22557 face = mode_line_string_face;
22558 else
22559 face = list2 (face, mode_line_string_face);
22560 props = list2 (Qface, face);
22561 if (copy_string)
22562 lisp_string = Fcopy_sequence (lisp_string);
22564 if (!NILP (props))
22565 Fadd_text_properties (make_number (0), make_number (len),
22566 props, lisp_string);
22569 if (len > 0)
22571 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22572 n += len;
22575 if (field_width > len)
22577 field_width -= len;
22578 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
22579 if (!NILP (props))
22580 Fadd_text_properties (make_number (0), make_number (field_width),
22581 props, lisp_string);
22582 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22583 n += field_width;
22586 return n;
22590 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
22591 1, 4, 0,
22592 doc: /* Format a string out of a mode line format specification.
22593 First arg FORMAT specifies the mode line format (see `mode-line-format'
22594 for details) to use.
22596 By default, the format is evaluated for the currently selected window.
22598 Optional second arg FACE specifies the face property to put on all
22599 characters for which no face is specified. The value nil means the
22600 default face. The value t means whatever face the window's mode line
22601 currently uses (either `mode-line' or `mode-line-inactive',
22602 depending on whether the window is the selected window or not).
22603 An integer value means the value string has no text
22604 properties.
22606 Optional third and fourth args WINDOW and BUFFER specify the window
22607 and buffer to use as the context for the formatting (defaults
22608 are the selected window and the WINDOW's buffer). */)
22609 (Lisp_Object format, Lisp_Object face,
22610 Lisp_Object window, Lisp_Object buffer)
22612 struct it it;
22613 int len;
22614 struct window *w;
22615 struct buffer *old_buffer = NULL;
22616 int face_id;
22617 int no_props = INTEGERP (face);
22618 ptrdiff_t count = SPECPDL_INDEX ();
22619 Lisp_Object str;
22620 int string_start = 0;
22622 w = decode_any_window (window);
22623 XSETWINDOW (window, w);
22625 if (NILP (buffer))
22626 buffer = w->contents;
22627 CHECK_BUFFER (buffer);
22629 /* Make formatting the modeline a non-op when noninteractive, otherwise
22630 there will be problems later caused by a partially initialized frame. */
22631 if (NILP (format) || noninteractive)
22632 return empty_unibyte_string;
22634 if (no_props)
22635 face = Qnil;
22637 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
22638 : EQ (face, Qt) ? (EQ (window, selected_window)
22639 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
22640 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
22641 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
22642 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
22643 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
22644 : DEFAULT_FACE_ID;
22646 old_buffer = current_buffer;
22648 /* Save things including mode_line_proptrans_alist,
22649 and set that to nil so that we don't alter the outer value. */
22650 record_unwind_protect (unwind_format_mode_line,
22651 format_mode_line_unwind_data
22652 (XFRAME (WINDOW_FRAME (w)),
22653 old_buffer, selected_window, 1));
22654 mode_line_proptrans_alist = Qnil;
22656 Fselect_window (window, Qt);
22657 set_buffer_internal_1 (XBUFFER (buffer));
22659 init_iterator (&it, w, -1, -1, NULL, face_id);
22661 if (no_props)
22663 mode_line_target = MODE_LINE_NOPROP;
22664 mode_line_string_face_prop = Qnil;
22665 mode_line_string_list = Qnil;
22666 string_start = MODE_LINE_NOPROP_LEN (0);
22668 else
22670 mode_line_target = MODE_LINE_STRING;
22671 mode_line_string_list = Qnil;
22672 mode_line_string_face = face;
22673 mode_line_string_face_prop
22674 = NILP (face) ? Qnil : list2 (Qface, face);
22677 push_kboard (FRAME_KBOARD (it.f));
22678 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
22679 pop_kboard ();
22681 if (no_props)
22683 len = MODE_LINE_NOPROP_LEN (string_start);
22684 str = make_string (mode_line_noprop_buf + string_start, len);
22686 else
22688 mode_line_string_list = Fnreverse (mode_line_string_list);
22689 str = Fmapconcat (intern ("identity"), mode_line_string_list,
22690 empty_unibyte_string);
22693 unbind_to (count, Qnil);
22694 return str;
22697 /* Write a null-terminated, right justified decimal representation of
22698 the positive integer D to BUF using a minimal field width WIDTH. */
22700 static void
22701 pint2str (register char *buf, register int width, register ptrdiff_t d)
22703 register char *p = buf;
22705 if (d <= 0)
22706 *p++ = '0';
22707 else
22709 while (d > 0)
22711 *p++ = d % 10 + '0';
22712 d /= 10;
22716 for (width -= (int) (p - buf); width > 0; --width)
22717 *p++ = ' ';
22718 *p-- = '\0';
22719 while (p > buf)
22721 d = *buf;
22722 *buf++ = *p;
22723 *p-- = d;
22727 /* Write a null-terminated, right justified decimal and "human
22728 readable" representation of the nonnegative integer D to BUF using
22729 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22731 static const char power_letter[] =
22733 0, /* no letter */
22734 'k', /* kilo */
22735 'M', /* mega */
22736 'G', /* giga */
22737 'T', /* tera */
22738 'P', /* peta */
22739 'E', /* exa */
22740 'Z', /* zetta */
22741 'Y' /* yotta */
22744 static void
22745 pint2hrstr (char *buf, int width, ptrdiff_t d)
22747 /* We aim to represent the nonnegative integer D as
22748 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22749 ptrdiff_t quotient = d;
22750 int remainder = 0;
22751 /* -1 means: do not use TENTHS. */
22752 int tenths = -1;
22753 int exponent = 0;
22755 /* Length of QUOTIENT.TENTHS as a string. */
22756 int length;
22758 char * psuffix;
22759 char * p;
22761 if (quotient >= 1000)
22763 /* Scale to the appropriate EXPONENT. */
22766 remainder = quotient % 1000;
22767 quotient /= 1000;
22768 exponent++;
22770 while (quotient >= 1000);
22772 /* Round to nearest and decide whether to use TENTHS or not. */
22773 if (quotient <= 9)
22775 tenths = remainder / 100;
22776 if (remainder % 100 >= 50)
22778 if (tenths < 9)
22779 tenths++;
22780 else
22782 quotient++;
22783 if (quotient == 10)
22784 tenths = -1;
22785 else
22786 tenths = 0;
22790 else
22791 if (remainder >= 500)
22793 if (quotient < 999)
22794 quotient++;
22795 else
22797 quotient = 1;
22798 exponent++;
22799 tenths = 0;
22804 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22805 if (tenths == -1 && quotient <= 99)
22806 if (quotient <= 9)
22807 length = 1;
22808 else
22809 length = 2;
22810 else
22811 length = 3;
22812 p = psuffix = buf + max (width, length);
22814 /* Print EXPONENT. */
22815 *psuffix++ = power_letter[exponent];
22816 *psuffix = '\0';
22818 /* Print TENTHS. */
22819 if (tenths >= 0)
22821 *--p = '0' + tenths;
22822 *--p = '.';
22825 /* Print QUOTIENT. */
22828 int digit = quotient % 10;
22829 *--p = '0' + digit;
22831 while ((quotient /= 10) != 0);
22833 /* Print leading spaces. */
22834 while (buf < p)
22835 *--p = ' ';
22838 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22839 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22840 type of CODING_SYSTEM. Return updated pointer into BUF. */
22842 static unsigned char invalid_eol_type[] = "(*invalid*)";
22844 static char *
22845 decode_mode_spec_coding (Lisp_Object coding_system, register char *buf, int eol_flag)
22847 Lisp_Object val;
22848 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
22849 const unsigned char *eol_str;
22850 int eol_str_len;
22851 /* The EOL conversion we are using. */
22852 Lisp_Object eoltype;
22854 val = CODING_SYSTEM_SPEC (coding_system);
22855 eoltype = Qnil;
22857 if (!VECTORP (val)) /* Not yet decided. */
22859 *buf++ = multibyte ? '-' : ' ';
22860 if (eol_flag)
22861 eoltype = eol_mnemonic_undecided;
22862 /* Don't mention EOL conversion if it isn't decided. */
22864 else
22866 Lisp_Object attrs;
22867 Lisp_Object eolvalue;
22869 attrs = AREF (val, 0);
22870 eolvalue = AREF (val, 2);
22872 *buf++ = multibyte
22873 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
22874 : ' ';
22876 if (eol_flag)
22878 /* The EOL conversion that is normal on this system. */
22880 if (NILP (eolvalue)) /* Not yet decided. */
22881 eoltype = eol_mnemonic_undecided;
22882 else if (VECTORP (eolvalue)) /* Not yet decided. */
22883 eoltype = eol_mnemonic_undecided;
22884 else /* eolvalue is Qunix, Qdos, or Qmac. */
22885 eoltype = (EQ (eolvalue, Qunix)
22886 ? eol_mnemonic_unix
22887 : (EQ (eolvalue, Qdos) == 1
22888 ? eol_mnemonic_dos : eol_mnemonic_mac));
22892 if (eol_flag)
22894 /* Mention the EOL conversion if it is not the usual one. */
22895 if (STRINGP (eoltype))
22897 eol_str = SDATA (eoltype);
22898 eol_str_len = SBYTES (eoltype);
22900 else if (CHARACTERP (eoltype))
22902 int c = XFASTINT (eoltype);
22903 return buf + CHAR_STRING (c, (unsigned char *) buf);
22905 else
22907 eol_str = invalid_eol_type;
22908 eol_str_len = sizeof (invalid_eol_type) - 1;
22910 memcpy (buf, eol_str, eol_str_len);
22911 buf += eol_str_len;
22914 return buf;
22917 /* Return a string for the output of a mode line %-spec for window W,
22918 generated by character C. FIELD_WIDTH > 0 means pad the string
22919 returned with spaces to that value. Return a Lisp string in
22920 *STRING if the resulting string is taken from that Lisp string.
22922 Note we operate on the current buffer for most purposes. */
22924 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22926 static const char *
22927 decode_mode_spec (struct window *w, register int c, int field_width,
22928 Lisp_Object *string)
22930 Lisp_Object obj;
22931 struct frame *f = XFRAME (WINDOW_FRAME (w));
22932 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
22933 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22934 produce strings from numerical values, so limit preposterously
22935 large values of FIELD_WIDTH to avoid overrunning the buffer's
22936 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22937 bytes plus the terminating null. */
22938 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
22939 struct buffer *b = current_buffer;
22941 obj = Qnil;
22942 *string = Qnil;
22944 switch (c)
22946 case '*':
22947 if (!NILP (BVAR (b, read_only)))
22948 return "%";
22949 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22950 return "*";
22951 return "-";
22953 case '+':
22954 /* This differs from %* only for a modified read-only buffer. */
22955 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22956 return "*";
22957 if (!NILP (BVAR (b, read_only)))
22958 return "%";
22959 return "-";
22961 case '&':
22962 /* This differs from %* in ignoring read-only-ness. */
22963 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22964 return "*";
22965 return "-";
22967 case '%':
22968 return "%";
22970 case '[':
22972 int i;
22973 char *p;
22975 if (command_loop_level > 5)
22976 return "[[[... ";
22977 p = decode_mode_spec_buf;
22978 for (i = 0; i < command_loop_level; i++)
22979 *p++ = '[';
22980 *p = 0;
22981 return decode_mode_spec_buf;
22984 case ']':
22986 int i;
22987 char *p;
22989 if (command_loop_level > 5)
22990 return " ...]]]";
22991 p = decode_mode_spec_buf;
22992 for (i = 0; i < command_loop_level; i++)
22993 *p++ = ']';
22994 *p = 0;
22995 return decode_mode_spec_buf;
22998 case '-':
23000 register int i;
23002 /* Let lots_of_dashes be a string of infinite length. */
23003 if (mode_line_target == MODE_LINE_NOPROP
23004 || mode_line_target == MODE_LINE_STRING)
23005 return "--";
23006 if (field_width <= 0
23007 || field_width > sizeof (lots_of_dashes))
23009 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
23010 decode_mode_spec_buf[i] = '-';
23011 decode_mode_spec_buf[i] = '\0';
23012 return decode_mode_spec_buf;
23014 else
23015 return lots_of_dashes;
23018 case 'b':
23019 obj = BVAR (b, name);
23020 break;
23022 case 'c':
23023 /* %c and %l are ignored in `frame-title-format'.
23024 (In redisplay_internal, the frame title is drawn _before_ the
23025 windows are updated, so the stuff which depends on actual
23026 window contents (such as %l) may fail to render properly, or
23027 even crash emacs.) */
23028 if (mode_line_target == MODE_LINE_TITLE)
23029 return "";
23030 else
23032 ptrdiff_t col = current_column ();
23033 w->column_number_displayed = col;
23034 pint2str (decode_mode_spec_buf, width, col);
23035 return decode_mode_spec_buf;
23038 case 'e':
23039 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23041 if (NILP (Vmemory_full))
23042 return "";
23043 else
23044 return "!MEM FULL! ";
23046 #else
23047 return "";
23048 #endif
23050 case 'F':
23051 /* %F displays the frame name. */
23052 if (!NILP (f->title))
23053 return SSDATA (f->title);
23054 if (f->explicit_name || ! FRAME_WINDOW_P (f))
23055 return SSDATA (f->name);
23056 return "Emacs";
23058 case 'f':
23059 obj = BVAR (b, filename);
23060 break;
23062 case 'i':
23064 ptrdiff_t size = ZV - BEGV;
23065 pint2str (decode_mode_spec_buf, width, size);
23066 return decode_mode_spec_buf;
23069 case 'I':
23071 ptrdiff_t size = ZV - BEGV;
23072 pint2hrstr (decode_mode_spec_buf, width, size);
23073 return decode_mode_spec_buf;
23076 case 'l':
23078 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
23079 ptrdiff_t topline, nlines, height;
23080 ptrdiff_t junk;
23082 /* %c and %l are ignored in `frame-title-format'. */
23083 if (mode_line_target == MODE_LINE_TITLE)
23084 return "";
23086 startpos = marker_position (w->start);
23087 startpos_byte = marker_byte_position (w->start);
23088 height = WINDOW_TOTAL_LINES (w);
23090 /* If we decided that this buffer isn't suitable for line numbers,
23091 don't forget that too fast. */
23092 if (w->base_line_pos == -1)
23093 goto no_value;
23095 /* If the buffer is very big, don't waste time. */
23096 if (INTEGERP (Vline_number_display_limit)
23097 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
23099 w->base_line_pos = 0;
23100 w->base_line_number = 0;
23101 goto no_value;
23104 if (w->base_line_number > 0
23105 && w->base_line_pos > 0
23106 && w->base_line_pos <= startpos)
23108 line = w->base_line_number;
23109 linepos = w->base_line_pos;
23110 linepos_byte = buf_charpos_to_bytepos (b, linepos);
23112 else
23114 line = 1;
23115 linepos = BUF_BEGV (b);
23116 linepos_byte = BUF_BEGV_BYTE (b);
23119 /* Count lines from base line to window start position. */
23120 nlines = display_count_lines (linepos_byte,
23121 startpos_byte,
23122 startpos, &junk);
23124 topline = nlines + line;
23126 /* Determine a new base line, if the old one is too close
23127 or too far away, or if we did not have one.
23128 "Too close" means it's plausible a scroll-down would
23129 go back past it. */
23130 if (startpos == BUF_BEGV (b))
23132 w->base_line_number = topline;
23133 w->base_line_pos = BUF_BEGV (b);
23135 else if (nlines < height + 25 || nlines > height * 3 + 50
23136 || linepos == BUF_BEGV (b))
23138 ptrdiff_t limit = BUF_BEGV (b);
23139 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
23140 ptrdiff_t position;
23141 ptrdiff_t distance =
23142 (height * 2 + 30) * line_number_display_limit_width;
23144 if (startpos - distance > limit)
23146 limit = startpos - distance;
23147 limit_byte = CHAR_TO_BYTE (limit);
23150 nlines = display_count_lines (startpos_byte,
23151 limit_byte,
23152 - (height * 2 + 30),
23153 &position);
23154 /* If we couldn't find the lines we wanted within
23155 line_number_display_limit_width chars per line,
23156 give up on line numbers for this window. */
23157 if (position == limit_byte && limit == startpos - distance)
23159 w->base_line_pos = -1;
23160 w->base_line_number = 0;
23161 goto no_value;
23164 w->base_line_number = topline - nlines;
23165 w->base_line_pos = BYTE_TO_CHAR (position);
23168 /* Now count lines from the start pos to point. */
23169 nlines = display_count_lines (startpos_byte,
23170 PT_BYTE, PT, &junk);
23172 /* Record that we did display the line number. */
23173 line_number_displayed = 1;
23175 /* Make the string to show. */
23176 pint2str (decode_mode_spec_buf, width, topline + nlines);
23177 return decode_mode_spec_buf;
23178 no_value:
23180 char *p = decode_mode_spec_buf;
23181 int pad = width - 2;
23182 while (pad-- > 0)
23183 *p++ = ' ';
23184 *p++ = '?';
23185 *p++ = '?';
23186 *p = '\0';
23187 return decode_mode_spec_buf;
23190 break;
23192 case 'm':
23193 obj = BVAR (b, mode_name);
23194 break;
23196 case 'n':
23197 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
23198 return " Narrow";
23199 break;
23201 case 'p':
23203 ptrdiff_t pos = marker_position (w->start);
23204 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23206 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
23208 if (pos <= BUF_BEGV (b))
23209 return "All";
23210 else
23211 return "Bottom";
23213 else if (pos <= BUF_BEGV (b))
23214 return "Top";
23215 else
23217 if (total > 1000000)
23218 /* Do it differently for a large value, to avoid overflow. */
23219 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23220 else
23221 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
23222 /* We can't normally display a 3-digit number,
23223 so get us a 2-digit number that is close. */
23224 if (total == 100)
23225 total = 99;
23226 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23227 return decode_mode_spec_buf;
23231 /* Display percentage of size above the bottom of the screen. */
23232 case 'P':
23234 ptrdiff_t toppos = marker_position (w->start);
23235 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
23236 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23238 if (botpos >= BUF_ZV (b))
23240 if (toppos <= BUF_BEGV (b))
23241 return "All";
23242 else
23243 return "Bottom";
23245 else
23247 if (total > 1000000)
23248 /* Do it differently for a large value, to avoid overflow. */
23249 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23250 else
23251 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
23252 /* We can't normally display a 3-digit number,
23253 so get us a 2-digit number that is close. */
23254 if (total == 100)
23255 total = 99;
23256 if (toppos <= BUF_BEGV (b))
23257 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
23258 else
23259 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23260 return decode_mode_spec_buf;
23264 case 's':
23265 /* status of process */
23266 obj = Fget_buffer_process (Fcurrent_buffer ());
23267 if (NILP (obj))
23268 return "no process";
23269 #ifndef MSDOS
23270 obj = Fsymbol_name (Fprocess_status (obj));
23271 #endif
23272 break;
23274 case '@':
23276 ptrdiff_t count = inhibit_garbage_collection ();
23277 Lisp_Object curdir = BVAR (current_buffer, directory);
23278 Lisp_Object val = Qnil;
23280 if (STRINGP (curdir))
23281 val = call1 (intern ("file-remote-p"), curdir);
23283 unbind_to (count, Qnil);
23285 if (NILP (val))
23286 return "-";
23287 else
23288 return "@";
23291 case 'z':
23292 /* coding-system (not including end-of-line format) */
23293 case 'Z':
23294 /* coding-system (including end-of-line type) */
23296 int eol_flag = (c == 'Z');
23297 char *p = decode_mode_spec_buf;
23299 if (! FRAME_WINDOW_P (f))
23301 /* No need to mention EOL here--the terminal never needs
23302 to do EOL conversion. */
23303 p = decode_mode_spec_coding (CODING_ID_NAME
23304 (FRAME_KEYBOARD_CODING (f)->id),
23305 p, 0);
23306 p = decode_mode_spec_coding (CODING_ID_NAME
23307 (FRAME_TERMINAL_CODING (f)->id),
23308 p, 0);
23310 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
23311 p, eol_flag);
23313 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23314 #ifdef subprocesses
23315 obj = Fget_buffer_process (Fcurrent_buffer ());
23316 if (PROCESSP (obj))
23318 p = decode_mode_spec_coding
23319 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
23320 p = decode_mode_spec_coding
23321 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
23323 #endif /* subprocesses */
23324 #endif /* 0 */
23325 *p = 0;
23326 return decode_mode_spec_buf;
23330 if (STRINGP (obj))
23332 *string = obj;
23333 return SSDATA (obj);
23335 else
23336 return "";
23340 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23341 means count lines back from START_BYTE. But don't go beyond
23342 LIMIT_BYTE. Return the number of lines thus found (always
23343 nonnegative).
23345 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23346 either the position COUNT lines after/before START_BYTE, if we
23347 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23348 COUNT lines. */
23350 static ptrdiff_t
23351 display_count_lines (ptrdiff_t start_byte,
23352 ptrdiff_t limit_byte, ptrdiff_t count,
23353 ptrdiff_t *byte_pos_ptr)
23355 register unsigned char *cursor;
23356 unsigned char *base;
23358 register ptrdiff_t ceiling;
23359 register unsigned char *ceiling_addr;
23360 ptrdiff_t orig_count = count;
23362 /* If we are not in selective display mode,
23363 check only for newlines. */
23364 int selective_display = (!NILP (BVAR (current_buffer, selective_display))
23365 && !INTEGERP (BVAR (current_buffer, selective_display)));
23367 if (count > 0)
23369 while (start_byte < limit_byte)
23371 ceiling = BUFFER_CEILING_OF (start_byte);
23372 ceiling = min (limit_byte - 1, ceiling);
23373 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
23374 base = (cursor = BYTE_POS_ADDR (start_byte));
23378 if (selective_display)
23380 while (*cursor != '\n' && *cursor != 015
23381 && ++cursor != ceiling_addr)
23382 continue;
23383 if (cursor == ceiling_addr)
23384 break;
23386 else
23388 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
23389 if (! cursor)
23390 break;
23393 cursor++;
23395 if (--count == 0)
23397 start_byte += cursor - base;
23398 *byte_pos_ptr = start_byte;
23399 return orig_count;
23402 while (cursor < ceiling_addr);
23404 start_byte += ceiling_addr - base;
23407 else
23409 while (start_byte > limit_byte)
23411 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
23412 ceiling = max (limit_byte, ceiling);
23413 ceiling_addr = BYTE_POS_ADDR (ceiling);
23414 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
23415 while (1)
23417 if (selective_display)
23419 while (--cursor >= ceiling_addr
23420 && *cursor != '\n' && *cursor != 015)
23421 continue;
23422 if (cursor < ceiling_addr)
23423 break;
23425 else
23427 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
23428 if (! cursor)
23429 break;
23432 if (++count == 0)
23434 start_byte += cursor - base + 1;
23435 *byte_pos_ptr = start_byte;
23436 /* When scanning backwards, we should
23437 not count the newline posterior to which we stop. */
23438 return - orig_count - 1;
23441 start_byte += ceiling_addr - base;
23445 *byte_pos_ptr = limit_byte;
23447 if (count < 0)
23448 return - orig_count + count;
23449 return orig_count - count;
23455 /***********************************************************************
23456 Displaying strings
23457 ***********************************************************************/
23459 /* Display a NUL-terminated string, starting with index START.
23461 If STRING is non-null, display that C string. Otherwise, the Lisp
23462 string LISP_STRING is displayed. There's a case that STRING is
23463 non-null and LISP_STRING is not nil. It means STRING is a string
23464 data of LISP_STRING. In that case, we display LISP_STRING while
23465 ignoring its text properties.
23467 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23468 FACE_STRING. Display STRING or LISP_STRING with the face at
23469 FACE_STRING_POS in FACE_STRING:
23471 Display the string in the environment given by IT, but use the
23472 standard display table, temporarily.
23474 FIELD_WIDTH is the minimum number of output glyphs to produce.
23475 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23476 with spaces. If STRING has more characters, more than FIELD_WIDTH
23477 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23479 PRECISION is the maximum number of characters to output from
23480 STRING. PRECISION < 0 means don't truncate the string.
23482 This is roughly equivalent to printf format specifiers:
23484 FIELD_WIDTH PRECISION PRINTF
23485 ----------------------------------------
23486 -1 -1 %s
23487 -1 10 %.10s
23488 10 -1 %10s
23489 20 10 %20.10s
23491 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23492 display them, and < 0 means obey the current buffer's value of
23493 enable_multibyte_characters.
23495 Value is the number of columns displayed. */
23497 static int
23498 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23499 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23500 int field_width, int precision, int max_x, int multibyte)
23502 int hpos_at_start = it->hpos;
23503 int saved_face_id = it->face_id;
23504 struct glyph_row *row = it->glyph_row;
23505 ptrdiff_t it_charpos;
23507 /* Initialize the iterator IT for iteration over STRING beginning
23508 with index START. */
23509 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23510 precision, field_width, multibyte);
23511 if (string && STRINGP (lisp_string))
23512 /* LISP_STRING is the one returned by decode_mode_spec. We should
23513 ignore its text properties. */
23514 it->stop_charpos = it->end_charpos;
23516 /* If displaying STRING, set up the face of the iterator from
23517 FACE_STRING, if that's given. */
23518 if (STRINGP (face_string))
23520 ptrdiff_t endptr;
23521 struct face *face;
23523 it->face_id
23524 = face_at_string_position (it->w, face_string, face_string_pos,
23525 0, &endptr, it->base_face_id, 0);
23526 face = FACE_FROM_ID (it->f, it->face_id);
23527 it->face_box_p = face->box != FACE_NO_BOX;
23530 /* Set max_x to the maximum allowed X position. Don't let it go
23531 beyond the right edge of the window. */
23532 if (max_x <= 0)
23533 max_x = it->last_visible_x;
23534 else
23535 max_x = min (max_x, it->last_visible_x);
23537 /* Skip over display elements that are not visible. because IT->w is
23538 hscrolled. */
23539 if (it->current_x < it->first_visible_x)
23540 move_it_in_display_line_to (it, 100000, it->first_visible_x,
23541 MOVE_TO_POS | MOVE_TO_X);
23543 row->ascent = it->max_ascent;
23544 row->height = it->max_ascent + it->max_descent;
23545 row->phys_ascent = it->max_phys_ascent;
23546 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
23547 row->extra_line_spacing = it->max_extra_line_spacing;
23549 if (STRINGP (it->string))
23550 it_charpos = IT_STRING_CHARPOS (*it);
23551 else
23552 it_charpos = IT_CHARPOS (*it);
23554 /* This condition is for the case that we are called with current_x
23555 past last_visible_x. */
23556 while (it->current_x < max_x)
23558 int x_before, x, n_glyphs_before, i, nglyphs;
23560 /* Get the next display element. */
23561 if (!get_next_display_element (it))
23562 break;
23564 /* Produce glyphs. */
23565 x_before = it->current_x;
23566 n_glyphs_before = row->used[TEXT_AREA];
23567 PRODUCE_GLYPHS (it);
23569 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
23570 i = 0;
23571 x = x_before;
23572 while (i < nglyphs)
23574 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
23576 if (it->line_wrap != TRUNCATE
23577 && x + glyph->pixel_width > max_x)
23579 /* End of continued line or max_x reached. */
23580 if (CHAR_GLYPH_PADDING_P (*glyph))
23582 /* A wide character is unbreakable. */
23583 if (row->reversed_p)
23584 unproduce_glyphs (it, row->used[TEXT_AREA]
23585 - n_glyphs_before);
23586 row->used[TEXT_AREA] = n_glyphs_before;
23587 it->current_x = x_before;
23589 else
23591 if (row->reversed_p)
23592 unproduce_glyphs (it, row->used[TEXT_AREA]
23593 - (n_glyphs_before + i));
23594 row->used[TEXT_AREA] = n_glyphs_before + i;
23595 it->current_x = x;
23597 break;
23599 else if (x + glyph->pixel_width >= it->first_visible_x)
23601 /* Glyph is at least partially visible. */
23602 ++it->hpos;
23603 if (x < it->first_visible_x)
23604 row->x = x - it->first_visible_x;
23606 else
23608 /* Glyph is off the left margin of the display area.
23609 Should not happen. */
23610 emacs_abort ();
23613 row->ascent = max (row->ascent, it->max_ascent);
23614 row->height = max (row->height, it->max_ascent + it->max_descent);
23615 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
23616 row->phys_height = max (row->phys_height,
23617 it->max_phys_ascent + it->max_phys_descent);
23618 row->extra_line_spacing = max (row->extra_line_spacing,
23619 it->max_extra_line_spacing);
23620 x += glyph->pixel_width;
23621 ++i;
23624 /* Stop if max_x reached. */
23625 if (i < nglyphs)
23626 break;
23628 /* Stop at line ends. */
23629 if (ITERATOR_AT_END_OF_LINE_P (it))
23631 it->continuation_lines_width = 0;
23632 break;
23635 set_iterator_to_next (it, 1);
23636 if (STRINGP (it->string))
23637 it_charpos = IT_STRING_CHARPOS (*it);
23638 else
23639 it_charpos = IT_CHARPOS (*it);
23641 /* Stop if truncating at the right edge. */
23642 if (it->line_wrap == TRUNCATE
23643 && it->current_x >= it->last_visible_x)
23645 /* Add truncation mark, but don't do it if the line is
23646 truncated at a padding space. */
23647 if (it_charpos < it->string_nchars)
23649 if (!FRAME_WINDOW_P (it->f))
23651 int ii, n;
23653 if (it->current_x > it->last_visible_x)
23655 if (!row->reversed_p)
23657 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
23658 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23659 break;
23661 else
23663 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
23664 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23665 break;
23666 unproduce_glyphs (it, ii + 1);
23667 ii = row->used[TEXT_AREA] - (ii + 1);
23669 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
23671 row->used[TEXT_AREA] = ii;
23672 produce_special_glyphs (it, IT_TRUNCATION);
23675 produce_special_glyphs (it, IT_TRUNCATION);
23677 row->truncated_on_right_p = 1;
23679 break;
23683 /* Maybe insert a truncation at the left. */
23684 if (it->first_visible_x
23685 && it_charpos > 0)
23687 if (!FRAME_WINDOW_P (it->f)
23688 || (row->reversed_p
23689 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23690 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
23691 insert_left_trunc_glyphs (it);
23692 row->truncated_on_left_p = 1;
23695 it->face_id = saved_face_id;
23697 /* Value is number of columns displayed. */
23698 return it->hpos - hpos_at_start;
23703 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23704 appears as an element of LIST or as the car of an element of LIST.
23705 If PROPVAL is a list, compare each element against LIST in that
23706 way, and return 1/2 if any element of PROPVAL is found in LIST.
23707 Otherwise return 0. This function cannot quit.
23708 The return value is 2 if the text is invisible but with an ellipsis
23709 and 1 if it's invisible and without an ellipsis. */
23712 invisible_p (register Lisp_Object propval, Lisp_Object list)
23714 register Lisp_Object tail, proptail;
23716 for (tail = list; CONSP (tail); tail = XCDR (tail))
23718 register Lisp_Object tem;
23719 tem = XCAR (tail);
23720 if (EQ (propval, tem))
23721 return 1;
23722 if (CONSP (tem) && EQ (propval, XCAR (tem)))
23723 return NILP (XCDR (tem)) ? 1 : 2;
23726 if (CONSP (propval))
23728 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
23730 Lisp_Object propelt;
23731 propelt = XCAR (proptail);
23732 for (tail = list; CONSP (tail); tail = XCDR (tail))
23734 register Lisp_Object tem;
23735 tem = XCAR (tail);
23736 if (EQ (propelt, tem))
23737 return 1;
23738 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
23739 return NILP (XCDR (tem)) ? 1 : 2;
23744 return 0;
23747 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
23748 doc: /* Non-nil if the property makes the text invisible.
23749 POS-OR-PROP can be a marker or number, in which case it is taken to be
23750 a position in the current buffer and the value of the `invisible' property
23751 is checked; or it can be some other value, which is then presumed to be the
23752 value of the `invisible' property of the text of interest.
23753 The non-nil value returned can be t for truly invisible text or something
23754 else if the text is replaced by an ellipsis. */)
23755 (Lisp_Object pos_or_prop)
23757 Lisp_Object prop
23758 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
23759 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
23760 : pos_or_prop);
23761 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
23762 return (invis == 0 ? Qnil
23763 : invis == 1 ? Qt
23764 : make_number (invis));
23767 /* Calculate a width or height in pixels from a specification using
23768 the following elements:
23770 SPEC ::=
23771 NUM - a (fractional) multiple of the default font width/height
23772 (NUM) - specifies exactly NUM pixels
23773 UNIT - a fixed number of pixels, see below.
23774 ELEMENT - size of a display element in pixels, see below.
23775 (NUM . SPEC) - equals NUM * SPEC
23776 (+ SPEC SPEC ...) - add pixel values
23777 (- SPEC SPEC ...) - subtract pixel values
23778 (- SPEC) - negate pixel value
23780 NUM ::=
23781 INT or FLOAT - a number constant
23782 SYMBOL - use symbol's (buffer local) variable binding.
23784 UNIT ::=
23785 in - pixels per inch *)
23786 mm - pixels per 1/1000 meter *)
23787 cm - pixels per 1/100 meter *)
23788 width - width of current font in pixels.
23789 height - height of current font in pixels.
23791 *) using the ratio(s) defined in display-pixels-per-inch.
23793 ELEMENT ::=
23795 left-fringe - left fringe width in pixels
23796 right-fringe - right fringe width in pixels
23798 left-margin - left margin width in pixels
23799 right-margin - right margin width in pixels
23801 scroll-bar - scroll-bar area width in pixels
23803 Examples:
23805 Pixels corresponding to 5 inches:
23806 (5 . in)
23808 Total width of non-text areas on left side of window (if scroll-bar is on left):
23809 '(space :width (+ left-fringe left-margin scroll-bar))
23811 Align to first text column (in header line):
23812 '(space :align-to 0)
23814 Align to middle of text area minus half the width of variable `my-image'
23815 containing a loaded image:
23816 '(space :align-to (0.5 . (- text my-image)))
23818 Width of left margin minus width of 1 character in the default font:
23819 '(space :width (- left-margin 1))
23821 Width of left margin minus width of 2 characters in the current font:
23822 '(space :width (- left-margin (2 . width)))
23824 Center 1 character over left-margin (in header line):
23825 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23827 Different ways to express width of left fringe plus left margin minus one pixel:
23828 '(space :width (- (+ left-fringe left-margin) (1)))
23829 '(space :width (+ left-fringe left-margin (- (1))))
23830 '(space :width (+ left-fringe left-margin (-1)))
23834 static int
23835 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
23836 struct font *font, int width_p, int *align_to)
23838 double pixels;
23840 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23841 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23843 if (NILP (prop))
23844 return OK_PIXELS (0);
23846 eassert (FRAME_LIVE_P (it->f));
23848 if (SYMBOLP (prop))
23850 if (SCHARS (SYMBOL_NAME (prop)) == 2)
23852 char *unit = SSDATA (SYMBOL_NAME (prop));
23854 if (unit[0] == 'i' && unit[1] == 'n')
23855 pixels = 1.0;
23856 else if (unit[0] == 'm' && unit[1] == 'm')
23857 pixels = 25.4;
23858 else if (unit[0] == 'c' && unit[1] == 'm')
23859 pixels = 2.54;
23860 else
23861 pixels = 0;
23862 if (pixels > 0)
23864 double ppi = (width_p ? FRAME_RES_X (it->f)
23865 : FRAME_RES_Y (it->f));
23867 if (ppi > 0)
23868 return OK_PIXELS (ppi / pixels);
23869 return 0;
23873 #ifdef HAVE_WINDOW_SYSTEM
23874 if (EQ (prop, Qheight))
23875 return OK_PIXELS (font ? FONT_HEIGHT (font) : FRAME_LINE_HEIGHT (it->f));
23876 if (EQ (prop, Qwidth))
23877 return OK_PIXELS (font ? FONT_WIDTH (font) : FRAME_COLUMN_WIDTH (it->f));
23878 #else
23879 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
23880 return OK_PIXELS (1);
23881 #endif
23883 if (EQ (prop, Qtext))
23884 return OK_PIXELS (width_p
23885 ? window_box_width (it->w, TEXT_AREA)
23886 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
23888 if (align_to && *align_to < 0)
23890 *res = 0;
23891 if (EQ (prop, Qleft))
23892 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
23893 if (EQ (prop, Qright))
23894 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
23895 if (EQ (prop, Qcenter))
23896 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
23897 + window_box_width (it->w, TEXT_AREA) / 2);
23898 if (EQ (prop, Qleft_fringe))
23899 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23900 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
23901 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
23902 if (EQ (prop, Qright_fringe))
23903 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23904 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23905 : window_box_right_offset (it->w, TEXT_AREA));
23906 if (EQ (prop, Qleft_margin))
23907 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
23908 if (EQ (prop, Qright_margin))
23909 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
23910 if (EQ (prop, Qscroll_bar))
23911 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
23913 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23914 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23915 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23916 : 0)));
23918 else
23920 if (EQ (prop, Qleft_fringe))
23921 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
23922 if (EQ (prop, Qright_fringe))
23923 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
23924 if (EQ (prop, Qleft_margin))
23925 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
23926 if (EQ (prop, Qright_margin))
23927 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
23928 if (EQ (prop, Qscroll_bar))
23929 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
23932 prop = buffer_local_value (prop, it->w->contents);
23933 if (EQ (prop, Qunbound))
23934 prop = Qnil;
23937 if (INTEGERP (prop) || FLOATP (prop))
23939 int base_unit = (width_p
23940 ? FRAME_COLUMN_WIDTH (it->f)
23941 : FRAME_LINE_HEIGHT (it->f));
23942 return OK_PIXELS (XFLOATINT (prop) * base_unit);
23945 if (CONSP (prop))
23947 Lisp_Object car = XCAR (prop);
23948 Lisp_Object cdr = XCDR (prop);
23950 if (SYMBOLP (car))
23952 #ifdef HAVE_WINDOW_SYSTEM
23953 if (FRAME_WINDOW_P (it->f)
23954 && valid_image_p (prop))
23956 ptrdiff_t id = lookup_image (it->f, prop);
23957 struct image *img = IMAGE_FROM_ID (it->f, id);
23959 return OK_PIXELS (width_p ? img->width : img->height);
23961 #endif
23962 if (EQ (car, Qplus) || EQ (car, Qminus))
23964 int first = 1;
23965 double px;
23967 pixels = 0;
23968 while (CONSP (cdr))
23970 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
23971 font, width_p, align_to))
23972 return 0;
23973 if (first)
23974 pixels = (EQ (car, Qplus) ? px : -px), first = 0;
23975 else
23976 pixels += px;
23977 cdr = XCDR (cdr);
23979 if (EQ (car, Qminus))
23980 pixels = -pixels;
23981 return OK_PIXELS (pixels);
23984 car = buffer_local_value (car, it->w->contents);
23985 if (EQ (car, Qunbound))
23986 car = Qnil;
23989 if (INTEGERP (car) || FLOATP (car))
23991 double fact;
23992 pixels = XFLOATINT (car);
23993 if (NILP (cdr))
23994 return OK_PIXELS (pixels);
23995 if (calc_pixel_width_or_height (&fact, it, cdr,
23996 font, width_p, align_to))
23997 return OK_PIXELS (pixels * fact);
23998 return 0;
24001 return 0;
24004 return 0;
24008 /***********************************************************************
24009 Glyph Display
24010 ***********************************************************************/
24012 #ifdef HAVE_WINDOW_SYSTEM
24014 #ifdef GLYPH_DEBUG
24016 void
24017 dump_glyph_string (struct glyph_string *s)
24019 fprintf (stderr, "glyph string\n");
24020 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
24021 s->x, s->y, s->width, s->height);
24022 fprintf (stderr, " ybase = %d\n", s->ybase);
24023 fprintf (stderr, " hl = %d\n", s->hl);
24024 fprintf (stderr, " left overhang = %d, right = %d\n",
24025 s->left_overhang, s->right_overhang);
24026 fprintf (stderr, " nchars = %d\n", s->nchars);
24027 fprintf (stderr, " extends to end of line = %d\n",
24028 s->extends_to_end_of_line_p);
24029 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
24030 fprintf (stderr, " bg width = %d\n", s->background_width);
24033 #endif /* GLYPH_DEBUG */
24035 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24036 of XChar2b structures for S; it can't be allocated in
24037 init_glyph_string because it must be allocated via `alloca'. W
24038 is the window on which S is drawn. ROW and AREA are the glyph row
24039 and area within the row from which S is constructed. START is the
24040 index of the first glyph structure covered by S. HL is a
24041 face-override for drawing S. */
24043 #ifdef HAVE_NTGUI
24044 #define OPTIONAL_HDC(hdc) HDC hdc,
24045 #define DECLARE_HDC(hdc) HDC hdc;
24046 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24047 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24048 #endif
24050 #ifndef OPTIONAL_HDC
24051 #define OPTIONAL_HDC(hdc)
24052 #define DECLARE_HDC(hdc)
24053 #define ALLOCATE_HDC(hdc, f)
24054 #define RELEASE_HDC(hdc, f)
24055 #endif
24057 static void
24058 init_glyph_string (struct glyph_string *s,
24059 OPTIONAL_HDC (hdc)
24060 XChar2b *char2b, struct window *w, struct glyph_row *row,
24061 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
24063 memset (s, 0, sizeof *s);
24064 s->w = w;
24065 s->f = XFRAME (w->frame);
24066 #ifdef HAVE_NTGUI
24067 s->hdc = hdc;
24068 #endif
24069 s->display = FRAME_X_DISPLAY (s->f);
24070 s->window = FRAME_X_WINDOW (s->f);
24071 s->char2b = char2b;
24072 s->hl = hl;
24073 s->row = row;
24074 s->area = area;
24075 s->first_glyph = row->glyphs[area] + start;
24076 s->height = row->height;
24077 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
24078 s->ybase = s->y + row->ascent;
24082 /* Append the list of glyph strings with head H and tail T to the list
24083 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24085 static void
24086 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24087 struct glyph_string *h, struct glyph_string *t)
24089 if (h)
24091 if (*head)
24092 (*tail)->next = h;
24093 else
24094 *head = h;
24095 h->prev = *tail;
24096 *tail = t;
24101 /* Prepend the list of glyph strings with head H and tail T to the
24102 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24103 result. */
24105 static void
24106 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
24107 struct glyph_string *h, struct glyph_string *t)
24109 if (h)
24111 if (*head)
24112 (*head)->prev = t;
24113 else
24114 *tail = t;
24115 t->next = *head;
24116 *head = h;
24121 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24122 Set *HEAD and *TAIL to the resulting list. */
24124 static void
24125 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
24126 struct glyph_string *s)
24128 s->next = s->prev = NULL;
24129 append_glyph_string_lists (head, tail, s, s);
24133 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24134 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24135 make sure that X resources for the face returned are allocated.
24136 Value is a pointer to a realized face that is ready for display if
24137 DISPLAY_P is non-zero. */
24139 static struct face *
24140 get_char_face_and_encoding (struct frame *f, int c, int face_id,
24141 XChar2b *char2b, int display_p)
24143 struct face *face = FACE_FROM_ID (f, face_id);
24144 unsigned code = 0;
24146 if (face->font)
24148 code = face->font->driver->encode_char (face->font, c);
24150 if (code == FONT_INVALID_CODE)
24151 code = 0;
24153 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24155 /* Make sure X resources of the face are allocated. */
24156 #ifdef HAVE_X_WINDOWS
24157 if (display_p)
24158 #endif
24160 eassert (face != NULL);
24161 prepare_face_for_display (f, face);
24164 return face;
24168 /* Get face and two-byte form of character glyph GLYPH on frame F.
24169 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24170 a pointer to a realized face that is ready for display. */
24172 static struct face *
24173 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
24174 XChar2b *char2b, int *two_byte_p)
24176 struct face *face;
24177 unsigned code = 0;
24179 eassert (glyph->type == CHAR_GLYPH);
24180 face = FACE_FROM_ID (f, glyph->face_id);
24182 /* Make sure X resources of the face are allocated. */
24183 eassert (face != NULL);
24184 prepare_face_for_display (f, face);
24186 if (two_byte_p)
24187 *two_byte_p = 0;
24189 if (face->font)
24191 if (CHAR_BYTE8_P (glyph->u.ch))
24192 code = CHAR_TO_BYTE8 (glyph->u.ch);
24193 else
24194 code = face->font->driver->encode_char (face->font, glyph->u.ch);
24196 if (code == FONT_INVALID_CODE)
24197 code = 0;
24200 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24201 return face;
24205 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24206 Return 1 if FONT has a glyph for C, otherwise return 0. */
24208 static int
24209 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
24211 unsigned code;
24213 if (CHAR_BYTE8_P (c))
24214 code = CHAR_TO_BYTE8 (c);
24215 else
24216 code = font->driver->encode_char (font, c);
24218 if (code == FONT_INVALID_CODE)
24219 return 0;
24220 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24221 return 1;
24225 /* Fill glyph string S with composition components specified by S->cmp.
24227 BASE_FACE is the base face of the composition.
24228 S->cmp_from is the index of the first component for S.
24230 OVERLAPS non-zero means S should draw the foreground only, and use
24231 its physical height for clipping. See also draw_glyphs.
24233 Value is the index of a component not in S. */
24235 static int
24236 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
24237 int overlaps)
24239 int i;
24240 /* For all glyphs of this composition, starting at the offset
24241 S->cmp_from, until we reach the end of the definition or encounter a
24242 glyph that requires the different face, add it to S. */
24243 struct face *face;
24245 eassert (s);
24247 s->for_overlaps = overlaps;
24248 s->face = NULL;
24249 s->font = NULL;
24250 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
24252 int c = COMPOSITION_GLYPH (s->cmp, i);
24254 /* TAB in a composition means display glyphs with padding space
24255 on the left or right. */
24256 if (c != '\t')
24258 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
24259 -1, Qnil);
24261 face = get_char_face_and_encoding (s->f, c, face_id,
24262 s->char2b + i, 1);
24263 if (face)
24265 if (! s->face)
24267 s->face = face;
24268 s->font = s->face->font;
24270 else if (s->face != face)
24271 break;
24274 ++s->nchars;
24276 s->cmp_to = i;
24278 if (s->face == NULL)
24280 s->face = base_face->ascii_face;
24281 s->font = s->face->font;
24284 /* All glyph strings for the same composition has the same width,
24285 i.e. the width set for the first component of the composition. */
24286 s->width = s->first_glyph->pixel_width;
24288 /* If the specified font could not be loaded, use the frame's
24289 default font, but record the fact that we couldn't load it in
24290 the glyph string so that we can draw rectangles for the
24291 characters of the glyph string. */
24292 if (s->font == NULL)
24294 s->font_not_found_p = 1;
24295 s->font = FRAME_FONT (s->f);
24298 /* Adjust base line for subscript/superscript text. */
24299 s->ybase += s->first_glyph->voffset;
24301 /* This glyph string must always be drawn with 16-bit functions. */
24302 s->two_byte_p = 1;
24304 return s->cmp_to;
24307 static int
24308 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
24309 int start, int end, int overlaps)
24311 struct glyph *glyph, *last;
24312 Lisp_Object lgstring;
24313 int i;
24315 s->for_overlaps = overlaps;
24316 glyph = s->row->glyphs[s->area] + start;
24317 last = s->row->glyphs[s->area] + end;
24318 s->cmp_id = glyph->u.cmp.id;
24319 s->cmp_from = glyph->slice.cmp.from;
24320 s->cmp_to = glyph->slice.cmp.to + 1;
24321 s->face = FACE_FROM_ID (s->f, face_id);
24322 lgstring = composition_gstring_from_id (s->cmp_id);
24323 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
24324 glyph++;
24325 while (glyph < last
24326 && glyph->u.cmp.automatic
24327 && glyph->u.cmp.id == s->cmp_id
24328 && s->cmp_to == glyph->slice.cmp.from)
24329 s->cmp_to = (glyph++)->slice.cmp.to + 1;
24331 for (i = s->cmp_from; i < s->cmp_to; i++)
24333 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
24334 unsigned code = LGLYPH_CODE (lglyph);
24336 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
24338 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
24339 return glyph - s->row->glyphs[s->area];
24343 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24344 See the comment of fill_glyph_string for arguments.
24345 Value is the index of the first glyph not in S. */
24348 static int
24349 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
24350 int start, int end, int overlaps)
24352 struct glyph *glyph, *last;
24353 int voffset;
24355 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
24356 s->for_overlaps = overlaps;
24357 glyph = s->row->glyphs[s->area] + start;
24358 last = s->row->glyphs[s->area] + end;
24359 voffset = glyph->voffset;
24360 s->face = FACE_FROM_ID (s->f, face_id);
24361 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
24362 s->nchars = 1;
24363 s->width = glyph->pixel_width;
24364 glyph++;
24365 while (glyph < last
24366 && glyph->type == GLYPHLESS_GLYPH
24367 && glyph->voffset == voffset
24368 && glyph->face_id == face_id)
24370 s->nchars++;
24371 s->width += glyph->pixel_width;
24372 glyph++;
24374 s->ybase += voffset;
24375 return glyph - s->row->glyphs[s->area];
24379 /* Fill glyph string S from a sequence of character glyphs.
24381 FACE_ID is the face id of the string. START is the index of the
24382 first glyph to consider, END is the index of the last + 1.
24383 OVERLAPS non-zero means S should draw the foreground only, and use
24384 its physical height for clipping. See also draw_glyphs.
24386 Value is the index of the first glyph not in S. */
24388 static int
24389 fill_glyph_string (struct glyph_string *s, int face_id,
24390 int start, int end, int overlaps)
24392 struct glyph *glyph, *last;
24393 int voffset;
24394 int glyph_not_available_p;
24396 eassert (s->f == XFRAME (s->w->frame));
24397 eassert (s->nchars == 0);
24398 eassert (start >= 0 && end > start);
24400 s->for_overlaps = overlaps;
24401 glyph = s->row->glyphs[s->area] + start;
24402 last = s->row->glyphs[s->area] + end;
24403 voffset = glyph->voffset;
24404 s->padding_p = glyph->padding_p;
24405 glyph_not_available_p = glyph->glyph_not_available_p;
24407 while (glyph < last
24408 && glyph->type == CHAR_GLYPH
24409 && glyph->voffset == voffset
24410 /* Same face id implies same font, nowadays. */
24411 && glyph->face_id == face_id
24412 && glyph->glyph_not_available_p == glyph_not_available_p)
24414 int two_byte_p;
24416 s->face = get_glyph_face_and_encoding (s->f, glyph,
24417 s->char2b + s->nchars,
24418 &two_byte_p);
24419 s->two_byte_p = two_byte_p;
24420 ++s->nchars;
24421 eassert (s->nchars <= end - start);
24422 s->width += glyph->pixel_width;
24423 if (glyph++->padding_p != s->padding_p)
24424 break;
24427 s->font = s->face->font;
24429 /* If the specified font could not be loaded, use the frame's font,
24430 but record the fact that we couldn't load it in
24431 S->font_not_found_p so that we can draw rectangles for the
24432 characters of the glyph string. */
24433 if (s->font == NULL || glyph_not_available_p)
24435 s->font_not_found_p = 1;
24436 s->font = FRAME_FONT (s->f);
24439 /* Adjust base line for subscript/superscript text. */
24440 s->ybase += voffset;
24442 eassert (s->face && s->face->gc);
24443 return glyph - s->row->glyphs[s->area];
24447 /* Fill glyph string S from image glyph S->first_glyph. */
24449 static void
24450 fill_image_glyph_string (struct glyph_string *s)
24452 eassert (s->first_glyph->type == IMAGE_GLYPH);
24453 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
24454 eassert (s->img);
24455 s->slice = s->first_glyph->slice.img;
24456 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24457 s->font = s->face->font;
24458 s->width = s->first_glyph->pixel_width;
24460 /* Adjust base line for subscript/superscript text. */
24461 s->ybase += s->first_glyph->voffset;
24465 /* Fill glyph string S from a sequence of stretch glyphs.
24467 START is the index of the first glyph to consider,
24468 END is the index of the last + 1.
24470 Value is the index of the first glyph not in S. */
24472 static int
24473 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
24475 struct glyph *glyph, *last;
24476 int voffset, face_id;
24478 eassert (s->first_glyph->type == STRETCH_GLYPH);
24480 glyph = s->row->glyphs[s->area] + start;
24481 last = s->row->glyphs[s->area] + end;
24482 face_id = glyph->face_id;
24483 s->face = FACE_FROM_ID (s->f, face_id);
24484 s->font = s->face->font;
24485 s->width = glyph->pixel_width;
24486 s->nchars = 1;
24487 voffset = glyph->voffset;
24489 for (++glyph;
24490 (glyph < last
24491 && glyph->type == STRETCH_GLYPH
24492 && glyph->voffset == voffset
24493 && glyph->face_id == face_id);
24494 ++glyph)
24495 s->width += glyph->pixel_width;
24497 /* Adjust base line for subscript/superscript text. */
24498 s->ybase += voffset;
24500 /* The case that face->gc == 0 is handled when drawing the glyph
24501 string by calling prepare_face_for_display. */
24502 eassert (s->face);
24503 return glyph - s->row->glyphs[s->area];
24506 static struct font_metrics *
24507 get_per_char_metric (struct font *font, XChar2b *char2b)
24509 static struct font_metrics metrics;
24510 unsigned code;
24512 if (! font)
24513 return NULL;
24514 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24515 if (code == FONT_INVALID_CODE)
24516 return NULL;
24517 font->driver->text_extents (font, &code, 1, &metrics);
24518 return &metrics;
24521 /* EXPORT for RIF:
24522 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24523 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24524 assumed to be zero. */
24526 void
24527 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
24529 *left = *right = 0;
24531 if (glyph->type == CHAR_GLYPH)
24533 struct face *face;
24534 XChar2b char2b;
24535 struct font_metrics *pcm;
24537 face = get_glyph_face_and_encoding (f, glyph, &char2b, NULL);
24538 if (face->font && (pcm = get_per_char_metric (face->font, &char2b)))
24540 if (pcm->rbearing > pcm->width)
24541 *right = pcm->rbearing - pcm->width;
24542 if (pcm->lbearing < 0)
24543 *left = -pcm->lbearing;
24546 else if (glyph->type == COMPOSITE_GLYPH)
24548 if (! glyph->u.cmp.automatic)
24550 struct composition *cmp = composition_table[glyph->u.cmp.id];
24552 if (cmp->rbearing > cmp->pixel_width)
24553 *right = cmp->rbearing - cmp->pixel_width;
24554 if (cmp->lbearing < 0)
24555 *left = - cmp->lbearing;
24557 else
24559 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
24560 struct font_metrics metrics;
24562 composition_gstring_width (gstring, glyph->slice.cmp.from,
24563 glyph->slice.cmp.to + 1, &metrics);
24564 if (metrics.rbearing > metrics.width)
24565 *right = metrics.rbearing - metrics.width;
24566 if (metrics.lbearing < 0)
24567 *left = - metrics.lbearing;
24573 /* Return the index of the first glyph preceding glyph string S that
24574 is overwritten by S because of S's left overhang. Value is -1
24575 if no glyphs are overwritten. */
24577 static int
24578 left_overwritten (struct glyph_string *s)
24580 int k;
24582 if (s->left_overhang)
24584 int x = 0, i;
24585 struct glyph *glyphs = s->row->glyphs[s->area];
24586 int first = s->first_glyph - glyphs;
24588 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
24589 x -= glyphs[i].pixel_width;
24591 k = i + 1;
24593 else
24594 k = -1;
24596 return k;
24600 /* Return the index of the first glyph preceding glyph string S that
24601 is overwriting S because of its right overhang. Value is -1 if no
24602 glyph in front of S overwrites S. */
24604 static int
24605 left_overwriting (struct glyph_string *s)
24607 int i, k, x;
24608 struct glyph *glyphs = s->row->glyphs[s->area];
24609 int first = s->first_glyph - glyphs;
24611 k = -1;
24612 x = 0;
24613 for (i = first - 1; i >= 0; --i)
24615 int left, right;
24616 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24617 if (x + right > 0)
24618 k = i;
24619 x -= glyphs[i].pixel_width;
24622 return k;
24626 /* Return the index of the last glyph following glyph string S that is
24627 overwritten by S because of S's right overhang. Value is -1 if
24628 no such glyph is found. */
24630 static int
24631 right_overwritten (struct glyph_string *s)
24633 int k = -1;
24635 if (s->right_overhang)
24637 int x = 0, i;
24638 struct glyph *glyphs = s->row->glyphs[s->area];
24639 int first = (s->first_glyph - glyphs
24640 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24641 int end = s->row->used[s->area];
24643 for (i = first; i < end && s->right_overhang > x; ++i)
24644 x += glyphs[i].pixel_width;
24646 k = i;
24649 return k;
24653 /* Return the index of the last glyph following glyph string S that
24654 overwrites S because of its left overhang. Value is negative
24655 if no such glyph is found. */
24657 static int
24658 right_overwriting (struct glyph_string *s)
24660 int i, k, x;
24661 int end = s->row->used[s->area];
24662 struct glyph *glyphs = s->row->glyphs[s->area];
24663 int first = (s->first_glyph - glyphs
24664 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24666 k = -1;
24667 x = 0;
24668 for (i = first; i < end; ++i)
24670 int left, right;
24671 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24672 if (x - left < 0)
24673 k = i;
24674 x += glyphs[i].pixel_width;
24677 return k;
24681 /* Set background width of glyph string S. START is the index of the
24682 first glyph following S. LAST_X is the right-most x-position + 1
24683 in the drawing area. */
24685 static void
24686 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
24688 /* If the face of this glyph string has to be drawn to the end of
24689 the drawing area, set S->extends_to_end_of_line_p. */
24691 if (start == s->row->used[s->area]
24692 && ((s->row->fill_line_p
24693 && (s->hl == DRAW_NORMAL_TEXT
24694 || s->hl == DRAW_IMAGE_RAISED
24695 || s->hl == DRAW_IMAGE_SUNKEN))
24696 || s->hl == DRAW_MOUSE_FACE))
24697 s->extends_to_end_of_line_p = 1;
24699 /* If S extends its face to the end of the line, set its
24700 background_width to the distance to the right edge of the drawing
24701 area. */
24702 if (s->extends_to_end_of_line_p)
24703 s->background_width = last_x - s->x + 1;
24704 else
24705 s->background_width = s->width;
24709 /* Compute overhangs and x-positions for glyph string S and its
24710 predecessors, or successors. X is the starting x-position for S.
24711 BACKWARD_P non-zero means process predecessors. */
24713 static void
24714 compute_overhangs_and_x (struct glyph_string *s, int x, int backward_p)
24716 if (backward_p)
24718 while (s)
24720 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24721 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24722 x -= s->width;
24723 s->x = x;
24724 s = s->prev;
24727 else
24729 while (s)
24731 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24732 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24733 s->x = x;
24734 x += s->width;
24735 s = s->next;
24742 /* The following macros are only called from draw_glyphs below.
24743 They reference the following parameters of that function directly:
24744 `w', `row', `area', and `overlap_p'
24745 as well as the following local variables:
24746 `s', `f', and `hdc' (in W32) */
24748 #ifdef HAVE_NTGUI
24749 /* On W32, silently add local `hdc' variable to argument list of
24750 init_glyph_string. */
24751 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24752 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24753 #else
24754 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24755 init_glyph_string (s, char2b, w, row, area, start, hl)
24756 #endif
24758 /* Add a glyph string for a stretch glyph to the list of strings
24759 between HEAD and TAIL. START is the index of the stretch glyph in
24760 row area AREA of glyph row ROW. END is the index of the last glyph
24761 in that glyph row area. X is the current output position assigned
24762 to the new glyph string constructed. HL overrides that face of the
24763 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24764 is the right-most x-position of the drawing area. */
24766 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24767 and below -- keep them on one line. */
24768 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24769 do \
24771 s = alloca (sizeof *s); \
24772 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24773 START = fill_stretch_glyph_string (s, START, END); \
24774 append_glyph_string (&HEAD, &TAIL, s); \
24775 s->x = (X); \
24777 while (0)
24780 /* Add a glyph string for an image glyph to the list of strings
24781 between HEAD and TAIL. START is the index of the image glyph in
24782 row area AREA of glyph row ROW. END is the index of the last glyph
24783 in that glyph row area. X is the current output position assigned
24784 to the new glyph string constructed. HL overrides that face of the
24785 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24786 is the right-most x-position of the drawing area. */
24788 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24789 do \
24791 s = alloca (sizeof *s); \
24792 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24793 fill_image_glyph_string (s); \
24794 append_glyph_string (&HEAD, &TAIL, s); \
24795 ++START; \
24796 s->x = (X); \
24798 while (0)
24801 /* Add a glyph string for a sequence of character glyphs to the list
24802 of strings between HEAD and TAIL. START is the index of the first
24803 glyph in row area AREA of glyph row ROW that is part of the new
24804 glyph string. END is the index of the last glyph in that glyph row
24805 area. X is the current output position assigned to the new glyph
24806 string constructed. HL overrides that face of the glyph; e.g. it
24807 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24808 right-most x-position of the drawing area. */
24810 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24811 do \
24813 int face_id; \
24814 XChar2b *char2b; \
24816 face_id = (row)->glyphs[area][START].face_id; \
24818 s = alloca (sizeof *s); \
24819 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24820 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24821 append_glyph_string (&HEAD, &TAIL, s); \
24822 s->x = (X); \
24823 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24825 while (0)
24828 /* Add a glyph string for a composite sequence to the list of strings
24829 between HEAD and TAIL. START is the index of the first glyph in
24830 row area AREA of glyph row ROW that is part of the new glyph
24831 string. END is the index of the last glyph in that glyph row area.
24832 X is the current output position assigned to the new glyph string
24833 constructed. HL overrides that face of the glyph; e.g. it is
24834 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24835 x-position of the drawing area. */
24837 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24838 do { \
24839 int face_id = (row)->glyphs[area][START].face_id; \
24840 struct face *base_face = FACE_FROM_ID (f, face_id); \
24841 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24842 struct composition *cmp = composition_table[cmp_id]; \
24843 XChar2b *char2b; \
24844 struct glyph_string *first_s = NULL; \
24845 int n; \
24847 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
24849 /* Make glyph_strings for each glyph sequence that is drawable by \
24850 the same face, and append them to HEAD/TAIL. */ \
24851 for (n = 0; n < cmp->glyph_len;) \
24853 s = alloca (sizeof *s); \
24854 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24855 append_glyph_string (&(HEAD), &(TAIL), s); \
24856 s->cmp = cmp; \
24857 s->cmp_from = n; \
24858 s->x = (X); \
24859 if (n == 0) \
24860 first_s = s; \
24861 n = fill_composite_glyph_string (s, base_face, overlaps); \
24864 ++START; \
24865 s = first_s; \
24866 } while (0)
24869 /* Add a glyph string for a glyph-string sequence to the list of strings
24870 between HEAD and TAIL. */
24872 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24873 do { \
24874 int face_id; \
24875 XChar2b *char2b; \
24876 Lisp_Object gstring; \
24878 face_id = (row)->glyphs[area][START].face_id; \
24879 gstring = (composition_gstring_from_id \
24880 ((row)->glyphs[area][START].u.cmp.id)); \
24881 s = alloca (sizeof *s); \
24882 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
24883 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24884 append_glyph_string (&(HEAD), &(TAIL), s); \
24885 s->x = (X); \
24886 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24887 } while (0)
24890 /* Add a glyph string for a sequence of glyphless character's glyphs
24891 to the list of strings between HEAD and TAIL. The meanings of
24892 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24894 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24895 do \
24897 int face_id; \
24899 face_id = (row)->glyphs[area][START].face_id; \
24901 s = alloca (sizeof *s); \
24902 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24903 append_glyph_string (&HEAD, &TAIL, s); \
24904 s->x = (X); \
24905 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24906 overlaps); \
24908 while (0)
24911 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24912 of AREA of glyph row ROW on window W between indices START and END.
24913 HL overrides the face for drawing glyph strings, e.g. it is
24914 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24915 x-positions of the drawing area.
24917 This is an ugly monster macro construct because we must use alloca
24918 to allocate glyph strings (because draw_glyphs can be called
24919 asynchronously). */
24921 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24922 do \
24924 HEAD = TAIL = NULL; \
24925 while (START < END) \
24927 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24928 switch (first_glyph->type) \
24930 case CHAR_GLYPH: \
24931 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24932 HL, X, LAST_X); \
24933 break; \
24935 case COMPOSITE_GLYPH: \
24936 if (first_glyph->u.cmp.automatic) \
24937 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24938 HL, X, LAST_X); \
24939 else \
24940 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24941 HL, X, LAST_X); \
24942 break; \
24944 case STRETCH_GLYPH: \
24945 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24946 HL, X, LAST_X); \
24947 break; \
24949 case IMAGE_GLYPH: \
24950 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24951 HL, X, LAST_X); \
24952 break; \
24954 case GLYPHLESS_GLYPH: \
24955 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24956 HL, X, LAST_X); \
24957 break; \
24959 default: \
24960 emacs_abort (); \
24963 if (s) \
24965 set_glyph_string_background_width (s, START, LAST_X); \
24966 (X) += s->width; \
24969 } while (0)
24972 /* Draw glyphs between START and END in AREA of ROW on window W,
24973 starting at x-position X. X is relative to AREA in W. HL is a
24974 face-override with the following meaning:
24976 DRAW_NORMAL_TEXT draw normally
24977 DRAW_CURSOR draw in cursor face
24978 DRAW_MOUSE_FACE draw in mouse face.
24979 DRAW_INVERSE_VIDEO draw in mode line face
24980 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24981 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24983 If OVERLAPS is non-zero, draw only the foreground of characters and
24984 clip to the physical height of ROW. Non-zero value also defines
24985 the overlapping part to be drawn:
24987 OVERLAPS_PRED overlap with preceding rows
24988 OVERLAPS_SUCC overlap with succeeding rows
24989 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24990 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24992 Value is the x-position reached, relative to AREA of W. */
24994 static int
24995 draw_glyphs (struct window *w, int x, struct glyph_row *row,
24996 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
24997 enum draw_glyphs_face hl, int overlaps)
24999 struct glyph_string *head, *tail;
25000 struct glyph_string *s;
25001 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
25002 int i, j, x_reached, last_x, area_left = 0;
25003 struct frame *f = XFRAME (WINDOW_FRAME (w));
25004 DECLARE_HDC (hdc);
25006 ALLOCATE_HDC (hdc, f);
25008 /* Let's rather be paranoid than getting a SEGV. */
25009 end = min (end, row->used[area]);
25010 start = clip_to_bounds (0, start, end);
25012 /* Translate X to frame coordinates. Set last_x to the right
25013 end of the drawing area. */
25014 if (row->full_width_p)
25016 /* X is relative to the left edge of W, without scroll bars
25017 or fringes. */
25018 area_left = WINDOW_LEFT_EDGE_X (w);
25019 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
25020 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
25022 else
25024 area_left = window_box_left (w, area);
25025 last_x = area_left + window_box_width (w, area);
25027 x += area_left;
25029 /* Build a doubly-linked list of glyph_string structures between
25030 head and tail from what we have to draw. Note that the macro
25031 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25032 the reason we use a separate variable `i'. */
25033 i = start;
25034 USE_SAFE_ALLOCA;
25035 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
25036 if (tail)
25037 x_reached = tail->x + tail->background_width;
25038 else
25039 x_reached = x;
25041 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25042 the row, redraw some glyphs in front or following the glyph
25043 strings built above. */
25044 if (head && !overlaps && row->contains_overlapping_glyphs_p)
25046 struct glyph_string *h, *t;
25047 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
25048 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
25049 int check_mouse_face = 0;
25050 int dummy_x = 0;
25052 /* If mouse highlighting is on, we may need to draw adjacent
25053 glyphs using mouse-face highlighting. */
25054 if (area == TEXT_AREA && row->mouse_face_p
25055 && hlinfo->mouse_face_beg_row >= 0
25056 && hlinfo->mouse_face_end_row >= 0)
25058 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
25060 if (row_vpos >= hlinfo->mouse_face_beg_row
25061 && row_vpos <= hlinfo->mouse_face_end_row)
25063 check_mouse_face = 1;
25064 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
25065 ? hlinfo->mouse_face_beg_col : 0;
25066 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
25067 ? hlinfo->mouse_face_end_col
25068 : row->used[TEXT_AREA];
25072 /* Compute overhangs for all glyph strings. */
25073 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
25074 for (s = head; s; s = s->next)
25075 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
25077 /* Prepend glyph strings for glyphs in front of the first glyph
25078 string that are overwritten because of the first glyph
25079 string's left overhang. The background of all strings
25080 prepended must be drawn because the first glyph string
25081 draws over it. */
25082 i = left_overwritten (head);
25083 if (i >= 0)
25085 enum draw_glyphs_face overlap_hl;
25087 /* If this row contains mouse highlighting, attempt to draw
25088 the overlapped glyphs with the correct highlight. This
25089 code fails if the overlap encompasses more than one glyph
25090 and mouse-highlight spans only some of these glyphs.
25091 However, making it work perfectly involves a lot more
25092 code, and I don't know if the pathological case occurs in
25093 practice, so we'll stick to this for now. --- cyd */
25094 if (check_mouse_face
25095 && mouse_beg_col < start && mouse_end_col > i)
25096 overlap_hl = DRAW_MOUSE_FACE;
25097 else
25098 overlap_hl = DRAW_NORMAL_TEXT;
25100 if (hl != overlap_hl)
25101 clip_head = head;
25102 j = i;
25103 BUILD_GLYPH_STRINGS (j, start, h, t,
25104 overlap_hl, dummy_x, last_x);
25105 start = i;
25106 compute_overhangs_and_x (t, head->x, 1);
25107 prepend_glyph_string_lists (&head, &tail, h, t);
25108 if (clip_head == NULL)
25109 clip_head = head;
25112 /* Prepend glyph strings for glyphs in front of the first glyph
25113 string that overwrite that glyph string because of their
25114 right overhang. For these strings, only the foreground must
25115 be drawn, because it draws over the glyph string at `head'.
25116 The background must not be drawn because this would overwrite
25117 right overhangs of preceding glyphs for which no glyph
25118 strings exist. */
25119 i = left_overwriting (head);
25120 if (i >= 0)
25122 enum draw_glyphs_face overlap_hl;
25124 if (check_mouse_face
25125 && mouse_beg_col < start && mouse_end_col > i)
25126 overlap_hl = DRAW_MOUSE_FACE;
25127 else
25128 overlap_hl = DRAW_NORMAL_TEXT;
25130 if (hl == overlap_hl || clip_head == NULL)
25131 clip_head = head;
25132 BUILD_GLYPH_STRINGS (i, start, h, t,
25133 overlap_hl, dummy_x, last_x);
25134 for (s = h; s; s = s->next)
25135 s->background_filled_p = 1;
25136 compute_overhangs_and_x (t, head->x, 1);
25137 prepend_glyph_string_lists (&head, &tail, h, t);
25140 /* Append glyphs strings for glyphs following the last glyph
25141 string tail that are overwritten by tail. The background of
25142 these strings has to be drawn because tail's foreground draws
25143 over it. */
25144 i = right_overwritten (tail);
25145 if (i >= 0)
25147 enum draw_glyphs_face overlap_hl;
25149 if (check_mouse_face
25150 && mouse_beg_col < i && mouse_end_col > end)
25151 overlap_hl = DRAW_MOUSE_FACE;
25152 else
25153 overlap_hl = DRAW_NORMAL_TEXT;
25155 if (hl != overlap_hl)
25156 clip_tail = tail;
25157 BUILD_GLYPH_STRINGS (end, i, h, t,
25158 overlap_hl, x, last_x);
25159 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25160 we don't have `end = i;' here. */
25161 compute_overhangs_and_x (h, tail->x + tail->width, 0);
25162 append_glyph_string_lists (&head, &tail, h, t);
25163 if (clip_tail == NULL)
25164 clip_tail = tail;
25167 /* Append glyph strings for glyphs following the last glyph
25168 string tail that overwrite tail. The foreground of such
25169 glyphs has to be drawn because it writes into the background
25170 of tail. The background must not be drawn because it could
25171 paint over the foreground of following glyphs. */
25172 i = right_overwriting (tail);
25173 if (i >= 0)
25175 enum draw_glyphs_face overlap_hl;
25176 if (check_mouse_face
25177 && mouse_beg_col < i && mouse_end_col > end)
25178 overlap_hl = DRAW_MOUSE_FACE;
25179 else
25180 overlap_hl = DRAW_NORMAL_TEXT;
25182 if (hl == overlap_hl || clip_tail == NULL)
25183 clip_tail = tail;
25184 i++; /* We must include the Ith glyph. */
25185 BUILD_GLYPH_STRINGS (end, i, h, t,
25186 overlap_hl, x, last_x);
25187 for (s = h; s; s = s->next)
25188 s->background_filled_p = 1;
25189 compute_overhangs_and_x (h, tail->x + tail->width, 0);
25190 append_glyph_string_lists (&head, &tail, h, t);
25192 if (clip_head || clip_tail)
25193 for (s = head; s; s = s->next)
25195 s->clip_head = clip_head;
25196 s->clip_tail = clip_tail;
25200 /* Draw all strings. */
25201 for (s = head; s; s = s->next)
25202 FRAME_RIF (f)->draw_glyph_string (s);
25204 #ifndef HAVE_NS
25205 /* When focus a sole frame and move horizontally, this sets on_p to 0
25206 causing a failure to erase prev cursor position. */
25207 if (area == TEXT_AREA
25208 && !row->full_width_p
25209 /* When drawing overlapping rows, only the glyph strings'
25210 foreground is drawn, which doesn't erase a cursor
25211 completely. */
25212 && !overlaps)
25214 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
25215 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
25216 : (tail ? tail->x + tail->background_width : x));
25217 x0 -= area_left;
25218 x1 -= area_left;
25220 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
25221 row->y, MATRIX_ROW_BOTTOM_Y (row));
25223 #endif
25225 /* Value is the x-position up to which drawn, relative to AREA of W.
25226 This doesn't include parts drawn because of overhangs. */
25227 if (row->full_width_p)
25228 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
25229 else
25230 x_reached -= area_left;
25232 RELEASE_HDC (hdc, f);
25234 SAFE_FREE ();
25235 return x_reached;
25238 /* Expand row matrix if too narrow. Don't expand if area
25239 is not present. */
25241 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25243 if (!it->f->fonts_changed \
25244 && (it->glyph_row->glyphs[area] \
25245 < it->glyph_row->glyphs[area + 1])) \
25247 it->w->ncols_scale_factor++; \
25248 it->f->fonts_changed = 1; \
25252 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25253 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25255 static void
25256 append_glyph (struct it *it)
25258 struct glyph *glyph;
25259 enum glyph_row_area area = it->area;
25261 eassert (it->glyph_row);
25262 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
25264 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25265 if (glyph < it->glyph_row->glyphs[area + 1])
25267 /* If the glyph row is reversed, we need to prepend the glyph
25268 rather than append it. */
25269 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25271 struct glyph *g;
25273 /* Make room for the additional glyph. */
25274 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25275 g[1] = *g;
25276 glyph = it->glyph_row->glyphs[area];
25278 glyph->charpos = CHARPOS (it->position);
25279 glyph->object = it->object;
25280 if (it->pixel_width > 0)
25282 glyph->pixel_width = it->pixel_width;
25283 glyph->padding_p = 0;
25285 else
25287 /* Assure at least 1-pixel width. Otherwise, cursor can't
25288 be displayed correctly. */
25289 glyph->pixel_width = 1;
25290 glyph->padding_p = 1;
25292 glyph->ascent = it->ascent;
25293 glyph->descent = it->descent;
25294 glyph->voffset = it->voffset;
25295 glyph->type = CHAR_GLYPH;
25296 glyph->avoid_cursor_p = it->avoid_cursor_p;
25297 glyph->multibyte_p = it->multibyte_p;
25298 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25300 /* In R2L rows, the left and the right box edges need to be
25301 drawn in reverse direction. */
25302 glyph->right_box_line_p = it->start_of_box_run_p;
25303 glyph->left_box_line_p = it->end_of_box_run_p;
25305 else
25307 glyph->left_box_line_p = it->start_of_box_run_p;
25308 glyph->right_box_line_p = it->end_of_box_run_p;
25310 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25311 || it->phys_descent > it->descent);
25312 glyph->glyph_not_available_p = it->glyph_not_available_p;
25313 glyph->face_id = it->face_id;
25314 glyph->u.ch = it->char_to_display;
25315 glyph->slice.img = null_glyph_slice;
25316 glyph->font_type = FONT_TYPE_UNKNOWN;
25317 if (it->bidi_p)
25319 glyph->resolved_level = it->bidi_it.resolved_level;
25320 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25321 glyph->bidi_type = it->bidi_it.type;
25323 else
25325 glyph->resolved_level = 0;
25326 glyph->bidi_type = UNKNOWN_BT;
25328 ++it->glyph_row->used[area];
25330 else
25331 IT_EXPAND_MATRIX_WIDTH (it, area);
25334 /* Store one glyph for the composition IT->cmp_it.id in
25335 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25336 non-null. */
25338 static void
25339 append_composite_glyph (struct it *it)
25341 struct glyph *glyph;
25342 enum glyph_row_area area = it->area;
25344 eassert (it->glyph_row);
25346 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25347 if (glyph < it->glyph_row->glyphs[area + 1])
25349 /* If the glyph row is reversed, we need to prepend the glyph
25350 rather than append it. */
25351 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
25353 struct glyph *g;
25355 /* Make room for the new glyph. */
25356 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25357 g[1] = *g;
25358 glyph = it->glyph_row->glyphs[it->area];
25360 glyph->charpos = it->cmp_it.charpos;
25361 glyph->object = it->object;
25362 glyph->pixel_width = it->pixel_width;
25363 glyph->ascent = it->ascent;
25364 glyph->descent = it->descent;
25365 glyph->voffset = it->voffset;
25366 glyph->type = COMPOSITE_GLYPH;
25367 if (it->cmp_it.ch < 0)
25369 glyph->u.cmp.automatic = 0;
25370 glyph->u.cmp.id = it->cmp_it.id;
25371 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
25373 else
25375 glyph->u.cmp.automatic = 1;
25376 glyph->u.cmp.id = it->cmp_it.id;
25377 glyph->slice.cmp.from = it->cmp_it.from;
25378 glyph->slice.cmp.to = it->cmp_it.to - 1;
25380 glyph->avoid_cursor_p = it->avoid_cursor_p;
25381 glyph->multibyte_p = it->multibyte_p;
25382 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25384 /* In R2L rows, the left and the right box edges need to be
25385 drawn in reverse direction. */
25386 glyph->right_box_line_p = it->start_of_box_run_p;
25387 glyph->left_box_line_p = it->end_of_box_run_p;
25389 else
25391 glyph->left_box_line_p = it->start_of_box_run_p;
25392 glyph->right_box_line_p = it->end_of_box_run_p;
25394 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25395 || it->phys_descent > it->descent);
25396 glyph->padding_p = 0;
25397 glyph->glyph_not_available_p = 0;
25398 glyph->face_id = it->face_id;
25399 glyph->font_type = FONT_TYPE_UNKNOWN;
25400 if (it->bidi_p)
25402 glyph->resolved_level = it->bidi_it.resolved_level;
25403 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25404 glyph->bidi_type = it->bidi_it.type;
25406 ++it->glyph_row->used[area];
25408 else
25409 IT_EXPAND_MATRIX_WIDTH (it, area);
25413 /* Change IT->ascent and IT->height according to the setting of
25414 IT->voffset. */
25416 static void
25417 take_vertical_position_into_account (struct it *it)
25419 if (it->voffset)
25421 if (it->voffset < 0)
25422 /* Increase the ascent so that we can display the text higher
25423 in the line. */
25424 it->ascent -= it->voffset;
25425 else
25426 /* Increase the descent so that we can display the text lower
25427 in the line. */
25428 it->descent += it->voffset;
25433 /* Produce glyphs/get display metrics for the image IT is loaded with.
25434 See the description of struct display_iterator in dispextern.h for
25435 an overview of struct display_iterator. */
25437 static void
25438 produce_image_glyph (struct it *it)
25440 struct image *img;
25441 struct face *face;
25442 int glyph_ascent, crop;
25443 struct glyph_slice slice;
25445 eassert (it->what == IT_IMAGE);
25447 face = FACE_FROM_ID (it->f, it->face_id);
25448 eassert (face);
25449 /* Make sure X resources of the face is loaded. */
25450 prepare_face_for_display (it->f, face);
25452 if (it->image_id < 0)
25454 /* Fringe bitmap. */
25455 it->ascent = it->phys_ascent = 0;
25456 it->descent = it->phys_descent = 0;
25457 it->pixel_width = 0;
25458 it->nglyphs = 0;
25459 return;
25462 img = IMAGE_FROM_ID (it->f, it->image_id);
25463 eassert (img);
25464 /* Make sure X resources of the image is loaded. */
25465 prepare_image_for_display (it->f, img);
25467 slice.x = slice.y = 0;
25468 slice.width = img->width;
25469 slice.height = img->height;
25471 if (INTEGERP (it->slice.x))
25472 slice.x = XINT (it->slice.x);
25473 else if (FLOATP (it->slice.x))
25474 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
25476 if (INTEGERP (it->slice.y))
25477 slice.y = XINT (it->slice.y);
25478 else if (FLOATP (it->slice.y))
25479 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
25481 if (INTEGERP (it->slice.width))
25482 slice.width = XINT (it->slice.width);
25483 else if (FLOATP (it->slice.width))
25484 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
25486 if (INTEGERP (it->slice.height))
25487 slice.height = XINT (it->slice.height);
25488 else if (FLOATP (it->slice.height))
25489 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
25491 if (slice.x >= img->width)
25492 slice.x = img->width;
25493 if (slice.y >= img->height)
25494 slice.y = img->height;
25495 if (slice.x + slice.width >= img->width)
25496 slice.width = img->width - slice.x;
25497 if (slice.y + slice.height > img->height)
25498 slice.height = img->height - slice.y;
25500 if (slice.width == 0 || slice.height == 0)
25501 return;
25503 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
25505 it->descent = slice.height - glyph_ascent;
25506 if (slice.y == 0)
25507 it->descent += img->vmargin;
25508 if (slice.y + slice.height == img->height)
25509 it->descent += img->vmargin;
25510 it->phys_descent = it->descent;
25512 it->pixel_width = slice.width;
25513 if (slice.x == 0)
25514 it->pixel_width += img->hmargin;
25515 if (slice.x + slice.width == img->width)
25516 it->pixel_width += img->hmargin;
25518 /* It's quite possible for images to have an ascent greater than
25519 their height, so don't get confused in that case. */
25520 if (it->descent < 0)
25521 it->descent = 0;
25523 it->nglyphs = 1;
25525 if (face->box != FACE_NO_BOX)
25527 if (face->box_line_width > 0)
25529 if (slice.y == 0)
25530 it->ascent += face->box_line_width;
25531 if (slice.y + slice.height == img->height)
25532 it->descent += face->box_line_width;
25535 if (it->start_of_box_run_p && slice.x == 0)
25536 it->pixel_width += eabs (face->box_line_width);
25537 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
25538 it->pixel_width += eabs (face->box_line_width);
25541 take_vertical_position_into_account (it);
25543 /* Automatically crop wide image glyphs at right edge so we can
25544 draw the cursor on same display row. */
25545 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
25546 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
25548 it->pixel_width -= crop;
25549 slice.width -= crop;
25552 if (it->glyph_row)
25554 struct glyph *glyph;
25555 enum glyph_row_area area = it->area;
25557 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25558 if (glyph < it->glyph_row->glyphs[area + 1])
25560 glyph->charpos = CHARPOS (it->position);
25561 glyph->object = it->object;
25562 glyph->pixel_width = it->pixel_width;
25563 glyph->ascent = glyph_ascent;
25564 glyph->descent = it->descent;
25565 glyph->voffset = it->voffset;
25566 glyph->type = IMAGE_GLYPH;
25567 glyph->avoid_cursor_p = it->avoid_cursor_p;
25568 glyph->multibyte_p = it->multibyte_p;
25569 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25571 /* In R2L rows, the left and the right box edges need to be
25572 drawn in reverse direction. */
25573 glyph->right_box_line_p = it->start_of_box_run_p;
25574 glyph->left_box_line_p = it->end_of_box_run_p;
25576 else
25578 glyph->left_box_line_p = it->start_of_box_run_p;
25579 glyph->right_box_line_p = it->end_of_box_run_p;
25581 glyph->overlaps_vertically_p = 0;
25582 glyph->padding_p = 0;
25583 glyph->glyph_not_available_p = 0;
25584 glyph->face_id = it->face_id;
25585 glyph->u.img_id = img->id;
25586 glyph->slice.img = slice;
25587 glyph->font_type = FONT_TYPE_UNKNOWN;
25588 if (it->bidi_p)
25590 glyph->resolved_level = it->bidi_it.resolved_level;
25591 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25592 glyph->bidi_type = it->bidi_it.type;
25594 ++it->glyph_row->used[area];
25596 else
25597 IT_EXPAND_MATRIX_WIDTH (it, area);
25602 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25603 of the glyph, WIDTH and HEIGHT are the width and height of the
25604 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25606 static void
25607 append_stretch_glyph (struct it *it, Lisp_Object object,
25608 int width, int height, int ascent)
25610 struct glyph *glyph;
25611 enum glyph_row_area area = it->area;
25613 eassert (ascent >= 0 && ascent <= height);
25615 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25616 if (glyph < it->glyph_row->glyphs[area + 1])
25618 /* If the glyph row is reversed, we need to prepend the glyph
25619 rather than append it. */
25620 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25622 struct glyph *g;
25624 /* Make room for the additional glyph. */
25625 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25626 g[1] = *g;
25627 glyph = it->glyph_row->glyphs[area];
25629 /* Decrease the width of the first glyph of the row that
25630 begins before first_visible_x (e.g., due to hscroll).
25631 This is so the overall width of the row becomes smaller
25632 by the scroll amount, and the stretch glyph appended by
25633 extend_face_to_end_of_line will be wider, to shift the
25634 row glyphs to the right. (In L2R rows, the corresponding
25635 left-shift effect is accomplished by setting row->x to a
25636 negative value, which won't work with R2L rows.)
25638 This must leave us with a positive value of WIDTH, since
25639 otherwise the call to move_it_in_display_line_to at the
25640 beginning of display_line would have got past the entire
25641 first glyph, and then it->current_x would have been
25642 greater or equal to it->first_visible_x. */
25643 if (it->current_x < it->first_visible_x)
25644 width -= it->first_visible_x - it->current_x;
25645 eassert (width > 0);
25647 glyph->charpos = CHARPOS (it->position);
25648 glyph->object = object;
25649 glyph->pixel_width = width;
25650 glyph->ascent = ascent;
25651 glyph->descent = height - ascent;
25652 glyph->voffset = it->voffset;
25653 glyph->type = STRETCH_GLYPH;
25654 glyph->avoid_cursor_p = it->avoid_cursor_p;
25655 glyph->multibyte_p = it->multibyte_p;
25656 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25658 /* In R2L rows, the left and the right box edges need to be
25659 drawn in reverse direction. */
25660 glyph->right_box_line_p = it->start_of_box_run_p;
25661 glyph->left_box_line_p = it->end_of_box_run_p;
25663 else
25665 glyph->left_box_line_p = it->start_of_box_run_p;
25666 glyph->right_box_line_p = it->end_of_box_run_p;
25668 glyph->overlaps_vertically_p = 0;
25669 glyph->padding_p = 0;
25670 glyph->glyph_not_available_p = 0;
25671 glyph->face_id = it->face_id;
25672 glyph->u.stretch.ascent = ascent;
25673 glyph->u.stretch.height = height;
25674 glyph->slice.img = null_glyph_slice;
25675 glyph->font_type = FONT_TYPE_UNKNOWN;
25676 if (it->bidi_p)
25678 glyph->resolved_level = it->bidi_it.resolved_level;
25679 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
25680 glyph->bidi_type = it->bidi_it.type;
25682 else
25684 glyph->resolved_level = 0;
25685 glyph->bidi_type = UNKNOWN_BT;
25687 ++it->glyph_row->used[area];
25689 else
25690 IT_EXPAND_MATRIX_WIDTH (it, area);
25693 #endif /* HAVE_WINDOW_SYSTEM */
25695 /* Produce a stretch glyph for iterator IT. IT->object is the value
25696 of the glyph property displayed. The value must be a list
25697 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25698 being recognized:
25700 1. `:width WIDTH' specifies that the space should be WIDTH *
25701 canonical char width wide. WIDTH may be an integer or floating
25702 point number.
25704 2. `:relative-width FACTOR' specifies that the width of the stretch
25705 should be computed from the width of the first character having the
25706 `glyph' property, and should be FACTOR times that width.
25708 3. `:align-to HPOS' specifies that the space should be wide enough
25709 to reach HPOS, a value in canonical character units.
25711 Exactly one of the above pairs must be present.
25713 4. `:height HEIGHT' specifies that the height of the stretch produced
25714 should be HEIGHT, measured in canonical character units.
25716 5. `:relative-height FACTOR' specifies that the height of the
25717 stretch should be FACTOR times the height of the characters having
25718 the glyph property.
25720 Either none or exactly one of 4 or 5 must be present.
25722 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25723 of the stretch should be used for the ascent of the stretch.
25724 ASCENT must be in the range 0 <= ASCENT <= 100. */
25726 void
25727 produce_stretch_glyph (struct it *it)
25729 /* (space :width WIDTH :height HEIGHT ...) */
25730 Lisp_Object prop, plist;
25731 int width = 0, height = 0, align_to = -1;
25732 int zero_width_ok_p = 0;
25733 double tem;
25734 struct font *font = NULL;
25736 #ifdef HAVE_WINDOW_SYSTEM
25737 int ascent = 0;
25738 int zero_height_ok_p = 0;
25740 if (FRAME_WINDOW_P (it->f))
25742 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25743 font = face->font ? face->font : FRAME_FONT (it->f);
25744 prepare_face_for_display (it->f, face);
25746 #endif
25748 /* List should start with `space'. */
25749 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
25750 plist = XCDR (it->object);
25752 /* Compute the width of the stretch. */
25753 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
25754 && calc_pixel_width_or_height (&tem, it, prop, font, 1, 0))
25756 /* Absolute width `:width WIDTH' specified and valid. */
25757 zero_width_ok_p = 1;
25758 width = (int)tem;
25760 #ifdef HAVE_WINDOW_SYSTEM
25761 else if (FRAME_WINDOW_P (it->f)
25762 && (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0))
25764 /* Relative width `:relative-width FACTOR' specified and valid.
25765 Compute the width of the characters having the `glyph'
25766 property. */
25767 struct it it2;
25768 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
25770 it2 = *it;
25771 if (it->multibyte_p)
25772 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
25773 else
25775 it2.c = it2.char_to_display = *p, it2.len = 1;
25776 if (! ASCII_CHAR_P (it2.c))
25777 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
25780 it2.glyph_row = NULL;
25781 it2.what = IT_CHARACTER;
25782 x_produce_glyphs (&it2);
25783 width = NUMVAL (prop) * it2.pixel_width;
25785 #endif /* HAVE_WINDOW_SYSTEM */
25786 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
25787 && calc_pixel_width_or_height (&tem, it, prop, font, 1, &align_to))
25789 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
25790 align_to = (align_to < 0
25792 : align_to - window_box_left_offset (it->w, TEXT_AREA));
25793 else if (align_to < 0)
25794 align_to = window_box_left_offset (it->w, TEXT_AREA);
25795 width = max (0, (int)tem + align_to - it->current_x);
25796 zero_width_ok_p = 1;
25798 else
25799 /* Nothing specified -> width defaults to canonical char width. */
25800 width = FRAME_COLUMN_WIDTH (it->f);
25802 if (width <= 0 && (width < 0 || !zero_width_ok_p))
25803 width = 1;
25805 #ifdef HAVE_WINDOW_SYSTEM
25806 /* Compute height. */
25807 if (FRAME_WINDOW_P (it->f))
25809 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
25810 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25812 height = (int)tem;
25813 zero_height_ok_p = 1;
25815 else if (prop = Fplist_get (plist, QCrelative_height),
25816 NUMVAL (prop) > 0)
25817 height = FONT_HEIGHT (font) * NUMVAL (prop);
25818 else
25819 height = FONT_HEIGHT (font);
25821 if (height <= 0 && (height < 0 || !zero_height_ok_p))
25822 height = 1;
25824 /* Compute percentage of height used for ascent. If
25825 `:ascent ASCENT' is present and valid, use that. Otherwise,
25826 derive the ascent from the font in use. */
25827 if (prop = Fplist_get (plist, QCascent),
25828 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
25829 ascent = height * NUMVAL (prop) / 100.0;
25830 else if (!NILP (prop)
25831 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25832 ascent = min (max (0, (int)tem), height);
25833 else
25834 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
25836 else
25837 #endif /* HAVE_WINDOW_SYSTEM */
25838 height = 1;
25840 if (width > 0 && it->line_wrap != TRUNCATE
25841 && it->current_x + width > it->last_visible_x)
25843 width = it->last_visible_x - it->current_x;
25844 #ifdef HAVE_WINDOW_SYSTEM
25845 /* Subtract one more pixel from the stretch width, but only on
25846 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25847 width -= FRAME_WINDOW_P (it->f);
25848 #endif
25851 if (width > 0 && height > 0 && it->glyph_row)
25853 Lisp_Object o_object = it->object;
25854 Lisp_Object object = it->stack[it->sp - 1].string;
25855 int n = width;
25857 if (!STRINGP (object))
25858 object = it->w->contents;
25859 #ifdef HAVE_WINDOW_SYSTEM
25860 if (FRAME_WINDOW_P (it->f))
25861 append_stretch_glyph (it, object, width, height, ascent);
25862 else
25863 #endif
25865 it->object = object;
25866 it->char_to_display = ' ';
25867 it->pixel_width = it->len = 1;
25868 while (n--)
25869 tty_append_glyph (it);
25870 it->object = o_object;
25874 it->pixel_width = width;
25875 #ifdef HAVE_WINDOW_SYSTEM
25876 if (FRAME_WINDOW_P (it->f))
25878 it->ascent = it->phys_ascent = ascent;
25879 it->descent = it->phys_descent = height - it->ascent;
25880 it->nglyphs = width > 0 && height > 0 ? 1 : 0;
25881 take_vertical_position_into_account (it);
25883 else
25884 #endif
25885 it->nglyphs = width;
25888 /* Get information about special display element WHAT in an
25889 environment described by IT. WHAT is one of IT_TRUNCATION or
25890 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25891 non-null glyph_row member. This function ensures that fields like
25892 face_id, c, len of IT are left untouched. */
25894 static void
25895 produce_special_glyphs (struct it *it, enum display_element_type what)
25897 struct it temp_it;
25898 Lisp_Object gc;
25899 GLYPH glyph;
25901 temp_it = *it;
25902 temp_it.object = make_number (0);
25903 memset (&temp_it.current, 0, sizeof temp_it.current);
25905 if (what == IT_CONTINUATION)
25907 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25908 if (it->bidi_it.paragraph_dir == R2L)
25909 SET_GLYPH_FROM_CHAR (glyph, '/');
25910 else
25911 SET_GLYPH_FROM_CHAR (glyph, '\\');
25912 if (it->dp
25913 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25915 /* FIXME: Should we mirror GC for R2L lines? */
25916 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25917 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25920 else if (what == IT_TRUNCATION)
25922 /* Truncation glyph. */
25923 SET_GLYPH_FROM_CHAR (glyph, '$');
25924 if (it->dp
25925 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25927 /* FIXME: Should we mirror GC for R2L lines? */
25928 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25929 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25932 else
25933 emacs_abort ();
25935 #ifdef HAVE_WINDOW_SYSTEM
25936 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25937 is turned off, we precede the truncation/continuation glyphs by a
25938 stretch glyph whose width is computed such that these special
25939 glyphs are aligned at the window margin, even when very different
25940 fonts are used in different glyph rows. */
25941 if (FRAME_WINDOW_P (temp_it.f)
25942 /* init_iterator calls this with it->glyph_row == NULL, and it
25943 wants only the pixel width of the truncation/continuation
25944 glyphs. */
25945 && temp_it.glyph_row
25946 /* insert_left_trunc_glyphs calls us at the beginning of the
25947 row, and it has its own calculation of the stretch glyph
25948 width. */
25949 && temp_it.glyph_row->used[TEXT_AREA] > 0
25950 && (temp_it.glyph_row->reversed_p
25951 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
25952 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
25954 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
25956 if (stretch_width > 0)
25958 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
25959 struct font *font =
25960 face->font ? face->font : FRAME_FONT (temp_it.f);
25961 int stretch_ascent =
25962 (((temp_it.ascent + temp_it.descent)
25963 * FONT_BASE (font)) / FONT_HEIGHT (font));
25965 append_stretch_glyph (&temp_it, make_number (0), stretch_width,
25966 temp_it.ascent + temp_it.descent,
25967 stretch_ascent);
25970 #endif
25972 temp_it.dp = NULL;
25973 temp_it.what = IT_CHARACTER;
25974 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
25975 temp_it.face_id = GLYPH_FACE (glyph);
25976 temp_it.len = CHAR_BYTES (temp_it.c);
25978 PRODUCE_GLYPHS (&temp_it);
25979 it->pixel_width = temp_it.pixel_width;
25980 it->nglyphs = temp_it.nglyphs;
25983 #ifdef HAVE_WINDOW_SYSTEM
25985 /* Calculate line-height and line-spacing properties.
25986 An integer value specifies explicit pixel value.
25987 A float value specifies relative value to current face height.
25988 A cons (float . face-name) specifies relative value to
25989 height of specified face font.
25991 Returns height in pixels, or nil. */
25994 static Lisp_Object
25995 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
25996 int boff, int override)
25998 Lisp_Object face_name = Qnil;
25999 int ascent, descent, height;
26001 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
26002 return val;
26004 if (CONSP (val))
26006 face_name = XCAR (val);
26007 val = XCDR (val);
26008 if (!NUMBERP (val))
26009 val = make_number (1);
26010 if (NILP (face_name))
26012 height = it->ascent + it->descent;
26013 goto scale;
26017 if (NILP (face_name))
26019 font = FRAME_FONT (it->f);
26020 boff = FRAME_BASELINE_OFFSET (it->f);
26022 else if (EQ (face_name, Qt))
26024 override = 0;
26026 else
26028 int face_id;
26029 struct face *face;
26031 face_id = lookup_named_face (it->f, face_name, 0);
26032 if (face_id < 0)
26033 return make_number (-1);
26035 face = FACE_FROM_ID (it->f, face_id);
26036 font = face->font;
26037 if (font == NULL)
26038 return make_number (-1);
26039 boff = font->baseline_offset;
26040 if (font->vertical_centering)
26041 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26044 ascent = FONT_BASE (font) + boff;
26045 descent = FONT_DESCENT (font) - boff;
26047 if (override)
26049 it->override_ascent = ascent;
26050 it->override_descent = descent;
26051 it->override_boff = boff;
26054 height = ascent + descent;
26056 scale:
26057 if (FLOATP (val))
26058 height = (int)(XFLOAT_DATA (val) * height);
26059 else if (INTEGERP (val))
26060 height *= XINT (val);
26062 return make_number (height);
26066 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26067 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
26068 and only if this is for a character for which no font was found.
26070 If the display method (it->glyphless_method) is
26071 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26072 length of the acronym or the hexadecimal string, UPPER_XOFF and
26073 UPPER_YOFF are pixel offsets for the upper part of the string,
26074 LOWER_XOFF and LOWER_YOFF are for the lower part.
26076 For the other display methods, LEN through LOWER_YOFF are zero. */
26078 static void
26079 append_glyphless_glyph (struct it *it, int face_id, int for_no_font, int len,
26080 short upper_xoff, short upper_yoff,
26081 short lower_xoff, short lower_yoff)
26083 struct glyph *glyph;
26084 enum glyph_row_area area = it->area;
26086 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
26087 if (glyph < it->glyph_row->glyphs[area + 1])
26089 /* If the glyph row is reversed, we need to prepend the glyph
26090 rather than append it. */
26091 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26093 struct glyph *g;
26095 /* Make room for the additional glyph. */
26096 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
26097 g[1] = *g;
26098 glyph = it->glyph_row->glyphs[area];
26100 glyph->charpos = CHARPOS (it->position);
26101 glyph->object = it->object;
26102 glyph->pixel_width = it->pixel_width;
26103 glyph->ascent = it->ascent;
26104 glyph->descent = it->descent;
26105 glyph->voffset = it->voffset;
26106 glyph->type = GLYPHLESS_GLYPH;
26107 glyph->u.glyphless.method = it->glyphless_method;
26108 glyph->u.glyphless.for_no_font = for_no_font;
26109 glyph->u.glyphless.len = len;
26110 glyph->u.glyphless.ch = it->c;
26111 glyph->slice.glyphless.upper_xoff = upper_xoff;
26112 glyph->slice.glyphless.upper_yoff = upper_yoff;
26113 glyph->slice.glyphless.lower_xoff = lower_xoff;
26114 glyph->slice.glyphless.lower_yoff = lower_yoff;
26115 glyph->avoid_cursor_p = it->avoid_cursor_p;
26116 glyph->multibyte_p = it->multibyte_p;
26117 if (it->glyph_row->reversed_p && area == TEXT_AREA)
26119 /* In R2L rows, the left and the right box edges need to be
26120 drawn in reverse direction. */
26121 glyph->right_box_line_p = it->start_of_box_run_p;
26122 glyph->left_box_line_p = it->end_of_box_run_p;
26124 else
26126 glyph->left_box_line_p = it->start_of_box_run_p;
26127 glyph->right_box_line_p = it->end_of_box_run_p;
26129 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
26130 || it->phys_descent > it->descent);
26131 glyph->padding_p = 0;
26132 glyph->glyph_not_available_p = 0;
26133 glyph->face_id = face_id;
26134 glyph->font_type = FONT_TYPE_UNKNOWN;
26135 if (it->bidi_p)
26137 glyph->resolved_level = it->bidi_it.resolved_level;
26138 eassert ((it->bidi_it.type & 7) == it->bidi_it.type);
26139 glyph->bidi_type = it->bidi_it.type;
26141 ++it->glyph_row->used[area];
26143 else
26144 IT_EXPAND_MATRIX_WIDTH (it, area);
26148 /* Produce a glyph for a glyphless character for iterator IT.
26149 IT->glyphless_method specifies which method to use for displaying
26150 the character. See the description of enum
26151 glyphless_display_method in dispextern.h for the detail.
26153 FOR_NO_FONT is nonzero if and only if this is for a character for
26154 which no font was found. ACRONYM, if non-nil, is an acronym string
26155 for the character. */
26157 static void
26158 produce_glyphless_glyph (struct it *it, int for_no_font, Lisp_Object acronym)
26160 int face_id;
26161 struct face *face;
26162 struct font *font;
26163 int base_width, base_height, width, height;
26164 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
26165 int len;
26167 /* Get the metrics of the base font. We always refer to the current
26168 ASCII face. */
26169 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
26170 font = face->font ? face->font : FRAME_FONT (it->f);
26171 it->ascent = FONT_BASE (font) + font->baseline_offset;
26172 it->descent = FONT_DESCENT (font) - font->baseline_offset;
26173 base_height = it->ascent + it->descent;
26174 base_width = font->average_width;
26176 face_id = merge_glyphless_glyph_face (it);
26178 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
26180 it->pixel_width = THIN_SPACE_WIDTH;
26181 len = 0;
26182 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26184 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
26186 width = CHAR_WIDTH (it->c);
26187 if (width == 0)
26188 width = 1;
26189 else if (width > 4)
26190 width = 4;
26191 it->pixel_width = base_width * width;
26192 len = 0;
26193 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26195 else
26197 char buf[7];
26198 const char *str;
26199 unsigned int code[6];
26200 int upper_len;
26201 int ascent, descent;
26202 struct font_metrics metrics_upper, metrics_lower;
26204 face = FACE_FROM_ID (it->f, face_id);
26205 font = face->font ? face->font : FRAME_FONT (it->f);
26206 prepare_face_for_display (it->f, face);
26208 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
26210 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
26211 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
26212 if (CONSP (acronym))
26213 acronym = XCAR (acronym);
26214 str = STRINGP (acronym) ? SSDATA (acronym) : "";
26216 else
26218 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
26219 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c);
26220 str = buf;
26222 for (len = 0; str[len] && ASCII_CHAR_P (str[len]) && len < 6; len++)
26223 code[len] = font->driver->encode_char (font, str[len]);
26224 upper_len = (len + 1) / 2;
26225 font->driver->text_extents (font, code, upper_len,
26226 &metrics_upper);
26227 font->driver->text_extents (font, code + upper_len, len - upper_len,
26228 &metrics_lower);
26232 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26233 width = max (metrics_upper.width, metrics_lower.width) + 4;
26234 upper_xoff = upper_yoff = 2; /* the typical case */
26235 if (base_width >= width)
26237 /* Align the upper to the left, the lower to the right. */
26238 it->pixel_width = base_width;
26239 lower_xoff = base_width - 2 - metrics_lower.width;
26241 else
26243 /* Center the shorter one. */
26244 it->pixel_width = width;
26245 if (metrics_upper.width >= metrics_lower.width)
26246 lower_xoff = (width - metrics_lower.width) / 2;
26247 else
26249 /* FIXME: This code doesn't look right. It formerly was
26250 missing the "lower_xoff = 0;", which couldn't have
26251 been right since it left lower_xoff uninitialized. */
26252 lower_xoff = 0;
26253 upper_xoff = (width - metrics_upper.width) / 2;
26257 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26258 top, bottom, and between upper and lower strings. */
26259 height = (metrics_upper.ascent + metrics_upper.descent
26260 + metrics_lower.ascent + metrics_lower.descent) + 5;
26261 /* Center vertically.
26262 H:base_height, D:base_descent
26263 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26265 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26266 descent = D - H/2 + h/2;
26267 lower_yoff = descent - 2 - ld;
26268 upper_yoff = lower_yoff - la - 1 - ud; */
26269 ascent = - (it->descent - (base_height + height + 1) / 2);
26270 descent = it->descent - (base_height - height) / 2;
26271 lower_yoff = descent - 2 - metrics_lower.descent;
26272 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
26273 - metrics_upper.descent);
26274 /* Don't make the height shorter than the base height. */
26275 if (height > base_height)
26277 it->ascent = ascent;
26278 it->descent = descent;
26282 it->phys_ascent = it->ascent;
26283 it->phys_descent = it->descent;
26284 if (it->glyph_row)
26285 append_glyphless_glyph (it, face_id, for_no_font, len,
26286 upper_xoff, upper_yoff,
26287 lower_xoff, lower_yoff);
26288 it->nglyphs = 1;
26289 take_vertical_position_into_account (it);
26293 /* RIF:
26294 Produce glyphs/get display metrics for the display element IT is
26295 loaded with. See the description of struct it in dispextern.h
26296 for an overview of struct it. */
26298 void
26299 x_produce_glyphs (struct it *it)
26301 int extra_line_spacing = it->extra_line_spacing;
26303 it->glyph_not_available_p = 0;
26305 if (it->what == IT_CHARACTER)
26307 XChar2b char2b;
26308 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26309 struct font *font = face->font;
26310 struct font_metrics *pcm = NULL;
26311 int boff; /* Baseline offset. */
26313 if (font == NULL)
26315 /* When no suitable font is found, display this character by
26316 the method specified in the first extra slot of
26317 Vglyphless_char_display. */
26318 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
26320 eassert (it->what == IT_GLYPHLESS);
26321 produce_glyphless_glyph (it, 1, STRINGP (acronym) ? acronym : Qnil);
26322 goto done;
26325 boff = font->baseline_offset;
26326 if (font->vertical_centering)
26327 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26329 if (it->char_to_display != '\n' && it->char_to_display != '\t')
26331 int stretched_p;
26333 it->nglyphs = 1;
26335 if (it->override_ascent >= 0)
26337 it->ascent = it->override_ascent;
26338 it->descent = it->override_descent;
26339 boff = it->override_boff;
26341 else
26343 it->ascent = FONT_BASE (font) + boff;
26344 it->descent = FONT_DESCENT (font) - boff;
26347 if (get_char_glyph_code (it->char_to_display, font, &char2b))
26349 pcm = get_per_char_metric (font, &char2b);
26350 if (pcm->width == 0
26351 && pcm->rbearing == 0 && pcm->lbearing == 0)
26352 pcm = NULL;
26355 if (pcm)
26357 it->phys_ascent = pcm->ascent + boff;
26358 it->phys_descent = pcm->descent - boff;
26359 it->pixel_width = pcm->width;
26361 else
26363 it->glyph_not_available_p = 1;
26364 it->phys_ascent = it->ascent;
26365 it->phys_descent = it->descent;
26366 it->pixel_width = font->space_width;
26369 if (it->constrain_row_ascent_descent_p)
26371 if (it->descent > it->max_descent)
26373 it->ascent += it->descent - it->max_descent;
26374 it->descent = it->max_descent;
26376 if (it->ascent > it->max_ascent)
26378 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26379 it->ascent = it->max_ascent;
26381 it->phys_ascent = min (it->phys_ascent, it->ascent);
26382 it->phys_descent = min (it->phys_descent, it->descent);
26383 extra_line_spacing = 0;
26386 /* If this is a space inside a region of text with
26387 `space-width' property, change its width. */
26388 stretched_p = it->char_to_display == ' ' && !NILP (it->space_width);
26389 if (stretched_p)
26390 it->pixel_width *= XFLOATINT (it->space_width);
26392 /* If face has a box, add the box thickness to the character
26393 height. If character has a box line to the left and/or
26394 right, add the box line width to the character's width. */
26395 if (face->box != FACE_NO_BOX)
26397 int thick = face->box_line_width;
26399 if (thick > 0)
26401 it->ascent += thick;
26402 it->descent += thick;
26404 else
26405 thick = -thick;
26407 if (it->start_of_box_run_p)
26408 it->pixel_width += thick;
26409 if (it->end_of_box_run_p)
26410 it->pixel_width += thick;
26413 /* If face has an overline, add the height of the overline
26414 (1 pixel) and a 1 pixel margin to the character height. */
26415 if (face->overline_p)
26416 it->ascent += overline_margin;
26418 if (it->constrain_row_ascent_descent_p)
26420 if (it->ascent > it->max_ascent)
26421 it->ascent = it->max_ascent;
26422 if (it->descent > it->max_descent)
26423 it->descent = it->max_descent;
26426 take_vertical_position_into_account (it);
26428 /* If we have to actually produce glyphs, do it. */
26429 if (it->glyph_row)
26431 if (stretched_p)
26433 /* Translate a space with a `space-width' property
26434 into a stretch glyph. */
26435 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
26436 / FONT_HEIGHT (font));
26437 append_stretch_glyph (it, it->object, it->pixel_width,
26438 it->ascent + it->descent, ascent);
26440 else
26441 append_glyph (it);
26443 /* If characters with lbearing or rbearing are displayed
26444 in this line, record that fact in a flag of the
26445 glyph row. This is used to optimize X output code. */
26446 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
26447 it->glyph_row->contains_overlapping_glyphs_p = 1;
26449 if (! stretched_p && it->pixel_width == 0)
26450 /* We assure that all visible glyphs have at least 1-pixel
26451 width. */
26452 it->pixel_width = 1;
26454 else if (it->char_to_display == '\n')
26456 /* A newline has no width, but we need the height of the
26457 line. But if previous part of the line sets a height,
26458 don't increase that height. */
26460 Lisp_Object height;
26461 Lisp_Object total_height = Qnil;
26463 it->override_ascent = -1;
26464 it->pixel_width = 0;
26465 it->nglyphs = 0;
26467 height = get_it_property (it, Qline_height);
26468 /* Split (line-height total-height) list. */
26469 if (CONSP (height)
26470 && CONSP (XCDR (height))
26471 && NILP (XCDR (XCDR (height))))
26473 total_height = XCAR (XCDR (height));
26474 height = XCAR (height);
26476 height = calc_line_height_property (it, height, font, boff, 1);
26478 if (it->override_ascent >= 0)
26480 it->ascent = it->override_ascent;
26481 it->descent = it->override_descent;
26482 boff = it->override_boff;
26484 else
26486 it->ascent = FONT_BASE (font) + boff;
26487 it->descent = FONT_DESCENT (font) - boff;
26490 if (EQ (height, Qt))
26492 if (it->descent > it->max_descent)
26494 it->ascent += it->descent - it->max_descent;
26495 it->descent = it->max_descent;
26497 if (it->ascent > it->max_ascent)
26499 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26500 it->ascent = it->max_ascent;
26502 it->phys_ascent = min (it->phys_ascent, it->ascent);
26503 it->phys_descent = min (it->phys_descent, it->descent);
26504 it->constrain_row_ascent_descent_p = 1;
26505 extra_line_spacing = 0;
26507 else
26509 Lisp_Object spacing;
26511 it->phys_ascent = it->ascent;
26512 it->phys_descent = it->descent;
26514 if ((it->max_ascent > 0 || it->max_descent > 0)
26515 && face->box != FACE_NO_BOX
26516 && face->box_line_width > 0)
26518 it->ascent += face->box_line_width;
26519 it->descent += face->box_line_width;
26521 if (!NILP (height)
26522 && XINT (height) > it->ascent + it->descent)
26523 it->ascent = XINT (height) - it->descent;
26525 if (!NILP (total_height))
26526 spacing = calc_line_height_property (it, total_height, font, boff, 0);
26527 else
26529 spacing = get_it_property (it, Qline_spacing);
26530 spacing = calc_line_height_property (it, spacing, font, boff, 0);
26532 if (INTEGERP (spacing))
26534 extra_line_spacing = XINT (spacing);
26535 if (!NILP (total_height))
26536 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
26540 else /* i.e. (it->char_to_display == '\t') */
26542 if (font->space_width > 0)
26544 int tab_width = it->tab_width * font->space_width;
26545 int x = it->current_x + it->continuation_lines_width;
26546 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
26548 /* If the distance from the current position to the next tab
26549 stop is less than a space character width, use the
26550 tab stop after that. */
26551 if (next_tab_x - x < font->space_width)
26552 next_tab_x += tab_width;
26554 it->pixel_width = next_tab_x - x;
26555 it->nglyphs = 1;
26556 it->ascent = it->phys_ascent = FONT_BASE (font) + boff;
26557 it->descent = it->phys_descent = FONT_DESCENT (font) - boff;
26559 if (it->glyph_row)
26561 append_stretch_glyph (it, it->object, it->pixel_width,
26562 it->ascent + it->descent, it->ascent);
26565 else
26567 it->pixel_width = 0;
26568 it->nglyphs = 1;
26572 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
26574 /* A static composition.
26576 Note: A composition is represented as one glyph in the
26577 glyph matrix. There are no padding glyphs.
26579 Important note: pixel_width, ascent, and descent are the
26580 values of what is drawn by draw_glyphs (i.e. the values of
26581 the overall glyphs composed). */
26582 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26583 int boff; /* baseline offset */
26584 struct composition *cmp = composition_table[it->cmp_it.id];
26585 int glyph_len = cmp->glyph_len;
26586 struct font *font = face->font;
26588 it->nglyphs = 1;
26590 /* If we have not yet calculated pixel size data of glyphs of
26591 the composition for the current face font, calculate them
26592 now. Theoretically, we have to check all fonts for the
26593 glyphs, but that requires much time and memory space. So,
26594 here we check only the font of the first glyph. This may
26595 lead to incorrect display, but it's very rare, and C-l
26596 (recenter-top-bottom) can correct the display anyway. */
26597 if (! cmp->font || cmp->font != font)
26599 /* Ascent and descent of the font of the first character
26600 of this composition (adjusted by baseline offset).
26601 Ascent and descent of overall glyphs should not be less
26602 than these, respectively. */
26603 int font_ascent, font_descent, font_height;
26604 /* Bounding box of the overall glyphs. */
26605 int leftmost, rightmost, lowest, highest;
26606 int lbearing, rbearing;
26607 int i, width, ascent, descent;
26608 int left_padded = 0, right_padded = 0;
26609 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26610 XChar2b char2b;
26611 struct font_metrics *pcm;
26612 int font_not_found_p;
26613 ptrdiff_t pos;
26615 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
26616 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
26617 break;
26618 if (glyph_len < cmp->glyph_len)
26619 right_padded = 1;
26620 for (i = 0; i < glyph_len; i++)
26622 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
26623 break;
26624 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26626 if (i > 0)
26627 left_padded = 1;
26629 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
26630 : IT_CHARPOS (*it));
26631 /* If no suitable font is found, use the default font. */
26632 font_not_found_p = font == NULL;
26633 if (font_not_found_p)
26635 face = face->ascii_face;
26636 font = face->font;
26638 boff = font->baseline_offset;
26639 if (font->vertical_centering)
26640 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26641 font_ascent = FONT_BASE (font) + boff;
26642 font_descent = FONT_DESCENT (font) - boff;
26643 font_height = FONT_HEIGHT (font);
26645 cmp->font = font;
26647 pcm = NULL;
26648 if (! font_not_found_p)
26650 get_char_face_and_encoding (it->f, c, it->face_id,
26651 &char2b, 0);
26652 pcm = get_per_char_metric (font, &char2b);
26655 /* Initialize the bounding box. */
26656 if (pcm)
26658 width = cmp->glyph_len > 0 ? pcm->width : 0;
26659 ascent = pcm->ascent;
26660 descent = pcm->descent;
26661 lbearing = pcm->lbearing;
26662 rbearing = pcm->rbearing;
26664 else
26666 width = cmp->glyph_len > 0 ? font->space_width : 0;
26667 ascent = FONT_BASE (font);
26668 descent = FONT_DESCENT (font);
26669 lbearing = 0;
26670 rbearing = width;
26673 rightmost = width;
26674 leftmost = 0;
26675 lowest = - descent + boff;
26676 highest = ascent + boff;
26678 if (! font_not_found_p
26679 && font->default_ascent
26680 && CHAR_TABLE_P (Vuse_default_ascent)
26681 && !NILP (Faref (Vuse_default_ascent,
26682 make_number (it->char_to_display))))
26683 highest = font->default_ascent + boff;
26685 /* Draw the first glyph at the normal position. It may be
26686 shifted to right later if some other glyphs are drawn
26687 at the left. */
26688 cmp->offsets[i * 2] = 0;
26689 cmp->offsets[i * 2 + 1] = boff;
26690 cmp->lbearing = lbearing;
26691 cmp->rbearing = rbearing;
26693 /* Set cmp->offsets for the remaining glyphs. */
26694 for (i++; i < glyph_len; i++)
26696 int left, right, btm, top;
26697 int ch = COMPOSITION_GLYPH (cmp, i);
26698 int face_id;
26699 struct face *this_face;
26701 if (ch == '\t')
26702 ch = ' ';
26703 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
26704 this_face = FACE_FROM_ID (it->f, face_id);
26705 font = this_face->font;
26707 if (font == NULL)
26708 pcm = NULL;
26709 else
26711 get_char_face_and_encoding (it->f, ch, face_id,
26712 &char2b, 0);
26713 pcm = get_per_char_metric (font, &char2b);
26715 if (! pcm)
26716 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26717 else
26719 width = pcm->width;
26720 ascent = pcm->ascent;
26721 descent = pcm->descent;
26722 lbearing = pcm->lbearing;
26723 rbearing = pcm->rbearing;
26724 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
26726 /* Relative composition with or without
26727 alternate chars. */
26728 left = (leftmost + rightmost - width) / 2;
26729 btm = - descent + boff;
26730 if (font->relative_compose
26731 && (! CHAR_TABLE_P (Vignore_relative_composition)
26732 || NILP (Faref (Vignore_relative_composition,
26733 make_number (ch)))))
26736 if (- descent >= font->relative_compose)
26737 /* One extra pixel between two glyphs. */
26738 btm = highest + 1;
26739 else if (ascent <= 0)
26740 /* One extra pixel between two glyphs. */
26741 btm = lowest - 1 - ascent - descent;
26744 else
26746 /* A composition rule is specified by an integer
26747 value that encodes global and new reference
26748 points (GREF and NREF). GREF and NREF are
26749 specified by numbers as below:
26751 0---1---2 -- ascent
26755 9--10--11 -- center
26757 ---3---4---5--- baseline
26759 6---7---8 -- descent
26761 int rule = COMPOSITION_RULE (cmp, i);
26762 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
26764 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
26765 grefx = gref % 3, nrefx = nref % 3;
26766 grefy = gref / 3, nrefy = nref / 3;
26767 if (xoff)
26768 xoff = font_height * (xoff - 128) / 256;
26769 if (yoff)
26770 yoff = font_height * (yoff - 128) / 256;
26772 left = (leftmost
26773 + grefx * (rightmost - leftmost) / 2
26774 - nrefx * width / 2
26775 + xoff);
26777 btm = ((grefy == 0 ? highest
26778 : grefy == 1 ? 0
26779 : grefy == 2 ? lowest
26780 : (highest + lowest) / 2)
26781 - (nrefy == 0 ? ascent + descent
26782 : nrefy == 1 ? descent - boff
26783 : nrefy == 2 ? 0
26784 : (ascent + descent) / 2)
26785 + yoff);
26788 cmp->offsets[i * 2] = left;
26789 cmp->offsets[i * 2 + 1] = btm + descent;
26791 /* Update the bounding box of the overall glyphs. */
26792 if (width > 0)
26794 right = left + width;
26795 if (left < leftmost)
26796 leftmost = left;
26797 if (right > rightmost)
26798 rightmost = right;
26800 top = btm + descent + ascent;
26801 if (top > highest)
26802 highest = top;
26803 if (btm < lowest)
26804 lowest = btm;
26806 if (cmp->lbearing > left + lbearing)
26807 cmp->lbearing = left + lbearing;
26808 if (cmp->rbearing < left + rbearing)
26809 cmp->rbearing = left + rbearing;
26813 /* If there are glyphs whose x-offsets are negative,
26814 shift all glyphs to the right and make all x-offsets
26815 non-negative. */
26816 if (leftmost < 0)
26818 for (i = 0; i < cmp->glyph_len; i++)
26819 cmp->offsets[i * 2] -= leftmost;
26820 rightmost -= leftmost;
26821 cmp->lbearing -= leftmost;
26822 cmp->rbearing -= leftmost;
26825 if (left_padded && cmp->lbearing < 0)
26827 for (i = 0; i < cmp->glyph_len; i++)
26828 cmp->offsets[i * 2] -= cmp->lbearing;
26829 rightmost -= cmp->lbearing;
26830 cmp->rbearing -= cmp->lbearing;
26831 cmp->lbearing = 0;
26833 if (right_padded && rightmost < cmp->rbearing)
26835 rightmost = cmp->rbearing;
26838 cmp->pixel_width = rightmost;
26839 cmp->ascent = highest;
26840 cmp->descent = - lowest;
26841 if (cmp->ascent < font_ascent)
26842 cmp->ascent = font_ascent;
26843 if (cmp->descent < font_descent)
26844 cmp->descent = font_descent;
26847 if (it->glyph_row
26848 && (cmp->lbearing < 0
26849 || cmp->rbearing > cmp->pixel_width))
26850 it->glyph_row->contains_overlapping_glyphs_p = 1;
26852 it->pixel_width = cmp->pixel_width;
26853 it->ascent = it->phys_ascent = cmp->ascent;
26854 it->descent = it->phys_descent = cmp->descent;
26855 if (face->box != FACE_NO_BOX)
26857 int thick = face->box_line_width;
26859 if (thick > 0)
26861 it->ascent += thick;
26862 it->descent += thick;
26864 else
26865 thick = - thick;
26867 if (it->start_of_box_run_p)
26868 it->pixel_width += thick;
26869 if (it->end_of_box_run_p)
26870 it->pixel_width += thick;
26873 /* If face has an overline, add the height of the overline
26874 (1 pixel) and a 1 pixel margin to the character height. */
26875 if (face->overline_p)
26876 it->ascent += overline_margin;
26878 take_vertical_position_into_account (it);
26879 if (it->ascent < 0)
26880 it->ascent = 0;
26881 if (it->descent < 0)
26882 it->descent = 0;
26884 if (it->glyph_row && cmp->glyph_len > 0)
26885 append_composite_glyph (it);
26887 else if (it->what == IT_COMPOSITION)
26889 /* A dynamic (automatic) composition. */
26890 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26891 Lisp_Object gstring;
26892 struct font_metrics metrics;
26894 it->nglyphs = 1;
26896 gstring = composition_gstring_from_id (it->cmp_it.id);
26897 it->pixel_width
26898 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
26899 &metrics);
26900 if (it->glyph_row
26901 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
26902 it->glyph_row->contains_overlapping_glyphs_p = 1;
26903 it->ascent = it->phys_ascent = metrics.ascent;
26904 it->descent = it->phys_descent = metrics.descent;
26905 if (face->box != FACE_NO_BOX)
26907 int thick = face->box_line_width;
26909 if (thick > 0)
26911 it->ascent += thick;
26912 it->descent += thick;
26914 else
26915 thick = - thick;
26917 if (it->start_of_box_run_p)
26918 it->pixel_width += thick;
26919 if (it->end_of_box_run_p)
26920 it->pixel_width += thick;
26922 /* If face has an overline, add the height of the overline
26923 (1 pixel) and a 1 pixel margin to the character height. */
26924 if (face->overline_p)
26925 it->ascent += overline_margin;
26926 take_vertical_position_into_account (it);
26927 if (it->ascent < 0)
26928 it->ascent = 0;
26929 if (it->descent < 0)
26930 it->descent = 0;
26932 if (it->glyph_row)
26933 append_composite_glyph (it);
26935 else if (it->what == IT_GLYPHLESS)
26936 produce_glyphless_glyph (it, 0, Qnil);
26937 else if (it->what == IT_IMAGE)
26938 produce_image_glyph (it);
26939 else if (it->what == IT_STRETCH)
26940 produce_stretch_glyph (it);
26942 done:
26943 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26944 because this isn't true for images with `:ascent 100'. */
26945 eassert (it->ascent >= 0 && it->descent >= 0);
26946 if (it->area == TEXT_AREA)
26947 it->current_x += it->pixel_width;
26949 if (extra_line_spacing > 0)
26951 it->descent += extra_line_spacing;
26952 if (extra_line_spacing > it->max_extra_line_spacing)
26953 it->max_extra_line_spacing = extra_line_spacing;
26956 it->max_ascent = max (it->max_ascent, it->ascent);
26957 it->max_descent = max (it->max_descent, it->descent);
26958 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
26959 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
26962 /* EXPORT for RIF:
26963 Output LEN glyphs starting at START at the nominal cursor position.
26964 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26965 being updated, and UPDATED_AREA is the area of that row being updated. */
26967 void
26968 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
26969 struct glyph *start, enum glyph_row_area updated_area, int len)
26971 int x, hpos, chpos = w->phys_cursor.hpos;
26973 eassert (updated_row);
26974 /* When the window is hscrolled, cursor hpos can legitimately be out
26975 of bounds, but we draw the cursor at the corresponding window
26976 margin in that case. */
26977 if (!updated_row->reversed_p && chpos < 0)
26978 chpos = 0;
26979 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
26980 chpos = updated_row->used[TEXT_AREA] - 1;
26982 block_input ();
26984 /* Write glyphs. */
26986 hpos = start - updated_row->glyphs[updated_area];
26987 x = draw_glyphs (w, w->output_cursor.x,
26988 updated_row, updated_area,
26989 hpos, hpos + len,
26990 DRAW_NORMAL_TEXT, 0);
26992 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26993 if (updated_area == TEXT_AREA
26994 && w->phys_cursor_on_p
26995 && w->phys_cursor.vpos == w->output_cursor.vpos
26996 && chpos >= hpos
26997 && chpos < hpos + len)
26998 w->phys_cursor_on_p = 0;
27000 unblock_input ();
27002 /* Advance the output cursor. */
27003 w->output_cursor.hpos += len;
27004 w->output_cursor.x = x;
27008 /* EXPORT for RIF:
27009 Insert LEN glyphs from START at the nominal cursor position. */
27011 void
27012 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
27013 struct glyph *start, enum glyph_row_area updated_area, int len)
27015 struct frame *f;
27016 int line_height, shift_by_width, shifted_region_width;
27017 struct glyph_row *row;
27018 struct glyph *glyph;
27019 int frame_x, frame_y;
27020 ptrdiff_t hpos;
27022 eassert (updated_row);
27023 block_input ();
27024 f = XFRAME (WINDOW_FRAME (w));
27026 /* Get the height of the line we are in. */
27027 row = updated_row;
27028 line_height = row->height;
27030 /* Get the width of the glyphs to insert. */
27031 shift_by_width = 0;
27032 for (glyph = start; glyph < start + len; ++glyph)
27033 shift_by_width += glyph->pixel_width;
27035 /* Get the width of the region to shift right. */
27036 shifted_region_width = (window_box_width (w, updated_area)
27037 - w->output_cursor.x
27038 - shift_by_width);
27040 /* Shift right. */
27041 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
27042 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
27044 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
27045 line_height, shift_by_width);
27047 /* Write the glyphs. */
27048 hpos = start - row->glyphs[updated_area];
27049 draw_glyphs (w, w->output_cursor.x, row, updated_area,
27050 hpos, hpos + len,
27051 DRAW_NORMAL_TEXT, 0);
27053 /* Advance the output cursor. */
27054 w->output_cursor.hpos += len;
27055 w->output_cursor.x += shift_by_width;
27056 unblock_input ();
27060 /* EXPORT for RIF:
27061 Erase the current text line from the nominal cursor position
27062 (inclusive) to pixel column TO_X (exclusive). The idea is that
27063 everything from TO_X onward is already erased.
27065 TO_X is a pixel position relative to UPDATED_AREA of currently
27066 updated window W. TO_X == -1 means clear to the end of this area. */
27068 void
27069 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
27070 enum glyph_row_area updated_area, int to_x)
27072 struct frame *f;
27073 int max_x, min_y, max_y;
27074 int from_x, from_y, to_y;
27076 eassert (updated_row);
27077 f = XFRAME (w->frame);
27079 if (updated_row->full_width_p)
27080 max_x = (WINDOW_PIXEL_WIDTH (w)
27081 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
27082 else
27083 max_x = window_box_width (w, updated_area);
27084 max_y = window_text_bottom_y (w);
27086 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27087 of window. For TO_X > 0, truncate to end of drawing area. */
27088 if (to_x == 0)
27089 return;
27090 else if (to_x < 0)
27091 to_x = max_x;
27092 else
27093 to_x = min (to_x, max_x);
27095 to_y = min (max_y, w->output_cursor.y + updated_row->height);
27097 /* Notice if the cursor will be cleared by this operation. */
27098 if (!updated_row->full_width_p)
27099 notice_overwritten_cursor (w, updated_area,
27100 w->output_cursor.x, -1,
27101 updated_row->y,
27102 MATRIX_ROW_BOTTOM_Y (updated_row));
27104 from_x = w->output_cursor.x;
27106 /* Translate to frame coordinates. */
27107 if (updated_row->full_width_p)
27109 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
27110 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
27112 else
27114 int area_left = window_box_left (w, updated_area);
27115 from_x += area_left;
27116 to_x += area_left;
27119 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
27120 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
27121 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
27123 /* Prevent inadvertently clearing to end of the X window. */
27124 if (to_x > from_x && to_y > from_y)
27126 block_input ();
27127 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
27128 to_x - from_x, to_y - from_y);
27129 unblock_input ();
27133 #endif /* HAVE_WINDOW_SYSTEM */
27137 /***********************************************************************
27138 Cursor types
27139 ***********************************************************************/
27141 /* Value is the internal representation of the specified cursor type
27142 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27143 of the bar cursor. */
27145 static enum text_cursor_kinds
27146 get_specified_cursor_type (Lisp_Object arg, int *width)
27148 enum text_cursor_kinds type;
27150 if (NILP (arg))
27151 return NO_CURSOR;
27153 if (EQ (arg, Qbox))
27154 return FILLED_BOX_CURSOR;
27156 if (EQ (arg, Qhollow))
27157 return HOLLOW_BOX_CURSOR;
27159 if (EQ (arg, Qbar))
27161 *width = 2;
27162 return BAR_CURSOR;
27165 if (CONSP (arg)
27166 && EQ (XCAR (arg), Qbar)
27167 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27169 *width = XINT (XCDR (arg));
27170 return BAR_CURSOR;
27173 if (EQ (arg, Qhbar))
27175 *width = 2;
27176 return HBAR_CURSOR;
27179 if (CONSP (arg)
27180 && EQ (XCAR (arg), Qhbar)
27181 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27183 *width = XINT (XCDR (arg));
27184 return HBAR_CURSOR;
27187 /* Treat anything unknown as "hollow box cursor".
27188 It was bad to signal an error; people have trouble fixing
27189 .Xdefaults with Emacs, when it has something bad in it. */
27190 type = HOLLOW_BOX_CURSOR;
27192 return type;
27195 /* Set the default cursor types for specified frame. */
27196 void
27197 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
27199 int width = 1;
27200 Lisp_Object tem;
27202 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
27203 FRAME_CURSOR_WIDTH (f) = width;
27205 /* By default, set up the blink-off state depending on the on-state. */
27207 tem = Fassoc (arg, Vblink_cursor_alist);
27208 if (!NILP (tem))
27210 FRAME_BLINK_OFF_CURSOR (f)
27211 = get_specified_cursor_type (XCDR (tem), &width);
27212 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
27214 else
27215 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
27217 /* Make sure the cursor gets redrawn. */
27218 f->cursor_type_changed = 1;
27222 #ifdef HAVE_WINDOW_SYSTEM
27224 /* Return the cursor we want to be displayed in window W. Return
27225 width of bar/hbar cursor through WIDTH arg. Return with
27226 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27227 (i.e. if the `system caret' should track this cursor).
27229 In a mini-buffer window, we want the cursor only to appear if we
27230 are reading input from this window. For the selected window, we
27231 want the cursor type given by the frame parameter or buffer local
27232 setting of cursor-type. If explicitly marked off, draw no cursor.
27233 In all other cases, we want a hollow box cursor. */
27235 static enum text_cursor_kinds
27236 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
27237 int *active_cursor)
27239 struct frame *f = XFRAME (w->frame);
27240 struct buffer *b = XBUFFER (w->contents);
27241 int cursor_type = DEFAULT_CURSOR;
27242 Lisp_Object alt_cursor;
27243 int non_selected = 0;
27245 *active_cursor = 1;
27247 /* Echo area */
27248 if (cursor_in_echo_area
27249 && FRAME_HAS_MINIBUF_P (f)
27250 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
27252 if (w == XWINDOW (echo_area_window))
27254 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
27256 *width = FRAME_CURSOR_WIDTH (f);
27257 return FRAME_DESIRED_CURSOR (f);
27259 else
27260 return get_specified_cursor_type (BVAR (b, cursor_type), width);
27263 *active_cursor = 0;
27264 non_selected = 1;
27267 /* Detect a nonselected window or nonselected frame. */
27268 else if (w != XWINDOW (f->selected_window)
27269 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
27271 *active_cursor = 0;
27273 if (MINI_WINDOW_P (w) && minibuf_level == 0)
27274 return NO_CURSOR;
27276 non_selected = 1;
27279 /* Never display a cursor in a window in which cursor-type is nil. */
27280 if (NILP (BVAR (b, cursor_type)))
27281 return NO_CURSOR;
27283 /* Get the normal cursor type for this window. */
27284 if (EQ (BVAR (b, cursor_type), Qt))
27286 cursor_type = FRAME_DESIRED_CURSOR (f);
27287 *width = FRAME_CURSOR_WIDTH (f);
27289 else
27290 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
27292 /* Use cursor-in-non-selected-windows instead
27293 for non-selected window or frame. */
27294 if (non_selected)
27296 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
27297 if (!EQ (Qt, alt_cursor))
27298 return get_specified_cursor_type (alt_cursor, width);
27299 /* t means modify the normal cursor type. */
27300 if (cursor_type == FILLED_BOX_CURSOR)
27301 cursor_type = HOLLOW_BOX_CURSOR;
27302 else if (cursor_type == BAR_CURSOR && *width > 1)
27303 --*width;
27304 return cursor_type;
27307 /* Use normal cursor if not blinked off. */
27308 if (!w->cursor_off_p)
27310 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
27312 if (cursor_type == FILLED_BOX_CURSOR)
27314 /* Using a block cursor on large images can be very annoying.
27315 So use a hollow cursor for "large" images.
27316 If image is not transparent (no mask), also use hollow cursor. */
27317 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
27318 if (img != NULL && IMAGEP (img->spec))
27320 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27321 where N = size of default frame font size.
27322 This should cover most of the "tiny" icons people may use. */
27323 if (!img->mask
27324 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
27325 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
27326 cursor_type = HOLLOW_BOX_CURSOR;
27329 else if (cursor_type != NO_CURSOR)
27331 /* Display current only supports BOX and HOLLOW cursors for images.
27332 So for now, unconditionally use a HOLLOW cursor when cursor is
27333 not a solid box cursor. */
27334 cursor_type = HOLLOW_BOX_CURSOR;
27337 return cursor_type;
27340 /* Cursor is blinked off, so determine how to "toggle" it. */
27342 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27343 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
27344 return get_specified_cursor_type (XCDR (alt_cursor), width);
27346 /* Then see if frame has specified a specific blink off cursor type. */
27347 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
27349 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
27350 return FRAME_BLINK_OFF_CURSOR (f);
27353 #if 0
27354 /* Some people liked having a permanently visible blinking cursor,
27355 while others had very strong opinions against it. So it was
27356 decided to remove it. KFS 2003-09-03 */
27358 /* Finally perform built-in cursor blinking:
27359 filled box <-> hollow box
27360 wide [h]bar <-> narrow [h]bar
27361 narrow [h]bar <-> no cursor
27362 other type <-> no cursor */
27364 if (cursor_type == FILLED_BOX_CURSOR)
27365 return HOLLOW_BOX_CURSOR;
27367 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
27369 *width = 1;
27370 return cursor_type;
27372 #endif
27374 return NO_CURSOR;
27378 /* Notice when the text cursor of window W has been completely
27379 overwritten by a drawing operation that outputs glyphs in AREA
27380 starting at X0 and ending at X1 in the line starting at Y0 and
27381 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27382 the rest of the line after X0 has been written. Y coordinates
27383 are window-relative. */
27385 static void
27386 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
27387 int x0, int x1, int y0, int y1)
27389 int cx0, cx1, cy0, cy1;
27390 struct glyph_row *row;
27392 if (!w->phys_cursor_on_p)
27393 return;
27394 if (area != TEXT_AREA)
27395 return;
27397 if (w->phys_cursor.vpos < 0
27398 || w->phys_cursor.vpos >= w->current_matrix->nrows
27399 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
27400 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
27401 return;
27403 if (row->cursor_in_fringe_p)
27405 row->cursor_in_fringe_p = 0;
27406 draw_fringe_bitmap (w, row, row->reversed_p);
27407 w->phys_cursor_on_p = 0;
27408 return;
27411 cx0 = w->phys_cursor.x;
27412 cx1 = cx0 + w->phys_cursor_width;
27413 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
27414 return;
27416 /* The cursor image will be completely removed from the
27417 screen if the output area intersects the cursor area in
27418 y-direction. When we draw in [y0 y1[, and some part of
27419 the cursor is at y < y0, that part must have been drawn
27420 before. When scrolling, the cursor is erased before
27421 actually scrolling, so we don't come here. When not
27422 scrolling, the rows above the old cursor row must have
27423 changed, and in this case these rows must have written
27424 over the cursor image.
27426 Likewise if part of the cursor is below y1, with the
27427 exception of the cursor being in the first blank row at
27428 the buffer and window end because update_text_area
27429 doesn't draw that row. (Except when it does, but
27430 that's handled in update_text_area.) */
27432 cy0 = w->phys_cursor.y;
27433 cy1 = cy0 + w->phys_cursor_height;
27434 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
27435 return;
27437 w->phys_cursor_on_p = 0;
27440 #endif /* HAVE_WINDOW_SYSTEM */
27443 /************************************************************************
27444 Mouse Face
27445 ************************************************************************/
27447 #ifdef HAVE_WINDOW_SYSTEM
27449 /* EXPORT for RIF:
27450 Fix the display of area AREA of overlapping row ROW in window W
27451 with respect to the overlapping part OVERLAPS. */
27453 void
27454 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
27455 enum glyph_row_area area, int overlaps)
27457 int i, x;
27459 block_input ();
27461 x = 0;
27462 for (i = 0; i < row->used[area];)
27464 if (row->glyphs[area][i].overlaps_vertically_p)
27466 int start = i, start_x = x;
27470 x += row->glyphs[area][i].pixel_width;
27471 ++i;
27473 while (i < row->used[area]
27474 && row->glyphs[area][i].overlaps_vertically_p);
27476 draw_glyphs (w, start_x, row, area,
27477 start, i,
27478 DRAW_NORMAL_TEXT, overlaps);
27480 else
27482 x += row->glyphs[area][i].pixel_width;
27483 ++i;
27487 unblock_input ();
27491 /* EXPORT:
27492 Draw the cursor glyph of window W in glyph row ROW. See the
27493 comment of draw_glyphs for the meaning of HL. */
27495 void
27496 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
27497 enum draw_glyphs_face hl)
27499 /* If cursor hpos is out of bounds, don't draw garbage. This can
27500 happen in mini-buffer windows when switching between echo area
27501 glyphs and mini-buffer. */
27502 if ((row->reversed_p
27503 ? (w->phys_cursor.hpos >= 0)
27504 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
27506 int on_p = w->phys_cursor_on_p;
27507 int x1;
27508 int hpos = w->phys_cursor.hpos;
27510 /* When the window is hscrolled, cursor hpos can legitimately be
27511 out of bounds, but we draw the cursor at the corresponding
27512 window margin in that case. */
27513 if (!row->reversed_p && hpos < 0)
27514 hpos = 0;
27515 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27516 hpos = row->used[TEXT_AREA] - 1;
27518 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
27519 hl, 0);
27520 w->phys_cursor_on_p = on_p;
27522 if (hl == DRAW_CURSOR)
27523 w->phys_cursor_width = x1 - w->phys_cursor.x;
27524 /* When we erase the cursor, and ROW is overlapped by other
27525 rows, make sure that these overlapping parts of other rows
27526 are redrawn. */
27527 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
27529 w->phys_cursor_width = x1 - w->phys_cursor.x;
27531 if (row > w->current_matrix->rows
27532 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
27533 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
27534 OVERLAPS_ERASED_CURSOR);
27536 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
27537 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
27538 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
27539 OVERLAPS_ERASED_CURSOR);
27545 /* Erase the image of a cursor of window W from the screen. */
27547 void
27548 erase_phys_cursor (struct window *w)
27550 struct frame *f = XFRAME (w->frame);
27551 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27552 int hpos = w->phys_cursor.hpos;
27553 int vpos = w->phys_cursor.vpos;
27554 int mouse_face_here_p = 0;
27555 struct glyph_matrix *active_glyphs = w->current_matrix;
27556 struct glyph_row *cursor_row;
27557 struct glyph *cursor_glyph;
27558 enum draw_glyphs_face hl;
27560 /* No cursor displayed or row invalidated => nothing to do on the
27561 screen. */
27562 if (w->phys_cursor_type == NO_CURSOR)
27563 goto mark_cursor_off;
27565 /* VPOS >= active_glyphs->nrows means that window has been resized.
27566 Don't bother to erase the cursor. */
27567 if (vpos >= active_glyphs->nrows)
27568 goto mark_cursor_off;
27570 /* If row containing cursor is marked invalid, there is nothing we
27571 can do. */
27572 cursor_row = MATRIX_ROW (active_glyphs, vpos);
27573 if (!cursor_row->enabled_p)
27574 goto mark_cursor_off;
27576 /* If line spacing is > 0, old cursor may only be partially visible in
27577 window after split-window. So adjust visible height. */
27578 cursor_row->visible_height = min (cursor_row->visible_height,
27579 window_text_bottom_y (w) - cursor_row->y);
27581 /* If row is completely invisible, don't attempt to delete a cursor which
27582 isn't there. This can happen if cursor is at top of a window, and
27583 we switch to a buffer with a header line in that window. */
27584 if (cursor_row->visible_height <= 0)
27585 goto mark_cursor_off;
27587 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27588 if (cursor_row->cursor_in_fringe_p)
27590 cursor_row->cursor_in_fringe_p = 0;
27591 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
27592 goto mark_cursor_off;
27595 /* This can happen when the new row is shorter than the old one.
27596 In this case, either draw_glyphs or clear_end_of_line
27597 should have cleared the cursor. Note that we wouldn't be
27598 able to erase the cursor in this case because we don't have a
27599 cursor glyph at hand. */
27600 if ((cursor_row->reversed_p
27601 ? (w->phys_cursor.hpos < 0)
27602 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
27603 goto mark_cursor_off;
27605 /* When the window is hscrolled, cursor hpos can legitimately be out
27606 of bounds, but we draw the cursor at the corresponding window
27607 margin in that case. */
27608 if (!cursor_row->reversed_p && hpos < 0)
27609 hpos = 0;
27610 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
27611 hpos = cursor_row->used[TEXT_AREA] - 1;
27613 /* If the cursor is in the mouse face area, redisplay that when
27614 we clear the cursor. */
27615 if (! NILP (hlinfo->mouse_face_window)
27616 && coords_in_mouse_face_p (w, hpos, vpos)
27617 /* Don't redraw the cursor's spot in mouse face if it is at the
27618 end of a line (on a newline). The cursor appears there, but
27619 mouse highlighting does not. */
27620 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
27621 mouse_face_here_p = 1;
27623 /* Maybe clear the display under the cursor. */
27624 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
27626 int x, y;
27627 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
27628 int width;
27630 cursor_glyph = get_phys_cursor_glyph (w);
27631 if (cursor_glyph == NULL)
27632 goto mark_cursor_off;
27634 width = cursor_glyph->pixel_width;
27635 x = w->phys_cursor.x;
27636 if (x < 0)
27638 width += x;
27639 x = 0;
27641 width = min (width, window_box_width (w, TEXT_AREA) - x);
27642 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
27643 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
27645 if (width > 0)
27646 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
27649 /* Erase the cursor by redrawing the character underneath it. */
27650 if (mouse_face_here_p)
27651 hl = DRAW_MOUSE_FACE;
27652 else
27653 hl = DRAW_NORMAL_TEXT;
27654 draw_phys_cursor_glyph (w, cursor_row, hl);
27656 mark_cursor_off:
27657 w->phys_cursor_on_p = 0;
27658 w->phys_cursor_type = NO_CURSOR;
27662 /* EXPORT:
27663 Display or clear cursor of window W. If ON is zero, clear the
27664 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27665 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27667 void
27668 display_and_set_cursor (struct window *w, bool on,
27669 int hpos, int vpos, int x, int y)
27671 struct frame *f = XFRAME (w->frame);
27672 int new_cursor_type;
27673 int new_cursor_width;
27674 int active_cursor;
27675 struct glyph_row *glyph_row;
27676 struct glyph *glyph;
27678 /* This is pointless on invisible frames, and dangerous on garbaged
27679 windows and frames; in the latter case, the frame or window may
27680 be in the midst of changing its size, and x and y may be off the
27681 window. */
27682 if (! FRAME_VISIBLE_P (f)
27683 || FRAME_GARBAGED_P (f)
27684 || vpos >= w->current_matrix->nrows
27685 || hpos >= w->current_matrix->matrix_w)
27686 return;
27688 /* If cursor is off and we want it off, return quickly. */
27689 if (!on && !w->phys_cursor_on_p)
27690 return;
27692 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
27693 /* If cursor row is not enabled, we don't really know where to
27694 display the cursor. */
27695 if (!glyph_row->enabled_p)
27697 w->phys_cursor_on_p = 0;
27698 return;
27701 glyph = NULL;
27702 if (!glyph_row->exact_window_width_line_p
27703 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
27704 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
27706 eassert (input_blocked_p ());
27708 /* Set new_cursor_type to the cursor we want to be displayed. */
27709 new_cursor_type = get_window_cursor_type (w, glyph,
27710 &new_cursor_width, &active_cursor);
27712 /* If cursor is currently being shown and we don't want it to be or
27713 it is in the wrong place, or the cursor type is not what we want,
27714 erase it. */
27715 if (w->phys_cursor_on_p
27716 && (!on
27717 || w->phys_cursor.x != x
27718 || w->phys_cursor.y != y
27719 /* HPOS can be negative in R2L rows whose
27720 exact_window_width_line_p flag is set (i.e. their newline
27721 would "overflow into the fringe"). */
27722 || hpos < 0
27723 || new_cursor_type != w->phys_cursor_type
27724 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
27725 && new_cursor_width != w->phys_cursor_width)))
27726 erase_phys_cursor (w);
27728 /* Don't check phys_cursor_on_p here because that flag is only set
27729 to zero in some cases where we know that the cursor has been
27730 completely erased, to avoid the extra work of erasing the cursor
27731 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27732 still not be visible, or it has only been partly erased. */
27733 if (on)
27735 w->phys_cursor_ascent = glyph_row->ascent;
27736 w->phys_cursor_height = glyph_row->height;
27738 /* Set phys_cursor_.* before x_draw_.* is called because some
27739 of them may need the information. */
27740 w->phys_cursor.x = x;
27741 w->phys_cursor.y = glyph_row->y;
27742 w->phys_cursor.hpos = hpos;
27743 w->phys_cursor.vpos = vpos;
27746 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
27747 new_cursor_type, new_cursor_width,
27748 on, active_cursor);
27752 /* Switch the display of W's cursor on or off, according to the value
27753 of ON. */
27755 static void
27756 update_window_cursor (struct window *w, bool on)
27758 /* Don't update cursor in windows whose frame is in the process
27759 of being deleted. */
27760 if (w->current_matrix)
27762 int hpos = w->phys_cursor.hpos;
27763 int vpos = w->phys_cursor.vpos;
27764 struct glyph_row *row;
27766 if (vpos >= w->current_matrix->nrows
27767 || hpos >= w->current_matrix->matrix_w)
27768 return;
27770 row = MATRIX_ROW (w->current_matrix, vpos);
27772 /* When the window is hscrolled, cursor hpos can legitimately be
27773 out of bounds, but we draw the cursor at the corresponding
27774 window margin in that case. */
27775 if (!row->reversed_p && hpos < 0)
27776 hpos = 0;
27777 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27778 hpos = row->used[TEXT_AREA] - 1;
27780 block_input ();
27781 display_and_set_cursor (w, on, hpos, vpos,
27782 w->phys_cursor.x, w->phys_cursor.y);
27783 unblock_input ();
27788 /* Call update_window_cursor with parameter ON_P on all leaf windows
27789 in the window tree rooted at W. */
27791 static void
27792 update_cursor_in_window_tree (struct window *w, bool on_p)
27794 while (w)
27796 if (WINDOWP (w->contents))
27797 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
27798 else
27799 update_window_cursor (w, on_p);
27801 w = NILP (w->next) ? 0 : XWINDOW (w->next);
27806 /* EXPORT:
27807 Display the cursor on window W, or clear it, according to ON_P.
27808 Don't change the cursor's position. */
27810 void
27811 x_update_cursor (struct frame *f, bool on_p)
27813 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
27817 /* EXPORT:
27818 Clear the cursor of window W to background color, and mark the
27819 cursor as not shown. This is used when the text where the cursor
27820 is about to be rewritten. */
27822 void
27823 x_clear_cursor (struct window *w)
27825 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
27826 update_window_cursor (w, 0);
27829 #endif /* HAVE_WINDOW_SYSTEM */
27831 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27832 and MSDOS. */
27833 static void
27834 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
27835 int start_hpos, int end_hpos,
27836 enum draw_glyphs_face draw)
27838 #ifdef HAVE_WINDOW_SYSTEM
27839 if (FRAME_WINDOW_P (XFRAME (w->frame)))
27841 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
27842 return;
27844 #endif
27845 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27846 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
27847 #endif
27850 /* Display the active region described by mouse_face_* according to DRAW. */
27852 static void
27853 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
27855 struct window *w = XWINDOW (hlinfo->mouse_face_window);
27856 struct frame *f = XFRAME (WINDOW_FRAME (w));
27858 if (/* If window is in the process of being destroyed, don't bother
27859 to do anything. */
27860 w->current_matrix != NULL
27861 /* Don't update mouse highlight if hidden. */
27862 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
27863 /* Recognize when we are called to operate on rows that don't exist
27864 anymore. This can happen when a window is split. */
27865 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
27867 int phys_cursor_on_p = w->phys_cursor_on_p;
27868 struct glyph_row *row, *first, *last;
27870 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
27871 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
27873 for (row = first; row <= last && row->enabled_p; ++row)
27875 int start_hpos, end_hpos, start_x;
27877 /* For all but the first row, the highlight starts at column 0. */
27878 if (row == first)
27880 /* R2L rows have BEG and END in reversed order, but the
27881 screen drawing geometry is always left to right. So
27882 we need to mirror the beginning and end of the
27883 highlighted area in R2L rows. */
27884 if (!row->reversed_p)
27886 start_hpos = hlinfo->mouse_face_beg_col;
27887 start_x = hlinfo->mouse_face_beg_x;
27889 else if (row == last)
27891 start_hpos = hlinfo->mouse_face_end_col;
27892 start_x = hlinfo->mouse_face_end_x;
27894 else
27896 start_hpos = 0;
27897 start_x = 0;
27900 else if (row->reversed_p && row == last)
27902 start_hpos = hlinfo->mouse_face_end_col;
27903 start_x = hlinfo->mouse_face_end_x;
27905 else
27907 start_hpos = 0;
27908 start_x = 0;
27911 if (row == last)
27913 if (!row->reversed_p)
27914 end_hpos = hlinfo->mouse_face_end_col;
27915 else if (row == first)
27916 end_hpos = hlinfo->mouse_face_beg_col;
27917 else
27919 end_hpos = row->used[TEXT_AREA];
27920 if (draw == DRAW_NORMAL_TEXT)
27921 row->fill_line_p = 1; /* Clear to end of line */
27924 else if (row->reversed_p && row == first)
27925 end_hpos = hlinfo->mouse_face_beg_col;
27926 else
27928 end_hpos = row->used[TEXT_AREA];
27929 if (draw == DRAW_NORMAL_TEXT)
27930 row->fill_line_p = 1; /* Clear to end of line */
27933 if (end_hpos > start_hpos)
27935 draw_row_with_mouse_face (w, start_x, row,
27936 start_hpos, end_hpos, draw);
27938 row->mouse_face_p
27939 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
27943 #ifdef HAVE_WINDOW_SYSTEM
27944 /* When we've written over the cursor, arrange for it to
27945 be displayed again. */
27946 if (FRAME_WINDOW_P (f)
27947 && phys_cursor_on_p && !w->phys_cursor_on_p)
27949 int hpos = w->phys_cursor.hpos;
27951 /* When the window is hscrolled, cursor hpos can legitimately be
27952 out of bounds, but we draw the cursor at the corresponding
27953 window margin in that case. */
27954 if (!row->reversed_p && hpos < 0)
27955 hpos = 0;
27956 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27957 hpos = row->used[TEXT_AREA] - 1;
27959 block_input ();
27960 display_and_set_cursor (w, 1, hpos, w->phys_cursor.vpos,
27961 w->phys_cursor.x, w->phys_cursor.y);
27962 unblock_input ();
27964 #endif /* HAVE_WINDOW_SYSTEM */
27967 #ifdef HAVE_WINDOW_SYSTEM
27968 /* Change the mouse cursor. */
27969 if (FRAME_WINDOW_P (f) && NILP (do_mouse_tracking))
27971 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27972 if (draw == DRAW_NORMAL_TEXT
27973 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
27974 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
27975 else
27976 #endif
27977 if (draw == DRAW_MOUSE_FACE)
27978 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
27979 else
27980 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
27982 #endif /* HAVE_WINDOW_SYSTEM */
27985 /* EXPORT:
27986 Clear out the mouse-highlighted active region.
27987 Redraw it un-highlighted first. Value is non-zero if mouse
27988 face was actually drawn unhighlighted. */
27991 clear_mouse_face (Mouse_HLInfo *hlinfo)
27993 int cleared = 0;
27995 if (!hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window))
27997 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
27998 cleared = 1;
28001 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
28002 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
28003 hlinfo->mouse_face_window = Qnil;
28004 hlinfo->mouse_face_overlay = Qnil;
28005 return cleared;
28008 /* Return true if the coordinates HPOS and VPOS on windows W are
28009 within the mouse face on that window. */
28010 static bool
28011 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
28013 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
28015 /* Quickly resolve the easy cases. */
28016 if (!(WINDOWP (hlinfo->mouse_face_window)
28017 && XWINDOW (hlinfo->mouse_face_window) == w))
28018 return false;
28019 if (vpos < hlinfo->mouse_face_beg_row
28020 || vpos > hlinfo->mouse_face_end_row)
28021 return false;
28022 if (vpos > hlinfo->mouse_face_beg_row
28023 && vpos < hlinfo->mouse_face_end_row)
28024 return true;
28026 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
28028 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28030 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
28031 return true;
28033 else if ((vpos == hlinfo->mouse_face_beg_row
28034 && hpos >= hlinfo->mouse_face_beg_col)
28035 || (vpos == hlinfo->mouse_face_end_row
28036 && hpos < hlinfo->mouse_face_end_col))
28037 return true;
28039 else
28041 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
28043 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
28044 return true;
28046 else if ((vpos == hlinfo->mouse_face_beg_row
28047 && hpos <= hlinfo->mouse_face_beg_col)
28048 || (vpos == hlinfo->mouse_face_end_row
28049 && hpos > hlinfo->mouse_face_end_col))
28050 return true;
28052 return false;
28056 /* EXPORT:
28057 True if physical cursor of window W is within mouse face. */
28059 bool
28060 cursor_in_mouse_face_p (struct window *w)
28062 int hpos = w->phys_cursor.hpos;
28063 int vpos = w->phys_cursor.vpos;
28064 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
28066 /* When the window is hscrolled, cursor hpos can legitimately be out
28067 of bounds, but we draw the cursor at the corresponding window
28068 margin in that case. */
28069 if (!row->reversed_p && hpos < 0)
28070 hpos = 0;
28071 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
28072 hpos = row->used[TEXT_AREA] - 1;
28074 return coords_in_mouse_face_p (w, hpos, vpos);
28079 /* Find the glyph rows START_ROW and END_ROW of window W that display
28080 characters between buffer positions START_CHARPOS and END_CHARPOS
28081 (excluding END_CHARPOS). DISP_STRING is a display string that
28082 covers these buffer positions. This is similar to
28083 row_containing_pos, but is more accurate when bidi reordering makes
28084 buffer positions change non-linearly with glyph rows. */
28085 static void
28086 rows_from_pos_range (struct window *w,
28087 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
28088 Lisp_Object disp_string,
28089 struct glyph_row **start, struct glyph_row **end)
28091 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28092 int last_y = window_text_bottom_y (w);
28093 struct glyph_row *row;
28095 *start = NULL;
28096 *end = NULL;
28098 while (!first->enabled_p
28099 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
28100 first++;
28102 /* Find the START row. */
28103 for (row = first;
28104 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
28105 row++)
28107 /* A row can potentially be the START row if the range of the
28108 characters it displays intersects the range
28109 [START_CHARPOS..END_CHARPOS). */
28110 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
28111 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
28112 /* See the commentary in row_containing_pos, for the
28113 explanation of the complicated way to check whether
28114 some position is beyond the end of the characters
28115 displayed by a row. */
28116 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
28117 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
28118 && !row->ends_at_zv_p
28119 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
28120 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
28121 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
28122 && !row->ends_at_zv_p
28123 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
28125 /* Found a candidate row. Now make sure at least one of the
28126 glyphs it displays has a charpos from the range
28127 [START_CHARPOS..END_CHARPOS).
28129 This is not obvious because bidi reordering could make
28130 buffer positions of a row be 1,2,3,102,101,100, and if we
28131 want to highlight characters in [50..60), we don't want
28132 this row, even though [50..60) does intersect [1..103),
28133 the range of character positions given by the row's start
28134 and end positions. */
28135 struct glyph *g = row->glyphs[TEXT_AREA];
28136 struct glyph *e = g + row->used[TEXT_AREA];
28138 while (g < e)
28140 if (((BUFFERP (g->object) || INTEGERP (g->object))
28141 && start_charpos <= g->charpos && g->charpos < end_charpos)
28142 /* A glyph that comes from DISP_STRING is by
28143 definition to be highlighted. */
28144 || EQ (g->object, disp_string))
28145 *start = row;
28146 g++;
28148 if (*start)
28149 break;
28153 /* Find the END row. */
28154 if (!*start
28155 /* If the last row is partially visible, start looking for END
28156 from that row, instead of starting from FIRST. */
28157 && !(row->enabled_p
28158 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
28159 row = first;
28160 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
28162 struct glyph_row *next = row + 1;
28163 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
28165 if (!next->enabled_p
28166 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
28167 /* The first row >= START whose range of displayed characters
28168 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28169 is the row END + 1. */
28170 || (start_charpos < next_start
28171 && end_charpos < next_start)
28172 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
28173 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
28174 && !next->ends_at_zv_p
28175 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
28176 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
28177 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
28178 && !next->ends_at_zv_p
28179 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
28181 *end = row;
28182 break;
28184 else
28186 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28187 but none of the characters it displays are in the range, it is
28188 also END + 1. */
28189 struct glyph *g = next->glyphs[TEXT_AREA];
28190 struct glyph *s = g;
28191 struct glyph *e = g + next->used[TEXT_AREA];
28193 while (g < e)
28195 if (((BUFFERP (g->object) || INTEGERP (g->object))
28196 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
28197 /* If the buffer position of the first glyph in
28198 the row is equal to END_CHARPOS, it means
28199 the last character to be highlighted is the
28200 newline of ROW, and we must consider NEXT as
28201 END, not END+1. */
28202 || (((!next->reversed_p && g == s)
28203 || (next->reversed_p && g == e - 1))
28204 && (g->charpos == end_charpos
28205 /* Special case for when NEXT is an
28206 empty line at ZV. */
28207 || (g->charpos == -1
28208 && !row->ends_at_zv_p
28209 && next_start == end_charpos)))))
28210 /* A glyph that comes from DISP_STRING is by
28211 definition to be highlighted. */
28212 || EQ (g->object, disp_string))
28213 break;
28214 g++;
28216 if (g == e)
28218 *end = row;
28219 break;
28221 /* The first row that ends at ZV must be the last to be
28222 highlighted. */
28223 else if (next->ends_at_zv_p)
28225 *end = next;
28226 break;
28232 /* This function sets the mouse_face_* elements of HLINFO, assuming
28233 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28234 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28235 for the overlay or run of text properties specifying the mouse
28236 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28237 before-string and after-string that must also be highlighted.
28238 DISP_STRING, if non-nil, is a display string that may cover some
28239 or all of the highlighted text. */
28241 static void
28242 mouse_face_from_buffer_pos (Lisp_Object window,
28243 Mouse_HLInfo *hlinfo,
28244 ptrdiff_t mouse_charpos,
28245 ptrdiff_t start_charpos,
28246 ptrdiff_t end_charpos,
28247 Lisp_Object before_string,
28248 Lisp_Object after_string,
28249 Lisp_Object disp_string)
28251 struct window *w = XWINDOW (window);
28252 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28253 struct glyph_row *r1, *r2;
28254 struct glyph *glyph, *end;
28255 ptrdiff_t ignore, pos;
28256 int x;
28258 eassert (NILP (disp_string) || STRINGP (disp_string));
28259 eassert (NILP (before_string) || STRINGP (before_string));
28260 eassert (NILP (after_string) || STRINGP (after_string));
28262 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28263 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
28264 if (r1 == NULL)
28265 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28266 /* If the before-string or display-string contains newlines,
28267 rows_from_pos_range skips to its last row. Move back. */
28268 if (!NILP (before_string) || !NILP (disp_string))
28270 struct glyph_row *prev;
28271 while ((prev = r1 - 1, prev >= first)
28272 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
28273 && prev->used[TEXT_AREA] > 0)
28275 struct glyph *beg = prev->glyphs[TEXT_AREA];
28276 glyph = beg + prev->used[TEXT_AREA];
28277 while (--glyph >= beg && INTEGERP (glyph->object));
28278 if (glyph < beg
28279 || !(EQ (glyph->object, before_string)
28280 || EQ (glyph->object, disp_string)))
28281 break;
28282 r1 = prev;
28285 if (r2 == NULL)
28287 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28288 hlinfo->mouse_face_past_end = 1;
28290 else if (!NILP (after_string))
28292 /* If the after-string has newlines, advance to its last row. */
28293 struct glyph_row *next;
28294 struct glyph_row *last
28295 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28297 for (next = r2 + 1;
28298 next <= last
28299 && next->used[TEXT_AREA] > 0
28300 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
28301 ++next)
28302 r2 = next;
28304 /* The rest of the display engine assumes that mouse_face_beg_row is
28305 either above mouse_face_end_row or identical to it. But with
28306 bidi-reordered continued lines, the row for START_CHARPOS could
28307 be below the row for END_CHARPOS. If so, swap the rows and store
28308 them in correct order. */
28309 if (r1->y > r2->y)
28311 struct glyph_row *tem = r2;
28313 r2 = r1;
28314 r1 = tem;
28317 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
28318 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
28320 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28321 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28322 could be anywhere in the row and in any order. The strategy
28323 below is to find the leftmost and the rightmost glyph that
28324 belongs to either of these 3 strings, or whose position is
28325 between START_CHARPOS and END_CHARPOS, and highlight all the
28326 glyphs between those two. This may cover more than just the text
28327 between START_CHARPOS and END_CHARPOS if the range of characters
28328 strides the bidi level boundary, e.g. if the beginning is in R2L
28329 text while the end is in L2R text or vice versa. */
28330 if (!r1->reversed_p)
28332 /* This row is in a left to right paragraph. Scan it left to
28333 right. */
28334 glyph = r1->glyphs[TEXT_AREA];
28335 end = glyph + r1->used[TEXT_AREA];
28336 x = r1->x;
28338 /* Skip truncation glyphs at the start of the glyph row. */
28339 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28340 for (; glyph < end
28341 && INTEGERP (glyph->object)
28342 && glyph->charpos < 0;
28343 ++glyph)
28344 x += glyph->pixel_width;
28346 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28347 or DISP_STRING, and the first glyph from buffer whose
28348 position is between START_CHARPOS and END_CHARPOS. */
28349 for (; glyph < end
28350 && !INTEGERP (glyph->object)
28351 && !EQ (glyph->object, disp_string)
28352 && !(BUFFERP (glyph->object)
28353 && (glyph->charpos >= start_charpos
28354 && glyph->charpos < end_charpos));
28355 ++glyph)
28357 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28358 are present at buffer positions between START_CHARPOS and
28359 END_CHARPOS, or if they come from an overlay. */
28360 if (EQ (glyph->object, before_string))
28362 pos = string_buffer_position (before_string,
28363 start_charpos);
28364 /* If pos == 0, it means before_string came from an
28365 overlay, not from a buffer position. */
28366 if (!pos || (pos >= start_charpos && pos < end_charpos))
28367 break;
28369 else if (EQ (glyph->object, after_string))
28371 pos = string_buffer_position (after_string, end_charpos);
28372 if (!pos || (pos >= start_charpos && pos < end_charpos))
28373 break;
28375 x += glyph->pixel_width;
28377 hlinfo->mouse_face_beg_x = x;
28378 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28380 else
28382 /* This row is in a right to left paragraph. Scan it right to
28383 left. */
28384 struct glyph *g;
28386 end = r1->glyphs[TEXT_AREA] - 1;
28387 glyph = end + r1->used[TEXT_AREA];
28389 /* Skip truncation glyphs at the start of the glyph row. */
28390 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28391 for (; glyph > end
28392 && INTEGERP (glyph->object)
28393 && glyph->charpos < 0;
28394 --glyph)
28397 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28398 or DISP_STRING, and the first glyph from buffer whose
28399 position is between START_CHARPOS and END_CHARPOS. */
28400 for (; glyph > end
28401 && !INTEGERP (glyph->object)
28402 && !EQ (glyph->object, disp_string)
28403 && !(BUFFERP (glyph->object)
28404 && (glyph->charpos >= start_charpos
28405 && glyph->charpos < end_charpos));
28406 --glyph)
28408 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28409 are present at buffer positions between START_CHARPOS and
28410 END_CHARPOS, or if they come from an overlay. */
28411 if (EQ (glyph->object, before_string))
28413 pos = string_buffer_position (before_string, start_charpos);
28414 /* If pos == 0, it means before_string came from an
28415 overlay, not from a buffer position. */
28416 if (!pos || (pos >= start_charpos && pos < end_charpos))
28417 break;
28419 else if (EQ (glyph->object, after_string))
28421 pos = string_buffer_position (after_string, end_charpos);
28422 if (!pos || (pos >= start_charpos && pos < end_charpos))
28423 break;
28427 glyph++; /* first glyph to the right of the highlighted area */
28428 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
28429 x += g->pixel_width;
28430 hlinfo->mouse_face_beg_x = x;
28431 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28434 /* If the highlight ends in a different row, compute GLYPH and END
28435 for the end row. Otherwise, reuse the values computed above for
28436 the row where the highlight begins. */
28437 if (r2 != r1)
28439 if (!r2->reversed_p)
28441 glyph = r2->glyphs[TEXT_AREA];
28442 end = glyph + r2->used[TEXT_AREA];
28443 x = r2->x;
28445 else
28447 end = r2->glyphs[TEXT_AREA] - 1;
28448 glyph = end + r2->used[TEXT_AREA];
28452 if (!r2->reversed_p)
28454 /* Skip truncation and continuation glyphs near the end of the
28455 row, and also blanks and stretch glyphs inserted by
28456 extend_face_to_end_of_line. */
28457 while (end > glyph
28458 && INTEGERP ((end - 1)->object))
28459 --end;
28460 /* Scan the rest of the glyph row from the end, looking for the
28461 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28462 DISP_STRING, or whose position is between START_CHARPOS
28463 and END_CHARPOS */
28464 for (--end;
28465 end > glyph
28466 && !INTEGERP (end->object)
28467 && !EQ (end->object, disp_string)
28468 && !(BUFFERP (end->object)
28469 && (end->charpos >= start_charpos
28470 && end->charpos < end_charpos));
28471 --end)
28473 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28474 are present at buffer positions between START_CHARPOS and
28475 END_CHARPOS, or if they come from an overlay. */
28476 if (EQ (end->object, before_string))
28478 pos = string_buffer_position (before_string, start_charpos);
28479 if (!pos || (pos >= start_charpos && pos < end_charpos))
28480 break;
28482 else if (EQ (end->object, after_string))
28484 pos = string_buffer_position (after_string, end_charpos);
28485 if (!pos || (pos >= start_charpos && pos < end_charpos))
28486 break;
28489 /* Find the X coordinate of the last glyph to be highlighted. */
28490 for (; glyph <= end; ++glyph)
28491 x += glyph->pixel_width;
28493 hlinfo->mouse_face_end_x = x;
28494 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
28496 else
28498 /* Skip truncation and continuation glyphs near the end of the
28499 row, and also blanks and stretch glyphs inserted by
28500 extend_face_to_end_of_line. */
28501 x = r2->x;
28502 end++;
28503 while (end < glyph
28504 && INTEGERP (end->object))
28506 x += end->pixel_width;
28507 ++end;
28509 /* Scan the rest of the glyph row from the end, looking for the
28510 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28511 DISP_STRING, or whose position is between START_CHARPOS
28512 and END_CHARPOS */
28513 for ( ;
28514 end < glyph
28515 && !INTEGERP (end->object)
28516 && !EQ (end->object, disp_string)
28517 && !(BUFFERP (end->object)
28518 && (end->charpos >= start_charpos
28519 && end->charpos < end_charpos));
28520 ++end)
28522 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28523 are present at buffer positions between START_CHARPOS and
28524 END_CHARPOS, or if they come from an overlay. */
28525 if (EQ (end->object, before_string))
28527 pos = string_buffer_position (before_string, start_charpos);
28528 if (!pos || (pos >= start_charpos && pos < end_charpos))
28529 break;
28531 else if (EQ (end->object, after_string))
28533 pos = string_buffer_position (after_string, end_charpos);
28534 if (!pos || (pos >= start_charpos && pos < end_charpos))
28535 break;
28537 x += end->pixel_width;
28539 /* If we exited the above loop because we arrived at the last
28540 glyph of the row, and its buffer position is still not in
28541 range, it means the last character in range is the preceding
28542 newline. Bump the end column and x values to get past the
28543 last glyph. */
28544 if (end == glyph
28545 && BUFFERP (end->object)
28546 && (end->charpos < start_charpos
28547 || end->charpos >= end_charpos))
28549 x += end->pixel_width;
28550 ++end;
28552 hlinfo->mouse_face_end_x = x;
28553 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
28556 hlinfo->mouse_face_window = window;
28557 hlinfo->mouse_face_face_id
28558 = face_at_buffer_position (w, mouse_charpos, &ignore,
28559 mouse_charpos + 1,
28560 !hlinfo->mouse_face_hidden, -1);
28561 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28564 /* The following function is not used anymore (replaced with
28565 mouse_face_from_string_pos), but I leave it here for the time
28566 being, in case someone would. */
28568 #if 0 /* not used */
28570 /* Find the position of the glyph for position POS in OBJECT in
28571 window W's current matrix, and return in *X, *Y the pixel
28572 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28574 RIGHT_P non-zero means return the position of the right edge of the
28575 glyph, RIGHT_P zero means return the left edge position.
28577 If no glyph for POS exists in the matrix, return the position of
28578 the glyph with the next smaller position that is in the matrix, if
28579 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28580 exists in the matrix, return the position of the glyph with the
28581 next larger position in OBJECT.
28583 Value is non-zero if a glyph was found. */
28585 static int
28586 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
28587 int *hpos, int *vpos, int *x, int *y, int right_p)
28589 int yb = window_text_bottom_y (w);
28590 struct glyph_row *r;
28591 struct glyph *best_glyph = NULL;
28592 struct glyph_row *best_row = NULL;
28593 int best_x = 0;
28595 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28596 r->enabled_p && r->y < yb;
28597 ++r)
28599 struct glyph *g = r->glyphs[TEXT_AREA];
28600 struct glyph *e = g + r->used[TEXT_AREA];
28601 int gx;
28603 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28604 if (EQ (g->object, object))
28606 if (g->charpos == pos)
28608 best_glyph = g;
28609 best_x = gx;
28610 best_row = r;
28611 goto found;
28613 else if (best_glyph == NULL
28614 || ((eabs (g->charpos - pos)
28615 < eabs (best_glyph->charpos - pos))
28616 && (right_p
28617 ? g->charpos < pos
28618 : g->charpos > pos)))
28620 best_glyph = g;
28621 best_x = gx;
28622 best_row = r;
28627 found:
28629 if (best_glyph)
28631 *x = best_x;
28632 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
28634 if (right_p)
28636 *x += best_glyph->pixel_width;
28637 ++*hpos;
28640 *y = best_row->y;
28641 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
28644 return best_glyph != NULL;
28646 #endif /* not used */
28648 /* Find the positions of the first and the last glyphs in window W's
28649 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28650 (assumed to be a string), and return in HLINFO's mouse_face_*
28651 members the pixel and column/row coordinates of those glyphs. */
28653 static void
28654 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
28655 Lisp_Object object,
28656 ptrdiff_t startpos, ptrdiff_t endpos)
28658 int yb = window_text_bottom_y (w);
28659 struct glyph_row *r;
28660 struct glyph *g, *e;
28661 int gx;
28662 int found = 0;
28664 /* Find the glyph row with at least one position in the range
28665 [STARTPOS..ENDPOS), and the first glyph in that row whose
28666 position belongs to that range. */
28667 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28668 r->enabled_p && r->y < yb;
28669 ++r)
28671 if (!r->reversed_p)
28673 g = r->glyphs[TEXT_AREA];
28674 e = g + r->used[TEXT_AREA];
28675 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28676 if (EQ (g->object, object)
28677 && startpos <= g->charpos && g->charpos < endpos)
28679 hlinfo->mouse_face_beg_row
28680 = MATRIX_ROW_VPOS (r, w->current_matrix);
28681 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28682 hlinfo->mouse_face_beg_x = gx;
28683 found = 1;
28684 break;
28687 else
28689 struct glyph *g1;
28691 e = r->glyphs[TEXT_AREA];
28692 g = e + r->used[TEXT_AREA];
28693 for ( ; g > e; --g)
28694 if (EQ ((g-1)->object, object)
28695 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
28697 hlinfo->mouse_face_beg_row
28698 = MATRIX_ROW_VPOS (r, w->current_matrix);
28699 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28700 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
28701 gx += g1->pixel_width;
28702 hlinfo->mouse_face_beg_x = gx;
28703 found = 1;
28704 break;
28707 if (found)
28708 break;
28711 if (!found)
28712 return;
28714 /* Starting with the next row, look for the first row which does NOT
28715 include any glyphs whose positions are in the range. */
28716 for (++r; r->enabled_p && r->y < yb; ++r)
28718 g = r->glyphs[TEXT_AREA];
28719 e = g + r->used[TEXT_AREA];
28720 found = 0;
28721 for ( ; g < e; ++g)
28722 if (EQ (g->object, object)
28723 && startpos <= g->charpos && g->charpos < endpos)
28725 found = 1;
28726 break;
28728 if (!found)
28729 break;
28732 /* The highlighted region ends on the previous row. */
28733 r--;
28735 /* Set the end row. */
28736 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
28738 /* Compute and set the end column and the end column's horizontal
28739 pixel coordinate. */
28740 if (!r->reversed_p)
28742 g = r->glyphs[TEXT_AREA];
28743 e = g + r->used[TEXT_AREA];
28744 for ( ; e > g; --e)
28745 if (EQ ((e-1)->object, object)
28746 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
28747 break;
28748 hlinfo->mouse_face_end_col = e - g;
28750 for (gx = r->x; g < e; ++g)
28751 gx += g->pixel_width;
28752 hlinfo->mouse_face_end_x = gx;
28754 else
28756 e = r->glyphs[TEXT_AREA];
28757 g = e + r->used[TEXT_AREA];
28758 for (gx = r->x ; e < g; ++e)
28760 if (EQ (e->object, object)
28761 && startpos <= e->charpos && e->charpos < endpos)
28762 break;
28763 gx += e->pixel_width;
28765 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
28766 hlinfo->mouse_face_end_x = gx;
28770 #ifdef HAVE_WINDOW_SYSTEM
28772 /* See if position X, Y is within a hot-spot of an image. */
28774 static int
28775 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
28777 if (!CONSP (hot_spot))
28778 return 0;
28780 if (EQ (XCAR (hot_spot), Qrect))
28782 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28783 Lisp_Object rect = XCDR (hot_spot);
28784 Lisp_Object tem;
28785 if (!CONSP (rect))
28786 return 0;
28787 if (!CONSP (XCAR (rect)))
28788 return 0;
28789 if (!CONSP (XCDR (rect)))
28790 return 0;
28791 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
28792 return 0;
28793 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
28794 return 0;
28795 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
28796 return 0;
28797 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
28798 return 0;
28799 return 1;
28801 else if (EQ (XCAR (hot_spot), Qcircle))
28803 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28804 Lisp_Object circ = XCDR (hot_spot);
28805 Lisp_Object lr, lx0, ly0;
28806 if (CONSP (circ)
28807 && CONSP (XCAR (circ))
28808 && (lr = XCDR (circ), INTEGERP (lr) || FLOATP (lr))
28809 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
28810 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
28812 double r = XFLOATINT (lr);
28813 double dx = XINT (lx0) - x;
28814 double dy = XINT (ly0) - y;
28815 return (dx * dx + dy * dy <= r * r);
28818 else if (EQ (XCAR (hot_spot), Qpoly))
28820 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28821 if (VECTORP (XCDR (hot_spot)))
28823 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
28824 Lisp_Object *poly = v->contents;
28825 ptrdiff_t n = v->header.size;
28826 ptrdiff_t i;
28827 int inside = 0;
28828 Lisp_Object lx, ly;
28829 int x0, y0;
28831 /* Need an even number of coordinates, and at least 3 edges. */
28832 if (n < 6 || n & 1)
28833 return 0;
28835 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28836 If count is odd, we are inside polygon. Pixels on edges
28837 may or may not be included depending on actual geometry of the
28838 polygon. */
28839 if ((lx = poly[n-2], !INTEGERP (lx))
28840 || (ly = poly[n-1], !INTEGERP (lx)))
28841 return 0;
28842 x0 = XINT (lx), y0 = XINT (ly);
28843 for (i = 0; i < n; i += 2)
28845 int x1 = x0, y1 = y0;
28846 if ((lx = poly[i], !INTEGERP (lx))
28847 || (ly = poly[i+1], !INTEGERP (ly)))
28848 return 0;
28849 x0 = XINT (lx), y0 = XINT (ly);
28851 /* Does this segment cross the X line? */
28852 if (x0 >= x)
28854 if (x1 >= x)
28855 continue;
28857 else if (x1 < x)
28858 continue;
28859 if (y > y0 && y > y1)
28860 continue;
28861 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
28862 inside = !inside;
28864 return inside;
28867 return 0;
28870 Lisp_Object
28871 find_hot_spot (Lisp_Object map, int x, int y)
28873 while (CONSP (map))
28875 if (CONSP (XCAR (map))
28876 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
28877 return XCAR (map);
28878 map = XCDR (map);
28881 return Qnil;
28884 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
28885 3, 3, 0,
28886 doc: /* Lookup in image map MAP coordinates X and Y.
28887 An image map is an alist where each element has the format (AREA ID PLIST).
28888 An AREA is specified as either a rectangle, a circle, or a polygon:
28889 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28890 pixel coordinates of the upper left and bottom right corners.
28891 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28892 and the radius of the circle; r may be a float or integer.
28893 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28894 vector describes one corner in the polygon.
28895 Returns the alist element for the first matching AREA in MAP. */)
28896 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
28898 if (NILP (map))
28899 return Qnil;
28901 CHECK_NUMBER (x);
28902 CHECK_NUMBER (y);
28904 return find_hot_spot (map,
28905 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
28906 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
28910 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28911 static void
28912 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
28914 /* Do not change cursor shape while dragging mouse. */
28915 if (!NILP (do_mouse_tracking))
28916 return;
28918 if (!NILP (pointer))
28920 if (EQ (pointer, Qarrow))
28921 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28922 else if (EQ (pointer, Qhand))
28923 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
28924 else if (EQ (pointer, Qtext))
28925 cursor = FRAME_X_OUTPUT (f)->text_cursor;
28926 else if (EQ (pointer, intern ("hdrag")))
28927 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
28928 else if (EQ (pointer, intern ("nhdrag")))
28929 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
28930 #ifdef HAVE_X_WINDOWS
28931 else if (EQ (pointer, intern ("vdrag")))
28932 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28933 #endif
28934 else if (EQ (pointer, intern ("hourglass")))
28935 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
28936 else if (EQ (pointer, Qmodeline))
28937 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
28938 else
28939 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28942 if (cursor != No_Cursor)
28943 FRAME_RIF (f)->define_frame_cursor (f, cursor);
28946 #endif /* HAVE_WINDOW_SYSTEM */
28948 /* Take proper action when mouse has moved to the mode or header line
28949 or marginal area AREA of window W, x-position X and y-position Y.
28950 X is relative to the start of the text display area of W, so the
28951 width of bitmap areas and scroll bars must be subtracted to get a
28952 position relative to the start of the mode line. */
28954 static void
28955 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
28956 enum window_part area)
28958 struct window *w = XWINDOW (window);
28959 struct frame *f = XFRAME (w->frame);
28960 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28961 #ifdef HAVE_WINDOW_SYSTEM
28962 Display_Info *dpyinfo;
28963 #endif
28964 Cursor cursor = No_Cursor;
28965 Lisp_Object pointer = Qnil;
28966 int dx, dy, width, height;
28967 ptrdiff_t charpos;
28968 Lisp_Object string, object = Qnil;
28969 Lisp_Object pos IF_LINT (= Qnil), help;
28971 Lisp_Object mouse_face;
28972 int original_x_pixel = x;
28973 struct glyph * glyph = NULL, * row_start_glyph = NULL;
28974 struct glyph_row *row IF_LINT (= 0);
28976 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
28978 int x0;
28979 struct glyph *end;
28981 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28982 returns them in row/column units! */
28983 string = mode_line_string (w, area, &x, &y, &charpos,
28984 &object, &dx, &dy, &width, &height);
28986 row = (area == ON_MODE_LINE
28987 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
28988 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
28990 /* Find the glyph under the mouse pointer. */
28991 if (row->mode_line_p && row->enabled_p)
28993 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
28994 end = glyph + row->used[TEXT_AREA];
28996 for (x0 = original_x_pixel;
28997 glyph < end && x0 >= glyph->pixel_width;
28998 ++glyph)
28999 x0 -= glyph->pixel_width;
29001 if (glyph >= end)
29002 glyph = NULL;
29005 else
29007 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
29008 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
29009 returns them in row/column units! */
29010 string = marginal_area_string (w, area, &x, &y, &charpos,
29011 &object, &dx, &dy, &width, &height);
29014 help = Qnil;
29016 #ifdef HAVE_WINDOW_SYSTEM
29017 if (IMAGEP (object))
29019 Lisp_Object image_map, hotspot;
29020 if ((image_map = Fplist_get (XCDR (object), QCmap),
29021 !NILP (image_map))
29022 && (hotspot = find_hot_spot (image_map, dx, dy),
29023 CONSP (hotspot))
29024 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29026 Lisp_Object plist;
29028 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29029 If so, we could look for mouse-enter, mouse-leave
29030 properties in PLIST (and do something...). */
29031 hotspot = XCDR (hotspot);
29032 if (CONSP (hotspot)
29033 && (plist = XCAR (hotspot), CONSP (plist)))
29035 pointer = Fplist_get (plist, Qpointer);
29036 if (NILP (pointer))
29037 pointer = Qhand;
29038 help = Fplist_get (plist, Qhelp_echo);
29039 if (!NILP (help))
29041 help_echo_string = help;
29042 XSETWINDOW (help_echo_window, w);
29043 help_echo_object = w->contents;
29044 help_echo_pos = charpos;
29048 if (NILP (pointer))
29049 pointer = Fplist_get (XCDR (object), QCpointer);
29051 #endif /* HAVE_WINDOW_SYSTEM */
29053 if (STRINGP (string))
29054 pos = make_number (charpos);
29056 /* Set the help text and mouse pointer. If the mouse is on a part
29057 of the mode line without any text (e.g. past the right edge of
29058 the mode line text), use the default help text and pointer. */
29059 if (STRINGP (string) || area == ON_MODE_LINE)
29061 /* Arrange to display the help by setting the global variables
29062 help_echo_string, help_echo_object, and help_echo_pos. */
29063 if (NILP (help))
29065 if (STRINGP (string))
29066 help = Fget_text_property (pos, Qhelp_echo, string);
29068 if (!NILP (help))
29070 help_echo_string = help;
29071 XSETWINDOW (help_echo_window, w);
29072 help_echo_object = string;
29073 help_echo_pos = charpos;
29075 else if (area == ON_MODE_LINE)
29077 Lisp_Object default_help
29078 = buffer_local_value (Qmode_line_default_help_echo,
29079 w->contents);
29081 if (STRINGP (default_help))
29083 help_echo_string = default_help;
29084 XSETWINDOW (help_echo_window, w);
29085 help_echo_object = Qnil;
29086 help_echo_pos = -1;
29091 #ifdef HAVE_WINDOW_SYSTEM
29092 /* Change the mouse pointer according to what is under it. */
29093 if (FRAME_WINDOW_P (f))
29095 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
29096 || minibuf_level
29097 || NILP (Vresize_mini_windows));
29099 dpyinfo = FRAME_DISPLAY_INFO (f);
29100 if (STRINGP (string))
29102 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29104 if (NILP (pointer))
29105 pointer = Fget_text_property (pos, Qpointer, string);
29107 /* Change the mouse pointer according to what is under X/Y. */
29108 if (NILP (pointer)
29109 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
29111 Lisp_Object map;
29112 map = Fget_text_property (pos, Qlocal_map, string);
29113 if (!KEYMAPP (map))
29114 map = Fget_text_property (pos, Qkeymap, string);
29115 if (!KEYMAPP (map) && draggable)
29116 cursor = dpyinfo->vertical_scroll_bar_cursor;
29119 else if (draggable)
29120 /* Default mode-line pointer. */
29121 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
29123 #endif
29126 /* Change the mouse face according to what is under X/Y. */
29127 if (STRINGP (string))
29129 mouse_face = Fget_text_property (pos, Qmouse_face, string);
29130 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
29131 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29132 && glyph)
29134 Lisp_Object b, e;
29136 struct glyph * tmp_glyph;
29138 int gpos;
29139 int gseq_length;
29140 int total_pixel_width;
29141 ptrdiff_t begpos, endpos, ignore;
29143 int vpos, hpos;
29145 b = Fprevious_single_property_change (make_number (charpos + 1),
29146 Qmouse_face, string, Qnil);
29147 if (NILP (b))
29148 begpos = 0;
29149 else
29150 begpos = XINT (b);
29152 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
29153 if (NILP (e))
29154 endpos = SCHARS (string);
29155 else
29156 endpos = XINT (e);
29158 /* Calculate the glyph position GPOS of GLYPH in the
29159 displayed string, relative to the beginning of the
29160 highlighted part of the string.
29162 Note: GPOS is different from CHARPOS. CHARPOS is the
29163 position of GLYPH in the internal string object. A mode
29164 line string format has structures which are converted to
29165 a flattened string by the Emacs Lisp interpreter. The
29166 internal string is an element of those structures. The
29167 displayed string is the flattened string. */
29168 tmp_glyph = row_start_glyph;
29169 while (tmp_glyph < glyph
29170 && (!(EQ (tmp_glyph->object, glyph->object)
29171 && begpos <= tmp_glyph->charpos
29172 && tmp_glyph->charpos < endpos)))
29173 tmp_glyph++;
29174 gpos = glyph - tmp_glyph;
29176 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29177 the highlighted part of the displayed string to which
29178 GLYPH belongs. Note: GSEQ_LENGTH is different from
29179 SCHARS (STRING), because the latter returns the length of
29180 the internal string. */
29181 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
29182 tmp_glyph > glyph
29183 && (!(EQ (tmp_glyph->object, glyph->object)
29184 && begpos <= tmp_glyph->charpos
29185 && tmp_glyph->charpos < endpos));
29186 tmp_glyph--)
29188 gseq_length = gpos + (tmp_glyph - glyph) + 1;
29190 /* Calculate the total pixel width of all the glyphs between
29191 the beginning of the highlighted area and GLYPH. */
29192 total_pixel_width = 0;
29193 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
29194 total_pixel_width += tmp_glyph->pixel_width;
29196 /* Pre calculation of re-rendering position. Note: X is in
29197 column units here, after the call to mode_line_string or
29198 marginal_area_string. */
29199 hpos = x - gpos;
29200 vpos = (area == ON_MODE_LINE
29201 ? (w->current_matrix)->nrows - 1
29202 : 0);
29204 /* If GLYPH's position is included in the region that is
29205 already drawn in mouse face, we have nothing to do. */
29206 if ( EQ (window, hlinfo->mouse_face_window)
29207 && (!row->reversed_p
29208 ? (hlinfo->mouse_face_beg_col <= hpos
29209 && hpos < hlinfo->mouse_face_end_col)
29210 /* In R2L rows we swap BEG and END, see below. */
29211 : (hlinfo->mouse_face_end_col <= hpos
29212 && hpos < hlinfo->mouse_face_beg_col))
29213 && hlinfo->mouse_face_beg_row == vpos )
29214 return;
29216 if (clear_mouse_face (hlinfo))
29217 cursor = No_Cursor;
29219 if (!row->reversed_p)
29221 hlinfo->mouse_face_beg_col = hpos;
29222 hlinfo->mouse_face_beg_x = original_x_pixel
29223 - (total_pixel_width + dx);
29224 hlinfo->mouse_face_end_col = hpos + gseq_length;
29225 hlinfo->mouse_face_end_x = 0;
29227 else
29229 /* In R2L rows, show_mouse_face expects BEG and END
29230 coordinates to be swapped. */
29231 hlinfo->mouse_face_end_col = hpos;
29232 hlinfo->mouse_face_end_x = original_x_pixel
29233 - (total_pixel_width + dx);
29234 hlinfo->mouse_face_beg_col = hpos + gseq_length;
29235 hlinfo->mouse_face_beg_x = 0;
29238 hlinfo->mouse_face_beg_row = vpos;
29239 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
29240 hlinfo->mouse_face_past_end = 0;
29241 hlinfo->mouse_face_window = window;
29243 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
29244 charpos,
29245 0, &ignore,
29246 glyph->face_id,
29248 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29250 if (NILP (pointer))
29251 pointer = Qhand;
29253 else if ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29254 clear_mouse_face (hlinfo);
29256 #ifdef HAVE_WINDOW_SYSTEM
29257 if (FRAME_WINDOW_P (f))
29258 define_frame_cursor1 (f, cursor, pointer);
29259 #endif
29263 /* EXPORT:
29264 Take proper action when the mouse has moved to position X, Y on
29265 frame F with regards to highlighting portions of display that have
29266 mouse-face properties. Also de-highlight portions of display where
29267 the mouse was before, set the mouse pointer shape as appropriate
29268 for the mouse coordinates, and activate help echo (tooltips).
29269 X and Y can be negative or out of range. */
29271 void
29272 note_mouse_highlight (struct frame *f, int x, int y)
29274 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29275 enum window_part part = ON_NOTHING;
29276 Lisp_Object window;
29277 struct window *w;
29278 Cursor cursor = No_Cursor;
29279 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
29280 struct buffer *b;
29282 /* When a menu is active, don't highlight because this looks odd. */
29283 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29284 if (popup_activated ())
29285 return;
29286 #endif
29288 if (!f->glyphs_initialized_p
29289 || f->pointer_invisible)
29290 return;
29292 hlinfo->mouse_face_mouse_x = x;
29293 hlinfo->mouse_face_mouse_y = y;
29294 hlinfo->mouse_face_mouse_frame = f;
29296 if (hlinfo->mouse_face_defer)
29297 return;
29299 /* Which window is that in? */
29300 window = window_from_coordinates (f, x, y, &part, 1);
29302 /* If displaying active text in another window, clear that. */
29303 if (! EQ (window, hlinfo->mouse_face_window)
29304 /* Also clear if we move out of text area in same window. */
29305 || (!NILP (hlinfo->mouse_face_window)
29306 && !NILP (window)
29307 && part != ON_TEXT
29308 && part != ON_MODE_LINE
29309 && part != ON_HEADER_LINE))
29310 clear_mouse_face (hlinfo);
29312 /* Not on a window -> return. */
29313 if (!WINDOWP (window))
29314 return;
29316 /* Reset help_echo_string. It will get recomputed below. */
29317 help_echo_string = Qnil;
29319 /* Convert to window-relative pixel coordinates. */
29320 w = XWINDOW (window);
29321 frame_to_window_pixel_xy (w, &x, &y);
29323 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29324 /* Handle tool-bar window differently since it doesn't display a
29325 buffer. */
29326 if (EQ (window, f->tool_bar_window))
29328 note_tool_bar_highlight (f, x, y);
29329 return;
29331 #endif
29333 /* Mouse is on the mode, header line or margin? */
29334 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
29335 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29337 note_mode_line_or_margin_highlight (window, x, y, part);
29339 #ifdef HAVE_WINDOW_SYSTEM
29340 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29342 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29343 /* Show non-text cursor (Bug#16647). */
29344 goto set_cursor;
29346 else
29347 #endif
29348 return;
29351 #ifdef HAVE_WINDOW_SYSTEM
29352 if (part == ON_VERTICAL_BORDER)
29354 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29355 help_echo_string = build_string ("drag-mouse-1: resize");
29357 else if (part == ON_RIGHT_DIVIDER)
29359 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29360 help_echo_string = build_string ("drag-mouse-1: resize");
29362 else if (part == ON_BOTTOM_DIVIDER)
29363 if (! WINDOW_BOTTOMMOST_P (w)
29364 || minibuf_level
29365 || NILP (Vresize_mini_windows))
29367 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29368 help_echo_string = build_string ("drag-mouse-1: resize");
29370 else
29371 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29372 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
29373 || part == ON_VERTICAL_SCROLL_BAR
29374 || part == ON_HORIZONTAL_SCROLL_BAR)
29375 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29376 else
29377 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29378 #endif
29380 /* Are we in a window whose display is up to date?
29381 And verify the buffer's text has not changed. */
29382 b = XBUFFER (w->contents);
29383 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
29385 int hpos, vpos, dx, dy, area = LAST_AREA;
29386 ptrdiff_t pos;
29387 struct glyph *glyph;
29388 Lisp_Object object;
29389 Lisp_Object mouse_face = Qnil, position;
29390 Lisp_Object *overlay_vec = NULL;
29391 ptrdiff_t i, noverlays;
29392 struct buffer *obuf;
29393 ptrdiff_t obegv, ozv;
29394 int same_region;
29396 /* Find the glyph under X/Y. */
29397 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
29399 #ifdef HAVE_WINDOW_SYSTEM
29400 /* Look for :pointer property on image. */
29401 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
29403 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
29404 if (img != NULL && IMAGEP (img->spec))
29406 Lisp_Object image_map, hotspot;
29407 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
29408 !NILP (image_map))
29409 && (hotspot = find_hot_spot (image_map,
29410 glyph->slice.img.x + dx,
29411 glyph->slice.img.y + dy),
29412 CONSP (hotspot))
29413 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29415 Lisp_Object plist;
29417 /* Could check XCAR (hotspot) to see if we enter/leave
29418 this hot-spot.
29419 If so, we could look for mouse-enter, mouse-leave
29420 properties in PLIST (and do something...). */
29421 hotspot = XCDR (hotspot);
29422 if (CONSP (hotspot)
29423 && (plist = XCAR (hotspot), CONSP (plist)))
29425 pointer = Fplist_get (plist, Qpointer);
29426 if (NILP (pointer))
29427 pointer = Qhand;
29428 help_echo_string = Fplist_get (plist, Qhelp_echo);
29429 if (!NILP (help_echo_string))
29431 help_echo_window = window;
29432 help_echo_object = glyph->object;
29433 help_echo_pos = glyph->charpos;
29437 if (NILP (pointer))
29438 pointer = Fplist_get (XCDR (img->spec), QCpointer);
29441 #endif /* HAVE_WINDOW_SYSTEM */
29443 /* Clear mouse face if X/Y not over text. */
29444 if (glyph == NULL
29445 || area != TEXT_AREA
29446 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
29447 /* Glyph's OBJECT is an integer for glyphs inserted by the
29448 display engine for its internal purposes, like truncation
29449 and continuation glyphs and blanks beyond the end of
29450 line's text on text terminals. If we are over such a
29451 glyph, we are not over any text. */
29452 || INTEGERP (glyph->object)
29453 /* R2L rows have a stretch glyph at their front, which
29454 stands for no text, whereas L2R rows have no glyphs at
29455 all beyond the end of text. Treat such stretch glyphs
29456 like we do with NULL glyphs in L2R rows. */
29457 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
29458 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
29459 && glyph->type == STRETCH_GLYPH
29460 && glyph->avoid_cursor_p))
29462 if (clear_mouse_face (hlinfo))
29463 cursor = No_Cursor;
29464 #ifdef HAVE_WINDOW_SYSTEM
29465 if (FRAME_WINDOW_P (f) && NILP (pointer))
29467 if (area != TEXT_AREA)
29468 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29469 else
29470 pointer = Vvoid_text_area_pointer;
29472 #endif
29473 goto set_cursor;
29476 pos = glyph->charpos;
29477 object = glyph->object;
29478 if (!STRINGP (object) && !BUFFERP (object))
29479 goto set_cursor;
29481 /* If we get an out-of-range value, return now; avoid an error. */
29482 if (BUFFERP (object) && pos > BUF_Z (b))
29483 goto set_cursor;
29485 /* Make the window's buffer temporarily current for
29486 overlays_at and compute_char_face. */
29487 obuf = current_buffer;
29488 current_buffer = b;
29489 obegv = BEGV;
29490 ozv = ZV;
29491 BEGV = BEG;
29492 ZV = Z;
29494 /* Is this char mouse-active or does it have help-echo? */
29495 position = make_number (pos);
29497 USE_SAFE_ALLOCA;
29499 if (BUFFERP (object))
29501 /* Put all the overlays we want in a vector in overlay_vec. */
29502 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, 0);
29503 /* Sort overlays into increasing priority order. */
29504 noverlays = sort_overlays (overlay_vec, noverlays, w);
29506 else
29507 noverlays = 0;
29509 if (NILP (Vmouse_highlight))
29511 clear_mouse_face (hlinfo);
29512 goto check_help_echo;
29515 same_region = coords_in_mouse_face_p (w, hpos, vpos);
29517 if (same_region)
29518 cursor = No_Cursor;
29520 /* Check mouse-face highlighting. */
29521 if (! same_region
29522 /* If there exists an overlay with mouse-face overlapping
29523 the one we are currently highlighting, we have to
29524 check if we enter the overlapping overlay, and then
29525 highlight only that. */
29526 || (OVERLAYP (hlinfo->mouse_face_overlay)
29527 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
29529 /* Find the highest priority overlay with a mouse-face. */
29530 Lisp_Object overlay = Qnil;
29531 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
29533 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
29534 if (!NILP (mouse_face))
29535 overlay = overlay_vec[i];
29538 /* If we're highlighting the same overlay as before, there's
29539 no need to do that again. */
29540 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
29541 goto check_help_echo;
29542 hlinfo->mouse_face_overlay = overlay;
29544 /* Clear the display of the old active region, if any. */
29545 if (clear_mouse_face (hlinfo))
29546 cursor = No_Cursor;
29548 /* If no overlay applies, get a text property. */
29549 if (NILP (overlay))
29550 mouse_face = Fget_text_property (position, Qmouse_face, object);
29552 /* Next, compute the bounds of the mouse highlighting and
29553 display it. */
29554 if (!NILP (mouse_face) && STRINGP (object))
29556 /* The mouse-highlighting comes from a display string
29557 with a mouse-face. */
29558 Lisp_Object s, e;
29559 ptrdiff_t ignore;
29561 s = Fprevious_single_property_change
29562 (make_number (pos + 1), Qmouse_face, object, Qnil);
29563 e = Fnext_single_property_change
29564 (position, Qmouse_face, object, Qnil);
29565 if (NILP (s))
29566 s = make_number (0);
29567 if (NILP (e))
29568 e = make_number (SCHARS (object));
29569 mouse_face_from_string_pos (w, hlinfo, object,
29570 XINT (s), XINT (e));
29571 hlinfo->mouse_face_past_end = 0;
29572 hlinfo->mouse_face_window = window;
29573 hlinfo->mouse_face_face_id
29574 = face_at_string_position (w, object, pos, 0, &ignore,
29575 glyph->face_id, 1);
29576 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29577 cursor = No_Cursor;
29579 else
29581 /* The mouse-highlighting, if any, comes from an overlay
29582 or text property in the buffer. */
29583 Lisp_Object buffer IF_LINT (= Qnil);
29584 Lisp_Object disp_string IF_LINT (= Qnil);
29586 if (STRINGP (object))
29588 /* If we are on a display string with no mouse-face,
29589 check if the text under it has one. */
29590 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
29591 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29592 pos = string_buffer_position (object, start);
29593 if (pos > 0)
29595 mouse_face = get_char_property_and_overlay
29596 (make_number (pos), Qmouse_face, w->contents, &overlay);
29597 buffer = w->contents;
29598 disp_string = object;
29601 else
29603 buffer = object;
29604 disp_string = Qnil;
29607 if (!NILP (mouse_face))
29609 Lisp_Object before, after;
29610 Lisp_Object before_string, after_string;
29611 /* To correctly find the limits of mouse highlight
29612 in a bidi-reordered buffer, we must not use the
29613 optimization of limiting the search in
29614 previous-single-property-change and
29615 next-single-property-change, because
29616 rows_from_pos_range needs the real start and end
29617 positions to DTRT in this case. That's because
29618 the first row visible in a window does not
29619 necessarily display the character whose position
29620 is the smallest. */
29621 Lisp_Object lim1
29622 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29623 ? Fmarker_position (w->start)
29624 : Qnil;
29625 Lisp_Object lim2
29626 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29627 ? make_number (BUF_Z (XBUFFER (buffer))
29628 - w->window_end_pos)
29629 : Qnil;
29631 if (NILP (overlay))
29633 /* Handle the text property case. */
29634 before = Fprevious_single_property_change
29635 (make_number (pos + 1), Qmouse_face, buffer, lim1);
29636 after = Fnext_single_property_change
29637 (make_number (pos), Qmouse_face, buffer, lim2);
29638 before_string = after_string = Qnil;
29640 else
29642 /* Handle the overlay case. */
29643 before = Foverlay_start (overlay);
29644 after = Foverlay_end (overlay);
29645 before_string = Foverlay_get (overlay, Qbefore_string);
29646 after_string = Foverlay_get (overlay, Qafter_string);
29648 if (!STRINGP (before_string)) before_string = Qnil;
29649 if (!STRINGP (after_string)) after_string = Qnil;
29652 mouse_face_from_buffer_pos (window, hlinfo, pos,
29653 NILP (before)
29655 : XFASTINT (before),
29656 NILP (after)
29657 ? BUF_Z (XBUFFER (buffer))
29658 : XFASTINT (after),
29659 before_string, after_string,
29660 disp_string);
29661 cursor = No_Cursor;
29666 check_help_echo:
29668 /* Look for a `help-echo' property. */
29669 if (NILP (help_echo_string)) {
29670 Lisp_Object help, overlay;
29672 /* Check overlays first. */
29673 help = overlay = Qnil;
29674 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
29676 overlay = overlay_vec[i];
29677 help = Foverlay_get (overlay, Qhelp_echo);
29680 if (!NILP (help))
29682 help_echo_string = help;
29683 help_echo_window = window;
29684 help_echo_object = overlay;
29685 help_echo_pos = pos;
29687 else
29689 Lisp_Object obj = glyph->object;
29690 ptrdiff_t charpos = glyph->charpos;
29692 /* Try text properties. */
29693 if (STRINGP (obj)
29694 && charpos >= 0
29695 && charpos < SCHARS (obj))
29697 help = Fget_text_property (make_number (charpos),
29698 Qhelp_echo, obj);
29699 if (NILP (help))
29701 /* If the string itself doesn't specify a help-echo,
29702 see if the buffer text ``under'' it does. */
29703 struct glyph_row *r
29704 = MATRIX_ROW (w->current_matrix, vpos);
29705 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29706 ptrdiff_t p = string_buffer_position (obj, start);
29707 if (p > 0)
29709 help = Fget_char_property (make_number (p),
29710 Qhelp_echo, w->contents);
29711 if (!NILP (help))
29713 charpos = p;
29714 obj = w->contents;
29719 else if (BUFFERP (obj)
29720 && charpos >= BEGV
29721 && charpos < ZV)
29722 help = Fget_text_property (make_number (charpos), Qhelp_echo,
29723 obj);
29725 if (!NILP (help))
29727 help_echo_string = help;
29728 help_echo_window = window;
29729 help_echo_object = obj;
29730 help_echo_pos = charpos;
29735 #ifdef HAVE_WINDOW_SYSTEM
29736 /* Look for a `pointer' property. */
29737 if (FRAME_WINDOW_P (f) && NILP (pointer))
29739 /* Check overlays first. */
29740 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
29741 pointer = Foverlay_get (overlay_vec[i], Qpointer);
29743 if (NILP (pointer))
29745 Lisp_Object obj = glyph->object;
29746 ptrdiff_t charpos = glyph->charpos;
29748 /* Try text properties. */
29749 if (STRINGP (obj)
29750 && charpos >= 0
29751 && charpos < SCHARS (obj))
29753 pointer = Fget_text_property (make_number (charpos),
29754 Qpointer, obj);
29755 if (NILP (pointer))
29757 /* If the string itself doesn't specify a pointer,
29758 see if the buffer text ``under'' it does. */
29759 struct glyph_row *r
29760 = MATRIX_ROW (w->current_matrix, vpos);
29761 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29762 ptrdiff_t p = string_buffer_position (obj, start);
29763 if (p > 0)
29764 pointer = Fget_char_property (make_number (p),
29765 Qpointer, w->contents);
29768 else if (BUFFERP (obj)
29769 && charpos >= BEGV
29770 && charpos < ZV)
29771 pointer = Fget_text_property (make_number (charpos),
29772 Qpointer, obj);
29775 #endif /* HAVE_WINDOW_SYSTEM */
29777 BEGV = obegv;
29778 ZV = ozv;
29779 current_buffer = obuf;
29780 SAFE_FREE ();
29783 set_cursor:
29785 #ifdef HAVE_WINDOW_SYSTEM
29786 if (FRAME_WINDOW_P (f))
29787 define_frame_cursor1 (f, cursor, pointer);
29788 #else
29789 /* This is here to prevent a compiler error, about "label at end of
29790 compound statement". */
29791 return;
29792 #endif
29796 /* EXPORT for RIF:
29797 Clear any mouse-face on window W. This function is part of the
29798 redisplay interface, and is called from try_window_id and similar
29799 functions to ensure the mouse-highlight is off. */
29801 void
29802 x_clear_window_mouse_face (struct window *w)
29804 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
29805 Lisp_Object window;
29807 block_input ();
29808 XSETWINDOW (window, w);
29809 if (EQ (window, hlinfo->mouse_face_window))
29810 clear_mouse_face (hlinfo);
29811 unblock_input ();
29815 /* EXPORT:
29816 Just discard the mouse face information for frame F, if any.
29817 This is used when the size of F is changed. */
29819 void
29820 cancel_mouse_face (struct frame *f)
29822 Lisp_Object window;
29823 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29825 window = hlinfo->mouse_face_window;
29826 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
29827 reset_mouse_highlight (hlinfo);
29832 /***********************************************************************
29833 Exposure Events
29834 ***********************************************************************/
29836 #ifdef HAVE_WINDOW_SYSTEM
29838 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29839 which intersects rectangle R. R is in window-relative coordinates. */
29841 static void
29842 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
29843 enum glyph_row_area area)
29845 struct glyph *first = row->glyphs[area];
29846 struct glyph *end = row->glyphs[area] + row->used[area];
29847 struct glyph *last;
29848 int first_x, start_x, x;
29850 if (area == TEXT_AREA && row->fill_line_p)
29851 /* If row extends face to end of line write the whole line. */
29852 draw_glyphs (w, 0, row, area,
29853 0, row->used[area],
29854 DRAW_NORMAL_TEXT, 0);
29855 else
29857 /* Set START_X to the window-relative start position for drawing glyphs of
29858 AREA. The first glyph of the text area can be partially visible.
29859 The first glyphs of other areas cannot. */
29860 start_x = window_box_left_offset (w, area);
29861 x = start_x;
29862 if (area == TEXT_AREA)
29863 x += row->x;
29865 /* Find the first glyph that must be redrawn. */
29866 while (first < end
29867 && x + first->pixel_width < r->x)
29869 x += first->pixel_width;
29870 ++first;
29873 /* Find the last one. */
29874 last = first;
29875 first_x = x;
29876 while (last < end
29877 && x < r->x + r->width)
29879 x += last->pixel_width;
29880 ++last;
29883 /* Repaint. */
29884 if (last > first)
29885 draw_glyphs (w, first_x - start_x, row, area,
29886 first - row->glyphs[area], last - row->glyphs[area],
29887 DRAW_NORMAL_TEXT, 0);
29892 /* Redraw the parts of the glyph row ROW on window W intersecting
29893 rectangle R. R is in window-relative coordinates. Value is
29894 non-zero if mouse-face was overwritten. */
29896 static int
29897 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
29899 eassert (row->enabled_p);
29901 if (row->mode_line_p || w->pseudo_window_p)
29902 draw_glyphs (w, 0, row, TEXT_AREA,
29903 0, row->used[TEXT_AREA],
29904 DRAW_NORMAL_TEXT, 0);
29905 else
29907 if (row->used[LEFT_MARGIN_AREA])
29908 expose_area (w, row, r, LEFT_MARGIN_AREA);
29909 if (row->used[TEXT_AREA])
29910 expose_area (w, row, r, TEXT_AREA);
29911 if (row->used[RIGHT_MARGIN_AREA])
29912 expose_area (w, row, r, RIGHT_MARGIN_AREA);
29913 draw_row_fringe_bitmaps (w, row);
29916 return row->mouse_face_p;
29920 /* Redraw those parts of glyphs rows during expose event handling that
29921 overlap other rows. Redrawing of an exposed line writes over parts
29922 of lines overlapping that exposed line; this function fixes that.
29924 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29925 row in W's current matrix that is exposed and overlaps other rows.
29926 LAST_OVERLAPPING_ROW is the last such row. */
29928 static void
29929 expose_overlaps (struct window *w,
29930 struct glyph_row *first_overlapping_row,
29931 struct glyph_row *last_overlapping_row,
29932 XRectangle *r)
29934 struct glyph_row *row;
29936 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
29937 if (row->overlapping_p)
29939 eassert (row->enabled_p && !row->mode_line_p);
29941 row->clip = r;
29942 if (row->used[LEFT_MARGIN_AREA])
29943 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
29945 if (row->used[TEXT_AREA])
29946 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
29948 if (row->used[RIGHT_MARGIN_AREA])
29949 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
29950 row->clip = NULL;
29955 /* Return non-zero if W's cursor intersects rectangle R. */
29957 static int
29958 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
29960 XRectangle cr, result;
29961 struct glyph *cursor_glyph;
29962 struct glyph_row *row;
29964 if (w->phys_cursor.vpos >= 0
29965 && w->phys_cursor.vpos < w->current_matrix->nrows
29966 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
29967 row->enabled_p)
29968 && row->cursor_in_fringe_p)
29970 /* Cursor is in the fringe. */
29971 cr.x = window_box_right_offset (w,
29972 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
29973 ? RIGHT_MARGIN_AREA
29974 : TEXT_AREA));
29975 cr.y = row->y;
29976 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
29977 cr.height = row->height;
29978 return x_intersect_rectangles (&cr, r, &result);
29981 cursor_glyph = get_phys_cursor_glyph (w);
29982 if (cursor_glyph)
29984 /* r is relative to W's box, but w->phys_cursor.x is relative
29985 to left edge of W's TEXT area. Adjust it. */
29986 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
29987 cr.y = w->phys_cursor.y;
29988 cr.width = cursor_glyph->pixel_width;
29989 cr.height = w->phys_cursor_height;
29990 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29991 I assume the effect is the same -- and this is portable. */
29992 return x_intersect_rectangles (&cr, r, &result);
29994 /* If we don't understand the format, pretend we're not in the hot-spot. */
29995 return 0;
29999 /* EXPORT:
30000 Draw a vertical window border to the right of window W if W doesn't
30001 have vertical scroll bars. */
30003 void
30004 x_draw_vertical_border (struct window *w)
30006 struct frame *f = XFRAME (WINDOW_FRAME (w));
30008 /* We could do better, if we knew what type of scroll-bar the adjacent
30009 windows (on either side) have... But we don't :-(
30010 However, I think this works ok. ++KFS 2003-04-25 */
30012 /* Redraw borders between horizontally adjacent windows. Don't
30013 do it for frames with vertical scroll bars because either the
30014 right scroll bar of a window, or the left scroll bar of its
30015 neighbor will suffice as a border. */
30016 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
30017 return;
30019 /* Note: It is necessary to redraw both the left and the right
30020 borders, for when only this single window W is being
30021 redisplayed. */
30022 if (!WINDOW_RIGHTMOST_P (w)
30023 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
30025 int x0, x1, y0, y1;
30027 window_box_edges (w, &x0, &y0, &x1, &y1);
30028 y1 -= 1;
30030 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30031 x1 -= 1;
30033 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
30036 if (!WINDOW_LEFTMOST_P (w)
30037 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
30039 int x0, x1, y0, y1;
30041 window_box_edges (w, &x0, &y0, &x1, &y1);
30042 y1 -= 1;
30044 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
30045 x0 -= 1;
30047 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
30052 /* Draw window dividers for window W. */
30054 void
30055 x_draw_right_divider (struct window *w)
30057 struct frame *f = WINDOW_XFRAME (w);
30059 if (w->mini || w->pseudo_window_p)
30060 return;
30061 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30063 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
30064 int x1 = WINDOW_RIGHT_EDGE_X (w);
30065 int y0 = WINDOW_TOP_EDGE_Y (w);
30066 /* The bottom divider prevails. */
30067 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30069 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30073 static void
30074 x_draw_bottom_divider (struct window *w)
30076 struct frame *f = XFRAME (WINDOW_FRAME (w));
30078 if (w->mini || w->pseudo_window_p)
30079 return;
30080 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30082 int x0 = WINDOW_LEFT_EDGE_X (w);
30083 int x1 = WINDOW_RIGHT_EDGE_X (w);
30084 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
30085 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
30087 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
30091 /* Redraw the part of window W intersection rectangle FR. Pixel
30092 coordinates in FR are frame-relative. Call this function with
30093 input blocked. Value is non-zero if the exposure overwrites
30094 mouse-face. */
30096 static int
30097 expose_window (struct window *w, XRectangle *fr)
30099 struct frame *f = XFRAME (w->frame);
30100 XRectangle wr, r;
30101 int mouse_face_overwritten_p = 0;
30103 /* If window is not yet fully initialized, do nothing. This can
30104 happen when toolkit scroll bars are used and a window is split.
30105 Reconfiguring the scroll bar will generate an expose for a newly
30106 created window. */
30107 if (w->current_matrix == NULL)
30108 return 0;
30110 /* When we're currently updating the window, display and current
30111 matrix usually don't agree. Arrange for a thorough display
30112 later. */
30113 if (w->must_be_updated_p)
30115 SET_FRAME_GARBAGED (f);
30116 return 0;
30119 /* Frame-relative pixel rectangle of W. */
30120 wr.x = WINDOW_LEFT_EDGE_X (w);
30121 wr.y = WINDOW_TOP_EDGE_Y (w);
30122 wr.width = WINDOW_PIXEL_WIDTH (w);
30123 wr.height = WINDOW_PIXEL_HEIGHT (w);
30125 if (x_intersect_rectangles (fr, &wr, &r))
30127 int yb = window_text_bottom_y (w);
30128 struct glyph_row *row;
30129 int cursor_cleared_p, phys_cursor_on_p;
30130 struct glyph_row *first_overlapping_row, *last_overlapping_row;
30132 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
30133 r.x, r.y, r.width, r.height));
30135 /* Convert to window coordinates. */
30136 r.x -= WINDOW_LEFT_EDGE_X (w);
30137 r.y -= WINDOW_TOP_EDGE_Y (w);
30139 /* Turn off the cursor. */
30140 if (!w->pseudo_window_p
30141 && phys_cursor_in_rect_p (w, &r))
30143 x_clear_cursor (w);
30144 cursor_cleared_p = 1;
30146 else
30147 cursor_cleared_p = 0;
30149 /* If the row containing the cursor extends face to end of line,
30150 then expose_area might overwrite the cursor outside the
30151 rectangle and thus notice_overwritten_cursor might clear
30152 w->phys_cursor_on_p. We remember the original value and
30153 check later if it is changed. */
30154 phys_cursor_on_p = w->phys_cursor_on_p;
30156 /* Update lines intersecting rectangle R. */
30157 first_overlapping_row = last_overlapping_row = NULL;
30158 for (row = w->current_matrix->rows;
30159 row->enabled_p;
30160 ++row)
30162 int y0 = row->y;
30163 int y1 = MATRIX_ROW_BOTTOM_Y (row);
30165 if ((y0 >= r.y && y0 < r.y + r.height)
30166 || (y1 > r.y && y1 < r.y + r.height)
30167 || (r.y >= y0 && r.y < y1)
30168 || (r.y + r.height > y0 && r.y + r.height < y1))
30170 /* A header line may be overlapping, but there is no need
30171 to fix overlapping areas for them. KFS 2005-02-12 */
30172 if (row->overlapping_p && !row->mode_line_p)
30174 if (first_overlapping_row == NULL)
30175 first_overlapping_row = row;
30176 last_overlapping_row = row;
30179 row->clip = fr;
30180 if (expose_line (w, row, &r))
30181 mouse_face_overwritten_p = 1;
30182 row->clip = NULL;
30184 else if (row->overlapping_p)
30186 /* We must redraw a row overlapping the exposed area. */
30187 if (y0 < r.y
30188 ? y0 + row->phys_height > r.y
30189 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
30191 if (first_overlapping_row == NULL)
30192 first_overlapping_row = row;
30193 last_overlapping_row = row;
30197 if (y1 >= yb)
30198 break;
30201 /* Display the mode line if there is one. */
30202 if (WINDOW_WANTS_MODELINE_P (w)
30203 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
30204 row->enabled_p)
30205 && row->y < r.y + r.height)
30207 if (expose_line (w, row, &r))
30208 mouse_face_overwritten_p = 1;
30211 if (!w->pseudo_window_p)
30213 /* Fix the display of overlapping rows. */
30214 if (first_overlapping_row)
30215 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
30216 fr);
30218 /* Draw border between windows. */
30219 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30220 x_draw_right_divider (w);
30221 else
30222 x_draw_vertical_border (w);
30224 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30225 x_draw_bottom_divider (w);
30227 /* Turn the cursor on again. */
30228 if (cursor_cleared_p
30229 || (phys_cursor_on_p && !w->phys_cursor_on_p))
30230 update_window_cursor (w, 1);
30234 return mouse_face_overwritten_p;
30239 /* Redraw (parts) of all windows in the window tree rooted at W that
30240 intersect R. R contains frame pixel coordinates. Value is
30241 non-zero if the exposure overwrites mouse-face. */
30243 static int
30244 expose_window_tree (struct window *w, XRectangle *r)
30246 struct frame *f = XFRAME (w->frame);
30247 int mouse_face_overwritten_p = 0;
30249 while (w && !FRAME_GARBAGED_P (f))
30251 if (WINDOWP (w->contents))
30252 mouse_face_overwritten_p
30253 |= expose_window_tree (XWINDOW (w->contents), r);
30254 else
30255 mouse_face_overwritten_p |= expose_window (w, r);
30257 w = NILP (w->next) ? NULL : XWINDOW (w->next);
30260 return mouse_face_overwritten_p;
30264 /* EXPORT:
30265 Redisplay an exposed area of frame F. X and Y are the upper-left
30266 corner of the exposed rectangle. W and H are width and height of
30267 the exposed area. All are pixel values. W or H zero means redraw
30268 the entire frame. */
30270 void
30271 expose_frame (struct frame *f, int x, int y, int w, int h)
30273 XRectangle r;
30274 int mouse_face_overwritten_p = 0;
30276 TRACE ((stderr, "expose_frame "));
30278 /* No need to redraw if frame will be redrawn soon. */
30279 if (FRAME_GARBAGED_P (f))
30281 TRACE ((stderr, " garbaged\n"));
30282 return;
30285 /* If basic faces haven't been realized yet, there is no point in
30286 trying to redraw anything. This can happen when we get an expose
30287 event while Emacs is starting, e.g. by moving another window. */
30288 if (FRAME_FACE_CACHE (f) == NULL
30289 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
30291 TRACE ((stderr, " no faces\n"));
30292 return;
30295 if (w == 0 || h == 0)
30297 r.x = r.y = 0;
30298 r.width = FRAME_TEXT_WIDTH (f);
30299 r.height = FRAME_TEXT_HEIGHT (f);
30301 else
30303 r.x = x;
30304 r.y = y;
30305 r.width = w;
30306 r.height = h;
30309 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
30310 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
30312 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30313 if (WINDOWP (f->tool_bar_window))
30314 mouse_face_overwritten_p
30315 |= expose_window (XWINDOW (f->tool_bar_window), &r);
30316 #endif
30318 #ifdef HAVE_X_WINDOWS
30319 #ifndef MSDOS
30320 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30321 if (WINDOWP (f->menu_bar_window))
30322 mouse_face_overwritten_p
30323 |= expose_window (XWINDOW (f->menu_bar_window), &r);
30324 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30325 #endif
30326 #endif
30328 /* Some window managers support a focus-follows-mouse style with
30329 delayed raising of frames. Imagine a partially obscured frame,
30330 and moving the mouse into partially obscured mouse-face on that
30331 frame. The visible part of the mouse-face will be highlighted,
30332 then the WM raises the obscured frame. With at least one WM, KDE
30333 2.1, Emacs is not getting any event for the raising of the frame
30334 (even tried with SubstructureRedirectMask), only Expose events.
30335 These expose events will draw text normally, i.e. not
30336 highlighted. Which means we must redo the highlight here.
30337 Subsume it under ``we love X''. --gerd 2001-08-15 */
30338 /* Included in Windows version because Windows most likely does not
30339 do the right thing if any third party tool offers
30340 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30341 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
30343 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30344 if (f == hlinfo->mouse_face_mouse_frame)
30346 int mouse_x = hlinfo->mouse_face_mouse_x;
30347 int mouse_y = hlinfo->mouse_face_mouse_y;
30348 clear_mouse_face (hlinfo);
30349 note_mouse_highlight (f, mouse_x, mouse_y);
30355 /* EXPORT:
30356 Determine the intersection of two rectangles R1 and R2. Return
30357 the intersection in *RESULT. Value is non-zero if RESULT is not
30358 empty. */
30361 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
30363 XRectangle *left, *right;
30364 XRectangle *upper, *lower;
30365 int intersection_p = 0;
30367 /* Rearrange so that R1 is the left-most rectangle. */
30368 if (r1->x < r2->x)
30369 left = r1, right = r2;
30370 else
30371 left = r2, right = r1;
30373 /* X0 of the intersection is right.x0, if this is inside R1,
30374 otherwise there is no intersection. */
30375 if (right->x <= left->x + left->width)
30377 result->x = right->x;
30379 /* The right end of the intersection is the minimum of
30380 the right ends of left and right. */
30381 result->width = (min (left->x + left->width, right->x + right->width)
30382 - result->x);
30384 /* Same game for Y. */
30385 if (r1->y < r2->y)
30386 upper = r1, lower = r2;
30387 else
30388 upper = r2, lower = r1;
30390 /* The upper end of the intersection is lower.y0, if this is inside
30391 of upper. Otherwise, there is no intersection. */
30392 if (lower->y <= upper->y + upper->height)
30394 result->y = lower->y;
30396 /* The lower end of the intersection is the minimum of the lower
30397 ends of upper and lower. */
30398 result->height = (min (lower->y + lower->height,
30399 upper->y + upper->height)
30400 - result->y);
30401 intersection_p = 1;
30405 return intersection_p;
30408 #endif /* HAVE_WINDOW_SYSTEM */
30411 /***********************************************************************
30412 Initialization
30413 ***********************************************************************/
30415 void
30416 syms_of_xdisp (void)
30418 Vwith_echo_area_save_vector = Qnil;
30419 staticpro (&Vwith_echo_area_save_vector);
30421 Vmessage_stack = Qnil;
30422 staticpro (&Vmessage_stack);
30424 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
30425 DEFSYM (Qredisplay_internal, "redisplay_internal (C function)");
30427 message_dolog_marker1 = Fmake_marker ();
30428 staticpro (&message_dolog_marker1);
30429 message_dolog_marker2 = Fmake_marker ();
30430 staticpro (&message_dolog_marker2);
30431 message_dolog_marker3 = Fmake_marker ();
30432 staticpro (&message_dolog_marker3);
30434 #ifdef GLYPH_DEBUG
30435 defsubr (&Sdump_frame_glyph_matrix);
30436 defsubr (&Sdump_glyph_matrix);
30437 defsubr (&Sdump_glyph_row);
30438 defsubr (&Sdump_tool_bar_row);
30439 defsubr (&Strace_redisplay);
30440 defsubr (&Strace_to_stderr);
30441 #endif
30442 #ifdef HAVE_WINDOW_SYSTEM
30443 defsubr (&Stool_bar_height);
30444 defsubr (&Slookup_image_map);
30445 #endif
30446 defsubr (&Sline_pixel_height);
30447 defsubr (&Sformat_mode_line);
30448 defsubr (&Sinvisible_p);
30449 defsubr (&Scurrent_bidi_paragraph_direction);
30450 defsubr (&Swindow_text_pixel_size);
30451 defsubr (&Smove_point_visually);
30453 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
30454 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
30455 DEFSYM (Qoverriding_local_map, "overriding-local-map");
30456 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
30457 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
30458 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
30459 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
30460 DEFSYM (Qeval, "eval");
30461 DEFSYM (QCdata, ":data");
30462 DEFSYM (Qdisplay, "display");
30463 DEFSYM (Qspace_width, "space-width");
30464 DEFSYM (Qraise, "raise");
30465 DEFSYM (Qslice, "slice");
30466 DEFSYM (Qspace, "space");
30467 DEFSYM (Qmargin, "margin");
30468 DEFSYM (Qpointer, "pointer");
30469 DEFSYM (Qleft_margin, "left-margin");
30470 DEFSYM (Qright_margin, "right-margin");
30471 DEFSYM (Qcenter, "center");
30472 DEFSYM (Qline_height, "line-height");
30473 DEFSYM (QCalign_to, ":align-to");
30474 DEFSYM (QCrelative_width, ":relative-width");
30475 DEFSYM (QCrelative_height, ":relative-height");
30476 DEFSYM (QCeval, ":eval");
30477 DEFSYM (QCpropertize, ":propertize");
30478 DEFSYM (QCfile, ":file");
30479 DEFSYM (Qfontified, "fontified");
30480 DEFSYM (Qfontification_functions, "fontification-functions");
30481 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
30482 DEFSYM (Qescape_glyph, "escape-glyph");
30483 DEFSYM (Qnobreak_space, "nobreak-space");
30484 DEFSYM (Qimage, "image");
30485 DEFSYM (Qtext, "text");
30486 DEFSYM (Qboth, "both");
30487 DEFSYM (Qboth_horiz, "both-horiz");
30488 DEFSYM (Qtext_image_horiz, "text-image-horiz");
30489 DEFSYM (QCmap, ":map");
30490 DEFSYM (QCpointer, ":pointer");
30491 DEFSYM (Qrect, "rect");
30492 DEFSYM (Qcircle, "circle");
30493 DEFSYM (Qpoly, "poly");
30494 DEFSYM (Qmessage_truncate_lines, "message-truncate-lines");
30495 DEFSYM (Qgrow_only, "grow-only");
30496 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
30497 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
30498 DEFSYM (Qposition, "position");
30499 DEFSYM (Qbuffer_position, "buffer-position");
30500 DEFSYM (Qobject, "object");
30501 DEFSYM (Qbar, "bar");
30502 DEFSYM (Qhbar, "hbar");
30503 DEFSYM (Qbox, "box");
30504 DEFSYM (Qhollow, "hollow");
30505 DEFSYM (Qhand, "hand");
30506 DEFSYM (Qarrow, "arrow");
30507 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
30509 list_of_error = list1 (list2 (intern_c_string ("error"),
30510 intern_c_string ("void-variable")));
30511 staticpro (&list_of_error);
30513 DEFSYM (Qlast_arrow_position, "last-arrow-position");
30514 DEFSYM (Qlast_arrow_string, "last-arrow-string");
30515 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
30516 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
30518 echo_buffer[0] = echo_buffer[1] = Qnil;
30519 staticpro (&echo_buffer[0]);
30520 staticpro (&echo_buffer[1]);
30522 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
30523 staticpro (&echo_area_buffer[0]);
30524 staticpro (&echo_area_buffer[1]);
30526 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
30527 staticpro (&Vmessages_buffer_name);
30529 mode_line_proptrans_alist = Qnil;
30530 staticpro (&mode_line_proptrans_alist);
30531 mode_line_string_list = Qnil;
30532 staticpro (&mode_line_string_list);
30533 mode_line_string_face = Qnil;
30534 staticpro (&mode_line_string_face);
30535 mode_line_string_face_prop = Qnil;
30536 staticpro (&mode_line_string_face_prop);
30537 Vmode_line_unwind_vector = Qnil;
30538 staticpro (&Vmode_line_unwind_vector);
30540 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
30542 help_echo_string = Qnil;
30543 staticpro (&help_echo_string);
30544 help_echo_object = Qnil;
30545 staticpro (&help_echo_object);
30546 help_echo_window = Qnil;
30547 staticpro (&help_echo_window);
30548 previous_help_echo_string = Qnil;
30549 staticpro (&previous_help_echo_string);
30550 help_echo_pos = -1;
30552 DEFSYM (Qright_to_left, "right-to-left");
30553 DEFSYM (Qleft_to_right, "left-to-right");
30554 defsubr (&Sbidi_resolved_levels);
30556 #ifdef HAVE_WINDOW_SYSTEM
30557 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
30558 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
30559 For example, if a block cursor is over a tab, it will be drawn as
30560 wide as that tab on the display. */);
30561 x_stretch_cursor_p = 0;
30562 #endif
30564 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
30565 doc: /* Non-nil means highlight trailing whitespace.
30566 The face used for trailing whitespace is `trailing-whitespace'. */);
30567 Vshow_trailing_whitespace = Qnil;
30569 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
30570 doc: /* Control highlighting of non-ASCII space and hyphen chars.
30571 If the value is t, Emacs highlights non-ASCII chars which have the
30572 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30573 or `escape-glyph' face respectively.
30575 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30576 U+2011 (non-breaking hyphen) are affected.
30578 Any other non-nil value means to display these characters as a escape
30579 glyph followed by an ordinary space or hyphen.
30581 A value of nil means no special handling of these characters. */);
30582 Vnobreak_char_display = Qt;
30584 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
30585 doc: /* The pointer shape to show in void text areas.
30586 A value of nil means to show the text pointer. Other options are
30587 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30588 `hourglass'. */);
30589 Vvoid_text_area_pointer = Qarrow;
30591 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
30592 doc: /* Non-nil means don't actually do any redisplay.
30593 This is used for internal purposes. */);
30594 Vinhibit_redisplay = Qnil;
30596 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
30597 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30598 Vglobal_mode_string = Qnil;
30600 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
30601 doc: /* Marker for where to display an arrow on top of the buffer text.
30602 This must be the beginning of a line in order to work.
30603 See also `overlay-arrow-string'. */);
30604 Voverlay_arrow_position = Qnil;
30606 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
30607 doc: /* String to display as an arrow in non-window frames.
30608 See also `overlay-arrow-position'. */);
30609 Voverlay_arrow_string = build_pure_c_string ("=>");
30611 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
30612 doc: /* List of variables (symbols) which hold markers for overlay arrows.
30613 The symbols on this list are examined during redisplay to determine
30614 where to display overlay arrows. */);
30615 Voverlay_arrow_variable_list
30616 = list1 (intern_c_string ("overlay-arrow-position"));
30618 DEFVAR_INT ("scroll-step", emacs_scroll_step,
30619 doc: /* The number of lines to try scrolling a window by when point moves out.
30620 If that fails to bring point back on frame, point is centered instead.
30621 If this is zero, point is always centered after it moves off frame.
30622 If you want scrolling to always be a line at a time, you should set
30623 `scroll-conservatively' to a large value rather than set this to 1. */);
30625 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
30626 doc: /* Scroll up to this many lines, to bring point back on screen.
30627 If point moves off-screen, redisplay will scroll by up to
30628 `scroll-conservatively' lines in order to bring point just barely
30629 onto the screen again. If that cannot be done, then redisplay
30630 recenters point as usual.
30632 If the value is greater than 100, redisplay will never recenter point,
30633 but will always scroll just enough text to bring point into view, even
30634 if you move far away.
30636 A value of zero means always recenter point if it moves off screen. */);
30637 scroll_conservatively = 0;
30639 DEFVAR_INT ("scroll-margin", scroll_margin,
30640 doc: /* Number of lines of margin at the top and bottom of a window.
30641 Recenter the window whenever point gets within this many lines
30642 of the top or bottom of the window. */);
30643 scroll_margin = 0;
30645 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
30646 doc: /* Pixels per inch value for non-window system displays.
30647 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30648 Vdisplay_pixels_per_inch = make_float (72.0);
30650 #ifdef GLYPH_DEBUG
30651 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
30652 #endif
30654 DEFVAR_LISP ("truncate-partial-width-windows",
30655 Vtruncate_partial_width_windows,
30656 doc: /* Non-nil means truncate lines in windows narrower than the frame.
30657 For an integer value, truncate lines in each window narrower than the
30658 full frame width, provided the window width is less than that integer;
30659 otherwise, respect the value of `truncate-lines'.
30661 For any other non-nil value, truncate lines in all windows that do
30662 not span the full frame width.
30664 A value of nil means to respect the value of `truncate-lines'.
30666 If `word-wrap' is enabled, you might want to reduce this. */);
30667 Vtruncate_partial_width_windows = make_number (50);
30669 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
30670 doc: /* Maximum buffer size for which line number should be displayed.
30671 If the buffer is bigger than this, the line number does not appear
30672 in the mode line. A value of nil means no limit. */);
30673 Vline_number_display_limit = Qnil;
30675 DEFVAR_INT ("line-number-display-limit-width",
30676 line_number_display_limit_width,
30677 doc: /* Maximum line width (in characters) for line number display.
30678 If the average length of the lines near point is bigger than this, then the
30679 line number may be omitted from the mode line. */);
30680 line_number_display_limit_width = 200;
30682 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
30683 doc: /* Non-nil means highlight region even in nonselected windows. */);
30684 highlight_nonselected_windows = 0;
30686 DEFVAR_BOOL ("multiple-frames", multiple_frames,
30687 doc: /* Non-nil if more than one frame is visible on this display.
30688 Minibuffer-only frames don't count, but iconified frames do.
30689 This variable is not guaranteed to be accurate except while processing
30690 `frame-title-format' and `icon-title-format'. */);
30692 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
30693 doc: /* Template for displaying the title bar of visible frames.
30694 \(Assuming the window manager supports this feature.)
30696 This variable has the same structure as `mode-line-format', except that
30697 the %c and %l constructs are ignored. It is used only on frames for
30698 which no explicit name has been set \(see `modify-frame-parameters'). */);
30700 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
30701 doc: /* Template for displaying the title bar of an iconified frame.
30702 \(Assuming the window manager supports this feature.)
30703 This variable has the same structure as `mode-line-format' (which see),
30704 and is used only on frames for which no explicit name has been set
30705 \(see `modify-frame-parameters'). */);
30706 Vicon_title_format
30707 = Vframe_title_format
30708 = listn (CONSTYPE_PURE, 3,
30709 intern_c_string ("multiple-frames"),
30710 build_pure_c_string ("%b"),
30711 listn (CONSTYPE_PURE, 4,
30712 empty_unibyte_string,
30713 intern_c_string ("invocation-name"),
30714 build_pure_c_string ("@"),
30715 intern_c_string ("system-name")));
30717 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
30718 doc: /* Maximum number of lines to keep in the message log buffer.
30719 If nil, disable message logging. If t, log messages but don't truncate
30720 the buffer when it becomes large. */);
30721 Vmessage_log_max = make_number (1000);
30723 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
30724 doc: /* Functions called before redisplay, if window sizes have changed.
30725 The value should be a list of functions that take one argument.
30726 Just before redisplay, for each frame, if any of its windows have changed
30727 size since the last redisplay, or have been split or deleted,
30728 all the functions in the list are called, with the frame as argument. */);
30729 Vwindow_size_change_functions = Qnil;
30731 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
30732 doc: /* List of functions to call before redisplaying a window with scrolling.
30733 Each function is called with two arguments, the window and its new
30734 display-start position. Note that these functions are also called by
30735 `set-window-buffer'. Also note that the value of `window-end' is not
30736 valid when these functions are called.
30738 Warning: Do not use this feature to alter the way the window
30739 is scrolled. It is not designed for that, and such use probably won't
30740 work. */);
30741 Vwindow_scroll_functions = Qnil;
30743 DEFVAR_LISP ("window-text-change-functions",
30744 Vwindow_text_change_functions,
30745 doc: /* Functions to call in redisplay when text in the window might change. */);
30746 Vwindow_text_change_functions = Qnil;
30748 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
30749 doc: /* Functions called when redisplay of a window reaches the end trigger.
30750 Each function is called with two arguments, the window and the end trigger value.
30751 See `set-window-redisplay-end-trigger'. */);
30752 Vredisplay_end_trigger_functions = Qnil;
30754 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
30755 doc: /* Non-nil means autoselect window with mouse pointer.
30756 If nil, do not autoselect windows.
30757 A positive number means delay autoselection by that many seconds: a
30758 window is autoselected only after the mouse has remained in that
30759 window for the duration of the delay.
30760 A negative number has a similar effect, but causes windows to be
30761 autoselected only after the mouse has stopped moving. \(Because of
30762 the way Emacs compares mouse events, you will occasionally wait twice
30763 that time before the window gets selected.\)
30764 Any other value means to autoselect window instantaneously when the
30765 mouse pointer enters it.
30767 Autoselection selects the minibuffer only if it is active, and never
30768 unselects the minibuffer if it is active.
30770 When customizing this variable make sure that the actual value of
30771 `focus-follows-mouse' matches the behavior of your window manager. */);
30772 Vmouse_autoselect_window = Qnil;
30774 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
30775 doc: /* Non-nil means automatically resize tool-bars.
30776 This dynamically changes the tool-bar's height to the minimum height
30777 that is needed to make all tool-bar items visible.
30778 If value is `grow-only', the tool-bar's height is only increased
30779 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30780 Vauto_resize_tool_bars = Qt;
30782 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
30783 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30784 auto_raise_tool_bar_buttons_p = 1;
30786 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
30787 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30788 make_cursor_line_fully_visible_p = 1;
30790 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
30791 doc: /* Border below tool-bar in pixels.
30792 If an integer, use it as the height of the border.
30793 If it is one of `internal-border-width' or `border-width', use the
30794 value of the corresponding frame parameter.
30795 Otherwise, no border is added below the tool-bar. */);
30796 Vtool_bar_border = Qinternal_border_width;
30798 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
30799 doc: /* Margin around tool-bar buttons in pixels.
30800 If an integer, use that for both horizontal and vertical margins.
30801 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30802 HORZ specifying the horizontal margin, and VERT specifying the
30803 vertical margin. */);
30804 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
30806 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
30807 doc: /* Relief thickness of tool-bar buttons. */);
30808 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
30810 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
30811 doc: /* Tool bar style to use.
30812 It can be one of
30813 image - show images only
30814 text - show text only
30815 both - show both, text below image
30816 both-horiz - show text to the right of the image
30817 text-image-horiz - show text to the left of the image
30818 any other - use system default or image if no system default.
30820 This variable only affects the GTK+ toolkit version of Emacs. */);
30821 Vtool_bar_style = Qnil;
30823 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
30824 doc: /* Maximum number of characters a label can have to be shown.
30825 The tool bar style must also show labels for this to have any effect, see
30826 `tool-bar-style'. */);
30827 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
30829 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
30830 doc: /* List of functions to call to fontify regions of text.
30831 Each function is called with one argument POS. Functions must
30832 fontify a region starting at POS in the current buffer, and give
30833 fontified regions the property `fontified'. */);
30834 Vfontification_functions = Qnil;
30835 Fmake_variable_buffer_local (Qfontification_functions);
30837 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30838 unibyte_display_via_language_environment,
30839 doc: /* Non-nil means display unibyte text according to language environment.
30840 Specifically, this means that raw bytes in the range 160-255 decimal
30841 are displayed by converting them to the equivalent multibyte characters
30842 according to the current language environment. As a result, they are
30843 displayed according to the current fontset.
30845 Note that this variable affects only how these bytes are displayed,
30846 but does not change the fact they are interpreted as raw bytes. */);
30847 unibyte_display_via_language_environment = 0;
30849 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
30850 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30851 If a float, it specifies a fraction of the mini-window frame's height.
30852 If an integer, it specifies a number of lines. */);
30853 Vmax_mini_window_height = make_float (0.25);
30855 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
30856 doc: /* How to resize mini-windows (the minibuffer and the echo area).
30857 A value of nil means don't automatically resize mini-windows.
30858 A value of t means resize them to fit the text displayed in them.
30859 A value of `grow-only', the default, means let mini-windows grow only;
30860 they return to their normal size when the minibuffer is closed, or the
30861 echo area becomes empty. */);
30862 Vresize_mini_windows = Qgrow_only;
30864 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
30865 doc: /* Alist specifying how to blink the cursor off.
30866 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30867 `cursor-type' frame-parameter or variable equals ON-STATE,
30868 comparing using `equal', Emacs uses OFF-STATE to specify
30869 how to blink it off. ON-STATE and OFF-STATE are values for
30870 the `cursor-type' frame parameter.
30872 If a frame's ON-STATE has no entry in this list,
30873 the frame's other specifications determine how to blink the cursor off. */);
30874 Vblink_cursor_alist = Qnil;
30876 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
30877 doc: /* Allow or disallow automatic horizontal scrolling of windows.
30878 If non-nil, windows are automatically scrolled horizontally to make
30879 point visible. */);
30880 automatic_hscrolling_p = 1;
30881 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
30883 DEFVAR_INT ("hscroll-margin", hscroll_margin,
30884 doc: /* How many columns away from the window edge point is allowed to get
30885 before automatic hscrolling will horizontally scroll the window. */);
30886 hscroll_margin = 5;
30888 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
30889 doc: /* How many columns to scroll the window when point gets too close to the edge.
30890 When point is less than `hscroll-margin' columns from the window
30891 edge, automatic hscrolling will scroll the window by the amount of columns
30892 determined by this variable. If its value is a positive integer, scroll that
30893 many columns. If it's a positive floating-point number, it specifies the
30894 fraction of the window's width to scroll. If it's nil or zero, point will be
30895 centered horizontally after the scroll. Any other value, including negative
30896 numbers, are treated as if the value were zero.
30898 Automatic hscrolling always moves point outside the scroll margin, so if
30899 point was more than scroll step columns inside the margin, the window will
30900 scroll more than the value given by the scroll step.
30902 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30903 and `scroll-right' overrides this variable's effect. */);
30904 Vhscroll_step = make_number (0);
30906 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
30907 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
30908 Bind this around calls to `message' to let it take effect. */);
30909 message_truncate_lines = 0;
30911 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
30912 doc: /* Normal hook run to update the menu bar definitions.
30913 Redisplay runs this hook before it redisplays the menu bar.
30914 This is used to update menus such as Buffers, whose contents depend on
30915 various data. */);
30916 Vmenu_bar_update_hook = Qnil;
30918 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
30919 doc: /* Frame for which we are updating a menu.
30920 The enable predicate for a menu binding should check this variable. */);
30921 Vmenu_updating_frame = Qnil;
30923 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
30924 doc: /* Non-nil means don't update menu bars. Internal use only. */);
30925 inhibit_menubar_update = 0;
30927 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
30928 doc: /* Prefix prepended to all continuation lines at display time.
30929 The value may be a string, an image, or a stretch-glyph; it is
30930 interpreted in the same way as the value of a `display' text property.
30932 This variable is overridden by any `wrap-prefix' text or overlay
30933 property.
30935 To add a prefix to non-continuation lines, use `line-prefix'. */);
30936 Vwrap_prefix = Qnil;
30937 DEFSYM (Qwrap_prefix, "wrap-prefix");
30938 Fmake_variable_buffer_local (Qwrap_prefix);
30940 DEFVAR_LISP ("line-prefix", Vline_prefix,
30941 doc: /* Prefix prepended to all non-continuation lines at display time.
30942 The value may be a string, an image, or a stretch-glyph; it is
30943 interpreted in the same way as the value of a `display' text property.
30945 This variable is overridden by any `line-prefix' text or overlay
30946 property.
30948 To add a prefix to continuation lines, use `wrap-prefix'. */);
30949 Vline_prefix = Qnil;
30950 DEFSYM (Qline_prefix, "line-prefix");
30951 Fmake_variable_buffer_local (Qline_prefix);
30953 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
30954 doc: /* Non-nil means don't eval Lisp during redisplay. */);
30955 inhibit_eval_during_redisplay = 0;
30957 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
30958 doc: /* Non-nil means don't free realized faces. Internal use only. */);
30959 inhibit_free_realized_faces = 0;
30961 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring,
30962 doc: /* Non-nil means don't mirror characters even when bidi context requires that.
30963 Intended for use during debugging and for testing bidi display;
30964 see biditest.el in the test suite. */);
30965 inhibit_bidi_mirroring = 0;
30967 #ifdef GLYPH_DEBUG
30968 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
30969 doc: /* Inhibit try_window_id display optimization. */);
30970 inhibit_try_window_id = 0;
30972 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
30973 doc: /* Inhibit try_window_reusing display optimization. */);
30974 inhibit_try_window_reusing = 0;
30976 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
30977 doc: /* Inhibit try_cursor_movement display optimization. */);
30978 inhibit_try_cursor_movement = 0;
30979 #endif /* GLYPH_DEBUG */
30981 DEFVAR_INT ("overline-margin", overline_margin,
30982 doc: /* Space between overline and text, in pixels.
30983 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30984 margin to the character height. */);
30985 overline_margin = 2;
30987 DEFVAR_INT ("underline-minimum-offset",
30988 underline_minimum_offset,
30989 doc: /* Minimum distance between baseline and underline.
30990 This can improve legibility of underlined text at small font sizes,
30991 particularly when using variable `x-use-underline-position-properties'
30992 with fonts that specify an UNDERLINE_POSITION relatively close to the
30993 baseline. The default value is 1. */);
30994 underline_minimum_offset = 1;
30996 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
30997 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30998 This feature only works when on a window system that can change
30999 cursor shapes. */);
31000 display_hourglass_p = 1;
31002 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
31003 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
31004 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
31006 #ifdef HAVE_WINDOW_SYSTEM
31007 hourglass_atimer = NULL;
31008 hourglass_shown_p = 0;
31009 #endif /* HAVE_WINDOW_SYSTEM */
31011 DEFSYM (Qglyphless_char, "glyphless-char");
31012 DEFSYM (Qhex_code, "hex-code");
31013 DEFSYM (Qempty_box, "empty-box");
31014 DEFSYM (Qthin_space, "thin-space");
31015 DEFSYM (Qzero_width, "zero-width");
31017 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
31018 doc: /* Function run just before redisplay.
31019 It is called with one argument, which is the set of windows that are to
31020 be redisplayed. This set can be nil (meaning, only the selected window),
31021 or t (meaning all windows). */);
31022 Vpre_redisplay_function = intern ("ignore");
31024 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
31025 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
31027 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
31028 doc: /* Char-table defining glyphless characters.
31029 Each element, if non-nil, should be one of the following:
31030 an ASCII acronym string: display this string in a box
31031 `hex-code': display the hexadecimal code of a character in a box
31032 `empty-box': display as an empty box
31033 `thin-space': display as 1-pixel width space
31034 `zero-width': don't display
31035 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31036 display method for graphical terminals and text terminals respectively.
31037 GRAPHICAL and TEXT should each have one of the values listed above.
31039 The char-table has one extra slot to control the display of a character for
31040 which no font is found. This slot only takes effect on graphical terminals.
31041 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31042 `thin-space'. The default is `empty-box'.
31044 If a character has a non-nil entry in an active display table, the
31045 display table takes effect; in this case, Emacs does not consult
31046 `glyphless-char-display' at all. */);
31047 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
31048 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
31049 Qempty_box);
31051 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
31052 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
31053 Vdebug_on_message = Qnil;
31055 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
31056 doc: /* */);
31057 Vredisplay__all_windows_cause
31058 = Fmake_vector (make_number (100), make_number (0));
31060 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
31061 doc: /* */);
31062 Vredisplay__mode_lines_cause
31063 = Fmake_vector (make_number (100), make_number (0));
31067 /* Initialize this module when Emacs starts. */
31069 void
31070 init_xdisp (void)
31072 CHARPOS (this_line_start_pos) = 0;
31074 if (!noninteractive)
31076 struct window *m = XWINDOW (minibuf_window);
31077 Lisp_Object frame = m->frame;
31078 struct frame *f = XFRAME (frame);
31079 Lisp_Object root = FRAME_ROOT_WINDOW (f);
31080 struct window *r = XWINDOW (root);
31081 int i;
31083 echo_area_window = minibuf_window;
31085 r->top_line = FRAME_TOP_MARGIN (f);
31086 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
31087 r->total_cols = FRAME_COLS (f);
31088 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
31089 r->total_lines = FRAME_TOTAL_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
31090 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
31092 m->top_line = FRAME_TOTAL_LINES (f) - 1;
31093 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
31094 m->total_cols = FRAME_COLS (f);
31095 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
31096 m->total_lines = 1;
31097 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
31099 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
31100 scratch_glyph_row.glyphs[TEXT_AREA + 1]
31101 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
31103 /* The default ellipsis glyphs `...'. */
31104 for (i = 0; i < 3; ++i)
31105 default_invis_vector[i] = make_number ('.');
31109 /* Allocate the buffer for frame titles.
31110 Also used for `format-mode-line'. */
31111 int size = 100;
31112 mode_line_noprop_buf = xmalloc (size);
31113 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
31114 mode_line_noprop_ptr = mode_line_noprop_buf;
31115 mode_line_target = MODE_LINE_DISPLAY;
31118 help_echo_showing_p = 0;
31121 #ifdef HAVE_WINDOW_SYSTEM
31123 /* Platform-independent portion of hourglass implementation. */
31125 /* Timer function of hourglass_atimer. */
31127 static void
31128 show_hourglass (struct atimer *timer)
31130 /* The timer implementation will cancel this timer automatically
31131 after this function has run. Set hourglass_atimer to null
31132 so that we know the timer doesn't have to be canceled. */
31133 hourglass_atimer = NULL;
31135 if (!hourglass_shown_p)
31137 Lisp_Object tail, frame;
31139 block_input ();
31141 FOR_EACH_FRAME (tail, frame)
31143 struct frame *f = XFRAME (frame);
31145 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31146 && FRAME_RIF (f)->show_hourglass)
31147 FRAME_RIF (f)->show_hourglass (f);
31150 hourglass_shown_p = 1;
31151 unblock_input ();
31155 /* Cancel a currently active hourglass timer, and start a new one. */
31157 void
31158 start_hourglass (void)
31160 struct timespec delay;
31162 cancel_hourglass ();
31164 if (INTEGERP (Vhourglass_delay)
31165 && XINT (Vhourglass_delay) > 0)
31166 delay = make_timespec (min (XINT (Vhourglass_delay),
31167 TYPE_MAXIMUM (time_t)),
31169 else if (FLOATP (Vhourglass_delay)
31170 && XFLOAT_DATA (Vhourglass_delay) > 0)
31171 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
31172 else
31173 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
31175 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
31176 show_hourglass, NULL);
31179 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31180 shown. */
31182 void
31183 cancel_hourglass (void)
31185 if (hourglass_atimer)
31187 cancel_atimer (hourglass_atimer);
31188 hourglass_atimer = NULL;
31191 if (hourglass_shown_p)
31193 Lisp_Object tail, frame;
31195 block_input ();
31197 FOR_EACH_FRAME (tail, frame)
31199 struct frame *f = XFRAME (frame);
31201 if (FRAME_LIVE_P (f) && FRAME_WINDOW_P (f)
31202 && FRAME_RIF (f)->hide_hourglass)
31203 FRAME_RIF (f)->hide_hourglass (f);
31204 #ifdef HAVE_NTGUI
31205 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31206 else if (!FRAME_W32_P (f))
31207 w32_arrow_cursor ();
31208 #endif
31211 hourglass_shown_p = 0;
31212 unblock_input ();
31216 #endif /* HAVE_WINDOW_SYSTEM */