Fix minor issues with functions that dump glyph matrices.
[emacs.git] / src / xdisp.c
blob0558aa8099dd5a6bb7186432966a0fa9cd3ffb70
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 bool hourglass_shown_p;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 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 return height;
1030 /* Return the pixel width of display area AREA of window W.
1031 ANY_AREA means return the total width of W, not including
1032 fringes to the left and right of the window. */
1035 window_box_width (struct window *w, enum glyph_row_area area)
1037 int width = w->pixel_width;
1039 if (!w->pseudo_window_p)
1041 width -= WINDOW_SCROLL_BAR_AREA_WIDTH (w);
1042 width -= WINDOW_RIGHT_DIVIDER_WIDTH (w);
1044 if (area == TEXT_AREA)
1045 width -= (WINDOW_MARGINS_WIDTH (w)
1046 + WINDOW_FRINGES_WIDTH (w));
1047 else if (area == LEFT_MARGIN_AREA)
1048 width = WINDOW_LEFT_MARGIN_WIDTH (w);
1049 else if (area == RIGHT_MARGIN_AREA)
1050 width = WINDOW_RIGHT_MARGIN_WIDTH (w);
1053 /* With wide margins, fringes, etc. we might end up with a negative
1054 width, correct that here. */
1055 return max (0, width);
1059 /* Return the pixel height of the display area of window W, not
1060 including mode lines of W, if any. */
1063 window_box_height (struct window *w)
1065 struct frame *f = XFRAME (w->frame);
1066 int height = WINDOW_PIXEL_HEIGHT (w);
1068 eassert (height >= 0);
1070 height -= WINDOW_BOTTOM_DIVIDER_WIDTH (w);
1072 /* Note: the code below that determines the mode-line/header-line
1073 height is essentially the same as that contained in the macro
1074 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1075 the appropriate glyph row has its `mode_line_p' flag set,
1076 and if it doesn't, uses estimate_mode_line_height instead. */
1078 if (WINDOW_WANTS_MODELINE_P (w))
1080 struct glyph_row *ml_row
1081 = (w->current_matrix && w->current_matrix->rows
1082 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
1083 : 0);
1084 if (ml_row && ml_row->mode_line_p)
1085 height -= ml_row->height;
1086 else
1087 height -= estimate_mode_line_height (f, CURRENT_MODE_LINE_FACE_ID (w));
1090 if (WINDOW_WANTS_HEADER_LINE_P (w))
1092 struct glyph_row *hl_row
1093 = (w->current_matrix && w->current_matrix->rows
1094 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
1095 : 0);
1096 if (hl_row && hl_row->mode_line_p)
1097 height -= hl_row->height;
1098 else
1099 height -= estimate_mode_line_height (f, HEADER_LINE_FACE_ID);
1102 /* With a very small font and a mode-line that's taller than
1103 default, we might end up with a negative height. */
1104 return max (0, height);
1107 /* Return the window-relative coordinate of the left edge of display
1108 area AREA of window W. ANY_AREA means return the left edge of the
1109 whole window, to the right of the left fringe of W. */
1112 window_box_left_offset (struct window *w, enum glyph_row_area area)
1114 int x;
1116 if (w->pseudo_window_p)
1117 return 0;
1119 x = WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
1121 if (area == TEXT_AREA)
1122 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1123 + window_box_width (w, LEFT_MARGIN_AREA));
1124 else if (area == RIGHT_MARGIN_AREA)
1125 x += (WINDOW_LEFT_FRINGE_WIDTH (w)
1126 + window_box_width (w, LEFT_MARGIN_AREA)
1127 + window_box_width (w, TEXT_AREA)
1128 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
1130 : WINDOW_RIGHT_FRINGE_WIDTH (w)));
1131 else if (area == LEFT_MARGIN_AREA
1132 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w))
1133 x += WINDOW_LEFT_FRINGE_WIDTH (w);
1135 /* Don't return more than the window's pixel width. */
1136 return min (x, w->pixel_width);
1140 /* Return the window-relative coordinate of the right edge of display
1141 area AREA of window W. ANY_AREA means return the right edge of the
1142 whole window, to the left of the right fringe of W. */
1145 window_box_right_offset (struct window *w, enum glyph_row_area area)
1147 /* Don't return more than the window's pixel width. */
1148 return min (window_box_left_offset (w, area) + window_box_width (w, area),
1149 w->pixel_width);
1152 /* Return the frame-relative coordinate of the left edge of display
1153 area AREA of window W. ANY_AREA means return the left edge of the
1154 whole window, to the right of the left fringe of W. */
1157 window_box_left (struct window *w, enum glyph_row_area area)
1159 struct frame *f = XFRAME (w->frame);
1160 int x;
1162 if (w->pseudo_window_p)
1163 return FRAME_INTERNAL_BORDER_WIDTH (f);
1165 x = (WINDOW_LEFT_EDGE_X (w)
1166 + window_box_left_offset (w, area));
1168 return x;
1172 /* Return the frame-relative coordinate of the right edge of display
1173 area AREA of window W. ANY_AREA means return the right edge of the
1174 whole window, to the left of the right fringe of W. */
1177 window_box_right (struct window *w, enum glyph_row_area area)
1179 return window_box_left (w, area) + window_box_width (w, area);
1182 /* Get the bounding box of the display area AREA of window W, without
1183 mode lines, in frame-relative coordinates. ANY_AREA means the
1184 whole window, not including the left and right fringes of
1185 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1186 coordinates of the upper-left corner of the box. Return in
1187 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1189 void
1190 window_box (struct window *w, enum glyph_row_area area, int *box_x,
1191 int *box_y, int *box_width, int *box_height)
1193 if (box_width)
1194 *box_width = window_box_width (w, area);
1195 if (box_height)
1196 *box_height = window_box_height (w);
1197 if (box_x)
1198 *box_x = window_box_left (w, area);
1199 if (box_y)
1201 *box_y = WINDOW_TOP_EDGE_Y (w);
1202 if (WINDOW_WANTS_HEADER_LINE_P (w))
1203 *box_y += CURRENT_HEADER_LINE_HEIGHT (w);
1207 #ifdef HAVE_WINDOW_SYSTEM
1209 /* Get the bounding box of the display area AREA of window W, without
1210 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1211 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1212 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1213 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1214 box. */
1216 static void
1217 window_box_edges (struct window *w, int *top_left_x, int *top_left_y,
1218 int *bottom_right_x, int *bottom_right_y)
1220 window_box (w, ANY_AREA, top_left_x, top_left_y,
1221 bottom_right_x, bottom_right_y);
1222 *bottom_right_x += *top_left_x;
1223 *bottom_right_y += *top_left_y;
1226 #endif /* HAVE_WINDOW_SYSTEM */
1228 /***********************************************************************
1229 Utilities
1230 ***********************************************************************/
1232 /* Return the bottom y-position of the line the iterator IT is in.
1233 This can modify IT's settings. */
1236 line_bottom_y (struct it *it)
1238 int line_height = it->max_ascent + it->max_descent;
1239 int line_top_y = it->current_y;
1241 if (line_height == 0)
1243 if (last_height)
1244 line_height = last_height;
1245 else if (IT_CHARPOS (*it) < ZV)
1247 move_it_by_lines (it, 1);
1248 line_height = (it->max_ascent || it->max_descent
1249 ? it->max_ascent + it->max_descent
1250 : last_height);
1252 else
1254 struct glyph_row *row = it->glyph_row;
1256 /* Use the default character height. */
1257 it->glyph_row = NULL;
1258 it->what = IT_CHARACTER;
1259 it->c = ' ';
1260 it->len = 1;
1261 PRODUCE_GLYPHS (it);
1262 line_height = it->ascent + it->descent;
1263 it->glyph_row = row;
1267 return line_top_y + line_height;
1270 DEFUN ("line-pixel-height", Fline_pixel_height,
1271 Sline_pixel_height, 0, 0, 0,
1272 doc: /* Return height in pixels of text line in the selected window.
1274 Value is the height in pixels of the line at point. */)
1275 (void)
1277 struct it it;
1278 struct text_pos pt;
1279 struct window *w = XWINDOW (selected_window);
1280 struct buffer *old_buffer = NULL;
1281 Lisp_Object result;
1283 if (XBUFFER (w->contents) != current_buffer)
1285 old_buffer = current_buffer;
1286 set_buffer_internal_1 (XBUFFER (w->contents));
1288 SET_TEXT_POS (pt, PT, PT_BYTE);
1289 start_display (&it, w, pt);
1290 it.vpos = it.current_y = 0;
1291 last_height = 0;
1292 result = make_number (line_bottom_y (&it));
1293 if (old_buffer)
1294 set_buffer_internal_1 (old_buffer);
1296 return result;
1299 /* Return the default pixel height of text lines in window W. The
1300 value is the canonical height of the W frame's default font, plus
1301 any extra space required by the line-spacing variable or frame
1302 parameter.
1304 Implementation note: this ignores any line-spacing text properties
1305 put on the newline characters. This is because those properties
1306 only affect the _screen_ line ending in the newline (i.e., in a
1307 continued line, only the last screen line will be affected), which
1308 means only a small number of lines in a buffer can ever use this
1309 feature. Since this function is used to compute the default pixel
1310 equivalent of text lines in a window, we can safely ignore those
1311 few lines. For the same reasons, we ignore the line-height
1312 properties. */
1314 default_line_pixel_height (struct window *w)
1316 struct frame *f = WINDOW_XFRAME (w);
1317 int height = FRAME_LINE_HEIGHT (f);
1319 if (!FRAME_INITIAL_P (f) && BUFFERP (w->contents))
1321 struct buffer *b = XBUFFER (w->contents);
1322 Lisp_Object val = BVAR (b, extra_line_spacing);
1324 if (NILP (val))
1325 val = BVAR (&buffer_defaults, extra_line_spacing);
1326 if (!NILP (val))
1328 if (RANGED_INTEGERP (0, val, INT_MAX))
1329 height += XFASTINT (val);
1330 else if (FLOATP (val))
1332 int addon = XFLOAT_DATA (val) * height + 0.5;
1334 if (addon >= 0)
1335 height += addon;
1338 else
1339 height += f->extra_line_spacing;
1342 return height;
1345 /* Subroutine of pos_visible_p below. Extracts a display string, if
1346 any, from the display spec given as its argument. */
1347 static Lisp_Object
1348 string_from_display_spec (Lisp_Object spec)
1350 if (CONSP (spec))
1352 while (CONSP (spec))
1354 if (STRINGP (XCAR (spec)))
1355 return XCAR (spec);
1356 spec = XCDR (spec);
1359 else if (VECTORP (spec))
1361 ptrdiff_t i;
1363 for (i = 0; i < ASIZE (spec); i++)
1365 if (STRINGP (AREF (spec, i)))
1366 return AREF (spec, i);
1368 return Qnil;
1371 return spec;
1375 /* Limit insanely large values of W->hscroll on frame F to the largest
1376 value that will still prevent first_visible_x and last_visible_x of
1377 'struct it' from overflowing an int. */
1378 static int
1379 window_hscroll_limited (struct window *w, struct frame *f)
1381 ptrdiff_t window_hscroll = w->hscroll;
1382 int window_text_width = window_box_width (w, TEXT_AREA);
1383 int colwidth = FRAME_COLUMN_WIDTH (f);
1385 if (window_hscroll > (INT_MAX - window_text_width) / colwidth - 1)
1386 window_hscroll = (INT_MAX - window_text_width) / colwidth - 1;
1388 return window_hscroll;
1391 /* Return 1 if position CHARPOS is visible in window W.
1392 CHARPOS < 0 means return info about WINDOW_END position.
1393 If visible, set *X and *Y to pixel coordinates of top left corner.
1394 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1395 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1398 pos_visible_p (struct window *w, ptrdiff_t charpos, int *x, int *y,
1399 int *rtop, int *rbot, int *rowh, int *vpos)
1401 struct it it;
1402 void *itdata = bidi_shelve_cache ();
1403 struct text_pos top;
1404 int visible_p = 0;
1405 struct buffer *old_buffer = NULL;
1407 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w))))
1408 return visible_p;
1410 if (XBUFFER (w->contents) != current_buffer)
1412 old_buffer = current_buffer;
1413 set_buffer_internal_1 (XBUFFER (w->contents));
1416 SET_TEXT_POS_FROM_MARKER (top, w->start);
1417 /* Scrolling a minibuffer window via scroll bar when the echo area
1418 shows long text sometimes resets the minibuffer contents behind
1419 our backs. */
1420 if (CHARPOS (top) > ZV)
1421 SET_TEXT_POS (top, BEGV, BEGV_BYTE);
1423 /* Compute exact mode line heights. */
1424 if (WINDOW_WANTS_MODELINE_P (w))
1425 w->mode_line_height
1426 = display_mode_line (w, CURRENT_MODE_LINE_FACE_ID (w),
1427 BVAR (current_buffer, mode_line_format));
1429 if (WINDOW_WANTS_HEADER_LINE_P (w))
1430 w->header_line_height
1431 = display_mode_line (w, HEADER_LINE_FACE_ID,
1432 BVAR (current_buffer, header_line_format));
1434 start_display (&it, w, top);
1435 move_it_to (&it, charpos, -1, it.last_visible_y - 1, -1,
1436 (charpos >= 0 ? MOVE_TO_POS : 0) | MOVE_TO_Y);
1438 if (charpos >= 0
1439 && (((!it.bidi_p || it.bidi_it.scan_dir != -1)
1440 && IT_CHARPOS (it) >= charpos)
1441 /* When scanning backwards under bidi iteration, move_it_to
1442 stops at or _before_ CHARPOS, because it stops at or to
1443 the _right_ of the character at CHARPOS. */
1444 || (it.bidi_p && it.bidi_it.scan_dir == -1
1445 && IT_CHARPOS (it) <= charpos)))
1447 /* We have reached CHARPOS, or passed it. How the call to
1448 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1449 or covered by a display property, move_it_to stops at the end
1450 of the invisible text, to the right of CHARPOS. (ii) If
1451 CHARPOS is in a display vector, move_it_to stops on its last
1452 glyph. */
1453 int top_x = it.current_x;
1454 int top_y = it.current_y;
1455 int window_top_y = WINDOW_HEADER_LINE_HEIGHT (w);
1456 int bottom_y;
1457 struct it save_it;
1458 void *save_it_data = NULL;
1460 /* Calling line_bottom_y may change it.method, it.position, etc. */
1461 SAVE_IT (save_it, it, save_it_data);
1462 last_height = 0;
1463 bottom_y = line_bottom_y (&it);
1464 if (top_y < window_top_y)
1465 visible_p = bottom_y > window_top_y;
1466 else if (top_y < it.last_visible_y)
1467 visible_p = 1;
1468 if (bottom_y >= it.last_visible_y
1469 && it.bidi_p && it.bidi_it.scan_dir == -1
1470 && IT_CHARPOS (it) < charpos)
1472 /* When the last line of the window is scanned backwards
1473 under bidi iteration, we could be duped into thinking
1474 that we have passed CHARPOS, when in fact move_it_to
1475 simply stopped short of CHARPOS because it reached
1476 last_visible_y. To see if that's what happened, we call
1477 move_it_to again with a slightly larger vertical limit,
1478 and see if it actually moved vertically; if it did, we
1479 didn't really reach CHARPOS, which is beyond window end. */
1480 /* Why 10? because we don't know how many canonical lines
1481 will the height of the next line(s) be. So we guess. */
1482 int ten_more_lines = 10 * default_line_pixel_height (w);
1484 move_it_to (&it, charpos, -1, bottom_y + ten_more_lines, -1,
1485 MOVE_TO_POS | MOVE_TO_Y);
1486 if (it.current_y > top_y)
1487 visible_p = 0;
1490 RESTORE_IT (&it, &save_it, save_it_data);
1491 if (visible_p)
1493 if (it.method == GET_FROM_DISPLAY_VECTOR)
1495 /* We stopped on the last glyph of a display vector.
1496 Try and recompute. Hack alert! */
1497 if (charpos < 2 || top.charpos >= charpos)
1498 top_x = it.glyph_row->x;
1499 else
1501 struct it it2, it2_prev;
1502 /* The idea is to get to the previous buffer
1503 position, consume the character there, and use
1504 the pixel coordinates we get after that. But if
1505 the previous buffer position is also displayed
1506 from a display vector, we need to consume all of
1507 the glyphs from that display vector. */
1508 start_display (&it2, w, top);
1509 move_it_to (&it2, charpos - 1, -1, -1, -1, MOVE_TO_POS);
1510 /* If we didn't get to CHARPOS - 1, there's some
1511 replacing display property at that position, and
1512 we stopped after it. That is exactly the place
1513 whose coordinates we want. */
1514 if (IT_CHARPOS (it2) != charpos - 1)
1515 it2_prev = it2;
1516 else
1518 /* Iterate until we get out of the display
1519 vector that displays the character at
1520 CHARPOS - 1. */
1521 do {
1522 get_next_display_element (&it2);
1523 PRODUCE_GLYPHS (&it2);
1524 it2_prev = it2;
1525 set_iterator_to_next (&it2, 1);
1526 } while (it2.method == GET_FROM_DISPLAY_VECTOR
1527 && IT_CHARPOS (it2) < charpos);
1529 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev)
1530 || it2_prev.current_x > it2_prev.last_visible_x)
1531 top_x = it.glyph_row->x;
1532 else
1534 top_x = it2_prev.current_x;
1535 top_y = it2_prev.current_y;
1539 else if (IT_CHARPOS (it) != charpos)
1541 Lisp_Object cpos = make_number (charpos);
1542 Lisp_Object spec = Fget_char_property (cpos, Qdisplay, Qnil);
1543 Lisp_Object string = string_from_display_spec (spec);
1544 struct text_pos tpos;
1545 int replacing_spec_p;
1546 bool newline_in_string
1547 = (STRINGP (string)
1548 && memchr (SDATA (string), '\n', SBYTES (string)));
1550 SET_TEXT_POS (tpos, charpos, CHAR_TO_BYTE (charpos));
1551 replacing_spec_p
1552 = (!NILP (spec)
1553 && handle_display_spec (NULL, spec, Qnil, Qnil, &tpos,
1554 charpos, FRAME_WINDOW_P (it.f)));
1555 /* The tricky code below is needed because there's a
1556 discrepancy between move_it_to and how we set cursor
1557 when PT is at the beginning of a portion of text
1558 covered by a display property or an overlay with a
1559 display property, or the display line ends in a
1560 newline from a display string. move_it_to will stop
1561 _after_ such display strings, whereas
1562 set_cursor_from_row conspires with cursor_row_p to
1563 place the cursor on the first glyph produced from the
1564 display string. */
1566 /* We have overshoot PT because it is covered by a
1567 display property that replaces the text it covers.
1568 If the string includes embedded newlines, we are also
1569 in the wrong display line. Backtrack to the correct
1570 line, where the display property begins. */
1571 if (replacing_spec_p)
1573 Lisp_Object startpos, endpos;
1574 EMACS_INT start, end;
1575 struct it it3;
1576 int it3_moved;
1578 /* Find the first and the last buffer positions
1579 covered by the display string. */
1580 endpos =
1581 Fnext_single_char_property_change (cpos, Qdisplay,
1582 Qnil, Qnil);
1583 startpos =
1584 Fprevious_single_char_property_change (endpos, Qdisplay,
1585 Qnil, Qnil);
1586 start = XFASTINT (startpos);
1587 end = XFASTINT (endpos);
1588 /* Move to the last buffer position before the
1589 display property. */
1590 start_display (&it3, w, top);
1591 if (start > CHARPOS (top))
1592 move_it_to (&it3, start - 1, -1, -1, -1, MOVE_TO_POS);
1593 /* Move forward one more line if the position before
1594 the display string is a newline or if it is the
1595 rightmost character on a line that is
1596 continued or word-wrapped. */
1597 if (it3.method == GET_FROM_BUFFER
1598 && (it3.c == '\n'
1599 || FETCH_BYTE (IT_BYTEPOS (it3)) == '\n'))
1600 move_it_by_lines (&it3, 1);
1601 else if (move_it_in_display_line_to (&it3, -1,
1602 it3.current_x
1603 + it3.pixel_width,
1604 MOVE_TO_X)
1605 == MOVE_LINE_CONTINUED)
1607 move_it_by_lines (&it3, 1);
1608 /* When we are under word-wrap, the #$@%!
1609 move_it_by_lines moves 2 lines, so we need to
1610 fix that up. */
1611 if (it3.line_wrap == WORD_WRAP)
1612 move_it_by_lines (&it3, -1);
1615 /* Record the vertical coordinate of the display
1616 line where we wound up. */
1617 top_y = it3.current_y;
1618 if (it3.bidi_p)
1620 /* When characters are reordered for display,
1621 the character displayed to the left of the
1622 display string could be _after_ the display
1623 property in the logical order. Use the
1624 smallest vertical position of these two. */
1625 start_display (&it3, w, top);
1626 move_it_to (&it3, end + 1, -1, -1, -1, MOVE_TO_POS);
1627 if (it3.current_y < top_y)
1628 top_y = it3.current_y;
1630 /* Move from the top of the window to the beginning
1631 of the display line where the display string
1632 begins. */
1633 start_display (&it3, w, top);
1634 move_it_to (&it3, -1, 0, top_y, -1, MOVE_TO_X | MOVE_TO_Y);
1635 /* If it3_moved stays zero after the 'while' loop
1636 below, that means we already were at a newline
1637 before the loop (e.g., the display string begins
1638 with a newline), so we don't need to (and cannot)
1639 inspect the glyphs of it3.glyph_row, because
1640 PRODUCE_GLYPHS will not produce anything for a
1641 newline, and thus it3.glyph_row stays at its
1642 stale content it got at top of the window. */
1643 it3_moved = 0;
1644 /* Finally, advance the iterator until we hit the
1645 first display element whose character position is
1646 CHARPOS, or until the first newline from the
1647 display string, which signals the end of the
1648 display line. */
1649 while (get_next_display_element (&it3))
1651 PRODUCE_GLYPHS (&it3);
1652 if (IT_CHARPOS (it3) == charpos
1653 || ITERATOR_AT_END_OF_LINE_P (&it3))
1654 break;
1655 it3_moved = 1;
1656 set_iterator_to_next (&it3, 0);
1658 top_x = it3.current_x - it3.pixel_width;
1659 /* Normally, we would exit the above loop because we
1660 found the display element whose character
1661 position is CHARPOS. For the contingency that we
1662 didn't, and stopped at the first newline from the
1663 display string, move back over the glyphs
1664 produced from the string, until we find the
1665 rightmost glyph not from the string. */
1666 if (it3_moved
1667 && newline_in_string
1668 && IT_CHARPOS (it3) != charpos && EQ (it3.object, string))
1670 struct glyph *g = it3.glyph_row->glyphs[TEXT_AREA]
1671 + it3.glyph_row->used[TEXT_AREA];
1673 while (EQ ((g - 1)->object, string))
1675 --g;
1676 top_x -= g->pixel_width;
1678 eassert (g < it3.glyph_row->glyphs[TEXT_AREA]
1679 + it3.glyph_row->used[TEXT_AREA]);
1684 *x = top_x;
1685 *y = max (top_y + max (0, it.max_ascent - it.ascent), window_top_y);
1686 *rtop = max (0, window_top_y - top_y);
1687 *rbot = max (0, bottom_y - it.last_visible_y);
1688 *rowh = max (0, (min (bottom_y, it.last_visible_y)
1689 - max (top_y, window_top_y)));
1690 *vpos = it.vpos;
1693 else
1695 /* Either we were asked to provide info about WINDOW_END, or
1696 CHARPOS is in the partially visible glyph row at end of
1697 window. */
1698 struct it it2;
1699 void *it2data = NULL;
1701 SAVE_IT (it2, it, it2data);
1702 if (IT_CHARPOS (it) < ZV && FETCH_BYTE (IT_BYTEPOS (it)) != '\n')
1703 move_it_by_lines (&it, 1);
1704 if (charpos < IT_CHARPOS (it)
1705 || (it.what == IT_EOB && charpos == IT_CHARPOS (it)))
1707 visible_p = true;
1708 RESTORE_IT (&it2, &it2, it2data);
1709 move_it_to (&it2, charpos, -1, -1, -1, MOVE_TO_POS);
1710 *x = it2.current_x;
1711 *y = it2.current_y + it2.max_ascent - it2.ascent;
1712 *rtop = max (0, -it2.current_y);
1713 *rbot = max (0, ((it2.current_y + it2.max_ascent + it2.max_descent)
1714 - it.last_visible_y));
1715 *rowh = max (0, (min (it2.current_y + it2.max_ascent + it2.max_descent,
1716 it.last_visible_y)
1717 - max (it2.current_y,
1718 WINDOW_HEADER_LINE_HEIGHT (w))));
1719 *vpos = it2.vpos;
1721 else
1722 bidi_unshelve_cache (it2data, 1);
1724 bidi_unshelve_cache (itdata, 0);
1726 if (old_buffer)
1727 set_buffer_internal_1 (old_buffer);
1729 if (visible_p && w->hscroll > 0)
1730 *x -=
1731 window_hscroll_limited (w, WINDOW_XFRAME (w))
1732 * WINDOW_FRAME_COLUMN_WIDTH (w);
1734 #if 0
1735 /* Debugging code. */
1736 if (visible_p)
1737 fprintf (stderr, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1738 charpos, w->vscroll, *x, *y, *rtop, *rbot, *rowh, *vpos);
1739 else
1740 fprintf (stderr, "-pv pt=%d vs=%d\n", charpos, w->vscroll);
1741 #endif
1743 return visible_p;
1747 /* Return the next character from STR. Return in *LEN the length of
1748 the character. This is like STRING_CHAR_AND_LENGTH but never
1749 returns an invalid character. If we find one, we return a `?', but
1750 with the length of the invalid character. */
1752 static int
1753 string_char_and_length (const unsigned char *str, int *len)
1755 int c;
1757 c = STRING_CHAR_AND_LENGTH (str, *len);
1758 if (!CHAR_VALID_P (c))
1759 /* We may not change the length here because other places in Emacs
1760 don't use this function, i.e. they silently accept invalid
1761 characters. */
1762 c = '?';
1764 return c;
1769 /* Given a position POS containing a valid character and byte position
1770 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1772 static struct text_pos
1773 string_pos_nchars_ahead (struct text_pos pos, Lisp_Object string, ptrdiff_t nchars)
1775 eassert (STRINGP (string) && nchars >= 0);
1777 if (STRING_MULTIBYTE (string))
1779 const unsigned char *p = SDATA (string) + BYTEPOS (pos);
1780 int len;
1782 while (nchars--)
1784 string_char_and_length (p, &len);
1785 p += len;
1786 CHARPOS (pos) += 1;
1787 BYTEPOS (pos) += len;
1790 else
1791 SET_TEXT_POS (pos, CHARPOS (pos) + nchars, BYTEPOS (pos) + nchars);
1793 return pos;
1797 /* Value is the text position, i.e. character and byte position,
1798 for character position CHARPOS in STRING. */
1800 static struct text_pos
1801 string_pos (ptrdiff_t charpos, Lisp_Object string)
1803 struct text_pos pos;
1804 eassert (STRINGP (string));
1805 eassert (charpos >= 0);
1806 SET_TEXT_POS (pos, charpos, string_char_to_byte (string, charpos));
1807 return pos;
1811 /* Value is a text position, i.e. character and byte position, for
1812 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1813 means recognize multibyte characters. */
1815 static struct text_pos
1816 c_string_pos (ptrdiff_t charpos, const char *s, bool multibyte_p)
1818 struct text_pos pos;
1820 eassert (s != NULL);
1821 eassert (charpos >= 0);
1823 if (multibyte_p)
1825 int len;
1827 SET_TEXT_POS (pos, 0, 0);
1828 while (charpos--)
1830 string_char_and_length ((const unsigned char *) s, &len);
1831 s += len;
1832 CHARPOS (pos) += 1;
1833 BYTEPOS (pos) += len;
1836 else
1837 SET_TEXT_POS (pos, charpos, charpos);
1839 return pos;
1843 /* Value is the number of characters in C string S. MULTIBYTE_P
1844 non-zero means recognize multibyte characters. */
1846 static ptrdiff_t
1847 number_of_chars (const char *s, bool multibyte_p)
1849 ptrdiff_t nchars;
1851 if (multibyte_p)
1853 ptrdiff_t rest = strlen (s);
1854 int len;
1855 const unsigned char *p = (const unsigned char *) s;
1857 for (nchars = 0; rest > 0; ++nchars)
1859 string_char_and_length (p, &len);
1860 rest -= len, p += len;
1863 else
1864 nchars = strlen (s);
1866 return nchars;
1870 /* Compute byte position NEWPOS->bytepos corresponding to
1871 NEWPOS->charpos. POS is a known position in string STRING.
1872 NEWPOS->charpos must be >= POS.charpos. */
1874 static void
1875 compute_string_pos (struct text_pos *newpos, struct text_pos pos, Lisp_Object string)
1877 eassert (STRINGP (string));
1878 eassert (CHARPOS (*newpos) >= CHARPOS (pos));
1880 if (STRING_MULTIBYTE (string))
1881 *newpos = string_pos_nchars_ahead (pos, string,
1882 CHARPOS (*newpos) - CHARPOS (pos));
1883 else
1884 BYTEPOS (*newpos) = CHARPOS (*newpos);
1887 /* EXPORT:
1888 Return an estimation of the pixel height of mode or header lines on
1889 frame F. FACE_ID specifies what line's height to estimate. */
1892 estimate_mode_line_height (struct frame *f, enum face_id face_id)
1894 #ifdef HAVE_WINDOW_SYSTEM
1895 if (FRAME_WINDOW_P (f))
1897 int height = FONT_HEIGHT (FRAME_FONT (f));
1899 /* This function is called so early when Emacs starts that the face
1900 cache and mode line face are not yet initialized. */
1901 if (FRAME_FACE_CACHE (f))
1903 struct face *face = FACE_FROM_ID (f, face_id);
1904 if (face)
1906 if (face->font)
1907 height = FONT_HEIGHT (face->font);
1908 if (face->box_line_width > 0)
1909 height += 2 * face->box_line_width;
1913 return height;
1915 #endif
1917 return 1;
1920 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1921 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1922 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1923 not force the value into range. */
1925 void
1926 pixel_to_glyph_coords (struct frame *f, register int pix_x, register int pix_y,
1927 int *x, int *y, NativeRectangle *bounds, int noclip)
1930 #ifdef HAVE_WINDOW_SYSTEM
1931 if (FRAME_WINDOW_P (f))
1933 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1934 even for negative values. */
1935 if (pix_x < 0)
1936 pix_x -= FRAME_COLUMN_WIDTH (f) - 1;
1937 if (pix_y < 0)
1938 pix_y -= FRAME_LINE_HEIGHT (f) - 1;
1940 pix_x = FRAME_PIXEL_X_TO_COL (f, pix_x);
1941 pix_y = FRAME_PIXEL_Y_TO_LINE (f, pix_y);
1943 if (bounds)
1944 STORE_NATIVE_RECT (*bounds,
1945 FRAME_COL_TO_PIXEL_X (f, pix_x),
1946 FRAME_LINE_TO_PIXEL_Y (f, pix_y),
1947 FRAME_COLUMN_WIDTH (f) - 1,
1948 FRAME_LINE_HEIGHT (f) - 1);
1950 /* PXW: Should we clip pixels before converting to columns/lines? */
1951 if (!noclip)
1953 if (pix_x < 0)
1954 pix_x = 0;
1955 else if (pix_x > FRAME_TOTAL_COLS (f))
1956 pix_x = FRAME_TOTAL_COLS (f);
1958 if (pix_y < 0)
1959 pix_y = 0;
1960 else if (pix_y > FRAME_LINES (f))
1961 pix_y = FRAME_LINES (f);
1964 #endif
1966 *x = pix_x;
1967 *y = pix_y;
1971 /* Find the glyph under window-relative coordinates X/Y in window W.
1972 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1973 strings. Return in *HPOS and *VPOS the row and column number of
1974 the glyph found. Return in *AREA the glyph area containing X.
1975 Value is a pointer to the glyph found or null if X/Y is not on
1976 text, or we can't tell because W's current matrix is not up to
1977 date. */
1979 static struct glyph *
1980 x_y_to_hpos_vpos (struct window *w, int x, int y, int *hpos, int *vpos,
1981 int *dx, int *dy, int *area)
1983 struct glyph *glyph, *end;
1984 struct glyph_row *row = NULL;
1985 int x0, i;
1987 /* Find row containing Y. Give up if some row is not enabled. */
1988 for (i = 0; i < w->current_matrix->nrows; ++i)
1990 row = MATRIX_ROW (w->current_matrix, i);
1991 if (!row->enabled_p)
1992 return NULL;
1993 if (y >= row->y && y < MATRIX_ROW_BOTTOM_Y (row))
1994 break;
1997 *vpos = i;
1998 *hpos = 0;
2000 /* Give up if Y is not in the window. */
2001 if (i == w->current_matrix->nrows)
2002 return NULL;
2004 /* Get the glyph area containing X. */
2005 if (w->pseudo_window_p)
2007 *area = TEXT_AREA;
2008 x0 = 0;
2010 else
2012 if (x < window_box_left_offset (w, TEXT_AREA))
2014 *area = LEFT_MARGIN_AREA;
2015 x0 = window_box_left_offset (w, LEFT_MARGIN_AREA);
2017 else if (x < window_box_right_offset (w, TEXT_AREA))
2019 *area = TEXT_AREA;
2020 x0 = window_box_left_offset (w, TEXT_AREA) + min (row->x, 0);
2022 else
2024 *area = RIGHT_MARGIN_AREA;
2025 x0 = window_box_left_offset (w, RIGHT_MARGIN_AREA);
2029 /* Find glyph containing X. */
2030 glyph = row->glyphs[*area];
2031 end = glyph + row->used[*area];
2032 x -= x0;
2033 while (glyph < end && x >= glyph->pixel_width)
2035 x -= glyph->pixel_width;
2036 ++glyph;
2039 if (glyph == end)
2040 return NULL;
2042 if (dx)
2044 *dx = x;
2045 *dy = y - (row->y + row->ascent - glyph->ascent);
2048 *hpos = glyph - row->glyphs[*area];
2049 return glyph;
2052 /* Convert frame-relative x/y to coordinates relative to window W.
2053 Takes pseudo-windows into account. */
2055 static void
2056 frame_to_window_pixel_xy (struct window *w, int *x, int *y)
2058 if (w->pseudo_window_p)
2060 /* A pseudo-window is always full-width, and starts at the
2061 left edge of the frame, plus a frame border. */
2062 struct frame *f = XFRAME (w->frame);
2063 *x -= FRAME_INTERNAL_BORDER_WIDTH (f);
2064 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
2066 else
2068 *x -= WINDOW_LEFT_EDGE_X (w);
2069 *y = FRAME_TO_WINDOW_PIXEL_Y (w, *y);
2073 #ifdef HAVE_WINDOW_SYSTEM
2075 /* EXPORT:
2076 Return in RECTS[] at most N clipping rectangles for glyph string S.
2077 Return the number of stored rectangles. */
2080 get_glyph_string_clip_rects (struct glyph_string *s, NativeRectangle *rects, int n)
2082 XRectangle r;
2084 if (n <= 0)
2085 return 0;
2087 if (s->row->full_width_p)
2089 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2090 r.x = WINDOW_LEFT_EDGE_X (s->w);
2091 if (s->row->mode_line_p)
2092 r.width = WINDOW_PIXEL_WIDTH (s->w) - WINDOW_RIGHT_DIVIDER_WIDTH (s->w);
2093 else
2094 r.width = WINDOW_PIXEL_WIDTH (s->w);
2096 /* Unless displaying a mode or menu bar line, which are always
2097 fully visible, clip to the visible part of the row. */
2098 if (s->w->pseudo_window_p)
2099 r.height = s->row->visible_height;
2100 else
2101 r.height = s->height;
2103 else
2105 /* This is a text line that may be partially visible. */
2106 r.x = window_box_left (s->w, s->area);
2107 r.width = window_box_width (s->w, s->area);
2108 r.height = s->row->visible_height;
2111 if (s->clip_head)
2112 if (r.x < s->clip_head->x)
2114 if (r.width >= s->clip_head->x - r.x)
2115 r.width -= s->clip_head->x - r.x;
2116 else
2117 r.width = 0;
2118 r.x = s->clip_head->x;
2120 if (s->clip_tail)
2121 if (r.x + r.width > s->clip_tail->x + s->clip_tail->background_width)
2123 if (s->clip_tail->x + s->clip_tail->background_width >= r.x)
2124 r.width = s->clip_tail->x + s->clip_tail->background_width - r.x;
2125 else
2126 r.width = 0;
2129 /* If S draws overlapping rows, it's sufficient to use the top and
2130 bottom of the window for clipping because this glyph string
2131 intentionally draws over other lines. */
2132 if (s->for_overlaps)
2134 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2135 r.height = window_text_bottom_y (s->w) - r.y;
2137 /* Alas, the above simple strategy does not work for the
2138 environments with anti-aliased text: if the same text is
2139 drawn onto the same place multiple times, it gets thicker.
2140 If the overlap we are processing is for the erased cursor, we
2141 take the intersection with the rectangle of the cursor. */
2142 if (s->for_overlaps & OVERLAPS_ERASED_CURSOR)
2144 XRectangle rc, r_save = r;
2146 rc.x = WINDOW_TEXT_TO_FRAME_PIXEL_X (s->w, s->w->phys_cursor.x);
2147 rc.y = s->w->phys_cursor.y;
2148 rc.width = s->w->phys_cursor_width;
2149 rc.height = s->w->phys_cursor_height;
2151 x_intersect_rectangles (&r_save, &rc, &r);
2154 else
2156 /* Don't use S->y for clipping because it doesn't take partially
2157 visible lines into account. For example, it can be negative for
2158 partially visible lines at the top of a window. */
2159 if (!s->row->full_width_p
2160 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s->w, s->row))
2161 r.y = WINDOW_HEADER_LINE_HEIGHT (s->w);
2162 else
2163 r.y = max (0, s->row->y);
2166 r.y = WINDOW_TO_FRAME_PIXEL_Y (s->w, r.y);
2168 /* If drawing the cursor, don't let glyph draw outside its
2169 advertised boundaries. Cleartype does this under some circumstances. */
2170 if (s->hl == DRAW_CURSOR)
2172 struct glyph *glyph = s->first_glyph;
2173 int height, max_y;
2175 if (s->x > r.x)
2177 r.width -= s->x - r.x;
2178 r.x = s->x;
2180 r.width = min (r.width, glyph->pixel_width);
2182 /* If r.y is below window bottom, ensure that we still see a cursor. */
2183 height = min (glyph->ascent + glyph->descent,
2184 min (FRAME_LINE_HEIGHT (s->f), s->row->visible_height));
2185 max_y = window_text_bottom_y (s->w) - height;
2186 max_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, max_y);
2187 if (s->ybase - glyph->ascent > max_y)
2189 r.y = max_y;
2190 r.height = height;
2192 else
2194 /* Don't draw cursor glyph taller than our actual glyph. */
2195 height = max (FRAME_LINE_HEIGHT (s->f), glyph->ascent + glyph->descent);
2196 if (height < r.height)
2198 max_y = r.y + r.height;
2199 r.y = min (max_y, max (r.y, s->ybase + glyph->descent - height));
2200 r.height = min (max_y - r.y, height);
2205 if (s->row->clip)
2207 XRectangle r_save = r;
2209 if (! x_intersect_rectangles (&r_save, s->row->clip, &r))
2210 r.width = 0;
2213 if ((s->for_overlaps & OVERLAPS_BOTH) == 0
2214 || ((s->for_overlaps & OVERLAPS_BOTH) == OVERLAPS_BOTH && n == 1))
2216 #ifdef CONVERT_FROM_XRECT
2217 CONVERT_FROM_XRECT (r, *rects);
2218 #else
2219 *rects = r;
2220 #endif
2221 return 1;
2223 else
2225 /* If we are processing overlapping and allowed to return
2226 multiple clipping rectangles, we exclude the row of the glyph
2227 string from the clipping rectangle. This is to avoid drawing
2228 the same text on the environment with anti-aliasing. */
2229 #ifdef CONVERT_FROM_XRECT
2230 XRectangle rs[2];
2231 #else
2232 XRectangle *rs = rects;
2233 #endif
2234 int i = 0, row_y = WINDOW_TO_FRAME_PIXEL_Y (s->w, s->row->y);
2236 if (s->for_overlaps & OVERLAPS_PRED)
2238 rs[i] = r;
2239 if (r.y + r.height > row_y)
2241 if (r.y < row_y)
2242 rs[i].height = row_y - r.y;
2243 else
2244 rs[i].height = 0;
2246 i++;
2248 if (s->for_overlaps & OVERLAPS_SUCC)
2250 rs[i] = r;
2251 if (r.y < row_y + s->row->visible_height)
2253 if (r.y + r.height > row_y + s->row->visible_height)
2255 rs[i].y = row_y + s->row->visible_height;
2256 rs[i].height = r.y + r.height - rs[i].y;
2258 else
2259 rs[i].height = 0;
2261 i++;
2264 n = i;
2265 #ifdef CONVERT_FROM_XRECT
2266 for (i = 0; i < n; i++)
2267 CONVERT_FROM_XRECT (rs[i], rects[i]);
2268 #endif
2269 return n;
2273 /* EXPORT:
2274 Return in *NR the clipping rectangle for glyph string S. */
2276 void
2277 get_glyph_string_clip_rect (struct glyph_string *s, NativeRectangle *nr)
2279 get_glyph_string_clip_rects (s, nr, 1);
2283 /* EXPORT:
2284 Return the position and height of the phys cursor in window W.
2285 Set w->phys_cursor_width to width of phys cursor.
2288 void
2289 get_phys_cursor_geometry (struct window *w, struct glyph_row *row,
2290 struct glyph *glyph, int *xp, int *yp, int *heightp)
2292 struct frame *f = XFRAME (WINDOW_FRAME (w));
2293 int x, y, wd, h, h0, y0;
2295 /* Compute the width of the rectangle to draw. If on a stretch
2296 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2297 rectangle as wide as the glyph, but use a canonical character
2298 width instead. */
2299 wd = glyph->pixel_width - 1;
2300 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2301 wd++; /* Why? */
2302 #endif
2304 x = w->phys_cursor.x;
2305 if (x < 0)
2307 wd += x;
2308 x = 0;
2311 if (glyph->type == STRETCH_GLYPH
2312 && !x_stretch_cursor_p)
2313 wd = min (FRAME_COLUMN_WIDTH (f), wd);
2314 w->phys_cursor_width = wd;
2316 y = w->phys_cursor.y + row->ascent - glyph->ascent;
2318 /* If y is below window bottom, ensure that we still see a cursor. */
2319 h0 = min (FRAME_LINE_HEIGHT (f), row->visible_height);
2321 h = max (h0, glyph->ascent + glyph->descent);
2322 h0 = min (h0, glyph->ascent + glyph->descent);
2324 y0 = WINDOW_HEADER_LINE_HEIGHT (w);
2325 if (y < y0)
2327 h = max (h - (y0 - y) + 1, h0);
2328 y = y0 - 1;
2330 else
2332 y0 = window_text_bottom_y (w) - h0;
2333 if (y > y0)
2335 h += y - y0;
2336 y = y0;
2340 *xp = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
2341 *yp = WINDOW_TO_FRAME_PIXEL_Y (w, y);
2342 *heightp = h;
2346 * Remember which glyph the mouse is over.
2349 void
2350 remember_mouse_glyph (struct frame *f, int gx, int gy, NativeRectangle *rect)
2352 Lisp_Object window;
2353 struct window *w;
2354 struct glyph_row *r, *gr, *end_row;
2355 enum window_part part;
2356 enum glyph_row_area area;
2357 int x, y, width, height;
2359 /* Try to determine frame pixel position and size of the glyph under
2360 frame pixel coordinates X/Y on frame F. */
2362 if (window_resize_pixelwise)
2364 width = height = 1;
2365 goto virtual_glyph;
2367 else if (!f->glyphs_initialized_p
2368 || (window = window_from_coordinates (f, gx, gy, &part, 0),
2369 NILP (window)))
2371 width = FRAME_SMALLEST_CHAR_WIDTH (f);
2372 height = FRAME_SMALLEST_FONT_HEIGHT (f);
2373 goto virtual_glyph;
2376 w = XWINDOW (window);
2377 width = WINDOW_FRAME_COLUMN_WIDTH (w);
2378 height = WINDOW_FRAME_LINE_HEIGHT (w);
2380 x = window_relative_x_coord (w, part, gx);
2381 y = gy - WINDOW_TOP_EDGE_Y (w);
2383 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
2384 end_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
2386 if (w->pseudo_window_p)
2388 area = TEXT_AREA;
2389 part = ON_MODE_LINE; /* Don't adjust margin. */
2390 goto text_glyph;
2393 switch (part)
2395 case ON_LEFT_MARGIN:
2396 area = LEFT_MARGIN_AREA;
2397 goto text_glyph;
2399 case ON_RIGHT_MARGIN:
2400 area = RIGHT_MARGIN_AREA;
2401 goto text_glyph;
2403 case ON_HEADER_LINE:
2404 case ON_MODE_LINE:
2405 gr = (part == ON_HEADER_LINE
2406 ? MATRIX_HEADER_LINE_ROW (w->current_matrix)
2407 : MATRIX_MODE_LINE_ROW (w->current_matrix));
2408 gy = gr->y;
2409 area = TEXT_AREA;
2410 goto text_glyph_row_found;
2412 case ON_TEXT:
2413 area = TEXT_AREA;
2415 text_glyph:
2416 gr = 0; gy = 0;
2417 for (; r <= end_row && r->enabled_p; ++r)
2418 if (r->y + r->height > y)
2420 gr = r; gy = r->y;
2421 break;
2424 text_glyph_row_found:
2425 if (gr && gy <= y)
2427 struct glyph *g = gr->glyphs[area];
2428 struct glyph *end = g + gr->used[area];
2430 height = gr->height;
2431 for (gx = gr->x; g < end; gx += g->pixel_width, ++g)
2432 if (gx + g->pixel_width > x)
2433 break;
2435 if (g < end)
2437 if (g->type == IMAGE_GLYPH)
2439 /* Don't remember when mouse is over image, as
2440 image may have hot-spots. */
2441 STORE_NATIVE_RECT (*rect, 0, 0, 0, 0);
2442 return;
2444 width = g->pixel_width;
2446 else
2448 /* Use nominal char spacing at end of line. */
2449 x -= gx;
2450 gx += (x / width) * width;
2453 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2455 gx += window_box_left_offset (w, area);
2456 /* Don't expand over the modeline to make sure the vertical
2457 drag cursor is shown early enough. */
2458 height = min (height,
2459 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2462 else
2464 /* Use nominal line height at end of window. */
2465 gx = (x / width) * width;
2466 y -= gy;
2467 gy += (y / height) * height;
2468 if (part != ON_MODE_LINE && part != ON_HEADER_LINE)
2469 /* See comment above. */
2470 height = min (height,
2471 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w) - gy));
2473 break;
2475 case ON_LEFT_FRINGE:
2476 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2477 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w)
2478 : window_box_right_offset (w, LEFT_MARGIN_AREA));
2479 width = WINDOW_LEFT_FRINGE_WIDTH (w);
2480 goto row_glyph;
2482 case ON_RIGHT_FRINGE:
2483 gx = (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2484 ? window_box_right_offset (w, RIGHT_MARGIN_AREA)
2485 : window_box_right_offset (w, TEXT_AREA));
2486 if (WINDOW_RIGHT_DIVIDER_WIDTH (w) == 0
2487 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w)
2488 && !WINDOW_RIGHTMOST_P (w))
2489 if (gx < WINDOW_PIXEL_WIDTH (w) - width)
2490 /* Make sure the vertical border can get her own glyph to the
2491 right of the one we build here. */
2492 width = WINDOW_RIGHT_FRINGE_WIDTH (w) - width;
2493 else
2494 width = WINDOW_PIXEL_WIDTH (w) - gx;
2495 else
2496 width = WINDOW_RIGHT_FRINGE_WIDTH (w);
2498 goto row_glyph;
2500 case ON_VERTICAL_BORDER:
2501 gx = WINDOW_PIXEL_WIDTH (w) - width;
2502 goto row_glyph;
2504 case ON_SCROLL_BAR:
2505 gx = (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w)
2507 : (window_box_right_offset (w, RIGHT_MARGIN_AREA)
2508 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
2509 ? WINDOW_RIGHT_FRINGE_WIDTH (w)
2510 : 0)));
2511 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
2513 row_glyph:
2514 gr = 0, gy = 0;
2515 for (; r <= end_row && r->enabled_p; ++r)
2516 if (r->y + r->height > y)
2518 gr = r; gy = r->y;
2519 break;
2522 if (gr && gy <= y)
2523 height = gr->height;
2524 else
2526 /* Use nominal line height at end of window. */
2527 y -= gy;
2528 gy += (y / height) * height;
2530 break;
2532 case ON_RIGHT_DIVIDER:
2533 gx = WINDOW_PIXEL_WIDTH (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
2534 width = WINDOW_RIGHT_DIVIDER_WIDTH (w);
2535 gy = 0;
2536 /* The bottom divider prevails. */
2537 height = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2538 goto add_edge;;
2540 case ON_BOTTOM_DIVIDER:
2541 gx = 0;
2542 width = WINDOW_PIXEL_WIDTH (w);
2543 gy = WINDOW_PIXEL_HEIGHT (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2544 height = WINDOW_BOTTOM_DIVIDER_WIDTH (w);
2545 goto add_edge;
2547 default:
2549 virtual_glyph:
2550 /* If there is no glyph under the mouse, then we divide the screen
2551 into a grid of the smallest glyph in the frame, and use that
2552 as our "glyph". */
2554 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2555 round down even for negative values. */
2556 if (gx < 0)
2557 gx -= width - 1;
2558 if (gy < 0)
2559 gy -= height - 1;
2561 gx = (gx / width) * width;
2562 gy = (gy / height) * height;
2564 goto store_rect;
2567 add_edge:
2568 gx += WINDOW_LEFT_EDGE_X (w);
2569 gy += WINDOW_TOP_EDGE_Y (w);
2571 store_rect:
2572 STORE_NATIVE_RECT (*rect, gx, gy, width, height);
2574 /* Visible feedback for debugging. */
2575 #if 0
2576 #if HAVE_X_WINDOWS
2577 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2578 f->output_data.x->normal_gc,
2579 gx, gy, width, height);
2580 #endif
2581 #endif
2585 #endif /* HAVE_WINDOW_SYSTEM */
2587 static void
2588 adjust_window_ends (struct window *w, struct glyph_row *row, bool current)
2590 eassert (w);
2591 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
2592 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
2593 w->window_end_vpos
2594 = MATRIX_ROW_VPOS (row, current ? w->current_matrix : w->desired_matrix);
2597 /***********************************************************************
2598 Lisp form evaluation
2599 ***********************************************************************/
2601 /* Error handler for safe_eval and safe_call. */
2603 static Lisp_Object
2604 safe_eval_handler (Lisp_Object arg, ptrdiff_t nargs, Lisp_Object *args)
2606 add_to_log ("Error during redisplay: %S signaled %S",
2607 Flist (nargs, args), arg);
2608 return Qnil;
2611 /* Call function FUNC with the rest of NARGS - 1 arguments
2612 following. Return the result, or nil if something went
2613 wrong. Prevent redisplay during the evaluation. */
2615 static Lisp_Object
2616 safe__call (bool inhibit_quit, ptrdiff_t nargs, Lisp_Object func, va_list ap)
2618 Lisp_Object val;
2620 if (inhibit_eval_during_redisplay)
2621 val = Qnil;
2622 else
2624 ptrdiff_t i;
2625 ptrdiff_t count = SPECPDL_INDEX ();
2626 struct gcpro gcpro1;
2627 Lisp_Object *args = alloca (nargs * word_size);
2629 args[0] = func;
2630 for (i = 1; i < nargs; i++)
2631 args[i] = va_arg (ap, Lisp_Object);
2633 GCPRO1 (args[0]);
2634 gcpro1.nvars = nargs;
2635 specbind (Qinhibit_redisplay, Qt);
2636 if (inhibit_quit)
2637 specbind (Qinhibit_quit, Qt);
2638 /* Use Qt to ensure debugger does not run,
2639 so there is no possibility of wanting to redisplay. */
2640 val = internal_condition_case_n (Ffuncall, nargs, args, Qt,
2641 safe_eval_handler);
2642 UNGCPRO;
2643 val = unbind_to (count, val);
2646 return val;
2649 Lisp_Object
2650 safe_call (ptrdiff_t nargs, Lisp_Object func, ...)
2652 Lisp_Object retval;
2653 va_list ap;
2655 va_start (ap, func);
2656 retval = safe__call (false, nargs, func, ap);
2657 va_end (ap);
2658 return retval;
2661 /* Call function FN with one argument ARG.
2662 Return the result, or nil if something went wrong. */
2664 Lisp_Object
2665 safe_call1 (Lisp_Object fn, Lisp_Object arg)
2667 return safe_call (2, fn, arg);
2670 static Lisp_Object
2671 safe__call1 (bool inhibit_quit, Lisp_Object fn, ...)
2673 Lisp_Object retval;
2674 va_list ap;
2676 va_start (ap, fn);
2677 retval = safe__call (inhibit_quit, 2, fn, ap);
2678 va_end (ap);
2679 return retval;
2682 static Lisp_Object Qeval;
2684 Lisp_Object
2685 safe_eval (Lisp_Object sexpr)
2687 return safe__call1 (false, Qeval, sexpr);
2690 static Lisp_Object
2691 safe__eval (bool inhibit_quit, Lisp_Object sexpr)
2693 return safe__call1 (inhibit_quit, Qeval, sexpr);
2696 /* Call function FN with two arguments ARG1 and ARG2.
2697 Return the result, or nil if something went wrong. */
2699 Lisp_Object
2700 safe_call2 (Lisp_Object fn, Lisp_Object arg1, Lisp_Object arg2)
2702 return safe_call (3, fn, arg1, arg2);
2707 /***********************************************************************
2708 Debugging
2709 ***********************************************************************/
2711 #if 0
2713 /* Define CHECK_IT to perform sanity checks on iterators.
2714 This is for debugging. It is too slow to do unconditionally. */
2716 static void
2717 check_it (struct it *it)
2719 if (it->method == GET_FROM_STRING)
2721 eassert (STRINGP (it->string));
2722 eassert (IT_STRING_CHARPOS (*it) >= 0);
2724 else
2726 eassert (IT_STRING_CHARPOS (*it) < 0);
2727 if (it->method == GET_FROM_BUFFER)
2729 /* Check that character and byte positions agree. */
2730 eassert (IT_CHARPOS (*it) == BYTE_TO_CHAR (IT_BYTEPOS (*it)));
2734 if (it->dpvec)
2735 eassert (it->current.dpvec_index >= 0);
2736 else
2737 eassert (it->current.dpvec_index < 0);
2740 #define CHECK_IT(IT) check_it ((IT))
2742 #else /* not 0 */
2744 #define CHECK_IT(IT) (void) 0
2746 #endif /* not 0 */
2749 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2751 /* Check that the window end of window W is what we expect it
2752 to be---the last row in the current matrix displaying text. */
2754 static void
2755 check_window_end (struct window *w)
2757 if (!MINI_WINDOW_P (w) && w->window_end_valid)
2759 struct glyph_row *row;
2760 eassert ((row = MATRIX_ROW (w->current_matrix, w->window_end_vpos),
2761 !row->enabled_p
2762 || MATRIX_ROW_DISPLAYS_TEXT_P (row)
2763 || MATRIX_ROW_VPOS (row, w->current_matrix) == 0));
2767 #define CHECK_WINDOW_END(W) check_window_end ((W))
2769 #else
2771 #define CHECK_WINDOW_END(W) (void) 0
2773 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2775 /***********************************************************************
2776 Iterator initialization
2777 ***********************************************************************/
2779 /* Initialize IT for displaying current_buffer in window W, starting
2780 at character position CHARPOS. CHARPOS < 0 means that no buffer
2781 position is specified which is useful when the iterator is assigned
2782 a position later. BYTEPOS is the byte position corresponding to
2783 CHARPOS.
2785 If ROW is not null, calls to produce_glyphs with IT as parameter
2786 will produce glyphs in that row.
2788 BASE_FACE_ID is the id of a base face to use. It must be one of
2789 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2790 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2791 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2793 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2794 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2795 will be initialized to use the corresponding mode line glyph row of
2796 the desired matrix of W. */
2798 void
2799 init_iterator (struct it *it, struct window *w,
2800 ptrdiff_t charpos, ptrdiff_t bytepos,
2801 struct glyph_row *row, enum face_id base_face_id)
2803 enum face_id remapped_base_face_id = base_face_id;
2805 /* Some precondition checks. */
2806 eassert (w != NULL && it != NULL);
2807 eassert (charpos < 0 || (charpos >= BUF_BEG (current_buffer)
2808 && charpos <= ZV));
2810 /* If face attributes have been changed since the last redisplay,
2811 free realized faces now because they depend on face definitions
2812 that might have changed. Don't free faces while there might be
2813 desired matrices pending which reference these faces. */
2814 if (face_change_count && !inhibit_free_realized_faces)
2816 face_change_count = 0;
2817 free_all_realized_faces (Qnil);
2820 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2821 if (! NILP (Vface_remapping_alist))
2822 remapped_base_face_id
2823 = lookup_basic_face (XFRAME (w->frame), base_face_id);
2825 /* Use one of the mode line rows of W's desired matrix if
2826 appropriate. */
2827 if (row == NULL)
2829 if (base_face_id == MODE_LINE_FACE_ID
2830 || base_face_id == MODE_LINE_INACTIVE_FACE_ID)
2831 row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
2832 else if (base_face_id == HEADER_LINE_FACE_ID)
2833 row = MATRIX_HEADER_LINE_ROW (w->desired_matrix);
2836 /* Clear IT. */
2837 memset (it, 0, sizeof *it);
2838 it->current.overlay_string_index = -1;
2839 it->current.dpvec_index = -1;
2840 it->base_face_id = remapped_base_face_id;
2841 it->string = Qnil;
2842 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
2843 it->paragraph_embedding = L2R;
2844 it->bidi_it.string.lstring = Qnil;
2845 it->bidi_it.string.s = NULL;
2846 it->bidi_it.string.bufpos = 0;
2847 it->bidi_it.w = w;
2849 /* The window in which we iterate over current_buffer: */
2850 XSETWINDOW (it->window, w);
2851 it->w = w;
2852 it->f = XFRAME (w->frame);
2854 it->cmp_it.id = -1;
2856 /* Extra space between lines (on window systems only). */
2857 if (base_face_id == DEFAULT_FACE_ID
2858 && FRAME_WINDOW_P (it->f))
2860 if (NATNUMP (BVAR (current_buffer, extra_line_spacing)))
2861 it->extra_line_spacing = XFASTINT (BVAR (current_buffer, extra_line_spacing));
2862 else if (FLOATP (BVAR (current_buffer, extra_line_spacing)))
2863 it->extra_line_spacing = (XFLOAT_DATA (BVAR (current_buffer, extra_line_spacing))
2864 * FRAME_LINE_HEIGHT (it->f));
2865 else if (it->f->extra_line_spacing > 0)
2866 it->extra_line_spacing = it->f->extra_line_spacing;
2867 it->max_extra_line_spacing = 0;
2870 /* If realized faces have been removed, e.g. because of face
2871 attribute changes of named faces, recompute them. When running
2872 in batch mode, the face cache of the initial frame is null. If
2873 we happen to get called, make a dummy face cache. */
2874 if (FRAME_FACE_CACHE (it->f) == NULL)
2875 init_frame_faces (it->f);
2876 if (FRAME_FACE_CACHE (it->f)->used == 0)
2877 recompute_basic_faces (it->f);
2879 /* Current value of the `slice', `space-width', and 'height' properties. */
2880 it->slice.x = it->slice.y = it->slice.width = it->slice.height = Qnil;
2881 it->space_width = Qnil;
2882 it->font_height = Qnil;
2883 it->override_ascent = -1;
2885 /* Are control characters displayed as `^C'? */
2886 it->ctl_arrow_p = !NILP (BVAR (current_buffer, ctl_arrow));
2888 /* -1 means everything between a CR and the following line end
2889 is invisible. >0 means lines indented more than this value are
2890 invisible. */
2891 it->selective = (INTEGERP (BVAR (current_buffer, selective_display))
2892 ? (clip_to_bounds
2893 (-1, XINT (BVAR (current_buffer, selective_display)),
2894 PTRDIFF_MAX))
2895 : (!NILP (BVAR (current_buffer, selective_display))
2896 ? -1 : 0));
2897 it->selective_display_ellipsis_p
2898 = !NILP (BVAR (current_buffer, selective_display_ellipses));
2900 /* Display table to use. */
2901 it->dp = window_display_table (w);
2903 /* Are multibyte characters enabled in current_buffer? */
2904 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
2906 /* Get the position at which the redisplay_end_trigger hook should
2907 be run, if it is to be run at all. */
2908 if (MARKERP (w->redisplay_end_trigger)
2909 && XMARKER (w->redisplay_end_trigger)->buffer != 0)
2910 it->redisplay_end_trigger_charpos
2911 = marker_position (w->redisplay_end_trigger);
2912 else if (INTEGERP (w->redisplay_end_trigger))
2913 it->redisplay_end_trigger_charpos
2914 = clip_to_bounds (PTRDIFF_MIN, XINT (w->redisplay_end_trigger),
2915 PTRDIFF_MAX);
2917 it->tab_width = SANE_TAB_WIDTH (current_buffer);
2919 /* Are lines in the display truncated? */
2920 if (base_face_id != DEFAULT_FACE_ID
2921 || it->w->hscroll
2922 || (! WINDOW_FULL_WIDTH_P (it->w)
2923 && ((!NILP (Vtruncate_partial_width_windows)
2924 && !INTEGERP (Vtruncate_partial_width_windows))
2925 || (INTEGERP (Vtruncate_partial_width_windows)
2926 /* PXW: Shall we do something about this? */
2927 && (WINDOW_TOTAL_COLS (it->w)
2928 < XINT (Vtruncate_partial_width_windows))))))
2929 it->line_wrap = TRUNCATE;
2930 else if (NILP (BVAR (current_buffer, truncate_lines)))
2931 it->line_wrap = NILP (BVAR (current_buffer, word_wrap))
2932 ? WINDOW_WRAP : WORD_WRAP;
2933 else
2934 it->line_wrap = TRUNCATE;
2936 /* Get dimensions of truncation and continuation glyphs. These are
2937 displayed as fringe bitmaps under X, but we need them for such
2938 frames when the fringes are turned off. But leave the dimensions
2939 zero for tooltip frames, as these glyphs look ugly there and also
2940 sabotage calculations of tooltip dimensions in x-show-tip. */
2941 #ifdef HAVE_WINDOW_SYSTEM
2942 if (!(FRAME_WINDOW_P (it->f)
2943 && FRAMEP (tip_frame)
2944 && it->f == XFRAME (tip_frame)))
2945 #endif
2947 if (it->line_wrap == TRUNCATE)
2949 /* We will need the truncation glyph. */
2950 eassert (it->glyph_row == NULL);
2951 produce_special_glyphs (it, IT_TRUNCATION);
2952 it->truncation_pixel_width = it->pixel_width;
2954 else
2956 /* We will need the continuation glyph. */
2957 eassert (it->glyph_row == NULL);
2958 produce_special_glyphs (it, IT_CONTINUATION);
2959 it->continuation_pixel_width = it->pixel_width;
2963 /* Reset these values to zero because the produce_special_glyphs
2964 above has changed them. */
2965 it->pixel_width = it->ascent = it->descent = 0;
2966 it->phys_ascent = it->phys_descent = 0;
2968 /* Set this after getting the dimensions of truncation and
2969 continuation glyphs, so that we don't produce glyphs when calling
2970 produce_special_glyphs, above. */
2971 it->glyph_row = row;
2972 it->area = TEXT_AREA;
2974 /* Forget any previous info about this row being reversed. */
2975 if (it->glyph_row)
2976 it->glyph_row->reversed_p = 0;
2978 /* Get the dimensions of the display area. The display area
2979 consists of the visible window area plus a horizontally scrolled
2980 part to the left of the window. All x-values are relative to the
2981 start of this total display area. */
2982 if (base_face_id != DEFAULT_FACE_ID)
2984 /* Mode lines, menu bar in terminal frames. */
2985 it->first_visible_x = 0;
2986 it->last_visible_x = WINDOW_PIXEL_WIDTH (w);
2988 else
2990 it->first_visible_x
2991 = window_hscroll_limited (it->w, it->f) * FRAME_COLUMN_WIDTH (it->f);
2992 it->last_visible_x = (it->first_visible_x
2993 + window_box_width (w, TEXT_AREA));
2995 /* If we truncate lines, leave room for the truncation glyph(s) at
2996 the right margin. Otherwise, leave room for the continuation
2997 glyph(s). Done only if the window has no right fringe. */
2998 if (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
3000 if (it->line_wrap == TRUNCATE)
3001 it->last_visible_x -= it->truncation_pixel_width;
3002 else
3003 it->last_visible_x -= it->continuation_pixel_width;
3006 it->header_line_p = WINDOW_WANTS_HEADER_LINE_P (w);
3007 it->current_y = WINDOW_HEADER_LINE_HEIGHT (w) + w->vscroll;
3010 /* Leave room for a border glyph. */
3011 if (!FRAME_WINDOW_P (it->f)
3012 && !WINDOW_RIGHTMOST_P (it->w))
3013 it->last_visible_x -= 1;
3015 it->last_visible_y = window_text_bottom_y (w);
3017 /* For mode lines and alike, arrange for the first glyph having a
3018 left box line if the face specifies a box. */
3019 if (base_face_id != DEFAULT_FACE_ID)
3021 struct face *face;
3023 it->face_id = remapped_base_face_id;
3025 /* If we have a boxed mode line, make the first character appear
3026 with a left box line. */
3027 face = FACE_FROM_ID (it->f, remapped_base_face_id);
3028 if (face && face->box != FACE_NO_BOX)
3029 it->start_of_box_run_p = true;
3032 /* If a buffer position was specified, set the iterator there,
3033 getting overlays and face properties from that position. */
3034 if (charpos >= BUF_BEG (current_buffer))
3036 it->stop_charpos = charpos;
3037 it->end_charpos = ZV;
3038 eassert (charpos == BYTE_TO_CHAR (bytepos));
3039 IT_CHARPOS (*it) = charpos;
3040 IT_BYTEPOS (*it) = bytepos;
3042 /* We will rely on `reseat' to set this up properly, via
3043 handle_face_prop. */
3044 it->face_id = it->base_face_id;
3046 it->start = it->current;
3047 /* Do we need to reorder bidirectional text? Not if this is a
3048 unibyte buffer: by definition, none of the single-byte
3049 characters are strong R2L, so no reordering is needed. And
3050 bidi.c doesn't support unibyte buffers anyway. Also, don't
3051 reorder while we are loading loadup.el, since the tables of
3052 character properties needed for reordering are not yet
3053 available. */
3054 it->bidi_p =
3055 NILP (Vpurify_flag)
3056 && !NILP (BVAR (current_buffer, bidi_display_reordering))
3057 && it->multibyte_p;
3059 /* If we are to reorder bidirectional text, init the bidi
3060 iterator. */
3061 if (it->bidi_p)
3063 /* Since we don't know at this point whether there will be
3064 any R2L lines in the window, we reserve space for
3065 truncation/continuation glyphs even if only the left
3066 fringe is absent. */
3067 if (base_face_id == DEFAULT_FACE_ID
3068 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
3069 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
3071 if (it->line_wrap == TRUNCATE)
3072 it->last_visible_x -= it->truncation_pixel_width;
3073 else
3074 it->last_visible_x -= it->continuation_pixel_width;
3076 /* Note the paragraph direction that this buffer wants to
3077 use. */
3078 if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
3079 Qleft_to_right))
3080 it->paragraph_embedding = L2R;
3081 else if (EQ (BVAR (current_buffer, bidi_paragraph_direction),
3082 Qright_to_left))
3083 it->paragraph_embedding = R2L;
3084 else
3085 it->paragraph_embedding = NEUTRAL_DIR;
3086 bidi_unshelve_cache (NULL, 0);
3087 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
3088 &it->bidi_it);
3091 /* Compute faces etc. */
3092 reseat (it, it->current.pos, 1);
3095 CHECK_IT (it);
3099 /* Initialize IT for the display of window W with window start POS. */
3101 void
3102 start_display (struct it *it, struct window *w, struct text_pos pos)
3104 struct glyph_row *row;
3105 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
3107 row = w->desired_matrix->rows + first_vpos;
3108 init_iterator (it, w, CHARPOS (pos), BYTEPOS (pos), row, DEFAULT_FACE_ID);
3109 it->first_vpos = first_vpos;
3111 /* Don't reseat to previous visible line start if current start
3112 position is in a string or image. */
3113 if (it->method == GET_FROM_BUFFER && it->line_wrap != TRUNCATE)
3115 int start_at_line_beg_p;
3116 int first_y = it->current_y;
3118 /* If window start is not at a line start, skip forward to POS to
3119 get the correct continuation lines width. */
3120 start_at_line_beg_p = (CHARPOS (pos) == BEGV
3121 || FETCH_BYTE (BYTEPOS (pos) - 1) == '\n');
3122 if (!start_at_line_beg_p)
3124 int new_x;
3126 reseat_at_previous_visible_line_start (it);
3127 move_it_to (it, CHARPOS (pos), -1, -1, -1, MOVE_TO_POS);
3129 new_x = it->current_x + it->pixel_width;
3131 /* If lines are continued, this line may end in the middle
3132 of a multi-glyph character (e.g. a control character
3133 displayed as \003, or in the middle of an overlay
3134 string). In this case move_it_to above will not have
3135 taken us to the start of the continuation line but to the
3136 end of the continued line. */
3137 if (it->current_x > 0
3138 && it->line_wrap != TRUNCATE /* Lines are continued. */
3139 && (/* And glyph doesn't fit on the line. */
3140 new_x > it->last_visible_x
3141 /* Or it fits exactly and we're on a window
3142 system frame. */
3143 || (new_x == it->last_visible_x
3144 && FRAME_WINDOW_P (it->f)
3145 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
3146 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
3147 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
3149 if ((it->current.dpvec_index >= 0
3150 || it->current.overlay_string_index >= 0)
3151 /* If we are on a newline from a display vector or
3152 overlay string, then we are already at the end of
3153 a screen line; no need to go to the next line in
3154 that case, as this line is not really continued.
3155 (If we do go to the next line, C-e will not DTRT.) */
3156 && it->c != '\n')
3158 set_iterator_to_next (it, 1);
3159 move_it_in_display_line_to (it, -1, -1, 0);
3162 it->continuation_lines_width += it->current_x;
3164 /* If the character at POS is displayed via a display
3165 vector, move_it_to above stops at the final glyph of
3166 IT->dpvec. To make the caller redisplay that character
3167 again (a.k.a. start at POS), we need to reset the
3168 dpvec_index to the beginning of IT->dpvec. */
3169 else if (it->current.dpvec_index >= 0)
3170 it->current.dpvec_index = 0;
3172 /* We're starting a new display line, not affected by the
3173 height of the continued line, so clear the appropriate
3174 fields in the iterator structure. */
3175 it->max_ascent = it->max_descent = 0;
3176 it->max_phys_ascent = it->max_phys_descent = 0;
3178 it->current_y = first_y;
3179 it->vpos = 0;
3180 it->current_x = it->hpos = 0;
3186 /* Return 1 if POS is a position in ellipses displayed for invisible
3187 text. W is the window we display, for text property lookup. */
3189 static int
3190 in_ellipses_for_invisible_text_p (struct display_pos *pos, struct window *w)
3192 Lisp_Object prop, window;
3193 int ellipses_p = 0;
3194 ptrdiff_t charpos = CHARPOS (pos->pos);
3196 /* If POS specifies a position in a display vector, this might
3197 be for an ellipsis displayed for invisible text. We won't
3198 get the iterator set up for delivering that ellipsis unless
3199 we make sure that it gets aware of the invisible text. */
3200 if (pos->dpvec_index >= 0
3201 && pos->overlay_string_index < 0
3202 && CHARPOS (pos->string_pos) < 0
3203 && charpos > BEGV
3204 && (XSETWINDOW (window, w),
3205 prop = Fget_char_property (make_number (charpos),
3206 Qinvisible, window),
3207 !TEXT_PROP_MEANS_INVISIBLE (prop)))
3209 prop = Fget_char_property (make_number (charpos - 1), Qinvisible,
3210 window);
3211 ellipses_p = 2 == TEXT_PROP_MEANS_INVISIBLE (prop);
3214 return ellipses_p;
3218 /* Initialize IT for stepping through current_buffer in window W,
3219 starting at position POS that includes overlay string and display
3220 vector/ control character translation position information. Value
3221 is zero if there are overlay strings with newlines at POS. */
3223 static int
3224 init_from_display_pos (struct it *it, struct window *w, struct display_pos *pos)
3226 ptrdiff_t charpos = CHARPOS (pos->pos), bytepos = BYTEPOS (pos->pos);
3227 int i, overlay_strings_with_newlines = 0;
3229 /* If POS specifies a position in a display vector, this might
3230 be for an ellipsis displayed for invisible text. We won't
3231 get the iterator set up for delivering that ellipsis unless
3232 we make sure that it gets aware of the invisible text. */
3233 if (in_ellipses_for_invisible_text_p (pos, w))
3235 --charpos;
3236 bytepos = 0;
3239 /* Keep in mind: the call to reseat in init_iterator skips invisible
3240 text, so we might end up at a position different from POS. This
3241 is only a problem when POS is a row start after a newline and an
3242 overlay starts there with an after-string, and the overlay has an
3243 invisible property. Since we don't skip invisible text in
3244 display_line and elsewhere immediately after consuming the
3245 newline before the row start, such a POS will not be in a string,
3246 but the call to init_iterator below will move us to the
3247 after-string. */
3248 init_iterator (it, w, charpos, bytepos, NULL, DEFAULT_FACE_ID);
3250 /* This only scans the current chunk -- it should scan all chunks.
3251 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3252 to 16 in 22.1 to make this a lesser problem. */
3253 for (i = 0; i < it->n_overlay_strings && i < OVERLAY_STRING_CHUNK_SIZE; ++i)
3255 const char *s = SSDATA (it->overlay_strings[i]);
3256 const char *e = s + SBYTES (it->overlay_strings[i]);
3258 while (s < e && *s != '\n')
3259 ++s;
3261 if (s < e)
3263 overlay_strings_with_newlines = 1;
3264 break;
3268 /* If position is within an overlay string, set up IT to the right
3269 overlay string. */
3270 if (pos->overlay_string_index >= 0)
3272 int relative_index;
3274 /* If the first overlay string happens to have a `display'
3275 property for an image, the iterator will be set up for that
3276 image, and we have to undo that setup first before we can
3277 correct the overlay string index. */
3278 if (it->method == GET_FROM_IMAGE)
3279 pop_it (it);
3281 /* We already have the first chunk of overlay strings in
3282 IT->overlay_strings. Load more until the one for
3283 pos->overlay_string_index is in IT->overlay_strings. */
3284 if (pos->overlay_string_index >= OVERLAY_STRING_CHUNK_SIZE)
3286 ptrdiff_t n = pos->overlay_string_index / OVERLAY_STRING_CHUNK_SIZE;
3287 it->current.overlay_string_index = 0;
3288 while (n--)
3290 load_overlay_strings (it, 0);
3291 it->current.overlay_string_index += OVERLAY_STRING_CHUNK_SIZE;
3295 it->current.overlay_string_index = pos->overlay_string_index;
3296 relative_index = (it->current.overlay_string_index
3297 % OVERLAY_STRING_CHUNK_SIZE);
3298 it->string = it->overlay_strings[relative_index];
3299 eassert (STRINGP (it->string));
3300 it->current.string_pos = pos->string_pos;
3301 it->method = GET_FROM_STRING;
3302 it->end_charpos = SCHARS (it->string);
3303 /* Set up the bidi iterator for this overlay string. */
3304 if (it->bidi_p)
3306 it->bidi_it.string.lstring = it->string;
3307 it->bidi_it.string.s = NULL;
3308 it->bidi_it.string.schars = SCHARS (it->string);
3309 it->bidi_it.string.bufpos = it->overlay_strings_charpos;
3310 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
3311 it->bidi_it.string.unibyte = !it->multibyte_p;
3312 it->bidi_it.w = it->w;
3313 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3314 FRAME_WINDOW_P (it->f), &it->bidi_it);
3316 /* Synchronize the state of the bidi iterator with
3317 pos->string_pos. For any string position other than
3318 zero, this will be done automagically when we resume
3319 iteration over the string and get_visually_first_element
3320 is called. But if string_pos is zero, and the string is
3321 to be reordered for display, we need to resync manually,
3322 since it could be that the iteration state recorded in
3323 pos ended at string_pos of 0 moving backwards in string. */
3324 if (CHARPOS (pos->string_pos) == 0)
3326 get_visually_first_element (it);
3327 if (IT_STRING_CHARPOS (*it) != 0)
3328 do {
3329 /* Paranoia. */
3330 eassert (it->bidi_it.charpos < it->bidi_it.string.schars);
3331 bidi_move_to_visually_next (&it->bidi_it);
3332 } while (it->bidi_it.charpos != 0);
3334 eassert (IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
3335 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos);
3339 if (CHARPOS (pos->string_pos) >= 0)
3341 /* Recorded position is not in an overlay string, but in another
3342 string. This can only be a string from a `display' property.
3343 IT should already be filled with that string. */
3344 it->current.string_pos = pos->string_pos;
3345 eassert (STRINGP (it->string));
3346 if (it->bidi_p)
3347 bidi_init_it (IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it),
3348 FRAME_WINDOW_P (it->f), &it->bidi_it);
3351 /* Restore position in display vector translations, control
3352 character translations or ellipses. */
3353 if (pos->dpvec_index >= 0)
3355 if (it->dpvec == NULL)
3356 get_next_display_element (it);
3357 eassert (it->dpvec && it->current.dpvec_index == 0);
3358 it->current.dpvec_index = pos->dpvec_index;
3361 CHECK_IT (it);
3362 return !overlay_strings_with_newlines;
3366 /* Initialize IT for stepping through current_buffer in window W
3367 starting at ROW->start. */
3369 static void
3370 init_to_row_start (struct it *it, struct window *w, struct glyph_row *row)
3372 init_from_display_pos (it, w, &row->start);
3373 it->start = row->start;
3374 it->continuation_lines_width = row->continuation_lines_width;
3375 CHECK_IT (it);
3379 /* Initialize IT for stepping through current_buffer in window W
3380 starting in the line following ROW, i.e. starting at ROW->end.
3381 Value is zero if there are overlay strings with newlines at ROW's
3382 end position. */
3384 static int
3385 init_to_row_end (struct it *it, struct window *w, struct glyph_row *row)
3387 int success = 0;
3389 if (init_from_display_pos (it, w, &row->end))
3391 if (row->continued_p)
3392 it->continuation_lines_width
3393 = row->continuation_lines_width + row->pixel_width;
3394 CHECK_IT (it);
3395 success = 1;
3398 return success;
3404 /***********************************************************************
3405 Text properties
3406 ***********************************************************************/
3408 /* Called when IT reaches IT->stop_charpos. Handle text property and
3409 overlay changes. Set IT->stop_charpos to the next position where
3410 to stop. */
3412 static void
3413 handle_stop (struct it *it)
3415 enum prop_handled handled;
3416 int handle_overlay_change_p;
3417 struct props *p;
3419 it->dpvec = NULL;
3420 it->current.dpvec_index = -1;
3421 handle_overlay_change_p = !it->ignore_overlay_strings_at_pos_p;
3422 it->ignore_overlay_strings_at_pos_p = 0;
3423 it->ellipsis_p = 0;
3425 /* Use face of preceding text for ellipsis (if invisible) */
3426 if (it->selective_display_ellipsis_p)
3427 it->saved_face_id = it->face_id;
3429 /* Here's the description of the semantics of, and the logic behind,
3430 the various HANDLED_* statuses:
3432 HANDLED_NORMALLY means the handler did its job, and the loop
3433 should proceed to calling the next handler in order.
3435 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3436 change in the properties and overlays at current position, so the
3437 loop should be restarted, to re-invoke the handlers that were
3438 already called. This happens when fontification-functions were
3439 called by handle_fontified_prop, and actually fontified
3440 something. Another case where HANDLED_RECOMPUTE_PROPS is
3441 returned is when we discover overlay strings that need to be
3442 displayed right away. The loop below will continue for as long
3443 as the status is HANDLED_RECOMPUTE_PROPS.
3445 HANDLED_RETURN means return immediately to the caller, to
3446 continue iteration without calling any further handlers. This is
3447 used when we need to act on some property right away, for example
3448 when we need to display the ellipsis or a replacing display
3449 property, such as display string or image.
3451 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3452 consumed, and the handler switched to the next overlay string.
3453 This signals the loop below to refrain from looking for more
3454 overlays before all the overlay strings of the current overlay
3455 are processed.
3457 Some of the handlers called by the loop push the iterator state
3458 onto the stack (see 'push_it'), and arrange for the iteration to
3459 continue with another object, such as an image, a display string,
3460 or an overlay string. In most such cases, it->stop_charpos is
3461 set to the first character of the string, so that when the
3462 iteration resumes, this function will immediately be called
3463 again, to examine the properties at the beginning of the string.
3465 When a display or overlay string is exhausted, the iterator state
3466 is popped (see 'pop_it'), and iteration continues with the
3467 previous object. Again, in many such cases this function is
3468 called again to find the next position where properties might
3469 change. */
3473 handled = HANDLED_NORMALLY;
3475 /* Call text property handlers. */
3476 for (p = it_props; p->handler; ++p)
3478 handled = p->handler (it);
3480 if (handled == HANDLED_RECOMPUTE_PROPS)
3481 break;
3482 else if (handled == HANDLED_RETURN)
3484 /* We still want to show before and after strings from
3485 overlays even if the actual buffer text is replaced. */
3486 if (!handle_overlay_change_p
3487 || it->sp > 1
3488 /* Don't call get_overlay_strings_1 if we already
3489 have overlay strings loaded, because doing so
3490 will load them again and push the iterator state
3491 onto the stack one more time, which is not
3492 expected by the rest of the code that processes
3493 overlay strings. */
3494 || (it->current.overlay_string_index < 0
3495 ? !get_overlay_strings_1 (it, 0, 0)
3496 : 0))
3498 if (it->ellipsis_p)
3499 setup_for_ellipsis (it, 0);
3500 /* When handling a display spec, we might load an
3501 empty string. In that case, discard it here. We
3502 used to discard it in handle_single_display_spec,
3503 but that causes get_overlay_strings_1, above, to
3504 ignore overlay strings that we must check. */
3505 if (STRINGP (it->string) && !SCHARS (it->string))
3506 pop_it (it);
3507 return;
3509 else if (STRINGP (it->string) && !SCHARS (it->string))
3510 pop_it (it);
3511 else
3513 it->ignore_overlay_strings_at_pos_p = true;
3514 it->string_from_display_prop_p = 0;
3515 it->from_disp_prop_p = 0;
3516 handle_overlay_change_p = 0;
3518 handled = HANDLED_RECOMPUTE_PROPS;
3519 break;
3521 else if (handled == HANDLED_OVERLAY_STRING_CONSUMED)
3522 handle_overlay_change_p = 0;
3525 if (handled != HANDLED_RECOMPUTE_PROPS)
3527 /* Don't check for overlay strings below when set to deliver
3528 characters from a display vector. */
3529 if (it->method == GET_FROM_DISPLAY_VECTOR)
3530 handle_overlay_change_p = 0;
3532 /* Handle overlay changes.
3533 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3534 if it finds overlays. */
3535 if (handle_overlay_change_p)
3536 handled = handle_overlay_change (it);
3539 if (it->ellipsis_p)
3541 setup_for_ellipsis (it, 0);
3542 break;
3545 while (handled == HANDLED_RECOMPUTE_PROPS);
3547 /* Determine where to stop next. */
3548 if (handled == HANDLED_NORMALLY)
3549 compute_stop_pos (it);
3553 /* Compute IT->stop_charpos from text property and overlay change
3554 information for IT's current position. */
3556 static void
3557 compute_stop_pos (struct it *it)
3559 register INTERVAL iv, next_iv;
3560 Lisp_Object object, limit, position;
3561 ptrdiff_t charpos, bytepos;
3563 if (STRINGP (it->string))
3565 /* Strings are usually short, so don't limit the search for
3566 properties. */
3567 it->stop_charpos = it->end_charpos;
3568 object = it->string;
3569 limit = Qnil;
3570 charpos = IT_STRING_CHARPOS (*it);
3571 bytepos = IT_STRING_BYTEPOS (*it);
3573 else
3575 ptrdiff_t pos;
3577 /* If end_charpos is out of range for some reason, such as a
3578 misbehaving display function, rationalize it (Bug#5984). */
3579 if (it->end_charpos > ZV)
3580 it->end_charpos = ZV;
3581 it->stop_charpos = it->end_charpos;
3583 /* If next overlay change is in front of the current stop pos
3584 (which is IT->end_charpos), stop there. Note: value of
3585 next_overlay_change is point-max if no overlay change
3586 follows. */
3587 charpos = IT_CHARPOS (*it);
3588 bytepos = IT_BYTEPOS (*it);
3589 pos = next_overlay_change (charpos);
3590 if (pos < it->stop_charpos)
3591 it->stop_charpos = pos;
3593 /* Set up variables for computing the stop position from text
3594 property changes. */
3595 XSETBUFFER (object, current_buffer);
3596 limit = make_number (IT_CHARPOS (*it) + TEXT_PROP_DISTANCE_LIMIT);
3599 /* Get the interval containing IT's position. Value is a null
3600 interval if there isn't such an interval. */
3601 position = make_number (charpos);
3602 iv = validate_interval_range (object, &position, &position, 0);
3603 if (iv)
3605 Lisp_Object values_here[LAST_PROP_IDX];
3606 struct props *p;
3608 /* Get properties here. */
3609 for (p = it_props; p->handler; ++p)
3610 values_here[p->idx] = textget (iv->plist, *p->name);
3612 /* Look for an interval following iv that has different
3613 properties. */
3614 for (next_iv = next_interval (iv);
3615 (next_iv
3616 && (NILP (limit)
3617 || XFASTINT (limit) > next_iv->position));
3618 next_iv = next_interval (next_iv))
3620 for (p = it_props; p->handler; ++p)
3622 Lisp_Object new_value;
3624 new_value = textget (next_iv->plist, *p->name);
3625 if (!EQ (values_here[p->idx], new_value))
3626 break;
3629 if (p->handler)
3630 break;
3633 if (next_iv)
3635 if (INTEGERP (limit)
3636 && next_iv->position >= XFASTINT (limit))
3637 /* No text property change up to limit. */
3638 it->stop_charpos = min (XFASTINT (limit), it->stop_charpos);
3639 else
3640 /* Text properties change in next_iv. */
3641 it->stop_charpos = min (it->stop_charpos, next_iv->position);
3645 if (it->cmp_it.id < 0)
3647 ptrdiff_t stoppos = it->end_charpos;
3649 if (it->bidi_p && it->bidi_it.scan_dir < 0)
3650 stoppos = -1;
3651 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos,
3652 stoppos, it->string);
3655 eassert (STRINGP (it->string)
3656 || (it->stop_charpos >= BEGV
3657 && it->stop_charpos >= IT_CHARPOS (*it)));
3661 /* Return the position of the next overlay change after POS in
3662 current_buffer. Value is point-max if no overlay change
3663 follows. This is like `next-overlay-change' but doesn't use
3664 xmalloc. */
3666 static ptrdiff_t
3667 next_overlay_change (ptrdiff_t pos)
3669 ptrdiff_t i, noverlays;
3670 ptrdiff_t endpos;
3671 Lisp_Object *overlays;
3673 /* Get all overlays at the given position. */
3674 GET_OVERLAYS_AT (pos, overlays, noverlays, &endpos, 1);
3676 /* If any of these overlays ends before endpos,
3677 use its ending point instead. */
3678 for (i = 0; i < noverlays; ++i)
3680 Lisp_Object oend;
3681 ptrdiff_t oendpos;
3683 oend = OVERLAY_END (overlays[i]);
3684 oendpos = OVERLAY_POSITION (oend);
3685 endpos = min (endpos, oendpos);
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 size = 20;
5749 ptrdiff_t n = 0, i, j;
5750 int invis_p;
5751 struct overlay_entry *entries = alloca (size * sizeof *entries);
5752 USE_SAFE_ALLOCA;
5754 if (charpos <= 0)
5755 charpos = IT_CHARPOS (*it);
5757 /* Append the overlay string STRING of overlay OVERLAY to vector
5758 `entries' which has size `size' and currently contains `n'
5759 elements. AFTER_P non-zero means STRING is an after-string of
5760 OVERLAY. */
5761 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5762 do \
5764 Lisp_Object priority; \
5766 if (n == size) \
5768 struct overlay_entry *old = entries; \
5769 SAFE_NALLOCA (entries, 2, size); \
5770 memcpy (entries, old, size * sizeof *entries); \
5771 size *= 2; \
5774 entries[n].string = (STRING); \
5775 entries[n].overlay = (OVERLAY); \
5776 priority = Foverlay_get ((OVERLAY), Qpriority); \
5777 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5778 entries[n].after_string_p = (AFTER_P); \
5779 ++n; \
5781 while (0)
5783 /* Process overlay before the overlay center. */
5784 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
5786 XSETMISC (overlay, ov);
5787 eassert (OVERLAYP (overlay));
5788 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5789 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5791 if (end < charpos)
5792 break;
5794 /* Skip this overlay if it doesn't start or end at IT's current
5795 position. */
5796 if (end != charpos && start != charpos)
5797 continue;
5799 /* Skip this overlay if it doesn't apply to IT->w. */
5800 window = Foverlay_get (overlay, Qwindow);
5801 if (WINDOWP (window) && XWINDOW (window) != it->w)
5802 continue;
5804 /* If the text ``under'' the overlay is invisible, both before-
5805 and after-strings from this overlay are visible; start and
5806 end position are indistinguishable. */
5807 invisible = Foverlay_get (overlay, Qinvisible);
5808 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5810 /* If overlay has a non-empty before-string, record it. */
5811 if ((start == charpos || (end == charpos && invis_p))
5812 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5813 && SCHARS (str))
5814 RECORD_OVERLAY_STRING (overlay, str, 0);
5816 /* If overlay has a non-empty after-string, record it. */
5817 if ((end == charpos || (start == charpos && invis_p))
5818 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5819 && SCHARS (str))
5820 RECORD_OVERLAY_STRING (overlay, str, 1);
5823 /* Process overlays after the overlay center. */
5824 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
5826 XSETMISC (overlay, ov);
5827 eassert (OVERLAYP (overlay));
5828 start = OVERLAY_POSITION (OVERLAY_START (overlay));
5829 end = OVERLAY_POSITION (OVERLAY_END (overlay));
5831 if (start > charpos)
5832 break;
5834 /* Skip this overlay if it doesn't start or end at IT's current
5835 position. */
5836 if (end != charpos && start != charpos)
5837 continue;
5839 /* Skip this overlay if it doesn't apply to IT->w. */
5840 window = Foverlay_get (overlay, Qwindow);
5841 if (WINDOWP (window) && XWINDOW (window) != it->w)
5842 continue;
5844 /* If the text ``under'' the overlay is invisible, it has a zero
5845 dimension, and both before- and after-strings apply. */
5846 invisible = Foverlay_get (overlay, Qinvisible);
5847 invis_p = TEXT_PROP_MEANS_INVISIBLE (invisible);
5849 /* If overlay has a non-empty before-string, record it. */
5850 if ((start == charpos || (end == charpos && invis_p))
5851 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str))
5852 && SCHARS (str))
5853 RECORD_OVERLAY_STRING (overlay, str, 0);
5855 /* If overlay has a non-empty after-string, record it. */
5856 if ((end == charpos || (start == charpos && invis_p))
5857 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str))
5858 && SCHARS (str))
5859 RECORD_OVERLAY_STRING (overlay, str, 1);
5862 #undef RECORD_OVERLAY_STRING
5864 /* Sort entries. */
5865 if (n > 1)
5866 qsort (entries, n, sizeof *entries, compare_overlay_entries);
5868 /* Record number of overlay strings, and where we computed it. */
5869 it->n_overlay_strings = n;
5870 it->overlay_strings_charpos = charpos;
5872 /* IT->current.overlay_string_index is the number of overlay strings
5873 that have already been consumed by IT. Copy some of the
5874 remaining overlay strings to IT->overlay_strings. */
5875 i = 0;
5876 j = it->current.overlay_string_index;
5877 while (i < OVERLAY_STRING_CHUNK_SIZE && j < n)
5879 it->overlay_strings[i] = entries[j].string;
5880 it->string_overlays[i++] = entries[j++].overlay;
5883 CHECK_IT (it);
5884 SAFE_FREE ();
5888 /* Get the first chunk of overlay strings at IT's current buffer
5889 position, or at CHARPOS if that is > 0. Value is non-zero if at
5890 least one overlay string was found. */
5892 static int
5893 get_overlay_strings_1 (struct it *it, ptrdiff_t charpos, int compute_stop_p)
5895 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5896 process. This fills IT->overlay_strings with strings, and sets
5897 IT->n_overlay_strings to the total number of strings to process.
5898 IT->pos.overlay_string_index has to be set temporarily to zero
5899 because load_overlay_strings needs this; it must be set to -1
5900 when no overlay strings are found because a zero value would
5901 indicate a position in the first overlay string. */
5902 it->current.overlay_string_index = 0;
5903 load_overlay_strings (it, charpos);
5905 /* If we found overlay strings, set up IT to deliver display
5906 elements from the first one. Otherwise set up IT to deliver
5907 from current_buffer. */
5908 if (it->n_overlay_strings)
5910 /* Make sure we know settings in current_buffer, so that we can
5911 restore meaningful values when we're done with the overlay
5912 strings. */
5913 if (compute_stop_p)
5914 compute_stop_pos (it);
5915 eassert (it->face_id >= 0);
5917 /* Save IT's settings. They are restored after all overlay
5918 strings have been processed. */
5919 eassert (!compute_stop_p || it->sp == 0);
5921 /* When called from handle_stop, there might be an empty display
5922 string loaded. In that case, don't bother saving it. But
5923 don't use this optimization with the bidi iterator, since we
5924 need the corresponding pop_it call to resync the bidi
5925 iterator's position with IT's position, after we are done
5926 with the overlay strings. (The corresponding call to pop_it
5927 in case of an empty display string is in
5928 next_overlay_string.) */
5929 if (!(!it->bidi_p
5930 && STRINGP (it->string) && !SCHARS (it->string)))
5931 push_it (it, NULL);
5933 /* Set up IT to deliver display elements from the first overlay
5934 string. */
5935 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
5936 it->string = it->overlay_strings[0];
5937 it->from_overlay = Qnil;
5938 it->stop_charpos = 0;
5939 eassert (STRINGP (it->string));
5940 it->end_charpos = SCHARS (it->string);
5941 it->prev_stop = 0;
5942 it->base_level_stop = 0;
5943 it->multibyte_p = STRING_MULTIBYTE (it->string);
5944 it->method = GET_FROM_STRING;
5945 it->from_disp_prop_p = 0;
5947 /* Force paragraph direction to be that of the parent
5948 buffer. */
5949 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
5950 it->paragraph_embedding = it->bidi_it.paragraph_dir;
5951 else
5952 it->paragraph_embedding = L2R;
5954 /* Set up the bidi iterator for this overlay string. */
5955 if (it->bidi_p)
5957 ptrdiff_t pos = (charpos > 0 ? charpos : IT_CHARPOS (*it));
5959 it->bidi_it.string.lstring = it->string;
5960 it->bidi_it.string.s = NULL;
5961 it->bidi_it.string.schars = SCHARS (it->string);
5962 it->bidi_it.string.bufpos = pos;
5963 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
5964 it->bidi_it.string.unibyte = !it->multibyte_p;
5965 it->bidi_it.w = it->w;
5966 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
5968 return 1;
5971 it->current.overlay_string_index = -1;
5972 return 0;
5975 static int
5976 get_overlay_strings (struct it *it, ptrdiff_t charpos)
5978 it->string = Qnil;
5979 it->method = GET_FROM_BUFFER;
5981 (void) get_overlay_strings_1 (it, charpos, 1);
5983 CHECK_IT (it);
5985 /* Value is non-zero if we found at least one overlay string. */
5986 return STRINGP (it->string);
5991 /***********************************************************************
5992 Saving and restoring state
5993 ***********************************************************************/
5995 /* Save current settings of IT on IT->stack. Called, for example,
5996 before setting up IT for an overlay string, to be able to restore
5997 IT's settings to what they were after the overlay string has been
5998 processed. If POSITION is non-NULL, it is the position to save on
5999 the stack instead of IT->position. */
6001 static void
6002 push_it (struct it *it, struct text_pos *position)
6004 struct iterator_stack_entry *p;
6006 eassert (it->sp < IT_STACK_SIZE);
6007 p = it->stack + it->sp;
6009 p->stop_charpos = it->stop_charpos;
6010 p->prev_stop = it->prev_stop;
6011 p->base_level_stop = it->base_level_stop;
6012 p->cmp_it = it->cmp_it;
6013 eassert (it->face_id >= 0);
6014 p->face_id = it->face_id;
6015 p->string = it->string;
6016 p->method = it->method;
6017 p->from_overlay = it->from_overlay;
6018 switch (p->method)
6020 case GET_FROM_IMAGE:
6021 p->u.image.object = it->object;
6022 p->u.image.image_id = it->image_id;
6023 p->u.image.slice = it->slice;
6024 break;
6025 case GET_FROM_STRETCH:
6026 p->u.stretch.object = it->object;
6027 break;
6029 p->position = position ? *position : it->position;
6030 p->current = it->current;
6031 p->end_charpos = it->end_charpos;
6032 p->string_nchars = it->string_nchars;
6033 p->area = it->area;
6034 p->multibyte_p = it->multibyte_p;
6035 p->avoid_cursor_p = it->avoid_cursor_p;
6036 p->space_width = it->space_width;
6037 p->font_height = it->font_height;
6038 p->voffset = it->voffset;
6039 p->string_from_display_prop_p = it->string_from_display_prop_p;
6040 p->string_from_prefix_prop_p = it->string_from_prefix_prop_p;
6041 p->display_ellipsis_p = 0;
6042 p->line_wrap = it->line_wrap;
6043 p->bidi_p = it->bidi_p;
6044 p->paragraph_embedding = it->paragraph_embedding;
6045 p->from_disp_prop_p = it->from_disp_prop_p;
6046 ++it->sp;
6048 /* Save the state of the bidi iterator as well. */
6049 if (it->bidi_p)
6050 bidi_push_it (&it->bidi_it);
6053 static void
6054 iterate_out_of_display_property (struct it *it)
6056 int buffer_p = !STRINGP (it->string);
6057 ptrdiff_t eob = (buffer_p ? ZV : it->end_charpos);
6058 ptrdiff_t bob = (buffer_p ? BEGV : 0);
6060 eassert (eob >= CHARPOS (it->position) && CHARPOS (it->position) >= bob);
6062 /* Maybe initialize paragraph direction. If we are at the beginning
6063 of a new paragraph, next_element_from_buffer may not have a
6064 chance to do that. */
6065 if (it->bidi_it.first_elt && it->bidi_it.charpos < eob)
6066 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
6067 /* prev_stop can be zero, so check against BEGV as well. */
6068 while (it->bidi_it.charpos >= bob
6069 && it->prev_stop <= it->bidi_it.charpos
6070 && it->bidi_it.charpos < CHARPOS (it->position)
6071 && it->bidi_it.charpos < eob)
6072 bidi_move_to_visually_next (&it->bidi_it);
6073 /* Record the stop_pos we just crossed, for when we cross it
6074 back, maybe. */
6075 if (it->bidi_it.charpos > CHARPOS (it->position))
6076 it->prev_stop = CHARPOS (it->position);
6077 /* If we ended up not where pop_it put us, resync IT's
6078 positional members with the bidi iterator. */
6079 if (it->bidi_it.charpos != CHARPOS (it->position))
6080 SET_TEXT_POS (it->position, it->bidi_it.charpos, it->bidi_it.bytepos);
6081 if (buffer_p)
6082 it->current.pos = it->position;
6083 else
6084 it->current.string_pos = it->position;
6087 /* Restore IT's settings from IT->stack. Called, for example, when no
6088 more overlay strings must be processed, and we return to delivering
6089 display elements from a buffer, or when the end of a string from a
6090 `display' property is reached and we return to delivering display
6091 elements from an overlay string, or from a buffer. */
6093 static void
6094 pop_it (struct it *it)
6096 struct iterator_stack_entry *p;
6097 int from_display_prop = it->from_disp_prop_p;
6099 eassert (it->sp > 0);
6100 --it->sp;
6101 p = it->stack + it->sp;
6102 it->stop_charpos = p->stop_charpos;
6103 it->prev_stop = p->prev_stop;
6104 it->base_level_stop = p->base_level_stop;
6105 it->cmp_it = p->cmp_it;
6106 it->face_id = p->face_id;
6107 it->current = p->current;
6108 it->position = p->position;
6109 it->string = p->string;
6110 it->from_overlay = p->from_overlay;
6111 if (NILP (it->string))
6112 SET_TEXT_POS (it->current.string_pos, -1, -1);
6113 it->method = p->method;
6114 switch (it->method)
6116 case GET_FROM_IMAGE:
6117 it->image_id = p->u.image.image_id;
6118 it->object = p->u.image.object;
6119 it->slice = p->u.image.slice;
6120 break;
6121 case GET_FROM_STRETCH:
6122 it->object = p->u.stretch.object;
6123 break;
6124 case GET_FROM_BUFFER:
6125 it->object = it->w->contents;
6126 break;
6127 case GET_FROM_STRING:
6129 struct face *face = FACE_FROM_ID (it->f, it->face_id);
6131 /* Restore the face_box_p flag, since it could have been
6132 overwritten by the face of the object that we just finished
6133 displaying. */
6134 if (face)
6135 it->face_box_p = face->box != FACE_NO_BOX;
6136 it->object = it->string;
6138 break;
6139 case GET_FROM_DISPLAY_VECTOR:
6140 if (it->s)
6141 it->method = GET_FROM_C_STRING;
6142 else if (STRINGP (it->string))
6143 it->method = GET_FROM_STRING;
6144 else
6146 it->method = GET_FROM_BUFFER;
6147 it->object = it->w->contents;
6150 it->end_charpos = p->end_charpos;
6151 it->string_nchars = p->string_nchars;
6152 it->area = p->area;
6153 it->multibyte_p = p->multibyte_p;
6154 it->avoid_cursor_p = p->avoid_cursor_p;
6155 it->space_width = p->space_width;
6156 it->font_height = p->font_height;
6157 it->voffset = p->voffset;
6158 it->string_from_display_prop_p = p->string_from_display_prop_p;
6159 it->string_from_prefix_prop_p = p->string_from_prefix_prop_p;
6160 it->line_wrap = p->line_wrap;
6161 it->bidi_p = p->bidi_p;
6162 it->paragraph_embedding = p->paragraph_embedding;
6163 it->from_disp_prop_p = p->from_disp_prop_p;
6164 if (it->bidi_p)
6166 bidi_pop_it (&it->bidi_it);
6167 /* Bidi-iterate until we get out of the portion of text, if any,
6168 covered by a `display' text property or by an overlay with
6169 `display' property. (We cannot just jump there, because the
6170 internal coherency of the bidi iterator state can not be
6171 preserved across such jumps.) We also must determine the
6172 paragraph base direction if the overlay we just processed is
6173 at the beginning of a new paragraph. */
6174 if (from_display_prop
6175 && (it->method == GET_FROM_BUFFER || it->method == GET_FROM_STRING))
6176 iterate_out_of_display_property (it);
6178 eassert ((BUFFERP (it->object)
6179 && IT_CHARPOS (*it) == it->bidi_it.charpos
6180 && IT_BYTEPOS (*it) == it->bidi_it.bytepos)
6181 || (STRINGP (it->object)
6182 && IT_STRING_CHARPOS (*it) == it->bidi_it.charpos
6183 && IT_STRING_BYTEPOS (*it) == it->bidi_it.bytepos)
6184 || (CONSP (it->object) && it->method == GET_FROM_STRETCH));
6190 /***********************************************************************
6191 Moving over lines
6192 ***********************************************************************/
6194 /* Set IT's current position to the previous line start. */
6196 static void
6197 back_to_previous_line_start (struct it *it)
6199 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
6201 DEC_BOTH (cp, bp);
6202 IT_CHARPOS (*it) = find_newline_no_quit (cp, bp, -1, &IT_BYTEPOS (*it));
6206 /* Move IT to the next line start.
6208 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6209 we skipped over part of the text (as opposed to moving the iterator
6210 continuously over the text). Otherwise, don't change the value
6211 of *SKIPPED_P.
6213 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6214 iterator on the newline, if it was found.
6216 Newlines may come from buffer text, overlay strings, or strings
6217 displayed via the `display' property. That's the reason we can't
6218 simply use find_newline_no_quit.
6220 Note that this function may not skip over invisible text that is so
6221 because of text properties and immediately follows a newline. If
6222 it would, function reseat_at_next_visible_line_start, when called
6223 from set_iterator_to_next, would effectively make invisible
6224 characters following a newline part of the wrong glyph row, which
6225 leads to wrong cursor motion. */
6227 static int
6228 forward_to_next_line_start (struct it *it, int *skipped_p,
6229 struct bidi_it *bidi_it_prev)
6231 ptrdiff_t old_selective;
6232 int newline_found_p, n;
6233 const int MAX_NEWLINE_DISTANCE = 500;
6235 /* If already on a newline, just consume it to avoid unintended
6236 skipping over invisible text below. */
6237 if (it->what == IT_CHARACTER
6238 && it->c == '\n'
6239 && CHARPOS (it->position) == IT_CHARPOS (*it))
6241 if (it->bidi_p && bidi_it_prev)
6242 *bidi_it_prev = it->bidi_it;
6243 set_iterator_to_next (it, 0);
6244 it->c = 0;
6245 return 1;
6248 /* Don't handle selective display in the following. It's (a)
6249 unnecessary because it's done by the caller, and (b) leads to an
6250 infinite recursion because next_element_from_ellipsis indirectly
6251 calls this function. */
6252 old_selective = it->selective;
6253 it->selective = 0;
6255 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6256 from buffer text. */
6257 for (n = newline_found_p = 0;
6258 !newline_found_p && n < MAX_NEWLINE_DISTANCE;
6259 n += STRINGP (it->string) ? 0 : 1)
6261 if (!get_next_display_element (it))
6262 return 0;
6263 newline_found_p = it->what == IT_CHARACTER && it->c == '\n';
6264 if (newline_found_p && it->bidi_p && bidi_it_prev)
6265 *bidi_it_prev = it->bidi_it;
6266 set_iterator_to_next (it, 0);
6269 /* If we didn't find a newline near enough, see if we can use a
6270 short-cut. */
6271 if (!newline_found_p)
6273 ptrdiff_t bytepos, start = IT_CHARPOS (*it);
6274 ptrdiff_t limit = find_newline_no_quit (start, IT_BYTEPOS (*it),
6275 1, &bytepos);
6276 Lisp_Object pos;
6278 eassert (!STRINGP (it->string));
6280 /* If there isn't any `display' property in sight, and no
6281 overlays, we can just use the position of the newline in
6282 buffer text. */
6283 if (it->stop_charpos >= limit
6284 || ((pos = Fnext_single_property_change (make_number (start),
6285 Qdisplay, Qnil,
6286 make_number (limit)),
6287 NILP (pos))
6288 && next_overlay_change (start) == ZV))
6290 if (!it->bidi_p)
6292 IT_CHARPOS (*it) = limit;
6293 IT_BYTEPOS (*it) = bytepos;
6295 else
6297 struct bidi_it bprev;
6299 /* Help bidi.c avoid expensive searches for display
6300 properties and overlays, by telling it that there are
6301 none up to `limit'. */
6302 if (it->bidi_it.disp_pos < limit)
6304 it->bidi_it.disp_pos = limit;
6305 it->bidi_it.disp_prop = 0;
6307 do {
6308 bprev = it->bidi_it;
6309 bidi_move_to_visually_next (&it->bidi_it);
6310 } while (it->bidi_it.charpos != limit);
6311 IT_CHARPOS (*it) = limit;
6312 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6313 if (bidi_it_prev)
6314 *bidi_it_prev = bprev;
6316 *skipped_p = newline_found_p = true;
6318 else
6320 while (get_next_display_element (it)
6321 && !newline_found_p)
6323 newline_found_p = ITERATOR_AT_END_OF_LINE_P (it);
6324 if (newline_found_p && it->bidi_p && bidi_it_prev)
6325 *bidi_it_prev = it->bidi_it;
6326 set_iterator_to_next (it, 0);
6331 it->selective = old_selective;
6332 return newline_found_p;
6336 /* Set IT's current position to the previous visible line start. Skip
6337 invisible text that is so either due to text properties or due to
6338 selective display. Caution: this does not change IT->current_x and
6339 IT->hpos. */
6341 static void
6342 back_to_previous_visible_line_start (struct it *it)
6344 while (IT_CHARPOS (*it) > BEGV)
6346 back_to_previous_line_start (it);
6348 if (IT_CHARPOS (*it) <= BEGV)
6349 break;
6351 /* If selective > 0, then lines indented more than its value are
6352 invisible. */
6353 if (it->selective > 0
6354 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6355 it->selective))
6356 continue;
6358 /* Check the newline before point for invisibility. */
6360 Lisp_Object prop;
6361 prop = Fget_char_property (make_number (IT_CHARPOS (*it) - 1),
6362 Qinvisible, it->window);
6363 if (TEXT_PROP_MEANS_INVISIBLE (prop))
6364 continue;
6367 if (IT_CHARPOS (*it) <= BEGV)
6368 break;
6371 struct it it2;
6372 void *it2data = NULL;
6373 ptrdiff_t pos;
6374 ptrdiff_t beg, end;
6375 Lisp_Object val, overlay;
6377 SAVE_IT (it2, *it, it2data);
6379 /* If newline is part of a composition, continue from start of composition */
6380 if (find_composition (IT_CHARPOS (*it), -1, &beg, &end, &val, Qnil)
6381 && beg < IT_CHARPOS (*it))
6382 goto replaced;
6384 /* If newline is replaced by a display property, find start of overlay
6385 or interval and continue search from that point. */
6386 pos = --IT_CHARPOS (it2);
6387 --IT_BYTEPOS (it2);
6388 it2.sp = 0;
6389 bidi_unshelve_cache (NULL, 0);
6390 it2.string_from_display_prop_p = 0;
6391 it2.from_disp_prop_p = 0;
6392 if (handle_display_prop (&it2) == HANDLED_RETURN
6393 && !NILP (val = get_char_property_and_overlay
6394 (make_number (pos), Qdisplay, Qnil, &overlay))
6395 && (OVERLAYP (overlay)
6396 ? (beg = OVERLAY_POSITION (OVERLAY_START (overlay)))
6397 : get_property_and_range (pos, Qdisplay, &val, &beg, &end, Qnil)))
6399 RESTORE_IT (it, it, it2data);
6400 goto replaced;
6403 /* Newline is not replaced by anything -- so we are done. */
6404 RESTORE_IT (it, it, it2data);
6405 break;
6407 replaced:
6408 if (beg < BEGV)
6409 beg = BEGV;
6410 IT_CHARPOS (*it) = beg;
6411 IT_BYTEPOS (*it) = buf_charpos_to_bytepos (current_buffer, beg);
6415 it->continuation_lines_width = 0;
6417 eassert (IT_CHARPOS (*it) >= BEGV);
6418 eassert (IT_CHARPOS (*it) == BEGV
6419 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6420 CHECK_IT (it);
6424 /* Reseat iterator IT at the previous visible line start. Skip
6425 invisible text that is so either due to text properties or due to
6426 selective display. At the end, update IT's overlay information,
6427 face information etc. */
6429 void
6430 reseat_at_previous_visible_line_start (struct it *it)
6432 back_to_previous_visible_line_start (it);
6433 reseat (it, it->current.pos, 1);
6434 CHECK_IT (it);
6438 /* Reseat iterator IT on the next visible line start in the current
6439 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6440 preceding the line start. Skip over invisible text that is so
6441 because of selective display. Compute faces, overlays etc at the
6442 new position. Note that this function does not skip over text that
6443 is invisible because of text properties. */
6445 static void
6446 reseat_at_next_visible_line_start (struct it *it, int on_newline_p)
6448 int newline_found_p, skipped_p = 0;
6449 struct bidi_it bidi_it_prev;
6451 newline_found_p = forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6453 /* Skip over lines that are invisible because they are indented
6454 more than the value of IT->selective. */
6455 if (it->selective > 0)
6456 while (IT_CHARPOS (*it) < ZV
6457 && indented_beyond_p (IT_CHARPOS (*it), IT_BYTEPOS (*it),
6458 it->selective))
6460 eassert (IT_BYTEPOS (*it) == BEGV
6461 || FETCH_BYTE (IT_BYTEPOS (*it) - 1) == '\n');
6462 newline_found_p =
6463 forward_to_next_line_start (it, &skipped_p, &bidi_it_prev);
6466 /* Position on the newline if that's what's requested. */
6467 if (on_newline_p && newline_found_p)
6469 if (STRINGP (it->string))
6471 if (IT_STRING_CHARPOS (*it) > 0)
6473 if (!it->bidi_p)
6475 --IT_STRING_CHARPOS (*it);
6476 --IT_STRING_BYTEPOS (*it);
6478 else
6480 /* We need to restore the bidi iterator to the state
6481 it had on the newline, and resync the IT's
6482 position with that. */
6483 it->bidi_it = bidi_it_prev;
6484 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
6485 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
6489 else if (IT_CHARPOS (*it) > BEGV)
6491 if (!it->bidi_p)
6493 --IT_CHARPOS (*it);
6494 --IT_BYTEPOS (*it);
6496 else
6498 /* We need to restore the bidi iterator to the state it
6499 had on the newline and resync IT with that. */
6500 it->bidi_it = bidi_it_prev;
6501 IT_CHARPOS (*it) = it->bidi_it.charpos;
6502 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
6504 reseat (it, it->current.pos, 0);
6507 else if (skipped_p)
6508 reseat (it, it->current.pos, 0);
6510 CHECK_IT (it);
6515 /***********************************************************************
6516 Changing an iterator's position
6517 ***********************************************************************/
6519 /* Change IT's current position to POS in current_buffer. If FORCE_P
6520 is non-zero, always check for text properties at the new position.
6521 Otherwise, text properties are only looked up if POS >=
6522 IT->check_charpos of a property. */
6524 static void
6525 reseat (struct it *it, struct text_pos pos, int force_p)
6527 ptrdiff_t original_pos = IT_CHARPOS (*it);
6529 reseat_1 (it, pos, 0);
6531 /* Determine where to check text properties. Avoid doing it
6532 where possible because text property lookup is very expensive. */
6533 if (force_p
6534 || CHARPOS (pos) > it->stop_charpos
6535 || CHARPOS (pos) < original_pos)
6537 if (it->bidi_p)
6539 /* For bidi iteration, we need to prime prev_stop and
6540 base_level_stop with our best estimations. */
6541 /* Implementation note: Of course, POS is not necessarily a
6542 stop position, so assigning prev_pos to it is a lie; we
6543 should have called compute_stop_backwards. However, if
6544 the current buffer does not include any R2L characters,
6545 that call would be a waste of cycles, because the
6546 iterator will never move back, and thus never cross this
6547 "fake" stop position. So we delay that backward search
6548 until the time we really need it, in next_element_from_buffer. */
6549 if (CHARPOS (pos) != it->prev_stop)
6550 it->prev_stop = CHARPOS (pos);
6551 if (CHARPOS (pos) < it->base_level_stop)
6552 it->base_level_stop = 0; /* meaning it's unknown */
6553 handle_stop (it);
6555 else
6557 handle_stop (it);
6558 it->prev_stop = it->base_level_stop = 0;
6563 CHECK_IT (it);
6567 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6568 IT->stop_pos to POS, also. */
6570 static void
6571 reseat_1 (struct it *it, struct text_pos pos, int set_stop_p)
6573 /* Don't call this function when scanning a C string. */
6574 eassert (it->s == NULL);
6576 /* POS must be a reasonable value. */
6577 eassert (CHARPOS (pos) >= BEGV && CHARPOS (pos) <= ZV);
6579 it->current.pos = it->position = pos;
6580 it->end_charpos = ZV;
6581 it->dpvec = NULL;
6582 it->current.dpvec_index = -1;
6583 it->current.overlay_string_index = -1;
6584 IT_STRING_CHARPOS (*it) = -1;
6585 IT_STRING_BYTEPOS (*it) = -1;
6586 it->string = Qnil;
6587 it->method = GET_FROM_BUFFER;
6588 it->object = it->w->contents;
6589 it->area = TEXT_AREA;
6590 it->multibyte_p = !NILP (BVAR (current_buffer, enable_multibyte_characters));
6591 it->sp = 0;
6592 it->string_from_display_prop_p = 0;
6593 it->string_from_prefix_prop_p = 0;
6595 it->from_disp_prop_p = 0;
6596 it->face_before_selective_p = 0;
6597 if (it->bidi_p)
6599 bidi_init_it (IT_CHARPOS (*it), IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6600 &it->bidi_it);
6601 bidi_unshelve_cache (NULL, 0);
6602 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6603 it->bidi_it.string.s = NULL;
6604 it->bidi_it.string.lstring = Qnil;
6605 it->bidi_it.string.bufpos = 0;
6606 it->bidi_it.string.from_disp_str = 0;
6607 it->bidi_it.string.unibyte = 0;
6608 it->bidi_it.w = it->w;
6611 if (set_stop_p)
6613 it->stop_charpos = CHARPOS (pos);
6614 it->base_level_stop = CHARPOS (pos);
6616 /* This make the information stored in it->cmp_it invalidate. */
6617 it->cmp_it.id = -1;
6621 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6622 If S is non-null, it is a C string to iterate over. Otherwise,
6623 STRING gives a Lisp string to iterate over.
6625 If PRECISION > 0, don't return more then PRECISION number of
6626 characters from the string.
6628 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6629 characters have been returned. FIELD_WIDTH < 0 means an infinite
6630 field width.
6632 MULTIBYTE = 0 means disable processing of multibyte characters,
6633 MULTIBYTE > 0 means enable it,
6634 MULTIBYTE < 0 means use IT->multibyte_p.
6636 IT must be initialized via a prior call to init_iterator before
6637 calling this function. */
6639 static void
6640 reseat_to_string (struct it *it, const char *s, Lisp_Object string,
6641 ptrdiff_t charpos, ptrdiff_t precision, int field_width,
6642 int multibyte)
6644 /* No text property checks performed by default, but see below. */
6645 it->stop_charpos = -1;
6647 /* Set iterator position and end position. */
6648 memset (&it->current, 0, sizeof it->current);
6649 it->current.overlay_string_index = -1;
6650 it->current.dpvec_index = -1;
6651 eassert (charpos >= 0);
6653 /* If STRING is specified, use its multibyteness, otherwise use the
6654 setting of MULTIBYTE, if specified. */
6655 if (multibyte >= 0)
6656 it->multibyte_p = multibyte > 0;
6658 /* Bidirectional reordering of strings is controlled by the default
6659 value of bidi-display-reordering. Don't try to reorder while
6660 loading loadup.el, as the necessary character property tables are
6661 not yet available. */
6662 it->bidi_p =
6663 NILP (Vpurify_flag)
6664 && !NILP (BVAR (&buffer_defaults, bidi_display_reordering));
6666 if (s == NULL)
6668 eassert (STRINGP (string));
6669 it->string = string;
6670 it->s = NULL;
6671 it->end_charpos = it->string_nchars = SCHARS (string);
6672 it->method = GET_FROM_STRING;
6673 it->current.string_pos = string_pos (charpos, string);
6675 if (it->bidi_p)
6677 it->bidi_it.string.lstring = string;
6678 it->bidi_it.string.s = NULL;
6679 it->bidi_it.string.schars = it->end_charpos;
6680 it->bidi_it.string.bufpos = 0;
6681 it->bidi_it.string.from_disp_str = 0;
6682 it->bidi_it.string.unibyte = !it->multibyte_p;
6683 it->bidi_it.w = it->w;
6684 bidi_init_it (charpos, IT_STRING_BYTEPOS (*it),
6685 FRAME_WINDOW_P (it->f), &it->bidi_it);
6688 else
6690 it->s = (const unsigned char *) s;
6691 it->string = Qnil;
6693 /* Note that we use IT->current.pos, not it->current.string_pos,
6694 for displaying C strings. */
6695 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = -1;
6696 if (it->multibyte_p)
6698 it->current.pos = c_string_pos (charpos, s, 1);
6699 it->end_charpos = it->string_nchars = number_of_chars (s, 1);
6701 else
6703 IT_CHARPOS (*it) = IT_BYTEPOS (*it) = charpos;
6704 it->end_charpos = it->string_nchars = strlen (s);
6707 if (it->bidi_p)
6709 it->bidi_it.string.lstring = Qnil;
6710 it->bidi_it.string.s = (const unsigned char *) s;
6711 it->bidi_it.string.schars = it->end_charpos;
6712 it->bidi_it.string.bufpos = 0;
6713 it->bidi_it.string.from_disp_str = 0;
6714 it->bidi_it.string.unibyte = !it->multibyte_p;
6715 it->bidi_it.w = it->w;
6716 bidi_init_it (charpos, IT_BYTEPOS (*it), FRAME_WINDOW_P (it->f),
6717 &it->bidi_it);
6719 it->method = GET_FROM_C_STRING;
6722 /* PRECISION > 0 means don't return more than PRECISION characters
6723 from the string. */
6724 if (precision > 0 && it->end_charpos - charpos > precision)
6726 it->end_charpos = it->string_nchars = charpos + precision;
6727 if (it->bidi_p)
6728 it->bidi_it.string.schars = it->end_charpos;
6731 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6732 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6733 FIELD_WIDTH < 0 means infinite field width. This is useful for
6734 padding with `-' at the end of a mode line. */
6735 if (field_width < 0)
6736 field_width = INFINITY;
6737 /* Implementation note: We deliberately don't enlarge
6738 it->bidi_it.string.schars here to fit it->end_charpos, because
6739 the bidi iterator cannot produce characters out of thin air. */
6740 if (field_width > it->end_charpos - charpos)
6741 it->end_charpos = charpos + field_width;
6743 /* Use the standard display table for displaying strings. */
6744 if (DISP_TABLE_P (Vstandard_display_table))
6745 it->dp = XCHAR_TABLE (Vstandard_display_table);
6747 it->stop_charpos = charpos;
6748 it->prev_stop = charpos;
6749 it->base_level_stop = 0;
6750 if (it->bidi_p)
6752 it->bidi_it.first_elt = 1;
6753 it->bidi_it.paragraph_dir = NEUTRAL_DIR;
6754 it->bidi_it.disp_pos = -1;
6756 if (s == NULL && it->multibyte_p)
6758 ptrdiff_t endpos = SCHARS (it->string);
6759 if (endpos > it->end_charpos)
6760 endpos = it->end_charpos;
6761 composition_compute_stop_pos (&it->cmp_it, charpos, -1, endpos,
6762 it->string);
6764 CHECK_IT (it);
6769 /***********************************************************************
6770 Iteration
6771 ***********************************************************************/
6773 /* Map enum it_method value to corresponding next_element_from_* function. */
6775 static int (* get_next_element[NUM_IT_METHODS]) (struct it *it) =
6777 next_element_from_buffer,
6778 next_element_from_display_vector,
6779 next_element_from_string,
6780 next_element_from_c_string,
6781 next_element_from_image,
6782 next_element_from_stretch
6785 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6788 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6789 (possibly with the following characters). */
6791 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6792 ((IT)->cmp_it.id >= 0 \
6793 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6794 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6795 END_CHARPOS, (IT)->w, \
6796 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6797 (IT)->string)))
6800 /* Lookup the char-table Vglyphless_char_display for character C (-1
6801 if we want information for no-font case), and return the display
6802 method symbol. By side-effect, update it->what and
6803 it->glyphless_method. This function is called from
6804 get_next_display_element for each character element, and from
6805 x_produce_glyphs when no suitable font was found. */
6807 Lisp_Object
6808 lookup_glyphless_char_display (int c, struct it *it)
6810 Lisp_Object glyphless_method = Qnil;
6812 if (CHAR_TABLE_P (Vglyphless_char_display)
6813 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display)) >= 1)
6815 if (c >= 0)
6817 glyphless_method = CHAR_TABLE_REF (Vglyphless_char_display, c);
6818 if (CONSP (glyphless_method))
6819 glyphless_method = FRAME_WINDOW_P (it->f)
6820 ? XCAR (glyphless_method)
6821 : XCDR (glyphless_method);
6823 else
6824 glyphless_method = XCHAR_TABLE (Vglyphless_char_display)->extras[0];
6827 retry:
6828 if (NILP (glyphless_method))
6830 if (c >= 0)
6831 /* The default is to display the character by a proper font. */
6832 return Qnil;
6833 /* The default for the no-font case is to display an empty box. */
6834 glyphless_method = Qempty_box;
6836 if (EQ (glyphless_method, Qzero_width))
6838 if (c >= 0)
6839 return glyphless_method;
6840 /* This method can't be used for the no-font case. */
6841 glyphless_method = Qempty_box;
6843 if (EQ (glyphless_method, Qthin_space))
6844 it->glyphless_method = GLYPHLESS_DISPLAY_THIN_SPACE;
6845 else if (EQ (glyphless_method, Qempty_box))
6846 it->glyphless_method = GLYPHLESS_DISPLAY_EMPTY_BOX;
6847 else if (EQ (glyphless_method, Qhex_code))
6848 it->glyphless_method = GLYPHLESS_DISPLAY_HEX_CODE;
6849 else if (STRINGP (glyphless_method))
6850 it->glyphless_method = GLYPHLESS_DISPLAY_ACRONYM;
6851 else
6853 /* Invalid value. We use the default method. */
6854 glyphless_method = Qnil;
6855 goto retry;
6857 it->what = IT_GLYPHLESS;
6858 return glyphless_method;
6861 /* Merge escape glyph face and cache the result. */
6863 static struct frame *last_escape_glyph_frame = NULL;
6864 static int last_escape_glyph_face_id = (1 << FACE_ID_BITS);
6865 static int last_escape_glyph_merged_face_id = 0;
6867 static int
6868 merge_escape_glyph_face (struct it *it)
6870 int face_id;
6872 if (it->f == last_escape_glyph_frame
6873 && it->face_id == last_escape_glyph_face_id)
6874 face_id = last_escape_glyph_merged_face_id;
6875 else
6877 /* Merge the `escape-glyph' face into the current face. */
6878 face_id = merge_faces (it->f, Qescape_glyph, 0, it->face_id);
6879 last_escape_glyph_frame = it->f;
6880 last_escape_glyph_face_id = it->face_id;
6881 last_escape_glyph_merged_face_id = face_id;
6883 return face_id;
6886 /* Likewise for glyphless glyph face. */
6888 static struct frame *last_glyphless_glyph_frame = NULL;
6889 static int last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
6890 static int last_glyphless_glyph_merged_face_id = 0;
6893 merge_glyphless_glyph_face (struct it *it)
6895 int face_id;
6897 if (it->f == last_glyphless_glyph_frame
6898 && it->face_id == last_glyphless_glyph_face_id)
6899 face_id = last_glyphless_glyph_merged_face_id;
6900 else
6902 /* Merge the `glyphless-char' face into the current face. */
6903 face_id = merge_faces (it->f, Qglyphless_char, 0, it->face_id);
6904 last_glyphless_glyph_frame = it->f;
6905 last_glyphless_glyph_face_id = it->face_id;
6906 last_glyphless_glyph_merged_face_id = face_id;
6908 return face_id;
6911 /* Load IT's display element fields with information about the next
6912 display element from the current position of IT. Value is zero if
6913 end of buffer (or C string) is reached. */
6915 static int
6916 get_next_display_element (struct it *it)
6918 /* Non-zero means that we found a display element. Zero means that
6919 we hit the end of what we iterate over. Performance note: the
6920 function pointer `method' used here turns out to be faster than
6921 using a sequence of if-statements. */
6922 int success_p;
6924 get_next:
6925 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
6927 if (it->what == IT_CHARACTER)
6929 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6930 and only if (a) the resolved directionality of that character
6931 is R..." */
6932 /* FIXME: Do we need an exception for characters from display
6933 tables? */
6934 if (it->bidi_p && it->bidi_it.type == STRONG_R)
6935 it->c = bidi_mirror_char (it->c);
6936 /* Map via display table or translate control characters.
6937 IT->c, IT->len etc. have been set to the next character by
6938 the function call above. If we have a display table, and it
6939 contains an entry for IT->c, translate it. Don't do this if
6940 IT->c itself comes from a display table, otherwise we could
6941 end up in an infinite recursion. (An alternative could be to
6942 count the recursion depth of this function and signal an
6943 error when a certain maximum depth is reached.) Is it worth
6944 it? */
6945 if (success_p && it->dpvec == NULL)
6947 Lisp_Object dv;
6948 struct charset *unibyte = CHARSET_FROM_ID (charset_unibyte);
6949 int nonascii_space_p = 0;
6950 int nonascii_hyphen_p = 0;
6951 int c = it->c; /* This is the character to display. */
6953 if (! it->multibyte_p && ! ASCII_CHAR_P (c))
6955 eassert (SINGLE_BYTE_CHAR_P (c));
6956 if (unibyte_display_via_language_environment)
6958 c = DECODE_CHAR (unibyte, c);
6959 if (c < 0)
6960 c = BYTE8_TO_CHAR (it->c);
6962 else
6963 c = BYTE8_TO_CHAR (it->c);
6966 if (it->dp
6967 && (dv = DISP_CHAR_VECTOR (it->dp, c),
6968 VECTORP (dv)))
6970 struct Lisp_Vector *v = XVECTOR (dv);
6972 /* Return the first character from the display table
6973 entry, if not empty. If empty, don't display the
6974 current character. */
6975 if (v->header.size)
6977 it->dpvec_char_len = it->len;
6978 it->dpvec = v->contents;
6979 it->dpend = v->contents + v->header.size;
6980 it->current.dpvec_index = 0;
6981 it->dpvec_face_id = -1;
6982 it->saved_face_id = it->face_id;
6983 it->method = GET_FROM_DISPLAY_VECTOR;
6984 it->ellipsis_p = 0;
6986 else
6988 set_iterator_to_next (it, 0);
6990 goto get_next;
6993 if (! NILP (lookup_glyphless_char_display (c, it)))
6995 if (it->what == IT_GLYPHLESS)
6996 goto done;
6997 /* Don't display this character. */
6998 set_iterator_to_next (it, 0);
6999 goto get_next;
7002 /* If `nobreak-char-display' is non-nil, we display
7003 non-ASCII spaces and hyphens specially. */
7004 if (! ASCII_CHAR_P (c) && ! NILP (Vnobreak_char_display))
7006 if (c == 0xA0)
7007 nonascii_space_p = true;
7008 else if (c == 0xAD || c == 0x2010 || c == 0x2011)
7009 nonascii_hyphen_p = true;
7012 /* Translate control characters into `\003' or `^C' form.
7013 Control characters coming from a display table entry are
7014 currently not translated because we use IT->dpvec to hold
7015 the translation. This could easily be changed but I
7016 don't believe that it is worth doing.
7018 The characters handled by `nobreak-char-display' must be
7019 translated too.
7021 Non-printable characters and raw-byte characters are also
7022 translated to octal form. */
7023 if (((c < ' ' || c == 127) /* ASCII control chars. */
7024 ? (it->area != TEXT_AREA
7025 /* In mode line, treat \n, \t like other crl chars. */
7026 || (c != '\t'
7027 && it->glyph_row
7028 && (it->glyph_row->mode_line_p || it->avoid_cursor_p))
7029 || (c != '\n' && c != '\t'))
7030 : (nonascii_space_p
7031 || nonascii_hyphen_p
7032 || CHAR_BYTE8_P (c)
7033 || ! CHAR_PRINTABLE_P (c))))
7035 /* C is a control character, non-ASCII space/hyphen,
7036 raw-byte, or a non-printable character which must be
7037 displayed either as '\003' or as `^C' where the '\\'
7038 and '^' can be defined in the display table. Fill
7039 IT->ctl_chars with glyphs for what we have to
7040 display. Then, set IT->dpvec to these glyphs. */
7041 Lisp_Object gc;
7042 int ctl_len;
7043 int face_id;
7044 int lface_id = 0;
7045 int escape_glyph;
7047 /* Handle control characters with ^. */
7049 if (ASCII_CHAR_P (c) && it->ctl_arrow_p)
7051 int g;
7053 g = '^'; /* default glyph for Control */
7054 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7055 if (it->dp
7056 && (gc = DISP_CTRL_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7058 g = GLYPH_CODE_CHAR (gc);
7059 lface_id = GLYPH_CODE_FACE (gc);
7062 face_id = (lface_id
7063 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7064 : merge_escape_glyph_face (it));
7066 XSETINT (it->ctl_chars[0], g);
7067 XSETINT (it->ctl_chars[1], c ^ 0100);
7068 ctl_len = 2;
7069 goto display_control;
7072 /* Handle non-ascii space in the mode where it only gets
7073 highlighting. */
7075 if (nonascii_space_p && EQ (Vnobreak_char_display, Qt))
7077 /* Merge `nobreak-space' into the current face. */
7078 face_id = merge_faces (it->f, Qnobreak_space, 0,
7079 it->face_id);
7080 XSETINT (it->ctl_chars[0], ' ');
7081 ctl_len = 1;
7082 goto display_control;
7085 /* Handle sequences that start with the "escape glyph". */
7087 /* the default escape glyph is \. */
7088 escape_glyph = '\\';
7090 if (it->dp
7091 && (gc = DISP_ESCAPE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
7093 escape_glyph = GLYPH_CODE_CHAR (gc);
7094 lface_id = GLYPH_CODE_FACE (gc);
7097 face_id = (lface_id
7098 ? merge_faces (it->f, Qt, lface_id, it->face_id)
7099 : merge_escape_glyph_face (it));
7101 /* Draw non-ASCII hyphen with just highlighting: */
7103 if (nonascii_hyphen_p && EQ (Vnobreak_char_display, Qt))
7105 XSETINT (it->ctl_chars[0], '-');
7106 ctl_len = 1;
7107 goto display_control;
7110 /* Draw non-ASCII space/hyphen with escape glyph: */
7112 if (nonascii_space_p || nonascii_hyphen_p)
7114 XSETINT (it->ctl_chars[0], escape_glyph);
7115 XSETINT (it->ctl_chars[1], nonascii_space_p ? ' ' : '-');
7116 ctl_len = 2;
7117 goto display_control;
7121 char str[10];
7122 int len, i;
7124 if (CHAR_BYTE8_P (c))
7125 /* Display \200 instead of \17777600. */
7126 c = CHAR_TO_BYTE8 (c);
7127 len = sprintf (str, "%03o", c);
7129 XSETINT (it->ctl_chars[0], escape_glyph);
7130 for (i = 0; i < len; i++)
7131 XSETINT (it->ctl_chars[i + 1], str[i]);
7132 ctl_len = len + 1;
7135 display_control:
7136 /* Set up IT->dpvec and return first character from it. */
7137 it->dpvec_char_len = it->len;
7138 it->dpvec = it->ctl_chars;
7139 it->dpend = it->dpvec + ctl_len;
7140 it->current.dpvec_index = 0;
7141 it->dpvec_face_id = face_id;
7142 it->saved_face_id = it->face_id;
7143 it->method = GET_FROM_DISPLAY_VECTOR;
7144 it->ellipsis_p = 0;
7145 goto get_next;
7147 it->char_to_display = c;
7149 else if (success_p)
7151 it->char_to_display = it->c;
7155 #ifdef HAVE_WINDOW_SYSTEM
7156 /* Adjust face id for a multibyte character. There are no multibyte
7157 character in unibyte text. */
7158 if ((it->what == IT_CHARACTER || it->what == IT_COMPOSITION)
7159 && it->multibyte_p
7160 && success_p
7161 && FRAME_WINDOW_P (it->f))
7163 struct face *face = FACE_FROM_ID (it->f, it->face_id);
7165 if (it->what == IT_COMPOSITION && it->cmp_it.ch >= 0)
7167 /* Automatic composition with glyph-string. */
7168 Lisp_Object gstring = composition_gstring_from_id (it->cmp_it.id);
7170 it->face_id = face_for_font (it->f, LGSTRING_FONT (gstring), face);
7172 else
7174 ptrdiff_t pos = (it->s ? -1
7175 : STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
7176 : IT_CHARPOS (*it));
7177 int c;
7179 if (it->what == IT_CHARACTER)
7180 c = it->char_to_display;
7181 else
7183 struct composition *cmp = composition_table[it->cmp_it.id];
7184 int i;
7186 c = ' ';
7187 for (i = 0; i < cmp->glyph_len; i++)
7188 /* TAB in a composition means display glyphs with
7189 padding space on the left or right. */
7190 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
7191 break;
7193 it->face_id = FACE_FOR_CHAR (it->f, face, c, pos, it->string);
7196 #endif /* HAVE_WINDOW_SYSTEM */
7198 done:
7199 /* Is this character the last one of a run of characters with
7200 box? If yes, set IT->end_of_box_run_p to 1. */
7201 if (it->face_box_p
7202 && it->s == NULL)
7204 if (it->method == GET_FROM_STRING && it->sp)
7206 int face_id = underlying_face_id (it);
7207 struct face *face = FACE_FROM_ID (it->f, face_id);
7209 if (face)
7211 if (face->box == FACE_NO_BOX)
7213 /* If the box comes from face properties in a
7214 display string, check faces in that string. */
7215 int string_face_id = face_after_it_pos (it);
7216 it->end_of_box_run_p
7217 = (FACE_FROM_ID (it->f, string_face_id)->box
7218 == FACE_NO_BOX);
7220 /* Otherwise, the box comes from the underlying face.
7221 If this is the last string character displayed, check
7222 the next buffer location. */
7223 else if ((IT_STRING_CHARPOS (*it) >= SCHARS (it->string) - 1)
7224 /* n_overlay_strings is unreliable unless
7225 overlay_string_index is non-negative. */
7226 && ((it->current.overlay_string_index >= 0
7227 && (it->current.overlay_string_index
7228 == it->n_overlay_strings - 1))
7229 /* A string from display property. */
7230 || it->from_disp_prop_p))
7232 ptrdiff_t ignore;
7233 int next_face_id;
7234 struct text_pos pos = it->current.pos;
7236 /* For a string from a display property, the next
7237 buffer position is stored in the 'position'
7238 member of the iteration stack slot below the
7239 current one, see handle_single_display_spec. By
7240 contrast, it->current.pos was is not yet updated
7241 to point to that buffer position; that will
7242 happen in pop_it, after we finish displaying the
7243 current string. Note that we already checked
7244 above that it->sp is positive, so subtracting one
7245 from it is safe. */
7246 if (it->from_disp_prop_p)
7247 pos = (it->stack + it->sp - 1)->position;
7248 else
7249 INC_TEXT_POS (pos, it->multibyte_p);
7251 if (CHARPOS (pos) >= ZV)
7252 it->end_of_box_run_p = true;
7253 else
7255 next_face_id = face_at_buffer_position
7256 (it->w, CHARPOS (pos), &ignore,
7257 CHARPOS (pos) + TEXT_PROP_DISTANCE_LIMIT, 0, -1);
7258 it->end_of_box_run_p
7259 = (FACE_FROM_ID (it->f, next_face_id)->box
7260 == FACE_NO_BOX);
7265 /* next_element_from_display_vector sets this flag according to
7266 faces of the display vector glyphs, see there. */
7267 else if (it->method != GET_FROM_DISPLAY_VECTOR)
7269 int face_id = face_after_it_pos (it);
7270 it->end_of_box_run_p
7271 = (face_id != it->face_id
7272 && FACE_FROM_ID (it->f, face_id)->box == FACE_NO_BOX);
7275 /* If we reached the end of the object we've been iterating (e.g., a
7276 display string or an overlay string), and there's something on
7277 IT->stack, proceed with what's on the stack. It doesn't make
7278 sense to return zero if there's unprocessed stuff on the stack,
7279 because otherwise that stuff will never be displayed. */
7280 if (!success_p && it->sp > 0)
7282 set_iterator_to_next (it, 0);
7283 success_p = get_next_display_element (it);
7286 /* Value is 0 if end of buffer or string reached. */
7287 return success_p;
7291 /* Move IT to the next display element.
7293 RESEAT_P non-zero means if called on a newline in buffer text,
7294 skip to the next visible line start.
7296 Functions get_next_display_element and set_iterator_to_next are
7297 separate because I find this arrangement easier to handle than a
7298 get_next_display_element function that also increments IT's
7299 position. The way it is we can first look at an iterator's current
7300 display element, decide whether it fits on a line, and if it does,
7301 increment the iterator position. The other way around we probably
7302 would either need a flag indicating whether the iterator has to be
7303 incremented the next time, or we would have to implement a
7304 decrement position function which would not be easy to write. */
7306 void
7307 set_iterator_to_next (struct it *it, int reseat_p)
7309 /* Reset flags indicating start and end of a sequence of characters
7310 with box. Reset them at the start of this function because
7311 moving the iterator to a new position might set them. */
7312 it->start_of_box_run_p = it->end_of_box_run_p = 0;
7314 switch (it->method)
7316 case GET_FROM_BUFFER:
7317 /* The current display element of IT is a character from
7318 current_buffer. Advance in the buffer, and maybe skip over
7319 invisible lines that are so because of selective display. */
7320 if (ITERATOR_AT_END_OF_LINE_P (it) && reseat_p)
7321 reseat_at_next_visible_line_start (it, 0);
7322 else if (it->cmp_it.id >= 0)
7324 /* We are currently getting glyphs from a composition. */
7325 int i;
7327 if (! it->bidi_p)
7329 IT_CHARPOS (*it) += it->cmp_it.nchars;
7330 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
7331 if (it->cmp_it.to < it->cmp_it.nglyphs)
7333 it->cmp_it.from = it->cmp_it.to;
7335 else
7337 it->cmp_it.id = -1;
7338 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7339 IT_BYTEPOS (*it),
7340 it->end_charpos, Qnil);
7343 else if (! it->cmp_it.reversed_p)
7345 /* Composition created while scanning forward. */
7346 /* Update IT's char/byte positions to point to the first
7347 character of the next grapheme cluster, or to the
7348 character visually after the current composition. */
7349 for (i = 0; i < it->cmp_it.nchars; i++)
7350 bidi_move_to_visually_next (&it->bidi_it);
7351 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7352 IT_CHARPOS (*it) = it->bidi_it.charpos;
7354 if (it->cmp_it.to < it->cmp_it.nglyphs)
7356 /* Proceed to the next grapheme cluster. */
7357 it->cmp_it.from = it->cmp_it.to;
7359 else
7361 /* No more grapheme clusters in this composition.
7362 Find the next stop position. */
7363 ptrdiff_t stop = it->end_charpos;
7364 if (it->bidi_it.scan_dir < 0)
7365 /* Now we are scanning backward and don't know
7366 where to stop. */
7367 stop = -1;
7368 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7369 IT_BYTEPOS (*it), stop, Qnil);
7372 else
7374 /* Composition created while scanning backward. */
7375 /* Update IT's char/byte positions to point to the last
7376 character of the previous grapheme cluster, or the
7377 character visually after the current composition. */
7378 for (i = 0; i < it->cmp_it.nchars; i++)
7379 bidi_move_to_visually_next (&it->bidi_it);
7380 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7381 IT_CHARPOS (*it) = it->bidi_it.charpos;
7382 if (it->cmp_it.from > 0)
7384 /* Proceed to the previous grapheme cluster. */
7385 it->cmp_it.to = it->cmp_it.from;
7387 else
7389 /* No more grapheme clusters in this composition.
7390 Find the next stop position. */
7391 ptrdiff_t stop = it->end_charpos;
7392 if (it->bidi_it.scan_dir < 0)
7393 /* Now we are scanning backward and don't know
7394 where to stop. */
7395 stop = -1;
7396 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7397 IT_BYTEPOS (*it), stop, Qnil);
7401 else
7403 eassert (it->len != 0);
7405 if (!it->bidi_p)
7407 IT_BYTEPOS (*it) += it->len;
7408 IT_CHARPOS (*it) += 1;
7410 else
7412 int prev_scan_dir = it->bidi_it.scan_dir;
7413 /* If this is a new paragraph, determine its base
7414 direction (a.k.a. its base embedding level). */
7415 if (it->bidi_it.new_paragraph)
7416 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
7417 bidi_move_to_visually_next (&it->bidi_it);
7418 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7419 IT_CHARPOS (*it) = it->bidi_it.charpos;
7420 if (prev_scan_dir != it->bidi_it.scan_dir)
7422 /* As the scan direction was changed, we must
7423 re-compute the stop position for composition. */
7424 ptrdiff_t stop = it->end_charpos;
7425 if (it->bidi_it.scan_dir < 0)
7426 stop = -1;
7427 composition_compute_stop_pos (&it->cmp_it, IT_CHARPOS (*it),
7428 IT_BYTEPOS (*it), stop, Qnil);
7431 eassert (IT_BYTEPOS (*it) == CHAR_TO_BYTE (IT_CHARPOS (*it)));
7433 break;
7435 case GET_FROM_C_STRING:
7436 /* Current display element of IT is from a C string. */
7437 if (!it->bidi_p
7438 /* If the string position is beyond string's end, it means
7439 next_element_from_c_string is padding the string with
7440 blanks, in which case we bypass the bidi iterator,
7441 because it cannot deal with such virtual characters. */
7442 || IT_CHARPOS (*it) >= it->bidi_it.string.schars)
7444 IT_BYTEPOS (*it) += it->len;
7445 IT_CHARPOS (*it) += 1;
7447 else
7449 bidi_move_to_visually_next (&it->bidi_it);
7450 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7451 IT_CHARPOS (*it) = it->bidi_it.charpos;
7453 break;
7455 case GET_FROM_DISPLAY_VECTOR:
7456 /* Current display element of IT is from a display table entry.
7457 Advance in the display table definition. Reset it to null if
7458 end reached, and continue with characters from buffers/
7459 strings. */
7460 ++it->current.dpvec_index;
7462 /* Restore face of the iterator to what they were before the
7463 display vector entry (these entries may contain faces). */
7464 it->face_id = it->saved_face_id;
7466 if (it->dpvec + it->current.dpvec_index >= it->dpend)
7468 int recheck_faces = it->ellipsis_p;
7470 if (it->s)
7471 it->method = GET_FROM_C_STRING;
7472 else if (STRINGP (it->string))
7473 it->method = GET_FROM_STRING;
7474 else
7476 it->method = GET_FROM_BUFFER;
7477 it->object = it->w->contents;
7480 it->dpvec = NULL;
7481 it->current.dpvec_index = -1;
7483 /* Skip over characters which were displayed via IT->dpvec. */
7484 if (it->dpvec_char_len < 0)
7485 reseat_at_next_visible_line_start (it, 1);
7486 else if (it->dpvec_char_len > 0)
7488 if (it->method == GET_FROM_STRING
7489 && it->current.overlay_string_index >= 0
7490 && it->n_overlay_strings > 0)
7491 it->ignore_overlay_strings_at_pos_p = true;
7492 it->len = it->dpvec_char_len;
7493 set_iterator_to_next (it, reseat_p);
7496 /* Maybe recheck faces after display vector. */
7497 if (recheck_faces)
7498 it->stop_charpos = IT_CHARPOS (*it);
7500 break;
7502 case GET_FROM_STRING:
7503 /* Current display element is a character from a Lisp string. */
7504 eassert (it->s == NULL && STRINGP (it->string));
7505 /* Don't advance past string end. These conditions are true
7506 when set_iterator_to_next is called at the end of
7507 get_next_display_element, in which case the Lisp string is
7508 already exhausted, and all we want is pop the iterator
7509 stack. */
7510 if (it->current.overlay_string_index >= 0)
7512 /* This is an overlay string, so there's no padding with
7513 spaces, and the number of characters in the string is
7514 where the string ends. */
7515 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7516 goto consider_string_end;
7518 else
7520 /* Not an overlay string. There could be padding, so test
7521 against it->end_charpos. */
7522 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7523 goto consider_string_end;
7525 if (it->cmp_it.id >= 0)
7527 int i;
7529 if (! it->bidi_p)
7531 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
7532 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
7533 if (it->cmp_it.to < it->cmp_it.nglyphs)
7534 it->cmp_it.from = it->cmp_it.to;
7535 else
7537 it->cmp_it.id = -1;
7538 composition_compute_stop_pos (&it->cmp_it,
7539 IT_STRING_CHARPOS (*it),
7540 IT_STRING_BYTEPOS (*it),
7541 it->end_charpos, it->string);
7544 else if (! it->cmp_it.reversed_p)
7546 for (i = 0; i < it->cmp_it.nchars; i++)
7547 bidi_move_to_visually_next (&it->bidi_it);
7548 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7549 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7551 if (it->cmp_it.to < it->cmp_it.nglyphs)
7552 it->cmp_it.from = it->cmp_it.to;
7553 else
7555 ptrdiff_t stop = it->end_charpos;
7556 if (it->bidi_it.scan_dir < 0)
7557 stop = -1;
7558 composition_compute_stop_pos (&it->cmp_it,
7559 IT_STRING_CHARPOS (*it),
7560 IT_STRING_BYTEPOS (*it), stop,
7561 it->string);
7564 else
7566 for (i = 0; i < it->cmp_it.nchars; i++)
7567 bidi_move_to_visually_next (&it->bidi_it);
7568 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7569 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7570 if (it->cmp_it.from > 0)
7571 it->cmp_it.to = it->cmp_it.from;
7572 else
7574 ptrdiff_t stop = it->end_charpos;
7575 if (it->bidi_it.scan_dir < 0)
7576 stop = -1;
7577 composition_compute_stop_pos (&it->cmp_it,
7578 IT_STRING_CHARPOS (*it),
7579 IT_STRING_BYTEPOS (*it), stop,
7580 it->string);
7584 else
7586 if (!it->bidi_p
7587 /* If the string position is beyond string's end, it
7588 means next_element_from_string is padding the string
7589 with blanks, in which case we bypass the bidi
7590 iterator, because it cannot deal with such virtual
7591 characters. */
7592 || IT_STRING_CHARPOS (*it) >= it->bidi_it.string.schars)
7594 IT_STRING_BYTEPOS (*it) += it->len;
7595 IT_STRING_CHARPOS (*it) += 1;
7597 else
7599 int prev_scan_dir = it->bidi_it.scan_dir;
7601 bidi_move_to_visually_next (&it->bidi_it);
7602 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7603 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7604 if (prev_scan_dir != it->bidi_it.scan_dir)
7606 ptrdiff_t stop = it->end_charpos;
7608 if (it->bidi_it.scan_dir < 0)
7609 stop = -1;
7610 composition_compute_stop_pos (&it->cmp_it,
7611 IT_STRING_CHARPOS (*it),
7612 IT_STRING_BYTEPOS (*it), stop,
7613 it->string);
7618 consider_string_end:
7620 if (it->current.overlay_string_index >= 0)
7622 /* IT->string is an overlay string. Advance to the
7623 next, if there is one. */
7624 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7626 it->ellipsis_p = 0;
7627 next_overlay_string (it);
7628 if (it->ellipsis_p)
7629 setup_for_ellipsis (it, 0);
7632 else
7634 /* IT->string is not an overlay string. If we reached
7635 its end, and there is something on IT->stack, proceed
7636 with what is on the stack. This can be either another
7637 string, this time an overlay string, or a buffer. */
7638 if (IT_STRING_CHARPOS (*it) == SCHARS (it->string)
7639 && it->sp > 0)
7641 pop_it (it);
7642 if (it->method == GET_FROM_STRING)
7643 goto consider_string_end;
7646 break;
7648 case GET_FROM_IMAGE:
7649 case GET_FROM_STRETCH:
7650 /* The position etc with which we have to proceed are on
7651 the stack. The position may be at the end of a string,
7652 if the `display' property takes up the whole string. */
7653 eassert (it->sp > 0);
7654 pop_it (it);
7655 if (it->method == GET_FROM_STRING)
7656 goto consider_string_end;
7657 break;
7659 default:
7660 /* There are no other methods defined, so this should be a bug. */
7661 emacs_abort ();
7664 eassert (it->method != GET_FROM_STRING
7665 || (STRINGP (it->string)
7666 && IT_STRING_CHARPOS (*it) >= 0));
7669 /* Load IT's display element fields with information about the next
7670 display element which comes from a display table entry or from the
7671 result of translating a control character to one of the forms `^C'
7672 or `\003'.
7674 IT->dpvec holds the glyphs to return as characters.
7675 IT->saved_face_id holds the face id before the display vector--it
7676 is restored into IT->face_id in set_iterator_to_next. */
7678 static int
7679 next_element_from_display_vector (struct it *it)
7681 Lisp_Object gc;
7682 int prev_face_id = it->face_id;
7683 int next_face_id;
7685 /* Precondition. */
7686 eassert (it->dpvec && it->current.dpvec_index >= 0);
7688 it->face_id = it->saved_face_id;
7690 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7691 That seemed totally bogus - so I changed it... */
7692 gc = it->dpvec[it->current.dpvec_index];
7694 if (GLYPH_CODE_P (gc))
7696 struct face *this_face, *prev_face, *next_face;
7698 it->c = GLYPH_CODE_CHAR (gc);
7699 it->len = CHAR_BYTES (it->c);
7701 /* The entry may contain a face id to use. Such a face id is
7702 the id of a Lisp face, not a realized face. A face id of
7703 zero means no face is specified. */
7704 if (it->dpvec_face_id >= 0)
7705 it->face_id = it->dpvec_face_id;
7706 else
7708 int lface_id = GLYPH_CODE_FACE (gc);
7709 if (lface_id > 0)
7710 it->face_id = merge_faces (it->f, Qt, lface_id,
7711 it->saved_face_id);
7714 /* Glyphs in the display vector could have the box face, so we
7715 need to set the related flags in the iterator, as
7716 appropriate. */
7717 this_face = FACE_FROM_ID (it->f, it->face_id);
7718 prev_face = FACE_FROM_ID (it->f, prev_face_id);
7720 /* Is this character the first character of a box-face run? */
7721 it->start_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7722 && (!prev_face
7723 || prev_face->box == FACE_NO_BOX));
7725 /* For the last character of the box-face run, we need to look
7726 either at the next glyph from the display vector, or at the
7727 face we saw before the display vector. */
7728 next_face_id = it->saved_face_id;
7729 if (it->current.dpvec_index < it->dpend - it->dpvec - 1)
7731 if (it->dpvec_face_id >= 0)
7732 next_face_id = it->dpvec_face_id;
7733 else
7735 int lface_id =
7736 GLYPH_CODE_FACE (it->dpvec[it->current.dpvec_index + 1]);
7738 if (lface_id > 0)
7739 next_face_id = merge_faces (it->f, Qt, lface_id,
7740 it->saved_face_id);
7743 next_face = FACE_FROM_ID (it->f, next_face_id);
7744 it->end_of_box_run_p = (this_face && this_face->box != FACE_NO_BOX
7745 && (!next_face
7746 || next_face->box == FACE_NO_BOX));
7747 it->face_box_p = this_face && this_face->box != FACE_NO_BOX;
7749 else
7750 /* Display table entry is invalid. Return a space. */
7751 it->c = ' ', it->len = 1;
7753 /* Don't change position and object of the iterator here. They are
7754 still the values of the character that had this display table
7755 entry or was translated, and that's what we want. */
7756 it->what = IT_CHARACTER;
7757 return 1;
7760 /* Get the first element of string/buffer in the visual order, after
7761 being reseated to a new position in a string or a buffer. */
7762 static void
7763 get_visually_first_element (struct it *it)
7765 int string_p = STRINGP (it->string) || it->s;
7766 ptrdiff_t eob = (string_p ? it->bidi_it.string.schars : ZV);
7767 ptrdiff_t bob = (string_p ? 0 : BEGV);
7769 if (STRINGP (it->string))
7771 it->bidi_it.charpos = IT_STRING_CHARPOS (*it);
7772 it->bidi_it.bytepos = IT_STRING_BYTEPOS (*it);
7774 else
7776 it->bidi_it.charpos = IT_CHARPOS (*it);
7777 it->bidi_it.bytepos = IT_BYTEPOS (*it);
7780 if (it->bidi_it.charpos == eob)
7782 /* Nothing to do, but reset the FIRST_ELT flag, like
7783 bidi_paragraph_init does, because we are not going to
7784 call it. */
7785 it->bidi_it.first_elt = 0;
7787 else if (it->bidi_it.charpos == bob
7788 || (!string_p
7789 && (FETCH_CHAR (it->bidi_it.bytepos - 1) == '\n'
7790 || FETCH_CHAR (it->bidi_it.bytepos) == '\n')))
7792 /* If we are at the beginning of a line/string, we can produce
7793 the next element right away. */
7794 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7795 bidi_move_to_visually_next (&it->bidi_it);
7797 else
7799 ptrdiff_t orig_bytepos = it->bidi_it.bytepos;
7801 /* We need to prime the bidi iterator starting at the line's or
7802 string's beginning, before we will be able to produce the
7803 next element. */
7804 if (string_p)
7805 it->bidi_it.charpos = it->bidi_it.bytepos = 0;
7806 else
7807 it->bidi_it.charpos = find_newline_no_quit (IT_CHARPOS (*it),
7808 IT_BYTEPOS (*it), -1,
7809 &it->bidi_it.bytepos);
7810 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 1);
7813 /* Now return to buffer/string position where we were asked
7814 to get the next display element, and produce that. */
7815 bidi_move_to_visually_next (&it->bidi_it);
7817 while (it->bidi_it.bytepos != orig_bytepos
7818 && it->bidi_it.charpos < eob);
7821 /* Adjust IT's position information to where we ended up. */
7822 if (STRINGP (it->string))
7824 IT_STRING_CHARPOS (*it) = it->bidi_it.charpos;
7825 IT_STRING_BYTEPOS (*it) = it->bidi_it.bytepos;
7827 else
7829 IT_CHARPOS (*it) = it->bidi_it.charpos;
7830 IT_BYTEPOS (*it) = it->bidi_it.bytepos;
7833 if (STRINGP (it->string) || !it->s)
7835 ptrdiff_t stop, charpos, bytepos;
7837 if (STRINGP (it->string))
7839 eassert (!it->s);
7840 stop = SCHARS (it->string);
7841 if (stop > it->end_charpos)
7842 stop = it->end_charpos;
7843 charpos = IT_STRING_CHARPOS (*it);
7844 bytepos = IT_STRING_BYTEPOS (*it);
7846 else
7848 stop = it->end_charpos;
7849 charpos = IT_CHARPOS (*it);
7850 bytepos = IT_BYTEPOS (*it);
7852 if (it->bidi_it.scan_dir < 0)
7853 stop = -1;
7854 composition_compute_stop_pos (&it->cmp_it, charpos, bytepos, stop,
7855 it->string);
7859 /* Load IT with the next display element from Lisp string IT->string.
7860 IT->current.string_pos is the current position within the string.
7861 If IT->current.overlay_string_index >= 0, the Lisp string is an
7862 overlay string. */
7864 static int
7865 next_element_from_string (struct it *it)
7867 struct text_pos position;
7869 eassert (STRINGP (it->string));
7870 eassert (!it->bidi_p || EQ (it->string, it->bidi_it.string.lstring));
7871 eassert (IT_STRING_CHARPOS (*it) >= 0);
7872 position = it->current.string_pos;
7874 /* With bidi reordering, the character to display might not be the
7875 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7876 that we were reseat()ed to a new string, whose paragraph
7877 direction is not known. */
7878 if (it->bidi_p && it->bidi_it.first_elt)
7880 get_visually_first_element (it);
7881 SET_TEXT_POS (position, IT_STRING_CHARPOS (*it), IT_STRING_BYTEPOS (*it));
7884 /* Time to check for invisible text? */
7885 if (IT_STRING_CHARPOS (*it) < it->end_charpos)
7887 if (IT_STRING_CHARPOS (*it) >= it->stop_charpos)
7889 if (!(!it->bidi_p
7890 || BIDI_AT_BASE_LEVEL (it->bidi_it)
7891 || IT_STRING_CHARPOS (*it) == it->stop_charpos))
7893 /* With bidi non-linear iteration, we could find
7894 ourselves far beyond the last computed stop_charpos,
7895 with several other stop positions in between that we
7896 missed. Scan them all now, in buffer's logical
7897 order, until we find and handle the last stop_charpos
7898 that precedes our current position. */
7899 handle_stop_backwards (it, it->stop_charpos);
7900 return GET_NEXT_DISPLAY_ELEMENT (it);
7902 else
7904 if (it->bidi_p)
7906 /* Take note of the stop position we just moved
7907 across, for when we will move back across it. */
7908 it->prev_stop = it->stop_charpos;
7909 /* If we are at base paragraph embedding level, take
7910 note of the last stop position seen at this
7911 level. */
7912 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
7913 it->base_level_stop = it->stop_charpos;
7915 handle_stop (it);
7917 /* Since a handler may have changed IT->method, we must
7918 recurse here. */
7919 return GET_NEXT_DISPLAY_ELEMENT (it);
7922 else if (it->bidi_p
7923 /* If we are before prev_stop, we may have overstepped
7924 on our way backwards a stop_pos, and if so, we need
7925 to handle that stop_pos. */
7926 && IT_STRING_CHARPOS (*it) < it->prev_stop
7927 /* We can sometimes back up for reasons that have nothing
7928 to do with bidi reordering. E.g., compositions. The
7929 code below is only needed when we are above the base
7930 embedding level, so test for that explicitly. */
7931 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
7933 /* If we lost track of base_level_stop, we have no better
7934 place for handle_stop_backwards to start from than string
7935 beginning. This happens, e.g., when we were reseated to
7936 the previous screenful of text by vertical-motion. */
7937 if (it->base_level_stop <= 0
7938 || IT_STRING_CHARPOS (*it) < it->base_level_stop)
7939 it->base_level_stop = 0;
7940 handle_stop_backwards (it, it->base_level_stop);
7941 return GET_NEXT_DISPLAY_ELEMENT (it);
7945 if (it->current.overlay_string_index >= 0)
7947 /* Get the next character from an overlay string. In overlay
7948 strings, there is no field width or padding with spaces to
7949 do. */
7950 if (IT_STRING_CHARPOS (*it) >= SCHARS (it->string))
7952 it->what = IT_EOB;
7953 return 0;
7955 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7956 IT_STRING_BYTEPOS (*it),
7957 it->bidi_it.scan_dir < 0
7958 ? -1
7959 : SCHARS (it->string))
7960 && next_element_from_composition (it))
7962 return 1;
7964 else if (STRING_MULTIBYTE (it->string))
7966 const unsigned char *s = (SDATA (it->string)
7967 + IT_STRING_BYTEPOS (*it));
7968 it->c = string_char_and_length (s, &it->len);
7970 else
7972 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
7973 it->len = 1;
7976 else
7978 /* Get the next character from a Lisp string that is not an
7979 overlay string. Such strings come from the mode line, for
7980 example. We may have to pad with spaces, or truncate the
7981 string. See also next_element_from_c_string. */
7982 if (IT_STRING_CHARPOS (*it) >= it->end_charpos)
7984 it->what = IT_EOB;
7985 return 0;
7987 else if (IT_STRING_CHARPOS (*it) >= it->string_nchars)
7989 /* Pad with spaces. */
7990 it->c = ' ', it->len = 1;
7991 CHARPOS (position) = BYTEPOS (position) = -1;
7993 else if (CHAR_COMPOSED_P (it, IT_STRING_CHARPOS (*it),
7994 IT_STRING_BYTEPOS (*it),
7995 it->bidi_it.scan_dir < 0
7996 ? -1
7997 : it->string_nchars)
7998 && next_element_from_composition (it))
8000 return 1;
8002 else if (STRING_MULTIBYTE (it->string))
8004 const unsigned char *s = (SDATA (it->string)
8005 + IT_STRING_BYTEPOS (*it));
8006 it->c = string_char_and_length (s, &it->len);
8008 else
8010 it->c = SREF (it->string, IT_STRING_BYTEPOS (*it));
8011 it->len = 1;
8015 /* Record what we have and where it came from. */
8016 it->what = IT_CHARACTER;
8017 it->object = it->string;
8018 it->position = position;
8019 return 1;
8023 /* Load IT with next display element from C string IT->s.
8024 IT->string_nchars is the maximum number of characters to return
8025 from the string. IT->end_charpos may be greater than
8026 IT->string_nchars when this function is called, in which case we
8027 may have to return padding spaces. Value is zero if end of string
8028 reached, including padding spaces. */
8030 static int
8031 next_element_from_c_string (struct it *it)
8033 bool success_p = true;
8035 eassert (it->s);
8036 eassert (!it->bidi_p || it->s == it->bidi_it.string.s);
8037 it->what = IT_CHARACTER;
8038 BYTEPOS (it->position) = CHARPOS (it->position) = 0;
8039 it->object = Qnil;
8041 /* With bidi reordering, the character to display might not be the
8042 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8043 we were reseated to a new string, whose paragraph direction is
8044 not known. */
8045 if (it->bidi_p && it->bidi_it.first_elt)
8046 get_visually_first_element (it);
8048 /* IT's position can be greater than IT->string_nchars in case a
8049 field width or precision has been specified when the iterator was
8050 initialized. */
8051 if (IT_CHARPOS (*it) >= it->end_charpos)
8053 /* End of the game. */
8054 it->what = IT_EOB;
8055 success_p = 0;
8057 else if (IT_CHARPOS (*it) >= it->string_nchars)
8059 /* Pad with spaces. */
8060 it->c = ' ', it->len = 1;
8061 BYTEPOS (it->position) = CHARPOS (it->position) = -1;
8063 else if (it->multibyte_p)
8064 it->c = string_char_and_length (it->s + IT_BYTEPOS (*it), &it->len);
8065 else
8066 it->c = it->s[IT_BYTEPOS (*it)], it->len = 1;
8068 return success_p;
8072 /* Set up IT to return characters from an ellipsis, if appropriate.
8073 The definition of the ellipsis glyphs may come from a display table
8074 entry. This function fills IT with the first glyph from the
8075 ellipsis if an ellipsis is to be displayed. */
8077 static int
8078 next_element_from_ellipsis (struct it *it)
8080 if (it->selective_display_ellipsis_p)
8081 setup_for_ellipsis (it, it->len);
8082 else
8084 /* The face at the current position may be different from the
8085 face we find after the invisible text. Remember what it
8086 was in IT->saved_face_id, and signal that it's there by
8087 setting face_before_selective_p. */
8088 it->saved_face_id = it->face_id;
8089 it->method = GET_FROM_BUFFER;
8090 it->object = it->w->contents;
8091 reseat_at_next_visible_line_start (it, 1);
8092 it->face_before_selective_p = true;
8095 return GET_NEXT_DISPLAY_ELEMENT (it);
8099 /* Deliver an image display element. The iterator IT is already
8100 filled with image information (done in handle_display_prop). Value
8101 is always 1. */
8104 static int
8105 next_element_from_image (struct it *it)
8107 it->what = IT_IMAGE;
8108 it->ignore_overlay_strings_at_pos_p = 0;
8109 return 1;
8113 /* Fill iterator IT with next display element from a stretch glyph
8114 property. IT->object is the value of the text property. Value is
8115 always 1. */
8117 static int
8118 next_element_from_stretch (struct it *it)
8120 it->what = IT_STRETCH;
8121 return 1;
8124 /* Scan backwards from IT's current position until we find a stop
8125 position, or until BEGV. This is called when we find ourself
8126 before both the last known prev_stop and base_level_stop while
8127 reordering bidirectional text. */
8129 static void
8130 compute_stop_pos_backwards (struct it *it)
8132 const int SCAN_BACK_LIMIT = 1000;
8133 struct text_pos pos;
8134 struct display_pos save_current = it->current;
8135 struct text_pos save_position = it->position;
8136 ptrdiff_t charpos = IT_CHARPOS (*it);
8137 ptrdiff_t where_we_are = charpos;
8138 ptrdiff_t save_stop_pos = it->stop_charpos;
8139 ptrdiff_t save_end_pos = it->end_charpos;
8141 eassert (NILP (it->string) && !it->s);
8142 eassert (it->bidi_p);
8143 it->bidi_p = 0;
8146 it->end_charpos = min (charpos + 1, ZV);
8147 charpos = max (charpos - SCAN_BACK_LIMIT, BEGV);
8148 SET_TEXT_POS (pos, charpos, CHAR_TO_BYTE (charpos));
8149 reseat_1 (it, pos, 0);
8150 compute_stop_pos (it);
8151 /* We must advance forward, right? */
8152 if (it->stop_charpos <= charpos)
8153 emacs_abort ();
8155 while (charpos > BEGV && it->stop_charpos >= it->end_charpos);
8157 if (it->stop_charpos <= where_we_are)
8158 it->prev_stop = it->stop_charpos;
8159 else
8160 it->prev_stop = BEGV;
8161 it->bidi_p = true;
8162 it->current = save_current;
8163 it->position = save_position;
8164 it->stop_charpos = save_stop_pos;
8165 it->end_charpos = save_end_pos;
8168 /* Scan forward from CHARPOS in the current buffer/string, until we
8169 find a stop position > current IT's position. Then handle the stop
8170 position before that. This is called when we bump into a stop
8171 position while reordering bidirectional text. CHARPOS should be
8172 the last previously processed stop_pos (or BEGV/0, if none were
8173 processed yet) whose position is less that IT's current
8174 position. */
8176 static void
8177 handle_stop_backwards (struct it *it, ptrdiff_t charpos)
8179 int bufp = !STRINGP (it->string);
8180 ptrdiff_t where_we_are = (bufp ? IT_CHARPOS (*it) : IT_STRING_CHARPOS (*it));
8181 struct display_pos save_current = it->current;
8182 struct text_pos save_position = it->position;
8183 struct text_pos pos1;
8184 ptrdiff_t next_stop;
8186 /* Scan in strict logical order. */
8187 eassert (it->bidi_p);
8188 it->bidi_p = 0;
8191 it->prev_stop = charpos;
8192 if (bufp)
8194 SET_TEXT_POS (pos1, charpos, CHAR_TO_BYTE (charpos));
8195 reseat_1 (it, pos1, 0);
8197 else
8198 it->current.string_pos = string_pos (charpos, it->string);
8199 compute_stop_pos (it);
8200 /* We must advance forward, right? */
8201 if (it->stop_charpos <= it->prev_stop)
8202 emacs_abort ();
8203 charpos = it->stop_charpos;
8205 while (charpos <= where_we_are);
8207 it->bidi_p = true;
8208 it->current = save_current;
8209 it->position = save_position;
8210 next_stop = it->stop_charpos;
8211 it->stop_charpos = it->prev_stop;
8212 handle_stop (it);
8213 it->stop_charpos = next_stop;
8216 /* Load IT with the next display element from current_buffer. Value
8217 is zero if end of buffer reached. IT->stop_charpos is the next
8218 position at which to stop and check for text properties or buffer
8219 end. */
8221 static int
8222 next_element_from_buffer (struct it *it)
8224 bool success_p = true;
8226 eassert (IT_CHARPOS (*it) >= BEGV);
8227 eassert (NILP (it->string) && !it->s);
8228 eassert (!it->bidi_p
8229 || (EQ (it->bidi_it.string.lstring, Qnil)
8230 && it->bidi_it.string.s == NULL));
8232 /* With bidi reordering, the character to display might not be the
8233 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8234 we were reseat()ed to a new buffer position, which is potentially
8235 a different paragraph. */
8236 if (it->bidi_p && it->bidi_it.first_elt)
8238 get_visually_first_element (it);
8239 SET_TEXT_POS (it->position, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8242 if (IT_CHARPOS (*it) >= it->stop_charpos)
8244 if (IT_CHARPOS (*it) >= it->end_charpos)
8246 int overlay_strings_follow_p;
8248 /* End of the game, except when overlay strings follow that
8249 haven't been returned yet. */
8250 if (it->overlay_strings_at_end_processed_p)
8251 overlay_strings_follow_p = 0;
8252 else
8254 it->overlay_strings_at_end_processed_p = true;
8255 overlay_strings_follow_p = get_overlay_strings (it, 0);
8258 if (overlay_strings_follow_p)
8259 success_p = GET_NEXT_DISPLAY_ELEMENT (it);
8260 else
8262 it->what = IT_EOB;
8263 it->position = it->current.pos;
8264 success_p = 0;
8267 else if (!(!it->bidi_p
8268 || BIDI_AT_BASE_LEVEL (it->bidi_it)
8269 || IT_CHARPOS (*it) == it->stop_charpos))
8271 /* With bidi non-linear iteration, we could find ourselves
8272 far beyond the last computed stop_charpos, with several
8273 other stop positions in between that we missed. Scan
8274 them all now, in buffer's logical order, until we find
8275 and handle the last stop_charpos that precedes our
8276 current position. */
8277 handle_stop_backwards (it, it->stop_charpos);
8278 return GET_NEXT_DISPLAY_ELEMENT (it);
8280 else
8282 if (it->bidi_p)
8284 /* Take note of the stop position we just moved across,
8285 for when we will move back across it. */
8286 it->prev_stop = it->stop_charpos;
8287 /* If we are at base paragraph embedding level, take
8288 note of the last stop position seen at this
8289 level. */
8290 if (BIDI_AT_BASE_LEVEL (it->bidi_it))
8291 it->base_level_stop = it->stop_charpos;
8293 handle_stop (it);
8294 return GET_NEXT_DISPLAY_ELEMENT (it);
8297 else if (it->bidi_p
8298 /* If we are before prev_stop, we may have overstepped on
8299 our way backwards a stop_pos, and if so, we need to
8300 handle that stop_pos. */
8301 && IT_CHARPOS (*it) < it->prev_stop
8302 /* We can sometimes back up for reasons that have nothing
8303 to do with bidi reordering. E.g., compositions. The
8304 code below is only needed when we are above the base
8305 embedding level, so test for that explicitly. */
8306 && !BIDI_AT_BASE_LEVEL (it->bidi_it))
8308 if (it->base_level_stop <= 0
8309 || IT_CHARPOS (*it) < it->base_level_stop)
8311 /* If we lost track of base_level_stop, we need to find
8312 prev_stop by looking backwards. This happens, e.g., when
8313 we were reseated to the previous screenful of text by
8314 vertical-motion. */
8315 it->base_level_stop = BEGV;
8316 compute_stop_pos_backwards (it);
8317 handle_stop_backwards (it, it->prev_stop);
8319 else
8320 handle_stop_backwards (it, it->base_level_stop);
8321 return GET_NEXT_DISPLAY_ELEMENT (it);
8323 else
8325 /* No face changes, overlays etc. in sight, so just return a
8326 character from current_buffer. */
8327 unsigned char *p;
8328 ptrdiff_t stop;
8330 /* Maybe run the redisplay end trigger hook. Performance note:
8331 This doesn't seem to cost measurable time. */
8332 if (it->redisplay_end_trigger_charpos
8333 && it->glyph_row
8334 && IT_CHARPOS (*it) >= it->redisplay_end_trigger_charpos)
8335 run_redisplay_end_trigger_hook (it);
8337 stop = it->bidi_it.scan_dir < 0 ? -1 : it->end_charpos;
8338 if (CHAR_COMPOSED_P (it, IT_CHARPOS (*it), IT_BYTEPOS (*it),
8339 stop)
8340 && next_element_from_composition (it))
8342 return 1;
8345 /* Get the next character, maybe multibyte. */
8346 p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
8347 if (it->multibyte_p && !ASCII_BYTE_P (*p))
8348 it->c = STRING_CHAR_AND_LENGTH (p, it->len);
8349 else
8350 it->c = *p, it->len = 1;
8352 /* Record what we have and where it came from. */
8353 it->what = IT_CHARACTER;
8354 it->object = it->w->contents;
8355 it->position = it->current.pos;
8357 /* Normally we return the character found above, except when we
8358 really want to return an ellipsis for selective display. */
8359 if (it->selective)
8361 if (it->c == '\n')
8363 /* A value of selective > 0 means hide lines indented more
8364 than that number of columns. */
8365 if (it->selective > 0
8366 && IT_CHARPOS (*it) + 1 < ZV
8367 && indented_beyond_p (IT_CHARPOS (*it) + 1,
8368 IT_BYTEPOS (*it) + 1,
8369 it->selective))
8371 success_p = next_element_from_ellipsis (it);
8372 it->dpvec_char_len = -1;
8375 else if (it->c == '\r' && it->selective == -1)
8377 /* A value of selective == -1 means that everything from the
8378 CR to the end of the line is invisible, with maybe an
8379 ellipsis displayed for it. */
8380 success_p = next_element_from_ellipsis (it);
8381 it->dpvec_char_len = -1;
8386 /* Value is zero if end of buffer reached. */
8387 eassert (!success_p || it->what != IT_CHARACTER || it->len > 0);
8388 return success_p;
8392 /* Run the redisplay end trigger hook for IT. */
8394 static void
8395 run_redisplay_end_trigger_hook (struct it *it)
8397 Lisp_Object args[3];
8399 /* IT->glyph_row should be non-null, i.e. we should be actually
8400 displaying something, or otherwise we should not run the hook. */
8401 eassert (it->glyph_row);
8403 /* Set up hook arguments. */
8404 args[0] = Qredisplay_end_trigger_functions;
8405 args[1] = it->window;
8406 XSETINT (args[2], it->redisplay_end_trigger_charpos);
8407 it->redisplay_end_trigger_charpos = 0;
8409 /* Since we are *trying* to run these functions, don't try to run
8410 them again, even if they get an error. */
8411 wset_redisplay_end_trigger (it->w, Qnil);
8412 Frun_hook_with_args (3, args);
8414 /* Notice if it changed the face of the character we are on. */
8415 handle_face_prop (it);
8419 /* Deliver a composition display element. Unlike the other
8420 next_element_from_XXX, this function is not registered in the array
8421 get_next_element[]. It is called from next_element_from_buffer and
8422 next_element_from_string when necessary. */
8424 static int
8425 next_element_from_composition (struct it *it)
8427 it->what = IT_COMPOSITION;
8428 it->len = it->cmp_it.nbytes;
8429 if (STRINGP (it->string))
8431 if (it->c < 0)
8433 IT_STRING_CHARPOS (*it) += it->cmp_it.nchars;
8434 IT_STRING_BYTEPOS (*it) += it->cmp_it.nbytes;
8435 return 0;
8437 it->position = it->current.string_pos;
8438 it->object = it->string;
8439 it->c = composition_update_it (&it->cmp_it, IT_STRING_CHARPOS (*it),
8440 IT_STRING_BYTEPOS (*it), it->string);
8442 else
8444 if (it->c < 0)
8446 IT_CHARPOS (*it) += it->cmp_it.nchars;
8447 IT_BYTEPOS (*it) += it->cmp_it.nbytes;
8448 if (it->bidi_p)
8450 if (it->bidi_it.new_paragraph)
8451 bidi_paragraph_init (it->paragraph_embedding, &it->bidi_it, 0);
8452 /* Resync the bidi iterator with IT's new position.
8453 FIXME: this doesn't support bidirectional text. */
8454 while (it->bidi_it.charpos < IT_CHARPOS (*it))
8455 bidi_move_to_visually_next (&it->bidi_it);
8457 return 0;
8459 it->position = it->current.pos;
8460 it->object = it->w->contents;
8461 it->c = composition_update_it (&it->cmp_it, IT_CHARPOS (*it),
8462 IT_BYTEPOS (*it), Qnil);
8464 return 1;
8469 /***********************************************************************
8470 Moving an iterator without producing glyphs
8471 ***********************************************************************/
8473 /* Check if iterator is at a position corresponding to a valid buffer
8474 position after some move_it_ call. */
8476 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8477 ((it)->method == GET_FROM_STRING \
8478 ? IT_STRING_CHARPOS (*it) == 0 \
8479 : 1)
8482 /* Move iterator IT to a specified buffer or X position within one
8483 line on the display without producing glyphs.
8485 OP should be a bit mask including some or all of these bits:
8486 MOVE_TO_X: Stop upon reaching x-position TO_X.
8487 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8488 Regardless of OP's value, stop upon reaching the end of the display line.
8490 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8491 This means, in particular, that TO_X includes window's horizontal
8492 scroll amount.
8494 The return value has several possible values that
8495 say what condition caused the scan to stop:
8497 MOVE_POS_MATCH_OR_ZV
8498 - when TO_POS or ZV was reached.
8500 MOVE_X_REACHED
8501 -when TO_X was reached before TO_POS or ZV were reached.
8503 MOVE_LINE_CONTINUED
8504 - when we reached the end of the display area and the line must
8505 be continued.
8507 MOVE_LINE_TRUNCATED
8508 - when we reached the end of the display area and the line is
8509 truncated.
8511 MOVE_NEWLINE_OR_CR
8512 - when we stopped at a line end, i.e. a newline or a CR and selective
8513 display is on. */
8515 static enum move_it_result
8516 move_it_in_display_line_to (struct it *it,
8517 ptrdiff_t to_charpos, int to_x,
8518 enum move_operation_enum op)
8520 enum move_it_result result = MOVE_UNDEFINED;
8521 struct glyph_row *saved_glyph_row;
8522 struct it wrap_it, atpos_it, atx_it, ppos_it;
8523 void *wrap_data = NULL, *atpos_data = NULL, *atx_data = NULL;
8524 void *ppos_data = NULL;
8525 int may_wrap = 0;
8526 enum it_method prev_method = it->method;
8527 ptrdiff_t closest_pos IF_LINT (= 0), prev_pos = IT_CHARPOS (*it);
8528 int saw_smaller_pos = prev_pos < to_charpos;
8530 /* Don't produce glyphs in produce_glyphs. */
8531 saved_glyph_row = it->glyph_row;
8532 it->glyph_row = NULL;
8534 /* Use wrap_it to save a copy of IT wherever a word wrap could
8535 occur. Use atpos_it to save a copy of IT at the desired buffer
8536 position, if found, so that we can scan ahead and check if the
8537 word later overshoots the window edge. Use atx_it similarly, for
8538 pixel positions. */
8539 wrap_it.sp = -1;
8540 atpos_it.sp = -1;
8541 atx_it.sp = -1;
8543 /* Use ppos_it under bidi reordering to save a copy of IT for the
8544 initial position. We restore that position in IT when we have
8545 scanned the entire display line without finding a match for
8546 TO_CHARPOS and all the character positions are greater than
8547 TO_CHARPOS. We then restart the scan from the initial position,
8548 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8549 the closest to TO_CHARPOS. */
8550 if (it->bidi_p)
8552 if ((op & MOVE_TO_POS) && IT_CHARPOS (*it) >= to_charpos)
8554 SAVE_IT (ppos_it, *it, ppos_data);
8555 closest_pos = IT_CHARPOS (*it);
8557 else
8558 closest_pos = ZV;
8561 #define BUFFER_POS_REACHED_P() \
8562 ((op & MOVE_TO_POS) != 0 \
8563 && BUFFERP (it->object) \
8564 && (IT_CHARPOS (*it) == to_charpos \
8565 || ((!it->bidi_p \
8566 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8567 && IT_CHARPOS (*it) > to_charpos) \
8568 || (it->what == IT_COMPOSITION \
8569 && ((IT_CHARPOS (*it) > to_charpos \
8570 && to_charpos >= it->cmp_it.charpos) \
8571 || (IT_CHARPOS (*it) < to_charpos \
8572 && to_charpos <= it->cmp_it.charpos)))) \
8573 && (it->method == GET_FROM_BUFFER \
8574 || (it->method == GET_FROM_DISPLAY_VECTOR \
8575 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8577 /* If there's a line-/wrap-prefix, handle it. */
8578 if (it->hpos == 0 && it->method == GET_FROM_BUFFER
8579 && it->current_y < it->last_visible_y)
8580 handle_line_prefix (it);
8582 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8583 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8585 while (1)
8587 int x, i, ascent = 0, descent = 0;
8589 /* Utility macro to reset an iterator with x, ascent, and descent. */
8590 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8591 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8592 (IT)->max_descent = descent)
8594 /* Stop if we move beyond TO_CHARPOS (after an image or a
8595 display string or stretch glyph). */
8596 if ((op & MOVE_TO_POS) != 0
8597 && BUFFERP (it->object)
8598 && it->method == GET_FROM_BUFFER
8599 && (((!it->bidi_p
8600 /* When the iterator is at base embedding level, we
8601 are guaranteed that characters are delivered for
8602 display in strictly increasing order of their
8603 buffer positions. */
8604 || BIDI_AT_BASE_LEVEL (it->bidi_it))
8605 && IT_CHARPOS (*it) > to_charpos)
8606 || (it->bidi_p
8607 && (prev_method == GET_FROM_IMAGE
8608 || prev_method == GET_FROM_STRETCH
8609 || prev_method == GET_FROM_STRING)
8610 /* Passed TO_CHARPOS from left to right. */
8611 && ((prev_pos < to_charpos
8612 && IT_CHARPOS (*it) > to_charpos)
8613 /* Passed TO_CHARPOS from right to left. */
8614 || (prev_pos > to_charpos
8615 && IT_CHARPOS (*it) < to_charpos)))))
8617 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8619 result = MOVE_POS_MATCH_OR_ZV;
8620 break;
8622 else if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8623 /* If wrap_it is valid, the current position might be in a
8624 word that is wrapped. So, save the iterator in
8625 atpos_it and continue to see if wrapping happens. */
8626 SAVE_IT (atpos_it, *it, atpos_data);
8629 /* Stop when ZV reached.
8630 We used to stop here when TO_CHARPOS reached as well, but that is
8631 too soon if this glyph does not fit on this line. So we handle it
8632 explicitly below. */
8633 if (!get_next_display_element (it))
8635 result = MOVE_POS_MATCH_OR_ZV;
8636 break;
8639 if (it->line_wrap == TRUNCATE)
8641 if (BUFFER_POS_REACHED_P ())
8643 result = MOVE_POS_MATCH_OR_ZV;
8644 break;
8647 else
8649 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
8651 if (IT_DISPLAYING_WHITESPACE (it))
8652 may_wrap = 1;
8653 else if (may_wrap)
8655 /* We have reached a glyph that follows one or more
8656 whitespace characters. If the position is
8657 already found, we are done. */
8658 if (atpos_it.sp >= 0)
8660 RESTORE_IT (it, &atpos_it, atpos_data);
8661 result = MOVE_POS_MATCH_OR_ZV;
8662 goto done;
8664 if (atx_it.sp >= 0)
8666 RESTORE_IT (it, &atx_it, atx_data);
8667 result = MOVE_X_REACHED;
8668 goto done;
8670 /* Otherwise, we can wrap here. */
8671 SAVE_IT (wrap_it, *it, wrap_data);
8672 may_wrap = 0;
8677 /* Remember the line height for the current line, in case
8678 the next element doesn't fit on the line. */
8679 ascent = it->max_ascent;
8680 descent = it->max_descent;
8682 /* The call to produce_glyphs will get the metrics of the
8683 display element IT is loaded with. Record the x-position
8684 before this display element, in case it doesn't fit on the
8685 line. */
8686 x = it->current_x;
8688 PRODUCE_GLYPHS (it);
8690 if (it->area != TEXT_AREA)
8692 prev_method = it->method;
8693 if (it->method == GET_FROM_BUFFER)
8694 prev_pos = IT_CHARPOS (*it);
8695 set_iterator_to_next (it, 1);
8696 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8697 SET_TEXT_POS (this_line_min_pos,
8698 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8699 if (it->bidi_p
8700 && (op & MOVE_TO_POS)
8701 && IT_CHARPOS (*it) > to_charpos
8702 && IT_CHARPOS (*it) < closest_pos)
8703 closest_pos = IT_CHARPOS (*it);
8704 continue;
8707 /* The number of glyphs we get back in IT->nglyphs will normally
8708 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8709 character on a terminal frame, or (iii) a line end. For the
8710 second case, IT->nglyphs - 1 padding glyphs will be present.
8711 (On X frames, there is only one glyph produced for a
8712 composite character.)
8714 The behavior implemented below means, for continuation lines,
8715 that as many spaces of a TAB as fit on the current line are
8716 displayed there. For terminal frames, as many glyphs of a
8717 multi-glyph character are displayed in the current line, too.
8718 This is what the old redisplay code did, and we keep it that
8719 way. Under X, the whole shape of a complex character must
8720 fit on the line or it will be completely displayed in the
8721 next line.
8723 Note that both for tabs and padding glyphs, all glyphs have
8724 the same width. */
8725 if (it->nglyphs)
8727 /* More than one glyph or glyph doesn't fit on line. All
8728 glyphs have the same width. */
8729 int single_glyph_width = it->pixel_width / it->nglyphs;
8730 int new_x;
8731 int x_before_this_char = x;
8732 int hpos_before_this_char = it->hpos;
8734 for (i = 0; i < it->nglyphs; ++i, x = new_x)
8736 new_x = x + single_glyph_width;
8738 /* We want to leave anything reaching TO_X to the caller. */
8739 if ((op & MOVE_TO_X) && new_x > to_x)
8741 if (BUFFER_POS_REACHED_P ())
8743 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8744 goto buffer_pos_reached;
8745 if (atpos_it.sp < 0)
8747 SAVE_IT (atpos_it, *it, atpos_data);
8748 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8751 else
8753 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8755 it->current_x = x;
8756 result = MOVE_X_REACHED;
8757 break;
8759 if (atx_it.sp < 0)
8761 SAVE_IT (atx_it, *it, atx_data);
8762 IT_RESET_X_ASCENT_DESCENT (&atx_it);
8767 if (/* Lines are continued. */
8768 it->line_wrap != TRUNCATE
8769 && (/* And glyph doesn't fit on the line. */
8770 new_x > it->last_visible_x
8771 /* Or it fits exactly and we're on a window
8772 system frame. */
8773 || (new_x == it->last_visible_x
8774 && FRAME_WINDOW_P (it->f)
8775 && ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8776 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8777 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
8779 if (/* IT->hpos == 0 means the very first glyph
8780 doesn't fit on the line, e.g. a wide image. */
8781 it->hpos == 0
8782 || (new_x == it->last_visible_x
8783 && FRAME_WINDOW_P (it->f)
8784 /* When word-wrap is ON and we have a valid
8785 wrap point, we don't allow the last glyph
8786 to "just barely fit" on the line. */
8787 && (it->line_wrap != WORD_WRAP
8788 || wrap_it.sp < 0)))
8790 ++it->hpos;
8791 it->current_x = new_x;
8793 /* The character's last glyph just barely fits
8794 in this row. */
8795 if (i == it->nglyphs - 1)
8797 /* If this is the destination position,
8798 return a position *before* it in this row,
8799 now that we know it fits in this row. */
8800 if (BUFFER_POS_REACHED_P ())
8802 if (it->line_wrap != WORD_WRAP
8803 || wrap_it.sp < 0)
8805 it->hpos = hpos_before_this_char;
8806 it->current_x = x_before_this_char;
8807 result = MOVE_POS_MATCH_OR_ZV;
8808 break;
8810 if (it->line_wrap == WORD_WRAP
8811 && atpos_it.sp < 0)
8813 SAVE_IT (atpos_it, *it, atpos_data);
8814 atpos_it.current_x = x_before_this_char;
8815 atpos_it.hpos = hpos_before_this_char;
8819 prev_method = it->method;
8820 if (it->method == GET_FROM_BUFFER)
8821 prev_pos = IT_CHARPOS (*it);
8822 set_iterator_to_next (it, 1);
8823 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8824 SET_TEXT_POS (this_line_min_pos,
8825 IT_CHARPOS (*it), IT_BYTEPOS (*it));
8826 /* On graphical terminals, newlines may
8827 "overflow" into the fringe if
8828 overflow-newline-into-fringe is non-nil.
8829 On text terminals, and on graphical
8830 terminals with no right margin, newlines
8831 may overflow into the last glyph on the
8832 display line.*/
8833 if (!FRAME_WINDOW_P (it->f)
8834 || ((it->bidi_p
8835 && it->bidi_it.paragraph_dir == R2L)
8836 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8837 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8838 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8840 if (!get_next_display_element (it))
8842 result = MOVE_POS_MATCH_OR_ZV;
8843 break;
8845 if (BUFFER_POS_REACHED_P ())
8847 if (ITERATOR_AT_END_OF_LINE_P (it))
8848 result = MOVE_POS_MATCH_OR_ZV;
8849 else
8850 result = MOVE_LINE_CONTINUED;
8851 break;
8853 if (ITERATOR_AT_END_OF_LINE_P (it)
8854 && (it->line_wrap != WORD_WRAP
8855 || wrap_it.sp < 0))
8857 result = MOVE_NEWLINE_OR_CR;
8858 break;
8863 else
8864 IT_RESET_X_ASCENT_DESCENT (it);
8866 if (wrap_it.sp >= 0)
8868 RESTORE_IT (it, &wrap_it, wrap_data);
8869 atpos_it.sp = -1;
8870 atx_it.sp = -1;
8873 TRACE_MOVE ((stderr, "move_it_in: continued at %d\n",
8874 IT_CHARPOS (*it)));
8875 result = MOVE_LINE_CONTINUED;
8876 break;
8879 if (BUFFER_POS_REACHED_P ())
8881 if (it->line_wrap != WORD_WRAP || wrap_it.sp < 0)
8882 goto buffer_pos_reached;
8883 if (it->line_wrap == WORD_WRAP && atpos_it.sp < 0)
8885 SAVE_IT (atpos_it, *it, atpos_data);
8886 IT_RESET_X_ASCENT_DESCENT (&atpos_it);
8890 if (new_x > it->first_visible_x)
8892 /* Glyph is visible. Increment number of glyphs that
8893 would be displayed. */
8894 ++it->hpos;
8898 if (result != MOVE_UNDEFINED)
8899 break;
8901 else if (BUFFER_POS_REACHED_P ())
8903 buffer_pos_reached:
8904 IT_RESET_X_ASCENT_DESCENT (it);
8905 result = MOVE_POS_MATCH_OR_ZV;
8906 break;
8908 else if ((op & MOVE_TO_X) && it->current_x >= to_x)
8910 /* Stop when TO_X specified and reached. This check is
8911 necessary here because of lines consisting of a line end,
8912 only. The line end will not produce any glyphs and we
8913 would never get MOVE_X_REACHED. */
8914 eassert (it->nglyphs == 0);
8915 result = MOVE_X_REACHED;
8916 break;
8919 /* Is this a line end? If yes, we're done. */
8920 if (ITERATOR_AT_END_OF_LINE_P (it))
8922 /* If we are past TO_CHARPOS, but never saw any character
8923 positions smaller than TO_CHARPOS, return
8924 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8925 did. */
8926 if (it->bidi_p && (op & MOVE_TO_POS) != 0)
8928 if (!saw_smaller_pos && IT_CHARPOS (*it) > to_charpos)
8930 if (closest_pos < ZV)
8932 RESTORE_IT (it, &ppos_it, ppos_data);
8933 /* Don't recurse if closest_pos is equal to
8934 to_charpos, since we have just tried that. */
8935 if (closest_pos != to_charpos)
8936 move_it_in_display_line_to (it, closest_pos, -1,
8937 MOVE_TO_POS);
8938 result = MOVE_POS_MATCH_OR_ZV;
8940 else
8941 goto buffer_pos_reached;
8943 else if (it->line_wrap == WORD_WRAP && atpos_it.sp >= 0
8944 && IT_CHARPOS (*it) > to_charpos)
8945 goto buffer_pos_reached;
8946 else
8947 result = MOVE_NEWLINE_OR_CR;
8949 else
8950 result = MOVE_NEWLINE_OR_CR;
8951 break;
8954 prev_method = it->method;
8955 if (it->method == GET_FROM_BUFFER)
8956 prev_pos = IT_CHARPOS (*it);
8957 /* The current display element has been consumed. Advance
8958 to the next. */
8959 set_iterator_to_next (it, 1);
8960 if (IT_CHARPOS (*it) < CHARPOS (this_line_min_pos))
8961 SET_TEXT_POS (this_line_min_pos, IT_CHARPOS (*it), IT_BYTEPOS (*it));
8962 if (IT_CHARPOS (*it) < to_charpos)
8963 saw_smaller_pos = 1;
8964 if (it->bidi_p
8965 && (op & MOVE_TO_POS)
8966 && IT_CHARPOS (*it) >= to_charpos
8967 && IT_CHARPOS (*it) < closest_pos)
8968 closest_pos = IT_CHARPOS (*it);
8970 /* Stop if lines are truncated and IT's current x-position is
8971 past the right edge of the window now. */
8972 if (it->line_wrap == TRUNCATE
8973 && it->current_x >= it->last_visible_x)
8975 if (!FRAME_WINDOW_P (it->f)
8976 || ((it->bidi_p && it->bidi_it.paragraph_dir == R2L)
8977 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
8978 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0
8979 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
8981 int at_eob_p = 0;
8983 if ((at_eob_p = !get_next_display_element (it))
8984 || BUFFER_POS_REACHED_P ()
8985 /* If we are past TO_CHARPOS, but never saw any
8986 character positions smaller than TO_CHARPOS,
8987 return MOVE_POS_MATCH_OR_ZV, like the
8988 unidirectional display did. */
8989 || (it->bidi_p && (op & MOVE_TO_POS) != 0
8990 && !saw_smaller_pos
8991 && IT_CHARPOS (*it) > to_charpos))
8993 if (it->bidi_p
8994 && !BUFFER_POS_REACHED_P ()
8995 && !at_eob_p && closest_pos < ZV)
8997 RESTORE_IT (it, &ppos_it, ppos_data);
8998 if (closest_pos != to_charpos)
8999 move_it_in_display_line_to (it, closest_pos, -1,
9000 MOVE_TO_POS);
9002 result = MOVE_POS_MATCH_OR_ZV;
9003 break;
9005 if (ITERATOR_AT_END_OF_LINE_P (it))
9007 result = MOVE_NEWLINE_OR_CR;
9008 break;
9011 else if (it->bidi_p && (op & MOVE_TO_POS) != 0
9012 && !saw_smaller_pos
9013 && IT_CHARPOS (*it) > to_charpos)
9015 if (closest_pos < ZV)
9017 RESTORE_IT (it, &ppos_it, ppos_data);
9018 if (closest_pos != to_charpos)
9019 move_it_in_display_line_to (it, closest_pos, -1,
9020 MOVE_TO_POS);
9022 result = MOVE_POS_MATCH_OR_ZV;
9023 break;
9025 result = MOVE_LINE_TRUNCATED;
9026 break;
9028 #undef IT_RESET_X_ASCENT_DESCENT
9031 #undef BUFFER_POS_REACHED_P
9033 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9034 restore the saved iterator. */
9035 if (atpos_it.sp >= 0)
9036 RESTORE_IT (it, &atpos_it, atpos_data);
9037 else if (atx_it.sp >= 0)
9038 RESTORE_IT (it, &atx_it, atx_data);
9040 done:
9042 if (atpos_data)
9043 bidi_unshelve_cache (atpos_data, 1);
9044 if (atx_data)
9045 bidi_unshelve_cache (atx_data, 1);
9046 if (wrap_data)
9047 bidi_unshelve_cache (wrap_data, 1);
9048 if (ppos_data)
9049 bidi_unshelve_cache (ppos_data, 1);
9051 /* Restore the iterator settings altered at the beginning of this
9052 function. */
9053 it->glyph_row = saved_glyph_row;
9054 return result;
9057 /* For external use. */
9058 void
9059 move_it_in_display_line (struct it *it,
9060 ptrdiff_t to_charpos, int to_x,
9061 enum move_operation_enum op)
9063 if (it->line_wrap == WORD_WRAP
9064 && (op & MOVE_TO_X))
9066 struct it save_it;
9067 void *save_data = NULL;
9068 int skip;
9070 SAVE_IT (save_it, *it, save_data);
9071 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9072 /* When word-wrap is on, TO_X may lie past the end
9073 of a wrapped line. Then it->current is the
9074 character on the next line, so backtrack to the
9075 space before the wrap point. */
9076 if (skip == MOVE_LINE_CONTINUED)
9078 int prev_x = max (it->current_x - 1, 0);
9079 RESTORE_IT (it, &save_it, save_data);
9080 move_it_in_display_line_to
9081 (it, -1, prev_x, MOVE_TO_X);
9083 else
9084 bidi_unshelve_cache (save_data, 1);
9086 else
9087 move_it_in_display_line_to (it, to_charpos, to_x, op);
9091 /* Move IT forward until it satisfies one or more of the criteria in
9092 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9094 OP is a bit-mask that specifies where to stop, and in particular,
9095 which of those four position arguments makes a difference. See the
9096 description of enum move_operation_enum.
9098 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9099 screen line, this function will set IT to the next position that is
9100 displayed to the right of TO_CHARPOS on the screen.
9102 Return the maximum pixel length of any line scanned but never more
9103 than it.last_visible_x. */
9106 move_it_to (struct it *it, ptrdiff_t to_charpos, int to_x, int to_y, int to_vpos, int op)
9108 enum move_it_result skip, skip2 = MOVE_X_REACHED;
9109 int line_height, line_start_x = 0, reached = 0;
9110 int max_current_x = 0;
9111 void *backup_data = NULL;
9113 for (;;)
9115 if (op & MOVE_TO_VPOS)
9117 /* If no TO_CHARPOS and no TO_X specified, stop at the
9118 start of the line TO_VPOS. */
9119 if ((op & (MOVE_TO_X | MOVE_TO_POS)) == 0)
9121 if (it->vpos == to_vpos)
9123 reached = 1;
9124 break;
9126 else
9127 skip = move_it_in_display_line_to (it, -1, -1, 0);
9129 else
9131 /* TO_VPOS >= 0 means stop at TO_X in the line at
9132 TO_VPOS, or at TO_POS, whichever comes first. */
9133 if (it->vpos == to_vpos)
9135 reached = 2;
9136 break;
9139 skip = move_it_in_display_line_to (it, to_charpos, to_x, op);
9141 if (skip == MOVE_POS_MATCH_OR_ZV || it->vpos == to_vpos)
9143 reached = 3;
9144 break;
9146 else if (skip == MOVE_X_REACHED && it->vpos != to_vpos)
9148 /* We have reached TO_X but not in the line we want. */
9149 skip = move_it_in_display_line_to (it, to_charpos,
9150 -1, MOVE_TO_POS);
9151 if (skip == MOVE_POS_MATCH_OR_ZV)
9153 reached = 4;
9154 break;
9159 else if (op & MOVE_TO_Y)
9161 struct it it_backup;
9163 if (it->line_wrap == WORD_WRAP)
9164 SAVE_IT (it_backup, *it, backup_data);
9166 /* TO_Y specified means stop at TO_X in the line containing
9167 TO_Y---or at TO_CHARPOS if this is reached first. The
9168 problem is that we can't really tell whether the line
9169 contains TO_Y before we have completely scanned it, and
9170 this may skip past TO_X. What we do is to first scan to
9171 TO_X.
9173 If TO_X is not specified, use a TO_X of zero. The reason
9174 is to make the outcome of this function more predictable.
9175 If we didn't use TO_X == 0, we would stop at the end of
9176 the line which is probably not what a caller would expect
9177 to happen. */
9178 skip = move_it_in_display_line_to
9179 (it, to_charpos, ((op & MOVE_TO_X) ? to_x : 0),
9180 (MOVE_TO_X | (op & MOVE_TO_POS)));
9182 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9183 if (skip == MOVE_POS_MATCH_OR_ZV)
9184 reached = 5;
9185 else if (skip == MOVE_X_REACHED)
9187 /* If TO_X was reached, we want to know whether TO_Y is
9188 in the line. We know this is the case if the already
9189 scanned glyphs make the line tall enough. Otherwise,
9190 we must check by scanning the rest of the line. */
9191 line_height = it->max_ascent + it->max_descent;
9192 if (to_y >= it->current_y
9193 && to_y < it->current_y + line_height)
9195 reached = 6;
9196 break;
9198 SAVE_IT (it_backup, *it, backup_data);
9199 TRACE_MOVE ((stderr, "move_it: from %d\n", IT_CHARPOS (*it)));
9200 skip2 = move_it_in_display_line_to (it, to_charpos, -1,
9201 op & MOVE_TO_POS);
9202 TRACE_MOVE ((stderr, "move_it: to %d\n", IT_CHARPOS (*it)));
9203 line_height = it->max_ascent + it->max_descent;
9204 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9206 if (to_y >= it->current_y
9207 && to_y < it->current_y + line_height)
9209 /* If TO_Y is in this line and TO_X was reached
9210 above, we scanned too far. We have to restore
9211 IT's settings to the ones before skipping. But
9212 keep the more accurate values of max_ascent and
9213 max_descent we've found while skipping the rest
9214 of the line, for the sake of callers, such as
9215 pos_visible_p, that need to know the line
9216 height. */
9217 int max_ascent = it->max_ascent;
9218 int max_descent = it->max_descent;
9220 RESTORE_IT (it, &it_backup, backup_data);
9221 it->max_ascent = max_ascent;
9222 it->max_descent = max_descent;
9223 reached = 6;
9225 else
9227 skip = skip2;
9228 if (skip == MOVE_POS_MATCH_OR_ZV)
9229 reached = 7;
9232 else
9234 /* Check whether TO_Y is in this line. */
9235 line_height = it->max_ascent + it->max_descent;
9236 TRACE_MOVE ((stderr, "move_it: line_height = %d\n", line_height));
9238 if (to_y >= it->current_y
9239 && to_y < it->current_y + line_height)
9241 if (to_y > it->current_y)
9242 max_current_x = max (it->current_x, max_current_x);
9244 /* When word-wrap is on, TO_X may lie past the end
9245 of a wrapped line. Then it->current is the
9246 character on the next line, so backtrack to the
9247 space before the wrap point. */
9248 if (skip == MOVE_LINE_CONTINUED
9249 && it->line_wrap == WORD_WRAP)
9251 int prev_x = max (it->current_x - 1, 0);
9252 RESTORE_IT (it, &it_backup, backup_data);
9253 skip = move_it_in_display_line_to
9254 (it, -1, prev_x, MOVE_TO_X);
9257 reached = 6;
9261 if (reached)
9263 max_current_x = max (it->current_x, max_current_x);
9264 break;
9267 else if (BUFFERP (it->object)
9268 && (it->method == GET_FROM_BUFFER
9269 || it->method == GET_FROM_STRETCH)
9270 && IT_CHARPOS (*it) >= to_charpos
9271 /* Under bidi iteration, a call to set_iterator_to_next
9272 can scan far beyond to_charpos if the initial
9273 portion of the next line needs to be reordered. In
9274 that case, give move_it_in_display_line_to another
9275 chance below. */
9276 && !(it->bidi_p
9277 && it->bidi_it.scan_dir == -1))
9278 skip = MOVE_POS_MATCH_OR_ZV;
9279 else
9280 skip = move_it_in_display_line_to (it, to_charpos, -1, MOVE_TO_POS);
9282 switch (skip)
9284 case MOVE_POS_MATCH_OR_ZV:
9285 max_current_x = max (it->current_x, max_current_x);
9286 reached = 8;
9287 goto out;
9289 case MOVE_NEWLINE_OR_CR:
9290 max_current_x = max (it->current_x, max_current_x);
9291 set_iterator_to_next (it, 1);
9292 it->continuation_lines_width = 0;
9293 break;
9295 case MOVE_LINE_TRUNCATED:
9296 max_current_x = it->last_visible_x;
9297 it->continuation_lines_width = 0;
9298 reseat_at_next_visible_line_start (it, 0);
9299 if ((op & MOVE_TO_POS) != 0
9300 && IT_CHARPOS (*it) > to_charpos)
9302 reached = 9;
9303 goto out;
9305 break;
9307 case MOVE_LINE_CONTINUED:
9308 max_current_x = it->last_visible_x;
9309 /* For continued lines ending in a tab, some of the glyphs
9310 associated with the tab are displayed on the current
9311 line. Since it->current_x does not include these glyphs,
9312 we use it->last_visible_x instead. */
9313 if (it->c == '\t')
9315 it->continuation_lines_width += it->last_visible_x;
9316 /* When moving by vpos, ensure that the iterator really
9317 advances to the next line (bug#847, bug#969). Fixme:
9318 do we need to do this in other circumstances? */
9319 if (it->current_x != it->last_visible_x
9320 && (op & MOVE_TO_VPOS)
9321 && !(op & (MOVE_TO_X | MOVE_TO_POS)))
9323 line_start_x = it->current_x + it->pixel_width
9324 - it->last_visible_x;
9325 if (FRAME_WINDOW_P (it->f))
9327 struct face *face = FACE_FROM_ID (it->f, it->face_id);
9328 struct font *face_font = face->font;
9330 /* When display_line produces a continued line
9331 that ends in a TAB, it skips a tab stop that
9332 is closer than the font's space character
9333 width (see x_produce_glyphs where it produces
9334 the stretch glyph which represents a TAB).
9335 We need to reproduce the same logic here. */
9336 eassert (face_font);
9337 if (face_font)
9339 if (line_start_x < face_font->space_width)
9340 line_start_x
9341 += it->tab_width * face_font->space_width;
9344 set_iterator_to_next (it, 0);
9347 else
9348 it->continuation_lines_width += it->current_x;
9349 break;
9351 default:
9352 emacs_abort ();
9355 /* Reset/increment for the next run. */
9356 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
9357 it->current_x = line_start_x;
9358 line_start_x = 0;
9359 it->hpos = 0;
9360 it->current_y += it->max_ascent + it->max_descent;
9361 ++it->vpos;
9362 last_height = it->max_ascent + it->max_descent;
9363 it->max_ascent = it->max_descent = 0;
9366 out:
9368 /* On text terminals, we may stop at the end of a line in the middle
9369 of a multi-character glyph. If the glyph itself is continued,
9370 i.e. it is actually displayed on the next line, don't treat this
9371 stopping point as valid; move to the next line instead (unless
9372 that brings us offscreen). */
9373 if (!FRAME_WINDOW_P (it->f)
9374 && op & MOVE_TO_POS
9375 && IT_CHARPOS (*it) == to_charpos
9376 && it->what == IT_CHARACTER
9377 && it->nglyphs > 1
9378 && it->line_wrap == WINDOW_WRAP
9379 && it->current_x == it->last_visible_x - 1
9380 && it->c != '\n'
9381 && it->c != '\t'
9382 && it->vpos < it->w->window_end_vpos)
9384 it->continuation_lines_width += it->current_x;
9385 it->current_x = it->hpos = it->max_ascent = it->max_descent = 0;
9386 it->current_y += it->max_ascent + it->max_descent;
9387 ++it->vpos;
9388 last_height = it->max_ascent + it->max_descent;
9391 if (backup_data)
9392 bidi_unshelve_cache (backup_data, 1);
9394 TRACE_MOVE ((stderr, "move_it_to: reached %d\n", reached));
9396 return max_current_x;
9400 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9402 If DY > 0, move IT backward at least that many pixels. DY = 0
9403 means move IT backward to the preceding line start or BEGV. This
9404 function may move over more than DY pixels if IT->current_y - DY
9405 ends up in the middle of a line; in this case IT->current_y will be
9406 set to the top of the line moved to. */
9408 void
9409 move_it_vertically_backward (struct it *it, int dy)
9411 int nlines, h;
9412 struct it it2, it3;
9413 void *it2data = NULL, *it3data = NULL;
9414 ptrdiff_t start_pos;
9415 int nchars_per_row
9416 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9417 ptrdiff_t pos_limit;
9419 move_further_back:
9420 eassert (dy >= 0);
9422 start_pos = IT_CHARPOS (*it);
9424 /* Estimate how many newlines we must move back. */
9425 nlines = max (1, dy / default_line_pixel_height (it->w));
9426 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9427 pos_limit = BEGV;
9428 else
9429 pos_limit = max (start_pos - nlines * nchars_per_row, BEGV);
9431 /* Set the iterator's position that many lines back. But don't go
9432 back more than NLINES full screen lines -- this wins a day with
9433 buffers which have very long lines. */
9434 while (nlines-- && IT_CHARPOS (*it) > pos_limit)
9435 back_to_previous_visible_line_start (it);
9437 /* Reseat the iterator here. When moving backward, we don't want
9438 reseat to skip forward over invisible text, set up the iterator
9439 to deliver from overlay strings at the new position etc. So,
9440 use reseat_1 here. */
9441 reseat_1 (it, it->current.pos, 1);
9443 /* We are now surely at a line start. */
9444 it->current_x = it->hpos = 0; /* FIXME: this is incorrect when bidi
9445 reordering is in effect. */
9446 it->continuation_lines_width = 0;
9448 /* Move forward and see what y-distance we moved. First move to the
9449 start of the next line so that we get its height. We need this
9450 height to be able to tell whether we reached the specified
9451 y-distance. */
9452 SAVE_IT (it2, *it, it2data);
9453 it2.max_ascent = it2.max_descent = 0;
9456 move_it_to (&it2, start_pos, -1, -1, it2.vpos + 1,
9457 MOVE_TO_POS | MOVE_TO_VPOS);
9459 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2)
9460 /* If we are in a display string which starts at START_POS,
9461 and that display string includes a newline, and we are
9462 right after that newline (i.e. at the beginning of a
9463 display line), exit the loop, because otherwise we will
9464 infloop, since move_it_to will see that it is already at
9465 START_POS and will not move. */
9466 || (it2.method == GET_FROM_STRING
9467 && IT_CHARPOS (it2) == start_pos
9468 && SREF (it2.string, IT_STRING_BYTEPOS (it2) - 1) == '\n')));
9469 eassert (IT_CHARPOS (*it) >= BEGV);
9470 SAVE_IT (it3, it2, it3data);
9472 move_it_to (&it2, start_pos, -1, -1, -1, MOVE_TO_POS);
9473 eassert (IT_CHARPOS (*it) >= BEGV);
9474 /* H is the actual vertical distance from the position in *IT
9475 and the starting position. */
9476 h = it2.current_y - it->current_y;
9477 /* NLINES is the distance in number of lines. */
9478 nlines = it2.vpos - it->vpos;
9480 /* Correct IT's y and vpos position
9481 so that they are relative to the starting point. */
9482 it->vpos -= nlines;
9483 it->current_y -= h;
9485 if (dy == 0)
9487 /* DY == 0 means move to the start of the screen line. The
9488 value of nlines is > 0 if continuation lines were involved,
9489 or if the original IT position was at start of a line. */
9490 RESTORE_IT (it, it, it2data);
9491 if (nlines > 0)
9492 move_it_by_lines (it, nlines);
9493 /* The above code moves us to some position NLINES down,
9494 usually to its first glyph (leftmost in an L2R line), but
9495 that's not necessarily the start of the line, under bidi
9496 reordering. We want to get to the character position
9497 that is immediately after the newline of the previous
9498 line. */
9499 if (it->bidi_p
9500 && !it->continuation_lines_width
9501 && !STRINGP (it->string)
9502 && IT_CHARPOS (*it) > BEGV
9503 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9505 ptrdiff_t cp = IT_CHARPOS (*it), bp = IT_BYTEPOS (*it);
9507 DEC_BOTH (cp, bp);
9508 cp = find_newline_no_quit (cp, bp, -1, NULL);
9509 move_it_to (it, cp, -1, -1, -1, MOVE_TO_POS);
9511 bidi_unshelve_cache (it3data, 1);
9513 else
9515 /* The y-position we try to reach, relative to *IT.
9516 Note that H has been subtracted in front of the if-statement. */
9517 int target_y = it->current_y + h - dy;
9518 int y0 = it3.current_y;
9519 int y1;
9520 int line_height;
9522 RESTORE_IT (&it3, &it3, it3data);
9523 y1 = line_bottom_y (&it3);
9524 line_height = y1 - y0;
9525 RESTORE_IT (it, it, it2data);
9526 /* If we did not reach target_y, try to move further backward if
9527 we can. If we moved too far backward, try to move forward. */
9528 if (target_y < it->current_y
9529 /* This is heuristic. In a window that's 3 lines high, with
9530 a line height of 13 pixels each, recentering with point
9531 on the bottom line will try to move -39/2 = 19 pixels
9532 backward. Try to avoid moving into the first line. */
9533 && (it->current_y - target_y
9534 > min (window_box_height (it->w), line_height * 2 / 3))
9535 && IT_CHARPOS (*it) > BEGV)
9537 TRACE_MOVE ((stderr, " not far enough -> move_vert %d\n",
9538 target_y - it->current_y));
9539 dy = it->current_y - target_y;
9540 goto move_further_back;
9542 else if (target_y >= it->current_y + line_height
9543 && IT_CHARPOS (*it) < ZV)
9545 /* Should move forward by at least one line, maybe more.
9547 Note: Calling move_it_by_lines can be expensive on
9548 terminal frames, where compute_motion is used (via
9549 vmotion) to do the job, when there are very long lines
9550 and truncate-lines is nil. That's the reason for
9551 treating terminal frames specially here. */
9553 if (!FRAME_WINDOW_P (it->f))
9554 move_it_vertically (it, target_y - (it->current_y + line_height));
9555 else
9559 move_it_by_lines (it, 1);
9561 while (target_y >= line_bottom_y (it) && IT_CHARPOS (*it) < ZV);
9568 /* Move IT by a specified amount of pixel lines DY. DY negative means
9569 move backwards. DY = 0 means move to start of screen line. At the
9570 end, IT will be on the start of a screen line. */
9572 void
9573 move_it_vertically (struct it *it, int dy)
9575 if (dy <= 0)
9576 move_it_vertically_backward (it, -dy);
9577 else
9579 TRACE_MOVE ((stderr, "move_it_v: from %d, %d\n", IT_CHARPOS (*it), dy));
9580 move_it_to (it, ZV, -1, it->current_y + dy, -1,
9581 MOVE_TO_POS | MOVE_TO_Y);
9582 TRACE_MOVE ((stderr, "move_it_v: to %d\n", IT_CHARPOS (*it)));
9584 /* If buffer ends in ZV without a newline, move to the start of
9585 the line to satisfy the post-condition. */
9586 if (IT_CHARPOS (*it) == ZV
9587 && ZV > BEGV
9588 && FETCH_BYTE (IT_BYTEPOS (*it) - 1) != '\n')
9589 move_it_by_lines (it, 0);
9594 /* Move iterator IT past the end of the text line it is in. */
9596 void
9597 move_it_past_eol (struct it *it)
9599 enum move_it_result rc;
9601 rc = move_it_in_display_line_to (it, Z, 0, MOVE_TO_POS);
9602 if (rc == MOVE_NEWLINE_OR_CR)
9603 set_iterator_to_next (it, 0);
9607 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9608 negative means move up. DVPOS == 0 means move to the start of the
9609 screen line.
9611 Optimization idea: If we would know that IT->f doesn't use
9612 a face with proportional font, we could be faster for
9613 truncate-lines nil. */
9615 void
9616 move_it_by_lines (struct it *it, ptrdiff_t dvpos)
9619 /* The commented-out optimization uses vmotion on terminals. This
9620 gives bad results, because elements like it->what, on which
9621 callers such as pos_visible_p rely, aren't updated. */
9622 /* struct position pos;
9623 if (!FRAME_WINDOW_P (it->f))
9625 struct text_pos textpos;
9627 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9628 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9629 reseat (it, textpos, 1);
9630 it->vpos += pos.vpos;
9631 it->current_y += pos.vpos;
9633 else */
9635 if (dvpos == 0)
9637 /* DVPOS == 0 means move to the start of the screen line. */
9638 move_it_vertically_backward (it, 0);
9639 /* Let next call to line_bottom_y calculate real line height. */
9640 last_height = 0;
9642 else if (dvpos > 0)
9644 move_it_to (it, -1, -1, -1, it->vpos + dvpos, MOVE_TO_VPOS);
9645 if (!IT_POS_VALID_AFTER_MOVE_P (it))
9647 /* Only move to the next buffer position if we ended up in a
9648 string from display property, not in an overlay string
9649 (before-string or after-string). That is because the
9650 latter don't conceal the underlying buffer position, so
9651 we can ask to move the iterator to the exact position we
9652 are interested in. Note that, even if we are already at
9653 IT_CHARPOS (*it), the call below is not a no-op, as it
9654 will detect that we are at the end of the string, pop the
9655 iterator, and compute it->current_x and it->hpos
9656 correctly. */
9657 move_it_to (it, IT_CHARPOS (*it) + it->string_from_display_prop_p,
9658 -1, -1, -1, MOVE_TO_POS);
9661 else
9663 struct it it2;
9664 void *it2data = NULL;
9665 ptrdiff_t start_charpos, i;
9666 int nchars_per_row
9667 = (it->last_visible_x - it->first_visible_x) / FRAME_COLUMN_WIDTH (it->f);
9668 bool hit_pos_limit = false;
9669 ptrdiff_t pos_limit;
9671 /* Start at the beginning of the screen line containing IT's
9672 position. This may actually move vertically backwards,
9673 in case of overlays, so adjust dvpos accordingly. */
9674 dvpos += it->vpos;
9675 move_it_vertically_backward (it, 0);
9676 dvpos -= it->vpos;
9678 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9679 screen lines, and reseat the iterator there. */
9680 start_charpos = IT_CHARPOS (*it);
9681 if (it->line_wrap == TRUNCATE || nchars_per_row == 0)
9682 pos_limit = BEGV;
9683 else
9684 pos_limit = max (start_charpos + dvpos * nchars_per_row, BEGV);
9686 for (i = -dvpos; i > 0 && IT_CHARPOS (*it) > pos_limit; --i)
9687 back_to_previous_visible_line_start (it);
9688 if (i > 0 && IT_CHARPOS (*it) <= pos_limit)
9689 hit_pos_limit = true;
9690 reseat (it, it->current.pos, 1);
9692 /* Move further back if we end up in a string or an image. */
9693 while (!IT_POS_VALID_AFTER_MOVE_P (it))
9695 /* First try to move to start of display line. */
9696 dvpos += it->vpos;
9697 move_it_vertically_backward (it, 0);
9698 dvpos -= it->vpos;
9699 if (IT_POS_VALID_AFTER_MOVE_P (it))
9700 break;
9701 /* If start of line is still in string or image,
9702 move further back. */
9703 back_to_previous_visible_line_start (it);
9704 reseat (it, it->current.pos, 1);
9705 dvpos--;
9708 it->current_x = it->hpos = 0;
9710 /* Above call may have moved too far if continuation lines
9711 are involved. Scan forward and see if it did. */
9712 SAVE_IT (it2, *it, it2data);
9713 it2.vpos = it2.current_y = 0;
9714 move_it_to (&it2, start_charpos, -1, -1, -1, MOVE_TO_POS);
9715 it->vpos -= it2.vpos;
9716 it->current_y -= it2.current_y;
9717 it->current_x = it->hpos = 0;
9719 /* If we moved too far back, move IT some lines forward. */
9720 if (it2.vpos > -dvpos)
9722 int delta = it2.vpos + dvpos;
9724 RESTORE_IT (&it2, &it2, it2data);
9725 SAVE_IT (it2, *it, it2data);
9726 move_it_to (it, -1, -1, -1, it->vpos + delta, MOVE_TO_VPOS);
9727 /* Move back again if we got too far ahead. */
9728 if (IT_CHARPOS (*it) >= start_charpos)
9729 RESTORE_IT (it, &it2, it2data);
9730 else
9731 bidi_unshelve_cache (it2data, 1);
9733 else if (hit_pos_limit && pos_limit > BEGV
9734 && dvpos < 0 && it2.vpos < -dvpos)
9736 /* If we hit the limit, but still didn't make it far enough
9737 back, that means there's a display string with a newline
9738 covering a large chunk of text, and that caused
9739 back_to_previous_visible_line_start try to go too far.
9740 Punish those who commit such atrocities by going back
9741 until we've reached DVPOS, after lifting the limit, which
9742 could make it slow for very long lines. "If it hurts,
9743 don't do that!" */
9744 dvpos += it2.vpos;
9745 RESTORE_IT (it, it, it2data);
9746 for (i = -dvpos; i > 0; --i)
9748 back_to_previous_visible_line_start (it);
9749 it->vpos--;
9751 reseat_1 (it, it->current.pos, 1);
9753 else
9754 RESTORE_IT (it, it, it2data);
9758 /* Return true if IT points into the middle of a display vector. */
9760 bool
9761 in_display_vector_p (struct it *it)
9763 return (it->method == GET_FROM_DISPLAY_VECTOR
9764 && it->current.dpvec_index > 0
9765 && it->dpvec + it->current.dpvec_index != it->dpend);
9768 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9769 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9770 WINDOW must be a live window and defaults to the selected one. The
9771 return value is a cons of the maximum pixel-width of any text line and
9772 the maximum pixel-height of all text lines.
9774 The optional argument FROM, if non-nil, specifies the first text
9775 position and defaults to the minimum accessible position of the buffer.
9776 If FROM is t, use the minimum accessible position that is not a newline
9777 character. TO, if non-nil, specifies the last text position and
9778 defaults to the maximum accessible position of the buffer. If TO is t,
9779 use the maximum accessible position that is not a newline character.
9781 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9782 width that can be returned. X-LIMIT nil or omitted, means to use the
9783 pixel-width of WINDOW's body; use this if you do not intend to change
9784 the width of WINDOW. Use the maximum width WINDOW may assume if you
9785 intend to change WINDOW's width. In any case, text whose x-coordinate
9786 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9787 can take some time, it's always a good idea to make this argument as
9788 small as possible; in particular, if the buffer contains long lines that
9789 shall be truncated anyway.
9791 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9792 height that can be returned. Text lines whose y-coordinate is beyond
9793 Y-LIMIT are ignored. Since calculating the text height of a large
9794 buffer can take some time, it makes sense to specify this argument if
9795 the size of the buffer is unknown.
9797 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9798 include the height of the mode- or header-line of WINDOW in the return
9799 value. If it is either the symbol `mode-line' or `header-line', include
9800 only the height of that line, if present, in the return value. If t,
9801 include the height of both, if present, in the return value. */)
9802 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit, Lisp_Object y_limit,
9803 Lisp_Object mode_and_header_line)
9805 struct window *w = decode_live_window (window);
9806 Lisp_Object buf;
9807 struct buffer *b;
9808 struct it it;
9809 struct buffer *old_buffer = NULL;
9810 ptrdiff_t start, end, pos;
9811 struct text_pos startp;
9812 void *itdata = NULL;
9813 int c, max_y = -1, x = 0, y = 0;
9815 buf = w->contents;
9816 CHECK_BUFFER (buf);
9817 b = XBUFFER (buf);
9819 if (b != current_buffer)
9821 old_buffer = current_buffer;
9822 set_buffer_internal (b);
9825 if (NILP (from))
9826 start = BEGV;
9827 else if (EQ (from, Qt))
9829 start = pos = BEGV;
9830 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9831 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9832 start = pos;
9833 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9834 start = pos;
9836 else
9838 CHECK_NUMBER_COERCE_MARKER (from);
9839 start = min (max (XINT (from), BEGV), ZV);
9842 if (NILP (to))
9843 end = ZV;
9844 else if (EQ (to, Qt))
9846 end = pos = ZV;
9847 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9848 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9849 end = pos;
9850 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9851 end = pos;
9853 else
9855 CHECK_NUMBER_COERCE_MARKER (to);
9856 end = max (start, min (XINT (to), ZV));
9859 if (!NILP (y_limit))
9861 CHECK_NUMBER (y_limit);
9862 max_y = min (XINT (y_limit), INT_MAX);
9865 itdata = bidi_shelve_cache ();
9866 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9867 start_display (&it, w, startp);
9869 if (NILP (x_limit))
9870 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9871 else
9873 CHECK_NUMBER (x_limit);
9874 it.last_visible_x = min (XINT (x_limit), INFINITY);
9875 /* Actually, we never want move_it_to stop at to_x. But to make
9876 sure that move_it_in_display_line_to always moves far enough,
9877 we set it to INT_MAX and specify MOVE_TO_X. */
9878 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9879 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9882 y = it.current_y + it.max_ascent + it.max_descent;
9884 if (!EQ (mode_and_header_line, Qheader_line)
9885 && !EQ (mode_and_header_line, Qt))
9886 /* Do not count the header-line which was counted automatically by
9887 start_display. */
9888 y = y - WINDOW_HEADER_LINE_HEIGHT (w);
9890 if (EQ (mode_and_header_line, Qmode_line)
9891 || EQ (mode_and_header_line, Qt))
9892 /* Do count the mode-line which is not included automatically by
9893 start_display. */
9894 y = y + WINDOW_MODE_LINE_HEIGHT (w);
9896 bidi_unshelve_cache (itdata, 0);
9898 if (old_buffer)
9899 set_buffer_internal (old_buffer);
9901 return Fcons (make_number (x), make_number (y));
9904 /***********************************************************************
9905 Messages
9906 ***********************************************************************/
9909 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9910 to *Messages*. */
9912 void
9913 add_to_log (const char *format, Lisp_Object arg1, Lisp_Object arg2)
9915 Lisp_Object args[3];
9916 Lisp_Object msg, fmt;
9917 char *buffer;
9918 ptrdiff_t len;
9919 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9920 USE_SAFE_ALLOCA;
9922 fmt = msg = Qnil;
9923 GCPRO4 (fmt, msg, arg1, arg2);
9925 args[0] = fmt = build_string (format);
9926 args[1] = arg1;
9927 args[2] = arg2;
9928 msg = Fformat (3, args);
9930 len = SBYTES (msg) + 1;
9931 buffer = SAFE_ALLOCA (len);
9932 memcpy (buffer, SDATA (msg), len);
9934 message_dolog (buffer, len - 1, 1, 0);
9935 SAFE_FREE ();
9937 UNGCPRO;
9941 /* Output a newline in the *Messages* buffer if "needs" one. */
9943 void
9944 message_log_maybe_newline (void)
9946 if (message_log_need_newline)
9947 message_dolog ("", 0, 1, 0);
9951 /* Add a string M of length NBYTES to the message log, optionally
9952 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9953 true, means interpret the contents of M as multibyte. This
9954 function calls low-level routines in order to bypass text property
9955 hooks, etc. which might not be safe to run.
9957 This may GC (insert may run before/after change hooks),
9958 so the buffer M must NOT point to a Lisp string. */
9960 void
9961 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
9963 const unsigned char *msg = (const unsigned char *) m;
9965 if (!NILP (Vmemory_full))
9966 return;
9968 if (!NILP (Vmessage_log_max))
9970 struct buffer *oldbuf;
9971 Lisp_Object oldpoint, oldbegv, oldzv;
9972 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9973 ptrdiff_t point_at_end = 0;
9974 ptrdiff_t zv_at_end = 0;
9975 Lisp_Object old_deactivate_mark;
9976 struct gcpro gcpro1;
9978 old_deactivate_mark = Vdeactivate_mark;
9979 oldbuf = current_buffer;
9981 /* Ensure the Messages buffer exists, and switch to it.
9982 If we created it, set the major-mode. */
9984 int newbuffer = 0;
9985 if (NILP (Fget_buffer (Vmessages_buffer_name))) newbuffer = 1;
9987 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9989 if (newbuffer
9990 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9991 call0 (intern ("messages-buffer-mode"));
9994 bset_undo_list (current_buffer, Qt);
9995 bset_cache_long_scans (current_buffer, Qnil);
9997 oldpoint = message_dolog_marker1;
9998 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
9999 oldbegv = message_dolog_marker2;
10000 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
10001 oldzv = message_dolog_marker3;
10002 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
10003 GCPRO1 (old_deactivate_mark);
10005 if (PT == Z)
10006 point_at_end = 1;
10007 if (ZV == Z)
10008 zv_at_end = 1;
10010 BEGV = BEG;
10011 BEGV_BYTE = BEG_BYTE;
10012 ZV = Z;
10013 ZV_BYTE = Z_BYTE;
10014 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10016 /* Insert the string--maybe converting multibyte to single byte
10017 or vice versa, so that all the text fits the buffer. */
10018 if (multibyte
10019 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
10021 ptrdiff_t i;
10022 int c, char_bytes;
10023 char work[1];
10025 /* Convert a multibyte string to single-byte
10026 for the *Message* buffer. */
10027 for (i = 0; i < nbytes; i += char_bytes)
10029 c = string_char_and_length (msg + i, &char_bytes);
10030 work[0] = (ASCII_CHAR_P (c)
10032 : multibyte_char_to_unibyte (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 USE_SAFE_ALLOCA;
10208 char *buffer = SAFE_ALLOCA (nbytes);
10209 memcpy (buffer, SDATA (m), nbytes);
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 Lisp
10315 String whose data pointer might be passed to us in M. So
10316 we use a local copy. */
10317 char *fmt = xstrdup (m);
10319 if (noninteractive_need_newline)
10320 putc ('\n', stderr);
10321 noninteractive_need_newline = 0;
10322 fprintf (stderr, fmt, SDATA (ENCODE_SYSTEM (string)));
10323 if (!cursor_in_echo_area)
10324 fprintf (stderr, "\n");
10325 fflush (stderr);
10326 xfree (fmt);
10329 else if (INTERACTIVE)
10331 /* The frame whose minibuffer we're going to display the message on.
10332 It may be larger than the selected frame, so we need
10333 to use its buffer, not the selected frame's buffer. */
10334 Lisp_Object mini_window;
10335 struct frame *f, *sf = SELECTED_FRAME ();
10337 /* Get the frame containing the minibuffer
10338 that the selected frame is using. */
10339 mini_window = FRAME_MINIBUF_WINDOW (sf);
10340 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10342 /* Error messages get reported properly by cmd_error, so this must be
10343 just an informative message; if the frame hasn't really been
10344 initialized yet, just toss it. */
10345 if (f->glyphs_initialized_p)
10347 Lisp_Object args[2], msg;
10348 struct gcpro gcpro1, gcpro2;
10350 args[0] = build_string (m);
10351 args[1] = msg = string;
10352 GCPRO2 (args[0], msg);
10353 gcpro1.nvars = 2;
10355 msg = Fformat (2, args);
10357 if (log)
10358 message3 (msg);
10359 else
10360 message3_nolog (msg);
10362 UNGCPRO;
10364 /* Print should start at the beginning of the message
10365 buffer next time. */
10366 message_buf_print = 0;
10372 /* Dump an informative message to the minibuf. If M is 0, clear out
10373 any existing message, and let the mini-buffer text show through. */
10375 static void
10376 vmessage (const char *m, va_list ap)
10378 if (noninteractive)
10380 if (m)
10382 if (noninteractive_need_newline)
10383 putc ('\n', stderr);
10384 noninteractive_need_newline = 0;
10385 vfprintf (stderr, m, ap);
10386 if (cursor_in_echo_area == 0)
10387 fprintf (stderr, "\n");
10388 fflush (stderr);
10391 else if (INTERACTIVE)
10393 /* The frame whose mini-buffer we're going to display the message
10394 on. It may be larger than the selected frame, so we need to
10395 use its buffer, not the selected frame's buffer. */
10396 Lisp_Object mini_window;
10397 struct frame *f, *sf = SELECTED_FRAME ();
10399 /* Get the frame containing the mini-buffer
10400 that the selected frame is using. */
10401 mini_window = FRAME_MINIBUF_WINDOW (sf);
10402 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10404 /* Error messages get reported properly by cmd_error, so this must be
10405 just an informative message; if the frame hasn't really been
10406 initialized yet, just toss it. */
10407 if (f->glyphs_initialized_p)
10409 if (m)
10411 ptrdiff_t len;
10412 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10413 char *message_buf = alloca (maxsize + 1);
10415 len = doprnt (message_buf, maxsize, m, 0, ap);
10417 message3 (make_string (message_buf, len));
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);
10585 bset_undo_list (current_buffer, Qt);
10586 bset_read_only (current_buffer, Qnil);
10587 specbind (Qinhibit_read_only, Qt);
10588 specbind (Qinhibit_modification_hooks, Qt);
10590 if (clear_buffer_p && Z > BEG)
10591 del_range (BEG, Z);
10593 eassert (BEGV >= BEG);
10594 eassert (ZV <= Z && ZV >= BEGV);
10596 rc = fn (a1, a2);
10598 eassert (BEGV >= BEG);
10599 eassert (ZV <= Z && ZV >= BEGV);
10601 unbind_to (count, Qnil);
10602 return rc;
10606 /* Save state that should be preserved around the call to the function
10607 FN called in with_echo_area_buffer. */
10609 static Lisp_Object
10610 with_echo_area_buffer_unwind_data (struct window *w)
10612 int i = 0;
10613 Lisp_Object vector, tmp;
10615 /* Reduce consing by keeping one vector in
10616 Vwith_echo_area_save_vector. */
10617 vector = Vwith_echo_area_save_vector;
10618 Vwith_echo_area_save_vector = Qnil;
10620 if (NILP (vector))
10621 vector = Fmake_vector (make_number (9), Qnil);
10623 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10624 ASET (vector, i, Vdeactivate_mark); ++i;
10625 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10627 if (w)
10629 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10630 ASET (vector, i, w->contents); ++i;
10631 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10632 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10633 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10634 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10636 else
10638 int end = i + 6;
10639 for (; i < end; ++i)
10640 ASET (vector, i, Qnil);
10643 eassert (i == ASIZE (vector));
10644 return vector;
10648 /* Restore global state from VECTOR which was created by
10649 with_echo_area_buffer_unwind_data. */
10651 static void
10652 unwind_with_echo_area_buffer (Lisp_Object vector)
10654 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10655 Vdeactivate_mark = AREF (vector, 1);
10656 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10658 if (WINDOWP (AREF (vector, 3)))
10660 struct window *w;
10661 Lisp_Object buffer;
10663 w = XWINDOW (AREF (vector, 3));
10664 buffer = AREF (vector, 4);
10666 wset_buffer (w, buffer);
10667 set_marker_both (w->pointm, buffer,
10668 XFASTINT (AREF (vector, 5)),
10669 XFASTINT (AREF (vector, 6)));
10670 set_marker_both (w->start, buffer,
10671 XFASTINT (AREF (vector, 7)),
10672 XFASTINT (AREF (vector, 8)));
10675 Vwith_echo_area_save_vector = vector;
10679 /* Set up the echo area for use by print functions. MULTIBYTE_P
10680 non-zero means we will print multibyte. */
10682 void
10683 setup_echo_area_for_printing (int multibyte_p)
10685 /* If we can't find an echo area any more, exit. */
10686 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10687 Fkill_emacs (Qnil);
10689 ensure_echo_area_buffers ();
10691 if (!message_buf_print)
10693 /* A message has been output since the last time we printed.
10694 Choose a fresh echo area buffer. */
10695 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10696 echo_area_buffer[0] = echo_buffer[1];
10697 else
10698 echo_area_buffer[0] = echo_buffer[0];
10700 /* Switch to that buffer and clear it. */
10701 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10702 bset_truncate_lines (current_buffer, Qnil);
10704 if (Z > BEG)
10706 ptrdiff_t count = SPECPDL_INDEX ();
10707 specbind (Qinhibit_read_only, Qt);
10708 /* Note that undo recording is always disabled. */
10709 del_range (BEG, Z);
10710 unbind_to (count, Qnil);
10712 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10714 /* Set up the buffer for the multibyteness we need. */
10715 if (multibyte_p
10716 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10717 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10719 /* Raise the frame containing the echo area. */
10720 if (minibuffer_auto_raise)
10722 struct frame *sf = SELECTED_FRAME ();
10723 Lisp_Object mini_window;
10724 mini_window = FRAME_MINIBUF_WINDOW (sf);
10725 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10728 message_log_maybe_newline ();
10729 message_buf_print = 1;
10731 else
10733 if (NILP (echo_area_buffer[0]))
10735 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10736 echo_area_buffer[0] = echo_buffer[1];
10737 else
10738 echo_area_buffer[0] = echo_buffer[0];
10741 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10743 /* Someone switched buffers between print requests. */
10744 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10745 bset_truncate_lines (current_buffer, Qnil);
10751 /* Display an echo area message in window W. Value is non-zero if W's
10752 height is changed. If display_last_displayed_message_p is
10753 non-zero, display the message that was last displayed, otherwise
10754 display the current message. */
10756 static int
10757 display_echo_area (struct window *w)
10759 int i, no_message_p, window_height_changed_p;
10761 /* Temporarily disable garbage collections while displaying the echo
10762 area. This is done because a GC can print a message itself.
10763 That message would modify the echo area buffer's contents while a
10764 redisplay of the buffer is going on, and seriously confuse
10765 redisplay. */
10766 ptrdiff_t count = inhibit_garbage_collection ();
10768 /* If there is no message, we must call display_echo_area_1
10769 nevertheless because it resizes the window. But we will have to
10770 reset the echo_area_buffer in question to nil at the end because
10771 with_echo_area_buffer will sets it to an empty buffer. */
10772 i = display_last_displayed_message_p ? 1 : 0;
10773 no_message_p = NILP (echo_area_buffer[i]);
10775 window_height_changed_p
10776 = with_echo_area_buffer (w, display_last_displayed_message_p,
10777 display_echo_area_1,
10778 (intptr_t) w, Qnil);
10780 if (no_message_p)
10781 echo_area_buffer[i] = Qnil;
10783 unbind_to (count, Qnil);
10784 return window_height_changed_p;
10788 /* Helper for display_echo_area. Display the current buffer which
10789 contains the current echo area message in window W, a mini-window,
10790 a pointer to which is passed in A1. A2..A4 are currently not used.
10791 Change the height of W so that all of the message is displayed.
10792 Value is non-zero if height of W was changed. */
10794 static int
10795 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10797 intptr_t i1 = a1;
10798 struct window *w = (struct window *) i1;
10799 Lisp_Object window;
10800 struct text_pos start;
10801 int window_height_changed_p = 0;
10803 /* Do this before displaying, so that we have a large enough glyph
10804 matrix for the display. If we can't get enough space for the
10805 whole text, display the last N lines. That works by setting w->start. */
10806 window_height_changed_p = resize_mini_window (w, 0);
10808 /* Use the starting position chosen by resize_mini_window. */
10809 SET_TEXT_POS_FROM_MARKER (start, w->start);
10811 /* Display. */
10812 clear_glyph_matrix (w->desired_matrix);
10813 XSETWINDOW (window, w);
10814 try_window (window, start, 0);
10816 return window_height_changed_p;
10820 /* Resize the echo area window to exactly the size needed for the
10821 currently displayed message, if there is one. If a mini-buffer
10822 is active, don't shrink it. */
10824 void
10825 resize_echo_area_exactly (void)
10827 if (BUFFERP (echo_area_buffer[0])
10828 && WINDOWP (echo_area_window))
10830 struct window *w = XWINDOW (echo_area_window);
10831 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10832 int resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10833 (intptr_t) w, resize_exactly);
10834 if (resized_p)
10836 windows_or_buffers_changed = 42;
10837 update_mode_lines = 30;
10838 redisplay_internal ();
10844 /* Callback function for with_echo_area_buffer, when used from
10845 resize_echo_area_exactly. A1 contains a pointer to the window to
10846 resize, EXACTLY non-nil means resize the mini-window exactly to the
10847 size of the text displayed. A3 and A4 are not used. Value is what
10848 resize_mini_window returns. */
10850 static int
10851 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10853 intptr_t i1 = a1;
10854 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10858 /* Resize mini-window W to fit the size of its contents. EXACT_P
10859 means size the window exactly to the size needed. Otherwise, it's
10860 only enlarged until W's buffer is empty.
10862 Set W->start to the right place to begin display. If the whole
10863 contents fit, start at the beginning. Otherwise, start so as
10864 to make the end of the contents appear. This is particularly
10865 important for y-or-n-p, but seems desirable generally.
10867 Value is non-zero if the window height has been changed. */
10870 resize_mini_window (struct window *w, int exact_p)
10872 struct frame *f = XFRAME (w->frame);
10873 int window_height_changed_p = 0;
10875 eassert (MINI_WINDOW_P (w));
10877 /* By default, start display at the beginning. */
10878 set_marker_both (w->start, w->contents,
10879 BUF_BEGV (XBUFFER (w->contents)),
10880 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10882 /* Don't resize windows while redisplaying a window; it would
10883 confuse redisplay functions when the size of the window they are
10884 displaying changes from under them. Such a resizing can happen,
10885 for instance, when which-func prints a long message while
10886 we are running fontification-functions. We're running these
10887 functions with safe_call which binds inhibit-redisplay to t. */
10888 if (!NILP (Vinhibit_redisplay))
10889 return 0;
10891 /* Nil means don't try to resize. */
10892 if (NILP (Vresize_mini_windows)
10893 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10894 return 0;
10896 if (!FRAME_MINIBUF_ONLY_P (f))
10898 struct it it;
10899 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
10900 + WINDOW_PIXEL_HEIGHT (w));
10901 int unit = FRAME_LINE_HEIGHT (f);
10902 int height, max_height;
10903 struct text_pos start;
10904 struct buffer *old_current_buffer = NULL;
10906 if (current_buffer != XBUFFER (w->contents))
10908 old_current_buffer = current_buffer;
10909 set_buffer_internal (XBUFFER (w->contents));
10912 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10914 /* Compute the max. number of lines specified by the user. */
10915 if (FLOATP (Vmax_mini_window_height))
10916 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
10917 else if (INTEGERP (Vmax_mini_window_height))
10918 max_height = XINT (Vmax_mini_window_height) * unit;
10919 else
10920 max_height = total_height / 4;
10922 /* Correct that max. height if it's bogus. */
10923 max_height = clip_to_bounds (unit, max_height, total_height);
10925 /* Find out the height of the text in the window. */
10926 if (it.line_wrap == TRUNCATE)
10927 height = unit;
10928 else
10930 last_height = 0;
10931 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10932 if (it.max_ascent == 0 && it.max_descent == 0)
10933 height = it.current_y + last_height;
10934 else
10935 height = it.current_y + it.max_ascent + it.max_descent;
10936 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10939 /* Compute a suitable window start. */
10940 if (height > max_height)
10942 height = (max_height / unit) * unit;
10943 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10944 move_it_vertically_backward (&it, height - unit);
10945 start = it.current.pos;
10947 else
10948 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10949 SET_MARKER_FROM_TEXT_POS (w->start, start);
10951 if (EQ (Vresize_mini_windows, Qgrow_only))
10953 /* Let it grow only, until we display an empty message, in which
10954 case the window shrinks again. */
10955 if (height > WINDOW_PIXEL_HEIGHT (w))
10957 int old_height = WINDOW_PIXEL_HEIGHT (w);
10959 FRAME_WINDOWS_FROZEN (f) = 1;
10960 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10961 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10963 else if (height < WINDOW_PIXEL_HEIGHT (w)
10964 && (exact_p || BEGV == ZV))
10966 int old_height = WINDOW_PIXEL_HEIGHT (w);
10968 FRAME_WINDOWS_FROZEN (f) = 0;
10969 shrink_mini_window (w, 1);
10970 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10973 else
10975 /* Always resize to exact size needed. */
10976 if (height > WINDOW_PIXEL_HEIGHT (w))
10978 int old_height = WINDOW_PIXEL_HEIGHT (w);
10980 FRAME_WINDOWS_FROZEN (f) = 1;
10981 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10982 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10984 else if (height < WINDOW_PIXEL_HEIGHT (w))
10986 int old_height = WINDOW_PIXEL_HEIGHT (w);
10988 FRAME_WINDOWS_FROZEN (f) = 0;
10989 shrink_mini_window (w, 1);
10991 if (height)
10993 FRAME_WINDOWS_FROZEN (f) = 1;
10994 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10997 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11001 if (old_current_buffer)
11002 set_buffer_internal (old_current_buffer);
11005 return window_height_changed_p;
11009 /* Value is the current message, a string, or nil if there is no
11010 current message. */
11012 Lisp_Object
11013 current_message (void)
11015 Lisp_Object msg;
11017 if (!BUFFERP (echo_area_buffer[0]))
11018 msg = Qnil;
11019 else
11021 with_echo_area_buffer (0, 0, current_message_1,
11022 (intptr_t) &msg, Qnil);
11023 if (NILP (msg))
11024 echo_area_buffer[0] = Qnil;
11027 return msg;
11031 static int
11032 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
11034 intptr_t i1 = a1;
11035 Lisp_Object *msg = (Lisp_Object *) i1;
11037 if (Z > BEG)
11038 *msg = make_buffer_string (BEG, Z, 1);
11039 else
11040 *msg = Qnil;
11041 return 0;
11045 /* Push the current message on Vmessage_stack for later restoration
11046 by restore_message. Value is non-zero if the current message isn't
11047 empty. This is a relatively infrequent operation, so it's not
11048 worth optimizing. */
11050 bool
11051 push_message (void)
11053 Lisp_Object msg = current_message ();
11054 Vmessage_stack = Fcons (msg, Vmessage_stack);
11055 return STRINGP (msg);
11059 /* Restore message display from the top of Vmessage_stack. */
11061 void
11062 restore_message (void)
11064 eassert (CONSP (Vmessage_stack));
11065 message3_nolog (XCAR (Vmessage_stack));
11069 /* Handler for unwind-protect calling pop_message. */
11071 void
11072 pop_message_unwind (void)
11074 /* Pop the top-most entry off Vmessage_stack. */
11075 eassert (CONSP (Vmessage_stack));
11076 Vmessage_stack = XCDR (Vmessage_stack);
11080 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11081 exits. If the stack is not empty, we have a missing pop_message
11082 somewhere. */
11084 void
11085 check_message_stack (void)
11087 if (!NILP (Vmessage_stack))
11088 emacs_abort ();
11092 /* Truncate to NCHARS what will be displayed in the echo area the next
11093 time we display it---but don't redisplay it now. */
11095 void
11096 truncate_echo_area (ptrdiff_t nchars)
11098 if (nchars == 0)
11099 echo_area_buffer[0] = Qnil;
11100 else if (!noninteractive
11101 && INTERACTIVE
11102 && !NILP (echo_area_buffer[0]))
11104 struct frame *sf = SELECTED_FRAME ();
11105 /* Error messages get reported properly by cmd_error, so this must be
11106 just an informative message; if the frame hasn't really been
11107 initialized yet, just toss it. */
11108 if (sf->glyphs_initialized_p)
11109 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
11114 /* Helper function for truncate_echo_area. Truncate the current
11115 message to at most NCHARS characters. */
11117 static int
11118 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11120 if (BEG + nchars < Z)
11121 del_range (BEG + nchars, Z);
11122 if (Z == BEG)
11123 echo_area_buffer[0] = Qnil;
11124 return 0;
11127 /* Set the current message to STRING. */
11129 static void
11130 set_message (Lisp_Object string)
11132 eassert (STRINGP (string));
11134 message_enable_multibyte = STRING_MULTIBYTE (string);
11136 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11137 message_buf_print = 0;
11138 help_echo_showing_p = 0;
11140 if (STRINGP (Vdebug_on_message)
11141 && STRINGP (string)
11142 && fast_string_match (Vdebug_on_message, string) >= 0)
11143 call_debugger (list2 (Qerror, string));
11147 /* Helper function for set_message. First argument is ignored and second
11148 argument has the same meaning as for set_message.
11149 This function is called with the echo area buffer being current. */
11151 static int
11152 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11154 eassert (STRINGP (string));
11156 /* Change multibyteness of the echo buffer appropriately. */
11157 if (message_enable_multibyte
11158 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11159 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11161 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11162 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11163 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11165 /* Insert new message at BEG. */
11166 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11168 /* This function takes care of single/multibyte conversion.
11169 We just have to ensure that the echo area buffer has the right
11170 setting of enable_multibyte_characters. */
11171 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 1);
11173 return 0;
11177 /* Clear messages. CURRENT_P non-zero means clear the current
11178 message. LAST_DISPLAYED_P non-zero means clear the message
11179 last displayed. */
11181 void
11182 clear_message (bool current_p, bool last_displayed_p)
11184 if (current_p)
11186 echo_area_buffer[0] = Qnil;
11187 message_cleared_p = true;
11190 if (last_displayed_p)
11191 echo_area_buffer[1] = Qnil;
11193 message_buf_print = 0;
11196 /* Clear garbaged frames.
11198 This function is used where the old redisplay called
11199 redraw_garbaged_frames which in turn called redraw_frame which in
11200 turn called clear_frame. The call to clear_frame was a source of
11201 flickering. I believe a clear_frame is not necessary. It should
11202 suffice in the new redisplay to invalidate all current matrices,
11203 and ensure a complete redisplay of all windows. */
11205 static void
11206 clear_garbaged_frames (void)
11208 if (frame_garbaged)
11210 Lisp_Object tail, frame;
11212 FOR_EACH_FRAME (tail, frame)
11214 struct frame *f = XFRAME (frame);
11216 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11218 if (f->resized_p)
11219 redraw_frame (f);
11220 else
11221 clear_current_matrices (f);
11222 fset_redisplay (f);
11223 f->garbaged = false;
11224 f->resized_p = false;
11228 frame_garbaged = false;
11233 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11234 is non-zero update selected_frame. Value is non-zero if the
11235 mini-windows height has been changed. */
11237 static int
11238 echo_area_display (int update_frame_p)
11240 Lisp_Object mini_window;
11241 struct window *w;
11242 struct frame *f;
11243 int window_height_changed_p = 0;
11244 struct frame *sf = SELECTED_FRAME ();
11246 mini_window = FRAME_MINIBUF_WINDOW (sf);
11247 w = XWINDOW (mini_window);
11248 f = XFRAME (WINDOW_FRAME (w));
11250 /* Don't display if frame is invisible or not yet initialized. */
11251 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11252 return 0;
11254 #ifdef HAVE_WINDOW_SYSTEM
11255 /* When Emacs starts, selected_frame may be the initial terminal
11256 frame. If we let this through, a message would be displayed on
11257 the terminal. */
11258 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11259 return 0;
11260 #endif /* HAVE_WINDOW_SYSTEM */
11262 /* Redraw garbaged frames. */
11263 clear_garbaged_frames ();
11265 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11267 echo_area_window = mini_window;
11268 window_height_changed_p = display_echo_area (w);
11269 w->must_be_updated_p = true;
11271 /* Update the display, unless called from redisplay_internal.
11272 Also don't update the screen during redisplay itself. The
11273 update will happen at the end of redisplay, and an update
11274 here could cause confusion. */
11275 if (update_frame_p && !redisplaying_p)
11277 int n = 0;
11279 /* If the display update has been interrupted by pending
11280 input, update mode lines in the frame. Due to the
11281 pending input, it might have been that redisplay hasn't
11282 been called, so that mode lines above the echo area are
11283 garbaged. This looks odd, so we prevent it here. */
11284 if (!display_completed)
11285 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11287 if (window_height_changed_p
11288 /* Don't do this if Emacs is shutting down. Redisplay
11289 needs to run hooks. */
11290 && !NILP (Vrun_hooks))
11292 /* Must update other windows. Likewise as in other
11293 cases, don't let this update be interrupted by
11294 pending input. */
11295 ptrdiff_t count = SPECPDL_INDEX ();
11296 specbind (Qredisplay_dont_pause, Qt);
11297 windows_or_buffers_changed = 44;
11298 redisplay_internal ();
11299 unbind_to (count, Qnil);
11301 else if (FRAME_WINDOW_P (f) && n == 0)
11303 /* Window configuration is the same as before.
11304 Can do with a display update of the echo area,
11305 unless we displayed some mode lines. */
11306 update_single_window (w, 1);
11307 flush_frame (f);
11309 else
11310 update_frame (f, 1, 1);
11312 /* If cursor is in the echo area, make sure that the next
11313 redisplay displays the minibuffer, so that the cursor will
11314 be replaced with what the minibuffer wants. */
11315 if (cursor_in_echo_area)
11316 wset_redisplay (XWINDOW (mini_window));
11319 else if (!EQ (mini_window, selected_window))
11320 wset_redisplay (XWINDOW (mini_window));
11322 /* Last displayed message is now the current message. */
11323 echo_area_buffer[1] = echo_area_buffer[0];
11324 /* Inform read_char that we're not echoing. */
11325 echo_message_buffer = Qnil;
11327 /* Prevent redisplay optimization in redisplay_internal by resetting
11328 this_line_start_pos. This is done because the mini-buffer now
11329 displays the message instead of its buffer text. */
11330 if (EQ (mini_window, selected_window))
11331 CHARPOS (this_line_start_pos) = 0;
11333 return window_height_changed_p;
11336 /* Nonzero if W's buffer was changed but not saved. */
11338 static int
11339 window_buffer_changed (struct window *w)
11341 struct buffer *b = XBUFFER (w->contents);
11343 eassert (BUFFER_LIVE_P (b));
11345 return (((BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star));
11348 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11350 static int
11351 mode_line_update_needed (struct window *w)
11353 return (w->column_number_displayed != -1
11354 && !(PT == w->last_point && !window_outdated (w))
11355 && (w->column_number_displayed != current_column ()));
11358 /* Nonzero if window start of W is frozen and may not be changed during
11359 redisplay. */
11361 static bool
11362 window_frozen_p (struct window *w)
11364 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11366 Lisp_Object window;
11368 XSETWINDOW (window, w);
11369 if (MINI_WINDOW_P (w))
11370 return 0;
11371 else if (EQ (window, selected_window))
11372 return 0;
11373 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11374 && EQ (window, Vminibuf_scroll_window))
11375 /* This special window can't be frozen too. */
11376 return 0;
11377 else
11378 return 1;
11380 return 0;
11383 /***********************************************************************
11384 Mode Lines and Frame Titles
11385 ***********************************************************************/
11387 /* A buffer for constructing non-propertized mode-line strings and
11388 frame titles in it; allocated from the heap in init_xdisp and
11389 resized as needed in store_mode_line_noprop_char. */
11391 static char *mode_line_noprop_buf;
11393 /* The buffer's end, and a current output position in it. */
11395 static char *mode_line_noprop_buf_end;
11396 static char *mode_line_noprop_ptr;
11398 #define MODE_LINE_NOPROP_LEN(start) \
11399 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11401 static enum {
11402 MODE_LINE_DISPLAY = 0,
11403 MODE_LINE_TITLE,
11404 MODE_LINE_NOPROP,
11405 MODE_LINE_STRING
11406 } mode_line_target;
11408 /* Alist that caches the results of :propertize.
11409 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11410 static Lisp_Object mode_line_proptrans_alist;
11412 /* List of strings making up the mode-line. */
11413 static Lisp_Object mode_line_string_list;
11415 /* Base face property when building propertized mode line string. */
11416 static Lisp_Object mode_line_string_face;
11417 static Lisp_Object mode_line_string_face_prop;
11420 /* Unwind data for mode line strings */
11422 static Lisp_Object Vmode_line_unwind_vector;
11424 static Lisp_Object
11425 format_mode_line_unwind_data (struct frame *target_frame,
11426 struct buffer *obuf,
11427 Lisp_Object owin,
11428 int save_proptrans)
11430 Lisp_Object vector, tmp;
11432 /* Reduce consing by keeping one vector in
11433 Vwith_echo_area_save_vector. */
11434 vector = Vmode_line_unwind_vector;
11435 Vmode_line_unwind_vector = Qnil;
11437 if (NILP (vector))
11438 vector = Fmake_vector (make_number (10), Qnil);
11440 ASET (vector, 0, make_number (mode_line_target));
11441 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11442 ASET (vector, 2, mode_line_string_list);
11443 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11444 ASET (vector, 4, mode_line_string_face);
11445 ASET (vector, 5, mode_line_string_face_prop);
11447 if (obuf)
11448 XSETBUFFER (tmp, obuf);
11449 else
11450 tmp = Qnil;
11451 ASET (vector, 6, tmp);
11452 ASET (vector, 7, owin);
11453 if (target_frame)
11455 /* Similarly to `with-selected-window', if the operation selects
11456 a window on another frame, we must restore that frame's
11457 selected window, and (for a tty) the top-frame. */
11458 ASET (vector, 8, target_frame->selected_window);
11459 if (FRAME_TERMCAP_P (target_frame))
11460 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11463 return vector;
11466 static void
11467 unwind_format_mode_line (Lisp_Object vector)
11469 Lisp_Object old_window = AREF (vector, 7);
11470 Lisp_Object target_frame_window = AREF (vector, 8);
11471 Lisp_Object old_top_frame = AREF (vector, 9);
11473 mode_line_target = XINT (AREF (vector, 0));
11474 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11475 mode_line_string_list = AREF (vector, 2);
11476 if (! EQ (AREF (vector, 3), Qt))
11477 mode_line_proptrans_alist = AREF (vector, 3);
11478 mode_line_string_face = AREF (vector, 4);
11479 mode_line_string_face_prop = AREF (vector, 5);
11481 /* Select window before buffer, since it may change the buffer. */
11482 if (!NILP (old_window))
11484 /* If the operation that we are unwinding had selected a window
11485 on a different frame, reset its frame-selected-window. For a
11486 text terminal, reset its top-frame if necessary. */
11487 if (!NILP (target_frame_window))
11489 Lisp_Object frame
11490 = WINDOW_FRAME (XWINDOW (target_frame_window));
11492 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11493 Fselect_window (target_frame_window, Qt);
11495 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11496 Fselect_frame (old_top_frame, Qt);
11499 Fselect_window (old_window, Qt);
11502 if (!NILP (AREF (vector, 6)))
11504 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11505 ASET (vector, 6, Qnil);
11508 Vmode_line_unwind_vector = vector;
11512 /* Store a single character C for the frame title in mode_line_noprop_buf.
11513 Re-allocate mode_line_noprop_buf if necessary. */
11515 static void
11516 store_mode_line_noprop_char (char c)
11518 /* If output position has reached the end of the allocated buffer,
11519 increase the buffer's size. */
11520 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11522 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11523 ptrdiff_t size = len;
11524 mode_line_noprop_buf =
11525 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11526 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11527 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11530 *mode_line_noprop_ptr++ = c;
11534 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11535 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11536 characters that yield more columns than PRECISION; PRECISION <= 0
11537 means copy the whole string. Pad with spaces until FIELD_WIDTH
11538 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11539 pad. Called from display_mode_element when it is used to build a
11540 frame title. */
11542 static int
11543 store_mode_line_noprop (const char *string, int field_width, int precision)
11545 const unsigned char *str = (const unsigned char *) string;
11546 int n = 0;
11547 ptrdiff_t dummy, nbytes;
11549 /* Copy at most PRECISION chars from STR. */
11550 nbytes = strlen (string);
11551 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11552 while (nbytes--)
11553 store_mode_line_noprop_char (*str++);
11555 /* Fill up with spaces until FIELD_WIDTH reached. */
11556 while (field_width > 0
11557 && n < field_width)
11559 store_mode_line_noprop_char (' ');
11560 ++n;
11563 return n;
11566 /***********************************************************************
11567 Frame Titles
11568 ***********************************************************************/
11570 #ifdef HAVE_WINDOW_SYSTEM
11572 /* Set the title of FRAME, if it has changed. The title format is
11573 Vicon_title_format if FRAME is iconified, otherwise it is
11574 frame_title_format. */
11576 static void
11577 x_consider_frame_title (Lisp_Object frame)
11579 struct frame *f = XFRAME (frame);
11581 if (FRAME_WINDOW_P (f)
11582 || FRAME_MINIBUF_ONLY_P (f)
11583 || f->explicit_name)
11585 /* Do we have more than one visible frame on this X display? */
11586 Lisp_Object tail, other_frame, fmt;
11587 ptrdiff_t title_start;
11588 char *title;
11589 ptrdiff_t len;
11590 struct it it;
11591 ptrdiff_t count = SPECPDL_INDEX ();
11593 FOR_EACH_FRAME (tail, other_frame)
11595 struct frame *tf = XFRAME (other_frame);
11597 if (tf != f
11598 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11599 && !FRAME_MINIBUF_ONLY_P (tf)
11600 && !EQ (other_frame, tip_frame)
11601 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11602 break;
11605 /* Set global variable indicating that multiple frames exist. */
11606 multiple_frames = CONSP (tail);
11608 /* Switch to the buffer of selected window of the frame. Set up
11609 mode_line_target so that display_mode_element will output into
11610 mode_line_noprop_buf; then display the title. */
11611 record_unwind_protect (unwind_format_mode_line,
11612 format_mode_line_unwind_data
11613 (f, current_buffer, selected_window, 0));
11615 Fselect_window (f->selected_window, Qt);
11616 set_buffer_internal_1
11617 (XBUFFER (XWINDOW (f->selected_window)->contents));
11618 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11620 mode_line_target = MODE_LINE_TITLE;
11621 title_start = MODE_LINE_NOPROP_LEN (0);
11622 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11623 NULL, DEFAULT_FACE_ID);
11624 display_mode_element (&it, 0, -1, -1, fmt, Qnil, 0);
11625 len = MODE_LINE_NOPROP_LEN (title_start);
11626 title = mode_line_noprop_buf + title_start;
11627 unbind_to (count, Qnil);
11629 /* Set the title only if it's changed. This avoids consing in
11630 the common case where it hasn't. (If it turns out that we've
11631 already wasted too much time by walking through the list with
11632 display_mode_element, then we might need to optimize at a
11633 higher level than this.) */
11634 if (! STRINGP (f->name)
11635 || SBYTES (f->name) != len
11636 || memcmp (title, SDATA (f->name), len) != 0)
11637 x_implicitly_set_name (f, make_string (title, len), Qnil);
11641 #endif /* not HAVE_WINDOW_SYSTEM */
11644 /***********************************************************************
11645 Menu Bars
11646 ***********************************************************************/
11648 /* Non-zero if we will not redisplay all visible windows. */
11649 #define REDISPLAY_SOME_P() \
11650 ((windows_or_buffers_changed == 0 \
11651 || windows_or_buffers_changed == REDISPLAY_SOME) \
11652 && (update_mode_lines == 0 \
11653 || update_mode_lines == REDISPLAY_SOME))
11655 /* Prepare for redisplay by updating menu-bar item lists when
11656 appropriate. This can call eval. */
11658 static void
11659 prepare_menu_bars (void)
11661 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11662 bool some_windows = REDISPLAY_SOME_P ();
11663 struct gcpro gcpro1, gcpro2;
11664 Lisp_Object tooltip_frame;
11666 #ifdef HAVE_WINDOW_SYSTEM
11667 tooltip_frame = tip_frame;
11668 #else
11669 tooltip_frame = Qnil;
11670 #endif
11672 if (FUNCTIONP (Vpre_redisplay_function))
11674 Lisp_Object windows = all_windows ? Qt : Qnil;
11675 if (all_windows && some_windows)
11677 Lisp_Object ws = window_list ();
11678 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11680 Lisp_Object this = XCAR (ws);
11681 struct window *w = XWINDOW (this);
11682 if (w->redisplay
11683 || XFRAME (w->frame)->redisplay
11684 || XBUFFER (w->contents)->text->redisplay)
11686 windows = Fcons (this, windows);
11690 safe__call1 (true, Vpre_redisplay_function, windows);
11693 /* Update all frame titles based on their buffer names, etc. We do
11694 this before the menu bars so that the buffer-menu will show the
11695 up-to-date frame titles. */
11696 #ifdef HAVE_WINDOW_SYSTEM
11697 if (all_windows)
11699 Lisp_Object tail, frame;
11701 FOR_EACH_FRAME (tail, frame)
11703 struct frame *f = XFRAME (frame);
11704 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11705 if (some_windows
11706 && !f->redisplay
11707 && !w->redisplay
11708 && !XBUFFER (w->contents)->text->redisplay)
11709 continue;
11711 if (!EQ (frame, tooltip_frame)
11712 && (FRAME_ICONIFIED_P (f)
11713 || FRAME_VISIBLE_P (f) == 1
11714 /* Exclude TTY frames that are obscured because they
11715 are not the top frame on their console. This is
11716 because x_consider_frame_title actually switches
11717 to the frame, which for TTY frames means it is
11718 marked as garbaged, and will be completely
11719 redrawn on the next redisplay cycle. This causes
11720 TTY frames to be completely redrawn, when there
11721 are more than one of them, even though nothing
11722 should be changed on display. */
11723 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11724 x_consider_frame_title (frame);
11727 #endif /* HAVE_WINDOW_SYSTEM */
11729 /* Update the menu bar item lists, if appropriate. This has to be
11730 done before any actual redisplay or generation of display lines. */
11732 if (all_windows)
11734 Lisp_Object tail, frame;
11735 ptrdiff_t count = SPECPDL_INDEX ();
11736 /* 1 means that update_menu_bar has run its hooks
11737 so any further calls to update_menu_bar shouldn't do so again. */
11738 int menu_bar_hooks_run = 0;
11740 record_unwind_save_match_data ();
11742 FOR_EACH_FRAME (tail, frame)
11744 struct frame *f = XFRAME (frame);
11745 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11747 /* Ignore tooltip frame. */
11748 if (EQ (frame, tooltip_frame))
11749 continue;
11751 if (some_windows
11752 && !f->redisplay
11753 && !w->redisplay
11754 && !XBUFFER (w->contents)->text->redisplay)
11755 continue;
11757 /* If a window on this frame changed size, report that to
11758 the user and clear the size-change flag. */
11759 if (FRAME_WINDOW_SIZES_CHANGED (f))
11761 Lisp_Object functions;
11763 /* Clear flag first in case we get an error below. */
11764 FRAME_WINDOW_SIZES_CHANGED (f) = 0;
11765 functions = Vwindow_size_change_functions;
11766 GCPRO2 (tail, functions);
11768 while (CONSP (functions))
11770 if (!EQ (XCAR (functions), Qt))
11771 call1 (XCAR (functions), frame);
11772 functions = XCDR (functions);
11774 UNGCPRO;
11777 GCPRO1 (tail);
11778 menu_bar_hooks_run = update_menu_bar (f, 0, menu_bar_hooks_run);
11779 #ifdef HAVE_WINDOW_SYSTEM
11780 update_tool_bar (f, 0);
11781 #endif
11782 UNGCPRO;
11785 unbind_to (count, Qnil);
11787 else
11789 struct frame *sf = SELECTED_FRAME ();
11790 update_menu_bar (sf, 1, 0);
11791 #ifdef HAVE_WINDOW_SYSTEM
11792 update_tool_bar (sf, 1);
11793 #endif
11798 /* Update the menu bar item list for frame F. This has to be done
11799 before we start to fill in any display lines, because it can call
11800 eval.
11802 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11804 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11805 already ran the menu bar hooks for this redisplay, so there
11806 is no need to run them again. The return value is the
11807 updated value of this flag, to pass to the next call. */
11809 static int
11810 update_menu_bar (struct frame *f, int save_match_data, int hooks_run)
11812 Lisp_Object window;
11813 register struct window *w;
11815 /* If called recursively during a menu update, do nothing. This can
11816 happen when, for instance, an activate-menubar-hook causes a
11817 redisplay. */
11818 if (inhibit_menubar_update)
11819 return hooks_run;
11821 window = FRAME_SELECTED_WINDOW (f);
11822 w = XWINDOW (window);
11824 if (FRAME_WINDOW_P (f)
11826 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11827 || defined (HAVE_NS) || defined (USE_GTK)
11828 FRAME_EXTERNAL_MENU_BAR (f)
11829 #else
11830 FRAME_MENU_BAR_LINES (f) > 0
11831 #endif
11832 : FRAME_MENU_BAR_LINES (f) > 0)
11834 /* If the user has switched buffers or windows, we need to
11835 recompute to reflect the new bindings. But we'll
11836 recompute when update_mode_lines is set too; that means
11837 that people can use force-mode-line-update to request
11838 that the menu bar be recomputed. The adverse effect on
11839 the rest of the redisplay algorithm is about the same as
11840 windows_or_buffers_changed anyway. */
11841 if (windows_or_buffers_changed
11842 /* This used to test w->update_mode_line, but we believe
11843 there is no need to recompute the menu in that case. */
11844 || update_mode_lines
11845 || window_buffer_changed (w))
11847 struct buffer *prev = current_buffer;
11848 ptrdiff_t count = SPECPDL_INDEX ();
11850 specbind (Qinhibit_menubar_update, Qt);
11852 set_buffer_internal_1 (XBUFFER (w->contents));
11853 if (save_match_data)
11854 record_unwind_save_match_data ();
11855 if (NILP (Voverriding_local_map_menu_flag))
11857 specbind (Qoverriding_terminal_local_map, Qnil);
11858 specbind (Qoverriding_local_map, Qnil);
11861 if (!hooks_run)
11863 /* Run the Lucid hook. */
11864 safe_run_hooks (Qactivate_menubar_hook);
11866 /* If it has changed current-menubar from previous value,
11867 really recompute the menu-bar from the value. */
11868 if (! NILP (Vlucid_menu_bar_dirty_flag))
11869 call0 (Qrecompute_lucid_menubar);
11871 safe_run_hooks (Qmenu_bar_update_hook);
11873 hooks_run = 1;
11876 XSETFRAME (Vmenu_updating_frame, f);
11877 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11879 /* Redisplay the menu bar in case we changed it. */
11880 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11881 || defined (HAVE_NS) || defined (USE_GTK)
11882 if (FRAME_WINDOW_P (f))
11884 #if defined (HAVE_NS)
11885 /* All frames on Mac OS share the same menubar. So only
11886 the selected frame should be allowed to set it. */
11887 if (f == SELECTED_FRAME ())
11888 #endif
11889 set_frame_menubar (f, 0, 0);
11891 else
11892 /* On a terminal screen, the menu bar is an ordinary screen
11893 line, and this makes it get updated. */
11894 w->update_mode_line = 1;
11895 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11896 /* In the non-toolkit version, the menu bar is an ordinary screen
11897 line, and this makes it get updated. */
11898 w->update_mode_line = 1;
11899 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11901 unbind_to (count, Qnil);
11902 set_buffer_internal_1 (prev);
11906 return hooks_run;
11909 /***********************************************************************
11910 Tool-bars
11911 ***********************************************************************/
11913 #ifdef HAVE_WINDOW_SYSTEM
11915 /* Tool-bar item index of the item on which a mouse button was pressed
11916 or -1. */
11918 int last_tool_bar_item;
11920 /* Select `frame' temporarily without running all the code in
11921 do_switch_frame.
11922 FIXME: Maybe do_switch_frame should be trimmed down similarly
11923 when `norecord' is set. */
11924 static void
11925 fast_set_selected_frame (Lisp_Object frame)
11927 if (!EQ (selected_frame, frame))
11929 selected_frame = frame;
11930 selected_window = XFRAME (frame)->selected_window;
11934 /* Update the tool-bar item list for frame F. This has to be done
11935 before we start to fill in any display lines. Called from
11936 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11937 and restore it here. */
11939 static void
11940 update_tool_bar (struct frame *f, int save_match_data)
11942 #if defined (USE_GTK) || defined (HAVE_NS)
11943 int do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11944 #else
11945 int do_update = (WINDOWP (f->tool_bar_window)
11946 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0);
11947 #endif
11949 if (do_update)
11951 Lisp_Object window;
11952 struct window *w;
11954 window = FRAME_SELECTED_WINDOW (f);
11955 w = XWINDOW (window);
11957 /* If the user has switched buffers or windows, we need to
11958 recompute to reflect the new bindings. But we'll
11959 recompute when update_mode_lines is set too; that means
11960 that people can use force-mode-line-update to request
11961 that the menu bar be recomputed. The adverse effect on
11962 the rest of the redisplay algorithm is about the same as
11963 windows_or_buffers_changed anyway. */
11964 if (windows_or_buffers_changed
11965 || w->update_mode_line
11966 || update_mode_lines
11967 || window_buffer_changed (w))
11969 struct buffer *prev = current_buffer;
11970 ptrdiff_t count = SPECPDL_INDEX ();
11971 Lisp_Object frame, new_tool_bar;
11972 int new_n_tool_bar;
11973 struct gcpro gcpro1;
11975 /* Set current_buffer to the buffer of the selected
11976 window of the frame, so that we get the right local
11977 keymaps. */
11978 set_buffer_internal_1 (XBUFFER (w->contents));
11980 /* Save match data, if we must. */
11981 if (save_match_data)
11982 record_unwind_save_match_data ();
11984 /* Make sure that we don't accidentally use bogus keymaps. */
11985 if (NILP (Voverriding_local_map_menu_flag))
11987 specbind (Qoverriding_terminal_local_map, Qnil);
11988 specbind (Qoverriding_local_map, Qnil);
11991 GCPRO1 (new_tool_bar);
11993 /* We must temporarily set the selected frame to this frame
11994 before calling tool_bar_items, because the calculation of
11995 the tool-bar keymap uses the selected frame (see
11996 `tool-bar-make-keymap' in tool-bar.el). */
11997 eassert (EQ (selected_window,
11998 /* Since we only explicitly preserve selected_frame,
11999 check that selected_window would be redundant. */
12000 XFRAME (selected_frame)->selected_window));
12001 record_unwind_protect (fast_set_selected_frame, selected_frame);
12002 XSETFRAME (frame, f);
12003 fast_set_selected_frame (frame);
12005 /* Build desired tool-bar items from keymaps. */
12006 new_tool_bar
12007 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
12008 &new_n_tool_bar);
12010 /* Redisplay the tool-bar if we changed it. */
12011 if (new_n_tool_bar != f->n_tool_bar_items
12012 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
12014 /* Redisplay that happens asynchronously due to an expose event
12015 may access f->tool_bar_items. Make sure we update both
12016 variables within BLOCK_INPUT so no such event interrupts. */
12017 block_input ();
12018 fset_tool_bar_items (f, new_tool_bar);
12019 f->n_tool_bar_items = new_n_tool_bar;
12020 w->update_mode_line = 1;
12021 unblock_input ();
12024 UNGCPRO;
12026 unbind_to (count, Qnil);
12027 set_buffer_internal_1 (prev);
12032 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12034 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12035 F's desired tool-bar contents. F->tool_bar_items must have
12036 been set up previously by calling prepare_menu_bars. */
12038 static void
12039 build_desired_tool_bar_string (struct frame *f)
12041 int i, size, size_needed;
12042 struct gcpro gcpro1, gcpro2, gcpro3;
12043 Lisp_Object image, plist, props;
12045 image = plist = props = Qnil;
12046 GCPRO3 (image, plist, props);
12048 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12049 Otherwise, make a new string. */
12051 /* The size of the string we might be able to reuse. */
12052 size = (STRINGP (f->desired_tool_bar_string)
12053 ? SCHARS (f->desired_tool_bar_string)
12054 : 0);
12056 /* We need one space in the string for each image. */
12057 size_needed = f->n_tool_bar_items;
12059 /* Reuse f->desired_tool_bar_string, if possible. */
12060 if (size < size_needed || NILP (f->desired_tool_bar_string))
12061 fset_desired_tool_bar_string
12062 (f, Fmake_string (make_number (size_needed), make_number (' ')));
12063 else
12065 props = list4 (Qdisplay, Qnil, Qmenu_item, Qnil);
12066 Fremove_text_properties (make_number (0), make_number (size),
12067 props, f->desired_tool_bar_string);
12070 /* Put a `display' property on the string for the images to display,
12071 put a `menu_item' property on tool-bar items with a value that
12072 is the index of the item in F's tool-bar item vector. */
12073 for (i = 0; i < f->n_tool_bar_items; ++i)
12075 #define PROP(IDX) \
12076 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12078 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
12079 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
12080 int hmargin, vmargin, relief, idx, end;
12082 /* If image is a vector, choose the image according to the
12083 button state. */
12084 image = PROP (TOOL_BAR_ITEM_IMAGES);
12085 if (VECTORP (image))
12087 if (enabled_p)
12088 idx = (selected_p
12089 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12090 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
12091 else
12092 idx = (selected_p
12093 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12094 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
12096 eassert (ASIZE (image) >= idx);
12097 image = AREF (image, idx);
12099 else
12100 idx = -1;
12102 /* Ignore invalid image specifications. */
12103 if (!valid_image_p (image))
12104 continue;
12106 /* Display the tool-bar button pressed, or depressed. */
12107 plist = Fcopy_sequence (XCDR (image));
12109 /* Compute margin and relief to draw. */
12110 relief = (tool_bar_button_relief >= 0
12111 ? tool_bar_button_relief
12112 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12113 hmargin = vmargin = relief;
12115 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12116 INT_MAX - max (hmargin, vmargin)))
12118 hmargin += XFASTINT (Vtool_bar_button_margin);
12119 vmargin += XFASTINT (Vtool_bar_button_margin);
12121 else if (CONSP (Vtool_bar_button_margin))
12123 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12124 INT_MAX - hmargin))
12125 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12127 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12128 INT_MAX - vmargin))
12129 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12132 if (auto_raise_tool_bar_buttons_p)
12134 /* Add a `:relief' property to the image spec if the item is
12135 selected. */
12136 if (selected_p)
12138 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12139 hmargin -= relief;
12140 vmargin -= relief;
12143 else
12145 /* If image is selected, display it pressed, i.e. with a
12146 negative relief. If it's not selected, display it with a
12147 raised relief. */
12148 plist = Fplist_put (plist, QCrelief,
12149 (selected_p
12150 ? make_number (-relief)
12151 : make_number (relief)));
12152 hmargin -= relief;
12153 vmargin -= relief;
12156 /* Put a margin around the image. */
12157 if (hmargin || vmargin)
12159 if (hmargin == vmargin)
12160 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12161 else
12162 plist = Fplist_put (plist, QCmargin,
12163 Fcons (make_number (hmargin),
12164 make_number (vmargin)));
12167 /* If button is not enabled, and we don't have special images
12168 for the disabled state, make the image appear disabled by
12169 applying an appropriate algorithm to it. */
12170 if (!enabled_p && idx < 0)
12171 plist = Fplist_put (plist, QCconversion, Qdisabled);
12173 /* Put a `display' text property on the string for the image to
12174 display. Put a `menu-item' property on the string that gives
12175 the start of this item's properties in the tool-bar items
12176 vector. */
12177 image = Fcons (Qimage, plist);
12178 props = list4 (Qdisplay, image,
12179 Qmenu_item, make_number (i * TOOL_BAR_ITEM_NSLOTS));
12181 /* Let the last image hide all remaining spaces in the tool bar
12182 string. The string can be longer than needed when we reuse a
12183 previous string. */
12184 if (i + 1 == f->n_tool_bar_items)
12185 end = SCHARS (f->desired_tool_bar_string);
12186 else
12187 end = i + 1;
12188 Fadd_text_properties (make_number (i), make_number (end),
12189 props, f->desired_tool_bar_string);
12190 #undef PROP
12193 UNGCPRO;
12197 /* Display one line of the tool-bar of frame IT->f.
12199 HEIGHT specifies the desired height of the tool-bar line.
12200 If the actual height of the glyph row is less than HEIGHT, the
12201 row's height is increased to HEIGHT, and the icons are centered
12202 vertically in the new height.
12204 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12205 count a final empty row in case the tool-bar width exactly matches
12206 the window width.
12209 static void
12210 display_tool_bar_line (struct it *it, int height)
12212 struct glyph_row *row = it->glyph_row;
12213 int max_x = it->last_visible_x;
12214 struct glyph *last;
12216 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12217 clear_glyph_row (row);
12218 row->enabled_p = true;
12219 row->y = it->current_y;
12221 /* Note that this isn't made use of if the face hasn't a box,
12222 so there's no need to check the face here. */
12223 it->start_of_box_run_p = 1;
12225 while (it->current_x < max_x)
12227 int x, n_glyphs_before, i, nglyphs;
12228 struct it it_before;
12230 /* Get the next display element. */
12231 if (!get_next_display_element (it))
12233 /* Don't count empty row if we are counting needed tool-bar lines. */
12234 if (height < 0 && !it->hpos)
12235 return;
12236 break;
12239 /* Produce glyphs. */
12240 n_glyphs_before = row->used[TEXT_AREA];
12241 it_before = *it;
12243 PRODUCE_GLYPHS (it);
12245 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12246 i = 0;
12247 x = it_before.current_x;
12248 while (i < nglyphs)
12250 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12252 if (x + glyph->pixel_width > max_x)
12254 /* Glyph doesn't fit on line. Backtrack. */
12255 row->used[TEXT_AREA] = n_glyphs_before;
12256 *it = it_before;
12257 /* If this is the only glyph on this line, it will never fit on the
12258 tool-bar, so skip it. But ensure there is at least one glyph,
12259 so we don't accidentally disable the tool-bar. */
12260 if (n_glyphs_before == 0
12261 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12262 break;
12263 goto out;
12266 ++it->hpos;
12267 x += glyph->pixel_width;
12268 ++i;
12271 /* Stop at line end. */
12272 if (ITERATOR_AT_END_OF_LINE_P (it))
12273 break;
12275 set_iterator_to_next (it, 1);
12278 out:;
12280 row->displays_text_p = row->used[TEXT_AREA] != 0;
12282 /* Use default face for the border below the tool bar.
12284 FIXME: When auto-resize-tool-bars is grow-only, there is
12285 no additional border below the possibly empty tool-bar lines.
12286 So to make the extra empty lines look "normal", we have to
12287 use the tool-bar face for the border too. */
12288 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12289 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12290 it->face_id = DEFAULT_FACE_ID;
12292 extend_face_to_end_of_line (it);
12293 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12294 last->right_box_line_p = 1;
12295 if (last == row->glyphs[TEXT_AREA])
12296 last->left_box_line_p = 1;
12298 /* Make line the desired height and center it vertically. */
12299 if ((height -= it->max_ascent + it->max_descent) > 0)
12301 /* Don't add more than one line height. */
12302 height %= FRAME_LINE_HEIGHT (it->f);
12303 it->max_ascent += height / 2;
12304 it->max_descent += (height + 1) / 2;
12307 compute_line_metrics (it);
12309 /* If line is empty, make it occupy the rest of the tool-bar. */
12310 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12312 row->height = row->phys_height = it->last_visible_y - row->y;
12313 row->visible_height = row->height;
12314 row->ascent = row->phys_ascent = 0;
12315 row->extra_line_spacing = 0;
12318 row->full_width_p = 1;
12319 row->continued_p = 0;
12320 row->truncated_on_left_p = 0;
12321 row->truncated_on_right_p = 0;
12323 it->current_x = it->hpos = 0;
12324 it->current_y += row->height;
12325 ++it->vpos;
12326 ++it->glyph_row;
12330 /* Max tool-bar height. Basically, this is what makes all other windows
12331 disappear when the frame gets too small. Rethink this! */
12333 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12334 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12336 /* Value is the number of pixels needed to make all tool-bar items of
12337 frame F visible. The actual number of glyph rows needed is
12338 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 it.first_visible_x = 0;
12354 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12355 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12356 it.paragraph_embedding = L2R;
12358 while (!ITERATOR_AT_END_P (&it))
12360 clear_glyph_row (temp_row);
12361 it.glyph_row = temp_row;
12362 display_tool_bar_line (&it, -1);
12364 clear_glyph_row (temp_row);
12366 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12367 if (n_rows)
12368 *n_rows = it.vpos > 0 ? it.vpos : -1;
12370 if (pixelwise)
12371 return it.current_y;
12372 else
12373 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12376 #endif /* !USE_GTK && !HAVE_NS */
12378 #if defined USE_GTK || defined HAVE_NS
12379 EXFUN (Ftool_bar_height, 2) ATTRIBUTE_CONST;
12380 EXFUN (Ftool_bar_lines_needed, 1) ATTRIBUTE_CONST;
12381 #endif
12383 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12384 0, 2, 0,
12385 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12386 If FRAME is nil or omitted, use the selected frame. Optional argument
12387 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12388 (Lisp_Object frame, Lisp_Object pixelwise)
12390 int height = 0;
12392 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12393 struct frame *f = decode_any_frame (frame);
12395 if (WINDOWP (f->tool_bar_window)
12396 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12398 update_tool_bar (f, 1);
12399 if (f->n_tool_bar_items)
12401 build_desired_tool_bar_string (f);
12402 height = tool_bar_height (f, NULL, NILP (pixelwise) ? 0 : 1);
12405 #endif
12407 return make_number (height);
12411 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12412 height should be changed. */
12414 static int
12415 redisplay_tool_bar (struct frame *f)
12417 #if defined (USE_GTK) || defined (HAVE_NS)
12419 if (FRAME_EXTERNAL_TOOL_BAR (f))
12420 update_frame_tool_bar (f);
12421 return 0;
12423 #else /* !USE_GTK && !HAVE_NS */
12425 struct window *w;
12426 struct it it;
12427 struct glyph_row *row;
12429 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12430 do anything. This means you must start with tool-bar-lines
12431 non-zero to get the auto-sizing effect. Or in other words, you
12432 can turn off tool-bars by specifying tool-bar-lines zero. */
12433 if (!WINDOWP (f->tool_bar_window)
12434 || (w = XWINDOW (f->tool_bar_window),
12435 WINDOW_PIXEL_HEIGHT (w) == 0))
12436 return 0;
12438 /* Set up an iterator for the tool-bar window. */
12439 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12440 it.first_visible_x = 0;
12441 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12442 row = it.glyph_row;
12444 /* Build a string that represents the contents of the tool-bar. */
12445 build_desired_tool_bar_string (f);
12446 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12447 /* FIXME: This should be controlled by a user option. But it
12448 doesn't make sense to have an R2L tool bar if the menu bar cannot
12449 be drawn also R2L, and making the menu bar R2L is tricky due
12450 toolkit-specific code that implements it. If an R2L tool bar is
12451 ever supported, display_tool_bar_line should also be augmented to
12452 call unproduce_glyphs like display_line and display_string
12453 do. */
12454 it.paragraph_embedding = L2R;
12456 if (f->n_tool_bar_rows == 0)
12458 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, 1);
12460 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12462 Lisp_Object frame;
12463 int new_lines = ((new_height + FRAME_LINE_HEIGHT (f) - 1)
12464 / FRAME_LINE_HEIGHT (f));
12466 XSETFRAME (frame, f);
12467 Fmodify_frame_parameters (frame,
12468 list1 (Fcons (Qtool_bar_lines,
12469 make_number (new_lines))));
12470 /* Always do that now. */
12471 clear_glyph_matrix (w->desired_matrix);
12472 f->fonts_changed = 1;
12473 return 1;
12477 /* Display as many lines as needed to display all tool-bar items. */
12479 if (f->n_tool_bar_rows > 0)
12481 int border, rows, height, extra;
12483 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12484 border = XINT (Vtool_bar_border);
12485 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12486 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12487 else if (EQ (Vtool_bar_border, Qborder_width))
12488 border = f->border_width;
12489 else
12490 border = 0;
12491 if (border < 0)
12492 border = 0;
12494 rows = f->n_tool_bar_rows;
12495 height = max (1, (it.last_visible_y - border) / rows);
12496 extra = it.last_visible_y - border - height * rows;
12498 while (it.current_y < it.last_visible_y)
12500 int h = 0;
12501 if (extra > 0 && rows-- > 0)
12503 h = (extra + rows - 1) / rows;
12504 extra -= h;
12506 display_tool_bar_line (&it, height + h);
12509 else
12511 while (it.current_y < it.last_visible_y)
12512 display_tool_bar_line (&it, 0);
12515 /* It doesn't make much sense to try scrolling in the tool-bar
12516 window, so don't do it. */
12517 w->desired_matrix->no_scrolling_p = 1;
12518 w->must_be_updated_p = 1;
12520 if (!NILP (Vauto_resize_tool_bars))
12522 /* Do we really allow the toolbar to occupy the whole frame? */
12523 int max_tool_bar_height = MAX_FRAME_TOOL_BAR_HEIGHT (f);
12524 int change_height_p = 0;
12526 /* If we couldn't display everything, change the tool-bar's
12527 height if there is room for more. */
12528 if (IT_STRING_CHARPOS (it) < it.end_charpos
12529 && it.current_y < max_tool_bar_height)
12530 change_height_p = 1;
12532 /* We subtract 1 because display_tool_bar_line advances the
12533 glyph_row pointer before returning to its caller. We want to
12534 examine the last glyph row produced by
12535 display_tool_bar_line. */
12536 row = it.glyph_row - 1;
12538 /* If there are blank lines at the end, except for a partially
12539 visible blank line at the end that is smaller than
12540 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12541 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12542 && row->height >= FRAME_LINE_HEIGHT (f))
12543 change_height_p = 1;
12545 /* If row displays tool-bar items, but is partially visible,
12546 change the tool-bar's height. */
12547 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12548 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y
12549 && MATRIX_ROW_BOTTOM_Y (row) < max_tool_bar_height)
12550 change_height_p = 1;
12552 /* Resize windows as needed by changing the `tool-bar-lines'
12553 frame parameter. */
12554 if (change_height_p)
12556 Lisp_Object frame;
12557 int nrows;
12558 int new_height = tool_bar_height (f, &nrows, 1);
12560 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12561 && !f->minimize_tool_bar_window_p)
12562 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12563 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12564 f->minimize_tool_bar_window_p = 0;
12566 if (change_height_p)
12568 /* Current size of the tool-bar window in canonical line
12569 units. */
12570 int old_lines = WINDOW_TOTAL_LINES (w);
12571 /* Required size of the tool-bar window in canonical
12572 line units. */
12573 int new_lines = ((new_height + FRAME_LINE_HEIGHT (f) - 1)
12574 / FRAME_LINE_HEIGHT (f));
12575 /* Maximum size of the tool-bar window in canonical line
12576 units that this frame can allow. */
12577 int max_lines =
12578 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f))) - 1;
12580 /* Don't try to change the tool-bar window size and set
12581 the fonts_changed flag unless really necessary. That
12582 flag causes redisplay to give up and retry
12583 redisplaying the frame from scratch, so setting it
12584 unnecessarily can lead to nasty redisplay loops. */
12585 if (new_lines <= max_lines
12586 && eabs (new_lines - old_lines) >= 1)
12588 XSETFRAME (frame, f);
12589 Fmodify_frame_parameters (frame,
12590 list1 (Fcons (Qtool_bar_lines,
12591 make_number (new_lines))));
12592 clear_glyph_matrix (w->desired_matrix);
12593 f->n_tool_bar_rows = nrows;
12594 f->fonts_changed = 1;
12595 return 1;
12601 f->minimize_tool_bar_window_p = 0;
12602 return 0;
12604 #endif /* USE_GTK || HAVE_NS */
12607 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12609 /* Get information about the tool-bar item which is displayed in GLYPH
12610 on frame F. Return in *PROP_IDX the index where tool-bar item
12611 properties start in F->tool_bar_items. Value is zero if
12612 GLYPH doesn't display a tool-bar item. */
12614 static int
12615 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12617 Lisp_Object prop;
12618 int success_p;
12619 int charpos;
12621 /* This function can be called asynchronously, which means we must
12622 exclude any possibility that Fget_text_property signals an
12623 error. */
12624 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12625 charpos = max (0, charpos);
12627 /* Get the text property `menu-item' at pos. The value of that
12628 property is the start index of this item's properties in
12629 F->tool_bar_items. */
12630 prop = Fget_text_property (make_number (charpos),
12631 Qmenu_item, f->current_tool_bar_string);
12632 if (INTEGERP (prop))
12634 *prop_idx = XINT (prop);
12635 success_p = 1;
12637 else
12638 success_p = 0;
12640 return success_p;
12644 /* Get information about the tool-bar item at position X/Y on frame F.
12645 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12646 the current matrix of the tool-bar window of F, or NULL if not
12647 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12648 item in F->tool_bar_items. Value is
12650 -1 if X/Y is not on a tool-bar item
12651 0 if X/Y is on the same item that was highlighted before.
12652 1 otherwise. */
12654 static int
12655 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12656 int *hpos, int *vpos, int *prop_idx)
12658 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12659 struct window *w = XWINDOW (f->tool_bar_window);
12660 int area;
12662 /* Find the glyph under X/Y. */
12663 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12664 if (*glyph == NULL)
12665 return -1;
12667 /* Get the start of this tool-bar item's properties in
12668 f->tool_bar_items. */
12669 if (!tool_bar_item_info (f, *glyph, prop_idx))
12670 return -1;
12672 /* Is mouse on the highlighted item? */
12673 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12674 && *vpos >= hlinfo->mouse_face_beg_row
12675 && *vpos <= hlinfo->mouse_face_end_row
12676 && (*vpos > hlinfo->mouse_face_beg_row
12677 || *hpos >= hlinfo->mouse_face_beg_col)
12678 && (*vpos < hlinfo->mouse_face_end_row
12679 || *hpos < hlinfo->mouse_face_end_col
12680 || hlinfo->mouse_face_past_end))
12681 return 0;
12683 return 1;
12687 /* EXPORT:
12688 Handle mouse button event on the tool-bar of frame F, at
12689 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12690 0 for button release. MODIFIERS is event modifiers for button
12691 release. */
12693 void
12694 handle_tool_bar_click (struct frame *f, int x, int y, int down_p,
12695 int modifiers)
12697 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12698 struct window *w = XWINDOW (f->tool_bar_window);
12699 int hpos, vpos, prop_idx;
12700 struct glyph *glyph;
12701 Lisp_Object enabled_p;
12702 int ts;
12704 /* If not on the highlighted tool-bar item, and mouse-highlight is
12705 non-nil, return. This is so we generate the tool-bar button
12706 click only when the mouse button is released on the same item as
12707 where it was pressed. However, when mouse-highlight is disabled,
12708 generate the click when the button is released regardless of the
12709 highlight, since tool-bar items are not highlighted in that
12710 case. */
12711 frame_to_window_pixel_xy (w, &x, &y);
12712 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12713 if (ts == -1
12714 || (ts != 0 && !NILP (Vmouse_highlight)))
12715 return;
12717 /* When mouse-highlight is off, generate the click for the item
12718 where the button was pressed, disregarding where it was
12719 released. */
12720 if (NILP (Vmouse_highlight) && !down_p)
12721 prop_idx = last_tool_bar_item;
12723 /* If item is disabled, do nothing. */
12724 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12725 if (NILP (enabled_p))
12726 return;
12728 if (down_p)
12730 /* Show item in pressed state. */
12731 if (!NILP (Vmouse_highlight))
12732 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12733 last_tool_bar_item = prop_idx;
12735 else
12737 Lisp_Object key, frame;
12738 struct input_event event;
12739 EVENT_INIT (event);
12741 /* Show item in released state. */
12742 if (!NILP (Vmouse_highlight))
12743 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12745 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12747 XSETFRAME (frame, f);
12748 event.kind = TOOL_BAR_EVENT;
12749 event.frame_or_window = frame;
12750 event.arg = frame;
12751 kbd_buffer_store_event (&event);
12753 event.kind = TOOL_BAR_EVENT;
12754 event.frame_or_window = frame;
12755 event.arg = key;
12756 event.modifiers = modifiers;
12757 kbd_buffer_store_event (&event);
12758 last_tool_bar_item = -1;
12763 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12764 tool-bar window-relative coordinates X/Y. Called from
12765 note_mouse_highlight. */
12767 static void
12768 note_tool_bar_highlight (struct frame *f, int x, int y)
12770 Lisp_Object window = f->tool_bar_window;
12771 struct window *w = XWINDOW (window);
12772 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12773 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12774 int hpos, vpos;
12775 struct glyph *glyph;
12776 struct glyph_row *row;
12777 int i;
12778 Lisp_Object enabled_p;
12779 int prop_idx;
12780 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12781 int mouse_down_p, rc;
12783 /* Function note_mouse_highlight is called with negative X/Y
12784 values when mouse moves outside of the frame. */
12785 if (x <= 0 || y <= 0)
12787 clear_mouse_face (hlinfo);
12788 return;
12791 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12792 if (rc < 0)
12794 /* Not on tool-bar item. */
12795 clear_mouse_face (hlinfo);
12796 return;
12798 else if (rc == 0)
12799 /* On same tool-bar item as before. */
12800 goto set_help_echo;
12802 clear_mouse_face (hlinfo);
12804 /* Mouse is down, but on different tool-bar item? */
12805 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12806 && f == dpyinfo->last_mouse_frame);
12808 if (mouse_down_p
12809 && last_tool_bar_item != prop_idx)
12810 return;
12812 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12814 /* If tool-bar item is not enabled, don't highlight it. */
12815 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12816 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12818 /* Compute the x-position of the glyph. In front and past the
12819 image is a space. We include this in the highlighted area. */
12820 row = MATRIX_ROW (w->current_matrix, vpos);
12821 for (i = x = 0; i < hpos; ++i)
12822 x += row->glyphs[TEXT_AREA][i].pixel_width;
12824 /* Record this as the current active region. */
12825 hlinfo->mouse_face_beg_col = hpos;
12826 hlinfo->mouse_face_beg_row = vpos;
12827 hlinfo->mouse_face_beg_x = x;
12828 hlinfo->mouse_face_past_end = 0;
12830 hlinfo->mouse_face_end_col = hpos + 1;
12831 hlinfo->mouse_face_end_row = vpos;
12832 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12833 hlinfo->mouse_face_window = window;
12834 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12836 /* Display it as active. */
12837 show_mouse_face (hlinfo, draw);
12840 set_help_echo:
12842 /* Set help_echo_string to a help string to display for this tool-bar item.
12843 XTread_socket does the rest. */
12844 help_echo_object = help_echo_window = Qnil;
12845 help_echo_pos = -1;
12846 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12847 if (NILP (help_echo_string))
12848 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12851 #endif /* !USE_GTK && !HAVE_NS */
12853 #endif /* HAVE_WINDOW_SYSTEM */
12857 /************************************************************************
12858 Horizontal scrolling
12859 ************************************************************************/
12861 static int hscroll_window_tree (Lisp_Object);
12862 static int hscroll_windows (Lisp_Object);
12864 /* For all leaf windows in the window tree rooted at WINDOW, set their
12865 hscroll value so that PT is (i) visible in the window, and (ii) so
12866 that it is not within a certain margin at the window's left and
12867 right border. Value is non-zero if any window's hscroll has been
12868 changed. */
12870 static int
12871 hscroll_window_tree (Lisp_Object window)
12873 int hscrolled_p = 0;
12874 int hscroll_relative_p = FLOATP (Vhscroll_step);
12875 int hscroll_step_abs = 0;
12876 double hscroll_step_rel = 0;
12878 if (hscroll_relative_p)
12880 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12881 if (hscroll_step_rel < 0)
12883 hscroll_relative_p = 0;
12884 hscroll_step_abs = 0;
12887 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12889 hscroll_step_abs = XINT (Vhscroll_step);
12890 if (hscroll_step_abs < 0)
12891 hscroll_step_abs = 0;
12893 else
12894 hscroll_step_abs = 0;
12896 while (WINDOWP (window))
12898 struct window *w = XWINDOW (window);
12900 if (WINDOWP (w->contents))
12901 hscrolled_p |= hscroll_window_tree (w->contents);
12902 else if (w->cursor.vpos >= 0)
12904 int h_margin;
12905 int text_area_width;
12906 struct glyph_row *cursor_row;
12907 struct glyph_row *bottom_row;
12908 int row_r2l_p;
12910 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12911 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12912 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12913 else
12914 cursor_row = bottom_row - 1;
12916 if (!cursor_row->enabled_p)
12918 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12919 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12920 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12921 else
12922 cursor_row = bottom_row - 1;
12924 row_r2l_p = cursor_row->reversed_p;
12926 text_area_width = window_box_width (w, TEXT_AREA);
12928 /* Scroll when cursor is inside this scroll margin. */
12929 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12931 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12932 /* In some pathological cases, like restoring a window
12933 configuration into a frame that is much smaller than
12934 the one from which the configuration was saved, we
12935 get glyph rows whose start and end have zero buffer
12936 positions, which we cannot handle below. Just skip
12937 such windows. */
12938 && CHARPOS (cursor_row->start.pos) >= BUF_BEG (w->contents)
12939 /* For left-to-right rows, hscroll when cursor is either
12940 (i) inside the right hscroll margin, or (ii) if it is
12941 inside the left margin and the window is already
12942 hscrolled. */
12943 && ((!row_r2l_p
12944 && ((w->hscroll
12945 && w->cursor.x <= h_margin)
12946 || (cursor_row->enabled_p
12947 && cursor_row->truncated_on_right_p
12948 && (w->cursor.x >= text_area_width - h_margin))))
12949 /* For right-to-left rows, the logic is similar,
12950 except that rules for scrolling to left and right
12951 are reversed. E.g., if cursor.x <= h_margin, we
12952 need to hscroll "to the right" unconditionally,
12953 and that will scroll the screen to the left so as
12954 to reveal the next portion of the row. */
12955 || (row_r2l_p
12956 && ((cursor_row->enabled_p
12957 /* FIXME: It is confusing to set the
12958 truncated_on_right_p flag when R2L rows
12959 are actually truncated on the left. */
12960 && cursor_row->truncated_on_right_p
12961 && w->cursor.x <= h_margin)
12962 || (w->hscroll
12963 && (w->cursor.x >= text_area_width - h_margin))))))
12965 struct it it;
12966 ptrdiff_t hscroll;
12967 struct buffer *saved_current_buffer;
12968 ptrdiff_t pt;
12969 int wanted_x;
12971 /* Find point in a display of infinite width. */
12972 saved_current_buffer = current_buffer;
12973 current_buffer = XBUFFER (w->contents);
12975 if (w == XWINDOW (selected_window))
12976 pt = PT;
12977 else
12978 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
12980 /* Move iterator to pt starting at cursor_row->start in
12981 a line with infinite width. */
12982 init_to_row_start (&it, w, cursor_row);
12983 it.last_visible_x = INFINITY;
12984 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12985 current_buffer = saved_current_buffer;
12987 /* Position cursor in window. */
12988 if (!hscroll_relative_p && hscroll_step_abs == 0)
12989 hscroll = max (0, (it.current_x
12990 - (ITERATOR_AT_END_OF_LINE_P (&it)
12991 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12992 : (text_area_width / 2))))
12993 / FRAME_COLUMN_WIDTH (it.f);
12994 else if ((!row_r2l_p
12995 && w->cursor.x >= text_area_width - h_margin)
12996 || (row_r2l_p && w->cursor.x <= h_margin))
12998 if (hscroll_relative_p)
12999 wanted_x = text_area_width * (1 - hscroll_step_rel)
13000 - h_margin;
13001 else
13002 wanted_x = text_area_width
13003 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
13004 - h_margin;
13005 hscroll
13006 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
13008 else
13010 if (hscroll_relative_p)
13011 wanted_x = text_area_width * hscroll_step_rel
13012 + h_margin;
13013 else
13014 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
13015 + h_margin;
13016 hscroll
13017 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
13019 hscroll = max (hscroll, w->min_hscroll);
13021 /* Don't prevent redisplay optimizations if hscroll
13022 hasn't changed, as it will unnecessarily slow down
13023 redisplay. */
13024 if (w->hscroll != hscroll)
13026 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
13027 w->hscroll = hscroll;
13028 hscrolled_p = 1;
13033 window = w->next;
13036 /* Value is non-zero if hscroll of any leaf window has been changed. */
13037 return hscrolled_p;
13041 /* Set hscroll so that cursor is visible and not inside horizontal
13042 scroll margins for all windows in the tree rooted at WINDOW. See
13043 also hscroll_window_tree above. Value is non-zero if any window's
13044 hscroll has been changed. If it has, desired matrices on the frame
13045 of WINDOW are cleared. */
13047 static int
13048 hscroll_windows (Lisp_Object window)
13050 int hscrolled_p = hscroll_window_tree (window);
13051 if (hscrolled_p)
13052 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
13053 return hscrolled_p;
13058 /************************************************************************
13059 Redisplay
13060 ************************************************************************/
13062 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13063 to a non-zero value. This is sometimes handy to have in a debugger
13064 session. */
13066 #ifdef GLYPH_DEBUG
13068 /* First and last unchanged row for try_window_id. */
13070 static int debug_first_unchanged_at_end_vpos;
13071 static int debug_last_unchanged_at_beg_vpos;
13073 /* Delta vpos and y. */
13075 static int debug_dvpos, debug_dy;
13077 /* Delta in characters and bytes for try_window_id. */
13079 static ptrdiff_t debug_delta, debug_delta_bytes;
13081 /* Values of window_end_pos and window_end_vpos at the end of
13082 try_window_id. */
13084 static ptrdiff_t debug_end_vpos;
13086 /* Append a string to W->desired_matrix->method. FMT is a printf
13087 format string. If trace_redisplay_p is true also printf the
13088 resulting string to stderr. */
13090 static void debug_method_add (struct window *, char const *, ...)
13091 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13093 static void
13094 debug_method_add (struct window *w, char const *fmt, ...)
13096 void *ptr = w;
13097 char *method = w->desired_matrix->method;
13098 int len = strlen (method);
13099 int size = sizeof w->desired_matrix->method;
13100 int remaining = size - len - 1;
13101 va_list ap;
13103 if (len && remaining)
13105 method[len] = '|';
13106 --remaining, ++len;
13109 va_start (ap, fmt);
13110 vsnprintf (method + len, remaining + 1, fmt, ap);
13111 va_end (ap);
13113 if (trace_redisplay_p)
13114 fprintf (stderr, "%p (%s): %s\n",
13115 ptr,
13116 ((BUFFERP (w->contents)
13117 && STRINGP (BVAR (XBUFFER (w->contents), name)))
13118 ? SSDATA (BVAR (XBUFFER (w->contents), name))
13119 : "no buffer"),
13120 method + len);
13123 #endif /* GLYPH_DEBUG */
13126 /* Value is non-zero if all changes in window W, which displays
13127 current_buffer, are in the text between START and END. START is a
13128 buffer position, END is given as a distance from Z. Used in
13129 redisplay_internal for display optimization. */
13131 static int
13132 text_outside_line_unchanged_p (struct window *w,
13133 ptrdiff_t start, ptrdiff_t end)
13135 int unchanged_p = 1;
13137 /* If text or overlays have changed, see where. */
13138 if (window_outdated (w))
13140 /* Gap in the line? */
13141 if (GPT < start || Z - GPT < end)
13142 unchanged_p = 0;
13144 /* Changes start in front of the line, or end after it? */
13145 if (unchanged_p
13146 && (BEG_UNCHANGED < start - 1
13147 || END_UNCHANGED < end))
13148 unchanged_p = 0;
13150 /* If selective display, can't optimize if changes start at the
13151 beginning of the line. */
13152 if (unchanged_p
13153 && INTEGERP (BVAR (current_buffer, selective_display))
13154 && XINT (BVAR (current_buffer, selective_display)) > 0
13155 && (BEG_UNCHANGED < start || GPT <= start))
13156 unchanged_p = 0;
13158 /* If there are overlays at the start or end of the line, these
13159 may have overlay strings with newlines in them. A change at
13160 START, for instance, may actually concern the display of such
13161 overlay strings as well, and they are displayed on different
13162 lines. So, quickly rule out this case. (For the future, it
13163 might be desirable to implement something more telling than
13164 just BEG/END_UNCHANGED.) */
13165 if (unchanged_p)
13167 if (BEG + BEG_UNCHANGED == start
13168 && overlay_touches_p (start))
13169 unchanged_p = 0;
13170 if (END_UNCHANGED == end
13171 && overlay_touches_p (Z - end))
13172 unchanged_p = 0;
13175 /* Under bidi reordering, adding or deleting a character in the
13176 beginning of a paragraph, before the first strong directional
13177 character, can change the base direction of the paragraph (unless
13178 the buffer specifies a fixed paragraph direction), which will
13179 require to redisplay the whole paragraph. It might be worthwhile
13180 to find the paragraph limits and widen the range of redisplayed
13181 lines to that, but for now just give up this optimization. */
13182 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13183 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13184 unchanged_p = 0;
13187 return unchanged_p;
13191 /* Do a frame update, taking possible shortcuts into account. This is
13192 the main external entry point for redisplay.
13194 If the last redisplay displayed an echo area message and that message
13195 is no longer requested, we clear the echo area or bring back the
13196 mini-buffer if that is in use. */
13198 void
13199 redisplay (void)
13201 redisplay_internal ();
13205 static Lisp_Object
13206 overlay_arrow_string_or_property (Lisp_Object var)
13208 Lisp_Object val;
13210 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13211 return val;
13213 return Voverlay_arrow_string;
13216 /* Return 1 if there are any overlay-arrows in current_buffer. */
13217 static int
13218 overlay_arrow_in_current_buffer_p (void)
13220 Lisp_Object vlist;
13222 for (vlist = Voverlay_arrow_variable_list;
13223 CONSP (vlist);
13224 vlist = XCDR (vlist))
13226 Lisp_Object var = XCAR (vlist);
13227 Lisp_Object val;
13229 if (!SYMBOLP (var))
13230 continue;
13231 val = find_symbol_value (var);
13232 if (MARKERP (val)
13233 && current_buffer == XMARKER (val)->buffer)
13234 return 1;
13236 return 0;
13240 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13241 has changed. */
13243 static int
13244 overlay_arrows_changed_p (void)
13246 Lisp_Object vlist;
13248 for (vlist = Voverlay_arrow_variable_list;
13249 CONSP (vlist);
13250 vlist = XCDR (vlist))
13252 Lisp_Object var = XCAR (vlist);
13253 Lisp_Object val, pstr;
13255 if (!SYMBOLP (var))
13256 continue;
13257 val = find_symbol_value (var);
13258 if (!MARKERP (val))
13259 continue;
13260 if (! EQ (COERCE_MARKER (val),
13261 Fget (var, Qlast_arrow_position))
13262 || ! (pstr = overlay_arrow_string_or_property (var),
13263 EQ (pstr, Fget (var, Qlast_arrow_string))))
13264 return 1;
13266 return 0;
13269 /* Mark overlay arrows to be updated on next redisplay. */
13271 static void
13272 update_overlay_arrows (int up_to_date)
13274 Lisp_Object vlist;
13276 for (vlist = Voverlay_arrow_variable_list;
13277 CONSP (vlist);
13278 vlist = XCDR (vlist))
13280 Lisp_Object var = XCAR (vlist);
13282 if (!SYMBOLP (var))
13283 continue;
13285 if (up_to_date > 0)
13287 Lisp_Object val = find_symbol_value (var);
13288 Fput (var, Qlast_arrow_position,
13289 COERCE_MARKER (val));
13290 Fput (var, Qlast_arrow_string,
13291 overlay_arrow_string_or_property (var));
13293 else if (up_to_date < 0
13294 || !NILP (Fget (var, Qlast_arrow_position)))
13296 Fput (var, Qlast_arrow_position, Qt);
13297 Fput (var, Qlast_arrow_string, Qt);
13303 /* Return overlay arrow string to display at row.
13304 Return integer (bitmap number) for arrow bitmap in left fringe.
13305 Return nil if no overlay arrow. */
13307 static Lisp_Object
13308 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13310 Lisp_Object vlist;
13312 for (vlist = Voverlay_arrow_variable_list;
13313 CONSP (vlist);
13314 vlist = XCDR (vlist))
13316 Lisp_Object var = XCAR (vlist);
13317 Lisp_Object val;
13319 if (!SYMBOLP (var))
13320 continue;
13322 val = find_symbol_value (var);
13324 if (MARKERP (val)
13325 && current_buffer == XMARKER (val)->buffer
13326 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13328 if (FRAME_WINDOW_P (it->f)
13329 /* FIXME: if ROW->reversed_p is set, this should test
13330 the right fringe, not the left one. */
13331 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13333 #ifdef HAVE_WINDOW_SYSTEM
13334 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13336 int fringe_bitmap;
13337 if ((fringe_bitmap = lookup_fringe_bitmap (val)) != 0)
13338 return make_number (fringe_bitmap);
13340 #endif
13341 return make_number (-1); /* Use default arrow bitmap. */
13343 return overlay_arrow_string_or_property (var);
13347 return Qnil;
13350 /* Return 1 if point moved out of or into a composition. Otherwise
13351 return 0. PREV_BUF and PREV_PT are the last point buffer and
13352 position. BUF and PT are the current point buffer and position. */
13354 static int
13355 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13356 struct buffer *buf, ptrdiff_t pt)
13358 ptrdiff_t start, end;
13359 Lisp_Object prop;
13360 Lisp_Object buffer;
13362 XSETBUFFER (buffer, buf);
13363 /* Check a composition at the last point if point moved within the
13364 same buffer. */
13365 if (prev_buf == buf)
13367 if (prev_pt == pt)
13368 /* Point didn't move. */
13369 return 0;
13371 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13372 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13373 && composition_valid_p (start, end, prop)
13374 && start < prev_pt && end > prev_pt)
13375 /* The last point was within the composition. Return 1 iff
13376 point moved out of the composition. */
13377 return (pt <= start || pt >= end);
13380 /* Check a composition at the current point. */
13381 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13382 && find_composition (pt, -1, &start, &end, &prop, buffer)
13383 && composition_valid_p (start, end, prop)
13384 && start < pt && end > pt);
13387 /* Reconsider the clip changes of buffer which is displayed in W. */
13389 static void
13390 reconsider_clip_changes (struct window *w)
13392 struct buffer *b = XBUFFER (w->contents);
13394 if (b->clip_changed
13395 && w->window_end_valid
13396 && w->current_matrix->buffer == b
13397 && w->current_matrix->zv == BUF_ZV (b)
13398 && w->current_matrix->begv == BUF_BEGV (b))
13399 b->clip_changed = 0;
13401 /* If display wasn't paused, and W is not a tool bar window, see if
13402 point has been moved into or out of a composition. In that case,
13403 we set b->clip_changed to 1 to force updating the screen. If
13404 b->clip_changed has already been set to 1, we can skip this
13405 check. */
13406 if (!b->clip_changed && w->window_end_valid)
13408 ptrdiff_t pt = (w == XWINDOW (selected_window)
13409 ? PT : marker_position (w->pointm));
13411 if ((w->current_matrix->buffer != b || pt != w->last_point)
13412 && check_point_in_composition (w->current_matrix->buffer,
13413 w->last_point, b, pt))
13414 b->clip_changed = 1;
13418 static void
13419 propagate_buffer_redisplay (void)
13420 { /* Resetting b->text->redisplay is problematic!
13421 We can't just reset it in the case that some window that displays
13422 it has not been redisplayed; and such a window can stay
13423 unredisplayed for a long time if it's currently invisible.
13424 But we do want to reset it at the end of redisplay otherwise
13425 its displayed windows will keep being redisplayed over and over
13426 again.
13427 So we copy all b->text->redisplay flags up to their windows here,
13428 such that mark_window_display_accurate can safely reset
13429 b->text->redisplay. */
13430 Lisp_Object ws = window_list ();
13431 for (; CONSP (ws); ws = XCDR (ws))
13433 struct window *thisw = XWINDOW (XCAR (ws));
13434 struct buffer *thisb = XBUFFER (thisw->contents);
13435 if (thisb->text->redisplay)
13436 thisw->redisplay = true;
13440 #define STOP_POLLING \
13441 do { if (! polling_stopped_here) stop_polling (); \
13442 polling_stopped_here = 1; } while (0)
13444 #define RESUME_POLLING \
13445 do { if (polling_stopped_here) start_polling (); \
13446 polling_stopped_here = 0; } while (0)
13449 /* Perhaps in the future avoid recentering windows if it
13450 is not necessary; currently that causes some problems. */
13452 static void
13453 redisplay_internal (void)
13455 struct window *w = XWINDOW (selected_window);
13456 struct window *sw;
13457 struct frame *fr;
13458 int pending;
13459 bool must_finish = 0, match_p;
13460 struct text_pos tlbufpos, tlendpos;
13461 int number_of_visible_frames;
13462 ptrdiff_t count;
13463 struct frame *sf;
13464 int polling_stopped_here = 0;
13465 Lisp_Object tail, frame;
13467 /* True means redisplay has to consider all windows on all
13468 frames. False, only selected_window is considered. */
13469 bool consider_all_windows_p;
13471 /* True means redisplay has to redisplay the miniwindow. */
13472 bool update_miniwindow_p = false;
13474 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13476 /* No redisplay if running in batch mode or frame is not yet fully
13477 initialized, or redisplay is explicitly turned off by setting
13478 Vinhibit_redisplay. */
13479 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13480 || !NILP (Vinhibit_redisplay))
13481 return;
13483 /* Don't examine these until after testing Vinhibit_redisplay.
13484 When Emacs is shutting down, perhaps because its connection to
13485 X has dropped, we should not look at them at all. */
13486 fr = XFRAME (w->frame);
13487 sf = SELECTED_FRAME ();
13489 if (!fr->glyphs_initialized_p)
13490 return;
13492 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13493 if (popup_activated ())
13494 return;
13495 #endif
13497 /* I don't think this happens but let's be paranoid. */
13498 if (redisplaying_p)
13499 return;
13501 /* Record a function that clears redisplaying_p
13502 when we leave this function. */
13503 count = SPECPDL_INDEX ();
13504 record_unwind_protect_void (unwind_redisplay);
13505 redisplaying_p = 1;
13506 specbind (Qinhibit_free_realized_faces, Qnil);
13508 /* Record this function, so it appears on the profiler's backtraces. */
13509 record_in_backtrace (Qredisplay_internal, &Qnil, 0);
13511 FOR_EACH_FRAME (tail, frame)
13512 XFRAME (frame)->already_hscrolled_p = 0;
13514 retry:
13515 /* Remember the currently selected window. */
13516 sw = w;
13518 pending = 0;
13519 last_escape_glyph_frame = NULL;
13520 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
13521 last_glyphless_glyph_frame = NULL;
13522 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
13524 /* If face_change_count is non-zero, init_iterator will free all
13525 realized faces, which includes the faces referenced from current
13526 matrices. So, we can't reuse current matrices in this case. */
13527 if (face_change_count)
13528 windows_or_buffers_changed = 47;
13530 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13531 && FRAME_TTY (sf)->previous_frame != sf)
13533 /* Since frames on a single ASCII terminal share the same
13534 display area, displaying a different frame means redisplay
13535 the whole thing. */
13536 SET_FRAME_GARBAGED (sf);
13537 #ifndef DOS_NT
13538 set_tty_color_mode (FRAME_TTY (sf), sf);
13539 #endif
13540 FRAME_TTY (sf)->previous_frame = sf;
13543 /* Set the visible flags for all frames. Do this before checking for
13544 resized or garbaged frames; they want to know if their frames are
13545 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13546 number_of_visible_frames = 0;
13548 FOR_EACH_FRAME (tail, frame)
13550 struct frame *f = XFRAME (frame);
13552 if (FRAME_VISIBLE_P (f))
13554 ++number_of_visible_frames;
13555 /* Adjust matrices for visible frames only. */
13556 if (f->fonts_changed)
13558 adjust_frame_glyphs (f);
13559 f->fonts_changed = 0;
13561 /* If cursor type has been changed on the frame
13562 other than selected, consider all frames. */
13563 if (f != sf && f->cursor_type_changed)
13564 update_mode_lines = 31;
13566 clear_desired_matrices (f);
13569 /* Notice any pending interrupt request to change frame size. */
13570 do_pending_window_change (1);
13572 /* do_pending_window_change could change the selected_window due to
13573 frame resizing which makes the selected window too small. */
13574 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13575 sw = w;
13577 /* Clear frames marked as garbaged. */
13578 clear_garbaged_frames ();
13580 /* Build menubar and tool-bar items. */
13581 if (NILP (Vmemory_full))
13582 prepare_menu_bars ();
13584 reconsider_clip_changes (w);
13586 /* In most cases selected window displays current buffer. */
13587 match_p = XBUFFER (w->contents) == current_buffer;
13588 if (match_p)
13590 /* Detect case that we need to write or remove a star in the mode line. */
13591 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13592 w->update_mode_line = 1;
13594 if (mode_line_update_needed (w))
13595 w->update_mode_line = 1;
13597 /* If reconsider_clip_changes above decided that the narrowing
13598 in the current buffer changed, make sure all other windows
13599 showing that buffer will be redisplayed. */
13600 if (current_buffer->clip_changed)
13601 bset_update_mode_line (current_buffer);
13604 /* Normally the message* functions will have already displayed and
13605 updated the echo area, but the frame may have been trashed, or
13606 the update may have been preempted, so display the echo area
13607 again here. Checking message_cleared_p captures the case that
13608 the echo area should be cleared. */
13609 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13610 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13611 || (message_cleared_p
13612 && minibuf_level == 0
13613 /* If the mini-window is currently selected, this means the
13614 echo-area doesn't show through. */
13615 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13617 int window_height_changed_p = echo_area_display (0);
13619 if (message_cleared_p)
13620 update_miniwindow_p = true;
13622 must_finish = 1;
13624 /* If we don't display the current message, don't clear the
13625 message_cleared_p flag, because, if we did, we wouldn't clear
13626 the echo area in the next redisplay which doesn't preserve
13627 the echo area. */
13628 if (!display_last_displayed_message_p)
13629 message_cleared_p = 0;
13631 if (window_height_changed_p)
13633 windows_or_buffers_changed = 50;
13635 /* If window configuration was changed, frames may have been
13636 marked garbaged. Clear them or we will experience
13637 surprises wrt scrolling. */
13638 clear_garbaged_frames ();
13641 else if (EQ (selected_window, minibuf_window)
13642 && (current_buffer->clip_changed || window_outdated (w))
13643 && resize_mini_window (w, 0))
13645 /* Resized active mini-window to fit the size of what it is
13646 showing if its contents might have changed. */
13647 must_finish = 1;
13649 /* If window configuration was changed, frames may have been
13650 marked garbaged. Clear them or we will experience
13651 surprises wrt scrolling. */
13652 clear_garbaged_frames ();
13655 if (windows_or_buffers_changed && !update_mode_lines)
13656 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13657 only the windows's contents needs to be refreshed, or whether the
13658 mode-lines also need a refresh. */
13659 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13660 ? REDISPLAY_SOME : 32);
13662 /* If specs for an arrow have changed, do thorough redisplay
13663 to ensure we remove any arrow that should no longer exist. */
13664 if (overlay_arrows_changed_p ())
13665 /* Apparently, this is the only case where we update other windows,
13666 without updating other mode-lines. */
13667 windows_or_buffers_changed = 49;
13669 consider_all_windows_p = (update_mode_lines
13670 || windows_or_buffers_changed);
13672 #define AINC(a,i) \
13673 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13674 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13676 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13677 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13679 /* Optimize the case that only the line containing the cursor in the
13680 selected window has changed. Variables starting with this_ are
13681 set in display_line and record information about the line
13682 containing the cursor. */
13683 tlbufpos = this_line_start_pos;
13684 tlendpos = this_line_end_pos;
13685 if (!consider_all_windows_p
13686 && CHARPOS (tlbufpos) > 0
13687 && !w->update_mode_line
13688 && !current_buffer->clip_changed
13689 && !current_buffer->prevent_redisplay_optimizations_p
13690 && FRAME_VISIBLE_P (XFRAME (w->frame))
13691 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13692 && !XFRAME (w->frame)->cursor_type_changed
13693 /* Make sure recorded data applies to current buffer, etc. */
13694 && this_line_buffer == current_buffer
13695 && match_p
13696 && !w->force_start
13697 && !w->optional_new_start
13698 /* Point must be on the line that we have info recorded about. */
13699 && PT >= CHARPOS (tlbufpos)
13700 && PT <= Z - CHARPOS (tlendpos)
13701 /* All text outside that line, including its final newline,
13702 must be unchanged. */
13703 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13704 CHARPOS (tlendpos)))
13706 if (CHARPOS (tlbufpos) > BEGV
13707 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13708 && (CHARPOS (tlbufpos) == ZV
13709 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13710 /* Former continuation line has disappeared by becoming empty. */
13711 goto cancel;
13712 else if (window_outdated (w) || MINI_WINDOW_P (w))
13714 /* We have to handle the case of continuation around a
13715 wide-column character (see the comment in indent.c around
13716 line 1340).
13718 For instance, in the following case:
13720 -------- Insert --------
13721 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13722 J_I_ ==> J_I_ `^^' are cursors.
13723 ^^ ^^
13724 -------- --------
13726 As we have to redraw the line above, we cannot use this
13727 optimization. */
13729 struct it it;
13730 int line_height_before = this_line_pixel_height;
13732 /* Note that start_display will handle the case that the
13733 line starting at tlbufpos is a continuation line. */
13734 start_display (&it, w, tlbufpos);
13736 /* Implementation note: It this still necessary? */
13737 if (it.current_x != this_line_start_x)
13738 goto cancel;
13740 TRACE ((stderr, "trying display optimization 1\n"));
13741 w->cursor.vpos = -1;
13742 overlay_arrow_seen = 0;
13743 it.vpos = this_line_vpos;
13744 it.current_y = this_line_y;
13745 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13746 display_line (&it);
13748 /* If line contains point, is not continued,
13749 and ends at same distance from eob as before, we win. */
13750 if (w->cursor.vpos >= 0
13751 /* Line is not continued, otherwise this_line_start_pos
13752 would have been set to 0 in display_line. */
13753 && CHARPOS (this_line_start_pos)
13754 /* Line ends as before. */
13755 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13756 /* Line has same height as before. Otherwise other lines
13757 would have to be shifted up or down. */
13758 && this_line_pixel_height == line_height_before)
13760 /* If this is not the window's last line, we must adjust
13761 the charstarts of the lines below. */
13762 if (it.current_y < it.last_visible_y)
13764 struct glyph_row *row
13765 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13766 ptrdiff_t delta, delta_bytes;
13768 /* We used to distinguish between two cases here,
13769 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13770 when the line ends in a newline or the end of the
13771 buffer's accessible portion. But both cases did
13772 the same, so they were collapsed. */
13773 delta = (Z
13774 - CHARPOS (tlendpos)
13775 - MATRIX_ROW_START_CHARPOS (row));
13776 delta_bytes = (Z_BYTE
13777 - BYTEPOS (tlendpos)
13778 - MATRIX_ROW_START_BYTEPOS (row));
13780 increment_matrix_positions (w->current_matrix,
13781 this_line_vpos + 1,
13782 w->current_matrix->nrows,
13783 delta, delta_bytes);
13786 /* If this row displays text now but previously didn't,
13787 or vice versa, w->window_end_vpos may have to be
13788 adjusted. */
13789 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13791 if (w->window_end_vpos < this_line_vpos)
13792 w->window_end_vpos = this_line_vpos;
13794 else if (w->window_end_vpos == this_line_vpos
13795 && this_line_vpos > 0)
13796 w->window_end_vpos = this_line_vpos - 1;
13797 w->window_end_valid = 0;
13799 /* Update hint: No need to try to scroll in update_window. */
13800 w->desired_matrix->no_scrolling_p = 1;
13802 #ifdef GLYPH_DEBUG
13803 *w->desired_matrix->method = 0;
13804 debug_method_add (w, "optimization 1");
13805 #endif
13806 #ifdef HAVE_WINDOW_SYSTEM
13807 update_window_fringes (w, 0);
13808 #endif
13809 goto update;
13811 else
13812 goto cancel;
13814 else if (/* Cursor position hasn't changed. */
13815 PT == w->last_point
13816 /* Make sure the cursor was last displayed
13817 in this window. Otherwise we have to reposition it. */
13819 /* PXW: Must be converted to pixels, probably. */
13820 && 0 <= w->cursor.vpos
13821 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13823 if (!must_finish)
13825 do_pending_window_change (1);
13826 /* If selected_window changed, redisplay again. */
13827 if (WINDOWP (selected_window)
13828 && (w = XWINDOW (selected_window)) != sw)
13829 goto retry;
13831 /* We used to always goto end_of_redisplay here, but this
13832 isn't enough if we have a blinking cursor. */
13833 if (w->cursor_off_p == w->last_cursor_off_p)
13834 goto end_of_redisplay;
13836 goto update;
13838 /* If highlighting the region, or if the cursor is in the echo area,
13839 then we can't just move the cursor. */
13840 else if (NILP (Vshow_trailing_whitespace)
13841 && !cursor_in_echo_area)
13843 struct it it;
13844 struct glyph_row *row;
13846 /* Skip from tlbufpos to PT and see where it is. Note that
13847 PT may be in invisible text. If so, we will end at the
13848 next visible position. */
13849 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13850 NULL, DEFAULT_FACE_ID);
13851 it.current_x = this_line_start_x;
13852 it.current_y = this_line_y;
13853 it.vpos = this_line_vpos;
13855 /* The call to move_it_to stops in front of PT, but
13856 moves over before-strings. */
13857 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13859 if (it.vpos == this_line_vpos
13860 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13861 row->enabled_p))
13863 eassert (this_line_vpos == it.vpos);
13864 eassert (this_line_y == it.current_y);
13865 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13866 #ifdef GLYPH_DEBUG
13867 *w->desired_matrix->method = 0;
13868 debug_method_add (w, "optimization 3");
13869 #endif
13870 goto update;
13872 else
13873 goto cancel;
13876 cancel:
13877 /* Text changed drastically or point moved off of line. */
13878 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13881 CHARPOS (this_line_start_pos) = 0;
13882 ++clear_face_cache_count;
13883 #ifdef HAVE_WINDOW_SYSTEM
13884 ++clear_image_cache_count;
13885 #endif
13887 /* Build desired matrices, and update the display. If
13888 consider_all_windows_p is non-zero, do it for all windows on all
13889 frames. Otherwise do it for selected_window, only. */
13891 if (consider_all_windows_p)
13893 FOR_EACH_FRAME (tail, frame)
13894 XFRAME (frame)->updated_p = 0;
13896 propagate_buffer_redisplay ();
13898 FOR_EACH_FRAME (tail, frame)
13900 struct frame *f = XFRAME (frame);
13902 /* We don't have to do anything for unselected terminal
13903 frames. */
13904 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13905 && !EQ (FRAME_TTY (f)->top_frame, frame))
13906 continue;
13908 retry_frame:
13910 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13912 bool gcscrollbars
13913 /* Only GC scrollbars when we redisplay the whole frame. */
13914 = f->redisplay || !REDISPLAY_SOME_P ();
13915 /* Mark all the scroll bars to be removed; we'll redeem
13916 the ones we want when we redisplay their windows. */
13917 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13918 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13920 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13921 redisplay_windows (FRAME_ROOT_WINDOW (f));
13922 /* Remember that the invisible frames need to be redisplayed next
13923 time they're visible. */
13924 else if (!REDISPLAY_SOME_P ())
13925 f->redisplay = true;
13927 /* The X error handler may have deleted that frame. */
13928 if (!FRAME_LIVE_P (f))
13929 continue;
13931 /* Any scroll bars which redisplay_windows should have
13932 nuked should now go away. */
13933 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13934 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13936 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13938 /* If fonts changed on visible frame, display again. */
13939 if (f->fonts_changed)
13941 adjust_frame_glyphs (f);
13942 f->fonts_changed = 0;
13943 goto retry_frame;
13946 /* See if we have to hscroll. */
13947 if (!f->already_hscrolled_p)
13949 f->already_hscrolled_p = 1;
13950 if (hscroll_windows (f->root_window))
13951 goto retry_frame;
13954 /* Prevent various kinds of signals during display
13955 update. stdio is not robust about handling
13956 signals, which can cause an apparent I/O error. */
13957 if (interrupt_input)
13958 unrequest_sigio ();
13959 STOP_POLLING;
13961 pending |= update_frame (f, 0, 0);
13962 f->cursor_type_changed = 0;
13963 f->updated_p = 1;
13968 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
13970 if (!pending)
13972 /* Do the mark_window_display_accurate after all windows have
13973 been redisplayed because this call resets flags in buffers
13974 which are needed for proper redisplay. */
13975 FOR_EACH_FRAME (tail, frame)
13977 struct frame *f = XFRAME (frame);
13978 if (f->updated_p)
13980 f->redisplay = false;
13981 mark_window_display_accurate (f->root_window, 1);
13982 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13983 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13988 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13990 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13991 struct frame *mini_frame;
13993 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
13994 /* Use list_of_error, not Qerror, so that
13995 we catch only errors and don't run the debugger. */
13996 internal_condition_case_1 (redisplay_window_1, selected_window,
13997 list_of_error,
13998 redisplay_window_error);
13999 if (update_miniwindow_p)
14000 internal_condition_case_1 (redisplay_window_1, mini_window,
14001 list_of_error,
14002 redisplay_window_error);
14004 /* Compare desired and current matrices, perform output. */
14006 update:
14007 /* If fonts changed, display again. */
14008 if (sf->fonts_changed)
14009 goto retry;
14011 /* Prevent various kinds of signals during display update.
14012 stdio is not robust about handling signals,
14013 which can cause an apparent I/O error. */
14014 if (interrupt_input)
14015 unrequest_sigio ();
14016 STOP_POLLING;
14018 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
14020 if (hscroll_windows (selected_window))
14021 goto retry;
14023 XWINDOW (selected_window)->must_be_updated_p = true;
14024 pending = update_frame (sf, 0, 0);
14025 sf->cursor_type_changed = 0;
14028 /* We may have called echo_area_display at the top of this
14029 function. If the echo area is on another frame, that may
14030 have put text on a frame other than the selected one, so the
14031 above call to update_frame would not have caught it. Catch
14032 it here. */
14033 mini_window = FRAME_MINIBUF_WINDOW (sf);
14034 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
14036 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
14038 XWINDOW (mini_window)->must_be_updated_p = true;
14039 pending |= update_frame (mini_frame, 0, 0);
14040 mini_frame->cursor_type_changed = 0;
14041 if (!pending && hscroll_windows (mini_window))
14042 goto retry;
14046 /* If display was paused because of pending input, make sure we do a
14047 thorough update the next time. */
14048 if (pending)
14050 /* Prevent the optimization at the beginning of
14051 redisplay_internal that tries a single-line update of the
14052 line containing the cursor in the selected window. */
14053 CHARPOS (this_line_start_pos) = 0;
14055 /* Let the overlay arrow be updated the next time. */
14056 update_overlay_arrows (0);
14058 /* If we pause after scrolling, some rows in the current
14059 matrices of some windows are not valid. */
14060 if (!WINDOW_FULL_WIDTH_P (w)
14061 && !FRAME_WINDOW_P (XFRAME (w->frame)))
14062 update_mode_lines = 36;
14064 else
14066 if (!consider_all_windows_p)
14068 /* This has already been done above if
14069 consider_all_windows_p is set. */
14070 if (XBUFFER (w->contents)->text->redisplay
14071 && buffer_window_count (XBUFFER (w->contents)) > 1)
14072 /* This can happen if b->text->redisplay was set during
14073 jit-lock. */
14074 propagate_buffer_redisplay ();
14075 mark_window_display_accurate_1 (w, 1);
14077 /* Say overlay arrows are up to date. */
14078 update_overlay_arrows (1);
14080 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
14081 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
14084 update_mode_lines = 0;
14085 windows_or_buffers_changed = 0;
14088 /* Start SIGIO interrupts coming again. Having them off during the
14089 code above makes it less likely one will discard output, but not
14090 impossible, since there might be stuff in the system buffer here.
14091 But it is much hairier to try to do anything about that. */
14092 if (interrupt_input)
14093 request_sigio ();
14094 RESUME_POLLING;
14096 /* If a frame has become visible which was not before, redisplay
14097 again, so that we display it. Expose events for such a frame
14098 (which it gets when becoming visible) don't call the parts of
14099 redisplay constructing glyphs, so simply exposing a frame won't
14100 display anything in this case. So, we have to display these
14101 frames here explicitly. */
14102 if (!pending)
14104 int new_count = 0;
14106 FOR_EACH_FRAME (tail, frame)
14108 if (XFRAME (frame)->visible)
14109 new_count++;
14112 if (new_count != number_of_visible_frames)
14113 windows_or_buffers_changed = 52;
14116 /* Change frame size now if a change is pending. */
14117 do_pending_window_change (1);
14119 /* If we just did a pending size change, or have additional
14120 visible frames, or selected_window changed, redisplay again. */
14121 if ((windows_or_buffers_changed && !pending)
14122 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
14123 goto retry;
14125 /* Clear the face and image caches.
14127 We used to do this only if consider_all_windows_p. But the cache
14128 needs to be cleared if a timer creates images in the current
14129 buffer (e.g. the test case in Bug#6230). */
14131 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14133 clear_face_cache (0);
14134 clear_face_cache_count = 0;
14137 #ifdef HAVE_WINDOW_SYSTEM
14138 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14140 clear_image_caches (Qnil);
14141 clear_image_cache_count = 0;
14143 #endif /* HAVE_WINDOW_SYSTEM */
14145 end_of_redisplay:
14146 #ifdef HAVE_NS
14147 ns_set_doc_edited ();
14148 #endif
14149 if (interrupt_input && interrupts_deferred)
14150 request_sigio ();
14152 unbind_to (count, Qnil);
14153 RESUME_POLLING;
14157 /* Redisplay, but leave alone any recent echo area message unless
14158 another message has been requested in its place.
14160 This is useful in situations where you need to redisplay but no
14161 user action has occurred, making it inappropriate for the message
14162 area to be cleared. See tracking_off and
14163 wait_reading_process_output for examples of these situations.
14165 FROM_WHERE is an integer saying from where this function was
14166 called. This is useful for debugging. */
14168 void
14169 redisplay_preserve_echo_area (int from_where)
14171 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14173 if (!NILP (echo_area_buffer[1]))
14175 /* We have a previously displayed message, but no current
14176 message. Redisplay the previous message. */
14177 display_last_displayed_message_p = 1;
14178 redisplay_internal ();
14179 display_last_displayed_message_p = 0;
14181 else
14182 redisplay_internal ();
14184 flush_frame (SELECTED_FRAME ());
14188 /* Function registered with record_unwind_protect in redisplay_internal. */
14190 static void
14191 unwind_redisplay (void)
14193 redisplaying_p = 0;
14197 /* Mark the display of leaf window W as accurate or inaccurate.
14198 If ACCURATE_P is non-zero mark display of W as accurate. If
14199 ACCURATE_P is zero, arrange for W to be redisplayed the next
14200 time redisplay_internal is called. */
14202 static void
14203 mark_window_display_accurate_1 (struct window *w, int accurate_p)
14205 struct buffer *b = XBUFFER (w->contents);
14207 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14208 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14209 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14211 if (accurate_p)
14213 b->clip_changed = false;
14214 b->prevent_redisplay_optimizations_p = false;
14215 eassert (buffer_window_count (b) > 0);
14216 /* Resetting b->text->redisplay is problematic!
14217 In order to make it safer to do it here, redisplay_internal must
14218 have copied all b->text->redisplay to their respective windows. */
14219 b->text->redisplay = false;
14221 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14222 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14223 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14224 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14226 w->current_matrix->buffer = b;
14227 w->current_matrix->begv = BUF_BEGV (b);
14228 w->current_matrix->zv = BUF_ZV (b);
14230 w->last_cursor_vpos = w->cursor.vpos;
14231 w->last_cursor_off_p = w->cursor_off_p;
14233 if (w == XWINDOW (selected_window))
14234 w->last_point = BUF_PT (b);
14235 else
14236 w->last_point = marker_position (w->pointm);
14238 w->window_end_valid = true;
14239 w->update_mode_line = false;
14242 w->redisplay = !accurate_p;
14246 /* Mark the display of windows in the window tree rooted at WINDOW as
14247 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14248 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14249 be redisplayed the next time redisplay_internal is called. */
14251 void
14252 mark_window_display_accurate (Lisp_Object window, int accurate_p)
14254 struct window *w;
14256 for (; !NILP (window); window = w->next)
14258 w = XWINDOW (window);
14259 if (WINDOWP (w->contents))
14260 mark_window_display_accurate (w->contents, accurate_p);
14261 else
14262 mark_window_display_accurate_1 (w, accurate_p);
14265 if (accurate_p)
14266 update_overlay_arrows (1);
14267 else
14268 /* Force a thorough redisplay the next time by setting
14269 last_arrow_position and last_arrow_string to t, which is
14270 unequal to any useful value of Voverlay_arrow_... */
14271 update_overlay_arrows (-1);
14275 /* Return value in display table DP (Lisp_Char_Table *) for character
14276 C. Since a display table doesn't have any parent, we don't have to
14277 follow parent. Do not call this function directly but use the
14278 macro DISP_CHAR_VECTOR. */
14280 Lisp_Object
14281 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14283 Lisp_Object val;
14285 if (ASCII_CHAR_P (c))
14287 val = dp->ascii;
14288 if (SUB_CHAR_TABLE_P (val))
14289 val = XSUB_CHAR_TABLE (val)->contents[c];
14291 else
14293 Lisp_Object table;
14295 XSETCHAR_TABLE (table, dp);
14296 val = char_table_ref (table, c);
14298 if (NILP (val))
14299 val = dp->defalt;
14300 return val;
14305 /***********************************************************************
14306 Window Redisplay
14307 ***********************************************************************/
14309 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14311 static void
14312 redisplay_windows (Lisp_Object window)
14314 while (!NILP (window))
14316 struct window *w = XWINDOW (window);
14318 if (WINDOWP (w->contents))
14319 redisplay_windows (w->contents);
14320 else if (BUFFERP (w->contents))
14322 displayed_buffer = XBUFFER (w->contents);
14323 /* Use list_of_error, not Qerror, so that
14324 we catch only errors and don't run the debugger. */
14325 internal_condition_case_1 (redisplay_window_0, window,
14326 list_of_error,
14327 redisplay_window_error);
14330 window = w->next;
14334 static Lisp_Object
14335 redisplay_window_error (Lisp_Object ignore)
14337 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14338 return Qnil;
14341 static Lisp_Object
14342 redisplay_window_0 (Lisp_Object window)
14344 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14345 redisplay_window (window, false);
14346 return Qnil;
14349 static Lisp_Object
14350 redisplay_window_1 (Lisp_Object window)
14352 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14353 redisplay_window (window, true);
14354 return Qnil;
14358 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14359 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14360 which positions recorded in ROW differ from current buffer
14361 positions.
14363 Return 0 if cursor is not on this row, 1 otherwise. */
14365 static int
14366 set_cursor_from_row (struct window *w, struct glyph_row *row,
14367 struct glyph_matrix *matrix,
14368 ptrdiff_t delta, ptrdiff_t delta_bytes,
14369 int dy, int dvpos)
14371 struct glyph *glyph = row->glyphs[TEXT_AREA];
14372 struct glyph *end = glyph + row->used[TEXT_AREA];
14373 struct glyph *cursor = NULL;
14374 /* The last known character position in row. */
14375 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14376 int x = row->x;
14377 ptrdiff_t pt_old = PT - delta;
14378 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14379 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14380 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14381 /* A glyph beyond the edge of TEXT_AREA which we should never
14382 touch. */
14383 struct glyph *glyphs_end = end;
14384 /* Non-zero means we've found a match for cursor position, but that
14385 glyph has the avoid_cursor_p flag set. */
14386 int match_with_avoid_cursor = 0;
14387 /* Non-zero means we've seen at least one glyph that came from a
14388 display string. */
14389 int string_seen = 0;
14390 /* Largest and smallest buffer positions seen so far during scan of
14391 glyph row. */
14392 ptrdiff_t bpos_max = pos_before;
14393 ptrdiff_t bpos_min = pos_after;
14394 /* Last buffer position covered by an overlay string with an integer
14395 `cursor' property. */
14396 ptrdiff_t bpos_covered = 0;
14397 /* Non-zero means the display string on which to display the cursor
14398 comes from a text property, not from an overlay. */
14399 int string_from_text_prop = 0;
14401 /* Don't even try doing anything if called for a mode-line or
14402 header-line row, since the rest of the code isn't prepared to
14403 deal with such calamities. */
14404 eassert (!row->mode_line_p);
14405 if (row->mode_line_p)
14406 return 0;
14408 /* Skip over glyphs not having an object at the start and the end of
14409 the row. These are special glyphs like truncation marks on
14410 terminal frames. */
14411 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14413 if (!row->reversed_p)
14415 while (glyph < end
14416 && INTEGERP (glyph->object)
14417 && glyph->charpos < 0)
14419 x += glyph->pixel_width;
14420 ++glyph;
14422 while (end > glyph
14423 && INTEGERP ((end - 1)->object)
14424 /* CHARPOS is zero for blanks and stretch glyphs
14425 inserted by extend_face_to_end_of_line. */
14426 && (end - 1)->charpos <= 0)
14427 --end;
14428 glyph_before = glyph - 1;
14429 glyph_after = end;
14431 else
14433 struct glyph *g;
14435 /* If the glyph row is reversed, we need to process it from back
14436 to front, so swap the edge pointers. */
14437 glyphs_end = end = glyph - 1;
14438 glyph += row->used[TEXT_AREA] - 1;
14440 while (glyph > end + 1
14441 && INTEGERP (glyph->object)
14442 && glyph->charpos < 0)
14444 --glyph;
14445 x -= glyph->pixel_width;
14447 if (INTEGERP (glyph->object) && glyph->charpos < 0)
14448 --glyph;
14449 /* By default, in reversed rows we put the cursor on the
14450 rightmost (first in the reading order) glyph. */
14451 for (g = end + 1; g < glyph; g++)
14452 x += g->pixel_width;
14453 while (end < glyph
14454 && INTEGERP ((end + 1)->object)
14455 && (end + 1)->charpos <= 0)
14456 ++end;
14457 glyph_before = glyph + 1;
14458 glyph_after = end;
14461 else if (row->reversed_p)
14463 /* In R2L rows that don't display text, put the cursor on the
14464 rightmost glyph. Case in point: an empty last line that is
14465 part of an R2L paragraph. */
14466 cursor = end - 1;
14467 /* Avoid placing the cursor on the last glyph of the row, where
14468 on terminal frames we hold the vertical border between
14469 adjacent windows. */
14470 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14471 && !WINDOW_RIGHTMOST_P (w)
14472 && cursor == row->glyphs[LAST_AREA] - 1)
14473 cursor--;
14474 x = -1; /* will be computed below, at label compute_x */
14477 /* Step 1: Try to find the glyph whose character position
14478 corresponds to point. If that's not possible, find 2 glyphs
14479 whose character positions are the closest to point, one before
14480 point, the other after it. */
14481 if (!row->reversed_p)
14482 while (/* not marched to end of glyph row */
14483 glyph < end
14484 /* glyph was not inserted by redisplay for internal purposes */
14485 && !INTEGERP (glyph->object))
14487 if (BUFFERP (glyph->object))
14489 ptrdiff_t dpos = glyph->charpos - pt_old;
14491 if (glyph->charpos > bpos_max)
14492 bpos_max = glyph->charpos;
14493 if (glyph->charpos < bpos_min)
14494 bpos_min = glyph->charpos;
14495 if (!glyph->avoid_cursor_p)
14497 /* If we hit point, we've found the glyph on which to
14498 display the cursor. */
14499 if (dpos == 0)
14501 match_with_avoid_cursor = 0;
14502 break;
14504 /* See if we've found a better approximation to
14505 POS_BEFORE or to POS_AFTER. */
14506 if (0 > dpos && dpos > pos_before - pt_old)
14508 pos_before = glyph->charpos;
14509 glyph_before = glyph;
14511 else if (0 < dpos && dpos < pos_after - pt_old)
14513 pos_after = glyph->charpos;
14514 glyph_after = glyph;
14517 else if (dpos == 0)
14518 match_with_avoid_cursor = 1;
14520 else if (STRINGP (glyph->object))
14522 Lisp_Object chprop;
14523 ptrdiff_t glyph_pos = glyph->charpos;
14525 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14526 glyph->object);
14527 if (!NILP (chprop))
14529 /* If the string came from a `display' text property,
14530 look up the buffer position of that property and
14531 use that position to update bpos_max, as if we
14532 actually saw such a position in one of the row's
14533 glyphs. This helps with supporting integer values
14534 of `cursor' property on the display string in
14535 situations where most or all of the row's buffer
14536 text is completely covered by display properties,
14537 so that no glyph with valid buffer positions is
14538 ever seen in the row. */
14539 ptrdiff_t prop_pos =
14540 string_buffer_position_lim (glyph->object, pos_before,
14541 pos_after, 0);
14543 if (prop_pos >= pos_before)
14544 bpos_max = prop_pos;
14546 if (INTEGERP (chprop))
14548 bpos_covered = bpos_max + XINT (chprop);
14549 /* If the `cursor' property covers buffer positions up
14550 to and including point, we should display cursor on
14551 this glyph. Note that, if a `cursor' property on one
14552 of the string's characters has an integer value, we
14553 will break out of the loop below _before_ we get to
14554 the position match above. IOW, integer values of
14555 the `cursor' property override the "exact match for
14556 point" strategy of positioning the cursor. */
14557 /* Implementation note: bpos_max == pt_old when, e.g.,
14558 we are in an empty line, where bpos_max is set to
14559 MATRIX_ROW_START_CHARPOS, see above. */
14560 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14562 cursor = glyph;
14563 break;
14567 string_seen = 1;
14569 x += glyph->pixel_width;
14570 ++glyph;
14572 else if (glyph > end) /* row is reversed */
14573 while (!INTEGERP (glyph->object))
14575 if (BUFFERP (glyph->object))
14577 ptrdiff_t dpos = glyph->charpos - pt_old;
14579 if (glyph->charpos > bpos_max)
14580 bpos_max = glyph->charpos;
14581 if (glyph->charpos < bpos_min)
14582 bpos_min = glyph->charpos;
14583 if (!glyph->avoid_cursor_p)
14585 if (dpos == 0)
14587 match_with_avoid_cursor = 0;
14588 break;
14590 if (0 > dpos && dpos > pos_before - pt_old)
14592 pos_before = glyph->charpos;
14593 glyph_before = glyph;
14595 else if (0 < dpos && dpos < pos_after - pt_old)
14597 pos_after = glyph->charpos;
14598 glyph_after = glyph;
14601 else if (dpos == 0)
14602 match_with_avoid_cursor = 1;
14604 else if (STRINGP (glyph->object))
14606 Lisp_Object chprop;
14607 ptrdiff_t glyph_pos = glyph->charpos;
14609 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14610 glyph->object);
14611 if (!NILP (chprop))
14613 ptrdiff_t prop_pos =
14614 string_buffer_position_lim (glyph->object, pos_before,
14615 pos_after, 0);
14617 if (prop_pos >= pos_before)
14618 bpos_max = prop_pos;
14620 if (INTEGERP (chprop))
14622 bpos_covered = bpos_max + XINT (chprop);
14623 /* If the `cursor' property covers buffer positions up
14624 to and including point, we should display cursor on
14625 this glyph. */
14626 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14628 cursor = glyph;
14629 break;
14632 string_seen = 1;
14634 --glyph;
14635 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14637 x--; /* can't use any pixel_width */
14638 break;
14640 x -= glyph->pixel_width;
14643 /* Step 2: If we didn't find an exact match for point, we need to
14644 look for a proper place to put the cursor among glyphs between
14645 GLYPH_BEFORE and GLYPH_AFTER. */
14646 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14647 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14648 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14650 /* An empty line has a single glyph whose OBJECT is zero and
14651 whose CHARPOS is the position of a newline on that line.
14652 Note that on a TTY, there are more glyphs after that, which
14653 were produced by extend_face_to_end_of_line, but their
14654 CHARPOS is zero or negative. */
14655 int empty_line_p =
14656 (row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14657 && INTEGERP (glyph->object) && glyph->charpos > 0
14658 /* On a TTY, continued and truncated rows also have a glyph at
14659 their end whose OBJECT is zero and whose CHARPOS is
14660 positive (the continuation and truncation glyphs), but such
14661 rows are obviously not "empty". */
14662 && !(row->continued_p || row->truncated_on_right_p);
14664 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14666 ptrdiff_t ellipsis_pos;
14668 /* Scan back over the ellipsis glyphs. */
14669 if (!row->reversed_p)
14671 ellipsis_pos = (glyph - 1)->charpos;
14672 while (glyph > row->glyphs[TEXT_AREA]
14673 && (glyph - 1)->charpos == ellipsis_pos)
14674 glyph--, x -= glyph->pixel_width;
14675 /* That loop always goes one position too far, including
14676 the glyph before the ellipsis. So scan forward over
14677 that one. */
14678 x += glyph->pixel_width;
14679 glyph++;
14681 else /* row is reversed */
14683 ellipsis_pos = (glyph + 1)->charpos;
14684 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14685 && (glyph + 1)->charpos == ellipsis_pos)
14686 glyph++, x += glyph->pixel_width;
14687 x -= glyph->pixel_width;
14688 glyph--;
14691 else if (match_with_avoid_cursor)
14693 cursor = glyph_after;
14694 x = -1;
14696 else if (string_seen)
14698 int incr = row->reversed_p ? -1 : +1;
14700 /* Need to find the glyph that came out of a string which is
14701 present at point. That glyph is somewhere between
14702 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14703 positioned between POS_BEFORE and POS_AFTER in the
14704 buffer. */
14705 struct glyph *start, *stop;
14706 ptrdiff_t pos = pos_before;
14708 x = -1;
14710 /* If the row ends in a newline from a display string,
14711 reordering could have moved the glyphs belonging to the
14712 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14713 in this case we extend the search to the last glyph in
14714 the row that was not inserted by redisplay. */
14715 if (row->ends_in_newline_from_string_p)
14717 glyph_after = end;
14718 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14721 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14722 correspond to POS_BEFORE and POS_AFTER, respectively. We
14723 need START and STOP in the order that corresponds to the
14724 row's direction as given by its reversed_p flag. If the
14725 directionality of characters between POS_BEFORE and
14726 POS_AFTER is the opposite of the row's base direction,
14727 these characters will have been reordered for display,
14728 and we need to reverse START and STOP. */
14729 if (!row->reversed_p)
14731 start = min (glyph_before, glyph_after);
14732 stop = max (glyph_before, glyph_after);
14734 else
14736 start = max (glyph_before, glyph_after);
14737 stop = min (glyph_before, glyph_after);
14739 for (glyph = start + incr;
14740 row->reversed_p ? glyph > stop : glyph < stop; )
14743 /* Any glyphs that come from the buffer are here because
14744 of bidi reordering. Skip them, and only pay
14745 attention to glyphs that came from some string. */
14746 if (STRINGP (glyph->object))
14748 Lisp_Object str;
14749 ptrdiff_t tem;
14750 /* If the display property covers the newline, we
14751 need to search for it one position farther. */
14752 ptrdiff_t lim = pos_after
14753 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14755 string_from_text_prop = 0;
14756 str = glyph->object;
14757 tem = string_buffer_position_lim (str, pos, lim, 0);
14758 if (tem == 0 /* from overlay */
14759 || pos <= tem)
14761 /* If the string from which this glyph came is
14762 found in the buffer at point, or at position
14763 that is closer to point than pos_after, then
14764 we've found the glyph we've been looking for.
14765 If it comes from an overlay (tem == 0), and
14766 it has the `cursor' property on one of its
14767 glyphs, record that glyph as a candidate for
14768 displaying the cursor. (As in the
14769 unidirectional version, we will display the
14770 cursor on the last candidate we find.) */
14771 if (tem == 0
14772 || tem == pt_old
14773 || (tem - pt_old > 0 && tem < pos_after))
14775 /* The glyphs from this string could have
14776 been reordered. Find the one with the
14777 smallest string position. Or there could
14778 be a character in the string with the
14779 `cursor' property, which means display
14780 cursor on that character's glyph. */
14781 ptrdiff_t strpos = glyph->charpos;
14783 if (tem)
14785 cursor = glyph;
14786 string_from_text_prop = 1;
14788 for ( ;
14789 (row->reversed_p ? glyph > stop : glyph < stop)
14790 && EQ (glyph->object, str);
14791 glyph += incr)
14793 Lisp_Object cprop;
14794 ptrdiff_t gpos = glyph->charpos;
14796 cprop = Fget_char_property (make_number (gpos),
14797 Qcursor,
14798 glyph->object);
14799 if (!NILP (cprop))
14801 cursor = glyph;
14802 break;
14804 if (tem && glyph->charpos < strpos)
14806 strpos = glyph->charpos;
14807 cursor = glyph;
14811 if (tem == pt_old
14812 || (tem - pt_old > 0 && tem < pos_after))
14813 goto compute_x;
14815 if (tem)
14816 pos = tem + 1; /* don't find previous instances */
14818 /* This string is not what we want; skip all of the
14819 glyphs that came from it. */
14820 while ((row->reversed_p ? glyph > stop : glyph < stop)
14821 && EQ (glyph->object, str))
14822 glyph += incr;
14824 else
14825 glyph += incr;
14828 /* If we reached the end of the line, and END was from a string,
14829 the cursor is not on this line. */
14830 if (cursor == NULL
14831 && (row->reversed_p ? glyph <= end : glyph >= end)
14832 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14833 && STRINGP (end->object)
14834 && row->continued_p)
14835 return 0;
14837 /* A truncated row may not include PT among its character positions.
14838 Setting the cursor inside the scroll margin will trigger
14839 recalculation of hscroll in hscroll_window_tree. But if a
14840 display string covers point, defer to the string-handling
14841 code below to figure this out. */
14842 else if (row->truncated_on_left_p && pt_old < bpos_min)
14844 cursor = glyph_before;
14845 x = -1;
14847 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14848 /* Zero-width characters produce no glyphs. */
14849 || (!empty_line_p
14850 && (row->reversed_p
14851 ? glyph_after > glyphs_end
14852 : glyph_after < glyphs_end)))
14854 cursor = glyph_after;
14855 x = -1;
14859 compute_x:
14860 if (cursor != NULL)
14861 glyph = cursor;
14862 else if (glyph == glyphs_end
14863 && pos_before == pos_after
14864 && STRINGP ((row->reversed_p
14865 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14866 : row->glyphs[TEXT_AREA])->object))
14868 /* If all the glyphs of this row came from strings, put the
14869 cursor on the first glyph of the row. This avoids having the
14870 cursor outside of the text area in this very rare and hard
14871 use case. */
14872 glyph =
14873 row->reversed_p
14874 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14875 : row->glyphs[TEXT_AREA];
14877 if (x < 0)
14879 struct glyph *g;
14881 /* Need to compute x that corresponds to GLYPH. */
14882 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14884 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14885 emacs_abort ();
14886 x += g->pixel_width;
14890 /* ROW could be part of a continued line, which, under bidi
14891 reordering, might have other rows whose start and end charpos
14892 occlude point. Only set w->cursor if we found a better
14893 approximation to the cursor position than we have from previously
14894 examined candidate rows belonging to the same continued line. */
14895 if (/* We already have a candidate row. */
14896 w->cursor.vpos >= 0
14897 /* That candidate is not the row we are processing. */
14898 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14899 /* Make sure cursor.vpos specifies a row whose start and end
14900 charpos occlude point, and it is valid candidate for being a
14901 cursor-row. This is because some callers of this function
14902 leave cursor.vpos at the row where the cursor was displayed
14903 during the last redisplay cycle. */
14904 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14905 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14906 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14908 struct glyph *g1
14909 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14911 /* Don't consider glyphs that are outside TEXT_AREA. */
14912 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14913 return 0;
14914 /* Keep the candidate whose buffer position is the closest to
14915 point or has the `cursor' property. */
14916 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14917 w->cursor.hpos >= 0
14918 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14919 && ((BUFFERP (g1->object)
14920 && (g1->charpos == pt_old /* An exact match always wins. */
14921 || (BUFFERP (glyph->object)
14922 && eabs (g1->charpos - pt_old)
14923 < eabs (glyph->charpos - pt_old))))
14924 /* Previous candidate is a glyph from a string that has
14925 a non-nil `cursor' property. */
14926 || (STRINGP (g1->object)
14927 && (!NILP (Fget_char_property (make_number (g1->charpos),
14928 Qcursor, g1->object))
14929 /* Previous candidate is from the same display
14930 string as this one, and the display string
14931 came from a text property. */
14932 || (EQ (g1->object, glyph->object)
14933 && string_from_text_prop)
14934 /* this candidate is from newline and its
14935 position is not an exact match */
14936 || (INTEGERP (glyph->object)
14937 && glyph->charpos != pt_old)))))
14938 return 0;
14939 /* If this candidate gives an exact match, use that. */
14940 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14941 /* If this candidate is a glyph created for the
14942 terminating newline of a line, and point is on that
14943 newline, it wins because it's an exact match. */
14944 || (!row->continued_p
14945 && INTEGERP (glyph->object)
14946 && glyph->charpos == 0
14947 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14948 /* Otherwise, keep the candidate that comes from a row
14949 spanning less buffer positions. This may win when one or
14950 both candidate positions are on glyphs that came from
14951 display strings, for which we cannot compare buffer
14952 positions. */
14953 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14954 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14955 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14956 return 0;
14958 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14959 w->cursor.x = x;
14960 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14961 w->cursor.y = row->y + dy;
14963 if (w == XWINDOW (selected_window))
14965 if (!row->continued_p
14966 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14967 && row->x == 0)
14969 this_line_buffer = XBUFFER (w->contents);
14971 CHARPOS (this_line_start_pos)
14972 = MATRIX_ROW_START_CHARPOS (row) + delta;
14973 BYTEPOS (this_line_start_pos)
14974 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14976 CHARPOS (this_line_end_pos)
14977 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14978 BYTEPOS (this_line_end_pos)
14979 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14981 this_line_y = w->cursor.y;
14982 this_line_pixel_height = row->height;
14983 this_line_vpos = w->cursor.vpos;
14984 this_line_start_x = row->x;
14986 else
14987 CHARPOS (this_line_start_pos) = 0;
14990 return 1;
14994 /* Run window scroll functions, if any, for WINDOW with new window
14995 start STARTP. Sets the window start of WINDOW to that position.
14997 We assume that the window's buffer is really current. */
14999 static struct text_pos
15000 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
15002 struct window *w = XWINDOW (window);
15003 SET_MARKER_FROM_TEXT_POS (w->start, startp);
15005 eassert (current_buffer == XBUFFER (w->contents));
15007 if (!NILP (Vwindow_scroll_functions))
15009 run_hook_with_args_2 (Qwindow_scroll_functions, window,
15010 make_number (CHARPOS (startp)));
15011 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15012 /* In case the hook functions switch buffers. */
15013 set_buffer_internal (XBUFFER (w->contents));
15016 return startp;
15020 /* Make sure the line containing the cursor is fully visible.
15021 A value of 1 means there is nothing to be done.
15022 (Either the line is fully visible, or it cannot be made so,
15023 or we cannot tell.)
15025 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15026 is higher than window.
15028 If CURRENT_MATRIX_P is non-zero, use the information from the
15029 window's current glyph matrix; otherwise use the desired glyph
15030 matrix.
15032 A value of 0 means the caller should do scrolling
15033 as if point had gone off the screen. */
15035 static int
15036 cursor_row_fully_visible_p (struct window *w, int force_p, int current_matrix_p)
15038 struct glyph_matrix *matrix;
15039 struct glyph_row *row;
15040 int window_height;
15042 if (!make_cursor_line_fully_visible_p)
15043 return 1;
15045 /* It's not always possible to find the cursor, e.g, when a window
15046 is full of overlay strings. Don't do anything in that case. */
15047 if (w->cursor.vpos < 0)
15048 return 1;
15050 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
15051 row = MATRIX_ROW (matrix, w->cursor.vpos);
15053 /* If the cursor row is not partially visible, there's nothing to do. */
15054 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
15055 return 1;
15057 /* If the row the cursor is in is taller than the window's height,
15058 it's not clear what to do, so do nothing. */
15059 window_height = window_box_height (w);
15060 if (row->height >= window_height)
15062 if (!force_p || MINI_WINDOW_P (w)
15063 || w->vscroll || w->cursor.vpos == 0)
15064 return 1;
15066 return 0;
15070 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15071 non-zero means only WINDOW is redisplayed in redisplay_internal.
15072 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15073 in redisplay_window to bring a partially visible line into view in
15074 the case that only the cursor has moved.
15076 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15077 last screen line's vertical height extends past the end of the screen.
15079 Value is
15081 1 if scrolling succeeded
15083 0 if scrolling didn't find point.
15085 -1 if new fonts have been loaded so that we must interrupt
15086 redisplay, adjust glyph matrices, and try again. */
15088 enum
15090 SCROLLING_SUCCESS,
15091 SCROLLING_FAILED,
15092 SCROLLING_NEED_LARGER_MATRICES
15095 /* If scroll-conservatively is more than this, never recenter.
15097 If you change this, don't forget to update the doc string of
15098 `scroll-conservatively' and the Emacs manual. */
15099 #define SCROLL_LIMIT 100
15101 static int
15102 try_scrolling (Lisp_Object window, int just_this_one_p,
15103 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
15104 int temp_scroll_step, int last_line_misfit)
15106 struct window *w = XWINDOW (window);
15107 struct frame *f = XFRAME (w->frame);
15108 struct text_pos pos, startp;
15109 struct it it;
15110 int this_scroll_margin, scroll_max, rc, height;
15111 int dy = 0, amount_to_scroll = 0, scroll_down_p = 0;
15112 int extra_scroll_margin_lines = last_line_misfit ? 1 : 0;
15113 Lisp_Object aggressive;
15114 /* We will never try scrolling more than this number of lines. */
15115 int scroll_limit = SCROLL_LIMIT;
15116 int frame_line_height = default_line_pixel_height (w);
15117 int window_total_lines
15118 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15120 #ifdef GLYPH_DEBUG
15121 debug_method_add (w, "try_scrolling");
15122 #endif
15124 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15126 /* Compute scroll margin height in pixels. We scroll when point is
15127 within this distance from the top or bottom of the window. */
15128 if (scroll_margin > 0)
15129 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
15130 * frame_line_height;
15131 else
15132 this_scroll_margin = 0;
15134 /* Force arg_scroll_conservatively to have a reasonable value, to
15135 avoid scrolling too far away with slow move_it_* functions. Note
15136 that the user can supply scroll-conservatively equal to
15137 `most-positive-fixnum', which can be larger than INT_MAX. */
15138 if (arg_scroll_conservatively > scroll_limit)
15140 arg_scroll_conservatively = scroll_limit + 1;
15141 scroll_max = scroll_limit * frame_line_height;
15143 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15144 /* Compute how much we should try to scroll maximally to bring
15145 point into view. */
15146 scroll_max = (max (scroll_step,
15147 max (arg_scroll_conservatively, temp_scroll_step))
15148 * frame_line_height);
15149 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15150 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15151 /* We're trying to scroll because of aggressive scrolling but no
15152 scroll_step is set. Choose an arbitrary one. */
15153 scroll_max = 10 * frame_line_height;
15154 else
15155 scroll_max = 0;
15157 too_near_end:
15159 /* Decide whether to scroll down. */
15160 if (PT > CHARPOS (startp))
15162 int scroll_margin_y;
15164 /* Compute the pixel ypos of the scroll margin, then move IT to
15165 either that ypos or PT, whichever comes first. */
15166 start_display (&it, w, startp);
15167 scroll_margin_y = it.last_visible_y - this_scroll_margin
15168 - frame_line_height * extra_scroll_margin_lines;
15169 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15170 (MOVE_TO_POS | MOVE_TO_Y));
15172 if (PT > CHARPOS (it.current.pos))
15174 int y0 = line_bottom_y (&it);
15175 /* Compute how many pixels below window bottom to stop searching
15176 for PT. This avoids costly search for PT that is far away if
15177 the user limited scrolling by a small number of lines, but
15178 always finds PT if scroll_conservatively is set to a large
15179 number, such as most-positive-fixnum. */
15180 int slack = max (scroll_max, 10 * frame_line_height);
15181 int y_to_move = it.last_visible_y + slack;
15183 /* Compute the distance from the scroll margin to PT or to
15184 the scroll limit, whichever comes first. This should
15185 include the height of the cursor line, to make that line
15186 fully visible. */
15187 move_it_to (&it, PT, -1, y_to_move,
15188 -1, MOVE_TO_POS | MOVE_TO_Y);
15189 dy = line_bottom_y (&it) - y0;
15191 if (dy > scroll_max)
15192 return SCROLLING_FAILED;
15194 if (dy > 0)
15195 scroll_down_p = 1;
15199 if (scroll_down_p)
15201 /* Point is in or below the bottom scroll margin, so move the
15202 window start down. If scrolling conservatively, move it just
15203 enough down to make point visible. If scroll_step is set,
15204 move it down by scroll_step. */
15205 if (arg_scroll_conservatively)
15206 amount_to_scroll
15207 = min (max (dy, frame_line_height),
15208 frame_line_height * arg_scroll_conservatively);
15209 else if (scroll_step || temp_scroll_step)
15210 amount_to_scroll = scroll_max;
15211 else
15213 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15214 height = WINDOW_BOX_TEXT_HEIGHT (w);
15215 if (NUMBERP (aggressive))
15217 double float_amount = XFLOATINT (aggressive) * height;
15218 int aggressive_scroll = float_amount;
15219 if (aggressive_scroll == 0 && float_amount > 0)
15220 aggressive_scroll = 1;
15221 /* Don't let point enter the scroll margin near top of
15222 the window. This could happen if the value of
15223 scroll_up_aggressively is too large and there are
15224 non-zero margins, because scroll_up_aggressively
15225 means put point that fraction of window height
15226 _from_the_bottom_margin_. */
15227 if (aggressive_scroll + 2*this_scroll_margin > height)
15228 aggressive_scroll = height - 2*this_scroll_margin;
15229 amount_to_scroll = dy + aggressive_scroll;
15233 if (amount_to_scroll <= 0)
15234 return SCROLLING_FAILED;
15236 start_display (&it, w, startp);
15237 if (arg_scroll_conservatively <= scroll_limit)
15238 move_it_vertically (&it, amount_to_scroll);
15239 else
15241 /* Extra precision for users who set scroll-conservatively
15242 to a large number: make sure the amount we scroll
15243 the window start is never less than amount_to_scroll,
15244 which was computed as distance from window bottom to
15245 point. This matters when lines at window top and lines
15246 below window bottom have different height. */
15247 struct it it1;
15248 void *it1data = NULL;
15249 /* We use a temporary it1 because line_bottom_y can modify
15250 its argument, if it moves one line down; see there. */
15251 int start_y;
15253 SAVE_IT (it1, it, it1data);
15254 start_y = line_bottom_y (&it1);
15255 do {
15256 RESTORE_IT (&it, &it, it1data);
15257 move_it_by_lines (&it, 1);
15258 SAVE_IT (it1, it, it1data);
15259 } while (line_bottom_y (&it1) - start_y < amount_to_scroll);
15262 /* If STARTP is unchanged, move it down another screen line. */
15263 if (CHARPOS (it.current.pos) == CHARPOS (startp))
15264 move_it_by_lines (&it, 1);
15265 startp = it.current.pos;
15267 else
15269 struct text_pos scroll_margin_pos = startp;
15270 int y_offset = 0;
15272 /* See if point is inside the scroll margin at the top of the
15273 window. */
15274 if (this_scroll_margin)
15276 int y_start;
15278 start_display (&it, w, startp);
15279 y_start = it.current_y;
15280 move_it_vertically (&it, this_scroll_margin);
15281 scroll_margin_pos = it.current.pos;
15282 /* If we didn't move enough before hitting ZV, request
15283 additional amount of scroll, to move point out of the
15284 scroll margin. */
15285 if (IT_CHARPOS (it) == ZV
15286 && it.current_y - y_start < this_scroll_margin)
15287 y_offset = this_scroll_margin - (it.current_y - y_start);
15290 if (PT < CHARPOS (scroll_margin_pos))
15292 /* Point is in the scroll margin at the top of the window or
15293 above what is displayed in the window. */
15294 int y0, y_to_move;
15296 /* Compute the vertical distance from PT to the scroll
15297 margin position. Move as far as scroll_max allows, or
15298 one screenful, or 10 screen lines, whichever is largest.
15299 Give up if distance is greater than scroll_max or if we
15300 didn't reach the scroll margin position. */
15301 SET_TEXT_POS (pos, PT, PT_BYTE);
15302 start_display (&it, w, pos);
15303 y0 = it.current_y;
15304 y_to_move = max (it.last_visible_y,
15305 max (scroll_max, 10 * frame_line_height));
15306 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15307 y_to_move, -1,
15308 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15309 dy = it.current_y - y0;
15310 if (dy > scroll_max
15311 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15312 return SCROLLING_FAILED;
15314 /* Additional scroll for when ZV was too close to point. */
15315 dy += y_offset;
15317 /* Compute new window start. */
15318 start_display (&it, w, startp);
15320 if (arg_scroll_conservatively)
15321 amount_to_scroll = max (dy, frame_line_height *
15322 max (scroll_step, temp_scroll_step));
15323 else if (scroll_step || temp_scroll_step)
15324 amount_to_scroll = scroll_max;
15325 else
15327 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15328 height = WINDOW_BOX_TEXT_HEIGHT (w);
15329 if (NUMBERP (aggressive))
15331 double float_amount = XFLOATINT (aggressive) * height;
15332 int aggressive_scroll = float_amount;
15333 if (aggressive_scroll == 0 && float_amount > 0)
15334 aggressive_scroll = 1;
15335 /* Don't let point enter the scroll margin near
15336 bottom of the window, if the value of
15337 scroll_down_aggressively happens to be too
15338 large. */
15339 if (aggressive_scroll + 2*this_scroll_margin > height)
15340 aggressive_scroll = height - 2*this_scroll_margin;
15341 amount_to_scroll = dy + aggressive_scroll;
15345 if (amount_to_scroll <= 0)
15346 return SCROLLING_FAILED;
15348 move_it_vertically_backward (&it, amount_to_scroll);
15349 startp = it.current.pos;
15353 /* Run window scroll functions. */
15354 startp = run_window_scroll_functions (window, startp);
15356 /* Display the window. Give up if new fonts are loaded, or if point
15357 doesn't appear. */
15358 if (!try_window (window, startp, 0))
15359 rc = SCROLLING_NEED_LARGER_MATRICES;
15360 else if (w->cursor.vpos < 0)
15362 clear_glyph_matrix (w->desired_matrix);
15363 rc = SCROLLING_FAILED;
15365 else
15367 /* Maybe forget recorded base line for line number display. */
15368 if (!just_this_one_p
15369 || current_buffer->clip_changed
15370 || BEG_UNCHANGED < CHARPOS (startp))
15371 w->base_line_number = 0;
15373 /* If cursor ends up on a partially visible line,
15374 treat that as being off the bottom of the screen. */
15375 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1, 0)
15376 /* It's possible that the cursor is on the first line of the
15377 buffer, which is partially obscured due to a vscroll
15378 (Bug#7537). In that case, avoid looping forever. */
15379 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15381 clear_glyph_matrix (w->desired_matrix);
15382 ++extra_scroll_margin_lines;
15383 goto too_near_end;
15385 rc = SCROLLING_SUCCESS;
15388 return rc;
15392 /* Compute a suitable window start for window W if display of W starts
15393 on a continuation line. Value is non-zero if a new window start
15394 was computed.
15396 The new window start will be computed, based on W's width, starting
15397 from the start of the continued line. It is the start of the
15398 screen line with the minimum distance from the old start W->start. */
15400 static int
15401 compute_window_start_on_continuation_line (struct window *w)
15403 struct text_pos pos, start_pos;
15404 int window_start_changed_p = 0;
15406 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15408 /* If window start is on a continuation line... Window start may be
15409 < BEGV in case there's invisible text at the start of the
15410 buffer (M-x rmail, for example). */
15411 if (CHARPOS (start_pos) > BEGV
15412 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15414 struct it it;
15415 struct glyph_row *row;
15417 /* Handle the case that the window start is out of range. */
15418 if (CHARPOS (start_pos) < BEGV)
15419 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15420 else if (CHARPOS (start_pos) > ZV)
15421 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15423 /* Find the start of the continued line. This should be fast
15424 because find_newline is fast (newline cache). */
15425 row = w->desired_matrix->rows + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0);
15426 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15427 row, DEFAULT_FACE_ID);
15428 reseat_at_previous_visible_line_start (&it);
15430 /* If the line start is "too far" away from the window start,
15431 say it takes too much time to compute a new window start. */
15432 if (CHARPOS (start_pos) - IT_CHARPOS (it)
15433 /* PXW: Do we need upper bounds here? */
15434 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
15436 int min_distance, distance;
15438 /* Move forward by display lines to find the new window
15439 start. If window width was enlarged, the new start can
15440 be expected to be > the old start. If window width was
15441 decreased, the new window start will be < the old start.
15442 So, we're looking for the display line start with the
15443 minimum distance from the old window start. */
15444 pos = it.current.pos;
15445 min_distance = INFINITY;
15446 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15447 distance < min_distance)
15449 min_distance = distance;
15450 pos = it.current.pos;
15451 if (it.line_wrap == WORD_WRAP)
15453 /* Under WORD_WRAP, move_it_by_lines is likely to
15454 overshoot and stop not at the first, but the
15455 second character from the left margin. So in
15456 that case, we need a more tight control on the X
15457 coordinate of the iterator than move_it_by_lines
15458 promises in its contract. The method is to first
15459 go to the last (rightmost) visible character of a
15460 line, then move to the leftmost character on the
15461 next line in a separate call. */
15462 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15463 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15464 move_it_to (&it, ZV, 0,
15465 it.current_y + it.max_ascent + it.max_descent, -1,
15466 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15468 else
15469 move_it_by_lines (&it, 1);
15472 /* Set the window start there. */
15473 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15474 window_start_changed_p = 1;
15478 return window_start_changed_p;
15482 /* Try cursor movement in case text has not changed in window WINDOW,
15483 with window start STARTP. Value is
15485 CURSOR_MOVEMENT_SUCCESS if successful
15487 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15489 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15490 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15491 we want to scroll as if scroll-step were set to 1. See the code.
15493 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15494 which case we have to abort this redisplay, and adjust matrices
15495 first. */
15497 enum
15499 CURSOR_MOVEMENT_SUCCESS,
15500 CURSOR_MOVEMENT_CANNOT_BE_USED,
15501 CURSOR_MOVEMENT_MUST_SCROLL,
15502 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15505 static int
15506 try_cursor_movement (Lisp_Object window, struct text_pos startp, int *scroll_step)
15508 struct window *w = XWINDOW (window);
15509 struct frame *f = XFRAME (w->frame);
15510 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15512 #ifdef GLYPH_DEBUG
15513 if (inhibit_try_cursor_movement)
15514 return rc;
15515 #endif
15517 /* Previously, there was a check for Lisp integer in the
15518 if-statement below. Now, this field is converted to
15519 ptrdiff_t, thus zero means invalid position in a buffer. */
15520 eassert (w->last_point > 0);
15521 /* Likewise there was a check whether window_end_vpos is nil or larger
15522 than the window. Now window_end_vpos is int and so never nil, but
15523 let's leave eassert to check whether it fits in the window. */
15524 eassert (w->window_end_vpos < w->current_matrix->nrows);
15526 /* Handle case where text has not changed, only point, and it has
15527 not moved off the frame. */
15528 if (/* Point may be in this window. */
15529 PT >= CHARPOS (startp)
15530 /* Selective display hasn't changed. */
15531 && !current_buffer->clip_changed
15532 /* Function force-mode-line-update is used to force a thorough
15533 redisplay. It sets either windows_or_buffers_changed or
15534 update_mode_lines. So don't take a shortcut here for these
15535 cases. */
15536 && !update_mode_lines
15537 && !windows_or_buffers_changed
15538 && !f->cursor_type_changed
15539 && NILP (Vshow_trailing_whitespace)
15540 /* This code is not used for mini-buffer for the sake of the case
15541 of redisplaying to replace an echo area message; since in
15542 that case the mini-buffer contents per se are usually
15543 unchanged. This code is of no real use in the mini-buffer
15544 since the handling of this_line_start_pos, etc., in redisplay
15545 handles the same cases. */
15546 && !EQ (window, minibuf_window)
15547 && (FRAME_WINDOW_P (f)
15548 || !overlay_arrow_in_current_buffer_p ()))
15550 int this_scroll_margin, top_scroll_margin;
15551 struct glyph_row *row = NULL;
15552 int frame_line_height = default_line_pixel_height (w);
15553 int window_total_lines
15554 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15556 #ifdef GLYPH_DEBUG
15557 debug_method_add (w, "cursor movement");
15558 #endif
15560 /* Scroll if point within this distance from the top or bottom
15561 of the window. This is a pixel value. */
15562 if (scroll_margin > 0)
15564 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15565 this_scroll_margin *= frame_line_height;
15567 else
15568 this_scroll_margin = 0;
15570 top_scroll_margin = this_scroll_margin;
15571 if (WINDOW_WANTS_HEADER_LINE_P (w))
15572 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15574 /* Start with the row the cursor was displayed during the last
15575 not paused redisplay. Give up if that row is not valid. */
15576 if (w->last_cursor_vpos < 0
15577 || w->last_cursor_vpos >= w->current_matrix->nrows)
15578 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15579 else
15581 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15582 if (row->mode_line_p)
15583 ++row;
15584 if (!row->enabled_p)
15585 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15588 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15590 int scroll_p = 0, must_scroll = 0;
15591 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15593 if (PT > w->last_point)
15595 /* Point has moved forward. */
15596 while (MATRIX_ROW_END_CHARPOS (row) < PT
15597 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15599 eassert (row->enabled_p);
15600 ++row;
15603 /* If the end position of a row equals the start
15604 position of the next row, and PT is at that position,
15605 we would rather display cursor in the next line. */
15606 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15607 && MATRIX_ROW_END_CHARPOS (row) == PT
15608 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15609 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15610 && !cursor_row_p (row))
15611 ++row;
15613 /* If within the scroll margin, scroll. Note that
15614 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15615 the next line would be drawn, and that
15616 this_scroll_margin can be zero. */
15617 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15618 || PT > MATRIX_ROW_END_CHARPOS (row)
15619 /* Line is completely visible last line in window
15620 and PT is to be set in the next line. */
15621 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15622 && PT == MATRIX_ROW_END_CHARPOS (row)
15623 && !row->ends_at_zv_p
15624 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15625 scroll_p = 1;
15627 else if (PT < w->last_point)
15629 /* Cursor has to be moved backward. Note that PT >=
15630 CHARPOS (startp) because of the outer if-statement. */
15631 while (!row->mode_line_p
15632 && (MATRIX_ROW_START_CHARPOS (row) > PT
15633 || (MATRIX_ROW_START_CHARPOS (row) == PT
15634 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15635 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15636 row > w->current_matrix->rows
15637 && (row-1)->ends_in_newline_from_string_p))))
15638 && (row->y > top_scroll_margin
15639 || CHARPOS (startp) == BEGV))
15641 eassert (row->enabled_p);
15642 --row;
15645 /* Consider the following case: Window starts at BEGV,
15646 there is invisible, intangible text at BEGV, so that
15647 display starts at some point START > BEGV. It can
15648 happen that we are called with PT somewhere between
15649 BEGV and START. Try to handle that case. */
15650 if (row < w->current_matrix->rows
15651 || row->mode_line_p)
15653 row = w->current_matrix->rows;
15654 if (row->mode_line_p)
15655 ++row;
15658 /* Due to newlines in overlay strings, we may have to
15659 skip forward over overlay strings. */
15660 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15661 && MATRIX_ROW_END_CHARPOS (row) == PT
15662 && !cursor_row_p (row))
15663 ++row;
15665 /* If within the scroll margin, scroll. */
15666 if (row->y < top_scroll_margin
15667 && CHARPOS (startp) != BEGV)
15668 scroll_p = 1;
15670 else
15672 /* Cursor did not move. So don't scroll even if cursor line
15673 is partially visible, as it was so before. */
15674 rc = CURSOR_MOVEMENT_SUCCESS;
15677 if (PT < MATRIX_ROW_START_CHARPOS (row)
15678 || PT > MATRIX_ROW_END_CHARPOS (row))
15680 /* if PT is not in the glyph row, give up. */
15681 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15682 must_scroll = 1;
15684 else if (rc != CURSOR_MOVEMENT_SUCCESS
15685 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15687 struct glyph_row *row1;
15689 /* If rows are bidi-reordered and point moved, back up
15690 until we find a row that does not belong to a
15691 continuation line. This is because we must consider
15692 all rows of a continued line as candidates for the
15693 new cursor positioning, since row start and end
15694 positions change non-linearly with vertical position
15695 in such rows. */
15696 /* FIXME: Revisit this when glyph ``spilling'' in
15697 continuation lines' rows is implemented for
15698 bidi-reordered rows. */
15699 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15700 MATRIX_ROW_CONTINUATION_LINE_P (row);
15701 --row)
15703 /* If we hit the beginning of the displayed portion
15704 without finding the first row of a continued
15705 line, give up. */
15706 if (row <= row1)
15708 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15709 break;
15711 eassert (row->enabled_p);
15714 if (must_scroll)
15716 else if (rc != CURSOR_MOVEMENT_SUCCESS
15717 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15718 /* Make sure this isn't a header line by any chance, since
15719 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15720 && !row->mode_line_p
15721 && make_cursor_line_fully_visible_p)
15723 if (PT == MATRIX_ROW_END_CHARPOS (row)
15724 && !row->ends_at_zv_p
15725 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15726 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15727 else if (row->height > window_box_height (w))
15729 /* If we end up in a partially visible line, let's
15730 make it fully visible, except when it's taller
15731 than the window, in which case we can't do much
15732 about it. */
15733 *scroll_step = 1;
15734 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15736 else
15738 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15739 if (!cursor_row_fully_visible_p (w, 0, 1))
15740 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15741 else
15742 rc = CURSOR_MOVEMENT_SUCCESS;
15745 else if (scroll_p)
15746 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15747 else if (rc != CURSOR_MOVEMENT_SUCCESS
15748 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15750 /* With bidi-reordered rows, there could be more than
15751 one candidate row whose start and end positions
15752 occlude point. We need to let set_cursor_from_row
15753 find the best candidate. */
15754 /* FIXME: Revisit this when glyph ``spilling'' in
15755 continuation lines' rows is implemented for
15756 bidi-reordered rows. */
15757 int rv = 0;
15761 int at_zv_p = 0, exact_match_p = 0;
15763 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15764 && PT <= MATRIX_ROW_END_CHARPOS (row)
15765 && cursor_row_p (row))
15766 rv |= set_cursor_from_row (w, row, w->current_matrix,
15767 0, 0, 0, 0);
15768 /* As soon as we've found the exact match for point,
15769 or the first suitable row whose ends_at_zv_p flag
15770 is set, we are done. */
15771 if (rv)
15773 at_zv_p = MATRIX_ROW (w->current_matrix,
15774 w->cursor.vpos)->ends_at_zv_p;
15775 if (!at_zv_p
15776 && w->cursor.hpos >= 0
15777 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15778 w->cursor.vpos))
15780 struct glyph_row *candidate =
15781 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15782 struct glyph *g =
15783 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15784 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15786 exact_match_p =
15787 (BUFFERP (g->object) && g->charpos == PT)
15788 || (INTEGERP (g->object)
15789 && (g->charpos == PT
15790 || (g->charpos == 0 && endpos - 1 == PT)));
15792 if (at_zv_p || exact_match_p)
15794 rc = CURSOR_MOVEMENT_SUCCESS;
15795 break;
15798 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15799 break;
15800 ++row;
15802 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15803 || row->continued_p)
15804 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15805 || (MATRIX_ROW_START_CHARPOS (row) == PT
15806 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15807 /* If we didn't find any candidate rows, or exited the
15808 loop before all the candidates were examined, signal
15809 to the caller that this method failed. */
15810 if (rc != CURSOR_MOVEMENT_SUCCESS
15811 && !(rv
15812 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15813 && !row->continued_p))
15814 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15815 else if (rv)
15816 rc = CURSOR_MOVEMENT_SUCCESS;
15818 else
15822 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15824 rc = CURSOR_MOVEMENT_SUCCESS;
15825 break;
15827 ++row;
15829 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15830 && MATRIX_ROW_START_CHARPOS (row) == PT
15831 && cursor_row_p (row));
15836 return rc;
15839 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15840 static
15841 #endif
15842 void
15843 set_vertical_scroll_bar (struct window *w)
15845 ptrdiff_t start, end, whole;
15847 /* Calculate the start and end positions for the current window.
15848 At some point, it would be nice to choose between scrollbars
15849 which reflect the whole buffer size, with special markers
15850 indicating narrowing, and scrollbars which reflect only the
15851 visible region.
15853 Note that mini-buffers sometimes aren't displaying any text. */
15854 if (!MINI_WINDOW_P (w)
15855 || (w == XWINDOW (minibuf_window)
15856 && NILP (echo_area_buffer[0])))
15858 struct buffer *buf = XBUFFER (w->contents);
15859 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15860 start = marker_position (w->start) - BUF_BEGV (buf);
15861 /* I don't think this is guaranteed to be right. For the
15862 moment, we'll pretend it is. */
15863 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15865 if (end < start)
15866 end = start;
15867 if (whole < (end - start))
15868 whole = end - start;
15870 else
15871 start = end = whole = 0;
15873 /* Indicate what this scroll bar ought to be displaying now. */
15874 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15875 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15876 (w, end - start, whole, start);
15880 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15881 selected_window is redisplayed.
15883 We can return without actually redisplaying the window if fonts has been
15884 changed on window's frame. In that case, redisplay_internal will retry.
15886 As one of the important parts of redisplaying a window, we need to
15887 decide whether the previous window-start position (stored in the
15888 window's w->start marker position) is still valid, and if it isn't,
15889 recompute it. Some details about that:
15891 . The previous window-start could be in a continuation line, in
15892 which case we need to recompute it when the window width
15893 changes. See compute_window_start_on_continuation_line and its
15894 call below.
15896 . The text that changed since last redisplay could include the
15897 previous window-start position. In that case, we try to salvage
15898 what we can from the current glyph matrix by calling
15899 try_scrolling, which see.
15901 . Some Emacs command could force us to use a specific window-start
15902 position by setting the window's force_start flag, or gently
15903 propose doing that by setting the window's optional_new_start
15904 flag. In these cases, we try using the specified start point if
15905 that succeeds (i.e. the window desired matrix is successfully
15906 recomputed, and point location is within the window). In case
15907 of optional_new_start, we first check if the specified start
15908 position is feasible, i.e. if it will allow point to be
15909 displayed in the window. If using the specified start point
15910 fails, e.g., if new fonts are needed to be loaded, we abort the
15911 redisplay cycle and leave it up to the next cycle to figure out
15912 things.
15914 . Note that the window's force_start flag is sometimes set by
15915 redisplay itself, when it decides that the previous window start
15916 point is fine and should be kept. Search for "goto force_start"
15917 below to see the details. Like the values of window-start
15918 specified outside of redisplay, these internally-deduced values
15919 are tested for feasibility, and ignored if found to be
15920 unfeasible.
15922 . Note that the function try_window, used to completely redisplay
15923 a window, accepts the window's start point as its argument.
15924 This is used several times in the redisplay code to control
15925 where the window start will be, according to user options such
15926 as scroll-conservatively, and also to ensure the screen line
15927 showing point will be fully (as opposed to partially) visible on
15928 display. */
15930 static void
15931 redisplay_window (Lisp_Object window, bool just_this_one_p)
15933 struct window *w = XWINDOW (window);
15934 struct frame *f = XFRAME (w->frame);
15935 struct buffer *buffer = XBUFFER (w->contents);
15936 struct buffer *old = current_buffer;
15937 struct text_pos lpoint, opoint, startp;
15938 int update_mode_line;
15939 int tem;
15940 struct it it;
15941 /* Record it now because it's overwritten. */
15942 bool current_matrix_up_to_date_p = false;
15943 bool used_current_matrix_p = false;
15944 /* This is less strict than current_matrix_up_to_date_p.
15945 It indicates that the buffer contents and narrowing are unchanged. */
15946 bool buffer_unchanged_p = false;
15947 int temp_scroll_step = 0;
15948 ptrdiff_t count = SPECPDL_INDEX ();
15949 int rc;
15950 int centering_position = -1;
15951 int last_line_misfit = 0;
15952 ptrdiff_t beg_unchanged, end_unchanged;
15953 int frame_line_height;
15955 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15956 opoint = lpoint;
15958 #ifdef GLYPH_DEBUG
15959 *w->desired_matrix->method = 0;
15960 #endif
15962 if (!just_this_one_p
15963 && REDISPLAY_SOME_P ()
15964 && !w->redisplay
15965 && !f->redisplay
15966 && !buffer->text->redisplay
15967 && BUF_PT (buffer) == w->last_point)
15968 return;
15970 /* Make sure that both W's markers are valid. */
15971 eassert (XMARKER (w->start)->buffer == buffer);
15972 eassert (XMARKER (w->pointm)->buffer == buffer);
15974 /* We come here again if we need to run window-text-change-functions
15975 below. */
15976 restart:
15977 reconsider_clip_changes (w);
15978 frame_line_height = default_line_pixel_height (w);
15980 /* Has the mode line to be updated? */
15981 update_mode_line = (w->update_mode_line
15982 || update_mode_lines
15983 || buffer->clip_changed
15984 || buffer->prevent_redisplay_optimizations_p);
15986 if (!just_this_one_p)
15987 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15988 cleverly elsewhere. */
15989 w->must_be_updated_p = true;
15991 if (MINI_WINDOW_P (w))
15993 if (w == XWINDOW (echo_area_window)
15994 && !NILP (echo_area_buffer[0]))
15996 if (update_mode_line)
15997 /* We may have to update a tty frame's menu bar or a
15998 tool-bar. Example `M-x C-h C-h C-g'. */
15999 goto finish_menu_bars;
16000 else
16001 /* We've already displayed the echo area glyphs in this window. */
16002 goto finish_scroll_bars;
16004 else if ((w != XWINDOW (minibuf_window)
16005 || minibuf_level == 0)
16006 /* When buffer is nonempty, redisplay window normally. */
16007 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
16008 /* Quail displays non-mini buffers in minibuffer window.
16009 In that case, redisplay the window normally. */
16010 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
16012 /* W is a mini-buffer window, but it's not active, so clear
16013 it. */
16014 int yb = window_text_bottom_y (w);
16015 struct glyph_row *row;
16016 int y;
16018 for (y = 0, row = w->desired_matrix->rows;
16019 y < yb;
16020 y += row->height, ++row)
16021 blank_row (w, row, y);
16022 goto finish_scroll_bars;
16025 clear_glyph_matrix (w->desired_matrix);
16028 /* Otherwise set up data on this window; select its buffer and point
16029 value. */
16030 /* Really select the buffer, for the sake of buffer-local
16031 variables. */
16032 set_buffer_internal_1 (XBUFFER (w->contents));
16034 current_matrix_up_to_date_p
16035 = (w->window_end_valid
16036 && !current_buffer->clip_changed
16037 && !current_buffer->prevent_redisplay_optimizations_p
16038 && !window_outdated (w));
16040 /* Run the window-text-change-functions
16041 if it is possible that the text on the screen has changed
16042 (either due to modification of the text, or any other reason). */
16043 if (!current_matrix_up_to_date_p
16044 && !NILP (Vwindow_text_change_functions))
16046 safe_run_hooks (Qwindow_text_change_functions);
16047 goto restart;
16050 beg_unchanged = BEG_UNCHANGED;
16051 end_unchanged = END_UNCHANGED;
16053 SET_TEXT_POS (opoint, PT, PT_BYTE);
16055 specbind (Qinhibit_point_motion_hooks, Qt);
16057 buffer_unchanged_p
16058 = (w->window_end_valid
16059 && !current_buffer->clip_changed
16060 && !window_outdated (w));
16062 /* When windows_or_buffers_changed is non-zero, we can't rely
16063 on the window end being valid, so set it to zero there. */
16064 if (windows_or_buffers_changed)
16066 /* If window starts on a continuation line, maybe adjust the
16067 window start in case the window's width changed. */
16068 if (XMARKER (w->start)->buffer == current_buffer)
16069 compute_window_start_on_continuation_line (w);
16071 w->window_end_valid = false;
16072 /* If so, we also can't rely on current matrix
16073 and should not fool try_cursor_movement below. */
16074 current_matrix_up_to_date_p = false;
16077 /* Some sanity checks. */
16078 CHECK_WINDOW_END (w);
16079 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
16080 emacs_abort ();
16081 if (BYTEPOS (opoint) < CHARPOS (opoint))
16082 emacs_abort ();
16084 if (mode_line_update_needed (w))
16085 update_mode_line = 1;
16087 /* Point refers normally to the selected window. For any other
16088 window, set up appropriate value. */
16089 if (!EQ (window, selected_window))
16091 ptrdiff_t new_pt = marker_position (w->pointm);
16092 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
16093 if (new_pt < BEGV)
16095 new_pt = BEGV;
16096 new_pt_byte = BEGV_BYTE;
16097 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
16099 else if (new_pt > (ZV - 1))
16101 new_pt = ZV;
16102 new_pt_byte = ZV_BYTE;
16103 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
16106 /* We don't use SET_PT so that the point-motion hooks don't run. */
16107 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
16110 /* If any of the character widths specified in the display table
16111 have changed, invalidate the width run cache. It's true that
16112 this may be a bit late to catch such changes, but the rest of
16113 redisplay goes (non-fatally) haywire when the display table is
16114 changed, so why should we worry about doing any better? */
16115 if (current_buffer->width_run_cache
16116 || (current_buffer->base_buffer
16117 && current_buffer->base_buffer->width_run_cache))
16119 struct Lisp_Char_Table *disptab = buffer_display_table ();
16121 if (! disptab_matches_widthtab
16122 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
16124 struct buffer *buf = current_buffer;
16126 if (buf->base_buffer)
16127 buf = buf->base_buffer;
16128 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
16129 recompute_width_table (current_buffer, disptab);
16133 /* If window-start is screwed up, choose a new one. */
16134 if (XMARKER (w->start)->buffer != current_buffer)
16135 goto recenter;
16137 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16139 /* If someone specified a new starting point but did not insist,
16140 check whether it can be used. */
16141 if ((w->optional_new_start || window_frozen_p (w))
16142 && CHARPOS (startp) >= BEGV
16143 && CHARPOS (startp) <= ZV)
16145 ptrdiff_t it_charpos;
16147 w->optional_new_start = 0;
16148 start_display (&it, w, startp);
16149 move_it_to (&it, PT, 0, it.last_visible_y, -1,
16150 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
16151 /* Record IT's position now, since line_bottom_y might change
16152 that. */
16153 it_charpos = IT_CHARPOS (it);
16154 /* Make sure we set the force_start flag only if the cursor row
16155 will be fully visible. Otherwise, the code under force_start
16156 label below will try to move point back into view, which is
16157 not what the code which sets optional_new_start wants. */
16158 if ((it.current_y == 0 || line_bottom_y (&it) < it.last_visible_y)
16159 && !w->force_start)
16161 if (it_charpos == PT)
16162 w->force_start = 1;
16163 /* IT may overshoot PT if text at PT is invisible. */
16164 else if (it_charpos > PT && CHARPOS (startp) <= PT)
16165 w->force_start = 1;
16166 #ifdef GLYPH_DEBUG
16167 if (w->force_start)
16169 if (window_frozen_p (w))
16170 debug_method_add (w, "set force_start from frozen window start");
16171 else
16172 debug_method_add (w, "set force_start from optional_new_start");
16174 #endif
16178 force_start:
16180 /* Handle case where place to start displaying has been specified,
16181 unless the specified location is outside the accessible range. */
16182 if (w->force_start)
16184 /* We set this later on if we have to adjust point. */
16185 int new_vpos = -1;
16187 w->force_start = 0;
16188 w->vscroll = 0;
16189 w->window_end_valid = 0;
16191 /* Forget any recorded base line for line number display. */
16192 if (!buffer_unchanged_p)
16193 w->base_line_number = 0;
16195 /* Redisplay the mode line. Select the buffer properly for that.
16196 Also, run the hook window-scroll-functions
16197 because we have scrolled. */
16198 /* Note, we do this after clearing force_start because
16199 if there's an error, it is better to forget about force_start
16200 than to get into an infinite loop calling the hook functions
16201 and having them get more errors. */
16202 if (!update_mode_line
16203 || ! NILP (Vwindow_scroll_functions))
16205 update_mode_line = 1;
16206 w->update_mode_line = 1;
16207 startp = run_window_scroll_functions (window, startp);
16210 if (CHARPOS (startp) < BEGV)
16211 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16212 else if (CHARPOS (startp) > ZV)
16213 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16215 /* Redisplay, then check if cursor has been set during the
16216 redisplay. Give up if new fonts were loaded. */
16217 /* We used to issue a CHECK_MARGINS argument to try_window here,
16218 but this causes scrolling to fail when point begins inside
16219 the scroll margin (bug#148) -- cyd */
16220 if (!try_window (window, startp, 0))
16222 w->force_start = 1;
16223 clear_glyph_matrix (w->desired_matrix);
16224 goto need_larger_matrices;
16227 if (w->cursor.vpos < 0)
16229 /* If point does not appear, try to move point so it does
16230 appear. The desired matrix has been built above, so we
16231 can use it here. */
16232 new_vpos = window_box_height (w) / 2;
16235 if (!cursor_row_fully_visible_p (w, 0, 0))
16237 /* Point does appear, but on a line partly visible at end of window.
16238 Move it back to a fully-visible line. */
16239 new_vpos = window_box_height (w);
16240 /* But if window_box_height suggests a Y coordinate that is
16241 not less than we already have, that line will clearly not
16242 be fully visible, so give up and scroll the display.
16243 This can happen when the default face uses a font whose
16244 dimensions are different from the frame's default
16245 font. */
16246 if (new_vpos >= w->cursor.y)
16248 w->cursor.vpos = -1;
16249 clear_glyph_matrix (w->desired_matrix);
16250 goto try_to_scroll;
16253 else if (w->cursor.vpos >= 0)
16255 /* Some people insist on not letting point enter the scroll
16256 margin, even though this part handles windows that didn't
16257 scroll at all. */
16258 int window_total_lines
16259 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16260 int margin = min (scroll_margin, window_total_lines / 4);
16261 int pixel_margin = margin * frame_line_height;
16262 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16264 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16265 below, which finds the row to move point to, advances by
16266 the Y coordinate of the _next_ row, see the definition of
16267 MATRIX_ROW_BOTTOM_Y. */
16268 if (w->cursor.vpos < margin + header_line)
16270 w->cursor.vpos = -1;
16271 clear_glyph_matrix (w->desired_matrix);
16272 goto try_to_scroll;
16274 else
16276 int window_height = window_box_height (w);
16278 if (header_line)
16279 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16280 if (w->cursor.y >= window_height - pixel_margin)
16282 w->cursor.vpos = -1;
16283 clear_glyph_matrix (w->desired_matrix);
16284 goto try_to_scroll;
16289 /* If we need to move point for either of the above reasons,
16290 now actually do it. */
16291 if (new_vpos >= 0)
16293 struct glyph_row *row;
16295 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16296 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16297 ++row;
16299 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16300 MATRIX_ROW_START_BYTEPOS (row));
16302 if (w != XWINDOW (selected_window))
16303 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16304 else if (current_buffer == old)
16305 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16307 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16309 /* Re-run pre-redisplay-function so it can update the region
16310 according to the new position of point. */
16311 /* Other than the cursor, w's redisplay is done so we can set its
16312 redisplay to false. Also the buffer's redisplay can be set to
16313 false, since propagate_buffer_redisplay should have already
16314 propagated its info to `w' anyway. */
16315 w->redisplay = false;
16316 XBUFFER (w->contents)->text->redisplay = false;
16317 safe__call1 (true, Vpre_redisplay_function, Fcons (window, Qnil));
16319 if (w->redisplay || XBUFFER (w->contents)->text->redisplay)
16321 /* pre-redisplay-function made changes (e.g. move the region)
16322 that require another round of redisplay. */
16323 clear_glyph_matrix (w->desired_matrix);
16324 if (!try_window (window, startp, 0))
16325 goto need_larger_matrices;
16328 if (w->cursor.vpos < 0 || !cursor_row_fully_visible_p (w, 0, 0))
16330 clear_glyph_matrix (w->desired_matrix);
16331 goto try_to_scroll;
16334 #ifdef GLYPH_DEBUG
16335 debug_method_add (w, "forced window start");
16336 #endif
16337 goto done;
16340 /* Handle case where text has not changed, only point, and it has
16341 not moved off the frame, and we are not retrying after hscroll.
16342 (current_matrix_up_to_date_p is nonzero when retrying.) */
16343 if (current_matrix_up_to_date_p
16344 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16345 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16347 switch (rc)
16349 case CURSOR_MOVEMENT_SUCCESS:
16350 used_current_matrix_p = 1;
16351 goto done;
16353 case CURSOR_MOVEMENT_MUST_SCROLL:
16354 goto try_to_scroll;
16356 default:
16357 emacs_abort ();
16360 /* If current starting point was originally the beginning of a line
16361 but no longer is, find a new starting point. */
16362 else if (w->start_at_line_beg
16363 && !(CHARPOS (startp) <= BEGV
16364 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16366 #ifdef GLYPH_DEBUG
16367 debug_method_add (w, "recenter 1");
16368 #endif
16369 goto recenter;
16372 /* Try scrolling with try_window_id. Value is > 0 if update has
16373 been done, it is -1 if we know that the same window start will
16374 not work. It is 0 if unsuccessful for some other reason. */
16375 else if ((tem = try_window_id (w)) != 0)
16377 #ifdef GLYPH_DEBUG
16378 debug_method_add (w, "try_window_id %d", tem);
16379 #endif
16381 if (f->fonts_changed)
16382 goto need_larger_matrices;
16383 if (tem > 0)
16384 goto done;
16386 /* Otherwise try_window_id has returned -1 which means that we
16387 don't want the alternative below this comment to execute. */
16389 else if (CHARPOS (startp) >= BEGV
16390 && CHARPOS (startp) <= ZV
16391 && PT >= CHARPOS (startp)
16392 && (CHARPOS (startp) < ZV
16393 /* Avoid starting at end of buffer. */
16394 || CHARPOS (startp) == BEGV
16395 || !window_outdated (w)))
16397 int d1, d2, d5, d6;
16398 int rtop, rbot;
16400 /* If first window line is a continuation line, and window start
16401 is inside the modified region, but the first change is before
16402 current window start, we must select a new window start.
16404 However, if this is the result of a down-mouse event (e.g. by
16405 extending the mouse-drag-overlay), we don't want to select a
16406 new window start, since that would change the position under
16407 the mouse, resulting in an unwanted mouse-movement rather
16408 than a simple mouse-click. */
16409 if (!w->start_at_line_beg
16410 && NILP (do_mouse_tracking)
16411 && CHARPOS (startp) > BEGV
16412 && CHARPOS (startp) > BEG + beg_unchanged
16413 && CHARPOS (startp) <= Z - end_unchanged
16414 /* Even if w->start_at_line_beg is nil, a new window may
16415 start at a line_beg, since that's how set_buffer_window
16416 sets it. So, we need to check the return value of
16417 compute_window_start_on_continuation_line. (See also
16418 bug#197). */
16419 && XMARKER (w->start)->buffer == current_buffer
16420 && compute_window_start_on_continuation_line (w)
16421 /* It doesn't make sense to force the window start like we
16422 do at label force_start if it is already known that point
16423 will not be fully visible in the resulting window, because
16424 doing so will move point from its correct position
16425 instead of scrolling the window to bring point into view.
16426 See bug#9324. */
16427 && pos_visible_p (w, PT, &d1, &d2, &rtop, &rbot, &d5, &d6)
16428 /* A very tall row could need more than the window height,
16429 in which case we accept that it is partially visible. */
16430 && (rtop != 0) == (rbot != 0))
16432 w->force_start = 1;
16433 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16434 #ifdef GLYPH_DEBUG
16435 debug_method_add (w, "recomputed window start in continuation line");
16436 #endif
16437 goto force_start;
16440 #ifdef GLYPH_DEBUG
16441 debug_method_add (w, "same window start");
16442 #endif
16444 /* Try to redisplay starting at same place as before.
16445 If point has not moved off frame, accept the results. */
16446 if (!current_matrix_up_to_date_p
16447 /* Don't use try_window_reusing_current_matrix in this case
16448 because a window scroll function can have changed the
16449 buffer. */
16450 || !NILP (Vwindow_scroll_functions)
16451 || MINI_WINDOW_P (w)
16452 || !(used_current_matrix_p
16453 = try_window_reusing_current_matrix (w)))
16455 IF_DEBUG (debug_method_add (w, "1"));
16456 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16457 /* -1 means we need to scroll.
16458 0 means we need new matrices, but fonts_changed
16459 is set in that case, so we will detect it below. */
16460 goto try_to_scroll;
16463 if (f->fonts_changed)
16464 goto need_larger_matrices;
16466 if (w->cursor.vpos >= 0)
16468 if (!just_this_one_p
16469 || current_buffer->clip_changed
16470 || BEG_UNCHANGED < CHARPOS (startp))
16471 /* Forget any recorded base line for line number display. */
16472 w->base_line_number = 0;
16474 if (!cursor_row_fully_visible_p (w, 1, 0))
16476 clear_glyph_matrix (w->desired_matrix);
16477 last_line_misfit = 1;
16479 /* Drop through and scroll. */
16480 else
16481 goto done;
16483 else
16484 clear_glyph_matrix (w->desired_matrix);
16487 try_to_scroll:
16489 /* Redisplay the mode line. Select the buffer properly for that. */
16490 if (!update_mode_line)
16492 update_mode_line = 1;
16493 w->update_mode_line = 1;
16496 /* Try to scroll by specified few lines. */
16497 if ((scroll_conservatively
16498 || emacs_scroll_step
16499 || temp_scroll_step
16500 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16501 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16502 && CHARPOS (startp) >= BEGV
16503 && CHARPOS (startp) <= ZV)
16505 /* The function returns -1 if new fonts were loaded, 1 if
16506 successful, 0 if not successful. */
16507 int ss = try_scrolling (window, just_this_one_p,
16508 scroll_conservatively,
16509 emacs_scroll_step,
16510 temp_scroll_step, last_line_misfit);
16511 switch (ss)
16513 case SCROLLING_SUCCESS:
16514 goto done;
16516 case SCROLLING_NEED_LARGER_MATRICES:
16517 goto need_larger_matrices;
16519 case SCROLLING_FAILED:
16520 break;
16522 default:
16523 emacs_abort ();
16527 /* Finally, just choose a place to start which positions point
16528 according to user preferences. */
16530 recenter:
16532 #ifdef GLYPH_DEBUG
16533 debug_method_add (w, "recenter");
16534 #endif
16536 /* Forget any previously recorded base line for line number display. */
16537 if (!buffer_unchanged_p)
16538 w->base_line_number = 0;
16540 /* Determine the window start relative to point. */
16541 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16542 it.current_y = it.last_visible_y;
16543 if (centering_position < 0)
16545 int window_total_lines
16546 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16547 int margin =
16548 scroll_margin > 0
16549 ? min (scroll_margin, window_total_lines / 4)
16550 : 0;
16551 ptrdiff_t margin_pos = CHARPOS (startp);
16552 Lisp_Object aggressive;
16553 int scrolling_up;
16555 /* If there is a scroll margin at the top of the window, find
16556 its character position. */
16557 if (margin
16558 /* Cannot call start_display if startp is not in the
16559 accessible region of the buffer. This can happen when we
16560 have just switched to a different buffer and/or changed
16561 its restriction. In that case, startp is initialized to
16562 the character position 1 (BEGV) because we did not yet
16563 have chance to display the buffer even once. */
16564 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16566 struct it it1;
16567 void *it1data = NULL;
16569 SAVE_IT (it1, it, it1data);
16570 start_display (&it1, w, startp);
16571 move_it_vertically (&it1, margin * frame_line_height);
16572 margin_pos = IT_CHARPOS (it1);
16573 RESTORE_IT (&it, &it, it1data);
16575 scrolling_up = PT > margin_pos;
16576 aggressive =
16577 scrolling_up
16578 ? BVAR (current_buffer, scroll_up_aggressively)
16579 : BVAR (current_buffer, scroll_down_aggressively);
16581 if (!MINI_WINDOW_P (w)
16582 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16584 int pt_offset = 0;
16586 /* Setting scroll-conservatively overrides
16587 scroll-*-aggressively. */
16588 if (!scroll_conservatively && NUMBERP (aggressive))
16590 double float_amount = XFLOATINT (aggressive);
16592 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16593 if (pt_offset == 0 && float_amount > 0)
16594 pt_offset = 1;
16595 if (pt_offset && margin > 0)
16596 margin -= 1;
16598 /* Compute how much to move the window start backward from
16599 point so that point will be displayed where the user
16600 wants it. */
16601 if (scrolling_up)
16603 centering_position = it.last_visible_y;
16604 if (pt_offset)
16605 centering_position -= pt_offset;
16606 centering_position -=
16607 frame_line_height * (1 + margin + (last_line_misfit != 0))
16608 + WINDOW_HEADER_LINE_HEIGHT (w);
16609 /* Don't let point enter the scroll margin near top of
16610 the window. */
16611 if (centering_position < margin * frame_line_height)
16612 centering_position = margin * frame_line_height;
16614 else
16615 centering_position = margin * frame_line_height + pt_offset;
16617 else
16618 /* Set the window start half the height of the window backward
16619 from point. */
16620 centering_position = window_box_height (w) / 2;
16622 move_it_vertically_backward (&it, centering_position);
16624 eassert (IT_CHARPOS (it) >= BEGV);
16626 /* The function move_it_vertically_backward may move over more
16627 than the specified y-distance. If it->w is small, e.g. a
16628 mini-buffer window, we may end up in front of the window's
16629 display area. Start displaying at the start of the line
16630 containing PT in this case. */
16631 if (it.current_y <= 0)
16633 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16634 move_it_vertically_backward (&it, 0);
16635 it.current_y = 0;
16638 it.current_x = it.hpos = 0;
16640 /* Set the window start position here explicitly, to avoid an
16641 infinite loop in case the functions in window-scroll-functions
16642 get errors. */
16643 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16645 /* Run scroll hooks. */
16646 startp = run_window_scroll_functions (window, it.current.pos);
16648 /* Redisplay the window. */
16649 if (!current_matrix_up_to_date_p
16650 || windows_or_buffers_changed
16651 || f->cursor_type_changed
16652 /* Don't use try_window_reusing_current_matrix in this case
16653 because it can have changed the buffer. */
16654 || !NILP (Vwindow_scroll_functions)
16655 || !just_this_one_p
16656 || MINI_WINDOW_P (w)
16657 || !(used_current_matrix_p
16658 = try_window_reusing_current_matrix (w)))
16659 try_window (window, startp, 0);
16661 /* If new fonts have been loaded (due to fontsets), give up. We
16662 have to start a new redisplay since we need to re-adjust glyph
16663 matrices. */
16664 if (f->fonts_changed)
16665 goto need_larger_matrices;
16667 /* If cursor did not appear assume that the middle of the window is
16668 in the first line of the window. Do it again with the next line.
16669 (Imagine a window of height 100, displaying two lines of height
16670 60. Moving back 50 from it->last_visible_y will end in the first
16671 line.) */
16672 if (w->cursor.vpos < 0)
16674 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16676 clear_glyph_matrix (w->desired_matrix);
16677 move_it_by_lines (&it, 1);
16678 try_window (window, it.current.pos, 0);
16680 else if (PT < IT_CHARPOS (it))
16682 clear_glyph_matrix (w->desired_matrix);
16683 move_it_by_lines (&it, -1);
16684 try_window (window, it.current.pos, 0);
16686 else
16688 /* Not much we can do about it. */
16692 /* Consider the following case: Window starts at BEGV, there is
16693 invisible, intangible text at BEGV, so that display starts at
16694 some point START > BEGV. It can happen that we are called with
16695 PT somewhere between BEGV and START. Try to handle that case,
16696 and similar ones. */
16697 if (w->cursor.vpos < 0)
16699 /* First, try locating the proper glyph row for PT. */
16700 struct glyph_row *row =
16701 row_containing_pos (w, PT, w->current_matrix->rows, NULL, 0);
16703 /* Sometimes point is at the beginning of invisible text that is
16704 before the 1st character displayed in the row. In that case,
16705 row_containing_pos fails to find the row, because no glyphs
16706 with appropriate buffer positions are present in the row.
16707 Therefore, we next try to find the row which shows the 1st
16708 position after the invisible text. */
16709 if (!row)
16711 Lisp_Object val =
16712 get_char_property_and_overlay (make_number (PT), Qinvisible,
16713 Qnil, NULL);
16715 if (TEXT_PROP_MEANS_INVISIBLE (val))
16717 ptrdiff_t alt_pos;
16718 Lisp_Object invis_end =
16719 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16720 Qnil, Qnil);
16722 if (NATNUMP (invis_end))
16723 alt_pos = XFASTINT (invis_end);
16724 else
16725 alt_pos = ZV;
16726 row = row_containing_pos (w, alt_pos, w->current_matrix->rows,
16727 NULL, 0);
16730 /* Finally, fall back on the first row of the window after the
16731 header line (if any). This is slightly better than not
16732 displaying the cursor at all. */
16733 if (!row)
16735 row = w->current_matrix->rows;
16736 if (row->mode_line_p)
16737 ++row;
16739 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16742 if (!cursor_row_fully_visible_p (w, 0, 0))
16744 /* If vscroll is enabled, disable it and try again. */
16745 if (w->vscroll)
16747 w->vscroll = 0;
16748 clear_glyph_matrix (w->desired_matrix);
16749 goto recenter;
16752 /* Users who set scroll-conservatively to a large number want
16753 point just above/below the scroll margin. If we ended up
16754 with point's row partially visible, move the window start to
16755 make that row fully visible and out of the margin. */
16756 if (scroll_conservatively > SCROLL_LIMIT)
16758 int window_total_lines
16759 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) * frame_line_height;
16760 int margin =
16761 scroll_margin > 0
16762 ? min (scroll_margin, window_total_lines / 4)
16763 : 0;
16764 int move_down = w->cursor.vpos >= window_total_lines / 2;
16766 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16767 clear_glyph_matrix (w->desired_matrix);
16768 if (1 == try_window (window, it.current.pos,
16769 TRY_WINDOW_CHECK_MARGINS))
16770 goto done;
16773 /* If centering point failed to make the whole line visible,
16774 put point at the top instead. That has to make the whole line
16775 visible, if it can be done. */
16776 if (centering_position == 0)
16777 goto done;
16779 clear_glyph_matrix (w->desired_matrix);
16780 centering_position = 0;
16781 goto recenter;
16784 done:
16786 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16787 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16788 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16790 /* Display the mode line, if we must. */
16791 if ((update_mode_line
16792 /* If window not full width, must redo its mode line
16793 if (a) the window to its side is being redone and
16794 (b) we do a frame-based redisplay. This is a consequence
16795 of how inverted lines are drawn in frame-based redisplay. */
16796 || (!just_this_one_p
16797 && !FRAME_WINDOW_P (f)
16798 && !WINDOW_FULL_WIDTH_P (w))
16799 /* Line number to display. */
16800 || w->base_line_pos > 0
16801 /* Column number is displayed and different from the one displayed. */
16802 || (w->column_number_displayed != -1
16803 && (w->column_number_displayed != current_column ())))
16804 /* This means that the window has a mode line. */
16805 && (WINDOW_WANTS_MODELINE_P (w)
16806 || WINDOW_WANTS_HEADER_LINE_P (w)))
16809 display_mode_lines (w);
16811 /* If mode line height has changed, arrange for a thorough
16812 immediate redisplay using the correct mode line height. */
16813 if (WINDOW_WANTS_MODELINE_P (w)
16814 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16816 f->fonts_changed = 1;
16817 w->mode_line_height = -1;
16818 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16819 = DESIRED_MODE_LINE_HEIGHT (w);
16822 /* If header line height has changed, arrange for a thorough
16823 immediate redisplay using the correct header line height. */
16824 if (WINDOW_WANTS_HEADER_LINE_P (w)
16825 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16827 f->fonts_changed = 1;
16828 w->header_line_height = -1;
16829 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16830 = DESIRED_HEADER_LINE_HEIGHT (w);
16833 if (f->fonts_changed)
16834 goto need_larger_matrices;
16837 if (!line_number_displayed && w->base_line_pos != -1)
16839 w->base_line_pos = 0;
16840 w->base_line_number = 0;
16843 finish_menu_bars:
16845 /* When we reach a frame's selected window, redo the frame's menu bar. */
16846 if (update_mode_line
16847 && EQ (FRAME_SELECTED_WINDOW (f), window))
16849 int redisplay_menu_p = 0;
16851 if (FRAME_WINDOW_P (f))
16853 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16854 || defined (HAVE_NS) || defined (USE_GTK)
16855 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16856 #else
16857 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16858 #endif
16860 else
16861 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16863 if (redisplay_menu_p)
16864 display_menu_bar (w);
16866 #ifdef HAVE_WINDOW_SYSTEM
16867 if (FRAME_WINDOW_P (f))
16869 #if defined (USE_GTK) || defined (HAVE_NS)
16870 if (FRAME_EXTERNAL_TOOL_BAR (f))
16871 redisplay_tool_bar (f);
16872 #else
16873 if (WINDOWP (f->tool_bar_window)
16874 && (FRAME_TOOL_BAR_HEIGHT (f) > 0
16875 || !NILP (Vauto_resize_tool_bars))
16876 && redisplay_tool_bar (f))
16877 ignore_mouse_drag_p = 1;
16878 #endif
16880 #endif
16883 #ifdef HAVE_WINDOW_SYSTEM
16884 if (FRAME_WINDOW_P (f)
16885 && update_window_fringes (w, (just_this_one_p
16886 || (!used_current_matrix_p && !overlay_arrow_seen)
16887 || w->pseudo_window_p)))
16889 update_begin (f);
16890 block_input ();
16891 if (draw_window_fringes (w, 1))
16893 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
16894 x_draw_right_divider (w);
16895 else
16896 x_draw_vertical_border (w);
16898 unblock_input ();
16899 update_end (f);
16902 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
16903 x_draw_bottom_divider (w);
16904 #endif /* HAVE_WINDOW_SYSTEM */
16906 /* We go to this label, with fonts_changed set, if it is
16907 necessary to try again using larger glyph matrices.
16908 We have to redeem the scroll bar even in this case,
16909 because the loop in redisplay_internal expects that. */
16910 need_larger_matrices:
16912 finish_scroll_bars:
16914 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16916 /* Set the thumb's position and size. */
16917 set_vertical_scroll_bar (w);
16919 /* Note that we actually used the scroll bar attached to this
16920 window, so it shouldn't be deleted at the end of redisplay. */
16921 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16922 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16925 /* Restore current_buffer and value of point in it. The window
16926 update may have changed the buffer, so first make sure `opoint'
16927 is still valid (Bug#6177). */
16928 if (CHARPOS (opoint) < BEGV)
16929 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16930 else if (CHARPOS (opoint) > ZV)
16931 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16932 else
16933 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16935 set_buffer_internal_1 (old);
16936 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16937 shorter. This can be caused by log truncation in *Messages*. */
16938 if (CHARPOS (lpoint) <= ZV)
16939 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16941 unbind_to (count, Qnil);
16945 /* Build the complete desired matrix of WINDOW with a window start
16946 buffer position POS.
16948 Value is 1 if successful. It is zero if fonts were loaded during
16949 redisplay which makes re-adjusting glyph matrices necessary, and -1
16950 if point would appear in the scroll margins.
16951 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16952 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16953 set in FLAGS.) */
16956 try_window (Lisp_Object window, struct text_pos pos, int flags)
16958 struct window *w = XWINDOW (window);
16959 struct it it;
16960 struct glyph_row *last_text_row = NULL;
16961 struct frame *f = XFRAME (w->frame);
16962 int frame_line_height = default_line_pixel_height (w);
16964 /* Make POS the new window start. */
16965 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
16967 /* Mark cursor position as unknown. No overlay arrow seen. */
16968 w->cursor.vpos = -1;
16969 overlay_arrow_seen = 0;
16971 /* Initialize iterator and info to start at POS. */
16972 start_display (&it, w, pos);
16974 /* Display all lines of W. */
16975 while (it.current_y < it.last_visible_y)
16977 if (display_line (&it))
16978 last_text_row = it.glyph_row - 1;
16979 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
16980 return 0;
16983 /* Don't let the cursor end in the scroll margins. */
16984 if ((flags & TRY_WINDOW_CHECK_MARGINS)
16985 && !MINI_WINDOW_P (w))
16987 int this_scroll_margin;
16988 int window_total_lines
16989 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16991 if (scroll_margin > 0)
16993 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
16994 this_scroll_margin *= frame_line_height;
16996 else
16997 this_scroll_margin = 0;
16999 if ((w->cursor.y >= 0 /* not vscrolled */
17000 && w->cursor.y < this_scroll_margin
17001 && CHARPOS (pos) > BEGV
17002 && IT_CHARPOS (it) < ZV)
17003 /* rms: considering make_cursor_line_fully_visible_p here
17004 seems to give wrong results. We don't want to recenter
17005 when the last line is partly visible, we want to allow
17006 that case to be handled in the usual way. */
17007 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
17009 w->cursor.vpos = -1;
17010 clear_glyph_matrix (w->desired_matrix);
17011 return -1;
17015 /* If bottom moved off end of frame, change mode line percentage. */
17016 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
17017 w->update_mode_line = 1;
17019 /* Set window_end_pos to the offset of the last character displayed
17020 on the window from the end of current_buffer. Set
17021 window_end_vpos to its row number. */
17022 if (last_text_row)
17024 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
17025 adjust_window_ends (w, last_text_row, 0);
17026 eassert
17027 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
17028 w->window_end_vpos)));
17030 else
17032 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17033 w->window_end_pos = Z - ZV;
17034 w->window_end_vpos = 0;
17037 /* But that is not valid info until redisplay finishes. */
17038 w->window_end_valid = 0;
17039 return 1;
17044 /************************************************************************
17045 Window redisplay reusing current matrix when buffer has not changed
17046 ************************************************************************/
17048 /* Try redisplay of window W showing an unchanged buffer with a
17049 different window start than the last time it was displayed by
17050 reusing its current matrix. Value is non-zero if successful.
17051 W->start is the new window start. */
17053 static int
17054 try_window_reusing_current_matrix (struct window *w)
17056 struct frame *f = XFRAME (w->frame);
17057 struct glyph_row *bottom_row;
17058 struct it it;
17059 struct run run;
17060 struct text_pos start, new_start;
17061 int nrows_scrolled, i;
17062 struct glyph_row *last_text_row;
17063 struct glyph_row *last_reused_text_row;
17064 struct glyph_row *start_row;
17065 int start_vpos, min_y, max_y;
17067 #ifdef GLYPH_DEBUG
17068 if (inhibit_try_window_reusing)
17069 return 0;
17070 #endif
17072 if (/* This function doesn't handle terminal frames. */
17073 !FRAME_WINDOW_P (f)
17074 /* Don't try to reuse the display if windows have been split
17075 or such. */
17076 || windows_or_buffers_changed
17077 || f->cursor_type_changed)
17078 return 0;
17080 /* Can't do this if showing trailing whitespace. */
17081 if (!NILP (Vshow_trailing_whitespace))
17082 return 0;
17084 /* If top-line visibility has changed, give up. */
17085 if (WINDOW_WANTS_HEADER_LINE_P (w)
17086 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
17087 return 0;
17089 /* Give up if old or new display is scrolled vertically. We could
17090 make this function handle this, but right now it doesn't. */
17091 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17092 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
17093 return 0;
17095 /* The variable new_start now holds the new window start. The old
17096 start `start' can be determined from the current matrix. */
17097 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
17098 start = start_row->minpos;
17099 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17101 /* Clear the desired matrix for the display below. */
17102 clear_glyph_matrix (w->desired_matrix);
17104 if (CHARPOS (new_start) <= CHARPOS (start))
17106 /* Don't use this method if the display starts with an ellipsis
17107 displayed for invisible text. It's not easy to handle that case
17108 below, and it's certainly not worth the effort since this is
17109 not a frequent case. */
17110 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
17111 return 0;
17113 IF_DEBUG (debug_method_add (w, "twu1"));
17115 /* Display up to a row that can be reused. The variable
17116 last_text_row is set to the last row displayed that displays
17117 text. Note that it.vpos == 0 if or if not there is a
17118 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17119 start_display (&it, w, new_start);
17120 w->cursor.vpos = -1;
17121 last_text_row = last_reused_text_row = NULL;
17123 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17125 /* If we have reached into the characters in the START row,
17126 that means the line boundaries have changed. So we
17127 can't start copying with the row START. Maybe it will
17128 work to start copying with the following row. */
17129 while (IT_CHARPOS (it) > CHARPOS (start))
17131 /* Advance to the next row as the "start". */
17132 start_row++;
17133 start = start_row->minpos;
17134 /* If there are no more rows to try, or just one, give up. */
17135 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
17136 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
17137 || CHARPOS (start) == ZV)
17139 clear_glyph_matrix (w->desired_matrix);
17140 return 0;
17143 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17145 /* If we have reached alignment, we can copy the rest of the
17146 rows. */
17147 if (IT_CHARPOS (it) == CHARPOS (start)
17148 /* Don't accept "alignment" inside a display vector,
17149 since start_row could have started in the middle of
17150 that same display vector (thus their character
17151 positions match), and we have no way of telling if
17152 that is the case. */
17153 && it.current.dpvec_index < 0)
17154 break;
17156 if (display_line (&it))
17157 last_text_row = it.glyph_row - 1;
17161 /* A value of current_y < last_visible_y means that we stopped
17162 at the previous window start, which in turn means that we
17163 have at least one reusable row. */
17164 if (it.current_y < it.last_visible_y)
17166 struct glyph_row *row;
17168 /* IT.vpos always starts from 0; it counts text lines. */
17169 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
17171 /* Find PT if not already found in the lines displayed. */
17172 if (w->cursor.vpos < 0)
17174 int dy = it.current_y - start_row->y;
17176 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17177 row = row_containing_pos (w, PT, row, NULL, dy);
17178 if (row)
17179 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
17180 dy, nrows_scrolled);
17181 else
17183 clear_glyph_matrix (w->desired_matrix);
17184 return 0;
17188 /* Scroll the display. Do it before the current matrix is
17189 changed. The problem here is that update has not yet
17190 run, i.e. part of the current matrix is not up to date.
17191 scroll_run_hook will clear the cursor, and use the
17192 current matrix to get the height of the row the cursor is
17193 in. */
17194 run.current_y = start_row->y;
17195 run.desired_y = it.current_y;
17196 run.height = it.last_visible_y - it.current_y;
17198 if (run.height > 0 && run.current_y != run.desired_y)
17200 update_begin (f);
17201 FRAME_RIF (f)->update_window_begin_hook (w);
17202 FRAME_RIF (f)->clear_window_mouse_face (w);
17203 FRAME_RIF (f)->scroll_run_hook (w, &run);
17204 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17205 update_end (f);
17208 /* Shift current matrix down by nrows_scrolled lines. */
17209 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17210 rotate_matrix (w->current_matrix,
17211 start_vpos,
17212 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17213 nrows_scrolled);
17215 /* Disable lines that must be updated. */
17216 for (i = 0; i < nrows_scrolled; ++i)
17217 (start_row + i)->enabled_p = false;
17219 /* Re-compute Y positions. */
17220 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17221 max_y = it.last_visible_y;
17222 for (row = start_row + nrows_scrolled;
17223 row < bottom_row;
17224 ++row)
17226 row->y = it.current_y;
17227 row->visible_height = row->height;
17229 if (row->y < min_y)
17230 row->visible_height -= min_y - row->y;
17231 if (row->y + row->height > max_y)
17232 row->visible_height -= row->y + row->height - max_y;
17233 if (row->fringe_bitmap_periodic_p)
17234 row->redraw_fringe_bitmaps_p = 1;
17236 it.current_y += row->height;
17238 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17239 last_reused_text_row = row;
17240 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17241 break;
17244 /* Disable lines in the current matrix which are now
17245 below the window. */
17246 for (++row; row < bottom_row; ++row)
17247 row->enabled_p = row->mode_line_p = 0;
17250 /* Update window_end_pos etc.; last_reused_text_row is the last
17251 reused row from the current matrix containing text, if any.
17252 The value of last_text_row is the last displayed line
17253 containing text. */
17254 if (last_reused_text_row)
17255 adjust_window_ends (w, last_reused_text_row, 1);
17256 else if (last_text_row)
17257 adjust_window_ends (w, last_text_row, 0);
17258 else
17260 /* This window must be completely empty. */
17261 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17262 w->window_end_pos = Z - ZV;
17263 w->window_end_vpos = 0;
17265 w->window_end_valid = 0;
17267 /* Update hint: don't try scrolling again in update_window. */
17268 w->desired_matrix->no_scrolling_p = 1;
17270 #ifdef GLYPH_DEBUG
17271 debug_method_add (w, "try_window_reusing_current_matrix 1");
17272 #endif
17273 return 1;
17275 else if (CHARPOS (new_start) > CHARPOS (start))
17277 struct glyph_row *pt_row, *row;
17278 struct glyph_row *first_reusable_row;
17279 struct glyph_row *first_row_to_display;
17280 int dy;
17281 int yb = window_text_bottom_y (w);
17283 /* Find the row starting at new_start, if there is one. Don't
17284 reuse a partially visible line at the end. */
17285 first_reusable_row = start_row;
17286 while (first_reusable_row->enabled_p
17287 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17288 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17289 < CHARPOS (new_start)))
17290 ++first_reusable_row;
17292 /* Give up if there is no row to reuse. */
17293 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17294 || !first_reusable_row->enabled_p
17295 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17296 != CHARPOS (new_start)))
17297 return 0;
17299 /* We can reuse fully visible rows beginning with
17300 first_reusable_row to the end of the window. Set
17301 first_row_to_display to the first row that cannot be reused.
17302 Set pt_row to the row containing point, if there is any. */
17303 pt_row = NULL;
17304 for (first_row_to_display = first_reusable_row;
17305 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17306 ++first_row_to_display)
17308 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17309 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17310 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17311 && first_row_to_display->ends_at_zv_p
17312 && pt_row == NULL)))
17313 pt_row = first_row_to_display;
17316 /* Start displaying at the start of first_row_to_display. */
17317 eassert (first_row_to_display->y < yb);
17318 init_to_row_start (&it, w, first_row_to_display);
17320 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17321 - start_vpos);
17322 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17323 - nrows_scrolled);
17324 it.current_y = (first_row_to_display->y - first_reusable_row->y
17325 + WINDOW_HEADER_LINE_HEIGHT (w));
17327 /* Display lines beginning with first_row_to_display in the
17328 desired matrix. Set last_text_row to the last row displayed
17329 that displays text. */
17330 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17331 if (pt_row == NULL)
17332 w->cursor.vpos = -1;
17333 last_text_row = NULL;
17334 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17335 if (display_line (&it))
17336 last_text_row = it.glyph_row - 1;
17338 /* If point is in a reused row, adjust y and vpos of the cursor
17339 position. */
17340 if (pt_row)
17342 w->cursor.vpos -= nrows_scrolled;
17343 w->cursor.y -= first_reusable_row->y - start_row->y;
17346 /* Give up if point isn't in a row displayed or reused. (This
17347 also handles the case where w->cursor.vpos < nrows_scrolled
17348 after the calls to display_line, which can happen with scroll
17349 margins. See bug#1295.) */
17350 if (w->cursor.vpos < 0)
17352 clear_glyph_matrix (w->desired_matrix);
17353 return 0;
17356 /* Scroll the display. */
17357 run.current_y = first_reusable_row->y;
17358 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17359 run.height = it.last_visible_y - run.current_y;
17360 dy = run.current_y - run.desired_y;
17362 if (run.height)
17364 update_begin (f);
17365 FRAME_RIF (f)->update_window_begin_hook (w);
17366 FRAME_RIF (f)->clear_window_mouse_face (w);
17367 FRAME_RIF (f)->scroll_run_hook (w, &run);
17368 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17369 update_end (f);
17372 /* Adjust Y positions of reused rows. */
17373 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17374 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17375 max_y = it.last_visible_y;
17376 for (row = first_reusable_row; row < first_row_to_display; ++row)
17378 row->y -= dy;
17379 row->visible_height = row->height;
17380 if (row->y < min_y)
17381 row->visible_height -= min_y - row->y;
17382 if (row->y + row->height > max_y)
17383 row->visible_height -= row->y + row->height - max_y;
17384 if (row->fringe_bitmap_periodic_p)
17385 row->redraw_fringe_bitmaps_p = 1;
17388 /* Scroll the current matrix. */
17389 eassert (nrows_scrolled > 0);
17390 rotate_matrix (w->current_matrix,
17391 start_vpos,
17392 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17393 -nrows_scrolled);
17395 /* Disable rows not reused. */
17396 for (row -= nrows_scrolled; row < bottom_row; ++row)
17397 row->enabled_p = false;
17399 /* Point may have moved to a different line, so we cannot assume that
17400 the previous cursor position is valid; locate the correct row. */
17401 if (pt_row)
17403 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17404 row < bottom_row
17405 && PT >= MATRIX_ROW_END_CHARPOS (row)
17406 && !row->ends_at_zv_p;
17407 row++)
17409 w->cursor.vpos++;
17410 w->cursor.y = row->y;
17412 if (row < bottom_row)
17414 /* Can't simply scan the row for point with
17415 bidi-reordered glyph rows. Let set_cursor_from_row
17416 figure out where to put the cursor, and if it fails,
17417 give up. */
17418 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17420 if (!set_cursor_from_row (w, row, w->current_matrix,
17421 0, 0, 0, 0))
17423 clear_glyph_matrix (w->desired_matrix);
17424 return 0;
17427 else
17429 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17430 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17432 for (; glyph < end
17433 && (!BUFFERP (glyph->object)
17434 || glyph->charpos < PT);
17435 glyph++)
17437 w->cursor.hpos++;
17438 w->cursor.x += glyph->pixel_width;
17444 /* Adjust window end. A null value of last_text_row means that
17445 the window end is in reused rows which in turn means that
17446 only its vpos can have changed. */
17447 if (last_text_row)
17448 adjust_window_ends (w, last_text_row, 0);
17449 else
17450 w->window_end_vpos -= nrows_scrolled;
17452 w->window_end_valid = 0;
17453 w->desired_matrix->no_scrolling_p = 1;
17455 #ifdef GLYPH_DEBUG
17456 debug_method_add (w, "try_window_reusing_current_matrix 2");
17457 #endif
17458 return 1;
17461 return 0;
17466 /************************************************************************
17467 Window redisplay reusing current matrix when buffer has changed
17468 ************************************************************************/
17470 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17471 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17472 ptrdiff_t *, ptrdiff_t *);
17473 static struct glyph_row *
17474 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17475 struct glyph_row *);
17478 /* Return the last row in MATRIX displaying text. If row START is
17479 non-null, start searching with that row. IT gives the dimensions
17480 of the display. Value is null if matrix is empty; otherwise it is
17481 a pointer to the row found. */
17483 static struct glyph_row *
17484 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17485 struct glyph_row *start)
17487 struct glyph_row *row, *row_found;
17489 /* Set row_found to the last row in IT->w's current matrix
17490 displaying text. The loop looks funny but think of partially
17491 visible lines. */
17492 row_found = NULL;
17493 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17494 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17496 eassert (row->enabled_p);
17497 row_found = row;
17498 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17499 break;
17500 ++row;
17503 return row_found;
17507 /* Return the last row in the current matrix of W that is not affected
17508 by changes at the start of current_buffer that occurred since W's
17509 current matrix was built. Value is null if no such row exists.
17511 BEG_UNCHANGED us the number of characters unchanged at the start of
17512 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17513 first changed character in current_buffer. Characters at positions <
17514 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17515 when the current matrix was built. */
17517 static struct glyph_row *
17518 find_last_unchanged_at_beg_row (struct window *w)
17520 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17521 struct glyph_row *row;
17522 struct glyph_row *row_found = NULL;
17523 int yb = window_text_bottom_y (w);
17525 /* Find the last row displaying unchanged text. */
17526 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17527 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17528 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17529 ++row)
17531 if (/* If row ends before first_changed_pos, it is unchanged,
17532 except in some case. */
17533 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17534 /* When row ends in ZV and we write at ZV it is not
17535 unchanged. */
17536 && !row->ends_at_zv_p
17537 /* When first_changed_pos is the end of a continued line,
17538 row is not unchanged because it may be no longer
17539 continued. */
17540 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17541 && (row->continued_p
17542 || row->exact_window_width_line_p))
17543 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17544 needs to be recomputed, so don't consider this row as
17545 unchanged. This happens when the last line was
17546 bidi-reordered and was killed immediately before this
17547 redisplay cycle. In that case, ROW->end stores the
17548 buffer position of the first visual-order character of
17549 the killed text, which is now beyond ZV. */
17550 && CHARPOS (row->end.pos) <= ZV)
17551 row_found = row;
17553 /* Stop if last visible row. */
17554 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17555 break;
17558 return row_found;
17562 /* Find the first glyph row in the current matrix of W that is not
17563 affected by changes at the end of current_buffer since the
17564 time W's current matrix was built.
17566 Return in *DELTA the number of chars by which buffer positions in
17567 unchanged text at the end of current_buffer must be adjusted.
17569 Return in *DELTA_BYTES the corresponding number of bytes.
17571 Value is null if no such row exists, i.e. all rows are affected by
17572 changes. */
17574 static struct glyph_row *
17575 find_first_unchanged_at_end_row (struct window *w,
17576 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17578 struct glyph_row *row;
17579 struct glyph_row *row_found = NULL;
17581 *delta = *delta_bytes = 0;
17583 /* Display must not have been paused, otherwise the current matrix
17584 is not up to date. */
17585 eassert (w->window_end_valid);
17587 /* A value of window_end_pos >= END_UNCHANGED means that the window
17588 end is in the range of changed text. If so, there is no
17589 unchanged row at the end of W's current matrix. */
17590 if (w->window_end_pos >= END_UNCHANGED)
17591 return NULL;
17593 /* Set row to the last row in W's current matrix displaying text. */
17594 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17596 /* If matrix is entirely empty, no unchanged row exists. */
17597 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17599 /* The value of row is the last glyph row in the matrix having a
17600 meaningful buffer position in it. The end position of row
17601 corresponds to window_end_pos. This allows us to translate
17602 buffer positions in the current matrix to current buffer
17603 positions for characters not in changed text. */
17604 ptrdiff_t Z_old =
17605 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17606 ptrdiff_t Z_BYTE_old =
17607 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17608 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17609 struct glyph_row *first_text_row
17610 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17612 *delta = Z - Z_old;
17613 *delta_bytes = Z_BYTE - Z_BYTE_old;
17615 /* Set last_unchanged_pos to the buffer position of the last
17616 character in the buffer that has not been changed. Z is the
17617 index + 1 of the last character in current_buffer, i.e. by
17618 subtracting END_UNCHANGED we get the index of the last
17619 unchanged character, and we have to add BEG to get its buffer
17620 position. */
17621 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17622 last_unchanged_pos_old = last_unchanged_pos - *delta;
17624 /* Search backward from ROW for a row displaying a line that
17625 starts at a minimum position >= last_unchanged_pos_old. */
17626 for (; row > first_text_row; --row)
17628 /* This used to abort, but it can happen.
17629 It is ok to just stop the search instead here. KFS. */
17630 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17631 break;
17633 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17634 row_found = row;
17638 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17640 return row_found;
17644 /* Make sure that glyph rows in the current matrix of window W
17645 reference the same glyph memory as corresponding rows in the
17646 frame's frame matrix. This function is called after scrolling W's
17647 current matrix on a terminal frame in try_window_id and
17648 try_window_reusing_current_matrix. */
17650 static void
17651 sync_frame_with_window_matrix_rows (struct window *w)
17653 struct frame *f = XFRAME (w->frame);
17654 struct glyph_row *window_row, *window_row_end, *frame_row;
17656 /* Preconditions: W must be a leaf window and full-width. Its frame
17657 must have a frame matrix. */
17658 eassert (BUFFERP (w->contents));
17659 eassert (WINDOW_FULL_WIDTH_P (w));
17660 eassert (!FRAME_WINDOW_P (f));
17662 /* If W is a full-width window, glyph pointers in W's current matrix
17663 have, by definition, to be the same as glyph pointers in the
17664 corresponding frame matrix. Note that frame matrices have no
17665 marginal areas (see build_frame_matrix). */
17666 window_row = w->current_matrix->rows;
17667 window_row_end = window_row + w->current_matrix->nrows;
17668 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17669 while (window_row < window_row_end)
17671 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17672 struct glyph *end = window_row->glyphs[LAST_AREA];
17674 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17675 frame_row->glyphs[TEXT_AREA] = start;
17676 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17677 frame_row->glyphs[LAST_AREA] = end;
17679 /* Disable frame rows whose corresponding window rows have
17680 been disabled in try_window_id. */
17681 if (!window_row->enabled_p)
17682 frame_row->enabled_p = false;
17684 ++window_row, ++frame_row;
17689 /* Find the glyph row in window W containing CHARPOS. Consider all
17690 rows between START and END (not inclusive). END null means search
17691 all rows to the end of the display area of W. Value is the row
17692 containing CHARPOS or null. */
17694 struct glyph_row *
17695 row_containing_pos (struct window *w, ptrdiff_t charpos,
17696 struct glyph_row *start, struct glyph_row *end, int dy)
17698 struct glyph_row *row = start;
17699 struct glyph_row *best_row = NULL;
17700 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17701 int last_y;
17703 /* If we happen to start on a header-line, skip that. */
17704 if (row->mode_line_p)
17705 ++row;
17707 if ((end && row >= end) || !row->enabled_p)
17708 return NULL;
17710 last_y = window_text_bottom_y (w) - dy;
17712 while (1)
17714 /* Give up if we have gone too far. */
17715 if (end && row >= end)
17716 return NULL;
17717 /* This formerly returned if they were equal.
17718 I think that both quantities are of a "last plus one" type;
17719 if so, when they are equal, the row is within the screen. -- rms. */
17720 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17721 return NULL;
17723 /* If it is in this row, return this row. */
17724 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17725 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17726 /* The end position of a row equals the start
17727 position of the next row. If CHARPOS is there, we
17728 would rather consider it displayed in the next
17729 line, except when this line ends in ZV. */
17730 && !row_for_charpos_p (row, charpos)))
17731 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17733 struct glyph *g;
17735 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17736 || (!best_row && !row->continued_p))
17737 return row;
17738 /* In bidi-reordered rows, there could be several rows whose
17739 edges surround CHARPOS, all of these rows belonging to
17740 the same continued line. We need to find the row which
17741 fits CHARPOS the best. */
17742 for (g = row->glyphs[TEXT_AREA];
17743 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17744 g++)
17746 if (!STRINGP (g->object))
17748 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17750 mindif = eabs (g->charpos - charpos);
17751 best_row = row;
17752 /* Exact match always wins. */
17753 if (mindif == 0)
17754 return best_row;
17759 else if (best_row && !row->continued_p)
17760 return best_row;
17761 ++row;
17766 /* Try to redisplay window W by reusing its existing display. W's
17767 current matrix must be up to date when this function is called,
17768 i.e. window_end_valid must be nonzero.
17770 Value is
17772 >= 1 if successful, i.e. display has been updated
17773 specifically:
17774 1 means the changes were in front of a newline that precedes
17775 the window start, and the whole current matrix was reused
17776 2 means the changes were after the last position displayed
17777 in the window, and the whole current matrix was reused
17778 3 means portions of the current matrix were reused, while
17779 some of the screen lines were redrawn
17780 -1 if redisplay with same window start is known not to succeed
17781 0 if otherwise unsuccessful
17783 The following steps are performed:
17785 1. Find the last row in the current matrix of W that is not
17786 affected by changes at the start of current_buffer. If no such row
17787 is found, give up.
17789 2. Find the first row in W's current matrix that is not affected by
17790 changes at the end of current_buffer. Maybe there is no such row.
17792 3. Display lines beginning with the row + 1 found in step 1 to the
17793 row found in step 2 or, if step 2 didn't find a row, to the end of
17794 the window.
17796 4. If cursor is not known to appear on the window, give up.
17798 5. If display stopped at the row found in step 2, scroll the
17799 display and current matrix as needed.
17801 6. Maybe display some lines at the end of W, if we must. This can
17802 happen under various circumstances, like a partially visible line
17803 becoming fully visible, or because newly displayed lines are displayed
17804 in smaller font sizes.
17806 7. Update W's window end information. */
17808 static int
17809 try_window_id (struct window *w)
17811 struct frame *f = XFRAME (w->frame);
17812 struct glyph_matrix *current_matrix = w->current_matrix;
17813 struct glyph_matrix *desired_matrix = w->desired_matrix;
17814 struct glyph_row *last_unchanged_at_beg_row;
17815 struct glyph_row *first_unchanged_at_end_row;
17816 struct glyph_row *row;
17817 struct glyph_row *bottom_row;
17818 int bottom_vpos;
17819 struct it it;
17820 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17821 int dvpos, dy;
17822 struct text_pos start_pos;
17823 struct run run;
17824 int first_unchanged_at_end_vpos = 0;
17825 struct glyph_row *last_text_row, *last_text_row_at_end;
17826 struct text_pos start;
17827 ptrdiff_t first_changed_charpos, last_changed_charpos;
17829 #ifdef GLYPH_DEBUG
17830 if (inhibit_try_window_id)
17831 return 0;
17832 #endif
17834 /* This is handy for debugging. */
17835 #if 0
17836 #define GIVE_UP(X) \
17837 do { \
17838 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17839 return 0; \
17840 } while (0)
17841 #else
17842 #define GIVE_UP(X) return 0
17843 #endif
17845 SET_TEXT_POS_FROM_MARKER (start, w->start);
17847 /* Don't use this for mini-windows because these can show
17848 messages and mini-buffers, and we don't handle that here. */
17849 if (MINI_WINDOW_P (w))
17850 GIVE_UP (1);
17852 /* This flag is used to prevent redisplay optimizations. */
17853 if (windows_or_buffers_changed || f->cursor_type_changed)
17854 GIVE_UP (2);
17856 /* This function's optimizations cannot be used if overlays have
17857 changed in the buffer displayed by the window, so give up if they
17858 have. */
17859 if (w->last_overlay_modified != OVERLAY_MODIFF)
17860 GIVE_UP (21);
17862 /* Verify that narrowing has not changed.
17863 Also verify that we were not told to prevent redisplay optimizations.
17864 It would be nice to further
17865 reduce the number of cases where this prevents try_window_id. */
17866 if (current_buffer->clip_changed
17867 || current_buffer->prevent_redisplay_optimizations_p)
17868 GIVE_UP (3);
17870 /* Window must either use window-based redisplay or be full width. */
17871 if (!FRAME_WINDOW_P (f)
17872 && (!FRAME_LINE_INS_DEL_OK (f)
17873 || !WINDOW_FULL_WIDTH_P (w)))
17874 GIVE_UP (4);
17876 /* Give up if point is known NOT to appear in W. */
17877 if (PT < CHARPOS (start))
17878 GIVE_UP (5);
17880 /* Another way to prevent redisplay optimizations. */
17881 if (w->last_modified == 0)
17882 GIVE_UP (6);
17884 /* Verify that window is not hscrolled. */
17885 if (w->hscroll != 0)
17886 GIVE_UP (7);
17888 /* Verify that display wasn't paused. */
17889 if (!w->window_end_valid)
17890 GIVE_UP (8);
17892 /* Likewise if highlighting trailing whitespace. */
17893 if (!NILP (Vshow_trailing_whitespace))
17894 GIVE_UP (11);
17896 /* Can't use this if overlay arrow position and/or string have
17897 changed. */
17898 if (overlay_arrows_changed_p ())
17899 GIVE_UP (12);
17901 /* When word-wrap is on, adding a space to the first word of a
17902 wrapped line can change the wrap position, altering the line
17903 above it. It might be worthwhile to handle this more
17904 intelligently, but for now just redisplay from scratch. */
17905 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
17906 GIVE_UP (21);
17908 /* Under bidi reordering, adding or deleting a character in the
17909 beginning of a paragraph, before the first strong directional
17910 character, can change the base direction of the paragraph (unless
17911 the buffer specifies a fixed paragraph direction), which will
17912 require to redisplay the whole paragraph. It might be worthwhile
17913 to find the paragraph limits and widen the range of redisplayed
17914 lines to that, but for now just give up this optimization and
17915 redisplay from scratch. */
17916 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17917 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
17918 GIVE_UP (22);
17920 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17921 only if buffer has really changed. The reason is that the gap is
17922 initially at Z for freshly visited files. The code below would
17923 set end_unchanged to 0 in that case. */
17924 if (MODIFF > SAVE_MODIFF
17925 /* This seems to happen sometimes after saving a buffer. */
17926 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17928 if (GPT - BEG < BEG_UNCHANGED)
17929 BEG_UNCHANGED = GPT - BEG;
17930 if (Z - GPT < END_UNCHANGED)
17931 END_UNCHANGED = Z - GPT;
17934 /* The position of the first and last character that has been changed. */
17935 first_changed_charpos = BEG + BEG_UNCHANGED;
17936 last_changed_charpos = Z - END_UNCHANGED;
17938 /* If window starts after a line end, and the last change is in
17939 front of that newline, then changes don't affect the display.
17940 This case happens with stealth-fontification. Note that although
17941 the display is unchanged, glyph positions in the matrix have to
17942 be adjusted, of course. */
17943 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17944 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17945 && ((last_changed_charpos < CHARPOS (start)
17946 && CHARPOS (start) == BEGV)
17947 || (last_changed_charpos < CHARPOS (start) - 1
17948 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17950 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17951 struct glyph_row *r0;
17953 /* Compute how many chars/bytes have been added to or removed
17954 from the buffer. */
17955 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17956 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17957 Z_delta = Z - Z_old;
17958 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
17960 /* Give up if PT is not in the window. Note that it already has
17961 been checked at the start of try_window_id that PT is not in
17962 front of the window start. */
17963 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
17964 GIVE_UP (13);
17966 /* If window start is unchanged, we can reuse the whole matrix
17967 as is, after adjusting glyph positions. No need to compute
17968 the window end again, since its offset from Z hasn't changed. */
17969 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17970 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
17971 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
17972 /* PT must not be in a partially visible line. */
17973 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
17974 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17976 /* Adjust positions in the glyph matrix. */
17977 if (Z_delta || Z_delta_bytes)
17979 struct glyph_row *r1
17980 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17981 increment_matrix_positions (w->current_matrix,
17982 MATRIX_ROW_VPOS (r0, current_matrix),
17983 MATRIX_ROW_VPOS (r1, current_matrix),
17984 Z_delta, Z_delta_bytes);
17987 /* Set the cursor. */
17988 row = row_containing_pos (w, PT, r0, NULL, 0);
17989 if (row)
17990 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17991 return 1;
17995 /* Handle the case that changes are all below what is displayed in
17996 the window, and that PT is in the window. This shortcut cannot
17997 be taken if ZV is visible in the window, and text has been added
17998 there that is visible in the window. */
17999 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
18000 /* ZV is not visible in the window, or there are no
18001 changes at ZV, actually. */
18002 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
18003 || first_changed_charpos == last_changed_charpos))
18005 struct glyph_row *r0;
18007 /* Give up if PT is not in the window. Note that it already has
18008 been checked at the start of try_window_id that PT is not in
18009 front of the window start. */
18010 if (PT >= MATRIX_ROW_END_CHARPOS (row))
18011 GIVE_UP (14);
18013 /* If window start is unchanged, we can reuse the whole matrix
18014 as is, without changing glyph positions since no text has
18015 been added/removed in front of the window end. */
18016 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
18017 if (TEXT_POS_EQUAL_P (start, r0->minpos)
18018 /* PT must not be in a partially visible line. */
18019 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
18020 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
18022 /* We have to compute the window end anew since text
18023 could have been added/removed after it. */
18024 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18025 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18027 /* Set the cursor. */
18028 row = row_containing_pos (w, PT, r0, NULL, 0);
18029 if (row)
18030 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
18031 return 2;
18035 /* Give up if window start is in the changed area.
18037 The condition used to read
18039 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18041 but why that was tested escapes me at the moment. */
18042 if (CHARPOS (start) >= first_changed_charpos
18043 && CHARPOS (start) <= last_changed_charpos)
18044 GIVE_UP (15);
18046 /* Check that window start agrees with the start of the first glyph
18047 row in its current matrix. Check this after we know the window
18048 start is not in changed text, otherwise positions would not be
18049 comparable. */
18050 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
18051 if (!TEXT_POS_EQUAL_P (start, row->minpos))
18052 GIVE_UP (16);
18054 /* Give up if the window ends in strings. Overlay strings
18055 at the end are difficult to handle, so don't try. */
18056 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
18057 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
18058 GIVE_UP (20);
18060 /* Compute the position at which we have to start displaying new
18061 lines. Some of the lines at the top of the window might be
18062 reusable because they are not displaying changed text. Find the
18063 last row in W's current matrix not affected by changes at the
18064 start of current_buffer. Value is null if changes start in the
18065 first line of window. */
18066 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
18067 if (last_unchanged_at_beg_row)
18069 /* Avoid starting to display in the middle of a character, a TAB
18070 for instance. This is easier than to set up the iterator
18071 exactly, and it's not a frequent case, so the additional
18072 effort wouldn't really pay off. */
18073 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
18074 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
18075 && last_unchanged_at_beg_row > w->current_matrix->rows)
18076 --last_unchanged_at_beg_row;
18078 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
18079 GIVE_UP (17);
18081 if (init_to_row_end (&it, w, last_unchanged_at_beg_row) == 0)
18082 GIVE_UP (18);
18083 start_pos = it.current.pos;
18085 /* Start displaying new lines in the desired matrix at the same
18086 vpos we would use in the current matrix, i.e. below
18087 last_unchanged_at_beg_row. */
18088 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
18089 current_matrix);
18090 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18091 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
18093 eassert (it.hpos == 0 && it.current_x == 0);
18095 else
18097 /* There are no reusable lines at the start of the window.
18098 Start displaying in the first text line. */
18099 start_display (&it, w, start);
18100 it.vpos = it.first_vpos;
18101 start_pos = it.current.pos;
18104 /* Find the first row that is not affected by changes at the end of
18105 the buffer. Value will be null if there is no unchanged row, in
18106 which case we must redisplay to the end of the window. delta
18107 will be set to the value by which buffer positions beginning with
18108 first_unchanged_at_end_row have to be adjusted due to text
18109 changes. */
18110 first_unchanged_at_end_row
18111 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
18112 IF_DEBUG (debug_delta = delta);
18113 IF_DEBUG (debug_delta_bytes = delta_bytes);
18115 /* Set stop_pos to the buffer position up to which we will have to
18116 display new lines. If first_unchanged_at_end_row != NULL, this
18117 is the buffer position of the start of the line displayed in that
18118 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18119 that we don't stop at a buffer position. */
18120 stop_pos = 0;
18121 if (first_unchanged_at_end_row)
18123 eassert (last_unchanged_at_beg_row == NULL
18124 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
18126 /* If this is a continuation line, move forward to the next one
18127 that isn't. Changes in lines above affect this line.
18128 Caution: this may move first_unchanged_at_end_row to a row
18129 not displaying text. */
18130 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
18131 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18132 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18133 < it.last_visible_y))
18134 ++first_unchanged_at_end_row;
18136 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18137 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18138 >= it.last_visible_y))
18139 first_unchanged_at_end_row = NULL;
18140 else
18142 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
18143 + delta);
18144 first_unchanged_at_end_vpos
18145 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
18146 eassert (stop_pos >= Z - END_UNCHANGED);
18149 else if (last_unchanged_at_beg_row == NULL)
18150 GIVE_UP (19);
18153 #ifdef GLYPH_DEBUG
18155 /* Either there is no unchanged row at the end, or the one we have
18156 now displays text. This is a necessary condition for the window
18157 end pos calculation at the end of this function. */
18158 eassert (first_unchanged_at_end_row == NULL
18159 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18161 debug_last_unchanged_at_beg_vpos
18162 = (last_unchanged_at_beg_row
18163 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
18164 : -1);
18165 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
18167 #endif /* GLYPH_DEBUG */
18170 /* Display new lines. Set last_text_row to the last new line
18171 displayed which has text on it, i.e. might end up as being the
18172 line where the window_end_vpos is. */
18173 w->cursor.vpos = -1;
18174 last_text_row = NULL;
18175 overlay_arrow_seen = 0;
18176 while (it.current_y < it.last_visible_y
18177 && !f->fonts_changed
18178 && (first_unchanged_at_end_row == NULL
18179 || IT_CHARPOS (it) < stop_pos))
18181 if (display_line (&it))
18182 last_text_row = it.glyph_row - 1;
18185 if (f->fonts_changed)
18186 return -1;
18189 /* Compute differences in buffer positions, y-positions etc. for
18190 lines reused at the bottom of the window. Compute what we can
18191 scroll. */
18192 if (first_unchanged_at_end_row
18193 /* No lines reused because we displayed everything up to the
18194 bottom of the window. */
18195 && it.current_y < it.last_visible_y)
18197 dvpos = (it.vpos
18198 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
18199 current_matrix));
18200 dy = it.current_y - first_unchanged_at_end_row->y;
18201 run.current_y = first_unchanged_at_end_row->y;
18202 run.desired_y = run.current_y + dy;
18203 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
18205 else
18207 delta = delta_bytes = dvpos = dy
18208 = run.current_y = run.desired_y = run.height = 0;
18209 first_unchanged_at_end_row = NULL;
18211 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
18214 /* Find the cursor if not already found. We have to decide whether
18215 PT will appear on this window (it sometimes doesn't, but this is
18216 not a very frequent case.) This decision has to be made before
18217 the current matrix is altered. A value of cursor.vpos < 0 means
18218 that PT is either in one of the lines beginning at
18219 first_unchanged_at_end_row or below the window. Don't care for
18220 lines that might be displayed later at the window end; as
18221 mentioned, this is not a frequent case. */
18222 if (w->cursor.vpos < 0)
18224 /* Cursor in unchanged rows at the top? */
18225 if (PT < CHARPOS (start_pos)
18226 && last_unchanged_at_beg_row)
18228 row = row_containing_pos (w, PT,
18229 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
18230 last_unchanged_at_beg_row + 1, 0);
18231 if (row)
18232 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
18235 /* Start from first_unchanged_at_end_row looking for PT. */
18236 else if (first_unchanged_at_end_row)
18238 row = row_containing_pos (w, PT - delta,
18239 first_unchanged_at_end_row, NULL, 0);
18240 if (row)
18241 set_cursor_from_row (w, row, w->current_matrix, delta,
18242 delta_bytes, dy, dvpos);
18245 /* Give up if cursor was not found. */
18246 if (w->cursor.vpos < 0)
18248 clear_glyph_matrix (w->desired_matrix);
18249 return -1;
18253 /* Don't let the cursor end in the scroll margins. */
18255 int this_scroll_margin, cursor_height;
18256 int frame_line_height = default_line_pixel_height (w);
18257 int window_total_lines
18258 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18260 this_scroll_margin =
18261 max (0, min (scroll_margin, window_total_lines / 4));
18262 this_scroll_margin *= frame_line_height;
18263 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18265 if ((w->cursor.y < this_scroll_margin
18266 && CHARPOS (start) > BEGV)
18267 /* Old redisplay didn't take scroll margin into account at the bottom,
18268 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18269 || (w->cursor.y + (make_cursor_line_fully_visible_p
18270 ? cursor_height + this_scroll_margin
18271 : 1)) > it.last_visible_y)
18273 w->cursor.vpos = -1;
18274 clear_glyph_matrix (w->desired_matrix);
18275 return -1;
18279 /* Scroll the display. Do it before changing the current matrix so
18280 that xterm.c doesn't get confused about where the cursor glyph is
18281 found. */
18282 if (dy && run.height)
18284 update_begin (f);
18286 if (FRAME_WINDOW_P (f))
18288 FRAME_RIF (f)->update_window_begin_hook (w);
18289 FRAME_RIF (f)->clear_window_mouse_face (w);
18290 FRAME_RIF (f)->scroll_run_hook (w, &run);
18291 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
18293 else
18295 /* Terminal frame. In this case, dvpos gives the number of
18296 lines to scroll by; dvpos < 0 means scroll up. */
18297 int from_vpos
18298 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18299 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18300 int end = (WINDOW_TOP_EDGE_LINE (w)
18301 + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0)
18302 + window_internal_height (w));
18304 #if defined (HAVE_GPM) || defined (MSDOS)
18305 x_clear_window_mouse_face (w);
18306 #endif
18307 /* Perform the operation on the screen. */
18308 if (dvpos > 0)
18310 /* Scroll last_unchanged_at_beg_row to the end of the
18311 window down dvpos lines. */
18312 set_terminal_window (f, end);
18314 /* On dumb terminals delete dvpos lines at the end
18315 before inserting dvpos empty lines. */
18316 if (!FRAME_SCROLL_REGION_OK (f))
18317 ins_del_lines (f, end - dvpos, -dvpos);
18319 /* Insert dvpos empty lines in front of
18320 last_unchanged_at_beg_row. */
18321 ins_del_lines (f, from, dvpos);
18323 else if (dvpos < 0)
18325 /* Scroll up last_unchanged_at_beg_vpos to the end of
18326 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18327 set_terminal_window (f, end);
18329 /* Delete dvpos lines in front of
18330 last_unchanged_at_beg_vpos. ins_del_lines will set
18331 the cursor to the given vpos and emit |dvpos| delete
18332 line sequences. */
18333 ins_del_lines (f, from + dvpos, dvpos);
18335 /* On a dumb terminal insert dvpos empty lines at the
18336 end. */
18337 if (!FRAME_SCROLL_REGION_OK (f))
18338 ins_del_lines (f, end + dvpos, -dvpos);
18341 set_terminal_window (f, 0);
18344 update_end (f);
18347 /* Shift reused rows of the current matrix to the right position.
18348 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18349 text. */
18350 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18351 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18352 if (dvpos < 0)
18354 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18355 bottom_vpos, dvpos);
18356 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18357 bottom_vpos);
18359 else if (dvpos > 0)
18361 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18362 bottom_vpos, dvpos);
18363 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18364 first_unchanged_at_end_vpos + dvpos);
18367 /* For frame-based redisplay, make sure that current frame and window
18368 matrix are in sync with respect to glyph memory. */
18369 if (!FRAME_WINDOW_P (f))
18370 sync_frame_with_window_matrix_rows (w);
18372 /* Adjust buffer positions in reused rows. */
18373 if (delta || delta_bytes)
18374 increment_matrix_positions (current_matrix,
18375 first_unchanged_at_end_vpos + dvpos,
18376 bottom_vpos, delta, delta_bytes);
18378 /* Adjust Y positions. */
18379 if (dy)
18380 shift_glyph_matrix (w, current_matrix,
18381 first_unchanged_at_end_vpos + dvpos,
18382 bottom_vpos, dy);
18384 if (first_unchanged_at_end_row)
18386 first_unchanged_at_end_row += dvpos;
18387 if (first_unchanged_at_end_row->y >= it.last_visible_y
18388 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18389 first_unchanged_at_end_row = NULL;
18392 /* If scrolling up, there may be some lines to display at the end of
18393 the window. */
18394 last_text_row_at_end = NULL;
18395 if (dy < 0)
18397 /* Scrolling up can leave for example a partially visible line
18398 at the end of the window to be redisplayed. */
18399 /* Set last_row to the glyph row in the current matrix where the
18400 window end line is found. It has been moved up or down in
18401 the matrix by dvpos. */
18402 int last_vpos = w->window_end_vpos + dvpos;
18403 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18405 /* If last_row is the window end line, it should display text. */
18406 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18408 /* If window end line was partially visible before, begin
18409 displaying at that line. Otherwise begin displaying with the
18410 line following it. */
18411 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18413 init_to_row_start (&it, w, last_row);
18414 it.vpos = last_vpos;
18415 it.current_y = last_row->y;
18417 else
18419 init_to_row_end (&it, w, last_row);
18420 it.vpos = 1 + last_vpos;
18421 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18422 ++last_row;
18425 /* We may start in a continuation line. If so, we have to
18426 get the right continuation_lines_width and current_x. */
18427 it.continuation_lines_width = last_row->continuation_lines_width;
18428 it.hpos = it.current_x = 0;
18430 /* Display the rest of the lines at the window end. */
18431 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18432 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18434 /* Is it always sure that the display agrees with lines in
18435 the current matrix? I don't think so, so we mark rows
18436 displayed invalid in the current matrix by setting their
18437 enabled_p flag to zero. */
18438 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18439 if (display_line (&it))
18440 last_text_row_at_end = it.glyph_row - 1;
18444 /* Update window_end_pos and window_end_vpos. */
18445 if (first_unchanged_at_end_row && !last_text_row_at_end)
18447 /* Window end line if one of the preserved rows from the current
18448 matrix. Set row to the last row displaying text in current
18449 matrix starting at first_unchanged_at_end_row, after
18450 scrolling. */
18451 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18452 row = find_last_row_displaying_text (w->current_matrix, &it,
18453 first_unchanged_at_end_row);
18454 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18455 adjust_window_ends (w, row, 1);
18456 eassert (w->window_end_bytepos >= 0);
18457 IF_DEBUG (debug_method_add (w, "A"));
18459 else if (last_text_row_at_end)
18461 adjust_window_ends (w, last_text_row_at_end, 0);
18462 eassert (w->window_end_bytepos >= 0);
18463 IF_DEBUG (debug_method_add (w, "B"));
18465 else if (last_text_row)
18467 /* We have displayed either to the end of the window or at the
18468 end of the window, i.e. the last row with text is to be found
18469 in the desired matrix. */
18470 adjust_window_ends (w, last_text_row, 0);
18471 eassert (w->window_end_bytepos >= 0);
18473 else if (first_unchanged_at_end_row == NULL
18474 && last_text_row == NULL
18475 && last_text_row_at_end == NULL)
18477 /* Displayed to end of window, but no line containing text was
18478 displayed. Lines were deleted at the end of the window. */
18479 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
18480 int vpos = w->window_end_vpos;
18481 struct glyph_row *current_row = current_matrix->rows + vpos;
18482 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18484 for (row = NULL;
18485 row == NULL && vpos >= first_vpos;
18486 --vpos, --current_row, --desired_row)
18488 if (desired_row->enabled_p)
18490 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18491 row = desired_row;
18493 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18494 row = current_row;
18497 eassert (row != NULL);
18498 w->window_end_vpos = vpos + 1;
18499 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18500 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18501 eassert (w->window_end_bytepos >= 0);
18502 IF_DEBUG (debug_method_add (w, "C"));
18504 else
18505 emacs_abort ();
18507 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18508 debug_end_vpos = w->window_end_vpos));
18510 /* Record that display has not been completed. */
18511 w->window_end_valid = 0;
18512 w->desired_matrix->no_scrolling_p = 1;
18513 return 3;
18515 #undef GIVE_UP
18520 /***********************************************************************
18521 More debugging support
18522 ***********************************************************************/
18524 #ifdef GLYPH_DEBUG
18526 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18527 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18528 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18531 /* Dump the contents of glyph matrix MATRIX on stderr.
18533 GLYPHS 0 means don't show glyph contents.
18534 GLYPHS 1 means show glyphs in short form
18535 GLYPHS > 1 means show glyphs in long form. */
18537 void
18538 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18540 int i;
18541 for (i = 0; i < matrix->nrows; ++i)
18542 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18546 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18547 the glyph row and area where the glyph comes from. */
18549 void
18550 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18552 if (glyph->type == CHAR_GLYPH
18553 || glyph->type == GLYPHLESS_GLYPH)
18555 fprintf (stderr,
18556 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18557 glyph - row->glyphs[TEXT_AREA],
18558 (glyph->type == CHAR_GLYPH
18559 ? 'C'
18560 : 'G'),
18561 glyph->charpos,
18562 (BUFFERP (glyph->object)
18563 ? 'B'
18564 : (STRINGP (glyph->object)
18565 ? 'S'
18566 : (INTEGERP (glyph->object)
18567 ? '0'
18568 : '-'))),
18569 glyph->pixel_width,
18570 glyph->u.ch,
18571 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18572 ? glyph->u.ch
18573 : '.'),
18574 glyph->face_id,
18575 glyph->left_box_line_p,
18576 glyph->right_box_line_p);
18578 else if (glyph->type == STRETCH_GLYPH)
18580 fprintf (stderr,
18581 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18582 glyph - row->glyphs[TEXT_AREA],
18583 'S',
18584 glyph->charpos,
18585 (BUFFERP (glyph->object)
18586 ? 'B'
18587 : (STRINGP (glyph->object)
18588 ? 'S'
18589 : (INTEGERP (glyph->object)
18590 ? '0'
18591 : '-'))),
18592 glyph->pixel_width,
18594 ' ',
18595 glyph->face_id,
18596 glyph->left_box_line_p,
18597 glyph->right_box_line_p);
18599 else if (glyph->type == IMAGE_GLYPH)
18601 fprintf (stderr,
18602 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18603 glyph - row->glyphs[TEXT_AREA],
18604 'I',
18605 glyph->charpos,
18606 (BUFFERP (glyph->object)
18607 ? 'B'
18608 : (STRINGP (glyph->object)
18609 ? 'S'
18610 : (INTEGERP (glyph->object)
18611 ? '0'
18612 : '-'))),
18613 glyph->pixel_width,
18614 glyph->u.img_id,
18615 '.',
18616 glyph->face_id,
18617 glyph->left_box_line_p,
18618 glyph->right_box_line_p);
18620 else if (glyph->type == COMPOSITE_GLYPH)
18622 fprintf (stderr,
18623 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18624 glyph - row->glyphs[TEXT_AREA],
18625 '+',
18626 glyph->charpos,
18627 (BUFFERP (glyph->object)
18628 ? 'B'
18629 : (STRINGP (glyph->object)
18630 ? 'S'
18631 : (INTEGERP (glyph->object)
18632 ? '0'
18633 : '-'))),
18634 glyph->pixel_width,
18635 glyph->u.cmp.id);
18636 if (glyph->u.cmp.automatic)
18637 fprintf (stderr,
18638 "[%d-%d]",
18639 glyph->slice.cmp.from, glyph->slice.cmp.to);
18640 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18641 glyph->face_id,
18642 glyph->left_box_line_p,
18643 glyph->right_box_line_p);
18648 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18649 GLYPHS 0 means don't show glyph contents.
18650 GLYPHS 1 means show glyphs in short form
18651 GLYPHS > 1 means show glyphs in long form. */
18653 void
18654 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18656 if (glyphs != 1)
18658 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18659 fprintf (stderr, "==============================================================================\n");
18661 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18662 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18663 vpos,
18664 MATRIX_ROW_START_CHARPOS (row),
18665 MATRIX_ROW_END_CHARPOS (row),
18666 row->used[TEXT_AREA],
18667 row->contains_overlapping_glyphs_p,
18668 row->enabled_p,
18669 row->truncated_on_left_p,
18670 row->truncated_on_right_p,
18671 row->continued_p,
18672 MATRIX_ROW_CONTINUATION_LINE_P (row),
18673 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18674 row->ends_at_zv_p,
18675 row->fill_line_p,
18676 row->ends_in_middle_of_char_p,
18677 row->starts_in_middle_of_char_p,
18678 row->mouse_face_p,
18679 row->x,
18680 row->y,
18681 row->pixel_width,
18682 row->height,
18683 row->visible_height,
18684 row->ascent,
18685 row->phys_ascent);
18686 /* The next 3 lines should align to "Start" in the header. */
18687 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18688 row->end.overlay_string_index,
18689 row->continuation_lines_width);
18690 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18691 CHARPOS (row->start.string_pos),
18692 CHARPOS (row->end.string_pos));
18693 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18694 row->end.dpvec_index);
18697 if (glyphs > 1)
18699 int area;
18701 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18703 struct glyph *glyph = row->glyphs[area];
18704 struct glyph *glyph_end = glyph + row->used[area];
18706 /* Glyph for a line end in text. */
18707 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18708 ++glyph_end;
18710 if (glyph < glyph_end)
18711 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
18713 for (; glyph < glyph_end; ++glyph)
18714 dump_glyph (row, glyph, area);
18717 else if (glyphs == 1)
18719 int area;
18721 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18723 char *s = alloca (row->used[area] + 4);
18724 int i;
18726 for (i = 0; i < row->used[area]; ++i)
18728 struct glyph *glyph = row->glyphs[area] + i;
18729 if (i == row->used[area] - 1
18730 && area == TEXT_AREA
18731 && INTEGERP (glyph->object)
18732 && glyph->type == CHAR_GLYPH
18733 && glyph->u.ch == ' ')
18735 strcpy (&s[i], "[\\n]");
18736 i += 4;
18738 else if (glyph->type == CHAR_GLYPH
18739 && glyph->u.ch < 0x80
18740 && glyph->u.ch >= ' ')
18741 s[i] = glyph->u.ch;
18742 else
18743 s[i] = '.';
18746 s[i] = '\0';
18747 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18753 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18754 Sdump_glyph_matrix, 0, 1, "p",
18755 doc: /* Dump the current matrix of the selected window to stderr.
18756 Shows contents of glyph row structures. With non-nil
18757 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18758 glyphs in short form, otherwise show glyphs in long form.
18760 Interactively, no argument means show glyphs in short form;
18761 with numeric argument, its value is passed as the GLYPHS flag. */)
18762 (Lisp_Object glyphs)
18764 struct window *w = XWINDOW (selected_window);
18765 struct buffer *buffer = XBUFFER (w->contents);
18767 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18768 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18769 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18770 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18771 fprintf (stderr, "=============================================\n");
18772 dump_glyph_matrix (w->current_matrix,
18773 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18774 return Qnil;
18778 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18779 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* Dump the current glyph matrix of the selected frame to stderr.
18780 Only text-mode frames have frame glyph matrices. */)
18781 (void)
18783 struct frame *f = XFRAME (selected_frame);
18785 if (f->current_matrix)
18786 dump_glyph_matrix (f->current_matrix, 1);
18787 else
18788 fprintf (stderr, "*** This frame doesn't have a frame glyph matrix ***\n");
18789 return Qnil;
18793 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18794 doc: /* Dump glyph row ROW to stderr.
18795 GLYPH 0 means don't dump glyphs.
18796 GLYPH 1 means dump glyphs in short form.
18797 GLYPH > 1 or omitted means dump glyphs in long form. */)
18798 (Lisp_Object row, Lisp_Object glyphs)
18800 struct glyph_matrix *matrix;
18801 EMACS_INT vpos;
18803 CHECK_NUMBER (row);
18804 matrix = XWINDOW (selected_window)->current_matrix;
18805 vpos = XINT (row);
18806 if (vpos >= 0 && vpos < matrix->nrows)
18807 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18808 vpos,
18809 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18810 return Qnil;
18814 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18815 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18816 GLYPH 0 means don't dump glyphs.
18817 GLYPH 1 means dump glyphs in short form.
18818 GLYPH > 1 or omitted means dump glyphs in long form.
18820 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18821 do nothing. */)
18822 (Lisp_Object row, Lisp_Object glyphs)
18824 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18825 struct frame *sf = SELECTED_FRAME ();
18826 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18827 EMACS_INT vpos;
18829 CHECK_NUMBER (row);
18830 vpos = XINT (row);
18831 if (vpos >= 0 && vpos < m->nrows)
18832 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18833 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18834 #endif
18835 return Qnil;
18839 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18840 doc: /* Toggle tracing of redisplay.
18841 With ARG, turn tracing on if and only if ARG is positive. */)
18842 (Lisp_Object arg)
18844 if (NILP (arg))
18845 trace_redisplay_p = !trace_redisplay_p;
18846 else
18848 arg = Fprefix_numeric_value (arg);
18849 trace_redisplay_p = XINT (arg) > 0;
18852 return Qnil;
18856 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18857 doc: /* Like `format', but print result to stderr.
18858 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18859 (ptrdiff_t nargs, Lisp_Object *args)
18861 Lisp_Object s = Fformat (nargs, args);
18862 fprintf (stderr, "%s", SDATA (s));
18863 return Qnil;
18866 #endif /* GLYPH_DEBUG */
18870 /***********************************************************************
18871 Building Desired Matrix Rows
18872 ***********************************************************************/
18874 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18875 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18877 static struct glyph_row *
18878 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18880 struct frame *f = XFRAME (WINDOW_FRAME (w));
18881 struct buffer *buffer = XBUFFER (w->contents);
18882 struct buffer *old = current_buffer;
18883 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18884 int arrow_len = SCHARS (overlay_arrow_string);
18885 const unsigned char *arrow_end = arrow_string + arrow_len;
18886 const unsigned char *p;
18887 struct it it;
18888 bool multibyte_p;
18889 int n_glyphs_before;
18891 set_buffer_temp (buffer);
18892 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18893 it.glyph_row->used[TEXT_AREA] = 0;
18894 SET_TEXT_POS (it.position, 0, 0);
18896 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18897 p = arrow_string;
18898 while (p < arrow_end)
18900 Lisp_Object face, ilisp;
18902 /* Get the next character. */
18903 if (multibyte_p)
18904 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18905 else
18907 it.c = it.char_to_display = *p, it.len = 1;
18908 if (! ASCII_CHAR_P (it.c))
18909 it.char_to_display = BYTE8_TO_CHAR (it.c);
18911 p += it.len;
18913 /* Get its face. */
18914 ilisp = make_number (p - arrow_string);
18915 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18916 it.face_id = compute_char_face (f, it.char_to_display, face);
18918 /* Compute its width, get its glyphs. */
18919 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18920 SET_TEXT_POS (it.position, -1, -1);
18921 PRODUCE_GLYPHS (&it);
18923 /* If this character doesn't fit any more in the line, we have
18924 to remove some glyphs. */
18925 if (it.current_x > it.last_visible_x)
18927 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18928 break;
18932 set_buffer_temp (old);
18933 return it.glyph_row;
18937 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18938 glyphs to insert is determined by produce_special_glyphs. */
18940 static void
18941 insert_left_trunc_glyphs (struct it *it)
18943 struct it truncate_it;
18944 struct glyph *from, *end, *to, *toend;
18946 eassert (!FRAME_WINDOW_P (it->f)
18947 || (!it->glyph_row->reversed_p
18948 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18949 || (it->glyph_row->reversed_p
18950 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
18952 /* Get the truncation glyphs. */
18953 truncate_it = *it;
18954 truncate_it.current_x = 0;
18955 truncate_it.face_id = DEFAULT_FACE_ID;
18956 truncate_it.glyph_row = &scratch_glyph_row;
18957 truncate_it.area = TEXT_AREA;
18958 truncate_it.glyph_row->used[TEXT_AREA] = 0;
18959 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
18960 truncate_it.object = make_number (0);
18961 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
18963 /* Overwrite glyphs from IT with truncation glyphs. */
18964 if (!it->glyph_row->reversed_p)
18966 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18968 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18969 end = from + tused;
18970 to = it->glyph_row->glyphs[TEXT_AREA];
18971 toend = to + it->glyph_row->used[TEXT_AREA];
18972 if (FRAME_WINDOW_P (it->f))
18974 /* On GUI frames, when variable-size fonts are displayed,
18975 the truncation glyphs may need more pixels than the row's
18976 glyphs they overwrite. We overwrite more glyphs to free
18977 enough screen real estate, and enlarge the stretch glyph
18978 on the right (see display_line), if there is one, to
18979 preserve the screen position of the truncation glyphs on
18980 the right. */
18981 int w = 0;
18982 struct glyph *g = to;
18983 short used;
18985 /* The first glyph could be partially visible, in which case
18986 it->glyph_row->x will be negative. But we want the left
18987 truncation glyphs to be aligned at the left margin of the
18988 window, so we override the x coordinate at which the row
18989 will begin. */
18990 it->glyph_row->x = 0;
18991 while (g < toend && w < it->truncation_pixel_width)
18993 w += g->pixel_width;
18994 ++g;
18996 if (g - to - tused > 0)
18998 memmove (to + tused, g, (toend - g) * sizeof(*g));
18999 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
19001 used = it->glyph_row->used[TEXT_AREA];
19002 if (it->glyph_row->truncated_on_right_p
19003 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
19004 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
19005 == STRETCH_GLYPH)
19007 int extra = w - it->truncation_pixel_width;
19009 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
19013 while (from < end)
19014 *to++ = *from++;
19016 /* There may be padding glyphs left over. Overwrite them too. */
19017 if (!FRAME_WINDOW_P (it->f))
19019 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
19021 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
19022 while (from < end)
19023 *to++ = *from++;
19027 if (to > toend)
19028 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
19030 else
19032 short tused = truncate_it.glyph_row->used[TEXT_AREA];
19034 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19035 that back to front. */
19036 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
19037 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19038 toend = it->glyph_row->glyphs[TEXT_AREA];
19039 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
19040 if (FRAME_WINDOW_P (it->f))
19042 int w = 0;
19043 struct glyph *g = to;
19045 while (g >= toend && w < it->truncation_pixel_width)
19047 w += g->pixel_width;
19048 --g;
19050 if (to - g - tused > 0)
19051 to = g + tused;
19052 if (it->glyph_row->truncated_on_right_p
19053 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
19054 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
19056 int extra = w - it->truncation_pixel_width;
19058 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
19062 while (from >= end && to >= toend)
19063 *to-- = *from--;
19064 if (!FRAME_WINDOW_P (it->f))
19066 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
19068 from =
19069 truncate_it.glyph_row->glyphs[TEXT_AREA]
19070 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19071 while (from >= end && to >= toend)
19072 *to-- = *from--;
19075 if (from >= end)
19077 /* Need to free some room before prepending additional
19078 glyphs. */
19079 int move_by = from - end + 1;
19080 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
19081 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
19083 for ( ; g >= g0; g--)
19084 g[move_by] = *g;
19085 while (from >= end)
19086 *to-- = *from--;
19087 it->glyph_row->used[TEXT_AREA] += move_by;
19092 /* Compute the hash code for ROW. */
19093 unsigned
19094 row_hash (struct glyph_row *row)
19096 int area, k;
19097 unsigned hashval = 0;
19099 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19100 for (k = 0; k < row->used[area]; ++k)
19101 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
19102 + row->glyphs[area][k].u.val
19103 + row->glyphs[area][k].face_id
19104 + row->glyphs[area][k].padding_p
19105 + (row->glyphs[area][k].type << 2));
19107 return hashval;
19110 /* Compute the pixel height and width of IT->glyph_row.
19112 Most of the time, ascent and height of a display line will be equal
19113 to the max_ascent and max_height values of the display iterator
19114 structure. This is not the case if
19116 1. We hit ZV without displaying anything. In this case, max_ascent
19117 and max_height will be zero.
19119 2. We have some glyphs that don't contribute to the line height.
19120 (The glyph row flag contributes_to_line_height_p is for future
19121 pixmap extensions).
19123 The first case is easily covered by using default values because in
19124 these cases, the line height does not really matter, except that it
19125 must not be zero. */
19127 static void
19128 compute_line_metrics (struct it *it)
19130 struct glyph_row *row = it->glyph_row;
19132 if (FRAME_WINDOW_P (it->f))
19134 int i, min_y, max_y;
19136 /* The line may consist of one space only, that was added to
19137 place the cursor on it. If so, the row's height hasn't been
19138 computed yet. */
19139 if (row->height == 0)
19141 if (it->max_ascent + it->max_descent == 0)
19142 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
19143 row->ascent = it->max_ascent;
19144 row->height = it->max_ascent + it->max_descent;
19145 row->phys_ascent = it->max_phys_ascent;
19146 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19147 row->extra_line_spacing = it->max_extra_line_spacing;
19150 /* Compute the width of this line. */
19151 row->pixel_width = row->x;
19152 for (i = 0; i < row->used[TEXT_AREA]; ++i)
19153 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
19155 eassert (row->pixel_width >= 0);
19156 eassert (row->ascent >= 0 && row->height > 0);
19158 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
19159 || MATRIX_ROW_OVERLAPS_PRED_P (row));
19161 /* If first line's physical ascent is larger than its logical
19162 ascent, use the physical ascent, and make the row taller.
19163 This makes accented characters fully visible. */
19164 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
19165 && row->phys_ascent > row->ascent)
19167 row->height += row->phys_ascent - row->ascent;
19168 row->ascent = row->phys_ascent;
19171 /* Compute how much of the line is visible. */
19172 row->visible_height = row->height;
19174 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
19175 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
19177 if (row->y < min_y)
19178 row->visible_height -= min_y - row->y;
19179 if (row->y + row->height > max_y)
19180 row->visible_height -= row->y + row->height - max_y;
19182 else
19184 row->pixel_width = row->used[TEXT_AREA];
19185 if (row->continued_p)
19186 row->pixel_width -= it->continuation_pixel_width;
19187 else if (row->truncated_on_right_p)
19188 row->pixel_width -= it->truncation_pixel_width;
19189 row->ascent = row->phys_ascent = 0;
19190 row->height = row->phys_height = row->visible_height = 1;
19191 row->extra_line_spacing = 0;
19194 /* Compute a hash code for this row. */
19195 row->hash = row_hash (row);
19197 it->max_ascent = it->max_descent = 0;
19198 it->max_phys_ascent = it->max_phys_descent = 0;
19202 /* Append one space to the glyph row of iterator IT if doing a
19203 window-based redisplay. The space has the same face as
19204 IT->face_id. Value is non-zero if a space was added.
19206 This function is called to make sure that there is always one glyph
19207 at the end of a glyph row that the cursor can be set on under
19208 window-systems. (If there weren't such a glyph we would not know
19209 how wide and tall a box cursor should be displayed).
19211 At the same time this space let's a nicely handle clearing to the
19212 end of the line if the row ends in italic text. */
19214 static int
19215 append_space_for_newline (struct it *it, int default_face_p)
19217 if (FRAME_WINDOW_P (it->f))
19219 int n = it->glyph_row->used[TEXT_AREA];
19221 if (it->glyph_row->glyphs[TEXT_AREA] + n
19222 < it->glyph_row->glyphs[1 + TEXT_AREA])
19224 /* Save some values that must not be changed.
19225 Must save IT->c and IT->len because otherwise
19226 ITERATOR_AT_END_P wouldn't work anymore after
19227 append_space_for_newline has been called. */
19228 enum display_element_type saved_what = it->what;
19229 int saved_c = it->c, saved_len = it->len;
19230 int saved_char_to_display = it->char_to_display;
19231 int saved_x = it->current_x;
19232 int saved_face_id = it->face_id;
19233 int saved_box_end = it->end_of_box_run_p;
19234 struct text_pos saved_pos;
19235 Lisp_Object saved_object;
19236 struct face *face;
19238 saved_object = it->object;
19239 saved_pos = it->position;
19241 it->what = IT_CHARACTER;
19242 memset (&it->position, 0, sizeof it->position);
19243 it->object = make_number (0);
19244 it->c = it->char_to_display = ' ';
19245 it->len = 1;
19247 /* If the default face was remapped, be sure to use the
19248 remapped face for the appended newline. */
19249 if (default_face_p)
19250 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19251 else if (it->face_before_selective_p)
19252 it->face_id = it->saved_face_id;
19253 face = FACE_FROM_ID (it->f, it->face_id);
19254 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19255 /* In R2L rows, we will prepend a stretch glyph that will
19256 have the end_of_box_run_p flag set for it, so there's no
19257 need for the appended newline glyph to have that flag
19258 set. */
19259 if (it->glyph_row->reversed_p
19260 /* But if the appended newline glyph goes all the way to
19261 the end of the row, there will be no stretch glyph,
19262 so leave the box flag set. */
19263 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19264 it->end_of_box_run_p = 0;
19266 PRODUCE_GLYPHS (it);
19268 it->override_ascent = -1;
19269 it->constrain_row_ascent_descent_p = 0;
19270 it->current_x = saved_x;
19271 it->object = saved_object;
19272 it->position = saved_pos;
19273 it->what = saved_what;
19274 it->face_id = saved_face_id;
19275 it->len = saved_len;
19276 it->c = saved_c;
19277 it->char_to_display = saved_char_to_display;
19278 it->end_of_box_run_p = saved_box_end;
19279 return 1;
19283 return 0;
19287 /* Extend the face of the last glyph in the text area of IT->glyph_row
19288 to the end of the display line. Called from display_line. If the
19289 glyph row is empty, add a space glyph to it so that we know the
19290 face to draw. Set the glyph row flag fill_line_p. If the glyph
19291 row is R2L, prepend a stretch glyph to cover the empty space to the
19292 left of the leftmost glyph. */
19294 static void
19295 extend_face_to_end_of_line (struct it *it)
19297 struct face *face, *default_face;
19298 struct frame *f = it->f;
19300 /* If line is already filled, do nothing. Non window-system frames
19301 get a grace of one more ``pixel'' because their characters are
19302 1-``pixel'' wide, so they hit the equality too early. This grace
19303 is needed only for R2L rows that are not continued, to produce
19304 one extra blank where we could display the cursor. */
19305 if ((it->current_x >= it->last_visible_x
19306 + (!FRAME_WINDOW_P (f)
19307 && it->glyph_row->reversed_p
19308 && !it->glyph_row->continued_p))
19309 /* If the window has display margins, we will need to extend
19310 their face even if the text area is filled. */
19311 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19312 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19313 return;
19315 /* The default face, possibly remapped. */
19316 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
19318 /* Face extension extends the background and box of IT->face_id
19319 to the end of the line. If the background equals the background
19320 of the frame, we don't have to do anything. */
19321 if (it->face_before_selective_p)
19322 face = FACE_FROM_ID (f, it->saved_face_id);
19323 else
19324 face = FACE_FROM_ID (f, it->face_id);
19326 if (FRAME_WINDOW_P (f)
19327 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19328 && face->box == FACE_NO_BOX
19329 && face->background == FRAME_BACKGROUND_PIXEL (f)
19330 #ifdef HAVE_WINDOW_SYSTEM
19331 && !face->stipple
19332 #endif
19333 && !it->glyph_row->reversed_p)
19334 return;
19336 /* Set the glyph row flag indicating that the face of the last glyph
19337 in the text area has to be drawn to the end of the text area. */
19338 it->glyph_row->fill_line_p = 1;
19340 /* If current character of IT is not ASCII, make sure we have the
19341 ASCII face. This will be automatically undone the next time
19342 get_next_display_element returns a multibyte character. Note
19343 that the character will always be single byte in unibyte
19344 text. */
19345 if (!ASCII_CHAR_P (it->c))
19347 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19350 if (FRAME_WINDOW_P (f))
19352 /* If the row is empty, add a space with the current face of IT,
19353 so that we know which face to draw. */
19354 if (it->glyph_row->used[TEXT_AREA] == 0)
19356 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19357 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19358 it->glyph_row->used[TEXT_AREA] = 1;
19360 /* Mode line and the header line don't have margins, and
19361 likewise the frame's tool-bar window, if there is any. */
19362 if (!(it->glyph_row->mode_line_p
19363 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19364 || (WINDOWP (f->tool_bar_window)
19365 && it->w == XWINDOW (f->tool_bar_window))
19366 #endif
19369 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19370 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19372 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19373 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19374 default_face->id;
19375 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19377 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19378 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19380 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19381 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19382 default_face->id;
19383 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19386 #ifdef HAVE_WINDOW_SYSTEM
19387 if (it->glyph_row->reversed_p)
19389 /* Prepend a stretch glyph to the row, such that the
19390 rightmost glyph will be drawn flushed all the way to the
19391 right margin of the window. The stretch glyph that will
19392 occupy the empty space, if any, to the left of the
19393 glyphs. */
19394 struct font *font = face->font ? face->font : FRAME_FONT (f);
19395 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19396 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19397 struct glyph *g;
19398 int row_width, stretch_ascent, stretch_width;
19399 struct text_pos saved_pos;
19400 int saved_face_id, saved_avoid_cursor, saved_box_start;
19402 for (row_width = 0, g = row_start; g < row_end; g++)
19403 row_width += g->pixel_width;
19405 /* FIXME: There are various minor display glitches in R2L
19406 rows when only one of the fringes is missing. The
19407 strange condition below produces the least bad effect. */
19408 if ((WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19409 == (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
19410 || WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
19411 stretch_width = window_box_width (it->w, TEXT_AREA);
19412 else
19413 stretch_width = it->last_visible_x - it->first_visible_x;
19414 stretch_width -= row_width;
19416 if (stretch_width > 0)
19418 stretch_ascent =
19419 (((it->ascent + it->descent)
19420 * FONT_BASE (font)) / FONT_HEIGHT (font));
19421 saved_pos = it->position;
19422 memset (&it->position, 0, sizeof it->position);
19423 saved_avoid_cursor = it->avoid_cursor_p;
19424 it->avoid_cursor_p = 1;
19425 saved_face_id = it->face_id;
19426 saved_box_start = it->start_of_box_run_p;
19427 /* The last row's stretch glyph should get the default
19428 face, to avoid painting the rest of the window with
19429 the region face, if the region ends at ZV. */
19430 if (it->glyph_row->ends_at_zv_p)
19431 it->face_id = default_face->id;
19432 else
19433 it->face_id = face->id;
19434 it->start_of_box_run_p = 0;
19435 append_stretch_glyph (it, make_number (0), stretch_width,
19436 it->ascent + it->descent, stretch_ascent);
19437 it->position = saved_pos;
19438 it->avoid_cursor_p = saved_avoid_cursor;
19439 it->face_id = saved_face_id;
19440 it->start_of_box_run_p = saved_box_start;
19442 /* If stretch_width comes out negative, it means that the
19443 last glyph is only partially visible. In R2L rows, we
19444 want the leftmost glyph to be partially visible, so we
19445 need to give the row the corresponding left offset. */
19446 if (stretch_width < 0)
19447 it->glyph_row->x = stretch_width;
19449 #endif /* HAVE_WINDOW_SYSTEM */
19451 else
19453 /* Save some values that must not be changed. */
19454 int saved_x = it->current_x;
19455 struct text_pos saved_pos;
19456 Lisp_Object saved_object;
19457 enum display_element_type saved_what = it->what;
19458 int saved_face_id = it->face_id;
19460 saved_object = it->object;
19461 saved_pos = it->position;
19463 it->what = IT_CHARACTER;
19464 memset (&it->position, 0, sizeof it->position);
19465 it->object = make_number (0);
19466 it->c = it->char_to_display = ' ';
19467 it->len = 1;
19469 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19470 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19471 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19472 && !it->glyph_row->mode_line_p
19473 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19475 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19476 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19478 for (it->current_x = 0; g < e; g++)
19479 it->current_x += g->pixel_width;
19481 it->area = LEFT_MARGIN_AREA;
19482 it->face_id = default_face->id;
19483 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19484 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19486 PRODUCE_GLYPHS (it);
19487 /* term.c:produce_glyphs advances it->current_x only for
19488 TEXT_AREA. */
19489 it->current_x += it->pixel_width;
19492 it->current_x = saved_x;
19493 it->area = TEXT_AREA;
19496 /* The last row's blank glyphs should get the default face, to
19497 avoid painting the rest of the window with the region face,
19498 if the region ends at ZV. */
19499 if (it->glyph_row->ends_at_zv_p)
19500 it->face_id = default_face->id;
19501 else
19502 it->face_id = face->id;
19503 PRODUCE_GLYPHS (it);
19505 while (it->current_x <= it->last_visible_x)
19506 PRODUCE_GLYPHS (it);
19508 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19509 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19510 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19511 && !it->glyph_row->mode_line_p
19512 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19514 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19515 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19517 for ( ; g < e; g++)
19518 it->current_x += g->pixel_width;
19520 it->area = RIGHT_MARGIN_AREA;
19521 it->face_id = default_face->id;
19522 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19523 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19525 PRODUCE_GLYPHS (it);
19526 it->current_x += it->pixel_width;
19529 it->area = TEXT_AREA;
19532 /* Don't count these blanks really. It would let us insert a left
19533 truncation glyph below and make us set the cursor on them, maybe. */
19534 it->current_x = saved_x;
19535 it->object = saved_object;
19536 it->position = saved_pos;
19537 it->what = saved_what;
19538 it->face_id = saved_face_id;
19543 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19544 trailing whitespace. */
19546 static int
19547 trailing_whitespace_p (ptrdiff_t charpos)
19549 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19550 int c = 0;
19552 while (bytepos < ZV_BYTE
19553 && (c = FETCH_CHAR (bytepos),
19554 c == ' ' || c == '\t'))
19555 ++bytepos;
19557 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19559 if (bytepos != PT_BYTE)
19560 return 1;
19562 return 0;
19566 /* Highlight trailing whitespace, if any, in ROW. */
19568 static void
19569 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19571 int used = row->used[TEXT_AREA];
19573 if (used)
19575 struct glyph *start = row->glyphs[TEXT_AREA];
19576 struct glyph *glyph = start + used - 1;
19578 if (row->reversed_p)
19580 /* Right-to-left rows need to be processed in the opposite
19581 direction, so swap the edge pointers. */
19582 glyph = start;
19583 start = row->glyphs[TEXT_AREA] + used - 1;
19586 /* Skip over glyphs inserted to display the cursor at the
19587 end of a line, for extending the face of the last glyph
19588 to the end of the line on terminals, and for truncation
19589 and continuation glyphs. */
19590 if (!row->reversed_p)
19592 while (glyph >= start
19593 && glyph->type == CHAR_GLYPH
19594 && INTEGERP (glyph->object))
19595 --glyph;
19597 else
19599 while (glyph <= start
19600 && glyph->type == CHAR_GLYPH
19601 && INTEGERP (glyph->object))
19602 ++glyph;
19605 /* If last glyph is a space or stretch, and it's trailing
19606 whitespace, set the face of all trailing whitespace glyphs in
19607 IT->glyph_row to `trailing-whitespace'. */
19608 if ((row->reversed_p ? glyph <= start : glyph >= start)
19609 && BUFFERP (glyph->object)
19610 && (glyph->type == STRETCH_GLYPH
19611 || (glyph->type == CHAR_GLYPH
19612 && glyph->u.ch == ' '))
19613 && trailing_whitespace_p (glyph->charpos))
19615 int face_id = lookup_named_face (f, Qtrailing_whitespace, 0);
19616 if (face_id < 0)
19617 return;
19619 if (!row->reversed_p)
19621 while (glyph >= start
19622 && BUFFERP (glyph->object)
19623 && (glyph->type == STRETCH_GLYPH
19624 || (glyph->type == CHAR_GLYPH
19625 && glyph->u.ch == ' ')))
19626 (glyph--)->face_id = face_id;
19628 else
19630 while (glyph <= start
19631 && BUFFERP (glyph->object)
19632 && (glyph->type == STRETCH_GLYPH
19633 || (glyph->type == CHAR_GLYPH
19634 && glyph->u.ch == ' ')))
19635 (glyph++)->face_id = face_id;
19642 /* Value is non-zero if glyph row ROW should be
19643 considered to hold the buffer position CHARPOS. */
19645 static int
19646 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
19648 int result = 1;
19650 if (charpos == CHARPOS (row->end.pos)
19651 || charpos == MATRIX_ROW_END_CHARPOS (row))
19653 /* Suppose the row ends on a string.
19654 Unless the row is continued, that means it ends on a newline
19655 in the string. If it's anything other than a display string
19656 (e.g., a before-string from an overlay), we don't want the
19657 cursor there. (This heuristic seems to give the optimal
19658 behavior for the various types of multi-line strings.)
19659 One exception: if the string has `cursor' property on one of
19660 its characters, we _do_ want the cursor there. */
19661 if (CHARPOS (row->end.string_pos) >= 0)
19663 if (row->continued_p)
19664 result = 1;
19665 else
19667 /* Check for `display' property. */
19668 struct glyph *beg = row->glyphs[TEXT_AREA];
19669 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
19670 struct glyph *glyph;
19672 result = 0;
19673 for (glyph = end; glyph >= beg; --glyph)
19674 if (STRINGP (glyph->object))
19676 Lisp_Object prop
19677 = Fget_char_property (make_number (charpos),
19678 Qdisplay, Qnil);
19679 result =
19680 (!NILP (prop)
19681 && display_prop_string_p (prop, glyph->object));
19682 /* If there's a `cursor' property on one of the
19683 string's characters, this row is a cursor row,
19684 even though this is not a display string. */
19685 if (!result)
19687 Lisp_Object s = glyph->object;
19689 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
19691 ptrdiff_t gpos = glyph->charpos;
19693 if (!NILP (Fget_char_property (make_number (gpos),
19694 Qcursor, s)))
19696 result = 1;
19697 break;
19701 break;
19705 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
19707 /* If the row ends in middle of a real character,
19708 and the line is continued, we want the cursor here.
19709 That's because CHARPOS (ROW->end.pos) would equal
19710 PT if PT is before the character. */
19711 if (!row->ends_in_ellipsis_p)
19712 result = row->continued_p;
19713 else
19714 /* If the row ends in an ellipsis, then
19715 CHARPOS (ROW->end.pos) will equal point after the
19716 invisible text. We want that position to be displayed
19717 after the ellipsis. */
19718 result = 0;
19720 /* If the row ends at ZV, display the cursor at the end of that
19721 row instead of at the start of the row below. */
19722 else if (row->ends_at_zv_p)
19723 result = 1;
19724 else
19725 result = 0;
19728 return result;
19731 /* Value is non-zero if glyph row ROW should be
19732 used to hold the cursor. */
19734 static int
19735 cursor_row_p (struct glyph_row *row)
19737 return row_for_charpos_p (row, PT);
19742 /* Push the property PROP so that it will be rendered at the current
19743 position in IT. Return 1 if PROP was successfully pushed, 0
19744 otherwise. Called from handle_line_prefix to handle the
19745 `line-prefix' and `wrap-prefix' properties. */
19747 static int
19748 push_prefix_prop (struct it *it, Lisp_Object prop)
19750 struct text_pos pos =
19751 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
19753 eassert (it->method == GET_FROM_BUFFER
19754 || it->method == GET_FROM_DISPLAY_VECTOR
19755 || it->method == GET_FROM_STRING);
19757 /* We need to save the current buffer/string position, so it will be
19758 restored by pop_it, because iterate_out_of_display_property
19759 depends on that being set correctly, but some situations leave
19760 it->position not yet set when this function is called. */
19761 push_it (it, &pos);
19763 if (STRINGP (prop))
19765 if (SCHARS (prop) == 0)
19767 pop_it (it);
19768 return 0;
19771 it->string = prop;
19772 it->string_from_prefix_prop_p = 1;
19773 it->multibyte_p = STRING_MULTIBYTE (it->string);
19774 it->current.overlay_string_index = -1;
19775 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
19776 it->end_charpos = it->string_nchars = SCHARS (it->string);
19777 it->method = GET_FROM_STRING;
19778 it->stop_charpos = 0;
19779 it->prev_stop = 0;
19780 it->base_level_stop = 0;
19782 /* Force paragraph direction to be that of the parent
19783 buffer/string. */
19784 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
19785 it->paragraph_embedding = it->bidi_it.paragraph_dir;
19786 else
19787 it->paragraph_embedding = L2R;
19789 /* Set up the bidi iterator for this display string. */
19790 if (it->bidi_p)
19792 it->bidi_it.string.lstring = it->string;
19793 it->bidi_it.string.s = NULL;
19794 it->bidi_it.string.schars = it->end_charpos;
19795 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19796 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19797 it->bidi_it.string.unibyte = !it->multibyte_p;
19798 it->bidi_it.w = it->w;
19799 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19802 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19804 it->method = GET_FROM_STRETCH;
19805 it->object = prop;
19807 #ifdef HAVE_WINDOW_SYSTEM
19808 else if (IMAGEP (prop))
19810 it->what = IT_IMAGE;
19811 it->image_id = lookup_image (it->f, prop);
19812 it->method = GET_FROM_IMAGE;
19814 #endif /* HAVE_WINDOW_SYSTEM */
19815 else
19817 pop_it (it); /* bogus display property, give up */
19818 return 0;
19821 return 1;
19824 /* Return the character-property PROP at the current position in IT. */
19826 static Lisp_Object
19827 get_it_property (struct it *it, Lisp_Object prop)
19829 Lisp_Object position, object = it->object;
19831 if (STRINGP (object))
19832 position = make_number (IT_STRING_CHARPOS (*it));
19833 else if (BUFFERP (object))
19835 position = make_number (IT_CHARPOS (*it));
19836 object = it->window;
19838 else
19839 return Qnil;
19841 return Fget_char_property (position, prop, object);
19844 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19846 static void
19847 handle_line_prefix (struct it *it)
19849 Lisp_Object prefix;
19851 if (it->continuation_lines_width > 0)
19853 prefix = get_it_property (it, Qwrap_prefix);
19854 if (NILP (prefix))
19855 prefix = Vwrap_prefix;
19857 else
19859 prefix = get_it_property (it, Qline_prefix);
19860 if (NILP (prefix))
19861 prefix = Vline_prefix;
19863 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19865 /* If the prefix is wider than the window, and we try to wrap
19866 it, it would acquire its own wrap prefix, and so on till the
19867 iterator stack overflows. So, don't wrap the prefix. */
19868 it->line_wrap = TRUNCATE;
19869 it->avoid_cursor_p = 1;
19875 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19876 only for R2L lines from display_line and display_string, when they
19877 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19878 the line/string needs to be continued on the next glyph row. */
19879 static void
19880 unproduce_glyphs (struct it *it, int n)
19882 struct glyph *glyph, *end;
19884 eassert (it->glyph_row);
19885 eassert (it->glyph_row->reversed_p);
19886 eassert (it->area == TEXT_AREA);
19887 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19889 if (n > it->glyph_row->used[TEXT_AREA])
19890 n = it->glyph_row->used[TEXT_AREA];
19891 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19892 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19893 for ( ; glyph < end; glyph++)
19894 glyph[-n] = *glyph;
19897 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19898 and ROW->maxpos. */
19899 static void
19900 find_row_edges (struct it *it, struct glyph_row *row,
19901 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19902 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19904 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19905 lines' rows is implemented for bidi-reordered rows. */
19907 /* ROW->minpos is the value of min_pos, the minimal buffer position
19908 we have in ROW, or ROW->start.pos if that is smaller. */
19909 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19910 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19911 else
19912 /* We didn't find buffer positions smaller than ROW->start, or
19913 didn't find _any_ valid buffer positions in any of the glyphs,
19914 so we must trust the iterator's computed positions. */
19915 row->minpos = row->start.pos;
19916 if (max_pos <= 0)
19918 max_pos = CHARPOS (it->current.pos);
19919 max_bpos = BYTEPOS (it->current.pos);
19922 /* Here are the various use-cases for ending the row, and the
19923 corresponding values for ROW->maxpos:
19925 Line ends in a newline from buffer eol_pos + 1
19926 Line is continued from buffer max_pos + 1
19927 Line is truncated on right it->current.pos
19928 Line ends in a newline from string max_pos + 1(*)
19929 (*) + 1 only when line ends in a forward scan
19930 Line is continued from string max_pos
19931 Line is continued from display vector max_pos
19932 Line is entirely from a string min_pos == max_pos
19933 Line is entirely from a display vector min_pos == max_pos
19934 Line that ends at ZV ZV
19936 If you discover other use-cases, please add them here as
19937 appropriate. */
19938 if (row->ends_at_zv_p)
19939 row->maxpos = it->current.pos;
19940 else if (row->used[TEXT_AREA])
19942 int seen_this_string = 0;
19943 struct glyph_row *r1 = row - 1;
19945 /* Did we see the same display string on the previous row? */
19946 if (STRINGP (it->object)
19947 /* this is not the first row */
19948 && row > it->w->desired_matrix->rows
19949 /* previous row is not the header line */
19950 && !r1->mode_line_p
19951 /* previous row also ends in a newline from a string */
19952 && r1->ends_in_newline_from_string_p)
19954 struct glyph *start, *end;
19956 /* Search for the last glyph of the previous row that came
19957 from buffer or string. Depending on whether the row is
19958 L2R or R2L, we need to process it front to back or the
19959 other way round. */
19960 if (!r1->reversed_p)
19962 start = r1->glyphs[TEXT_AREA];
19963 end = start + r1->used[TEXT_AREA];
19964 /* Glyphs inserted by redisplay have an integer (zero)
19965 as their object. */
19966 while (end > start
19967 && INTEGERP ((end - 1)->object)
19968 && (end - 1)->charpos <= 0)
19969 --end;
19970 if (end > start)
19972 if (EQ ((end - 1)->object, it->object))
19973 seen_this_string = 1;
19975 else
19976 /* If all the glyphs of the previous row were inserted
19977 by redisplay, it means the previous row was
19978 produced from a single newline, which is only
19979 possible if that newline came from the same string
19980 as the one which produced this ROW. */
19981 seen_this_string = 1;
19983 else
19985 end = r1->glyphs[TEXT_AREA] - 1;
19986 start = end + r1->used[TEXT_AREA];
19987 while (end < start
19988 && INTEGERP ((end + 1)->object)
19989 && (end + 1)->charpos <= 0)
19990 ++end;
19991 if (end < start)
19993 if (EQ ((end + 1)->object, it->object))
19994 seen_this_string = 1;
19996 else
19997 seen_this_string = 1;
20000 /* Take note of each display string that covers a newline only
20001 once, the first time we see it. This is for when a display
20002 string includes more than one newline in it. */
20003 if (row->ends_in_newline_from_string_p && !seen_this_string)
20005 /* If we were scanning the buffer forward when we displayed
20006 the string, we want to account for at least one buffer
20007 position that belongs to this row (position covered by
20008 the display string), so that cursor positioning will
20009 consider this row as a candidate when point is at the end
20010 of the visual line represented by this row. This is not
20011 required when scanning back, because max_pos will already
20012 have a much larger value. */
20013 if (CHARPOS (row->end.pos) > max_pos)
20014 INC_BOTH (max_pos, max_bpos);
20015 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20017 else if (CHARPOS (it->eol_pos) > 0)
20018 SET_TEXT_POS (row->maxpos,
20019 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
20020 else if (row->continued_p)
20022 /* If max_pos is different from IT's current position, it
20023 means IT->method does not belong to the display element
20024 at max_pos. However, it also means that the display
20025 element at max_pos was displayed in its entirety on this
20026 line, which is equivalent to saying that the next line
20027 starts at the next buffer position. */
20028 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
20029 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20030 else
20032 INC_BOTH (max_pos, max_bpos);
20033 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
20036 else if (row->truncated_on_right_p)
20037 /* display_line already called reseat_at_next_visible_line_start,
20038 which puts the iterator at the beginning of the next line, in
20039 the logical order. */
20040 row->maxpos = it->current.pos;
20041 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
20042 /* A line that is entirely from a string/image/stretch... */
20043 row->maxpos = row->minpos;
20044 else
20045 emacs_abort ();
20047 else
20048 row->maxpos = it->current.pos;
20051 /* Construct the glyph row IT->glyph_row in the desired matrix of
20052 IT->w from text at the current position of IT. See dispextern.h
20053 for an overview of struct it. Value is non-zero if
20054 IT->glyph_row displays text, as opposed to a line displaying ZV
20055 only. */
20057 static int
20058 display_line (struct it *it)
20060 struct glyph_row *row = it->glyph_row;
20061 Lisp_Object overlay_arrow_string;
20062 struct it wrap_it;
20063 void *wrap_data = NULL;
20064 int may_wrap = 0, wrap_x IF_LINT (= 0);
20065 int wrap_row_used = -1;
20066 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
20067 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
20068 int wrap_row_extra_line_spacing IF_LINT (= 0);
20069 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
20070 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
20071 int cvpos;
20072 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
20073 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
20074 bool pending_handle_line_prefix = false;
20076 /* We always start displaying at hpos zero even if hscrolled. */
20077 eassert (it->hpos == 0 && it->current_x == 0);
20079 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
20080 >= it->w->desired_matrix->nrows)
20082 it->w->nrows_scale_factor++;
20083 it->f->fonts_changed = 1;
20084 return 0;
20087 /* Clear the result glyph row and enable it. */
20088 prepare_desired_row (it->w, row, false);
20090 row->y = it->current_y;
20091 row->start = it->start;
20092 row->continuation_lines_width = it->continuation_lines_width;
20093 row->displays_text_p = 1;
20094 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
20095 it->starts_in_middle_of_char_p = 0;
20097 /* Arrange the overlays nicely for our purposes. Usually, we call
20098 display_line on only one line at a time, in which case this
20099 can't really hurt too much, or we call it on lines which appear
20100 one after another in the buffer, in which case all calls to
20101 recenter_overlay_lists but the first will be pretty cheap. */
20102 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
20104 /* Move over display elements that are not visible because we are
20105 hscrolled. This may stop at an x-position < IT->first_visible_x
20106 if the first glyph is partially visible or if we hit a line end. */
20107 if (it->current_x < it->first_visible_x)
20109 enum move_it_result move_result;
20111 this_line_min_pos = row->start.pos;
20112 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
20113 MOVE_TO_POS | MOVE_TO_X);
20114 /* If we are under a large hscroll, move_it_in_display_line_to
20115 could hit the end of the line without reaching
20116 it->first_visible_x. Pretend that we did reach it. This is
20117 especially important on a TTY, where we will call
20118 extend_face_to_end_of_line, which needs to know how many
20119 blank glyphs to produce. */
20120 if (it->current_x < it->first_visible_x
20121 && (move_result == MOVE_NEWLINE_OR_CR
20122 || move_result == MOVE_POS_MATCH_OR_ZV))
20123 it->current_x = it->first_visible_x;
20125 /* Record the smallest positions seen while we moved over
20126 display elements that are not visible. This is needed by
20127 redisplay_internal for optimizing the case where the cursor
20128 stays inside the same line. The rest of this function only
20129 considers positions that are actually displayed, so
20130 RECORD_MAX_MIN_POS will not otherwise record positions that
20131 are hscrolled to the left of the left edge of the window. */
20132 min_pos = CHARPOS (this_line_min_pos);
20133 min_bpos = BYTEPOS (this_line_min_pos);
20135 else if (it->area == TEXT_AREA)
20137 /* We only do this when not calling move_it_in_display_line_to
20138 above, because that function calls itself handle_line_prefix. */
20139 handle_line_prefix (it);
20141 else
20143 /* Line-prefix and wrap-prefix are always displayed in the text
20144 area. But if this is the first call to display_line after
20145 init_iterator, the iterator might have been set up to write
20146 into a marginal area, e.g. if the line begins with some
20147 display property that writes to the margins. So we need to
20148 wait with the call to handle_line_prefix until whatever
20149 writes to the margin has done its job. */
20150 pending_handle_line_prefix = true;
20153 /* Get the initial row height. This is either the height of the
20154 text hscrolled, if there is any, or zero. */
20155 row->ascent = it->max_ascent;
20156 row->height = it->max_ascent + it->max_descent;
20157 row->phys_ascent = it->max_phys_ascent;
20158 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
20159 row->extra_line_spacing = it->max_extra_line_spacing;
20161 /* Utility macro to record max and min buffer positions seen until now. */
20162 #define RECORD_MAX_MIN_POS(IT) \
20163 do \
20165 int composition_p = !STRINGP ((IT)->string) \
20166 && ((IT)->what == IT_COMPOSITION); \
20167 ptrdiff_t current_pos = \
20168 composition_p ? (IT)->cmp_it.charpos \
20169 : IT_CHARPOS (*(IT)); \
20170 ptrdiff_t current_bpos = \
20171 composition_p ? CHAR_TO_BYTE (current_pos) \
20172 : IT_BYTEPOS (*(IT)); \
20173 if (current_pos < min_pos) \
20175 min_pos = current_pos; \
20176 min_bpos = current_bpos; \
20178 if (IT_CHARPOS (*it) > max_pos) \
20180 max_pos = IT_CHARPOS (*it); \
20181 max_bpos = IT_BYTEPOS (*it); \
20184 while (0)
20186 /* Loop generating characters. The loop is left with IT on the next
20187 character to display. */
20188 while (1)
20190 int n_glyphs_before, hpos_before, x_before;
20191 int x, nglyphs;
20192 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
20194 /* Retrieve the next thing to display. Value is zero if end of
20195 buffer reached. */
20196 if (!get_next_display_element (it))
20198 /* Maybe add a space at the end of this line that is used to
20199 display the cursor there under X. Set the charpos of the
20200 first glyph of blank lines not corresponding to any text
20201 to -1. */
20202 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20203 row->exact_window_width_line_p = 1;
20204 else if ((append_space_for_newline (it, 1) && row->used[TEXT_AREA] == 1)
20205 || row->used[TEXT_AREA] == 0)
20207 row->glyphs[TEXT_AREA]->charpos = -1;
20208 row->displays_text_p = 0;
20210 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
20211 && (!MINI_WINDOW_P (it->w)
20212 || (minibuf_level && EQ (it->window, minibuf_window))))
20213 row->indicate_empty_line_p = 1;
20216 it->continuation_lines_width = 0;
20217 row->ends_at_zv_p = 1;
20218 /* A row that displays right-to-left text must always have
20219 its last face extended all the way to the end of line,
20220 even if this row ends in ZV, because we still write to
20221 the screen left to right. We also need to extend the
20222 last face if the default face is remapped to some
20223 different face, otherwise the functions that clear
20224 portions of the screen will clear with the default face's
20225 background color. */
20226 if (row->reversed_p
20227 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
20228 extend_face_to_end_of_line (it);
20229 break;
20232 /* Now, get the metrics of what we want to display. This also
20233 generates glyphs in `row' (which is IT->glyph_row). */
20234 n_glyphs_before = row->used[TEXT_AREA];
20235 x = it->current_x;
20237 /* Remember the line height so far in case the next element doesn't
20238 fit on the line. */
20239 if (it->line_wrap != TRUNCATE)
20241 ascent = it->max_ascent;
20242 descent = it->max_descent;
20243 phys_ascent = it->max_phys_ascent;
20244 phys_descent = it->max_phys_descent;
20246 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
20248 if (IT_DISPLAYING_WHITESPACE (it))
20249 may_wrap = 1;
20250 else if (may_wrap)
20252 SAVE_IT (wrap_it, *it, wrap_data);
20253 wrap_x = x;
20254 wrap_row_used = row->used[TEXT_AREA];
20255 wrap_row_ascent = row->ascent;
20256 wrap_row_height = row->height;
20257 wrap_row_phys_ascent = row->phys_ascent;
20258 wrap_row_phys_height = row->phys_height;
20259 wrap_row_extra_line_spacing = row->extra_line_spacing;
20260 wrap_row_min_pos = min_pos;
20261 wrap_row_min_bpos = min_bpos;
20262 wrap_row_max_pos = max_pos;
20263 wrap_row_max_bpos = max_bpos;
20264 may_wrap = 0;
20269 PRODUCE_GLYPHS (it);
20271 /* If this display element was in marginal areas, continue with
20272 the next one. */
20273 if (it->area != TEXT_AREA)
20275 row->ascent = max (row->ascent, it->max_ascent);
20276 row->height = max (row->height, it->max_ascent + it->max_descent);
20277 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20278 row->phys_height = max (row->phys_height,
20279 it->max_phys_ascent + it->max_phys_descent);
20280 row->extra_line_spacing = max (row->extra_line_spacing,
20281 it->max_extra_line_spacing);
20282 set_iterator_to_next (it, 1);
20283 /* If we didn't handle the line/wrap prefix above, and the
20284 call to set_iterator_to_next just switched to TEXT_AREA,
20285 process the prefix now. */
20286 if (it->area == TEXT_AREA && pending_handle_line_prefix)
20288 pending_handle_line_prefix = false;
20289 handle_line_prefix (it);
20291 continue;
20294 /* Does the display element fit on the line? If we truncate
20295 lines, we should draw past the right edge of the window. If
20296 we don't truncate, we want to stop so that we can display the
20297 continuation glyph before the right margin. If lines are
20298 continued, there are two possible strategies for characters
20299 resulting in more than 1 glyph (e.g. tabs): Display as many
20300 glyphs as possible in this line and leave the rest for the
20301 continuation line, or display the whole element in the next
20302 line. Original redisplay did the former, so we do it also. */
20303 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20304 hpos_before = it->hpos;
20305 x_before = x;
20307 if (/* Not a newline. */
20308 nglyphs > 0
20309 /* Glyphs produced fit entirely in the line. */
20310 && it->current_x < it->last_visible_x)
20312 it->hpos += nglyphs;
20313 row->ascent = max (row->ascent, it->max_ascent);
20314 row->height = max (row->height, it->max_ascent + it->max_descent);
20315 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20316 row->phys_height = max (row->phys_height,
20317 it->max_phys_ascent + it->max_phys_descent);
20318 row->extra_line_spacing = max (row->extra_line_spacing,
20319 it->max_extra_line_spacing);
20320 if (it->current_x - it->pixel_width < it->first_visible_x
20321 /* In R2L rows, we arrange in extend_face_to_end_of_line
20322 to add a right offset to the line, by a suitable
20323 change to the stretch glyph that is the leftmost
20324 glyph of the line. */
20325 && !row->reversed_p)
20326 row->x = x - it->first_visible_x;
20327 /* Record the maximum and minimum buffer positions seen so
20328 far in glyphs that will be displayed by this row. */
20329 if (it->bidi_p)
20330 RECORD_MAX_MIN_POS (it);
20332 else
20334 int i, new_x;
20335 struct glyph *glyph;
20337 for (i = 0; i < nglyphs; ++i, x = new_x)
20339 /* Identify the glyphs added by the last call to
20340 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20341 the previous glyphs. */
20342 if (!row->reversed_p)
20343 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20344 else
20345 glyph = row->glyphs[TEXT_AREA] + nglyphs - 1 - i;
20346 new_x = x + glyph->pixel_width;
20348 if (/* Lines are continued. */
20349 it->line_wrap != TRUNCATE
20350 && (/* Glyph doesn't fit on the line. */
20351 new_x > it->last_visible_x
20352 /* Or it fits exactly on a window system frame. */
20353 || (new_x == it->last_visible_x
20354 && FRAME_WINDOW_P (it->f)
20355 && (row->reversed_p
20356 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20357 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20359 /* End of a continued line. */
20361 if (it->hpos == 0
20362 || (new_x == it->last_visible_x
20363 && FRAME_WINDOW_P (it->f)
20364 && (row->reversed_p
20365 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20366 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20368 /* Current glyph is the only one on the line or
20369 fits exactly on the line. We must continue
20370 the line because we can't draw the cursor
20371 after the glyph. */
20372 row->continued_p = 1;
20373 it->current_x = new_x;
20374 it->continuation_lines_width += new_x;
20375 ++it->hpos;
20376 if (i == nglyphs - 1)
20378 /* If line-wrap is on, check if a previous
20379 wrap point was found. */
20380 if (wrap_row_used > 0
20381 /* Even if there is a previous wrap
20382 point, continue the line here as
20383 usual, if (i) the previous character
20384 was a space or tab AND (ii) the
20385 current character is not. */
20386 && (!may_wrap
20387 || IT_DISPLAYING_WHITESPACE (it)))
20388 goto back_to_wrap;
20390 /* Record the maximum and minimum buffer
20391 positions seen so far in glyphs that will be
20392 displayed by this row. */
20393 if (it->bidi_p)
20394 RECORD_MAX_MIN_POS (it);
20395 set_iterator_to_next (it, 1);
20396 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20398 if (!get_next_display_element (it))
20400 row->exact_window_width_line_p = 1;
20401 it->continuation_lines_width = 0;
20402 row->continued_p = 0;
20403 row->ends_at_zv_p = 1;
20405 else if (ITERATOR_AT_END_OF_LINE_P (it))
20407 row->continued_p = 0;
20408 row->exact_window_width_line_p = 1;
20412 else if (it->bidi_p)
20413 RECORD_MAX_MIN_POS (it);
20414 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20415 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20416 extend_face_to_end_of_line (it);
20418 else if (CHAR_GLYPH_PADDING_P (*glyph)
20419 && !FRAME_WINDOW_P (it->f))
20421 /* A padding glyph that doesn't fit on this line.
20422 This means the whole character doesn't fit
20423 on the line. */
20424 if (row->reversed_p)
20425 unproduce_glyphs (it, row->used[TEXT_AREA]
20426 - n_glyphs_before);
20427 row->used[TEXT_AREA] = n_glyphs_before;
20429 /* Fill the rest of the row with continuation
20430 glyphs like in 20.x. */
20431 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20432 < row->glyphs[1 + TEXT_AREA])
20433 produce_special_glyphs (it, IT_CONTINUATION);
20435 row->continued_p = 1;
20436 it->current_x = x_before;
20437 it->continuation_lines_width += x_before;
20439 /* Restore the height to what it was before the
20440 element not fitting on the line. */
20441 it->max_ascent = ascent;
20442 it->max_descent = descent;
20443 it->max_phys_ascent = phys_ascent;
20444 it->max_phys_descent = phys_descent;
20445 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20446 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20447 extend_face_to_end_of_line (it);
20449 else if (wrap_row_used > 0)
20451 back_to_wrap:
20452 if (row->reversed_p)
20453 unproduce_glyphs (it,
20454 row->used[TEXT_AREA] - wrap_row_used);
20455 RESTORE_IT (it, &wrap_it, wrap_data);
20456 it->continuation_lines_width += wrap_x;
20457 row->used[TEXT_AREA] = wrap_row_used;
20458 row->ascent = wrap_row_ascent;
20459 row->height = wrap_row_height;
20460 row->phys_ascent = wrap_row_phys_ascent;
20461 row->phys_height = wrap_row_phys_height;
20462 row->extra_line_spacing = wrap_row_extra_line_spacing;
20463 min_pos = wrap_row_min_pos;
20464 min_bpos = wrap_row_min_bpos;
20465 max_pos = wrap_row_max_pos;
20466 max_bpos = wrap_row_max_bpos;
20467 row->continued_p = 1;
20468 row->ends_at_zv_p = 0;
20469 row->exact_window_width_line_p = 0;
20470 it->continuation_lines_width += x;
20472 /* Make sure that a non-default face is extended
20473 up to the right margin of the window. */
20474 extend_face_to_end_of_line (it);
20476 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20478 /* A TAB that extends past the right edge of the
20479 window. This produces a single glyph on
20480 window system frames. We leave the glyph in
20481 this row and let it fill the row, but don't
20482 consume the TAB. */
20483 if ((row->reversed_p
20484 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20485 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20486 produce_special_glyphs (it, IT_CONTINUATION);
20487 it->continuation_lines_width += it->last_visible_x;
20488 row->ends_in_middle_of_char_p = 1;
20489 row->continued_p = 1;
20490 glyph->pixel_width = it->last_visible_x - x;
20491 it->starts_in_middle_of_char_p = 1;
20492 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20493 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20494 extend_face_to_end_of_line (it);
20496 else
20498 /* Something other than a TAB that draws past
20499 the right edge of the window. Restore
20500 positions to values before the element. */
20501 if (row->reversed_p)
20502 unproduce_glyphs (it, row->used[TEXT_AREA]
20503 - (n_glyphs_before + i));
20504 row->used[TEXT_AREA] = n_glyphs_before + i;
20506 /* Display continuation glyphs. */
20507 it->current_x = x_before;
20508 it->continuation_lines_width += x;
20509 if (!FRAME_WINDOW_P (it->f)
20510 || (row->reversed_p
20511 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20512 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20513 produce_special_glyphs (it, IT_CONTINUATION);
20514 row->continued_p = 1;
20516 extend_face_to_end_of_line (it);
20518 if (nglyphs > 1 && i > 0)
20520 row->ends_in_middle_of_char_p = 1;
20521 it->starts_in_middle_of_char_p = 1;
20524 /* Restore the height to what it was before the
20525 element not fitting on the line. */
20526 it->max_ascent = ascent;
20527 it->max_descent = descent;
20528 it->max_phys_ascent = phys_ascent;
20529 it->max_phys_descent = phys_descent;
20532 break;
20534 else if (new_x > it->first_visible_x)
20536 /* Increment number of glyphs actually displayed. */
20537 ++it->hpos;
20539 /* Record the maximum and minimum buffer positions
20540 seen so far in glyphs that will be displayed by
20541 this row. */
20542 if (it->bidi_p)
20543 RECORD_MAX_MIN_POS (it);
20545 if (x < it->first_visible_x && !row->reversed_p)
20546 /* Glyph is partially visible, i.e. row starts at
20547 negative X position. Don't do that in R2L
20548 rows, where we arrange to add a right offset to
20549 the line in extend_face_to_end_of_line, by a
20550 suitable change to the stretch glyph that is
20551 the leftmost glyph of the line. */
20552 row->x = x - it->first_visible_x;
20553 /* When the last glyph of an R2L row only fits
20554 partially on the line, we need to set row->x to a
20555 negative offset, so that the leftmost glyph is
20556 the one that is partially visible. But if we are
20557 going to produce the truncation glyph, this will
20558 be taken care of in produce_special_glyphs. */
20559 if (row->reversed_p
20560 && new_x > it->last_visible_x
20561 && !(it->line_wrap == TRUNCATE
20562 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
20564 eassert (FRAME_WINDOW_P (it->f));
20565 row->x = it->last_visible_x - new_x;
20568 else
20570 /* Glyph is completely off the left margin of the
20571 window. This should not happen because of the
20572 move_it_in_display_line at the start of this
20573 function, unless the text display area of the
20574 window is empty. */
20575 eassert (it->first_visible_x <= it->last_visible_x);
20578 /* Even if this display element produced no glyphs at all,
20579 we want to record its position. */
20580 if (it->bidi_p && nglyphs == 0)
20581 RECORD_MAX_MIN_POS (it);
20583 row->ascent = max (row->ascent, it->max_ascent);
20584 row->height = max (row->height, it->max_ascent + it->max_descent);
20585 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20586 row->phys_height = max (row->phys_height,
20587 it->max_phys_ascent + it->max_phys_descent);
20588 row->extra_line_spacing = max (row->extra_line_spacing,
20589 it->max_extra_line_spacing);
20591 /* End of this display line if row is continued. */
20592 if (row->continued_p || row->ends_at_zv_p)
20593 break;
20596 at_end_of_line:
20597 /* Is this a line end? If yes, we're also done, after making
20598 sure that a non-default face is extended up to the right
20599 margin of the window. */
20600 if (ITERATOR_AT_END_OF_LINE_P (it))
20602 int used_before = row->used[TEXT_AREA];
20604 row->ends_in_newline_from_string_p = STRINGP (it->object);
20606 /* Add a space at the end of the line that is used to
20607 display the cursor there. */
20608 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20609 append_space_for_newline (it, 0);
20611 /* Extend the face to the end of the line. */
20612 extend_face_to_end_of_line (it);
20614 /* Make sure we have the position. */
20615 if (used_before == 0)
20616 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
20618 /* Record the position of the newline, for use in
20619 find_row_edges. */
20620 it->eol_pos = it->current.pos;
20622 /* Consume the line end. This skips over invisible lines. */
20623 set_iterator_to_next (it, 1);
20624 it->continuation_lines_width = 0;
20625 break;
20628 /* Proceed with next display element. Note that this skips
20629 over lines invisible because of selective display. */
20630 set_iterator_to_next (it, 1);
20632 /* If we truncate lines, we are done when the last displayed
20633 glyphs reach past the right margin of the window. */
20634 if (it->line_wrap == TRUNCATE
20635 && ((FRAME_WINDOW_P (it->f)
20636 /* Images are preprocessed in produce_image_glyph such
20637 that they are cropped at the right edge of the
20638 window, so an image glyph will always end exactly at
20639 last_visible_x, even if there's no right fringe. */
20640 && ((row->reversed_p
20641 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20642 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))
20643 || it->what == IT_IMAGE))
20644 ? (it->current_x >= it->last_visible_x)
20645 : (it->current_x > it->last_visible_x)))
20647 /* Maybe add truncation glyphs. */
20648 if (!FRAME_WINDOW_P (it->f)
20649 || (row->reversed_p
20650 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20651 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20653 int i, n;
20655 if (!row->reversed_p)
20657 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
20658 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20659 break;
20661 else
20663 for (i = 0; i < row->used[TEXT_AREA]; i++)
20664 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20665 break;
20666 /* Remove any padding glyphs at the front of ROW, to
20667 make room for the truncation glyphs we will be
20668 adding below. The loop below always inserts at
20669 least one truncation glyph, so also remove the
20670 last glyph added to ROW. */
20671 unproduce_glyphs (it, i + 1);
20672 /* Adjust i for the loop below. */
20673 i = row->used[TEXT_AREA] - (i + 1);
20676 /* produce_special_glyphs overwrites the last glyph, so
20677 we don't want that if we want to keep that last
20678 glyph, which means it's an image. */
20679 if (it->current_x > it->last_visible_x)
20681 it->current_x = x_before;
20682 if (!FRAME_WINDOW_P (it->f))
20684 for (n = row->used[TEXT_AREA]; i < n; ++i)
20686 row->used[TEXT_AREA] = i;
20687 produce_special_glyphs (it, IT_TRUNCATION);
20690 else
20692 row->used[TEXT_AREA] = i;
20693 produce_special_glyphs (it, IT_TRUNCATION);
20695 it->hpos = hpos_before;
20698 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20700 /* Don't truncate if we can overflow newline into fringe. */
20701 if (!get_next_display_element (it))
20703 it->continuation_lines_width = 0;
20704 row->ends_at_zv_p = 1;
20705 row->exact_window_width_line_p = 1;
20706 break;
20708 if (ITERATOR_AT_END_OF_LINE_P (it))
20710 row->exact_window_width_line_p = 1;
20711 goto at_end_of_line;
20713 it->current_x = x_before;
20714 it->hpos = hpos_before;
20717 row->truncated_on_right_p = 1;
20718 it->continuation_lines_width = 0;
20719 reseat_at_next_visible_line_start (it, 0);
20720 /* We insist below that IT's position be at ZV because in
20721 bidi-reordered lines the character at visible line start
20722 might not be the character that follows the newline in
20723 the logical order. */
20724 if (IT_BYTEPOS (*it) > BEG_BYTE)
20725 row->ends_at_zv_p =
20726 IT_BYTEPOS (*it) >= ZV_BYTE && FETCH_BYTE (ZV_BYTE - 1) != '\n';
20727 else
20728 row->ends_at_zv_p = false;
20729 break;
20733 if (wrap_data)
20734 bidi_unshelve_cache (wrap_data, 1);
20736 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20737 at the left window margin. */
20738 if (it->first_visible_x
20739 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
20741 if (!FRAME_WINDOW_P (it->f)
20742 || (((row->reversed_p
20743 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
20744 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
20745 /* Don't let insert_left_trunc_glyphs overwrite the
20746 first glyph of the row if it is an image. */
20747 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
20748 insert_left_trunc_glyphs (it);
20749 row->truncated_on_left_p = 1;
20752 /* Remember the position at which this line ends.
20754 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20755 cannot be before the call to find_row_edges below, since that is
20756 where these positions are determined. */
20757 row->end = it->current;
20758 if (!it->bidi_p)
20760 row->minpos = row->start.pos;
20761 row->maxpos = row->end.pos;
20763 else
20765 /* ROW->minpos and ROW->maxpos must be the smallest and
20766 `1 + the largest' buffer positions in ROW. But if ROW was
20767 bidi-reordered, these two positions can be anywhere in the
20768 row, so we must determine them now. */
20769 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
20772 /* If the start of this line is the overlay arrow-position, then
20773 mark this glyph row as the one containing the overlay arrow.
20774 This is clearly a mess with variable size fonts. It would be
20775 better to let it be displayed like cursors under X. */
20776 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
20777 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
20778 !NILP (overlay_arrow_string)))
20780 /* Overlay arrow in window redisplay is a fringe bitmap. */
20781 if (STRINGP (overlay_arrow_string))
20783 struct glyph_row *arrow_row
20784 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
20785 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
20786 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
20787 struct glyph *p = row->glyphs[TEXT_AREA];
20788 struct glyph *p2, *end;
20790 /* Copy the arrow glyphs. */
20791 while (glyph < arrow_end)
20792 *p++ = *glyph++;
20794 /* Throw away padding glyphs. */
20795 p2 = p;
20796 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
20797 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
20798 ++p2;
20799 if (p2 > p)
20801 while (p2 < end)
20802 *p++ = *p2++;
20803 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
20806 else
20808 eassert (INTEGERP (overlay_arrow_string));
20809 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
20811 overlay_arrow_seen = 1;
20814 /* Highlight trailing whitespace. */
20815 if (!NILP (Vshow_trailing_whitespace))
20816 highlight_trailing_whitespace (it->f, it->glyph_row);
20818 /* Compute pixel dimensions of this line. */
20819 compute_line_metrics (it);
20821 /* Implementation note: No changes in the glyphs of ROW or in their
20822 faces can be done past this point, because compute_line_metrics
20823 computes ROW's hash value and stores it within the glyph_row
20824 structure. */
20826 /* Record whether this row ends inside an ellipsis. */
20827 row->ends_in_ellipsis_p
20828 = (it->method == GET_FROM_DISPLAY_VECTOR
20829 && it->ellipsis_p);
20831 /* Save fringe bitmaps in this row. */
20832 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
20833 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
20834 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
20835 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
20837 it->left_user_fringe_bitmap = 0;
20838 it->left_user_fringe_face_id = 0;
20839 it->right_user_fringe_bitmap = 0;
20840 it->right_user_fringe_face_id = 0;
20842 /* Maybe set the cursor. */
20843 cvpos = it->w->cursor.vpos;
20844 if ((cvpos < 0
20845 /* In bidi-reordered rows, keep checking for proper cursor
20846 position even if one has been found already, because buffer
20847 positions in such rows change non-linearly with ROW->VPOS,
20848 when a line is continued. One exception: when we are at ZV,
20849 display cursor on the first suitable glyph row, since all
20850 the empty rows after that also have their position set to ZV. */
20851 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20852 lines' rows is implemented for bidi-reordered rows. */
20853 || (it->bidi_p
20854 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
20855 && PT >= MATRIX_ROW_START_CHARPOS (row)
20856 && PT <= MATRIX_ROW_END_CHARPOS (row)
20857 && cursor_row_p (row))
20858 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
20860 /* Prepare for the next line. This line starts horizontally at (X
20861 HPOS) = (0 0). Vertical positions are incremented. As a
20862 convenience for the caller, IT->glyph_row is set to the next
20863 row to be used. */
20864 it->current_x = it->hpos = 0;
20865 it->current_y += row->height;
20866 SET_TEXT_POS (it->eol_pos, 0, 0);
20867 ++it->vpos;
20868 ++it->glyph_row;
20869 /* The next row should by default use the same value of the
20870 reversed_p flag as this one. set_iterator_to_next decides when
20871 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20872 the flag accordingly. */
20873 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20874 it->glyph_row->reversed_p = row->reversed_p;
20875 it->start = row->end;
20876 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
20878 #undef RECORD_MAX_MIN_POS
20881 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20882 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20883 doc: /* Return paragraph direction at point in BUFFER.
20884 Value is either `left-to-right' or `right-to-left'.
20885 If BUFFER is omitted or nil, it defaults to the current buffer.
20887 Paragraph direction determines how the text in the paragraph is displayed.
20888 In left-to-right paragraphs, text begins at the left margin of the window
20889 and the reading direction is generally left to right. In right-to-left
20890 paragraphs, text begins at the right margin and is read from right to left.
20892 See also `bidi-paragraph-direction'. */)
20893 (Lisp_Object buffer)
20895 struct buffer *buf = current_buffer;
20896 struct buffer *old = buf;
20898 if (! NILP (buffer))
20900 CHECK_BUFFER (buffer);
20901 buf = XBUFFER (buffer);
20904 if (NILP (BVAR (buf, bidi_display_reordering))
20905 || NILP (BVAR (buf, enable_multibyte_characters))
20906 /* When we are loading loadup.el, the character property tables
20907 needed for bidi iteration are not yet available. */
20908 || !NILP (Vpurify_flag))
20909 return Qleft_to_right;
20910 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
20911 return BVAR (buf, bidi_paragraph_direction);
20912 else
20914 /* Determine the direction from buffer text. We could try to
20915 use current_matrix if it is up to date, but this seems fast
20916 enough as it is. */
20917 struct bidi_it itb;
20918 ptrdiff_t pos = BUF_PT (buf);
20919 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
20920 int c;
20921 void *itb_data = bidi_shelve_cache ();
20923 set_buffer_temp (buf);
20924 /* bidi_paragraph_init finds the base direction of the paragraph
20925 by searching forward from paragraph start. We need the base
20926 direction of the current or _previous_ paragraph, so we need
20927 to make sure we are within that paragraph. To that end, find
20928 the previous non-empty line. */
20929 if (pos >= ZV && pos > BEGV)
20930 DEC_BOTH (pos, bytepos);
20931 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20932 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
20934 while ((c = FETCH_BYTE (bytepos)) == '\n'
20935 || c == ' ' || c == '\t' || c == '\f')
20937 if (bytepos <= BEGV_BYTE)
20938 break;
20939 bytepos--;
20940 pos--;
20942 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
20943 bytepos--;
20945 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
20946 itb.paragraph_dir = NEUTRAL_DIR;
20947 itb.string.s = NULL;
20948 itb.string.lstring = Qnil;
20949 itb.string.bufpos = 0;
20950 itb.string.from_disp_str = 0;
20951 itb.string.unibyte = 0;
20952 /* We have no window to use here for ignoring window-specific
20953 overlays. Using NULL for window pointer will cause
20954 compute_display_string_pos to use the current buffer. */
20955 itb.w = NULL;
20956 bidi_paragraph_init (NEUTRAL_DIR, &itb, 1);
20957 bidi_unshelve_cache (itb_data, 0);
20958 set_buffer_temp (old);
20959 switch (itb.paragraph_dir)
20961 case L2R:
20962 return Qleft_to_right;
20963 break;
20964 case R2L:
20965 return Qright_to_left;
20966 break;
20967 default:
20968 emacs_abort ();
20973 DEFUN ("move-point-visually", Fmove_point_visually,
20974 Smove_point_visually, 1, 1, 0,
20975 doc: /* Move point in the visual order in the specified DIRECTION.
20976 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20977 left.
20979 Value is the new character position of point. */)
20980 (Lisp_Object direction)
20982 struct window *w = XWINDOW (selected_window);
20983 struct buffer *b = XBUFFER (w->contents);
20984 struct glyph_row *row;
20985 int dir;
20986 Lisp_Object paragraph_dir;
20988 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20989 (!(ROW)->continued_p \
20990 && INTEGERP ((GLYPH)->object) \
20991 && (GLYPH)->type == CHAR_GLYPH \
20992 && (GLYPH)->u.ch == ' ' \
20993 && (GLYPH)->charpos >= 0 \
20994 && !(GLYPH)->avoid_cursor_p)
20996 CHECK_NUMBER (direction);
20997 dir = XINT (direction);
20998 if (dir > 0)
20999 dir = 1;
21000 else
21001 dir = -1;
21003 /* If current matrix is up-to-date, we can use the information
21004 recorded in the glyphs, at least as long as the goal is on the
21005 screen. */
21006 if (w->window_end_valid
21007 && !windows_or_buffers_changed
21008 && b
21009 && !b->clip_changed
21010 && !b->prevent_redisplay_optimizations_p
21011 && !window_outdated (w)
21012 /* We rely below on the cursor coordinates to be up to date, but
21013 we cannot trust them if some command moved point since the
21014 last complete redisplay. */
21015 && w->last_point == BUF_PT (b)
21016 && w->cursor.vpos >= 0
21017 && w->cursor.vpos < w->current_matrix->nrows
21018 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
21020 struct glyph *g = row->glyphs[TEXT_AREA];
21021 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
21022 struct glyph *gpt = g + w->cursor.hpos;
21024 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
21026 if (BUFFERP (g->object) && g->charpos != PT)
21028 SET_PT (g->charpos);
21029 w->cursor.vpos = -1;
21030 return make_number (PT);
21032 else if (!INTEGERP (g->object) && !EQ (g->object, gpt->object))
21034 ptrdiff_t new_pos;
21036 if (BUFFERP (gpt->object))
21038 new_pos = PT;
21039 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
21040 new_pos += (row->reversed_p ? -dir : dir);
21041 else
21042 new_pos -= (row->reversed_p ? -dir : dir);;
21044 else if (BUFFERP (g->object))
21045 new_pos = g->charpos;
21046 else
21047 break;
21048 SET_PT (new_pos);
21049 w->cursor.vpos = -1;
21050 return make_number (PT);
21052 else if (ROW_GLYPH_NEWLINE_P (row, g))
21054 /* Glyphs inserted at the end of a non-empty line for
21055 positioning the cursor have zero charpos, so we must
21056 deduce the value of point by other means. */
21057 if (g->charpos > 0)
21058 SET_PT (g->charpos);
21059 else if (row->ends_at_zv_p && PT != ZV)
21060 SET_PT (ZV);
21061 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
21062 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21063 else
21064 break;
21065 w->cursor.vpos = -1;
21066 return make_number (PT);
21069 if (g == e || INTEGERP (g->object))
21071 if (row->truncated_on_left_p || row->truncated_on_right_p)
21072 goto simulate_display;
21073 if (!row->reversed_p)
21074 row += dir;
21075 else
21076 row -= dir;
21077 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
21078 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
21079 goto simulate_display;
21081 if (dir > 0)
21083 if (row->reversed_p && !row->continued_p)
21085 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21086 w->cursor.vpos = -1;
21087 return make_number (PT);
21089 g = row->glyphs[TEXT_AREA];
21090 e = g + row->used[TEXT_AREA];
21091 for ( ; g < e; g++)
21093 if (BUFFERP (g->object)
21094 /* Empty lines have only one glyph, which stands
21095 for the newline, and whose charpos is the
21096 buffer position of the newline. */
21097 || ROW_GLYPH_NEWLINE_P (row, g)
21098 /* When the buffer ends in a newline, the line at
21099 EOB also has one glyph, but its charpos is -1. */
21100 || (row->ends_at_zv_p
21101 && !row->reversed_p
21102 && INTEGERP (g->object)
21103 && g->type == CHAR_GLYPH
21104 && g->u.ch == ' '))
21106 if (g->charpos > 0)
21107 SET_PT (g->charpos);
21108 else if (!row->reversed_p
21109 && row->ends_at_zv_p
21110 && PT != ZV)
21111 SET_PT (ZV);
21112 else
21113 continue;
21114 w->cursor.vpos = -1;
21115 return make_number (PT);
21119 else
21121 if (!row->reversed_p && !row->continued_p)
21123 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21124 w->cursor.vpos = -1;
21125 return make_number (PT);
21127 e = row->glyphs[TEXT_AREA];
21128 g = e + row->used[TEXT_AREA] - 1;
21129 for ( ; g >= e; g--)
21131 if (BUFFERP (g->object)
21132 || (ROW_GLYPH_NEWLINE_P (row, g)
21133 && g->charpos > 0)
21134 /* Empty R2L lines on GUI frames have the buffer
21135 position of the newline stored in the stretch
21136 glyph. */
21137 || g->type == STRETCH_GLYPH
21138 || (row->ends_at_zv_p
21139 && row->reversed_p
21140 && INTEGERP (g->object)
21141 && g->type == CHAR_GLYPH
21142 && g->u.ch == ' '))
21144 if (g->charpos > 0)
21145 SET_PT (g->charpos);
21146 else if (row->reversed_p
21147 && row->ends_at_zv_p
21148 && PT != ZV)
21149 SET_PT (ZV);
21150 else
21151 continue;
21152 w->cursor.vpos = -1;
21153 return make_number (PT);
21160 simulate_display:
21162 /* If we wind up here, we failed to move by using the glyphs, so we
21163 need to simulate display instead. */
21165 if (b)
21166 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
21167 else
21168 paragraph_dir = Qleft_to_right;
21169 if (EQ (paragraph_dir, Qright_to_left))
21170 dir = -dir;
21171 if (PT <= BEGV && dir < 0)
21172 xsignal0 (Qbeginning_of_buffer);
21173 else if (PT >= ZV && dir > 0)
21174 xsignal0 (Qend_of_buffer);
21175 else
21177 struct text_pos pt;
21178 struct it it;
21179 int pt_x, target_x, pixel_width, pt_vpos;
21180 bool at_eol_p;
21181 bool overshoot_expected = false;
21182 bool target_is_eol_p = false;
21184 /* Setup the arena. */
21185 SET_TEXT_POS (pt, PT, PT_BYTE);
21186 start_display (&it, w, pt);
21188 if (it.cmp_it.id < 0
21189 && it.method == GET_FROM_STRING
21190 && it.area == TEXT_AREA
21191 && it.string_from_display_prop_p
21192 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
21193 overshoot_expected = true;
21195 /* Find the X coordinate of point. We start from the beginning
21196 of this or previous line to make sure we are before point in
21197 the logical order (since the move_it_* functions can only
21198 move forward). */
21199 reseat:
21200 reseat_at_previous_visible_line_start (&it);
21201 it.current_x = it.hpos = it.current_y = it.vpos = 0;
21202 if (IT_CHARPOS (it) != PT)
21204 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
21205 -1, -1, -1, MOVE_TO_POS);
21206 /* If we missed point because the character there is
21207 displayed out of a display vector that has more than one
21208 glyph, retry expecting overshoot. */
21209 if (it.method == GET_FROM_DISPLAY_VECTOR
21210 && it.current.dpvec_index > 0
21211 && !overshoot_expected)
21213 overshoot_expected = true;
21214 goto reseat;
21216 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
21217 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
21219 pt_x = it.current_x;
21220 pt_vpos = it.vpos;
21221 if (dir > 0 || overshoot_expected)
21223 struct glyph_row *row = it.glyph_row;
21225 /* When point is at beginning of line, we don't have
21226 information about the glyph there loaded into struct
21227 it. Calling get_next_display_element fixes that. */
21228 if (pt_x == 0)
21229 get_next_display_element (&it);
21230 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21231 it.glyph_row = NULL;
21232 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
21233 it.glyph_row = row;
21234 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21235 it, lest it will become out of sync with it's buffer
21236 position. */
21237 it.current_x = pt_x;
21239 else
21240 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21241 pixel_width = it.pixel_width;
21242 if (overshoot_expected && at_eol_p)
21243 pixel_width = 0;
21244 else if (pixel_width <= 0)
21245 pixel_width = 1;
21247 /* If there's a display string (or something similar) at point,
21248 we are actually at the glyph to the left of point, so we need
21249 to correct the X coordinate. */
21250 if (overshoot_expected)
21252 if (it.bidi_p)
21253 pt_x += pixel_width * it.bidi_it.scan_dir;
21254 else
21255 pt_x += pixel_width;
21258 /* Compute target X coordinate, either to the left or to the
21259 right of point. On TTY frames, all characters have the same
21260 pixel width of 1, so we can use that. On GUI frames we don't
21261 have an easy way of getting at the pixel width of the
21262 character to the left of point, so we use a different method
21263 of getting to that place. */
21264 if (dir > 0)
21265 target_x = pt_x + pixel_width;
21266 else
21267 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
21269 /* Target X coordinate could be one line above or below the line
21270 of point, in which case we need to adjust the target X
21271 coordinate. Also, if moving to the left, we need to begin at
21272 the left edge of the point's screen line. */
21273 if (dir < 0)
21275 if (pt_x > 0)
21277 start_display (&it, w, pt);
21278 reseat_at_previous_visible_line_start (&it);
21279 it.current_x = it.current_y = it.hpos = 0;
21280 if (pt_vpos != 0)
21281 move_it_by_lines (&it, pt_vpos);
21283 else
21285 move_it_by_lines (&it, -1);
21286 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
21287 target_is_eol_p = true;
21288 /* Under word-wrap, we don't know the x coordinate of
21289 the last character displayed on the previous line,
21290 which immediately precedes the wrap point. To find
21291 out its x coordinate, we try moving to the right
21292 margin of the window, which will stop at the wrap
21293 point, and then reset target_x to point at the
21294 character that precedes the wrap point. This is not
21295 needed on GUI frames, because (see below) there we
21296 move from the left margin one grapheme cluster at a
21297 time, and stop when we hit the wrap point. */
21298 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
21300 void *it_data = NULL;
21301 struct it it2;
21303 SAVE_IT (it2, it, it_data);
21304 move_it_in_display_line_to (&it, ZV, target_x,
21305 MOVE_TO_POS | MOVE_TO_X);
21306 /* If we arrived at target_x, that _is_ the last
21307 character on the previous line. */
21308 if (it.current_x != target_x)
21309 target_x = it.current_x - 1;
21310 RESTORE_IT (&it, &it2, it_data);
21314 else
21316 if (at_eol_p
21317 || (target_x >= it.last_visible_x
21318 && it.line_wrap != TRUNCATE))
21320 if (pt_x > 0)
21321 move_it_by_lines (&it, 0);
21322 move_it_by_lines (&it, 1);
21323 target_x = 0;
21327 /* Move to the target X coordinate. */
21328 #ifdef HAVE_WINDOW_SYSTEM
21329 /* On GUI frames, as we don't know the X coordinate of the
21330 character to the left of point, moving point to the left
21331 requires walking, one grapheme cluster at a time, until we
21332 find ourself at a place immediately to the left of the
21333 character at point. */
21334 if (FRAME_WINDOW_P (it.f) && dir < 0)
21336 struct text_pos new_pos;
21337 enum move_it_result rc = MOVE_X_REACHED;
21339 if (it.current_x == 0)
21340 get_next_display_element (&it);
21341 if (it.what == IT_COMPOSITION)
21343 new_pos.charpos = it.cmp_it.charpos;
21344 new_pos.bytepos = -1;
21346 else
21347 new_pos = it.current.pos;
21349 while (it.current_x + it.pixel_width <= target_x
21350 && (rc == MOVE_X_REACHED
21351 /* Under word-wrap, move_it_in_display_line_to
21352 stops at correct coordinates, but sometimes
21353 returns MOVE_POS_MATCH_OR_ZV. */
21354 || (it.line_wrap == WORD_WRAP
21355 && rc == MOVE_POS_MATCH_OR_ZV)))
21357 int new_x = it.current_x + it.pixel_width;
21359 /* For composed characters, we want the position of the
21360 first character in the grapheme cluster (usually, the
21361 composition's base character), whereas it.current
21362 might give us the position of the _last_ one, e.g. if
21363 the composition is rendered in reverse due to bidi
21364 reordering. */
21365 if (it.what == IT_COMPOSITION)
21367 new_pos.charpos = it.cmp_it.charpos;
21368 new_pos.bytepos = -1;
21370 else
21371 new_pos = it.current.pos;
21372 if (new_x == it.current_x)
21373 new_x++;
21374 rc = move_it_in_display_line_to (&it, ZV, new_x,
21375 MOVE_TO_POS | MOVE_TO_X);
21376 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21377 break;
21379 /* The previous position we saw in the loop is the one we
21380 want. */
21381 if (new_pos.bytepos == -1)
21382 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21383 it.current.pos = new_pos;
21385 else
21386 #endif
21387 if (it.current_x != target_x)
21388 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21390 /* When lines are truncated, the above loop will stop at the
21391 window edge. But we want to get to the end of line, even if
21392 it is beyond the window edge; automatic hscroll will then
21393 scroll the window to show point as appropriate. */
21394 if (target_is_eol_p && it.line_wrap == TRUNCATE
21395 && get_next_display_element (&it))
21397 struct text_pos new_pos = it.current.pos;
21399 while (!ITERATOR_AT_END_OF_LINE_P (&it))
21401 set_iterator_to_next (&it, 0);
21402 if (it.method == GET_FROM_BUFFER)
21403 new_pos = it.current.pos;
21404 if (!get_next_display_element (&it))
21405 break;
21408 it.current.pos = new_pos;
21411 /* If we ended up in a display string that covers point, move to
21412 buffer position to the right in the visual order. */
21413 if (dir > 0)
21415 while (IT_CHARPOS (it) == PT)
21417 set_iterator_to_next (&it, 0);
21418 if (!get_next_display_element (&it))
21419 break;
21423 /* Move point to that position. */
21424 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21427 return make_number (PT);
21429 #undef ROW_GLYPH_NEWLINE_P
21433 /***********************************************************************
21434 Menu Bar
21435 ***********************************************************************/
21437 /* Redisplay the menu bar in the frame for window W.
21439 The menu bar of X frames that don't have X toolkit support is
21440 displayed in a special window W->frame->menu_bar_window.
21442 The menu bar of terminal frames is treated specially as far as
21443 glyph matrices are concerned. Menu bar lines are not part of
21444 windows, so the update is done directly on the frame matrix rows
21445 for the menu bar. */
21447 static void
21448 display_menu_bar (struct window *w)
21450 struct frame *f = XFRAME (WINDOW_FRAME (w));
21451 struct it it;
21452 Lisp_Object items;
21453 int i;
21455 /* Don't do all this for graphical frames. */
21456 #ifdef HAVE_NTGUI
21457 if (FRAME_W32_P (f))
21458 return;
21459 #endif
21460 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21461 if (FRAME_X_P (f))
21462 return;
21463 #endif
21465 #ifdef HAVE_NS
21466 if (FRAME_NS_P (f))
21467 return;
21468 #endif /* HAVE_NS */
21470 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21471 eassert (!FRAME_WINDOW_P (f));
21472 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
21473 it.first_visible_x = 0;
21474 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21475 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21476 if (FRAME_WINDOW_P (f))
21478 /* Menu bar lines are displayed in the desired matrix of the
21479 dummy window menu_bar_window. */
21480 struct window *menu_w;
21481 menu_w = XWINDOW (f->menu_bar_window);
21482 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
21483 MENU_FACE_ID);
21484 it.first_visible_x = 0;
21485 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21487 else
21488 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21490 /* This is a TTY frame, i.e. character hpos/vpos are used as
21491 pixel x/y. */
21492 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
21493 MENU_FACE_ID);
21494 it.first_visible_x = 0;
21495 it.last_visible_x = FRAME_COLS (f);
21498 /* FIXME: This should be controlled by a user option. See the
21499 comments in redisplay_tool_bar and display_mode_line about
21500 this. */
21501 it.paragraph_embedding = L2R;
21503 /* Clear all rows of the menu bar. */
21504 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
21506 struct glyph_row *row = it.glyph_row + i;
21507 clear_glyph_row (row);
21508 row->enabled_p = true;
21509 row->full_width_p = 1;
21512 /* Display all items of the menu bar. */
21513 items = FRAME_MENU_BAR_ITEMS (it.f);
21514 for (i = 0; i < ASIZE (items); i += 4)
21516 Lisp_Object string;
21518 /* Stop at nil string. */
21519 string = AREF (items, i + 1);
21520 if (NILP (string))
21521 break;
21523 /* Remember where item was displayed. */
21524 ASET (items, i + 3, make_number (it.hpos));
21526 /* Display the item, pad with one space. */
21527 if (it.current_x < it.last_visible_x)
21528 display_string (NULL, string, Qnil, 0, 0, &it,
21529 SCHARS (string) + 1, 0, 0, -1);
21532 /* Fill out the line with spaces. */
21533 if (it.current_x < it.last_visible_x)
21534 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
21536 /* Compute the total height of the lines. */
21537 compute_line_metrics (&it);
21540 /* Deep copy of a glyph row, including the glyphs. */
21541 static void
21542 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
21544 struct glyph *pointers[1 + LAST_AREA];
21545 int to_used = to->used[TEXT_AREA];
21547 /* Save glyph pointers of TO. */
21548 memcpy (pointers, to->glyphs, sizeof to->glyphs);
21550 /* Do a structure assignment. */
21551 *to = *from;
21553 /* Restore original glyph pointers of TO. */
21554 memcpy (to->glyphs, pointers, sizeof to->glyphs);
21556 /* Copy the glyphs. */
21557 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
21558 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
21560 /* If we filled only part of the TO row, fill the rest with
21561 space_glyph (which will display as empty space). */
21562 if (to_used > from->used[TEXT_AREA])
21563 fill_up_frame_row_with_spaces (to, to_used);
21566 /* Display one menu item on a TTY, by overwriting the glyphs in the
21567 frame F's desired glyph matrix with glyphs produced from the menu
21568 item text. Called from term.c to display TTY drop-down menus one
21569 item at a time.
21571 ITEM_TEXT is the menu item text as a C string.
21573 FACE_ID is the face ID to be used for this menu item. FACE_ID
21574 could specify one of 3 faces: a face for an enabled item, a face
21575 for a disabled item, or a face for a selected item.
21577 X and Y are coordinates of the first glyph in the frame's desired
21578 matrix to be overwritten by the menu item. Since this is a TTY, Y
21579 is the zero-based number of the glyph row and X is the zero-based
21580 glyph number in the row, starting from left, where to start
21581 displaying the item.
21583 SUBMENU non-zero means this menu item drops down a submenu, which
21584 should be indicated by displaying a proper visual cue after the
21585 item text. */
21587 void
21588 display_tty_menu_item (const char *item_text, int width, int face_id,
21589 int x, int y, int submenu)
21591 struct it it;
21592 struct frame *f = SELECTED_FRAME ();
21593 struct window *w = XWINDOW (f->selected_window);
21594 int saved_used, saved_truncated, saved_width, saved_reversed;
21595 struct glyph_row *row;
21596 size_t item_len = strlen (item_text);
21598 eassert (FRAME_TERMCAP_P (f));
21600 /* Don't write beyond the matrix's last row. This can happen for
21601 TTY screens that are not high enough to show the entire menu.
21602 (This is actually a bit of defensive programming, as
21603 tty_menu_display already limits the number of menu items to one
21604 less than the number of screen lines.) */
21605 if (y >= f->desired_matrix->nrows)
21606 return;
21608 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
21609 it.first_visible_x = 0;
21610 it.last_visible_x = FRAME_COLS (f) - 1;
21611 row = it.glyph_row;
21612 /* Start with the row contents from the current matrix. */
21613 deep_copy_glyph_row (row, f->current_matrix->rows + y);
21614 saved_width = row->full_width_p;
21615 row->full_width_p = 1;
21616 saved_reversed = row->reversed_p;
21617 row->reversed_p = 0;
21618 row->enabled_p = true;
21620 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21621 desired face. */
21622 eassert (x < f->desired_matrix->matrix_w);
21623 it.current_x = it.hpos = x;
21624 it.current_y = it.vpos = y;
21625 saved_used = row->used[TEXT_AREA];
21626 saved_truncated = row->truncated_on_right_p;
21627 row->used[TEXT_AREA] = x;
21628 it.face_id = face_id;
21629 it.line_wrap = TRUNCATE;
21631 /* FIXME: This should be controlled by a user option. See the
21632 comments in redisplay_tool_bar and display_mode_line about this.
21633 Also, if paragraph_embedding could ever be R2L, changes will be
21634 needed to avoid shifting to the right the row characters in
21635 term.c:append_glyph. */
21636 it.paragraph_embedding = L2R;
21638 /* Pad with a space on the left. */
21639 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
21640 width--;
21641 /* Display the menu item, pad with spaces to WIDTH. */
21642 if (submenu)
21644 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21645 item_len, 0, FRAME_COLS (f) - 1, -1);
21646 width -= item_len;
21647 /* Indicate with " >" that there's a submenu. */
21648 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
21649 FRAME_COLS (f) - 1, -1);
21651 else
21652 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21653 width, 0, FRAME_COLS (f) - 1, -1);
21655 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
21656 row->truncated_on_right_p = saved_truncated;
21657 row->hash = row_hash (row);
21658 row->full_width_p = saved_width;
21659 row->reversed_p = saved_reversed;
21662 /***********************************************************************
21663 Mode Line
21664 ***********************************************************************/
21666 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21667 FORCE is non-zero, redisplay mode lines unconditionally.
21668 Otherwise, redisplay only mode lines that are garbaged. Value is
21669 the number of windows whose mode lines were redisplayed. */
21671 static int
21672 redisplay_mode_lines (Lisp_Object window, bool force)
21674 int nwindows = 0;
21676 while (!NILP (window))
21678 struct window *w = XWINDOW (window);
21680 if (WINDOWP (w->contents))
21681 nwindows += redisplay_mode_lines (w->contents, force);
21682 else if (force
21683 || FRAME_GARBAGED_P (XFRAME (w->frame))
21684 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
21686 struct text_pos lpoint;
21687 struct buffer *old = current_buffer;
21689 /* Set the window's buffer for the mode line display. */
21690 SET_TEXT_POS (lpoint, PT, PT_BYTE);
21691 set_buffer_internal_1 (XBUFFER (w->contents));
21693 /* Point refers normally to the selected window. For any
21694 other window, set up appropriate value. */
21695 if (!EQ (window, selected_window))
21697 struct text_pos pt;
21699 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
21700 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
21703 /* Display mode lines. */
21704 clear_glyph_matrix (w->desired_matrix);
21705 if (display_mode_lines (w))
21706 ++nwindows;
21708 /* Restore old settings. */
21709 set_buffer_internal_1 (old);
21710 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
21713 window = w->next;
21716 return nwindows;
21720 /* Display the mode and/or header line of window W. Value is the
21721 sum number of mode lines and header lines displayed. */
21723 static int
21724 display_mode_lines (struct window *w)
21726 Lisp_Object old_selected_window = selected_window;
21727 Lisp_Object old_selected_frame = selected_frame;
21728 Lisp_Object new_frame = w->frame;
21729 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
21730 int n = 0;
21732 selected_frame = new_frame;
21733 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21734 or window's point, then we'd need select_window_1 here as well. */
21735 XSETWINDOW (selected_window, w);
21736 XFRAME (new_frame)->selected_window = selected_window;
21738 /* These will be set while the mode line specs are processed. */
21739 line_number_displayed = 0;
21740 w->column_number_displayed = -1;
21742 if (WINDOW_WANTS_MODELINE_P (w))
21744 struct window *sel_w = XWINDOW (old_selected_window);
21746 /* Select mode line face based on the real selected window. */
21747 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
21748 BVAR (current_buffer, mode_line_format));
21749 ++n;
21752 if (WINDOW_WANTS_HEADER_LINE_P (w))
21754 display_mode_line (w, HEADER_LINE_FACE_ID,
21755 BVAR (current_buffer, header_line_format));
21756 ++n;
21759 XFRAME (new_frame)->selected_window = old_frame_selected_window;
21760 selected_frame = old_selected_frame;
21761 selected_window = old_selected_window;
21762 if (n > 0)
21763 w->must_be_updated_p = true;
21764 return n;
21768 /* Display mode or header line of window W. FACE_ID specifies which
21769 line to display; it is either MODE_LINE_FACE_ID or
21770 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21771 display. Value is the pixel height of the mode/header line
21772 displayed. */
21774 static int
21775 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
21777 struct it it;
21778 struct face *face;
21779 ptrdiff_t count = SPECPDL_INDEX ();
21781 init_iterator (&it, w, -1, -1, NULL, face_id);
21782 /* Don't extend on a previously drawn mode-line.
21783 This may happen if called from pos_visible_p. */
21784 it.glyph_row->enabled_p = false;
21785 prepare_desired_row (w, it.glyph_row, true);
21787 it.glyph_row->mode_line_p = 1;
21789 /* FIXME: This should be controlled by a user option. But
21790 supporting such an option is not trivial, since the mode line is
21791 made up of many separate strings. */
21792 it.paragraph_embedding = L2R;
21794 record_unwind_protect (unwind_format_mode_line,
21795 format_mode_line_unwind_data (NULL, NULL, Qnil, 0));
21797 mode_line_target = MODE_LINE_DISPLAY;
21799 /* Temporarily make frame's keyboard the current kboard so that
21800 kboard-local variables in the mode_line_format will get the right
21801 values. */
21802 push_kboard (FRAME_KBOARD (it.f));
21803 record_unwind_save_match_data ();
21804 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
21805 pop_kboard ();
21807 unbind_to (count, Qnil);
21809 /* Fill up with spaces. */
21810 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
21812 compute_line_metrics (&it);
21813 it.glyph_row->full_width_p = 1;
21814 it.glyph_row->continued_p = 0;
21815 it.glyph_row->truncated_on_left_p = 0;
21816 it.glyph_row->truncated_on_right_p = 0;
21818 /* Make a 3D mode-line have a shadow at its right end. */
21819 face = FACE_FROM_ID (it.f, face_id);
21820 extend_face_to_end_of_line (&it);
21821 if (face->box != FACE_NO_BOX)
21823 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
21824 + it.glyph_row->used[TEXT_AREA] - 1);
21825 last->right_box_line_p = 1;
21828 return it.glyph_row->height;
21831 /* Move element ELT in LIST to the front of LIST.
21832 Return the updated list. */
21834 static Lisp_Object
21835 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
21837 register Lisp_Object tail, prev;
21838 register Lisp_Object tem;
21840 tail = list;
21841 prev = Qnil;
21842 while (CONSP (tail))
21844 tem = XCAR (tail);
21846 if (EQ (elt, tem))
21848 /* Splice out the link TAIL. */
21849 if (NILP (prev))
21850 list = XCDR (tail);
21851 else
21852 Fsetcdr (prev, XCDR (tail));
21854 /* Now make it the first. */
21855 Fsetcdr (tail, list);
21856 return tail;
21858 else
21859 prev = tail;
21860 tail = XCDR (tail);
21861 QUIT;
21864 /* Not found--return unchanged LIST. */
21865 return list;
21868 /* Contribute ELT to the mode line for window IT->w. How it
21869 translates into text depends on its data type.
21871 IT describes the display environment in which we display, as usual.
21873 DEPTH is the depth in recursion. It is used to prevent
21874 infinite recursion here.
21876 FIELD_WIDTH is the number of characters the display of ELT should
21877 occupy in the mode line, and PRECISION is the maximum number of
21878 characters to display from ELT's representation. See
21879 display_string for details.
21881 Returns the hpos of the end of the text generated by ELT.
21883 PROPS is a property list to add to any string we encounter.
21885 If RISKY is nonzero, remove (disregard) any properties in any string
21886 we encounter, and ignore :eval and :propertize.
21888 The global variable `mode_line_target' determines whether the
21889 output is passed to `store_mode_line_noprop',
21890 `store_mode_line_string', or `display_string'. */
21892 static int
21893 display_mode_element (struct it *it, int depth, int field_width, int precision,
21894 Lisp_Object elt, Lisp_Object props, int risky)
21896 int n = 0, field, prec;
21897 int literal = 0;
21899 tail_recurse:
21900 if (depth > 100)
21901 elt = build_string ("*too-deep*");
21903 depth++;
21905 switch (XTYPE (elt))
21907 case Lisp_String:
21909 /* A string: output it and check for %-constructs within it. */
21910 unsigned char c;
21911 ptrdiff_t offset = 0;
21913 if (SCHARS (elt) > 0
21914 && (!NILP (props) || risky))
21916 Lisp_Object oprops, aelt;
21917 oprops = Ftext_properties_at (make_number (0), elt);
21919 /* If the starting string's properties are not what
21920 we want, translate the string. Also, if the string
21921 is risky, do that anyway. */
21923 if (NILP (Fequal (props, oprops)) || risky)
21925 /* If the starting string has properties,
21926 merge the specified ones onto the existing ones. */
21927 if (! NILP (oprops) && !risky)
21929 Lisp_Object tem;
21931 oprops = Fcopy_sequence (oprops);
21932 tem = props;
21933 while (CONSP (tem))
21935 oprops = Fplist_put (oprops, XCAR (tem),
21936 XCAR (XCDR (tem)));
21937 tem = XCDR (XCDR (tem));
21939 props = oprops;
21942 aelt = Fassoc (elt, mode_line_proptrans_alist);
21943 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
21945 /* AELT is what we want. Move it to the front
21946 without consing. */
21947 elt = XCAR (aelt);
21948 mode_line_proptrans_alist
21949 = move_elt_to_front (aelt, mode_line_proptrans_alist);
21951 else
21953 Lisp_Object tem;
21955 /* If AELT has the wrong props, it is useless.
21956 so get rid of it. */
21957 if (! NILP (aelt))
21958 mode_line_proptrans_alist
21959 = Fdelq (aelt, mode_line_proptrans_alist);
21961 elt = Fcopy_sequence (elt);
21962 Fset_text_properties (make_number (0), Flength (elt),
21963 props, elt);
21964 /* Add this item to mode_line_proptrans_alist. */
21965 mode_line_proptrans_alist
21966 = Fcons (Fcons (elt, props),
21967 mode_line_proptrans_alist);
21968 /* Truncate mode_line_proptrans_alist
21969 to at most 50 elements. */
21970 tem = Fnthcdr (make_number (50),
21971 mode_line_proptrans_alist);
21972 if (! NILP (tem))
21973 XSETCDR (tem, Qnil);
21978 offset = 0;
21980 if (literal)
21982 prec = precision - n;
21983 switch (mode_line_target)
21985 case MODE_LINE_NOPROP:
21986 case MODE_LINE_TITLE:
21987 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
21988 break;
21989 case MODE_LINE_STRING:
21990 n += store_mode_line_string (NULL, elt, 1, 0, prec, Qnil);
21991 break;
21992 case MODE_LINE_DISPLAY:
21993 n += display_string (NULL, elt, Qnil, 0, 0, it,
21994 0, prec, 0, STRING_MULTIBYTE (elt));
21995 break;
21998 break;
22001 /* Handle the non-literal case. */
22003 while ((precision <= 0 || n < precision)
22004 && SREF (elt, offset) != 0
22005 && (mode_line_target != MODE_LINE_DISPLAY
22006 || it->current_x < it->last_visible_x))
22008 ptrdiff_t last_offset = offset;
22010 /* Advance to end of string or next format specifier. */
22011 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
22014 if (offset - 1 != last_offset)
22016 ptrdiff_t nchars, nbytes;
22018 /* Output to end of string or up to '%'. Field width
22019 is length of string. Don't output more than
22020 PRECISION allows us. */
22021 offset--;
22023 prec = c_string_width (SDATA (elt) + last_offset,
22024 offset - last_offset, precision - n,
22025 &nchars, &nbytes);
22027 switch (mode_line_target)
22029 case MODE_LINE_NOPROP:
22030 case MODE_LINE_TITLE:
22031 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
22032 break;
22033 case MODE_LINE_STRING:
22035 ptrdiff_t bytepos = last_offset;
22036 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22037 ptrdiff_t endpos = (precision <= 0
22038 ? string_byte_to_char (elt, offset)
22039 : charpos + nchars);
22041 n += store_mode_line_string (NULL,
22042 Fsubstring (elt, make_number (charpos),
22043 make_number (endpos)),
22044 0, 0, 0, Qnil);
22046 break;
22047 case MODE_LINE_DISPLAY:
22049 ptrdiff_t bytepos = last_offset;
22050 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
22052 if (precision <= 0)
22053 nchars = string_byte_to_char (elt, offset) - charpos;
22054 n += display_string (NULL, elt, Qnil, 0, charpos,
22055 it, 0, nchars, 0,
22056 STRING_MULTIBYTE (elt));
22058 break;
22061 else /* c == '%' */
22063 ptrdiff_t percent_position = offset;
22065 /* Get the specified minimum width. Zero means
22066 don't pad. */
22067 field = 0;
22068 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
22069 field = field * 10 + c - '0';
22071 /* Don't pad beyond the total padding allowed. */
22072 if (field_width - n > 0 && field > field_width - n)
22073 field = field_width - n;
22075 /* Note that either PRECISION <= 0 or N < PRECISION. */
22076 prec = precision - n;
22078 if (c == 'M')
22079 n += display_mode_element (it, depth, field, prec,
22080 Vglobal_mode_string, props,
22081 risky);
22082 else if (c != 0)
22084 bool multibyte;
22085 ptrdiff_t bytepos, charpos;
22086 const char *spec;
22087 Lisp_Object string;
22089 bytepos = percent_position;
22090 charpos = (STRING_MULTIBYTE (elt)
22091 ? string_byte_to_char (elt, bytepos)
22092 : bytepos);
22093 spec = decode_mode_spec (it->w, c, field, &string);
22094 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
22096 switch (mode_line_target)
22098 case MODE_LINE_NOPROP:
22099 case MODE_LINE_TITLE:
22100 n += store_mode_line_noprop (spec, field, prec);
22101 break;
22102 case MODE_LINE_STRING:
22104 Lisp_Object tem = build_string (spec);
22105 props = Ftext_properties_at (make_number (charpos), elt);
22106 /* Should only keep face property in props */
22107 n += store_mode_line_string (NULL, tem, 0, field, prec, props);
22109 break;
22110 case MODE_LINE_DISPLAY:
22112 int nglyphs_before, nwritten;
22114 nglyphs_before = it->glyph_row->used[TEXT_AREA];
22115 nwritten = display_string (spec, string, elt,
22116 charpos, 0, it,
22117 field, prec, 0,
22118 multibyte);
22120 /* Assign to the glyphs written above the
22121 string where the `%x' came from, position
22122 of the `%'. */
22123 if (nwritten > 0)
22125 struct glyph *glyph
22126 = (it->glyph_row->glyphs[TEXT_AREA]
22127 + nglyphs_before);
22128 int i;
22130 for (i = 0; i < nwritten; ++i)
22132 glyph[i].object = elt;
22133 glyph[i].charpos = charpos;
22136 n += nwritten;
22139 break;
22142 else /* c == 0 */
22143 break;
22147 break;
22149 case Lisp_Symbol:
22150 /* A symbol: process the value of the symbol recursively
22151 as if it appeared here directly. Avoid error if symbol void.
22152 Special case: if value of symbol is a string, output the string
22153 literally. */
22155 register Lisp_Object tem;
22157 /* If the variable is not marked as risky to set
22158 then its contents are risky to use. */
22159 if (NILP (Fget (elt, Qrisky_local_variable)))
22160 risky = 1;
22162 tem = Fboundp (elt);
22163 if (!NILP (tem))
22165 tem = Fsymbol_value (elt);
22166 /* If value is a string, output that string literally:
22167 don't check for % within it. */
22168 if (STRINGP (tem))
22169 literal = 1;
22171 if (!EQ (tem, elt))
22173 /* Give up right away for nil or t. */
22174 elt = tem;
22175 goto tail_recurse;
22179 break;
22181 case Lisp_Cons:
22183 register Lisp_Object car, tem;
22185 /* A cons cell: five distinct cases.
22186 If first element is :eval or :propertize, do something special.
22187 If first element is a string or a cons, process all the elements
22188 and effectively concatenate them.
22189 If first element is a negative number, truncate displaying cdr to
22190 at most that many characters. If positive, pad (with spaces)
22191 to at least that many characters.
22192 If first element is a symbol, process the cadr or caddr recursively
22193 according to whether the symbol's value is non-nil or nil. */
22194 car = XCAR (elt);
22195 if (EQ (car, QCeval))
22197 /* An element of the form (:eval FORM) means evaluate FORM
22198 and use the result as mode line elements. */
22200 if (risky)
22201 break;
22203 if (CONSP (XCDR (elt)))
22205 Lisp_Object spec;
22206 spec = safe__eval (true, XCAR (XCDR (elt)));
22207 n += display_mode_element (it, depth, field_width - n,
22208 precision - n, spec, props,
22209 risky);
22212 else if (EQ (car, QCpropertize))
22214 /* An element of the form (:propertize ELT PROPS...)
22215 means display ELT but applying properties PROPS. */
22217 if (risky)
22218 break;
22220 if (CONSP (XCDR (elt)))
22221 n += display_mode_element (it, depth, field_width - n,
22222 precision - n, XCAR (XCDR (elt)),
22223 XCDR (XCDR (elt)), risky);
22225 else if (SYMBOLP (car))
22227 tem = Fboundp (car);
22228 elt = XCDR (elt);
22229 if (!CONSP (elt))
22230 goto invalid;
22231 /* elt is now the cdr, and we know it is a cons cell.
22232 Use its car if CAR has a non-nil value. */
22233 if (!NILP (tem))
22235 tem = Fsymbol_value (car);
22236 if (!NILP (tem))
22238 elt = XCAR (elt);
22239 goto tail_recurse;
22242 /* Symbol's value is nil (or symbol is unbound)
22243 Get the cddr of the original list
22244 and if possible find the caddr and use that. */
22245 elt = XCDR (elt);
22246 if (NILP (elt))
22247 break;
22248 else if (!CONSP (elt))
22249 goto invalid;
22250 elt = XCAR (elt);
22251 goto tail_recurse;
22253 else if (INTEGERP (car))
22255 register int lim = XINT (car);
22256 elt = XCDR (elt);
22257 if (lim < 0)
22259 /* Negative int means reduce maximum width. */
22260 if (precision <= 0)
22261 precision = -lim;
22262 else
22263 precision = min (precision, -lim);
22265 else if (lim > 0)
22267 /* Padding specified. Don't let it be more than
22268 current maximum. */
22269 if (precision > 0)
22270 lim = min (precision, lim);
22272 /* If that's more padding than already wanted, queue it.
22273 But don't reduce padding already specified even if
22274 that is beyond the current truncation point. */
22275 field_width = max (lim, field_width);
22277 goto tail_recurse;
22279 else if (STRINGP (car) || CONSP (car))
22281 Lisp_Object halftail = elt;
22282 int len = 0;
22284 while (CONSP (elt)
22285 && (precision <= 0 || n < precision))
22287 n += display_mode_element (it, depth,
22288 /* Do padding only after the last
22289 element in the list. */
22290 (! CONSP (XCDR (elt))
22291 ? field_width - n
22292 : 0),
22293 precision - n, XCAR (elt),
22294 props, risky);
22295 elt = XCDR (elt);
22296 len++;
22297 if ((len & 1) == 0)
22298 halftail = XCDR (halftail);
22299 /* Check for cycle. */
22300 if (EQ (halftail, elt))
22301 break;
22305 break;
22307 default:
22308 invalid:
22309 elt = build_string ("*invalid*");
22310 goto tail_recurse;
22313 /* Pad to FIELD_WIDTH. */
22314 if (field_width > 0 && n < field_width)
22316 switch (mode_line_target)
22318 case MODE_LINE_NOPROP:
22319 case MODE_LINE_TITLE:
22320 n += store_mode_line_noprop ("", field_width - n, 0);
22321 break;
22322 case MODE_LINE_STRING:
22323 n += store_mode_line_string ("", Qnil, 0, field_width - n, 0, Qnil);
22324 break;
22325 case MODE_LINE_DISPLAY:
22326 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22327 0, 0, 0);
22328 break;
22332 return n;
22335 /* Store a mode-line string element in mode_line_string_list.
22337 If STRING is non-null, display that C string. Otherwise, the Lisp
22338 string LISP_STRING is displayed.
22340 FIELD_WIDTH is the minimum number of output glyphs to produce.
22341 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22342 with spaces. FIELD_WIDTH <= 0 means don't pad.
22344 PRECISION is the maximum number of characters to output from
22345 STRING. PRECISION <= 0 means don't truncate the string.
22347 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22348 properties to the string.
22350 PROPS are the properties to add to the string.
22351 The mode_line_string_face face property is always added to the string.
22354 static int
22355 store_mode_line_string (const char *string, Lisp_Object lisp_string, int copy_string,
22356 int field_width, int precision, Lisp_Object props)
22358 ptrdiff_t len;
22359 int n = 0;
22361 if (string != NULL)
22363 len = strlen (string);
22364 if (precision > 0 && len > precision)
22365 len = precision;
22366 lisp_string = make_string (string, len);
22367 if (NILP (props))
22368 props = mode_line_string_face_prop;
22369 else if (!NILP (mode_line_string_face))
22371 Lisp_Object face = Fplist_get (props, Qface);
22372 props = Fcopy_sequence (props);
22373 if (NILP (face))
22374 face = mode_line_string_face;
22375 else
22376 face = list2 (face, mode_line_string_face);
22377 props = Fplist_put (props, Qface, face);
22379 Fadd_text_properties (make_number (0), make_number (len),
22380 props, lisp_string);
22382 else
22384 len = XFASTINT (Flength (lisp_string));
22385 if (precision > 0 && len > precision)
22387 len = precision;
22388 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
22389 precision = -1;
22391 if (!NILP (mode_line_string_face))
22393 Lisp_Object face;
22394 if (NILP (props))
22395 props = Ftext_properties_at (make_number (0), lisp_string);
22396 face = Fplist_get (props, Qface);
22397 if (NILP (face))
22398 face = mode_line_string_face;
22399 else
22400 face = list2 (face, mode_line_string_face);
22401 props = list2 (Qface, face);
22402 if (copy_string)
22403 lisp_string = Fcopy_sequence (lisp_string);
22405 if (!NILP (props))
22406 Fadd_text_properties (make_number (0), make_number (len),
22407 props, lisp_string);
22410 if (len > 0)
22412 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22413 n += len;
22416 if (field_width > len)
22418 field_width -= len;
22419 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
22420 if (!NILP (props))
22421 Fadd_text_properties (make_number (0), make_number (field_width),
22422 props, lisp_string);
22423 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22424 n += field_width;
22427 return n;
22431 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
22432 1, 4, 0,
22433 doc: /* Format a string out of a mode line format specification.
22434 First arg FORMAT specifies the mode line format (see `mode-line-format'
22435 for details) to use.
22437 By default, the format is evaluated for the currently selected window.
22439 Optional second arg FACE specifies the face property to put on all
22440 characters for which no face is specified. The value nil means the
22441 default face. The value t means whatever face the window's mode line
22442 currently uses (either `mode-line' or `mode-line-inactive',
22443 depending on whether the window is the selected window or not).
22444 An integer value means the value string has no text
22445 properties.
22447 Optional third and fourth args WINDOW and BUFFER specify the window
22448 and buffer to use as the context for the formatting (defaults
22449 are the selected window and the WINDOW's buffer). */)
22450 (Lisp_Object format, Lisp_Object face,
22451 Lisp_Object window, Lisp_Object buffer)
22453 struct it it;
22454 int len;
22455 struct window *w;
22456 struct buffer *old_buffer = NULL;
22457 int face_id;
22458 int no_props = INTEGERP (face);
22459 ptrdiff_t count = SPECPDL_INDEX ();
22460 Lisp_Object str;
22461 int string_start = 0;
22463 w = decode_any_window (window);
22464 XSETWINDOW (window, w);
22466 if (NILP (buffer))
22467 buffer = w->contents;
22468 CHECK_BUFFER (buffer);
22470 /* Make formatting the modeline a non-op when noninteractive, otherwise
22471 there will be problems later caused by a partially initialized frame. */
22472 if (NILP (format) || noninteractive)
22473 return empty_unibyte_string;
22475 if (no_props)
22476 face = Qnil;
22478 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
22479 : EQ (face, Qt) ? (EQ (window, selected_window)
22480 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
22481 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
22482 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
22483 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
22484 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
22485 : DEFAULT_FACE_ID;
22487 old_buffer = current_buffer;
22489 /* Save things including mode_line_proptrans_alist,
22490 and set that to nil so that we don't alter the outer value. */
22491 record_unwind_protect (unwind_format_mode_line,
22492 format_mode_line_unwind_data
22493 (XFRAME (WINDOW_FRAME (w)),
22494 old_buffer, selected_window, 1));
22495 mode_line_proptrans_alist = Qnil;
22497 Fselect_window (window, Qt);
22498 set_buffer_internal_1 (XBUFFER (buffer));
22500 init_iterator (&it, w, -1, -1, NULL, face_id);
22502 if (no_props)
22504 mode_line_target = MODE_LINE_NOPROP;
22505 mode_line_string_face_prop = Qnil;
22506 mode_line_string_list = Qnil;
22507 string_start = MODE_LINE_NOPROP_LEN (0);
22509 else
22511 mode_line_target = MODE_LINE_STRING;
22512 mode_line_string_list = Qnil;
22513 mode_line_string_face = face;
22514 mode_line_string_face_prop
22515 = NILP (face) ? Qnil : list2 (Qface, face);
22518 push_kboard (FRAME_KBOARD (it.f));
22519 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
22520 pop_kboard ();
22522 if (no_props)
22524 len = MODE_LINE_NOPROP_LEN (string_start);
22525 str = make_string (mode_line_noprop_buf + string_start, len);
22527 else
22529 mode_line_string_list = Fnreverse (mode_line_string_list);
22530 str = Fmapconcat (intern ("identity"), mode_line_string_list,
22531 empty_unibyte_string);
22534 unbind_to (count, Qnil);
22535 return str;
22538 /* Write a null-terminated, right justified decimal representation of
22539 the positive integer D to BUF using a minimal field width WIDTH. */
22541 static void
22542 pint2str (register char *buf, register int width, register ptrdiff_t d)
22544 register char *p = buf;
22546 if (d <= 0)
22547 *p++ = '0';
22548 else
22550 while (d > 0)
22552 *p++ = d % 10 + '0';
22553 d /= 10;
22557 for (width -= (int) (p - buf); width > 0; --width)
22558 *p++ = ' ';
22559 *p-- = '\0';
22560 while (p > buf)
22562 d = *buf;
22563 *buf++ = *p;
22564 *p-- = d;
22568 /* Write a null-terminated, right justified decimal and "human
22569 readable" representation of the nonnegative integer D to BUF using
22570 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22572 static const char power_letter[] =
22574 0, /* no letter */
22575 'k', /* kilo */
22576 'M', /* mega */
22577 'G', /* giga */
22578 'T', /* tera */
22579 'P', /* peta */
22580 'E', /* exa */
22581 'Z', /* zetta */
22582 'Y' /* yotta */
22585 static void
22586 pint2hrstr (char *buf, int width, ptrdiff_t d)
22588 /* We aim to represent the nonnegative integer D as
22589 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22590 ptrdiff_t quotient = d;
22591 int remainder = 0;
22592 /* -1 means: do not use TENTHS. */
22593 int tenths = -1;
22594 int exponent = 0;
22596 /* Length of QUOTIENT.TENTHS as a string. */
22597 int length;
22599 char * psuffix;
22600 char * p;
22602 if (quotient >= 1000)
22604 /* Scale to the appropriate EXPONENT. */
22607 remainder = quotient % 1000;
22608 quotient /= 1000;
22609 exponent++;
22611 while (quotient >= 1000);
22613 /* Round to nearest and decide whether to use TENTHS or not. */
22614 if (quotient <= 9)
22616 tenths = remainder / 100;
22617 if (remainder % 100 >= 50)
22619 if (tenths < 9)
22620 tenths++;
22621 else
22623 quotient++;
22624 if (quotient == 10)
22625 tenths = -1;
22626 else
22627 tenths = 0;
22631 else
22632 if (remainder >= 500)
22634 if (quotient < 999)
22635 quotient++;
22636 else
22638 quotient = 1;
22639 exponent++;
22640 tenths = 0;
22645 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22646 if (tenths == -1 && quotient <= 99)
22647 if (quotient <= 9)
22648 length = 1;
22649 else
22650 length = 2;
22651 else
22652 length = 3;
22653 p = psuffix = buf + max (width, length);
22655 /* Print EXPONENT. */
22656 *psuffix++ = power_letter[exponent];
22657 *psuffix = '\0';
22659 /* Print TENTHS. */
22660 if (tenths >= 0)
22662 *--p = '0' + tenths;
22663 *--p = '.';
22666 /* Print QUOTIENT. */
22669 int digit = quotient % 10;
22670 *--p = '0' + digit;
22672 while ((quotient /= 10) != 0);
22674 /* Print leading spaces. */
22675 while (buf < p)
22676 *--p = ' ';
22679 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22680 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22681 type of CODING_SYSTEM. Return updated pointer into BUF. */
22683 static unsigned char invalid_eol_type[] = "(*invalid*)";
22685 static char *
22686 decode_mode_spec_coding (Lisp_Object coding_system, register char *buf, int eol_flag)
22688 Lisp_Object val;
22689 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
22690 const unsigned char *eol_str;
22691 int eol_str_len;
22692 /* The EOL conversion we are using. */
22693 Lisp_Object eoltype;
22695 val = CODING_SYSTEM_SPEC (coding_system);
22696 eoltype = Qnil;
22698 if (!VECTORP (val)) /* Not yet decided. */
22700 *buf++ = multibyte ? '-' : ' ';
22701 if (eol_flag)
22702 eoltype = eol_mnemonic_undecided;
22703 /* Don't mention EOL conversion if it isn't decided. */
22705 else
22707 Lisp_Object attrs;
22708 Lisp_Object eolvalue;
22710 attrs = AREF (val, 0);
22711 eolvalue = AREF (val, 2);
22713 *buf++ = multibyte
22714 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
22715 : ' ';
22717 if (eol_flag)
22719 /* The EOL conversion that is normal on this system. */
22721 if (NILP (eolvalue)) /* Not yet decided. */
22722 eoltype = eol_mnemonic_undecided;
22723 else if (VECTORP (eolvalue)) /* Not yet decided. */
22724 eoltype = eol_mnemonic_undecided;
22725 else /* eolvalue is Qunix, Qdos, or Qmac. */
22726 eoltype = (EQ (eolvalue, Qunix)
22727 ? eol_mnemonic_unix
22728 : (EQ (eolvalue, Qdos) == 1
22729 ? eol_mnemonic_dos : eol_mnemonic_mac));
22733 if (eol_flag)
22735 /* Mention the EOL conversion if it is not the usual one. */
22736 if (STRINGP (eoltype))
22738 eol_str = SDATA (eoltype);
22739 eol_str_len = SBYTES (eoltype);
22741 else if (CHARACTERP (eoltype))
22743 unsigned char *tmp = alloca (MAX_MULTIBYTE_LENGTH);
22744 int c = XFASTINT (eoltype);
22745 eol_str_len = CHAR_STRING (c, tmp);
22746 eol_str = tmp;
22748 else
22750 eol_str = invalid_eol_type;
22751 eol_str_len = sizeof (invalid_eol_type) - 1;
22753 memcpy (buf, eol_str, eol_str_len);
22754 buf += eol_str_len;
22757 return buf;
22760 /* Return a string for the output of a mode line %-spec for window W,
22761 generated by character C. FIELD_WIDTH > 0 means pad the string
22762 returned with spaces to that value. Return a Lisp string in
22763 *STRING if the resulting string is taken from that Lisp string.
22765 Note we operate on the current buffer for most purposes. */
22767 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22769 static const char *
22770 decode_mode_spec (struct window *w, register int c, int field_width,
22771 Lisp_Object *string)
22773 Lisp_Object obj;
22774 struct frame *f = XFRAME (WINDOW_FRAME (w));
22775 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
22776 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22777 produce strings from numerical values, so limit preposterously
22778 large values of FIELD_WIDTH to avoid overrunning the buffer's
22779 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22780 bytes plus the terminating null. */
22781 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
22782 struct buffer *b = current_buffer;
22784 obj = Qnil;
22785 *string = Qnil;
22787 switch (c)
22789 case '*':
22790 if (!NILP (BVAR (b, read_only)))
22791 return "%";
22792 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22793 return "*";
22794 return "-";
22796 case '+':
22797 /* This differs from %* only for a modified read-only buffer. */
22798 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22799 return "*";
22800 if (!NILP (BVAR (b, read_only)))
22801 return "%";
22802 return "-";
22804 case '&':
22805 /* This differs from %* in ignoring read-only-ness. */
22806 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22807 return "*";
22808 return "-";
22810 case '%':
22811 return "%";
22813 case '[':
22815 int i;
22816 char *p;
22818 if (command_loop_level > 5)
22819 return "[[[... ";
22820 p = decode_mode_spec_buf;
22821 for (i = 0; i < command_loop_level; i++)
22822 *p++ = '[';
22823 *p = 0;
22824 return decode_mode_spec_buf;
22827 case ']':
22829 int i;
22830 char *p;
22832 if (command_loop_level > 5)
22833 return " ...]]]";
22834 p = decode_mode_spec_buf;
22835 for (i = 0; i < command_loop_level; i++)
22836 *p++ = ']';
22837 *p = 0;
22838 return decode_mode_spec_buf;
22841 case '-':
22843 register int i;
22845 /* Let lots_of_dashes be a string of infinite length. */
22846 if (mode_line_target == MODE_LINE_NOPROP
22847 || mode_line_target == MODE_LINE_STRING)
22848 return "--";
22849 if (field_width <= 0
22850 || field_width > sizeof (lots_of_dashes))
22852 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
22853 decode_mode_spec_buf[i] = '-';
22854 decode_mode_spec_buf[i] = '\0';
22855 return decode_mode_spec_buf;
22857 else
22858 return lots_of_dashes;
22861 case 'b':
22862 obj = BVAR (b, name);
22863 break;
22865 case 'c':
22866 /* %c and %l are ignored in `frame-title-format'.
22867 (In redisplay_internal, the frame title is drawn _before_ the
22868 windows are updated, so the stuff which depends on actual
22869 window contents (such as %l) may fail to render properly, or
22870 even crash emacs.) */
22871 if (mode_line_target == MODE_LINE_TITLE)
22872 return "";
22873 else
22875 ptrdiff_t col = current_column ();
22876 w->column_number_displayed = col;
22877 pint2str (decode_mode_spec_buf, width, col);
22878 return decode_mode_spec_buf;
22881 case 'e':
22882 #ifndef SYSTEM_MALLOC
22884 if (NILP (Vmemory_full))
22885 return "";
22886 else
22887 return "!MEM FULL! ";
22889 #else
22890 return "";
22891 #endif
22893 case 'F':
22894 /* %F displays the frame name. */
22895 if (!NILP (f->title))
22896 return SSDATA (f->title);
22897 if (f->explicit_name || ! FRAME_WINDOW_P (f))
22898 return SSDATA (f->name);
22899 return "Emacs";
22901 case 'f':
22902 obj = BVAR (b, filename);
22903 break;
22905 case 'i':
22907 ptrdiff_t size = ZV - BEGV;
22908 pint2str (decode_mode_spec_buf, width, size);
22909 return decode_mode_spec_buf;
22912 case 'I':
22914 ptrdiff_t size = ZV - BEGV;
22915 pint2hrstr (decode_mode_spec_buf, width, size);
22916 return decode_mode_spec_buf;
22919 case 'l':
22921 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
22922 ptrdiff_t topline, nlines, height;
22923 ptrdiff_t junk;
22925 /* %c and %l are ignored in `frame-title-format'. */
22926 if (mode_line_target == MODE_LINE_TITLE)
22927 return "";
22929 startpos = marker_position (w->start);
22930 startpos_byte = marker_byte_position (w->start);
22931 height = WINDOW_TOTAL_LINES (w);
22933 /* If we decided that this buffer isn't suitable for line numbers,
22934 don't forget that too fast. */
22935 if (w->base_line_pos == -1)
22936 goto no_value;
22938 /* If the buffer is very big, don't waste time. */
22939 if (INTEGERP (Vline_number_display_limit)
22940 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
22942 w->base_line_pos = 0;
22943 w->base_line_number = 0;
22944 goto no_value;
22947 if (w->base_line_number > 0
22948 && w->base_line_pos > 0
22949 && w->base_line_pos <= startpos)
22951 line = w->base_line_number;
22952 linepos = w->base_line_pos;
22953 linepos_byte = buf_charpos_to_bytepos (b, linepos);
22955 else
22957 line = 1;
22958 linepos = BUF_BEGV (b);
22959 linepos_byte = BUF_BEGV_BYTE (b);
22962 /* Count lines from base line to window start position. */
22963 nlines = display_count_lines (linepos_byte,
22964 startpos_byte,
22965 startpos, &junk);
22967 topline = nlines + line;
22969 /* Determine a new base line, if the old one is too close
22970 or too far away, or if we did not have one.
22971 "Too close" means it's plausible a scroll-down would
22972 go back past it. */
22973 if (startpos == BUF_BEGV (b))
22975 w->base_line_number = topline;
22976 w->base_line_pos = BUF_BEGV (b);
22978 else if (nlines < height + 25 || nlines > height * 3 + 50
22979 || linepos == BUF_BEGV (b))
22981 ptrdiff_t limit = BUF_BEGV (b);
22982 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
22983 ptrdiff_t position;
22984 ptrdiff_t distance =
22985 (height * 2 + 30) * line_number_display_limit_width;
22987 if (startpos - distance > limit)
22989 limit = startpos - distance;
22990 limit_byte = CHAR_TO_BYTE (limit);
22993 nlines = display_count_lines (startpos_byte,
22994 limit_byte,
22995 - (height * 2 + 30),
22996 &position);
22997 /* If we couldn't find the lines we wanted within
22998 line_number_display_limit_width chars per line,
22999 give up on line numbers for this window. */
23000 if (position == limit_byte && limit == startpos - distance)
23002 w->base_line_pos = -1;
23003 w->base_line_number = 0;
23004 goto no_value;
23007 w->base_line_number = topline - nlines;
23008 w->base_line_pos = BYTE_TO_CHAR (position);
23011 /* Now count lines from the start pos to point. */
23012 nlines = display_count_lines (startpos_byte,
23013 PT_BYTE, PT, &junk);
23015 /* Record that we did display the line number. */
23016 line_number_displayed = 1;
23018 /* Make the string to show. */
23019 pint2str (decode_mode_spec_buf, width, topline + nlines);
23020 return decode_mode_spec_buf;
23021 no_value:
23023 char* p = decode_mode_spec_buf;
23024 int pad = width - 2;
23025 while (pad-- > 0)
23026 *p++ = ' ';
23027 *p++ = '?';
23028 *p++ = '?';
23029 *p = '\0';
23030 return decode_mode_spec_buf;
23033 break;
23035 case 'm':
23036 obj = BVAR (b, mode_name);
23037 break;
23039 case 'n':
23040 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
23041 return " Narrow";
23042 break;
23044 case 'p':
23046 ptrdiff_t pos = marker_position (w->start);
23047 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23049 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
23051 if (pos <= BUF_BEGV (b))
23052 return "All";
23053 else
23054 return "Bottom";
23056 else if (pos <= BUF_BEGV (b))
23057 return "Top";
23058 else
23060 if (total > 1000000)
23061 /* Do it differently for a large value, to avoid overflow. */
23062 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23063 else
23064 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
23065 /* We can't normally display a 3-digit number,
23066 so get us a 2-digit number that is close. */
23067 if (total == 100)
23068 total = 99;
23069 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23070 return decode_mode_spec_buf;
23074 /* Display percentage of size above the bottom of the screen. */
23075 case 'P':
23077 ptrdiff_t toppos = marker_position (w->start);
23078 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
23079 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23081 if (botpos >= BUF_ZV (b))
23083 if (toppos <= BUF_BEGV (b))
23084 return "All";
23085 else
23086 return "Bottom";
23088 else
23090 if (total > 1000000)
23091 /* Do it differently for a large value, to avoid overflow. */
23092 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23093 else
23094 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
23095 /* We can't normally display a 3-digit number,
23096 so get us a 2-digit number that is close. */
23097 if (total == 100)
23098 total = 99;
23099 if (toppos <= BUF_BEGV (b))
23100 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
23101 else
23102 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23103 return decode_mode_spec_buf;
23107 case 's':
23108 /* status of process */
23109 obj = Fget_buffer_process (Fcurrent_buffer ());
23110 if (NILP (obj))
23111 return "no process";
23112 #ifndef MSDOS
23113 obj = Fsymbol_name (Fprocess_status (obj));
23114 #endif
23115 break;
23117 case '@':
23119 ptrdiff_t count = inhibit_garbage_collection ();
23120 Lisp_Object curdir = BVAR (current_buffer, directory);
23121 Lisp_Object val = Qnil;
23123 if (STRINGP (curdir))
23124 val = call1 (intern ("file-remote-p"), curdir);
23126 unbind_to (count, Qnil);
23128 if (NILP (val))
23129 return "-";
23130 else
23131 return "@";
23134 case 'z':
23135 /* coding-system (not including end-of-line format) */
23136 case 'Z':
23137 /* coding-system (including end-of-line type) */
23139 int eol_flag = (c == 'Z');
23140 char *p = decode_mode_spec_buf;
23142 if (! FRAME_WINDOW_P (f))
23144 /* No need to mention EOL here--the terminal never needs
23145 to do EOL conversion. */
23146 p = decode_mode_spec_coding (CODING_ID_NAME
23147 (FRAME_KEYBOARD_CODING (f)->id),
23148 p, 0);
23149 p = decode_mode_spec_coding (CODING_ID_NAME
23150 (FRAME_TERMINAL_CODING (f)->id),
23151 p, 0);
23153 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
23154 p, eol_flag);
23156 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23157 #ifdef subprocesses
23158 obj = Fget_buffer_process (Fcurrent_buffer ());
23159 if (PROCESSP (obj))
23161 p = decode_mode_spec_coding
23162 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
23163 p = decode_mode_spec_coding
23164 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
23166 #endif /* subprocesses */
23167 #endif /* 0 */
23168 *p = 0;
23169 return decode_mode_spec_buf;
23173 if (STRINGP (obj))
23175 *string = obj;
23176 return SSDATA (obj);
23178 else
23179 return "";
23183 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23184 means count lines back from START_BYTE. But don't go beyond
23185 LIMIT_BYTE. Return the number of lines thus found (always
23186 nonnegative).
23188 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23189 either the position COUNT lines after/before START_BYTE, if we
23190 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23191 COUNT lines. */
23193 static ptrdiff_t
23194 display_count_lines (ptrdiff_t start_byte,
23195 ptrdiff_t limit_byte, ptrdiff_t count,
23196 ptrdiff_t *byte_pos_ptr)
23198 register unsigned char *cursor;
23199 unsigned char *base;
23201 register ptrdiff_t ceiling;
23202 register unsigned char *ceiling_addr;
23203 ptrdiff_t orig_count = count;
23205 /* If we are not in selective display mode,
23206 check only for newlines. */
23207 int selective_display = (!NILP (BVAR (current_buffer, selective_display))
23208 && !INTEGERP (BVAR (current_buffer, selective_display)));
23210 if (count > 0)
23212 while (start_byte < limit_byte)
23214 ceiling = BUFFER_CEILING_OF (start_byte);
23215 ceiling = min (limit_byte - 1, ceiling);
23216 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
23217 base = (cursor = BYTE_POS_ADDR (start_byte));
23221 if (selective_display)
23223 while (*cursor != '\n' && *cursor != 015
23224 && ++cursor != ceiling_addr)
23225 continue;
23226 if (cursor == ceiling_addr)
23227 break;
23229 else
23231 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
23232 if (! cursor)
23233 break;
23236 cursor++;
23238 if (--count == 0)
23240 start_byte += cursor - base;
23241 *byte_pos_ptr = start_byte;
23242 return orig_count;
23245 while (cursor < ceiling_addr);
23247 start_byte += ceiling_addr - base;
23250 else
23252 while (start_byte > limit_byte)
23254 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
23255 ceiling = max (limit_byte, ceiling);
23256 ceiling_addr = BYTE_POS_ADDR (ceiling);
23257 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
23258 while (1)
23260 if (selective_display)
23262 while (--cursor >= ceiling_addr
23263 && *cursor != '\n' && *cursor != 015)
23264 continue;
23265 if (cursor < ceiling_addr)
23266 break;
23268 else
23270 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
23271 if (! cursor)
23272 break;
23275 if (++count == 0)
23277 start_byte += cursor - base + 1;
23278 *byte_pos_ptr = start_byte;
23279 /* When scanning backwards, we should
23280 not count the newline posterior to which we stop. */
23281 return - orig_count - 1;
23284 start_byte += ceiling_addr - base;
23288 *byte_pos_ptr = limit_byte;
23290 if (count < 0)
23291 return - orig_count + count;
23292 return orig_count - count;
23298 /***********************************************************************
23299 Displaying strings
23300 ***********************************************************************/
23302 /* Display a NUL-terminated string, starting with index START.
23304 If STRING is non-null, display that C string. Otherwise, the Lisp
23305 string LISP_STRING is displayed. There's a case that STRING is
23306 non-null and LISP_STRING is not nil. It means STRING is a string
23307 data of LISP_STRING. In that case, we display LISP_STRING while
23308 ignoring its text properties.
23310 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23311 FACE_STRING. Display STRING or LISP_STRING with the face at
23312 FACE_STRING_POS in FACE_STRING:
23314 Display the string in the environment given by IT, but use the
23315 standard display table, temporarily.
23317 FIELD_WIDTH is the minimum number of output glyphs to produce.
23318 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23319 with spaces. If STRING has more characters, more than FIELD_WIDTH
23320 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23322 PRECISION is the maximum number of characters to output from
23323 STRING. PRECISION < 0 means don't truncate the string.
23325 This is roughly equivalent to printf format specifiers:
23327 FIELD_WIDTH PRECISION PRINTF
23328 ----------------------------------------
23329 -1 -1 %s
23330 -1 10 %.10s
23331 10 -1 %10s
23332 20 10 %20.10s
23334 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23335 display them, and < 0 means obey the current buffer's value of
23336 enable_multibyte_characters.
23338 Value is the number of columns displayed. */
23340 static int
23341 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23342 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23343 int field_width, int precision, int max_x, int multibyte)
23345 int hpos_at_start = it->hpos;
23346 int saved_face_id = it->face_id;
23347 struct glyph_row *row = it->glyph_row;
23348 ptrdiff_t it_charpos;
23350 /* Initialize the iterator IT for iteration over STRING beginning
23351 with index START. */
23352 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23353 precision, field_width, multibyte);
23354 if (string && STRINGP (lisp_string))
23355 /* LISP_STRING is the one returned by decode_mode_spec. We should
23356 ignore its text properties. */
23357 it->stop_charpos = it->end_charpos;
23359 /* If displaying STRING, set up the face of the iterator from
23360 FACE_STRING, if that's given. */
23361 if (STRINGP (face_string))
23363 ptrdiff_t endptr;
23364 struct face *face;
23366 it->face_id
23367 = face_at_string_position (it->w, face_string, face_string_pos,
23368 0, &endptr, it->base_face_id, 0);
23369 face = FACE_FROM_ID (it->f, it->face_id);
23370 it->face_box_p = face->box != FACE_NO_BOX;
23373 /* Set max_x to the maximum allowed X position. Don't let it go
23374 beyond the right edge of the window. */
23375 if (max_x <= 0)
23376 max_x = it->last_visible_x;
23377 else
23378 max_x = min (max_x, it->last_visible_x);
23380 /* Skip over display elements that are not visible. because IT->w is
23381 hscrolled. */
23382 if (it->current_x < it->first_visible_x)
23383 move_it_in_display_line_to (it, 100000, it->first_visible_x,
23384 MOVE_TO_POS | MOVE_TO_X);
23386 row->ascent = it->max_ascent;
23387 row->height = it->max_ascent + it->max_descent;
23388 row->phys_ascent = it->max_phys_ascent;
23389 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
23390 row->extra_line_spacing = it->max_extra_line_spacing;
23392 if (STRINGP (it->string))
23393 it_charpos = IT_STRING_CHARPOS (*it);
23394 else
23395 it_charpos = IT_CHARPOS (*it);
23397 /* This condition is for the case that we are called with current_x
23398 past last_visible_x. */
23399 while (it->current_x < max_x)
23401 int x_before, x, n_glyphs_before, i, nglyphs;
23403 /* Get the next display element. */
23404 if (!get_next_display_element (it))
23405 break;
23407 /* Produce glyphs. */
23408 x_before = it->current_x;
23409 n_glyphs_before = row->used[TEXT_AREA];
23410 PRODUCE_GLYPHS (it);
23412 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
23413 i = 0;
23414 x = x_before;
23415 while (i < nglyphs)
23417 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
23419 if (it->line_wrap != TRUNCATE
23420 && x + glyph->pixel_width > max_x)
23422 /* End of continued line or max_x reached. */
23423 if (CHAR_GLYPH_PADDING_P (*glyph))
23425 /* A wide character is unbreakable. */
23426 if (row->reversed_p)
23427 unproduce_glyphs (it, row->used[TEXT_AREA]
23428 - n_glyphs_before);
23429 row->used[TEXT_AREA] = n_glyphs_before;
23430 it->current_x = x_before;
23432 else
23434 if (row->reversed_p)
23435 unproduce_glyphs (it, row->used[TEXT_AREA]
23436 - (n_glyphs_before + i));
23437 row->used[TEXT_AREA] = n_glyphs_before + i;
23438 it->current_x = x;
23440 break;
23442 else if (x + glyph->pixel_width >= it->first_visible_x)
23444 /* Glyph is at least partially visible. */
23445 ++it->hpos;
23446 if (x < it->first_visible_x)
23447 row->x = x - it->first_visible_x;
23449 else
23451 /* Glyph is off the left margin of the display area.
23452 Should not happen. */
23453 emacs_abort ();
23456 row->ascent = max (row->ascent, it->max_ascent);
23457 row->height = max (row->height, it->max_ascent + it->max_descent);
23458 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
23459 row->phys_height = max (row->phys_height,
23460 it->max_phys_ascent + it->max_phys_descent);
23461 row->extra_line_spacing = max (row->extra_line_spacing,
23462 it->max_extra_line_spacing);
23463 x += glyph->pixel_width;
23464 ++i;
23467 /* Stop if max_x reached. */
23468 if (i < nglyphs)
23469 break;
23471 /* Stop at line ends. */
23472 if (ITERATOR_AT_END_OF_LINE_P (it))
23474 it->continuation_lines_width = 0;
23475 break;
23478 set_iterator_to_next (it, 1);
23479 if (STRINGP (it->string))
23480 it_charpos = IT_STRING_CHARPOS (*it);
23481 else
23482 it_charpos = IT_CHARPOS (*it);
23484 /* Stop if truncating at the right edge. */
23485 if (it->line_wrap == TRUNCATE
23486 && it->current_x >= it->last_visible_x)
23488 /* Add truncation mark, but don't do it if the line is
23489 truncated at a padding space. */
23490 if (it_charpos < it->string_nchars)
23492 if (!FRAME_WINDOW_P (it->f))
23494 int ii, n;
23496 if (it->current_x > it->last_visible_x)
23498 if (!row->reversed_p)
23500 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
23501 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23502 break;
23504 else
23506 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
23507 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23508 break;
23509 unproduce_glyphs (it, ii + 1);
23510 ii = row->used[TEXT_AREA] - (ii + 1);
23512 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
23514 row->used[TEXT_AREA] = ii;
23515 produce_special_glyphs (it, IT_TRUNCATION);
23518 produce_special_glyphs (it, IT_TRUNCATION);
23520 row->truncated_on_right_p = 1;
23522 break;
23526 /* Maybe insert a truncation at the left. */
23527 if (it->first_visible_x
23528 && it_charpos > 0)
23530 if (!FRAME_WINDOW_P (it->f)
23531 || (row->reversed_p
23532 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23533 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
23534 insert_left_trunc_glyphs (it);
23535 row->truncated_on_left_p = 1;
23538 it->face_id = saved_face_id;
23540 /* Value is number of columns displayed. */
23541 return it->hpos - hpos_at_start;
23546 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23547 appears as an element of LIST or as the car of an element of LIST.
23548 If PROPVAL is a list, compare each element against LIST in that
23549 way, and return 1/2 if any element of PROPVAL is found in LIST.
23550 Otherwise return 0. This function cannot quit.
23551 The return value is 2 if the text is invisible but with an ellipsis
23552 and 1 if it's invisible and without an ellipsis. */
23555 invisible_p (register Lisp_Object propval, Lisp_Object list)
23557 register Lisp_Object tail, proptail;
23559 for (tail = list; CONSP (tail); tail = XCDR (tail))
23561 register Lisp_Object tem;
23562 tem = XCAR (tail);
23563 if (EQ (propval, tem))
23564 return 1;
23565 if (CONSP (tem) && EQ (propval, XCAR (tem)))
23566 return NILP (XCDR (tem)) ? 1 : 2;
23569 if (CONSP (propval))
23571 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
23573 Lisp_Object propelt;
23574 propelt = XCAR (proptail);
23575 for (tail = list; CONSP (tail); tail = XCDR (tail))
23577 register Lisp_Object tem;
23578 tem = XCAR (tail);
23579 if (EQ (propelt, tem))
23580 return 1;
23581 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
23582 return NILP (XCDR (tem)) ? 1 : 2;
23587 return 0;
23590 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
23591 doc: /* Non-nil if the property makes the text invisible.
23592 POS-OR-PROP can be a marker or number, in which case it is taken to be
23593 a position in the current buffer and the value of the `invisible' property
23594 is checked; or it can be some other value, which is then presumed to be the
23595 value of the `invisible' property of the text of interest.
23596 The non-nil value returned can be t for truly invisible text or something
23597 else if the text is replaced by an ellipsis. */)
23598 (Lisp_Object pos_or_prop)
23600 Lisp_Object prop
23601 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
23602 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
23603 : pos_or_prop);
23604 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
23605 return (invis == 0 ? Qnil
23606 : invis == 1 ? Qt
23607 : make_number (invis));
23610 /* Calculate a width or height in pixels from a specification using
23611 the following elements:
23613 SPEC ::=
23614 NUM - a (fractional) multiple of the default font width/height
23615 (NUM) - specifies exactly NUM pixels
23616 UNIT - a fixed number of pixels, see below.
23617 ELEMENT - size of a display element in pixels, see below.
23618 (NUM . SPEC) - equals NUM * SPEC
23619 (+ SPEC SPEC ...) - add pixel values
23620 (- SPEC SPEC ...) - subtract pixel values
23621 (- SPEC) - negate pixel value
23623 NUM ::=
23624 INT or FLOAT - a number constant
23625 SYMBOL - use symbol's (buffer local) variable binding.
23627 UNIT ::=
23628 in - pixels per inch *)
23629 mm - pixels per 1/1000 meter *)
23630 cm - pixels per 1/100 meter *)
23631 width - width of current font in pixels.
23632 height - height of current font in pixels.
23634 *) using the ratio(s) defined in display-pixels-per-inch.
23636 ELEMENT ::=
23638 left-fringe - left fringe width in pixels
23639 right-fringe - right fringe width in pixels
23641 left-margin - left margin width in pixels
23642 right-margin - right margin width in pixels
23644 scroll-bar - scroll-bar area width in pixels
23646 Examples:
23648 Pixels corresponding to 5 inches:
23649 (5 . in)
23651 Total width of non-text areas on left side of window (if scroll-bar is on left):
23652 '(space :width (+ left-fringe left-margin scroll-bar))
23654 Align to first text column (in header line):
23655 '(space :align-to 0)
23657 Align to middle of text area minus half the width of variable `my-image'
23658 containing a loaded image:
23659 '(space :align-to (0.5 . (- text my-image)))
23661 Width of left margin minus width of 1 character in the default font:
23662 '(space :width (- left-margin 1))
23664 Width of left margin minus width of 2 characters in the current font:
23665 '(space :width (- left-margin (2 . width)))
23667 Center 1 character over left-margin (in header line):
23668 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23670 Different ways to express width of left fringe plus left margin minus one pixel:
23671 '(space :width (- (+ left-fringe left-margin) (1)))
23672 '(space :width (+ left-fringe left-margin (- (1))))
23673 '(space :width (+ left-fringe left-margin (-1)))
23677 static int
23678 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
23679 struct font *font, int width_p, int *align_to)
23681 double pixels;
23683 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23684 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23686 if (NILP (prop))
23687 return OK_PIXELS (0);
23689 eassert (FRAME_LIVE_P (it->f));
23691 if (SYMBOLP (prop))
23693 if (SCHARS (SYMBOL_NAME (prop)) == 2)
23695 char *unit = SSDATA (SYMBOL_NAME (prop));
23697 if (unit[0] == 'i' && unit[1] == 'n')
23698 pixels = 1.0;
23699 else if (unit[0] == 'm' && unit[1] == 'm')
23700 pixels = 25.4;
23701 else if (unit[0] == 'c' && unit[1] == 'm')
23702 pixels = 2.54;
23703 else
23704 pixels = 0;
23705 if (pixels > 0)
23707 double ppi = (width_p ? FRAME_RES_X (it->f)
23708 : FRAME_RES_Y (it->f));
23710 if (ppi > 0)
23711 return OK_PIXELS (ppi / pixels);
23712 return 0;
23716 #ifdef HAVE_WINDOW_SYSTEM
23717 if (EQ (prop, Qheight))
23718 return OK_PIXELS (font ? FONT_HEIGHT (font) : FRAME_LINE_HEIGHT (it->f));
23719 if (EQ (prop, Qwidth))
23720 return OK_PIXELS (font ? FONT_WIDTH (font) : FRAME_COLUMN_WIDTH (it->f));
23721 #else
23722 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
23723 return OK_PIXELS (1);
23724 #endif
23726 if (EQ (prop, Qtext))
23727 return OK_PIXELS (width_p
23728 ? window_box_width (it->w, TEXT_AREA)
23729 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
23731 if (align_to && *align_to < 0)
23733 *res = 0;
23734 if (EQ (prop, Qleft))
23735 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
23736 if (EQ (prop, Qright))
23737 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
23738 if (EQ (prop, Qcenter))
23739 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
23740 + window_box_width (it->w, TEXT_AREA) / 2);
23741 if (EQ (prop, Qleft_fringe))
23742 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23743 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
23744 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
23745 if (EQ (prop, Qright_fringe))
23746 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23747 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23748 : window_box_right_offset (it->w, TEXT_AREA));
23749 if (EQ (prop, Qleft_margin))
23750 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
23751 if (EQ (prop, Qright_margin))
23752 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
23753 if (EQ (prop, Qscroll_bar))
23754 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
23756 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23757 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23758 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23759 : 0)));
23761 else
23763 if (EQ (prop, Qleft_fringe))
23764 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
23765 if (EQ (prop, Qright_fringe))
23766 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
23767 if (EQ (prop, Qleft_margin))
23768 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
23769 if (EQ (prop, Qright_margin))
23770 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
23771 if (EQ (prop, Qscroll_bar))
23772 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
23775 prop = buffer_local_value_1 (prop, it->w->contents);
23776 if (EQ (prop, Qunbound))
23777 prop = Qnil;
23780 if (INTEGERP (prop) || FLOATP (prop))
23782 int base_unit = (width_p
23783 ? FRAME_COLUMN_WIDTH (it->f)
23784 : FRAME_LINE_HEIGHT (it->f));
23785 return OK_PIXELS (XFLOATINT (prop) * base_unit);
23788 if (CONSP (prop))
23790 Lisp_Object car = XCAR (prop);
23791 Lisp_Object cdr = XCDR (prop);
23793 if (SYMBOLP (car))
23795 #ifdef HAVE_WINDOW_SYSTEM
23796 if (FRAME_WINDOW_P (it->f)
23797 && valid_image_p (prop))
23799 ptrdiff_t id = lookup_image (it->f, prop);
23800 struct image *img = IMAGE_FROM_ID (it->f, id);
23802 return OK_PIXELS (width_p ? img->width : img->height);
23804 #endif
23805 if (EQ (car, Qplus) || EQ (car, Qminus))
23807 int first = 1;
23808 double px;
23810 pixels = 0;
23811 while (CONSP (cdr))
23813 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
23814 font, width_p, align_to))
23815 return 0;
23816 if (first)
23817 pixels = (EQ (car, Qplus) ? px : -px), first = 0;
23818 else
23819 pixels += px;
23820 cdr = XCDR (cdr);
23822 if (EQ (car, Qminus))
23823 pixels = -pixels;
23824 return OK_PIXELS (pixels);
23827 car = buffer_local_value_1 (car, it->w->contents);
23828 if (EQ (car, Qunbound))
23829 car = Qnil;
23832 if (INTEGERP (car) || FLOATP (car))
23834 double fact;
23835 pixels = XFLOATINT (car);
23836 if (NILP (cdr))
23837 return OK_PIXELS (pixels);
23838 if (calc_pixel_width_or_height (&fact, it, cdr,
23839 font, width_p, align_to))
23840 return OK_PIXELS (pixels * fact);
23841 return 0;
23844 return 0;
23847 return 0;
23851 /***********************************************************************
23852 Glyph Display
23853 ***********************************************************************/
23855 #ifdef HAVE_WINDOW_SYSTEM
23857 #ifdef GLYPH_DEBUG
23859 void
23860 dump_glyph_string (struct glyph_string *s)
23862 fprintf (stderr, "glyph string\n");
23863 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
23864 s->x, s->y, s->width, s->height);
23865 fprintf (stderr, " ybase = %d\n", s->ybase);
23866 fprintf (stderr, " hl = %d\n", s->hl);
23867 fprintf (stderr, " left overhang = %d, right = %d\n",
23868 s->left_overhang, s->right_overhang);
23869 fprintf (stderr, " nchars = %d\n", s->nchars);
23870 fprintf (stderr, " extends to end of line = %d\n",
23871 s->extends_to_end_of_line_p);
23872 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
23873 fprintf (stderr, " bg width = %d\n", s->background_width);
23876 #endif /* GLYPH_DEBUG */
23878 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23879 of XChar2b structures for S; it can't be allocated in
23880 init_glyph_string because it must be allocated via `alloca'. W
23881 is the window on which S is drawn. ROW and AREA are the glyph row
23882 and area within the row from which S is constructed. START is the
23883 index of the first glyph structure covered by S. HL is a
23884 face-override for drawing S. */
23886 #ifdef HAVE_NTGUI
23887 #define OPTIONAL_HDC(hdc) HDC hdc,
23888 #define DECLARE_HDC(hdc) HDC hdc;
23889 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23890 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23891 #endif
23893 #ifndef OPTIONAL_HDC
23894 #define OPTIONAL_HDC(hdc)
23895 #define DECLARE_HDC(hdc)
23896 #define ALLOCATE_HDC(hdc, f)
23897 #define RELEASE_HDC(hdc, f)
23898 #endif
23900 static void
23901 init_glyph_string (struct glyph_string *s,
23902 OPTIONAL_HDC (hdc)
23903 XChar2b *char2b, struct window *w, struct glyph_row *row,
23904 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
23906 memset (s, 0, sizeof *s);
23907 s->w = w;
23908 s->f = XFRAME (w->frame);
23909 #ifdef HAVE_NTGUI
23910 s->hdc = hdc;
23911 #endif
23912 s->display = FRAME_X_DISPLAY (s->f);
23913 s->window = FRAME_X_WINDOW (s->f);
23914 s->char2b = char2b;
23915 s->hl = hl;
23916 s->row = row;
23917 s->area = area;
23918 s->first_glyph = row->glyphs[area] + start;
23919 s->height = row->height;
23920 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
23921 s->ybase = s->y + row->ascent;
23925 /* Append the list of glyph strings with head H and tail T to the list
23926 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23928 static void
23929 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
23930 struct glyph_string *h, struct glyph_string *t)
23932 if (h)
23934 if (*head)
23935 (*tail)->next = h;
23936 else
23937 *head = h;
23938 h->prev = *tail;
23939 *tail = t;
23944 /* Prepend the list of glyph strings with head H and tail T to the
23945 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23946 result. */
23948 static void
23949 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
23950 struct glyph_string *h, struct glyph_string *t)
23952 if (h)
23954 if (*head)
23955 (*head)->prev = t;
23956 else
23957 *tail = t;
23958 t->next = *head;
23959 *head = h;
23964 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23965 Set *HEAD and *TAIL to the resulting list. */
23967 static void
23968 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
23969 struct glyph_string *s)
23971 s->next = s->prev = NULL;
23972 append_glyph_string_lists (head, tail, s, s);
23976 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23977 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23978 make sure that X resources for the face returned are allocated.
23979 Value is a pointer to a realized face that is ready for display if
23980 DISPLAY_P is non-zero. */
23982 static struct face *
23983 get_char_face_and_encoding (struct frame *f, int c, int face_id,
23984 XChar2b *char2b, int display_p)
23986 struct face *face = FACE_FROM_ID (f, face_id);
23987 unsigned code = 0;
23989 if (face->font)
23991 code = face->font->driver->encode_char (face->font, c);
23993 if (code == FONT_INVALID_CODE)
23994 code = 0;
23996 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
23998 /* Make sure X resources of the face are allocated. */
23999 #ifdef HAVE_X_WINDOWS
24000 if (display_p)
24001 #endif
24003 eassert (face != NULL);
24004 PREPARE_FACE_FOR_DISPLAY (f, face);
24007 return face;
24011 /* Get face and two-byte form of character glyph GLYPH on frame F.
24012 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24013 a pointer to a realized face that is ready for display. */
24015 static struct face *
24016 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
24017 XChar2b *char2b, int *two_byte_p)
24019 struct face *face;
24020 unsigned code = 0;
24022 eassert (glyph->type == CHAR_GLYPH);
24023 face = FACE_FROM_ID (f, glyph->face_id);
24025 /* Make sure X resources of the face are allocated. */
24026 eassert (face != NULL);
24027 PREPARE_FACE_FOR_DISPLAY (f, face);
24029 if (two_byte_p)
24030 *two_byte_p = 0;
24032 if (face->font)
24034 if (CHAR_BYTE8_P (glyph->u.ch))
24035 code = CHAR_TO_BYTE8 (glyph->u.ch);
24036 else
24037 code = face->font->driver->encode_char (face->font, glyph->u.ch);
24039 if (code == FONT_INVALID_CODE)
24040 code = 0;
24043 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24044 return face;
24048 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24049 Return 1 if FONT has a glyph for C, otherwise return 0. */
24051 static int
24052 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
24054 unsigned code;
24056 if (CHAR_BYTE8_P (c))
24057 code = CHAR_TO_BYTE8 (c);
24058 else
24059 code = font->driver->encode_char (font, c);
24061 if (code == FONT_INVALID_CODE)
24062 return 0;
24063 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24064 return 1;
24068 /* Fill glyph string S with composition components specified by S->cmp.
24070 BASE_FACE is the base face of the composition.
24071 S->cmp_from is the index of the first component for S.
24073 OVERLAPS non-zero means S should draw the foreground only, and use
24074 its physical height for clipping. See also draw_glyphs.
24076 Value is the index of a component not in S. */
24078 static int
24079 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
24080 int overlaps)
24082 int i;
24083 /* For all glyphs of this composition, starting at the offset
24084 S->cmp_from, until we reach the end of the definition or encounter a
24085 glyph that requires the different face, add it to S. */
24086 struct face *face;
24088 eassert (s);
24090 s->for_overlaps = overlaps;
24091 s->face = NULL;
24092 s->font = NULL;
24093 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
24095 int c = COMPOSITION_GLYPH (s->cmp, i);
24097 /* TAB in a composition means display glyphs with padding space
24098 on the left or right. */
24099 if (c != '\t')
24101 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
24102 -1, Qnil);
24104 face = get_char_face_and_encoding (s->f, c, face_id,
24105 s->char2b + i, 1);
24106 if (face)
24108 if (! s->face)
24110 s->face = face;
24111 s->font = s->face->font;
24113 else if (s->face != face)
24114 break;
24117 ++s->nchars;
24119 s->cmp_to = i;
24121 if (s->face == NULL)
24123 s->face = base_face->ascii_face;
24124 s->font = s->face->font;
24127 /* All glyph strings for the same composition has the same width,
24128 i.e. the width set for the first component of the composition. */
24129 s->width = s->first_glyph->pixel_width;
24131 /* If the specified font could not be loaded, use the frame's
24132 default font, but record the fact that we couldn't load it in
24133 the glyph string so that we can draw rectangles for the
24134 characters of the glyph string. */
24135 if (s->font == NULL)
24137 s->font_not_found_p = 1;
24138 s->font = FRAME_FONT (s->f);
24141 /* Adjust base line for subscript/superscript text. */
24142 s->ybase += s->first_glyph->voffset;
24144 /* This glyph string must always be drawn with 16-bit functions. */
24145 s->two_byte_p = 1;
24147 return s->cmp_to;
24150 static int
24151 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
24152 int start, int end, int overlaps)
24154 struct glyph *glyph, *last;
24155 Lisp_Object lgstring;
24156 int i;
24158 s->for_overlaps = overlaps;
24159 glyph = s->row->glyphs[s->area] + start;
24160 last = s->row->glyphs[s->area] + end;
24161 s->cmp_id = glyph->u.cmp.id;
24162 s->cmp_from = glyph->slice.cmp.from;
24163 s->cmp_to = glyph->slice.cmp.to + 1;
24164 s->face = FACE_FROM_ID (s->f, face_id);
24165 lgstring = composition_gstring_from_id (s->cmp_id);
24166 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
24167 glyph++;
24168 while (glyph < last
24169 && glyph->u.cmp.automatic
24170 && glyph->u.cmp.id == s->cmp_id
24171 && s->cmp_to == glyph->slice.cmp.from)
24172 s->cmp_to = (glyph++)->slice.cmp.to + 1;
24174 for (i = s->cmp_from; i < s->cmp_to; i++)
24176 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
24177 unsigned code = LGLYPH_CODE (lglyph);
24179 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
24181 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
24182 return glyph - s->row->glyphs[s->area];
24186 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24187 See the comment of fill_glyph_string for arguments.
24188 Value is the index of the first glyph not in S. */
24191 static int
24192 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
24193 int start, int end, int overlaps)
24195 struct glyph *glyph, *last;
24196 int voffset;
24198 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
24199 s->for_overlaps = overlaps;
24200 glyph = s->row->glyphs[s->area] + start;
24201 last = s->row->glyphs[s->area] + end;
24202 voffset = glyph->voffset;
24203 s->face = FACE_FROM_ID (s->f, face_id);
24204 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
24205 s->nchars = 1;
24206 s->width = glyph->pixel_width;
24207 glyph++;
24208 while (glyph < last
24209 && glyph->type == GLYPHLESS_GLYPH
24210 && glyph->voffset == voffset
24211 && glyph->face_id == face_id)
24213 s->nchars++;
24214 s->width += glyph->pixel_width;
24215 glyph++;
24217 s->ybase += voffset;
24218 return glyph - s->row->glyphs[s->area];
24222 /* Fill glyph string S from a sequence of character glyphs.
24224 FACE_ID is the face id of the string. START is the index of the
24225 first glyph to consider, END is the index of the last + 1.
24226 OVERLAPS non-zero means S should draw the foreground only, and use
24227 its physical height for clipping. See also draw_glyphs.
24229 Value is the index of the first glyph not in S. */
24231 static int
24232 fill_glyph_string (struct glyph_string *s, int face_id,
24233 int start, int end, int overlaps)
24235 struct glyph *glyph, *last;
24236 int voffset;
24237 int glyph_not_available_p;
24239 eassert (s->f == XFRAME (s->w->frame));
24240 eassert (s->nchars == 0);
24241 eassert (start >= 0 && end > start);
24243 s->for_overlaps = overlaps;
24244 glyph = s->row->glyphs[s->area] + start;
24245 last = s->row->glyphs[s->area] + end;
24246 voffset = glyph->voffset;
24247 s->padding_p = glyph->padding_p;
24248 glyph_not_available_p = glyph->glyph_not_available_p;
24250 while (glyph < last
24251 && glyph->type == CHAR_GLYPH
24252 && glyph->voffset == voffset
24253 /* Same face id implies same font, nowadays. */
24254 && glyph->face_id == face_id
24255 && glyph->glyph_not_available_p == glyph_not_available_p)
24257 int two_byte_p;
24259 s->face = get_glyph_face_and_encoding (s->f, glyph,
24260 s->char2b + s->nchars,
24261 &two_byte_p);
24262 s->two_byte_p = two_byte_p;
24263 ++s->nchars;
24264 eassert (s->nchars <= end - start);
24265 s->width += glyph->pixel_width;
24266 if (glyph++->padding_p != s->padding_p)
24267 break;
24270 s->font = s->face->font;
24272 /* If the specified font could not be loaded, use the frame's font,
24273 but record the fact that we couldn't load it in
24274 S->font_not_found_p so that we can draw rectangles for the
24275 characters of the glyph string. */
24276 if (s->font == NULL || glyph_not_available_p)
24278 s->font_not_found_p = 1;
24279 s->font = FRAME_FONT (s->f);
24282 /* Adjust base line for subscript/superscript text. */
24283 s->ybase += voffset;
24285 eassert (s->face && s->face->gc);
24286 return glyph - s->row->glyphs[s->area];
24290 /* Fill glyph string S from image glyph S->first_glyph. */
24292 static void
24293 fill_image_glyph_string (struct glyph_string *s)
24295 eassert (s->first_glyph->type == IMAGE_GLYPH);
24296 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
24297 eassert (s->img);
24298 s->slice = s->first_glyph->slice.img;
24299 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24300 s->font = s->face->font;
24301 s->width = s->first_glyph->pixel_width;
24303 /* Adjust base line for subscript/superscript text. */
24304 s->ybase += s->first_glyph->voffset;
24308 /* Fill glyph string S from a sequence of stretch glyphs.
24310 START is the index of the first glyph to consider,
24311 END is the index of the last + 1.
24313 Value is the index of the first glyph not in S. */
24315 static int
24316 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
24318 struct glyph *glyph, *last;
24319 int voffset, face_id;
24321 eassert (s->first_glyph->type == STRETCH_GLYPH);
24323 glyph = s->row->glyphs[s->area] + start;
24324 last = s->row->glyphs[s->area] + end;
24325 face_id = glyph->face_id;
24326 s->face = FACE_FROM_ID (s->f, face_id);
24327 s->font = s->face->font;
24328 s->width = glyph->pixel_width;
24329 s->nchars = 1;
24330 voffset = glyph->voffset;
24332 for (++glyph;
24333 (glyph < last
24334 && glyph->type == STRETCH_GLYPH
24335 && glyph->voffset == voffset
24336 && glyph->face_id == face_id);
24337 ++glyph)
24338 s->width += glyph->pixel_width;
24340 /* Adjust base line for subscript/superscript text. */
24341 s->ybase += voffset;
24343 /* The case that face->gc == 0 is handled when drawing the glyph
24344 string by calling PREPARE_FACE_FOR_DISPLAY. */
24345 eassert (s->face);
24346 return glyph - s->row->glyphs[s->area];
24349 static struct font_metrics *
24350 get_per_char_metric (struct font *font, XChar2b *char2b)
24352 static struct font_metrics metrics;
24353 unsigned code;
24355 if (! font)
24356 return NULL;
24357 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24358 if (code == FONT_INVALID_CODE)
24359 return NULL;
24360 font->driver->text_extents (font, &code, 1, &metrics);
24361 return &metrics;
24364 /* EXPORT for RIF:
24365 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24366 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24367 assumed to be zero. */
24369 void
24370 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
24372 *left = *right = 0;
24374 if (glyph->type == CHAR_GLYPH)
24376 struct face *face;
24377 XChar2b char2b;
24378 struct font_metrics *pcm;
24380 face = get_glyph_face_and_encoding (f, glyph, &char2b, NULL);
24381 if (face->font && (pcm = get_per_char_metric (face->font, &char2b)))
24383 if (pcm->rbearing > pcm->width)
24384 *right = pcm->rbearing - pcm->width;
24385 if (pcm->lbearing < 0)
24386 *left = -pcm->lbearing;
24389 else if (glyph->type == COMPOSITE_GLYPH)
24391 if (! glyph->u.cmp.automatic)
24393 struct composition *cmp = composition_table[glyph->u.cmp.id];
24395 if (cmp->rbearing > cmp->pixel_width)
24396 *right = cmp->rbearing - cmp->pixel_width;
24397 if (cmp->lbearing < 0)
24398 *left = - cmp->lbearing;
24400 else
24402 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
24403 struct font_metrics metrics;
24405 composition_gstring_width (gstring, glyph->slice.cmp.from,
24406 glyph->slice.cmp.to + 1, &metrics);
24407 if (metrics.rbearing > metrics.width)
24408 *right = metrics.rbearing - metrics.width;
24409 if (metrics.lbearing < 0)
24410 *left = - metrics.lbearing;
24416 /* Return the index of the first glyph preceding glyph string S that
24417 is overwritten by S because of S's left overhang. Value is -1
24418 if no glyphs are overwritten. */
24420 static int
24421 left_overwritten (struct glyph_string *s)
24423 int k;
24425 if (s->left_overhang)
24427 int x = 0, i;
24428 struct glyph *glyphs = s->row->glyphs[s->area];
24429 int first = s->first_glyph - glyphs;
24431 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
24432 x -= glyphs[i].pixel_width;
24434 k = i + 1;
24436 else
24437 k = -1;
24439 return k;
24443 /* Return the index of the first glyph preceding glyph string S that
24444 is overwriting S because of its right overhang. Value is -1 if no
24445 glyph in front of S overwrites S. */
24447 static int
24448 left_overwriting (struct glyph_string *s)
24450 int i, k, x;
24451 struct glyph *glyphs = s->row->glyphs[s->area];
24452 int first = s->first_glyph - glyphs;
24454 k = -1;
24455 x = 0;
24456 for (i = first - 1; i >= 0; --i)
24458 int left, right;
24459 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24460 if (x + right > 0)
24461 k = i;
24462 x -= glyphs[i].pixel_width;
24465 return k;
24469 /* Return the index of the last glyph following glyph string S that is
24470 overwritten by S because of S's right overhang. Value is -1 if
24471 no such glyph is found. */
24473 static int
24474 right_overwritten (struct glyph_string *s)
24476 int k = -1;
24478 if (s->right_overhang)
24480 int x = 0, i;
24481 struct glyph *glyphs = s->row->glyphs[s->area];
24482 int first = (s->first_glyph - glyphs
24483 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24484 int end = s->row->used[s->area];
24486 for (i = first; i < end && s->right_overhang > x; ++i)
24487 x += glyphs[i].pixel_width;
24489 k = i;
24492 return k;
24496 /* Return the index of the last glyph following glyph string S that
24497 overwrites S because of its left overhang. Value is negative
24498 if no such glyph is found. */
24500 static int
24501 right_overwriting (struct glyph_string *s)
24503 int i, k, x;
24504 int end = s->row->used[s->area];
24505 struct glyph *glyphs = s->row->glyphs[s->area];
24506 int first = (s->first_glyph - glyphs
24507 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24509 k = -1;
24510 x = 0;
24511 for (i = first; i < end; ++i)
24513 int left, right;
24514 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24515 if (x - left < 0)
24516 k = i;
24517 x += glyphs[i].pixel_width;
24520 return k;
24524 /* Set background width of glyph string S. START is the index of the
24525 first glyph following S. LAST_X is the right-most x-position + 1
24526 in the drawing area. */
24528 static void
24529 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
24531 /* If the face of this glyph string has to be drawn to the end of
24532 the drawing area, set S->extends_to_end_of_line_p. */
24534 if (start == s->row->used[s->area]
24535 && ((s->row->fill_line_p
24536 && (s->hl == DRAW_NORMAL_TEXT
24537 || s->hl == DRAW_IMAGE_RAISED
24538 || s->hl == DRAW_IMAGE_SUNKEN))
24539 || s->hl == DRAW_MOUSE_FACE))
24540 s->extends_to_end_of_line_p = 1;
24542 /* If S extends its face to the end of the line, set its
24543 background_width to the distance to the right edge of the drawing
24544 area. */
24545 if (s->extends_to_end_of_line_p)
24546 s->background_width = last_x - s->x + 1;
24547 else
24548 s->background_width = s->width;
24552 /* Compute overhangs and x-positions for glyph string S and its
24553 predecessors, or successors. X is the starting x-position for S.
24554 BACKWARD_P non-zero means process predecessors. */
24556 static void
24557 compute_overhangs_and_x (struct glyph_string *s, int x, int backward_p)
24559 if (backward_p)
24561 while (s)
24563 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24564 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24565 x -= s->width;
24566 s->x = x;
24567 s = s->prev;
24570 else
24572 while (s)
24574 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24575 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24576 s->x = x;
24577 x += s->width;
24578 s = s->next;
24585 /* The following macros are only called from draw_glyphs below.
24586 They reference the following parameters of that function directly:
24587 `w', `row', `area', and `overlap_p'
24588 as well as the following local variables:
24589 `s', `f', and `hdc' (in W32) */
24591 #ifdef HAVE_NTGUI
24592 /* On W32, silently add local `hdc' variable to argument list of
24593 init_glyph_string. */
24594 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24595 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24596 #else
24597 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24598 init_glyph_string (s, char2b, w, row, area, start, hl)
24599 #endif
24601 /* Add a glyph string for a stretch glyph to the list of strings
24602 between HEAD and TAIL. START is the index of the stretch glyph in
24603 row area AREA of glyph row ROW. END is the index of the last glyph
24604 in that glyph row area. X is the current output position assigned
24605 to the new glyph string constructed. HL overrides that face of the
24606 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24607 is the right-most x-position of the drawing area. */
24609 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24610 and below -- keep them on one line. */
24611 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24612 do \
24614 s = alloca (sizeof *s); \
24615 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24616 START = fill_stretch_glyph_string (s, START, END); \
24617 append_glyph_string (&HEAD, &TAIL, s); \
24618 s->x = (X); \
24620 while (0)
24623 /* Add a glyph string for an image glyph to the list of strings
24624 between HEAD and TAIL. START is the index of the image glyph in
24625 row area AREA of glyph row ROW. END is the index of the last glyph
24626 in that glyph row area. X is the current output position assigned
24627 to the new glyph string constructed. HL overrides that face of the
24628 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24629 is the right-most x-position of the drawing area. */
24631 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24632 do \
24634 s = alloca (sizeof *s); \
24635 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24636 fill_image_glyph_string (s); \
24637 append_glyph_string (&HEAD, &TAIL, s); \
24638 ++START; \
24639 s->x = (X); \
24641 while (0)
24644 /* Add a glyph string for a sequence of character glyphs to the list
24645 of strings between HEAD and TAIL. START is the index of the first
24646 glyph in row area AREA of glyph row ROW that is part of the new
24647 glyph string. END is the index of the last glyph in that glyph row
24648 area. X is the current output position assigned to the new glyph
24649 string constructed. HL overrides that face of the glyph; e.g. it
24650 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24651 right-most x-position of the drawing area. */
24653 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24654 do \
24656 int face_id; \
24657 XChar2b *char2b; \
24659 face_id = (row)->glyphs[area][START].face_id; \
24661 s = alloca (sizeof *s); \
24662 char2b = alloca ((END - START) * sizeof *char2b); \
24663 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24664 append_glyph_string (&HEAD, &TAIL, s); \
24665 s->x = (X); \
24666 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24668 while (0)
24671 /* Add a glyph string for a composite sequence to the list of strings
24672 between HEAD and TAIL. START is the index of the first glyph in
24673 row area AREA of glyph row ROW that is part of the new glyph
24674 string. END is the index of the last glyph in that glyph row area.
24675 X is the current output position assigned to the new glyph string
24676 constructed. HL overrides that face of the glyph; e.g. it is
24677 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24678 x-position of the drawing area. */
24680 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24681 do { \
24682 int face_id = (row)->glyphs[area][START].face_id; \
24683 struct face *base_face = FACE_FROM_ID (f, face_id); \
24684 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24685 struct composition *cmp = composition_table[cmp_id]; \
24686 XChar2b *char2b; \
24687 struct glyph_string *first_s = NULL; \
24688 int n; \
24690 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24692 /* Make glyph_strings for each glyph sequence that is drawable by \
24693 the same face, and append them to HEAD/TAIL. */ \
24694 for (n = 0; n < cmp->glyph_len;) \
24696 s = alloca (sizeof *s); \
24697 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24698 append_glyph_string (&(HEAD), &(TAIL), s); \
24699 s->cmp = cmp; \
24700 s->cmp_from = n; \
24701 s->x = (X); \
24702 if (n == 0) \
24703 first_s = s; \
24704 n = fill_composite_glyph_string (s, base_face, overlaps); \
24707 ++START; \
24708 s = first_s; \
24709 } while (0)
24712 /* Add a glyph string for a glyph-string sequence to the list of strings
24713 between HEAD and TAIL. */
24715 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24716 do { \
24717 int face_id; \
24718 XChar2b *char2b; \
24719 Lisp_Object gstring; \
24721 face_id = (row)->glyphs[area][START].face_id; \
24722 gstring = (composition_gstring_from_id \
24723 ((row)->glyphs[area][START].u.cmp.id)); \
24724 s = alloca (sizeof *s); \
24725 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24726 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24727 append_glyph_string (&(HEAD), &(TAIL), s); \
24728 s->x = (X); \
24729 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24730 } while (0)
24733 /* Add a glyph string for a sequence of glyphless character's glyphs
24734 to the list of strings between HEAD and TAIL. The meanings of
24735 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24737 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24738 do \
24740 int face_id; \
24742 face_id = (row)->glyphs[area][START].face_id; \
24744 s = alloca (sizeof *s); \
24745 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24746 append_glyph_string (&HEAD, &TAIL, s); \
24747 s->x = (X); \
24748 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24749 overlaps); \
24751 while (0)
24754 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24755 of AREA of glyph row ROW on window W between indices START and END.
24756 HL overrides the face for drawing glyph strings, e.g. it is
24757 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24758 x-positions of the drawing area.
24760 This is an ugly monster macro construct because we must use alloca
24761 to allocate glyph strings (because draw_glyphs can be called
24762 asynchronously). */
24764 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24765 do \
24767 HEAD = TAIL = NULL; \
24768 while (START < END) \
24770 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24771 switch (first_glyph->type) \
24773 case CHAR_GLYPH: \
24774 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24775 HL, X, LAST_X); \
24776 break; \
24778 case COMPOSITE_GLYPH: \
24779 if (first_glyph->u.cmp.automatic) \
24780 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24781 HL, X, LAST_X); \
24782 else \
24783 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24784 HL, X, LAST_X); \
24785 break; \
24787 case STRETCH_GLYPH: \
24788 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24789 HL, X, LAST_X); \
24790 break; \
24792 case IMAGE_GLYPH: \
24793 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24794 HL, X, LAST_X); \
24795 break; \
24797 case GLYPHLESS_GLYPH: \
24798 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24799 HL, X, LAST_X); \
24800 break; \
24802 default: \
24803 emacs_abort (); \
24806 if (s) \
24808 set_glyph_string_background_width (s, START, LAST_X); \
24809 (X) += s->width; \
24812 } while (0)
24815 /* Draw glyphs between START and END in AREA of ROW on window W,
24816 starting at x-position X. X is relative to AREA in W. HL is a
24817 face-override with the following meaning:
24819 DRAW_NORMAL_TEXT draw normally
24820 DRAW_CURSOR draw in cursor face
24821 DRAW_MOUSE_FACE draw in mouse face.
24822 DRAW_INVERSE_VIDEO draw in mode line face
24823 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24824 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24826 If OVERLAPS is non-zero, draw only the foreground of characters and
24827 clip to the physical height of ROW. Non-zero value also defines
24828 the overlapping part to be drawn:
24830 OVERLAPS_PRED overlap with preceding rows
24831 OVERLAPS_SUCC overlap with succeeding rows
24832 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24833 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24835 Value is the x-position reached, relative to AREA of W. */
24837 static int
24838 draw_glyphs (struct window *w, int x, struct glyph_row *row,
24839 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
24840 enum draw_glyphs_face hl, int overlaps)
24842 struct glyph_string *head, *tail;
24843 struct glyph_string *s;
24844 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
24845 int i, j, x_reached, last_x, area_left = 0;
24846 struct frame *f = XFRAME (WINDOW_FRAME (w));
24847 DECLARE_HDC (hdc);
24849 ALLOCATE_HDC (hdc, f);
24851 /* Let's rather be paranoid than getting a SEGV. */
24852 end = min (end, row->used[area]);
24853 start = clip_to_bounds (0, start, end);
24855 /* Translate X to frame coordinates. Set last_x to the right
24856 end of the drawing area. */
24857 if (row->full_width_p)
24859 /* X is relative to the left edge of W, without scroll bars
24860 or fringes. */
24861 area_left = WINDOW_LEFT_EDGE_X (w);
24862 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
24863 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
24865 else
24867 area_left = window_box_left (w, area);
24868 last_x = area_left + window_box_width (w, area);
24870 x += area_left;
24872 /* Build a doubly-linked list of glyph_string structures between
24873 head and tail from what we have to draw. Note that the macro
24874 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24875 the reason we use a separate variable `i'. */
24876 i = start;
24877 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
24878 if (tail)
24879 x_reached = tail->x + tail->background_width;
24880 else
24881 x_reached = x;
24883 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24884 the row, redraw some glyphs in front or following the glyph
24885 strings built above. */
24886 if (head && !overlaps && row->contains_overlapping_glyphs_p)
24888 struct glyph_string *h, *t;
24889 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
24890 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
24891 int check_mouse_face = 0;
24892 int dummy_x = 0;
24894 /* If mouse highlighting is on, we may need to draw adjacent
24895 glyphs using mouse-face highlighting. */
24896 if (area == TEXT_AREA && row->mouse_face_p
24897 && hlinfo->mouse_face_beg_row >= 0
24898 && hlinfo->mouse_face_end_row >= 0)
24900 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
24902 if (row_vpos >= hlinfo->mouse_face_beg_row
24903 && row_vpos <= hlinfo->mouse_face_end_row)
24905 check_mouse_face = 1;
24906 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
24907 ? hlinfo->mouse_face_beg_col : 0;
24908 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
24909 ? hlinfo->mouse_face_end_col
24910 : row->used[TEXT_AREA];
24914 /* Compute overhangs for all glyph strings. */
24915 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
24916 for (s = head; s; s = s->next)
24917 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
24919 /* Prepend glyph strings for glyphs in front of the first glyph
24920 string that are overwritten because of the first glyph
24921 string's left overhang. The background of all strings
24922 prepended must be drawn because the first glyph string
24923 draws over it. */
24924 i = left_overwritten (head);
24925 if (i >= 0)
24927 enum draw_glyphs_face overlap_hl;
24929 /* If this row contains mouse highlighting, attempt to draw
24930 the overlapped glyphs with the correct highlight. This
24931 code fails if the overlap encompasses more than one glyph
24932 and mouse-highlight spans only some of these glyphs.
24933 However, making it work perfectly involves a lot more
24934 code, and I don't know if the pathological case occurs in
24935 practice, so we'll stick to this for now. --- cyd */
24936 if (check_mouse_face
24937 && mouse_beg_col < start && mouse_end_col > i)
24938 overlap_hl = DRAW_MOUSE_FACE;
24939 else
24940 overlap_hl = DRAW_NORMAL_TEXT;
24942 if (hl != overlap_hl)
24943 clip_head = head;
24944 j = i;
24945 BUILD_GLYPH_STRINGS (j, start, h, t,
24946 overlap_hl, dummy_x, last_x);
24947 start = i;
24948 compute_overhangs_and_x (t, head->x, 1);
24949 prepend_glyph_string_lists (&head, &tail, h, t);
24950 if (clip_head == NULL)
24951 clip_head = head;
24954 /* Prepend glyph strings for glyphs in front of the first glyph
24955 string that overwrite that glyph string because of their
24956 right overhang. For these strings, only the foreground must
24957 be drawn, because it draws over the glyph string at `head'.
24958 The background must not be drawn because this would overwrite
24959 right overhangs of preceding glyphs for which no glyph
24960 strings exist. */
24961 i = left_overwriting (head);
24962 if (i >= 0)
24964 enum draw_glyphs_face overlap_hl;
24966 if (check_mouse_face
24967 && mouse_beg_col < start && mouse_end_col > i)
24968 overlap_hl = DRAW_MOUSE_FACE;
24969 else
24970 overlap_hl = DRAW_NORMAL_TEXT;
24972 if (hl == overlap_hl || clip_head == NULL)
24973 clip_head = head;
24974 BUILD_GLYPH_STRINGS (i, start, h, t,
24975 overlap_hl, dummy_x, last_x);
24976 for (s = h; s; s = s->next)
24977 s->background_filled_p = 1;
24978 compute_overhangs_and_x (t, head->x, 1);
24979 prepend_glyph_string_lists (&head, &tail, h, t);
24982 /* Append glyphs strings for glyphs following the last glyph
24983 string tail that are overwritten by tail. The background of
24984 these strings has to be drawn because tail's foreground draws
24985 over it. */
24986 i = right_overwritten (tail);
24987 if (i >= 0)
24989 enum draw_glyphs_face overlap_hl;
24991 if (check_mouse_face
24992 && mouse_beg_col < i && mouse_end_col > end)
24993 overlap_hl = DRAW_MOUSE_FACE;
24994 else
24995 overlap_hl = DRAW_NORMAL_TEXT;
24997 if (hl != overlap_hl)
24998 clip_tail = tail;
24999 BUILD_GLYPH_STRINGS (end, i, h, t,
25000 overlap_hl, x, last_x);
25001 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25002 we don't have `end = i;' here. */
25003 compute_overhangs_and_x (h, tail->x + tail->width, 0);
25004 append_glyph_string_lists (&head, &tail, h, t);
25005 if (clip_tail == NULL)
25006 clip_tail = tail;
25009 /* Append glyph strings for glyphs following the last glyph
25010 string tail that overwrite tail. The foreground of such
25011 glyphs has to be drawn because it writes into the background
25012 of tail. The background must not be drawn because it could
25013 paint over the foreground of following glyphs. */
25014 i = right_overwriting (tail);
25015 if (i >= 0)
25017 enum draw_glyphs_face overlap_hl;
25018 if (check_mouse_face
25019 && mouse_beg_col < i && mouse_end_col > end)
25020 overlap_hl = DRAW_MOUSE_FACE;
25021 else
25022 overlap_hl = DRAW_NORMAL_TEXT;
25024 if (hl == overlap_hl || clip_tail == NULL)
25025 clip_tail = tail;
25026 i++; /* We must include the Ith glyph. */
25027 BUILD_GLYPH_STRINGS (end, i, h, t,
25028 overlap_hl, x, last_x);
25029 for (s = h; s; s = s->next)
25030 s->background_filled_p = 1;
25031 compute_overhangs_and_x (h, tail->x + tail->width, 0);
25032 append_glyph_string_lists (&head, &tail, h, t);
25034 if (clip_head || clip_tail)
25035 for (s = head; s; s = s->next)
25037 s->clip_head = clip_head;
25038 s->clip_tail = clip_tail;
25042 /* Draw all strings. */
25043 for (s = head; s; s = s->next)
25044 FRAME_RIF (f)->draw_glyph_string (s);
25046 #ifndef HAVE_NS
25047 /* When focus a sole frame and move horizontally, this sets on_p to 0
25048 causing a failure to erase prev cursor position. */
25049 if (area == TEXT_AREA
25050 && !row->full_width_p
25051 /* When drawing overlapping rows, only the glyph strings'
25052 foreground is drawn, which doesn't erase a cursor
25053 completely. */
25054 && !overlaps)
25056 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
25057 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
25058 : (tail ? tail->x + tail->background_width : x));
25059 x0 -= area_left;
25060 x1 -= area_left;
25062 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
25063 row->y, MATRIX_ROW_BOTTOM_Y (row));
25065 #endif
25067 /* Value is the x-position up to which drawn, relative to AREA of W.
25068 This doesn't include parts drawn because of overhangs. */
25069 if (row->full_width_p)
25070 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
25071 else
25072 x_reached -= area_left;
25074 RELEASE_HDC (hdc, f);
25076 return x_reached;
25079 /* Expand row matrix if too narrow. Don't expand if area
25080 is not present. */
25082 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25084 if (!it->f->fonts_changed \
25085 && (it->glyph_row->glyphs[area] \
25086 < it->glyph_row->glyphs[area + 1])) \
25088 it->w->ncols_scale_factor++; \
25089 it->f->fonts_changed = 1; \
25093 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25094 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25096 static void
25097 append_glyph (struct it *it)
25099 struct glyph *glyph;
25100 enum glyph_row_area area = it->area;
25102 eassert (it->glyph_row);
25103 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
25105 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25106 if (glyph < it->glyph_row->glyphs[area + 1])
25108 /* If the glyph row is reversed, we need to prepend the glyph
25109 rather than append it. */
25110 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25112 struct glyph *g;
25114 /* Make room for the additional glyph. */
25115 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25116 g[1] = *g;
25117 glyph = it->glyph_row->glyphs[area];
25119 glyph->charpos = CHARPOS (it->position);
25120 glyph->object = it->object;
25121 if (it->pixel_width > 0)
25123 glyph->pixel_width = it->pixel_width;
25124 glyph->padding_p = 0;
25126 else
25128 /* Assure at least 1-pixel width. Otherwise, cursor can't
25129 be displayed correctly. */
25130 glyph->pixel_width = 1;
25131 glyph->padding_p = 1;
25133 glyph->ascent = it->ascent;
25134 glyph->descent = it->descent;
25135 glyph->voffset = it->voffset;
25136 glyph->type = CHAR_GLYPH;
25137 glyph->avoid_cursor_p = it->avoid_cursor_p;
25138 glyph->multibyte_p = it->multibyte_p;
25139 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25141 /* In R2L rows, the left and the right box edges need to be
25142 drawn in reverse direction. */
25143 glyph->right_box_line_p = it->start_of_box_run_p;
25144 glyph->left_box_line_p = it->end_of_box_run_p;
25146 else
25148 glyph->left_box_line_p = it->start_of_box_run_p;
25149 glyph->right_box_line_p = it->end_of_box_run_p;
25151 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25152 || it->phys_descent > it->descent);
25153 glyph->glyph_not_available_p = it->glyph_not_available_p;
25154 glyph->face_id = it->face_id;
25155 glyph->u.ch = it->char_to_display;
25156 glyph->slice.img = null_glyph_slice;
25157 glyph->font_type = FONT_TYPE_UNKNOWN;
25158 if (it->bidi_p)
25160 glyph->resolved_level = it->bidi_it.resolved_level;
25161 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25162 emacs_abort ();
25163 glyph->bidi_type = it->bidi_it.type;
25165 else
25167 glyph->resolved_level = 0;
25168 glyph->bidi_type = UNKNOWN_BT;
25170 ++it->glyph_row->used[area];
25172 else
25173 IT_EXPAND_MATRIX_WIDTH (it, area);
25176 /* Store one glyph for the composition IT->cmp_it.id in
25177 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25178 non-null. */
25180 static void
25181 append_composite_glyph (struct it *it)
25183 struct glyph *glyph;
25184 enum glyph_row_area area = it->area;
25186 eassert (it->glyph_row);
25188 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25189 if (glyph < it->glyph_row->glyphs[area + 1])
25191 /* If the glyph row is reversed, we need to prepend the glyph
25192 rather than append it. */
25193 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
25195 struct glyph *g;
25197 /* Make room for the new glyph. */
25198 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25199 g[1] = *g;
25200 glyph = it->glyph_row->glyphs[it->area];
25202 glyph->charpos = it->cmp_it.charpos;
25203 glyph->object = it->object;
25204 glyph->pixel_width = it->pixel_width;
25205 glyph->ascent = it->ascent;
25206 glyph->descent = it->descent;
25207 glyph->voffset = it->voffset;
25208 glyph->type = COMPOSITE_GLYPH;
25209 if (it->cmp_it.ch < 0)
25211 glyph->u.cmp.automatic = 0;
25212 glyph->u.cmp.id = it->cmp_it.id;
25213 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
25215 else
25217 glyph->u.cmp.automatic = 1;
25218 glyph->u.cmp.id = it->cmp_it.id;
25219 glyph->slice.cmp.from = it->cmp_it.from;
25220 glyph->slice.cmp.to = it->cmp_it.to - 1;
25222 glyph->avoid_cursor_p = it->avoid_cursor_p;
25223 glyph->multibyte_p = it->multibyte_p;
25224 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25226 /* In R2L rows, the left and the right box edges need to be
25227 drawn in reverse direction. */
25228 glyph->right_box_line_p = it->start_of_box_run_p;
25229 glyph->left_box_line_p = it->end_of_box_run_p;
25231 else
25233 glyph->left_box_line_p = it->start_of_box_run_p;
25234 glyph->right_box_line_p = it->end_of_box_run_p;
25236 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25237 || it->phys_descent > it->descent);
25238 glyph->padding_p = 0;
25239 glyph->glyph_not_available_p = 0;
25240 glyph->face_id = it->face_id;
25241 glyph->font_type = FONT_TYPE_UNKNOWN;
25242 if (it->bidi_p)
25244 glyph->resolved_level = it->bidi_it.resolved_level;
25245 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25246 emacs_abort ();
25247 glyph->bidi_type = it->bidi_it.type;
25249 ++it->glyph_row->used[area];
25251 else
25252 IT_EXPAND_MATRIX_WIDTH (it, area);
25256 /* Change IT->ascent and IT->height according to the setting of
25257 IT->voffset. */
25259 static void
25260 take_vertical_position_into_account (struct it *it)
25262 if (it->voffset)
25264 if (it->voffset < 0)
25265 /* Increase the ascent so that we can display the text higher
25266 in the line. */
25267 it->ascent -= it->voffset;
25268 else
25269 /* Increase the descent so that we can display the text lower
25270 in the line. */
25271 it->descent += it->voffset;
25276 /* Produce glyphs/get display metrics for the image IT is loaded with.
25277 See the description of struct display_iterator in dispextern.h for
25278 an overview of struct display_iterator. */
25280 static void
25281 produce_image_glyph (struct it *it)
25283 struct image *img;
25284 struct face *face;
25285 int glyph_ascent, crop;
25286 struct glyph_slice slice;
25288 eassert (it->what == IT_IMAGE);
25290 face = FACE_FROM_ID (it->f, it->face_id);
25291 eassert (face);
25292 /* Make sure X resources of the face is loaded. */
25293 PREPARE_FACE_FOR_DISPLAY (it->f, face);
25295 if (it->image_id < 0)
25297 /* Fringe bitmap. */
25298 it->ascent = it->phys_ascent = 0;
25299 it->descent = it->phys_descent = 0;
25300 it->pixel_width = 0;
25301 it->nglyphs = 0;
25302 return;
25305 img = IMAGE_FROM_ID (it->f, it->image_id);
25306 eassert (img);
25307 /* Make sure X resources of the image is loaded. */
25308 prepare_image_for_display (it->f, img);
25310 slice.x = slice.y = 0;
25311 slice.width = img->width;
25312 slice.height = img->height;
25314 if (INTEGERP (it->slice.x))
25315 slice.x = XINT (it->slice.x);
25316 else if (FLOATP (it->slice.x))
25317 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
25319 if (INTEGERP (it->slice.y))
25320 slice.y = XINT (it->slice.y);
25321 else if (FLOATP (it->slice.y))
25322 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
25324 if (INTEGERP (it->slice.width))
25325 slice.width = XINT (it->slice.width);
25326 else if (FLOATP (it->slice.width))
25327 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
25329 if (INTEGERP (it->slice.height))
25330 slice.height = XINT (it->slice.height);
25331 else if (FLOATP (it->slice.height))
25332 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
25334 if (slice.x >= img->width)
25335 slice.x = img->width;
25336 if (slice.y >= img->height)
25337 slice.y = img->height;
25338 if (slice.x + slice.width >= img->width)
25339 slice.width = img->width - slice.x;
25340 if (slice.y + slice.height > img->height)
25341 slice.height = img->height - slice.y;
25343 if (slice.width == 0 || slice.height == 0)
25344 return;
25346 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
25348 it->descent = slice.height - glyph_ascent;
25349 if (slice.y == 0)
25350 it->descent += img->vmargin;
25351 if (slice.y + slice.height == img->height)
25352 it->descent += img->vmargin;
25353 it->phys_descent = it->descent;
25355 it->pixel_width = slice.width;
25356 if (slice.x == 0)
25357 it->pixel_width += img->hmargin;
25358 if (slice.x + slice.width == img->width)
25359 it->pixel_width += img->hmargin;
25361 /* It's quite possible for images to have an ascent greater than
25362 their height, so don't get confused in that case. */
25363 if (it->descent < 0)
25364 it->descent = 0;
25366 it->nglyphs = 1;
25368 if (face->box != FACE_NO_BOX)
25370 if (face->box_line_width > 0)
25372 if (slice.y == 0)
25373 it->ascent += face->box_line_width;
25374 if (slice.y + slice.height == img->height)
25375 it->descent += face->box_line_width;
25378 if (it->start_of_box_run_p && slice.x == 0)
25379 it->pixel_width += eabs (face->box_line_width);
25380 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
25381 it->pixel_width += eabs (face->box_line_width);
25384 take_vertical_position_into_account (it);
25386 /* Automatically crop wide image glyphs at right edge so we can
25387 draw the cursor on same display row. */
25388 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
25389 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
25391 it->pixel_width -= crop;
25392 slice.width -= crop;
25395 if (it->glyph_row)
25397 struct glyph *glyph;
25398 enum glyph_row_area area = it->area;
25400 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25401 if (glyph < it->glyph_row->glyphs[area + 1])
25403 glyph->charpos = CHARPOS (it->position);
25404 glyph->object = it->object;
25405 glyph->pixel_width = it->pixel_width;
25406 glyph->ascent = glyph_ascent;
25407 glyph->descent = it->descent;
25408 glyph->voffset = it->voffset;
25409 glyph->type = IMAGE_GLYPH;
25410 glyph->avoid_cursor_p = it->avoid_cursor_p;
25411 glyph->multibyte_p = it->multibyte_p;
25412 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25414 /* In R2L rows, the left and the right box edges need to be
25415 drawn in reverse direction. */
25416 glyph->right_box_line_p = it->start_of_box_run_p;
25417 glyph->left_box_line_p = it->end_of_box_run_p;
25419 else
25421 glyph->left_box_line_p = it->start_of_box_run_p;
25422 glyph->right_box_line_p = it->end_of_box_run_p;
25424 glyph->overlaps_vertically_p = 0;
25425 glyph->padding_p = 0;
25426 glyph->glyph_not_available_p = 0;
25427 glyph->face_id = it->face_id;
25428 glyph->u.img_id = img->id;
25429 glyph->slice.img = slice;
25430 glyph->font_type = FONT_TYPE_UNKNOWN;
25431 if (it->bidi_p)
25433 glyph->resolved_level = it->bidi_it.resolved_level;
25434 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25435 emacs_abort ();
25436 glyph->bidi_type = it->bidi_it.type;
25438 ++it->glyph_row->used[area];
25440 else
25441 IT_EXPAND_MATRIX_WIDTH (it, area);
25446 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25447 of the glyph, WIDTH and HEIGHT are the width and height of the
25448 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25450 static void
25451 append_stretch_glyph (struct it *it, Lisp_Object object,
25452 int width, int height, int ascent)
25454 struct glyph *glyph;
25455 enum glyph_row_area area = it->area;
25457 eassert (ascent >= 0 && ascent <= height);
25459 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25460 if (glyph < it->glyph_row->glyphs[area + 1])
25462 /* If the glyph row is reversed, we need to prepend the glyph
25463 rather than append it. */
25464 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25466 struct glyph *g;
25468 /* Make room for the additional glyph. */
25469 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25470 g[1] = *g;
25471 glyph = it->glyph_row->glyphs[area];
25473 /* Decrease the width of the first glyph of the row that
25474 begins before first_visible_x (e.g., due to hscroll).
25475 This is so the overall width of the row becomes smaller
25476 by the scroll amount, and the stretch glyph appended by
25477 extend_face_to_end_of_line will be wider, to shift the
25478 row glyphs to the right. (In L2R rows, the corresponding
25479 left-shift effect is accomplished by setting row->x to a
25480 negative value, which won't work with R2L rows.)
25482 This must leave us with a positive value of WIDTH, since
25483 otherwise the call to move_it_in_display_line_to at the
25484 beginning of display_line would have got past the entire
25485 first glyph, and then it->current_x would have been
25486 greater or equal to it->first_visible_x. */
25487 if (it->current_x < it->first_visible_x)
25488 width -= it->first_visible_x - it->current_x;
25489 eassert (width > 0);
25491 glyph->charpos = CHARPOS (it->position);
25492 glyph->object = object;
25493 glyph->pixel_width = width;
25494 glyph->ascent = ascent;
25495 glyph->descent = height - ascent;
25496 glyph->voffset = it->voffset;
25497 glyph->type = STRETCH_GLYPH;
25498 glyph->avoid_cursor_p = it->avoid_cursor_p;
25499 glyph->multibyte_p = it->multibyte_p;
25500 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25502 /* In R2L rows, the left and the right box edges need to be
25503 drawn in reverse direction. */
25504 glyph->right_box_line_p = it->start_of_box_run_p;
25505 glyph->left_box_line_p = it->end_of_box_run_p;
25507 else
25509 glyph->left_box_line_p = it->start_of_box_run_p;
25510 glyph->right_box_line_p = it->end_of_box_run_p;
25512 glyph->overlaps_vertically_p = 0;
25513 glyph->padding_p = 0;
25514 glyph->glyph_not_available_p = 0;
25515 glyph->face_id = it->face_id;
25516 glyph->u.stretch.ascent = ascent;
25517 glyph->u.stretch.height = height;
25518 glyph->slice.img = null_glyph_slice;
25519 glyph->font_type = FONT_TYPE_UNKNOWN;
25520 if (it->bidi_p)
25522 glyph->resolved_level = it->bidi_it.resolved_level;
25523 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25524 emacs_abort ();
25525 glyph->bidi_type = it->bidi_it.type;
25527 else
25529 glyph->resolved_level = 0;
25530 glyph->bidi_type = UNKNOWN_BT;
25532 ++it->glyph_row->used[area];
25534 else
25535 IT_EXPAND_MATRIX_WIDTH (it, area);
25538 #endif /* HAVE_WINDOW_SYSTEM */
25540 /* Produce a stretch glyph for iterator IT. IT->object is the value
25541 of the glyph property displayed. The value must be a list
25542 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25543 being recognized:
25545 1. `:width WIDTH' specifies that the space should be WIDTH *
25546 canonical char width wide. WIDTH may be an integer or floating
25547 point number.
25549 2. `:relative-width FACTOR' specifies that the width of the stretch
25550 should be computed from the width of the first character having the
25551 `glyph' property, and should be FACTOR times that width.
25553 3. `:align-to HPOS' specifies that the space should be wide enough
25554 to reach HPOS, a value in canonical character units.
25556 Exactly one of the above pairs must be present.
25558 4. `:height HEIGHT' specifies that the height of the stretch produced
25559 should be HEIGHT, measured in canonical character units.
25561 5. `:relative-height FACTOR' specifies that the height of the
25562 stretch should be FACTOR times the height of the characters having
25563 the glyph property.
25565 Either none or exactly one of 4 or 5 must be present.
25567 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25568 of the stretch should be used for the ascent of the stretch.
25569 ASCENT must be in the range 0 <= ASCENT <= 100. */
25571 void
25572 produce_stretch_glyph (struct it *it)
25574 /* (space :width WIDTH :height HEIGHT ...) */
25575 Lisp_Object prop, plist;
25576 int width = 0, height = 0, align_to = -1;
25577 int zero_width_ok_p = 0;
25578 double tem;
25579 struct font *font = NULL;
25581 #ifdef HAVE_WINDOW_SYSTEM
25582 int ascent = 0;
25583 int zero_height_ok_p = 0;
25585 if (FRAME_WINDOW_P (it->f))
25587 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25588 font = face->font ? face->font : FRAME_FONT (it->f);
25589 PREPARE_FACE_FOR_DISPLAY (it->f, face);
25591 #endif
25593 /* List should start with `space'. */
25594 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
25595 plist = XCDR (it->object);
25597 /* Compute the width of the stretch. */
25598 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
25599 && calc_pixel_width_or_height (&tem, it, prop, font, 1, 0))
25601 /* Absolute width `:width WIDTH' specified and valid. */
25602 zero_width_ok_p = 1;
25603 width = (int)tem;
25605 #ifdef HAVE_WINDOW_SYSTEM
25606 else if (FRAME_WINDOW_P (it->f)
25607 && (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0))
25609 /* Relative width `:relative-width FACTOR' specified and valid.
25610 Compute the width of the characters having the `glyph'
25611 property. */
25612 struct it it2;
25613 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
25615 it2 = *it;
25616 if (it->multibyte_p)
25617 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
25618 else
25620 it2.c = it2.char_to_display = *p, it2.len = 1;
25621 if (! ASCII_CHAR_P (it2.c))
25622 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
25625 it2.glyph_row = NULL;
25626 it2.what = IT_CHARACTER;
25627 x_produce_glyphs (&it2);
25628 width = NUMVAL (prop) * it2.pixel_width;
25630 #endif /* HAVE_WINDOW_SYSTEM */
25631 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
25632 && calc_pixel_width_or_height (&tem, it, prop, font, 1, &align_to))
25634 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
25635 align_to = (align_to < 0
25637 : align_to - window_box_left_offset (it->w, TEXT_AREA));
25638 else if (align_to < 0)
25639 align_to = window_box_left_offset (it->w, TEXT_AREA);
25640 width = max (0, (int)tem + align_to - it->current_x);
25641 zero_width_ok_p = 1;
25643 else
25644 /* Nothing specified -> width defaults to canonical char width. */
25645 width = FRAME_COLUMN_WIDTH (it->f);
25647 if (width <= 0 && (width < 0 || !zero_width_ok_p))
25648 width = 1;
25650 #ifdef HAVE_WINDOW_SYSTEM
25651 /* Compute height. */
25652 if (FRAME_WINDOW_P (it->f))
25654 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
25655 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25657 height = (int)tem;
25658 zero_height_ok_p = 1;
25660 else if (prop = Fplist_get (plist, QCrelative_height),
25661 NUMVAL (prop) > 0)
25662 height = FONT_HEIGHT (font) * NUMVAL (prop);
25663 else
25664 height = FONT_HEIGHT (font);
25666 if (height <= 0 && (height < 0 || !zero_height_ok_p))
25667 height = 1;
25669 /* Compute percentage of height used for ascent. If
25670 `:ascent ASCENT' is present and valid, use that. Otherwise,
25671 derive the ascent from the font in use. */
25672 if (prop = Fplist_get (plist, QCascent),
25673 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
25674 ascent = height * NUMVAL (prop) / 100.0;
25675 else if (!NILP (prop)
25676 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25677 ascent = min (max (0, (int)tem), height);
25678 else
25679 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
25681 else
25682 #endif /* HAVE_WINDOW_SYSTEM */
25683 height = 1;
25685 if (width > 0 && it->line_wrap != TRUNCATE
25686 && it->current_x + width > it->last_visible_x)
25688 width = it->last_visible_x - it->current_x;
25689 #ifdef HAVE_WINDOW_SYSTEM
25690 /* Subtract one more pixel from the stretch width, but only on
25691 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25692 width -= FRAME_WINDOW_P (it->f);
25693 #endif
25696 if (width > 0 && height > 0 && it->glyph_row)
25698 Lisp_Object o_object = it->object;
25699 Lisp_Object object = it->stack[it->sp - 1].string;
25700 int n = width;
25702 if (!STRINGP (object))
25703 object = it->w->contents;
25704 #ifdef HAVE_WINDOW_SYSTEM
25705 if (FRAME_WINDOW_P (it->f))
25706 append_stretch_glyph (it, object, width, height, ascent);
25707 else
25708 #endif
25710 it->object = object;
25711 it->char_to_display = ' ';
25712 it->pixel_width = it->len = 1;
25713 while (n--)
25714 tty_append_glyph (it);
25715 it->object = o_object;
25719 it->pixel_width = width;
25720 #ifdef HAVE_WINDOW_SYSTEM
25721 if (FRAME_WINDOW_P (it->f))
25723 it->ascent = it->phys_ascent = ascent;
25724 it->descent = it->phys_descent = height - it->ascent;
25725 it->nglyphs = width > 0 && height > 0 ? 1 : 0;
25726 take_vertical_position_into_account (it);
25728 else
25729 #endif
25730 it->nglyphs = width;
25733 /* Get information about special display element WHAT in an
25734 environment described by IT. WHAT is one of IT_TRUNCATION or
25735 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25736 non-null glyph_row member. This function ensures that fields like
25737 face_id, c, len of IT are left untouched. */
25739 static void
25740 produce_special_glyphs (struct it *it, enum display_element_type what)
25742 struct it temp_it;
25743 Lisp_Object gc;
25744 GLYPH glyph;
25746 temp_it = *it;
25747 temp_it.object = make_number (0);
25748 memset (&temp_it.current, 0, sizeof temp_it.current);
25750 if (what == IT_CONTINUATION)
25752 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25753 if (it->bidi_it.paragraph_dir == R2L)
25754 SET_GLYPH_FROM_CHAR (glyph, '/');
25755 else
25756 SET_GLYPH_FROM_CHAR (glyph, '\\');
25757 if (it->dp
25758 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25760 /* FIXME: Should we mirror GC for R2L lines? */
25761 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25762 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25765 else if (what == IT_TRUNCATION)
25767 /* Truncation glyph. */
25768 SET_GLYPH_FROM_CHAR (glyph, '$');
25769 if (it->dp
25770 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25772 /* FIXME: Should we mirror GC for R2L lines? */
25773 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25774 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25777 else
25778 emacs_abort ();
25780 #ifdef HAVE_WINDOW_SYSTEM
25781 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25782 is turned off, we precede the truncation/continuation glyphs by a
25783 stretch glyph whose width is computed such that these special
25784 glyphs are aligned at the window margin, even when very different
25785 fonts are used in different glyph rows. */
25786 if (FRAME_WINDOW_P (temp_it.f)
25787 /* init_iterator calls this with it->glyph_row == NULL, and it
25788 wants only the pixel width of the truncation/continuation
25789 glyphs. */
25790 && temp_it.glyph_row
25791 /* insert_left_trunc_glyphs calls us at the beginning of the
25792 row, and it has its own calculation of the stretch glyph
25793 width. */
25794 && temp_it.glyph_row->used[TEXT_AREA] > 0
25795 && (temp_it.glyph_row->reversed_p
25796 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
25797 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
25799 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
25801 if (stretch_width > 0)
25803 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
25804 struct font *font =
25805 face->font ? face->font : FRAME_FONT (temp_it.f);
25806 int stretch_ascent =
25807 (((temp_it.ascent + temp_it.descent)
25808 * FONT_BASE (font)) / FONT_HEIGHT (font));
25810 append_stretch_glyph (&temp_it, make_number (0), stretch_width,
25811 temp_it.ascent + temp_it.descent,
25812 stretch_ascent);
25815 #endif
25817 temp_it.dp = NULL;
25818 temp_it.what = IT_CHARACTER;
25819 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
25820 temp_it.face_id = GLYPH_FACE (glyph);
25821 temp_it.len = CHAR_BYTES (temp_it.c);
25823 PRODUCE_GLYPHS (&temp_it);
25824 it->pixel_width = temp_it.pixel_width;
25825 it->nglyphs = temp_it.nglyphs;
25828 #ifdef HAVE_WINDOW_SYSTEM
25830 /* Calculate line-height and line-spacing properties.
25831 An integer value specifies explicit pixel value.
25832 A float value specifies relative value to current face height.
25833 A cons (float . face-name) specifies relative value to
25834 height of specified face font.
25836 Returns height in pixels, or nil. */
25839 static Lisp_Object
25840 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
25841 int boff, int override)
25843 Lisp_Object face_name = Qnil;
25844 int ascent, descent, height;
25846 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
25847 return val;
25849 if (CONSP (val))
25851 face_name = XCAR (val);
25852 val = XCDR (val);
25853 if (!NUMBERP (val))
25854 val = make_number (1);
25855 if (NILP (face_name))
25857 height = it->ascent + it->descent;
25858 goto scale;
25862 if (NILP (face_name))
25864 font = FRAME_FONT (it->f);
25865 boff = FRAME_BASELINE_OFFSET (it->f);
25867 else if (EQ (face_name, Qt))
25869 override = 0;
25871 else
25873 int face_id;
25874 struct face *face;
25876 face_id = lookup_named_face (it->f, face_name, 0);
25877 if (face_id < 0)
25878 return make_number (-1);
25880 face = FACE_FROM_ID (it->f, face_id);
25881 font = face->font;
25882 if (font == NULL)
25883 return make_number (-1);
25884 boff = font->baseline_offset;
25885 if (font->vertical_centering)
25886 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
25889 ascent = FONT_BASE (font) + boff;
25890 descent = FONT_DESCENT (font) - boff;
25892 if (override)
25894 it->override_ascent = ascent;
25895 it->override_descent = descent;
25896 it->override_boff = boff;
25899 height = ascent + descent;
25901 scale:
25902 if (FLOATP (val))
25903 height = (int)(XFLOAT_DATA (val) * height);
25904 else if (INTEGERP (val))
25905 height *= XINT (val);
25907 return make_number (height);
25911 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25912 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25913 and only if this is for a character for which no font was found.
25915 If the display method (it->glyphless_method) is
25916 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25917 length of the acronym or the hexadecimal string, UPPER_XOFF and
25918 UPPER_YOFF are pixel offsets for the upper part of the string,
25919 LOWER_XOFF and LOWER_YOFF are for the lower part.
25921 For the other display methods, LEN through LOWER_YOFF are zero. */
25923 static void
25924 append_glyphless_glyph (struct it *it, int face_id, int for_no_font, int len,
25925 short upper_xoff, short upper_yoff,
25926 short lower_xoff, short lower_yoff)
25928 struct glyph *glyph;
25929 enum glyph_row_area area = it->area;
25931 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25932 if (glyph < it->glyph_row->glyphs[area + 1])
25934 /* If the glyph row is reversed, we need to prepend the glyph
25935 rather than append it. */
25936 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25938 struct glyph *g;
25940 /* Make room for the additional glyph. */
25941 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25942 g[1] = *g;
25943 glyph = it->glyph_row->glyphs[area];
25945 glyph->charpos = CHARPOS (it->position);
25946 glyph->object = it->object;
25947 glyph->pixel_width = it->pixel_width;
25948 glyph->ascent = it->ascent;
25949 glyph->descent = it->descent;
25950 glyph->voffset = it->voffset;
25951 glyph->type = GLYPHLESS_GLYPH;
25952 glyph->u.glyphless.method = it->glyphless_method;
25953 glyph->u.glyphless.for_no_font = for_no_font;
25954 glyph->u.glyphless.len = len;
25955 glyph->u.glyphless.ch = it->c;
25956 glyph->slice.glyphless.upper_xoff = upper_xoff;
25957 glyph->slice.glyphless.upper_yoff = upper_yoff;
25958 glyph->slice.glyphless.lower_xoff = lower_xoff;
25959 glyph->slice.glyphless.lower_yoff = lower_yoff;
25960 glyph->avoid_cursor_p = it->avoid_cursor_p;
25961 glyph->multibyte_p = it->multibyte_p;
25962 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25964 /* In R2L rows, the left and the right box edges need to be
25965 drawn in reverse direction. */
25966 glyph->right_box_line_p = it->start_of_box_run_p;
25967 glyph->left_box_line_p = it->end_of_box_run_p;
25969 else
25971 glyph->left_box_line_p = it->start_of_box_run_p;
25972 glyph->right_box_line_p = it->end_of_box_run_p;
25974 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25975 || it->phys_descent > it->descent);
25976 glyph->padding_p = 0;
25977 glyph->glyph_not_available_p = 0;
25978 glyph->face_id = face_id;
25979 glyph->font_type = FONT_TYPE_UNKNOWN;
25980 if (it->bidi_p)
25982 glyph->resolved_level = it->bidi_it.resolved_level;
25983 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25984 emacs_abort ();
25985 glyph->bidi_type = it->bidi_it.type;
25987 ++it->glyph_row->used[area];
25989 else
25990 IT_EXPAND_MATRIX_WIDTH (it, area);
25994 /* Produce a glyph for a glyphless character for iterator IT.
25995 IT->glyphless_method specifies which method to use for displaying
25996 the character. See the description of enum
25997 glyphless_display_method in dispextern.h for the detail.
25999 FOR_NO_FONT is nonzero if and only if this is for a character for
26000 which no font was found. ACRONYM, if non-nil, is an acronym string
26001 for the character. */
26003 static void
26004 produce_glyphless_glyph (struct it *it, int for_no_font, Lisp_Object acronym)
26006 int face_id;
26007 struct face *face;
26008 struct font *font;
26009 int base_width, base_height, width, height;
26010 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
26011 int len;
26013 /* Get the metrics of the base font. We always refer to the current
26014 ASCII face. */
26015 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
26016 font = face->font ? face->font : FRAME_FONT (it->f);
26017 it->ascent = FONT_BASE (font) + font->baseline_offset;
26018 it->descent = FONT_DESCENT (font) - font->baseline_offset;
26019 base_height = it->ascent + it->descent;
26020 base_width = font->average_width;
26022 face_id = merge_glyphless_glyph_face (it);
26024 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
26026 it->pixel_width = THIN_SPACE_WIDTH;
26027 len = 0;
26028 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26030 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
26032 width = CHAR_WIDTH (it->c);
26033 if (width == 0)
26034 width = 1;
26035 else if (width > 4)
26036 width = 4;
26037 it->pixel_width = base_width * width;
26038 len = 0;
26039 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
26041 else
26043 char buf[7];
26044 const char *str;
26045 unsigned int code[6];
26046 int upper_len;
26047 int ascent, descent;
26048 struct font_metrics metrics_upper, metrics_lower;
26050 face = FACE_FROM_ID (it->f, face_id);
26051 font = face->font ? face->font : FRAME_FONT (it->f);
26052 PREPARE_FACE_FOR_DISPLAY (it->f, face);
26054 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
26056 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
26057 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
26058 if (CONSP (acronym))
26059 acronym = XCAR (acronym);
26060 str = STRINGP (acronym) ? SSDATA (acronym) : "";
26062 else
26064 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
26065 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c);
26066 str = buf;
26068 for (len = 0; str[len] && ASCII_BYTE_P (str[len]) && len < 6; len++)
26069 code[len] = font->driver->encode_char (font, str[len]);
26070 upper_len = (len + 1) / 2;
26071 font->driver->text_extents (font, code, upper_len,
26072 &metrics_upper);
26073 font->driver->text_extents (font, code + upper_len, len - upper_len,
26074 &metrics_lower);
26078 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26079 width = max (metrics_upper.width, metrics_lower.width) + 4;
26080 upper_xoff = upper_yoff = 2; /* the typical case */
26081 if (base_width >= width)
26083 /* Align the upper to the left, the lower to the right. */
26084 it->pixel_width = base_width;
26085 lower_xoff = base_width - 2 - metrics_lower.width;
26087 else
26089 /* Center the shorter one. */
26090 it->pixel_width = width;
26091 if (metrics_upper.width >= metrics_lower.width)
26092 lower_xoff = (width - metrics_lower.width) / 2;
26093 else
26095 /* FIXME: This code doesn't look right. It formerly was
26096 missing the "lower_xoff = 0;", which couldn't have
26097 been right since it left lower_xoff uninitialized. */
26098 lower_xoff = 0;
26099 upper_xoff = (width - metrics_upper.width) / 2;
26103 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26104 top, bottom, and between upper and lower strings. */
26105 height = (metrics_upper.ascent + metrics_upper.descent
26106 + metrics_lower.ascent + metrics_lower.descent) + 5;
26107 /* Center vertically.
26108 H:base_height, D:base_descent
26109 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26111 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26112 descent = D - H/2 + h/2;
26113 lower_yoff = descent - 2 - ld;
26114 upper_yoff = lower_yoff - la - 1 - ud; */
26115 ascent = - (it->descent - (base_height + height + 1) / 2);
26116 descent = it->descent - (base_height - height) / 2;
26117 lower_yoff = descent - 2 - metrics_lower.descent;
26118 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
26119 - metrics_upper.descent);
26120 /* Don't make the height shorter than the base height. */
26121 if (height > base_height)
26123 it->ascent = ascent;
26124 it->descent = descent;
26128 it->phys_ascent = it->ascent;
26129 it->phys_descent = it->descent;
26130 if (it->glyph_row)
26131 append_glyphless_glyph (it, face_id, for_no_font, len,
26132 upper_xoff, upper_yoff,
26133 lower_xoff, lower_yoff);
26134 it->nglyphs = 1;
26135 take_vertical_position_into_account (it);
26139 /* RIF:
26140 Produce glyphs/get display metrics for the display element IT is
26141 loaded with. See the description of struct it in dispextern.h
26142 for an overview of struct it. */
26144 void
26145 x_produce_glyphs (struct it *it)
26147 int extra_line_spacing = it->extra_line_spacing;
26149 it->glyph_not_available_p = 0;
26151 if (it->what == IT_CHARACTER)
26153 XChar2b char2b;
26154 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26155 struct font *font = face->font;
26156 struct font_metrics *pcm = NULL;
26157 int boff; /* Baseline offset. */
26159 if (font == NULL)
26161 /* When no suitable font is found, display this character by
26162 the method specified in the first extra slot of
26163 Vglyphless_char_display. */
26164 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
26166 eassert (it->what == IT_GLYPHLESS);
26167 produce_glyphless_glyph (it, 1, STRINGP (acronym) ? acronym : Qnil);
26168 goto done;
26171 boff = font->baseline_offset;
26172 if (font->vertical_centering)
26173 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26175 if (it->char_to_display != '\n' && it->char_to_display != '\t')
26177 int stretched_p;
26179 it->nglyphs = 1;
26181 if (it->override_ascent >= 0)
26183 it->ascent = it->override_ascent;
26184 it->descent = it->override_descent;
26185 boff = it->override_boff;
26187 else
26189 it->ascent = FONT_BASE (font) + boff;
26190 it->descent = FONT_DESCENT (font) - boff;
26193 if (get_char_glyph_code (it->char_to_display, font, &char2b))
26195 pcm = get_per_char_metric (font, &char2b);
26196 if (pcm->width == 0
26197 && pcm->rbearing == 0 && pcm->lbearing == 0)
26198 pcm = NULL;
26201 if (pcm)
26203 it->phys_ascent = pcm->ascent + boff;
26204 it->phys_descent = pcm->descent - boff;
26205 it->pixel_width = pcm->width;
26207 else
26209 it->glyph_not_available_p = 1;
26210 it->phys_ascent = it->ascent;
26211 it->phys_descent = it->descent;
26212 it->pixel_width = font->space_width;
26215 if (it->constrain_row_ascent_descent_p)
26217 if (it->descent > it->max_descent)
26219 it->ascent += it->descent - it->max_descent;
26220 it->descent = it->max_descent;
26222 if (it->ascent > it->max_ascent)
26224 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26225 it->ascent = it->max_ascent;
26227 it->phys_ascent = min (it->phys_ascent, it->ascent);
26228 it->phys_descent = min (it->phys_descent, it->descent);
26229 extra_line_spacing = 0;
26232 /* If this is a space inside a region of text with
26233 `space-width' property, change its width. */
26234 stretched_p = it->char_to_display == ' ' && !NILP (it->space_width);
26235 if (stretched_p)
26236 it->pixel_width *= XFLOATINT (it->space_width);
26238 /* If face has a box, add the box thickness to the character
26239 height. If character has a box line to the left and/or
26240 right, add the box line width to the character's width. */
26241 if (face->box != FACE_NO_BOX)
26243 int thick = face->box_line_width;
26245 if (thick > 0)
26247 it->ascent += thick;
26248 it->descent += thick;
26250 else
26251 thick = -thick;
26253 if (it->start_of_box_run_p)
26254 it->pixel_width += thick;
26255 if (it->end_of_box_run_p)
26256 it->pixel_width += thick;
26259 /* If face has an overline, add the height of the overline
26260 (1 pixel) and a 1 pixel margin to the character height. */
26261 if (face->overline_p)
26262 it->ascent += overline_margin;
26264 if (it->constrain_row_ascent_descent_p)
26266 if (it->ascent > it->max_ascent)
26267 it->ascent = it->max_ascent;
26268 if (it->descent > it->max_descent)
26269 it->descent = it->max_descent;
26272 take_vertical_position_into_account (it);
26274 /* If we have to actually produce glyphs, do it. */
26275 if (it->glyph_row)
26277 if (stretched_p)
26279 /* Translate a space with a `space-width' property
26280 into a stretch glyph. */
26281 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
26282 / FONT_HEIGHT (font));
26283 append_stretch_glyph (it, it->object, it->pixel_width,
26284 it->ascent + it->descent, ascent);
26286 else
26287 append_glyph (it);
26289 /* If characters with lbearing or rbearing are displayed
26290 in this line, record that fact in a flag of the
26291 glyph row. This is used to optimize X output code. */
26292 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
26293 it->glyph_row->contains_overlapping_glyphs_p = 1;
26295 if (! stretched_p && it->pixel_width == 0)
26296 /* We assure that all visible glyphs have at least 1-pixel
26297 width. */
26298 it->pixel_width = 1;
26300 else if (it->char_to_display == '\n')
26302 /* A newline has no width, but we need the height of the
26303 line. But if previous part of the line sets a height,
26304 don't increase that height. */
26306 Lisp_Object height;
26307 Lisp_Object total_height = Qnil;
26309 it->override_ascent = -1;
26310 it->pixel_width = 0;
26311 it->nglyphs = 0;
26313 height = get_it_property (it, Qline_height);
26314 /* Split (line-height total-height) list. */
26315 if (CONSP (height)
26316 && CONSP (XCDR (height))
26317 && NILP (XCDR (XCDR (height))))
26319 total_height = XCAR (XCDR (height));
26320 height = XCAR (height);
26322 height = calc_line_height_property (it, height, font, boff, 1);
26324 if (it->override_ascent >= 0)
26326 it->ascent = it->override_ascent;
26327 it->descent = it->override_descent;
26328 boff = it->override_boff;
26330 else
26332 it->ascent = FONT_BASE (font) + boff;
26333 it->descent = FONT_DESCENT (font) - boff;
26336 if (EQ (height, Qt))
26338 if (it->descent > it->max_descent)
26340 it->ascent += it->descent - it->max_descent;
26341 it->descent = it->max_descent;
26343 if (it->ascent > it->max_ascent)
26345 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26346 it->ascent = it->max_ascent;
26348 it->phys_ascent = min (it->phys_ascent, it->ascent);
26349 it->phys_descent = min (it->phys_descent, it->descent);
26350 it->constrain_row_ascent_descent_p = 1;
26351 extra_line_spacing = 0;
26353 else
26355 Lisp_Object spacing;
26357 it->phys_ascent = it->ascent;
26358 it->phys_descent = it->descent;
26360 if ((it->max_ascent > 0 || it->max_descent > 0)
26361 && face->box != FACE_NO_BOX
26362 && face->box_line_width > 0)
26364 it->ascent += face->box_line_width;
26365 it->descent += face->box_line_width;
26367 if (!NILP (height)
26368 && XINT (height) > it->ascent + it->descent)
26369 it->ascent = XINT (height) - it->descent;
26371 if (!NILP (total_height))
26372 spacing = calc_line_height_property (it, total_height, font, boff, 0);
26373 else
26375 spacing = get_it_property (it, Qline_spacing);
26376 spacing = calc_line_height_property (it, spacing, font, boff, 0);
26378 if (INTEGERP (spacing))
26380 extra_line_spacing = XINT (spacing);
26381 if (!NILP (total_height))
26382 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
26386 else /* i.e. (it->char_to_display == '\t') */
26388 if (font->space_width > 0)
26390 int tab_width = it->tab_width * font->space_width;
26391 int x = it->current_x + it->continuation_lines_width;
26392 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
26394 /* If the distance from the current position to the next tab
26395 stop is less than a space character width, use the
26396 tab stop after that. */
26397 if (next_tab_x - x < font->space_width)
26398 next_tab_x += tab_width;
26400 it->pixel_width = next_tab_x - x;
26401 it->nglyphs = 1;
26402 it->ascent = it->phys_ascent = FONT_BASE (font) + boff;
26403 it->descent = it->phys_descent = FONT_DESCENT (font) - boff;
26405 if (it->glyph_row)
26407 append_stretch_glyph (it, it->object, it->pixel_width,
26408 it->ascent + it->descent, it->ascent);
26411 else
26413 it->pixel_width = 0;
26414 it->nglyphs = 1;
26418 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
26420 /* A static composition.
26422 Note: A composition is represented as one glyph in the
26423 glyph matrix. There are no padding glyphs.
26425 Important note: pixel_width, ascent, and descent are the
26426 values of what is drawn by draw_glyphs (i.e. the values of
26427 the overall glyphs composed). */
26428 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26429 int boff; /* baseline offset */
26430 struct composition *cmp = composition_table[it->cmp_it.id];
26431 int glyph_len = cmp->glyph_len;
26432 struct font *font = face->font;
26434 it->nglyphs = 1;
26436 /* If we have not yet calculated pixel size data of glyphs of
26437 the composition for the current face font, calculate them
26438 now. Theoretically, we have to check all fonts for the
26439 glyphs, but that requires much time and memory space. So,
26440 here we check only the font of the first glyph. This may
26441 lead to incorrect display, but it's very rare, and C-l
26442 (recenter-top-bottom) can correct the display anyway. */
26443 if (! cmp->font || cmp->font != font)
26445 /* Ascent and descent of the font of the first character
26446 of this composition (adjusted by baseline offset).
26447 Ascent and descent of overall glyphs should not be less
26448 than these, respectively. */
26449 int font_ascent, font_descent, font_height;
26450 /* Bounding box of the overall glyphs. */
26451 int leftmost, rightmost, lowest, highest;
26452 int lbearing, rbearing;
26453 int i, width, ascent, descent;
26454 int left_padded = 0, right_padded = 0;
26455 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26456 XChar2b char2b;
26457 struct font_metrics *pcm;
26458 int font_not_found_p;
26459 ptrdiff_t pos;
26461 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
26462 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
26463 break;
26464 if (glyph_len < cmp->glyph_len)
26465 right_padded = 1;
26466 for (i = 0; i < glyph_len; i++)
26468 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
26469 break;
26470 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26472 if (i > 0)
26473 left_padded = 1;
26475 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
26476 : IT_CHARPOS (*it));
26477 /* If no suitable font is found, use the default font. */
26478 font_not_found_p = font == NULL;
26479 if (font_not_found_p)
26481 face = face->ascii_face;
26482 font = face->font;
26484 boff = font->baseline_offset;
26485 if (font->vertical_centering)
26486 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26487 font_ascent = FONT_BASE (font) + boff;
26488 font_descent = FONT_DESCENT (font) - boff;
26489 font_height = FONT_HEIGHT (font);
26491 cmp->font = font;
26493 pcm = NULL;
26494 if (! font_not_found_p)
26496 get_char_face_and_encoding (it->f, c, it->face_id,
26497 &char2b, 0);
26498 pcm = get_per_char_metric (font, &char2b);
26501 /* Initialize the bounding box. */
26502 if (pcm)
26504 width = cmp->glyph_len > 0 ? pcm->width : 0;
26505 ascent = pcm->ascent;
26506 descent = pcm->descent;
26507 lbearing = pcm->lbearing;
26508 rbearing = pcm->rbearing;
26510 else
26512 width = cmp->glyph_len > 0 ? font->space_width : 0;
26513 ascent = FONT_BASE (font);
26514 descent = FONT_DESCENT (font);
26515 lbearing = 0;
26516 rbearing = width;
26519 rightmost = width;
26520 leftmost = 0;
26521 lowest = - descent + boff;
26522 highest = ascent + boff;
26524 if (! font_not_found_p
26525 && font->default_ascent
26526 && CHAR_TABLE_P (Vuse_default_ascent)
26527 && !NILP (Faref (Vuse_default_ascent,
26528 make_number (it->char_to_display))))
26529 highest = font->default_ascent + boff;
26531 /* Draw the first glyph at the normal position. It may be
26532 shifted to right later if some other glyphs are drawn
26533 at the left. */
26534 cmp->offsets[i * 2] = 0;
26535 cmp->offsets[i * 2 + 1] = boff;
26536 cmp->lbearing = lbearing;
26537 cmp->rbearing = rbearing;
26539 /* Set cmp->offsets for the remaining glyphs. */
26540 for (i++; i < glyph_len; i++)
26542 int left, right, btm, top;
26543 int ch = COMPOSITION_GLYPH (cmp, i);
26544 int face_id;
26545 struct face *this_face;
26547 if (ch == '\t')
26548 ch = ' ';
26549 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
26550 this_face = FACE_FROM_ID (it->f, face_id);
26551 font = this_face->font;
26553 if (font == NULL)
26554 pcm = NULL;
26555 else
26557 get_char_face_and_encoding (it->f, ch, face_id,
26558 &char2b, 0);
26559 pcm = get_per_char_metric (font, &char2b);
26561 if (! pcm)
26562 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26563 else
26565 width = pcm->width;
26566 ascent = pcm->ascent;
26567 descent = pcm->descent;
26568 lbearing = pcm->lbearing;
26569 rbearing = pcm->rbearing;
26570 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
26572 /* Relative composition with or without
26573 alternate chars. */
26574 left = (leftmost + rightmost - width) / 2;
26575 btm = - descent + boff;
26576 if (font->relative_compose
26577 && (! CHAR_TABLE_P (Vignore_relative_composition)
26578 || NILP (Faref (Vignore_relative_composition,
26579 make_number (ch)))))
26582 if (- descent >= font->relative_compose)
26583 /* One extra pixel between two glyphs. */
26584 btm = highest + 1;
26585 else if (ascent <= 0)
26586 /* One extra pixel between two glyphs. */
26587 btm = lowest - 1 - ascent - descent;
26590 else
26592 /* A composition rule is specified by an integer
26593 value that encodes global and new reference
26594 points (GREF and NREF). GREF and NREF are
26595 specified by numbers as below:
26597 0---1---2 -- ascent
26601 9--10--11 -- center
26603 ---3---4---5--- baseline
26605 6---7---8 -- descent
26607 int rule = COMPOSITION_RULE (cmp, i);
26608 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
26610 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
26611 grefx = gref % 3, nrefx = nref % 3;
26612 grefy = gref / 3, nrefy = nref / 3;
26613 if (xoff)
26614 xoff = font_height * (xoff - 128) / 256;
26615 if (yoff)
26616 yoff = font_height * (yoff - 128) / 256;
26618 left = (leftmost
26619 + grefx * (rightmost - leftmost) / 2
26620 - nrefx * width / 2
26621 + xoff);
26623 btm = ((grefy == 0 ? highest
26624 : grefy == 1 ? 0
26625 : grefy == 2 ? lowest
26626 : (highest + lowest) / 2)
26627 - (nrefy == 0 ? ascent + descent
26628 : nrefy == 1 ? descent - boff
26629 : nrefy == 2 ? 0
26630 : (ascent + descent) / 2)
26631 + yoff);
26634 cmp->offsets[i * 2] = left;
26635 cmp->offsets[i * 2 + 1] = btm + descent;
26637 /* Update the bounding box of the overall glyphs. */
26638 if (width > 0)
26640 right = left + width;
26641 if (left < leftmost)
26642 leftmost = left;
26643 if (right > rightmost)
26644 rightmost = right;
26646 top = btm + descent + ascent;
26647 if (top > highest)
26648 highest = top;
26649 if (btm < lowest)
26650 lowest = btm;
26652 if (cmp->lbearing > left + lbearing)
26653 cmp->lbearing = left + lbearing;
26654 if (cmp->rbearing < left + rbearing)
26655 cmp->rbearing = left + rbearing;
26659 /* If there are glyphs whose x-offsets are negative,
26660 shift all glyphs to the right and make all x-offsets
26661 non-negative. */
26662 if (leftmost < 0)
26664 for (i = 0; i < cmp->glyph_len; i++)
26665 cmp->offsets[i * 2] -= leftmost;
26666 rightmost -= leftmost;
26667 cmp->lbearing -= leftmost;
26668 cmp->rbearing -= leftmost;
26671 if (left_padded && cmp->lbearing < 0)
26673 for (i = 0; i < cmp->glyph_len; i++)
26674 cmp->offsets[i * 2] -= cmp->lbearing;
26675 rightmost -= cmp->lbearing;
26676 cmp->rbearing -= cmp->lbearing;
26677 cmp->lbearing = 0;
26679 if (right_padded && rightmost < cmp->rbearing)
26681 rightmost = cmp->rbearing;
26684 cmp->pixel_width = rightmost;
26685 cmp->ascent = highest;
26686 cmp->descent = - lowest;
26687 if (cmp->ascent < font_ascent)
26688 cmp->ascent = font_ascent;
26689 if (cmp->descent < font_descent)
26690 cmp->descent = font_descent;
26693 if (it->glyph_row
26694 && (cmp->lbearing < 0
26695 || cmp->rbearing > cmp->pixel_width))
26696 it->glyph_row->contains_overlapping_glyphs_p = 1;
26698 it->pixel_width = cmp->pixel_width;
26699 it->ascent = it->phys_ascent = cmp->ascent;
26700 it->descent = it->phys_descent = cmp->descent;
26701 if (face->box != FACE_NO_BOX)
26703 int thick = face->box_line_width;
26705 if (thick > 0)
26707 it->ascent += thick;
26708 it->descent += thick;
26710 else
26711 thick = - thick;
26713 if (it->start_of_box_run_p)
26714 it->pixel_width += thick;
26715 if (it->end_of_box_run_p)
26716 it->pixel_width += thick;
26719 /* If face has an overline, add the height of the overline
26720 (1 pixel) and a 1 pixel margin to the character height. */
26721 if (face->overline_p)
26722 it->ascent += overline_margin;
26724 take_vertical_position_into_account (it);
26725 if (it->ascent < 0)
26726 it->ascent = 0;
26727 if (it->descent < 0)
26728 it->descent = 0;
26730 if (it->glyph_row && cmp->glyph_len > 0)
26731 append_composite_glyph (it);
26733 else if (it->what == IT_COMPOSITION)
26735 /* A dynamic (automatic) composition. */
26736 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26737 Lisp_Object gstring;
26738 struct font_metrics metrics;
26740 it->nglyphs = 1;
26742 gstring = composition_gstring_from_id (it->cmp_it.id);
26743 it->pixel_width
26744 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
26745 &metrics);
26746 if (it->glyph_row
26747 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
26748 it->glyph_row->contains_overlapping_glyphs_p = 1;
26749 it->ascent = it->phys_ascent = metrics.ascent;
26750 it->descent = it->phys_descent = metrics.descent;
26751 if (face->box != FACE_NO_BOX)
26753 int thick = face->box_line_width;
26755 if (thick > 0)
26757 it->ascent += thick;
26758 it->descent += thick;
26760 else
26761 thick = - thick;
26763 if (it->start_of_box_run_p)
26764 it->pixel_width += thick;
26765 if (it->end_of_box_run_p)
26766 it->pixel_width += thick;
26768 /* If face has an overline, add the height of the overline
26769 (1 pixel) and a 1 pixel margin to the character height. */
26770 if (face->overline_p)
26771 it->ascent += overline_margin;
26772 take_vertical_position_into_account (it);
26773 if (it->ascent < 0)
26774 it->ascent = 0;
26775 if (it->descent < 0)
26776 it->descent = 0;
26778 if (it->glyph_row)
26779 append_composite_glyph (it);
26781 else if (it->what == IT_GLYPHLESS)
26782 produce_glyphless_glyph (it, 0, Qnil);
26783 else if (it->what == IT_IMAGE)
26784 produce_image_glyph (it);
26785 else if (it->what == IT_STRETCH)
26786 produce_stretch_glyph (it);
26788 done:
26789 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26790 because this isn't true for images with `:ascent 100'. */
26791 eassert (it->ascent >= 0 && it->descent >= 0);
26792 if (it->area == TEXT_AREA)
26793 it->current_x += it->pixel_width;
26795 if (extra_line_spacing > 0)
26797 it->descent += extra_line_spacing;
26798 if (extra_line_spacing > it->max_extra_line_spacing)
26799 it->max_extra_line_spacing = extra_line_spacing;
26802 it->max_ascent = max (it->max_ascent, it->ascent);
26803 it->max_descent = max (it->max_descent, it->descent);
26804 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
26805 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
26808 /* EXPORT for RIF:
26809 Output LEN glyphs starting at START at the nominal cursor position.
26810 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26811 being updated, and UPDATED_AREA is the area of that row being updated. */
26813 void
26814 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
26815 struct glyph *start, enum glyph_row_area updated_area, int len)
26817 int x, hpos, chpos = w->phys_cursor.hpos;
26819 eassert (updated_row);
26820 /* When the window is hscrolled, cursor hpos can legitimately be out
26821 of bounds, but we draw the cursor at the corresponding window
26822 margin in that case. */
26823 if (!updated_row->reversed_p && chpos < 0)
26824 chpos = 0;
26825 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
26826 chpos = updated_row->used[TEXT_AREA] - 1;
26828 block_input ();
26830 /* Write glyphs. */
26832 hpos = start - updated_row->glyphs[updated_area];
26833 x = draw_glyphs (w, w->output_cursor.x,
26834 updated_row, updated_area,
26835 hpos, hpos + len,
26836 DRAW_NORMAL_TEXT, 0);
26838 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26839 if (updated_area == TEXT_AREA
26840 && w->phys_cursor_on_p
26841 && w->phys_cursor.vpos == w->output_cursor.vpos
26842 && chpos >= hpos
26843 && chpos < hpos + len)
26844 w->phys_cursor_on_p = 0;
26846 unblock_input ();
26848 /* Advance the output cursor. */
26849 w->output_cursor.hpos += len;
26850 w->output_cursor.x = x;
26854 /* EXPORT for RIF:
26855 Insert LEN glyphs from START at the nominal cursor position. */
26857 void
26858 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
26859 struct glyph *start, enum glyph_row_area updated_area, int len)
26861 struct frame *f;
26862 int line_height, shift_by_width, shifted_region_width;
26863 struct glyph_row *row;
26864 struct glyph *glyph;
26865 int frame_x, frame_y;
26866 ptrdiff_t hpos;
26868 eassert (updated_row);
26869 block_input ();
26870 f = XFRAME (WINDOW_FRAME (w));
26872 /* Get the height of the line we are in. */
26873 row = updated_row;
26874 line_height = row->height;
26876 /* Get the width of the glyphs to insert. */
26877 shift_by_width = 0;
26878 for (glyph = start; glyph < start + len; ++glyph)
26879 shift_by_width += glyph->pixel_width;
26881 /* Get the width of the region to shift right. */
26882 shifted_region_width = (window_box_width (w, updated_area)
26883 - w->output_cursor.x
26884 - shift_by_width);
26886 /* Shift right. */
26887 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
26888 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
26890 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
26891 line_height, shift_by_width);
26893 /* Write the glyphs. */
26894 hpos = start - row->glyphs[updated_area];
26895 draw_glyphs (w, w->output_cursor.x, row, updated_area,
26896 hpos, hpos + len,
26897 DRAW_NORMAL_TEXT, 0);
26899 /* Advance the output cursor. */
26900 w->output_cursor.hpos += len;
26901 w->output_cursor.x += shift_by_width;
26902 unblock_input ();
26906 /* EXPORT for RIF:
26907 Erase the current text line from the nominal cursor position
26908 (inclusive) to pixel column TO_X (exclusive). The idea is that
26909 everything from TO_X onward is already erased.
26911 TO_X is a pixel position relative to UPDATED_AREA of currently
26912 updated window W. TO_X == -1 means clear to the end of this area. */
26914 void
26915 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
26916 enum glyph_row_area updated_area, int to_x)
26918 struct frame *f;
26919 int max_x, min_y, max_y;
26920 int from_x, from_y, to_y;
26922 eassert (updated_row);
26923 f = XFRAME (w->frame);
26925 if (updated_row->full_width_p)
26926 max_x = (WINDOW_PIXEL_WIDTH (w)
26927 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
26928 else
26929 max_x = window_box_width (w, updated_area);
26930 max_y = window_text_bottom_y (w);
26932 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26933 of window. For TO_X > 0, truncate to end of drawing area. */
26934 if (to_x == 0)
26935 return;
26936 else if (to_x < 0)
26937 to_x = max_x;
26938 else
26939 to_x = min (to_x, max_x);
26941 to_y = min (max_y, w->output_cursor.y + updated_row->height);
26943 /* Notice if the cursor will be cleared by this operation. */
26944 if (!updated_row->full_width_p)
26945 notice_overwritten_cursor (w, updated_area,
26946 w->output_cursor.x, -1,
26947 updated_row->y,
26948 MATRIX_ROW_BOTTOM_Y (updated_row));
26950 from_x = w->output_cursor.x;
26952 /* Translate to frame coordinates. */
26953 if (updated_row->full_width_p)
26955 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
26956 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
26958 else
26960 int area_left = window_box_left (w, updated_area);
26961 from_x += area_left;
26962 to_x += area_left;
26965 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
26966 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
26967 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
26969 /* Prevent inadvertently clearing to end of the X window. */
26970 if (to_x > from_x && to_y > from_y)
26972 block_input ();
26973 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
26974 to_x - from_x, to_y - from_y);
26975 unblock_input ();
26979 #endif /* HAVE_WINDOW_SYSTEM */
26983 /***********************************************************************
26984 Cursor types
26985 ***********************************************************************/
26987 /* Value is the internal representation of the specified cursor type
26988 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26989 of the bar cursor. */
26991 static enum text_cursor_kinds
26992 get_specified_cursor_type (Lisp_Object arg, int *width)
26994 enum text_cursor_kinds type;
26996 if (NILP (arg))
26997 return NO_CURSOR;
26999 if (EQ (arg, Qbox))
27000 return FILLED_BOX_CURSOR;
27002 if (EQ (arg, Qhollow))
27003 return HOLLOW_BOX_CURSOR;
27005 if (EQ (arg, Qbar))
27007 *width = 2;
27008 return BAR_CURSOR;
27011 if (CONSP (arg)
27012 && EQ (XCAR (arg), Qbar)
27013 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27015 *width = XINT (XCDR (arg));
27016 return BAR_CURSOR;
27019 if (EQ (arg, Qhbar))
27021 *width = 2;
27022 return HBAR_CURSOR;
27025 if (CONSP (arg)
27026 && EQ (XCAR (arg), Qhbar)
27027 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
27029 *width = XINT (XCDR (arg));
27030 return HBAR_CURSOR;
27033 /* Treat anything unknown as "hollow box cursor".
27034 It was bad to signal an error; people have trouble fixing
27035 .Xdefaults with Emacs, when it has something bad in it. */
27036 type = HOLLOW_BOX_CURSOR;
27038 return type;
27041 /* Set the default cursor types for specified frame. */
27042 void
27043 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
27045 int width = 1;
27046 Lisp_Object tem;
27048 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
27049 FRAME_CURSOR_WIDTH (f) = width;
27051 /* By default, set up the blink-off state depending on the on-state. */
27053 tem = Fassoc (arg, Vblink_cursor_alist);
27054 if (!NILP (tem))
27056 FRAME_BLINK_OFF_CURSOR (f)
27057 = get_specified_cursor_type (XCDR (tem), &width);
27058 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
27060 else
27061 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
27063 /* Make sure the cursor gets redrawn. */
27064 f->cursor_type_changed = 1;
27068 #ifdef HAVE_WINDOW_SYSTEM
27070 /* Return the cursor we want to be displayed in window W. Return
27071 width of bar/hbar cursor through WIDTH arg. Return with
27072 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27073 (i.e. if the `system caret' should track this cursor).
27075 In a mini-buffer window, we want the cursor only to appear if we
27076 are reading input from this window. For the selected window, we
27077 want the cursor type given by the frame parameter or buffer local
27078 setting of cursor-type. If explicitly marked off, draw no cursor.
27079 In all other cases, we want a hollow box cursor. */
27081 static enum text_cursor_kinds
27082 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
27083 int *active_cursor)
27085 struct frame *f = XFRAME (w->frame);
27086 struct buffer *b = XBUFFER (w->contents);
27087 int cursor_type = DEFAULT_CURSOR;
27088 Lisp_Object alt_cursor;
27089 int non_selected = 0;
27091 *active_cursor = 1;
27093 /* Echo area */
27094 if (cursor_in_echo_area
27095 && FRAME_HAS_MINIBUF_P (f)
27096 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
27098 if (w == XWINDOW (echo_area_window))
27100 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
27102 *width = FRAME_CURSOR_WIDTH (f);
27103 return FRAME_DESIRED_CURSOR (f);
27105 else
27106 return get_specified_cursor_type (BVAR (b, cursor_type), width);
27109 *active_cursor = 0;
27110 non_selected = 1;
27113 /* Detect a nonselected window or nonselected frame. */
27114 else if (w != XWINDOW (f->selected_window)
27115 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
27117 *active_cursor = 0;
27119 if (MINI_WINDOW_P (w) && minibuf_level == 0)
27120 return NO_CURSOR;
27122 non_selected = 1;
27125 /* Never display a cursor in a window in which cursor-type is nil. */
27126 if (NILP (BVAR (b, cursor_type)))
27127 return NO_CURSOR;
27129 /* Get the normal cursor type for this window. */
27130 if (EQ (BVAR (b, cursor_type), Qt))
27132 cursor_type = FRAME_DESIRED_CURSOR (f);
27133 *width = FRAME_CURSOR_WIDTH (f);
27135 else
27136 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
27138 /* Use cursor-in-non-selected-windows instead
27139 for non-selected window or frame. */
27140 if (non_selected)
27142 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
27143 if (!EQ (Qt, alt_cursor))
27144 return get_specified_cursor_type (alt_cursor, width);
27145 /* t means modify the normal cursor type. */
27146 if (cursor_type == FILLED_BOX_CURSOR)
27147 cursor_type = HOLLOW_BOX_CURSOR;
27148 else if (cursor_type == BAR_CURSOR && *width > 1)
27149 --*width;
27150 return cursor_type;
27153 /* Use normal cursor if not blinked off. */
27154 if (!w->cursor_off_p)
27156 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
27158 if (cursor_type == FILLED_BOX_CURSOR)
27160 /* Using a block cursor on large images can be very annoying.
27161 So use a hollow cursor for "large" images.
27162 If image is not transparent (no mask), also use hollow cursor. */
27163 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
27164 if (img != NULL && IMAGEP (img->spec))
27166 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27167 where N = size of default frame font size.
27168 This should cover most of the "tiny" icons people may use. */
27169 if (!img->mask
27170 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
27171 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
27172 cursor_type = HOLLOW_BOX_CURSOR;
27175 else if (cursor_type != NO_CURSOR)
27177 /* Display current only supports BOX and HOLLOW cursors for images.
27178 So for now, unconditionally use a HOLLOW cursor when cursor is
27179 not a solid box cursor. */
27180 cursor_type = HOLLOW_BOX_CURSOR;
27183 return cursor_type;
27186 /* Cursor is blinked off, so determine how to "toggle" it. */
27188 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27189 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
27190 return get_specified_cursor_type (XCDR (alt_cursor), width);
27192 /* Then see if frame has specified a specific blink off cursor type. */
27193 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
27195 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
27196 return FRAME_BLINK_OFF_CURSOR (f);
27199 #if 0
27200 /* Some people liked having a permanently visible blinking cursor,
27201 while others had very strong opinions against it. So it was
27202 decided to remove it. KFS 2003-09-03 */
27204 /* Finally perform built-in cursor blinking:
27205 filled box <-> hollow box
27206 wide [h]bar <-> narrow [h]bar
27207 narrow [h]bar <-> no cursor
27208 other type <-> no cursor */
27210 if (cursor_type == FILLED_BOX_CURSOR)
27211 return HOLLOW_BOX_CURSOR;
27213 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
27215 *width = 1;
27216 return cursor_type;
27218 #endif
27220 return NO_CURSOR;
27224 /* Notice when the text cursor of window W has been completely
27225 overwritten by a drawing operation that outputs glyphs in AREA
27226 starting at X0 and ending at X1 in the line starting at Y0 and
27227 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27228 the rest of the line after X0 has been written. Y coordinates
27229 are window-relative. */
27231 static void
27232 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
27233 int x0, int x1, int y0, int y1)
27235 int cx0, cx1, cy0, cy1;
27236 struct glyph_row *row;
27238 if (!w->phys_cursor_on_p)
27239 return;
27240 if (area != TEXT_AREA)
27241 return;
27243 if (w->phys_cursor.vpos < 0
27244 || w->phys_cursor.vpos >= w->current_matrix->nrows
27245 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
27246 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
27247 return;
27249 if (row->cursor_in_fringe_p)
27251 row->cursor_in_fringe_p = 0;
27252 draw_fringe_bitmap (w, row, row->reversed_p);
27253 w->phys_cursor_on_p = 0;
27254 return;
27257 cx0 = w->phys_cursor.x;
27258 cx1 = cx0 + w->phys_cursor_width;
27259 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
27260 return;
27262 /* The cursor image will be completely removed from the
27263 screen if the output area intersects the cursor area in
27264 y-direction. When we draw in [y0 y1[, and some part of
27265 the cursor is at y < y0, that part must have been drawn
27266 before. When scrolling, the cursor is erased before
27267 actually scrolling, so we don't come here. When not
27268 scrolling, the rows above the old cursor row must have
27269 changed, and in this case these rows must have written
27270 over the cursor image.
27272 Likewise if part of the cursor is below y1, with the
27273 exception of the cursor being in the first blank row at
27274 the buffer and window end because update_text_area
27275 doesn't draw that row. (Except when it does, but
27276 that's handled in update_text_area.) */
27278 cy0 = w->phys_cursor.y;
27279 cy1 = cy0 + w->phys_cursor_height;
27280 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
27281 return;
27283 w->phys_cursor_on_p = 0;
27286 #endif /* HAVE_WINDOW_SYSTEM */
27289 /************************************************************************
27290 Mouse Face
27291 ************************************************************************/
27293 #ifdef HAVE_WINDOW_SYSTEM
27295 /* EXPORT for RIF:
27296 Fix the display of area AREA of overlapping row ROW in window W
27297 with respect to the overlapping part OVERLAPS. */
27299 void
27300 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
27301 enum glyph_row_area area, int overlaps)
27303 int i, x;
27305 block_input ();
27307 x = 0;
27308 for (i = 0; i < row->used[area];)
27310 if (row->glyphs[area][i].overlaps_vertically_p)
27312 int start = i, start_x = x;
27316 x += row->glyphs[area][i].pixel_width;
27317 ++i;
27319 while (i < row->used[area]
27320 && row->glyphs[area][i].overlaps_vertically_p);
27322 draw_glyphs (w, start_x, row, area,
27323 start, i,
27324 DRAW_NORMAL_TEXT, overlaps);
27326 else
27328 x += row->glyphs[area][i].pixel_width;
27329 ++i;
27333 unblock_input ();
27337 /* EXPORT:
27338 Draw the cursor glyph of window W in glyph row ROW. See the
27339 comment of draw_glyphs for the meaning of HL. */
27341 void
27342 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
27343 enum draw_glyphs_face hl)
27345 /* If cursor hpos is out of bounds, don't draw garbage. This can
27346 happen in mini-buffer windows when switching between echo area
27347 glyphs and mini-buffer. */
27348 if ((row->reversed_p
27349 ? (w->phys_cursor.hpos >= 0)
27350 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
27352 int on_p = w->phys_cursor_on_p;
27353 int x1;
27354 int hpos = w->phys_cursor.hpos;
27356 /* When the window is hscrolled, cursor hpos can legitimately be
27357 out of bounds, but we draw the cursor at the corresponding
27358 window margin in that case. */
27359 if (!row->reversed_p && hpos < 0)
27360 hpos = 0;
27361 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27362 hpos = row->used[TEXT_AREA] - 1;
27364 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
27365 hl, 0);
27366 w->phys_cursor_on_p = on_p;
27368 if (hl == DRAW_CURSOR)
27369 w->phys_cursor_width = x1 - w->phys_cursor.x;
27370 /* When we erase the cursor, and ROW is overlapped by other
27371 rows, make sure that these overlapping parts of other rows
27372 are redrawn. */
27373 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
27375 w->phys_cursor_width = x1 - w->phys_cursor.x;
27377 if (row > w->current_matrix->rows
27378 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
27379 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
27380 OVERLAPS_ERASED_CURSOR);
27382 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
27383 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
27384 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
27385 OVERLAPS_ERASED_CURSOR);
27391 /* Erase the image of a cursor of window W from the screen. */
27393 #ifndef HAVE_NTGUI
27394 static
27395 #endif
27396 void
27397 erase_phys_cursor (struct window *w)
27399 struct frame *f = XFRAME (w->frame);
27400 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27401 int hpos = w->phys_cursor.hpos;
27402 int vpos = w->phys_cursor.vpos;
27403 int mouse_face_here_p = 0;
27404 struct glyph_matrix *active_glyphs = w->current_matrix;
27405 struct glyph_row *cursor_row;
27406 struct glyph *cursor_glyph;
27407 enum draw_glyphs_face hl;
27409 /* No cursor displayed or row invalidated => nothing to do on the
27410 screen. */
27411 if (w->phys_cursor_type == NO_CURSOR)
27412 goto mark_cursor_off;
27414 /* VPOS >= active_glyphs->nrows means that window has been resized.
27415 Don't bother to erase the cursor. */
27416 if (vpos >= active_glyphs->nrows)
27417 goto mark_cursor_off;
27419 /* If row containing cursor is marked invalid, there is nothing we
27420 can do. */
27421 cursor_row = MATRIX_ROW (active_glyphs, vpos);
27422 if (!cursor_row->enabled_p)
27423 goto mark_cursor_off;
27425 /* If line spacing is > 0, old cursor may only be partially visible in
27426 window after split-window. So adjust visible height. */
27427 cursor_row->visible_height = min (cursor_row->visible_height,
27428 window_text_bottom_y (w) - cursor_row->y);
27430 /* If row is completely invisible, don't attempt to delete a cursor which
27431 isn't there. This can happen if cursor is at top of a window, and
27432 we switch to a buffer with a header line in that window. */
27433 if (cursor_row->visible_height <= 0)
27434 goto mark_cursor_off;
27436 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27437 if (cursor_row->cursor_in_fringe_p)
27439 cursor_row->cursor_in_fringe_p = 0;
27440 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
27441 goto mark_cursor_off;
27444 /* This can happen when the new row is shorter than the old one.
27445 In this case, either draw_glyphs or clear_end_of_line
27446 should have cleared the cursor. Note that we wouldn't be
27447 able to erase the cursor in this case because we don't have a
27448 cursor glyph at hand. */
27449 if ((cursor_row->reversed_p
27450 ? (w->phys_cursor.hpos < 0)
27451 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
27452 goto mark_cursor_off;
27454 /* When the window is hscrolled, cursor hpos can legitimately be out
27455 of bounds, but we draw the cursor at the corresponding window
27456 margin in that case. */
27457 if (!cursor_row->reversed_p && hpos < 0)
27458 hpos = 0;
27459 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
27460 hpos = cursor_row->used[TEXT_AREA] - 1;
27462 /* If the cursor is in the mouse face area, redisplay that when
27463 we clear the cursor. */
27464 if (! NILP (hlinfo->mouse_face_window)
27465 && coords_in_mouse_face_p (w, hpos, vpos)
27466 /* Don't redraw the cursor's spot in mouse face if it is at the
27467 end of a line (on a newline). The cursor appears there, but
27468 mouse highlighting does not. */
27469 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
27470 mouse_face_here_p = 1;
27472 /* Maybe clear the display under the cursor. */
27473 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
27475 int x, y;
27476 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
27477 int width;
27479 cursor_glyph = get_phys_cursor_glyph (w);
27480 if (cursor_glyph == NULL)
27481 goto mark_cursor_off;
27483 width = cursor_glyph->pixel_width;
27484 x = w->phys_cursor.x;
27485 if (x < 0)
27487 width += x;
27488 x = 0;
27490 width = min (width, window_box_width (w, TEXT_AREA) - x);
27491 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
27492 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, x);
27494 if (width > 0)
27495 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
27498 /* Erase the cursor by redrawing the character underneath it. */
27499 if (mouse_face_here_p)
27500 hl = DRAW_MOUSE_FACE;
27501 else
27502 hl = DRAW_NORMAL_TEXT;
27503 draw_phys_cursor_glyph (w, cursor_row, hl);
27505 mark_cursor_off:
27506 w->phys_cursor_on_p = 0;
27507 w->phys_cursor_type = NO_CURSOR;
27511 /* EXPORT:
27512 Display or clear cursor of window W. If ON is zero, clear the
27513 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27514 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27516 void
27517 display_and_set_cursor (struct window *w, bool on,
27518 int hpos, int vpos, int x, int y)
27520 struct frame *f = XFRAME (w->frame);
27521 int new_cursor_type;
27522 int new_cursor_width;
27523 int active_cursor;
27524 struct glyph_row *glyph_row;
27525 struct glyph *glyph;
27527 /* This is pointless on invisible frames, and dangerous on garbaged
27528 windows and frames; in the latter case, the frame or window may
27529 be in the midst of changing its size, and x and y may be off the
27530 window. */
27531 if (! FRAME_VISIBLE_P (f)
27532 || FRAME_GARBAGED_P (f)
27533 || vpos >= w->current_matrix->nrows
27534 || hpos >= w->current_matrix->matrix_w)
27535 return;
27537 /* If cursor is off and we want it off, return quickly. */
27538 if (!on && !w->phys_cursor_on_p)
27539 return;
27541 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
27542 /* If cursor row is not enabled, we don't really know where to
27543 display the cursor. */
27544 if (!glyph_row->enabled_p)
27546 w->phys_cursor_on_p = 0;
27547 return;
27550 glyph = NULL;
27551 if (!glyph_row->exact_window_width_line_p
27552 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
27553 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
27555 eassert (input_blocked_p ());
27557 /* Set new_cursor_type to the cursor we want to be displayed. */
27558 new_cursor_type = get_window_cursor_type (w, glyph,
27559 &new_cursor_width, &active_cursor);
27561 /* If cursor is currently being shown and we don't want it to be or
27562 it is in the wrong place, or the cursor type is not what we want,
27563 erase it. */
27564 if (w->phys_cursor_on_p
27565 && (!on
27566 || w->phys_cursor.x != x
27567 || w->phys_cursor.y != y
27568 /* HPOS can be negative in R2L rows whose
27569 exact_window_width_line_p flag is set (i.e. their newline
27570 would "overflow into the fringe"). */
27571 || hpos < 0
27572 || new_cursor_type != w->phys_cursor_type
27573 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
27574 && new_cursor_width != w->phys_cursor_width)))
27575 erase_phys_cursor (w);
27577 /* Don't check phys_cursor_on_p here because that flag is only set
27578 to zero in some cases where we know that the cursor has been
27579 completely erased, to avoid the extra work of erasing the cursor
27580 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27581 still not be visible, or it has only been partly erased. */
27582 if (on)
27584 w->phys_cursor_ascent = glyph_row->ascent;
27585 w->phys_cursor_height = glyph_row->height;
27587 /* Set phys_cursor_.* before x_draw_.* is called because some
27588 of them may need the information. */
27589 w->phys_cursor.x = x;
27590 w->phys_cursor.y = glyph_row->y;
27591 w->phys_cursor.hpos = hpos;
27592 w->phys_cursor.vpos = vpos;
27595 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
27596 new_cursor_type, new_cursor_width,
27597 on, active_cursor);
27601 /* Switch the display of W's cursor on or off, according to the value
27602 of ON. */
27604 static void
27605 update_window_cursor (struct window *w, bool on)
27607 /* Don't update cursor in windows whose frame is in the process
27608 of being deleted. */
27609 if (w->current_matrix)
27611 int hpos = w->phys_cursor.hpos;
27612 int vpos = w->phys_cursor.vpos;
27613 struct glyph_row *row;
27615 if (vpos >= w->current_matrix->nrows
27616 || hpos >= w->current_matrix->matrix_w)
27617 return;
27619 row = MATRIX_ROW (w->current_matrix, vpos);
27621 /* When the window is hscrolled, cursor hpos can legitimately be
27622 out of bounds, but we draw the cursor at the corresponding
27623 window margin in that case. */
27624 if (!row->reversed_p && hpos < 0)
27625 hpos = 0;
27626 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27627 hpos = row->used[TEXT_AREA] - 1;
27629 block_input ();
27630 display_and_set_cursor (w, on, hpos, vpos,
27631 w->phys_cursor.x, w->phys_cursor.y);
27632 unblock_input ();
27637 /* Call update_window_cursor with parameter ON_P on all leaf windows
27638 in the window tree rooted at W. */
27640 static void
27641 update_cursor_in_window_tree (struct window *w, bool on_p)
27643 while (w)
27645 if (WINDOWP (w->contents))
27646 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
27647 else
27648 update_window_cursor (w, on_p);
27650 w = NILP (w->next) ? 0 : XWINDOW (w->next);
27655 /* EXPORT:
27656 Display the cursor on window W, or clear it, according to ON_P.
27657 Don't change the cursor's position. */
27659 void
27660 x_update_cursor (struct frame *f, bool on_p)
27662 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
27666 /* EXPORT:
27667 Clear the cursor of window W to background color, and mark the
27668 cursor as not shown. This is used when the text where the cursor
27669 is about to be rewritten. */
27671 void
27672 x_clear_cursor (struct window *w)
27674 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
27675 update_window_cursor (w, 0);
27678 #endif /* HAVE_WINDOW_SYSTEM */
27680 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27681 and MSDOS. */
27682 static void
27683 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
27684 int start_hpos, int end_hpos,
27685 enum draw_glyphs_face draw)
27687 #ifdef HAVE_WINDOW_SYSTEM
27688 if (FRAME_WINDOW_P (XFRAME (w->frame)))
27690 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
27691 return;
27693 #endif
27694 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27695 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
27696 #endif
27699 /* Display the active region described by mouse_face_* according to DRAW. */
27701 static void
27702 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
27704 struct window *w = XWINDOW (hlinfo->mouse_face_window);
27705 struct frame *f = XFRAME (WINDOW_FRAME (w));
27707 if (/* If window is in the process of being destroyed, don't bother
27708 to do anything. */
27709 w->current_matrix != NULL
27710 /* Don't update mouse highlight if hidden. */
27711 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
27712 /* Recognize when we are called to operate on rows that don't exist
27713 anymore. This can happen when a window is split. */
27714 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
27716 int phys_cursor_on_p = w->phys_cursor_on_p;
27717 struct glyph_row *row, *first, *last;
27719 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
27720 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
27722 for (row = first; row <= last && row->enabled_p; ++row)
27724 int start_hpos, end_hpos, start_x;
27726 /* For all but the first row, the highlight starts at column 0. */
27727 if (row == first)
27729 /* R2L rows have BEG and END in reversed order, but the
27730 screen drawing geometry is always left to right. So
27731 we need to mirror the beginning and end of the
27732 highlighted area in R2L rows. */
27733 if (!row->reversed_p)
27735 start_hpos = hlinfo->mouse_face_beg_col;
27736 start_x = hlinfo->mouse_face_beg_x;
27738 else if (row == last)
27740 start_hpos = hlinfo->mouse_face_end_col;
27741 start_x = hlinfo->mouse_face_end_x;
27743 else
27745 start_hpos = 0;
27746 start_x = 0;
27749 else if (row->reversed_p && row == last)
27751 start_hpos = hlinfo->mouse_face_end_col;
27752 start_x = hlinfo->mouse_face_end_x;
27754 else
27756 start_hpos = 0;
27757 start_x = 0;
27760 if (row == last)
27762 if (!row->reversed_p)
27763 end_hpos = hlinfo->mouse_face_end_col;
27764 else if (row == first)
27765 end_hpos = hlinfo->mouse_face_beg_col;
27766 else
27768 end_hpos = row->used[TEXT_AREA];
27769 if (draw == DRAW_NORMAL_TEXT)
27770 row->fill_line_p = 1; /* Clear to end of line */
27773 else if (row->reversed_p && row == first)
27774 end_hpos = hlinfo->mouse_face_beg_col;
27775 else
27777 end_hpos = row->used[TEXT_AREA];
27778 if (draw == DRAW_NORMAL_TEXT)
27779 row->fill_line_p = 1; /* Clear to end of line */
27782 if (end_hpos > start_hpos)
27784 draw_row_with_mouse_face (w, start_x, row,
27785 start_hpos, end_hpos, draw);
27787 row->mouse_face_p
27788 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
27792 #ifdef HAVE_WINDOW_SYSTEM
27793 /* When we've written over the cursor, arrange for it to
27794 be displayed again. */
27795 if (FRAME_WINDOW_P (f)
27796 && phys_cursor_on_p && !w->phys_cursor_on_p)
27798 int hpos = w->phys_cursor.hpos;
27800 /* When the window is hscrolled, cursor hpos can legitimately be
27801 out of bounds, but we draw the cursor at the corresponding
27802 window margin in that case. */
27803 if (!row->reversed_p && hpos < 0)
27804 hpos = 0;
27805 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27806 hpos = row->used[TEXT_AREA] - 1;
27808 block_input ();
27809 display_and_set_cursor (w, 1, hpos, w->phys_cursor.vpos,
27810 w->phys_cursor.x, w->phys_cursor.y);
27811 unblock_input ();
27813 #endif /* HAVE_WINDOW_SYSTEM */
27816 #ifdef HAVE_WINDOW_SYSTEM
27817 /* Change the mouse cursor. */
27818 if (FRAME_WINDOW_P (f))
27820 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27821 if (draw == DRAW_NORMAL_TEXT
27822 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
27823 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
27824 else
27825 #endif
27826 if (draw == DRAW_MOUSE_FACE)
27827 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
27828 else
27829 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
27831 #endif /* HAVE_WINDOW_SYSTEM */
27834 /* EXPORT:
27835 Clear out the mouse-highlighted active region.
27836 Redraw it un-highlighted first. Value is non-zero if mouse
27837 face was actually drawn unhighlighted. */
27840 clear_mouse_face (Mouse_HLInfo *hlinfo)
27842 int cleared = 0;
27844 if (!hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window))
27846 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
27847 cleared = 1;
27850 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
27851 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
27852 hlinfo->mouse_face_window = Qnil;
27853 hlinfo->mouse_face_overlay = Qnil;
27854 return cleared;
27857 /* Return true if the coordinates HPOS and VPOS on windows W are
27858 within the mouse face on that window. */
27859 static bool
27860 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
27862 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
27864 /* Quickly resolve the easy cases. */
27865 if (!(WINDOWP (hlinfo->mouse_face_window)
27866 && XWINDOW (hlinfo->mouse_face_window) == w))
27867 return false;
27868 if (vpos < hlinfo->mouse_face_beg_row
27869 || vpos > hlinfo->mouse_face_end_row)
27870 return false;
27871 if (vpos > hlinfo->mouse_face_beg_row
27872 && vpos < hlinfo->mouse_face_end_row)
27873 return true;
27875 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
27877 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
27879 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
27880 return true;
27882 else if ((vpos == hlinfo->mouse_face_beg_row
27883 && hpos >= hlinfo->mouse_face_beg_col)
27884 || (vpos == hlinfo->mouse_face_end_row
27885 && hpos < hlinfo->mouse_face_end_col))
27886 return true;
27888 else
27890 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
27892 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
27893 return true;
27895 else if ((vpos == hlinfo->mouse_face_beg_row
27896 && hpos <= hlinfo->mouse_face_beg_col)
27897 || (vpos == hlinfo->mouse_face_end_row
27898 && hpos > hlinfo->mouse_face_end_col))
27899 return true;
27901 return false;
27905 /* EXPORT:
27906 True if physical cursor of window W is within mouse face. */
27908 bool
27909 cursor_in_mouse_face_p (struct window *w)
27911 int hpos = w->phys_cursor.hpos;
27912 int vpos = w->phys_cursor.vpos;
27913 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
27915 /* When the window is hscrolled, cursor hpos can legitimately be out
27916 of bounds, but we draw the cursor at the corresponding window
27917 margin in that case. */
27918 if (!row->reversed_p && hpos < 0)
27919 hpos = 0;
27920 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27921 hpos = row->used[TEXT_AREA] - 1;
27923 return coords_in_mouse_face_p (w, hpos, vpos);
27928 /* Find the glyph rows START_ROW and END_ROW of window W that display
27929 characters between buffer positions START_CHARPOS and END_CHARPOS
27930 (excluding END_CHARPOS). DISP_STRING is a display string that
27931 covers these buffer positions. This is similar to
27932 row_containing_pos, but is more accurate when bidi reordering makes
27933 buffer positions change non-linearly with glyph rows. */
27934 static void
27935 rows_from_pos_range (struct window *w,
27936 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
27937 Lisp_Object disp_string,
27938 struct glyph_row **start, struct glyph_row **end)
27940 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
27941 int last_y = window_text_bottom_y (w);
27942 struct glyph_row *row;
27944 *start = NULL;
27945 *end = NULL;
27947 while (!first->enabled_p
27948 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
27949 first++;
27951 /* Find the START row. */
27952 for (row = first;
27953 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
27954 row++)
27956 /* A row can potentially be the START row if the range of the
27957 characters it displays intersects the range
27958 [START_CHARPOS..END_CHARPOS). */
27959 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
27960 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
27961 /* See the commentary in row_containing_pos, for the
27962 explanation of the complicated way to check whether
27963 some position is beyond the end of the characters
27964 displayed by a row. */
27965 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
27966 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
27967 && !row->ends_at_zv_p
27968 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
27969 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
27970 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
27971 && !row->ends_at_zv_p
27972 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
27974 /* Found a candidate row. Now make sure at least one of the
27975 glyphs it displays has a charpos from the range
27976 [START_CHARPOS..END_CHARPOS).
27978 This is not obvious because bidi reordering could make
27979 buffer positions of a row be 1,2,3,102,101,100, and if we
27980 want to highlight characters in [50..60), we don't want
27981 this row, even though [50..60) does intersect [1..103),
27982 the range of character positions given by the row's start
27983 and end positions. */
27984 struct glyph *g = row->glyphs[TEXT_AREA];
27985 struct glyph *e = g + row->used[TEXT_AREA];
27987 while (g < e)
27989 if (((BUFFERP (g->object) || INTEGERP (g->object))
27990 && start_charpos <= g->charpos && g->charpos < end_charpos)
27991 /* A glyph that comes from DISP_STRING is by
27992 definition to be highlighted. */
27993 || EQ (g->object, disp_string))
27994 *start = row;
27995 g++;
27997 if (*start)
27998 break;
28002 /* Find the END row. */
28003 if (!*start
28004 /* If the last row is partially visible, start looking for END
28005 from that row, instead of starting from FIRST. */
28006 && !(row->enabled_p
28007 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
28008 row = first;
28009 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
28011 struct glyph_row *next = row + 1;
28012 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
28014 if (!next->enabled_p
28015 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
28016 /* The first row >= START whose range of displayed characters
28017 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28018 is the row END + 1. */
28019 || (start_charpos < next_start
28020 && end_charpos < next_start)
28021 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
28022 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
28023 && !next->ends_at_zv_p
28024 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
28025 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
28026 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
28027 && !next->ends_at_zv_p
28028 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
28030 *end = row;
28031 break;
28033 else
28035 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28036 but none of the characters it displays are in the range, it is
28037 also END + 1. */
28038 struct glyph *g = next->glyphs[TEXT_AREA];
28039 struct glyph *s = g;
28040 struct glyph *e = g + next->used[TEXT_AREA];
28042 while (g < e)
28044 if (((BUFFERP (g->object) || INTEGERP (g->object))
28045 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
28046 /* If the buffer position of the first glyph in
28047 the row is equal to END_CHARPOS, it means
28048 the last character to be highlighted is the
28049 newline of ROW, and we must consider NEXT as
28050 END, not END+1. */
28051 || (((!next->reversed_p && g == s)
28052 || (next->reversed_p && g == e - 1))
28053 && (g->charpos == end_charpos
28054 /* Special case for when NEXT is an
28055 empty line at ZV. */
28056 || (g->charpos == -1
28057 && !row->ends_at_zv_p
28058 && next_start == end_charpos)))))
28059 /* A glyph that comes from DISP_STRING is by
28060 definition to be highlighted. */
28061 || EQ (g->object, disp_string))
28062 break;
28063 g++;
28065 if (g == e)
28067 *end = row;
28068 break;
28070 /* The first row that ends at ZV must be the last to be
28071 highlighted. */
28072 else if (next->ends_at_zv_p)
28074 *end = next;
28075 break;
28081 /* This function sets the mouse_face_* elements of HLINFO, assuming
28082 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28083 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28084 for the overlay or run of text properties specifying the mouse
28085 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28086 before-string and after-string that must also be highlighted.
28087 DISP_STRING, if non-nil, is a display string that may cover some
28088 or all of the highlighted text. */
28090 static void
28091 mouse_face_from_buffer_pos (Lisp_Object window,
28092 Mouse_HLInfo *hlinfo,
28093 ptrdiff_t mouse_charpos,
28094 ptrdiff_t start_charpos,
28095 ptrdiff_t end_charpos,
28096 Lisp_Object before_string,
28097 Lisp_Object after_string,
28098 Lisp_Object disp_string)
28100 struct window *w = XWINDOW (window);
28101 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28102 struct glyph_row *r1, *r2;
28103 struct glyph *glyph, *end;
28104 ptrdiff_t ignore, pos;
28105 int x;
28107 eassert (NILP (disp_string) || STRINGP (disp_string));
28108 eassert (NILP (before_string) || STRINGP (before_string));
28109 eassert (NILP (after_string) || STRINGP (after_string));
28111 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28112 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
28113 if (r1 == NULL)
28114 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28115 /* If the before-string or display-string contains newlines,
28116 rows_from_pos_range skips to its last row. Move back. */
28117 if (!NILP (before_string) || !NILP (disp_string))
28119 struct glyph_row *prev;
28120 while ((prev = r1 - 1, prev >= first)
28121 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
28122 && prev->used[TEXT_AREA] > 0)
28124 struct glyph *beg = prev->glyphs[TEXT_AREA];
28125 glyph = beg + prev->used[TEXT_AREA];
28126 while (--glyph >= beg && INTEGERP (glyph->object));
28127 if (glyph < beg
28128 || !(EQ (glyph->object, before_string)
28129 || EQ (glyph->object, disp_string)))
28130 break;
28131 r1 = prev;
28134 if (r2 == NULL)
28136 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28137 hlinfo->mouse_face_past_end = 1;
28139 else if (!NILP (after_string))
28141 /* If the after-string has newlines, advance to its last row. */
28142 struct glyph_row *next;
28143 struct glyph_row *last
28144 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28146 for (next = r2 + 1;
28147 next <= last
28148 && next->used[TEXT_AREA] > 0
28149 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
28150 ++next)
28151 r2 = next;
28153 /* The rest of the display engine assumes that mouse_face_beg_row is
28154 either above mouse_face_end_row or identical to it. But with
28155 bidi-reordered continued lines, the row for START_CHARPOS could
28156 be below the row for END_CHARPOS. If so, swap the rows and store
28157 them in correct order. */
28158 if (r1->y > r2->y)
28160 struct glyph_row *tem = r2;
28162 r2 = r1;
28163 r1 = tem;
28166 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
28167 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
28169 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28170 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28171 could be anywhere in the row and in any order. The strategy
28172 below is to find the leftmost and the rightmost glyph that
28173 belongs to either of these 3 strings, or whose position is
28174 between START_CHARPOS and END_CHARPOS, and highlight all the
28175 glyphs between those two. This may cover more than just the text
28176 between START_CHARPOS and END_CHARPOS if the range of characters
28177 strides the bidi level boundary, e.g. if the beginning is in R2L
28178 text while the end is in L2R text or vice versa. */
28179 if (!r1->reversed_p)
28181 /* This row is in a left to right paragraph. Scan it left to
28182 right. */
28183 glyph = r1->glyphs[TEXT_AREA];
28184 end = glyph + r1->used[TEXT_AREA];
28185 x = r1->x;
28187 /* Skip truncation glyphs at the start of the glyph row. */
28188 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28189 for (; glyph < end
28190 && INTEGERP (glyph->object)
28191 && glyph->charpos < 0;
28192 ++glyph)
28193 x += glyph->pixel_width;
28195 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28196 or DISP_STRING, and the first glyph from buffer whose
28197 position is between START_CHARPOS and END_CHARPOS. */
28198 for (; glyph < end
28199 && !INTEGERP (glyph->object)
28200 && !EQ (glyph->object, disp_string)
28201 && !(BUFFERP (glyph->object)
28202 && (glyph->charpos >= start_charpos
28203 && glyph->charpos < end_charpos));
28204 ++glyph)
28206 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28207 are present at buffer positions between START_CHARPOS and
28208 END_CHARPOS, or if they come from an overlay. */
28209 if (EQ (glyph->object, before_string))
28211 pos = string_buffer_position (before_string,
28212 start_charpos);
28213 /* If pos == 0, it means before_string came from an
28214 overlay, not from a buffer position. */
28215 if (!pos || (pos >= start_charpos && pos < end_charpos))
28216 break;
28218 else if (EQ (glyph->object, after_string))
28220 pos = string_buffer_position (after_string, end_charpos);
28221 if (!pos || (pos >= start_charpos && pos < end_charpos))
28222 break;
28224 x += glyph->pixel_width;
28226 hlinfo->mouse_face_beg_x = x;
28227 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28229 else
28231 /* This row is in a right to left paragraph. Scan it right to
28232 left. */
28233 struct glyph *g;
28235 end = r1->glyphs[TEXT_AREA] - 1;
28236 glyph = end + r1->used[TEXT_AREA];
28238 /* Skip truncation glyphs at the start of the glyph row. */
28239 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28240 for (; glyph > end
28241 && INTEGERP (glyph->object)
28242 && glyph->charpos < 0;
28243 --glyph)
28246 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28247 or DISP_STRING, and the first glyph from buffer whose
28248 position is between START_CHARPOS and END_CHARPOS. */
28249 for (; glyph > end
28250 && !INTEGERP (glyph->object)
28251 && !EQ (glyph->object, disp_string)
28252 && !(BUFFERP (glyph->object)
28253 && (glyph->charpos >= start_charpos
28254 && glyph->charpos < end_charpos));
28255 --glyph)
28257 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28258 are present at buffer positions between START_CHARPOS and
28259 END_CHARPOS, or if they come from an overlay. */
28260 if (EQ (glyph->object, before_string))
28262 pos = string_buffer_position (before_string, start_charpos);
28263 /* If pos == 0, it means before_string came from an
28264 overlay, not from a buffer position. */
28265 if (!pos || (pos >= start_charpos && pos < end_charpos))
28266 break;
28268 else if (EQ (glyph->object, after_string))
28270 pos = string_buffer_position (after_string, end_charpos);
28271 if (!pos || (pos >= start_charpos && pos < end_charpos))
28272 break;
28276 glyph++; /* first glyph to the right of the highlighted area */
28277 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
28278 x += g->pixel_width;
28279 hlinfo->mouse_face_beg_x = x;
28280 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28283 /* If the highlight ends in a different row, compute GLYPH and END
28284 for the end row. Otherwise, reuse the values computed above for
28285 the row where the highlight begins. */
28286 if (r2 != r1)
28288 if (!r2->reversed_p)
28290 glyph = r2->glyphs[TEXT_AREA];
28291 end = glyph + r2->used[TEXT_AREA];
28292 x = r2->x;
28294 else
28296 end = r2->glyphs[TEXT_AREA] - 1;
28297 glyph = end + r2->used[TEXT_AREA];
28301 if (!r2->reversed_p)
28303 /* Skip truncation and continuation glyphs near the end of the
28304 row, and also blanks and stretch glyphs inserted by
28305 extend_face_to_end_of_line. */
28306 while (end > glyph
28307 && INTEGERP ((end - 1)->object))
28308 --end;
28309 /* Scan the rest of the glyph row from the end, looking for the
28310 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28311 DISP_STRING, or whose position is between START_CHARPOS
28312 and END_CHARPOS */
28313 for (--end;
28314 end > glyph
28315 && !INTEGERP (end->object)
28316 && !EQ (end->object, disp_string)
28317 && !(BUFFERP (end->object)
28318 && (end->charpos >= start_charpos
28319 && end->charpos < end_charpos));
28320 --end)
28322 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28323 are present at buffer positions between START_CHARPOS and
28324 END_CHARPOS, or if they come from an overlay. */
28325 if (EQ (end->object, before_string))
28327 pos = string_buffer_position (before_string, start_charpos);
28328 if (!pos || (pos >= start_charpos && pos < end_charpos))
28329 break;
28331 else if (EQ (end->object, after_string))
28333 pos = string_buffer_position (after_string, end_charpos);
28334 if (!pos || (pos >= start_charpos && pos < end_charpos))
28335 break;
28338 /* Find the X coordinate of the last glyph to be highlighted. */
28339 for (; glyph <= end; ++glyph)
28340 x += glyph->pixel_width;
28342 hlinfo->mouse_face_end_x = x;
28343 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
28345 else
28347 /* Skip truncation and continuation glyphs near the end of the
28348 row, and also blanks and stretch glyphs inserted by
28349 extend_face_to_end_of_line. */
28350 x = r2->x;
28351 end++;
28352 while (end < glyph
28353 && INTEGERP (end->object))
28355 x += end->pixel_width;
28356 ++end;
28358 /* Scan the rest of the glyph row from the end, looking for the
28359 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28360 DISP_STRING, or whose position is between START_CHARPOS
28361 and END_CHARPOS */
28362 for ( ;
28363 end < glyph
28364 && !INTEGERP (end->object)
28365 && !EQ (end->object, disp_string)
28366 && !(BUFFERP (end->object)
28367 && (end->charpos >= start_charpos
28368 && end->charpos < end_charpos));
28369 ++end)
28371 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28372 are present at buffer positions between START_CHARPOS and
28373 END_CHARPOS, or if they come from an overlay. */
28374 if (EQ (end->object, before_string))
28376 pos = string_buffer_position (before_string, start_charpos);
28377 if (!pos || (pos >= start_charpos && pos < end_charpos))
28378 break;
28380 else if (EQ (end->object, after_string))
28382 pos = string_buffer_position (after_string, end_charpos);
28383 if (!pos || (pos >= start_charpos && pos < end_charpos))
28384 break;
28386 x += end->pixel_width;
28388 /* If we exited the above loop because we arrived at the last
28389 glyph of the row, and its buffer position is still not in
28390 range, it means the last character in range is the preceding
28391 newline. Bump the end column and x values to get past the
28392 last glyph. */
28393 if (end == glyph
28394 && BUFFERP (end->object)
28395 && (end->charpos < start_charpos
28396 || end->charpos >= end_charpos))
28398 x += end->pixel_width;
28399 ++end;
28401 hlinfo->mouse_face_end_x = x;
28402 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
28405 hlinfo->mouse_face_window = window;
28406 hlinfo->mouse_face_face_id
28407 = face_at_buffer_position (w, mouse_charpos, &ignore,
28408 mouse_charpos + 1,
28409 !hlinfo->mouse_face_hidden, -1);
28410 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28413 /* The following function is not used anymore (replaced with
28414 mouse_face_from_string_pos), but I leave it here for the time
28415 being, in case someone would. */
28417 #if 0 /* not used */
28419 /* Find the position of the glyph for position POS in OBJECT in
28420 window W's current matrix, and return in *X, *Y the pixel
28421 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28423 RIGHT_P non-zero means return the position of the right edge of the
28424 glyph, RIGHT_P zero means return the left edge position.
28426 If no glyph for POS exists in the matrix, return the position of
28427 the glyph with the next smaller position that is in the matrix, if
28428 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28429 exists in the matrix, return the position of the glyph with the
28430 next larger position in OBJECT.
28432 Value is non-zero if a glyph was found. */
28434 static int
28435 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
28436 int *hpos, int *vpos, int *x, int *y, int right_p)
28438 int yb = window_text_bottom_y (w);
28439 struct glyph_row *r;
28440 struct glyph *best_glyph = NULL;
28441 struct glyph_row *best_row = NULL;
28442 int best_x = 0;
28444 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28445 r->enabled_p && r->y < yb;
28446 ++r)
28448 struct glyph *g = r->glyphs[TEXT_AREA];
28449 struct glyph *e = g + r->used[TEXT_AREA];
28450 int gx;
28452 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28453 if (EQ (g->object, object))
28455 if (g->charpos == pos)
28457 best_glyph = g;
28458 best_x = gx;
28459 best_row = r;
28460 goto found;
28462 else if (best_glyph == NULL
28463 || ((eabs (g->charpos - pos)
28464 < eabs (best_glyph->charpos - pos))
28465 && (right_p
28466 ? g->charpos < pos
28467 : g->charpos > pos)))
28469 best_glyph = g;
28470 best_x = gx;
28471 best_row = r;
28476 found:
28478 if (best_glyph)
28480 *x = best_x;
28481 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
28483 if (right_p)
28485 *x += best_glyph->pixel_width;
28486 ++*hpos;
28489 *y = best_row->y;
28490 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
28493 return best_glyph != NULL;
28495 #endif /* not used */
28497 /* Find the positions of the first and the last glyphs in window W's
28498 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28499 (assumed to be a string), and return in HLINFO's mouse_face_*
28500 members the pixel and column/row coordinates of those glyphs. */
28502 static void
28503 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
28504 Lisp_Object object,
28505 ptrdiff_t startpos, ptrdiff_t endpos)
28507 int yb = window_text_bottom_y (w);
28508 struct glyph_row *r;
28509 struct glyph *g, *e;
28510 int gx;
28511 int found = 0;
28513 /* Find the glyph row with at least one position in the range
28514 [STARTPOS..ENDPOS), and the first glyph in that row whose
28515 position belongs to that range. */
28516 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28517 r->enabled_p && r->y < yb;
28518 ++r)
28520 if (!r->reversed_p)
28522 g = r->glyphs[TEXT_AREA];
28523 e = g + r->used[TEXT_AREA];
28524 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28525 if (EQ (g->object, object)
28526 && startpos <= g->charpos && g->charpos < endpos)
28528 hlinfo->mouse_face_beg_row
28529 = MATRIX_ROW_VPOS (r, w->current_matrix);
28530 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28531 hlinfo->mouse_face_beg_x = gx;
28532 found = 1;
28533 break;
28536 else
28538 struct glyph *g1;
28540 e = r->glyphs[TEXT_AREA];
28541 g = e + r->used[TEXT_AREA];
28542 for ( ; g > e; --g)
28543 if (EQ ((g-1)->object, object)
28544 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
28546 hlinfo->mouse_face_beg_row
28547 = MATRIX_ROW_VPOS (r, w->current_matrix);
28548 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28549 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
28550 gx += g1->pixel_width;
28551 hlinfo->mouse_face_beg_x = gx;
28552 found = 1;
28553 break;
28556 if (found)
28557 break;
28560 if (!found)
28561 return;
28563 /* Starting with the next row, look for the first row which does NOT
28564 include any glyphs whose positions are in the range. */
28565 for (++r; r->enabled_p && r->y < yb; ++r)
28567 g = r->glyphs[TEXT_AREA];
28568 e = g + r->used[TEXT_AREA];
28569 found = 0;
28570 for ( ; g < e; ++g)
28571 if (EQ (g->object, object)
28572 && startpos <= g->charpos && g->charpos < endpos)
28574 found = 1;
28575 break;
28577 if (!found)
28578 break;
28581 /* The highlighted region ends on the previous row. */
28582 r--;
28584 /* Set the end row. */
28585 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
28587 /* Compute and set the end column and the end column's horizontal
28588 pixel coordinate. */
28589 if (!r->reversed_p)
28591 g = r->glyphs[TEXT_AREA];
28592 e = g + r->used[TEXT_AREA];
28593 for ( ; e > g; --e)
28594 if (EQ ((e-1)->object, object)
28595 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
28596 break;
28597 hlinfo->mouse_face_end_col = e - g;
28599 for (gx = r->x; g < e; ++g)
28600 gx += g->pixel_width;
28601 hlinfo->mouse_face_end_x = gx;
28603 else
28605 e = r->glyphs[TEXT_AREA];
28606 g = e + r->used[TEXT_AREA];
28607 for (gx = r->x ; e < g; ++e)
28609 if (EQ (e->object, object)
28610 && startpos <= e->charpos && e->charpos < endpos)
28611 break;
28612 gx += e->pixel_width;
28614 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
28615 hlinfo->mouse_face_end_x = gx;
28619 #ifdef HAVE_WINDOW_SYSTEM
28621 /* See if position X, Y is within a hot-spot of an image. */
28623 static int
28624 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
28626 if (!CONSP (hot_spot))
28627 return 0;
28629 if (EQ (XCAR (hot_spot), Qrect))
28631 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28632 Lisp_Object rect = XCDR (hot_spot);
28633 Lisp_Object tem;
28634 if (!CONSP (rect))
28635 return 0;
28636 if (!CONSP (XCAR (rect)))
28637 return 0;
28638 if (!CONSP (XCDR (rect)))
28639 return 0;
28640 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
28641 return 0;
28642 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
28643 return 0;
28644 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
28645 return 0;
28646 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
28647 return 0;
28648 return 1;
28650 else if (EQ (XCAR (hot_spot), Qcircle))
28652 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28653 Lisp_Object circ = XCDR (hot_spot);
28654 Lisp_Object lr, lx0, ly0;
28655 if (CONSP (circ)
28656 && CONSP (XCAR (circ))
28657 && (lr = XCDR (circ), INTEGERP (lr) || FLOATP (lr))
28658 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
28659 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
28661 double r = XFLOATINT (lr);
28662 double dx = XINT (lx0) - x;
28663 double dy = XINT (ly0) - y;
28664 return (dx * dx + dy * dy <= r * r);
28667 else if (EQ (XCAR (hot_spot), Qpoly))
28669 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28670 if (VECTORP (XCDR (hot_spot)))
28672 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
28673 Lisp_Object *poly = v->contents;
28674 ptrdiff_t n = v->header.size;
28675 ptrdiff_t i;
28676 int inside = 0;
28677 Lisp_Object lx, ly;
28678 int x0, y0;
28680 /* Need an even number of coordinates, and at least 3 edges. */
28681 if (n < 6 || n & 1)
28682 return 0;
28684 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28685 If count is odd, we are inside polygon. Pixels on edges
28686 may or may not be included depending on actual geometry of the
28687 polygon. */
28688 if ((lx = poly[n-2], !INTEGERP (lx))
28689 || (ly = poly[n-1], !INTEGERP (lx)))
28690 return 0;
28691 x0 = XINT (lx), y0 = XINT (ly);
28692 for (i = 0; i < n; i += 2)
28694 int x1 = x0, y1 = y0;
28695 if ((lx = poly[i], !INTEGERP (lx))
28696 || (ly = poly[i+1], !INTEGERP (ly)))
28697 return 0;
28698 x0 = XINT (lx), y0 = XINT (ly);
28700 /* Does this segment cross the X line? */
28701 if (x0 >= x)
28703 if (x1 >= x)
28704 continue;
28706 else if (x1 < x)
28707 continue;
28708 if (y > y0 && y > y1)
28709 continue;
28710 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
28711 inside = !inside;
28713 return inside;
28716 return 0;
28719 Lisp_Object
28720 find_hot_spot (Lisp_Object map, int x, int y)
28722 while (CONSP (map))
28724 if (CONSP (XCAR (map))
28725 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
28726 return XCAR (map);
28727 map = XCDR (map);
28730 return Qnil;
28733 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
28734 3, 3, 0,
28735 doc: /* Lookup in image map MAP coordinates X and Y.
28736 An image map is an alist where each element has the format (AREA ID PLIST).
28737 An AREA is specified as either a rectangle, a circle, or a polygon:
28738 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28739 pixel coordinates of the upper left and bottom right corners.
28740 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28741 and the radius of the circle; r may be a float or integer.
28742 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28743 vector describes one corner in the polygon.
28744 Returns the alist element for the first matching AREA in MAP. */)
28745 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
28747 if (NILP (map))
28748 return Qnil;
28750 CHECK_NUMBER (x);
28751 CHECK_NUMBER (y);
28753 return find_hot_spot (map,
28754 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
28755 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
28759 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28760 static void
28761 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
28763 /* Do not change cursor shape while dragging mouse. */
28764 if (!NILP (do_mouse_tracking))
28765 return;
28767 if (!NILP (pointer))
28769 if (EQ (pointer, Qarrow))
28770 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28771 else if (EQ (pointer, Qhand))
28772 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
28773 else if (EQ (pointer, Qtext))
28774 cursor = FRAME_X_OUTPUT (f)->text_cursor;
28775 else if (EQ (pointer, intern ("hdrag")))
28776 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
28777 else if (EQ (pointer, intern ("nhdrag")))
28778 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
28779 #ifdef HAVE_X_WINDOWS
28780 else if (EQ (pointer, intern ("vdrag")))
28781 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28782 #endif
28783 else if (EQ (pointer, intern ("hourglass")))
28784 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
28785 else if (EQ (pointer, Qmodeline))
28786 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
28787 else
28788 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28791 if (cursor != No_Cursor)
28792 FRAME_RIF (f)->define_frame_cursor (f, cursor);
28795 #endif /* HAVE_WINDOW_SYSTEM */
28797 /* Take proper action when mouse has moved to the mode or header line
28798 or marginal area AREA of window W, x-position X and y-position Y.
28799 X is relative to the start of the text display area of W, so the
28800 width of bitmap areas and scroll bars must be subtracted to get a
28801 position relative to the start of the mode line. */
28803 static void
28804 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
28805 enum window_part area)
28807 struct window *w = XWINDOW (window);
28808 struct frame *f = XFRAME (w->frame);
28809 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28810 #ifdef HAVE_WINDOW_SYSTEM
28811 Display_Info *dpyinfo;
28812 #endif
28813 Cursor cursor = No_Cursor;
28814 Lisp_Object pointer = Qnil;
28815 int dx, dy, width, height;
28816 ptrdiff_t charpos;
28817 Lisp_Object string, object = Qnil;
28818 Lisp_Object pos IF_LINT (= Qnil), help;
28820 Lisp_Object mouse_face;
28821 int original_x_pixel = x;
28822 struct glyph * glyph = NULL, * row_start_glyph = NULL;
28823 struct glyph_row *row IF_LINT (= 0);
28825 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
28827 int x0;
28828 struct glyph *end;
28830 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28831 returns them in row/column units! */
28832 string = mode_line_string (w, area, &x, &y, &charpos,
28833 &object, &dx, &dy, &width, &height);
28835 row = (area == ON_MODE_LINE
28836 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
28837 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
28839 /* Find the glyph under the mouse pointer. */
28840 if (row->mode_line_p && row->enabled_p)
28842 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
28843 end = glyph + row->used[TEXT_AREA];
28845 for (x0 = original_x_pixel;
28846 glyph < end && x0 >= glyph->pixel_width;
28847 ++glyph)
28848 x0 -= glyph->pixel_width;
28850 if (glyph >= end)
28851 glyph = NULL;
28854 else
28856 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
28857 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28858 returns them in row/column units! */
28859 string = marginal_area_string (w, area, &x, &y, &charpos,
28860 &object, &dx, &dy, &width, &height);
28863 help = Qnil;
28865 #ifdef HAVE_WINDOW_SYSTEM
28866 if (IMAGEP (object))
28868 Lisp_Object image_map, hotspot;
28869 if ((image_map = Fplist_get (XCDR (object), QCmap),
28870 !NILP (image_map))
28871 && (hotspot = find_hot_spot (image_map, dx, dy),
28872 CONSP (hotspot))
28873 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
28875 Lisp_Object plist;
28877 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28878 If so, we could look for mouse-enter, mouse-leave
28879 properties in PLIST (and do something...). */
28880 hotspot = XCDR (hotspot);
28881 if (CONSP (hotspot)
28882 && (plist = XCAR (hotspot), CONSP (plist)))
28884 pointer = Fplist_get (plist, Qpointer);
28885 if (NILP (pointer))
28886 pointer = Qhand;
28887 help = Fplist_get (plist, Qhelp_echo);
28888 if (!NILP (help))
28890 help_echo_string = help;
28891 XSETWINDOW (help_echo_window, w);
28892 help_echo_object = w->contents;
28893 help_echo_pos = charpos;
28897 if (NILP (pointer))
28898 pointer = Fplist_get (XCDR (object), QCpointer);
28900 #endif /* HAVE_WINDOW_SYSTEM */
28902 if (STRINGP (string))
28903 pos = make_number (charpos);
28905 /* Set the help text and mouse pointer. If the mouse is on a part
28906 of the mode line without any text (e.g. past the right edge of
28907 the mode line text), use the default help text and pointer. */
28908 if (STRINGP (string) || area == ON_MODE_LINE)
28910 /* Arrange to display the help by setting the global variables
28911 help_echo_string, help_echo_object, and help_echo_pos. */
28912 if (NILP (help))
28914 if (STRINGP (string))
28915 help = Fget_text_property (pos, Qhelp_echo, string);
28917 if (!NILP (help))
28919 help_echo_string = help;
28920 XSETWINDOW (help_echo_window, w);
28921 help_echo_object = string;
28922 help_echo_pos = charpos;
28924 else if (area == ON_MODE_LINE)
28926 Lisp_Object default_help
28927 = buffer_local_value_1 (Qmode_line_default_help_echo,
28928 w->contents);
28930 if (STRINGP (default_help))
28932 help_echo_string = default_help;
28933 XSETWINDOW (help_echo_window, w);
28934 help_echo_object = Qnil;
28935 help_echo_pos = -1;
28940 #ifdef HAVE_WINDOW_SYSTEM
28941 /* Change the mouse pointer according to what is under it. */
28942 if (FRAME_WINDOW_P (f))
28944 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
28945 || minibuf_level
28946 || NILP (Vresize_mini_windows));
28948 dpyinfo = FRAME_DISPLAY_INFO (f);
28949 if (STRINGP (string))
28951 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28953 if (NILP (pointer))
28954 pointer = Fget_text_property (pos, Qpointer, string);
28956 /* Change the mouse pointer according to what is under X/Y. */
28957 if (NILP (pointer)
28958 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
28960 Lisp_Object map;
28961 map = Fget_text_property (pos, Qlocal_map, string);
28962 if (!KEYMAPP (map))
28963 map = Fget_text_property (pos, Qkeymap, string);
28964 if (!KEYMAPP (map) && draggable)
28965 cursor = dpyinfo->vertical_scroll_bar_cursor;
28968 else if (draggable)
28969 /* Default mode-line pointer. */
28970 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28972 #endif
28975 /* Change the mouse face according to what is under X/Y. */
28976 if (STRINGP (string))
28978 mouse_face = Fget_text_property (pos, Qmouse_face, string);
28979 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
28980 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
28981 && glyph)
28983 Lisp_Object b, e;
28985 struct glyph * tmp_glyph;
28987 int gpos;
28988 int gseq_length;
28989 int total_pixel_width;
28990 ptrdiff_t begpos, endpos, ignore;
28992 int vpos, hpos;
28994 b = Fprevious_single_property_change (make_number (charpos + 1),
28995 Qmouse_face, string, Qnil);
28996 if (NILP (b))
28997 begpos = 0;
28998 else
28999 begpos = XINT (b);
29001 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
29002 if (NILP (e))
29003 endpos = SCHARS (string);
29004 else
29005 endpos = XINT (e);
29007 /* Calculate the glyph position GPOS of GLYPH in the
29008 displayed string, relative to the beginning of the
29009 highlighted part of the string.
29011 Note: GPOS is different from CHARPOS. CHARPOS is the
29012 position of GLYPH in the internal string object. A mode
29013 line string format has structures which are converted to
29014 a flattened string by the Emacs Lisp interpreter. The
29015 internal string is an element of those structures. The
29016 displayed string is the flattened string. */
29017 tmp_glyph = row_start_glyph;
29018 while (tmp_glyph < glyph
29019 && (!(EQ (tmp_glyph->object, glyph->object)
29020 && begpos <= tmp_glyph->charpos
29021 && tmp_glyph->charpos < endpos)))
29022 tmp_glyph++;
29023 gpos = glyph - tmp_glyph;
29025 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29026 the highlighted part of the displayed string to which
29027 GLYPH belongs. Note: GSEQ_LENGTH is different from
29028 SCHARS (STRING), because the latter returns the length of
29029 the internal string. */
29030 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
29031 tmp_glyph > glyph
29032 && (!(EQ (tmp_glyph->object, glyph->object)
29033 && begpos <= tmp_glyph->charpos
29034 && tmp_glyph->charpos < endpos));
29035 tmp_glyph--)
29037 gseq_length = gpos + (tmp_glyph - glyph) + 1;
29039 /* Calculate the total pixel width of all the glyphs between
29040 the beginning of the highlighted area and GLYPH. */
29041 total_pixel_width = 0;
29042 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
29043 total_pixel_width += tmp_glyph->pixel_width;
29045 /* Pre calculation of re-rendering position. Note: X is in
29046 column units here, after the call to mode_line_string or
29047 marginal_area_string. */
29048 hpos = x - gpos;
29049 vpos = (area == ON_MODE_LINE
29050 ? (w->current_matrix)->nrows - 1
29051 : 0);
29053 /* If GLYPH's position is included in the region that is
29054 already drawn in mouse face, we have nothing to do. */
29055 if ( EQ (window, hlinfo->mouse_face_window)
29056 && (!row->reversed_p
29057 ? (hlinfo->mouse_face_beg_col <= hpos
29058 && hpos < hlinfo->mouse_face_end_col)
29059 /* In R2L rows we swap BEG and END, see below. */
29060 : (hlinfo->mouse_face_end_col <= hpos
29061 && hpos < hlinfo->mouse_face_beg_col))
29062 && hlinfo->mouse_face_beg_row == vpos )
29063 return;
29065 if (clear_mouse_face (hlinfo))
29066 cursor = No_Cursor;
29068 if (!row->reversed_p)
29070 hlinfo->mouse_face_beg_col = hpos;
29071 hlinfo->mouse_face_beg_x = original_x_pixel
29072 - (total_pixel_width + dx);
29073 hlinfo->mouse_face_end_col = hpos + gseq_length;
29074 hlinfo->mouse_face_end_x = 0;
29076 else
29078 /* In R2L rows, show_mouse_face expects BEG and END
29079 coordinates to be swapped. */
29080 hlinfo->mouse_face_end_col = hpos;
29081 hlinfo->mouse_face_end_x = original_x_pixel
29082 - (total_pixel_width + dx);
29083 hlinfo->mouse_face_beg_col = hpos + gseq_length;
29084 hlinfo->mouse_face_beg_x = 0;
29087 hlinfo->mouse_face_beg_row = vpos;
29088 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
29089 hlinfo->mouse_face_past_end = 0;
29090 hlinfo->mouse_face_window = window;
29092 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
29093 charpos,
29094 0, &ignore,
29095 glyph->face_id,
29097 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29099 if (NILP (pointer))
29100 pointer = Qhand;
29102 else if ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29103 clear_mouse_face (hlinfo);
29105 #ifdef HAVE_WINDOW_SYSTEM
29106 if (FRAME_WINDOW_P (f))
29107 define_frame_cursor1 (f, cursor, pointer);
29108 #endif
29112 /* EXPORT:
29113 Take proper action when the mouse has moved to position X, Y on
29114 frame F with regards to highlighting portions of display that have
29115 mouse-face properties. Also de-highlight portions of display where
29116 the mouse was before, set the mouse pointer shape as appropriate
29117 for the mouse coordinates, and activate help echo (tooltips).
29118 X and Y can be negative or out of range. */
29120 void
29121 note_mouse_highlight (struct frame *f, int x, int y)
29123 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29124 enum window_part part = ON_NOTHING;
29125 Lisp_Object window;
29126 struct window *w;
29127 Cursor cursor = No_Cursor;
29128 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
29129 struct buffer *b;
29131 /* When a menu is active, don't highlight because this looks odd. */
29132 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29133 if (popup_activated ())
29134 return;
29135 #endif
29137 if (!f->glyphs_initialized_p
29138 || f->pointer_invisible)
29139 return;
29141 hlinfo->mouse_face_mouse_x = x;
29142 hlinfo->mouse_face_mouse_y = y;
29143 hlinfo->mouse_face_mouse_frame = f;
29145 if (hlinfo->mouse_face_defer)
29146 return;
29148 /* Which window is that in? */
29149 window = window_from_coordinates (f, x, y, &part, 1);
29151 /* If displaying active text in another window, clear that. */
29152 if (! EQ (window, hlinfo->mouse_face_window)
29153 /* Also clear if we move out of text area in same window. */
29154 || (!NILP (hlinfo->mouse_face_window)
29155 && !NILP (window)
29156 && part != ON_TEXT
29157 && part != ON_MODE_LINE
29158 && part != ON_HEADER_LINE))
29159 clear_mouse_face (hlinfo);
29161 /* Not on a window -> return. */
29162 if (!WINDOWP (window))
29163 return;
29165 /* Reset help_echo_string. It will get recomputed below. */
29166 help_echo_string = Qnil;
29168 /* Convert to window-relative pixel coordinates. */
29169 w = XWINDOW (window);
29170 frame_to_window_pixel_xy (w, &x, &y);
29172 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29173 /* Handle tool-bar window differently since it doesn't display a
29174 buffer. */
29175 if (EQ (window, f->tool_bar_window))
29177 note_tool_bar_highlight (f, x, y);
29178 return;
29180 #endif
29182 /* Mouse is on the mode, header line or margin? */
29183 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
29184 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29186 note_mode_line_or_margin_highlight (window, x, y, part);
29188 #ifdef HAVE_WINDOW_SYSTEM
29189 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29191 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29192 /* Show non-text cursor (Bug#16647). */
29193 goto set_cursor;
29195 else
29196 #endif
29197 return;
29200 #ifdef HAVE_WINDOW_SYSTEM
29201 if (part == ON_VERTICAL_BORDER)
29203 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29204 help_echo_string = build_string ("drag-mouse-1: resize");
29206 else if (part == ON_RIGHT_DIVIDER)
29208 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29209 help_echo_string = build_string ("drag-mouse-1: resize");
29211 else if (part == ON_BOTTOM_DIVIDER)
29212 if (! WINDOW_BOTTOMMOST_P (w)
29213 || minibuf_level
29214 || NILP (Vresize_mini_windows))
29216 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29217 help_echo_string = build_string ("drag-mouse-1: resize");
29219 else
29220 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29221 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
29222 || part == ON_SCROLL_BAR)
29223 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29224 else
29225 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29226 #endif
29228 /* Are we in a window whose display is up to date?
29229 And verify the buffer's text has not changed. */
29230 b = XBUFFER (w->contents);
29231 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
29233 int hpos, vpos, dx, dy, area = LAST_AREA;
29234 ptrdiff_t pos;
29235 struct glyph *glyph;
29236 Lisp_Object object;
29237 Lisp_Object mouse_face = Qnil, position;
29238 Lisp_Object *overlay_vec = NULL;
29239 ptrdiff_t i, noverlays;
29240 struct buffer *obuf;
29241 ptrdiff_t obegv, ozv;
29242 int same_region;
29244 /* Find the glyph under X/Y. */
29245 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
29247 #ifdef HAVE_WINDOW_SYSTEM
29248 /* Look for :pointer property on image. */
29249 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
29251 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
29252 if (img != NULL && IMAGEP (img->spec))
29254 Lisp_Object image_map, hotspot;
29255 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
29256 !NILP (image_map))
29257 && (hotspot = find_hot_spot (image_map,
29258 glyph->slice.img.x + dx,
29259 glyph->slice.img.y + dy),
29260 CONSP (hotspot))
29261 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29263 Lisp_Object plist;
29265 /* Could check XCAR (hotspot) to see if we enter/leave
29266 this hot-spot.
29267 If so, we could look for mouse-enter, mouse-leave
29268 properties in PLIST (and do something...). */
29269 hotspot = XCDR (hotspot);
29270 if (CONSP (hotspot)
29271 && (plist = XCAR (hotspot), CONSP (plist)))
29273 pointer = Fplist_get (plist, Qpointer);
29274 if (NILP (pointer))
29275 pointer = Qhand;
29276 help_echo_string = Fplist_get (plist, Qhelp_echo);
29277 if (!NILP (help_echo_string))
29279 help_echo_window = window;
29280 help_echo_object = glyph->object;
29281 help_echo_pos = glyph->charpos;
29285 if (NILP (pointer))
29286 pointer = Fplist_get (XCDR (img->spec), QCpointer);
29289 #endif /* HAVE_WINDOW_SYSTEM */
29291 /* Clear mouse face if X/Y not over text. */
29292 if (glyph == NULL
29293 || area != TEXT_AREA
29294 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
29295 /* Glyph's OBJECT is an integer for glyphs inserted by the
29296 display engine for its internal purposes, like truncation
29297 and continuation glyphs and blanks beyond the end of
29298 line's text on text terminals. If we are over such a
29299 glyph, we are not over any text. */
29300 || INTEGERP (glyph->object)
29301 /* R2L rows have a stretch glyph at their front, which
29302 stands for no text, whereas L2R rows have no glyphs at
29303 all beyond the end of text. Treat such stretch glyphs
29304 like we do with NULL glyphs in L2R rows. */
29305 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
29306 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
29307 && glyph->type == STRETCH_GLYPH
29308 && glyph->avoid_cursor_p))
29310 if (clear_mouse_face (hlinfo))
29311 cursor = No_Cursor;
29312 #ifdef HAVE_WINDOW_SYSTEM
29313 if (FRAME_WINDOW_P (f) && NILP (pointer))
29315 if (area != TEXT_AREA)
29316 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29317 else
29318 pointer = Vvoid_text_area_pointer;
29320 #endif
29321 goto set_cursor;
29324 pos = glyph->charpos;
29325 object = glyph->object;
29326 if (!STRINGP (object) && !BUFFERP (object))
29327 goto set_cursor;
29329 /* If we get an out-of-range value, return now; avoid an error. */
29330 if (BUFFERP (object) && pos > BUF_Z (b))
29331 goto set_cursor;
29333 /* Make the window's buffer temporarily current for
29334 overlays_at and compute_char_face. */
29335 obuf = current_buffer;
29336 current_buffer = b;
29337 obegv = BEGV;
29338 ozv = ZV;
29339 BEGV = BEG;
29340 ZV = Z;
29342 /* Is this char mouse-active or does it have help-echo? */
29343 position = make_number (pos);
29345 if (BUFFERP (object))
29347 /* Put all the overlays we want in a vector in overlay_vec. */
29348 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, 0);
29349 /* Sort overlays into increasing priority order. */
29350 noverlays = sort_overlays (overlay_vec, noverlays, w);
29352 else
29353 noverlays = 0;
29355 if (NILP (Vmouse_highlight))
29357 clear_mouse_face (hlinfo);
29358 goto check_help_echo;
29361 same_region = coords_in_mouse_face_p (w, hpos, vpos);
29363 if (same_region)
29364 cursor = No_Cursor;
29366 /* Check mouse-face highlighting. */
29367 if (! same_region
29368 /* If there exists an overlay with mouse-face overlapping
29369 the one we are currently highlighting, we have to
29370 check if we enter the overlapping overlay, and then
29371 highlight only that. */
29372 || (OVERLAYP (hlinfo->mouse_face_overlay)
29373 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
29375 /* Find the highest priority overlay with a mouse-face. */
29376 Lisp_Object overlay = Qnil;
29377 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
29379 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
29380 if (!NILP (mouse_face))
29381 overlay = overlay_vec[i];
29384 /* If we're highlighting the same overlay as before, there's
29385 no need to do that again. */
29386 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
29387 goto check_help_echo;
29388 hlinfo->mouse_face_overlay = overlay;
29390 /* Clear the display of the old active region, if any. */
29391 if (clear_mouse_face (hlinfo))
29392 cursor = No_Cursor;
29394 /* If no overlay applies, get a text property. */
29395 if (NILP (overlay))
29396 mouse_face = Fget_text_property (position, Qmouse_face, object);
29398 /* Next, compute the bounds of the mouse highlighting and
29399 display it. */
29400 if (!NILP (mouse_face) && STRINGP (object))
29402 /* The mouse-highlighting comes from a display string
29403 with a mouse-face. */
29404 Lisp_Object s, e;
29405 ptrdiff_t ignore;
29407 s = Fprevious_single_property_change
29408 (make_number (pos + 1), Qmouse_face, object, Qnil);
29409 e = Fnext_single_property_change
29410 (position, Qmouse_face, object, Qnil);
29411 if (NILP (s))
29412 s = make_number (0);
29413 if (NILP (e))
29414 e = make_number (SCHARS (object));
29415 mouse_face_from_string_pos (w, hlinfo, object,
29416 XINT (s), XINT (e));
29417 hlinfo->mouse_face_past_end = 0;
29418 hlinfo->mouse_face_window = window;
29419 hlinfo->mouse_face_face_id
29420 = face_at_string_position (w, object, pos, 0, &ignore,
29421 glyph->face_id, 1);
29422 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29423 cursor = No_Cursor;
29425 else
29427 /* The mouse-highlighting, if any, comes from an overlay
29428 or text property in the buffer. */
29429 Lisp_Object buffer IF_LINT (= Qnil);
29430 Lisp_Object disp_string IF_LINT (= Qnil);
29432 if (STRINGP (object))
29434 /* If we are on a display string with no mouse-face,
29435 check if the text under it has one. */
29436 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
29437 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29438 pos = string_buffer_position (object, start);
29439 if (pos > 0)
29441 mouse_face = get_char_property_and_overlay
29442 (make_number (pos), Qmouse_face, w->contents, &overlay);
29443 buffer = w->contents;
29444 disp_string = object;
29447 else
29449 buffer = object;
29450 disp_string = Qnil;
29453 if (!NILP (mouse_face))
29455 Lisp_Object before, after;
29456 Lisp_Object before_string, after_string;
29457 /* To correctly find the limits of mouse highlight
29458 in a bidi-reordered buffer, we must not use the
29459 optimization of limiting the search in
29460 previous-single-property-change and
29461 next-single-property-change, because
29462 rows_from_pos_range needs the real start and end
29463 positions to DTRT in this case. That's because
29464 the first row visible in a window does not
29465 necessarily display the character whose position
29466 is the smallest. */
29467 Lisp_Object lim1
29468 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29469 ? Fmarker_position (w->start)
29470 : Qnil;
29471 Lisp_Object lim2
29472 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29473 ? make_number (BUF_Z (XBUFFER (buffer))
29474 - w->window_end_pos)
29475 : Qnil;
29477 if (NILP (overlay))
29479 /* Handle the text property case. */
29480 before = Fprevious_single_property_change
29481 (make_number (pos + 1), Qmouse_face, buffer, lim1);
29482 after = Fnext_single_property_change
29483 (make_number (pos), Qmouse_face, buffer, lim2);
29484 before_string = after_string = Qnil;
29486 else
29488 /* Handle the overlay case. */
29489 before = Foverlay_start (overlay);
29490 after = Foverlay_end (overlay);
29491 before_string = Foverlay_get (overlay, Qbefore_string);
29492 after_string = Foverlay_get (overlay, Qafter_string);
29494 if (!STRINGP (before_string)) before_string = Qnil;
29495 if (!STRINGP (after_string)) after_string = Qnil;
29498 mouse_face_from_buffer_pos (window, hlinfo, pos,
29499 NILP (before)
29501 : XFASTINT (before),
29502 NILP (after)
29503 ? BUF_Z (XBUFFER (buffer))
29504 : XFASTINT (after),
29505 before_string, after_string,
29506 disp_string);
29507 cursor = No_Cursor;
29512 check_help_echo:
29514 /* Look for a `help-echo' property. */
29515 if (NILP (help_echo_string)) {
29516 Lisp_Object help, overlay;
29518 /* Check overlays first. */
29519 help = overlay = Qnil;
29520 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
29522 overlay = overlay_vec[i];
29523 help = Foverlay_get (overlay, Qhelp_echo);
29526 if (!NILP (help))
29528 help_echo_string = help;
29529 help_echo_window = window;
29530 help_echo_object = overlay;
29531 help_echo_pos = pos;
29533 else
29535 Lisp_Object obj = glyph->object;
29536 ptrdiff_t charpos = glyph->charpos;
29538 /* Try text properties. */
29539 if (STRINGP (obj)
29540 && charpos >= 0
29541 && charpos < SCHARS (obj))
29543 help = Fget_text_property (make_number (charpos),
29544 Qhelp_echo, obj);
29545 if (NILP (help))
29547 /* If the string itself doesn't specify a help-echo,
29548 see if the buffer text ``under'' it does. */
29549 struct glyph_row *r
29550 = MATRIX_ROW (w->current_matrix, vpos);
29551 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29552 ptrdiff_t p = string_buffer_position (obj, start);
29553 if (p > 0)
29555 help = Fget_char_property (make_number (p),
29556 Qhelp_echo, w->contents);
29557 if (!NILP (help))
29559 charpos = p;
29560 obj = w->contents;
29565 else if (BUFFERP (obj)
29566 && charpos >= BEGV
29567 && charpos < ZV)
29568 help = Fget_text_property (make_number (charpos), Qhelp_echo,
29569 obj);
29571 if (!NILP (help))
29573 help_echo_string = help;
29574 help_echo_window = window;
29575 help_echo_object = obj;
29576 help_echo_pos = charpos;
29581 #ifdef HAVE_WINDOW_SYSTEM
29582 /* Look for a `pointer' property. */
29583 if (FRAME_WINDOW_P (f) && NILP (pointer))
29585 /* Check overlays first. */
29586 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
29587 pointer = Foverlay_get (overlay_vec[i], Qpointer);
29589 if (NILP (pointer))
29591 Lisp_Object obj = glyph->object;
29592 ptrdiff_t charpos = glyph->charpos;
29594 /* Try text properties. */
29595 if (STRINGP (obj)
29596 && charpos >= 0
29597 && charpos < SCHARS (obj))
29599 pointer = Fget_text_property (make_number (charpos),
29600 Qpointer, obj);
29601 if (NILP (pointer))
29603 /* If the string itself doesn't specify a pointer,
29604 see if the buffer text ``under'' it does. */
29605 struct glyph_row *r
29606 = MATRIX_ROW (w->current_matrix, vpos);
29607 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29608 ptrdiff_t p = string_buffer_position (obj, start);
29609 if (p > 0)
29610 pointer = Fget_char_property (make_number (p),
29611 Qpointer, w->contents);
29614 else if (BUFFERP (obj)
29615 && charpos >= BEGV
29616 && charpos < ZV)
29617 pointer = Fget_text_property (make_number (charpos),
29618 Qpointer, obj);
29621 #endif /* HAVE_WINDOW_SYSTEM */
29623 BEGV = obegv;
29624 ZV = ozv;
29625 current_buffer = obuf;
29628 set_cursor:
29630 #ifdef HAVE_WINDOW_SYSTEM
29631 if (FRAME_WINDOW_P (f))
29632 define_frame_cursor1 (f, cursor, pointer);
29633 #else
29634 /* This is here to prevent a compiler error, about "label at end of
29635 compound statement". */
29636 return;
29637 #endif
29641 /* EXPORT for RIF:
29642 Clear any mouse-face on window W. This function is part of the
29643 redisplay interface, and is called from try_window_id and similar
29644 functions to ensure the mouse-highlight is off. */
29646 void
29647 x_clear_window_mouse_face (struct window *w)
29649 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
29650 Lisp_Object window;
29652 block_input ();
29653 XSETWINDOW (window, w);
29654 if (EQ (window, hlinfo->mouse_face_window))
29655 clear_mouse_face (hlinfo);
29656 unblock_input ();
29660 /* EXPORT:
29661 Just discard the mouse face information for frame F, if any.
29662 This is used when the size of F is changed. */
29664 void
29665 cancel_mouse_face (struct frame *f)
29667 Lisp_Object window;
29668 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29670 window = hlinfo->mouse_face_window;
29671 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
29672 reset_mouse_highlight (hlinfo);
29677 /***********************************************************************
29678 Exposure Events
29679 ***********************************************************************/
29681 #ifdef HAVE_WINDOW_SYSTEM
29683 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29684 which intersects rectangle R. R is in window-relative coordinates. */
29686 static void
29687 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
29688 enum glyph_row_area area)
29690 struct glyph *first = row->glyphs[area];
29691 struct glyph *end = row->glyphs[area] + row->used[area];
29692 struct glyph *last;
29693 int first_x, start_x, x;
29695 if (area == TEXT_AREA && row->fill_line_p)
29696 /* If row extends face to end of line write the whole line. */
29697 draw_glyphs (w, 0, row, area,
29698 0, row->used[area],
29699 DRAW_NORMAL_TEXT, 0);
29700 else
29702 /* Set START_X to the window-relative start position for drawing glyphs of
29703 AREA. The first glyph of the text area can be partially visible.
29704 The first glyphs of other areas cannot. */
29705 start_x = window_box_left_offset (w, area);
29706 x = start_x;
29707 if (area == TEXT_AREA)
29708 x += row->x;
29710 /* Find the first glyph that must be redrawn. */
29711 while (first < end
29712 && x + first->pixel_width < r->x)
29714 x += first->pixel_width;
29715 ++first;
29718 /* Find the last one. */
29719 last = first;
29720 first_x = x;
29721 while (last < end
29722 && x < r->x + r->width)
29724 x += last->pixel_width;
29725 ++last;
29728 /* Repaint. */
29729 if (last > first)
29730 draw_glyphs (w, first_x - start_x, row, area,
29731 first - row->glyphs[area], last - row->glyphs[area],
29732 DRAW_NORMAL_TEXT, 0);
29737 /* Redraw the parts of the glyph row ROW on window W intersecting
29738 rectangle R. R is in window-relative coordinates. Value is
29739 non-zero if mouse-face was overwritten. */
29741 static int
29742 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
29744 eassert (row->enabled_p);
29746 if (row->mode_line_p || w->pseudo_window_p)
29747 draw_glyphs (w, 0, row, TEXT_AREA,
29748 0, row->used[TEXT_AREA],
29749 DRAW_NORMAL_TEXT, 0);
29750 else
29752 if (row->used[LEFT_MARGIN_AREA])
29753 expose_area (w, row, r, LEFT_MARGIN_AREA);
29754 if (row->used[TEXT_AREA])
29755 expose_area (w, row, r, TEXT_AREA);
29756 if (row->used[RIGHT_MARGIN_AREA])
29757 expose_area (w, row, r, RIGHT_MARGIN_AREA);
29758 draw_row_fringe_bitmaps (w, row);
29761 return row->mouse_face_p;
29765 /* Redraw those parts of glyphs rows during expose event handling that
29766 overlap other rows. Redrawing of an exposed line writes over parts
29767 of lines overlapping that exposed line; this function fixes that.
29769 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29770 row in W's current matrix that is exposed and overlaps other rows.
29771 LAST_OVERLAPPING_ROW is the last such row. */
29773 static void
29774 expose_overlaps (struct window *w,
29775 struct glyph_row *first_overlapping_row,
29776 struct glyph_row *last_overlapping_row,
29777 XRectangle *r)
29779 struct glyph_row *row;
29781 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
29782 if (row->overlapping_p)
29784 eassert (row->enabled_p && !row->mode_line_p);
29786 row->clip = r;
29787 if (row->used[LEFT_MARGIN_AREA])
29788 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
29790 if (row->used[TEXT_AREA])
29791 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
29793 if (row->used[RIGHT_MARGIN_AREA])
29794 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
29795 row->clip = NULL;
29800 /* Return non-zero if W's cursor intersects rectangle R. */
29802 static int
29803 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
29805 XRectangle cr, result;
29806 struct glyph *cursor_glyph;
29807 struct glyph_row *row;
29809 if (w->phys_cursor.vpos >= 0
29810 && w->phys_cursor.vpos < w->current_matrix->nrows
29811 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
29812 row->enabled_p)
29813 && row->cursor_in_fringe_p)
29815 /* Cursor is in the fringe. */
29816 cr.x = window_box_right_offset (w,
29817 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
29818 ? RIGHT_MARGIN_AREA
29819 : TEXT_AREA));
29820 cr.y = row->y;
29821 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
29822 cr.height = row->height;
29823 return x_intersect_rectangles (&cr, r, &result);
29826 cursor_glyph = get_phys_cursor_glyph (w);
29827 if (cursor_glyph)
29829 /* r is relative to W's box, but w->phys_cursor.x is relative
29830 to left edge of W's TEXT area. Adjust it. */
29831 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
29832 cr.y = w->phys_cursor.y;
29833 cr.width = cursor_glyph->pixel_width;
29834 cr.height = w->phys_cursor_height;
29835 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29836 I assume the effect is the same -- and this is portable. */
29837 return x_intersect_rectangles (&cr, r, &result);
29839 /* If we don't understand the format, pretend we're not in the hot-spot. */
29840 return 0;
29844 /* EXPORT:
29845 Draw a vertical window border to the right of window W if W doesn't
29846 have vertical scroll bars. */
29848 void
29849 x_draw_vertical_border (struct window *w)
29851 struct frame *f = XFRAME (WINDOW_FRAME (w));
29853 /* We could do better, if we knew what type of scroll-bar the adjacent
29854 windows (on either side) have... But we don't :-(
29855 However, I think this works ok. ++KFS 2003-04-25 */
29857 /* Redraw borders between horizontally adjacent windows. Don't
29858 do it for frames with vertical scroll bars because either the
29859 right scroll bar of a window, or the left scroll bar of its
29860 neighbor will suffice as a border. */
29861 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
29862 return;
29864 /* Note: It is necessary to redraw both the left and the right
29865 borders, for when only this single window W is being
29866 redisplayed. */
29867 if (!WINDOW_RIGHTMOST_P (w)
29868 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
29870 int x0, x1, y0, y1;
29872 window_box_edges (w, &x0, &y0, &x1, &y1);
29873 y1 -= 1;
29875 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
29876 x1 -= 1;
29878 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
29881 if (!WINDOW_LEFTMOST_P (w)
29882 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
29884 int x0, x1, y0, y1;
29886 window_box_edges (w, &x0, &y0, &x1, &y1);
29887 y1 -= 1;
29889 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
29890 x0 -= 1;
29892 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
29897 /* Draw window dividers for window W. */
29899 void
29900 x_draw_right_divider (struct window *w)
29902 struct frame *f = WINDOW_XFRAME (w);
29904 if (w->mini || w->pseudo_window_p)
29905 return;
29906 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
29908 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
29909 int x1 = WINDOW_RIGHT_EDGE_X (w);
29910 int y0 = WINDOW_TOP_EDGE_Y (w);
29911 /* The bottom divider prevails. */
29912 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
29914 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
29918 static void
29919 x_draw_bottom_divider (struct window *w)
29921 struct frame *f = XFRAME (WINDOW_FRAME (w));
29923 if (w->mini || w->pseudo_window_p)
29924 return;
29925 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
29927 int x0 = WINDOW_LEFT_EDGE_X (w);
29928 int x1 = WINDOW_RIGHT_EDGE_X (w);
29929 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
29930 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
29932 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
29936 /* Redraw the part of window W intersection rectangle FR. Pixel
29937 coordinates in FR are frame-relative. Call this function with
29938 input blocked. Value is non-zero if the exposure overwrites
29939 mouse-face. */
29941 static int
29942 expose_window (struct window *w, XRectangle *fr)
29944 struct frame *f = XFRAME (w->frame);
29945 XRectangle wr, r;
29946 int mouse_face_overwritten_p = 0;
29948 /* If window is not yet fully initialized, do nothing. This can
29949 happen when toolkit scroll bars are used and a window is split.
29950 Reconfiguring the scroll bar will generate an expose for a newly
29951 created window. */
29952 if (w->current_matrix == NULL)
29953 return 0;
29955 /* When we're currently updating the window, display and current
29956 matrix usually don't agree. Arrange for a thorough display
29957 later. */
29958 if (w->must_be_updated_p)
29960 SET_FRAME_GARBAGED (f);
29961 return 0;
29964 /* Frame-relative pixel rectangle of W. */
29965 wr.x = WINDOW_LEFT_EDGE_X (w);
29966 wr.y = WINDOW_TOP_EDGE_Y (w);
29967 wr.width = WINDOW_PIXEL_WIDTH (w);
29968 wr.height = WINDOW_PIXEL_HEIGHT (w);
29970 if (x_intersect_rectangles (fr, &wr, &r))
29972 int yb = window_text_bottom_y (w);
29973 struct glyph_row *row;
29974 int cursor_cleared_p, phys_cursor_on_p;
29975 struct glyph_row *first_overlapping_row, *last_overlapping_row;
29977 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
29978 r.x, r.y, r.width, r.height));
29980 /* Convert to window coordinates. */
29981 r.x -= WINDOW_LEFT_EDGE_X (w);
29982 r.y -= WINDOW_TOP_EDGE_Y (w);
29984 /* Turn off the cursor. */
29985 if (!w->pseudo_window_p
29986 && phys_cursor_in_rect_p (w, &r))
29988 x_clear_cursor (w);
29989 cursor_cleared_p = 1;
29991 else
29992 cursor_cleared_p = 0;
29994 /* If the row containing the cursor extends face to end of line,
29995 then expose_area might overwrite the cursor outside the
29996 rectangle and thus notice_overwritten_cursor might clear
29997 w->phys_cursor_on_p. We remember the original value and
29998 check later if it is changed. */
29999 phys_cursor_on_p = w->phys_cursor_on_p;
30001 /* Update lines intersecting rectangle R. */
30002 first_overlapping_row = last_overlapping_row = NULL;
30003 for (row = w->current_matrix->rows;
30004 row->enabled_p;
30005 ++row)
30007 int y0 = row->y;
30008 int y1 = MATRIX_ROW_BOTTOM_Y (row);
30010 if ((y0 >= r.y && y0 < r.y + r.height)
30011 || (y1 > r.y && y1 < r.y + r.height)
30012 || (r.y >= y0 && r.y < y1)
30013 || (r.y + r.height > y0 && r.y + r.height < y1))
30015 /* A header line may be overlapping, but there is no need
30016 to fix overlapping areas for them. KFS 2005-02-12 */
30017 if (row->overlapping_p && !row->mode_line_p)
30019 if (first_overlapping_row == NULL)
30020 first_overlapping_row = row;
30021 last_overlapping_row = row;
30024 row->clip = fr;
30025 if (expose_line (w, row, &r))
30026 mouse_face_overwritten_p = 1;
30027 row->clip = NULL;
30029 else if (row->overlapping_p)
30031 /* We must redraw a row overlapping the exposed area. */
30032 if (y0 < r.y
30033 ? y0 + row->phys_height > r.y
30034 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
30036 if (first_overlapping_row == NULL)
30037 first_overlapping_row = row;
30038 last_overlapping_row = row;
30042 if (y1 >= yb)
30043 break;
30046 /* Display the mode line if there is one. */
30047 if (WINDOW_WANTS_MODELINE_P (w)
30048 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
30049 row->enabled_p)
30050 && row->y < r.y + r.height)
30052 if (expose_line (w, row, &r))
30053 mouse_face_overwritten_p = 1;
30056 if (!w->pseudo_window_p)
30058 /* Fix the display of overlapping rows. */
30059 if (first_overlapping_row)
30060 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
30061 fr);
30063 /* Draw border between windows. */
30064 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
30065 x_draw_right_divider (w);
30066 else
30067 x_draw_vertical_border (w);
30069 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30070 x_draw_bottom_divider (w);
30072 /* Turn the cursor on again. */
30073 if (cursor_cleared_p
30074 || (phys_cursor_on_p && !w->phys_cursor_on_p))
30075 update_window_cursor (w, 1);
30079 return mouse_face_overwritten_p;
30084 /* Redraw (parts) of all windows in the window tree rooted at W that
30085 intersect R. R contains frame pixel coordinates. Value is
30086 non-zero if the exposure overwrites mouse-face. */
30088 static int
30089 expose_window_tree (struct window *w, XRectangle *r)
30091 struct frame *f = XFRAME (w->frame);
30092 int mouse_face_overwritten_p = 0;
30094 while (w && !FRAME_GARBAGED_P (f))
30096 if (WINDOWP (w->contents))
30097 mouse_face_overwritten_p
30098 |= expose_window_tree (XWINDOW (w->contents), r);
30099 else
30100 mouse_face_overwritten_p |= expose_window (w, r);
30102 w = NILP (w->next) ? NULL : XWINDOW (w->next);
30105 return mouse_face_overwritten_p;
30109 /* EXPORT:
30110 Redisplay an exposed area of frame F. X and Y are the upper-left
30111 corner of the exposed rectangle. W and H are width and height of
30112 the exposed area. All are pixel values. W or H zero means redraw
30113 the entire frame. */
30115 void
30116 expose_frame (struct frame *f, int x, int y, int w, int h)
30118 XRectangle r;
30119 int mouse_face_overwritten_p = 0;
30121 TRACE ((stderr, "expose_frame "));
30123 /* No need to redraw if frame will be redrawn soon. */
30124 if (FRAME_GARBAGED_P (f))
30126 TRACE ((stderr, " garbaged\n"));
30127 return;
30130 /* If basic faces haven't been realized yet, there is no point in
30131 trying to redraw anything. This can happen when we get an expose
30132 event while Emacs is starting, e.g. by moving another window. */
30133 if (FRAME_FACE_CACHE (f) == NULL
30134 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
30136 TRACE ((stderr, " no faces\n"));
30137 return;
30140 if (w == 0 || h == 0)
30142 r.x = r.y = 0;
30143 r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f);
30144 r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f);
30146 else
30148 r.x = x;
30149 r.y = y;
30150 r.width = w;
30151 r.height = h;
30154 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
30155 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
30157 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30158 if (WINDOWP (f->tool_bar_window))
30159 mouse_face_overwritten_p
30160 |= expose_window (XWINDOW (f->tool_bar_window), &r);
30161 #endif
30163 #ifdef HAVE_X_WINDOWS
30164 #ifndef MSDOS
30165 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30166 if (WINDOWP (f->menu_bar_window))
30167 mouse_face_overwritten_p
30168 |= expose_window (XWINDOW (f->menu_bar_window), &r);
30169 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30170 #endif
30171 #endif
30173 /* Some window managers support a focus-follows-mouse style with
30174 delayed raising of frames. Imagine a partially obscured frame,
30175 and moving the mouse into partially obscured mouse-face on that
30176 frame. The visible part of the mouse-face will be highlighted,
30177 then the WM raises the obscured frame. With at least one WM, KDE
30178 2.1, Emacs is not getting any event for the raising of the frame
30179 (even tried with SubstructureRedirectMask), only Expose events.
30180 These expose events will draw text normally, i.e. not
30181 highlighted. Which means we must redo the highlight here.
30182 Subsume it under ``we love X''. --gerd 2001-08-15 */
30183 /* Included in Windows version because Windows most likely does not
30184 do the right thing if any third party tool offers
30185 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30186 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
30188 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30189 if (f == hlinfo->mouse_face_mouse_frame)
30191 int mouse_x = hlinfo->mouse_face_mouse_x;
30192 int mouse_y = hlinfo->mouse_face_mouse_y;
30193 clear_mouse_face (hlinfo);
30194 note_mouse_highlight (f, mouse_x, mouse_y);
30200 /* EXPORT:
30201 Determine the intersection of two rectangles R1 and R2. Return
30202 the intersection in *RESULT. Value is non-zero if RESULT is not
30203 empty. */
30206 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
30208 XRectangle *left, *right;
30209 XRectangle *upper, *lower;
30210 int intersection_p = 0;
30212 /* Rearrange so that R1 is the left-most rectangle. */
30213 if (r1->x < r2->x)
30214 left = r1, right = r2;
30215 else
30216 left = r2, right = r1;
30218 /* X0 of the intersection is right.x0, if this is inside R1,
30219 otherwise there is no intersection. */
30220 if (right->x <= left->x + left->width)
30222 result->x = right->x;
30224 /* The right end of the intersection is the minimum of
30225 the right ends of left and right. */
30226 result->width = (min (left->x + left->width, right->x + right->width)
30227 - result->x);
30229 /* Same game for Y. */
30230 if (r1->y < r2->y)
30231 upper = r1, lower = r2;
30232 else
30233 upper = r2, lower = r1;
30235 /* The upper end of the intersection is lower.y0, if this is inside
30236 of upper. Otherwise, there is no intersection. */
30237 if (lower->y <= upper->y + upper->height)
30239 result->y = lower->y;
30241 /* The lower end of the intersection is the minimum of the lower
30242 ends of upper and lower. */
30243 result->height = (min (lower->y + lower->height,
30244 upper->y + upper->height)
30245 - result->y);
30246 intersection_p = 1;
30250 return intersection_p;
30253 #endif /* HAVE_WINDOW_SYSTEM */
30256 /***********************************************************************
30257 Initialization
30258 ***********************************************************************/
30260 void
30261 syms_of_xdisp (void)
30263 Vwith_echo_area_save_vector = Qnil;
30264 staticpro (&Vwith_echo_area_save_vector);
30266 Vmessage_stack = Qnil;
30267 staticpro (&Vmessage_stack);
30269 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
30270 DEFSYM (Qredisplay_internal, "redisplay_internal (C function)");
30272 message_dolog_marker1 = Fmake_marker ();
30273 staticpro (&message_dolog_marker1);
30274 message_dolog_marker2 = Fmake_marker ();
30275 staticpro (&message_dolog_marker2);
30276 message_dolog_marker3 = Fmake_marker ();
30277 staticpro (&message_dolog_marker3);
30279 #ifdef GLYPH_DEBUG
30280 defsubr (&Sdump_frame_glyph_matrix);
30281 defsubr (&Sdump_glyph_matrix);
30282 defsubr (&Sdump_glyph_row);
30283 defsubr (&Sdump_tool_bar_row);
30284 defsubr (&Strace_redisplay);
30285 defsubr (&Strace_to_stderr);
30286 #endif
30287 #ifdef HAVE_WINDOW_SYSTEM
30288 defsubr (&Stool_bar_height);
30289 defsubr (&Slookup_image_map);
30290 #endif
30291 defsubr (&Sline_pixel_height);
30292 defsubr (&Sformat_mode_line);
30293 defsubr (&Sinvisible_p);
30294 defsubr (&Scurrent_bidi_paragraph_direction);
30295 defsubr (&Swindow_text_pixel_size);
30296 defsubr (&Smove_point_visually);
30298 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
30299 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
30300 DEFSYM (Qoverriding_local_map, "overriding-local-map");
30301 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
30302 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
30303 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
30304 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
30305 DEFSYM (Qeval, "eval");
30306 DEFSYM (QCdata, ":data");
30307 DEFSYM (Qdisplay, "display");
30308 DEFSYM (Qspace_width, "space-width");
30309 DEFSYM (Qraise, "raise");
30310 DEFSYM (Qslice, "slice");
30311 DEFSYM (Qspace, "space");
30312 DEFSYM (Qmargin, "margin");
30313 DEFSYM (Qpointer, "pointer");
30314 DEFSYM (Qleft_margin, "left-margin");
30315 DEFSYM (Qright_margin, "right-margin");
30316 DEFSYM (Qcenter, "center");
30317 DEFSYM (Qline_height, "line-height");
30318 DEFSYM (QCalign_to, ":align-to");
30319 DEFSYM (QCrelative_width, ":relative-width");
30320 DEFSYM (QCrelative_height, ":relative-height");
30321 DEFSYM (QCeval, ":eval");
30322 DEFSYM (QCpropertize, ":propertize");
30323 DEFSYM (QCfile, ":file");
30324 DEFSYM (Qfontified, "fontified");
30325 DEFSYM (Qfontification_functions, "fontification-functions");
30326 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
30327 DEFSYM (Qescape_glyph, "escape-glyph");
30328 DEFSYM (Qnobreak_space, "nobreak-space");
30329 DEFSYM (Qimage, "image");
30330 DEFSYM (Qtext, "text");
30331 DEFSYM (Qboth, "both");
30332 DEFSYM (Qboth_horiz, "both-horiz");
30333 DEFSYM (Qtext_image_horiz, "text-image-horiz");
30334 DEFSYM (QCmap, ":map");
30335 DEFSYM (QCpointer, ":pointer");
30336 DEFSYM (Qrect, "rect");
30337 DEFSYM (Qcircle, "circle");
30338 DEFSYM (Qpoly, "poly");
30339 DEFSYM (Qmessage_truncate_lines, "message-truncate-lines");
30340 DEFSYM (Qgrow_only, "grow-only");
30341 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
30342 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
30343 DEFSYM (Qposition, "position");
30344 DEFSYM (Qbuffer_position, "buffer-position");
30345 DEFSYM (Qobject, "object");
30346 DEFSYM (Qbar, "bar");
30347 DEFSYM (Qhbar, "hbar");
30348 DEFSYM (Qbox, "box");
30349 DEFSYM (Qhollow, "hollow");
30350 DEFSYM (Qhand, "hand");
30351 DEFSYM (Qarrow, "arrow");
30352 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
30354 list_of_error = list1 (list2 (intern_c_string ("error"),
30355 intern_c_string ("void-variable")));
30356 staticpro (&list_of_error);
30358 DEFSYM (Qlast_arrow_position, "last-arrow-position");
30359 DEFSYM (Qlast_arrow_string, "last-arrow-string");
30360 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
30361 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
30363 echo_buffer[0] = echo_buffer[1] = Qnil;
30364 staticpro (&echo_buffer[0]);
30365 staticpro (&echo_buffer[1]);
30367 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
30368 staticpro (&echo_area_buffer[0]);
30369 staticpro (&echo_area_buffer[1]);
30371 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
30372 staticpro (&Vmessages_buffer_name);
30374 mode_line_proptrans_alist = Qnil;
30375 staticpro (&mode_line_proptrans_alist);
30376 mode_line_string_list = Qnil;
30377 staticpro (&mode_line_string_list);
30378 mode_line_string_face = Qnil;
30379 staticpro (&mode_line_string_face);
30380 mode_line_string_face_prop = Qnil;
30381 staticpro (&mode_line_string_face_prop);
30382 Vmode_line_unwind_vector = Qnil;
30383 staticpro (&Vmode_line_unwind_vector);
30385 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
30387 help_echo_string = Qnil;
30388 staticpro (&help_echo_string);
30389 help_echo_object = Qnil;
30390 staticpro (&help_echo_object);
30391 help_echo_window = Qnil;
30392 staticpro (&help_echo_window);
30393 previous_help_echo_string = Qnil;
30394 staticpro (&previous_help_echo_string);
30395 help_echo_pos = -1;
30397 DEFSYM (Qright_to_left, "right-to-left");
30398 DEFSYM (Qleft_to_right, "left-to-right");
30400 #ifdef HAVE_WINDOW_SYSTEM
30401 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
30402 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
30403 For example, if a block cursor is over a tab, it will be drawn as
30404 wide as that tab on the display. */);
30405 x_stretch_cursor_p = 0;
30406 #endif
30408 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
30409 doc: /* Non-nil means highlight trailing whitespace.
30410 The face used for trailing whitespace is `trailing-whitespace'. */);
30411 Vshow_trailing_whitespace = Qnil;
30413 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
30414 doc: /* Control highlighting of non-ASCII space and hyphen chars.
30415 If the value is t, Emacs highlights non-ASCII chars which have the
30416 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30417 or `escape-glyph' face respectively.
30419 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30420 U+2011 (non-breaking hyphen) are affected.
30422 Any other non-nil value means to display these characters as a escape
30423 glyph followed by an ordinary space or hyphen.
30425 A value of nil means no special handling of these characters. */);
30426 Vnobreak_char_display = Qt;
30428 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
30429 doc: /* The pointer shape to show in void text areas.
30430 A value of nil means to show the text pointer. Other options are `arrow',
30431 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30432 Vvoid_text_area_pointer = Qarrow;
30434 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
30435 doc: /* Non-nil means don't actually do any redisplay.
30436 This is used for internal purposes. */);
30437 Vinhibit_redisplay = Qnil;
30439 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
30440 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30441 Vglobal_mode_string = Qnil;
30443 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
30444 doc: /* Marker for where to display an arrow on top of the buffer text.
30445 This must be the beginning of a line in order to work.
30446 See also `overlay-arrow-string'. */);
30447 Voverlay_arrow_position = Qnil;
30449 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
30450 doc: /* String to display as an arrow in non-window frames.
30451 See also `overlay-arrow-position'. */);
30452 Voverlay_arrow_string = build_pure_c_string ("=>");
30454 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
30455 doc: /* List of variables (symbols) which hold markers for overlay arrows.
30456 The symbols on this list are examined during redisplay to determine
30457 where to display overlay arrows. */);
30458 Voverlay_arrow_variable_list
30459 = list1 (intern_c_string ("overlay-arrow-position"));
30461 DEFVAR_INT ("scroll-step", emacs_scroll_step,
30462 doc: /* The number of lines to try scrolling a window by when point moves out.
30463 If that fails to bring point back on frame, point is centered instead.
30464 If this is zero, point is always centered after it moves off frame.
30465 If you want scrolling to always be a line at a time, you should set
30466 `scroll-conservatively' to a large value rather than set this to 1. */);
30468 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
30469 doc: /* Scroll up to this many lines, to bring point back on screen.
30470 If point moves off-screen, redisplay will scroll by up to
30471 `scroll-conservatively' lines in order to bring point just barely
30472 onto the screen again. If that cannot be done, then redisplay
30473 recenters point as usual.
30475 If the value is greater than 100, redisplay will never recenter point,
30476 but will always scroll just enough text to bring point into view, even
30477 if you move far away.
30479 A value of zero means always recenter point if it moves off screen. */);
30480 scroll_conservatively = 0;
30482 DEFVAR_INT ("scroll-margin", scroll_margin,
30483 doc: /* Number of lines of margin at the top and bottom of a window.
30484 Recenter the window whenever point gets within this many lines
30485 of the top or bottom of the window. */);
30486 scroll_margin = 0;
30488 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
30489 doc: /* Pixels per inch value for non-window system displays.
30490 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30491 Vdisplay_pixels_per_inch = make_float (72.0);
30493 #ifdef GLYPH_DEBUG
30494 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
30495 #endif
30497 DEFVAR_LISP ("truncate-partial-width-windows",
30498 Vtruncate_partial_width_windows,
30499 doc: /* Non-nil means truncate lines in windows narrower than the frame.
30500 For an integer value, truncate lines in each window narrower than the
30501 full frame width, provided the window width is less than that integer;
30502 otherwise, respect the value of `truncate-lines'.
30504 For any other non-nil value, truncate lines in all windows that do
30505 not span the full frame width.
30507 A value of nil means to respect the value of `truncate-lines'.
30509 If `word-wrap' is enabled, you might want to reduce this. */);
30510 Vtruncate_partial_width_windows = make_number (50);
30512 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
30513 doc: /* Maximum buffer size for which line number should be displayed.
30514 If the buffer is bigger than this, the line number does not appear
30515 in the mode line. A value of nil means no limit. */);
30516 Vline_number_display_limit = Qnil;
30518 DEFVAR_INT ("line-number-display-limit-width",
30519 line_number_display_limit_width,
30520 doc: /* Maximum line width (in characters) for line number display.
30521 If the average length of the lines near point is bigger than this, then the
30522 line number may be omitted from the mode line. */);
30523 line_number_display_limit_width = 200;
30525 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
30526 doc: /* Non-nil means highlight region even in nonselected windows. */);
30527 highlight_nonselected_windows = 0;
30529 DEFVAR_BOOL ("multiple-frames", multiple_frames,
30530 doc: /* Non-nil if more than one frame is visible on this display.
30531 Minibuffer-only frames don't count, but iconified frames do.
30532 This variable is not guaranteed to be accurate except while processing
30533 `frame-title-format' and `icon-title-format'. */);
30535 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
30536 doc: /* Template for displaying the title bar of visible frames.
30537 \(Assuming the window manager supports this feature.)
30539 This variable has the same structure as `mode-line-format', except that
30540 the %c and %l constructs are ignored. It is used only on frames for
30541 which no explicit name has been set \(see `modify-frame-parameters'). */);
30543 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
30544 doc: /* Template for displaying the title bar of an iconified frame.
30545 \(Assuming the window manager supports this feature.)
30546 This variable has the same structure as `mode-line-format' (which see),
30547 and is used only on frames for which no explicit name has been set
30548 \(see `modify-frame-parameters'). */);
30549 Vicon_title_format
30550 = Vframe_title_format
30551 = listn (CONSTYPE_PURE, 3,
30552 intern_c_string ("multiple-frames"),
30553 build_pure_c_string ("%b"),
30554 listn (CONSTYPE_PURE, 4,
30555 empty_unibyte_string,
30556 intern_c_string ("invocation-name"),
30557 build_pure_c_string ("@"),
30558 intern_c_string ("system-name")));
30560 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
30561 doc: /* Maximum number of lines to keep in the message log buffer.
30562 If nil, disable message logging. If t, log messages but don't truncate
30563 the buffer when it becomes large. */);
30564 Vmessage_log_max = make_number (1000);
30566 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
30567 doc: /* Functions called before redisplay, if window sizes have changed.
30568 The value should be a list of functions that take one argument.
30569 Just before redisplay, for each frame, if any of its windows have changed
30570 size since the last redisplay, or have been split or deleted,
30571 all the functions in the list are called, with the frame as argument. */);
30572 Vwindow_size_change_functions = Qnil;
30574 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
30575 doc: /* List of functions to call before redisplaying a window with scrolling.
30576 Each function is called with two arguments, the window and its new
30577 display-start position. Note that these functions are also called by
30578 `set-window-buffer'. Also note that the value of `window-end' is not
30579 valid when these functions are called.
30581 Warning: Do not use this feature to alter the way the window
30582 is scrolled. It is not designed for that, and such use probably won't
30583 work. */);
30584 Vwindow_scroll_functions = Qnil;
30586 DEFVAR_LISP ("window-text-change-functions",
30587 Vwindow_text_change_functions,
30588 doc: /* Functions to call in redisplay when text in the window might change. */);
30589 Vwindow_text_change_functions = Qnil;
30591 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
30592 doc: /* Functions called when redisplay of a window reaches the end trigger.
30593 Each function is called with two arguments, the window and the end trigger value.
30594 See `set-window-redisplay-end-trigger'. */);
30595 Vredisplay_end_trigger_functions = Qnil;
30597 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
30598 doc: /* Non-nil means autoselect window with mouse pointer.
30599 If nil, do not autoselect windows.
30600 A positive number means delay autoselection by that many seconds: a
30601 window is autoselected only after the mouse has remained in that
30602 window for the duration of the delay.
30603 A negative number has a similar effect, but causes windows to be
30604 autoselected only after the mouse has stopped moving. \(Because of
30605 the way Emacs compares mouse events, you will occasionally wait twice
30606 that time before the window gets selected.\)
30607 Any other value means to autoselect window instantaneously when the
30608 mouse pointer enters it.
30610 Autoselection selects the minibuffer only if it is active, and never
30611 unselects the minibuffer if it is active.
30613 When customizing this variable make sure that the actual value of
30614 `focus-follows-mouse' matches the behavior of your window manager. */);
30615 Vmouse_autoselect_window = Qnil;
30617 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
30618 doc: /* Non-nil means automatically resize tool-bars.
30619 This dynamically changes the tool-bar's height to the minimum height
30620 that is needed to make all tool-bar items visible.
30621 If value is `grow-only', the tool-bar's height is only increased
30622 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30623 Vauto_resize_tool_bars = Qt;
30625 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
30626 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30627 auto_raise_tool_bar_buttons_p = 1;
30629 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
30630 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30631 make_cursor_line_fully_visible_p = 1;
30633 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
30634 doc: /* Border below tool-bar in pixels.
30635 If an integer, use it as the height of the border.
30636 If it is one of `internal-border-width' or `border-width', use the
30637 value of the corresponding frame parameter.
30638 Otherwise, no border is added below the tool-bar. */);
30639 Vtool_bar_border = Qinternal_border_width;
30641 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
30642 doc: /* Margin around tool-bar buttons in pixels.
30643 If an integer, use that for both horizontal and vertical margins.
30644 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30645 HORZ specifying the horizontal margin, and VERT specifying the
30646 vertical margin. */);
30647 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
30649 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
30650 doc: /* Relief thickness of tool-bar buttons. */);
30651 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
30653 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
30654 doc: /* Tool bar style to use.
30655 It can be one of
30656 image - show images only
30657 text - show text only
30658 both - show both, text below image
30659 both-horiz - show text to the right of the image
30660 text-image-horiz - show text to the left of the image
30661 any other - use system default or image if no system default.
30663 This variable only affects the GTK+ toolkit version of Emacs. */);
30664 Vtool_bar_style = Qnil;
30666 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
30667 doc: /* Maximum number of characters a label can have to be shown.
30668 The tool bar style must also show labels for this to have any effect, see
30669 `tool-bar-style'. */);
30670 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
30672 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
30673 doc: /* List of functions to call to fontify regions of text.
30674 Each function is called with one argument POS. Functions must
30675 fontify a region starting at POS in the current buffer, and give
30676 fontified regions the property `fontified'. */);
30677 Vfontification_functions = Qnil;
30678 Fmake_variable_buffer_local (Qfontification_functions);
30680 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30681 unibyte_display_via_language_environment,
30682 doc: /* Non-nil means display unibyte text according to language environment.
30683 Specifically, this means that raw bytes in the range 160-255 decimal
30684 are displayed by converting them to the equivalent multibyte characters
30685 according to the current language environment. As a result, they are
30686 displayed according to the current fontset.
30688 Note that this variable affects only how these bytes are displayed,
30689 but does not change the fact they are interpreted as raw bytes. */);
30690 unibyte_display_via_language_environment = 0;
30692 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
30693 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30694 If a float, it specifies a fraction of the mini-window frame's height.
30695 If an integer, it specifies a number of lines. */);
30696 Vmax_mini_window_height = make_float (0.25);
30698 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
30699 doc: /* How to resize mini-windows (the minibuffer and the echo area).
30700 A value of nil means don't automatically resize mini-windows.
30701 A value of t means resize them to fit the text displayed in them.
30702 A value of `grow-only', the default, means let mini-windows grow only;
30703 they return to their normal size when the minibuffer is closed, or the
30704 echo area becomes empty. */);
30705 Vresize_mini_windows = Qgrow_only;
30707 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
30708 doc: /* Alist specifying how to blink the cursor off.
30709 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30710 `cursor-type' frame-parameter or variable equals ON-STATE,
30711 comparing using `equal', Emacs uses OFF-STATE to specify
30712 how to blink it off. ON-STATE and OFF-STATE are values for
30713 the `cursor-type' frame parameter.
30715 If a frame's ON-STATE has no entry in this list,
30716 the frame's other specifications determine how to blink the cursor off. */);
30717 Vblink_cursor_alist = Qnil;
30719 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
30720 doc: /* Allow or disallow automatic horizontal scrolling of windows.
30721 If non-nil, windows are automatically scrolled horizontally to make
30722 point visible. */);
30723 automatic_hscrolling_p = 1;
30724 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
30726 DEFVAR_INT ("hscroll-margin", hscroll_margin,
30727 doc: /* How many columns away from the window edge point is allowed to get
30728 before automatic hscrolling will horizontally scroll the window. */);
30729 hscroll_margin = 5;
30731 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
30732 doc: /* How many columns to scroll the window when point gets too close to the edge.
30733 When point is less than `hscroll-margin' columns from the window
30734 edge, automatic hscrolling will scroll the window by the amount of columns
30735 determined by this variable. If its value is a positive integer, scroll that
30736 many columns. If it's a positive floating-point number, it specifies the
30737 fraction of the window's width to scroll. If it's nil or zero, point will be
30738 centered horizontally after the scroll. Any other value, including negative
30739 numbers, are treated as if the value were zero.
30741 Automatic hscrolling always moves point outside the scroll margin, so if
30742 point was more than scroll step columns inside the margin, the window will
30743 scroll more than the value given by the scroll step.
30745 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30746 and `scroll-right' overrides this variable's effect. */);
30747 Vhscroll_step = make_number (0);
30749 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
30750 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
30751 Bind this around calls to `message' to let it take effect. */);
30752 message_truncate_lines = 0;
30754 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
30755 doc: /* Normal hook run to update the menu bar definitions.
30756 Redisplay runs this hook before it redisplays the menu bar.
30757 This is used to update menus such as Buffers, whose contents depend on
30758 various data. */);
30759 Vmenu_bar_update_hook = Qnil;
30761 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
30762 doc: /* Frame for which we are updating a menu.
30763 The enable predicate for a menu binding should check this variable. */);
30764 Vmenu_updating_frame = Qnil;
30766 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
30767 doc: /* Non-nil means don't update menu bars. Internal use only. */);
30768 inhibit_menubar_update = 0;
30770 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
30771 doc: /* Prefix prepended to all continuation lines at display time.
30772 The value may be a string, an image, or a stretch-glyph; it is
30773 interpreted in the same way as the value of a `display' text property.
30775 This variable is overridden by any `wrap-prefix' text or overlay
30776 property.
30778 To add a prefix to non-continuation lines, use `line-prefix'. */);
30779 Vwrap_prefix = Qnil;
30780 DEFSYM (Qwrap_prefix, "wrap-prefix");
30781 Fmake_variable_buffer_local (Qwrap_prefix);
30783 DEFVAR_LISP ("line-prefix", Vline_prefix,
30784 doc: /* Prefix prepended to all non-continuation lines at display time.
30785 The value may be a string, an image, or a stretch-glyph; it is
30786 interpreted in the same way as the value of a `display' text property.
30788 This variable is overridden by any `line-prefix' text or overlay
30789 property.
30791 To add a prefix to continuation lines, use `wrap-prefix'. */);
30792 Vline_prefix = Qnil;
30793 DEFSYM (Qline_prefix, "line-prefix");
30794 Fmake_variable_buffer_local (Qline_prefix);
30796 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
30797 doc: /* Non-nil means don't eval Lisp during redisplay. */);
30798 inhibit_eval_during_redisplay = 0;
30800 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
30801 doc: /* Non-nil means don't free realized faces. Internal use only. */);
30802 inhibit_free_realized_faces = 0;
30804 #ifdef GLYPH_DEBUG
30805 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
30806 doc: /* Inhibit try_window_id display optimization. */);
30807 inhibit_try_window_id = 0;
30809 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
30810 doc: /* Inhibit try_window_reusing display optimization. */);
30811 inhibit_try_window_reusing = 0;
30813 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
30814 doc: /* Inhibit try_cursor_movement display optimization. */);
30815 inhibit_try_cursor_movement = 0;
30816 #endif /* GLYPH_DEBUG */
30818 DEFVAR_INT ("overline-margin", overline_margin,
30819 doc: /* Space between overline and text, in pixels.
30820 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30821 margin to the character height. */);
30822 overline_margin = 2;
30824 DEFVAR_INT ("underline-minimum-offset",
30825 underline_minimum_offset,
30826 doc: /* Minimum distance between baseline and underline.
30827 This can improve legibility of underlined text at small font sizes,
30828 particularly when using variable `x-use-underline-position-properties'
30829 with fonts that specify an UNDERLINE_POSITION relatively close to the
30830 baseline. The default value is 1. */);
30831 underline_minimum_offset = 1;
30833 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
30834 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30835 This feature only works when on a window system that can change
30836 cursor shapes. */);
30837 display_hourglass_p = 1;
30839 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
30840 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30841 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
30843 #ifdef HAVE_WINDOW_SYSTEM
30844 hourglass_atimer = NULL;
30845 hourglass_shown_p = 0;
30846 #endif /* HAVE_WINDOW_SYSTEM */
30848 DEFSYM (Qglyphless_char, "glyphless-char");
30849 DEFSYM (Qhex_code, "hex-code");
30850 DEFSYM (Qempty_box, "empty-box");
30851 DEFSYM (Qthin_space, "thin-space");
30852 DEFSYM (Qzero_width, "zero-width");
30854 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
30855 doc: /* Function run just before redisplay.
30856 It is called with one argument, which is the set of windows that are to
30857 be redisplayed. This set can be nil (meaning, only the selected window),
30858 or t (meaning all windows). */);
30859 Vpre_redisplay_function = intern ("ignore");
30861 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
30862 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
30864 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
30865 doc: /* Char-table defining glyphless characters.
30866 Each element, if non-nil, should be one of the following:
30867 an ASCII acronym string: display this string in a box
30868 `hex-code': display the hexadecimal code of a character in a box
30869 `empty-box': display as an empty box
30870 `thin-space': display as 1-pixel width space
30871 `zero-width': don't display
30872 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30873 display method for graphical terminals and text terminals respectively.
30874 GRAPHICAL and TEXT should each have one of the values listed above.
30876 The char-table has one extra slot to control the display of a character for
30877 which no font is found. This slot only takes effect on graphical terminals.
30878 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30879 `thin-space'. The default is `empty-box'.
30881 If a character has a non-nil entry in an active display table, the
30882 display table takes effect; in this case, Emacs does not consult
30883 `glyphless-char-display' at all. */);
30884 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
30885 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
30886 Qempty_box);
30888 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
30889 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
30890 Vdebug_on_message = Qnil;
30892 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
30893 doc: /* */);
30894 Vredisplay__all_windows_cause
30895 = Fmake_vector (make_number (100), make_number (0));
30897 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
30898 doc: /* */);
30899 Vredisplay__mode_lines_cause
30900 = Fmake_vector (make_number (100), make_number (0));
30904 /* Initialize this module when Emacs starts. */
30906 void
30907 init_xdisp (void)
30909 CHARPOS (this_line_start_pos) = 0;
30911 if (!noninteractive)
30913 struct window *m = XWINDOW (minibuf_window);
30914 Lisp_Object frame = m->frame;
30915 struct frame *f = XFRAME (frame);
30916 Lisp_Object root = FRAME_ROOT_WINDOW (f);
30917 struct window *r = XWINDOW (root);
30918 int i;
30920 echo_area_window = minibuf_window;
30922 r->top_line = FRAME_TOP_MARGIN (f);
30923 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
30924 r->total_cols = FRAME_COLS (f);
30925 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
30926 r->total_lines = FRAME_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
30927 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
30929 m->top_line = FRAME_LINES (f) - 1;
30930 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
30931 m->total_cols = FRAME_COLS (f);
30932 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
30933 m->total_lines = 1;
30934 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
30936 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
30937 scratch_glyph_row.glyphs[TEXT_AREA + 1]
30938 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
30940 /* The default ellipsis glyphs `...'. */
30941 for (i = 0; i < 3; ++i)
30942 default_invis_vector[i] = make_number ('.');
30946 /* Allocate the buffer for frame titles.
30947 Also used for `format-mode-line'. */
30948 int size = 100;
30949 mode_line_noprop_buf = xmalloc (size);
30950 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
30951 mode_line_noprop_ptr = mode_line_noprop_buf;
30952 mode_line_target = MODE_LINE_DISPLAY;
30955 help_echo_showing_p = 0;
30958 #ifdef HAVE_WINDOW_SYSTEM
30960 /* Platform-independent portion of hourglass implementation. */
30962 /* Cancel a currently active hourglass timer, and start a new one. */
30963 void
30964 start_hourglass (void)
30966 struct timespec delay;
30968 cancel_hourglass ();
30970 if (INTEGERP (Vhourglass_delay)
30971 && XINT (Vhourglass_delay) > 0)
30972 delay = make_timespec (min (XINT (Vhourglass_delay),
30973 TYPE_MAXIMUM (time_t)),
30975 else if (FLOATP (Vhourglass_delay)
30976 && XFLOAT_DATA (Vhourglass_delay) > 0)
30977 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
30978 else
30979 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
30981 #ifdef HAVE_NTGUI
30983 extern void w32_note_current_window (void);
30984 w32_note_current_window ();
30986 #endif /* HAVE_NTGUI */
30988 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
30989 show_hourglass, NULL);
30993 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30994 shown. */
30995 void
30996 cancel_hourglass (void)
30998 if (hourglass_atimer)
31000 cancel_atimer (hourglass_atimer);
31001 hourglass_atimer = NULL;
31004 if (hourglass_shown_p)
31005 hide_hourglass ();
31008 #endif /* HAVE_WINDOW_SYSTEM */