Fix display of R2L lines in partial-width windows.
[emacs.git] / src / xdisp.c
blob909349b81b39bbf17976e70602bdabae38938fba
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--;
9752 else
9753 RESTORE_IT (it, it, it2data);
9757 /* Return true if IT points into the middle of a display vector. */
9759 bool
9760 in_display_vector_p (struct it *it)
9762 return (it->method == GET_FROM_DISPLAY_VECTOR
9763 && it->current.dpvec_index > 0
9764 && it->dpvec + it->current.dpvec_index != it->dpend);
9767 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size, Swindow_text_pixel_size, 0, 6, 0,
9768 doc: /* Return the size of the text of WINDOW's buffer in pixels.
9769 WINDOW must be a live window and defaults to the selected one. The
9770 return value is a cons of the maximum pixel-width of any text line and
9771 the maximum pixel-height of all text lines.
9773 The optional argument FROM, if non-nil, specifies the first text
9774 position and defaults to the minimum accessible position of the buffer.
9775 If FROM is t, use the minimum accessible position that is not a newline
9776 character. TO, if non-nil, specifies the last text position and
9777 defaults to the maximum accessible position of the buffer. If TO is t,
9778 use the maximum accessible position that is not a newline character.
9780 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9781 width that can be returned. X-LIMIT nil or omitted, means to use the
9782 pixel-width of WINDOW's body; use this if you do not intend to change
9783 the width of WINDOW. Use the maximum width WINDOW may assume if you
9784 intend to change WINDOW's width. In any case, text whose x-coordinate
9785 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9786 can take some time, it's always a good idea to make this argument as
9787 small as possible; in particular, if the buffer contains long lines that
9788 shall be truncated anyway.
9790 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9791 height that can be returned. Text lines whose y-coordinate is beyond
9792 Y-LIMIT are ignored. Since calculating the text height of a large
9793 buffer can take some time, it makes sense to specify this argument if
9794 the size of the buffer is unknown.
9796 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9797 include the height of the mode- or header-line of WINDOW in the return
9798 value. If it is either the symbol `mode-line' or `header-line', include
9799 only the height of that line, if present, in the return value. If t,
9800 include the height of both, if present, in the return value. */)
9801 (Lisp_Object window, Lisp_Object from, Lisp_Object to, Lisp_Object x_limit, Lisp_Object y_limit,
9802 Lisp_Object mode_and_header_line)
9804 struct window *w = decode_live_window (window);
9805 Lisp_Object buf;
9806 struct buffer *b;
9807 struct it it;
9808 struct buffer *old_buffer = NULL;
9809 ptrdiff_t start, end, pos;
9810 struct text_pos startp;
9811 void *itdata = NULL;
9812 int c, max_y = -1, x = 0, y = 0;
9814 buf = w->contents;
9815 CHECK_BUFFER (buf);
9816 b = XBUFFER (buf);
9818 if (b != current_buffer)
9820 old_buffer = current_buffer;
9821 set_buffer_internal (b);
9824 if (NILP (from))
9825 start = BEGV;
9826 else if (EQ (from, Qt))
9828 start = pos = BEGV;
9829 while ((pos++ < ZV) && (c = FETCH_CHAR (pos))
9830 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9831 start = pos;
9832 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9833 start = pos;
9835 else
9837 CHECK_NUMBER_COERCE_MARKER (from);
9838 start = min (max (XINT (from), BEGV), ZV);
9841 if (NILP (to))
9842 end = ZV;
9843 else if (EQ (to, Qt))
9845 end = pos = ZV;
9846 while ((pos-- > BEGV) && (c = FETCH_CHAR (pos))
9847 && (c == ' ' || c == '\t' || c == '\n' || c == '\r'))
9848 end = pos;
9849 while ((pos++ < ZV) && (c = FETCH_CHAR (pos)) && (c == ' ' || c == '\t'))
9850 end = pos;
9852 else
9854 CHECK_NUMBER_COERCE_MARKER (to);
9855 end = max (start, min (XINT (to), ZV));
9858 if (!NILP (y_limit))
9860 CHECK_NUMBER (y_limit);
9861 max_y = min (XINT (y_limit), INT_MAX);
9864 itdata = bidi_shelve_cache ();
9865 SET_TEXT_POS (startp, start, CHAR_TO_BYTE (start));
9866 start_display (&it, w, startp);
9868 if (NILP (x_limit))
9869 x = move_it_to (&it, end, -1, max_y, -1, MOVE_TO_POS | MOVE_TO_Y);
9870 else
9872 CHECK_NUMBER (x_limit);
9873 it.last_visible_x = min (XINT (x_limit), INFINITY);
9874 /* Actually, we never want move_it_to stop at to_x. But to make
9875 sure that move_it_in_display_line_to always moves far enough,
9876 we set it to INT_MAX and specify MOVE_TO_X. */
9877 x = move_it_to (&it, end, INT_MAX, max_y, -1,
9878 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
9881 y = it.current_y + it.max_ascent + it.max_descent;
9883 if (!EQ (mode_and_header_line, Qheader_line)
9884 && !EQ (mode_and_header_line, Qt))
9885 /* Do not count the header-line which was counted automatically by
9886 start_display. */
9887 y = y - WINDOW_HEADER_LINE_HEIGHT (w);
9889 if (EQ (mode_and_header_line, Qmode_line)
9890 || EQ (mode_and_header_line, Qt))
9891 /* Do count the mode-line which is not included automatically by
9892 start_display. */
9893 y = y + WINDOW_MODE_LINE_HEIGHT (w);
9895 bidi_unshelve_cache (itdata, 0);
9897 if (old_buffer)
9898 set_buffer_internal (old_buffer);
9900 return Fcons (make_number (x), make_number (y));
9903 /***********************************************************************
9904 Messages
9905 ***********************************************************************/
9908 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9909 to *Messages*. */
9911 void
9912 add_to_log (const char *format, Lisp_Object arg1, Lisp_Object arg2)
9914 Lisp_Object args[3];
9915 Lisp_Object msg, fmt;
9916 char *buffer;
9917 ptrdiff_t len;
9918 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9919 USE_SAFE_ALLOCA;
9921 fmt = msg = Qnil;
9922 GCPRO4 (fmt, msg, arg1, arg2);
9924 args[0] = fmt = build_string (format);
9925 args[1] = arg1;
9926 args[2] = arg2;
9927 msg = Fformat (3, args);
9929 len = SBYTES (msg) + 1;
9930 buffer = SAFE_ALLOCA (len);
9931 memcpy (buffer, SDATA (msg), len);
9933 message_dolog (buffer, len - 1, 1, 0);
9934 SAFE_FREE ();
9936 UNGCPRO;
9940 /* Output a newline in the *Messages* buffer if "needs" one. */
9942 void
9943 message_log_maybe_newline (void)
9945 if (message_log_need_newline)
9946 message_dolog ("", 0, 1, 0);
9950 /* Add a string M of length NBYTES to the message log, optionally
9951 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9952 true, means interpret the contents of M as multibyte. This
9953 function calls low-level routines in order to bypass text property
9954 hooks, etc. which might not be safe to run.
9956 This may GC (insert may run before/after change hooks),
9957 so the buffer M must NOT point to a Lisp string. */
9959 void
9960 message_dolog (const char *m, ptrdiff_t nbytes, bool nlflag, bool multibyte)
9962 const unsigned char *msg = (const unsigned char *) m;
9964 if (!NILP (Vmemory_full))
9965 return;
9967 if (!NILP (Vmessage_log_max))
9969 struct buffer *oldbuf;
9970 Lisp_Object oldpoint, oldbegv, oldzv;
9971 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9972 ptrdiff_t point_at_end = 0;
9973 ptrdiff_t zv_at_end = 0;
9974 Lisp_Object old_deactivate_mark;
9975 struct gcpro gcpro1;
9977 old_deactivate_mark = Vdeactivate_mark;
9978 oldbuf = current_buffer;
9980 /* Ensure the Messages buffer exists, and switch to it.
9981 If we created it, set the major-mode. */
9983 int newbuffer = 0;
9984 if (NILP (Fget_buffer (Vmessages_buffer_name))) newbuffer = 1;
9986 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name));
9988 if (newbuffer
9989 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9990 call0 (intern ("messages-buffer-mode"));
9993 bset_undo_list (current_buffer, Qt);
9994 bset_cache_long_scans (current_buffer, Qnil);
9996 oldpoint = message_dolog_marker1;
9997 set_marker_restricted_both (oldpoint, Qnil, PT, PT_BYTE);
9998 oldbegv = message_dolog_marker2;
9999 set_marker_restricted_both (oldbegv, Qnil, BEGV, BEGV_BYTE);
10000 oldzv = message_dolog_marker3;
10001 set_marker_restricted_both (oldzv, Qnil, ZV, ZV_BYTE);
10002 GCPRO1 (old_deactivate_mark);
10004 if (PT == Z)
10005 point_at_end = 1;
10006 if (ZV == Z)
10007 zv_at_end = 1;
10009 BEGV = BEG;
10010 BEGV_BYTE = BEG_BYTE;
10011 ZV = Z;
10012 ZV_BYTE = Z_BYTE;
10013 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10015 /* Insert the string--maybe converting multibyte to single byte
10016 or vice versa, so that all the text fits the buffer. */
10017 if (multibyte
10018 && NILP (BVAR (current_buffer, enable_multibyte_characters)))
10020 ptrdiff_t i;
10021 int c, char_bytes;
10022 char work[1];
10024 /* Convert a multibyte string to single-byte
10025 for the *Message* buffer. */
10026 for (i = 0; i < nbytes; i += char_bytes)
10028 c = string_char_and_length (msg + i, &char_bytes);
10029 work[0] = (ASCII_CHAR_P (c)
10031 : multibyte_char_to_unibyte (c));
10032 insert_1_both (work, 1, 1, 1, 0, 0);
10035 else if (! multibyte
10036 && ! NILP (BVAR (current_buffer, enable_multibyte_characters)))
10038 ptrdiff_t i;
10039 int c, char_bytes;
10040 unsigned char str[MAX_MULTIBYTE_LENGTH];
10041 /* Convert a single-byte string to multibyte
10042 for the *Message* buffer. */
10043 for (i = 0; i < nbytes; i++)
10045 c = msg[i];
10046 MAKE_CHAR_MULTIBYTE (c);
10047 char_bytes = CHAR_STRING (c, str);
10048 insert_1_both ((char *) str, 1, char_bytes, 1, 0, 0);
10051 else if (nbytes)
10052 insert_1_both (m, chars_in_text (msg, nbytes), nbytes, 1, 0, 0);
10054 if (nlflag)
10056 ptrdiff_t this_bol, this_bol_byte, prev_bol, prev_bol_byte;
10057 printmax_t dups;
10059 insert_1_both ("\n", 1, 1, 1, 0, 0);
10061 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE, -2, 0);
10062 this_bol = PT;
10063 this_bol_byte = PT_BYTE;
10065 /* See if this line duplicates the previous one.
10066 If so, combine duplicates. */
10067 if (this_bol > BEG)
10069 scan_newline (PT, PT_BYTE, BEG, BEG_BYTE, -2, 0);
10070 prev_bol = PT;
10071 prev_bol_byte = PT_BYTE;
10073 dups = message_log_check_duplicate (prev_bol_byte,
10074 this_bol_byte);
10075 if (dups)
10077 del_range_both (prev_bol, prev_bol_byte,
10078 this_bol, this_bol_byte, 0);
10079 if (dups > 1)
10081 char dupstr[sizeof " [ times]"
10082 + INT_STRLEN_BOUND (printmax_t)];
10084 /* If you change this format, don't forget to also
10085 change message_log_check_duplicate. */
10086 int duplen = sprintf (dupstr, " [%"pMd" times]", dups);
10087 TEMP_SET_PT_BOTH (Z - 1, Z_BYTE - 1);
10088 insert_1_both (dupstr, duplen, duplen, 1, 0, 1);
10093 /* If we have more than the desired maximum number of lines
10094 in the *Messages* buffer now, delete the oldest ones.
10095 This is safe because we don't have undo in this buffer. */
10097 if (NATNUMP (Vmessage_log_max))
10099 scan_newline (Z, Z_BYTE, BEG, BEG_BYTE,
10100 -XFASTINT (Vmessage_log_max) - 1, 0);
10101 del_range_both (BEG, BEG_BYTE, PT, PT_BYTE, 0);
10104 BEGV = marker_position (oldbegv);
10105 BEGV_BYTE = marker_byte_position (oldbegv);
10107 if (zv_at_end)
10109 ZV = Z;
10110 ZV_BYTE = Z_BYTE;
10112 else
10114 ZV = marker_position (oldzv);
10115 ZV_BYTE = marker_byte_position (oldzv);
10118 if (point_at_end)
10119 TEMP_SET_PT_BOTH (Z, Z_BYTE);
10120 else
10121 /* We can't do Fgoto_char (oldpoint) because it will run some
10122 Lisp code. */
10123 TEMP_SET_PT_BOTH (marker_position (oldpoint),
10124 marker_byte_position (oldpoint));
10126 UNGCPRO;
10127 unchain_marker (XMARKER (oldpoint));
10128 unchain_marker (XMARKER (oldbegv));
10129 unchain_marker (XMARKER (oldzv));
10131 /* We called insert_1_both above with its 5th argument (PREPARE)
10132 zero, which prevents insert_1_both from calling
10133 prepare_to_modify_buffer, which in turns prevents us from
10134 incrementing windows_or_buffers_changed even if *Messages* is
10135 shown in some window. So we must manually set
10136 windows_or_buffers_changed here to make up for that. */
10137 windows_or_buffers_changed = old_windows_or_buffers_changed;
10138 bset_redisplay (current_buffer);
10140 set_buffer_internal (oldbuf);
10142 message_log_need_newline = !nlflag;
10143 Vdeactivate_mark = old_deactivate_mark;
10148 /* We are at the end of the buffer after just having inserted a newline.
10149 (Note: We depend on the fact we won't be crossing the gap.)
10150 Check to see if the most recent message looks a lot like the previous one.
10151 Return 0 if different, 1 if the new one should just replace it, or a
10152 value N > 1 if we should also append " [N times]". */
10154 static intmax_t
10155 message_log_check_duplicate (ptrdiff_t prev_bol_byte, ptrdiff_t this_bol_byte)
10157 ptrdiff_t i;
10158 ptrdiff_t len = Z_BYTE - 1 - this_bol_byte;
10159 int seen_dots = 0;
10160 unsigned char *p1 = BUF_BYTE_ADDRESS (current_buffer, prev_bol_byte);
10161 unsigned char *p2 = BUF_BYTE_ADDRESS (current_buffer, this_bol_byte);
10163 for (i = 0; i < len; i++)
10165 if (i >= 3 && p1[i - 3] == '.' && p1[i - 2] == '.' && p1[i - 1] == '.')
10166 seen_dots = 1;
10167 if (p1[i] != p2[i])
10168 return seen_dots;
10170 p1 += len;
10171 if (*p1 == '\n')
10172 return 2;
10173 if (*p1++ == ' ' && *p1++ == '[')
10175 char *pend;
10176 intmax_t n = strtoimax ((char *) p1, &pend, 10);
10177 if (0 < n && n < INTMAX_MAX && strncmp (pend, " times]\n", 8) == 0)
10178 return n + 1;
10180 return 0;
10184 /* Display an echo area message M with a specified length of NBYTES
10185 bytes. The string may include null characters. If M is not a
10186 string, clear out any existing message, and let the mini-buffer
10187 text show through.
10189 This function cancels echoing. */
10191 void
10192 message3 (Lisp_Object m)
10194 struct gcpro gcpro1;
10196 GCPRO1 (m);
10197 clear_message (true, true);
10198 cancel_echoing ();
10200 /* First flush out any partial line written with print. */
10201 message_log_maybe_newline ();
10202 if (STRINGP (m))
10204 ptrdiff_t nbytes = SBYTES (m);
10205 bool multibyte = STRING_MULTIBYTE (m);
10206 USE_SAFE_ALLOCA;
10207 char *buffer = SAFE_ALLOCA (nbytes);
10208 memcpy (buffer, SDATA (m), nbytes);
10209 message_dolog (buffer, nbytes, 1, multibyte);
10210 SAFE_FREE ();
10212 message3_nolog (m);
10214 UNGCPRO;
10218 /* The non-logging version of message3.
10219 This does not cancel echoing, because it is used for echoing.
10220 Perhaps we need to make a separate function for echoing
10221 and make this cancel echoing. */
10223 void
10224 message3_nolog (Lisp_Object m)
10226 struct frame *sf = SELECTED_FRAME ();
10228 if (FRAME_INITIAL_P (sf))
10230 if (noninteractive_need_newline)
10231 putc ('\n', stderr);
10232 noninteractive_need_newline = 0;
10233 if (STRINGP (m))
10235 Lisp_Object s = ENCODE_SYSTEM (m);
10237 fwrite (SDATA (s), SBYTES (s), 1, stderr);
10239 if (cursor_in_echo_area == 0)
10240 fprintf (stderr, "\n");
10241 fflush (stderr);
10243 /* Error messages get reported properly by cmd_error, so this must be just an
10244 informative message; if the frame hasn't really been initialized yet, just
10245 toss it. */
10246 else if (INTERACTIVE && sf->glyphs_initialized_p)
10248 /* Get the frame containing the mini-buffer
10249 that the selected frame is using. */
10250 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
10251 Lisp_Object frame = XWINDOW (mini_window)->frame;
10252 struct frame *f = XFRAME (frame);
10254 if (FRAME_VISIBLE_P (sf) && !FRAME_VISIBLE_P (f))
10255 Fmake_frame_visible (frame);
10257 if (STRINGP (m) && SCHARS (m) > 0)
10259 set_message (m);
10260 if (minibuffer_auto_raise)
10261 Fraise_frame (frame);
10262 /* Assume we are not echoing.
10263 (If we are, echo_now will override this.) */
10264 echo_message_buffer = Qnil;
10266 else
10267 clear_message (true, true);
10269 do_pending_window_change (0);
10270 echo_area_display (1);
10271 do_pending_window_change (0);
10272 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
10273 (*FRAME_TERMINAL (f)->frame_up_to_date_hook) (f);
10278 /* Display a null-terminated echo area message M. If M is 0, clear
10279 out any existing message, and let the mini-buffer text show through.
10281 The buffer M must continue to exist until after the echo area gets
10282 cleared or some other message gets displayed there. Do not pass
10283 text that is stored in a Lisp string. Do not pass text in a buffer
10284 that was alloca'd. */
10286 void
10287 message1 (const char *m)
10289 message3 (m ? build_unibyte_string (m) : Qnil);
10293 /* The non-logging counterpart of message1. */
10295 void
10296 message1_nolog (const char *m)
10298 message3_nolog (m ? build_unibyte_string (m) : Qnil);
10301 /* Display a message M which contains a single %s
10302 which gets replaced with STRING. */
10304 void
10305 message_with_string (const char *m, Lisp_Object string, int log)
10307 CHECK_STRING (string);
10309 if (noninteractive)
10311 if (m)
10313 /* ENCODE_SYSTEM below can GC and/or relocate the Lisp
10314 String whose data pointer might be passed to us in M. So
10315 we use a local copy. */
10316 char *fmt = xstrdup (m);
10318 if (noninteractive_need_newline)
10319 putc ('\n', stderr);
10320 noninteractive_need_newline = 0;
10321 fprintf (stderr, fmt, SDATA (ENCODE_SYSTEM (string)));
10322 if (!cursor_in_echo_area)
10323 fprintf (stderr, "\n");
10324 fflush (stderr);
10325 xfree (fmt);
10328 else if (INTERACTIVE)
10330 /* The frame whose minibuffer we're going to display the message on.
10331 It may be larger than the selected frame, so we need
10332 to use its buffer, not the selected frame's buffer. */
10333 Lisp_Object mini_window;
10334 struct frame *f, *sf = SELECTED_FRAME ();
10336 /* Get the frame containing the minibuffer
10337 that the selected frame is using. */
10338 mini_window = FRAME_MINIBUF_WINDOW (sf);
10339 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10341 /* Error messages get reported properly by cmd_error, so this must be
10342 just an informative message; if the frame hasn't really been
10343 initialized yet, just toss it. */
10344 if (f->glyphs_initialized_p)
10346 Lisp_Object args[2], msg;
10347 struct gcpro gcpro1, gcpro2;
10349 args[0] = build_string (m);
10350 args[1] = msg = string;
10351 GCPRO2 (args[0], msg);
10352 gcpro1.nvars = 2;
10354 msg = Fformat (2, args);
10356 if (log)
10357 message3 (msg);
10358 else
10359 message3_nolog (msg);
10361 UNGCPRO;
10363 /* Print should start at the beginning of the message
10364 buffer next time. */
10365 message_buf_print = 0;
10371 /* Dump an informative message to the minibuf. If M is 0, clear out
10372 any existing message, and let the mini-buffer text show through. */
10374 static void
10375 vmessage (const char *m, va_list ap)
10377 if (noninteractive)
10379 if (m)
10381 if (noninteractive_need_newline)
10382 putc ('\n', stderr);
10383 noninteractive_need_newline = 0;
10384 vfprintf (stderr, m, ap);
10385 if (cursor_in_echo_area == 0)
10386 fprintf (stderr, "\n");
10387 fflush (stderr);
10390 else if (INTERACTIVE)
10392 /* The frame whose mini-buffer we're going to display the message
10393 on. It may be larger than the selected frame, so we need to
10394 use its buffer, not the selected frame's buffer. */
10395 Lisp_Object mini_window;
10396 struct frame *f, *sf = SELECTED_FRAME ();
10398 /* Get the frame containing the mini-buffer
10399 that the selected frame is using. */
10400 mini_window = FRAME_MINIBUF_WINDOW (sf);
10401 f = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
10403 /* Error messages get reported properly by cmd_error, so this must be
10404 just an informative message; if the frame hasn't really been
10405 initialized yet, just toss it. */
10406 if (f->glyphs_initialized_p)
10408 if (m)
10410 ptrdiff_t len;
10411 ptrdiff_t maxsize = FRAME_MESSAGE_BUF_SIZE (f);
10412 char *message_buf = alloca (maxsize + 1);
10414 len = doprnt (message_buf, maxsize, m, 0, ap);
10416 message3 (make_string (message_buf, len));
10418 else
10419 message1 (0);
10421 /* Print should start at the beginning of the message
10422 buffer next time. */
10423 message_buf_print = 0;
10428 void
10429 message (const char *m, ...)
10431 va_list ap;
10432 va_start (ap, m);
10433 vmessage (m, ap);
10434 va_end (ap);
10438 #if 0
10439 /* The non-logging version of message. */
10441 void
10442 message_nolog (const char *m, ...)
10444 Lisp_Object old_log_max;
10445 va_list ap;
10446 va_start (ap, m);
10447 old_log_max = Vmessage_log_max;
10448 Vmessage_log_max = Qnil;
10449 vmessage (m, ap);
10450 Vmessage_log_max = old_log_max;
10451 va_end (ap);
10453 #endif
10456 /* Display the current message in the current mini-buffer. This is
10457 only called from error handlers in process.c, and is not time
10458 critical. */
10460 void
10461 update_echo_area (void)
10463 if (!NILP (echo_area_buffer[0]))
10465 Lisp_Object string;
10466 string = Fcurrent_message ();
10467 message3 (string);
10472 /* Make sure echo area buffers in `echo_buffers' are live.
10473 If they aren't, make new ones. */
10475 static void
10476 ensure_echo_area_buffers (void)
10478 int i;
10480 for (i = 0; i < 2; ++i)
10481 if (!BUFFERP (echo_buffer[i])
10482 || !BUFFER_LIVE_P (XBUFFER (echo_buffer[i])))
10484 char name[30];
10485 Lisp_Object old_buffer;
10486 int j;
10488 old_buffer = echo_buffer[i];
10489 echo_buffer[i] = Fget_buffer_create
10490 (make_formatted_string (name, " *Echo Area %d*", i));
10491 bset_truncate_lines (XBUFFER (echo_buffer[i]), Qnil);
10492 /* to force word wrap in echo area -
10493 it was decided to postpone this*/
10494 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10496 for (j = 0; j < 2; ++j)
10497 if (EQ (old_buffer, echo_area_buffer[j]))
10498 echo_area_buffer[j] = echo_buffer[i];
10503 /* Call FN with args A1..A2 with either the current or last displayed
10504 echo_area_buffer as current buffer.
10506 WHICH zero means use the current message buffer
10507 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10508 from echo_buffer[] and clear it.
10510 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10511 suitable buffer from echo_buffer[] and clear it.
10513 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10514 that the current message becomes the last displayed one, make
10515 choose a suitable buffer for echo_area_buffer[0], and clear it.
10517 Value is what FN returns. */
10519 static int
10520 with_echo_area_buffer (struct window *w, int which,
10521 int (*fn) (ptrdiff_t, Lisp_Object),
10522 ptrdiff_t a1, Lisp_Object a2)
10524 Lisp_Object buffer;
10525 int this_one, the_other, clear_buffer_p, rc;
10526 ptrdiff_t count = SPECPDL_INDEX ();
10528 /* If buffers aren't live, make new ones. */
10529 ensure_echo_area_buffers ();
10531 clear_buffer_p = 0;
10533 if (which == 0)
10534 this_one = 0, the_other = 1;
10535 else if (which > 0)
10536 this_one = 1, the_other = 0;
10537 else
10539 this_one = 0, the_other = 1;
10540 clear_buffer_p = true;
10542 /* We need a fresh one in case the current echo buffer equals
10543 the one containing the last displayed echo area message. */
10544 if (!NILP (echo_area_buffer[this_one])
10545 && EQ (echo_area_buffer[this_one], echo_area_buffer[the_other]))
10546 echo_area_buffer[this_one] = Qnil;
10549 /* Choose a suitable buffer from echo_buffer[] is we don't
10550 have one. */
10551 if (NILP (echo_area_buffer[this_one]))
10553 echo_area_buffer[this_one]
10554 = (EQ (echo_area_buffer[the_other], echo_buffer[this_one])
10555 ? echo_buffer[the_other]
10556 : echo_buffer[this_one]);
10557 clear_buffer_p = true;
10560 buffer = echo_area_buffer[this_one];
10562 /* Don't get confused by reusing the buffer used for echoing
10563 for a different purpose. */
10564 if (echo_kboard == NULL && EQ (buffer, echo_message_buffer))
10565 cancel_echoing ();
10567 record_unwind_protect (unwind_with_echo_area_buffer,
10568 with_echo_area_buffer_unwind_data (w));
10570 /* Make the echo area buffer current. Note that for display
10571 purposes, it is not necessary that the displayed window's buffer
10572 == current_buffer, except for text property lookup. So, let's
10573 only set that buffer temporarily here without doing a full
10574 Fset_window_buffer. We must also change w->pointm, though,
10575 because otherwise an assertions in unshow_buffer fails, and Emacs
10576 aborts. */
10577 set_buffer_internal_1 (XBUFFER (buffer));
10578 if (w)
10580 wset_buffer (w, buffer);
10581 set_marker_both (w->pointm, buffer, BEG, BEG_BYTE);
10584 bset_undo_list (current_buffer, Qt);
10585 bset_read_only (current_buffer, Qnil);
10586 specbind (Qinhibit_read_only, Qt);
10587 specbind (Qinhibit_modification_hooks, Qt);
10589 if (clear_buffer_p && Z > BEG)
10590 del_range (BEG, Z);
10592 eassert (BEGV >= BEG);
10593 eassert (ZV <= Z && ZV >= BEGV);
10595 rc = fn (a1, a2);
10597 eassert (BEGV >= BEG);
10598 eassert (ZV <= Z && ZV >= BEGV);
10600 unbind_to (count, Qnil);
10601 return rc;
10605 /* Save state that should be preserved around the call to the function
10606 FN called in with_echo_area_buffer. */
10608 static Lisp_Object
10609 with_echo_area_buffer_unwind_data (struct window *w)
10611 int i = 0;
10612 Lisp_Object vector, tmp;
10614 /* Reduce consing by keeping one vector in
10615 Vwith_echo_area_save_vector. */
10616 vector = Vwith_echo_area_save_vector;
10617 Vwith_echo_area_save_vector = Qnil;
10619 if (NILP (vector))
10620 vector = Fmake_vector (make_number (9), Qnil);
10622 XSETBUFFER (tmp, current_buffer); ASET (vector, i, tmp); ++i;
10623 ASET (vector, i, Vdeactivate_mark); ++i;
10624 ASET (vector, i, make_number (windows_or_buffers_changed)); ++i;
10626 if (w)
10628 XSETWINDOW (tmp, w); ASET (vector, i, tmp); ++i;
10629 ASET (vector, i, w->contents); ++i;
10630 ASET (vector, i, make_number (marker_position (w->pointm))); ++i;
10631 ASET (vector, i, make_number (marker_byte_position (w->pointm))); ++i;
10632 ASET (vector, i, make_number (marker_position (w->start))); ++i;
10633 ASET (vector, i, make_number (marker_byte_position (w->start))); ++i;
10635 else
10637 int end = i + 6;
10638 for (; i < end; ++i)
10639 ASET (vector, i, Qnil);
10642 eassert (i == ASIZE (vector));
10643 return vector;
10647 /* Restore global state from VECTOR which was created by
10648 with_echo_area_buffer_unwind_data. */
10650 static void
10651 unwind_with_echo_area_buffer (Lisp_Object vector)
10653 set_buffer_internal_1 (XBUFFER (AREF (vector, 0)));
10654 Vdeactivate_mark = AREF (vector, 1);
10655 windows_or_buffers_changed = XFASTINT (AREF (vector, 2));
10657 if (WINDOWP (AREF (vector, 3)))
10659 struct window *w;
10660 Lisp_Object buffer;
10662 w = XWINDOW (AREF (vector, 3));
10663 buffer = AREF (vector, 4);
10665 wset_buffer (w, buffer);
10666 set_marker_both (w->pointm, buffer,
10667 XFASTINT (AREF (vector, 5)),
10668 XFASTINT (AREF (vector, 6)));
10669 set_marker_both (w->start, buffer,
10670 XFASTINT (AREF (vector, 7)),
10671 XFASTINT (AREF (vector, 8)));
10674 Vwith_echo_area_save_vector = vector;
10678 /* Set up the echo area for use by print functions. MULTIBYTE_P
10679 non-zero means we will print multibyte. */
10681 void
10682 setup_echo_area_for_printing (int multibyte_p)
10684 /* If we can't find an echo area any more, exit. */
10685 if (! FRAME_LIVE_P (XFRAME (selected_frame)))
10686 Fkill_emacs (Qnil);
10688 ensure_echo_area_buffers ();
10690 if (!message_buf_print)
10692 /* A message has been output since the last time we printed.
10693 Choose a fresh echo area buffer. */
10694 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10695 echo_area_buffer[0] = echo_buffer[1];
10696 else
10697 echo_area_buffer[0] = echo_buffer[0];
10699 /* Switch to that buffer and clear it. */
10700 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10701 bset_truncate_lines (current_buffer, Qnil);
10703 if (Z > BEG)
10705 ptrdiff_t count = SPECPDL_INDEX ();
10706 specbind (Qinhibit_read_only, Qt);
10707 /* Note that undo recording is always disabled. */
10708 del_range (BEG, Z);
10709 unbind_to (count, Qnil);
10711 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
10713 /* Set up the buffer for the multibyteness we need. */
10714 if (multibyte_p
10715 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
10716 Fset_buffer_multibyte (multibyte_p ? Qt : Qnil);
10718 /* Raise the frame containing the echo area. */
10719 if (minibuffer_auto_raise)
10721 struct frame *sf = SELECTED_FRAME ();
10722 Lisp_Object mini_window;
10723 mini_window = FRAME_MINIBUF_WINDOW (sf);
10724 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window)));
10727 message_log_maybe_newline ();
10728 message_buf_print = 1;
10730 else
10732 if (NILP (echo_area_buffer[0]))
10734 if (EQ (echo_area_buffer[1], echo_buffer[0]))
10735 echo_area_buffer[0] = echo_buffer[1];
10736 else
10737 echo_area_buffer[0] = echo_buffer[0];
10740 if (current_buffer != XBUFFER (echo_area_buffer[0]))
10742 /* Someone switched buffers between print requests. */
10743 set_buffer_internal (XBUFFER (echo_area_buffer[0]));
10744 bset_truncate_lines (current_buffer, Qnil);
10750 /* Display an echo area message in window W. Value is non-zero if W's
10751 height is changed. If display_last_displayed_message_p is
10752 non-zero, display the message that was last displayed, otherwise
10753 display the current message. */
10755 static int
10756 display_echo_area (struct window *w)
10758 int i, no_message_p, window_height_changed_p;
10760 /* Temporarily disable garbage collections while displaying the echo
10761 area. This is done because a GC can print a message itself.
10762 That message would modify the echo area buffer's contents while a
10763 redisplay of the buffer is going on, and seriously confuse
10764 redisplay. */
10765 ptrdiff_t count = inhibit_garbage_collection ();
10767 /* If there is no message, we must call display_echo_area_1
10768 nevertheless because it resizes the window. But we will have to
10769 reset the echo_area_buffer in question to nil at the end because
10770 with_echo_area_buffer will sets it to an empty buffer. */
10771 i = display_last_displayed_message_p ? 1 : 0;
10772 no_message_p = NILP (echo_area_buffer[i]);
10774 window_height_changed_p
10775 = with_echo_area_buffer (w, display_last_displayed_message_p,
10776 display_echo_area_1,
10777 (intptr_t) w, Qnil);
10779 if (no_message_p)
10780 echo_area_buffer[i] = Qnil;
10782 unbind_to (count, Qnil);
10783 return window_height_changed_p;
10787 /* Helper for display_echo_area. Display the current buffer which
10788 contains the current echo area message in window W, a mini-window,
10789 a pointer to which is passed in A1. A2..A4 are currently not used.
10790 Change the height of W so that all of the message is displayed.
10791 Value is non-zero if height of W was changed. */
10793 static int
10794 display_echo_area_1 (ptrdiff_t a1, Lisp_Object a2)
10796 intptr_t i1 = a1;
10797 struct window *w = (struct window *) i1;
10798 Lisp_Object window;
10799 struct text_pos start;
10800 int window_height_changed_p = 0;
10802 /* Do this before displaying, so that we have a large enough glyph
10803 matrix for the display. If we can't get enough space for the
10804 whole text, display the last N lines. That works by setting w->start. */
10805 window_height_changed_p = resize_mini_window (w, 0);
10807 /* Use the starting position chosen by resize_mini_window. */
10808 SET_TEXT_POS_FROM_MARKER (start, w->start);
10810 /* Display. */
10811 clear_glyph_matrix (w->desired_matrix);
10812 XSETWINDOW (window, w);
10813 try_window (window, start, 0);
10815 return window_height_changed_p;
10819 /* Resize the echo area window to exactly the size needed for the
10820 currently displayed message, if there is one. If a mini-buffer
10821 is active, don't shrink it. */
10823 void
10824 resize_echo_area_exactly (void)
10826 if (BUFFERP (echo_area_buffer[0])
10827 && WINDOWP (echo_area_window))
10829 struct window *w = XWINDOW (echo_area_window);
10830 Lisp_Object resize_exactly = (minibuf_level == 0 ? Qt : Qnil);
10831 int resized_p = with_echo_area_buffer (w, 0, resize_mini_window_1,
10832 (intptr_t) w, resize_exactly);
10833 if (resized_p)
10835 windows_or_buffers_changed = 42;
10836 update_mode_lines = 30;
10837 redisplay_internal ();
10843 /* Callback function for with_echo_area_buffer, when used from
10844 resize_echo_area_exactly. A1 contains a pointer to the window to
10845 resize, EXACTLY non-nil means resize the mini-window exactly to the
10846 size of the text displayed. A3 and A4 are not used. Value is what
10847 resize_mini_window returns. */
10849 static int
10850 resize_mini_window_1 (ptrdiff_t a1, Lisp_Object exactly)
10852 intptr_t i1 = a1;
10853 return resize_mini_window ((struct window *) i1, !NILP (exactly));
10857 /* Resize mini-window W to fit the size of its contents. EXACT_P
10858 means size the window exactly to the size needed. Otherwise, it's
10859 only enlarged until W's buffer is empty.
10861 Set W->start to the right place to begin display. If the whole
10862 contents fit, start at the beginning. Otherwise, start so as
10863 to make the end of the contents appear. This is particularly
10864 important for y-or-n-p, but seems desirable generally.
10866 Value is non-zero if the window height has been changed. */
10869 resize_mini_window (struct window *w, int exact_p)
10871 struct frame *f = XFRAME (w->frame);
10872 int window_height_changed_p = 0;
10874 eassert (MINI_WINDOW_P (w));
10876 /* By default, start display at the beginning. */
10877 set_marker_both (w->start, w->contents,
10878 BUF_BEGV (XBUFFER (w->contents)),
10879 BUF_BEGV_BYTE (XBUFFER (w->contents)));
10881 /* Don't resize windows while redisplaying a window; it would
10882 confuse redisplay functions when the size of the window they are
10883 displaying changes from under them. Such a resizing can happen,
10884 for instance, when which-func prints a long message while
10885 we are running fontification-functions. We're running these
10886 functions with safe_call which binds inhibit-redisplay to t. */
10887 if (!NILP (Vinhibit_redisplay))
10888 return 0;
10890 /* Nil means don't try to resize. */
10891 if (NILP (Vresize_mini_windows)
10892 || (FRAME_X_P (f) && FRAME_X_OUTPUT (f) == NULL))
10893 return 0;
10895 if (!FRAME_MINIBUF_ONLY_P (f))
10897 struct it it;
10898 int total_height = (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)))
10899 + WINDOW_PIXEL_HEIGHT (w));
10900 int unit = FRAME_LINE_HEIGHT (f);
10901 int height, max_height;
10902 struct text_pos start;
10903 struct buffer *old_current_buffer = NULL;
10905 if (current_buffer != XBUFFER (w->contents))
10907 old_current_buffer = current_buffer;
10908 set_buffer_internal (XBUFFER (w->contents));
10911 init_iterator (&it, w, BEGV, BEGV_BYTE, NULL, DEFAULT_FACE_ID);
10913 /* Compute the max. number of lines specified by the user. */
10914 if (FLOATP (Vmax_mini_window_height))
10915 max_height = XFLOATINT (Vmax_mini_window_height) * total_height;
10916 else if (INTEGERP (Vmax_mini_window_height))
10917 max_height = XINT (Vmax_mini_window_height) * unit;
10918 else
10919 max_height = total_height / 4;
10921 /* Correct that max. height if it's bogus. */
10922 max_height = clip_to_bounds (unit, max_height, total_height);
10924 /* Find out the height of the text in the window. */
10925 if (it.line_wrap == TRUNCATE)
10926 height = unit;
10927 else
10929 last_height = 0;
10930 move_it_to (&it, ZV, -1, -1, -1, MOVE_TO_POS);
10931 if (it.max_ascent == 0 && it.max_descent == 0)
10932 height = it.current_y + last_height;
10933 else
10934 height = it.current_y + it.max_ascent + it.max_descent;
10935 height -= min (it.extra_line_spacing, it.max_extra_line_spacing);
10938 /* Compute a suitable window start. */
10939 if (height > max_height)
10941 height = (max_height / unit) * unit;
10942 init_iterator (&it, w, ZV, ZV_BYTE, NULL, DEFAULT_FACE_ID);
10943 move_it_vertically_backward (&it, height - unit);
10944 start = it.current.pos;
10946 else
10947 SET_TEXT_POS (start, BEGV, BEGV_BYTE);
10948 SET_MARKER_FROM_TEXT_POS (w->start, start);
10950 if (EQ (Vresize_mini_windows, Qgrow_only))
10952 /* Let it grow only, until we display an empty message, in which
10953 case the window shrinks again. */
10954 if (height > WINDOW_PIXEL_HEIGHT (w))
10956 int old_height = WINDOW_PIXEL_HEIGHT (w);
10958 FRAME_WINDOWS_FROZEN (f) = 1;
10959 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10960 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10962 else if (height < WINDOW_PIXEL_HEIGHT (w)
10963 && (exact_p || BEGV == ZV))
10965 int old_height = WINDOW_PIXEL_HEIGHT (w);
10967 FRAME_WINDOWS_FROZEN (f) = 0;
10968 shrink_mini_window (w, 1);
10969 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10972 else
10974 /* Always resize to exact size needed. */
10975 if (height > WINDOW_PIXEL_HEIGHT (w))
10977 int old_height = WINDOW_PIXEL_HEIGHT (w);
10979 FRAME_WINDOWS_FROZEN (f) = 1;
10980 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10981 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
10983 else if (height < WINDOW_PIXEL_HEIGHT (w))
10985 int old_height = WINDOW_PIXEL_HEIGHT (w);
10987 FRAME_WINDOWS_FROZEN (f) = 0;
10988 shrink_mini_window (w, 1);
10990 if (height)
10992 FRAME_WINDOWS_FROZEN (f) = 1;
10993 grow_mini_window (w, height - WINDOW_PIXEL_HEIGHT (w), 1);
10996 window_height_changed_p = WINDOW_PIXEL_HEIGHT (w) != old_height;
11000 if (old_current_buffer)
11001 set_buffer_internal (old_current_buffer);
11004 return window_height_changed_p;
11008 /* Value is the current message, a string, or nil if there is no
11009 current message. */
11011 Lisp_Object
11012 current_message (void)
11014 Lisp_Object msg;
11016 if (!BUFFERP (echo_area_buffer[0]))
11017 msg = Qnil;
11018 else
11020 with_echo_area_buffer (0, 0, current_message_1,
11021 (intptr_t) &msg, Qnil);
11022 if (NILP (msg))
11023 echo_area_buffer[0] = Qnil;
11026 return msg;
11030 static int
11031 current_message_1 (ptrdiff_t a1, Lisp_Object a2)
11033 intptr_t i1 = a1;
11034 Lisp_Object *msg = (Lisp_Object *) i1;
11036 if (Z > BEG)
11037 *msg = make_buffer_string (BEG, Z, 1);
11038 else
11039 *msg = Qnil;
11040 return 0;
11044 /* Push the current message on Vmessage_stack for later restoration
11045 by restore_message. Value is non-zero if the current message isn't
11046 empty. This is a relatively infrequent operation, so it's not
11047 worth optimizing. */
11049 bool
11050 push_message (void)
11052 Lisp_Object msg = current_message ();
11053 Vmessage_stack = Fcons (msg, Vmessage_stack);
11054 return STRINGP (msg);
11058 /* Restore message display from the top of Vmessage_stack. */
11060 void
11061 restore_message (void)
11063 eassert (CONSP (Vmessage_stack));
11064 message3_nolog (XCAR (Vmessage_stack));
11068 /* Handler for unwind-protect calling pop_message. */
11070 void
11071 pop_message_unwind (void)
11073 /* Pop the top-most entry off Vmessage_stack. */
11074 eassert (CONSP (Vmessage_stack));
11075 Vmessage_stack = XCDR (Vmessage_stack);
11079 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11080 exits. If the stack is not empty, we have a missing pop_message
11081 somewhere. */
11083 void
11084 check_message_stack (void)
11086 if (!NILP (Vmessage_stack))
11087 emacs_abort ();
11091 /* Truncate to NCHARS what will be displayed in the echo area the next
11092 time we display it---but don't redisplay it now. */
11094 void
11095 truncate_echo_area (ptrdiff_t nchars)
11097 if (nchars == 0)
11098 echo_area_buffer[0] = Qnil;
11099 else if (!noninteractive
11100 && INTERACTIVE
11101 && !NILP (echo_area_buffer[0]))
11103 struct frame *sf = SELECTED_FRAME ();
11104 /* Error messages get reported properly by cmd_error, so this must be
11105 just an informative message; if the frame hasn't really been
11106 initialized yet, just toss it. */
11107 if (sf->glyphs_initialized_p)
11108 with_echo_area_buffer (0, 0, truncate_message_1, nchars, Qnil);
11113 /* Helper function for truncate_echo_area. Truncate the current
11114 message to at most NCHARS characters. */
11116 static int
11117 truncate_message_1 (ptrdiff_t nchars, Lisp_Object a2)
11119 if (BEG + nchars < Z)
11120 del_range (BEG + nchars, Z);
11121 if (Z == BEG)
11122 echo_area_buffer[0] = Qnil;
11123 return 0;
11126 /* Set the current message to STRING. */
11128 static void
11129 set_message (Lisp_Object string)
11131 eassert (STRINGP (string));
11133 message_enable_multibyte = STRING_MULTIBYTE (string);
11135 with_echo_area_buffer (0, -1, set_message_1, 0, string);
11136 message_buf_print = 0;
11137 help_echo_showing_p = 0;
11139 if (STRINGP (Vdebug_on_message)
11140 && STRINGP (string)
11141 && fast_string_match (Vdebug_on_message, string) >= 0)
11142 call_debugger (list2 (Qerror, string));
11146 /* Helper function for set_message. First argument is ignored and second
11147 argument has the same meaning as for set_message.
11148 This function is called with the echo area buffer being current. */
11150 static int
11151 set_message_1 (ptrdiff_t a1, Lisp_Object string)
11153 eassert (STRINGP (string));
11155 /* Change multibyteness of the echo buffer appropriately. */
11156 if (message_enable_multibyte
11157 != !NILP (BVAR (current_buffer, enable_multibyte_characters)))
11158 Fset_buffer_multibyte (message_enable_multibyte ? Qt : Qnil);
11160 bset_truncate_lines (current_buffer, message_truncate_lines ? Qt : Qnil);
11161 if (!NILP (BVAR (current_buffer, bidi_display_reordering)))
11162 bset_bidi_paragraph_direction (current_buffer, Qleft_to_right);
11164 /* Insert new message at BEG. */
11165 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
11167 /* This function takes care of single/multibyte conversion.
11168 We just have to ensure that the echo area buffer has the right
11169 setting of enable_multibyte_characters. */
11170 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 1);
11172 return 0;
11176 /* Clear messages. CURRENT_P non-zero means clear the current
11177 message. LAST_DISPLAYED_P non-zero means clear the message
11178 last displayed. */
11180 void
11181 clear_message (bool current_p, bool last_displayed_p)
11183 if (current_p)
11185 echo_area_buffer[0] = Qnil;
11186 message_cleared_p = true;
11189 if (last_displayed_p)
11190 echo_area_buffer[1] = Qnil;
11192 message_buf_print = 0;
11195 /* Clear garbaged frames.
11197 This function is used where the old redisplay called
11198 redraw_garbaged_frames which in turn called redraw_frame which in
11199 turn called clear_frame. The call to clear_frame was a source of
11200 flickering. I believe a clear_frame is not necessary. It should
11201 suffice in the new redisplay to invalidate all current matrices,
11202 and ensure a complete redisplay of all windows. */
11204 static void
11205 clear_garbaged_frames (void)
11207 if (frame_garbaged)
11209 Lisp_Object tail, frame;
11211 FOR_EACH_FRAME (tail, frame)
11213 struct frame *f = XFRAME (frame);
11215 if (FRAME_VISIBLE_P (f) && FRAME_GARBAGED_P (f))
11217 if (f->resized_p)
11218 redraw_frame (f);
11219 else
11220 clear_current_matrices (f);
11221 fset_redisplay (f);
11222 f->garbaged = false;
11223 f->resized_p = false;
11227 frame_garbaged = false;
11232 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11233 is non-zero update selected_frame. Value is non-zero if the
11234 mini-windows height has been changed. */
11236 static int
11237 echo_area_display (int update_frame_p)
11239 Lisp_Object mini_window;
11240 struct window *w;
11241 struct frame *f;
11242 int window_height_changed_p = 0;
11243 struct frame *sf = SELECTED_FRAME ();
11245 mini_window = FRAME_MINIBUF_WINDOW (sf);
11246 w = XWINDOW (mini_window);
11247 f = XFRAME (WINDOW_FRAME (w));
11249 /* Don't display if frame is invisible or not yet initialized. */
11250 if (!FRAME_VISIBLE_P (f) || !f->glyphs_initialized_p)
11251 return 0;
11253 #ifdef HAVE_WINDOW_SYSTEM
11254 /* When Emacs starts, selected_frame may be the initial terminal
11255 frame. If we let this through, a message would be displayed on
11256 the terminal. */
11257 if (FRAME_INITIAL_P (XFRAME (selected_frame)))
11258 return 0;
11259 #endif /* HAVE_WINDOW_SYSTEM */
11261 /* Redraw garbaged frames. */
11262 clear_garbaged_frames ();
11264 if (!NILP (echo_area_buffer[0]) || minibuf_level == 0)
11266 echo_area_window = mini_window;
11267 window_height_changed_p = display_echo_area (w);
11268 w->must_be_updated_p = true;
11270 /* Update the display, unless called from redisplay_internal.
11271 Also don't update the screen during redisplay itself. The
11272 update will happen at the end of redisplay, and an update
11273 here could cause confusion. */
11274 if (update_frame_p && !redisplaying_p)
11276 int n = 0;
11278 /* If the display update has been interrupted by pending
11279 input, update mode lines in the frame. Due to the
11280 pending input, it might have been that redisplay hasn't
11281 been called, so that mode lines above the echo area are
11282 garbaged. This looks odd, so we prevent it here. */
11283 if (!display_completed)
11284 n = redisplay_mode_lines (FRAME_ROOT_WINDOW (f), false);
11286 if (window_height_changed_p
11287 /* Don't do this if Emacs is shutting down. Redisplay
11288 needs to run hooks. */
11289 && !NILP (Vrun_hooks))
11291 /* Must update other windows. Likewise as in other
11292 cases, don't let this update be interrupted by
11293 pending input. */
11294 ptrdiff_t count = SPECPDL_INDEX ();
11295 specbind (Qredisplay_dont_pause, Qt);
11296 windows_or_buffers_changed = 44;
11297 redisplay_internal ();
11298 unbind_to (count, Qnil);
11300 else if (FRAME_WINDOW_P (f) && n == 0)
11302 /* Window configuration is the same as before.
11303 Can do with a display update of the echo area,
11304 unless we displayed some mode lines. */
11305 update_single_window (w, 1);
11306 flush_frame (f);
11308 else
11309 update_frame (f, 1, 1);
11311 /* If cursor is in the echo area, make sure that the next
11312 redisplay displays the minibuffer, so that the cursor will
11313 be replaced with what the minibuffer wants. */
11314 if (cursor_in_echo_area)
11315 wset_redisplay (XWINDOW (mini_window));
11318 else if (!EQ (mini_window, selected_window))
11319 wset_redisplay (XWINDOW (mini_window));
11321 /* Last displayed message is now the current message. */
11322 echo_area_buffer[1] = echo_area_buffer[0];
11323 /* Inform read_char that we're not echoing. */
11324 echo_message_buffer = Qnil;
11326 /* Prevent redisplay optimization in redisplay_internal by resetting
11327 this_line_start_pos. This is done because the mini-buffer now
11328 displays the message instead of its buffer text. */
11329 if (EQ (mini_window, selected_window))
11330 CHARPOS (this_line_start_pos) = 0;
11332 return window_height_changed_p;
11335 /* Nonzero if W's buffer was changed but not saved. */
11337 static int
11338 window_buffer_changed (struct window *w)
11340 struct buffer *b = XBUFFER (w->contents);
11342 eassert (BUFFER_LIVE_P (b));
11344 return (((BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)) != w->last_had_star));
11347 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11349 static int
11350 mode_line_update_needed (struct window *w)
11352 return (w->column_number_displayed != -1
11353 && !(PT == w->last_point && !window_outdated (w))
11354 && (w->column_number_displayed != current_column ()));
11357 /* Nonzero if window start of W is frozen and may not be changed during
11358 redisplay. */
11360 static bool
11361 window_frozen_p (struct window *w)
11363 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w))))
11365 Lisp_Object window;
11367 XSETWINDOW (window, w);
11368 if (MINI_WINDOW_P (w))
11369 return 0;
11370 else if (EQ (window, selected_window))
11371 return 0;
11372 else if (MINI_WINDOW_P (XWINDOW (selected_window))
11373 && EQ (window, Vminibuf_scroll_window))
11374 /* This special window can't be frozen too. */
11375 return 0;
11376 else
11377 return 1;
11379 return 0;
11382 /***********************************************************************
11383 Mode Lines and Frame Titles
11384 ***********************************************************************/
11386 /* A buffer for constructing non-propertized mode-line strings and
11387 frame titles in it; allocated from the heap in init_xdisp and
11388 resized as needed in store_mode_line_noprop_char. */
11390 static char *mode_line_noprop_buf;
11392 /* The buffer's end, and a current output position in it. */
11394 static char *mode_line_noprop_buf_end;
11395 static char *mode_line_noprop_ptr;
11397 #define MODE_LINE_NOPROP_LEN(start) \
11398 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11400 static enum {
11401 MODE_LINE_DISPLAY = 0,
11402 MODE_LINE_TITLE,
11403 MODE_LINE_NOPROP,
11404 MODE_LINE_STRING
11405 } mode_line_target;
11407 /* Alist that caches the results of :propertize.
11408 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11409 static Lisp_Object mode_line_proptrans_alist;
11411 /* List of strings making up the mode-line. */
11412 static Lisp_Object mode_line_string_list;
11414 /* Base face property when building propertized mode line string. */
11415 static Lisp_Object mode_line_string_face;
11416 static Lisp_Object mode_line_string_face_prop;
11419 /* Unwind data for mode line strings */
11421 static Lisp_Object Vmode_line_unwind_vector;
11423 static Lisp_Object
11424 format_mode_line_unwind_data (struct frame *target_frame,
11425 struct buffer *obuf,
11426 Lisp_Object owin,
11427 int save_proptrans)
11429 Lisp_Object vector, tmp;
11431 /* Reduce consing by keeping one vector in
11432 Vwith_echo_area_save_vector. */
11433 vector = Vmode_line_unwind_vector;
11434 Vmode_line_unwind_vector = Qnil;
11436 if (NILP (vector))
11437 vector = Fmake_vector (make_number (10), Qnil);
11439 ASET (vector, 0, make_number (mode_line_target));
11440 ASET (vector, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11441 ASET (vector, 2, mode_line_string_list);
11442 ASET (vector, 3, save_proptrans ? mode_line_proptrans_alist : Qt);
11443 ASET (vector, 4, mode_line_string_face);
11444 ASET (vector, 5, mode_line_string_face_prop);
11446 if (obuf)
11447 XSETBUFFER (tmp, obuf);
11448 else
11449 tmp = Qnil;
11450 ASET (vector, 6, tmp);
11451 ASET (vector, 7, owin);
11452 if (target_frame)
11454 /* Similarly to `with-selected-window', if the operation selects
11455 a window on another frame, we must restore that frame's
11456 selected window, and (for a tty) the top-frame. */
11457 ASET (vector, 8, target_frame->selected_window);
11458 if (FRAME_TERMCAP_P (target_frame))
11459 ASET (vector, 9, FRAME_TTY (target_frame)->top_frame);
11462 return vector;
11465 static void
11466 unwind_format_mode_line (Lisp_Object vector)
11468 Lisp_Object old_window = AREF (vector, 7);
11469 Lisp_Object target_frame_window = AREF (vector, 8);
11470 Lisp_Object old_top_frame = AREF (vector, 9);
11472 mode_line_target = XINT (AREF (vector, 0));
11473 mode_line_noprop_ptr = mode_line_noprop_buf + XINT (AREF (vector, 1));
11474 mode_line_string_list = AREF (vector, 2);
11475 if (! EQ (AREF (vector, 3), Qt))
11476 mode_line_proptrans_alist = AREF (vector, 3);
11477 mode_line_string_face = AREF (vector, 4);
11478 mode_line_string_face_prop = AREF (vector, 5);
11480 /* Select window before buffer, since it may change the buffer. */
11481 if (!NILP (old_window))
11483 /* If the operation that we are unwinding had selected a window
11484 on a different frame, reset its frame-selected-window. For a
11485 text terminal, reset its top-frame if necessary. */
11486 if (!NILP (target_frame_window))
11488 Lisp_Object frame
11489 = WINDOW_FRAME (XWINDOW (target_frame_window));
11491 if (!EQ (frame, WINDOW_FRAME (XWINDOW (old_window))))
11492 Fselect_window (target_frame_window, Qt);
11494 if (!NILP (old_top_frame) && !EQ (old_top_frame, frame))
11495 Fselect_frame (old_top_frame, Qt);
11498 Fselect_window (old_window, Qt);
11501 if (!NILP (AREF (vector, 6)))
11503 set_buffer_internal_1 (XBUFFER (AREF (vector, 6)));
11504 ASET (vector, 6, Qnil);
11507 Vmode_line_unwind_vector = vector;
11511 /* Store a single character C for the frame title in mode_line_noprop_buf.
11512 Re-allocate mode_line_noprop_buf if necessary. */
11514 static void
11515 store_mode_line_noprop_char (char c)
11517 /* If output position has reached the end of the allocated buffer,
11518 increase the buffer's size. */
11519 if (mode_line_noprop_ptr == mode_line_noprop_buf_end)
11521 ptrdiff_t len = MODE_LINE_NOPROP_LEN (0);
11522 ptrdiff_t size = len;
11523 mode_line_noprop_buf =
11524 xpalloc (mode_line_noprop_buf, &size, 1, STRING_BYTES_BOUND, 1);
11525 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
11526 mode_line_noprop_ptr = mode_line_noprop_buf + len;
11529 *mode_line_noprop_ptr++ = c;
11533 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11534 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11535 characters that yield more columns than PRECISION; PRECISION <= 0
11536 means copy the whole string. Pad with spaces until FIELD_WIDTH
11537 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11538 pad. Called from display_mode_element when it is used to build a
11539 frame title. */
11541 static int
11542 store_mode_line_noprop (const char *string, int field_width, int precision)
11544 const unsigned char *str = (const unsigned char *) string;
11545 int n = 0;
11546 ptrdiff_t dummy, nbytes;
11548 /* Copy at most PRECISION chars from STR. */
11549 nbytes = strlen (string);
11550 n += c_string_width (str, nbytes, precision, &dummy, &nbytes);
11551 while (nbytes--)
11552 store_mode_line_noprop_char (*str++);
11554 /* Fill up with spaces until FIELD_WIDTH reached. */
11555 while (field_width > 0
11556 && n < field_width)
11558 store_mode_line_noprop_char (' ');
11559 ++n;
11562 return n;
11565 /***********************************************************************
11566 Frame Titles
11567 ***********************************************************************/
11569 #ifdef HAVE_WINDOW_SYSTEM
11571 /* Set the title of FRAME, if it has changed. The title format is
11572 Vicon_title_format if FRAME is iconified, otherwise it is
11573 frame_title_format. */
11575 static void
11576 x_consider_frame_title (Lisp_Object frame)
11578 struct frame *f = XFRAME (frame);
11580 if (FRAME_WINDOW_P (f)
11581 || FRAME_MINIBUF_ONLY_P (f)
11582 || f->explicit_name)
11584 /* Do we have more than one visible frame on this X display? */
11585 Lisp_Object tail, other_frame, fmt;
11586 ptrdiff_t title_start;
11587 char *title;
11588 ptrdiff_t len;
11589 struct it it;
11590 ptrdiff_t count = SPECPDL_INDEX ();
11592 FOR_EACH_FRAME (tail, other_frame)
11594 struct frame *tf = XFRAME (other_frame);
11596 if (tf != f
11597 && FRAME_KBOARD (tf) == FRAME_KBOARD (f)
11598 && !FRAME_MINIBUF_ONLY_P (tf)
11599 && !EQ (other_frame, tip_frame)
11600 && (FRAME_VISIBLE_P (tf) || FRAME_ICONIFIED_P (tf)))
11601 break;
11604 /* Set global variable indicating that multiple frames exist. */
11605 multiple_frames = CONSP (tail);
11607 /* Switch to the buffer of selected window of the frame. Set up
11608 mode_line_target so that display_mode_element will output into
11609 mode_line_noprop_buf; then display the title. */
11610 record_unwind_protect (unwind_format_mode_line,
11611 format_mode_line_unwind_data
11612 (f, current_buffer, selected_window, 0));
11614 Fselect_window (f->selected_window, Qt);
11615 set_buffer_internal_1
11616 (XBUFFER (XWINDOW (f->selected_window)->contents));
11617 fmt = FRAME_ICONIFIED_P (f) ? Vicon_title_format : Vframe_title_format;
11619 mode_line_target = MODE_LINE_TITLE;
11620 title_start = MODE_LINE_NOPROP_LEN (0);
11621 init_iterator (&it, XWINDOW (f->selected_window), -1, -1,
11622 NULL, DEFAULT_FACE_ID);
11623 display_mode_element (&it, 0, -1, -1, fmt, Qnil, 0);
11624 len = MODE_LINE_NOPROP_LEN (title_start);
11625 title = mode_line_noprop_buf + title_start;
11626 unbind_to (count, Qnil);
11628 /* Set the title only if it's changed. This avoids consing in
11629 the common case where it hasn't. (If it turns out that we've
11630 already wasted too much time by walking through the list with
11631 display_mode_element, then we might need to optimize at a
11632 higher level than this.) */
11633 if (! STRINGP (f->name)
11634 || SBYTES (f->name) != len
11635 || memcmp (title, SDATA (f->name), len) != 0)
11636 x_implicitly_set_name (f, make_string (title, len), Qnil);
11640 #endif /* not HAVE_WINDOW_SYSTEM */
11643 /***********************************************************************
11644 Menu Bars
11645 ***********************************************************************/
11647 /* Non-zero if we will not redisplay all visible windows. */
11648 #define REDISPLAY_SOME_P() \
11649 ((windows_or_buffers_changed == 0 \
11650 || windows_or_buffers_changed == REDISPLAY_SOME) \
11651 && (update_mode_lines == 0 \
11652 || update_mode_lines == REDISPLAY_SOME))
11654 /* Prepare for redisplay by updating menu-bar item lists when
11655 appropriate. This can call eval. */
11657 static void
11658 prepare_menu_bars (void)
11660 bool all_windows = windows_or_buffers_changed || update_mode_lines;
11661 bool some_windows = REDISPLAY_SOME_P ();
11662 struct gcpro gcpro1, gcpro2;
11663 Lisp_Object tooltip_frame;
11665 #ifdef HAVE_WINDOW_SYSTEM
11666 tooltip_frame = tip_frame;
11667 #else
11668 tooltip_frame = Qnil;
11669 #endif
11671 if (FUNCTIONP (Vpre_redisplay_function))
11673 Lisp_Object windows = all_windows ? Qt : Qnil;
11674 if (all_windows && some_windows)
11676 Lisp_Object ws = window_list ();
11677 for (windows = Qnil; CONSP (ws); ws = XCDR (ws))
11679 Lisp_Object this = XCAR (ws);
11680 struct window *w = XWINDOW (this);
11681 if (w->redisplay
11682 || XFRAME (w->frame)->redisplay
11683 || XBUFFER (w->contents)->text->redisplay)
11685 windows = Fcons (this, windows);
11689 safe__call1 (true, Vpre_redisplay_function, windows);
11692 /* Update all frame titles based on their buffer names, etc. We do
11693 this before the menu bars so that the buffer-menu will show the
11694 up-to-date frame titles. */
11695 #ifdef HAVE_WINDOW_SYSTEM
11696 if (all_windows)
11698 Lisp_Object tail, frame;
11700 FOR_EACH_FRAME (tail, frame)
11702 struct frame *f = XFRAME (frame);
11703 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11704 if (some_windows
11705 && !f->redisplay
11706 && !w->redisplay
11707 && !XBUFFER (w->contents)->text->redisplay)
11708 continue;
11710 if (!EQ (frame, tooltip_frame)
11711 && (FRAME_ICONIFIED_P (f)
11712 || FRAME_VISIBLE_P (f) == 1
11713 /* Exclude TTY frames that are obscured because they
11714 are not the top frame on their console. This is
11715 because x_consider_frame_title actually switches
11716 to the frame, which for TTY frames means it is
11717 marked as garbaged, and will be completely
11718 redrawn on the next redisplay cycle. This causes
11719 TTY frames to be completely redrawn, when there
11720 are more than one of them, even though nothing
11721 should be changed on display. */
11722 || (FRAME_VISIBLE_P (f) == 2 && FRAME_WINDOW_P (f))))
11723 x_consider_frame_title (frame);
11726 #endif /* HAVE_WINDOW_SYSTEM */
11728 /* Update the menu bar item lists, if appropriate. This has to be
11729 done before any actual redisplay or generation of display lines. */
11731 if (all_windows)
11733 Lisp_Object tail, frame;
11734 ptrdiff_t count = SPECPDL_INDEX ();
11735 /* 1 means that update_menu_bar has run its hooks
11736 so any further calls to update_menu_bar shouldn't do so again. */
11737 int menu_bar_hooks_run = 0;
11739 record_unwind_save_match_data ();
11741 FOR_EACH_FRAME (tail, frame)
11743 struct frame *f = XFRAME (frame);
11744 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
11746 /* Ignore tooltip frame. */
11747 if (EQ (frame, tooltip_frame))
11748 continue;
11750 if (some_windows
11751 && !f->redisplay
11752 && !w->redisplay
11753 && !XBUFFER (w->contents)->text->redisplay)
11754 continue;
11756 /* If a window on this frame changed size, report that to
11757 the user and clear the size-change flag. */
11758 if (FRAME_WINDOW_SIZES_CHANGED (f))
11760 Lisp_Object functions;
11762 /* Clear flag first in case we get an error below. */
11763 FRAME_WINDOW_SIZES_CHANGED (f) = 0;
11764 functions = Vwindow_size_change_functions;
11765 GCPRO2 (tail, functions);
11767 while (CONSP (functions))
11769 if (!EQ (XCAR (functions), Qt))
11770 call1 (XCAR (functions), frame);
11771 functions = XCDR (functions);
11773 UNGCPRO;
11776 GCPRO1 (tail);
11777 menu_bar_hooks_run = update_menu_bar (f, 0, menu_bar_hooks_run);
11778 #ifdef HAVE_WINDOW_SYSTEM
11779 update_tool_bar (f, 0);
11780 #endif
11781 #ifdef HAVE_NS
11782 if (windows_or_buffers_changed
11783 && FRAME_NS_P (f))
11784 ns_set_doc_edited
11785 (f, Fbuffer_modified_p (XWINDOW (f->selected_window)->contents));
11786 #endif
11787 UNGCPRO;
11790 unbind_to (count, Qnil);
11792 else
11794 struct frame *sf = SELECTED_FRAME ();
11795 update_menu_bar (sf, 1, 0);
11796 #ifdef HAVE_WINDOW_SYSTEM
11797 update_tool_bar (sf, 1);
11798 #endif
11803 /* Update the menu bar item list for frame F. This has to be done
11804 before we start to fill in any display lines, because it can call
11805 eval.
11807 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11809 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11810 already ran the menu bar hooks for this redisplay, so there
11811 is no need to run them again. The return value is the
11812 updated value of this flag, to pass to the next call. */
11814 static int
11815 update_menu_bar (struct frame *f, int save_match_data, int hooks_run)
11817 Lisp_Object window;
11818 register struct window *w;
11820 /* If called recursively during a menu update, do nothing. This can
11821 happen when, for instance, an activate-menubar-hook causes a
11822 redisplay. */
11823 if (inhibit_menubar_update)
11824 return hooks_run;
11826 window = FRAME_SELECTED_WINDOW (f);
11827 w = XWINDOW (window);
11829 if (FRAME_WINDOW_P (f)
11831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11832 || defined (HAVE_NS) || defined (USE_GTK)
11833 FRAME_EXTERNAL_MENU_BAR (f)
11834 #else
11835 FRAME_MENU_BAR_LINES (f) > 0
11836 #endif
11837 : FRAME_MENU_BAR_LINES (f) > 0)
11839 /* If the user has switched buffers or windows, we need to
11840 recompute to reflect the new bindings. But we'll
11841 recompute when update_mode_lines is set too; that means
11842 that people can use force-mode-line-update to request
11843 that the menu bar be recomputed. The adverse effect on
11844 the rest of the redisplay algorithm is about the same as
11845 windows_or_buffers_changed anyway. */
11846 if (windows_or_buffers_changed
11847 /* This used to test w->update_mode_line, but we believe
11848 there is no need to recompute the menu in that case. */
11849 || update_mode_lines
11850 || window_buffer_changed (w))
11852 struct buffer *prev = current_buffer;
11853 ptrdiff_t count = SPECPDL_INDEX ();
11855 specbind (Qinhibit_menubar_update, Qt);
11857 set_buffer_internal_1 (XBUFFER (w->contents));
11858 if (save_match_data)
11859 record_unwind_save_match_data ();
11860 if (NILP (Voverriding_local_map_menu_flag))
11862 specbind (Qoverriding_terminal_local_map, Qnil);
11863 specbind (Qoverriding_local_map, Qnil);
11866 if (!hooks_run)
11868 /* Run the Lucid hook. */
11869 safe_run_hooks (Qactivate_menubar_hook);
11871 /* If it has changed current-menubar from previous value,
11872 really recompute the menu-bar from the value. */
11873 if (! NILP (Vlucid_menu_bar_dirty_flag))
11874 call0 (Qrecompute_lucid_menubar);
11876 safe_run_hooks (Qmenu_bar_update_hook);
11878 hooks_run = 1;
11881 XSETFRAME (Vmenu_updating_frame, f);
11882 fset_menu_bar_items (f, menu_bar_items (FRAME_MENU_BAR_ITEMS (f)));
11884 /* Redisplay the menu bar in case we changed it. */
11885 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11886 || defined (HAVE_NS) || defined (USE_GTK)
11887 if (FRAME_WINDOW_P (f))
11889 #if defined (HAVE_NS)
11890 /* All frames on Mac OS share the same menubar. So only
11891 the selected frame should be allowed to set it. */
11892 if (f == SELECTED_FRAME ())
11893 #endif
11894 set_frame_menubar (f, 0, 0);
11896 else
11897 /* On a terminal screen, the menu bar is an ordinary screen
11898 line, and this makes it get updated. */
11899 w->update_mode_line = 1;
11900 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11901 /* In the non-toolkit version, the menu bar is an ordinary screen
11902 line, and this makes it get updated. */
11903 w->update_mode_line = 1;
11904 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11906 unbind_to (count, Qnil);
11907 set_buffer_internal_1 (prev);
11911 return hooks_run;
11914 /***********************************************************************
11915 Tool-bars
11916 ***********************************************************************/
11918 #ifdef HAVE_WINDOW_SYSTEM
11920 /* Tool-bar item index of the item on which a mouse button was pressed
11921 or -1. */
11923 int last_tool_bar_item;
11925 /* Select `frame' temporarily without running all the code in
11926 do_switch_frame.
11927 FIXME: Maybe do_switch_frame should be trimmed down similarly
11928 when `norecord' is set. */
11929 static void
11930 fast_set_selected_frame (Lisp_Object frame)
11932 if (!EQ (selected_frame, frame))
11934 selected_frame = frame;
11935 selected_window = XFRAME (frame)->selected_window;
11939 /* Update the tool-bar item list for frame F. This has to be done
11940 before we start to fill in any display lines. Called from
11941 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11942 and restore it here. */
11944 static void
11945 update_tool_bar (struct frame *f, int save_match_data)
11947 #if defined (USE_GTK) || defined (HAVE_NS)
11948 int do_update = FRAME_EXTERNAL_TOOL_BAR (f);
11949 #else
11950 int do_update = (WINDOWP (f->tool_bar_window)
11951 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0);
11952 #endif
11954 if (do_update)
11956 Lisp_Object window;
11957 struct window *w;
11959 window = FRAME_SELECTED_WINDOW (f);
11960 w = XWINDOW (window);
11962 /* If the user has switched buffers or windows, we need to
11963 recompute to reflect the new bindings. But we'll
11964 recompute when update_mode_lines is set too; that means
11965 that people can use force-mode-line-update to request
11966 that the menu bar be recomputed. The adverse effect on
11967 the rest of the redisplay algorithm is about the same as
11968 windows_or_buffers_changed anyway. */
11969 if (windows_or_buffers_changed
11970 || w->update_mode_line
11971 || update_mode_lines
11972 || window_buffer_changed (w))
11974 struct buffer *prev = current_buffer;
11975 ptrdiff_t count = SPECPDL_INDEX ();
11976 Lisp_Object frame, new_tool_bar;
11977 int new_n_tool_bar;
11978 struct gcpro gcpro1;
11980 /* Set current_buffer to the buffer of the selected
11981 window of the frame, so that we get the right local
11982 keymaps. */
11983 set_buffer_internal_1 (XBUFFER (w->contents));
11985 /* Save match data, if we must. */
11986 if (save_match_data)
11987 record_unwind_save_match_data ();
11989 /* Make sure that we don't accidentally use bogus keymaps. */
11990 if (NILP (Voverriding_local_map_menu_flag))
11992 specbind (Qoverriding_terminal_local_map, Qnil);
11993 specbind (Qoverriding_local_map, Qnil);
11996 GCPRO1 (new_tool_bar);
11998 /* We must temporarily set the selected frame to this frame
11999 before calling tool_bar_items, because the calculation of
12000 the tool-bar keymap uses the selected frame (see
12001 `tool-bar-make-keymap' in tool-bar.el). */
12002 eassert (EQ (selected_window,
12003 /* Since we only explicitly preserve selected_frame,
12004 check that selected_window would be redundant. */
12005 XFRAME (selected_frame)->selected_window));
12006 record_unwind_protect (fast_set_selected_frame, selected_frame);
12007 XSETFRAME (frame, f);
12008 fast_set_selected_frame (frame);
12010 /* Build desired tool-bar items from keymaps. */
12011 new_tool_bar
12012 = tool_bar_items (Fcopy_sequence (f->tool_bar_items),
12013 &new_n_tool_bar);
12015 /* Redisplay the tool-bar if we changed it. */
12016 if (new_n_tool_bar != f->n_tool_bar_items
12017 || NILP (Fequal (new_tool_bar, f->tool_bar_items)))
12019 /* Redisplay that happens asynchronously due to an expose event
12020 may access f->tool_bar_items. Make sure we update both
12021 variables within BLOCK_INPUT so no such event interrupts. */
12022 block_input ();
12023 fset_tool_bar_items (f, new_tool_bar);
12024 f->n_tool_bar_items = new_n_tool_bar;
12025 w->update_mode_line = 1;
12026 unblock_input ();
12029 UNGCPRO;
12031 unbind_to (count, Qnil);
12032 set_buffer_internal_1 (prev);
12037 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12039 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12040 F's desired tool-bar contents. F->tool_bar_items must have
12041 been set up previously by calling prepare_menu_bars. */
12043 static void
12044 build_desired_tool_bar_string (struct frame *f)
12046 int i, size, size_needed;
12047 struct gcpro gcpro1, gcpro2, gcpro3;
12048 Lisp_Object image, plist, props;
12050 image = plist = props = Qnil;
12051 GCPRO3 (image, plist, props);
12053 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12054 Otherwise, make a new string. */
12056 /* The size of the string we might be able to reuse. */
12057 size = (STRINGP (f->desired_tool_bar_string)
12058 ? SCHARS (f->desired_tool_bar_string)
12059 : 0);
12061 /* We need one space in the string for each image. */
12062 size_needed = f->n_tool_bar_items;
12064 /* Reuse f->desired_tool_bar_string, if possible. */
12065 if (size < size_needed || NILP (f->desired_tool_bar_string))
12066 fset_desired_tool_bar_string
12067 (f, Fmake_string (make_number (size_needed), make_number (' ')));
12068 else
12070 props = list4 (Qdisplay, Qnil, Qmenu_item, Qnil);
12071 Fremove_text_properties (make_number (0), make_number (size),
12072 props, f->desired_tool_bar_string);
12075 /* Put a `display' property on the string for the images to display,
12076 put a `menu_item' property on tool-bar items with a value that
12077 is the index of the item in F's tool-bar item vector. */
12078 for (i = 0; i < f->n_tool_bar_items; ++i)
12080 #define PROP(IDX) \
12081 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12083 int enabled_p = !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P));
12084 int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
12085 int hmargin, vmargin, relief, idx, end;
12087 /* If image is a vector, choose the image according to the
12088 button state. */
12089 image = PROP (TOOL_BAR_ITEM_IMAGES);
12090 if (VECTORP (image))
12092 if (enabled_p)
12093 idx = (selected_p
12094 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12095 : TOOL_BAR_IMAGE_ENABLED_DESELECTED);
12096 else
12097 idx = (selected_p
12098 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12099 : TOOL_BAR_IMAGE_DISABLED_DESELECTED);
12101 eassert (ASIZE (image) >= idx);
12102 image = AREF (image, idx);
12104 else
12105 idx = -1;
12107 /* Ignore invalid image specifications. */
12108 if (!valid_image_p (image))
12109 continue;
12111 /* Display the tool-bar button pressed, or depressed. */
12112 plist = Fcopy_sequence (XCDR (image));
12114 /* Compute margin and relief to draw. */
12115 relief = (tool_bar_button_relief >= 0
12116 ? tool_bar_button_relief
12117 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
12118 hmargin = vmargin = relief;
12120 if (RANGED_INTEGERP (1, Vtool_bar_button_margin,
12121 INT_MAX - max (hmargin, vmargin)))
12123 hmargin += XFASTINT (Vtool_bar_button_margin);
12124 vmargin += XFASTINT (Vtool_bar_button_margin);
12126 else if (CONSP (Vtool_bar_button_margin))
12128 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin),
12129 INT_MAX - hmargin))
12130 hmargin += XFASTINT (XCAR (Vtool_bar_button_margin));
12132 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin),
12133 INT_MAX - vmargin))
12134 vmargin += XFASTINT (XCDR (Vtool_bar_button_margin));
12137 if (auto_raise_tool_bar_buttons_p)
12139 /* Add a `:relief' property to the image spec if the item is
12140 selected. */
12141 if (selected_p)
12143 plist = Fplist_put (plist, QCrelief, make_number (-relief));
12144 hmargin -= relief;
12145 vmargin -= relief;
12148 else
12150 /* If image is selected, display it pressed, i.e. with a
12151 negative relief. If it's not selected, display it with a
12152 raised relief. */
12153 plist = Fplist_put (plist, QCrelief,
12154 (selected_p
12155 ? make_number (-relief)
12156 : make_number (relief)));
12157 hmargin -= relief;
12158 vmargin -= relief;
12161 /* Put a margin around the image. */
12162 if (hmargin || vmargin)
12164 if (hmargin == vmargin)
12165 plist = Fplist_put (plist, QCmargin, make_number (hmargin));
12166 else
12167 plist = Fplist_put (plist, QCmargin,
12168 Fcons (make_number (hmargin),
12169 make_number (vmargin)));
12172 /* If button is not enabled, and we don't have special images
12173 for the disabled state, make the image appear disabled by
12174 applying an appropriate algorithm to it. */
12175 if (!enabled_p && idx < 0)
12176 plist = Fplist_put (plist, QCconversion, Qdisabled);
12178 /* Put a `display' text property on the string for the image to
12179 display. Put a `menu-item' property on the string that gives
12180 the start of this item's properties in the tool-bar items
12181 vector. */
12182 image = Fcons (Qimage, plist);
12183 props = list4 (Qdisplay, image,
12184 Qmenu_item, make_number (i * TOOL_BAR_ITEM_NSLOTS));
12186 /* Let the last image hide all remaining spaces in the tool bar
12187 string. The string can be longer than needed when we reuse a
12188 previous string. */
12189 if (i + 1 == f->n_tool_bar_items)
12190 end = SCHARS (f->desired_tool_bar_string);
12191 else
12192 end = i + 1;
12193 Fadd_text_properties (make_number (i), make_number (end),
12194 props, f->desired_tool_bar_string);
12195 #undef PROP
12198 UNGCPRO;
12202 /* Display one line of the tool-bar of frame IT->f.
12204 HEIGHT specifies the desired height of the tool-bar line.
12205 If the actual height of the glyph row is less than HEIGHT, the
12206 row's height is increased to HEIGHT, and the icons are centered
12207 vertically in the new height.
12209 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12210 count a final empty row in case the tool-bar width exactly matches
12211 the window width.
12214 static void
12215 display_tool_bar_line (struct it *it, int height)
12217 struct glyph_row *row = it->glyph_row;
12218 int max_x = it->last_visible_x;
12219 struct glyph *last;
12221 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12222 clear_glyph_row (row);
12223 row->enabled_p = true;
12224 row->y = it->current_y;
12226 /* Note that this isn't made use of if the face hasn't a box,
12227 so there's no need to check the face here. */
12228 it->start_of_box_run_p = 1;
12230 while (it->current_x < max_x)
12232 int x, n_glyphs_before, i, nglyphs;
12233 struct it it_before;
12235 /* Get the next display element. */
12236 if (!get_next_display_element (it))
12238 /* Don't count empty row if we are counting needed tool-bar lines. */
12239 if (height < 0 && !it->hpos)
12240 return;
12241 break;
12244 /* Produce glyphs. */
12245 n_glyphs_before = row->used[TEXT_AREA];
12246 it_before = *it;
12248 PRODUCE_GLYPHS (it);
12250 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
12251 i = 0;
12252 x = it_before.current_x;
12253 while (i < nglyphs)
12255 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
12257 if (x + glyph->pixel_width > max_x)
12259 /* Glyph doesn't fit on line. Backtrack. */
12260 row->used[TEXT_AREA] = n_glyphs_before;
12261 *it = it_before;
12262 /* If this is the only glyph on this line, it will never fit on the
12263 tool-bar, so skip it. But ensure there is at least one glyph,
12264 so we don't accidentally disable the tool-bar. */
12265 if (n_glyphs_before == 0
12266 && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
12267 break;
12268 goto out;
12271 ++it->hpos;
12272 x += glyph->pixel_width;
12273 ++i;
12276 /* Stop at line end. */
12277 if (ITERATOR_AT_END_OF_LINE_P (it))
12278 break;
12280 set_iterator_to_next (it, 1);
12283 out:;
12285 row->displays_text_p = row->used[TEXT_AREA] != 0;
12287 /* Use default face for the border below the tool bar.
12289 FIXME: When auto-resize-tool-bars is grow-only, there is
12290 no additional border below the possibly empty tool-bar lines.
12291 So to make the extra empty lines look "normal", we have to
12292 use the tool-bar face for the border too. */
12293 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12294 && !EQ (Vauto_resize_tool_bars, Qgrow_only))
12295 it->face_id = DEFAULT_FACE_ID;
12297 extend_face_to_end_of_line (it);
12298 last = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
12299 last->right_box_line_p = 1;
12300 if (last == row->glyphs[TEXT_AREA])
12301 last->left_box_line_p = 1;
12303 /* Make line the desired height and center it vertically. */
12304 if ((height -= it->max_ascent + it->max_descent) > 0)
12306 /* Don't add more than one line height. */
12307 height %= FRAME_LINE_HEIGHT (it->f);
12308 it->max_ascent += height / 2;
12309 it->max_descent += (height + 1) / 2;
12312 compute_line_metrics (it);
12314 /* If line is empty, make it occupy the rest of the tool-bar. */
12315 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row))
12317 row->height = row->phys_height = it->last_visible_y - row->y;
12318 row->visible_height = row->height;
12319 row->ascent = row->phys_ascent = 0;
12320 row->extra_line_spacing = 0;
12323 row->full_width_p = 1;
12324 row->continued_p = 0;
12325 row->truncated_on_left_p = 0;
12326 row->truncated_on_right_p = 0;
12328 it->current_x = it->hpos = 0;
12329 it->current_y += row->height;
12330 ++it->vpos;
12331 ++it->glyph_row;
12335 /* Max tool-bar height. Basically, this is what makes all other windows
12336 disappear when the frame gets too small. Rethink this! */
12338 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12339 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12341 /* Value is the number of pixels needed to make all tool-bar items of
12342 frame F visible. The actual number of glyph rows needed is
12343 returned in *N_ROWS if non-NULL. */
12345 static int
12346 tool_bar_height (struct frame *f, int *n_rows, bool pixelwise)
12348 struct window *w = XWINDOW (f->tool_bar_window);
12349 struct it it;
12350 /* tool_bar_height is called from redisplay_tool_bar after building
12351 the desired matrix, so use (unused) mode-line row as temporary row to
12352 avoid destroying the first tool-bar row. */
12353 struct glyph_row *temp_row = MATRIX_MODE_LINE_ROW (w->desired_matrix);
12355 /* Initialize an iterator for iteration over
12356 F->desired_tool_bar_string in the tool-bar window of frame F. */
12357 init_iterator (&it, w, -1, -1, temp_row, TOOL_BAR_FACE_ID);
12358 it.first_visible_x = 0;
12359 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12360 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12361 it.paragraph_embedding = L2R;
12363 while (!ITERATOR_AT_END_P (&it))
12365 clear_glyph_row (temp_row);
12366 it.glyph_row = temp_row;
12367 display_tool_bar_line (&it, -1);
12369 clear_glyph_row (temp_row);
12371 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12372 if (n_rows)
12373 *n_rows = it.vpos > 0 ? it.vpos : -1;
12375 if (pixelwise)
12376 return it.current_y;
12377 else
12378 return (it.current_y + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
12381 #endif /* !USE_GTK && !HAVE_NS */
12383 #if defined USE_GTK || defined HAVE_NS
12384 EXFUN (Ftool_bar_height, 2) ATTRIBUTE_CONST;
12385 EXFUN (Ftool_bar_lines_needed, 1) ATTRIBUTE_CONST;
12386 #endif
12388 DEFUN ("tool-bar-height", Ftool_bar_height, Stool_bar_height,
12389 0, 2, 0,
12390 doc: /* Return the number of lines occupied by the tool bar of FRAME.
12391 If FRAME is nil or omitted, use the selected frame. Optional argument
12392 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12393 (Lisp_Object frame, Lisp_Object pixelwise)
12395 int height = 0;
12397 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12398 struct frame *f = decode_any_frame (frame);
12400 if (WINDOWP (f->tool_bar_window)
12401 && WINDOW_PIXEL_HEIGHT (XWINDOW (f->tool_bar_window)) > 0)
12403 update_tool_bar (f, 1);
12404 if (f->n_tool_bar_items)
12406 build_desired_tool_bar_string (f);
12407 height = tool_bar_height (f, NULL, NILP (pixelwise) ? 0 : 1);
12410 #endif
12412 return make_number (height);
12416 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12417 height should be changed. */
12419 static int
12420 redisplay_tool_bar (struct frame *f)
12422 #if defined (USE_GTK) || defined (HAVE_NS)
12424 if (FRAME_EXTERNAL_TOOL_BAR (f))
12425 update_frame_tool_bar (f);
12426 return 0;
12428 #else /* !USE_GTK && !HAVE_NS */
12430 struct window *w;
12431 struct it it;
12432 struct glyph_row *row;
12434 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12435 do anything. This means you must start with tool-bar-lines
12436 non-zero to get the auto-sizing effect. Or in other words, you
12437 can turn off tool-bars by specifying tool-bar-lines zero. */
12438 if (!WINDOWP (f->tool_bar_window)
12439 || (w = XWINDOW (f->tool_bar_window),
12440 WINDOW_PIXEL_HEIGHT (w) == 0))
12441 return 0;
12443 /* Set up an iterator for the tool-bar window. */
12444 init_iterator (&it, w, -1, -1, w->desired_matrix->rows, TOOL_BAR_FACE_ID);
12445 it.first_visible_x = 0;
12446 it.last_visible_x = WINDOW_PIXEL_WIDTH (w);
12447 row = it.glyph_row;
12449 /* Build a string that represents the contents of the tool-bar. */
12450 build_desired_tool_bar_string (f);
12451 reseat_to_string (&it, NULL, f->desired_tool_bar_string, 0, 0, 0, -1);
12452 /* FIXME: This should be controlled by a user option. But it
12453 doesn't make sense to have an R2L tool bar if the menu bar cannot
12454 be drawn also R2L, and making the menu bar R2L is tricky due
12455 toolkit-specific code that implements it. If an R2L tool bar is
12456 ever supported, display_tool_bar_line should also be augmented to
12457 call unproduce_glyphs like display_line and display_string
12458 do. */
12459 it.paragraph_embedding = L2R;
12461 if (f->n_tool_bar_rows == 0)
12463 int new_height = tool_bar_height (f, &f->n_tool_bar_rows, 1);
12465 if (new_height != WINDOW_PIXEL_HEIGHT (w))
12467 Lisp_Object frame;
12468 int new_lines = ((new_height + FRAME_LINE_HEIGHT (f) - 1)
12469 / FRAME_LINE_HEIGHT (f));
12471 XSETFRAME (frame, f);
12472 Fmodify_frame_parameters (frame,
12473 list1 (Fcons (Qtool_bar_lines,
12474 make_number (new_lines))));
12475 /* Always do that now. */
12476 clear_glyph_matrix (w->desired_matrix);
12477 f->fonts_changed = 1;
12478 return 1;
12482 /* Display as many lines as needed to display all tool-bar items. */
12484 if (f->n_tool_bar_rows > 0)
12486 int border, rows, height, extra;
12488 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border))
12489 border = XINT (Vtool_bar_border);
12490 else if (EQ (Vtool_bar_border, Qinternal_border_width))
12491 border = FRAME_INTERNAL_BORDER_WIDTH (f);
12492 else if (EQ (Vtool_bar_border, Qborder_width))
12493 border = f->border_width;
12494 else
12495 border = 0;
12496 if (border < 0)
12497 border = 0;
12499 rows = f->n_tool_bar_rows;
12500 height = max (1, (it.last_visible_y - border) / rows);
12501 extra = it.last_visible_y - border - height * rows;
12503 while (it.current_y < it.last_visible_y)
12505 int h = 0;
12506 if (extra > 0 && rows-- > 0)
12508 h = (extra + rows - 1) / rows;
12509 extra -= h;
12511 display_tool_bar_line (&it, height + h);
12514 else
12516 while (it.current_y < it.last_visible_y)
12517 display_tool_bar_line (&it, 0);
12520 /* It doesn't make much sense to try scrolling in the tool-bar
12521 window, so don't do it. */
12522 w->desired_matrix->no_scrolling_p = 1;
12523 w->must_be_updated_p = 1;
12525 if (!NILP (Vauto_resize_tool_bars))
12527 /* Do we really allow the toolbar to occupy the whole frame? */
12528 int max_tool_bar_height = MAX_FRAME_TOOL_BAR_HEIGHT (f);
12529 int change_height_p = 0;
12531 /* If we couldn't display everything, change the tool-bar's
12532 height if there is room for more. */
12533 if (IT_STRING_CHARPOS (it) < it.end_charpos
12534 && it.current_y < max_tool_bar_height)
12535 change_height_p = 1;
12537 /* We subtract 1 because display_tool_bar_line advances the
12538 glyph_row pointer before returning to its caller. We want to
12539 examine the last glyph row produced by
12540 display_tool_bar_line. */
12541 row = it.glyph_row - 1;
12543 /* If there are blank lines at the end, except for a partially
12544 visible blank line at the end that is smaller than
12545 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12546 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row)
12547 && row->height >= FRAME_LINE_HEIGHT (f))
12548 change_height_p = 1;
12550 /* If row displays tool-bar items, but is partially visible,
12551 change the tool-bar's height. */
12552 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
12553 && MATRIX_ROW_BOTTOM_Y (row) > it.last_visible_y
12554 && MATRIX_ROW_BOTTOM_Y (row) < max_tool_bar_height)
12555 change_height_p = 1;
12557 /* Resize windows as needed by changing the `tool-bar-lines'
12558 frame parameter. */
12559 if (change_height_p)
12561 Lisp_Object frame;
12562 int nrows;
12563 int new_height = tool_bar_height (f, &nrows, 1);
12565 change_height_p = ((EQ (Vauto_resize_tool_bars, Qgrow_only)
12566 && !f->minimize_tool_bar_window_p)
12567 ? (new_height > WINDOW_PIXEL_HEIGHT (w))
12568 : (new_height != WINDOW_PIXEL_HEIGHT (w)));
12569 f->minimize_tool_bar_window_p = 0;
12571 if (change_height_p)
12573 /* Current size of the tool-bar window in canonical line
12574 units. */
12575 int old_lines = WINDOW_TOTAL_LINES (w);
12576 /* Required size of the tool-bar window in canonical
12577 line units. */
12578 int new_lines = ((new_height + FRAME_LINE_HEIGHT (f) - 1)
12579 / FRAME_LINE_HEIGHT (f));
12580 /* Maximum size of the tool-bar window in canonical line
12581 units that this frame can allow. */
12582 int max_lines =
12583 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f))) - 1;
12585 /* Don't try to change the tool-bar window size and set
12586 the fonts_changed flag unless really necessary. That
12587 flag causes redisplay to give up and retry
12588 redisplaying the frame from scratch, so setting it
12589 unnecessarily can lead to nasty redisplay loops. */
12590 if (new_lines <= max_lines
12591 && eabs (new_lines - old_lines) >= 1)
12593 XSETFRAME (frame, f);
12594 Fmodify_frame_parameters (frame,
12595 list1 (Fcons (Qtool_bar_lines,
12596 make_number (new_lines))));
12597 clear_glyph_matrix (w->desired_matrix);
12598 f->n_tool_bar_rows = nrows;
12599 f->fonts_changed = 1;
12600 return 1;
12606 f->minimize_tool_bar_window_p = 0;
12607 return 0;
12609 #endif /* USE_GTK || HAVE_NS */
12612 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12614 /* Get information about the tool-bar item which is displayed in GLYPH
12615 on frame F. Return in *PROP_IDX the index where tool-bar item
12616 properties start in F->tool_bar_items. Value is zero if
12617 GLYPH doesn't display a tool-bar item. */
12619 static int
12620 tool_bar_item_info (struct frame *f, struct glyph *glyph, int *prop_idx)
12622 Lisp_Object prop;
12623 int success_p;
12624 int charpos;
12626 /* This function can be called asynchronously, which means we must
12627 exclude any possibility that Fget_text_property signals an
12628 error. */
12629 charpos = min (SCHARS (f->current_tool_bar_string), glyph->charpos);
12630 charpos = max (0, charpos);
12632 /* Get the text property `menu-item' at pos. The value of that
12633 property is the start index of this item's properties in
12634 F->tool_bar_items. */
12635 prop = Fget_text_property (make_number (charpos),
12636 Qmenu_item, f->current_tool_bar_string);
12637 if (INTEGERP (prop))
12639 *prop_idx = XINT (prop);
12640 success_p = 1;
12642 else
12643 success_p = 0;
12645 return success_p;
12649 /* Get information about the tool-bar item at position X/Y on frame F.
12650 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12651 the current matrix of the tool-bar window of F, or NULL if not
12652 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12653 item in F->tool_bar_items. Value is
12655 -1 if X/Y is not on a tool-bar item
12656 0 if X/Y is on the same item that was highlighted before.
12657 1 otherwise. */
12659 static int
12660 get_tool_bar_item (struct frame *f, int x, int y, struct glyph **glyph,
12661 int *hpos, int *vpos, int *prop_idx)
12663 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12664 struct window *w = XWINDOW (f->tool_bar_window);
12665 int area;
12667 /* Find the glyph under X/Y. */
12668 *glyph = x_y_to_hpos_vpos (w, x, y, hpos, vpos, 0, 0, &area);
12669 if (*glyph == NULL)
12670 return -1;
12672 /* Get the start of this tool-bar item's properties in
12673 f->tool_bar_items. */
12674 if (!tool_bar_item_info (f, *glyph, prop_idx))
12675 return -1;
12677 /* Is mouse on the highlighted item? */
12678 if (EQ (f->tool_bar_window, hlinfo->mouse_face_window)
12679 && *vpos >= hlinfo->mouse_face_beg_row
12680 && *vpos <= hlinfo->mouse_face_end_row
12681 && (*vpos > hlinfo->mouse_face_beg_row
12682 || *hpos >= hlinfo->mouse_face_beg_col)
12683 && (*vpos < hlinfo->mouse_face_end_row
12684 || *hpos < hlinfo->mouse_face_end_col
12685 || hlinfo->mouse_face_past_end))
12686 return 0;
12688 return 1;
12692 /* EXPORT:
12693 Handle mouse button event on the tool-bar of frame F, at
12694 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12695 0 for button release. MODIFIERS is event modifiers for button
12696 release. */
12698 void
12699 handle_tool_bar_click (struct frame *f, int x, int y, int down_p,
12700 int modifiers)
12702 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12703 struct window *w = XWINDOW (f->tool_bar_window);
12704 int hpos, vpos, prop_idx;
12705 struct glyph *glyph;
12706 Lisp_Object enabled_p;
12707 int ts;
12709 /* If not on the highlighted tool-bar item, and mouse-highlight is
12710 non-nil, return. This is so we generate the tool-bar button
12711 click only when the mouse button is released on the same item as
12712 where it was pressed. However, when mouse-highlight is disabled,
12713 generate the click when the button is released regardless of the
12714 highlight, since tool-bar items are not highlighted in that
12715 case. */
12716 frame_to_window_pixel_xy (w, &x, &y);
12717 ts = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12718 if (ts == -1
12719 || (ts != 0 && !NILP (Vmouse_highlight)))
12720 return;
12722 /* When mouse-highlight is off, generate the click for the item
12723 where the button was pressed, disregarding where it was
12724 released. */
12725 if (NILP (Vmouse_highlight) && !down_p)
12726 prop_idx = last_tool_bar_item;
12728 /* If item is disabled, do nothing. */
12729 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12730 if (NILP (enabled_p))
12731 return;
12733 if (down_p)
12735 /* Show item in pressed state. */
12736 if (!NILP (Vmouse_highlight))
12737 show_mouse_face (hlinfo, DRAW_IMAGE_SUNKEN);
12738 last_tool_bar_item = prop_idx;
12740 else
12742 Lisp_Object key, frame;
12743 struct input_event event;
12744 EVENT_INIT (event);
12746 /* Show item in released state. */
12747 if (!NILP (Vmouse_highlight))
12748 show_mouse_face (hlinfo, DRAW_IMAGE_RAISED);
12750 key = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_KEY);
12752 XSETFRAME (frame, f);
12753 event.kind = TOOL_BAR_EVENT;
12754 event.frame_or_window = frame;
12755 event.arg = frame;
12756 kbd_buffer_store_event (&event);
12758 event.kind = TOOL_BAR_EVENT;
12759 event.frame_or_window = frame;
12760 event.arg = key;
12761 event.modifiers = modifiers;
12762 kbd_buffer_store_event (&event);
12763 last_tool_bar_item = -1;
12768 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12769 tool-bar window-relative coordinates X/Y. Called from
12770 note_mouse_highlight. */
12772 static void
12773 note_tool_bar_highlight (struct frame *f, int x, int y)
12775 Lisp_Object window = f->tool_bar_window;
12776 struct window *w = XWINDOW (window);
12777 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
12778 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
12779 int hpos, vpos;
12780 struct glyph *glyph;
12781 struct glyph_row *row;
12782 int i;
12783 Lisp_Object enabled_p;
12784 int prop_idx;
12785 enum draw_glyphs_face draw = DRAW_IMAGE_RAISED;
12786 int mouse_down_p, rc;
12788 /* Function note_mouse_highlight is called with negative X/Y
12789 values when mouse moves outside of the frame. */
12790 if (x <= 0 || y <= 0)
12792 clear_mouse_face (hlinfo);
12793 return;
12796 rc = get_tool_bar_item (f, x, y, &glyph, &hpos, &vpos, &prop_idx);
12797 if (rc < 0)
12799 /* Not on tool-bar item. */
12800 clear_mouse_face (hlinfo);
12801 return;
12803 else if (rc == 0)
12804 /* On same tool-bar item as before. */
12805 goto set_help_echo;
12807 clear_mouse_face (hlinfo);
12809 /* Mouse is down, but on different tool-bar item? */
12810 mouse_down_p = (x_mouse_grabbed (dpyinfo)
12811 && f == dpyinfo->last_mouse_frame);
12813 if (mouse_down_p
12814 && last_tool_bar_item != prop_idx)
12815 return;
12817 draw = mouse_down_p ? DRAW_IMAGE_SUNKEN : DRAW_IMAGE_RAISED;
12819 /* If tool-bar item is not enabled, don't highlight it. */
12820 enabled_p = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_ENABLED_P);
12821 if (!NILP (enabled_p) && !NILP (Vmouse_highlight))
12823 /* Compute the x-position of the glyph. In front and past the
12824 image is a space. We include this in the highlighted area. */
12825 row = MATRIX_ROW (w->current_matrix, vpos);
12826 for (i = x = 0; i < hpos; ++i)
12827 x += row->glyphs[TEXT_AREA][i].pixel_width;
12829 /* Record this as the current active region. */
12830 hlinfo->mouse_face_beg_col = hpos;
12831 hlinfo->mouse_face_beg_row = vpos;
12832 hlinfo->mouse_face_beg_x = x;
12833 hlinfo->mouse_face_past_end = 0;
12835 hlinfo->mouse_face_end_col = hpos + 1;
12836 hlinfo->mouse_face_end_row = vpos;
12837 hlinfo->mouse_face_end_x = x + glyph->pixel_width;
12838 hlinfo->mouse_face_window = window;
12839 hlinfo->mouse_face_face_id = TOOL_BAR_FACE_ID;
12841 /* Display it as active. */
12842 show_mouse_face (hlinfo, draw);
12845 set_help_echo:
12847 /* Set help_echo_string to a help string to display for this tool-bar item.
12848 XTread_socket does the rest. */
12849 help_echo_object = help_echo_window = Qnil;
12850 help_echo_pos = -1;
12851 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_HELP);
12852 if (NILP (help_echo_string))
12853 help_echo_string = AREF (f->tool_bar_items, prop_idx + TOOL_BAR_ITEM_CAPTION);
12856 #endif /* !USE_GTK && !HAVE_NS */
12858 #endif /* HAVE_WINDOW_SYSTEM */
12862 /************************************************************************
12863 Horizontal scrolling
12864 ************************************************************************/
12866 static int hscroll_window_tree (Lisp_Object);
12867 static int hscroll_windows (Lisp_Object);
12869 /* For all leaf windows in the window tree rooted at WINDOW, set their
12870 hscroll value so that PT is (i) visible in the window, and (ii) so
12871 that it is not within a certain margin at the window's left and
12872 right border. Value is non-zero if any window's hscroll has been
12873 changed. */
12875 static int
12876 hscroll_window_tree (Lisp_Object window)
12878 int hscrolled_p = 0;
12879 int hscroll_relative_p = FLOATP (Vhscroll_step);
12880 int hscroll_step_abs = 0;
12881 double hscroll_step_rel = 0;
12883 if (hscroll_relative_p)
12885 hscroll_step_rel = XFLOAT_DATA (Vhscroll_step);
12886 if (hscroll_step_rel < 0)
12888 hscroll_relative_p = 0;
12889 hscroll_step_abs = 0;
12892 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step))
12894 hscroll_step_abs = XINT (Vhscroll_step);
12895 if (hscroll_step_abs < 0)
12896 hscroll_step_abs = 0;
12898 else
12899 hscroll_step_abs = 0;
12901 while (WINDOWP (window))
12903 struct window *w = XWINDOW (window);
12905 if (WINDOWP (w->contents))
12906 hscrolled_p |= hscroll_window_tree (w->contents);
12907 else if (w->cursor.vpos >= 0)
12909 int h_margin;
12910 int text_area_width;
12911 struct glyph_row *cursor_row;
12912 struct glyph_row *bottom_row;
12913 int row_r2l_p;
12915 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->desired_matrix, w);
12916 if (w->cursor.vpos < bottom_row - w->desired_matrix->rows)
12917 cursor_row = MATRIX_ROW (w->desired_matrix, w->cursor.vpos);
12918 else
12919 cursor_row = bottom_row - 1;
12921 if (!cursor_row->enabled_p)
12923 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
12924 if (w->cursor.vpos < bottom_row - w->current_matrix->rows)
12925 cursor_row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
12926 else
12927 cursor_row = bottom_row - 1;
12929 row_r2l_p = cursor_row->reversed_p;
12931 text_area_width = window_box_width (w, TEXT_AREA);
12933 /* Scroll when cursor is inside this scroll margin. */
12934 h_margin = hscroll_margin * WINDOW_FRAME_COLUMN_WIDTH (w);
12936 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode, w->contents))
12937 /* In some pathological cases, like restoring a window
12938 configuration into a frame that is much smaller than
12939 the one from which the configuration was saved, we
12940 get glyph rows whose start and end have zero buffer
12941 positions, which we cannot handle below. Just skip
12942 such windows. */
12943 && CHARPOS (cursor_row->start.pos) >= BUF_BEG (w->contents)
12944 /* For left-to-right rows, hscroll when cursor is either
12945 (i) inside the right hscroll margin, or (ii) if it is
12946 inside the left margin and the window is already
12947 hscrolled. */
12948 && ((!row_r2l_p
12949 && ((w->hscroll
12950 && w->cursor.x <= h_margin)
12951 || (cursor_row->enabled_p
12952 && cursor_row->truncated_on_right_p
12953 && (w->cursor.x >= text_area_width - h_margin))))
12954 /* For right-to-left rows, the logic is similar,
12955 except that rules for scrolling to left and right
12956 are reversed. E.g., if cursor.x <= h_margin, we
12957 need to hscroll "to the right" unconditionally,
12958 and that will scroll the screen to the left so as
12959 to reveal the next portion of the row. */
12960 || (row_r2l_p
12961 && ((cursor_row->enabled_p
12962 /* FIXME: It is confusing to set the
12963 truncated_on_right_p flag when R2L rows
12964 are actually truncated on the left. */
12965 && cursor_row->truncated_on_right_p
12966 && w->cursor.x <= h_margin)
12967 || (w->hscroll
12968 && (w->cursor.x >= text_area_width - h_margin))))))
12970 struct it it;
12971 ptrdiff_t hscroll;
12972 struct buffer *saved_current_buffer;
12973 ptrdiff_t pt;
12974 int wanted_x;
12976 /* Find point in a display of infinite width. */
12977 saved_current_buffer = current_buffer;
12978 current_buffer = XBUFFER (w->contents);
12980 if (w == XWINDOW (selected_window))
12981 pt = PT;
12982 else
12983 pt = clip_to_bounds (BEGV, marker_position (w->pointm), ZV);
12985 /* Move iterator to pt starting at cursor_row->start in
12986 a line with infinite width. */
12987 init_to_row_start (&it, w, cursor_row);
12988 it.last_visible_x = INFINITY;
12989 move_it_in_display_line_to (&it, pt, -1, MOVE_TO_POS);
12990 current_buffer = saved_current_buffer;
12992 /* Position cursor in window. */
12993 if (!hscroll_relative_p && hscroll_step_abs == 0)
12994 hscroll = max (0, (it.current_x
12995 - (ITERATOR_AT_END_OF_LINE_P (&it)
12996 ? (text_area_width - 4 * FRAME_COLUMN_WIDTH (it.f))
12997 : (text_area_width / 2))))
12998 / FRAME_COLUMN_WIDTH (it.f);
12999 else if ((!row_r2l_p
13000 && w->cursor.x >= text_area_width - h_margin)
13001 || (row_r2l_p && w->cursor.x <= h_margin))
13003 if (hscroll_relative_p)
13004 wanted_x = text_area_width * (1 - hscroll_step_rel)
13005 - h_margin;
13006 else
13007 wanted_x = text_area_width
13008 - hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
13009 - h_margin;
13010 hscroll
13011 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
13013 else
13015 if (hscroll_relative_p)
13016 wanted_x = text_area_width * hscroll_step_rel
13017 + h_margin;
13018 else
13019 wanted_x = hscroll_step_abs * FRAME_COLUMN_WIDTH (it.f)
13020 + h_margin;
13021 hscroll
13022 = max (0, it.current_x - wanted_x) / FRAME_COLUMN_WIDTH (it.f);
13024 hscroll = max (hscroll, w->min_hscroll);
13026 /* Don't prevent redisplay optimizations if hscroll
13027 hasn't changed, as it will unnecessarily slow down
13028 redisplay. */
13029 if (w->hscroll != hscroll)
13031 XBUFFER (w->contents)->prevent_redisplay_optimizations_p = 1;
13032 w->hscroll = hscroll;
13033 hscrolled_p = 1;
13038 window = w->next;
13041 /* Value is non-zero if hscroll of any leaf window has been changed. */
13042 return hscrolled_p;
13046 /* Set hscroll so that cursor is visible and not inside horizontal
13047 scroll margins for all windows in the tree rooted at WINDOW. See
13048 also hscroll_window_tree above. Value is non-zero if any window's
13049 hscroll has been changed. If it has, desired matrices on the frame
13050 of WINDOW are cleared. */
13052 static int
13053 hscroll_windows (Lisp_Object window)
13055 int hscrolled_p = hscroll_window_tree (window);
13056 if (hscrolled_p)
13057 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window))));
13058 return hscrolled_p;
13063 /************************************************************************
13064 Redisplay
13065 ************************************************************************/
13067 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13068 to a non-zero value. This is sometimes handy to have in a debugger
13069 session. */
13071 #ifdef GLYPH_DEBUG
13073 /* First and last unchanged row for try_window_id. */
13075 static int debug_first_unchanged_at_end_vpos;
13076 static int debug_last_unchanged_at_beg_vpos;
13078 /* Delta vpos and y. */
13080 static int debug_dvpos, debug_dy;
13082 /* Delta in characters and bytes for try_window_id. */
13084 static ptrdiff_t debug_delta, debug_delta_bytes;
13086 /* Values of window_end_pos and window_end_vpos at the end of
13087 try_window_id. */
13089 static ptrdiff_t debug_end_vpos;
13091 /* Append a string to W->desired_matrix->method. FMT is a printf
13092 format string. If trace_redisplay_p is true also printf the
13093 resulting string to stderr. */
13095 static void debug_method_add (struct window *, char const *, ...)
13096 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13098 static void
13099 debug_method_add (struct window *w, char const *fmt, ...)
13101 void *ptr = w;
13102 char *method = w->desired_matrix->method;
13103 int len = strlen (method);
13104 int size = sizeof w->desired_matrix->method;
13105 int remaining = size - len - 1;
13106 va_list ap;
13108 if (len && remaining)
13110 method[len] = '|';
13111 --remaining, ++len;
13114 va_start (ap, fmt);
13115 vsnprintf (method + len, remaining + 1, fmt, ap);
13116 va_end (ap);
13118 if (trace_redisplay_p)
13119 fprintf (stderr, "%p (%s): %s\n",
13120 ptr,
13121 ((BUFFERP (w->contents)
13122 && STRINGP (BVAR (XBUFFER (w->contents), name)))
13123 ? SSDATA (BVAR (XBUFFER (w->contents), name))
13124 : "no buffer"),
13125 method + len);
13128 #endif /* GLYPH_DEBUG */
13131 /* Value is non-zero if all changes in window W, which displays
13132 current_buffer, are in the text between START and END. START is a
13133 buffer position, END is given as a distance from Z. Used in
13134 redisplay_internal for display optimization. */
13136 static int
13137 text_outside_line_unchanged_p (struct window *w,
13138 ptrdiff_t start, ptrdiff_t end)
13140 int unchanged_p = 1;
13142 /* If text or overlays have changed, see where. */
13143 if (window_outdated (w))
13145 /* Gap in the line? */
13146 if (GPT < start || Z - GPT < end)
13147 unchanged_p = 0;
13149 /* Changes start in front of the line, or end after it? */
13150 if (unchanged_p
13151 && (BEG_UNCHANGED < start - 1
13152 || END_UNCHANGED < end))
13153 unchanged_p = 0;
13155 /* If selective display, can't optimize if changes start at the
13156 beginning of the line. */
13157 if (unchanged_p
13158 && INTEGERP (BVAR (current_buffer, selective_display))
13159 && XINT (BVAR (current_buffer, selective_display)) > 0
13160 && (BEG_UNCHANGED < start || GPT <= start))
13161 unchanged_p = 0;
13163 /* If there are overlays at the start or end of the line, these
13164 may have overlay strings with newlines in them. A change at
13165 START, for instance, may actually concern the display of such
13166 overlay strings as well, and they are displayed on different
13167 lines. So, quickly rule out this case. (For the future, it
13168 might be desirable to implement something more telling than
13169 just BEG/END_UNCHANGED.) */
13170 if (unchanged_p)
13172 if (BEG + BEG_UNCHANGED == start
13173 && overlay_touches_p (start))
13174 unchanged_p = 0;
13175 if (END_UNCHANGED == end
13176 && overlay_touches_p (Z - end))
13177 unchanged_p = 0;
13180 /* Under bidi reordering, adding or deleting a character in the
13181 beginning of a paragraph, before the first strong directional
13182 character, can change the base direction of the paragraph (unless
13183 the buffer specifies a fixed paragraph direction), which will
13184 require to redisplay the whole paragraph. It might be worthwhile
13185 to find the paragraph limits and widen the range of redisplayed
13186 lines to that, but for now just give up this optimization. */
13187 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
13188 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
13189 unchanged_p = 0;
13192 return unchanged_p;
13196 /* Do a frame update, taking possible shortcuts into account. This is
13197 the main external entry point for redisplay.
13199 If the last redisplay displayed an echo area message and that message
13200 is no longer requested, we clear the echo area or bring back the
13201 mini-buffer if that is in use. */
13203 void
13204 redisplay (void)
13206 redisplay_internal ();
13210 static Lisp_Object
13211 overlay_arrow_string_or_property (Lisp_Object var)
13213 Lisp_Object val;
13215 if (val = Fget (var, Qoverlay_arrow_string), STRINGP (val))
13216 return val;
13218 return Voverlay_arrow_string;
13221 /* Return 1 if there are any overlay-arrows in current_buffer. */
13222 static int
13223 overlay_arrow_in_current_buffer_p (void)
13225 Lisp_Object vlist;
13227 for (vlist = Voverlay_arrow_variable_list;
13228 CONSP (vlist);
13229 vlist = XCDR (vlist))
13231 Lisp_Object var = XCAR (vlist);
13232 Lisp_Object val;
13234 if (!SYMBOLP (var))
13235 continue;
13236 val = find_symbol_value (var);
13237 if (MARKERP (val)
13238 && current_buffer == XMARKER (val)->buffer)
13239 return 1;
13241 return 0;
13245 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13246 has changed. */
13248 static int
13249 overlay_arrows_changed_p (void)
13251 Lisp_Object vlist;
13253 for (vlist = Voverlay_arrow_variable_list;
13254 CONSP (vlist);
13255 vlist = XCDR (vlist))
13257 Lisp_Object var = XCAR (vlist);
13258 Lisp_Object val, pstr;
13260 if (!SYMBOLP (var))
13261 continue;
13262 val = find_symbol_value (var);
13263 if (!MARKERP (val))
13264 continue;
13265 if (! EQ (COERCE_MARKER (val),
13266 Fget (var, Qlast_arrow_position))
13267 || ! (pstr = overlay_arrow_string_or_property (var),
13268 EQ (pstr, Fget (var, Qlast_arrow_string))))
13269 return 1;
13271 return 0;
13274 /* Mark overlay arrows to be updated on next redisplay. */
13276 static void
13277 update_overlay_arrows (int up_to_date)
13279 Lisp_Object vlist;
13281 for (vlist = Voverlay_arrow_variable_list;
13282 CONSP (vlist);
13283 vlist = XCDR (vlist))
13285 Lisp_Object var = XCAR (vlist);
13287 if (!SYMBOLP (var))
13288 continue;
13290 if (up_to_date > 0)
13292 Lisp_Object val = find_symbol_value (var);
13293 Fput (var, Qlast_arrow_position,
13294 COERCE_MARKER (val));
13295 Fput (var, Qlast_arrow_string,
13296 overlay_arrow_string_or_property (var));
13298 else if (up_to_date < 0
13299 || !NILP (Fget (var, Qlast_arrow_position)))
13301 Fput (var, Qlast_arrow_position, Qt);
13302 Fput (var, Qlast_arrow_string, Qt);
13308 /* Return overlay arrow string to display at row.
13309 Return integer (bitmap number) for arrow bitmap in left fringe.
13310 Return nil if no overlay arrow. */
13312 static Lisp_Object
13313 overlay_arrow_at_row (struct it *it, struct glyph_row *row)
13315 Lisp_Object vlist;
13317 for (vlist = Voverlay_arrow_variable_list;
13318 CONSP (vlist);
13319 vlist = XCDR (vlist))
13321 Lisp_Object var = XCAR (vlist);
13322 Lisp_Object val;
13324 if (!SYMBOLP (var))
13325 continue;
13327 val = find_symbol_value (var);
13329 if (MARKERP (val)
13330 && current_buffer == XMARKER (val)->buffer
13331 && (MATRIX_ROW_START_CHARPOS (row) == marker_position (val)))
13333 if (FRAME_WINDOW_P (it->f)
13334 /* FIXME: if ROW->reversed_p is set, this should test
13335 the right fringe, not the left one. */
13336 && WINDOW_LEFT_FRINGE_WIDTH (it->w) > 0)
13338 #ifdef HAVE_WINDOW_SYSTEM
13339 if (val = Fget (var, Qoverlay_arrow_bitmap), SYMBOLP (val))
13341 int fringe_bitmap;
13342 if ((fringe_bitmap = lookup_fringe_bitmap (val)) != 0)
13343 return make_number (fringe_bitmap);
13345 #endif
13346 return make_number (-1); /* Use default arrow bitmap. */
13348 return overlay_arrow_string_or_property (var);
13352 return Qnil;
13355 /* Return 1 if point moved out of or into a composition. Otherwise
13356 return 0. PREV_BUF and PREV_PT are the last point buffer and
13357 position. BUF and PT are the current point buffer and position. */
13359 static int
13360 check_point_in_composition (struct buffer *prev_buf, ptrdiff_t prev_pt,
13361 struct buffer *buf, ptrdiff_t pt)
13363 ptrdiff_t start, end;
13364 Lisp_Object prop;
13365 Lisp_Object buffer;
13367 XSETBUFFER (buffer, buf);
13368 /* Check a composition at the last point if point moved within the
13369 same buffer. */
13370 if (prev_buf == buf)
13372 if (prev_pt == pt)
13373 /* Point didn't move. */
13374 return 0;
13376 if (prev_pt > BUF_BEGV (buf) && prev_pt < BUF_ZV (buf)
13377 && find_composition (prev_pt, -1, &start, &end, &prop, buffer)
13378 && composition_valid_p (start, end, prop)
13379 && start < prev_pt && end > prev_pt)
13380 /* The last point was within the composition. Return 1 iff
13381 point moved out of the composition. */
13382 return (pt <= start || pt >= end);
13385 /* Check a composition at the current point. */
13386 return (pt > BUF_BEGV (buf) && pt < BUF_ZV (buf)
13387 && find_composition (pt, -1, &start, &end, &prop, buffer)
13388 && composition_valid_p (start, end, prop)
13389 && start < pt && end > pt);
13392 /* Reconsider the clip changes of buffer which is displayed in W. */
13394 static void
13395 reconsider_clip_changes (struct window *w)
13397 struct buffer *b = XBUFFER (w->contents);
13399 if (b->clip_changed
13400 && w->window_end_valid
13401 && w->current_matrix->buffer == b
13402 && w->current_matrix->zv == BUF_ZV (b)
13403 && w->current_matrix->begv == BUF_BEGV (b))
13404 b->clip_changed = 0;
13406 /* If display wasn't paused, and W is not a tool bar window, see if
13407 point has been moved into or out of a composition. In that case,
13408 we set b->clip_changed to 1 to force updating the screen. If
13409 b->clip_changed has already been set to 1, we can skip this
13410 check. */
13411 if (!b->clip_changed && w->window_end_valid)
13413 ptrdiff_t pt = (w == XWINDOW (selected_window)
13414 ? PT : marker_position (w->pointm));
13416 if ((w->current_matrix->buffer != b || pt != w->last_point)
13417 && check_point_in_composition (w->current_matrix->buffer,
13418 w->last_point, b, pt))
13419 b->clip_changed = 1;
13423 static void
13424 propagate_buffer_redisplay (void)
13425 { /* Resetting b->text->redisplay is problematic!
13426 We can't just reset it in the case that some window that displays
13427 it has not been redisplayed; and such a window can stay
13428 unredisplayed for a long time if it's currently invisible.
13429 But we do want to reset it at the end of redisplay otherwise
13430 its displayed windows will keep being redisplayed over and over
13431 again.
13432 So we copy all b->text->redisplay flags up to their windows here,
13433 such that mark_window_display_accurate can safely reset
13434 b->text->redisplay. */
13435 Lisp_Object ws = window_list ();
13436 for (; CONSP (ws); ws = XCDR (ws))
13438 struct window *thisw = XWINDOW (XCAR (ws));
13439 struct buffer *thisb = XBUFFER (thisw->contents);
13440 if (thisb->text->redisplay)
13441 thisw->redisplay = true;
13445 #define STOP_POLLING \
13446 do { if (! polling_stopped_here) stop_polling (); \
13447 polling_stopped_here = 1; } while (0)
13449 #define RESUME_POLLING \
13450 do { if (polling_stopped_here) start_polling (); \
13451 polling_stopped_here = 0; } while (0)
13454 /* Perhaps in the future avoid recentering windows if it
13455 is not necessary; currently that causes some problems. */
13457 static void
13458 redisplay_internal (void)
13460 struct window *w = XWINDOW (selected_window);
13461 struct window *sw;
13462 struct frame *fr;
13463 int pending;
13464 bool must_finish = 0, match_p;
13465 struct text_pos tlbufpos, tlendpos;
13466 int number_of_visible_frames;
13467 ptrdiff_t count;
13468 struct frame *sf;
13469 int polling_stopped_here = 0;
13470 Lisp_Object tail, frame;
13472 /* True means redisplay has to consider all windows on all
13473 frames. False, only selected_window is considered. */
13474 bool consider_all_windows_p;
13476 /* True means redisplay has to redisplay the miniwindow. */
13477 bool update_miniwindow_p = false;
13479 TRACE ((stderr, "redisplay_internal %d\n", redisplaying_p));
13481 /* No redisplay if running in batch mode or frame is not yet fully
13482 initialized, or redisplay is explicitly turned off by setting
13483 Vinhibit_redisplay. */
13484 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13485 || !NILP (Vinhibit_redisplay))
13486 return;
13488 /* Don't examine these until after testing Vinhibit_redisplay.
13489 When Emacs is shutting down, perhaps because its connection to
13490 X has dropped, we should not look at them at all. */
13491 fr = XFRAME (w->frame);
13492 sf = SELECTED_FRAME ();
13494 if (!fr->glyphs_initialized_p)
13495 return;
13497 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13498 if (popup_activated ())
13499 return;
13500 #endif
13502 /* I don't think this happens but let's be paranoid. */
13503 if (redisplaying_p)
13504 return;
13506 /* Record a function that clears redisplaying_p
13507 when we leave this function. */
13508 count = SPECPDL_INDEX ();
13509 record_unwind_protect_void (unwind_redisplay);
13510 redisplaying_p = 1;
13511 specbind (Qinhibit_free_realized_faces, Qnil);
13513 /* Record this function, so it appears on the profiler's backtraces. */
13514 record_in_backtrace (Qredisplay_internal, &Qnil, 0);
13516 FOR_EACH_FRAME (tail, frame)
13517 XFRAME (frame)->already_hscrolled_p = 0;
13519 retry:
13520 /* Remember the currently selected window. */
13521 sw = w;
13523 pending = 0;
13524 last_escape_glyph_frame = NULL;
13525 last_escape_glyph_face_id = (1 << FACE_ID_BITS);
13526 last_glyphless_glyph_frame = NULL;
13527 last_glyphless_glyph_face_id = (1 << FACE_ID_BITS);
13529 /* If face_change_count is non-zero, init_iterator will free all
13530 realized faces, which includes the faces referenced from current
13531 matrices. So, we can't reuse current matrices in this case. */
13532 if (face_change_count)
13533 windows_or_buffers_changed = 47;
13535 if ((FRAME_TERMCAP_P (sf) || FRAME_MSDOS_P (sf))
13536 && FRAME_TTY (sf)->previous_frame != sf)
13538 /* Since frames on a single ASCII terminal share the same
13539 display area, displaying a different frame means redisplay
13540 the whole thing. */
13541 SET_FRAME_GARBAGED (sf);
13542 #ifndef DOS_NT
13543 set_tty_color_mode (FRAME_TTY (sf), sf);
13544 #endif
13545 FRAME_TTY (sf)->previous_frame = sf;
13548 /* Set the visible flags for all frames. Do this before checking for
13549 resized or garbaged frames; they want to know if their frames are
13550 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13551 number_of_visible_frames = 0;
13553 FOR_EACH_FRAME (tail, frame)
13555 struct frame *f = XFRAME (frame);
13557 if (FRAME_VISIBLE_P (f))
13559 ++number_of_visible_frames;
13560 /* Adjust matrices for visible frames only. */
13561 if (f->fonts_changed)
13563 adjust_frame_glyphs (f);
13564 f->fonts_changed = 0;
13566 /* If cursor type has been changed on the frame
13567 other than selected, consider all frames. */
13568 if (f != sf && f->cursor_type_changed)
13569 update_mode_lines = 31;
13571 clear_desired_matrices (f);
13574 /* Notice any pending interrupt request to change frame size. */
13575 do_pending_window_change (1);
13577 /* do_pending_window_change could change the selected_window due to
13578 frame resizing which makes the selected window too small. */
13579 if (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw)
13580 sw = w;
13582 /* Clear frames marked as garbaged. */
13583 clear_garbaged_frames ();
13585 /* Build menubar and tool-bar items. */
13586 if (NILP (Vmemory_full))
13587 prepare_menu_bars ();
13589 reconsider_clip_changes (w);
13591 /* In most cases selected window displays current buffer. */
13592 match_p = XBUFFER (w->contents) == current_buffer;
13593 if (match_p)
13595 /* Detect case that we need to write or remove a star in the mode line. */
13596 if ((SAVE_MODIFF < MODIFF) != w->last_had_star)
13597 w->update_mode_line = 1;
13599 if (mode_line_update_needed (w))
13600 w->update_mode_line = 1;
13603 /* Normally the message* functions will have already displayed and
13604 updated the echo area, but the frame may have been trashed, or
13605 the update may have been preempted, so display the echo area
13606 again here. Checking message_cleared_p captures the case that
13607 the echo area should be cleared. */
13608 if ((!NILP (echo_area_buffer[0]) && !display_last_displayed_message_p)
13609 || (!NILP (echo_area_buffer[1]) && display_last_displayed_message_p)
13610 || (message_cleared_p
13611 && minibuf_level == 0
13612 /* If the mini-window is currently selected, this means the
13613 echo-area doesn't show through. */
13614 && !MINI_WINDOW_P (XWINDOW (selected_window))))
13616 int window_height_changed_p = echo_area_display (0);
13618 if (message_cleared_p)
13619 update_miniwindow_p = true;
13621 must_finish = 1;
13623 /* If we don't display the current message, don't clear the
13624 message_cleared_p flag, because, if we did, we wouldn't clear
13625 the echo area in the next redisplay which doesn't preserve
13626 the echo area. */
13627 if (!display_last_displayed_message_p)
13628 message_cleared_p = 0;
13630 if (window_height_changed_p)
13632 windows_or_buffers_changed = 50;
13634 /* If window configuration was changed, frames may have been
13635 marked garbaged. Clear them or we will experience
13636 surprises wrt scrolling. */
13637 clear_garbaged_frames ();
13640 else if (EQ (selected_window, minibuf_window)
13641 && (current_buffer->clip_changed || window_outdated (w))
13642 && resize_mini_window (w, 0))
13644 /* Resized active mini-window to fit the size of what it is
13645 showing if its contents might have changed. */
13646 must_finish = 1;
13648 /* If window configuration was changed, frames may have been
13649 marked garbaged. Clear them or we will experience
13650 surprises wrt scrolling. */
13651 clear_garbaged_frames ();
13654 if (windows_or_buffers_changed && !update_mode_lines)
13655 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13656 only the windows's contents needs to be refreshed, or whether the
13657 mode-lines also need a refresh. */
13658 update_mode_lines = (windows_or_buffers_changed == REDISPLAY_SOME
13659 ? REDISPLAY_SOME : 32);
13661 /* If specs for an arrow have changed, do thorough redisplay
13662 to ensure we remove any arrow that should no longer exist. */
13663 if (overlay_arrows_changed_p ())
13664 /* Apparently, this is the only case where we update other windows,
13665 without updating other mode-lines. */
13666 windows_or_buffers_changed = 49;
13668 consider_all_windows_p = (update_mode_lines
13669 || windows_or_buffers_changed);
13671 #define AINC(a,i) \
13672 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13673 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13675 AINC (Vredisplay__all_windows_cause, windows_or_buffers_changed);
13676 AINC (Vredisplay__mode_lines_cause, update_mode_lines);
13678 /* Optimize the case that only the line containing the cursor in the
13679 selected window has changed. Variables starting with this_ are
13680 set in display_line and record information about the line
13681 containing the cursor. */
13682 tlbufpos = this_line_start_pos;
13683 tlendpos = this_line_end_pos;
13684 if (!consider_all_windows_p
13685 && CHARPOS (tlbufpos) > 0
13686 && !w->update_mode_line
13687 && !current_buffer->clip_changed
13688 && !current_buffer->prevent_redisplay_optimizations_p
13689 && FRAME_VISIBLE_P (XFRAME (w->frame))
13690 && !FRAME_OBSCURED_P (XFRAME (w->frame))
13691 && !XFRAME (w->frame)->cursor_type_changed
13692 /* Make sure recorded data applies to current buffer, etc. */
13693 && this_line_buffer == current_buffer
13694 && match_p
13695 && !w->force_start
13696 && !w->optional_new_start
13697 /* Point must be on the line that we have info recorded about. */
13698 && PT >= CHARPOS (tlbufpos)
13699 && PT <= Z - CHARPOS (tlendpos)
13700 /* All text outside that line, including its final newline,
13701 must be unchanged. */
13702 && text_outside_line_unchanged_p (w, CHARPOS (tlbufpos),
13703 CHARPOS (tlendpos)))
13705 if (CHARPOS (tlbufpos) > BEGV
13706 && FETCH_BYTE (BYTEPOS (tlbufpos) - 1) != '\n'
13707 && (CHARPOS (tlbufpos) == ZV
13708 || FETCH_BYTE (BYTEPOS (tlbufpos)) == '\n'))
13709 /* Former continuation line has disappeared by becoming empty. */
13710 goto cancel;
13711 else if (window_outdated (w) || MINI_WINDOW_P (w))
13713 /* We have to handle the case of continuation around a
13714 wide-column character (see the comment in indent.c around
13715 line 1340).
13717 For instance, in the following case:
13719 -------- Insert --------
13720 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13721 J_I_ ==> J_I_ `^^' are cursors.
13722 ^^ ^^
13723 -------- --------
13725 As we have to redraw the line above, we cannot use this
13726 optimization. */
13728 struct it it;
13729 int line_height_before = this_line_pixel_height;
13731 /* Note that start_display will handle the case that the
13732 line starting at tlbufpos is a continuation line. */
13733 start_display (&it, w, tlbufpos);
13735 /* Implementation note: It this still necessary? */
13736 if (it.current_x != this_line_start_x)
13737 goto cancel;
13739 TRACE ((stderr, "trying display optimization 1\n"));
13740 w->cursor.vpos = -1;
13741 overlay_arrow_seen = 0;
13742 it.vpos = this_line_vpos;
13743 it.current_y = this_line_y;
13744 it.glyph_row = MATRIX_ROW (w->desired_matrix, this_line_vpos);
13745 display_line (&it);
13747 /* If line contains point, is not continued,
13748 and ends at same distance from eob as before, we win. */
13749 if (w->cursor.vpos >= 0
13750 /* Line is not continued, otherwise this_line_start_pos
13751 would have been set to 0 in display_line. */
13752 && CHARPOS (this_line_start_pos)
13753 /* Line ends as before. */
13754 && CHARPOS (this_line_end_pos) == CHARPOS (tlendpos)
13755 /* Line has same height as before. Otherwise other lines
13756 would have to be shifted up or down. */
13757 && this_line_pixel_height == line_height_before)
13759 /* If this is not the window's last line, we must adjust
13760 the charstarts of the lines below. */
13761 if (it.current_y < it.last_visible_y)
13763 struct glyph_row *row
13764 = MATRIX_ROW (w->current_matrix, this_line_vpos + 1);
13765 ptrdiff_t delta, delta_bytes;
13767 /* We used to distinguish between two cases here,
13768 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13769 when the line ends in a newline or the end of the
13770 buffer's accessible portion. But both cases did
13771 the same, so they were collapsed. */
13772 delta = (Z
13773 - CHARPOS (tlendpos)
13774 - MATRIX_ROW_START_CHARPOS (row));
13775 delta_bytes = (Z_BYTE
13776 - BYTEPOS (tlendpos)
13777 - MATRIX_ROW_START_BYTEPOS (row));
13779 increment_matrix_positions (w->current_matrix,
13780 this_line_vpos + 1,
13781 w->current_matrix->nrows,
13782 delta, delta_bytes);
13785 /* If this row displays text now but previously didn't,
13786 or vice versa, w->window_end_vpos may have to be
13787 adjusted. */
13788 if (MATRIX_ROW_DISPLAYS_TEXT_P (it.glyph_row - 1))
13790 if (w->window_end_vpos < this_line_vpos)
13791 w->window_end_vpos = this_line_vpos;
13793 else if (w->window_end_vpos == this_line_vpos
13794 && this_line_vpos > 0)
13795 w->window_end_vpos = this_line_vpos - 1;
13796 w->window_end_valid = 0;
13798 /* Update hint: No need to try to scroll in update_window. */
13799 w->desired_matrix->no_scrolling_p = 1;
13801 #ifdef GLYPH_DEBUG
13802 *w->desired_matrix->method = 0;
13803 debug_method_add (w, "optimization 1");
13804 #endif
13805 #ifdef HAVE_WINDOW_SYSTEM
13806 update_window_fringes (w, 0);
13807 #endif
13808 goto update;
13810 else
13811 goto cancel;
13813 else if (/* Cursor position hasn't changed. */
13814 PT == w->last_point
13815 /* Make sure the cursor was last displayed
13816 in this window. Otherwise we have to reposition it. */
13818 /* PXW: Must be converted to pixels, probably. */
13819 && 0 <= w->cursor.vpos
13820 && w->cursor.vpos < WINDOW_TOTAL_LINES (w))
13822 if (!must_finish)
13824 do_pending_window_change (1);
13825 /* If selected_window changed, redisplay again. */
13826 if (WINDOWP (selected_window)
13827 && (w = XWINDOW (selected_window)) != sw)
13828 goto retry;
13830 /* We used to always goto end_of_redisplay here, but this
13831 isn't enough if we have a blinking cursor. */
13832 if (w->cursor_off_p == w->last_cursor_off_p)
13833 goto end_of_redisplay;
13835 goto update;
13837 /* If highlighting the region, or if the cursor is in the echo area,
13838 then we can't just move the cursor. */
13839 else if (NILP (Vshow_trailing_whitespace)
13840 && !cursor_in_echo_area)
13842 struct it it;
13843 struct glyph_row *row;
13845 /* Skip from tlbufpos to PT and see where it is. Note that
13846 PT may be in invisible text. If so, we will end at the
13847 next visible position. */
13848 init_iterator (&it, w, CHARPOS (tlbufpos), BYTEPOS (tlbufpos),
13849 NULL, DEFAULT_FACE_ID);
13850 it.current_x = this_line_start_x;
13851 it.current_y = this_line_y;
13852 it.vpos = this_line_vpos;
13854 /* The call to move_it_to stops in front of PT, but
13855 moves over before-strings. */
13856 move_it_to (&it, PT, -1, -1, -1, MOVE_TO_POS);
13858 if (it.vpos == this_line_vpos
13859 && (row = MATRIX_ROW (w->current_matrix, this_line_vpos),
13860 row->enabled_p))
13862 eassert (this_line_vpos == it.vpos);
13863 eassert (this_line_y == it.current_y);
13864 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
13865 #ifdef GLYPH_DEBUG
13866 *w->desired_matrix->method = 0;
13867 debug_method_add (w, "optimization 3");
13868 #endif
13869 goto update;
13871 else
13872 goto cancel;
13875 cancel:
13876 /* Text changed drastically or point moved off of line. */
13877 SET_MATRIX_ROW_ENABLED_P (w->desired_matrix, this_line_vpos, false);
13880 CHARPOS (this_line_start_pos) = 0;
13881 ++clear_face_cache_count;
13882 #ifdef HAVE_WINDOW_SYSTEM
13883 ++clear_image_cache_count;
13884 #endif
13886 /* Build desired matrices, and update the display. If
13887 consider_all_windows_p is non-zero, do it for all windows on all
13888 frames. Otherwise do it for selected_window, only. */
13890 if (consider_all_windows_p)
13892 FOR_EACH_FRAME (tail, frame)
13893 XFRAME (frame)->updated_p = 0;
13895 propagate_buffer_redisplay ();
13897 FOR_EACH_FRAME (tail, frame)
13899 struct frame *f = XFRAME (frame);
13901 /* We don't have to do anything for unselected terminal
13902 frames. */
13903 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
13904 && !EQ (FRAME_TTY (f)->top_frame, frame))
13905 continue;
13907 retry_frame:
13909 if (FRAME_WINDOW_P (f) || FRAME_TERMCAP_P (f) || f == sf)
13911 bool gcscrollbars
13912 /* Only GC scrollbars when we redisplay the whole frame. */
13913 = f->redisplay || !REDISPLAY_SOME_P ();
13914 /* Mark all the scroll bars to be removed; we'll redeem
13915 the ones we want when we redisplay their windows. */
13916 if (gcscrollbars && FRAME_TERMINAL (f)->condemn_scroll_bars_hook)
13917 FRAME_TERMINAL (f)->condemn_scroll_bars_hook (f);
13919 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13920 redisplay_windows (FRAME_ROOT_WINDOW (f));
13921 /* Remember that the invisible frames need to be redisplayed next
13922 time they're visible. */
13923 else if (!REDISPLAY_SOME_P ())
13924 f->redisplay = true;
13926 /* The X error handler may have deleted that frame. */
13927 if (!FRAME_LIVE_P (f))
13928 continue;
13930 /* Any scroll bars which redisplay_windows should have
13931 nuked should now go away. */
13932 if (gcscrollbars && FRAME_TERMINAL (f)->judge_scroll_bars_hook)
13933 FRAME_TERMINAL (f)->judge_scroll_bars_hook (f);
13935 if (FRAME_VISIBLE_P (f) && !FRAME_OBSCURED_P (f))
13937 /* If fonts changed on visible frame, display again. */
13938 if (f->fonts_changed)
13940 adjust_frame_glyphs (f);
13941 f->fonts_changed = 0;
13942 goto retry_frame;
13945 /* See if we have to hscroll. */
13946 if (!f->already_hscrolled_p)
13948 f->already_hscrolled_p = 1;
13949 if (hscroll_windows (f->root_window))
13950 goto retry_frame;
13953 /* Prevent various kinds of signals during display
13954 update. stdio is not robust about handling
13955 signals, which can cause an apparent I/O error. */
13956 if (interrupt_input)
13957 unrequest_sigio ();
13958 STOP_POLLING;
13960 pending |= update_frame (f, 0, 0);
13961 f->cursor_type_changed = 0;
13962 f->updated_p = 1;
13967 eassert (EQ (XFRAME (selected_frame)->selected_window, selected_window));
13969 if (!pending)
13971 /* Do the mark_window_display_accurate after all windows have
13972 been redisplayed because this call resets flags in buffers
13973 which are needed for proper redisplay. */
13974 FOR_EACH_FRAME (tail, frame)
13976 struct frame *f = XFRAME (frame);
13977 if (f->updated_p)
13979 f->redisplay = false;
13980 mark_window_display_accurate (f->root_window, 1);
13981 if (FRAME_TERMINAL (f)->frame_up_to_date_hook)
13982 FRAME_TERMINAL (f)->frame_up_to_date_hook (f);
13987 else if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
13989 Lisp_Object mini_window = FRAME_MINIBUF_WINDOW (sf);
13990 struct frame *mini_frame;
13992 displayed_buffer = XBUFFER (XWINDOW (selected_window)->contents);
13993 /* Use list_of_error, not Qerror, so that
13994 we catch only errors and don't run the debugger. */
13995 internal_condition_case_1 (redisplay_window_1, selected_window,
13996 list_of_error,
13997 redisplay_window_error);
13998 if (update_miniwindow_p)
13999 internal_condition_case_1 (redisplay_window_1, mini_window,
14000 list_of_error,
14001 redisplay_window_error);
14003 /* Compare desired and current matrices, perform output. */
14005 update:
14006 /* If fonts changed, display again. */
14007 if (sf->fonts_changed)
14008 goto retry;
14010 /* Prevent various kinds of signals during display update.
14011 stdio is not robust about handling signals,
14012 which can cause an apparent I/O error. */
14013 if (interrupt_input)
14014 unrequest_sigio ();
14015 STOP_POLLING;
14017 if (FRAME_VISIBLE_P (sf) && !FRAME_OBSCURED_P (sf))
14019 if (hscroll_windows (selected_window))
14020 goto retry;
14022 XWINDOW (selected_window)->must_be_updated_p = true;
14023 pending = update_frame (sf, 0, 0);
14024 sf->cursor_type_changed = 0;
14027 /* We may have called echo_area_display at the top of this
14028 function. If the echo area is on another frame, that may
14029 have put text on a frame other than the selected one, so the
14030 above call to update_frame would not have caught it. Catch
14031 it here. */
14032 mini_window = FRAME_MINIBUF_WINDOW (sf);
14033 mini_frame = XFRAME (WINDOW_FRAME (XWINDOW (mini_window)));
14035 if (mini_frame != sf && FRAME_WINDOW_P (mini_frame))
14037 XWINDOW (mini_window)->must_be_updated_p = true;
14038 pending |= update_frame (mini_frame, 0, 0);
14039 mini_frame->cursor_type_changed = 0;
14040 if (!pending && hscroll_windows (mini_window))
14041 goto retry;
14045 /* If display was paused because of pending input, make sure we do a
14046 thorough update the next time. */
14047 if (pending)
14049 /* Prevent the optimization at the beginning of
14050 redisplay_internal that tries a single-line update of the
14051 line containing the cursor in the selected window. */
14052 CHARPOS (this_line_start_pos) = 0;
14054 /* Let the overlay arrow be updated the next time. */
14055 update_overlay_arrows (0);
14057 /* If we pause after scrolling, some rows in the current
14058 matrices of some windows are not valid. */
14059 if (!WINDOW_FULL_WIDTH_P (w)
14060 && !FRAME_WINDOW_P (XFRAME (w->frame)))
14061 update_mode_lines = 36;
14063 else
14065 if (!consider_all_windows_p)
14067 /* This has already been done above if
14068 consider_all_windows_p is set. */
14069 if (XBUFFER (w->contents)->text->redisplay
14070 && buffer_window_count (XBUFFER (w->contents)) > 1)
14071 /* This can happen if b->text->redisplay was set during
14072 jit-lock. */
14073 propagate_buffer_redisplay ();
14074 mark_window_display_accurate_1 (w, 1);
14076 /* Say overlay arrows are up to date. */
14077 update_overlay_arrows (1);
14079 if (FRAME_TERMINAL (sf)->frame_up_to_date_hook != 0)
14080 FRAME_TERMINAL (sf)->frame_up_to_date_hook (sf);
14083 update_mode_lines = 0;
14084 windows_or_buffers_changed = 0;
14087 /* Start SIGIO interrupts coming again. Having them off during the
14088 code above makes it less likely one will discard output, but not
14089 impossible, since there might be stuff in the system buffer here.
14090 But it is much hairier to try to do anything about that. */
14091 if (interrupt_input)
14092 request_sigio ();
14093 RESUME_POLLING;
14095 /* If a frame has become visible which was not before, redisplay
14096 again, so that we display it. Expose events for such a frame
14097 (which it gets when becoming visible) don't call the parts of
14098 redisplay constructing glyphs, so simply exposing a frame won't
14099 display anything in this case. So, we have to display these
14100 frames here explicitly. */
14101 if (!pending)
14103 int new_count = 0;
14105 FOR_EACH_FRAME (tail, frame)
14107 if (XFRAME (frame)->visible)
14108 new_count++;
14111 if (new_count != number_of_visible_frames)
14112 windows_or_buffers_changed = 52;
14115 /* Change frame size now if a change is pending. */
14116 do_pending_window_change (1);
14118 /* If we just did a pending size change, or have additional
14119 visible frames, or selected_window changed, redisplay again. */
14120 if ((windows_or_buffers_changed && !pending)
14121 || (WINDOWP (selected_window) && (w = XWINDOW (selected_window)) != sw))
14122 goto retry;
14124 /* Clear the face and image caches.
14126 We used to do this only if consider_all_windows_p. But the cache
14127 needs to be cleared if a timer creates images in the current
14128 buffer (e.g. the test case in Bug#6230). */
14130 if (clear_face_cache_count > CLEAR_FACE_CACHE_COUNT)
14132 clear_face_cache (0);
14133 clear_face_cache_count = 0;
14136 #ifdef HAVE_WINDOW_SYSTEM
14137 if (clear_image_cache_count > CLEAR_IMAGE_CACHE_COUNT)
14139 clear_image_caches (Qnil);
14140 clear_image_cache_count = 0;
14142 #endif /* HAVE_WINDOW_SYSTEM */
14144 end_of_redisplay:
14145 if (interrupt_input && interrupts_deferred)
14146 request_sigio ();
14148 unbind_to (count, Qnil);
14149 RESUME_POLLING;
14153 /* Redisplay, but leave alone any recent echo area message unless
14154 another message has been requested in its place.
14156 This is useful in situations where you need to redisplay but no
14157 user action has occurred, making it inappropriate for the message
14158 area to be cleared. See tracking_off and
14159 wait_reading_process_output for examples of these situations.
14161 FROM_WHERE is an integer saying from where this function was
14162 called. This is useful for debugging. */
14164 void
14165 redisplay_preserve_echo_area (int from_where)
14167 TRACE ((stderr, "redisplay_preserve_echo_area (%d)\n", from_where));
14169 if (!NILP (echo_area_buffer[1]))
14171 /* We have a previously displayed message, but no current
14172 message. Redisplay the previous message. */
14173 display_last_displayed_message_p = 1;
14174 redisplay_internal ();
14175 display_last_displayed_message_p = 0;
14177 else
14178 redisplay_internal ();
14180 flush_frame (SELECTED_FRAME ());
14184 /* Function registered with record_unwind_protect in redisplay_internal. */
14186 static void
14187 unwind_redisplay (void)
14189 redisplaying_p = 0;
14193 /* Mark the display of leaf window W as accurate or inaccurate.
14194 If ACCURATE_P is non-zero mark display of W as accurate. If
14195 ACCURATE_P is zero, arrange for W to be redisplayed the next
14196 time redisplay_internal is called. */
14198 static void
14199 mark_window_display_accurate_1 (struct window *w, int accurate_p)
14201 struct buffer *b = XBUFFER (w->contents);
14203 w->last_modified = accurate_p ? BUF_MODIFF (b) : 0;
14204 w->last_overlay_modified = accurate_p ? BUF_OVERLAY_MODIFF (b) : 0;
14205 w->last_had_star = BUF_MODIFF (b) > BUF_SAVE_MODIFF (b);
14207 if (accurate_p)
14209 b->clip_changed = false;
14210 b->prevent_redisplay_optimizations_p = false;
14211 eassert (buffer_window_count (b) > 0);
14212 /* Resetting b->text->redisplay is problematic!
14213 In order to make it safer to do it here, redisplay_internal must
14214 have copied all b->text->redisplay to their respective windows. */
14215 b->text->redisplay = false;
14217 BUF_UNCHANGED_MODIFIED (b) = BUF_MODIFF (b);
14218 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = BUF_OVERLAY_MODIFF (b);
14219 BUF_BEG_UNCHANGED (b) = BUF_GPT (b) - BUF_BEG (b);
14220 BUF_END_UNCHANGED (b) = BUF_Z (b) - BUF_GPT (b);
14222 w->current_matrix->buffer = b;
14223 w->current_matrix->begv = BUF_BEGV (b);
14224 w->current_matrix->zv = BUF_ZV (b);
14226 w->last_cursor_vpos = w->cursor.vpos;
14227 w->last_cursor_off_p = w->cursor_off_p;
14229 if (w == XWINDOW (selected_window))
14230 w->last_point = BUF_PT (b);
14231 else
14232 w->last_point = marker_position (w->pointm);
14234 w->window_end_valid = true;
14235 w->update_mode_line = false;
14238 w->redisplay = !accurate_p;
14242 /* Mark the display of windows in the window tree rooted at WINDOW as
14243 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14244 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14245 be redisplayed the next time redisplay_internal is called. */
14247 void
14248 mark_window_display_accurate (Lisp_Object window, int accurate_p)
14250 struct window *w;
14252 for (; !NILP (window); window = w->next)
14254 w = XWINDOW (window);
14255 if (WINDOWP (w->contents))
14256 mark_window_display_accurate (w->contents, accurate_p);
14257 else
14258 mark_window_display_accurate_1 (w, accurate_p);
14261 if (accurate_p)
14262 update_overlay_arrows (1);
14263 else
14264 /* Force a thorough redisplay the next time by setting
14265 last_arrow_position and last_arrow_string to t, which is
14266 unequal to any useful value of Voverlay_arrow_... */
14267 update_overlay_arrows (-1);
14271 /* Return value in display table DP (Lisp_Char_Table *) for character
14272 C. Since a display table doesn't have any parent, we don't have to
14273 follow parent. Do not call this function directly but use the
14274 macro DISP_CHAR_VECTOR. */
14276 Lisp_Object
14277 disp_char_vector (struct Lisp_Char_Table *dp, int c)
14279 Lisp_Object val;
14281 if (ASCII_CHAR_P (c))
14283 val = dp->ascii;
14284 if (SUB_CHAR_TABLE_P (val))
14285 val = XSUB_CHAR_TABLE (val)->contents[c];
14287 else
14289 Lisp_Object table;
14291 XSETCHAR_TABLE (table, dp);
14292 val = char_table_ref (table, c);
14294 if (NILP (val))
14295 val = dp->defalt;
14296 return val;
14301 /***********************************************************************
14302 Window Redisplay
14303 ***********************************************************************/
14305 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14307 static void
14308 redisplay_windows (Lisp_Object window)
14310 while (!NILP (window))
14312 struct window *w = XWINDOW (window);
14314 if (WINDOWP (w->contents))
14315 redisplay_windows (w->contents);
14316 else if (BUFFERP (w->contents))
14318 displayed_buffer = XBUFFER (w->contents);
14319 /* Use list_of_error, not Qerror, so that
14320 we catch only errors and don't run the debugger. */
14321 internal_condition_case_1 (redisplay_window_0, window,
14322 list_of_error,
14323 redisplay_window_error);
14326 window = w->next;
14330 static Lisp_Object
14331 redisplay_window_error (Lisp_Object ignore)
14333 displayed_buffer->display_error_modiff = BUF_MODIFF (displayed_buffer);
14334 return Qnil;
14337 static Lisp_Object
14338 redisplay_window_0 (Lisp_Object window)
14340 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14341 redisplay_window (window, false);
14342 return Qnil;
14345 static Lisp_Object
14346 redisplay_window_1 (Lisp_Object window)
14348 if (displayed_buffer->display_error_modiff < BUF_MODIFF (displayed_buffer))
14349 redisplay_window (window, true);
14350 return Qnil;
14354 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14355 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14356 which positions recorded in ROW differ from current buffer
14357 positions.
14359 Return 0 if cursor is not on this row, 1 otherwise. */
14361 static int
14362 set_cursor_from_row (struct window *w, struct glyph_row *row,
14363 struct glyph_matrix *matrix,
14364 ptrdiff_t delta, ptrdiff_t delta_bytes,
14365 int dy, int dvpos)
14367 struct glyph *glyph = row->glyphs[TEXT_AREA];
14368 struct glyph *end = glyph + row->used[TEXT_AREA];
14369 struct glyph *cursor = NULL;
14370 /* The last known character position in row. */
14371 ptrdiff_t last_pos = MATRIX_ROW_START_CHARPOS (row) + delta;
14372 int x = row->x;
14373 ptrdiff_t pt_old = PT - delta;
14374 ptrdiff_t pos_before = MATRIX_ROW_START_CHARPOS (row) + delta;
14375 ptrdiff_t pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14376 struct glyph *glyph_before = glyph - 1, *glyph_after = end;
14377 /* A glyph beyond the edge of TEXT_AREA which we should never
14378 touch. */
14379 struct glyph *glyphs_end = end;
14380 /* Non-zero means we've found a match for cursor position, but that
14381 glyph has the avoid_cursor_p flag set. */
14382 int match_with_avoid_cursor = 0;
14383 /* Non-zero means we've seen at least one glyph that came from a
14384 display string. */
14385 int string_seen = 0;
14386 /* Largest and smallest buffer positions seen so far during scan of
14387 glyph row. */
14388 ptrdiff_t bpos_max = pos_before;
14389 ptrdiff_t bpos_min = pos_after;
14390 /* Last buffer position covered by an overlay string with an integer
14391 `cursor' property. */
14392 ptrdiff_t bpos_covered = 0;
14393 /* Non-zero means the display string on which to display the cursor
14394 comes from a text property, not from an overlay. */
14395 int string_from_text_prop = 0;
14397 /* Don't even try doing anything if called for a mode-line or
14398 header-line row, since the rest of the code isn't prepared to
14399 deal with such calamities. */
14400 eassert (!row->mode_line_p);
14401 if (row->mode_line_p)
14402 return 0;
14404 /* Skip over glyphs not having an object at the start and the end of
14405 the row. These are special glyphs like truncation marks on
14406 terminal frames. */
14407 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
14409 if (!row->reversed_p)
14411 while (glyph < end
14412 && INTEGERP (glyph->object)
14413 && glyph->charpos < 0)
14415 x += glyph->pixel_width;
14416 ++glyph;
14418 while (end > glyph
14419 && INTEGERP ((end - 1)->object)
14420 /* CHARPOS is zero for blanks and stretch glyphs
14421 inserted by extend_face_to_end_of_line. */
14422 && (end - 1)->charpos <= 0)
14423 --end;
14424 glyph_before = glyph - 1;
14425 glyph_after = end;
14427 else
14429 struct glyph *g;
14431 /* If the glyph row is reversed, we need to process it from back
14432 to front, so swap the edge pointers. */
14433 glyphs_end = end = glyph - 1;
14434 glyph += row->used[TEXT_AREA] - 1;
14436 while (glyph > end + 1
14437 && INTEGERP (glyph->object)
14438 && glyph->charpos < 0)
14440 --glyph;
14441 x -= glyph->pixel_width;
14443 if (INTEGERP (glyph->object) && glyph->charpos < 0)
14444 --glyph;
14445 /* By default, in reversed rows we put the cursor on the
14446 rightmost (first in the reading order) glyph. */
14447 for (g = end + 1; g < glyph; g++)
14448 x += g->pixel_width;
14449 while (end < glyph
14450 && INTEGERP ((end + 1)->object)
14451 && (end + 1)->charpos <= 0)
14452 ++end;
14453 glyph_before = glyph + 1;
14454 glyph_after = end;
14457 else if (row->reversed_p)
14459 /* In R2L rows that don't display text, put the cursor on the
14460 rightmost glyph. Case in point: an empty last line that is
14461 part of an R2L paragraph. */
14462 cursor = end - 1;
14463 /* Avoid placing the cursor on the last glyph of the row, where
14464 on terminal frames we hold the vertical border between
14465 adjacent windows. */
14466 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w))
14467 && !WINDOW_RIGHTMOST_P (w)
14468 && cursor == row->glyphs[LAST_AREA] - 1)
14469 cursor--;
14470 x = -1; /* will be computed below, at label compute_x */
14473 /* Step 1: Try to find the glyph whose character position
14474 corresponds to point. If that's not possible, find 2 glyphs
14475 whose character positions are the closest to point, one before
14476 point, the other after it. */
14477 if (!row->reversed_p)
14478 while (/* not marched to end of glyph row */
14479 glyph < end
14480 /* glyph was not inserted by redisplay for internal purposes */
14481 && !INTEGERP (glyph->object))
14483 if (BUFFERP (glyph->object))
14485 ptrdiff_t dpos = glyph->charpos - pt_old;
14487 if (glyph->charpos > bpos_max)
14488 bpos_max = glyph->charpos;
14489 if (glyph->charpos < bpos_min)
14490 bpos_min = glyph->charpos;
14491 if (!glyph->avoid_cursor_p)
14493 /* If we hit point, we've found the glyph on which to
14494 display the cursor. */
14495 if (dpos == 0)
14497 match_with_avoid_cursor = 0;
14498 break;
14500 /* See if we've found a better approximation to
14501 POS_BEFORE or to POS_AFTER. */
14502 if (0 > dpos && dpos > pos_before - pt_old)
14504 pos_before = glyph->charpos;
14505 glyph_before = glyph;
14507 else if (0 < dpos && dpos < pos_after - pt_old)
14509 pos_after = glyph->charpos;
14510 glyph_after = glyph;
14513 else if (dpos == 0)
14514 match_with_avoid_cursor = 1;
14516 else if (STRINGP (glyph->object))
14518 Lisp_Object chprop;
14519 ptrdiff_t glyph_pos = glyph->charpos;
14521 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14522 glyph->object);
14523 if (!NILP (chprop))
14525 /* If the string came from a `display' text property,
14526 look up the buffer position of that property and
14527 use that position to update bpos_max, as if we
14528 actually saw such a position in one of the row's
14529 glyphs. This helps with supporting integer values
14530 of `cursor' property on the display string in
14531 situations where most or all of the row's buffer
14532 text is completely covered by display properties,
14533 so that no glyph with valid buffer positions is
14534 ever seen in the row. */
14535 ptrdiff_t prop_pos =
14536 string_buffer_position_lim (glyph->object, pos_before,
14537 pos_after, 0);
14539 if (prop_pos >= pos_before)
14540 bpos_max = prop_pos;
14542 if (INTEGERP (chprop))
14544 bpos_covered = bpos_max + XINT (chprop);
14545 /* If the `cursor' property covers buffer positions up
14546 to and including point, we should display cursor on
14547 this glyph. Note that, if a `cursor' property on one
14548 of the string's characters has an integer value, we
14549 will break out of the loop below _before_ we get to
14550 the position match above. IOW, integer values of
14551 the `cursor' property override the "exact match for
14552 point" strategy of positioning the cursor. */
14553 /* Implementation note: bpos_max == pt_old when, e.g.,
14554 we are in an empty line, where bpos_max is set to
14555 MATRIX_ROW_START_CHARPOS, see above. */
14556 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14558 cursor = glyph;
14559 break;
14563 string_seen = 1;
14565 x += glyph->pixel_width;
14566 ++glyph;
14568 else if (glyph > end) /* row is reversed */
14569 while (!INTEGERP (glyph->object))
14571 if (BUFFERP (glyph->object))
14573 ptrdiff_t dpos = glyph->charpos - pt_old;
14575 if (glyph->charpos > bpos_max)
14576 bpos_max = glyph->charpos;
14577 if (glyph->charpos < bpos_min)
14578 bpos_min = glyph->charpos;
14579 if (!glyph->avoid_cursor_p)
14581 if (dpos == 0)
14583 match_with_avoid_cursor = 0;
14584 break;
14586 if (0 > dpos && dpos > pos_before - pt_old)
14588 pos_before = glyph->charpos;
14589 glyph_before = glyph;
14591 else if (0 < dpos && dpos < pos_after - pt_old)
14593 pos_after = glyph->charpos;
14594 glyph_after = glyph;
14597 else if (dpos == 0)
14598 match_with_avoid_cursor = 1;
14600 else if (STRINGP (glyph->object))
14602 Lisp_Object chprop;
14603 ptrdiff_t glyph_pos = glyph->charpos;
14605 chprop = Fget_char_property (make_number (glyph_pos), Qcursor,
14606 glyph->object);
14607 if (!NILP (chprop))
14609 ptrdiff_t prop_pos =
14610 string_buffer_position_lim (glyph->object, pos_before,
14611 pos_after, 0);
14613 if (prop_pos >= pos_before)
14614 bpos_max = prop_pos;
14616 if (INTEGERP (chprop))
14618 bpos_covered = bpos_max + XINT (chprop);
14619 /* If the `cursor' property covers buffer positions up
14620 to and including point, we should display cursor on
14621 this glyph. */
14622 if (bpos_max <= pt_old && bpos_covered >= pt_old)
14624 cursor = glyph;
14625 break;
14628 string_seen = 1;
14630 --glyph;
14631 if (glyph == glyphs_end) /* don't dereference outside TEXT_AREA */
14633 x--; /* can't use any pixel_width */
14634 break;
14636 x -= glyph->pixel_width;
14639 /* Step 2: If we didn't find an exact match for point, we need to
14640 look for a proper place to put the cursor among glyphs between
14641 GLYPH_BEFORE and GLYPH_AFTER. */
14642 if (!((row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14643 && BUFFERP (glyph->object) && glyph->charpos == pt_old)
14644 && !(bpos_max <= pt_old && pt_old <= bpos_covered))
14646 /* An empty line has a single glyph whose OBJECT is zero and
14647 whose CHARPOS is the position of a newline on that line.
14648 Note that on a TTY, there are more glyphs after that, which
14649 were produced by extend_face_to_end_of_line, but their
14650 CHARPOS is zero or negative. */
14651 int empty_line_p =
14652 (row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end)
14653 && INTEGERP (glyph->object) && glyph->charpos > 0
14654 /* On a TTY, continued and truncated rows also have a glyph at
14655 their end whose OBJECT is zero and whose CHARPOS is
14656 positive (the continuation and truncation glyphs), but such
14657 rows are obviously not "empty". */
14658 && !(row->continued_p || row->truncated_on_right_p);
14660 if (row->ends_in_ellipsis_p && pos_after == last_pos)
14662 ptrdiff_t ellipsis_pos;
14664 /* Scan back over the ellipsis glyphs. */
14665 if (!row->reversed_p)
14667 ellipsis_pos = (glyph - 1)->charpos;
14668 while (glyph > row->glyphs[TEXT_AREA]
14669 && (glyph - 1)->charpos == ellipsis_pos)
14670 glyph--, x -= glyph->pixel_width;
14671 /* That loop always goes one position too far, including
14672 the glyph before the ellipsis. So scan forward over
14673 that one. */
14674 x += glyph->pixel_width;
14675 glyph++;
14677 else /* row is reversed */
14679 ellipsis_pos = (glyph + 1)->charpos;
14680 while (glyph < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14681 && (glyph + 1)->charpos == ellipsis_pos)
14682 glyph++, x += glyph->pixel_width;
14683 x -= glyph->pixel_width;
14684 glyph--;
14687 else if (match_with_avoid_cursor)
14689 cursor = glyph_after;
14690 x = -1;
14692 else if (string_seen)
14694 int incr = row->reversed_p ? -1 : +1;
14696 /* Need to find the glyph that came out of a string which is
14697 present at point. That glyph is somewhere between
14698 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14699 positioned between POS_BEFORE and POS_AFTER in the
14700 buffer. */
14701 struct glyph *start, *stop;
14702 ptrdiff_t pos = pos_before;
14704 x = -1;
14706 /* If the row ends in a newline from a display string,
14707 reordering could have moved the glyphs belonging to the
14708 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14709 in this case we extend the search to the last glyph in
14710 the row that was not inserted by redisplay. */
14711 if (row->ends_in_newline_from_string_p)
14713 glyph_after = end;
14714 pos_after = MATRIX_ROW_END_CHARPOS (row) + delta;
14717 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14718 correspond to POS_BEFORE and POS_AFTER, respectively. We
14719 need START and STOP in the order that corresponds to the
14720 row's direction as given by its reversed_p flag. If the
14721 directionality of characters between POS_BEFORE and
14722 POS_AFTER is the opposite of the row's base direction,
14723 these characters will have been reordered for display,
14724 and we need to reverse START and STOP. */
14725 if (!row->reversed_p)
14727 start = min (glyph_before, glyph_after);
14728 stop = max (glyph_before, glyph_after);
14730 else
14732 start = max (glyph_before, glyph_after);
14733 stop = min (glyph_before, glyph_after);
14735 for (glyph = start + incr;
14736 row->reversed_p ? glyph > stop : glyph < stop; )
14739 /* Any glyphs that come from the buffer are here because
14740 of bidi reordering. Skip them, and only pay
14741 attention to glyphs that came from some string. */
14742 if (STRINGP (glyph->object))
14744 Lisp_Object str;
14745 ptrdiff_t tem;
14746 /* If the display property covers the newline, we
14747 need to search for it one position farther. */
14748 ptrdiff_t lim = pos_after
14749 + (pos_after == MATRIX_ROW_END_CHARPOS (row) + delta);
14751 string_from_text_prop = 0;
14752 str = glyph->object;
14753 tem = string_buffer_position_lim (str, pos, lim, 0);
14754 if (tem == 0 /* from overlay */
14755 || pos <= tem)
14757 /* If the string from which this glyph came is
14758 found in the buffer at point, or at position
14759 that is closer to point than pos_after, then
14760 we've found the glyph we've been looking for.
14761 If it comes from an overlay (tem == 0), and
14762 it has the `cursor' property on one of its
14763 glyphs, record that glyph as a candidate for
14764 displaying the cursor. (As in the
14765 unidirectional version, we will display the
14766 cursor on the last candidate we find.) */
14767 if (tem == 0
14768 || tem == pt_old
14769 || (tem - pt_old > 0 && tem < pos_after))
14771 /* The glyphs from this string could have
14772 been reordered. Find the one with the
14773 smallest string position. Or there could
14774 be a character in the string with the
14775 `cursor' property, which means display
14776 cursor on that character's glyph. */
14777 ptrdiff_t strpos = glyph->charpos;
14779 if (tem)
14781 cursor = glyph;
14782 string_from_text_prop = 1;
14784 for ( ;
14785 (row->reversed_p ? glyph > stop : glyph < stop)
14786 && EQ (glyph->object, str);
14787 glyph += incr)
14789 Lisp_Object cprop;
14790 ptrdiff_t gpos = glyph->charpos;
14792 cprop = Fget_char_property (make_number (gpos),
14793 Qcursor,
14794 glyph->object);
14795 if (!NILP (cprop))
14797 cursor = glyph;
14798 break;
14800 if (tem && glyph->charpos < strpos)
14802 strpos = glyph->charpos;
14803 cursor = glyph;
14807 if (tem == pt_old
14808 || (tem - pt_old > 0 && tem < pos_after))
14809 goto compute_x;
14811 if (tem)
14812 pos = tem + 1; /* don't find previous instances */
14814 /* This string is not what we want; skip all of the
14815 glyphs that came from it. */
14816 while ((row->reversed_p ? glyph > stop : glyph < stop)
14817 && EQ (glyph->object, str))
14818 glyph += incr;
14820 else
14821 glyph += incr;
14824 /* If we reached the end of the line, and END was from a string,
14825 the cursor is not on this line. */
14826 if (cursor == NULL
14827 && (row->reversed_p ? glyph <= end : glyph >= end)
14828 && (row->reversed_p ? end > glyphs_end : end < glyphs_end)
14829 && STRINGP (end->object)
14830 && row->continued_p)
14831 return 0;
14833 /* A truncated row may not include PT among its character positions.
14834 Setting the cursor inside the scroll margin will trigger
14835 recalculation of hscroll in hscroll_window_tree. But if a
14836 display string covers point, defer to the string-handling
14837 code below to figure this out. */
14838 else if (row->truncated_on_left_p && pt_old < bpos_min)
14840 cursor = glyph_before;
14841 x = -1;
14843 else if ((row->truncated_on_right_p && pt_old > bpos_max)
14844 /* Zero-width characters produce no glyphs. */
14845 || (!empty_line_p
14846 && (row->reversed_p
14847 ? glyph_after > glyphs_end
14848 : glyph_after < glyphs_end)))
14850 cursor = glyph_after;
14851 x = -1;
14855 compute_x:
14856 if (cursor != NULL)
14857 glyph = cursor;
14858 else if (glyph == glyphs_end
14859 && pos_before == pos_after
14860 && STRINGP ((row->reversed_p
14861 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14862 : row->glyphs[TEXT_AREA])->object))
14864 /* If all the glyphs of this row came from strings, put the
14865 cursor on the first glyph of the row. This avoids having the
14866 cursor outside of the text area in this very rare and hard
14867 use case. */
14868 glyph =
14869 row->reversed_p
14870 ? row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1
14871 : row->glyphs[TEXT_AREA];
14873 if (x < 0)
14875 struct glyph *g;
14877 /* Need to compute x that corresponds to GLYPH. */
14878 for (g = row->glyphs[TEXT_AREA], x = row->x; g < glyph; g++)
14880 if (g >= row->glyphs[TEXT_AREA] + row->used[TEXT_AREA])
14881 emacs_abort ();
14882 x += g->pixel_width;
14886 /* ROW could be part of a continued line, which, under bidi
14887 reordering, might have other rows whose start and end charpos
14888 occlude point. Only set w->cursor if we found a better
14889 approximation to the cursor position than we have from previously
14890 examined candidate rows belonging to the same continued line. */
14891 if (/* We already have a candidate row. */
14892 w->cursor.vpos >= 0
14893 /* That candidate is not the row we are processing. */
14894 && MATRIX_ROW (matrix, w->cursor.vpos) != row
14895 /* Make sure cursor.vpos specifies a row whose start and end
14896 charpos occlude point, and it is valid candidate for being a
14897 cursor-row. This is because some callers of this function
14898 leave cursor.vpos at the row where the cursor was displayed
14899 during the last redisplay cycle. */
14900 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos)) <= pt_old
14901 && pt_old <= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14902 && cursor_row_p (MATRIX_ROW (matrix, w->cursor.vpos)))
14904 struct glyph *g1
14905 = MATRIX_ROW_GLYPH_START (matrix, w->cursor.vpos) + w->cursor.hpos;
14907 /* Don't consider glyphs that are outside TEXT_AREA. */
14908 if (!(row->reversed_p ? glyph > glyphs_end : glyph < glyphs_end))
14909 return 0;
14910 /* Keep the candidate whose buffer position is the closest to
14911 point or has the `cursor' property. */
14912 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14913 w->cursor.hpos >= 0
14914 && w->cursor.hpos < MATRIX_ROW_USED (matrix, w->cursor.vpos)
14915 && ((BUFFERP (g1->object)
14916 && (g1->charpos == pt_old /* An exact match always wins. */
14917 || (BUFFERP (glyph->object)
14918 && eabs (g1->charpos - pt_old)
14919 < eabs (glyph->charpos - pt_old))))
14920 /* Previous candidate is a glyph from a string that has
14921 a non-nil `cursor' property. */
14922 || (STRINGP (g1->object)
14923 && (!NILP (Fget_char_property (make_number (g1->charpos),
14924 Qcursor, g1->object))
14925 /* Previous candidate is from the same display
14926 string as this one, and the display string
14927 came from a text property. */
14928 || (EQ (g1->object, glyph->object)
14929 && string_from_text_prop)
14930 /* this candidate is from newline and its
14931 position is not an exact match */
14932 || (INTEGERP (glyph->object)
14933 && glyph->charpos != pt_old)))))
14934 return 0;
14935 /* If this candidate gives an exact match, use that. */
14936 if (!((BUFFERP (glyph->object) && glyph->charpos == pt_old)
14937 /* If this candidate is a glyph created for the
14938 terminating newline of a line, and point is on that
14939 newline, it wins because it's an exact match. */
14940 || (!row->continued_p
14941 && INTEGERP (glyph->object)
14942 && glyph->charpos == 0
14943 && pt_old == MATRIX_ROW_END_CHARPOS (row) - 1))
14944 /* Otherwise, keep the candidate that comes from a row
14945 spanning less buffer positions. This may win when one or
14946 both candidate positions are on glyphs that came from
14947 display strings, for which we cannot compare buffer
14948 positions. */
14949 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14950 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix, w->cursor.vpos))
14951 < MATRIX_ROW_END_CHARPOS (row) - MATRIX_ROW_START_CHARPOS (row))
14952 return 0;
14954 w->cursor.hpos = glyph - row->glyphs[TEXT_AREA];
14955 w->cursor.x = x;
14956 w->cursor.vpos = MATRIX_ROW_VPOS (row, matrix) + dvpos;
14957 w->cursor.y = row->y + dy;
14959 if (w == XWINDOW (selected_window))
14961 if (!row->continued_p
14962 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
14963 && row->x == 0)
14965 this_line_buffer = XBUFFER (w->contents);
14967 CHARPOS (this_line_start_pos)
14968 = MATRIX_ROW_START_CHARPOS (row) + delta;
14969 BYTEPOS (this_line_start_pos)
14970 = MATRIX_ROW_START_BYTEPOS (row) + delta_bytes;
14972 CHARPOS (this_line_end_pos)
14973 = Z - (MATRIX_ROW_END_CHARPOS (row) + delta);
14974 BYTEPOS (this_line_end_pos)
14975 = Z_BYTE - (MATRIX_ROW_END_BYTEPOS (row) + delta_bytes);
14977 this_line_y = w->cursor.y;
14978 this_line_pixel_height = row->height;
14979 this_line_vpos = w->cursor.vpos;
14980 this_line_start_x = row->x;
14982 else
14983 CHARPOS (this_line_start_pos) = 0;
14986 return 1;
14990 /* Run window scroll functions, if any, for WINDOW with new window
14991 start STARTP. Sets the window start of WINDOW to that position.
14993 We assume that the window's buffer is really current. */
14995 static struct text_pos
14996 run_window_scroll_functions (Lisp_Object window, struct text_pos startp)
14998 struct window *w = XWINDOW (window);
14999 SET_MARKER_FROM_TEXT_POS (w->start, startp);
15001 eassert (current_buffer == XBUFFER (w->contents));
15003 if (!NILP (Vwindow_scroll_functions))
15005 run_hook_with_args_2 (Qwindow_scroll_functions, window,
15006 make_number (CHARPOS (startp)));
15007 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15008 /* In case the hook functions switch buffers. */
15009 set_buffer_internal (XBUFFER (w->contents));
15012 return startp;
15016 /* Make sure the line containing the cursor is fully visible.
15017 A value of 1 means there is nothing to be done.
15018 (Either the line is fully visible, or it cannot be made so,
15019 or we cannot tell.)
15021 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15022 is higher than window.
15024 A value of 0 means the caller should do scrolling
15025 as if point had gone off the screen. */
15027 static int
15028 cursor_row_fully_visible_p (struct window *w, int force_p, int current_matrix_p)
15030 struct glyph_matrix *matrix;
15031 struct glyph_row *row;
15032 int window_height;
15034 if (!make_cursor_line_fully_visible_p)
15035 return 1;
15037 /* It's not always possible to find the cursor, e.g, when a window
15038 is full of overlay strings. Don't do anything in that case. */
15039 if (w->cursor.vpos < 0)
15040 return 1;
15042 matrix = current_matrix_p ? w->current_matrix : w->desired_matrix;
15043 row = MATRIX_ROW (matrix, w->cursor.vpos);
15045 /* If the cursor row is not partially visible, there's nothing to do. */
15046 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row))
15047 return 1;
15049 /* If the row the cursor is in is taller than the window's height,
15050 it's not clear what to do, so do nothing. */
15051 window_height = window_box_height (w);
15052 if (row->height >= window_height)
15054 if (!force_p || MINI_WINDOW_P (w)
15055 || w->vscroll || w->cursor.vpos == 0)
15056 return 1;
15058 return 0;
15062 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15063 non-zero means only WINDOW is redisplayed in redisplay_internal.
15064 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15065 in redisplay_window to bring a partially visible line into view in
15066 the case that only the cursor has moved.
15068 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15069 last screen line's vertical height extends past the end of the screen.
15071 Value is
15073 1 if scrolling succeeded
15075 0 if scrolling didn't find point.
15077 -1 if new fonts have been loaded so that we must interrupt
15078 redisplay, adjust glyph matrices, and try again. */
15080 enum
15082 SCROLLING_SUCCESS,
15083 SCROLLING_FAILED,
15084 SCROLLING_NEED_LARGER_MATRICES
15087 /* If scroll-conservatively is more than this, never recenter.
15089 If you change this, don't forget to update the doc string of
15090 `scroll-conservatively' and the Emacs manual. */
15091 #define SCROLL_LIMIT 100
15093 static int
15094 try_scrolling (Lisp_Object window, int just_this_one_p,
15095 ptrdiff_t arg_scroll_conservatively, ptrdiff_t scroll_step,
15096 int temp_scroll_step, int last_line_misfit)
15098 struct window *w = XWINDOW (window);
15099 struct frame *f = XFRAME (w->frame);
15100 struct text_pos pos, startp;
15101 struct it it;
15102 int this_scroll_margin, scroll_max, rc, height;
15103 int dy = 0, amount_to_scroll = 0, scroll_down_p = 0;
15104 int extra_scroll_margin_lines = last_line_misfit ? 1 : 0;
15105 Lisp_Object aggressive;
15106 /* We will never try scrolling more than this number of lines. */
15107 int scroll_limit = SCROLL_LIMIT;
15108 int frame_line_height = default_line_pixel_height (w);
15109 int window_total_lines
15110 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15112 #ifdef GLYPH_DEBUG
15113 debug_method_add (w, "try_scrolling");
15114 #endif
15116 SET_TEXT_POS_FROM_MARKER (startp, w->start);
15118 /* Compute scroll margin height in pixels. We scroll when point is
15119 within this distance from the top or bottom of the window. */
15120 if (scroll_margin > 0)
15121 this_scroll_margin = min (scroll_margin, window_total_lines / 4)
15122 * frame_line_height;
15123 else
15124 this_scroll_margin = 0;
15126 /* Force arg_scroll_conservatively to have a reasonable value, to
15127 avoid scrolling too far away with slow move_it_* functions. Note
15128 that the user can supply scroll-conservatively equal to
15129 `most-positive-fixnum', which can be larger than INT_MAX. */
15130 if (arg_scroll_conservatively > scroll_limit)
15132 arg_scroll_conservatively = scroll_limit + 1;
15133 scroll_max = scroll_limit * frame_line_height;
15135 else if (scroll_step || arg_scroll_conservatively || temp_scroll_step)
15136 /* Compute how much we should try to scroll maximally to bring
15137 point into view. */
15138 scroll_max = (max (scroll_step,
15139 max (arg_scroll_conservatively, temp_scroll_step))
15140 * frame_line_height);
15141 else if (NUMBERP (BVAR (current_buffer, scroll_down_aggressively))
15142 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively)))
15143 /* We're trying to scroll because of aggressive scrolling but no
15144 scroll_step is set. Choose an arbitrary one. */
15145 scroll_max = 10 * frame_line_height;
15146 else
15147 scroll_max = 0;
15149 too_near_end:
15151 /* Decide whether to scroll down. */
15152 if (PT > CHARPOS (startp))
15154 int scroll_margin_y;
15156 /* Compute the pixel ypos of the scroll margin, then move IT to
15157 either that ypos or PT, whichever comes first. */
15158 start_display (&it, w, startp);
15159 scroll_margin_y = it.last_visible_y - this_scroll_margin
15160 - frame_line_height * extra_scroll_margin_lines;
15161 move_it_to (&it, PT, -1, scroll_margin_y - 1, -1,
15162 (MOVE_TO_POS | MOVE_TO_Y));
15164 if (PT > CHARPOS (it.current.pos))
15166 int y0 = line_bottom_y (&it);
15167 /* Compute how many pixels below window bottom to stop searching
15168 for PT. This avoids costly search for PT that is far away if
15169 the user limited scrolling by a small number of lines, but
15170 always finds PT if scroll_conservatively is set to a large
15171 number, such as most-positive-fixnum. */
15172 int slack = max (scroll_max, 10 * frame_line_height);
15173 int y_to_move = it.last_visible_y + slack;
15175 /* Compute the distance from the scroll margin to PT or to
15176 the scroll limit, whichever comes first. This should
15177 include the height of the cursor line, to make that line
15178 fully visible. */
15179 move_it_to (&it, PT, -1, y_to_move,
15180 -1, MOVE_TO_POS | MOVE_TO_Y);
15181 dy = line_bottom_y (&it) - y0;
15183 if (dy > scroll_max)
15184 return SCROLLING_FAILED;
15186 if (dy > 0)
15187 scroll_down_p = 1;
15191 if (scroll_down_p)
15193 /* Point is in or below the bottom scroll margin, so move the
15194 window start down. If scrolling conservatively, move it just
15195 enough down to make point visible. If scroll_step is set,
15196 move it down by scroll_step. */
15197 if (arg_scroll_conservatively)
15198 amount_to_scroll
15199 = min (max (dy, frame_line_height),
15200 frame_line_height * arg_scroll_conservatively);
15201 else if (scroll_step || temp_scroll_step)
15202 amount_to_scroll = scroll_max;
15203 else
15205 aggressive = BVAR (current_buffer, scroll_up_aggressively);
15206 height = WINDOW_BOX_TEXT_HEIGHT (w);
15207 if (NUMBERP (aggressive))
15209 double float_amount = XFLOATINT (aggressive) * height;
15210 int aggressive_scroll = float_amount;
15211 if (aggressive_scroll == 0 && float_amount > 0)
15212 aggressive_scroll = 1;
15213 /* Don't let point enter the scroll margin near top of
15214 the window. This could happen if the value of
15215 scroll_up_aggressively is too large and there are
15216 non-zero margins, because scroll_up_aggressively
15217 means put point that fraction of window height
15218 _from_the_bottom_margin_. */
15219 if (aggressive_scroll + 2*this_scroll_margin > height)
15220 aggressive_scroll = height - 2*this_scroll_margin;
15221 amount_to_scroll = dy + aggressive_scroll;
15225 if (amount_to_scroll <= 0)
15226 return SCROLLING_FAILED;
15228 start_display (&it, w, startp);
15229 if (arg_scroll_conservatively <= scroll_limit)
15230 move_it_vertically (&it, amount_to_scroll);
15231 else
15233 /* Extra precision for users who set scroll-conservatively
15234 to a large number: make sure the amount we scroll
15235 the window start is never less than amount_to_scroll,
15236 which was computed as distance from window bottom to
15237 point. This matters when lines at window top and lines
15238 below window bottom have different height. */
15239 struct it it1;
15240 void *it1data = NULL;
15241 /* We use a temporary it1 because line_bottom_y can modify
15242 its argument, if it moves one line down; see there. */
15243 int start_y;
15245 SAVE_IT (it1, it, it1data);
15246 start_y = line_bottom_y (&it1);
15247 do {
15248 RESTORE_IT (&it, &it, it1data);
15249 move_it_by_lines (&it, 1);
15250 SAVE_IT (it1, it, it1data);
15251 } while (line_bottom_y (&it1) - start_y < amount_to_scroll);
15254 /* If STARTP is unchanged, move it down another screen line. */
15255 if (CHARPOS (it.current.pos) == CHARPOS (startp))
15256 move_it_by_lines (&it, 1);
15257 startp = it.current.pos;
15259 else
15261 struct text_pos scroll_margin_pos = startp;
15262 int y_offset = 0;
15264 /* See if point is inside the scroll margin at the top of the
15265 window. */
15266 if (this_scroll_margin)
15268 int y_start;
15270 start_display (&it, w, startp);
15271 y_start = it.current_y;
15272 move_it_vertically (&it, this_scroll_margin);
15273 scroll_margin_pos = it.current.pos;
15274 /* If we didn't move enough before hitting ZV, request
15275 additional amount of scroll, to move point out of the
15276 scroll margin. */
15277 if (IT_CHARPOS (it) == ZV
15278 && it.current_y - y_start < this_scroll_margin)
15279 y_offset = this_scroll_margin - (it.current_y - y_start);
15282 if (PT < CHARPOS (scroll_margin_pos))
15284 /* Point is in the scroll margin at the top of the window or
15285 above what is displayed in the window. */
15286 int y0, y_to_move;
15288 /* Compute the vertical distance from PT to the scroll
15289 margin position. Move as far as scroll_max allows, or
15290 one screenful, or 10 screen lines, whichever is largest.
15291 Give up if distance is greater than scroll_max or if we
15292 didn't reach the scroll margin position. */
15293 SET_TEXT_POS (pos, PT, PT_BYTE);
15294 start_display (&it, w, pos);
15295 y0 = it.current_y;
15296 y_to_move = max (it.last_visible_y,
15297 max (scroll_max, 10 * frame_line_height));
15298 move_it_to (&it, CHARPOS (scroll_margin_pos), 0,
15299 y_to_move, -1,
15300 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15301 dy = it.current_y - y0;
15302 if (dy > scroll_max
15303 || IT_CHARPOS (it) < CHARPOS (scroll_margin_pos))
15304 return SCROLLING_FAILED;
15306 /* Additional scroll for when ZV was too close to point. */
15307 dy += y_offset;
15309 /* Compute new window start. */
15310 start_display (&it, w, startp);
15312 if (arg_scroll_conservatively)
15313 amount_to_scroll = max (dy, frame_line_height *
15314 max (scroll_step, temp_scroll_step));
15315 else if (scroll_step || temp_scroll_step)
15316 amount_to_scroll = scroll_max;
15317 else
15319 aggressive = BVAR (current_buffer, scroll_down_aggressively);
15320 height = WINDOW_BOX_TEXT_HEIGHT (w);
15321 if (NUMBERP (aggressive))
15323 double float_amount = XFLOATINT (aggressive) * height;
15324 int aggressive_scroll = float_amount;
15325 if (aggressive_scroll == 0 && float_amount > 0)
15326 aggressive_scroll = 1;
15327 /* Don't let point enter the scroll margin near
15328 bottom of the window, if the value of
15329 scroll_down_aggressively happens to be too
15330 large. */
15331 if (aggressive_scroll + 2*this_scroll_margin > height)
15332 aggressive_scroll = height - 2*this_scroll_margin;
15333 amount_to_scroll = dy + aggressive_scroll;
15337 if (amount_to_scroll <= 0)
15338 return SCROLLING_FAILED;
15340 move_it_vertically_backward (&it, amount_to_scroll);
15341 startp = it.current.pos;
15345 /* Run window scroll functions. */
15346 startp = run_window_scroll_functions (window, startp);
15348 /* Display the window. Give up if new fonts are loaded, or if point
15349 doesn't appear. */
15350 if (!try_window (window, startp, 0))
15351 rc = SCROLLING_NEED_LARGER_MATRICES;
15352 else if (w->cursor.vpos < 0)
15354 clear_glyph_matrix (w->desired_matrix);
15355 rc = SCROLLING_FAILED;
15357 else
15359 /* Maybe forget recorded base line for line number display. */
15360 if (!just_this_one_p
15361 || current_buffer->clip_changed
15362 || BEG_UNCHANGED < CHARPOS (startp))
15363 w->base_line_number = 0;
15365 /* If cursor ends up on a partially visible line,
15366 treat that as being off the bottom of the screen. */
15367 if (! cursor_row_fully_visible_p (w, extra_scroll_margin_lines <= 1, 0)
15368 /* It's possible that the cursor is on the first line of the
15369 buffer, which is partially obscured due to a vscroll
15370 (Bug#7537). In that case, avoid looping forever. */
15371 && extra_scroll_margin_lines < w->desired_matrix->nrows - 1)
15373 clear_glyph_matrix (w->desired_matrix);
15374 ++extra_scroll_margin_lines;
15375 goto too_near_end;
15377 rc = SCROLLING_SUCCESS;
15380 return rc;
15384 /* Compute a suitable window start for window W if display of W starts
15385 on a continuation line. Value is non-zero if a new window start
15386 was computed.
15388 The new window start will be computed, based on W's width, starting
15389 from the start of the continued line. It is the start of the
15390 screen line with the minimum distance from the old start W->start. */
15392 static int
15393 compute_window_start_on_continuation_line (struct window *w)
15395 struct text_pos pos, start_pos;
15396 int window_start_changed_p = 0;
15398 SET_TEXT_POS_FROM_MARKER (start_pos, w->start);
15400 /* If window start is on a continuation line... Window start may be
15401 < BEGV in case there's invisible text at the start of the
15402 buffer (M-x rmail, for example). */
15403 if (CHARPOS (start_pos) > BEGV
15404 && FETCH_BYTE (BYTEPOS (start_pos) - 1) != '\n')
15406 struct it it;
15407 struct glyph_row *row;
15409 /* Handle the case that the window start is out of range. */
15410 if (CHARPOS (start_pos) < BEGV)
15411 SET_TEXT_POS (start_pos, BEGV, BEGV_BYTE);
15412 else if (CHARPOS (start_pos) > ZV)
15413 SET_TEXT_POS (start_pos, ZV, ZV_BYTE);
15415 /* Find the start of the continued line. This should be fast
15416 because find_newline is fast (newline cache). */
15417 row = w->desired_matrix->rows + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0);
15418 init_iterator (&it, w, CHARPOS (start_pos), BYTEPOS (start_pos),
15419 row, DEFAULT_FACE_ID);
15420 reseat_at_previous_visible_line_start (&it);
15422 /* If the line start is "too far" away from the window start,
15423 say it takes too much time to compute a new window start. */
15424 if (CHARPOS (start_pos) - IT_CHARPOS (it)
15425 /* PXW: Do we need upper bounds here? */
15426 < WINDOW_TOTAL_LINES (w) * WINDOW_TOTAL_COLS (w))
15428 int min_distance, distance;
15430 /* Move forward by display lines to find the new window
15431 start. If window width was enlarged, the new start can
15432 be expected to be > the old start. If window width was
15433 decreased, the new window start will be < the old start.
15434 So, we're looking for the display line start with the
15435 minimum distance from the old window start. */
15436 pos = it.current.pos;
15437 min_distance = INFINITY;
15438 while ((distance = eabs (CHARPOS (start_pos) - IT_CHARPOS (it))),
15439 distance < min_distance)
15441 min_distance = distance;
15442 pos = it.current.pos;
15443 if (it.line_wrap == WORD_WRAP)
15445 /* Under WORD_WRAP, move_it_by_lines is likely to
15446 overshoot and stop not at the first, but the
15447 second character from the left margin. So in
15448 that case, we need a more tight control on the X
15449 coordinate of the iterator than move_it_by_lines
15450 promises in its contract. The method is to first
15451 go to the last (rightmost) visible character of a
15452 line, then move to the leftmost character on the
15453 next line in a separate call. */
15454 move_it_to (&it, ZV, it.last_visible_x, it.current_y, -1,
15455 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15456 move_it_to (&it, ZV, 0,
15457 it.current_y + it.max_ascent + it.max_descent, -1,
15458 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
15460 else
15461 move_it_by_lines (&it, 1);
15464 /* Set the window start there. */
15465 SET_MARKER_FROM_TEXT_POS (w->start, pos);
15466 window_start_changed_p = 1;
15470 return window_start_changed_p;
15474 /* Try cursor movement in case text has not changed in window WINDOW,
15475 with window start STARTP. Value is
15477 CURSOR_MOVEMENT_SUCCESS if successful
15479 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15481 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15482 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15483 we want to scroll as if scroll-step were set to 1. See the code.
15485 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15486 which case we have to abort this redisplay, and adjust matrices
15487 first. */
15489 enum
15491 CURSOR_MOVEMENT_SUCCESS,
15492 CURSOR_MOVEMENT_CANNOT_BE_USED,
15493 CURSOR_MOVEMENT_MUST_SCROLL,
15494 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15497 static int
15498 try_cursor_movement (Lisp_Object window, struct text_pos startp, int *scroll_step)
15500 struct window *w = XWINDOW (window);
15501 struct frame *f = XFRAME (w->frame);
15502 int rc = CURSOR_MOVEMENT_CANNOT_BE_USED;
15504 #ifdef GLYPH_DEBUG
15505 if (inhibit_try_cursor_movement)
15506 return rc;
15507 #endif
15509 /* Previously, there was a check for Lisp integer in the
15510 if-statement below. Now, this field is converted to
15511 ptrdiff_t, thus zero means invalid position in a buffer. */
15512 eassert (w->last_point > 0);
15513 /* Likewise there was a check whether window_end_vpos is nil or larger
15514 than the window. Now window_end_vpos is int and so never nil, but
15515 let's leave eassert to check whether it fits in the window. */
15516 eassert (w->window_end_vpos < w->current_matrix->nrows);
15518 /* Handle case where text has not changed, only point, and it has
15519 not moved off the frame. */
15520 if (/* Point may be in this window. */
15521 PT >= CHARPOS (startp)
15522 /* Selective display hasn't changed. */
15523 && !current_buffer->clip_changed
15524 /* Function force-mode-line-update is used to force a thorough
15525 redisplay. It sets either windows_or_buffers_changed or
15526 update_mode_lines. So don't take a shortcut here for these
15527 cases. */
15528 && !update_mode_lines
15529 && !windows_or_buffers_changed
15530 && !f->cursor_type_changed
15531 && NILP (Vshow_trailing_whitespace)
15532 /* This code is not used for mini-buffer for the sake of the case
15533 of redisplaying to replace an echo area message; since in
15534 that case the mini-buffer contents per se are usually
15535 unchanged. This code is of no real use in the mini-buffer
15536 since the handling of this_line_start_pos, etc., in redisplay
15537 handles the same cases. */
15538 && !EQ (window, minibuf_window)
15539 && (FRAME_WINDOW_P (f)
15540 || !overlay_arrow_in_current_buffer_p ()))
15542 int this_scroll_margin, top_scroll_margin;
15543 struct glyph_row *row = NULL;
15544 int frame_line_height = default_line_pixel_height (w);
15545 int window_total_lines
15546 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
15548 #ifdef GLYPH_DEBUG
15549 debug_method_add (w, "cursor movement");
15550 #endif
15552 /* Scroll if point within this distance from the top or bottom
15553 of the window. This is a pixel value. */
15554 if (scroll_margin > 0)
15556 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
15557 this_scroll_margin *= frame_line_height;
15559 else
15560 this_scroll_margin = 0;
15562 top_scroll_margin = this_scroll_margin;
15563 if (WINDOW_WANTS_HEADER_LINE_P (w))
15564 top_scroll_margin += CURRENT_HEADER_LINE_HEIGHT (w);
15566 /* Start with the row the cursor was displayed during the last
15567 not paused redisplay. Give up if that row is not valid. */
15568 if (w->last_cursor_vpos < 0
15569 || w->last_cursor_vpos >= w->current_matrix->nrows)
15570 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15571 else
15573 row = MATRIX_ROW (w->current_matrix, w->last_cursor_vpos);
15574 if (row->mode_line_p)
15575 ++row;
15576 if (!row->enabled_p)
15577 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15580 if (rc == CURSOR_MOVEMENT_CANNOT_BE_USED)
15582 int scroll_p = 0, must_scroll = 0;
15583 int last_y = window_text_bottom_y (w) - this_scroll_margin;
15585 if (PT > w->last_point)
15587 /* Point has moved forward. */
15588 while (MATRIX_ROW_END_CHARPOS (row) < PT
15589 && MATRIX_ROW_BOTTOM_Y (row) < last_y)
15591 eassert (row->enabled_p);
15592 ++row;
15595 /* If the end position of a row equals the start
15596 position of the next row, and PT is at that position,
15597 we would rather display cursor in the next line. */
15598 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15599 && MATRIX_ROW_END_CHARPOS (row) == PT
15600 && row < MATRIX_MODE_LINE_ROW (w->current_matrix)
15601 && MATRIX_ROW_START_CHARPOS (row+1) == PT
15602 && !cursor_row_p (row))
15603 ++row;
15605 /* If within the scroll margin, scroll. Note that
15606 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15607 the next line would be drawn, and that
15608 this_scroll_margin can be zero. */
15609 if (MATRIX_ROW_BOTTOM_Y (row) > last_y
15610 || PT > MATRIX_ROW_END_CHARPOS (row)
15611 /* Line is completely visible last line in window
15612 and PT is to be set in the next line. */
15613 || (MATRIX_ROW_BOTTOM_Y (row) == last_y
15614 && PT == MATRIX_ROW_END_CHARPOS (row)
15615 && !row->ends_at_zv_p
15616 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
15617 scroll_p = 1;
15619 else if (PT < w->last_point)
15621 /* Cursor has to be moved backward. Note that PT >=
15622 CHARPOS (startp) because of the outer if-statement. */
15623 while (!row->mode_line_p
15624 && (MATRIX_ROW_START_CHARPOS (row) > PT
15625 || (MATRIX_ROW_START_CHARPOS (row) == PT
15626 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row)
15627 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15628 row > w->current_matrix->rows
15629 && (row-1)->ends_in_newline_from_string_p))))
15630 && (row->y > top_scroll_margin
15631 || CHARPOS (startp) == BEGV))
15633 eassert (row->enabled_p);
15634 --row;
15637 /* Consider the following case: Window starts at BEGV,
15638 there is invisible, intangible text at BEGV, so that
15639 display starts at some point START > BEGV. It can
15640 happen that we are called with PT somewhere between
15641 BEGV and START. Try to handle that case. */
15642 if (row < w->current_matrix->rows
15643 || row->mode_line_p)
15645 row = w->current_matrix->rows;
15646 if (row->mode_line_p)
15647 ++row;
15650 /* Due to newlines in overlay strings, we may have to
15651 skip forward over overlay strings. */
15652 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15653 && MATRIX_ROW_END_CHARPOS (row) == PT
15654 && !cursor_row_p (row))
15655 ++row;
15657 /* If within the scroll margin, scroll. */
15658 if (row->y < top_scroll_margin
15659 && CHARPOS (startp) != BEGV)
15660 scroll_p = 1;
15662 else
15664 /* Cursor did not move. So don't scroll even if cursor line
15665 is partially visible, as it was so before. */
15666 rc = CURSOR_MOVEMENT_SUCCESS;
15669 if (PT < MATRIX_ROW_START_CHARPOS (row)
15670 || PT > MATRIX_ROW_END_CHARPOS (row))
15672 /* if PT is not in the glyph row, give up. */
15673 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15674 must_scroll = 1;
15676 else if (rc != CURSOR_MOVEMENT_SUCCESS
15677 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15679 struct glyph_row *row1;
15681 /* If rows are bidi-reordered and point moved, back up
15682 until we find a row that does not belong to a
15683 continuation line. This is because we must consider
15684 all rows of a continued line as candidates for the
15685 new cursor positioning, since row start and end
15686 positions change non-linearly with vertical position
15687 in such rows. */
15688 /* FIXME: Revisit this when glyph ``spilling'' in
15689 continuation lines' rows is implemented for
15690 bidi-reordered rows. */
15691 for (row1 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
15692 MATRIX_ROW_CONTINUATION_LINE_P (row);
15693 --row)
15695 /* If we hit the beginning of the displayed portion
15696 without finding the first row of a continued
15697 line, give up. */
15698 if (row <= row1)
15700 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15701 break;
15703 eassert (row->enabled_p);
15706 if (must_scroll)
15708 else if (rc != CURSOR_MOVEMENT_SUCCESS
15709 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w, row)
15710 /* Make sure this isn't a header line by any chance, since
15711 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15712 && !row->mode_line_p
15713 && make_cursor_line_fully_visible_p)
15715 if (PT == MATRIX_ROW_END_CHARPOS (row)
15716 && !row->ends_at_zv_p
15717 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
15718 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15719 else if (row->height > window_box_height (w))
15721 /* If we end up in a partially visible line, let's
15722 make it fully visible, except when it's taller
15723 than the window, in which case we can't do much
15724 about it. */
15725 *scroll_step = 1;
15726 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15728 else
15730 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
15731 if (!cursor_row_fully_visible_p (w, 0, 1))
15732 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15733 else
15734 rc = CURSOR_MOVEMENT_SUCCESS;
15737 else if (scroll_p)
15738 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15739 else if (rc != CURSOR_MOVEMENT_SUCCESS
15740 && !NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
15742 /* With bidi-reordered rows, there could be more than
15743 one candidate row whose start and end positions
15744 occlude point. We need to let set_cursor_from_row
15745 find the best candidate. */
15746 /* FIXME: Revisit this when glyph ``spilling'' in
15747 continuation lines' rows is implemented for
15748 bidi-reordered rows. */
15749 int rv = 0;
15753 int at_zv_p = 0, exact_match_p = 0;
15755 if (MATRIX_ROW_START_CHARPOS (row) <= PT
15756 && PT <= MATRIX_ROW_END_CHARPOS (row)
15757 && cursor_row_p (row))
15758 rv |= set_cursor_from_row (w, row, w->current_matrix,
15759 0, 0, 0, 0);
15760 /* As soon as we've found the exact match for point,
15761 or the first suitable row whose ends_at_zv_p flag
15762 is set, we are done. */
15763 if (rv)
15765 at_zv_p = MATRIX_ROW (w->current_matrix,
15766 w->cursor.vpos)->ends_at_zv_p;
15767 if (!at_zv_p
15768 && w->cursor.hpos >= 0
15769 && w->cursor.hpos < MATRIX_ROW_USED (w->current_matrix,
15770 w->cursor.vpos))
15772 struct glyph_row *candidate =
15773 MATRIX_ROW (w->current_matrix, w->cursor.vpos);
15774 struct glyph *g =
15775 candidate->glyphs[TEXT_AREA] + w->cursor.hpos;
15776 ptrdiff_t endpos = MATRIX_ROW_END_CHARPOS (candidate);
15778 exact_match_p =
15779 (BUFFERP (g->object) && g->charpos == PT)
15780 || (INTEGERP (g->object)
15781 && (g->charpos == PT
15782 || (g->charpos == 0 && endpos - 1 == PT)));
15784 if (at_zv_p || exact_match_p)
15786 rc = CURSOR_MOVEMENT_SUCCESS;
15787 break;
15790 if (MATRIX_ROW_BOTTOM_Y (row) == last_y)
15791 break;
15792 ++row;
15794 while (((MATRIX_ROW_CONTINUATION_LINE_P (row)
15795 || row->continued_p)
15796 && MATRIX_ROW_BOTTOM_Y (row) <= last_y)
15797 || (MATRIX_ROW_START_CHARPOS (row) == PT
15798 && MATRIX_ROW_BOTTOM_Y (row) < last_y));
15799 /* If we didn't find any candidate rows, or exited the
15800 loop before all the candidates were examined, signal
15801 to the caller that this method failed. */
15802 if (rc != CURSOR_MOVEMENT_SUCCESS
15803 && !(rv
15804 && !MATRIX_ROW_CONTINUATION_LINE_P (row)
15805 && !row->continued_p))
15806 rc = CURSOR_MOVEMENT_MUST_SCROLL;
15807 else if (rv)
15808 rc = CURSOR_MOVEMENT_SUCCESS;
15810 else
15814 if (set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0))
15816 rc = CURSOR_MOVEMENT_SUCCESS;
15817 break;
15819 ++row;
15821 while (MATRIX_ROW_BOTTOM_Y (row) < last_y
15822 && MATRIX_ROW_START_CHARPOS (row) == PT
15823 && cursor_row_p (row));
15828 return rc;
15831 #if !defined USE_TOOLKIT_SCROLL_BARS || defined USE_GTK
15832 static
15833 #endif
15834 void
15835 set_vertical_scroll_bar (struct window *w)
15837 ptrdiff_t start, end, whole;
15839 /* Calculate the start and end positions for the current window.
15840 At some point, it would be nice to choose between scrollbars
15841 which reflect the whole buffer size, with special markers
15842 indicating narrowing, and scrollbars which reflect only the
15843 visible region.
15845 Note that mini-buffers sometimes aren't displaying any text. */
15846 if (!MINI_WINDOW_P (w)
15847 || (w == XWINDOW (minibuf_window)
15848 && NILP (echo_area_buffer[0])))
15850 struct buffer *buf = XBUFFER (w->contents);
15851 whole = BUF_ZV (buf) - BUF_BEGV (buf);
15852 start = marker_position (w->start) - BUF_BEGV (buf);
15853 /* I don't think this is guaranteed to be right. For the
15854 moment, we'll pretend it is. */
15855 end = BUF_Z (buf) - w->window_end_pos - BUF_BEGV (buf);
15857 if (end < start)
15858 end = start;
15859 if (whole < (end - start))
15860 whole = end - start;
15862 else
15863 start = end = whole = 0;
15865 /* Indicate what this scroll bar ought to be displaying now. */
15866 if (FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15867 (*FRAME_TERMINAL (XFRAME (w->frame))->set_vertical_scroll_bar_hook)
15868 (w, end - start, whole, start);
15872 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15873 selected_window is redisplayed.
15875 We can return without actually redisplaying the window if fonts has been
15876 changed on window's frame. In that case, redisplay_internal will retry.
15878 As one of the important parts of redisplaying a window, we need to
15879 decide whether the previous window-start position (stored in the
15880 window's w->start marker position) is still valid, and if it isn't,
15881 recompute it. Some details about that:
15883 . The previous window-start could be in a continuation line, in
15884 which case we need to recompute it when the window width
15885 changes. See compute_window_start_on_continuation_line and its
15886 call below.
15888 . The text that changed since last redisplay could include the
15889 previous window-start position. In that case, we try to salvage
15890 what we can from the current glyph matrix by calling
15891 try_scrolling, which see.
15893 . Some Emacs command could force us to use a specific window-start
15894 position by setting the window's force_start flag, or gently
15895 propose doing that by setting the window's optional_new_start
15896 flag. In these cases, we try using the specified start point if
15897 that succeeds (i.e. the window desired matrix is successfully
15898 recomputed, and point location is within the window). In case
15899 of optional_new_start, we first check if the specified start
15900 position is feasible, i.e. if it will allow point to be
15901 displayed in the window. If using the specified start point
15902 fails, e.g., if new fonts are needed to be loaded, we abort the
15903 redisplay cycle and leave it up to the next cycle to figure out
15904 things.
15906 . Note that the window's force_start flag is sometimes set by
15907 redisplay itself, when it decides that the previous window start
15908 point is fine and should be kept. Search for "goto force_start"
15909 below to see the details. Like the values of window-start
15910 specified outside of redisplay, these internally-deduced values
15911 are tested for feasibility, and ignored if found to be
15912 unfeasible.
15914 . Note that the function try_window, used to completely redisplay
15915 a window, accepts the window's start point as its argument.
15916 This is used several times in the redisplay code to control
15917 where the window start will be, according to user options such
15918 as scroll-conservatively, and also to ensure the screen line
15919 showing point will be fully (as opposed to partially) visible on
15920 display. */
15922 static void
15923 redisplay_window (Lisp_Object window, bool just_this_one_p)
15925 struct window *w = XWINDOW (window);
15926 struct frame *f = XFRAME (w->frame);
15927 struct buffer *buffer = XBUFFER (w->contents);
15928 struct buffer *old = current_buffer;
15929 struct text_pos lpoint, opoint, startp;
15930 int update_mode_line;
15931 int tem;
15932 struct it it;
15933 /* Record it now because it's overwritten. */
15934 bool current_matrix_up_to_date_p = false;
15935 bool used_current_matrix_p = false;
15936 /* This is less strict than current_matrix_up_to_date_p.
15937 It indicates that the buffer contents and narrowing are unchanged. */
15938 bool buffer_unchanged_p = false;
15939 int temp_scroll_step = 0;
15940 ptrdiff_t count = SPECPDL_INDEX ();
15941 int rc;
15942 int centering_position = -1;
15943 int last_line_misfit = 0;
15944 ptrdiff_t beg_unchanged, end_unchanged;
15945 int frame_line_height;
15947 SET_TEXT_POS (lpoint, PT, PT_BYTE);
15948 opoint = lpoint;
15950 #ifdef GLYPH_DEBUG
15951 *w->desired_matrix->method = 0;
15952 #endif
15954 if (!just_this_one_p
15955 && REDISPLAY_SOME_P ()
15956 && !w->redisplay
15957 && !f->redisplay
15958 && !buffer->text->redisplay
15959 && BUF_PT (buffer) == w->last_point)
15960 return;
15962 /* Make sure that both W's markers are valid. */
15963 eassert (XMARKER (w->start)->buffer == buffer);
15964 eassert (XMARKER (w->pointm)->buffer == buffer);
15966 /* We come here again if we need to run window-text-change-functions
15967 below. */
15968 restart:
15969 reconsider_clip_changes (w);
15970 frame_line_height = default_line_pixel_height (w);
15972 /* Has the mode line to be updated? */
15973 update_mode_line = (w->update_mode_line
15974 || update_mode_lines
15975 || buffer->clip_changed
15976 || buffer->prevent_redisplay_optimizations_p);
15978 if (!just_this_one_p)
15979 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15980 cleverly elsewhere. */
15981 w->must_be_updated_p = true;
15983 if (MINI_WINDOW_P (w))
15985 if (w == XWINDOW (echo_area_window)
15986 && !NILP (echo_area_buffer[0]))
15988 if (update_mode_line)
15989 /* We may have to update a tty frame's menu bar or a
15990 tool-bar. Example `M-x C-h C-h C-g'. */
15991 goto finish_menu_bars;
15992 else
15993 /* We've already displayed the echo area glyphs in this window. */
15994 goto finish_scroll_bars;
15996 else if ((w != XWINDOW (minibuf_window)
15997 || minibuf_level == 0)
15998 /* When buffer is nonempty, redisplay window normally. */
15999 && BUF_Z (XBUFFER (w->contents)) == BUF_BEG (XBUFFER (w->contents))
16000 /* Quail displays non-mini buffers in minibuffer window.
16001 In that case, redisplay the window normally. */
16002 && !NILP (Fmemq (w->contents, Vminibuffer_list)))
16004 /* W is a mini-buffer window, but it's not active, so clear
16005 it. */
16006 int yb = window_text_bottom_y (w);
16007 struct glyph_row *row;
16008 int y;
16010 for (y = 0, row = w->desired_matrix->rows;
16011 y < yb;
16012 y += row->height, ++row)
16013 blank_row (w, row, y);
16014 goto finish_scroll_bars;
16017 clear_glyph_matrix (w->desired_matrix);
16020 /* Otherwise set up data on this window; select its buffer and point
16021 value. */
16022 /* Really select the buffer, for the sake of buffer-local
16023 variables. */
16024 set_buffer_internal_1 (XBUFFER (w->contents));
16026 current_matrix_up_to_date_p
16027 = (w->window_end_valid
16028 && !current_buffer->clip_changed
16029 && !current_buffer->prevent_redisplay_optimizations_p
16030 && !window_outdated (w));
16032 /* Run the window-text-change-functions
16033 if it is possible that the text on the screen has changed
16034 (either due to modification of the text, or any other reason). */
16035 if (!current_matrix_up_to_date_p
16036 && !NILP (Vwindow_text_change_functions))
16038 safe_run_hooks (Qwindow_text_change_functions);
16039 goto restart;
16042 beg_unchanged = BEG_UNCHANGED;
16043 end_unchanged = END_UNCHANGED;
16045 SET_TEXT_POS (opoint, PT, PT_BYTE);
16047 specbind (Qinhibit_point_motion_hooks, Qt);
16049 buffer_unchanged_p
16050 = (w->window_end_valid
16051 && !current_buffer->clip_changed
16052 && !window_outdated (w));
16054 /* When windows_or_buffers_changed is non-zero, we can't rely
16055 on the window end being valid, so set it to zero there. */
16056 if (windows_or_buffers_changed)
16058 /* If window starts on a continuation line, maybe adjust the
16059 window start in case the window's width changed. */
16060 if (XMARKER (w->start)->buffer == current_buffer)
16061 compute_window_start_on_continuation_line (w);
16063 w->window_end_valid = false;
16064 /* If so, we also can't rely on current matrix
16065 and should not fool try_cursor_movement below. */
16066 current_matrix_up_to_date_p = false;
16069 /* Some sanity checks. */
16070 CHECK_WINDOW_END (w);
16071 if (Z == Z_BYTE && CHARPOS (opoint) != BYTEPOS (opoint))
16072 emacs_abort ();
16073 if (BYTEPOS (opoint) < CHARPOS (opoint))
16074 emacs_abort ();
16076 if (mode_line_update_needed (w))
16077 update_mode_line = 1;
16079 /* Point refers normally to the selected window. For any other
16080 window, set up appropriate value. */
16081 if (!EQ (window, selected_window))
16083 ptrdiff_t new_pt = marker_position (w->pointm);
16084 ptrdiff_t new_pt_byte = marker_byte_position (w->pointm);
16085 if (new_pt < BEGV)
16087 new_pt = BEGV;
16088 new_pt_byte = BEGV_BYTE;
16089 set_marker_both (w->pointm, Qnil, BEGV, BEGV_BYTE);
16091 else if (new_pt > (ZV - 1))
16093 new_pt = ZV;
16094 new_pt_byte = ZV_BYTE;
16095 set_marker_both (w->pointm, Qnil, ZV, ZV_BYTE);
16098 /* We don't use SET_PT so that the point-motion hooks don't run. */
16099 TEMP_SET_PT_BOTH (new_pt, new_pt_byte);
16102 /* If any of the character widths specified in the display table
16103 have changed, invalidate the width run cache. It's true that
16104 this may be a bit late to catch such changes, but the rest of
16105 redisplay goes (non-fatally) haywire when the display table is
16106 changed, so why should we worry about doing any better? */
16107 if (current_buffer->width_run_cache
16108 || (current_buffer->base_buffer
16109 && current_buffer->base_buffer->width_run_cache))
16111 struct Lisp_Char_Table *disptab = buffer_display_table ();
16113 if (! disptab_matches_widthtab
16114 (disptab, XVECTOR (BVAR (current_buffer, width_table))))
16116 struct buffer *buf = current_buffer;
16118 if (buf->base_buffer)
16119 buf = buf->base_buffer;
16120 invalidate_region_cache (buf, buf->width_run_cache, BEG, Z);
16121 recompute_width_table (current_buffer, disptab);
16125 /* If window-start is screwed up, choose a new one. */
16126 if (XMARKER (w->start)->buffer != current_buffer)
16127 goto recenter;
16129 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16131 /* If someone specified a new starting point but did not insist,
16132 check whether it can be used. */
16133 if (w->optional_new_start
16134 && CHARPOS (startp) >= BEGV
16135 && CHARPOS (startp) <= ZV)
16137 w->optional_new_start = 0;
16138 start_display (&it, w, startp);
16139 move_it_to (&it, PT, 0, it.last_visible_y, -1,
16140 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y);
16141 if (IT_CHARPOS (it) == PT)
16142 w->force_start = 1;
16143 /* IT may overshoot PT if text at PT is invisible. */
16144 else if (IT_CHARPOS (it) > PT && CHARPOS (startp) <= PT)
16145 w->force_start = 1;
16148 force_start:
16150 /* Handle case where place to start displaying has been specified,
16151 unless the specified location is outside the accessible range. */
16152 if (w->force_start || window_frozen_p (w))
16154 /* We set this later on if we have to adjust point. */
16155 int new_vpos = -1;
16157 w->force_start = 0;
16158 w->vscroll = 0;
16159 w->window_end_valid = 0;
16161 /* Forget any recorded base line for line number display. */
16162 if (!buffer_unchanged_p)
16163 w->base_line_number = 0;
16165 /* Redisplay the mode line. Select the buffer properly for that.
16166 Also, run the hook window-scroll-functions
16167 because we have scrolled. */
16168 /* Note, we do this after clearing force_start because
16169 if there's an error, it is better to forget about force_start
16170 than to get into an infinite loop calling the hook functions
16171 and having them get more errors. */
16172 if (!update_mode_line
16173 || ! NILP (Vwindow_scroll_functions))
16175 update_mode_line = 1;
16176 w->update_mode_line = 1;
16177 startp = run_window_scroll_functions (window, startp);
16180 if (CHARPOS (startp) < BEGV)
16181 SET_TEXT_POS (startp, BEGV, BEGV_BYTE);
16182 else if (CHARPOS (startp) > ZV)
16183 SET_TEXT_POS (startp, ZV, ZV_BYTE);
16185 /* Redisplay, then check if cursor has been set during the
16186 redisplay. Give up if new fonts were loaded. */
16187 /* We used to issue a CHECK_MARGINS argument to try_window here,
16188 but this causes scrolling to fail when point begins inside
16189 the scroll margin (bug#148) -- cyd */
16190 if (!try_window (window, startp, 0))
16192 w->force_start = 1;
16193 clear_glyph_matrix (w->desired_matrix);
16194 goto need_larger_matrices;
16197 if (w->cursor.vpos < 0 && !window_frozen_p (w))
16199 /* If point does not appear, try to move point so it does
16200 appear. The desired matrix has been built above, so we
16201 can use it here. */
16202 new_vpos = window_box_height (w) / 2;
16205 if (!cursor_row_fully_visible_p (w, 0, 0))
16207 /* Point does appear, but on a line partly visible at end of window.
16208 Move it back to a fully-visible line. */
16209 new_vpos = window_box_height (w);
16210 /* But if window_box_height suggests a Y coordinate that is
16211 not less than we already have, that line will clearly not
16212 be fully visible, so give up and scroll the display.
16213 This can happen when the default face uses a font whose
16214 dimensions are different from the frame's default
16215 font. */
16216 if (new_vpos >= w->cursor.y)
16218 w->cursor.vpos = -1;
16219 clear_glyph_matrix (w->desired_matrix);
16220 goto try_to_scroll;
16223 else if (w->cursor.vpos >= 0)
16225 /* Some people insist on not letting point enter the scroll
16226 margin, even though this part handles windows that didn't
16227 scroll at all. */
16228 int window_total_lines
16229 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16230 int margin = min (scroll_margin, window_total_lines / 4);
16231 int pixel_margin = margin * frame_line_height;
16232 bool header_line = WINDOW_WANTS_HEADER_LINE_P (w);
16234 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16235 below, which finds the row to move point to, advances by
16236 the Y coordinate of the _next_ row, see the definition of
16237 MATRIX_ROW_BOTTOM_Y. */
16238 if (w->cursor.vpos < margin + header_line)
16240 w->cursor.vpos = -1;
16241 clear_glyph_matrix (w->desired_matrix);
16242 goto try_to_scroll;
16244 else
16246 int window_height = window_box_height (w);
16248 if (header_line)
16249 window_height += CURRENT_HEADER_LINE_HEIGHT (w);
16250 if (w->cursor.y >= window_height - pixel_margin)
16252 w->cursor.vpos = -1;
16253 clear_glyph_matrix (w->desired_matrix);
16254 goto try_to_scroll;
16259 /* If we need to move point for either of the above reasons,
16260 now actually do it. */
16261 if (new_vpos >= 0)
16263 struct glyph_row *row;
16265 row = MATRIX_FIRST_TEXT_ROW (w->desired_matrix);
16266 while (MATRIX_ROW_BOTTOM_Y (row) < new_vpos)
16267 ++row;
16269 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row),
16270 MATRIX_ROW_START_BYTEPOS (row));
16272 if (w != XWINDOW (selected_window))
16273 set_marker_both (w->pointm, Qnil, PT, PT_BYTE);
16274 else if (current_buffer == old)
16275 SET_TEXT_POS (lpoint, PT, PT_BYTE);
16277 set_cursor_from_row (w, row, w->desired_matrix, 0, 0, 0, 0);
16279 /* If we are highlighting the region, then we just changed
16280 the region, so redisplay to show it. */
16281 /* FIXME: We need to (re)run pre-redisplay-function! */
16282 /* if (markpos_of_region () >= 0)
16284 clear_glyph_matrix (w->desired_matrix);
16285 if (!try_window (window, startp, 0))
16286 goto need_larger_matrices;
16291 #ifdef GLYPH_DEBUG
16292 debug_method_add (w, "forced window start");
16293 #endif
16294 goto done;
16297 /* Handle case where text has not changed, only point, and it has
16298 not moved off the frame, and we are not retrying after hscroll.
16299 (current_matrix_up_to_date_p is nonzero when retrying.) */
16300 if (current_matrix_up_to_date_p
16301 && (rc = try_cursor_movement (window, startp, &temp_scroll_step),
16302 rc != CURSOR_MOVEMENT_CANNOT_BE_USED))
16304 switch (rc)
16306 case CURSOR_MOVEMENT_SUCCESS:
16307 used_current_matrix_p = 1;
16308 goto done;
16310 case CURSOR_MOVEMENT_MUST_SCROLL:
16311 goto try_to_scroll;
16313 default:
16314 emacs_abort ();
16317 /* If current starting point was originally the beginning of a line
16318 but no longer is, find a new starting point. */
16319 else if (w->start_at_line_beg
16320 && !(CHARPOS (startp) <= BEGV
16321 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n'))
16323 #ifdef GLYPH_DEBUG
16324 debug_method_add (w, "recenter 1");
16325 #endif
16326 goto recenter;
16329 /* Try scrolling with try_window_id. Value is > 0 if update has
16330 been done, it is -1 if we know that the same window start will
16331 not work. It is 0 if unsuccessful for some other reason. */
16332 else if ((tem = try_window_id (w)) != 0)
16334 #ifdef GLYPH_DEBUG
16335 debug_method_add (w, "try_window_id %d", tem);
16336 #endif
16338 if (f->fonts_changed)
16339 goto need_larger_matrices;
16340 if (tem > 0)
16341 goto done;
16343 /* Otherwise try_window_id has returned -1 which means that we
16344 don't want the alternative below this comment to execute. */
16346 else if (CHARPOS (startp) >= BEGV
16347 && CHARPOS (startp) <= ZV
16348 && PT >= CHARPOS (startp)
16349 && (CHARPOS (startp) < ZV
16350 /* Avoid starting at end of buffer. */
16351 || CHARPOS (startp) == BEGV
16352 || !window_outdated (w)))
16354 int d1, d2, d3, d4, d5, d6;
16356 /* If first window line is a continuation line, and window start
16357 is inside the modified region, but the first change is before
16358 current window start, we must select a new window start.
16360 However, if this is the result of a down-mouse event (e.g. by
16361 extending the mouse-drag-overlay), we don't want to select a
16362 new window start, since that would change the position under
16363 the mouse, resulting in an unwanted mouse-movement rather
16364 than a simple mouse-click. */
16365 if (!w->start_at_line_beg
16366 && NILP (do_mouse_tracking)
16367 && CHARPOS (startp) > BEGV
16368 && CHARPOS (startp) > BEG + beg_unchanged
16369 && CHARPOS (startp) <= Z - end_unchanged
16370 /* Even if w->start_at_line_beg is nil, a new window may
16371 start at a line_beg, since that's how set_buffer_window
16372 sets it. So, we need to check the return value of
16373 compute_window_start_on_continuation_line. (See also
16374 bug#197). */
16375 && XMARKER (w->start)->buffer == current_buffer
16376 && compute_window_start_on_continuation_line (w)
16377 /* It doesn't make sense to force the window start like we
16378 do at label force_start if it is already known that point
16379 will not be visible in the resulting window, because
16380 doing so will move point from its correct position
16381 instead of scrolling the window to bring point into view.
16382 See bug#9324. */
16383 && pos_visible_p (w, PT, &d1, &d2, &d3, &d4, &d5, &d6))
16385 w->force_start = 1;
16386 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16387 goto force_start;
16390 #ifdef GLYPH_DEBUG
16391 debug_method_add (w, "same window start");
16392 #endif
16394 /* Try to redisplay starting at same place as before.
16395 If point has not moved off frame, accept the results. */
16396 if (!current_matrix_up_to_date_p
16397 /* Don't use try_window_reusing_current_matrix in this case
16398 because a window scroll function can have changed the
16399 buffer. */
16400 || !NILP (Vwindow_scroll_functions)
16401 || MINI_WINDOW_P (w)
16402 || !(used_current_matrix_p
16403 = try_window_reusing_current_matrix (w)))
16405 IF_DEBUG (debug_method_add (w, "1"));
16406 if (try_window (window, startp, TRY_WINDOW_CHECK_MARGINS) < 0)
16407 /* -1 means we need to scroll.
16408 0 means we need new matrices, but fonts_changed
16409 is set in that case, so we will detect it below. */
16410 goto try_to_scroll;
16413 if (f->fonts_changed)
16414 goto need_larger_matrices;
16416 if (w->cursor.vpos >= 0)
16418 if (!just_this_one_p
16419 || current_buffer->clip_changed
16420 || BEG_UNCHANGED < CHARPOS (startp))
16421 /* Forget any recorded base line for line number display. */
16422 w->base_line_number = 0;
16424 if (!cursor_row_fully_visible_p (w, 1, 0))
16426 clear_glyph_matrix (w->desired_matrix);
16427 last_line_misfit = 1;
16429 /* Drop through and scroll. */
16430 else
16431 goto done;
16433 else
16434 clear_glyph_matrix (w->desired_matrix);
16437 try_to_scroll:
16439 /* Redisplay the mode line. Select the buffer properly for that. */
16440 if (!update_mode_line)
16442 update_mode_line = 1;
16443 w->update_mode_line = 1;
16446 /* Try to scroll by specified few lines. */
16447 if ((scroll_conservatively
16448 || emacs_scroll_step
16449 || temp_scroll_step
16450 || NUMBERP (BVAR (current_buffer, scroll_up_aggressively))
16451 || NUMBERP (BVAR (current_buffer, scroll_down_aggressively)))
16452 && CHARPOS (startp) >= BEGV
16453 && CHARPOS (startp) <= ZV)
16455 /* The function returns -1 if new fonts were loaded, 1 if
16456 successful, 0 if not successful. */
16457 int ss = try_scrolling (window, just_this_one_p,
16458 scroll_conservatively,
16459 emacs_scroll_step,
16460 temp_scroll_step, last_line_misfit);
16461 switch (ss)
16463 case SCROLLING_SUCCESS:
16464 goto done;
16466 case SCROLLING_NEED_LARGER_MATRICES:
16467 goto need_larger_matrices;
16469 case SCROLLING_FAILED:
16470 break;
16472 default:
16473 emacs_abort ();
16477 /* Finally, just choose a place to start which positions point
16478 according to user preferences. */
16480 recenter:
16482 #ifdef GLYPH_DEBUG
16483 debug_method_add (w, "recenter");
16484 #endif
16486 /* Forget any previously recorded base line for line number display. */
16487 if (!buffer_unchanged_p)
16488 w->base_line_number = 0;
16490 /* Determine the window start relative to point. */
16491 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16492 it.current_y = it.last_visible_y;
16493 if (centering_position < 0)
16495 int window_total_lines
16496 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16497 int margin =
16498 scroll_margin > 0
16499 ? min (scroll_margin, window_total_lines / 4)
16500 : 0;
16501 ptrdiff_t margin_pos = CHARPOS (startp);
16502 Lisp_Object aggressive;
16503 int scrolling_up;
16505 /* If there is a scroll margin at the top of the window, find
16506 its character position. */
16507 if (margin
16508 /* Cannot call start_display if startp is not in the
16509 accessible region of the buffer. This can happen when we
16510 have just switched to a different buffer and/or changed
16511 its restriction. In that case, startp is initialized to
16512 the character position 1 (BEGV) because we did not yet
16513 have chance to display the buffer even once. */
16514 && BEGV <= CHARPOS (startp) && CHARPOS (startp) <= ZV)
16516 struct it it1;
16517 void *it1data = NULL;
16519 SAVE_IT (it1, it, it1data);
16520 start_display (&it1, w, startp);
16521 move_it_vertically (&it1, margin * frame_line_height);
16522 margin_pos = IT_CHARPOS (it1);
16523 RESTORE_IT (&it, &it, it1data);
16525 scrolling_up = PT > margin_pos;
16526 aggressive =
16527 scrolling_up
16528 ? BVAR (current_buffer, scroll_up_aggressively)
16529 : BVAR (current_buffer, scroll_down_aggressively);
16531 if (!MINI_WINDOW_P (w)
16532 && (scroll_conservatively > SCROLL_LIMIT || NUMBERP (aggressive)))
16534 int pt_offset = 0;
16536 /* Setting scroll-conservatively overrides
16537 scroll-*-aggressively. */
16538 if (!scroll_conservatively && NUMBERP (aggressive))
16540 double float_amount = XFLOATINT (aggressive);
16542 pt_offset = float_amount * WINDOW_BOX_TEXT_HEIGHT (w);
16543 if (pt_offset == 0 && float_amount > 0)
16544 pt_offset = 1;
16545 if (pt_offset && margin > 0)
16546 margin -= 1;
16548 /* Compute how much to move the window start backward from
16549 point so that point will be displayed where the user
16550 wants it. */
16551 if (scrolling_up)
16553 centering_position = it.last_visible_y;
16554 if (pt_offset)
16555 centering_position -= pt_offset;
16556 centering_position -=
16557 frame_line_height * (1 + margin + (last_line_misfit != 0))
16558 + WINDOW_HEADER_LINE_HEIGHT (w);
16559 /* Don't let point enter the scroll margin near top of
16560 the window. */
16561 if (centering_position < margin * frame_line_height)
16562 centering_position = margin * frame_line_height;
16564 else
16565 centering_position = margin * frame_line_height + pt_offset;
16567 else
16568 /* Set the window start half the height of the window backward
16569 from point. */
16570 centering_position = window_box_height (w) / 2;
16572 move_it_vertically_backward (&it, centering_position);
16574 eassert (IT_CHARPOS (it) >= BEGV);
16576 /* The function move_it_vertically_backward may move over more
16577 than the specified y-distance. If it->w is small, e.g. a
16578 mini-buffer window, we may end up in front of the window's
16579 display area. Start displaying at the start of the line
16580 containing PT in this case. */
16581 if (it.current_y <= 0)
16583 init_iterator (&it, w, PT, PT_BYTE, NULL, DEFAULT_FACE_ID);
16584 move_it_vertically_backward (&it, 0);
16585 it.current_y = 0;
16588 it.current_x = it.hpos = 0;
16590 /* Set the window start position here explicitly, to avoid an
16591 infinite loop in case the functions in window-scroll-functions
16592 get errors. */
16593 set_marker_both (w->start, Qnil, IT_CHARPOS (it), IT_BYTEPOS (it));
16595 /* Run scroll hooks. */
16596 startp = run_window_scroll_functions (window, it.current.pos);
16598 /* Redisplay the window. */
16599 if (!current_matrix_up_to_date_p
16600 || windows_or_buffers_changed
16601 || f->cursor_type_changed
16602 /* Don't use try_window_reusing_current_matrix in this case
16603 because it can have changed the buffer. */
16604 || !NILP (Vwindow_scroll_functions)
16605 || !just_this_one_p
16606 || MINI_WINDOW_P (w)
16607 || !(used_current_matrix_p
16608 = try_window_reusing_current_matrix (w)))
16609 try_window (window, startp, 0);
16611 /* If new fonts have been loaded (due to fontsets), give up. We
16612 have to start a new redisplay since we need to re-adjust glyph
16613 matrices. */
16614 if (f->fonts_changed)
16615 goto need_larger_matrices;
16617 /* If cursor did not appear assume that the middle of the window is
16618 in the first line of the window. Do it again with the next line.
16619 (Imagine a window of height 100, displaying two lines of height
16620 60. Moving back 50 from it->last_visible_y will end in the first
16621 line.) */
16622 if (w->cursor.vpos < 0)
16624 if (w->window_end_valid && PT >= Z - w->window_end_pos)
16626 clear_glyph_matrix (w->desired_matrix);
16627 move_it_by_lines (&it, 1);
16628 try_window (window, it.current.pos, 0);
16630 else if (PT < IT_CHARPOS (it))
16632 clear_glyph_matrix (w->desired_matrix);
16633 move_it_by_lines (&it, -1);
16634 try_window (window, it.current.pos, 0);
16636 else
16638 /* Not much we can do about it. */
16642 /* Consider the following case: Window starts at BEGV, there is
16643 invisible, intangible text at BEGV, so that display starts at
16644 some point START > BEGV. It can happen that we are called with
16645 PT somewhere between BEGV and START. Try to handle that case,
16646 and similar ones. */
16647 if (w->cursor.vpos < 0)
16649 /* First, try locating the proper glyph row for PT. */
16650 struct glyph_row *row =
16651 row_containing_pos (w, PT, w->current_matrix->rows, NULL, 0);
16653 /* Sometimes point is at the beginning of invisible text that is
16654 before the 1st character displayed in the row. In that case,
16655 row_containing_pos fails to find the row, because no glyphs
16656 with appropriate buffer positions are present in the row.
16657 Therefore, we next try to find the row which shows the 1st
16658 position after the invisible text. */
16659 if (!row)
16661 Lisp_Object val =
16662 get_char_property_and_overlay (make_number (PT), Qinvisible,
16663 Qnil, NULL);
16665 if (TEXT_PROP_MEANS_INVISIBLE (val))
16667 ptrdiff_t alt_pos;
16668 Lisp_Object invis_end =
16669 Fnext_single_char_property_change (make_number (PT), Qinvisible,
16670 Qnil, Qnil);
16672 if (NATNUMP (invis_end))
16673 alt_pos = XFASTINT (invis_end);
16674 else
16675 alt_pos = ZV;
16676 row = row_containing_pos (w, alt_pos, w->current_matrix->rows,
16677 NULL, 0);
16680 /* Finally, fall back on the first row of the window after the
16681 header line (if any). This is slightly better than not
16682 displaying the cursor at all. */
16683 if (!row)
16685 row = w->current_matrix->rows;
16686 if (row->mode_line_p)
16687 ++row;
16689 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
16692 if (!cursor_row_fully_visible_p (w, 0, 0))
16694 /* If vscroll is enabled, disable it and try again. */
16695 if (w->vscroll)
16697 w->vscroll = 0;
16698 clear_glyph_matrix (w->desired_matrix);
16699 goto recenter;
16702 /* Users who set scroll-conservatively to a large number want
16703 point just above/below the scroll margin. If we ended up
16704 with point's row partially visible, move the window start to
16705 make that row fully visible and out of the margin. */
16706 if (scroll_conservatively > SCROLL_LIMIT)
16708 int window_total_lines
16709 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) * frame_line_height;
16710 int margin =
16711 scroll_margin > 0
16712 ? min (scroll_margin, window_total_lines / 4)
16713 : 0;
16714 int move_down = w->cursor.vpos >= window_total_lines / 2;
16716 move_it_by_lines (&it, move_down ? margin + 1 : -(margin + 1));
16717 clear_glyph_matrix (w->desired_matrix);
16718 if (1 == try_window (window, it.current.pos,
16719 TRY_WINDOW_CHECK_MARGINS))
16720 goto done;
16723 /* If centering point failed to make the whole line visible,
16724 put point at the top instead. That has to make the whole line
16725 visible, if it can be done. */
16726 if (centering_position == 0)
16727 goto done;
16729 clear_glyph_matrix (w->desired_matrix);
16730 centering_position = 0;
16731 goto recenter;
16734 done:
16736 SET_TEXT_POS_FROM_MARKER (startp, w->start);
16737 w->start_at_line_beg = (CHARPOS (startp) == BEGV
16738 || FETCH_BYTE (BYTEPOS (startp) - 1) == '\n');
16740 /* Display the mode line, if we must. */
16741 if ((update_mode_line
16742 /* If window not full width, must redo its mode line
16743 if (a) the window to its side is being redone and
16744 (b) we do a frame-based redisplay. This is a consequence
16745 of how inverted lines are drawn in frame-based redisplay. */
16746 || (!just_this_one_p
16747 && !FRAME_WINDOW_P (f)
16748 && !WINDOW_FULL_WIDTH_P (w))
16749 /* Line number to display. */
16750 || w->base_line_pos > 0
16751 /* Column number is displayed and different from the one displayed. */
16752 || (w->column_number_displayed != -1
16753 && (w->column_number_displayed != current_column ())))
16754 /* This means that the window has a mode line. */
16755 && (WINDOW_WANTS_MODELINE_P (w)
16756 || WINDOW_WANTS_HEADER_LINE_P (w)))
16759 display_mode_lines (w);
16761 /* If mode line height has changed, arrange for a thorough
16762 immediate redisplay using the correct mode line height. */
16763 if (WINDOW_WANTS_MODELINE_P (w)
16764 && CURRENT_MODE_LINE_HEIGHT (w) != DESIRED_MODE_LINE_HEIGHT (w))
16766 f->fonts_changed = 1;
16767 w->mode_line_height = -1;
16768 MATRIX_MODE_LINE_ROW (w->current_matrix)->height
16769 = DESIRED_MODE_LINE_HEIGHT (w);
16772 /* If header line height has changed, arrange for a thorough
16773 immediate redisplay using the correct header line height. */
16774 if (WINDOW_WANTS_HEADER_LINE_P (w)
16775 && CURRENT_HEADER_LINE_HEIGHT (w) != DESIRED_HEADER_LINE_HEIGHT (w))
16777 f->fonts_changed = 1;
16778 w->header_line_height = -1;
16779 MATRIX_HEADER_LINE_ROW (w->current_matrix)->height
16780 = DESIRED_HEADER_LINE_HEIGHT (w);
16783 if (f->fonts_changed)
16784 goto need_larger_matrices;
16787 if (!line_number_displayed && w->base_line_pos != -1)
16789 w->base_line_pos = 0;
16790 w->base_line_number = 0;
16793 finish_menu_bars:
16795 /* When we reach a frame's selected window, redo the frame's menu bar. */
16796 if (update_mode_line
16797 && EQ (FRAME_SELECTED_WINDOW (f), window))
16799 int redisplay_menu_p = 0;
16801 if (FRAME_WINDOW_P (f))
16803 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16804 || defined (HAVE_NS) || defined (USE_GTK)
16805 redisplay_menu_p = FRAME_EXTERNAL_MENU_BAR (f);
16806 #else
16807 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16808 #endif
16810 else
16811 redisplay_menu_p = FRAME_MENU_BAR_LINES (f) > 0;
16813 if (redisplay_menu_p)
16814 display_menu_bar (w);
16816 #ifdef HAVE_WINDOW_SYSTEM
16817 if (FRAME_WINDOW_P (f))
16819 #if defined (USE_GTK) || defined (HAVE_NS)
16820 if (FRAME_EXTERNAL_TOOL_BAR (f))
16821 redisplay_tool_bar (f);
16822 #else
16823 if (WINDOWP (f->tool_bar_window)
16824 && (FRAME_TOOL_BAR_HEIGHT (f) > 0
16825 || !NILP (Vauto_resize_tool_bars))
16826 && redisplay_tool_bar (f))
16827 ignore_mouse_drag_p = 1;
16828 #endif
16830 #endif
16833 #ifdef HAVE_WINDOW_SYSTEM
16834 if (FRAME_WINDOW_P (f)
16835 && update_window_fringes (w, (just_this_one_p
16836 || (!used_current_matrix_p && !overlay_arrow_seen)
16837 || w->pseudo_window_p)))
16839 update_begin (f);
16840 block_input ();
16841 if (draw_window_fringes (w, 1))
16843 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
16844 x_draw_right_divider (w);
16845 else
16846 x_draw_vertical_border (w);
16848 unblock_input ();
16849 update_end (f);
16852 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
16853 x_draw_bottom_divider (w);
16854 #endif /* HAVE_WINDOW_SYSTEM */
16856 /* We go to this label, with fonts_changed set, if it is
16857 necessary to try again using larger glyph matrices.
16858 We have to redeem the scroll bar even in this case,
16859 because the loop in redisplay_internal expects that. */
16860 need_larger_matrices:
16862 finish_scroll_bars:
16864 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
16866 /* Set the thumb's position and size. */
16867 set_vertical_scroll_bar (w);
16869 /* Note that we actually used the scroll bar attached to this
16870 window, so it shouldn't be deleted at the end of redisplay. */
16871 if (FRAME_TERMINAL (f)->redeem_scroll_bar_hook)
16872 (*FRAME_TERMINAL (f)->redeem_scroll_bar_hook) (w);
16875 /* Restore current_buffer and value of point in it. The window
16876 update may have changed the buffer, so first make sure `opoint'
16877 is still valid (Bug#6177). */
16878 if (CHARPOS (opoint) < BEGV)
16879 TEMP_SET_PT_BOTH (BEGV, BEGV_BYTE);
16880 else if (CHARPOS (opoint) > ZV)
16881 TEMP_SET_PT_BOTH (Z, Z_BYTE);
16882 else
16883 TEMP_SET_PT_BOTH (CHARPOS (opoint), BYTEPOS (opoint));
16885 set_buffer_internal_1 (old);
16886 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16887 shorter. This can be caused by log truncation in *Messages*. */
16888 if (CHARPOS (lpoint) <= ZV)
16889 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
16891 unbind_to (count, Qnil);
16895 /* Build the complete desired matrix of WINDOW with a window start
16896 buffer position POS.
16898 Value is 1 if successful. It is zero if fonts were loaded during
16899 redisplay which makes re-adjusting glyph matrices necessary, and -1
16900 if point would appear in the scroll margins.
16901 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16902 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16903 set in FLAGS.) */
16906 try_window (Lisp_Object window, struct text_pos pos, int flags)
16908 struct window *w = XWINDOW (window);
16909 struct it it;
16910 struct glyph_row *last_text_row = NULL;
16911 struct frame *f = XFRAME (w->frame);
16912 int frame_line_height = default_line_pixel_height (w);
16914 /* Make POS the new window start. */
16915 set_marker_both (w->start, Qnil, CHARPOS (pos), BYTEPOS (pos));
16917 /* Mark cursor position as unknown. No overlay arrow seen. */
16918 w->cursor.vpos = -1;
16919 overlay_arrow_seen = 0;
16921 /* Initialize iterator and info to start at POS. */
16922 start_display (&it, w, pos);
16924 /* Display all lines of W. */
16925 while (it.current_y < it.last_visible_y)
16927 if (display_line (&it))
16928 last_text_row = it.glyph_row - 1;
16929 if (f->fonts_changed && !(flags & TRY_WINDOW_IGNORE_FONTS_CHANGE))
16930 return 0;
16933 /* Don't let the cursor end in the scroll margins. */
16934 if ((flags & TRY_WINDOW_CHECK_MARGINS)
16935 && !MINI_WINDOW_P (w))
16937 int this_scroll_margin;
16938 int window_total_lines
16939 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (f) / frame_line_height;
16941 if (scroll_margin > 0)
16943 this_scroll_margin = min (scroll_margin, window_total_lines / 4);
16944 this_scroll_margin *= frame_line_height;
16946 else
16947 this_scroll_margin = 0;
16949 if ((w->cursor.y >= 0 /* not vscrolled */
16950 && w->cursor.y < this_scroll_margin
16951 && CHARPOS (pos) > BEGV
16952 && IT_CHARPOS (it) < ZV)
16953 /* rms: considering make_cursor_line_fully_visible_p here
16954 seems to give wrong results. We don't want to recenter
16955 when the last line is partly visible, we want to allow
16956 that case to be handled in the usual way. */
16957 || w->cursor.y > it.last_visible_y - this_scroll_margin - 1)
16959 w->cursor.vpos = -1;
16960 clear_glyph_matrix (w->desired_matrix);
16961 return -1;
16965 /* If bottom moved off end of frame, change mode line percentage. */
16966 if (w->window_end_pos <= 0 && Z != IT_CHARPOS (it))
16967 w->update_mode_line = 1;
16969 /* Set window_end_pos to the offset of the last character displayed
16970 on the window from the end of current_buffer. Set
16971 window_end_vpos to its row number. */
16972 if (last_text_row)
16974 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row));
16975 adjust_window_ends (w, last_text_row, 0);
16976 eassert
16977 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->desired_matrix,
16978 w->window_end_vpos)));
16980 else
16982 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
16983 w->window_end_pos = Z - ZV;
16984 w->window_end_vpos = 0;
16987 /* But that is not valid info until redisplay finishes. */
16988 w->window_end_valid = 0;
16989 return 1;
16994 /************************************************************************
16995 Window redisplay reusing current matrix when buffer has not changed
16996 ************************************************************************/
16998 /* Try redisplay of window W showing an unchanged buffer with a
16999 different window start than the last time it was displayed by
17000 reusing its current matrix. Value is non-zero if successful.
17001 W->start is the new window start. */
17003 static int
17004 try_window_reusing_current_matrix (struct window *w)
17006 struct frame *f = XFRAME (w->frame);
17007 struct glyph_row *bottom_row;
17008 struct it it;
17009 struct run run;
17010 struct text_pos start, new_start;
17011 int nrows_scrolled, i;
17012 struct glyph_row *last_text_row;
17013 struct glyph_row *last_reused_text_row;
17014 struct glyph_row *start_row;
17015 int start_vpos, min_y, max_y;
17017 #ifdef GLYPH_DEBUG
17018 if (inhibit_try_window_reusing)
17019 return 0;
17020 #endif
17022 if (/* This function doesn't handle terminal frames. */
17023 !FRAME_WINDOW_P (f)
17024 /* Don't try to reuse the display if windows have been split
17025 or such. */
17026 || windows_or_buffers_changed
17027 || f->cursor_type_changed)
17028 return 0;
17030 /* Can't do this if showing trailing whitespace. */
17031 if (!NILP (Vshow_trailing_whitespace))
17032 return 0;
17034 /* If top-line visibility has changed, give up. */
17035 if (WINDOW_WANTS_HEADER_LINE_P (w)
17036 != MATRIX_HEADER_LINE_ROW (w->current_matrix)->mode_line_p)
17037 return 0;
17039 /* Give up if old or new display is scrolled vertically. We could
17040 make this function handle this, but right now it doesn't. */
17041 start_row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17042 if (w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row))
17043 return 0;
17045 /* The variable new_start now holds the new window start. The old
17046 start `start' can be determined from the current matrix. */
17047 SET_TEXT_POS_FROM_MARKER (new_start, w->start);
17048 start = start_row->minpos;
17049 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17051 /* Clear the desired matrix for the display below. */
17052 clear_glyph_matrix (w->desired_matrix);
17054 if (CHARPOS (new_start) <= CHARPOS (start))
17056 /* Don't use this method if the display starts with an ellipsis
17057 displayed for invisible text. It's not easy to handle that case
17058 below, and it's certainly not worth the effort since this is
17059 not a frequent case. */
17060 if (in_ellipses_for_invisible_text_p (&start_row->start, w))
17061 return 0;
17063 IF_DEBUG (debug_method_add (w, "twu1"));
17065 /* Display up to a row that can be reused. The variable
17066 last_text_row is set to the last row displayed that displays
17067 text. Note that it.vpos == 0 if or if not there is a
17068 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17069 start_display (&it, w, new_start);
17070 w->cursor.vpos = -1;
17071 last_text_row = last_reused_text_row = NULL;
17073 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17075 /* If we have reached into the characters in the START row,
17076 that means the line boundaries have changed. So we
17077 can't start copying with the row START. Maybe it will
17078 work to start copying with the following row. */
17079 while (IT_CHARPOS (it) > CHARPOS (start))
17081 /* Advance to the next row as the "start". */
17082 start_row++;
17083 start = start_row->minpos;
17084 /* If there are no more rows to try, or just one, give up. */
17085 if (start_row == MATRIX_MODE_LINE_ROW (w->current_matrix) - 1
17086 || w->vscroll || MATRIX_ROW_PARTIALLY_VISIBLE_P (w, start_row)
17087 || CHARPOS (start) == ZV)
17089 clear_glyph_matrix (w->desired_matrix);
17090 return 0;
17093 start_vpos = MATRIX_ROW_VPOS (start_row, w->current_matrix);
17095 /* If we have reached alignment, we can copy the rest of the
17096 rows. */
17097 if (IT_CHARPOS (it) == CHARPOS (start)
17098 /* Don't accept "alignment" inside a display vector,
17099 since start_row could have started in the middle of
17100 that same display vector (thus their character
17101 positions match), and we have no way of telling if
17102 that is the case. */
17103 && it.current.dpvec_index < 0)
17104 break;
17106 if (display_line (&it))
17107 last_text_row = it.glyph_row - 1;
17111 /* A value of current_y < last_visible_y means that we stopped
17112 at the previous window start, which in turn means that we
17113 have at least one reusable row. */
17114 if (it.current_y < it.last_visible_y)
17116 struct glyph_row *row;
17118 /* IT.vpos always starts from 0; it counts text lines. */
17119 nrows_scrolled = it.vpos - (start_row - MATRIX_FIRST_TEXT_ROW (w->current_matrix));
17121 /* Find PT if not already found in the lines displayed. */
17122 if (w->cursor.vpos < 0)
17124 int dy = it.current_y - start_row->y;
17126 row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17127 row = row_containing_pos (w, PT, row, NULL, dy);
17128 if (row)
17129 set_cursor_from_row (w, row, w->current_matrix, 0, 0,
17130 dy, nrows_scrolled);
17131 else
17133 clear_glyph_matrix (w->desired_matrix);
17134 return 0;
17138 /* Scroll the display. Do it before the current matrix is
17139 changed. The problem here is that update has not yet
17140 run, i.e. part of the current matrix is not up to date.
17141 scroll_run_hook will clear the cursor, and use the
17142 current matrix to get the height of the row the cursor is
17143 in. */
17144 run.current_y = start_row->y;
17145 run.desired_y = it.current_y;
17146 run.height = it.last_visible_y - it.current_y;
17148 if (run.height > 0 && run.current_y != run.desired_y)
17150 update_begin (f);
17151 FRAME_RIF (f)->update_window_begin_hook (w);
17152 FRAME_RIF (f)->clear_window_mouse_face (w);
17153 FRAME_RIF (f)->scroll_run_hook (w, &run);
17154 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17155 update_end (f);
17158 /* Shift current matrix down by nrows_scrolled lines. */
17159 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17160 rotate_matrix (w->current_matrix,
17161 start_vpos,
17162 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17163 nrows_scrolled);
17165 /* Disable lines that must be updated. */
17166 for (i = 0; i < nrows_scrolled; ++i)
17167 (start_row + i)->enabled_p = false;
17169 /* Re-compute Y positions. */
17170 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17171 max_y = it.last_visible_y;
17172 for (row = start_row + nrows_scrolled;
17173 row < bottom_row;
17174 ++row)
17176 row->y = it.current_y;
17177 row->visible_height = row->height;
17179 if (row->y < min_y)
17180 row->visible_height -= min_y - row->y;
17181 if (row->y + row->height > max_y)
17182 row->visible_height -= row->y + row->height - max_y;
17183 if (row->fringe_bitmap_periodic_p)
17184 row->redraw_fringe_bitmaps_p = 1;
17186 it.current_y += row->height;
17188 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17189 last_reused_text_row = row;
17190 if (MATRIX_ROW_BOTTOM_Y (row) >= it.last_visible_y)
17191 break;
17194 /* Disable lines in the current matrix which are now
17195 below the window. */
17196 for (++row; row < bottom_row; ++row)
17197 row->enabled_p = row->mode_line_p = 0;
17200 /* Update window_end_pos etc.; last_reused_text_row is the last
17201 reused row from the current matrix containing text, if any.
17202 The value of last_text_row is the last displayed line
17203 containing text. */
17204 if (last_reused_text_row)
17205 adjust_window_ends (w, last_reused_text_row, 1);
17206 else if (last_text_row)
17207 adjust_window_ends (w, last_text_row, 0);
17208 else
17210 /* This window must be completely empty. */
17211 w->window_end_bytepos = Z_BYTE - ZV_BYTE;
17212 w->window_end_pos = Z - ZV;
17213 w->window_end_vpos = 0;
17215 w->window_end_valid = 0;
17217 /* Update hint: don't try scrolling again in update_window. */
17218 w->desired_matrix->no_scrolling_p = 1;
17220 #ifdef GLYPH_DEBUG
17221 debug_method_add (w, "try_window_reusing_current_matrix 1");
17222 #endif
17223 return 1;
17225 else if (CHARPOS (new_start) > CHARPOS (start))
17227 struct glyph_row *pt_row, *row;
17228 struct glyph_row *first_reusable_row;
17229 struct glyph_row *first_row_to_display;
17230 int dy;
17231 int yb = window_text_bottom_y (w);
17233 /* Find the row starting at new_start, if there is one. Don't
17234 reuse a partially visible line at the end. */
17235 first_reusable_row = start_row;
17236 while (first_reusable_row->enabled_p
17237 && MATRIX_ROW_BOTTOM_Y (first_reusable_row) < yb
17238 && (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17239 < CHARPOS (new_start)))
17240 ++first_reusable_row;
17242 /* Give up if there is no row to reuse. */
17243 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row) >= yb
17244 || !first_reusable_row->enabled_p
17245 || (MATRIX_ROW_START_CHARPOS (first_reusable_row)
17246 != CHARPOS (new_start)))
17247 return 0;
17249 /* We can reuse fully visible rows beginning with
17250 first_reusable_row to the end of the window. Set
17251 first_row_to_display to the first row that cannot be reused.
17252 Set pt_row to the row containing point, if there is any. */
17253 pt_row = NULL;
17254 for (first_row_to_display = first_reusable_row;
17255 MATRIX_ROW_BOTTOM_Y (first_row_to_display) < yb;
17256 ++first_row_to_display)
17258 if (PT >= MATRIX_ROW_START_CHARPOS (first_row_to_display)
17259 && (PT < MATRIX_ROW_END_CHARPOS (first_row_to_display)
17260 || (PT == MATRIX_ROW_END_CHARPOS (first_row_to_display)
17261 && first_row_to_display->ends_at_zv_p
17262 && pt_row == NULL)))
17263 pt_row = first_row_to_display;
17266 /* Start displaying at the start of first_row_to_display. */
17267 eassert (first_row_to_display->y < yb);
17268 init_to_row_start (&it, w, first_row_to_display);
17270 nrows_scrolled = (MATRIX_ROW_VPOS (first_reusable_row, w->current_matrix)
17271 - start_vpos);
17272 it.vpos = (MATRIX_ROW_VPOS (first_row_to_display, w->current_matrix)
17273 - nrows_scrolled);
17274 it.current_y = (first_row_to_display->y - first_reusable_row->y
17275 + WINDOW_HEADER_LINE_HEIGHT (w));
17277 /* Display lines beginning with first_row_to_display in the
17278 desired matrix. Set last_text_row to the last row displayed
17279 that displays text. */
17280 it.glyph_row = MATRIX_ROW (w->desired_matrix, it.vpos);
17281 if (pt_row == NULL)
17282 w->cursor.vpos = -1;
17283 last_text_row = NULL;
17284 while (it.current_y < it.last_visible_y && !f->fonts_changed)
17285 if (display_line (&it))
17286 last_text_row = it.glyph_row - 1;
17288 /* If point is in a reused row, adjust y and vpos of the cursor
17289 position. */
17290 if (pt_row)
17292 w->cursor.vpos -= nrows_scrolled;
17293 w->cursor.y -= first_reusable_row->y - start_row->y;
17296 /* Give up if point isn't in a row displayed or reused. (This
17297 also handles the case where w->cursor.vpos < nrows_scrolled
17298 after the calls to display_line, which can happen with scroll
17299 margins. See bug#1295.) */
17300 if (w->cursor.vpos < 0)
17302 clear_glyph_matrix (w->desired_matrix);
17303 return 0;
17306 /* Scroll the display. */
17307 run.current_y = first_reusable_row->y;
17308 run.desired_y = WINDOW_HEADER_LINE_HEIGHT (w);
17309 run.height = it.last_visible_y - run.current_y;
17310 dy = run.current_y - run.desired_y;
17312 if (run.height)
17314 update_begin (f);
17315 FRAME_RIF (f)->update_window_begin_hook (w);
17316 FRAME_RIF (f)->clear_window_mouse_face (w);
17317 FRAME_RIF (f)->scroll_run_hook (w, &run);
17318 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
17319 update_end (f);
17322 /* Adjust Y positions of reused rows. */
17323 bottom_row = MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w);
17324 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
17325 max_y = it.last_visible_y;
17326 for (row = first_reusable_row; row < first_row_to_display; ++row)
17328 row->y -= dy;
17329 row->visible_height = row->height;
17330 if (row->y < min_y)
17331 row->visible_height -= min_y - row->y;
17332 if (row->y + row->height > max_y)
17333 row->visible_height -= row->y + row->height - max_y;
17334 if (row->fringe_bitmap_periodic_p)
17335 row->redraw_fringe_bitmaps_p = 1;
17338 /* Scroll the current matrix. */
17339 eassert (nrows_scrolled > 0);
17340 rotate_matrix (w->current_matrix,
17341 start_vpos,
17342 MATRIX_ROW_VPOS (bottom_row, w->current_matrix),
17343 -nrows_scrolled);
17345 /* Disable rows not reused. */
17346 for (row -= nrows_scrolled; row < bottom_row; ++row)
17347 row->enabled_p = false;
17349 /* Point may have moved to a different line, so we cannot assume that
17350 the previous cursor position is valid; locate the correct row. */
17351 if (pt_row)
17353 for (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos);
17354 row < bottom_row
17355 && PT >= MATRIX_ROW_END_CHARPOS (row)
17356 && !row->ends_at_zv_p;
17357 row++)
17359 w->cursor.vpos++;
17360 w->cursor.y = row->y;
17362 if (row < bottom_row)
17364 /* Can't simply scan the row for point with
17365 bidi-reordered glyph rows. Let set_cursor_from_row
17366 figure out where to put the cursor, and if it fails,
17367 give up. */
17368 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering)))
17370 if (!set_cursor_from_row (w, row, w->current_matrix,
17371 0, 0, 0, 0))
17373 clear_glyph_matrix (w->desired_matrix);
17374 return 0;
17377 else
17379 struct glyph *glyph = row->glyphs[TEXT_AREA] + w->cursor.hpos;
17380 struct glyph *end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17382 for (; glyph < end
17383 && (!BUFFERP (glyph->object)
17384 || glyph->charpos < PT);
17385 glyph++)
17387 w->cursor.hpos++;
17388 w->cursor.x += glyph->pixel_width;
17394 /* Adjust window end. A null value of last_text_row means that
17395 the window end is in reused rows which in turn means that
17396 only its vpos can have changed. */
17397 if (last_text_row)
17398 adjust_window_ends (w, last_text_row, 0);
17399 else
17400 w->window_end_vpos -= nrows_scrolled;
17402 w->window_end_valid = 0;
17403 w->desired_matrix->no_scrolling_p = 1;
17405 #ifdef GLYPH_DEBUG
17406 debug_method_add (w, "try_window_reusing_current_matrix 2");
17407 #endif
17408 return 1;
17411 return 0;
17416 /************************************************************************
17417 Window redisplay reusing current matrix when buffer has changed
17418 ************************************************************************/
17420 static struct glyph_row *find_last_unchanged_at_beg_row (struct window *);
17421 static struct glyph_row *find_first_unchanged_at_end_row (struct window *,
17422 ptrdiff_t *, ptrdiff_t *);
17423 static struct glyph_row *
17424 find_last_row_displaying_text (struct glyph_matrix *, struct it *,
17425 struct glyph_row *);
17428 /* Return the last row in MATRIX displaying text. If row START is
17429 non-null, start searching with that row. IT gives the dimensions
17430 of the display. Value is null if matrix is empty; otherwise it is
17431 a pointer to the row found. */
17433 static struct glyph_row *
17434 find_last_row_displaying_text (struct glyph_matrix *matrix, struct it *it,
17435 struct glyph_row *start)
17437 struct glyph_row *row, *row_found;
17439 /* Set row_found to the last row in IT->w's current matrix
17440 displaying text. The loop looks funny but think of partially
17441 visible lines. */
17442 row_found = NULL;
17443 row = start ? start : MATRIX_FIRST_TEXT_ROW (matrix);
17444 while (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17446 eassert (row->enabled_p);
17447 row_found = row;
17448 if (MATRIX_ROW_BOTTOM_Y (row) >= it->last_visible_y)
17449 break;
17450 ++row;
17453 return row_found;
17457 /* Return the last row in the current matrix of W that is not affected
17458 by changes at the start of current_buffer that occurred since W's
17459 current matrix was built. Value is null if no such row exists.
17461 BEG_UNCHANGED us the number of characters unchanged at the start of
17462 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17463 first changed character in current_buffer. Characters at positions <
17464 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17465 when the current matrix was built. */
17467 static struct glyph_row *
17468 find_last_unchanged_at_beg_row (struct window *w)
17470 ptrdiff_t first_changed_pos = BEG + BEG_UNCHANGED;
17471 struct glyph_row *row;
17472 struct glyph_row *row_found = NULL;
17473 int yb = window_text_bottom_y (w);
17475 /* Find the last row displaying unchanged text. */
17476 for (row = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17477 MATRIX_ROW_DISPLAYS_TEXT_P (row)
17478 && MATRIX_ROW_START_CHARPOS (row) < first_changed_pos;
17479 ++row)
17481 if (/* If row ends before first_changed_pos, it is unchanged,
17482 except in some case. */
17483 MATRIX_ROW_END_CHARPOS (row) <= first_changed_pos
17484 /* When row ends in ZV and we write at ZV it is not
17485 unchanged. */
17486 && !row->ends_at_zv_p
17487 /* When first_changed_pos is the end of a continued line,
17488 row is not unchanged because it may be no longer
17489 continued. */
17490 && !(MATRIX_ROW_END_CHARPOS (row) == first_changed_pos
17491 && (row->continued_p
17492 || row->exact_window_width_line_p))
17493 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17494 needs to be recomputed, so don't consider this row as
17495 unchanged. This happens when the last line was
17496 bidi-reordered and was killed immediately before this
17497 redisplay cycle. In that case, ROW->end stores the
17498 buffer position of the first visual-order character of
17499 the killed text, which is now beyond ZV. */
17500 && CHARPOS (row->end.pos) <= ZV)
17501 row_found = row;
17503 /* Stop if last visible row. */
17504 if (MATRIX_ROW_BOTTOM_Y (row) >= yb)
17505 break;
17508 return row_found;
17512 /* Find the first glyph row in the current matrix of W that is not
17513 affected by changes at the end of current_buffer since the
17514 time W's current matrix was built.
17516 Return in *DELTA the number of chars by which buffer positions in
17517 unchanged text at the end of current_buffer must be adjusted.
17519 Return in *DELTA_BYTES the corresponding number of bytes.
17521 Value is null if no such row exists, i.e. all rows are affected by
17522 changes. */
17524 static struct glyph_row *
17525 find_first_unchanged_at_end_row (struct window *w,
17526 ptrdiff_t *delta, ptrdiff_t *delta_bytes)
17528 struct glyph_row *row;
17529 struct glyph_row *row_found = NULL;
17531 *delta = *delta_bytes = 0;
17533 /* Display must not have been paused, otherwise the current matrix
17534 is not up to date. */
17535 eassert (w->window_end_valid);
17537 /* A value of window_end_pos >= END_UNCHANGED means that the window
17538 end is in the range of changed text. If so, there is no
17539 unchanged row at the end of W's current matrix. */
17540 if (w->window_end_pos >= END_UNCHANGED)
17541 return NULL;
17543 /* Set row to the last row in W's current matrix displaying text. */
17544 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17546 /* If matrix is entirely empty, no unchanged row exists. */
17547 if (MATRIX_ROW_DISPLAYS_TEXT_P (row))
17549 /* The value of row is the last glyph row in the matrix having a
17550 meaningful buffer position in it. The end position of row
17551 corresponds to window_end_pos. This allows us to translate
17552 buffer positions in the current matrix to current buffer
17553 positions for characters not in changed text. */
17554 ptrdiff_t Z_old =
17555 MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17556 ptrdiff_t Z_BYTE_old =
17557 MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17558 ptrdiff_t last_unchanged_pos, last_unchanged_pos_old;
17559 struct glyph_row *first_text_row
17560 = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
17562 *delta = Z - Z_old;
17563 *delta_bytes = Z_BYTE - Z_BYTE_old;
17565 /* Set last_unchanged_pos to the buffer position of the last
17566 character in the buffer that has not been changed. Z is the
17567 index + 1 of the last character in current_buffer, i.e. by
17568 subtracting END_UNCHANGED we get the index of the last
17569 unchanged character, and we have to add BEG to get its buffer
17570 position. */
17571 last_unchanged_pos = Z - END_UNCHANGED + BEG;
17572 last_unchanged_pos_old = last_unchanged_pos - *delta;
17574 /* Search backward from ROW for a row displaying a line that
17575 starts at a minimum position >= last_unchanged_pos_old. */
17576 for (; row > first_text_row; --row)
17578 /* This used to abort, but it can happen.
17579 It is ok to just stop the search instead here. KFS. */
17580 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
17581 break;
17583 if (MATRIX_ROW_START_CHARPOS (row) >= last_unchanged_pos_old)
17584 row_found = row;
17588 eassert (!row_found || MATRIX_ROW_DISPLAYS_TEXT_P (row_found));
17590 return row_found;
17594 /* Make sure that glyph rows in the current matrix of window W
17595 reference the same glyph memory as corresponding rows in the
17596 frame's frame matrix. This function is called after scrolling W's
17597 current matrix on a terminal frame in try_window_id and
17598 try_window_reusing_current_matrix. */
17600 static void
17601 sync_frame_with_window_matrix_rows (struct window *w)
17603 struct frame *f = XFRAME (w->frame);
17604 struct glyph_row *window_row, *window_row_end, *frame_row;
17606 /* Preconditions: W must be a leaf window and full-width. Its frame
17607 must have a frame matrix. */
17608 eassert (BUFFERP (w->contents));
17609 eassert (WINDOW_FULL_WIDTH_P (w));
17610 eassert (!FRAME_WINDOW_P (f));
17612 /* If W is a full-width window, glyph pointers in W's current matrix
17613 have, by definition, to be the same as glyph pointers in the
17614 corresponding frame matrix. Note that frame matrices have no
17615 marginal areas (see build_frame_matrix). */
17616 window_row = w->current_matrix->rows;
17617 window_row_end = window_row + w->current_matrix->nrows;
17618 frame_row = f->current_matrix->rows + WINDOW_TOP_EDGE_LINE (w);
17619 while (window_row < window_row_end)
17621 struct glyph *start = window_row->glyphs[LEFT_MARGIN_AREA];
17622 struct glyph *end = window_row->glyphs[LAST_AREA];
17624 frame_row->glyphs[LEFT_MARGIN_AREA] = start;
17625 frame_row->glyphs[TEXT_AREA] = start;
17626 frame_row->glyphs[RIGHT_MARGIN_AREA] = end;
17627 frame_row->glyphs[LAST_AREA] = end;
17629 /* Disable frame rows whose corresponding window rows have
17630 been disabled in try_window_id. */
17631 if (!window_row->enabled_p)
17632 frame_row->enabled_p = false;
17634 ++window_row, ++frame_row;
17639 /* Find the glyph row in window W containing CHARPOS. Consider all
17640 rows between START and END (not inclusive). END null means search
17641 all rows to the end of the display area of W. Value is the row
17642 containing CHARPOS or null. */
17644 struct glyph_row *
17645 row_containing_pos (struct window *w, ptrdiff_t charpos,
17646 struct glyph_row *start, struct glyph_row *end, int dy)
17648 struct glyph_row *row = start;
17649 struct glyph_row *best_row = NULL;
17650 ptrdiff_t mindif = BUF_ZV (XBUFFER (w->contents)) + 1;
17651 int last_y;
17653 /* If we happen to start on a header-line, skip that. */
17654 if (row->mode_line_p)
17655 ++row;
17657 if ((end && row >= end) || !row->enabled_p)
17658 return NULL;
17660 last_y = window_text_bottom_y (w) - dy;
17662 while (1)
17664 /* Give up if we have gone too far. */
17665 if (end && row >= end)
17666 return NULL;
17667 /* This formerly returned if they were equal.
17668 I think that both quantities are of a "last plus one" type;
17669 if so, when they are equal, the row is within the screen. -- rms. */
17670 if (MATRIX_ROW_BOTTOM_Y (row) > last_y)
17671 return NULL;
17673 /* If it is in this row, return this row. */
17674 if (! (MATRIX_ROW_END_CHARPOS (row) < charpos
17675 || (MATRIX_ROW_END_CHARPOS (row) == charpos
17676 /* The end position of a row equals the start
17677 position of the next row. If CHARPOS is there, we
17678 would rather consider it displayed in the next
17679 line, except when this line ends in ZV. */
17680 && !row_for_charpos_p (row, charpos)))
17681 && charpos >= MATRIX_ROW_START_CHARPOS (row))
17683 struct glyph *g;
17685 if (NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17686 || (!best_row && !row->continued_p))
17687 return row;
17688 /* In bidi-reordered rows, there could be several rows whose
17689 edges surround CHARPOS, all of these rows belonging to
17690 the same continued line. We need to find the row which
17691 fits CHARPOS the best. */
17692 for (g = row->glyphs[TEXT_AREA];
17693 g < row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
17694 g++)
17696 if (!STRINGP (g->object))
17698 if (g->charpos > 0 && eabs (g->charpos - charpos) < mindif)
17700 mindif = eabs (g->charpos - charpos);
17701 best_row = row;
17702 /* Exact match always wins. */
17703 if (mindif == 0)
17704 return best_row;
17709 else if (best_row && !row->continued_p)
17710 return best_row;
17711 ++row;
17716 /* Try to redisplay window W by reusing its existing display. W's
17717 current matrix must be up to date when this function is called,
17718 i.e. window_end_valid must be nonzero.
17720 Value is
17722 >= 1 if successful, i.e. display has been updated
17723 specifically:
17724 1 means the changes were in front of a newline that precedes
17725 the window start, and the whole current matrix was reused
17726 2 means the changes were after the last position displayed
17727 in the window, and the whole current matrix was reused
17728 3 means portions of the current matrix were reused, while
17729 some of the screen lines were redrawn
17730 -1 if redisplay with same window start is known not to succeed
17731 0 if otherwise unsuccessful
17733 The following steps are performed:
17735 1. Find the last row in the current matrix of W that is not
17736 affected by changes at the start of current_buffer. If no such row
17737 is found, give up.
17739 2. Find the first row in W's current matrix that is not affected by
17740 changes at the end of current_buffer. Maybe there is no such row.
17742 3. Display lines beginning with the row + 1 found in step 1 to the
17743 row found in step 2 or, if step 2 didn't find a row, to the end of
17744 the window.
17746 4. If cursor is not known to appear on the window, give up.
17748 5. If display stopped at the row found in step 2, scroll the
17749 display and current matrix as needed.
17751 6. Maybe display some lines at the end of W, if we must. This can
17752 happen under various circumstances, like a partially visible line
17753 becoming fully visible, or because newly displayed lines are displayed
17754 in smaller font sizes.
17756 7. Update W's window end information. */
17758 static int
17759 try_window_id (struct window *w)
17761 struct frame *f = XFRAME (w->frame);
17762 struct glyph_matrix *current_matrix = w->current_matrix;
17763 struct glyph_matrix *desired_matrix = w->desired_matrix;
17764 struct glyph_row *last_unchanged_at_beg_row;
17765 struct glyph_row *first_unchanged_at_end_row;
17766 struct glyph_row *row;
17767 struct glyph_row *bottom_row;
17768 int bottom_vpos;
17769 struct it it;
17770 ptrdiff_t delta = 0, delta_bytes = 0, stop_pos;
17771 int dvpos, dy;
17772 struct text_pos start_pos;
17773 struct run run;
17774 int first_unchanged_at_end_vpos = 0;
17775 struct glyph_row *last_text_row, *last_text_row_at_end;
17776 struct text_pos start;
17777 ptrdiff_t first_changed_charpos, last_changed_charpos;
17779 #ifdef GLYPH_DEBUG
17780 if (inhibit_try_window_id)
17781 return 0;
17782 #endif
17784 /* This is handy for debugging. */
17785 #if 0
17786 #define GIVE_UP(X) \
17787 do { \
17788 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17789 return 0; \
17790 } while (0)
17791 #else
17792 #define GIVE_UP(X) return 0
17793 #endif
17795 SET_TEXT_POS_FROM_MARKER (start, w->start);
17797 /* Don't use this for mini-windows because these can show
17798 messages and mini-buffers, and we don't handle that here. */
17799 if (MINI_WINDOW_P (w))
17800 GIVE_UP (1);
17802 /* This flag is used to prevent redisplay optimizations. */
17803 if (windows_or_buffers_changed || f->cursor_type_changed)
17804 GIVE_UP (2);
17806 /* This function's optimizations cannot be used if overlays have
17807 changed in the buffer displayed by the window, so give up if they
17808 have. */
17809 if (w->last_overlay_modified != OVERLAY_MODIFF)
17810 GIVE_UP (21);
17812 /* Verify that narrowing has not changed.
17813 Also verify that we were not told to prevent redisplay optimizations.
17814 It would be nice to further
17815 reduce the number of cases where this prevents try_window_id. */
17816 if (current_buffer->clip_changed
17817 || current_buffer->prevent_redisplay_optimizations_p)
17818 GIVE_UP (3);
17820 /* Window must either use window-based redisplay or be full width. */
17821 if (!FRAME_WINDOW_P (f)
17822 && (!FRAME_LINE_INS_DEL_OK (f)
17823 || !WINDOW_FULL_WIDTH_P (w)))
17824 GIVE_UP (4);
17826 /* Give up if point is known NOT to appear in W. */
17827 if (PT < CHARPOS (start))
17828 GIVE_UP (5);
17830 /* Another way to prevent redisplay optimizations. */
17831 if (w->last_modified == 0)
17832 GIVE_UP (6);
17834 /* Verify that window is not hscrolled. */
17835 if (w->hscroll != 0)
17836 GIVE_UP (7);
17838 /* Verify that display wasn't paused. */
17839 if (!w->window_end_valid)
17840 GIVE_UP (8);
17842 /* Likewise if highlighting trailing whitespace. */
17843 if (!NILP (Vshow_trailing_whitespace))
17844 GIVE_UP (11);
17846 /* Can't use this if overlay arrow position and/or string have
17847 changed. */
17848 if (overlay_arrows_changed_p ())
17849 GIVE_UP (12);
17851 /* When word-wrap is on, adding a space to the first word of a
17852 wrapped line can change the wrap position, altering the line
17853 above it. It might be worthwhile to handle this more
17854 intelligently, but for now just redisplay from scratch. */
17855 if (!NILP (BVAR (XBUFFER (w->contents), word_wrap)))
17856 GIVE_UP (21);
17858 /* Under bidi reordering, adding or deleting a character in the
17859 beginning of a paragraph, before the first strong directional
17860 character, can change the base direction of the paragraph (unless
17861 the buffer specifies a fixed paragraph direction), which will
17862 require to redisplay the whole paragraph. It might be worthwhile
17863 to find the paragraph limits and widen the range of redisplayed
17864 lines to that, but for now just give up this optimization and
17865 redisplay from scratch. */
17866 if (!NILP (BVAR (XBUFFER (w->contents), bidi_display_reordering))
17867 && NILP (BVAR (XBUFFER (w->contents), bidi_paragraph_direction)))
17868 GIVE_UP (22);
17870 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17871 only if buffer has really changed. The reason is that the gap is
17872 initially at Z for freshly visited files. The code below would
17873 set end_unchanged to 0 in that case. */
17874 if (MODIFF > SAVE_MODIFF
17875 /* This seems to happen sometimes after saving a buffer. */
17876 || BEG_UNCHANGED + END_UNCHANGED > Z_BYTE)
17878 if (GPT - BEG < BEG_UNCHANGED)
17879 BEG_UNCHANGED = GPT - BEG;
17880 if (Z - GPT < END_UNCHANGED)
17881 END_UNCHANGED = Z - GPT;
17884 /* The position of the first and last character that has been changed. */
17885 first_changed_charpos = BEG + BEG_UNCHANGED;
17886 last_changed_charpos = Z - END_UNCHANGED;
17888 /* If window starts after a line end, and the last change is in
17889 front of that newline, then changes don't affect the display.
17890 This case happens with stealth-fontification. Note that although
17891 the display is unchanged, glyph positions in the matrix have to
17892 be adjusted, of course. */
17893 row = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
17894 if (MATRIX_ROW_DISPLAYS_TEXT_P (row)
17895 && ((last_changed_charpos < CHARPOS (start)
17896 && CHARPOS (start) == BEGV)
17897 || (last_changed_charpos < CHARPOS (start) - 1
17898 && FETCH_BYTE (BYTEPOS (start) - 1) == '\n')))
17900 ptrdiff_t Z_old, Z_delta, Z_BYTE_old, Z_delta_bytes;
17901 struct glyph_row *r0;
17903 /* Compute how many chars/bytes have been added to or removed
17904 from the buffer. */
17905 Z_old = MATRIX_ROW_END_CHARPOS (row) + w->window_end_pos;
17906 Z_BYTE_old = MATRIX_ROW_END_BYTEPOS (row) + w->window_end_bytepos;
17907 Z_delta = Z - Z_old;
17908 Z_delta_bytes = Z_BYTE - Z_BYTE_old;
17910 /* Give up if PT is not in the window. Note that it already has
17911 been checked at the start of try_window_id that PT is not in
17912 front of the window start. */
17913 if (PT >= MATRIX_ROW_END_CHARPOS (row) + Z_delta)
17914 GIVE_UP (13);
17916 /* If window start is unchanged, we can reuse the whole matrix
17917 as is, after adjusting glyph positions. No need to compute
17918 the window end again, since its offset from Z hasn't changed. */
17919 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17920 if (CHARPOS (start) == MATRIX_ROW_START_CHARPOS (r0) + Z_delta
17921 && BYTEPOS (start) == MATRIX_ROW_START_BYTEPOS (r0) + Z_delta_bytes
17922 /* PT must not be in a partially visible line. */
17923 && !(PT >= MATRIX_ROW_START_CHARPOS (row) + Z_delta
17924 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17926 /* Adjust positions in the glyph matrix. */
17927 if (Z_delta || Z_delta_bytes)
17929 struct glyph_row *r1
17930 = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
17931 increment_matrix_positions (w->current_matrix,
17932 MATRIX_ROW_VPOS (r0, current_matrix),
17933 MATRIX_ROW_VPOS (r1, current_matrix),
17934 Z_delta, Z_delta_bytes);
17937 /* Set the cursor. */
17938 row = row_containing_pos (w, PT, r0, NULL, 0);
17939 if (row)
17940 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17941 return 1;
17945 /* Handle the case that changes are all below what is displayed in
17946 the window, and that PT is in the window. This shortcut cannot
17947 be taken if ZV is visible in the window, and text has been added
17948 there that is visible in the window. */
17949 if (first_changed_charpos >= MATRIX_ROW_END_CHARPOS (row)
17950 /* ZV is not visible in the window, or there are no
17951 changes at ZV, actually. */
17952 && (current_matrix->zv > MATRIX_ROW_END_CHARPOS (row)
17953 || first_changed_charpos == last_changed_charpos))
17955 struct glyph_row *r0;
17957 /* Give up if PT is not in the window. Note that it already has
17958 been checked at the start of try_window_id that PT is not in
17959 front of the window start. */
17960 if (PT >= MATRIX_ROW_END_CHARPOS (row))
17961 GIVE_UP (14);
17963 /* If window start is unchanged, we can reuse the whole matrix
17964 as is, without changing glyph positions since no text has
17965 been added/removed in front of the window end. */
17966 r0 = MATRIX_FIRST_TEXT_ROW (current_matrix);
17967 if (TEXT_POS_EQUAL_P (start, r0->minpos)
17968 /* PT must not be in a partially visible line. */
17969 && !(PT >= MATRIX_ROW_START_CHARPOS (row)
17970 && MATRIX_ROW_BOTTOM_Y (row) > window_text_bottom_y (w)))
17972 /* We have to compute the window end anew since text
17973 could have been added/removed after it. */
17974 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
17975 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
17977 /* Set the cursor. */
17978 row = row_containing_pos (w, PT, r0, NULL, 0);
17979 if (row)
17980 set_cursor_from_row (w, row, current_matrix, 0, 0, 0, 0);
17981 return 2;
17985 /* Give up if window start is in the changed area.
17987 The condition used to read
17989 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17991 but why that was tested escapes me at the moment. */
17992 if (CHARPOS (start) >= first_changed_charpos
17993 && CHARPOS (start) <= last_changed_charpos)
17994 GIVE_UP (15);
17996 /* Check that window start agrees with the start of the first glyph
17997 row in its current matrix. Check this after we know the window
17998 start is not in changed text, otherwise positions would not be
17999 comparable. */
18000 row = MATRIX_FIRST_TEXT_ROW (current_matrix);
18001 if (!TEXT_POS_EQUAL_P (start, row->minpos))
18002 GIVE_UP (16);
18004 /* Give up if the window ends in strings. Overlay strings
18005 at the end are difficult to handle, so don't try. */
18006 row = MATRIX_ROW (current_matrix, w->window_end_vpos);
18007 if (MATRIX_ROW_START_CHARPOS (row) == MATRIX_ROW_END_CHARPOS (row))
18008 GIVE_UP (20);
18010 /* Compute the position at which we have to start displaying new
18011 lines. Some of the lines at the top of the window might be
18012 reusable because they are not displaying changed text. Find the
18013 last row in W's current matrix not affected by changes at the
18014 start of current_buffer. Value is null if changes start in the
18015 first line of window. */
18016 last_unchanged_at_beg_row = find_last_unchanged_at_beg_row (w);
18017 if (last_unchanged_at_beg_row)
18019 /* Avoid starting to display in the middle of a character, a TAB
18020 for instance. This is easier than to set up the iterator
18021 exactly, and it's not a frequent case, so the additional
18022 effort wouldn't really pay off. */
18023 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row)
18024 || last_unchanged_at_beg_row->ends_in_newline_from_string_p)
18025 && last_unchanged_at_beg_row > w->current_matrix->rows)
18026 --last_unchanged_at_beg_row;
18028 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row))
18029 GIVE_UP (17);
18031 if (init_to_row_end (&it, w, last_unchanged_at_beg_row) == 0)
18032 GIVE_UP (18);
18033 start_pos = it.current.pos;
18035 /* Start displaying new lines in the desired matrix at the same
18036 vpos we would use in the current matrix, i.e. below
18037 last_unchanged_at_beg_row. */
18038 it.vpos = 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row,
18039 current_matrix);
18040 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18041 it.current_y = MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row);
18043 eassert (it.hpos == 0 && it.current_x == 0);
18045 else
18047 /* There are no reusable lines at the start of the window.
18048 Start displaying in the first text line. */
18049 start_display (&it, w, start);
18050 it.vpos = it.first_vpos;
18051 start_pos = it.current.pos;
18054 /* Find the first row that is not affected by changes at the end of
18055 the buffer. Value will be null if there is no unchanged row, in
18056 which case we must redisplay to the end of the window. delta
18057 will be set to the value by which buffer positions beginning with
18058 first_unchanged_at_end_row have to be adjusted due to text
18059 changes. */
18060 first_unchanged_at_end_row
18061 = find_first_unchanged_at_end_row (w, &delta, &delta_bytes);
18062 IF_DEBUG (debug_delta = delta);
18063 IF_DEBUG (debug_delta_bytes = delta_bytes);
18065 /* Set stop_pos to the buffer position up to which we will have to
18066 display new lines. If first_unchanged_at_end_row != NULL, this
18067 is the buffer position of the start of the line displayed in that
18068 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18069 that we don't stop at a buffer position. */
18070 stop_pos = 0;
18071 if (first_unchanged_at_end_row)
18073 eassert (last_unchanged_at_beg_row == NULL
18074 || first_unchanged_at_end_row >= last_unchanged_at_beg_row);
18076 /* If this is a continuation line, move forward to the next one
18077 that isn't. Changes in lines above affect this line.
18078 Caution: this may move first_unchanged_at_end_row to a row
18079 not displaying text. */
18080 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row)
18081 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18082 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18083 < it.last_visible_y))
18084 ++first_unchanged_at_end_row;
18086 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row)
18087 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row)
18088 >= it.last_visible_y))
18089 first_unchanged_at_end_row = NULL;
18090 else
18092 stop_pos = (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row)
18093 + delta);
18094 first_unchanged_at_end_vpos
18095 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, current_matrix);
18096 eassert (stop_pos >= Z - END_UNCHANGED);
18099 else if (last_unchanged_at_beg_row == NULL)
18100 GIVE_UP (19);
18103 #ifdef GLYPH_DEBUG
18105 /* Either there is no unchanged row at the end, or the one we have
18106 now displays text. This is a necessary condition for the window
18107 end pos calculation at the end of this function. */
18108 eassert (first_unchanged_at_end_row == NULL
18109 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18111 debug_last_unchanged_at_beg_vpos
18112 = (last_unchanged_at_beg_row
18113 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row, current_matrix)
18114 : -1);
18115 debug_first_unchanged_at_end_vpos = first_unchanged_at_end_vpos;
18117 #endif /* GLYPH_DEBUG */
18120 /* Display new lines. Set last_text_row to the last new line
18121 displayed which has text on it, i.e. might end up as being the
18122 line where the window_end_vpos is. */
18123 w->cursor.vpos = -1;
18124 last_text_row = NULL;
18125 overlay_arrow_seen = 0;
18126 while (it.current_y < it.last_visible_y
18127 && !f->fonts_changed
18128 && (first_unchanged_at_end_row == NULL
18129 || IT_CHARPOS (it) < stop_pos))
18131 if (display_line (&it))
18132 last_text_row = it.glyph_row - 1;
18135 if (f->fonts_changed)
18136 return -1;
18139 /* Compute differences in buffer positions, y-positions etc. for
18140 lines reused at the bottom of the window. Compute what we can
18141 scroll. */
18142 if (first_unchanged_at_end_row
18143 /* No lines reused because we displayed everything up to the
18144 bottom of the window. */
18145 && it.current_y < it.last_visible_y)
18147 dvpos = (it.vpos
18148 - MATRIX_ROW_VPOS (first_unchanged_at_end_row,
18149 current_matrix));
18150 dy = it.current_y - first_unchanged_at_end_row->y;
18151 run.current_y = first_unchanged_at_end_row->y;
18152 run.desired_y = run.current_y + dy;
18153 run.height = it.last_visible_y - max (run.current_y, run.desired_y);
18155 else
18157 delta = delta_bytes = dvpos = dy
18158 = run.current_y = run.desired_y = run.height = 0;
18159 first_unchanged_at_end_row = NULL;
18161 IF_DEBUG ((debug_dvpos = dvpos, debug_dy = dy));
18164 /* Find the cursor if not already found. We have to decide whether
18165 PT will appear on this window (it sometimes doesn't, but this is
18166 not a very frequent case.) This decision has to be made before
18167 the current matrix is altered. A value of cursor.vpos < 0 means
18168 that PT is either in one of the lines beginning at
18169 first_unchanged_at_end_row or below the window. Don't care for
18170 lines that might be displayed later at the window end; as
18171 mentioned, this is not a frequent case. */
18172 if (w->cursor.vpos < 0)
18174 /* Cursor in unchanged rows at the top? */
18175 if (PT < CHARPOS (start_pos)
18176 && last_unchanged_at_beg_row)
18178 row = row_containing_pos (w, PT,
18179 MATRIX_FIRST_TEXT_ROW (w->current_matrix),
18180 last_unchanged_at_beg_row + 1, 0);
18181 if (row)
18182 set_cursor_from_row (w, row, w->current_matrix, 0, 0, 0, 0);
18185 /* Start from first_unchanged_at_end_row looking for PT. */
18186 else if (first_unchanged_at_end_row)
18188 row = row_containing_pos (w, PT - delta,
18189 first_unchanged_at_end_row, NULL, 0);
18190 if (row)
18191 set_cursor_from_row (w, row, w->current_matrix, delta,
18192 delta_bytes, dy, dvpos);
18195 /* Give up if cursor was not found. */
18196 if (w->cursor.vpos < 0)
18198 clear_glyph_matrix (w->desired_matrix);
18199 return -1;
18203 /* Don't let the cursor end in the scroll margins. */
18205 int this_scroll_margin, cursor_height;
18206 int frame_line_height = default_line_pixel_height (w);
18207 int window_total_lines
18208 = WINDOW_TOTAL_LINES (w) * FRAME_LINE_HEIGHT (it.f) / frame_line_height;
18210 this_scroll_margin =
18211 max (0, min (scroll_margin, window_total_lines / 4));
18212 this_scroll_margin *= frame_line_height;
18213 cursor_height = MATRIX_ROW (w->desired_matrix, w->cursor.vpos)->height;
18215 if ((w->cursor.y < this_scroll_margin
18216 && CHARPOS (start) > BEGV)
18217 /* Old redisplay didn't take scroll margin into account at the bottom,
18218 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18219 || (w->cursor.y + (make_cursor_line_fully_visible_p
18220 ? cursor_height + this_scroll_margin
18221 : 1)) > it.last_visible_y)
18223 w->cursor.vpos = -1;
18224 clear_glyph_matrix (w->desired_matrix);
18225 return -1;
18229 /* Scroll the display. Do it before changing the current matrix so
18230 that xterm.c doesn't get confused about where the cursor glyph is
18231 found. */
18232 if (dy && run.height)
18234 update_begin (f);
18236 if (FRAME_WINDOW_P (f))
18238 FRAME_RIF (f)->update_window_begin_hook (w);
18239 FRAME_RIF (f)->clear_window_mouse_face (w);
18240 FRAME_RIF (f)->scroll_run_hook (w, &run);
18241 FRAME_RIF (f)->update_window_end_hook (w, 0, 0);
18243 else
18245 /* Terminal frame. In this case, dvpos gives the number of
18246 lines to scroll by; dvpos < 0 means scroll up. */
18247 int from_vpos
18248 = MATRIX_ROW_VPOS (first_unchanged_at_end_row, w->current_matrix);
18249 int from = WINDOW_TOP_EDGE_LINE (w) + from_vpos;
18250 int end = (WINDOW_TOP_EDGE_LINE (w)
18251 + (WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0)
18252 + window_internal_height (w));
18254 #if defined (HAVE_GPM) || defined (MSDOS)
18255 x_clear_window_mouse_face (w);
18256 #endif
18257 /* Perform the operation on the screen. */
18258 if (dvpos > 0)
18260 /* Scroll last_unchanged_at_beg_row to the end of the
18261 window down dvpos lines. */
18262 set_terminal_window (f, end);
18264 /* On dumb terminals delete dvpos lines at the end
18265 before inserting dvpos empty lines. */
18266 if (!FRAME_SCROLL_REGION_OK (f))
18267 ins_del_lines (f, end - dvpos, -dvpos);
18269 /* Insert dvpos empty lines in front of
18270 last_unchanged_at_beg_row. */
18271 ins_del_lines (f, from, dvpos);
18273 else if (dvpos < 0)
18275 /* Scroll up last_unchanged_at_beg_vpos to the end of
18276 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18277 set_terminal_window (f, end);
18279 /* Delete dvpos lines in front of
18280 last_unchanged_at_beg_vpos. ins_del_lines will set
18281 the cursor to the given vpos and emit |dvpos| delete
18282 line sequences. */
18283 ins_del_lines (f, from + dvpos, dvpos);
18285 /* On a dumb terminal insert dvpos empty lines at the
18286 end. */
18287 if (!FRAME_SCROLL_REGION_OK (f))
18288 ins_del_lines (f, end + dvpos, -dvpos);
18291 set_terminal_window (f, 0);
18294 update_end (f);
18297 /* Shift reused rows of the current matrix to the right position.
18298 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18299 text. */
18300 bottom_row = MATRIX_BOTTOM_TEXT_ROW (current_matrix, w);
18301 bottom_vpos = MATRIX_ROW_VPOS (bottom_row, current_matrix);
18302 if (dvpos < 0)
18304 rotate_matrix (current_matrix, first_unchanged_at_end_vpos + dvpos,
18305 bottom_vpos, dvpos);
18306 clear_glyph_matrix_rows (current_matrix, bottom_vpos + dvpos,
18307 bottom_vpos);
18309 else if (dvpos > 0)
18311 rotate_matrix (current_matrix, first_unchanged_at_end_vpos,
18312 bottom_vpos, dvpos);
18313 clear_glyph_matrix_rows (current_matrix, first_unchanged_at_end_vpos,
18314 first_unchanged_at_end_vpos + dvpos);
18317 /* For frame-based redisplay, make sure that current frame and window
18318 matrix are in sync with respect to glyph memory. */
18319 if (!FRAME_WINDOW_P (f))
18320 sync_frame_with_window_matrix_rows (w);
18322 /* Adjust buffer positions in reused rows. */
18323 if (delta || delta_bytes)
18324 increment_matrix_positions (current_matrix,
18325 first_unchanged_at_end_vpos + dvpos,
18326 bottom_vpos, delta, delta_bytes);
18328 /* Adjust Y positions. */
18329 if (dy)
18330 shift_glyph_matrix (w, current_matrix,
18331 first_unchanged_at_end_vpos + dvpos,
18332 bottom_vpos, dy);
18334 if (first_unchanged_at_end_row)
18336 first_unchanged_at_end_row += dvpos;
18337 if (first_unchanged_at_end_row->y >= it.last_visible_y
18338 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row))
18339 first_unchanged_at_end_row = NULL;
18342 /* If scrolling up, there may be some lines to display at the end of
18343 the window. */
18344 last_text_row_at_end = NULL;
18345 if (dy < 0)
18347 /* Scrolling up can leave for example a partially visible line
18348 at the end of the window to be redisplayed. */
18349 /* Set last_row to the glyph row in the current matrix where the
18350 window end line is found. It has been moved up or down in
18351 the matrix by dvpos. */
18352 int last_vpos = w->window_end_vpos + dvpos;
18353 struct glyph_row *last_row = MATRIX_ROW (current_matrix, last_vpos);
18355 /* If last_row is the window end line, it should display text. */
18356 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row));
18358 /* If window end line was partially visible before, begin
18359 displaying at that line. Otherwise begin displaying with the
18360 line following it. */
18361 if (MATRIX_ROW_BOTTOM_Y (last_row) - dy >= it.last_visible_y)
18363 init_to_row_start (&it, w, last_row);
18364 it.vpos = last_vpos;
18365 it.current_y = last_row->y;
18367 else
18369 init_to_row_end (&it, w, last_row);
18370 it.vpos = 1 + last_vpos;
18371 it.current_y = MATRIX_ROW_BOTTOM_Y (last_row);
18372 ++last_row;
18375 /* We may start in a continuation line. If so, we have to
18376 get the right continuation_lines_width and current_x. */
18377 it.continuation_lines_width = last_row->continuation_lines_width;
18378 it.hpos = it.current_x = 0;
18380 /* Display the rest of the lines at the window end. */
18381 it.glyph_row = MATRIX_ROW (desired_matrix, it.vpos);
18382 while (it.current_y < it.last_visible_y && !f->fonts_changed)
18384 /* Is it always sure that the display agrees with lines in
18385 the current matrix? I don't think so, so we mark rows
18386 displayed invalid in the current matrix by setting their
18387 enabled_p flag to zero. */
18388 SET_MATRIX_ROW_ENABLED_P (w->current_matrix, it.vpos, false);
18389 if (display_line (&it))
18390 last_text_row_at_end = it.glyph_row - 1;
18394 /* Update window_end_pos and window_end_vpos. */
18395 if (first_unchanged_at_end_row && !last_text_row_at_end)
18397 /* Window end line if one of the preserved rows from the current
18398 matrix. Set row to the last row displaying text in current
18399 matrix starting at first_unchanged_at_end_row, after
18400 scrolling. */
18401 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row));
18402 row = find_last_row_displaying_text (w->current_matrix, &it,
18403 first_unchanged_at_end_row);
18404 eassert (row && MATRIX_ROW_DISPLAYS_TEXT_P (row));
18405 adjust_window_ends (w, row, 1);
18406 eassert (w->window_end_bytepos >= 0);
18407 IF_DEBUG (debug_method_add (w, "A"));
18409 else if (last_text_row_at_end)
18411 adjust_window_ends (w, last_text_row_at_end, 0);
18412 eassert (w->window_end_bytepos >= 0);
18413 IF_DEBUG (debug_method_add (w, "B"));
18415 else if (last_text_row)
18417 /* We have displayed either to the end of the window or at the
18418 end of the window, i.e. the last row with text is to be found
18419 in the desired matrix. */
18420 adjust_window_ends (w, last_text_row, 0);
18421 eassert (w->window_end_bytepos >= 0);
18423 else if (first_unchanged_at_end_row == NULL
18424 && last_text_row == NULL
18425 && last_text_row_at_end == NULL)
18427 /* Displayed to end of window, but no line containing text was
18428 displayed. Lines were deleted at the end of the window. */
18429 int first_vpos = WINDOW_WANTS_HEADER_LINE_P (w) ? 1 : 0;
18430 int vpos = w->window_end_vpos;
18431 struct glyph_row *current_row = current_matrix->rows + vpos;
18432 struct glyph_row *desired_row = desired_matrix->rows + vpos;
18434 for (row = NULL;
18435 row == NULL && vpos >= first_vpos;
18436 --vpos, --current_row, --desired_row)
18438 if (desired_row->enabled_p)
18440 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row))
18441 row = desired_row;
18443 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row))
18444 row = current_row;
18447 eassert (row != NULL);
18448 w->window_end_vpos = vpos + 1;
18449 w->window_end_pos = Z - MATRIX_ROW_END_CHARPOS (row);
18450 w->window_end_bytepos = Z_BYTE - MATRIX_ROW_END_BYTEPOS (row);
18451 eassert (w->window_end_bytepos >= 0);
18452 IF_DEBUG (debug_method_add (w, "C"));
18454 else
18455 emacs_abort ();
18457 IF_DEBUG ((debug_end_pos = w->window_end_pos,
18458 debug_end_vpos = w->window_end_vpos));
18460 /* Record that display has not been completed. */
18461 w->window_end_valid = 0;
18462 w->desired_matrix->no_scrolling_p = 1;
18463 return 3;
18465 #undef GIVE_UP
18470 /***********************************************************************
18471 More debugging support
18472 ***********************************************************************/
18474 #ifdef GLYPH_DEBUG
18476 void dump_glyph_row (struct glyph_row *, int, int) EXTERNALLY_VISIBLE;
18477 void dump_glyph_matrix (struct glyph_matrix *, int) EXTERNALLY_VISIBLE;
18478 void dump_glyph (struct glyph_row *, struct glyph *, int) EXTERNALLY_VISIBLE;
18481 /* Dump the contents of glyph matrix MATRIX on stderr.
18483 GLYPHS 0 means don't show glyph contents.
18484 GLYPHS 1 means show glyphs in short form
18485 GLYPHS > 1 means show glyphs in long form. */
18487 void
18488 dump_glyph_matrix (struct glyph_matrix *matrix, int glyphs)
18490 int i;
18491 for (i = 0; i < matrix->nrows; ++i)
18492 dump_glyph_row (MATRIX_ROW (matrix, i), i, glyphs);
18496 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18497 the glyph row and area where the glyph comes from. */
18499 void
18500 dump_glyph (struct glyph_row *row, struct glyph *glyph, int area)
18502 if (glyph->type == CHAR_GLYPH
18503 || glyph->type == GLYPHLESS_GLYPH)
18505 fprintf (stderr,
18506 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18507 glyph - row->glyphs[TEXT_AREA],
18508 (glyph->type == CHAR_GLYPH
18509 ? 'C'
18510 : 'G'),
18511 glyph->charpos,
18512 (BUFFERP (glyph->object)
18513 ? 'B'
18514 : (STRINGP (glyph->object)
18515 ? 'S'
18516 : (INTEGERP (glyph->object)
18517 ? '0'
18518 : '-'))),
18519 glyph->pixel_width,
18520 glyph->u.ch,
18521 (glyph->u.ch < 0x80 && glyph->u.ch >= ' '
18522 ? glyph->u.ch
18523 : '.'),
18524 glyph->face_id,
18525 glyph->left_box_line_p,
18526 glyph->right_box_line_p);
18528 else if (glyph->type == STRETCH_GLYPH)
18530 fprintf (stderr,
18531 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18532 glyph - row->glyphs[TEXT_AREA],
18533 'S',
18534 glyph->charpos,
18535 (BUFFERP (glyph->object)
18536 ? 'B'
18537 : (STRINGP (glyph->object)
18538 ? 'S'
18539 : (INTEGERP (glyph->object)
18540 ? '0'
18541 : '-'))),
18542 glyph->pixel_width,
18544 ' ',
18545 glyph->face_id,
18546 glyph->left_box_line_p,
18547 glyph->right_box_line_p);
18549 else if (glyph->type == IMAGE_GLYPH)
18551 fprintf (stderr,
18552 " %5"pD"d %c %9"pI"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18553 glyph - row->glyphs[TEXT_AREA],
18554 'I',
18555 glyph->charpos,
18556 (BUFFERP (glyph->object)
18557 ? 'B'
18558 : (STRINGP (glyph->object)
18559 ? 'S'
18560 : (INTEGERP (glyph->object)
18561 ? '0'
18562 : '-'))),
18563 glyph->pixel_width,
18564 glyph->u.img_id,
18565 '.',
18566 glyph->face_id,
18567 glyph->left_box_line_p,
18568 glyph->right_box_line_p);
18570 else if (glyph->type == COMPOSITE_GLYPH)
18572 fprintf (stderr,
18573 " %5"pD"d %c %9"pI"d %c %3d 0x%06x",
18574 glyph - row->glyphs[TEXT_AREA],
18575 '+',
18576 glyph->charpos,
18577 (BUFFERP (glyph->object)
18578 ? 'B'
18579 : (STRINGP (glyph->object)
18580 ? 'S'
18581 : (INTEGERP (glyph->object)
18582 ? '0'
18583 : '-'))),
18584 glyph->pixel_width,
18585 glyph->u.cmp.id);
18586 if (glyph->u.cmp.automatic)
18587 fprintf (stderr,
18588 "[%d-%d]",
18589 glyph->slice.cmp.from, glyph->slice.cmp.to);
18590 fprintf (stderr, " . %4d %1.1d%1.1d\n",
18591 glyph->face_id,
18592 glyph->left_box_line_p,
18593 glyph->right_box_line_p);
18598 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18599 GLYPHS 0 means don't show glyph contents.
18600 GLYPHS 1 means show glyphs in short form
18601 GLYPHS > 1 means show glyphs in long form. */
18603 void
18604 dump_glyph_row (struct glyph_row *row, int vpos, int glyphs)
18606 if (glyphs != 1)
18608 fprintf (stderr, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18609 fprintf (stderr, "==============================================================================\n");
18611 fprintf (stderr, "%3d %9"pI"d %9"pI"d %4d %1.1d%1.1d%1.1d%1.1d\
18612 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18613 vpos,
18614 MATRIX_ROW_START_CHARPOS (row),
18615 MATRIX_ROW_END_CHARPOS (row),
18616 row->used[TEXT_AREA],
18617 row->contains_overlapping_glyphs_p,
18618 row->enabled_p,
18619 row->truncated_on_left_p,
18620 row->truncated_on_right_p,
18621 row->continued_p,
18622 MATRIX_ROW_CONTINUATION_LINE_P (row),
18623 MATRIX_ROW_DISPLAYS_TEXT_P (row),
18624 row->ends_at_zv_p,
18625 row->fill_line_p,
18626 row->ends_in_middle_of_char_p,
18627 row->starts_in_middle_of_char_p,
18628 row->mouse_face_p,
18629 row->x,
18630 row->y,
18631 row->pixel_width,
18632 row->height,
18633 row->visible_height,
18634 row->ascent,
18635 row->phys_ascent);
18636 /* The next 3 lines should align to "Start" in the header. */
18637 fprintf (stderr, " %9"pD"d %9"pD"d\t%5d\n", row->start.overlay_string_index,
18638 row->end.overlay_string_index,
18639 row->continuation_lines_width);
18640 fprintf (stderr, " %9"pI"d %9"pI"d\n",
18641 CHARPOS (row->start.string_pos),
18642 CHARPOS (row->end.string_pos));
18643 fprintf (stderr, " %9d %9d\n", row->start.dpvec_index,
18644 row->end.dpvec_index);
18647 if (glyphs > 1)
18649 int area;
18651 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18653 struct glyph *glyph = row->glyphs[area];
18654 struct glyph *glyph_end = glyph + row->used[area];
18656 /* Glyph for a line end in text. */
18657 if (area == TEXT_AREA && glyph == glyph_end && glyph->charpos > 0)
18658 ++glyph_end;
18660 if (glyph < glyph_end)
18661 fprintf (stderr, " Glyph# Type Pos O W Code C Face LR\n");
18663 for (; glyph < glyph_end; ++glyph)
18664 dump_glyph (row, glyph, area);
18667 else if (glyphs == 1)
18669 int area;
18671 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
18673 char *s = alloca (row->used[area] + 4);
18674 int i;
18676 for (i = 0; i < row->used[area]; ++i)
18678 struct glyph *glyph = row->glyphs[area] + i;
18679 if (i == row->used[area] - 1
18680 && area == TEXT_AREA
18681 && INTEGERP (glyph->object)
18682 && glyph->type == CHAR_GLYPH
18683 && glyph->u.ch == ' ')
18685 strcpy (&s[i], "[\\n]");
18686 i += 4;
18688 else if (glyph->type == CHAR_GLYPH
18689 && glyph->u.ch < 0x80
18690 && glyph->u.ch >= ' ')
18691 s[i] = glyph->u.ch;
18692 else
18693 s[i] = '.';
18696 s[i] = '\0';
18697 fprintf (stderr, "%3d: (%d) '%s'\n", vpos, row->enabled_p, s);
18703 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix,
18704 Sdump_glyph_matrix, 0, 1, "p",
18705 doc: /* Dump the current matrix of the selected window to stderr.
18706 Shows contents of glyph row structures. With non-nil
18707 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18708 glyphs in short form, otherwise show glyphs in long form. */)
18709 (Lisp_Object glyphs)
18711 struct window *w = XWINDOW (selected_window);
18712 struct buffer *buffer = XBUFFER (w->contents);
18714 fprintf (stderr, "PT = %"pI"d, BEGV = %"pI"d. ZV = %"pI"d\n",
18715 BUF_PT (buffer), BUF_BEGV (buffer), BUF_ZV (buffer));
18716 fprintf (stderr, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18717 w->cursor.x, w->cursor.y, w->cursor.hpos, w->cursor.vpos);
18718 fprintf (stderr, "=============================================\n");
18719 dump_glyph_matrix (w->current_matrix,
18720 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 0);
18721 return Qnil;
18725 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix,
18726 Sdump_frame_glyph_matrix, 0, 0, "", doc: /* */)
18727 (void)
18729 struct frame *f = XFRAME (selected_frame);
18730 dump_glyph_matrix (f->current_matrix, 1);
18731 return Qnil;
18735 DEFUN ("dump-glyph-row", Fdump_glyph_row, Sdump_glyph_row, 1, 2, "",
18736 doc: /* Dump glyph row ROW to stderr.
18737 GLYPH 0 means don't dump glyphs.
18738 GLYPH 1 means dump glyphs in short form.
18739 GLYPH > 1 or omitted means dump glyphs in long form. */)
18740 (Lisp_Object row, Lisp_Object glyphs)
18742 struct glyph_matrix *matrix;
18743 EMACS_INT vpos;
18745 CHECK_NUMBER (row);
18746 matrix = XWINDOW (selected_window)->current_matrix;
18747 vpos = XINT (row);
18748 if (vpos >= 0 && vpos < matrix->nrows)
18749 dump_glyph_row (MATRIX_ROW (matrix, vpos),
18750 vpos,
18751 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18752 return Qnil;
18756 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row, Sdump_tool_bar_row, 1, 2, "",
18757 doc: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18758 GLYPH 0 means don't dump glyphs.
18759 GLYPH 1 means dump glyphs in short form.
18760 GLYPH > 1 or omitted means dump glyphs in long form.
18762 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18763 do nothing. */)
18764 (Lisp_Object row, Lisp_Object glyphs)
18766 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18767 struct frame *sf = SELECTED_FRAME ();
18768 struct glyph_matrix *m = XWINDOW (sf->tool_bar_window)->current_matrix;
18769 EMACS_INT vpos;
18771 CHECK_NUMBER (row);
18772 vpos = XINT (row);
18773 if (vpos >= 0 && vpos < m->nrows)
18774 dump_glyph_row (MATRIX_ROW (m, vpos), vpos,
18775 TYPE_RANGED_INTEGERP (int, glyphs) ? XINT (glyphs) : 2);
18776 #endif
18777 return Qnil;
18781 DEFUN ("trace-redisplay", Ftrace_redisplay, Strace_redisplay, 0, 1, "P",
18782 doc: /* Toggle tracing of redisplay.
18783 With ARG, turn tracing on if and only if ARG is positive. */)
18784 (Lisp_Object arg)
18786 if (NILP (arg))
18787 trace_redisplay_p = !trace_redisplay_p;
18788 else
18790 arg = Fprefix_numeric_value (arg);
18791 trace_redisplay_p = XINT (arg) > 0;
18794 return Qnil;
18798 DEFUN ("trace-to-stderr", Ftrace_to_stderr, Strace_to_stderr, 1, MANY, "",
18799 doc: /* Like `format', but print result to stderr.
18800 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18801 (ptrdiff_t nargs, Lisp_Object *args)
18803 Lisp_Object s = Fformat (nargs, args);
18804 fprintf (stderr, "%s", SDATA (s));
18805 return Qnil;
18808 #endif /* GLYPH_DEBUG */
18812 /***********************************************************************
18813 Building Desired Matrix Rows
18814 ***********************************************************************/
18816 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18817 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18819 static struct glyph_row *
18820 get_overlay_arrow_glyph_row (struct window *w, Lisp_Object overlay_arrow_string)
18822 struct frame *f = XFRAME (WINDOW_FRAME (w));
18823 struct buffer *buffer = XBUFFER (w->contents);
18824 struct buffer *old = current_buffer;
18825 const unsigned char *arrow_string = SDATA (overlay_arrow_string);
18826 int arrow_len = SCHARS (overlay_arrow_string);
18827 const unsigned char *arrow_end = arrow_string + arrow_len;
18828 const unsigned char *p;
18829 struct it it;
18830 bool multibyte_p;
18831 int n_glyphs_before;
18833 set_buffer_temp (buffer);
18834 init_iterator (&it, w, -1, -1, &scratch_glyph_row, DEFAULT_FACE_ID);
18835 it.glyph_row->used[TEXT_AREA] = 0;
18836 SET_TEXT_POS (it.position, 0, 0);
18838 multibyte_p = !NILP (BVAR (buffer, enable_multibyte_characters));
18839 p = arrow_string;
18840 while (p < arrow_end)
18842 Lisp_Object face, ilisp;
18844 /* Get the next character. */
18845 if (multibyte_p)
18846 it.c = it.char_to_display = string_char_and_length (p, &it.len);
18847 else
18849 it.c = it.char_to_display = *p, it.len = 1;
18850 if (! ASCII_CHAR_P (it.c))
18851 it.char_to_display = BYTE8_TO_CHAR (it.c);
18853 p += it.len;
18855 /* Get its face. */
18856 ilisp = make_number (p - arrow_string);
18857 face = Fget_text_property (ilisp, Qface, overlay_arrow_string);
18858 it.face_id = compute_char_face (f, it.char_to_display, face);
18860 /* Compute its width, get its glyphs. */
18861 n_glyphs_before = it.glyph_row->used[TEXT_AREA];
18862 SET_TEXT_POS (it.position, -1, -1);
18863 PRODUCE_GLYPHS (&it);
18865 /* If this character doesn't fit any more in the line, we have
18866 to remove some glyphs. */
18867 if (it.current_x > it.last_visible_x)
18869 it.glyph_row->used[TEXT_AREA] = n_glyphs_before;
18870 break;
18874 set_buffer_temp (old);
18875 return it.glyph_row;
18879 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18880 glyphs to insert is determined by produce_special_glyphs. */
18882 static void
18883 insert_left_trunc_glyphs (struct it *it)
18885 struct it truncate_it;
18886 struct glyph *from, *end, *to, *toend;
18888 eassert (!FRAME_WINDOW_P (it->f)
18889 || (!it->glyph_row->reversed_p
18890 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
18891 || (it->glyph_row->reversed_p
18892 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0));
18894 /* Get the truncation glyphs. */
18895 truncate_it = *it;
18896 truncate_it.current_x = 0;
18897 truncate_it.face_id = DEFAULT_FACE_ID;
18898 truncate_it.glyph_row = &scratch_glyph_row;
18899 truncate_it.area = TEXT_AREA;
18900 truncate_it.glyph_row->used[TEXT_AREA] = 0;
18901 CHARPOS (truncate_it.position) = BYTEPOS (truncate_it.position) = -1;
18902 truncate_it.object = make_number (0);
18903 produce_special_glyphs (&truncate_it, IT_TRUNCATION);
18905 /* Overwrite glyphs from IT with truncation glyphs. */
18906 if (!it->glyph_row->reversed_p)
18908 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18910 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18911 end = from + tused;
18912 to = it->glyph_row->glyphs[TEXT_AREA];
18913 toend = to + it->glyph_row->used[TEXT_AREA];
18914 if (FRAME_WINDOW_P (it->f))
18916 /* On GUI frames, when variable-size fonts are displayed,
18917 the truncation glyphs may need more pixels than the row's
18918 glyphs they overwrite. We overwrite more glyphs to free
18919 enough screen real estate, and enlarge the stretch glyph
18920 on the right (see display_line), if there is one, to
18921 preserve the screen position of the truncation glyphs on
18922 the right. */
18923 int w = 0;
18924 struct glyph *g = to;
18925 short used;
18927 /* The first glyph could be partially visible, in which case
18928 it->glyph_row->x will be negative. But we want the left
18929 truncation glyphs to be aligned at the left margin of the
18930 window, so we override the x coordinate at which the row
18931 will begin. */
18932 it->glyph_row->x = 0;
18933 while (g < toend && w < it->truncation_pixel_width)
18935 w += g->pixel_width;
18936 ++g;
18938 if (g - to - tused > 0)
18940 memmove (to + tused, g, (toend - g) * sizeof(*g));
18941 it->glyph_row->used[TEXT_AREA] -= g - to - tused;
18943 used = it->glyph_row->used[TEXT_AREA];
18944 if (it->glyph_row->truncated_on_right_p
18945 && WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0
18946 && it->glyph_row->glyphs[TEXT_AREA][used - 2].type
18947 == STRETCH_GLYPH)
18949 int extra = w - it->truncation_pixel_width;
18951 it->glyph_row->glyphs[TEXT_AREA][used - 2].pixel_width += extra;
18955 while (from < end)
18956 *to++ = *from++;
18958 /* There may be padding glyphs left over. Overwrite them too. */
18959 if (!FRAME_WINDOW_P (it->f))
18961 while (to < toend && CHAR_GLYPH_PADDING_P (*to))
18963 from = truncate_it.glyph_row->glyphs[TEXT_AREA];
18964 while (from < end)
18965 *to++ = *from++;
18969 if (to > toend)
18970 it->glyph_row->used[TEXT_AREA] = to - it->glyph_row->glyphs[TEXT_AREA];
18972 else
18974 short tused = truncate_it.glyph_row->used[TEXT_AREA];
18976 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18977 that back to front. */
18978 end = truncate_it.glyph_row->glyphs[TEXT_AREA];
18979 from = end + truncate_it.glyph_row->used[TEXT_AREA] - 1;
18980 toend = it->glyph_row->glyphs[TEXT_AREA];
18981 to = toend + it->glyph_row->used[TEXT_AREA] - 1;
18982 if (FRAME_WINDOW_P (it->f))
18984 int w = 0;
18985 struct glyph *g = to;
18987 while (g >= toend && w < it->truncation_pixel_width)
18989 w += g->pixel_width;
18990 --g;
18992 if (to - g - tused > 0)
18993 to = g + tused;
18994 if (it->glyph_row->truncated_on_right_p
18995 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0
18996 && it->glyph_row->glyphs[TEXT_AREA][1].type == STRETCH_GLYPH)
18998 int extra = w - it->truncation_pixel_width;
19000 it->glyph_row->glyphs[TEXT_AREA][1].pixel_width += extra;
19004 while (from >= end && to >= toend)
19005 *to-- = *from--;
19006 if (!FRAME_WINDOW_P (it->f))
19008 while (to >= toend && CHAR_GLYPH_PADDING_P (*to))
19010 from =
19011 truncate_it.glyph_row->glyphs[TEXT_AREA]
19012 + truncate_it.glyph_row->used[TEXT_AREA] - 1;
19013 while (from >= end && to >= toend)
19014 *to-- = *from--;
19017 if (from >= end)
19019 /* Need to free some room before prepending additional
19020 glyphs. */
19021 int move_by = from - end + 1;
19022 struct glyph *g0 = it->glyph_row->glyphs[TEXT_AREA];
19023 struct glyph *g = g0 + it->glyph_row->used[TEXT_AREA] - 1;
19025 for ( ; g >= g0; g--)
19026 g[move_by] = *g;
19027 while (from >= end)
19028 *to-- = *from--;
19029 it->glyph_row->used[TEXT_AREA] += move_by;
19034 /* Compute the hash code for ROW. */
19035 unsigned
19036 row_hash (struct glyph_row *row)
19038 int area, k;
19039 unsigned hashval = 0;
19041 for (area = LEFT_MARGIN_AREA; area < LAST_AREA; ++area)
19042 for (k = 0; k < row->used[area]; ++k)
19043 hashval = ((((hashval << 4) + (hashval >> 24)) & 0x0fffffff)
19044 + row->glyphs[area][k].u.val
19045 + row->glyphs[area][k].face_id
19046 + row->glyphs[area][k].padding_p
19047 + (row->glyphs[area][k].type << 2));
19049 return hashval;
19052 /* Compute the pixel height and width of IT->glyph_row.
19054 Most of the time, ascent and height of a display line will be equal
19055 to the max_ascent and max_height values of the display iterator
19056 structure. This is not the case if
19058 1. We hit ZV without displaying anything. In this case, max_ascent
19059 and max_height will be zero.
19061 2. We have some glyphs that don't contribute to the line height.
19062 (The glyph row flag contributes_to_line_height_p is for future
19063 pixmap extensions).
19065 The first case is easily covered by using default values because in
19066 these cases, the line height does not really matter, except that it
19067 must not be zero. */
19069 static void
19070 compute_line_metrics (struct it *it)
19072 struct glyph_row *row = it->glyph_row;
19074 if (FRAME_WINDOW_P (it->f))
19076 int i, min_y, max_y;
19078 /* The line may consist of one space only, that was added to
19079 place the cursor on it. If so, the row's height hasn't been
19080 computed yet. */
19081 if (row->height == 0)
19083 if (it->max_ascent + it->max_descent == 0)
19084 it->max_descent = it->max_phys_descent = FRAME_LINE_HEIGHT (it->f);
19085 row->ascent = it->max_ascent;
19086 row->height = it->max_ascent + it->max_descent;
19087 row->phys_ascent = it->max_phys_ascent;
19088 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
19089 row->extra_line_spacing = it->max_extra_line_spacing;
19092 /* Compute the width of this line. */
19093 row->pixel_width = row->x;
19094 for (i = 0; i < row->used[TEXT_AREA]; ++i)
19095 row->pixel_width += row->glyphs[TEXT_AREA][i].pixel_width;
19097 eassert (row->pixel_width >= 0);
19098 eassert (row->ascent >= 0 && row->height > 0);
19100 row->overlapping_p = (MATRIX_ROW_OVERLAPS_SUCC_P (row)
19101 || MATRIX_ROW_OVERLAPS_PRED_P (row));
19103 /* If first line's physical ascent is larger than its logical
19104 ascent, use the physical ascent, and make the row taller.
19105 This makes accented characters fully visible. */
19106 if (row == MATRIX_FIRST_TEXT_ROW (it->w->desired_matrix)
19107 && row->phys_ascent > row->ascent)
19109 row->height += row->phys_ascent - row->ascent;
19110 row->ascent = row->phys_ascent;
19113 /* Compute how much of the line is visible. */
19114 row->visible_height = row->height;
19116 min_y = WINDOW_HEADER_LINE_HEIGHT (it->w);
19117 max_y = WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w);
19119 if (row->y < min_y)
19120 row->visible_height -= min_y - row->y;
19121 if (row->y + row->height > max_y)
19122 row->visible_height -= row->y + row->height - max_y;
19124 else
19126 row->pixel_width = row->used[TEXT_AREA];
19127 if (row->continued_p)
19128 row->pixel_width -= it->continuation_pixel_width;
19129 else if (row->truncated_on_right_p)
19130 row->pixel_width -= it->truncation_pixel_width;
19131 row->ascent = row->phys_ascent = 0;
19132 row->height = row->phys_height = row->visible_height = 1;
19133 row->extra_line_spacing = 0;
19136 /* Compute a hash code for this row. */
19137 row->hash = row_hash (row);
19139 it->max_ascent = it->max_descent = 0;
19140 it->max_phys_ascent = it->max_phys_descent = 0;
19144 /* Append one space to the glyph row of iterator IT if doing a
19145 window-based redisplay. The space has the same face as
19146 IT->face_id. Value is non-zero if a space was added.
19148 This function is called to make sure that there is always one glyph
19149 at the end of a glyph row that the cursor can be set on under
19150 window-systems. (If there weren't such a glyph we would not know
19151 how wide and tall a box cursor should be displayed).
19153 At the same time this space let's a nicely handle clearing to the
19154 end of the line if the row ends in italic text. */
19156 static int
19157 append_space_for_newline (struct it *it, int default_face_p)
19159 if (FRAME_WINDOW_P (it->f))
19161 int n = it->glyph_row->used[TEXT_AREA];
19163 if (it->glyph_row->glyphs[TEXT_AREA] + n
19164 < it->glyph_row->glyphs[1 + TEXT_AREA])
19166 /* Save some values that must not be changed.
19167 Must save IT->c and IT->len because otherwise
19168 ITERATOR_AT_END_P wouldn't work anymore after
19169 append_space_for_newline has been called. */
19170 enum display_element_type saved_what = it->what;
19171 int saved_c = it->c, saved_len = it->len;
19172 int saved_char_to_display = it->char_to_display;
19173 int saved_x = it->current_x;
19174 int saved_face_id = it->face_id;
19175 int saved_box_end = it->end_of_box_run_p;
19176 struct text_pos saved_pos;
19177 Lisp_Object saved_object;
19178 struct face *face;
19180 saved_object = it->object;
19181 saved_pos = it->position;
19183 it->what = IT_CHARACTER;
19184 memset (&it->position, 0, sizeof it->position);
19185 it->object = make_number (0);
19186 it->c = it->char_to_display = ' ';
19187 it->len = 1;
19189 /* If the default face was remapped, be sure to use the
19190 remapped face for the appended newline. */
19191 if (default_face_p)
19192 it->face_id = lookup_basic_face (it->f, DEFAULT_FACE_ID);
19193 else if (it->face_before_selective_p)
19194 it->face_id = it->saved_face_id;
19195 face = FACE_FROM_ID (it->f, it->face_id);
19196 it->face_id = FACE_FOR_CHAR (it->f, face, 0, -1, Qnil);
19197 /* In R2L rows, we will prepend a stretch glyph that will
19198 have the end_of_box_run_p flag set for it, so there's no
19199 need for the appended newline glyph to have that flag
19200 set. */
19201 if (it->glyph_row->reversed_p
19202 /* But if the appended newline glyph goes all the way to
19203 the end of the row, there will be no stretch glyph,
19204 so leave the box flag set. */
19205 && saved_x + FRAME_COLUMN_WIDTH (it->f) < it->last_visible_x)
19206 it->end_of_box_run_p = 0;
19208 PRODUCE_GLYPHS (it);
19210 it->override_ascent = -1;
19211 it->constrain_row_ascent_descent_p = 0;
19212 it->current_x = saved_x;
19213 it->object = saved_object;
19214 it->position = saved_pos;
19215 it->what = saved_what;
19216 it->face_id = saved_face_id;
19217 it->len = saved_len;
19218 it->c = saved_c;
19219 it->char_to_display = saved_char_to_display;
19220 it->end_of_box_run_p = saved_box_end;
19221 return 1;
19225 return 0;
19229 /* Extend the face of the last glyph in the text area of IT->glyph_row
19230 to the end of the display line. Called from display_line. If the
19231 glyph row is empty, add a space glyph to it so that we know the
19232 face to draw. Set the glyph row flag fill_line_p. If the glyph
19233 row is R2L, prepend a stretch glyph to cover the empty space to the
19234 left of the leftmost glyph. */
19236 static void
19237 extend_face_to_end_of_line (struct it *it)
19239 struct face *face, *default_face;
19240 struct frame *f = it->f;
19242 /* If line is already filled, do nothing. Non window-system frames
19243 get a grace of one more ``pixel'' because their characters are
19244 1-``pixel'' wide, so they hit the equality too early. This grace
19245 is needed only for R2L rows that are not continued, to produce
19246 one extra blank where we could display the cursor. */
19247 if ((it->current_x >= it->last_visible_x
19248 + (!FRAME_WINDOW_P (f)
19249 && it->glyph_row->reversed_p
19250 && !it->glyph_row->continued_p))
19251 /* If the window has display margins, we will need to extend
19252 their face even if the text area is filled. */
19253 && !(WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19254 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0))
19255 return;
19257 /* The default face, possibly remapped. */
19258 default_face = FACE_FROM_ID (f, lookup_basic_face (f, DEFAULT_FACE_ID));
19260 /* Face extension extends the background and box of IT->face_id
19261 to the end of the line. If the background equals the background
19262 of the frame, we don't have to do anything. */
19263 if (it->face_before_selective_p)
19264 face = FACE_FROM_ID (f, it->saved_face_id);
19265 else
19266 face = FACE_FROM_ID (f, it->face_id);
19268 if (FRAME_WINDOW_P (f)
19269 && MATRIX_ROW_DISPLAYS_TEXT_P (it->glyph_row)
19270 && face->box == FACE_NO_BOX
19271 && face->background == FRAME_BACKGROUND_PIXEL (f)
19272 #ifdef HAVE_WINDOW_SYSTEM
19273 && !face->stipple
19274 #endif
19275 && !it->glyph_row->reversed_p)
19276 return;
19278 /* Set the glyph row flag indicating that the face of the last glyph
19279 in the text area has to be drawn to the end of the text area. */
19280 it->glyph_row->fill_line_p = 1;
19282 /* If current character of IT is not ASCII, make sure we have the
19283 ASCII face. This will be automatically undone the next time
19284 get_next_display_element returns a multibyte character. Note
19285 that the character will always be single byte in unibyte
19286 text. */
19287 if (!ASCII_CHAR_P (it->c))
19289 it->face_id = FACE_FOR_CHAR (f, face, 0, -1, Qnil);
19292 if (FRAME_WINDOW_P (f))
19294 /* If the row is empty, add a space with the current face of IT,
19295 so that we know which face to draw. */
19296 if (it->glyph_row->used[TEXT_AREA] == 0)
19298 it->glyph_row->glyphs[TEXT_AREA][0] = space_glyph;
19299 it->glyph_row->glyphs[TEXT_AREA][0].face_id = face->id;
19300 it->glyph_row->used[TEXT_AREA] = 1;
19302 /* Mode line and the header line don't have margins, and
19303 likewise the frame's tool-bar window, if there is any. */
19304 if (!(it->glyph_row->mode_line_p
19305 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19306 || (WINDOWP (f->tool_bar_window)
19307 && it->w == XWINDOW (f->tool_bar_window))
19308 #endif
19311 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19312 && it->glyph_row->used[LEFT_MARGIN_AREA] == 0)
19314 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0] = space_glyph;
19315 it->glyph_row->glyphs[LEFT_MARGIN_AREA][0].face_id =
19316 default_face->id;
19317 it->glyph_row->used[LEFT_MARGIN_AREA] = 1;
19319 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19320 && it->glyph_row->used[RIGHT_MARGIN_AREA] == 0)
19322 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0] = space_glyph;
19323 it->glyph_row->glyphs[RIGHT_MARGIN_AREA][0].face_id =
19324 default_face->id;
19325 it->glyph_row->used[RIGHT_MARGIN_AREA] = 1;
19328 #ifdef HAVE_WINDOW_SYSTEM
19329 if (it->glyph_row->reversed_p)
19331 /* Prepend a stretch glyph to the row, such that the
19332 rightmost glyph will be drawn flushed all the way to the
19333 right margin of the window. The stretch glyph that will
19334 occupy the empty space, if any, to the left of the
19335 glyphs. */
19336 struct font *font = face->font ? face->font : FRAME_FONT (f);
19337 struct glyph *row_start = it->glyph_row->glyphs[TEXT_AREA];
19338 struct glyph *row_end = row_start + it->glyph_row->used[TEXT_AREA];
19339 struct glyph *g;
19340 int row_width, stretch_ascent, stretch_width;
19341 struct text_pos saved_pos;
19342 int saved_face_id, saved_avoid_cursor, saved_box_start;
19344 for (row_width = 0, g = row_start; g < row_end; g++)
19345 row_width += g->pixel_width;
19347 /* FIXME: There are various minor display glitches in R2L
19348 rows when only one of the fringes is missing. The
19349 strange condition below produces the least bad effect. */
19350 if ((WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0)
19351 == (WINDOW_RIGHT_FRINGE_WIDTH (it->w) == 0)
19352 || WINDOW_RIGHT_FRINGE_WIDTH (it->w) != 0)
19353 stretch_width = window_box_width (it->w, TEXT_AREA);
19354 else
19355 stretch_width = it->last_visible_x - it->first_visible_x;
19356 stretch_width -= row_width;
19358 if (stretch_width > 0)
19360 stretch_ascent =
19361 (((it->ascent + it->descent)
19362 * FONT_BASE (font)) / FONT_HEIGHT (font));
19363 saved_pos = it->position;
19364 memset (&it->position, 0, sizeof it->position);
19365 saved_avoid_cursor = it->avoid_cursor_p;
19366 it->avoid_cursor_p = 1;
19367 saved_face_id = it->face_id;
19368 saved_box_start = it->start_of_box_run_p;
19369 /* The last row's stretch glyph should get the default
19370 face, to avoid painting the rest of the window with
19371 the region face, if the region ends at ZV. */
19372 if (it->glyph_row->ends_at_zv_p)
19373 it->face_id = default_face->id;
19374 else
19375 it->face_id = face->id;
19376 it->start_of_box_run_p = 0;
19377 append_stretch_glyph (it, make_number (0), stretch_width,
19378 it->ascent + it->descent, stretch_ascent);
19379 it->position = saved_pos;
19380 it->avoid_cursor_p = saved_avoid_cursor;
19381 it->face_id = saved_face_id;
19382 it->start_of_box_run_p = saved_box_start;
19384 /* If stretch_width comes out negative, it means that the
19385 last glyph is only partially visible. In R2L rows, we
19386 want the leftmost glyph to be partially visible, so we
19387 need to give the row the corresponding left offset. */
19388 if (stretch_width < 0)
19389 it->glyph_row->x = stretch_width;
19391 #endif /* HAVE_WINDOW_SYSTEM */
19393 else
19395 /* Save some values that must not be changed. */
19396 int saved_x = it->current_x;
19397 struct text_pos saved_pos;
19398 Lisp_Object saved_object;
19399 enum display_element_type saved_what = it->what;
19400 int saved_face_id = it->face_id;
19402 saved_object = it->object;
19403 saved_pos = it->position;
19405 it->what = IT_CHARACTER;
19406 memset (&it->position, 0, sizeof it->position);
19407 it->object = make_number (0);
19408 it->c = it->char_to_display = ' ';
19409 it->len = 1;
19411 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
19412 && (it->glyph_row->used[LEFT_MARGIN_AREA]
19413 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19414 && !it->glyph_row->mode_line_p
19415 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19417 struct glyph *g = it->glyph_row->glyphs[LEFT_MARGIN_AREA];
19418 struct glyph *e = g + it->glyph_row->used[LEFT_MARGIN_AREA];
19420 for (it->current_x = 0; g < e; g++)
19421 it->current_x += g->pixel_width;
19423 it->area = LEFT_MARGIN_AREA;
19424 it->face_id = default_face->id;
19425 while (it->glyph_row->used[LEFT_MARGIN_AREA]
19426 < WINDOW_LEFT_MARGIN_WIDTH (it->w))
19428 PRODUCE_GLYPHS (it);
19429 /* term.c:produce_glyphs advances it->current_x only for
19430 TEXT_AREA. */
19431 it->current_x += it->pixel_width;
19434 it->current_x = saved_x;
19435 it->area = TEXT_AREA;
19438 /* The last row's blank glyphs should get the default face, to
19439 avoid painting the rest of the window with the region face,
19440 if the region ends at ZV. */
19441 if (it->glyph_row->ends_at_zv_p)
19442 it->face_id = default_face->id;
19443 else
19444 it->face_id = face->id;
19445 PRODUCE_GLYPHS (it);
19447 while (it->current_x <= it->last_visible_x)
19448 PRODUCE_GLYPHS (it);
19450 if (WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0
19451 && (it->glyph_row->used[RIGHT_MARGIN_AREA]
19452 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19453 && !it->glyph_row->mode_line_p
19454 && default_face->background != FRAME_BACKGROUND_PIXEL (f))
19456 struct glyph *g = it->glyph_row->glyphs[RIGHT_MARGIN_AREA];
19457 struct glyph *e = g + it->glyph_row->used[RIGHT_MARGIN_AREA];
19459 for ( ; g < e; g++)
19460 it->current_x += g->pixel_width;
19462 it->area = RIGHT_MARGIN_AREA;
19463 it->face_id = default_face->id;
19464 while (it->glyph_row->used[RIGHT_MARGIN_AREA]
19465 < WINDOW_RIGHT_MARGIN_WIDTH (it->w))
19467 PRODUCE_GLYPHS (it);
19468 it->current_x += it->pixel_width;
19471 it->area = TEXT_AREA;
19474 /* Don't count these blanks really. It would let us insert a left
19475 truncation glyph below and make us set the cursor on them, maybe. */
19476 it->current_x = saved_x;
19477 it->object = saved_object;
19478 it->position = saved_pos;
19479 it->what = saved_what;
19480 it->face_id = saved_face_id;
19485 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19486 trailing whitespace. */
19488 static int
19489 trailing_whitespace_p (ptrdiff_t charpos)
19491 ptrdiff_t bytepos = CHAR_TO_BYTE (charpos);
19492 int c = 0;
19494 while (bytepos < ZV_BYTE
19495 && (c = FETCH_CHAR (bytepos),
19496 c == ' ' || c == '\t'))
19497 ++bytepos;
19499 if (bytepos >= ZV_BYTE || c == '\n' || c == '\r')
19501 if (bytepos != PT_BYTE)
19502 return 1;
19504 return 0;
19508 /* Highlight trailing whitespace, if any, in ROW. */
19510 static void
19511 highlight_trailing_whitespace (struct frame *f, struct glyph_row *row)
19513 int used = row->used[TEXT_AREA];
19515 if (used)
19517 struct glyph *start = row->glyphs[TEXT_AREA];
19518 struct glyph *glyph = start + used - 1;
19520 if (row->reversed_p)
19522 /* Right-to-left rows need to be processed in the opposite
19523 direction, so swap the edge pointers. */
19524 glyph = start;
19525 start = row->glyphs[TEXT_AREA] + used - 1;
19528 /* Skip over glyphs inserted to display the cursor at the
19529 end of a line, for extending the face of the last glyph
19530 to the end of the line on terminals, and for truncation
19531 and continuation glyphs. */
19532 if (!row->reversed_p)
19534 while (glyph >= start
19535 && glyph->type == CHAR_GLYPH
19536 && INTEGERP (glyph->object))
19537 --glyph;
19539 else
19541 while (glyph <= start
19542 && glyph->type == CHAR_GLYPH
19543 && INTEGERP (glyph->object))
19544 ++glyph;
19547 /* If last glyph is a space or stretch, and it's trailing
19548 whitespace, set the face of all trailing whitespace glyphs in
19549 IT->glyph_row to `trailing-whitespace'. */
19550 if ((row->reversed_p ? glyph <= start : glyph >= start)
19551 && BUFFERP (glyph->object)
19552 && (glyph->type == STRETCH_GLYPH
19553 || (glyph->type == CHAR_GLYPH
19554 && glyph->u.ch == ' '))
19555 && trailing_whitespace_p (glyph->charpos))
19557 int face_id = lookup_named_face (f, Qtrailing_whitespace, 0);
19558 if (face_id < 0)
19559 return;
19561 if (!row->reversed_p)
19563 while (glyph >= start
19564 && BUFFERP (glyph->object)
19565 && (glyph->type == STRETCH_GLYPH
19566 || (glyph->type == CHAR_GLYPH
19567 && glyph->u.ch == ' ')))
19568 (glyph--)->face_id = face_id;
19570 else
19572 while (glyph <= start
19573 && BUFFERP (glyph->object)
19574 && (glyph->type == STRETCH_GLYPH
19575 || (glyph->type == CHAR_GLYPH
19576 && glyph->u.ch == ' ')))
19577 (glyph++)->face_id = face_id;
19584 /* Value is non-zero if glyph row ROW should be
19585 considered to hold the buffer position CHARPOS. */
19587 static int
19588 row_for_charpos_p (struct glyph_row *row, ptrdiff_t charpos)
19590 int result = 1;
19592 if (charpos == CHARPOS (row->end.pos)
19593 || charpos == MATRIX_ROW_END_CHARPOS (row))
19595 /* Suppose the row ends on a string.
19596 Unless the row is continued, that means it ends on a newline
19597 in the string. If it's anything other than a display string
19598 (e.g., a before-string from an overlay), we don't want the
19599 cursor there. (This heuristic seems to give the optimal
19600 behavior for the various types of multi-line strings.)
19601 One exception: if the string has `cursor' property on one of
19602 its characters, we _do_ want the cursor there. */
19603 if (CHARPOS (row->end.string_pos) >= 0)
19605 if (row->continued_p)
19606 result = 1;
19607 else
19609 /* Check for `display' property. */
19610 struct glyph *beg = row->glyphs[TEXT_AREA];
19611 struct glyph *end = beg + row->used[TEXT_AREA] - 1;
19612 struct glyph *glyph;
19614 result = 0;
19615 for (glyph = end; glyph >= beg; --glyph)
19616 if (STRINGP (glyph->object))
19618 Lisp_Object prop
19619 = Fget_char_property (make_number (charpos),
19620 Qdisplay, Qnil);
19621 result =
19622 (!NILP (prop)
19623 && display_prop_string_p (prop, glyph->object));
19624 /* If there's a `cursor' property on one of the
19625 string's characters, this row is a cursor row,
19626 even though this is not a display string. */
19627 if (!result)
19629 Lisp_Object s = glyph->object;
19631 for ( ; glyph >= beg && EQ (glyph->object, s); --glyph)
19633 ptrdiff_t gpos = glyph->charpos;
19635 if (!NILP (Fget_char_property (make_number (gpos),
19636 Qcursor, s)))
19638 result = 1;
19639 break;
19643 break;
19647 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))
19649 /* If the row ends in middle of a real character,
19650 and the line is continued, we want the cursor here.
19651 That's because CHARPOS (ROW->end.pos) would equal
19652 PT if PT is before the character. */
19653 if (!row->ends_in_ellipsis_p)
19654 result = row->continued_p;
19655 else
19656 /* If the row ends in an ellipsis, then
19657 CHARPOS (ROW->end.pos) will equal point after the
19658 invisible text. We want that position to be displayed
19659 after the ellipsis. */
19660 result = 0;
19662 /* If the row ends at ZV, display the cursor at the end of that
19663 row instead of at the start of the row below. */
19664 else if (row->ends_at_zv_p)
19665 result = 1;
19666 else
19667 result = 0;
19670 return result;
19673 /* Value is non-zero if glyph row ROW should be
19674 used to hold the cursor. */
19676 static int
19677 cursor_row_p (struct glyph_row *row)
19679 return row_for_charpos_p (row, PT);
19684 /* Push the property PROP so that it will be rendered at the current
19685 position in IT. Return 1 if PROP was successfully pushed, 0
19686 otherwise. Called from handle_line_prefix to handle the
19687 `line-prefix' and `wrap-prefix' properties. */
19689 static int
19690 push_prefix_prop (struct it *it, Lisp_Object prop)
19692 struct text_pos pos =
19693 STRINGP (it->string) ? it->current.string_pos : it->current.pos;
19695 eassert (it->method == GET_FROM_BUFFER
19696 || it->method == GET_FROM_DISPLAY_VECTOR
19697 || it->method == GET_FROM_STRING);
19699 /* We need to save the current buffer/string position, so it will be
19700 restored by pop_it, because iterate_out_of_display_property
19701 depends on that being set correctly, but some situations leave
19702 it->position not yet set when this function is called. */
19703 push_it (it, &pos);
19705 if (STRINGP (prop))
19707 if (SCHARS (prop) == 0)
19709 pop_it (it);
19710 return 0;
19713 it->string = prop;
19714 it->string_from_prefix_prop_p = 1;
19715 it->multibyte_p = STRING_MULTIBYTE (it->string);
19716 it->current.overlay_string_index = -1;
19717 IT_STRING_CHARPOS (*it) = IT_STRING_BYTEPOS (*it) = 0;
19718 it->end_charpos = it->string_nchars = SCHARS (it->string);
19719 it->method = GET_FROM_STRING;
19720 it->stop_charpos = 0;
19721 it->prev_stop = 0;
19722 it->base_level_stop = 0;
19724 /* Force paragraph direction to be that of the parent
19725 buffer/string. */
19726 if (it->bidi_p && it->bidi_it.paragraph_dir == R2L)
19727 it->paragraph_embedding = it->bidi_it.paragraph_dir;
19728 else
19729 it->paragraph_embedding = L2R;
19731 /* Set up the bidi iterator for this display string. */
19732 if (it->bidi_p)
19734 it->bidi_it.string.lstring = it->string;
19735 it->bidi_it.string.s = NULL;
19736 it->bidi_it.string.schars = it->end_charpos;
19737 it->bidi_it.string.bufpos = IT_CHARPOS (*it);
19738 it->bidi_it.string.from_disp_str = it->string_from_display_prop_p;
19739 it->bidi_it.string.unibyte = !it->multibyte_p;
19740 it->bidi_it.w = it->w;
19741 bidi_init_it (0, 0, FRAME_WINDOW_P (it->f), &it->bidi_it);
19744 else if (CONSP (prop) && EQ (XCAR (prop), Qspace))
19746 it->method = GET_FROM_STRETCH;
19747 it->object = prop;
19749 #ifdef HAVE_WINDOW_SYSTEM
19750 else if (IMAGEP (prop))
19752 it->what = IT_IMAGE;
19753 it->image_id = lookup_image (it->f, prop);
19754 it->method = GET_FROM_IMAGE;
19756 #endif /* HAVE_WINDOW_SYSTEM */
19757 else
19759 pop_it (it); /* bogus display property, give up */
19760 return 0;
19763 return 1;
19766 /* Return the character-property PROP at the current position in IT. */
19768 static Lisp_Object
19769 get_it_property (struct it *it, Lisp_Object prop)
19771 Lisp_Object position, object = it->object;
19773 if (STRINGP (object))
19774 position = make_number (IT_STRING_CHARPOS (*it));
19775 else if (BUFFERP (object))
19777 position = make_number (IT_CHARPOS (*it));
19778 object = it->window;
19780 else
19781 return Qnil;
19783 return Fget_char_property (position, prop, object);
19786 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19788 static void
19789 handle_line_prefix (struct it *it)
19791 Lisp_Object prefix;
19793 if (it->continuation_lines_width > 0)
19795 prefix = get_it_property (it, Qwrap_prefix);
19796 if (NILP (prefix))
19797 prefix = Vwrap_prefix;
19799 else
19801 prefix = get_it_property (it, Qline_prefix);
19802 if (NILP (prefix))
19803 prefix = Vline_prefix;
19805 if (! NILP (prefix) && push_prefix_prop (it, prefix))
19807 /* If the prefix is wider than the window, and we try to wrap
19808 it, it would acquire its own wrap prefix, and so on till the
19809 iterator stack overflows. So, don't wrap the prefix. */
19810 it->line_wrap = TRUNCATE;
19811 it->avoid_cursor_p = 1;
19817 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19818 only for R2L lines from display_line and display_string, when they
19819 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19820 the line/string needs to be continued on the next glyph row. */
19821 static void
19822 unproduce_glyphs (struct it *it, int n)
19824 struct glyph *glyph, *end;
19826 eassert (it->glyph_row);
19827 eassert (it->glyph_row->reversed_p);
19828 eassert (it->area == TEXT_AREA);
19829 eassert (n <= it->glyph_row->used[TEXT_AREA]);
19831 if (n > it->glyph_row->used[TEXT_AREA])
19832 n = it->glyph_row->used[TEXT_AREA];
19833 glyph = it->glyph_row->glyphs[TEXT_AREA] + n;
19834 end = it->glyph_row->glyphs[TEXT_AREA] + it->glyph_row->used[TEXT_AREA];
19835 for ( ; glyph < end; glyph++)
19836 glyph[-n] = *glyph;
19839 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19840 and ROW->maxpos. */
19841 static void
19842 find_row_edges (struct it *it, struct glyph_row *row,
19843 ptrdiff_t min_pos, ptrdiff_t min_bpos,
19844 ptrdiff_t max_pos, ptrdiff_t max_bpos)
19846 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19847 lines' rows is implemented for bidi-reordered rows. */
19849 /* ROW->minpos is the value of min_pos, the minimal buffer position
19850 we have in ROW, or ROW->start.pos if that is smaller. */
19851 if (min_pos <= ZV && min_pos < row->start.pos.charpos)
19852 SET_TEXT_POS (row->minpos, min_pos, min_bpos);
19853 else
19854 /* We didn't find buffer positions smaller than ROW->start, or
19855 didn't find _any_ valid buffer positions in any of the glyphs,
19856 so we must trust the iterator's computed positions. */
19857 row->minpos = row->start.pos;
19858 if (max_pos <= 0)
19860 max_pos = CHARPOS (it->current.pos);
19861 max_bpos = BYTEPOS (it->current.pos);
19864 /* Here are the various use-cases for ending the row, and the
19865 corresponding values for ROW->maxpos:
19867 Line ends in a newline from buffer eol_pos + 1
19868 Line is continued from buffer max_pos + 1
19869 Line is truncated on right it->current.pos
19870 Line ends in a newline from string max_pos + 1(*)
19871 (*) + 1 only when line ends in a forward scan
19872 Line is continued from string max_pos
19873 Line is continued from display vector max_pos
19874 Line is entirely from a string min_pos == max_pos
19875 Line is entirely from a display vector min_pos == max_pos
19876 Line that ends at ZV ZV
19878 If you discover other use-cases, please add them here as
19879 appropriate. */
19880 if (row->ends_at_zv_p)
19881 row->maxpos = it->current.pos;
19882 else if (row->used[TEXT_AREA])
19884 int seen_this_string = 0;
19885 struct glyph_row *r1 = row - 1;
19887 /* Did we see the same display string on the previous row? */
19888 if (STRINGP (it->object)
19889 /* this is not the first row */
19890 && row > it->w->desired_matrix->rows
19891 /* previous row is not the header line */
19892 && !r1->mode_line_p
19893 /* previous row also ends in a newline from a string */
19894 && r1->ends_in_newline_from_string_p)
19896 struct glyph *start, *end;
19898 /* Search for the last glyph of the previous row that came
19899 from buffer or string. Depending on whether the row is
19900 L2R or R2L, we need to process it front to back or the
19901 other way round. */
19902 if (!r1->reversed_p)
19904 start = r1->glyphs[TEXT_AREA];
19905 end = start + r1->used[TEXT_AREA];
19906 /* Glyphs inserted by redisplay have an integer (zero)
19907 as their object. */
19908 while (end > start
19909 && INTEGERP ((end - 1)->object)
19910 && (end - 1)->charpos <= 0)
19911 --end;
19912 if (end > start)
19914 if (EQ ((end - 1)->object, it->object))
19915 seen_this_string = 1;
19917 else
19918 /* If all the glyphs of the previous row were inserted
19919 by redisplay, it means the previous row was
19920 produced from a single newline, which is only
19921 possible if that newline came from the same string
19922 as the one which produced this ROW. */
19923 seen_this_string = 1;
19925 else
19927 end = r1->glyphs[TEXT_AREA] - 1;
19928 start = end + r1->used[TEXT_AREA];
19929 while (end < start
19930 && INTEGERP ((end + 1)->object)
19931 && (end + 1)->charpos <= 0)
19932 ++end;
19933 if (end < start)
19935 if (EQ ((end + 1)->object, it->object))
19936 seen_this_string = 1;
19938 else
19939 seen_this_string = 1;
19942 /* Take note of each display string that covers a newline only
19943 once, the first time we see it. This is for when a display
19944 string includes more than one newline in it. */
19945 if (row->ends_in_newline_from_string_p && !seen_this_string)
19947 /* If we were scanning the buffer forward when we displayed
19948 the string, we want to account for at least one buffer
19949 position that belongs to this row (position covered by
19950 the display string), so that cursor positioning will
19951 consider this row as a candidate when point is at the end
19952 of the visual line represented by this row. This is not
19953 required when scanning back, because max_pos will already
19954 have a much larger value. */
19955 if (CHARPOS (row->end.pos) > max_pos)
19956 INC_BOTH (max_pos, max_bpos);
19957 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19959 else if (CHARPOS (it->eol_pos) > 0)
19960 SET_TEXT_POS (row->maxpos,
19961 CHARPOS (it->eol_pos) + 1, BYTEPOS (it->eol_pos) + 1);
19962 else if (row->continued_p)
19964 /* If max_pos is different from IT's current position, it
19965 means IT->method does not belong to the display element
19966 at max_pos. However, it also means that the display
19967 element at max_pos was displayed in its entirety on this
19968 line, which is equivalent to saying that the next line
19969 starts at the next buffer position. */
19970 if (IT_CHARPOS (*it) == max_pos && it->method != GET_FROM_BUFFER)
19971 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19972 else
19974 INC_BOTH (max_pos, max_bpos);
19975 SET_TEXT_POS (row->maxpos, max_pos, max_bpos);
19978 else if (row->truncated_on_right_p)
19979 /* display_line already called reseat_at_next_visible_line_start,
19980 which puts the iterator at the beginning of the next line, in
19981 the logical order. */
19982 row->maxpos = it->current.pos;
19983 else if (max_pos == min_pos && it->method != GET_FROM_BUFFER)
19984 /* A line that is entirely from a string/image/stretch... */
19985 row->maxpos = row->minpos;
19986 else
19987 emacs_abort ();
19989 else
19990 row->maxpos = it->current.pos;
19993 /* Construct the glyph row IT->glyph_row in the desired matrix of
19994 IT->w from text at the current position of IT. See dispextern.h
19995 for an overview of struct it. Value is non-zero if
19996 IT->glyph_row displays text, as opposed to a line displaying ZV
19997 only. */
19999 static int
20000 display_line (struct it *it)
20002 struct glyph_row *row = it->glyph_row;
20003 Lisp_Object overlay_arrow_string;
20004 struct it wrap_it;
20005 void *wrap_data = NULL;
20006 int may_wrap = 0, wrap_x IF_LINT (= 0);
20007 int wrap_row_used = -1;
20008 int wrap_row_ascent IF_LINT (= 0), wrap_row_height IF_LINT (= 0);
20009 int wrap_row_phys_ascent IF_LINT (= 0), wrap_row_phys_height IF_LINT (= 0);
20010 int wrap_row_extra_line_spacing IF_LINT (= 0);
20011 ptrdiff_t wrap_row_min_pos IF_LINT (= 0), wrap_row_min_bpos IF_LINT (= 0);
20012 ptrdiff_t wrap_row_max_pos IF_LINT (= 0), wrap_row_max_bpos IF_LINT (= 0);
20013 int cvpos;
20014 ptrdiff_t min_pos = ZV + 1, max_pos = 0;
20015 ptrdiff_t min_bpos IF_LINT (= 0), max_bpos IF_LINT (= 0);
20016 bool pending_handle_line_prefix = false;
20018 /* We always start displaying at hpos zero even if hscrolled. */
20019 eassert (it->hpos == 0 && it->current_x == 0);
20021 if (MATRIX_ROW_VPOS (row, it->w->desired_matrix)
20022 >= it->w->desired_matrix->nrows)
20024 it->w->nrows_scale_factor++;
20025 it->f->fonts_changed = 1;
20026 return 0;
20029 /* Clear the result glyph row and enable it. */
20030 prepare_desired_row (it->w, row, false);
20032 row->y = it->current_y;
20033 row->start = it->start;
20034 row->continuation_lines_width = it->continuation_lines_width;
20035 row->displays_text_p = 1;
20036 row->starts_in_middle_of_char_p = it->starts_in_middle_of_char_p;
20037 it->starts_in_middle_of_char_p = 0;
20039 /* Arrange the overlays nicely for our purposes. Usually, we call
20040 display_line on only one line at a time, in which case this
20041 can't really hurt too much, or we call it on lines which appear
20042 one after another in the buffer, in which case all calls to
20043 recenter_overlay_lists but the first will be pretty cheap. */
20044 recenter_overlay_lists (current_buffer, IT_CHARPOS (*it));
20046 /* Move over display elements that are not visible because we are
20047 hscrolled. This may stop at an x-position < IT->first_visible_x
20048 if the first glyph is partially visible or if we hit a line end. */
20049 if (it->current_x < it->first_visible_x)
20051 enum move_it_result move_result;
20053 this_line_min_pos = row->start.pos;
20054 move_result = move_it_in_display_line_to (it, ZV, it->first_visible_x,
20055 MOVE_TO_POS | MOVE_TO_X);
20056 /* If we are under a large hscroll, move_it_in_display_line_to
20057 could hit the end of the line without reaching
20058 it->first_visible_x. Pretend that we did reach it. This is
20059 especially important on a TTY, where we will call
20060 extend_face_to_end_of_line, which needs to know how many
20061 blank glyphs to produce. */
20062 if (it->current_x < it->first_visible_x
20063 && (move_result == MOVE_NEWLINE_OR_CR
20064 || move_result == MOVE_POS_MATCH_OR_ZV))
20065 it->current_x = it->first_visible_x;
20067 /* Record the smallest positions seen while we moved over
20068 display elements that are not visible. This is needed by
20069 redisplay_internal for optimizing the case where the cursor
20070 stays inside the same line. The rest of this function only
20071 considers positions that are actually displayed, so
20072 RECORD_MAX_MIN_POS will not otherwise record positions that
20073 are hscrolled to the left of the left edge of the window. */
20074 min_pos = CHARPOS (this_line_min_pos);
20075 min_bpos = BYTEPOS (this_line_min_pos);
20077 else if (it->area == TEXT_AREA)
20079 /* We only do this when not calling move_it_in_display_line_to
20080 above, because that function calls itself handle_line_prefix. */
20081 handle_line_prefix (it);
20083 else
20085 /* Line-prefix and wrap-prefix are always displayed in the text
20086 area. But if this is the first call to display_line after
20087 init_iterator, the iterator might have been set up to write
20088 into a marginal area, e.g. if the line begins with some
20089 display property that writes to the margins. So we need to
20090 wait with the call to handle_line_prefix until whatever
20091 writes to the margin has done its job. */
20092 pending_handle_line_prefix = true;
20095 /* Get the initial row height. This is either the height of the
20096 text hscrolled, if there is any, or zero. */
20097 row->ascent = it->max_ascent;
20098 row->height = it->max_ascent + it->max_descent;
20099 row->phys_ascent = it->max_phys_ascent;
20100 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
20101 row->extra_line_spacing = it->max_extra_line_spacing;
20103 /* Utility macro to record max and min buffer positions seen until now. */
20104 #define RECORD_MAX_MIN_POS(IT) \
20105 do \
20107 int composition_p = !STRINGP ((IT)->string) \
20108 && ((IT)->what == IT_COMPOSITION); \
20109 ptrdiff_t current_pos = \
20110 composition_p ? (IT)->cmp_it.charpos \
20111 : IT_CHARPOS (*(IT)); \
20112 ptrdiff_t current_bpos = \
20113 composition_p ? CHAR_TO_BYTE (current_pos) \
20114 : IT_BYTEPOS (*(IT)); \
20115 if (current_pos < min_pos) \
20117 min_pos = current_pos; \
20118 min_bpos = current_bpos; \
20120 if (IT_CHARPOS (*it) > max_pos) \
20122 max_pos = IT_CHARPOS (*it); \
20123 max_bpos = IT_BYTEPOS (*it); \
20126 while (0)
20128 /* Loop generating characters. The loop is left with IT on the next
20129 character to display. */
20130 while (1)
20132 int n_glyphs_before, hpos_before, x_before;
20133 int x, nglyphs;
20134 int ascent = 0, descent = 0, phys_ascent = 0, phys_descent = 0;
20136 /* Retrieve the next thing to display. Value is zero if end of
20137 buffer reached. */
20138 if (!get_next_display_element (it))
20140 /* Maybe add a space at the end of this line that is used to
20141 display the cursor there under X. Set the charpos of the
20142 first glyph of blank lines not corresponding to any text
20143 to -1. */
20144 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20145 row->exact_window_width_line_p = 1;
20146 else if ((append_space_for_newline (it, 1) && row->used[TEXT_AREA] == 1)
20147 || row->used[TEXT_AREA] == 0)
20149 row->glyphs[TEXT_AREA]->charpos = -1;
20150 row->displays_text_p = 0;
20152 if (!NILP (BVAR (XBUFFER (it->w->contents), indicate_empty_lines))
20153 && (!MINI_WINDOW_P (it->w)
20154 || (minibuf_level && EQ (it->window, minibuf_window))))
20155 row->indicate_empty_line_p = 1;
20158 it->continuation_lines_width = 0;
20159 row->ends_at_zv_p = 1;
20160 /* A row that displays right-to-left text must always have
20161 its last face extended all the way to the end of line,
20162 even if this row ends in ZV, because we still write to
20163 the screen left to right. We also need to extend the
20164 last face if the default face is remapped to some
20165 different face, otherwise the functions that clear
20166 portions of the screen will clear with the default face's
20167 background color. */
20168 if (row->reversed_p
20169 || lookup_basic_face (it->f, DEFAULT_FACE_ID) != DEFAULT_FACE_ID)
20170 extend_face_to_end_of_line (it);
20171 break;
20174 /* Now, get the metrics of what we want to display. This also
20175 generates glyphs in `row' (which is IT->glyph_row). */
20176 n_glyphs_before = row->used[TEXT_AREA];
20177 x = it->current_x;
20179 /* Remember the line height so far in case the next element doesn't
20180 fit on the line. */
20181 if (it->line_wrap != TRUNCATE)
20183 ascent = it->max_ascent;
20184 descent = it->max_descent;
20185 phys_ascent = it->max_phys_ascent;
20186 phys_descent = it->max_phys_descent;
20188 if (it->line_wrap == WORD_WRAP && it->area == TEXT_AREA)
20190 if (IT_DISPLAYING_WHITESPACE (it))
20191 may_wrap = 1;
20192 else if (may_wrap)
20194 SAVE_IT (wrap_it, *it, wrap_data);
20195 wrap_x = x;
20196 wrap_row_used = row->used[TEXT_AREA];
20197 wrap_row_ascent = row->ascent;
20198 wrap_row_height = row->height;
20199 wrap_row_phys_ascent = row->phys_ascent;
20200 wrap_row_phys_height = row->phys_height;
20201 wrap_row_extra_line_spacing = row->extra_line_spacing;
20202 wrap_row_min_pos = min_pos;
20203 wrap_row_min_bpos = min_bpos;
20204 wrap_row_max_pos = max_pos;
20205 wrap_row_max_bpos = max_bpos;
20206 may_wrap = 0;
20211 PRODUCE_GLYPHS (it);
20213 /* If this display element was in marginal areas, continue with
20214 the next one. */
20215 if (it->area != TEXT_AREA)
20217 row->ascent = max (row->ascent, it->max_ascent);
20218 row->height = max (row->height, it->max_ascent + it->max_descent);
20219 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20220 row->phys_height = max (row->phys_height,
20221 it->max_phys_ascent + it->max_phys_descent);
20222 row->extra_line_spacing = max (row->extra_line_spacing,
20223 it->max_extra_line_spacing);
20224 set_iterator_to_next (it, 1);
20225 /* If we didn't handle the line/wrap prefix above, and the
20226 call to set_iterator_to_next just switched to TEXT_AREA,
20227 process the prefix now. */
20228 if (it->area == TEXT_AREA && pending_handle_line_prefix)
20230 pending_handle_line_prefix = false;
20231 handle_line_prefix (it);
20233 continue;
20236 /* Does the display element fit on the line? If we truncate
20237 lines, we should draw past the right edge of the window. If
20238 we don't truncate, we want to stop so that we can display the
20239 continuation glyph before the right margin. If lines are
20240 continued, there are two possible strategies for characters
20241 resulting in more than 1 glyph (e.g. tabs): Display as many
20242 glyphs as possible in this line and leave the rest for the
20243 continuation line, or display the whole element in the next
20244 line. Original redisplay did the former, so we do it also. */
20245 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
20246 hpos_before = it->hpos;
20247 x_before = x;
20249 if (/* Not a newline. */
20250 nglyphs > 0
20251 /* Glyphs produced fit entirely in the line. */
20252 && it->current_x < it->last_visible_x)
20254 it->hpos += nglyphs;
20255 row->ascent = max (row->ascent, it->max_ascent);
20256 row->height = max (row->height, it->max_ascent + it->max_descent);
20257 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20258 row->phys_height = max (row->phys_height,
20259 it->max_phys_ascent + it->max_phys_descent);
20260 row->extra_line_spacing = max (row->extra_line_spacing,
20261 it->max_extra_line_spacing);
20262 if (it->current_x - it->pixel_width < it->first_visible_x
20263 /* In R2L rows, we arrange in extend_face_to_end_of_line
20264 to add a right offset to the line, by a suitable
20265 change to the stretch glyph that is the leftmost
20266 glyph of the line. */
20267 && !row->reversed_p)
20268 row->x = x - it->first_visible_x;
20269 /* Record the maximum and minimum buffer positions seen so
20270 far in glyphs that will be displayed by this row. */
20271 if (it->bidi_p)
20272 RECORD_MAX_MIN_POS (it);
20274 else
20276 int i, new_x;
20277 struct glyph *glyph;
20279 for (i = 0; i < nglyphs; ++i, x = new_x)
20281 /* Identify the glyphs added by the last call to
20282 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20283 the previous glyphs. */
20284 if (!row->reversed_p)
20285 glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
20286 else
20287 glyph = row->glyphs[TEXT_AREA] + nglyphs - 1 - i;
20288 new_x = x + glyph->pixel_width;
20290 if (/* Lines are continued. */
20291 it->line_wrap != TRUNCATE
20292 && (/* Glyph doesn't fit on the line. */
20293 new_x > it->last_visible_x
20294 /* Or it fits exactly on a window system frame. */
20295 || (new_x == it->last_visible_x
20296 && FRAME_WINDOW_P (it->f)
20297 && (row->reversed_p
20298 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20299 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)))))
20301 /* End of a continued line. */
20303 if (it->hpos == 0
20304 || (new_x == it->last_visible_x
20305 && FRAME_WINDOW_P (it->f)
20306 && (row->reversed_p
20307 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20308 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))))
20310 /* Current glyph is the only one on the line or
20311 fits exactly on the line. We must continue
20312 the line because we can't draw the cursor
20313 after the glyph. */
20314 row->continued_p = 1;
20315 it->current_x = new_x;
20316 it->continuation_lines_width += new_x;
20317 ++it->hpos;
20318 if (i == nglyphs - 1)
20320 /* If line-wrap is on, check if a previous
20321 wrap point was found. */
20322 if (wrap_row_used > 0
20323 /* Even if there is a previous wrap
20324 point, continue the line here as
20325 usual, if (i) the previous character
20326 was a space or tab AND (ii) the
20327 current character is not. */
20328 && (!may_wrap
20329 || IT_DISPLAYING_WHITESPACE (it)))
20330 goto back_to_wrap;
20332 /* Record the maximum and minimum buffer
20333 positions seen so far in glyphs that will be
20334 displayed by this row. */
20335 if (it->bidi_p)
20336 RECORD_MAX_MIN_POS (it);
20337 set_iterator_to_next (it, 1);
20338 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20340 if (!get_next_display_element (it))
20342 row->exact_window_width_line_p = 1;
20343 it->continuation_lines_width = 0;
20344 row->continued_p = 0;
20345 row->ends_at_zv_p = 1;
20347 else if (ITERATOR_AT_END_OF_LINE_P (it))
20349 row->continued_p = 0;
20350 row->exact_window_width_line_p = 1;
20354 else if (it->bidi_p)
20355 RECORD_MAX_MIN_POS (it);
20356 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20357 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20358 extend_face_to_end_of_line (it);
20360 else if (CHAR_GLYPH_PADDING_P (*glyph)
20361 && !FRAME_WINDOW_P (it->f))
20363 /* A padding glyph that doesn't fit on this line.
20364 This means the whole character doesn't fit
20365 on the line. */
20366 if (row->reversed_p)
20367 unproduce_glyphs (it, row->used[TEXT_AREA]
20368 - n_glyphs_before);
20369 row->used[TEXT_AREA] = n_glyphs_before;
20371 /* Fill the rest of the row with continuation
20372 glyphs like in 20.x. */
20373 while (row->glyphs[TEXT_AREA] + row->used[TEXT_AREA]
20374 < row->glyphs[1 + TEXT_AREA])
20375 produce_special_glyphs (it, IT_CONTINUATION);
20377 row->continued_p = 1;
20378 it->current_x = x_before;
20379 it->continuation_lines_width += x_before;
20381 /* Restore the height to what it was before the
20382 element not fitting on the line. */
20383 it->max_ascent = ascent;
20384 it->max_descent = descent;
20385 it->max_phys_ascent = phys_ascent;
20386 it->max_phys_descent = phys_descent;
20387 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20388 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20389 extend_face_to_end_of_line (it);
20391 else if (wrap_row_used > 0)
20393 back_to_wrap:
20394 if (row->reversed_p)
20395 unproduce_glyphs (it,
20396 row->used[TEXT_AREA] - wrap_row_used);
20397 RESTORE_IT (it, &wrap_it, wrap_data);
20398 it->continuation_lines_width += wrap_x;
20399 row->used[TEXT_AREA] = wrap_row_used;
20400 row->ascent = wrap_row_ascent;
20401 row->height = wrap_row_height;
20402 row->phys_ascent = wrap_row_phys_ascent;
20403 row->phys_height = wrap_row_phys_height;
20404 row->extra_line_spacing = wrap_row_extra_line_spacing;
20405 min_pos = wrap_row_min_pos;
20406 min_bpos = wrap_row_min_bpos;
20407 max_pos = wrap_row_max_pos;
20408 max_bpos = wrap_row_max_bpos;
20409 row->continued_p = 1;
20410 row->ends_at_zv_p = 0;
20411 row->exact_window_width_line_p = 0;
20412 it->continuation_lines_width += x;
20414 /* Make sure that a non-default face is extended
20415 up to the right margin of the window. */
20416 extend_face_to_end_of_line (it);
20418 else if (it->c == '\t' && FRAME_WINDOW_P (it->f))
20420 /* A TAB that extends past the right edge of the
20421 window. This produces a single glyph on
20422 window system frames. We leave the glyph in
20423 this row and let it fill the row, but don't
20424 consume the TAB. */
20425 if ((row->reversed_p
20426 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20427 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20428 produce_special_glyphs (it, IT_CONTINUATION);
20429 it->continuation_lines_width += it->last_visible_x;
20430 row->ends_in_middle_of_char_p = 1;
20431 row->continued_p = 1;
20432 glyph->pixel_width = it->last_visible_x - x;
20433 it->starts_in_middle_of_char_p = 1;
20434 if (WINDOW_LEFT_MARGIN_WIDTH (it->w) > 0
20435 || WINDOW_RIGHT_MARGIN_WIDTH (it->w) > 0)
20436 extend_face_to_end_of_line (it);
20438 else
20440 /* Something other than a TAB that draws past
20441 the right edge of the window. Restore
20442 positions to values before the element. */
20443 if (row->reversed_p)
20444 unproduce_glyphs (it, row->used[TEXT_AREA]
20445 - (n_glyphs_before + i));
20446 row->used[TEXT_AREA] = n_glyphs_before + i;
20448 /* Display continuation glyphs. */
20449 it->current_x = x_before;
20450 it->continuation_lines_width += x;
20451 if (!FRAME_WINDOW_P (it->f)
20452 || (row->reversed_p
20453 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20454 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20455 produce_special_glyphs (it, IT_CONTINUATION);
20456 row->continued_p = 1;
20458 extend_face_to_end_of_line (it);
20460 if (nglyphs > 1 && i > 0)
20462 row->ends_in_middle_of_char_p = 1;
20463 it->starts_in_middle_of_char_p = 1;
20466 /* Restore the height to what it was before the
20467 element not fitting on the line. */
20468 it->max_ascent = ascent;
20469 it->max_descent = descent;
20470 it->max_phys_ascent = phys_ascent;
20471 it->max_phys_descent = phys_descent;
20474 break;
20476 else if (new_x > it->first_visible_x)
20478 /* Increment number of glyphs actually displayed. */
20479 ++it->hpos;
20481 /* Record the maximum and minimum buffer positions
20482 seen so far in glyphs that will be displayed by
20483 this row. */
20484 if (it->bidi_p)
20485 RECORD_MAX_MIN_POS (it);
20487 if (x < it->first_visible_x && !row->reversed_p)
20488 /* Glyph is partially visible, i.e. row starts at
20489 negative X position. Don't do that in R2L
20490 rows, where we arrange to add a right offset to
20491 the line in extend_face_to_end_of_line, by a
20492 suitable change to the stretch glyph that is
20493 the leftmost glyph of the line. */
20494 row->x = x - it->first_visible_x;
20495 /* When the last glyph of an R2L row only fits
20496 partially on the line, we need to set row->x to a
20497 negative offset, so that the leftmost glyph is
20498 the one that is partially visible. But if we are
20499 going to produce the truncation glyph, this will
20500 be taken care of in produce_special_glyphs. */
20501 if (row->reversed_p
20502 && new_x > it->last_visible_x
20503 && !(it->line_wrap == TRUNCATE
20504 && WINDOW_LEFT_FRINGE_WIDTH (it->w) == 0))
20506 eassert (FRAME_WINDOW_P (it->f));
20507 row->x = it->last_visible_x - new_x;
20510 else
20512 /* Glyph is completely off the left margin of the
20513 window. This should not happen because of the
20514 move_it_in_display_line at the start of this
20515 function, unless the text display area of the
20516 window is empty. */
20517 eassert (it->first_visible_x <= it->last_visible_x);
20520 /* Even if this display element produced no glyphs at all,
20521 we want to record its position. */
20522 if (it->bidi_p && nglyphs == 0)
20523 RECORD_MAX_MIN_POS (it);
20525 row->ascent = max (row->ascent, it->max_ascent);
20526 row->height = max (row->height, it->max_ascent + it->max_descent);
20527 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
20528 row->phys_height = max (row->phys_height,
20529 it->max_phys_ascent + it->max_phys_descent);
20530 row->extra_line_spacing = max (row->extra_line_spacing,
20531 it->max_extra_line_spacing);
20533 /* End of this display line if row is continued. */
20534 if (row->continued_p || row->ends_at_zv_p)
20535 break;
20538 at_end_of_line:
20539 /* Is this a line end? If yes, we're also done, after making
20540 sure that a non-default face is extended up to the right
20541 margin of the window. */
20542 if (ITERATOR_AT_END_OF_LINE_P (it))
20544 int used_before = row->used[TEXT_AREA];
20546 row->ends_in_newline_from_string_p = STRINGP (it->object);
20548 /* Add a space at the end of the line that is used to
20549 display the cursor there. */
20550 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20551 append_space_for_newline (it, 0);
20553 /* Extend the face to the end of the line. */
20554 extend_face_to_end_of_line (it);
20556 /* Make sure we have the position. */
20557 if (used_before == 0)
20558 row->glyphs[TEXT_AREA]->charpos = CHARPOS (it->position);
20560 /* Record the position of the newline, for use in
20561 find_row_edges. */
20562 it->eol_pos = it->current.pos;
20564 /* Consume the line end. This skips over invisible lines. */
20565 set_iterator_to_next (it, 1);
20566 it->continuation_lines_width = 0;
20567 break;
20570 /* Proceed with next display element. Note that this skips
20571 over lines invisible because of selective display. */
20572 set_iterator_to_next (it, 1);
20574 /* If we truncate lines, we are done when the last displayed
20575 glyphs reach past the right margin of the window. */
20576 if (it->line_wrap == TRUNCATE
20577 && ((FRAME_WINDOW_P (it->f)
20578 /* Images are preprocessed in produce_image_glyph such
20579 that they are cropped at the right edge of the
20580 window, so an image glyph will always end exactly at
20581 last_visible_x, even if there's no right fringe. */
20582 && ((row->reversed_p
20583 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20584 : WINDOW_RIGHT_FRINGE_WIDTH (it->w))
20585 || it->what == IT_IMAGE))
20586 ? (it->current_x >= it->last_visible_x)
20587 : (it->current_x > it->last_visible_x)))
20589 /* Maybe add truncation glyphs. */
20590 if (!FRAME_WINDOW_P (it->f)
20591 || (row->reversed_p
20592 ? WINDOW_LEFT_FRINGE_WIDTH (it->w)
20593 : WINDOW_RIGHT_FRINGE_WIDTH (it->w)) == 0)
20595 int i, n;
20597 if (!row->reversed_p)
20599 for (i = row->used[TEXT_AREA] - 1; i > 0; --i)
20600 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20601 break;
20603 else
20605 for (i = 0; i < row->used[TEXT_AREA]; i++)
20606 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][i]))
20607 break;
20608 /* Remove any padding glyphs at the front of ROW, to
20609 make room for the truncation glyphs we will be
20610 adding below. The loop below always inserts at
20611 least one truncation glyph, so also remove the
20612 last glyph added to ROW. */
20613 unproduce_glyphs (it, i + 1);
20614 /* Adjust i for the loop below. */
20615 i = row->used[TEXT_AREA] - (i + 1);
20618 /* produce_special_glyphs overwrites the last glyph, so
20619 we don't want that if we want to keep that last
20620 glyph, which means it's an image. */
20621 if (it->current_x > it->last_visible_x)
20623 it->current_x = x_before;
20624 if (!FRAME_WINDOW_P (it->f))
20626 for (n = row->used[TEXT_AREA]; i < n; ++i)
20628 row->used[TEXT_AREA] = i;
20629 produce_special_glyphs (it, IT_TRUNCATION);
20632 else
20634 row->used[TEXT_AREA] = i;
20635 produce_special_glyphs (it, IT_TRUNCATION);
20637 it->hpos = hpos_before;
20640 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it))
20642 /* Don't truncate if we can overflow newline into fringe. */
20643 if (!get_next_display_element (it))
20645 it->continuation_lines_width = 0;
20646 row->ends_at_zv_p = 1;
20647 row->exact_window_width_line_p = 1;
20648 break;
20650 if (ITERATOR_AT_END_OF_LINE_P (it))
20652 row->exact_window_width_line_p = 1;
20653 goto at_end_of_line;
20655 it->current_x = x_before;
20656 it->hpos = hpos_before;
20659 row->truncated_on_right_p = 1;
20660 it->continuation_lines_width = 0;
20661 reseat_at_next_visible_line_start (it, 0);
20662 /* We insist below that IT's position be at ZV because in
20663 bidi-reordered lines the character at visible line start
20664 might not be the character that follows the newline in
20665 the logical order. */
20666 if (IT_BYTEPOS (*it) > BEG_BYTE)
20667 row->ends_at_zv_p =
20668 IT_BYTEPOS (*it) >= ZV_BYTE && FETCH_BYTE (ZV_BYTE - 1) != '\n';
20669 else
20670 row->ends_at_zv_p = false;
20671 break;
20675 if (wrap_data)
20676 bidi_unshelve_cache (wrap_data, 1);
20678 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20679 at the left window margin. */
20680 if (it->first_visible_x
20681 && IT_CHARPOS (*it) != CHARPOS (row->start.pos))
20683 if (!FRAME_WINDOW_P (it->f)
20684 || (((row->reversed_p
20685 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
20686 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
20687 /* Don't let insert_left_trunc_glyphs overwrite the
20688 first glyph of the row if it is an image. */
20689 && row->glyphs[TEXT_AREA]->type != IMAGE_GLYPH))
20690 insert_left_trunc_glyphs (it);
20691 row->truncated_on_left_p = 1;
20694 /* Remember the position at which this line ends.
20696 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20697 cannot be before the call to find_row_edges below, since that is
20698 where these positions are determined. */
20699 row->end = it->current;
20700 if (!it->bidi_p)
20702 row->minpos = row->start.pos;
20703 row->maxpos = row->end.pos;
20705 else
20707 /* ROW->minpos and ROW->maxpos must be the smallest and
20708 `1 + the largest' buffer positions in ROW. But if ROW was
20709 bidi-reordered, these two positions can be anywhere in the
20710 row, so we must determine them now. */
20711 find_row_edges (it, row, min_pos, min_bpos, max_pos, max_bpos);
20714 /* If the start of this line is the overlay arrow-position, then
20715 mark this glyph row as the one containing the overlay arrow.
20716 This is clearly a mess with variable size fonts. It would be
20717 better to let it be displayed like cursors under X. */
20718 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row) || !overlay_arrow_seen)
20719 && (overlay_arrow_string = overlay_arrow_at_row (it, row),
20720 !NILP (overlay_arrow_string)))
20722 /* Overlay arrow in window redisplay is a fringe bitmap. */
20723 if (STRINGP (overlay_arrow_string))
20725 struct glyph_row *arrow_row
20726 = get_overlay_arrow_glyph_row (it->w, overlay_arrow_string);
20727 struct glyph *glyph = arrow_row->glyphs[TEXT_AREA];
20728 struct glyph *arrow_end = glyph + arrow_row->used[TEXT_AREA];
20729 struct glyph *p = row->glyphs[TEXT_AREA];
20730 struct glyph *p2, *end;
20732 /* Copy the arrow glyphs. */
20733 while (glyph < arrow_end)
20734 *p++ = *glyph++;
20736 /* Throw away padding glyphs. */
20737 p2 = p;
20738 end = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA];
20739 while (p2 < end && CHAR_GLYPH_PADDING_P (*p2))
20740 ++p2;
20741 if (p2 > p)
20743 while (p2 < end)
20744 *p++ = *p2++;
20745 row->used[TEXT_AREA] = p2 - row->glyphs[TEXT_AREA];
20748 else
20750 eassert (INTEGERP (overlay_arrow_string));
20751 row->overlay_arrow_bitmap = XINT (overlay_arrow_string);
20753 overlay_arrow_seen = 1;
20756 /* Highlight trailing whitespace. */
20757 if (!NILP (Vshow_trailing_whitespace))
20758 highlight_trailing_whitespace (it->f, it->glyph_row);
20760 /* Compute pixel dimensions of this line. */
20761 compute_line_metrics (it);
20763 /* Implementation note: No changes in the glyphs of ROW or in their
20764 faces can be done past this point, because compute_line_metrics
20765 computes ROW's hash value and stores it within the glyph_row
20766 structure. */
20768 /* Record whether this row ends inside an ellipsis. */
20769 row->ends_in_ellipsis_p
20770 = (it->method == GET_FROM_DISPLAY_VECTOR
20771 && it->ellipsis_p);
20773 /* Save fringe bitmaps in this row. */
20774 row->left_user_fringe_bitmap = it->left_user_fringe_bitmap;
20775 row->left_user_fringe_face_id = it->left_user_fringe_face_id;
20776 row->right_user_fringe_bitmap = it->right_user_fringe_bitmap;
20777 row->right_user_fringe_face_id = it->right_user_fringe_face_id;
20779 it->left_user_fringe_bitmap = 0;
20780 it->left_user_fringe_face_id = 0;
20781 it->right_user_fringe_bitmap = 0;
20782 it->right_user_fringe_face_id = 0;
20784 /* Maybe set the cursor. */
20785 cvpos = it->w->cursor.vpos;
20786 if ((cvpos < 0
20787 /* In bidi-reordered rows, keep checking for proper cursor
20788 position even if one has been found already, because buffer
20789 positions in such rows change non-linearly with ROW->VPOS,
20790 when a line is continued. One exception: when we are at ZV,
20791 display cursor on the first suitable glyph row, since all
20792 the empty rows after that also have their position set to ZV. */
20793 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20794 lines' rows is implemented for bidi-reordered rows. */
20795 || (it->bidi_p
20796 && !MATRIX_ROW (it->w->desired_matrix, cvpos)->ends_at_zv_p))
20797 && PT >= MATRIX_ROW_START_CHARPOS (row)
20798 && PT <= MATRIX_ROW_END_CHARPOS (row)
20799 && cursor_row_p (row))
20800 set_cursor_from_row (it->w, row, it->w->desired_matrix, 0, 0, 0, 0);
20802 /* Prepare for the next line. This line starts horizontally at (X
20803 HPOS) = (0 0). Vertical positions are incremented. As a
20804 convenience for the caller, IT->glyph_row is set to the next
20805 row to be used. */
20806 it->current_x = it->hpos = 0;
20807 it->current_y += row->height;
20808 SET_TEXT_POS (it->eol_pos, 0, 0);
20809 ++it->vpos;
20810 ++it->glyph_row;
20811 /* The next row should by default use the same value of the
20812 reversed_p flag as this one. set_iterator_to_next decides when
20813 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20814 the flag accordingly. */
20815 if (it->glyph_row < MATRIX_BOTTOM_TEXT_ROW (it->w->desired_matrix, it->w))
20816 it->glyph_row->reversed_p = row->reversed_p;
20817 it->start = row->end;
20818 return MATRIX_ROW_DISPLAYS_TEXT_P (row);
20820 #undef RECORD_MAX_MIN_POS
20823 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction,
20824 Scurrent_bidi_paragraph_direction, 0, 1, 0,
20825 doc: /* Return paragraph direction at point in BUFFER.
20826 Value is either `left-to-right' or `right-to-left'.
20827 If BUFFER is omitted or nil, it defaults to the current buffer.
20829 Paragraph direction determines how the text in the paragraph is displayed.
20830 In left-to-right paragraphs, text begins at the left margin of the window
20831 and the reading direction is generally left to right. In right-to-left
20832 paragraphs, text begins at the right margin and is read from right to left.
20834 See also `bidi-paragraph-direction'. */)
20835 (Lisp_Object buffer)
20837 struct buffer *buf = current_buffer;
20838 struct buffer *old = buf;
20840 if (! NILP (buffer))
20842 CHECK_BUFFER (buffer);
20843 buf = XBUFFER (buffer);
20846 if (NILP (BVAR (buf, bidi_display_reordering))
20847 || NILP (BVAR (buf, enable_multibyte_characters))
20848 /* When we are loading loadup.el, the character property tables
20849 needed for bidi iteration are not yet available. */
20850 || !NILP (Vpurify_flag))
20851 return Qleft_to_right;
20852 else if (!NILP (BVAR (buf, bidi_paragraph_direction)))
20853 return BVAR (buf, bidi_paragraph_direction);
20854 else
20856 /* Determine the direction from buffer text. We could try to
20857 use current_matrix if it is up to date, but this seems fast
20858 enough as it is. */
20859 struct bidi_it itb;
20860 ptrdiff_t pos = BUF_PT (buf);
20861 ptrdiff_t bytepos = BUF_PT_BYTE (buf);
20862 int c;
20863 void *itb_data = bidi_shelve_cache ();
20865 set_buffer_temp (buf);
20866 /* bidi_paragraph_init finds the base direction of the paragraph
20867 by searching forward from paragraph start. We need the base
20868 direction of the current or _previous_ paragraph, so we need
20869 to make sure we are within that paragraph. To that end, find
20870 the previous non-empty line. */
20871 if (pos >= ZV && pos > BEGV)
20872 DEC_BOTH (pos, bytepos);
20873 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20874 pos, bytepos, ZV, ZV_BYTE, Qnil) > 0)
20876 while ((c = FETCH_BYTE (bytepos)) == '\n'
20877 || c == ' ' || c == '\t' || c == '\f')
20879 if (bytepos <= BEGV_BYTE)
20880 break;
20881 bytepos--;
20882 pos--;
20884 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos)))
20885 bytepos--;
20887 bidi_init_it (pos, bytepos, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb);
20888 itb.paragraph_dir = NEUTRAL_DIR;
20889 itb.string.s = NULL;
20890 itb.string.lstring = Qnil;
20891 itb.string.bufpos = 0;
20892 itb.string.from_disp_str = 0;
20893 itb.string.unibyte = 0;
20894 /* We have no window to use here for ignoring window-specific
20895 overlays. Using NULL for window pointer will cause
20896 compute_display_string_pos to use the current buffer. */
20897 itb.w = NULL;
20898 bidi_paragraph_init (NEUTRAL_DIR, &itb, 1);
20899 bidi_unshelve_cache (itb_data, 0);
20900 set_buffer_temp (old);
20901 switch (itb.paragraph_dir)
20903 case L2R:
20904 return Qleft_to_right;
20905 break;
20906 case R2L:
20907 return Qright_to_left;
20908 break;
20909 default:
20910 emacs_abort ();
20915 DEFUN ("move-point-visually", Fmove_point_visually,
20916 Smove_point_visually, 1, 1, 0,
20917 doc: /* Move point in the visual order in the specified DIRECTION.
20918 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20919 left.
20921 Value is the new character position of point. */)
20922 (Lisp_Object direction)
20924 struct window *w = XWINDOW (selected_window);
20925 struct buffer *b = XBUFFER (w->contents);
20926 struct glyph_row *row;
20927 int dir;
20928 Lisp_Object paragraph_dir;
20930 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20931 (!(ROW)->continued_p \
20932 && INTEGERP ((GLYPH)->object) \
20933 && (GLYPH)->type == CHAR_GLYPH \
20934 && (GLYPH)->u.ch == ' ' \
20935 && (GLYPH)->charpos >= 0 \
20936 && !(GLYPH)->avoid_cursor_p)
20938 CHECK_NUMBER (direction);
20939 dir = XINT (direction);
20940 if (dir > 0)
20941 dir = 1;
20942 else
20943 dir = -1;
20945 /* If current matrix is up-to-date, we can use the information
20946 recorded in the glyphs, at least as long as the goal is on the
20947 screen. */
20948 if (w->window_end_valid
20949 && !windows_or_buffers_changed
20950 && b
20951 && !b->clip_changed
20952 && !b->prevent_redisplay_optimizations_p
20953 && !window_outdated (w)
20954 /* We rely below on the cursor coordinates to be up to date, but
20955 we cannot trust them if some command moved point since the
20956 last complete redisplay. */
20957 && w->last_point == BUF_PT (b)
20958 && w->cursor.vpos >= 0
20959 && w->cursor.vpos < w->current_matrix->nrows
20960 && (row = MATRIX_ROW (w->current_matrix, w->cursor.vpos))->enabled_p)
20962 struct glyph *g = row->glyphs[TEXT_AREA];
20963 struct glyph *e = dir > 0 ? g + row->used[TEXT_AREA] : g - 1;
20964 struct glyph *gpt = g + w->cursor.hpos;
20966 for (g = gpt + dir; (dir > 0 ? g < e : g > e); g += dir)
20968 if (BUFFERP (g->object) && g->charpos != PT)
20970 SET_PT (g->charpos);
20971 w->cursor.vpos = -1;
20972 return make_number (PT);
20974 else if (!INTEGERP (g->object) && !EQ (g->object, gpt->object))
20976 ptrdiff_t new_pos;
20978 if (BUFFERP (gpt->object))
20980 new_pos = PT;
20981 if ((gpt->resolved_level - row->reversed_p) % 2 == 0)
20982 new_pos += (row->reversed_p ? -dir : dir);
20983 else
20984 new_pos -= (row->reversed_p ? -dir : dir);;
20986 else if (BUFFERP (g->object))
20987 new_pos = g->charpos;
20988 else
20989 break;
20990 SET_PT (new_pos);
20991 w->cursor.vpos = -1;
20992 return make_number (PT);
20994 else if (ROW_GLYPH_NEWLINE_P (row, g))
20996 /* Glyphs inserted at the end of a non-empty line for
20997 positioning the cursor have zero charpos, so we must
20998 deduce the value of point by other means. */
20999 if (g->charpos > 0)
21000 SET_PT (g->charpos);
21001 else if (row->ends_at_zv_p && PT != ZV)
21002 SET_PT (ZV);
21003 else if (PT != MATRIX_ROW_END_CHARPOS (row) - 1)
21004 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21005 else
21006 break;
21007 w->cursor.vpos = -1;
21008 return make_number (PT);
21011 if (g == e || INTEGERP (g->object))
21013 if (row->truncated_on_left_p || row->truncated_on_right_p)
21014 goto simulate_display;
21015 if (!row->reversed_p)
21016 row += dir;
21017 else
21018 row -= dir;
21019 if (row < MATRIX_FIRST_TEXT_ROW (w->current_matrix)
21020 || row > MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
21021 goto simulate_display;
21023 if (dir > 0)
21025 if (row->reversed_p && !row->continued_p)
21027 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21028 w->cursor.vpos = -1;
21029 return make_number (PT);
21031 g = row->glyphs[TEXT_AREA];
21032 e = g + row->used[TEXT_AREA];
21033 for ( ; g < e; g++)
21035 if (BUFFERP (g->object)
21036 /* Empty lines have only one glyph, which stands
21037 for the newline, and whose charpos is the
21038 buffer position of the newline. */
21039 || ROW_GLYPH_NEWLINE_P (row, g)
21040 /* When the buffer ends in a newline, the line at
21041 EOB also has one glyph, but its charpos is -1. */
21042 || (row->ends_at_zv_p
21043 && !row->reversed_p
21044 && INTEGERP (g->object)
21045 && g->type == CHAR_GLYPH
21046 && g->u.ch == ' '))
21048 if (g->charpos > 0)
21049 SET_PT (g->charpos);
21050 else if (!row->reversed_p
21051 && row->ends_at_zv_p
21052 && PT != ZV)
21053 SET_PT (ZV);
21054 else
21055 continue;
21056 w->cursor.vpos = -1;
21057 return make_number (PT);
21061 else
21063 if (!row->reversed_p && !row->continued_p)
21065 SET_PT (MATRIX_ROW_END_CHARPOS (row) - 1);
21066 w->cursor.vpos = -1;
21067 return make_number (PT);
21069 e = row->glyphs[TEXT_AREA];
21070 g = e + row->used[TEXT_AREA] - 1;
21071 for ( ; g >= e; g--)
21073 if (BUFFERP (g->object)
21074 || (ROW_GLYPH_NEWLINE_P (row, g)
21075 && g->charpos > 0)
21076 /* Empty R2L lines on GUI frames have the buffer
21077 position of the newline stored in the stretch
21078 glyph. */
21079 || g->type == STRETCH_GLYPH
21080 || (row->ends_at_zv_p
21081 && row->reversed_p
21082 && INTEGERP (g->object)
21083 && g->type == CHAR_GLYPH
21084 && g->u.ch == ' '))
21086 if (g->charpos > 0)
21087 SET_PT (g->charpos);
21088 else if (row->reversed_p
21089 && row->ends_at_zv_p
21090 && PT != ZV)
21091 SET_PT (ZV);
21092 else
21093 continue;
21094 w->cursor.vpos = -1;
21095 return make_number (PT);
21102 simulate_display:
21104 /* If we wind up here, we failed to move by using the glyphs, so we
21105 need to simulate display instead. */
21107 if (b)
21108 paragraph_dir = Fcurrent_bidi_paragraph_direction (w->contents);
21109 else
21110 paragraph_dir = Qleft_to_right;
21111 if (EQ (paragraph_dir, Qright_to_left))
21112 dir = -dir;
21113 if (PT <= BEGV && dir < 0)
21114 xsignal0 (Qbeginning_of_buffer);
21115 else if (PT >= ZV && dir > 0)
21116 xsignal0 (Qend_of_buffer);
21117 else
21119 struct text_pos pt;
21120 struct it it;
21121 int pt_x, target_x, pixel_width, pt_vpos;
21122 bool at_eol_p;
21123 bool overshoot_expected = false;
21124 bool target_is_eol_p = false;
21126 /* Setup the arena. */
21127 SET_TEXT_POS (pt, PT, PT_BYTE);
21128 start_display (&it, w, pt);
21130 if (it.cmp_it.id < 0
21131 && it.method == GET_FROM_STRING
21132 && it.area == TEXT_AREA
21133 && it.string_from_display_prop_p
21134 && (it.sp > 0 && it.stack[it.sp - 1].method == GET_FROM_BUFFER))
21135 overshoot_expected = true;
21137 /* Find the X coordinate of point. We start from the beginning
21138 of this or previous line to make sure we are before point in
21139 the logical order (since the move_it_* functions can only
21140 move forward). */
21141 reseat:
21142 reseat_at_previous_visible_line_start (&it);
21143 it.current_x = it.hpos = it.current_y = it.vpos = 0;
21144 if (IT_CHARPOS (it) != PT)
21146 move_it_to (&it, overshoot_expected ? PT - 1 : PT,
21147 -1, -1, -1, MOVE_TO_POS);
21148 /* If we missed point because the character there is
21149 displayed out of a display vector that has more than one
21150 glyph, retry expecting overshoot. */
21151 if (it.method == GET_FROM_DISPLAY_VECTOR
21152 && it.current.dpvec_index > 0
21153 && !overshoot_expected)
21155 overshoot_expected = true;
21156 goto reseat;
21158 else if (IT_CHARPOS (it) != PT && !overshoot_expected)
21159 move_it_in_display_line (&it, PT, -1, MOVE_TO_POS);
21161 pt_x = it.current_x;
21162 pt_vpos = it.vpos;
21163 if (dir > 0 || overshoot_expected)
21165 struct glyph_row *row = it.glyph_row;
21167 /* When point is at beginning of line, we don't have
21168 information about the glyph there loaded into struct
21169 it. Calling get_next_display_element fixes that. */
21170 if (pt_x == 0)
21171 get_next_display_element (&it);
21172 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21173 it.glyph_row = NULL;
21174 PRODUCE_GLYPHS (&it); /* compute it.pixel_width */
21175 it.glyph_row = row;
21176 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21177 it, lest it will become out of sync with it's buffer
21178 position. */
21179 it.current_x = pt_x;
21181 else
21182 at_eol_p = ITERATOR_AT_END_OF_LINE_P (&it);
21183 pixel_width = it.pixel_width;
21184 if (overshoot_expected && at_eol_p)
21185 pixel_width = 0;
21186 else if (pixel_width <= 0)
21187 pixel_width = 1;
21189 /* If there's a display string (or something similar) at point,
21190 we are actually at the glyph to the left of point, so we need
21191 to correct the X coordinate. */
21192 if (overshoot_expected)
21194 if (it.bidi_p)
21195 pt_x += pixel_width * it.bidi_it.scan_dir;
21196 else
21197 pt_x += pixel_width;
21200 /* Compute target X coordinate, either to the left or to the
21201 right of point. On TTY frames, all characters have the same
21202 pixel width of 1, so we can use that. On GUI frames we don't
21203 have an easy way of getting at the pixel width of the
21204 character to the left of point, so we use a different method
21205 of getting to that place. */
21206 if (dir > 0)
21207 target_x = pt_x + pixel_width;
21208 else
21209 target_x = pt_x - (!FRAME_WINDOW_P (it.f)) * pixel_width;
21211 /* Target X coordinate could be one line above or below the line
21212 of point, in which case we need to adjust the target X
21213 coordinate. Also, if moving to the left, we need to begin at
21214 the left edge of the point's screen line. */
21215 if (dir < 0)
21217 if (pt_x > 0)
21219 start_display (&it, w, pt);
21220 reseat_at_previous_visible_line_start (&it);
21221 it.current_x = it.current_y = it.hpos = 0;
21222 if (pt_vpos != 0)
21223 move_it_by_lines (&it, pt_vpos);
21225 else
21227 move_it_by_lines (&it, -1);
21228 target_x = it.last_visible_x - !FRAME_WINDOW_P (it.f);
21229 target_is_eol_p = true;
21230 /* Under word-wrap, we don't know the x coordinate of
21231 the last character displayed on the previous line,
21232 which immediately precedes the wrap point. To find
21233 out its x coordinate, we try moving to the right
21234 margin of the window, which will stop at the wrap
21235 point, and then reset target_x to point at the
21236 character that precedes the wrap point. This is not
21237 needed on GUI frames, because (see below) there we
21238 move from the left margin one grapheme cluster at a
21239 time, and stop when we hit the wrap point. */
21240 if (!FRAME_WINDOW_P (it.f) && it.line_wrap == WORD_WRAP)
21242 void *it_data = NULL;
21243 struct it it2;
21245 SAVE_IT (it2, it, it_data);
21246 move_it_in_display_line_to (&it, ZV, target_x,
21247 MOVE_TO_POS | MOVE_TO_X);
21248 /* If we arrived at target_x, that _is_ the last
21249 character on the previous line. */
21250 if (it.current_x != target_x)
21251 target_x = it.current_x - 1;
21252 RESTORE_IT (&it, &it2, it_data);
21256 else
21258 if (at_eol_p
21259 || (target_x >= it.last_visible_x
21260 && it.line_wrap != TRUNCATE))
21262 if (pt_x > 0)
21263 move_it_by_lines (&it, 0);
21264 move_it_by_lines (&it, 1);
21265 target_x = 0;
21269 /* Move to the target X coordinate. */
21270 #ifdef HAVE_WINDOW_SYSTEM
21271 /* On GUI frames, as we don't know the X coordinate of the
21272 character to the left of point, moving point to the left
21273 requires walking, one grapheme cluster at a time, until we
21274 find ourself at a place immediately to the left of the
21275 character at point. */
21276 if (FRAME_WINDOW_P (it.f) && dir < 0)
21278 struct text_pos new_pos;
21279 enum move_it_result rc = MOVE_X_REACHED;
21281 if (it.current_x == 0)
21282 get_next_display_element (&it);
21283 if (it.what == IT_COMPOSITION)
21285 new_pos.charpos = it.cmp_it.charpos;
21286 new_pos.bytepos = -1;
21288 else
21289 new_pos = it.current.pos;
21291 while (it.current_x + it.pixel_width <= target_x
21292 && (rc == MOVE_X_REACHED
21293 /* Under word-wrap, move_it_in_display_line_to
21294 stops at correct coordinates, but sometimes
21295 returns MOVE_POS_MATCH_OR_ZV. */
21296 || (it.line_wrap == WORD_WRAP
21297 && rc == MOVE_POS_MATCH_OR_ZV)))
21299 int new_x = it.current_x + it.pixel_width;
21301 /* For composed characters, we want the position of the
21302 first character in the grapheme cluster (usually, the
21303 composition's base character), whereas it.current
21304 might give us the position of the _last_ one, e.g. if
21305 the composition is rendered in reverse due to bidi
21306 reordering. */
21307 if (it.what == IT_COMPOSITION)
21309 new_pos.charpos = it.cmp_it.charpos;
21310 new_pos.bytepos = -1;
21312 else
21313 new_pos = it.current.pos;
21314 if (new_x == it.current_x)
21315 new_x++;
21316 rc = move_it_in_display_line_to (&it, ZV, new_x,
21317 MOVE_TO_POS | MOVE_TO_X);
21318 if (ITERATOR_AT_END_OF_LINE_P (&it) && !target_is_eol_p)
21319 break;
21321 /* The previous position we saw in the loop is the one we
21322 want. */
21323 if (new_pos.bytepos == -1)
21324 new_pos.bytepos = CHAR_TO_BYTE (new_pos.charpos);
21325 it.current.pos = new_pos;
21327 else
21328 #endif
21329 if (it.current_x != target_x)
21330 move_it_in_display_line_to (&it, ZV, target_x, MOVE_TO_POS | MOVE_TO_X);
21332 /* When lines are truncated, the above loop will stop at the
21333 window edge. But we want to get to the end of line, even if
21334 it is beyond the window edge; automatic hscroll will then
21335 scroll the window to show point as appropriate. */
21336 if (target_is_eol_p && it.line_wrap == TRUNCATE
21337 && get_next_display_element (&it))
21339 struct text_pos new_pos = it.current.pos;
21341 while (!ITERATOR_AT_END_OF_LINE_P (&it))
21343 set_iterator_to_next (&it, 0);
21344 if (it.method == GET_FROM_BUFFER)
21345 new_pos = it.current.pos;
21346 if (!get_next_display_element (&it))
21347 break;
21350 it.current.pos = new_pos;
21353 /* If we ended up in a display string that covers point, move to
21354 buffer position to the right in the visual order. */
21355 if (dir > 0)
21357 while (IT_CHARPOS (it) == PT)
21359 set_iterator_to_next (&it, 0);
21360 if (!get_next_display_element (&it))
21361 break;
21365 /* Move point to that position. */
21366 SET_PT_BOTH (IT_CHARPOS (it), IT_BYTEPOS (it));
21369 return make_number (PT);
21371 #undef ROW_GLYPH_NEWLINE_P
21375 /***********************************************************************
21376 Menu Bar
21377 ***********************************************************************/
21379 /* Redisplay the menu bar in the frame for window W.
21381 The menu bar of X frames that don't have X toolkit support is
21382 displayed in a special window W->frame->menu_bar_window.
21384 The menu bar of terminal frames is treated specially as far as
21385 glyph matrices are concerned. Menu bar lines are not part of
21386 windows, so the update is done directly on the frame matrix rows
21387 for the menu bar. */
21389 static void
21390 display_menu_bar (struct window *w)
21392 struct frame *f = XFRAME (WINDOW_FRAME (w));
21393 struct it it;
21394 Lisp_Object items;
21395 int i;
21397 /* Don't do all this for graphical frames. */
21398 #ifdef HAVE_NTGUI
21399 if (FRAME_W32_P (f))
21400 return;
21401 #endif
21402 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21403 if (FRAME_X_P (f))
21404 return;
21405 #endif
21407 #ifdef HAVE_NS
21408 if (FRAME_NS_P (f))
21409 return;
21410 #endif /* HAVE_NS */
21412 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21413 eassert (!FRAME_WINDOW_P (f));
21414 init_iterator (&it, w, -1, -1, f->desired_matrix->rows, MENU_FACE_ID);
21415 it.first_visible_x = 0;
21416 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21417 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21418 if (FRAME_WINDOW_P (f))
21420 /* Menu bar lines are displayed in the desired matrix of the
21421 dummy window menu_bar_window. */
21422 struct window *menu_w;
21423 menu_w = XWINDOW (f->menu_bar_window);
21424 init_iterator (&it, menu_w, -1, -1, menu_w->desired_matrix->rows,
21425 MENU_FACE_ID);
21426 it.first_visible_x = 0;
21427 it.last_visible_x = FRAME_PIXEL_WIDTH (f);
21429 else
21430 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21432 /* This is a TTY frame, i.e. character hpos/vpos are used as
21433 pixel x/y. */
21434 init_iterator (&it, w, -1, -1, f->desired_matrix->rows,
21435 MENU_FACE_ID);
21436 it.first_visible_x = 0;
21437 it.last_visible_x = FRAME_COLS (f);
21440 /* FIXME: This should be controlled by a user option. See the
21441 comments in redisplay_tool_bar and display_mode_line about
21442 this. */
21443 it.paragraph_embedding = L2R;
21445 /* Clear all rows of the menu bar. */
21446 for (i = 0; i < FRAME_MENU_BAR_LINES (f); ++i)
21448 struct glyph_row *row = it.glyph_row + i;
21449 clear_glyph_row (row);
21450 row->enabled_p = true;
21451 row->full_width_p = 1;
21454 /* Display all items of the menu bar. */
21455 items = FRAME_MENU_BAR_ITEMS (it.f);
21456 for (i = 0; i < ASIZE (items); i += 4)
21458 Lisp_Object string;
21460 /* Stop at nil string. */
21461 string = AREF (items, i + 1);
21462 if (NILP (string))
21463 break;
21465 /* Remember where item was displayed. */
21466 ASET (items, i + 3, make_number (it.hpos));
21468 /* Display the item, pad with one space. */
21469 if (it.current_x < it.last_visible_x)
21470 display_string (NULL, string, Qnil, 0, 0, &it,
21471 SCHARS (string) + 1, 0, 0, -1);
21474 /* Fill out the line with spaces. */
21475 if (it.current_x < it.last_visible_x)
21476 display_string ("", Qnil, Qnil, 0, 0, &it, -1, 0, 0, -1);
21478 /* Compute the total height of the lines. */
21479 compute_line_metrics (&it);
21482 /* Deep copy of a glyph row, including the glyphs. */
21483 static void
21484 deep_copy_glyph_row (struct glyph_row *to, struct glyph_row *from)
21486 struct glyph *pointers[1 + LAST_AREA];
21487 int to_used = to->used[TEXT_AREA];
21489 /* Save glyph pointers of TO. */
21490 memcpy (pointers, to->glyphs, sizeof to->glyphs);
21492 /* Do a structure assignment. */
21493 *to = *from;
21495 /* Restore original glyph pointers of TO. */
21496 memcpy (to->glyphs, pointers, sizeof to->glyphs);
21498 /* Copy the glyphs. */
21499 memcpy (to->glyphs[TEXT_AREA], from->glyphs[TEXT_AREA],
21500 min (from->used[TEXT_AREA], to_used) * sizeof (struct glyph));
21502 /* If we filled only part of the TO row, fill the rest with
21503 space_glyph (which will display as empty space). */
21504 if (to_used > from->used[TEXT_AREA])
21505 fill_up_frame_row_with_spaces (to, to_used);
21508 /* Display one menu item on a TTY, by overwriting the glyphs in the
21509 frame F's desired glyph matrix with glyphs produced from the menu
21510 item text. Called from term.c to display TTY drop-down menus one
21511 item at a time.
21513 ITEM_TEXT is the menu item text as a C string.
21515 FACE_ID is the face ID to be used for this menu item. FACE_ID
21516 could specify one of 3 faces: a face for an enabled item, a face
21517 for a disabled item, or a face for a selected item.
21519 X and Y are coordinates of the first glyph in the frame's desired
21520 matrix to be overwritten by the menu item. Since this is a TTY, Y
21521 is the zero-based number of the glyph row and X is the zero-based
21522 glyph number in the row, starting from left, where to start
21523 displaying the item.
21525 SUBMENU non-zero means this menu item drops down a submenu, which
21526 should be indicated by displaying a proper visual cue after the
21527 item text. */
21529 void
21530 display_tty_menu_item (const char *item_text, int width, int face_id,
21531 int x, int y, int submenu)
21533 struct it it;
21534 struct frame *f = SELECTED_FRAME ();
21535 struct window *w = XWINDOW (f->selected_window);
21536 int saved_used, saved_truncated, saved_width, saved_reversed;
21537 struct glyph_row *row;
21538 size_t item_len = strlen (item_text);
21540 eassert (FRAME_TERMCAP_P (f));
21542 /* Don't write beyond the matrix's last row. This can happen for
21543 TTY screens that are not high enough to show the entire menu.
21544 (This is actually a bit of defensive programming, as
21545 tty_menu_display already limits the number of menu items to one
21546 less than the number of screen lines.) */
21547 if (y >= f->desired_matrix->nrows)
21548 return;
21550 init_iterator (&it, w, -1, -1, f->desired_matrix->rows + y, MENU_FACE_ID);
21551 it.first_visible_x = 0;
21552 it.last_visible_x = FRAME_COLS (f) - 1;
21553 row = it.glyph_row;
21554 /* Start with the row contents from the current matrix. */
21555 deep_copy_glyph_row (row, f->current_matrix->rows + y);
21556 saved_width = row->full_width_p;
21557 row->full_width_p = 1;
21558 saved_reversed = row->reversed_p;
21559 row->reversed_p = 0;
21560 row->enabled_p = true;
21562 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21563 desired face. */
21564 eassert (x < f->desired_matrix->matrix_w);
21565 it.current_x = it.hpos = x;
21566 it.current_y = it.vpos = y;
21567 saved_used = row->used[TEXT_AREA];
21568 saved_truncated = row->truncated_on_right_p;
21569 row->used[TEXT_AREA] = x;
21570 it.face_id = face_id;
21571 it.line_wrap = TRUNCATE;
21573 /* FIXME: This should be controlled by a user option. See the
21574 comments in redisplay_tool_bar and display_mode_line about this.
21575 Also, if paragraph_embedding could ever be R2L, changes will be
21576 needed to avoid shifting to the right the row characters in
21577 term.c:append_glyph. */
21578 it.paragraph_embedding = L2R;
21580 /* Pad with a space on the left. */
21581 display_string (" ", Qnil, Qnil, 0, 0, &it, 1, 0, FRAME_COLS (f) - 1, -1);
21582 width--;
21583 /* Display the menu item, pad with spaces to WIDTH. */
21584 if (submenu)
21586 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21587 item_len, 0, FRAME_COLS (f) - 1, -1);
21588 width -= item_len;
21589 /* Indicate with " >" that there's a submenu. */
21590 display_string (" >", Qnil, Qnil, 0, 0, &it, width, 0,
21591 FRAME_COLS (f) - 1, -1);
21593 else
21594 display_string (item_text, Qnil, Qnil, 0, 0, &it,
21595 width, 0, FRAME_COLS (f) - 1, -1);
21597 row->used[TEXT_AREA] = max (saved_used, row->used[TEXT_AREA]);
21598 row->truncated_on_right_p = saved_truncated;
21599 row->hash = row_hash (row);
21600 row->full_width_p = saved_width;
21601 row->reversed_p = saved_reversed;
21604 /***********************************************************************
21605 Mode Line
21606 ***********************************************************************/
21608 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21609 FORCE is non-zero, redisplay mode lines unconditionally.
21610 Otherwise, redisplay only mode lines that are garbaged. Value is
21611 the number of windows whose mode lines were redisplayed. */
21613 static int
21614 redisplay_mode_lines (Lisp_Object window, bool force)
21616 int nwindows = 0;
21618 while (!NILP (window))
21620 struct window *w = XWINDOW (window);
21622 if (WINDOWP (w->contents))
21623 nwindows += redisplay_mode_lines (w->contents, force);
21624 else if (force
21625 || FRAME_GARBAGED_P (XFRAME (w->frame))
21626 || !MATRIX_MODE_LINE_ROW (w->current_matrix)->enabled_p)
21628 struct text_pos lpoint;
21629 struct buffer *old = current_buffer;
21631 /* Set the window's buffer for the mode line display. */
21632 SET_TEXT_POS (lpoint, PT, PT_BYTE);
21633 set_buffer_internal_1 (XBUFFER (w->contents));
21635 /* Point refers normally to the selected window. For any
21636 other window, set up appropriate value. */
21637 if (!EQ (window, selected_window))
21639 struct text_pos pt;
21641 CLIP_TEXT_POS_FROM_MARKER (pt, w->pointm);
21642 TEMP_SET_PT_BOTH (CHARPOS (pt), BYTEPOS (pt));
21645 /* Display mode lines. */
21646 clear_glyph_matrix (w->desired_matrix);
21647 if (display_mode_lines (w))
21648 ++nwindows;
21650 /* Restore old settings. */
21651 set_buffer_internal_1 (old);
21652 TEMP_SET_PT_BOTH (CHARPOS (lpoint), BYTEPOS (lpoint));
21655 window = w->next;
21658 return nwindows;
21662 /* Display the mode and/or header line of window W. Value is the
21663 sum number of mode lines and header lines displayed. */
21665 static int
21666 display_mode_lines (struct window *w)
21668 Lisp_Object old_selected_window = selected_window;
21669 Lisp_Object old_selected_frame = selected_frame;
21670 Lisp_Object new_frame = w->frame;
21671 Lisp_Object old_frame_selected_window = XFRAME (new_frame)->selected_window;
21672 int n = 0;
21674 selected_frame = new_frame;
21675 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21676 or window's point, then we'd need select_window_1 here as well. */
21677 XSETWINDOW (selected_window, w);
21678 XFRAME (new_frame)->selected_window = selected_window;
21680 /* These will be set while the mode line specs are processed. */
21681 line_number_displayed = 0;
21682 w->column_number_displayed = -1;
21684 if (WINDOW_WANTS_MODELINE_P (w))
21686 struct window *sel_w = XWINDOW (old_selected_window);
21688 /* Select mode line face based on the real selected window. */
21689 display_mode_line (w, CURRENT_MODE_LINE_FACE_ID_3 (sel_w, sel_w, w),
21690 BVAR (current_buffer, mode_line_format));
21691 ++n;
21694 if (WINDOW_WANTS_HEADER_LINE_P (w))
21696 display_mode_line (w, HEADER_LINE_FACE_ID,
21697 BVAR (current_buffer, header_line_format));
21698 ++n;
21701 XFRAME (new_frame)->selected_window = old_frame_selected_window;
21702 selected_frame = old_selected_frame;
21703 selected_window = old_selected_window;
21704 if (n > 0)
21705 w->must_be_updated_p = true;
21706 return n;
21710 /* Display mode or header line of window W. FACE_ID specifies which
21711 line to display; it is either MODE_LINE_FACE_ID or
21712 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21713 display. Value is the pixel height of the mode/header line
21714 displayed. */
21716 static int
21717 display_mode_line (struct window *w, enum face_id face_id, Lisp_Object format)
21719 struct it it;
21720 struct face *face;
21721 ptrdiff_t count = SPECPDL_INDEX ();
21723 init_iterator (&it, w, -1, -1, NULL, face_id);
21724 /* Don't extend on a previously drawn mode-line.
21725 This may happen if called from pos_visible_p. */
21726 it.glyph_row->enabled_p = false;
21727 prepare_desired_row (w, it.glyph_row, true);
21729 it.glyph_row->mode_line_p = 1;
21731 /* FIXME: This should be controlled by a user option. But
21732 supporting such an option is not trivial, since the mode line is
21733 made up of many separate strings. */
21734 it.paragraph_embedding = L2R;
21736 record_unwind_protect (unwind_format_mode_line,
21737 format_mode_line_unwind_data (NULL, NULL, Qnil, 0));
21739 mode_line_target = MODE_LINE_DISPLAY;
21741 /* Temporarily make frame's keyboard the current kboard so that
21742 kboard-local variables in the mode_line_format will get the right
21743 values. */
21744 push_kboard (FRAME_KBOARD (it.f));
21745 record_unwind_save_match_data ();
21746 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
21747 pop_kboard ();
21749 unbind_to (count, Qnil);
21751 /* Fill up with spaces. */
21752 display_string (" ", Qnil, Qnil, 0, 0, &it, 10000, -1, -1, 0);
21754 compute_line_metrics (&it);
21755 it.glyph_row->full_width_p = 1;
21756 it.glyph_row->continued_p = 0;
21757 it.glyph_row->truncated_on_left_p = 0;
21758 it.glyph_row->truncated_on_right_p = 0;
21760 /* Make a 3D mode-line have a shadow at its right end. */
21761 face = FACE_FROM_ID (it.f, face_id);
21762 extend_face_to_end_of_line (&it);
21763 if (face->box != FACE_NO_BOX)
21765 struct glyph *last = (it.glyph_row->glyphs[TEXT_AREA]
21766 + it.glyph_row->used[TEXT_AREA] - 1);
21767 last->right_box_line_p = 1;
21770 return it.glyph_row->height;
21773 /* Move element ELT in LIST to the front of LIST.
21774 Return the updated list. */
21776 static Lisp_Object
21777 move_elt_to_front (Lisp_Object elt, Lisp_Object list)
21779 register Lisp_Object tail, prev;
21780 register Lisp_Object tem;
21782 tail = list;
21783 prev = Qnil;
21784 while (CONSP (tail))
21786 tem = XCAR (tail);
21788 if (EQ (elt, tem))
21790 /* Splice out the link TAIL. */
21791 if (NILP (prev))
21792 list = XCDR (tail);
21793 else
21794 Fsetcdr (prev, XCDR (tail));
21796 /* Now make it the first. */
21797 Fsetcdr (tail, list);
21798 return tail;
21800 else
21801 prev = tail;
21802 tail = XCDR (tail);
21803 QUIT;
21806 /* Not found--return unchanged LIST. */
21807 return list;
21810 /* Contribute ELT to the mode line for window IT->w. How it
21811 translates into text depends on its data type.
21813 IT describes the display environment in which we display, as usual.
21815 DEPTH is the depth in recursion. It is used to prevent
21816 infinite recursion here.
21818 FIELD_WIDTH is the number of characters the display of ELT should
21819 occupy in the mode line, and PRECISION is the maximum number of
21820 characters to display from ELT's representation. See
21821 display_string for details.
21823 Returns the hpos of the end of the text generated by ELT.
21825 PROPS is a property list to add to any string we encounter.
21827 If RISKY is nonzero, remove (disregard) any properties in any string
21828 we encounter, and ignore :eval and :propertize.
21830 The global variable `mode_line_target' determines whether the
21831 output is passed to `store_mode_line_noprop',
21832 `store_mode_line_string', or `display_string'. */
21834 static int
21835 display_mode_element (struct it *it, int depth, int field_width, int precision,
21836 Lisp_Object elt, Lisp_Object props, int risky)
21838 int n = 0, field, prec;
21839 int literal = 0;
21841 tail_recurse:
21842 if (depth > 100)
21843 elt = build_string ("*too-deep*");
21845 depth++;
21847 switch (XTYPE (elt))
21849 case Lisp_String:
21851 /* A string: output it and check for %-constructs within it. */
21852 unsigned char c;
21853 ptrdiff_t offset = 0;
21855 if (SCHARS (elt) > 0
21856 && (!NILP (props) || risky))
21858 Lisp_Object oprops, aelt;
21859 oprops = Ftext_properties_at (make_number (0), elt);
21861 /* If the starting string's properties are not what
21862 we want, translate the string. Also, if the string
21863 is risky, do that anyway. */
21865 if (NILP (Fequal (props, oprops)) || risky)
21867 /* If the starting string has properties,
21868 merge the specified ones onto the existing ones. */
21869 if (! NILP (oprops) && !risky)
21871 Lisp_Object tem;
21873 oprops = Fcopy_sequence (oprops);
21874 tem = props;
21875 while (CONSP (tem))
21877 oprops = Fplist_put (oprops, XCAR (tem),
21878 XCAR (XCDR (tem)));
21879 tem = XCDR (XCDR (tem));
21881 props = oprops;
21884 aelt = Fassoc (elt, mode_line_proptrans_alist);
21885 if (! NILP (aelt) && !NILP (Fequal (props, XCDR (aelt))))
21887 /* AELT is what we want. Move it to the front
21888 without consing. */
21889 elt = XCAR (aelt);
21890 mode_line_proptrans_alist
21891 = move_elt_to_front (aelt, mode_line_proptrans_alist);
21893 else
21895 Lisp_Object tem;
21897 /* If AELT has the wrong props, it is useless.
21898 so get rid of it. */
21899 if (! NILP (aelt))
21900 mode_line_proptrans_alist
21901 = Fdelq (aelt, mode_line_proptrans_alist);
21903 elt = Fcopy_sequence (elt);
21904 Fset_text_properties (make_number (0), Flength (elt),
21905 props, elt);
21906 /* Add this item to mode_line_proptrans_alist. */
21907 mode_line_proptrans_alist
21908 = Fcons (Fcons (elt, props),
21909 mode_line_proptrans_alist);
21910 /* Truncate mode_line_proptrans_alist
21911 to at most 50 elements. */
21912 tem = Fnthcdr (make_number (50),
21913 mode_line_proptrans_alist);
21914 if (! NILP (tem))
21915 XSETCDR (tem, Qnil);
21920 offset = 0;
21922 if (literal)
21924 prec = precision - n;
21925 switch (mode_line_target)
21927 case MODE_LINE_NOPROP:
21928 case MODE_LINE_TITLE:
21929 n += store_mode_line_noprop (SSDATA (elt), -1, prec);
21930 break;
21931 case MODE_LINE_STRING:
21932 n += store_mode_line_string (NULL, elt, 1, 0, prec, Qnil);
21933 break;
21934 case MODE_LINE_DISPLAY:
21935 n += display_string (NULL, elt, Qnil, 0, 0, it,
21936 0, prec, 0, STRING_MULTIBYTE (elt));
21937 break;
21940 break;
21943 /* Handle the non-literal case. */
21945 while ((precision <= 0 || n < precision)
21946 && SREF (elt, offset) != 0
21947 && (mode_line_target != MODE_LINE_DISPLAY
21948 || it->current_x < it->last_visible_x))
21950 ptrdiff_t last_offset = offset;
21952 /* Advance to end of string or next format specifier. */
21953 while ((c = SREF (elt, offset++)) != '\0' && c != '%')
21956 if (offset - 1 != last_offset)
21958 ptrdiff_t nchars, nbytes;
21960 /* Output to end of string or up to '%'. Field width
21961 is length of string. Don't output more than
21962 PRECISION allows us. */
21963 offset--;
21965 prec = c_string_width (SDATA (elt) + last_offset,
21966 offset - last_offset, precision - n,
21967 &nchars, &nbytes);
21969 switch (mode_line_target)
21971 case MODE_LINE_NOPROP:
21972 case MODE_LINE_TITLE:
21973 n += store_mode_line_noprop (SSDATA (elt) + last_offset, 0, prec);
21974 break;
21975 case MODE_LINE_STRING:
21977 ptrdiff_t bytepos = last_offset;
21978 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
21979 ptrdiff_t endpos = (precision <= 0
21980 ? string_byte_to_char (elt, offset)
21981 : charpos + nchars);
21983 n += store_mode_line_string (NULL,
21984 Fsubstring (elt, make_number (charpos),
21985 make_number (endpos)),
21986 0, 0, 0, Qnil);
21988 break;
21989 case MODE_LINE_DISPLAY:
21991 ptrdiff_t bytepos = last_offset;
21992 ptrdiff_t charpos = string_byte_to_char (elt, bytepos);
21994 if (precision <= 0)
21995 nchars = string_byte_to_char (elt, offset) - charpos;
21996 n += display_string (NULL, elt, Qnil, 0, charpos,
21997 it, 0, nchars, 0,
21998 STRING_MULTIBYTE (elt));
22000 break;
22003 else /* c == '%' */
22005 ptrdiff_t percent_position = offset;
22007 /* Get the specified minimum width. Zero means
22008 don't pad. */
22009 field = 0;
22010 while ((c = SREF (elt, offset++)) >= '0' && c <= '9')
22011 field = field * 10 + c - '0';
22013 /* Don't pad beyond the total padding allowed. */
22014 if (field_width - n > 0 && field > field_width - n)
22015 field = field_width - n;
22017 /* Note that either PRECISION <= 0 or N < PRECISION. */
22018 prec = precision - n;
22020 if (c == 'M')
22021 n += display_mode_element (it, depth, field, prec,
22022 Vglobal_mode_string, props,
22023 risky);
22024 else if (c != 0)
22026 bool multibyte;
22027 ptrdiff_t bytepos, charpos;
22028 const char *spec;
22029 Lisp_Object string;
22031 bytepos = percent_position;
22032 charpos = (STRING_MULTIBYTE (elt)
22033 ? string_byte_to_char (elt, bytepos)
22034 : bytepos);
22035 spec = decode_mode_spec (it->w, c, field, &string);
22036 multibyte = STRINGP (string) && STRING_MULTIBYTE (string);
22038 switch (mode_line_target)
22040 case MODE_LINE_NOPROP:
22041 case MODE_LINE_TITLE:
22042 n += store_mode_line_noprop (spec, field, prec);
22043 break;
22044 case MODE_LINE_STRING:
22046 Lisp_Object tem = build_string (spec);
22047 props = Ftext_properties_at (make_number (charpos), elt);
22048 /* Should only keep face property in props */
22049 n += store_mode_line_string (NULL, tem, 0, field, prec, props);
22051 break;
22052 case MODE_LINE_DISPLAY:
22054 int nglyphs_before, nwritten;
22056 nglyphs_before = it->glyph_row->used[TEXT_AREA];
22057 nwritten = display_string (spec, string, elt,
22058 charpos, 0, it,
22059 field, prec, 0,
22060 multibyte);
22062 /* Assign to the glyphs written above the
22063 string where the `%x' came from, position
22064 of the `%'. */
22065 if (nwritten > 0)
22067 struct glyph *glyph
22068 = (it->glyph_row->glyphs[TEXT_AREA]
22069 + nglyphs_before);
22070 int i;
22072 for (i = 0; i < nwritten; ++i)
22074 glyph[i].object = elt;
22075 glyph[i].charpos = charpos;
22078 n += nwritten;
22081 break;
22084 else /* c == 0 */
22085 break;
22089 break;
22091 case Lisp_Symbol:
22092 /* A symbol: process the value of the symbol recursively
22093 as if it appeared here directly. Avoid error if symbol void.
22094 Special case: if value of symbol is a string, output the string
22095 literally. */
22097 register Lisp_Object tem;
22099 /* If the variable is not marked as risky to set
22100 then its contents are risky to use. */
22101 if (NILP (Fget (elt, Qrisky_local_variable)))
22102 risky = 1;
22104 tem = Fboundp (elt);
22105 if (!NILP (tem))
22107 tem = Fsymbol_value (elt);
22108 /* If value is a string, output that string literally:
22109 don't check for % within it. */
22110 if (STRINGP (tem))
22111 literal = 1;
22113 if (!EQ (tem, elt))
22115 /* Give up right away for nil or t. */
22116 elt = tem;
22117 goto tail_recurse;
22121 break;
22123 case Lisp_Cons:
22125 register Lisp_Object car, tem;
22127 /* A cons cell: five distinct cases.
22128 If first element is :eval or :propertize, do something special.
22129 If first element is a string or a cons, process all the elements
22130 and effectively concatenate them.
22131 If first element is a negative number, truncate displaying cdr to
22132 at most that many characters. If positive, pad (with spaces)
22133 to at least that many characters.
22134 If first element is a symbol, process the cadr or caddr recursively
22135 according to whether the symbol's value is non-nil or nil. */
22136 car = XCAR (elt);
22137 if (EQ (car, QCeval))
22139 /* An element of the form (:eval FORM) means evaluate FORM
22140 and use the result as mode line elements. */
22142 if (risky)
22143 break;
22145 if (CONSP (XCDR (elt)))
22147 Lisp_Object spec;
22148 spec = safe__eval (true, XCAR (XCDR (elt)));
22149 n += display_mode_element (it, depth, field_width - n,
22150 precision - n, spec, props,
22151 risky);
22154 else if (EQ (car, QCpropertize))
22156 /* An element of the form (:propertize ELT PROPS...)
22157 means display ELT but applying properties PROPS. */
22159 if (risky)
22160 break;
22162 if (CONSP (XCDR (elt)))
22163 n += display_mode_element (it, depth, field_width - n,
22164 precision - n, XCAR (XCDR (elt)),
22165 XCDR (XCDR (elt)), risky);
22167 else if (SYMBOLP (car))
22169 tem = Fboundp (car);
22170 elt = XCDR (elt);
22171 if (!CONSP (elt))
22172 goto invalid;
22173 /* elt is now the cdr, and we know it is a cons cell.
22174 Use its car if CAR has a non-nil value. */
22175 if (!NILP (tem))
22177 tem = Fsymbol_value (car);
22178 if (!NILP (tem))
22180 elt = XCAR (elt);
22181 goto tail_recurse;
22184 /* Symbol's value is nil (or symbol is unbound)
22185 Get the cddr of the original list
22186 and if possible find the caddr and use that. */
22187 elt = XCDR (elt);
22188 if (NILP (elt))
22189 break;
22190 else if (!CONSP (elt))
22191 goto invalid;
22192 elt = XCAR (elt);
22193 goto tail_recurse;
22195 else if (INTEGERP (car))
22197 register int lim = XINT (car);
22198 elt = XCDR (elt);
22199 if (lim < 0)
22201 /* Negative int means reduce maximum width. */
22202 if (precision <= 0)
22203 precision = -lim;
22204 else
22205 precision = min (precision, -lim);
22207 else if (lim > 0)
22209 /* Padding specified. Don't let it be more than
22210 current maximum. */
22211 if (precision > 0)
22212 lim = min (precision, lim);
22214 /* If that's more padding than already wanted, queue it.
22215 But don't reduce padding already specified even if
22216 that is beyond the current truncation point. */
22217 field_width = max (lim, field_width);
22219 goto tail_recurse;
22221 else if (STRINGP (car) || CONSP (car))
22223 Lisp_Object halftail = elt;
22224 int len = 0;
22226 while (CONSP (elt)
22227 && (precision <= 0 || n < precision))
22229 n += display_mode_element (it, depth,
22230 /* Do padding only after the last
22231 element in the list. */
22232 (! CONSP (XCDR (elt))
22233 ? field_width - n
22234 : 0),
22235 precision - n, XCAR (elt),
22236 props, risky);
22237 elt = XCDR (elt);
22238 len++;
22239 if ((len & 1) == 0)
22240 halftail = XCDR (halftail);
22241 /* Check for cycle. */
22242 if (EQ (halftail, elt))
22243 break;
22247 break;
22249 default:
22250 invalid:
22251 elt = build_string ("*invalid*");
22252 goto tail_recurse;
22255 /* Pad to FIELD_WIDTH. */
22256 if (field_width > 0 && n < field_width)
22258 switch (mode_line_target)
22260 case MODE_LINE_NOPROP:
22261 case MODE_LINE_TITLE:
22262 n += store_mode_line_noprop ("", field_width - n, 0);
22263 break;
22264 case MODE_LINE_STRING:
22265 n += store_mode_line_string ("", Qnil, 0, field_width - n, 0, Qnil);
22266 break;
22267 case MODE_LINE_DISPLAY:
22268 n += display_string ("", Qnil, Qnil, 0, 0, it, field_width - n,
22269 0, 0, 0);
22270 break;
22274 return n;
22277 /* Store a mode-line string element in mode_line_string_list.
22279 If STRING is non-null, display that C string. Otherwise, the Lisp
22280 string LISP_STRING is displayed.
22282 FIELD_WIDTH is the minimum number of output glyphs to produce.
22283 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22284 with spaces. FIELD_WIDTH <= 0 means don't pad.
22286 PRECISION is the maximum number of characters to output from
22287 STRING. PRECISION <= 0 means don't truncate the string.
22289 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22290 properties to the string.
22292 PROPS are the properties to add to the string.
22293 The mode_line_string_face face property is always added to the string.
22296 static int
22297 store_mode_line_string (const char *string, Lisp_Object lisp_string, int copy_string,
22298 int field_width, int precision, Lisp_Object props)
22300 ptrdiff_t len;
22301 int n = 0;
22303 if (string != NULL)
22305 len = strlen (string);
22306 if (precision > 0 && len > precision)
22307 len = precision;
22308 lisp_string = make_string (string, len);
22309 if (NILP (props))
22310 props = mode_line_string_face_prop;
22311 else if (!NILP (mode_line_string_face))
22313 Lisp_Object face = Fplist_get (props, Qface);
22314 props = Fcopy_sequence (props);
22315 if (NILP (face))
22316 face = mode_line_string_face;
22317 else
22318 face = list2 (face, mode_line_string_face);
22319 props = Fplist_put (props, Qface, face);
22321 Fadd_text_properties (make_number (0), make_number (len),
22322 props, lisp_string);
22324 else
22326 len = XFASTINT (Flength (lisp_string));
22327 if (precision > 0 && len > precision)
22329 len = precision;
22330 lisp_string = Fsubstring (lisp_string, make_number (0), make_number (len));
22331 precision = -1;
22333 if (!NILP (mode_line_string_face))
22335 Lisp_Object face;
22336 if (NILP (props))
22337 props = Ftext_properties_at (make_number (0), lisp_string);
22338 face = Fplist_get (props, Qface);
22339 if (NILP (face))
22340 face = mode_line_string_face;
22341 else
22342 face = list2 (face, mode_line_string_face);
22343 props = list2 (Qface, face);
22344 if (copy_string)
22345 lisp_string = Fcopy_sequence (lisp_string);
22347 if (!NILP (props))
22348 Fadd_text_properties (make_number (0), make_number (len),
22349 props, lisp_string);
22352 if (len > 0)
22354 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22355 n += len;
22358 if (field_width > len)
22360 field_width -= len;
22361 lisp_string = Fmake_string (make_number (field_width), make_number (' '));
22362 if (!NILP (props))
22363 Fadd_text_properties (make_number (0), make_number (field_width),
22364 props, lisp_string);
22365 mode_line_string_list = Fcons (lisp_string, mode_line_string_list);
22366 n += field_width;
22369 return n;
22373 DEFUN ("format-mode-line", Fformat_mode_line, Sformat_mode_line,
22374 1, 4, 0,
22375 doc: /* Format a string out of a mode line format specification.
22376 First arg FORMAT specifies the mode line format (see `mode-line-format'
22377 for details) to use.
22379 By default, the format is evaluated for the currently selected window.
22381 Optional second arg FACE specifies the face property to put on all
22382 characters for which no face is specified. The value nil means the
22383 default face. The value t means whatever face the window's mode line
22384 currently uses (either `mode-line' or `mode-line-inactive',
22385 depending on whether the window is the selected window or not).
22386 An integer value means the value string has no text
22387 properties.
22389 Optional third and fourth args WINDOW and BUFFER specify the window
22390 and buffer to use as the context for the formatting (defaults
22391 are the selected window and the WINDOW's buffer). */)
22392 (Lisp_Object format, Lisp_Object face,
22393 Lisp_Object window, Lisp_Object buffer)
22395 struct it it;
22396 int len;
22397 struct window *w;
22398 struct buffer *old_buffer = NULL;
22399 int face_id;
22400 int no_props = INTEGERP (face);
22401 ptrdiff_t count = SPECPDL_INDEX ();
22402 Lisp_Object str;
22403 int string_start = 0;
22405 w = decode_any_window (window);
22406 XSETWINDOW (window, w);
22408 if (NILP (buffer))
22409 buffer = w->contents;
22410 CHECK_BUFFER (buffer);
22412 /* Make formatting the modeline a non-op when noninteractive, otherwise
22413 there will be problems later caused by a partially initialized frame. */
22414 if (NILP (format) || noninteractive)
22415 return empty_unibyte_string;
22417 if (no_props)
22418 face = Qnil;
22420 face_id = (NILP (face) || EQ (face, Qdefault)) ? DEFAULT_FACE_ID
22421 : EQ (face, Qt) ? (EQ (window, selected_window)
22422 ? MODE_LINE_FACE_ID : MODE_LINE_INACTIVE_FACE_ID)
22423 : EQ (face, Qmode_line) ? MODE_LINE_FACE_ID
22424 : EQ (face, Qmode_line_inactive) ? MODE_LINE_INACTIVE_FACE_ID
22425 : EQ (face, Qheader_line) ? HEADER_LINE_FACE_ID
22426 : EQ (face, Qtool_bar) ? TOOL_BAR_FACE_ID
22427 : DEFAULT_FACE_ID;
22429 old_buffer = current_buffer;
22431 /* Save things including mode_line_proptrans_alist,
22432 and set that to nil so that we don't alter the outer value. */
22433 record_unwind_protect (unwind_format_mode_line,
22434 format_mode_line_unwind_data
22435 (XFRAME (WINDOW_FRAME (w)),
22436 old_buffer, selected_window, 1));
22437 mode_line_proptrans_alist = Qnil;
22439 Fselect_window (window, Qt);
22440 set_buffer_internal_1 (XBUFFER (buffer));
22442 init_iterator (&it, w, -1, -1, NULL, face_id);
22444 if (no_props)
22446 mode_line_target = MODE_LINE_NOPROP;
22447 mode_line_string_face_prop = Qnil;
22448 mode_line_string_list = Qnil;
22449 string_start = MODE_LINE_NOPROP_LEN (0);
22451 else
22453 mode_line_target = MODE_LINE_STRING;
22454 mode_line_string_list = Qnil;
22455 mode_line_string_face = face;
22456 mode_line_string_face_prop
22457 = NILP (face) ? Qnil : list2 (Qface, face);
22460 push_kboard (FRAME_KBOARD (it.f));
22461 display_mode_element (&it, 0, 0, 0, format, Qnil, 0);
22462 pop_kboard ();
22464 if (no_props)
22466 len = MODE_LINE_NOPROP_LEN (string_start);
22467 str = make_string (mode_line_noprop_buf + string_start, len);
22469 else
22471 mode_line_string_list = Fnreverse (mode_line_string_list);
22472 str = Fmapconcat (intern ("identity"), mode_line_string_list,
22473 empty_unibyte_string);
22476 unbind_to (count, Qnil);
22477 return str;
22480 /* Write a null-terminated, right justified decimal representation of
22481 the positive integer D to BUF using a minimal field width WIDTH. */
22483 static void
22484 pint2str (register char *buf, register int width, register ptrdiff_t d)
22486 register char *p = buf;
22488 if (d <= 0)
22489 *p++ = '0';
22490 else
22492 while (d > 0)
22494 *p++ = d % 10 + '0';
22495 d /= 10;
22499 for (width -= (int) (p - buf); width > 0; --width)
22500 *p++ = ' ';
22501 *p-- = '\0';
22502 while (p > buf)
22504 d = *buf;
22505 *buf++ = *p;
22506 *p-- = d;
22510 /* Write a null-terminated, right justified decimal and "human
22511 readable" representation of the nonnegative integer D to BUF using
22512 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22514 static const char power_letter[] =
22516 0, /* no letter */
22517 'k', /* kilo */
22518 'M', /* mega */
22519 'G', /* giga */
22520 'T', /* tera */
22521 'P', /* peta */
22522 'E', /* exa */
22523 'Z', /* zetta */
22524 'Y' /* yotta */
22527 static void
22528 pint2hrstr (char *buf, int width, ptrdiff_t d)
22530 /* We aim to represent the nonnegative integer D as
22531 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22532 ptrdiff_t quotient = d;
22533 int remainder = 0;
22534 /* -1 means: do not use TENTHS. */
22535 int tenths = -1;
22536 int exponent = 0;
22538 /* Length of QUOTIENT.TENTHS as a string. */
22539 int length;
22541 char * psuffix;
22542 char * p;
22544 if (quotient >= 1000)
22546 /* Scale to the appropriate EXPONENT. */
22549 remainder = quotient % 1000;
22550 quotient /= 1000;
22551 exponent++;
22553 while (quotient >= 1000);
22555 /* Round to nearest and decide whether to use TENTHS or not. */
22556 if (quotient <= 9)
22558 tenths = remainder / 100;
22559 if (remainder % 100 >= 50)
22561 if (tenths < 9)
22562 tenths++;
22563 else
22565 quotient++;
22566 if (quotient == 10)
22567 tenths = -1;
22568 else
22569 tenths = 0;
22573 else
22574 if (remainder >= 500)
22576 if (quotient < 999)
22577 quotient++;
22578 else
22580 quotient = 1;
22581 exponent++;
22582 tenths = 0;
22587 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22588 if (tenths == -1 && quotient <= 99)
22589 if (quotient <= 9)
22590 length = 1;
22591 else
22592 length = 2;
22593 else
22594 length = 3;
22595 p = psuffix = buf + max (width, length);
22597 /* Print EXPONENT. */
22598 *psuffix++ = power_letter[exponent];
22599 *psuffix = '\0';
22601 /* Print TENTHS. */
22602 if (tenths >= 0)
22604 *--p = '0' + tenths;
22605 *--p = '.';
22608 /* Print QUOTIENT. */
22611 int digit = quotient % 10;
22612 *--p = '0' + digit;
22614 while ((quotient /= 10) != 0);
22616 /* Print leading spaces. */
22617 while (buf < p)
22618 *--p = ' ';
22621 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22622 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22623 type of CODING_SYSTEM. Return updated pointer into BUF. */
22625 static unsigned char invalid_eol_type[] = "(*invalid*)";
22627 static char *
22628 decode_mode_spec_coding (Lisp_Object coding_system, register char *buf, int eol_flag)
22630 Lisp_Object val;
22631 bool multibyte = !NILP (BVAR (current_buffer, enable_multibyte_characters));
22632 const unsigned char *eol_str;
22633 int eol_str_len;
22634 /* The EOL conversion we are using. */
22635 Lisp_Object eoltype;
22637 val = CODING_SYSTEM_SPEC (coding_system);
22638 eoltype = Qnil;
22640 if (!VECTORP (val)) /* Not yet decided. */
22642 *buf++ = multibyte ? '-' : ' ';
22643 if (eol_flag)
22644 eoltype = eol_mnemonic_undecided;
22645 /* Don't mention EOL conversion if it isn't decided. */
22647 else
22649 Lisp_Object attrs;
22650 Lisp_Object eolvalue;
22652 attrs = AREF (val, 0);
22653 eolvalue = AREF (val, 2);
22655 *buf++ = multibyte
22656 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs))
22657 : ' ';
22659 if (eol_flag)
22661 /* The EOL conversion that is normal on this system. */
22663 if (NILP (eolvalue)) /* Not yet decided. */
22664 eoltype = eol_mnemonic_undecided;
22665 else if (VECTORP (eolvalue)) /* Not yet decided. */
22666 eoltype = eol_mnemonic_undecided;
22667 else /* eolvalue is Qunix, Qdos, or Qmac. */
22668 eoltype = (EQ (eolvalue, Qunix)
22669 ? eol_mnemonic_unix
22670 : (EQ (eolvalue, Qdos) == 1
22671 ? eol_mnemonic_dos : eol_mnemonic_mac));
22675 if (eol_flag)
22677 /* Mention the EOL conversion if it is not the usual one. */
22678 if (STRINGP (eoltype))
22680 eol_str = SDATA (eoltype);
22681 eol_str_len = SBYTES (eoltype);
22683 else if (CHARACTERP (eoltype))
22685 unsigned char *tmp = alloca (MAX_MULTIBYTE_LENGTH);
22686 int c = XFASTINT (eoltype);
22687 eol_str_len = CHAR_STRING (c, tmp);
22688 eol_str = tmp;
22690 else
22692 eol_str = invalid_eol_type;
22693 eol_str_len = sizeof (invalid_eol_type) - 1;
22695 memcpy (buf, eol_str, eol_str_len);
22696 buf += eol_str_len;
22699 return buf;
22702 /* Return a string for the output of a mode line %-spec for window W,
22703 generated by character C. FIELD_WIDTH > 0 means pad the string
22704 returned with spaces to that value. Return a Lisp string in
22705 *STRING if the resulting string is taken from that Lisp string.
22707 Note we operate on the current buffer for most purposes. */
22709 static char lots_of_dashes[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22711 static const char *
22712 decode_mode_spec (struct window *w, register int c, int field_width,
22713 Lisp_Object *string)
22715 Lisp_Object obj;
22716 struct frame *f = XFRAME (WINDOW_FRAME (w));
22717 char *decode_mode_spec_buf = f->decode_mode_spec_buffer;
22718 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22719 produce strings from numerical values, so limit preposterously
22720 large values of FIELD_WIDTH to avoid overrunning the buffer's
22721 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22722 bytes plus the terminating null. */
22723 int width = min (field_width, FRAME_MESSAGE_BUF_SIZE (f));
22724 struct buffer *b = current_buffer;
22726 obj = Qnil;
22727 *string = Qnil;
22729 switch (c)
22731 case '*':
22732 if (!NILP (BVAR (b, read_only)))
22733 return "%";
22734 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22735 return "*";
22736 return "-";
22738 case '+':
22739 /* This differs from %* only for a modified read-only buffer. */
22740 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22741 return "*";
22742 if (!NILP (BVAR (b, read_only)))
22743 return "%";
22744 return "-";
22746 case '&':
22747 /* This differs from %* in ignoring read-only-ness. */
22748 if (BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
22749 return "*";
22750 return "-";
22752 case '%':
22753 return "%";
22755 case '[':
22757 int i;
22758 char *p;
22760 if (command_loop_level > 5)
22761 return "[[[... ";
22762 p = decode_mode_spec_buf;
22763 for (i = 0; i < command_loop_level; i++)
22764 *p++ = '[';
22765 *p = 0;
22766 return decode_mode_spec_buf;
22769 case ']':
22771 int i;
22772 char *p;
22774 if (command_loop_level > 5)
22775 return " ...]]]";
22776 p = decode_mode_spec_buf;
22777 for (i = 0; i < command_loop_level; i++)
22778 *p++ = ']';
22779 *p = 0;
22780 return decode_mode_spec_buf;
22783 case '-':
22785 register int i;
22787 /* Let lots_of_dashes be a string of infinite length. */
22788 if (mode_line_target == MODE_LINE_NOPROP
22789 || mode_line_target == MODE_LINE_STRING)
22790 return "--";
22791 if (field_width <= 0
22792 || field_width > sizeof (lots_of_dashes))
22794 for (i = 0; i < FRAME_MESSAGE_BUF_SIZE (f) - 1; ++i)
22795 decode_mode_spec_buf[i] = '-';
22796 decode_mode_spec_buf[i] = '\0';
22797 return decode_mode_spec_buf;
22799 else
22800 return lots_of_dashes;
22803 case 'b':
22804 obj = BVAR (b, name);
22805 break;
22807 case 'c':
22808 /* %c and %l are ignored in `frame-title-format'.
22809 (In redisplay_internal, the frame title is drawn _before_ the
22810 windows are updated, so the stuff which depends on actual
22811 window contents (such as %l) may fail to render properly, or
22812 even crash emacs.) */
22813 if (mode_line_target == MODE_LINE_TITLE)
22814 return "";
22815 else
22817 ptrdiff_t col = current_column ();
22818 w->column_number_displayed = col;
22819 pint2str (decode_mode_spec_buf, width, col);
22820 return decode_mode_spec_buf;
22823 case 'e':
22824 #ifndef SYSTEM_MALLOC
22826 if (NILP (Vmemory_full))
22827 return "";
22828 else
22829 return "!MEM FULL! ";
22831 #else
22832 return "";
22833 #endif
22835 case 'F':
22836 /* %F displays the frame name. */
22837 if (!NILP (f->title))
22838 return SSDATA (f->title);
22839 if (f->explicit_name || ! FRAME_WINDOW_P (f))
22840 return SSDATA (f->name);
22841 return "Emacs";
22843 case 'f':
22844 obj = BVAR (b, filename);
22845 break;
22847 case 'i':
22849 ptrdiff_t size = ZV - BEGV;
22850 pint2str (decode_mode_spec_buf, width, size);
22851 return decode_mode_spec_buf;
22854 case 'I':
22856 ptrdiff_t size = ZV - BEGV;
22857 pint2hrstr (decode_mode_spec_buf, width, size);
22858 return decode_mode_spec_buf;
22861 case 'l':
22863 ptrdiff_t startpos, startpos_byte, line, linepos, linepos_byte;
22864 ptrdiff_t topline, nlines, height;
22865 ptrdiff_t junk;
22867 /* %c and %l are ignored in `frame-title-format'. */
22868 if (mode_line_target == MODE_LINE_TITLE)
22869 return "";
22871 startpos = marker_position (w->start);
22872 startpos_byte = marker_byte_position (w->start);
22873 height = WINDOW_TOTAL_LINES (w);
22875 /* If we decided that this buffer isn't suitable for line numbers,
22876 don't forget that too fast. */
22877 if (w->base_line_pos == -1)
22878 goto no_value;
22880 /* If the buffer is very big, don't waste time. */
22881 if (INTEGERP (Vline_number_display_limit)
22882 && BUF_ZV (b) - BUF_BEGV (b) > XINT (Vline_number_display_limit))
22884 w->base_line_pos = 0;
22885 w->base_line_number = 0;
22886 goto no_value;
22889 if (w->base_line_number > 0
22890 && w->base_line_pos > 0
22891 && w->base_line_pos <= startpos)
22893 line = w->base_line_number;
22894 linepos = w->base_line_pos;
22895 linepos_byte = buf_charpos_to_bytepos (b, linepos);
22897 else
22899 line = 1;
22900 linepos = BUF_BEGV (b);
22901 linepos_byte = BUF_BEGV_BYTE (b);
22904 /* Count lines from base line to window start position. */
22905 nlines = display_count_lines (linepos_byte,
22906 startpos_byte,
22907 startpos, &junk);
22909 topline = nlines + line;
22911 /* Determine a new base line, if the old one is too close
22912 or too far away, or if we did not have one.
22913 "Too close" means it's plausible a scroll-down would
22914 go back past it. */
22915 if (startpos == BUF_BEGV (b))
22917 w->base_line_number = topline;
22918 w->base_line_pos = BUF_BEGV (b);
22920 else if (nlines < height + 25 || nlines > height * 3 + 50
22921 || linepos == BUF_BEGV (b))
22923 ptrdiff_t limit = BUF_BEGV (b);
22924 ptrdiff_t limit_byte = BUF_BEGV_BYTE (b);
22925 ptrdiff_t position;
22926 ptrdiff_t distance =
22927 (height * 2 + 30) * line_number_display_limit_width;
22929 if (startpos - distance > limit)
22931 limit = startpos - distance;
22932 limit_byte = CHAR_TO_BYTE (limit);
22935 nlines = display_count_lines (startpos_byte,
22936 limit_byte,
22937 - (height * 2 + 30),
22938 &position);
22939 /* If we couldn't find the lines we wanted within
22940 line_number_display_limit_width chars per line,
22941 give up on line numbers for this window. */
22942 if (position == limit_byte && limit == startpos - distance)
22944 w->base_line_pos = -1;
22945 w->base_line_number = 0;
22946 goto no_value;
22949 w->base_line_number = topline - nlines;
22950 w->base_line_pos = BYTE_TO_CHAR (position);
22953 /* Now count lines from the start pos to point. */
22954 nlines = display_count_lines (startpos_byte,
22955 PT_BYTE, PT, &junk);
22957 /* Record that we did display the line number. */
22958 line_number_displayed = 1;
22960 /* Make the string to show. */
22961 pint2str (decode_mode_spec_buf, width, topline + nlines);
22962 return decode_mode_spec_buf;
22963 no_value:
22965 char* p = decode_mode_spec_buf;
22966 int pad = width - 2;
22967 while (pad-- > 0)
22968 *p++ = ' ';
22969 *p++ = '?';
22970 *p++ = '?';
22971 *p = '\0';
22972 return decode_mode_spec_buf;
22975 break;
22977 case 'm':
22978 obj = BVAR (b, mode_name);
22979 break;
22981 case 'n':
22982 if (BUF_BEGV (b) > BUF_BEG (b) || BUF_ZV (b) < BUF_Z (b))
22983 return " Narrow";
22984 break;
22986 case 'p':
22988 ptrdiff_t pos = marker_position (w->start);
22989 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
22991 if (w->window_end_pos <= BUF_Z (b) - BUF_ZV (b))
22993 if (pos <= BUF_BEGV (b))
22994 return "All";
22995 else
22996 return "Bottom";
22998 else if (pos <= BUF_BEGV (b))
22999 return "Top";
23000 else
23002 if (total > 1000000)
23003 /* Do it differently for a large value, to avoid overflow. */
23004 total = ((pos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23005 else
23006 total = ((pos - BUF_BEGV (b)) * 100 + total - 1) / total;
23007 /* We can't normally display a 3-digit number,
23008 so get us a 2-digit number that is close. */
23009 if (total == 100)
23010 total = 99;
23011 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23012 return decode_mode_spec_buf;
23016 /* Display percentage of size above the bottom of the screen. */
23017 case 'P':
23019 ptrdiff_t toppos = marker_position (w->start);
23020 ptrdiff_t botpos = BUF_Z (b) - w->window_end_pos;
23021 ptrdiff_t total = BUF_ZV (b) - BUF_BEGV (b);
23023 if (botpos >= BUF_ZV (b))
23025 if (toppos <= BUF_BEGV (b))
23026 return "All";
23027 else
23028 return "Bottom";
23030 else
23032 if (total > 1000000)
23033 /* Do it differently for a large value, to avoid overflow. */
23034 total = ((botpos - BUF_BEGV (b)) + (total / 100) - 1) / (total / 100);
23035 else
23036 total = ((botpos - BUF_BEGV (b)) * 100 + total - 1) / total;
23037 /* We can't normally display a 3-digit number,
23038 so get us a 2-digit number that is close. */
23039 if (total == 100)
23040 total = 99;
23041 if (toppos <= BUF_BEGV (b))
23042 sprintf (decode_mode_spec_buf, "Top%2"pD"d%%", total);
23043 else
23044 sprintf (decode_mode_spec_buf, "%2"pD"d%%", total);
23045 return decode_mode_spec_buf;
23049 case 's':
23050 /* status of process */
23051 obj = Fget_buffer_process (Fcurrent_buffer ());
23052 if (NILP (obj))
23053 return "no process";
23054 #ifndef MSDOS
23055 obj = Fsymbol_name (Fprocess_status (obj));
23056 #endif
23057 break;
23059 case '@':
23061 ptrdiff_t count = inhibit_garbage_collection ();
23062 Lisp_Object curdir = BVAR (current_buffer, directory);
23063 Lisp_Object val = Qnil;
23065 if (STRINGP (curdir))
23066 val = call1 (intern ("file-remote-p"), curdir);
23068 unbind_to (count, Qnil);
23070 if (NILP (val))
23071 return "-";
23072 else
23073 return "@";
23076 case 'z':
23077 /* coding-system (not including end-of-line format) */
23078 case 'Z':
23079 /* coding-system (including end-of-line type) */
23081 int eol_flag = (c == 'Z');
23082 char *p = decode_mode_spec_buf;
23084 if (! FRAME_WINDOW_P (f))
23086 /* No need to mention EOL here--the terminal never needs
23087 to do EOL conversion. */
23088 p = decode_mode_spec_coding (CODING_ID_NAME
23089 (FRAME_KEYBOARD_CODING (f)->id),
23090 p, 0);
23091 p = decode_mode_spec_coding (CODING_ID_NAME
23092 (FRAME_TERMINAL_CODING (f)->id),
23093 p, 0);
23095 p = decode_mode_spec_coding (BVAR (b, buffer_file_coding_system),
23096 p, eol_flag);
23098 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23099 #ifdef subprocesses
23100 obj = Fget_buffer_process (Fcurrent_buffer ());
23101 if (PROCESSP (obj))
23103 p = decode_mode_spec_coding
23104 (XPROCESS (obj)->decode_coding_system, p, eol_flag);
23105 p = decode_mode_spec_coding
23106 (XPROCESS (obj)->encode_coding_system, p, eol_flag);
23108 #endif /* subprocesses */
23109 #endif /* 0 */
23110 *p = 0;
23111 return decode_mode_spec_buf;
23115 if (STRINGP (obj))
23117 *string = obj;
23118 return SSDATA (obj);
23120 else
23121 return "";
23125 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23126 means count lines back from START_BYTE. But don't go beyond
23127 LIMIT_BYTE. Return the number of lines thus found (always
23128 nonnegative).
23130 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23131 either the position COUNT lines after/before START_BYTE, if we
23132 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23133 COUNT lines. */
23135 static ptrdiff_t
23136 display_count_lines (ptrdiff_t start_byte,
23137 ptrdiff_t limit_byte, ptrdiff_t count,
23138 ptrdiff_t *byte_pos_ptr)
23140 register unsigned char *cursor;
23141 unsigned char *base;
23143 register ptrdiff_t ceiling;
23144 register unsigned char *ceiling_addr;
23145 ptrdiff_t orig_count = count;
23147 /* If we are not in selective display mode,
23148 check only for newlines. */
23149 int selective_display = (!NILP (BVAR (current_buffer, selective_display))
23150 && !INTEGERP (BVAR (current_buffer, selective_display)));
23152 if (count > 0)
23154 while (start_byte < limit_byte)
23156 ceiling = BUFFER_CEILING_OF (start_byte);
23157 ceiling = min (limit_byte - 1, ceiling);
23158 ceiling_addr = BYTE_POS_ADDR (ceiling) + 1;
23159 base = (cursor = BYTE_POS_ADDR (start_byte));
23163 if (selective_display)
23165 while (*cursor != '\n' && *cursor != 015
23166 && ++cursor != ceiling_addr)
23167 continue;
23168 if (cursor == ceiling_addr)
23169 break;
23171 else
23173 cursor = memchr (cursor, '\n', ceiling_addr - cursor);
23174 if (! cursor)
23175 break;
23178 cursor++;
23180 if (--count == 0)
23182 start_byte += cursor - base;
23183 *byte_pos_ptr = start_byte;
23184 return orig_count;
23187 while (cursor < ceiling_addr);
23189 start_byte += ceiling_addr - base;
23192 else
23194 while (start_byte > limit_byte)
23196 ceiling = BUFFER_FLOOR_OF (start_byte - 1);
23197 ceiling = max (limit_byte, ceiling);
23198 ceiling_addr = BYTE_POS_ADDR (ceiling);
23199 base = (cursor = BYTE_POS_ADDR (start_byte - 1) + 1);
23200 while (1)
23202 if (selective_display)
23204 while (--cursor >= ceiling_addr
23205 && *cursor != '\n' && *cursor != 015)
23206 continue;
23207 if (cursor < ceiling_addr)
23208 break;
23210 else
23212 cursor = memrchr (ceiling_addr, '\n', cursor - ceiling_addr);
23213 if (! cursor)
23214 break;
23217 if (++count == 0)
23219 start_byte += cursor - base + 1;
23220 *byte_pos_ptr = start_byte;
23221 /* When scanning backwards, we should
23222 not count the newline posterior to which we stop. */
23223 return - orig_count - 1;
23226 start_byte += ceiling_addr - base;
23230 *byte_pos_ptr = limit_byte;
23232 if (count < 0)
23233 return - orig_count + count;
23234 return orig_count - count;
23240 /***********************************************************************
23241 Displaying strings
23242 ***********************************************************************/
23244 /* Display a NUL-terminated string, starting with index START.
23246 If STRING is non-null, display that C string. Otherwise, the Lisp
23247 string LISP_STRING is displayed. There's a case that STRING is
23248 non-null and LISP_STRING is not nil. It means STRING is a string
23249 data of LISP_STRING. In that case, we display LISP_STRING while
23250 ignoring its text properties.
23252 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23253 FACE_STRING. Display STRING or LISP_STRING with the face at
23254 FACE_STRING_POS in FACE_STRING:
23256 Display the string in the environment given by IT, but use the
23257 standard display table, temporarily.
23259 FIELD_WIDTH is the minimum number of output glyphs to produce.
23260 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23261 with spaces. If STRING has more characters, more than FIELD_WIDTH
23262 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23264 PRECISION is the maximum number of characters to output from
23265 STRING. PRECISION < 0 means don't truncate the string.
23267 This is roughly equivalent to printf format specifiers:
23269 FIELD_WIDTH PRECISION PRINTF
23270 ----------------------------------------
23271 -1 -1 %s
23272 -1 10 %.10s
23273 10 -1 %10s
23274 20 10 %20.10s
23276 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23277 display them, and < 0 means obey the current buffer's value of
23278 enable_multibyte_characters.
23280 Value is the number of columns displayed. */
23282 static int
23283 display_string (const char *string, Lisp_Object lisp_string, Lisp_Object face_string,
23284 ptrdiff_t face_string_pos, ptrdiff_t start, struct it *it,
23285 int field_width, int precision, int max_x, int multibyte)
23287 int hpos_at_start = it->hpos;
23288 int saved_face_id = it->face_id;
23289 struct glyph_row *row = it->glyph_row;
23290 ptrdiff_t it_charpos;
23292 /* Initialize the iterator IT for iteration over STRING beginning
23293 with index START. */
23294 reseat_to_string (it, NILP (lisp_string) ? string : NULL, lisp_string, start,
23295 precision, field_width, multibyte);
23296 if (string && STRINGP (lisp_string))
23297 /* LISP_STRING is the one returned by decode_mode_spec. We should
23298 ignore its text properties. */
23299 it->stop_charpos = it->end_charpos;
23301 /* If displaying STRING, set up the face of the iterator from
23302 FACE_STRING, if that's given. */
23303 if (STRINGP (face_string))
23305 ptrdiff_t endptr;
23306 struct face *face;
23308 it->face_id
23309 = face_at_string_position (it->w, face_string, face_string_pos,
23310 0, &endptr, it->base_face_id, 0);
23311 face = FACE_FROM_ID (it->f, it->face_id);
23312 it->face_box_p = face->box != FACE_NO_BOX;
23315 /* Set max_x to the maximum allowed X position. Don't let it go
23316 beyond the right edge of the window. */
23317 if (max_x <= 0)
23318 max_x = it->last_visible_x;
23319 else
23320 max_x = min (max_x, it->last_visible_x);
23322 /* Skip over display elements that are not visible. because IT->w is
23323 hscrolled. */
23324 if (it->current_x < it->first_visible_x)
23325 move_it_in_display_line_to (it, 100000, it->first_visible_x,
23326 MOVE_TO_POS | MOVE_TO_X);
23328 row->ascent = it->max_ascent;
23329 row->height = it->max_ascent + it->max_descent;
23330 row->phys_ascent = it->max_phys_ascent;
23331 row->phys_height = it->max_phys_ascent + it->max_phys_descent;
23332 row->extra_line_spacing = it->max_extra_line_spacing;
23334 if (STRINGP (it->string))
23335 it_charpos = IT_STRING_CHARPOS (*it);
23336 else
23337 it_charpos = IT_CHARPOS (*it);
23339 /* This condition is for the case that we are called with current_x
23340 past last_visible_x. */
23341 while (it->current_x < max_x)
23343 int x_before, x, n_glyphs_before, i, nglyphs;
23345 /* Get the next display element. */
23346 if (!get_next_display_element (it))
23347 break;
23349 /* Produce glyphs. */
23350 x_before = it->current_x;
23351 n_glyphs_before = row->used[TEXT_AREA];
23352 PRODUCE_GLYPHS (it);
23354 nglyphs = row->used[TEXT_AREA] - n_glyphs_before;
23355 i = 0;
23356 x = x_before;
23357 while (i < nglyphs)
23359 struct glyph *glyph = row->glyphs[TEXT_AREA] + n_glyphs_before + i;
23361 if (it->line_wrap != TRUNCATE
23362 && x + glyph->pixel_width > max_x)
23364 /* End of continued line or max_x reached. */
23365 if (CHAR_GLYPH_PADDING_P (*glyph))
23367 /* A wide character is unbreakable. */
23368 if (row->reversed_p)
23369 unproduce_glyphs (it, row->used[TEXT_AREA]
23370 - n_glyphs_before);
23371 row->used[TEXT_AREA] = n_glyphs_before;
23372 it->current_x = x_before;
23374 else
23376 if (row->reversed_p)
23377 unproduce_glyphs (it, row->used[TEXT_AREA]
23378 - (n_glyphs_before + i));
23379 row->used[TEXT_AREA] = n_glyphs_before + i;
23380 it->current_x = x;
23382 break;
23384 else if (x + glyph->pixel_width >= it->first_visible_x)
23386 /* Glyph is at least partially visible. */
23387 ++it->hpos;
23388 if (x < it->first_visible_x)
23389 row->x = x - it->first_visible_x;
23391 else
23393 /* Glyph is off the left margin of the display area.
23394 Should not happen. */
23395 emacs_abort ();
23398 row->ascent = max (row->ascent, it->max_ascent);
23399 row->height = max (row->height, it->max_ascent + it->max_descent);
23400 row->phys_ascent = max (row->phys_ascent, it->max_phys_ascent);
23401 row->phys_height = max (row->phys_height,
23402 it->max_phys_ascent + it->max_phys_descent);
23403 row->extra_line_spacing = max (row->extra_line_spacing,
23404 it->max_extra_line_spacing);
23405 x += glyph->pixel_width;
23406 ++i;
23409 /* Stop if max_x reached. */
23410 if (i < nglyphs)
23411 break;
23413 /* Stop at line ends. */
23414 if (ITERATOR_AT_END_OF_LINE_P (it))
23416 it->continuation_lines_width = 0;
23417 break;
23420 set_iterator_to_next (it, 1);
23421 if (STRINGP (it->string))
23422 it_charpos = IT_STRING_CHARPOS (*it);
23423 else
23424 it_charpos = IT_CHARPOS (*it);
23426 /* Stop if truncating at the right edge. */
23427 if (it->line_wrap == TRUNCATE
23428 && it->current_x >= it->last_visible_x)
23430 /* Add truncation mark, but don't do it if the line is
23431 truncated at a padding space. */
23432 if (it_charpos < it->string_nchars)
23434 if (!FRAME_WINDOW_P (it->f))
23436 int ii, n;
23438 if (it->current_x > it->last_visible_x)
23440 if (!row->reversed_p)
23442 for (ii = row->used[TEXT_AREA] - 1; ii > 0; --ii)
23443 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23444 break;
23446 else
23448 for (ii = 0; ii < row->used[TEXT_AREA]; ii++)
23449 if (!CHAR_GLYPH_PADDING_P (row->glyphs[TEXT_AREA][ii]))
23450 break;
23451 unproduce_glyphs (it, ii + 1);
23452 ii = row->used[TEXT_AREA] - (ii + 1);
23454 for (n = row->used[TEXT_AREA]; ii < n; ++ii)
23456 row->used[TEXT_AREA] = ii;
23457 produce_special_glyphs (it, IT_TRUNCATION);
23460 produce_special_glyphs (it, IT_TRUNCATION);
23462 row->truncated_on_right_p = 1;
23464 break;
23468 /* Maybe insert a truncation at the left. */
23469 if (it->first_visible_x
23470 && it_charpos > 0)
23472 if (!FRAME_WINDOW_P (it->f)
23473 || (row->reversed_p
23474 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23475 : WINDOW_LEFT_FRINGE_WIDTH (it->w)) == 0)
23476 insert_left_trunc_glyphs (it);
23477 row->truncated_on_left_p = 1;
23480 it->face_id = saved_face_id;
23482 /* Value is number of columns displayed. */
23483 return it->hpos - hpos_at_start;
23488 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23489 appears as an element of LIST or as the car of an element of LIST.
23490 If PROPVAL is a list, compare each element against LIST in that
23491 way, and return 1/2 if any element of PROPVAL is found in LIST.
23492 Otherwise return 0. This function cannot quit.
23493 The return value is 2 if the text is invisible but with an ellipsis
23494 and 1 if it's invisible and without an ellipsis. */
23497 invisible_p (register Lisp_Object propval, Lisp_Object list)
23499 register Lisp_Object tail, proptail;
23501 for (tail = list; CONSP (tail); tail = XCDR (tail))
23503 register Lisp_Object tem;
23504 tem = XCAR (tail);
23505 if (EQ (propval, tem))
23506 return 1;
23507 if (CONSP (tem) && EQ (propval, XCAR (tem)))
23508 return NILP (XCDR (tem)) ? 1 : 2;
23511 if (CONSP (propval))
23513 for (proptail = propval; CONSP (proptail); proptail = XCDR (proptail))
23515 Lisp_Object propelt;
23516 propelt = XCAR (proptail);
23517 for (tail = list; CONSP (tail); tail = XCDR (tail))
23519 register Lisp_Object tem;
23520 tem = XCAR (tail);
23521 if (EQ (propelt, tem))
23522 return 1;
23523 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
23524 return NILP (XCDR (tem)) ? 1 : 2;
23529 return 0;
23532 DEFUN ("invisible-p", Finvisible_p, Sinvisible_p, 1, 1, 0,
23533 doc: /* Non-nil if the property makes the text invisible.
23534 POS-OR-PROP can be a marker or number, in which case it is taken to be
23535 a position in the current buffer and the value of the `invisible' property
23536 is checked; or it can be some other value, which is then presumed to be the
23537 value of the `invisible' property of the text of interest.
23538 The non-nil value returned can be t for truly invisible text or something
23539 else if the text is replaced by an ellipsis. */)
23540 (Lisp_Object pos_or_prop)
23542 Lisp_Object prop
23543 = (NATNUMP (pos_or_prop) || MARKERP (pos_or_prop)
23544 ? Fget_char_property (pos_or_prop, Qinvisible, Qnil)
23545 : pos_or_prop);
23546 int invis = TEXT_PROP_MEANS_INVISIBLE (prop);
23547 return (invis == 0 ? Qnil
23548 : invis == 1 ? Qt
23549 : make_number (invis));
23552 /* Calculate a width or height in pixels from a specification using
23553 the following elements:
23555 SPEC ::=
23556 NUM - a (fractional) multiple of the default font width/height
23557 (NUM) - specifies exactly NUM pixels
23558 UNIT - a fixed number of pixels, see below.
23559 ELEMENT - size of a display element in pixels, see below.
23560 (NUM . SPEC) - equals NUM * SPEC
23561 (+ SPEC SPEC ...) - add pixel values
23562 (- SPEC SPEC ...) - subtract pixel values
23563 (- SPEC) - negate pixel value
23565 NUM ::=
23566 INT or FLOAT - a number constant
23567 SYMBOL - use symbol's (buffer local) variable binding.
23569 UNIT ::=
23570 in - pixels per inch *)
23571 mm - pixels per 1/1000 meter *)
23572 cm - pixels per 1/100 meter *)
23573 width - width of current font in pixels.
23574 height - height of current font in pixels.
23576 *) using the ratio(s) defined in display-pixels-per-inch.
23578 ELEMENT ::=
23580 left-fringe - left fringe width in pixels
23581 right-fringe - right fringe width in pixels
23583 left-margin - left margin width in pixels
23584 right-margin - right margin width in pixels
23586 scroll-bar - scroll-bar area width in pixels
23588 Examples:
23590 Pixels corresponding to 5 inches:
23591 (5 . in)
23593 Total width of non-text areas on left side of window (if scroll-bar is on left):
23594 '(space :width (+ left-fringe left-margin scroll-bar))
23596 Align to first text column (in header line):
23597 '(space :align-to 0)
23599 Align to middle of text area minus half the width of variable `my-image'
23600 containing a loaded image:
23601 '(space :align-to (0.5 . (- text my-image)))
23603 Width of left margin minus width of 1 character in the default font:
23604 '(space :width (- left-margin 1))
23606 Width of left margin minus width of 2 characters in the current font:
23607 '(space :width (- left-margin (2 . width)))
23609 Center 1 character over left-margin (in header line):
23610 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23612 Different ways to express width of left fringe plus left margin minus one pixel:
23613 '(space :width (- (+ left-fringe left-margin) (1)))
23614 '(space :width (+ left-fringe left-margin (- (1))))
23615 '(space :width (+ left-fringe left-margin (-1)))
23619 static int
23620 calc_pixel_width_or_height (double *res, struct it *it, Lisp_Object prop,
23621 struct font *font, int width_p, int *align_to)
23623 double pixels;
23625 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23626 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23628 if (NILP (prop))
23629 return OK_PIXELS (0);
23631 eassert (FRAME_LIVE_P (it->f));
23633 if (SYMBOLP (prop))
23635 if (SCHARS (SYMBOL_NAME (prop)) == 2)
23637 char *unit = SSDATA (SYMBOL_NAME (prop));
23639 if (unit[0] == 'i' && unit[1] == 'n')
23640 pixels = 1.0;
23641 else if (unit[0] == 'm' && unit[1] == 'm')
23642 pixels = 25.4;
23643 else if (unit[0] == 'c' && unit[1] == 'm')
23644 pixels = 2.54;
23645 else
23646 pixels = 0;
23647 if (pixels > 0)
23649 double ppi = (width_p ? FRAME_RES_X (it->f)
23650 : FRAME_RES_Y (it->f));
23652 if (ppi > 0)
23653 return OK_PIXELS (ppi / pixels);
23654 return 0;
23658 #ifdef HAVE_WINDOW_SYSTEM
23659 if (EQ (prop, Qheight))
23660 return OK_PIXELS (font ? FONT_HEIGHT (font) : FRAME_LINE_HEIGHT (it->f));
23661 if (EQ (prop, Qwidth))
23662 return OK_PIXELS (font ? FONT_WIDTH (font) : FRAME_COLUMN_WIDTH (it->f));
23663 #else
23664 if (EQ (prop, Qheight) || EQ (prop, Qwidth))
23665 return OK_PIXELS (1);
23666 #endif
23668 if (EQ (prop, Qtext))
23669 return OK_PIXELS (width_p
23670 ? window_box_width (it->w, TEXT_AREA)
23671 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it->w));
23673 if (align_to && *align_to < 0)
23675 *res = 0;
23676 if (EQ (prop, Qleft))
23677 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA));
23678 if (EQ (prop, Qright))
23679 return OK_ALIGN_TO (window_box_right_offset (it->w, TEXT_AREA));
23680 if (EQ (prop, Qcenter))
23681 return OK_ALIGN_TO (window_box_left_offset (it->w, TEXT_AREA)
23682 + window_box_width (it->w, TEXT_AREA) / 2);
23683 if (EQ (prop, Qleft_fringe))
23684 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23685 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it->w)
23686 : window_box_right_offset (it->w, LEFT_MARGIN_AREA));
23687 if (EQ (prop, Qright_fringe))
23688 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23689 ? window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23690 : window_box_right_offset (it->w, TEXT_AREA));
23691 if (EQ (prop, Qleft_margin))
23692 return OK_ALIGN_TO (window_box_left_offset (it->w, LEFT_MARGIN_AREA));
23693 if (EQ (prop, Qright_margin))
23694 return OK_ALIGN_TO (window_box_left_offset (it->w, RIGHT_MARGIN_AREA));
23695 if (EQ (prop, Qscroll_bar))
23696 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it->w)
23698 : (window_box_right_offset (it->w, RIGHT_MARGIN_AREA)
23699 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it->w)
23700 ? WINDOW_RIGHT_FRINGE_WIDTH (it->w)
23701 : 0)));
23703 else
23705 if (EQ (prop, Qleft_fringe))
23706 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it->w));
23707 if (EQ (prop, Qright_fringe))
23708 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it->w));
23709 if (EQ (prop, Qleft_margin))
23710 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it->w));
23711 if (EQ (prop, Qright_margin))
23712 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it->w));
23713 if (EQ (prop, Qscroll_bar))
23714 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it->w));
23717 prop = buffer_local_value_1 (prop, it->w->contents);
23718 if (EQ (prop, Qunbound))
23719 prop = Qnil;
23722 if (INTEGERP (prop) || FLOATP (prop))
23724 int base_unit = (width_p
23725 ? FRAME_COLUMN_WIDTH (it->f)
23726 : FRAME_LINE_HEIGHT (it->f));
23727 return OK_PIXELS (XFLOATINT (prop) * base_unit);
23730 if (CONSP (prop))
23732 Lisp_Object car = XCAR (prop);
23733 Lisp_Object cdr = XCDR (prop);
23735 if (SYMBOLP (car))
23737 #ifdef HAVE_WINDOW_SYSTEM
23738 if (FRAME_WINDOW_P (it->f)
23739 && valid_image_p (prop))
23741 ptrdiff_t id = lookup_image (it->f, prop);
23742 struct image *img = IMAGE_FROM_ID (it->f, id);
23744 return OK_PIXELS (width_p ? img->width : img->height);
23746 #endif
23747 if (EQ (car, Qplus) || EQ (car, Qminus))
23749 int first = 1;
23750 double px;
23752 pixels = 0;
23753 while (CONSP (cdr))
23755 if (!calc_pixel_width_or_height (&px, it, XCAR (cdr),
23756 font, width_p, align_to))
23757 return 0;
23758 if (first)
23759 pixels = (EQ (car, Qplus) ? px : -px), first = 0;
23760 else
23761 pixels += px;
23762 cdr = XCDR (cdr);
23764 if (EQ (car, Qminus))
23765 pixels = -pixels;
23766 return OK_PIXELS (pixels);
23769 car = buffer_local_value_1 (car, it->w->contents);
23770 if (EQ (car, Qunbound))
23771 car = Qnil;
23774 if (INTEGERP (car) || FLOATP (car))
23776 double fact;
23777 pixels = XFLOATINT (car);
23778 if (NILP (cdr))
23779 return OK_PIXELS (pixels);
23780 if (calc_pixel_width_or_height (&fact, it, cdr,
23781 font, width_p, align_to))
23782 return OK_PIXELS (pixels * fact);
23783 return 0;
23786 return 0;
23789 return 0;
23793 /***********************************************************************
23794 Glyph Display
23795 ***********************************************************************/
23797 #ifdef HAVE_WINDOW_SYSTEM
23799 #ifdef GLYPH_DEBUG
23801 void
23802 dump_glyph_string (struct glyph_string *s)
23804 fprintf (stderr, "glyph string\n");
23805 fprintf (stderr, " x, y, w, h = %d, %d, %d, %d\n",
23806 s->x, s->y, s->width, s->height);
23807 fprintf (stderr, " ybase = %d\n", s->ybase);
23808 fprintf (stderr, " hl = %d\n", s->hl);
23809 fprintf (stderr, " left overhang = %d, right = %d\n",
23810 s->left_overhang, s->right_overhang);
23811 fprintf (stderr, " nchars = %d\n", s->nchars);
23812 fprintf (stderr, " extends to end of line = %d\n",
23813 s->extends_to_end_of_line_p);
23814 fprintf (stderr, " font height = %d\n", FONT_HEIGHT (s->font));
23815 fprintf (stderr, " bg width = %d\n", s->background_width);
23818 #endif /* GLYPH_DEBUG */
23820 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23821 of XChar2b structures for S; it can't be allocated in
23822 init_glyph_string because it must be allocated via `alloca'. W
23823 is the window on which S is drawn. ROW and AREA are the glyph row
23824 and area within the row from which S is constructed. START is the
23825 index of the first glyph structure covered by S. HL is a
23826 face-override for drawing S. */
23828 #ifdef HAVE_NTGUI
23829 #define OPTIONAL_HDC(hdc) HDC hdc,
23830 #define DECLARE_HDC(hdc) HDC hdc;
23831 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23832 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23833 #endif
23835 #ifndef OPTIONAL_HDC
23836 #define OPTIONAL_HDC(hdc)
23837 #define DECLARE_HDC(hdc)
23838 #define ALLOCATE_HDC(hdc, f)
23839 #define RELEASE_HDC(hdc, f)
23840 #endif
23842 static void
23843 init_glyph_string (struct glyph_string *s,
23844 OPTIONAL_HDC (hdc)
23845 XChar2b *char2b, struct window *w, struct glyph_row *row,
23846 enum glyph_row_area area, int start, enum draw_glyphs_face hl)
23848 memset (s, 0, sizeof *s);
23849 s->w = w;
23850 s->f = XFRAME (w->frame);
23851 #ifdef HAVE_NTGUI
23852 s->hdc = hdc;
23853 #endif
23854 s->display = FRAME_X_DISPLAY (s->f);
23855 s->window = FRAME_X_WINDOW (s->f);
23856 s->char2b = char2b;
23857 s->hl = hl;
23858 s->row = row;
23859 s->area = area;
23860 s->first_glyph = row->glyphs[area] + start;
23861 s->height = row->height;
23862 s->y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
23863 s->ybase = s->y + row->ascent;
23867 /* Append the list of glyph strings with head H and tail T to the list
23868 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23870 static void
23871 append_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
23872 struct glyph_string *h, struct glyph_string *t)
23874 if (h)
23876 if (*head)
23877 (*tail)->next = h;
23878 else
23879 *head = h;
23880 h->prev = *tail;
23881 *tail = t;
23886 /* Prepend the list of glyph strings with head H and tail T to the
23887 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23888 result. */
23890 static void
23891 prepend_glyph_string_lists (struct glyph_string **head, struct glyph_string **tail,
23892 struct glyph_string *h, struct glyph_string *t)
23894 if (h)
23896 if (*head)
23897 (*head)->prev = t;
23898 else
23899 *tail = t;
23900 t->next = *head;
23901 *head = h;
23906 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23907 Set *HEAD and *TAIL to the resulting list. */
23909 static void
23910 append_glyph_string (struct glyph_string **head, struct glyph_string **tail,
23911 struct glyph_string *s)
23913 s->next = s->prev = NULL;
23914 append_glyph_string_lists (head, tail, s, s);
23918 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23919 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23920 make sure that X resources for the face returned are allocated.
23921 Value is a pointer to a realized face that is ready for display if
23922 DISPLAY_P is non-zero. */
23924 static struct face *
23925 get_char_face_and_encoding (struct frame *f, int c, int face_id,
23926 XChar2b *char2b, int display_p)
23928 struct face *face = FACE_FROM_ID (f, face_id);
23929 unsigned code = 0;
23931 if (face->font)
23933 code = face->font->driver->encode_char (face->font, c);
23935 if (code == FONT_INVALID_CODE)
23936 code = 0;
23938 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
23940 /* Make sure X resources of the face are allocated. */
23941 #ifdef HAVE_X_WINDOWS
23942 if (display_p)
23943 #endif
23945 eassert (face != NULL);
23946 PREPARE_FACE_FOR_DISPLAY (f, face);
23949 return face;
23953 /* Get face and two-byte form of character glyph GLYPH on frame F.
23954 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23955 a pointer to a realized face that is ready for display. */
23957 static struct face *
23958 get_glyph_face_and_encoding (struct frame *f, struct glyph *glyph,
23959 XChar2b *char2b, int *two_byte_p)
23961 struct face *face;
23962 unsigned code = 0;
23964 eassert (glyph->type == CHAR_GLYPH);
23965 face = FACE_FROM_ID (f, glyph->face_id);
23967 /* Make sure X resources of the face are allocated. */
23968 eassert (face != NULL);
23969 PREPARE_FACE_FOR_DISPLAY (f, face);
23971 if (two_byte_p)
23972 *two_byte_p = 0;
23974 if (face->font)
23976 if (CHAR_BYTE8_P (glyph->u.ch))
23977 code = CHAR_TO_BYTE8 (glyph->u.ch);
23978 else
23979 code = face->font->driver->encode_char (face->font, glyph->u.ch);
23981 if (code == FONT_INVALID_CODE)
23982 code = 0;
23985 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
23986 return face;
23990 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23991 Return 1 if FONT has a glyph for C, otherwise return 0. */
23993 static int
23994 get_char_glyph_code (int c, struct font *font, XChar2b *char2b)
23996 unsigned code;
23998 if (CHAR_BYTE8_P (c))
23999 code = CHAR_TO_BYTE8 (c);
24000 else
24001 code = font->driver->encode_char (font, c);
24003 if (code == FONT_INVALID_CODE)
24004 return 0;
24005 STORE_XCHAR2B (char2b, (code >> 8), (code & 0xFF));
24006 return 1;
24010 /* Fill glyph string S with composition components specified by S->cmp.
24012 BASE_FACE is the base face of the composition.
24013 S->cmp_from is the index of the first component for S.
24015 OVERLAPS non-zero means S should draw the foreground only, and use
24016 its physical height for clipping. See also draw_glyphs.
24018 Value is the index of a component not in S. */
24020 static int
24021 fill_composite_glyph_string (struct glyph_string *s, struct face *base_face,
24022 int overlaps)
24024 int i;
24025 /* For all glyphs of this composition, starting at the offset
24026 S->cmp_from, until we reach the end of the definition or encounter a
24027 glyph that requires the different face, add it to S. */
24028 struct face *face;
24030 eassert (s);
24032 s->for_overlaps = overlaps;
24033 s->face = NULL;
24034 s->font = NULL;
24035 for (i = s->cmp_from; i < s->cmp->glyph_len; i++)
24037 int c = COMPOSITION_GLYPH (s->cmp, i);
24039 /* TAB in a composition means display glyphs with padding space
24040 on the left or right. */
24041 if (c != '\t')
24043 int face_id = FACE_FOR_CHAR (s->f, base_face->ascii_face, c,
24044 -1, Qnil);
24046 face = get_char_face_and_encoding (s->f, c, face_id,
24047 s->char2b + i, 1);
24048 if (face)
24050 if (! s->face)
24052 s->face = face;
24053 s->font = s->face->font;
24055 else if (s->face != face)
24056 break;
24059 ++s->nchars;
24061 s->cmp_to = i;
24063 if (s->face == NULL)
24065 s->face = base_face->ascii_face;
24066 s->font = s->face->font;
24069 /* All glyph strings for the same composition has the same width,
24070 i.e. the width set for the first component of the composition. */
24071 s->width = s->first_glyph->pixel_width;
24073 /* If the specified font could not be loaded, use the frame's
24074 default font, but record the fact that we couldn't load it in
24075 the glyph string so that we can draw rectangles for the
24076 characters of the glyph string. */
24077 if (s->font == NULL)
24079 s->font_not_found_p = 1;
24080 s->font = FRAME_FONT (s->f);
24083 /* Adjust base line for subscript/superscript text. */
24084 s->ybase += s->first_glyph->voffset;
24086 /* This glyph string must always be drawn with 16-bit functions. */
24087 s->two_byte_p = 1;
24089 return s->cmp_to;
24092 static int
24093 fill_gstring_glyph_string (struct glyph_string *s, int face_id,
24094 int start, int end, int overlaps)
24096 struct glyph *glyph, *last;
24097 Lisp_Object lgstring;
24098 int i;
24100 s->for_overlaps = overlaps;
24101 glyph = s->row->glyphs[s->area] + start;
24102 last = s->row->glyphs[s->area] + end;
24103 s->cmp_id = glyph->u.cmp.id;
24104 s->cmp_from = glyph->slice.cmp.from;
24105 s->cmp_to = glyph->slice.cmp.to + 1;
24106 s->face = FACE_FROM_ID (s->f, face_id);
24107 lgstring = composition_gstring_from_id (s->cmp_id);
24108 s->font = XFONT_OBJECT (LGSTRING_FONT (lgstring));
24109 glyph++;
24110 while (glyph < last
24111 && glyph->u.cmp.automatic
24112 && glyph->u.cmp.id == s->cmp_id
24113 && s->cmp_to == glyph->slice.cmp.from)
24114 s->cmp_to = (glyph++)->slice.cmp.to + 1;
24116 for (i = s->cmp_from; i < s->cmp_to; i++)
24118 Lisp_Object lglyph = LGSTRING_GLYPH (lgstring, i);
24119 unsigned code = LGLYPH_CODE (lglyph);
24121 STORE_XCHAR2B ((s->char2b + i), code >> 8, code & 0xFF);
24123 s->width = composition_gstring_width (lgstring, s->cmp_from, s->cmp_to, NULL);
24124 return glyph - s->row->glyphs[s->area];
24128 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24129 See the comment of fill_glyph_string for arguments.
24130 Value is the index of the first glyph not in S. */
24133 static int
24134 fill_glyphless_glyph_string (struct glyph_string *s, int face_id,
24135 int start, int end, int overlaps)
24137 struct glyph *glyph, *last;
24138 int voffset;
24140 eassert (s->first_glyph->type == GLYPHLESS_GLYPH);
24141 s->for_overlaps = overlaps;
24142 glyph = s->row->glyphs[s->area] + start;
24143 last = s->row->glyphs[s->area] + end;
24144 voffset = glyph->voffset;
24145 s->face = FACE_FROM_ID (s->f, face_id);
24146 s->font = s->face->font ? s->face->font : FRAME_FONT (s->f);
24147 s->nchars = 1;
24148 s->width = glyph->pixel_width;
24149 glyph++;
24150 while (glyph < last
24151 && glyph->type == GLYPHLESS_GLYPH
24152 && glyph->voffset == voffset
24153 && glyph->face_id == face_id)
24155 s->nchars++;
24156 s->width += glyph->pixel_width;
24157 glyph++;
24159 s->ybase += voffset;
24160 return glyph - s->row->glyphs[s->area];
24164 /* Fill glyph string S from a sequence of character glyphs.
24166 FACE_ID is the face id of the string. START is the index of the
24167 first glyph to consider, END is the index of the last + 1.
24168 OVERLAPS non-zero means S should draw the foreground only, and use
24169 its physical height for clipping. See also draw_glyphs.
24171 Value is the index of the first glyph not in S. */
24173 static int
24174 fill_glyph_string (struct glyph_string *s, int face_id,
24175 int start, int end, int overlaps)
24177 struct glyph *glyph, *last;
24178 int voffset;
24179 int glyph_not_available_p;
24181 eassert (s->f == XFRAME (s->w->frame));
24182 eassert (s->nchars == 0);
24183 eassert (start >= 0 && end > start);
24185 s->for_overlaps = overlaps;
24186 glyph = s->row->glyphs[s->area] + start;
24187 last = s->row->glyphs[s->area] + end;
24188 voffset = glyph->voffset;
24189 s->padding_p = glyph->padding_p;
24190 glyph_not_available_p = glyph->glyph_not_available_p;
24192 while (glyph < last
24193 && glyph->type == CHAR_GLYPH
24194 && glyph->voffset == voffset
24195 /* Same face id implies same font, nowadays. */
24196 && glyph->face_id == face_id
24197 && glyph->glyph_not_available_p == glyph_not_available_p)
24199 int two_byte_p;
24201 s->face = get_glyph_face_and_encoding (s->f, glyph,
24202 s->char2b + s->nchars,
24203 &two_byte_p);
24204 s->two_byte_p = two_byte_p;
24205 ++s->nchars;
24206 eassert (s->nchars <= end - start);
24207 s->width += glyph->pixel_width;
24208 if (glyph++->padding_p != s->padding_p)
24209 break;
24212 s->font = s->face->font;
24214 /* If the specified font could not be loaded, use the frame's font,
24215 but record the fact that we couldn't load it in
24216 S->font_not_found_p so that we can draw rectangles for the
24217 characters of the glyph string. */
24218 if (s->font == NULL || glyph_not_available_p)
24220 s->font_not_found_p = 1;
24221 s->font = FRAME_FONT (s->f);
24224 /* Adjust base line for subscript/superscript text. */
24225 s->ybase += voffset;
24227 eassert (s->face && s->face->gc);
24228 return glyph - s->row->glyphs[s->area];
24232 /* Fill glyph string S from image glyph S->first_glyph. */
24234 static void
24235 fill_image_glyph_string (struct glyph_string *s)
24237 eassert (s->first_glyph->type == IMAGE_GLYPH);
24238 s->img = IMAGE_FROM_ID (s->f, s->first_glyph->u.img_id);
24239 eassert (s->img);
24240 s->slice = s->first_glyph->slice.img;
24241 s->face = FACE_FROM_ID (s->f, s->first_glyph->face_id);
24242 s->font = s->face->font;
24243 s->width = s->first_glyph->pixel_width;
24245 /* Adjust base line for subscript/superscript text. */
24246 s->ybase += s->first_glyph->voffset;
24250 /* Fill glyph string S from a sequence of stretch glyphs.
24252 START is the index of the first glyph to consider,
24253 END is the index of the last + 1.
24255 Value is the index of the first glyph not in S. */
24257 static int
24258 fill_stretch_glyph_string (struct glyph_string *s, int start, int end)
24260 struct glyph *glyph, *last;
24261 int voffset, face_id;
24263 eassert (s->first_glyph->type == STRETCH_GLYPH);
24265 glyph = s->row->glyphs[s->area] + start;
24266 last = s->row->glyphs[s->area] + end;
24267 face_id = glyph->face_id;
24268 s->face = FACE_FROM_ID (s->f, face_id);
24269 s->font = s->face->font;
24270 s->width = glyph->pixel_width;
24271 s->nchars = 1;
24272 voffset = glyph->voffset;
24274 for (++glyph;
24275 (glyph < last
24276 && glyph->type == STRETCH_GLYPH
24277 && glyph->voffset == voffset
24278 && glyph->face_id == face_id);
24279 ++glyph)
24280 s->width += glyph->pixel_width;
24282 /* Adjust base line for subscript/superscript text. */
24283 s->ybase += voffset;
24285 /* The case that face->gc == 0 is handled when drawing the glyph
24286 string by calling PREPARE_FACE_FOR_DISPLAY. */
24287 eassert (s->face);
24288 return glyph - s->row->glyphs[s->area];
24291 static struct font_metrics *
24292 get_per_char_metric (struct font *font, XChar2b *char2b)
24294 static struct font_metrics metrics;
24295 unsigned code;
24297 if (! font)
24298 return NULL;
24299 code = (XCHAR2B_BYTE1 (char2b) << 8) | XCHAR2B_BYTE2 (char2b);
24300 if (code == FONT_INVALID_CODE)
24301 return NULL;
24302 font->driver->text_extents (font, &code, 1, &metrics);
24303 return &metrics;
24306 /* EXPORT for RIF:
24307 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24308 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24309 assumed to be zero. */
24311 void
24312 x_get_glyph_overhangs (struct glyph *glyph, struct frame *f, int *left, int *right)
24314 *left = *right = 0;
24316 if (glyph->type == CHAR_GLYPH)
24318 struct face *face;
24319 XChar2b char2b;
24320 struct font_metrics *pcm;
24322 face = get_glyph_face_and_encoding (f, glyph, &char2b, NULL);
24323 if (face->font && (pcm = get_per_char_metric (face->font, &char2b)))
24325 if (pcm->rbearing > pcm->width)
24326 *right = pcm->rbearing - pcm->width;
24327 if (pcm->lbearing < 0)
24328 *left = -pcm->lbearing;
24331 else if (glyph->type == COMPOSITE_GLYPH)
24333 if (! glyph->u.cmp.automatic)
24335 struct composition *cmp = composition_table[glyph->u.cmp.id];
24337 if (cmp->rbearing > cmp->pixel_width)
24338 *right = cmp->rbearing - cmp->pixel_width;
24339 if (cmp->lbearing < 0)
24340 *left = - cmp->lbearing;
24342 else
24344 Lisp_Object gstring = composition_gstring_from_id (glyph->u.cmp.id);
24345 struct font_metrics metrics;
24347 composition_gstring_width (gstring, glyph->slice.cmp.from,
24348 glyph->slice.cmp.to + 1, &metrics);
24349 if (metrics.rbearing > metrics.width)
24350 *right = metrics.rbearing - metrics.width;
24351 if (metrics.lbearing < 0)
24352 *left = - metrics.lbearing;
24358 /* Return the index of the first glyph preceding glyph string S that
24359 is overwritten by S because of S's left overhang. Value is -1
24360 if no glyphs are overwritten. */
24362 static int
24363 left_overwritten (struct glyph_string *s)
24365 int k;
24367 if (s->left_overhang)
24369 int x = 0, i;
24370 struct glyph *glyphs = s->row->glyphs[s->area];
24371 int first = s->first_glyph - glyphs;
24373 for (i = first - 1; i >= 0 && x > -s->left_overhang; --i)
24374 x -= glyphs[i].pixel_width;
24376 k = i + 1;
24378 else
24379 k = -1;
24381 return k;
24385 /* Return the index of the first glyph preceding glyph string S that
24386 is overwriting S because of its right overhang. Value is -1 if no
24387 glyph in front of S overwrites S. */
24389 static int
24390 left_overwriting (struct glyph_string *s)
24392 int i, k, x;
24393 struct glyph *glyphs = s->row->glyphs[s->area];
24394 int first = s->first_glyph - glyphs;
24396 k = -1;
24397 x = 0;
24398 for (i = first - 1; i >= 0; --i)
24400 int left, right;
24401 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24402 if (x + right > 0)
24403 k = i;
24404 x -= glyphs[i].pixel_width;
24407 return k;
24411 /* Return the index of the last glyph following glyph string S that is
24412 overwritten by S because of S's right overhang. Value is -1 if
24413 no such glyph is found. */
24415 static int
24416 right_overwritten (struct glyph_string *s)
24418 int k = -1;
24420 if (s->right_overhang)
24422 int x = 0, i;
24423 struct glyph *glyphs = s->row->glyphs[s->area];
24424 int first = (s->first_glyph - glyphs
24425 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24426 int end = s->row->used[s->area];
24428 for (i = first; i < end && s->right_overhang > x; ++i)
24429 x += glyphs[i].pixel_width;
24431 k = i;
24434 return k;
24438 /* Return the index of the last glyph following glyph string S that
24439 overwrites S because of its left overhang. Value is negative
24440 if no such glyph is found. */
24442 static int
24443 right_overwriting (struct glyph_string *s)
24445 int i, k, x;
24446 int end = s->row->used[s->area];
24447 struct glyph *glyphs = s->row->glyphs[s->area];
24448 int first = (s->first_glyph - glyphs
24449 + (s->first_glyph->type == COMPOSITE_GLYPH ? 1 : s->nchars));
24451 k = -1;
24452 x = 0;
24453 for (i = first; i < end; ++i)
24455 int left, right;
24456 x_get_glyph_overhangs (glyphs + i, s->f, &left, &right);
24457 if (x - left < 0)
24458 k = i;
24459 x += glyphs[i].pixel_width;
24462 return k;
24466 /* Set background width of glyph string S. START is the index of the
24467 first glyph following S. LAST_X is the right-most x-position + 1
24468 in the drawing area. */
24470 static void
24471 set_glyph_string_background_width (struct glyph_string *s, int start, int last_x)
24473 /* If the face of this glyph string has to be drawn to the end of
24474 the drawing area, set S->extends_to_end_of_line_p. */
24476 if (start == s->row->used[s->area]
24477 && ((s->row->fill_line_p
24478 && (s->hl == DRAW_NORMAL_TEXT
24479 || s->hl == DRAW_IMAGE_RAISED
24480 || s->hl == DRAW_IMAGE_SUNKEN))
24481 || s->hl == DRAW_MOUSE_FACE))
24482 s->extends_to_end_of_line_p = 1;
24484 /* If S extends its face to the end of the line, set its
24485 background_width to the distance to the right edge of the drawing
24486 area. */
24487 if (s->extends_to_end_of_line_p)
24488 s->background_width = last_x - s->x + 1;
24489 else
24490 s->background_width = s->width;
24494 /* Compute overhangs and x-positions for glyph string S and its
24495 predecessors, or successors. X is the starting x-position for S.
24496 BACKWARD_P non-zero means process predecessors. */
24498 static void
24499 compute_overhangs_and_x (struct glyph_string *s, int x, int backward_p)
24501 if (backward_p)
24503 while (s)
24505 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24506 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24507 x -= s->width;
24508 s->x = x;
24509 s = s->prev;
24512 else
24514 while (s)
24516 if (FRAME_RIF (s->f)->compute_glyph_string_overhangs)
24517 FRAME_RIF (s->f)->compute_glyph_string_overhangs (s);
24518 s->x = x;
24519 x += s->width;
24520 s = s->next;
24527 /* The following macros are only called from draw_glyphs below.
24528 They reference the following parameters of that function directly:
24529 `w', `row', `area', and `overlap_p'
24530 as well as the following local variables:
24531 `s', `f', and `hdc' (in W32) */
24533 #ifdef HAVE_NTGUI
24534 /* On W32, silently add local `hdc' variable to argument list of
24535 init_glyph_string. */
24536 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24537 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24538 #else
24539 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24540 init_glyph_string (s, char2b, w, row, area, start, hl)
24541 #endif
24543 /* Add a glyph string for a stretch glyph to the list of strings
24544 between HEAD and TAIL. START is the index of the stretch glyph in
24545 row area AREA of glyph row ROW. END is the index of the last glyph
24546 in that glyph row area. X is the current output position assigned
24547 to the new glyph string constructed. HL overrides that face of the
24548 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24549 is the right-most x-position of the drawing area. */
24551 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24552 and below -- keep them on one line. */
24553 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24554 do \
24556 s = alloca (sizeof *s); \
24557 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24558 START = fill_stretch_glyph_string (s, START, END); \
24559 append_glyph_string (&HEAD, &TAIL, s); \
24560 s->x = (X); \
24562 while (0)
24565 /* Add a glyph string for an image glyph to the list of strings
24566 between HEAD and TAIL. START is the index of the image glyph in
24567 row area AREA of glyph row ROW. END is the index of the last glyph
24568 in that glyph row area. X is the current output position assigned
24569 to the new glyph string constructed. HL overrides that face of the
24570 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24571 is the right-most x-position of the drawing area. */
24573 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24574 do \
24576 s = alloca (sizeof *s); \
24577 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24578 fill_image_glyph_string (s); \
24579 append_glyph_string (&HEAD, &TAIL, s); \
24580 ++START; \
24581 s->x = (X); \
24583 while (0)
24586 /* Add a glyph string for a sequence of character glyphs to the list
24587 of strings between HEAD and TAIL. START is the index of the first
24588 glyph in row area AREA of glyph row ROW that is part of the new
24589 glyph string. END is the index of the last glyph in that glyph row
24590 area. X is the current output position assigned to the new glyph
24591 string constructed. HL overrides that face of the glyph; e.g. it
24592 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24593 right-most x-position of the drawing area. */
24595 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24596 do \
24598 int face_id; \
24599 XChar2b *char2b; \
24601 face_id = (row)->glyphs[area][START].face_id; \
24603 s = alloca (sizeof *s); \
24604 char2b = alloca ((END - START) * sizeof *char2b); \
24605 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24606 append_glyph_string (&HEAD, &TAIL, s); \
24607 s->x = (X); \
24608 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24610 while (0)
24613 /* Add a glyph string for a composite sequence to the list of strings
24614 between HEAD and TAIL. START is the index of the first glyph in
24615 row area AREA of glyph row ROW that is part of the new glyph
24616 string. END is the index of the last glyph in that glyph row area.
24617 X is the current output position assigned to the new glyph string
24618 constructed. HL overrides that face of the glyph; e.g. it is
24619 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24620 x-position of the drawing area. */
24622 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24623 do { \
24624 int face_id = (row)->glyphs[area][START].face_id; \
24625 struct face *base_face = FACE_FROM_ID (f, face_id); \
24626 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24627 struct composition *cmp = composition_table[cmp_id]; \
24628 XChar2b *char2b; \
24629 struct glyph_string *first_s = NULL; \
24630 int n; \
24632 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24634 /* Make glyph_strings for each glyph sequence that is drawable by \
24635 the same face, and append them to HEAD/TAIL. */ \
24636 for (n = 0; n < cmp->glyph_len;) \
24638 s = alloca (sizeof *s); \
24639 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24640 append_glyph_string (&(HEAD), &(TAIL), s); \
24641 s->cmp = cmp; \
24642 s->cmp_from = n; \
24643 s->x = (X); \
24644 if (n == 0) \
24645 first_s = s; \
24646 n = fill_composite_glyph_string (s, base_face, overlaps); \
24649 ++START; \
24650 s = first_s; \
24651 } while (0)
24654 /* Add a glyph string for a glyph-string sequence to the list of strings
24655 between HEAD and TAIL. */
24657 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24658 do { \
24659 int face_id; \
24660 XChar2b *char2b; \
24661 Lisp_Object gstring; \
24663 face_id = (row)->glyphs[area][START].face_id; \
24664 gstring = (composition_gstring_from_id \
24665 ((row)->glyphs[area][START].u.cmp.id)); \
24666 s = alloca (sizeof *s); \
24667 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24668 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24669 append_glyph_string (&(HEAD), &(TAIL), s); \
24670 s->x = (X); \
24671 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24672 } while (0)
24675 /* Add a glyph string for a sequence of glyphless character's glyphs
24676 to the list of strings between HEAD and TAIL. The meanings of
24677 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24679 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24680 do \
24682 int face_id; \
24684 face_id = (row)->glyphs[area][START].face_id; \
24686 s = alloca (sizeof *s); \
24687 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24688 append_glyph_string (&HEAD, &TAIL, s); \
24689 s->x = (X); \
24690 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24691 overlaps); \
24693 while (0)
24696 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24697 of AREA of glyph row ROW on window W between indices START and END.
24698 HL overrides the face for drawing glyph strings, e.g. it is
24699 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24700 x-positions of the drawing area.
24702 This is an ugly monster macro construct because we must use alloca
24703 to allocate glyph strings (because draw_glyphs can be called
24704 asynchronously). */
24706 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24707 do \
24709 HEAD = TAIL = NULL; \
24710 while (START < END) \
24712 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24713 switch (first_glyph->type) \
24715 case CHAR_GLYPH: \
24716 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24717 HL, X, LAST_X); \
24718 break; \
24720 case COMPOSITE_GLYPH: \
24721 if (first_glyph->u.cmp.automatic) \
24722 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24723 HL, X, LAST_X); \
24724 else \
24725 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24726 HL, X, LAST_X); \
24727 break; \
24729 case STRETCH_GLYPH: \
24730 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24731 HL, X, LAST_X); \
24732 break; \
24734 case IMAGE_GLYPH: \
24735 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24736 HL, X, LAST_X); \
24737 break; \
24739 case GLYPHLESS_GLYPH: \
24740 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24741 HL, X, LAST_X); \
24742 break; \
24744 default: \
24745 emacs_abort (); \
24748 if (s) \
24750 set_glyph_string_background_width (s, START, LAST_X); \
24751 (X) += s->width; \
24754 } while (0)
24757 /* Draw glyphs between START and END in AREA of ROW on window W,
24758 starting at x-position X. X is relative to AREA in W. HL is a
24759 face-override with the following meaning:
24761 DRAW_NORMAL_TEXT draw normally
24762 DRAW_CURSOR draw in cursor face
24763 DRAW_MOUSE_FACE draw in mouse face.
24764 DRAW_INVERSE_VIDEO draw in mode line face
24765 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24766 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24768 If OVERLAPS is non-zero, draw only the foreground of characters and
24769 clip to the physical height of ROW. Non-zero value also defines
24770 the overlapping part to be drawn:
24772 OVERLAPS_PRED overlap with preceding rows
24773 OVERLAPS_SUCC overlap with succeeding rows
24774 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24775 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24777 Value is the x-position reached, relative to AREA of W. */
24779 static int
24780 draw_glyphs (struct window *w, int x, struct glyph_row *row,
24781 enum glyph_row_area area, ptrdiff_t start, ptrdiff_t end,
24782 enum draw_glyphs_face hl, int overlaps)
24784 struct glyph_string *head, *tail;
24785 struct glyph_string *s;
24786 struct glyph_string *clip_head = NULL, *clip_tail = NULL;
24787 int i, j, x_reached, last_x, area_left = 0;
24788 struct frame *f = XFRAME (WINDOW_FRAME (w));
24789 DECLARE_HDC (hdc);
24791 ALLOCATE_HDC (hdc, f);
24793 /* Let's rather be paranoid than getting a SEGV. */
24794 end = min (end, row->used[area]);
24795 start = clip_to_bounds (0, start, end);
24797 /* Translate X to frame coordinates. Set last_x to the right
24798 end of the drawing area. */
24799 if (row->full_width_p)
24801 /* X is relative to the left edge of W, without scroll bars
24802 or fringes. */
24803 area_left = WINDOW_LEFT_EDGE_X (w);
24804 last_x = (WINDOW_LEFT_EDGE_X (w) + WINDOW_PIXEL_WIDTH (w)
24805 - (row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
24807 else
24809 area_left = window_box_left (w, area);
24810 last_x = area_left + window_box_width (w, area);
24812 x += area_left;
24814 /* Build a doubly-linked list of glyph_string structures between
24815 head and tail from what we have to draw. Note that the macro
24816 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24817 the reason we use a separate variable `i'. */
24818 i = start;
24819 BUILD_GLYPH_STRINGS (i, end, head, tail, hl, x, last_x);
24820 if (tail)
24821 x_reached = tail->x + tail->background_width;
24822 else
24823 x_reached = x;
24825 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24826 the row, redraw some glyphs in front or following the glyph
24827 strings built above. */
24828 if (head && !overlaps && row->contains_overlapping_glyphs_p)
24830 struct glyph_string *h, *t;
24831 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
24832 int mouse_beg_col IF_LINT (= 0), mouse_end_col IF_LINT (= 0);
24833 int check_mouse_face = 0;
24834 int dummy_x = 0;
24836 /* If mouse highlighting is on, we may need to draw adjacent
24837 glyphs using mouse-face highlighting. */
24838 if (area == TEXT_AREA && row->mouse_face_p
24839 && hlinfo->mouse_face_beg_row >= 0
24840 && hlinfo->mouse_face_end_row >= 0)
24842 ptrdiff_t row_vpos = MATRIX_ROW_VPOS (row, w->current_matrix);
24844 if (row_vpos >= hlinfo->mouse_face_beg_row
24845 && row_vpos <= hlinfo->mouse_face_end_row)
24847 check_mouse_face = 1;
24848 mouse_beg_col = (row_vpos == hlinfo->mouse_face_beg_row)
24849 ? hlinfo->mouse_face_beg_col : 0;
24850 mouse_end_col = (row_vpos == hlinfo->mouse_face_end_row)
24851 ? hlinfo->mouse_face_end_col
24852 : row->used[TEXT_AREA];
24856 /* Compute overhangs for all glyph strings. */
24857 if (FRAME_RIF (f)->compute_glyph_string_overhangs)
24858 for (s = head; s; s = s->next)
24859 FRAME_RIF (f)->compute_glyph_string_overhangs (s);
24861 /* Prepend glyph strings for glyphs in front of the first glyph
24862 string that are overwritten because of the first glyph
24863 string's left overhang. The background of all strings
24864 prepended must be drawn because the first glyph string
24865 draws over it. */
24866 i = left_overwritten (head);
24867 if (i >= 0)
24869 enum draw_glyphs_face overlap_hl;
24871 /* If this row contains mouse highlighting, attempt to draw
24872 the overlapped glyphs with the correct highlight. This
24873 code fails if the overlap encompasses more than one glyph
24874 and mouse-highlight spans only some of these glyphs.
24875 However, making it work perfectly involves a lot more
24876 code, and I don't know if the pathological case occurs in
24877 practice, so we'll stick to this for now. --- cyd */
24878 if (check_mouse_face
24879 && mouse_beg_col < start && mouse_end_col > i)
24880 overlap_hl = DRAW_MOUSE_FACE;
24881 else
24882 overlap_hl = DRAW_NORMAL_TEXT;
24884 j = i;
24885 BUILD_GLYPH_STRINGS (j, start, h, t,
24886 overlap_hl, dummy_x, last_x);
24887 start = i;
24888 compute_overhangs_and_x (t, head->x, 1);
24889 prepend_glyph_string_lists (&head, &tail, h, t);
24890 clip_head = head;
24893 /* Prepend glyph strings for glyphs in front of the first glyph
24894 string that overwrite that glyph string because of their
24895 right overhang. For these strings, only the foreground must
24896 be drawn, because it draws over the glyph string at `head'.
24897 The background must not be drawn because this would overwrite
24898 right overhangs of preceding glyphs for which no glyph
24899 strings exist. */
24900 i = left_overwriting (head);
24901 if (i >= 0)
24903 enum draw_glyphs_face overlap_hl;
24905 if (check_mouse_face
24906 && mouse_beg_col < start && mouse_end_col > i)
24907 overlap_hl = DRAW_MOUSE_FACE;
24908 else
24909 overlap_hl = DRAW_NORMAL_TEXT;
24911 clip_head = head;
24912 BUILD_GLYPH_STRINGS (i, start, h, t,
24913 overlap_hl, dummy_x, last_x);
24914 for (s = h; s; s = s->next)
24915 s->background_filled_p = 1;
24916 compute_overhangs_and_x (t, head->x, 1);
24917 prepend_glyph_string_lists (&head, &tail, h, t);
24920 /* Append glyphs strings for glyphs following the last glyph
24921 string tail that are overwritten by tail. The background of
24922 these strings has to be drawn because tail's foreground draws
24923 over it. */
24924 i = right_overwritten (tail);
24925 if (i >= 0)
24927 enum draw_glyphs_face overlap_hl;
24929 if (check_mouse_face
24930 && mouse_beg_col < i && mouse_end_col > end)
24931 overlap_hl = DRAW_MOUSE_FACE;
24932 else
24933 overlap_hl = DRAW_NORMAL_TEXT;
24935 BUILD_GLYPH_STRINGS (end, i, h, t,
24936 overlap_hl, x, last_x);
24937 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24938 we don't have `end = i;' here. */
24939 compute_overhangs_and_x (h, tail->x + tail->width, 0);
24940 append_glyph_string_lists (&head, &tail, h, t);
24941 clip_tail = tail;
24944 /* Append glyph strings for glyphs following the last glyph
24945 string tail that overwrite tail. The foreground of such
24946 glyphs has to be drawn because it writes into the background
24947 of tail. The background must not be drawn because it could
24948 paint over the foreground of following glyphs. */
24949 i = right_overwriting (tail);
24950 if (i >= 0)
24952 enum draw_glyphs_face overlap_hl;
24953 if (check_mouse_face
24954 && mouse_beg_col < i && mouse_end_col > end)
24955 overlap_hl = DRAW_MOUSE_FACE;
24956 else
24957 overlap_hl = DRAW_NORMAL_TEXT;
24959 clip_tail = tail;
24960 i++; /* We must include the Ith glyph. */
24961 BUILD_GLYPH_STRINGS (end, i, h, t,
24962 overlap_hl, x, last_x);
24963 for (s = h; s; s = s->next)
24964 s->background_filled_p = 1;
24965 compute_overhangs_and_x (h, tail->x + tail->width, 0);
24966 append_glyph_string_lists (&head, &tail, h, t);
24968 if (clip_head || clip_tail)
24969 for (s = head; s; s = s->next)
24971 s->clip_head = clip_head;
24972 s->clip_tail = clip_tail;
24976 /* Draw all strings. */
24977 for (s = head; s; s = s->next)
24978 FRAME_RIF (f)->draw_glyph_string (s);
24980 #ifndef HAVE_NS
24981 /* When focus a sole frame and move horizontally, this sets on_p to 0
24982 causing a failure to erase prev cursor position. */
24983 if (area == TEXT_AREA
24984 && !row->full_width_p
24985 /* When drawing overlapping rows, only the glyph strings'
24986 foreground is drawn, which doesn't erase a cursor
24987 completely. */
24988 && !overlaps)
24990 int x0 = clip_head ? clip_head->x : (head ? head->x : x);
24991 int x1 = (clip_tail ? clip_tail->x + clip_tail->background_width
24992 : (tail ? tail->x + tail->background_width : x));
24993 x0 -= area_left;
24994 x1 -= area_left;
24996 notice_overwritten_cursor (w, TEXT_AREA, x0, x1,
24997 row->y, MATRIX_ROW_BOTTOM_Y (row));
24999 #endif
25001 /* Value is the x-position up to which drawn, relative to AREA of W.
25002 This doesn't include parts drawn because of overhangs. */
25003 if (row->full_width_p)
25004 x_reached = FRAME_TO_WINDOW_PIXEL_X (w, x_reached);
25005 else
25006 x_reached -= area_left;
25008 RELEASE_HDC (hdc, f);
25010 return x_reached;
25013 /* Expand row matrix if too narrow. Don't expand if area
25014 is not present. */
25016 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25018 if (!it->f->fonts_changed \
25019 && (it->glyph_row->glyphs[area] \
25020 < it->glyph_row->glyphs[area + 1])) \
25022 it->w->ncols_scale_factor++; \
25023 it->f->fonts_changed = 1; \
25027 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25028 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25030 static void
25031 append_glyph (struct it *it)
25033 struct glyph *glyph;
25034 enum glyph_row_area area = it->area;
25036 eassert (it->glyph_row);
25037 eassert (it->char_to_display != '\n' && it->char_to_display != '\t');
25039 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25040 if (glyph < it->glyph_row->glyphs[area + 1])
25042 /* If the glyph row is reversed, we need to prepend the glyph
25043 rather than append it. */
25044 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25046 struct glyph *g;
25048 /* Make room for the additional glyph. */
25049 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25050 g[1] = *g;
25051 glyph = it->glyph_row->glyphs[area];
25053 glyph->charpos = CHARPOS (it->position);
25054 glyph->object = it->object;
25055 if (it->pixel_width > 0)
25057 glyph->pixel_width = it->pixel_width;
25058 glyph->padding_p = 0;
25060 else
25062 /* Assure at least 1-pixel width. Otherwise, cursor can't
25063 be displayed correctly. */
25064 glyph->pixel_width = 1;
25065 glyph->padding_p = 1;
25067 glyph->ascent = it->ascent;
25068 glyph->descent = it->descent;
25069 glyph->voffset = it->voffset;
25070 glyph->type = CHAR_GLYPH;
25071 glyph->avoid_cursor_p = it->avoid_cursor_p;
25072 glyph->multibyte_p = it->multibyte_p;
25073 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25075 /* In R2L rows, the left and the right box edges need to be
25076 drawn in reverse direction. */
25077 glyph->right_box_line_p = it->start_of_box_run_p;
25078 glyph->left_box_line_p = it->end_of_box_run_p;
25080 else
25082 glyph->left_box_line_p = it->start_of_box_run_p;
25083 glyph->right_box_line_p = it->end_of_box_run_p;
25085 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25086 || it->phys_descent > it->descent);
25087 glyph->glyph_not_available_p = it->glyph_not_available_p;
25088 glyph->face_id = it->face_id;
25089 glyph->u.ch = it->char_to_display;
25090 glyph->slice.img = null_glyph_slice;
25091 glyph->font_type = FONT_TYPE_UNKNOWN;
25092 if (it->bidi_p)
25094 glyph->resolved_level = it->bidi_it.resolved_level;
25095 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25096 emacs_abort ();
25097 glyph->bidi_type = it->bidi_it.type;
25099 else
25101 glyph->resolved_level = 0;
25102 glyph->bidi_type = UNKNOWN_BT;
25104 ++it->glyph_row->used[area];
25106 else
25107 IT_EXPAND_MATRIX_WIDTH (it, area);
25110 /* Store one glyph for the composition IT->cmp_it.id in
25111 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25112 non-null. */
25114 static void
25115 append_composite_glyph (struct it *it)
25117 struct glyph *glyph;
25118 enum glyph_row_area area = it->area;
25120 eassert (it->glyph_row);
25122 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25123 if (glyph < it->glyph_row->glyphs[area + 1])
25125 /* If the glyph row is reversed, we need to prepend the glyph
25126 rather than append it. */
25127 if (it->glyph_row->reversed_p && it->area == TEXT_AREA)
25129 struct glyph *g;
25131 /* Make room for the new glyph. */
25132 for (g = glyph - 1; g >= it->glyph_row->glyphs[it->area]; g--)
25133 g[1] = *g;
25134 glyph = it->glyph_row->glyphs[it->area];
25136 glyph->charpos = it->cmp_it.charpos;
25137 glyph->object = it->object;
25138 glyph->pixel_width = it->pixel_width;
25139 glyph->ascent = it->ascent;
25140 glyph->descent = it->descent;
25141 glyph->voffset = it->voffset;
25142 glyph->type = COMPOSITE_GLYPH;
25143 if (it->cmp_it.ch < 0)
25145 glyph->u.cmp.automatic = 0;
25146 glyph->u.cmp.id = it->cmp_it.id;
25147 glyph->slice.cmp.from = glyph->slice.cmp.to = 0;
25149 else
25151 glyph->u.cmp.automatic = 1;
25152 glyph->u.cmp.id = it->cmp_it.id;
25153 glyph->slice.cmp.from = it->cmp_it.from;
25154 glyph->slice.cmp.to = it->cmp_it.to - 1;
25156 glyph->avoid_cursor_p = it->avoid_cursor_p;
25157 glyph->multibyte_p = it->multibyte_p;
25158 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25160 /* In R2L rows, the left and the right box edges need to be
25161 drawn in reverse direction. */
25162 glyph->right_box_line_p = it->start_of_box_run_p;
25163 glyph->left_box_line_p = it->end_of_box_run_p;
25165 else
25167 glyph->left_box_line_p = it->start_of_box_run_p;
25168 glyph->right_box_line_p = it->end_of_box_run_p;
25170 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25171 || it->phys_descent > it->descent);
25172 glyph->padding_p = 0;
25173 glyph->glyph_not_available_p = 0;
25174 glyph->face_id = it->face_id;
25175 glyph->font_type = FONT_TYPE_UNKNOWN;
25176 if (it->bidi_p)
25178 glyph->resolved_level = it->bidi_it.resolved_level;
25179 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25180 emacs_abort ();
25181 glyph->bidi_type = it->bidi_it.type;
25183 ++it->glyph_row->used[area];
25185 else
25186 IT_EXPAND_MATRIX_WIDTH (it, area);
25190 /* Change IT->ascent and IT->height according to the setting of
25191 IT->voffset. */
25193 static void
25194 take_vertical_position_into_account (struct it *it)
25196 if (it->voffset)
25198 if (it->voffset < 0)
25199 /* Increase the ascent so that we can display the text higher
25200 in the line. */
25201 it->ascent -= it->voffset;
25202 else
25203 /* Increase the descent so that we can display the text lower
25204 in the line. */
25205 it->descent += it->voffset;
25210 /* Produce glyphs/get display metrics for the image IT is loaded with.
25211 See the description of struct display_iterator in dispextern.h for
25212 an overview of struct display_iterator. */
25214 static void
25215 produce_image_glyph (struct it *it)
25217 struct image *img;
25218 struct face *face;
25219 int glyph_ascent, crop;
25220 struct glyph_slice slice;
25222 eassert (it->what == IT_IMAGE);
25224 face = FACE_FROM_ID (it->f, it->face_id);
25225 eassert (face);
25226 /* Make sure X resources of the face is loaded. */
25227 PREPARE_FACE_FOR_DISPLAY (it->f, face);
25229 if (it->image_id < 0)
25231 /* Fringe bitmap. */
25232 it->ascent = it->phys_ascent = 0;
25233 it->descent = it->phys_descent = 0;
25234 it->pixel_width = 0;
25235 it->nglyphs = 0;
25236 return;
25239 img = IMAGE_FROM_ID (it->f, it->image_id);
25240 eassert (img);
25241 /* Make sure X resources of the image is loaded. */
25242 prepare_image_for_display (it->f, img);
25244 slice.x = slice.y = 0;
25245 slice.width = img->width;
25246 slice.height = img->height;
25248 if (INTEGERP (it->slice.x))
25249 slice.x = XINT (it->slice.x);
25250 else if (FLOATP (it->slice.x))
25251 slice.x = XFLOAT_DATA (it->slice.x) * img->width;
25253 if (INTEGERP (it->slice.y))
25254 slice.y = XINT (it->slice.y);
25255 else if (FLOATP (it->slice.y))
25256 slice.y = XFLOAT_DATA (it->slice.y) * img->height;
25258 if (INTEGERP (it->slice.width))
25259 slice.width = XINT (it->slice.width);
25260 else if (FLOATP (it->slice.width))
25261 slice.width = XFLOAT_DATA (it->slice.width) * img->width;
25263 if (INTEGERP (it->slice.height))
25264 slice.height = XINT (it->slice.height);
25265 else if (FLOATP (it->slice.height))
25266 slice.height = XFLOAT_DATA (it->slice.height) * img->height;
25268 if (slice.x >= img->width)
25269 slice.x = img->width;
25270 if (slice.y >= img->height)
25271 slice.y = img->height;
25272 if (slice.x + slice.width >= img->width)
25273 slice.width = img->width - slice.x;
25274 if (slice.y + slice.height > img->height)
25275 slice.height = img->height - slice.y;
25277 if (slice.width == 0 || slice.height == 0)
25278 return;
25280 it->ascent = it->phys_ascent = glyph_ascent = image_ascent (img, face, &slice);
25282 it->descent = slice.height - glyph_ascent;
25283 if (slice.y == 0)
25284 it->descent += img->vmargin;
25285 if (slice.y + slice.height == img->height)
25286 it->descent += img->vmargin;
25287 it->phys_descent = it->descent;
25289 it->pixel_width = slice.width;
25290 if (slice.x == 0)
25291 it->pixel_width += img->hmargin;
25292 if (slice.x + slice.width == img->width)
25293 it->pixel_width += img->hmargin;
25295 /* It's quite possible for images to have an ascent greater than
25296 their height, so don't get confused in that case. */
25297 if (it->descent < 0)
25298 it->descent = 0;
25300 it->nglyphs = 1;
25302 if (face->box != FACE_NO_BOX)
25304 if (face->box_line_width > 0)
25306 if (slice.y == 0)
25307 it->ascent += face->box_line_width;
25308 if (slice.y + slice.height == img->height)
25309 it->descent += face->box_line_width;
25312 if (it->start_of_box_run_p && slice.x == 0)
25313 it->pixel_width += eabs (face->box_line_width);
25314 if (it->end_of_box_run_p && slice.x + slice.width == img->width)
25315 it->pixel_width += eabs (face->box_line_width);
25318 take_vertical_position_into_account (it);
25320 /* Automatically crop wide image glyphs at right edge so we can
25321 draw the cursor on same display row. */
25322 if ((crop = it->pixel_width - (it->last_visible_x - it->current_x), crop > 0)
25323 && (it->hpos == 0 || it->pixel_width > it->last_visible_x / 4))
25325 it->pixel_width -= crop;
25326 slice.width -= crop;
25329 if (it->glyph_row)
25331 struct glyph *glyph;
25332 enum glyph_row_area area = it->area;
25334 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25335 if (glyph < it->glyph_row->glyphs[area + 1])
25337 glyph->charpos = CHARPOS (it->position);
25338 glyph->object = it->object;
25339 glyph->pixel_width = it->pixel_width;
25340 glyph->ascent = glyph_ascent;
25341 glyph->descent = it->descent;
25342 glyph->voffset = it->voffset;
25343 glyph->type = IMAGE_GLYPH;
25344 glyph->avoid_cursor_p = it->avoid_cursor_p;
25345 glyph->multibyte_p = it->multibyte_p;
25346 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25348 /* In R2L rows, the left and the right box edges need to be
25349 drawn in reverse direction. */
25350 glyph->right_box_line_p = it->start_of_box_run_p;
25351 glyph->left_box_line_p = it->end_of_box_run_p;
25353 else
25355 glyph->left_box_line_p = it->start_of_box_run_p;
25356 glyph->right_box_line_p = it->end_of_box_run_p;
25358 glyph->overlaps_vertically_p = 0;
25359 glyph->padding_p = 0;
25360 glyph->glyph_not_available_p = 0;
25361 glyph->face_id = it->face_id;
25362 glyph->u.img_id = img->id;
25363 glyph->slice.img = slice;
25364 glyph->font_type = FONT_TYPE_UNKNOWN;
25365 if (it->bidi_p)
25367 glyph->resolved_level = it->bidi_it.resolved_level;
25368 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25369 emacs_abort ();
25370 glyph->bidi_type = it->bidi_it.type;
25372 ++it->glyph_row->used[area];
25374 else
25375 IT_EXPAND_MATRIX_WIDTH (it, area);
25380 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25381 of the glyph, WIDTH and HEIGHT are the width and height of the
25382 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25384 static void
25385 append_stretch_glyph (struct it *it, Lisp_Object object,
25386 int width, int height, int ascent)
25388 struct glyph *glyph;
25389 enum glyph_row_area area = it->area;
25391 eassert (ascent >= 0 && ascent <= height);
25393 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25394 if (glyph < it->glyph_row->glyphs[area + 1])
25396 /* If the glyph row is reversed, we need to prepend the glyph
25397 rather than append it. */
25398 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25400 struct glyph *g;
25402 /* Make room for the additional glyph. */
25403 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25404 g[1] = *g;
25405 glyph = it->glyph_row->glyphs[area];
25407 /* Decrease the width of the first glyph of the row that
25408 begins before first_visible_x (e.g., due to hscroll).
25409 This is so the overall width of the row becomes smaller
25410 by the scroll amount, and the stretch glyph appended by
25411 extend_face_to_end_of_line will be wider, to shift the
25412 row glyphs to the right. (In L2R rows, the corresponding
25413 left-shift effect is accomplished by setting row->x to a
25414 negative value, which won't work with R2L rows.)
25416 This must leave us with a positive value of WIDTH, since
25417 otherwise the call to move_it_in_display_line_to at the
25418 beginning of display_line would have got past the entire
25419 first glyph, and then it->current_x would have been
25420 greater or equal to it->first_visible_x. */
25421 if (it->current_x < it->first_visible_x)
25422 width -= it->first_visible_x - it->current_x;
25423 eassert (width > 0);
25425 glyph->charpos = CHARPOS (it->position);
25426 glyph->object = object;
25427 glyph->pixel_width = width;
25428 glyph->ascent = ascent;
25429 glyph->descent = height - ascent;
25430 glyph->voffset = it->voffset;
25431 glyph->type = STRETCH_GLYPH;
25432 glyph->avoid_cursor_p = it->avoid_cursor_p;
25433 glyph->multibyte_p = it->multibyte_p;
25434 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25436 /* In R2L rows, the left and the right box edges need to be
25437 drawn in reverse direction. */
25438 glyph->right_box_line_p = it->start_of_box_run_p;
25439 glyph->left_box_line_p = it->end_of_box_run_p;
25441 else
25443 glyph->left_box_line_p = it->start_of_box_run_p;
25444 glyph->right_box_line_p = it->end_of_box_run_p;
25446 glyph->overlaps_vertically_p = 0;
25447 glyph->padding_p = 0;
25448 glyph->glyph_not_available_p = 0;
25449 glyph->face_id = it->face_id;
25450 glyph->u.stretch.ascent = ascent;
25451 glyph->u.stretch.height = height;
25452 glyph->slice.img = null_glyph_slice;
25453 glyph->font_type = FONT_TYPE_UNKNOWN;
25454 if (it->bidi_p)
25456 glyph->resolved_level = it->bidi_it.resolved_level;
25457 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25458 emacs_abort ();
25459 glyph->bidi_type = it->bidi_it.type;
25461 else
25463 glyph->resolved_level = 0;
25464 glyph->bidi_type = UNKNOWN_BT;
25466 ++it->glyph_row->used[area];
25468 else
25469 IT_EXPAND_MATRIX_WIDTH (it, area);
25472 #endif /* HAVE_WINDOW_SYSTEM */
25474 /* Produce a stretch glyph for iterator IT. IT->object is the value
25475 of the glyph property displayed. The value must be a list
25476 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25477 being recognized:
25479 1. `:width WIDTH' specifies that the space should be WIDTH *
25480 canonical char width wide. WIDTH may be an integer or floating
25481 point number.
25483 2. `:relative-width FACTOR' specifies that the width of the stretch
25484 should be computed from the width of the first character having the
25485 `glyph' property, and should be FACTOR times that width.
25487 3. `:align-to HPOS' specifies that the space should be wide enough
25488 to reach HPOS, a value in canonical character units.
25490 Exactly one of the above pairs must be present.
25492 4. `:height HEIGHT' specifies that the height of the stretch produced
25493 should be HEIGHT, measured in canonical character units.
25495 5. `:relative-height FACTOR' specifies that the height of the
25496 stretch should be FACTOR times the height of the characters having
25497 the glyph property.
25499 Either none or exactly one of 4 or 5 must be present.
25501 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25502 of the stretch should be used for the ascent of the stretch.
25503 ASCENT must be in the range 0 <= ASCENT <= 100. */
25505 void
25506 produce_stretch_glyph (struct it *it)
25508 /* (space :width WIDTH :height HEIGHT ...) */
25509 Lisp_Object prop, plist;
25510 int width = 0, height = 0, align_to = -1;
25511 int zero_width_ok_p = 0;
25512 double tem;
25513 struct font *font = NULL;
25515 #ifdef HAVE_WINDOW_SYSTEM
25516 int ascent = 0;
25517 int zero_height_ok_p = 0;
25519 if (FRAME_WINDOW_P (it->f))
25521 struct face *face = FACE_FROM_ID (it->f, it->face_id);
25522 font = face->font ? face->font : FRAME_FONT (it->f);
25523 PREPARE_FACE_FOR_DISPLAY (it->f, face);
25525 #endif
25527 /* List should start with `space'. */
25528 eassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
25529 plist = XCDR (it->object);
25531 /* Compute the width of the stretch. */
25532 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
25533 && calc_pixel_width_or_height (&tem, it, prop, font, 1, 0))
25535 /* Absolute width `:width WIDTH' specified and valid. */
25536 zero_width_ok_p = 1;
25537 width = (int)tem;
25539 #ifdef HAVE_WINDOW_SYSTEM
25540 else if (FRAME_WINDOW_P (it->f)
25541 && (prop = Fplist_get (plist, QCrelative_width), NUMVAL (prop) > 0))
25543 /* Relative width `:relative-width FACTOR' specified and valid.
25544 Compute the width of the characters having the `glyph'
25545 property. */
25546 struct it it2;
25547 unsigned char *p = BYTE_POS_ADDR (IT_BYTEPOS (*it));
25549 it2 = *it;
25550 if (it->multibyte_p)
25551 it2.c = it2.char_to_display = STRING_CHAR_AND_LENGTH (p, it2.len);
25552 else
25554 it2.c = it2.char_to_display = *p, it2.len = 1;
25555 if (! ASCII_CHAR_P (it2.c))
25556 it2.char_to_display = BYTE8_TO_CHAR (it2.c);
25559 it2.glyph_row = NULL;
25560 it2.what = IT_CHARACTER;
25561 x_produce_glyphs (&it2);
25562 width = NUMVAL (prop) * it2.pixel_width;
25564 #endif /* HAVE_WINDOW_SYSTEM */
25565 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
25566 && calc_pixel_width_or_height (&tem, it, prop, font, 1, &align_to))
25568 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
25569 align_to = (align_to < 0
25571 : align_to - window_box_left_offset (it->w, TEXT_AREA));
25572 else if (align_to < 0)
25573 align_to = window_box_left_offset (it->w, TEXT_AREA);
25574 width = max (0, (int)tem + align_to - it->current_x);
25575 zero_width_ok_p = 1;
25577 else
25578 /* Nothing specified -> width defaults to canonical char width. */
25579 width = FRAME_COLUMN_WIDTH (it->f);
25581 if (width <= 0 && (width < 0 || !zero_width_ok_p))
25582 width = 1;
25584 #ifdef HAVE_WINDOW_SYSTEM
25585 /* Compute height. */
25586 if (FRAME_WINDOW_P (it->f))
25588 if ((prop = Fplist_get (plist, QCheight), !NILP (prop))
25589 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25591 height = (int)tem;
25592 zero_height_ok_p = 1;
25594 else if (prop = Fplist_get (plist, QCrelative_height),
25595 NUMVAL (prop) > 0)
25596 height = FONT_HEIGHT (font) * NUMVAL (prop);
25597 else
25598 height = FONT_HEIGHT (font);
25600 if (height <= 0 && (height < 0 || !zero_height_ok_p))
25601 height = 1;
25603 /* Compute percentage of height used for ascent. If
25604 `:ascent ASCENT' is present and valid, use that. Otherwise,
25605 derive the ascent from the font in use. */
25606 if (prop = Fplist_get (plist, QCascent),
25607 NUMVAL (prop) > 0 && NUMVAL (prop) <= 100)
25608 ascent = height * NUMVAL (prop) / 100.0;
25609 else if (!NILP (prop)
25610 && calc_pixel_width_or_height (&tem, it, prop, font, 0, 0))
25611 ascent = min (max (0, (int)tem), height);
25612 else
25613 ascent = (height * FONT_BASE (font)) / FONT_HEIGHT (font);
25615 else
25616 #endif /* HAVE_WINDOW_SYSTEM */
25617 height = 1;
25619 if (width > 0 && it->line_wrap != TRUNCATE
25620 && it->current_x + width > it->last_visible_x)
25622 width = it->last_visible_x - it->current_x;
25623 #ifdef HAVE_WINDOW_SYSTEM
25624 /* Subtract one more pixel from the stretch width, but only on
25625 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25626 width -= FRAME_WINDOW_P (it->f);
25627 #endif
25630 if (width > 0 && height > 0 && it->glyph_row)
25632 Lisp_Object o_object = it->object;
25633 Lisp_Object object = it->stack[it->sp - 1].string;
25634 int n = width;
25636 if (!STRINGP (object))
25637 object = it->w->contents;
25638 #ifdef HAVE_WINDOW_SYSTEM
25639 if (FRAME_WINDOW_P (it->f))
25640 append_stretch_glyph (it, object, width, height, ascent);
25641 else
25642 #endif
25644 it->object = object;
25645 it->char_to_display = ' ';
25646 it->pixel_width = it->len = 1;
25647 while (n--)
25648 tty_append_glyph (it);
25649 it->object = o_object;
25653 it->pixel_width = width;
25654 #ifdef HAVE_WINDOW_SYSTEM
25655 if (FRAME_WINDOW_P (it->f))
25657 it->ascent = it->phys_ascent = ascent;
25658 it->descent = it->phys_descent = height - it->ascent;
25659 it->nglyphs = width > 0 && height > 0 ? 1 : 0;
25660 take_vertical_position_into_account (it);
25662 else
25663 #endif
25664 it->nglyphs = width;
25667 /* Get information about special display element WHAT in an
25668 environment described by IT. WHAT is one of IT_TRUNCATION or
25669 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25670 non-null glyph_row member. This function ensures that fields like
25671 face_id, c, len of IT are left untouched. */
25673 static void
25674 produce_special_glyphs (struct it *it, enum display_element_type what)
25676 struct it temp_it;
25677 Lisp_Object gc;
25678 GLYPH glyph;
25680 temp_it = *it;
25681 temp_it.object = make_number (0);
25682 memset (&temp_it.current, 0, sizeof temp_it.current);
25684 if (what == IT_CONTINUATION)
25686 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25687 if (it->bidi_it.paragraph_dir == R2L)
25688 SET_GLYPH_FROM_CHAR (glyph, '/');
25689 else
25690 SET_GLYPH_FROM_CHAR (glyph, '\\');
25691 if (it->dp
25692 && (gc = DISP_CONTINUE_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25694 /* FIXME: Should we mirror GC for R2L lines? */
25695 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25696 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25699 else if (what == IT_TRUNCATION)
25701 /* Truncation glyph. */
25702 SET_GLYPH_FROM_CHAR (glyph, '$');
25703 if (it->dp
25704 && (gc = DISP_TRUNC_GLYPH (it->dp), GLYPH_CODE_P (gc)))
25706 /* FIXME: Should we mirror GC for R2L lines? */
25707 SET_GLYPH_FROM_GLYPH_CODE (glyph, gc);
25708 spec_glyph_lookup_face (XWINDOW (it->window), &glyph);
25711 else
25712 emacs_abort ();
25714 #ifdef HAVE_WINDOW_SYSTEM
25715 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25716 is turned off, we precede the truncation/continuation glyphs by a
25717 stretch glyph whose width is computed such that these special
25718 glyphs are aligned at the window margin, even when very different
25719 fonts are used in different glyph rows. */
25720 if (FRAME_WINDOW_P (temp_it.f)
25721 /* init_iterator calls this with it->glyph_row == NULL, and it
25722 wants only the pixel width of the truncation/continuation
25723 glyphs. */
25724 && temp_it.glyph_row
25725 /* insert_left_trunc_glyphs calls us at the beginning of the
25726 row, and it has its own calculation of the stretch glyph
25727 width. */
25728 && temp_it.glyph_row->used[TEXT_AREA] > 0
25729 && (temp_it.glyph_row->reversed_p
25730 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it.w)
25731 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it.w)) == 0)
25733 int stretch_width = temp_it.last_visible_x - temp_it.current_x;
25735 if (stretch_width > 0)
25737 struct face *face = FACE_FROM_ID (temp_it.f, temp_it.face_id);
25738 struct font *font =
25739 face->font ? face->font : FRAME_FONT (temp_it.f);
25740 int stretch_ascent =
25741 (((temp_it.ascent + temp_it.descent)
25742 * FONT_BASE (font)) / FONT_HEIGHT (font));
25744 append_stretch_glyph (&temp_it, make_number (0), stretch_width,
25745 temp_it.ascent + temp_it.descent,
25746 stretch_ascent);
25749 #endif
25751 temp_it.dp = NULL;
25752 temp_it.what = IT_CHARACTER;
25753 temp_it.c = temp_it.char_to_display = GLYPH_CHAR (glyph);
25754 temp_it.face_id = GLYPH_FACE (glyph);
25755 temp_it.len = CHAR_BYTES (temp_it.c);
25757 PRODUCE_GLYPHS (&temp_it);
25758 it->pixel_width = temp_it.pixel_width;
25759 it->nglyphs = temp_it.nglyphs;
25762 #ifdef HAVE_WINDOW_SYSTEM
25764 /* Calculate line-height and line-spacing properties.
25765 An integer value specifies explicit pixel value.
25766 A float value specifies relative value to current face height.
25767 A cons (float . face-name) specifies relative value to
25768 height of specified face font.
25770 Returns height in pixels, or nil. */
25773 static Lisp_Object
25774 calc_line_height_property (struct it *it, Lisp_Object val, struct font *font,
25775 int boff, int override)
25777 Lisp_Object face_name = Qnil;
25778 int ascent, descent, height;
25780 if (NILP (val) || INTEGERP (val) || (override && EQ (val, Qt)))
25781 return val;
25783 if (CONSP (val))
25785 face_name = XCAR (val);
25786 val = XCDR (val);
25787 if (!NUMBERP (val))
25788 val = make_number (1);
25789 if (NILP (face_name))
25791 height = it->ascent + it->descent;
25792 goto scale;
25796 if (NILP (face_name))
25798 font = FRAME_FONT (it->f);
25799 boff = FRAME_BASELINE_OFFSET (it->f);
25801 else if (EQ (face_name, Qt))
25803 override = 0;
25805 else
25807 int face_id;
25808 struct face *face;
25810 face_id = lookup_named_face (it->f, face_name, 0);
25811 if (face_id < 0)
25812 return make_number (-1);
25814 face = FACE_FROM_ID (it->f, face_id);
25815 font = face->font;
25816 if (font == NULL)
25817 return make_number (-1);
25818 boff = font->baseline_offset;
25819 if (font->vertical_centering)
25820 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
25823 ascent = FONT_BASE (font) + boff;
25824 descent = FONT_DESCENT (font) - boff;
25826 if (override)
25828 it->override_ascent = ascent;
25829 it->override_descent = descent;
25830 it->override_boff = boff;
25833 height = ascent + descent;
25835 scale:
25836 if (FLOATP (val))
25837 height = (int)(XFLOAT_DATA (val) * height);
25838 else if (INTEGERP (val))
25839 height *= XINT (val);
25841 return make_number (height);
25845 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25846 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25847 and only if this is for a character for which no font was found.
25849 If the display method (it->glyphless_method) is
25850 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25851 length of the acronym or the hexadecimal string, UPPER_XOFF and
25852 UPPER_YOFF are pixel offsets for the upper part of the string,
25853 LOWER_XOFF and LOWER_YOFF are for the lower part.
25855 For the other display methods, LEN through LOWER_YOFF are zero. */
25857 static void
25858 append_glyphless_glyph (struct it *it, int face_id, int for_no_font, int len,
25859 short upper_xoff, short upper_yoff,
25860 short lower_xoff, short lower_yoff)
25862 struct glyph *glyph;
25863 enum glyph_row_area area = it->area;
25865 glyph = it->glyph_row->glyphs[area] + it->glyph_row->used[area];
25866 if (glyph < it->glyph_row->glyphs[area + 1])
25868 /* If the glyph row is reversed, we need to prepend the glyph
25869 rather than append it. */
25870 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25872 struct glyph *g;
25874 /* Make room for the additional glyph. */
25875 for (g = glyph - 1; g >= it->glyph_row->glyphs[area]; g--)
25876 g[1] = *g;
25877 glyph = it->glyph_row->glyphs[area];
25879 glyph->charpos = CHARPOS (it->position);
25880 glyph->object = it->object;
25881 glyph->pixel_width = it->pixel_width;
25882 glyph->ascent = it->ascent;
25883 glyph->descent = it->descent;
25884 glyph->voffset = it->voffset;
25885 glyph->type = GLYPHLESS_GLYPH;
25886 glyph->u.glyphless.method = it->glyphless_method;
25887 glyph->u.glyphless.for_no_font = for_no_font;
25888 glyph->u.glyphless.len = len;
25889 glyph->u.glyphless.ch = it->c;
25890 glyph->slice.glyphless.upper_xoff = upper_xoff;
25891 glyph->slice.glyphless.upper_yoff = upper_yoff;
25892 glyph->slice.glyphless.lower_xoff = lower_xoff;
25893 glyph->slice.glyphless.lower_yoff = lower_yoff;
25894 glyph->avoid_cursor_p = it->avoid_cursor_p;
25895 glyph->multibyte_p = it->multibyte_p;
25896 if (it->glyph_row->reversed_p && area == TEXT_AREA)
25898 /* In R2L rows, the left and the right box edges need to be
25899 drawn in reverse direction. */
25900 glyph->right_box_line_p = it->start_of_box_run_p;
25901 glyph->left_box_line_p = it->end_of_box_run_p;
25903 else
25905 glyph->left_box_line_p = it->start_of_box_run_p;
25906 glyph->right_box_line_p = it->end_of_box_run_p;
25908 glyph->overlaps_vertically_p = (it->phys_ascent > it->ascent
25909 || it->phys_descent > it->descent);
25910 glyph->padding_p = 0;
25911 glyph->glyph_not_available_p = 0;
25912 glyph->face_id = face_id;
25913 glyph->font_type = FONT_TYPE_UNKNOWN;
25914 if (it->bidi_p)
25916 glyph->resolved_level = it->bidi_it.resolved_level;
25917 if ((it->bidi_it.type & 7) != it->bidi_it.type)
25918 emacs_abort ();
25919 glyph->bidi_type = it->bidi_it.type;
25921 ++it->glyph_row->used[area];
25923 else
25924 IT_EXPAND_MATRIX_WIDTH (it, area);
25928 /* Produce a glyph for a glyphless character for iterator IT.
25929 IT->glyphless_method specifies which method to use for displaying
25930 the character. See the description of enum
25931 glyphless_display_method in dispextern.h for the detail.
25933 FOR_NO_FONT is nonzero if and only if this is for a character for
25934 which no font was found. ACRONYM, if non-nil, is an acronym string
25935 for the character. */
25937 static void
25938 produce_glyphless_glyph (struct it *it, int for_no_font, Lisp_Object acronym)
25940 int face_id;
25941 struct face *face;
25942 struct font *font;
25943 int base_width, base_height, width, height;
25944 short upper_xoff, upper_yoff, lower_xoff, lower_yoff;
25945 int len;
25947 /* Get the metrics of the base font. We always refer to the current
25948 ASCII face. */
25949 face = FACE_FROM_ID (it->f, it->face_id)->ascii_face;
25950 font = face->font ? face->font : FRAME_FONT (it->f);
25951 it->ascent = FONT_BASE (font) + font->baseline_offset;
25952 it->descent = FONT_DESCENT (font) - font->baseline_offset;
25953 base_height = it->ascent + it->descent;
25954 base_width = font->average_width;
25956 face_id = merge_glyphless_glyph_face (it);
25958 if (it->glyphless_method == GLYPHLESS_DISPLAY_THIN_SPACE)
25960 it->pixel_width = THIN_SPACE_WIDTH;
25961 len = 0;
25962 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
25964 else if (it->glyphless_method == GLYPHLESS_DISPLAY_EMPTY_BOX)
25966 width = CHAR_WIDTH (it->c);
25967 if (width == 0)
25968 width = 1;
25969 else if (width > 4)
25970 width = 4;
25971 it->pixel_width = base_width * width;
25972 len = 0;
25973 upper_xoff = upper_yoff = lower_xoff = lower_yoff = 0;
25975 else
25977 char buf[7];
25978 const char *str;
25979 unsigned int code[6];
25980 int upper_len;
25981 int ascent, descent;
25982 struct font_metrics metrics_upper, metrics_lower;
25984 face = FACE_FROM_ID (it->f, face_id);
25985 font = face->font ? face->font : FRAME_FONT (it->f);
25986 PREPARE_FACE_FOR_DISPLAY (it->f, face);
25988 if (it->glyphless_method == GLYPHLESS_DISPLAY_ACRONYM)
25990 if (! STRINGP (acronym) && CHAR_TABLE_P (Vglyphless_char_display))
25991 acronym = CHAR_TABLE_REF (Vglyphless_char_display, it->c);
25992 if (CONSP (acronym))
25993 acronym = XCAR (acronym);
25994 str = STRINGP (acronym) ? SSDATA (acronym) : "";
25996 else
25998 eassert (it->glyphless_method == GLYPHLESS_DISPLAY_HEX_CODE);
25999 sprintf (buf, "%0*X", it->c < 0x10000 ? 4 : 6, it->c);
26000 str = buf;
26002 for (len = 0; str[len] && ASCII_BYTE_P (str[len]) && len < 6; len++)
26003 code[len] = font->driver->encode_char (font, str[len]);
26004 upper_len = (len + 1) / 2;
26005 font->driver->text_extents (font, code, upper_len,
26006 &metrics_upper);
26007 font->driver->text_extents (font, code + upper_len, len - upper_len,
26008 &metrics_lower);
26012 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26013 width = max (metrics_upper.width, metrics_lower.width) + 4;
26014 upper_xoff = upper_yoff = 2; /* the typical case */
26015 if (base_width >= width)
26017 /* Align the upper to the left, the lower to the right. */
26018 it->pixel_width = base_width;
26019 lower_xoff = base_width - 2 - metrics_lower.width;
26021 else
26023 /* Center the shorter one. */
26024 it->pixel_width = width;
26025 if (metrics_upper.width >= metrics_lower.width)
26026 lower_xoff = (width - metrics_lower.width) / 2;
26027 else
26029 /* FIXME: This code doesn't look right. It formerly was
26030 missing the "lower_xoff = 0;", which couldn't have
26031 been right since it left lower_xoff uninitialized. */
26032 lower_xoff = 0;
26033 upper_xoff = (width - metrics_upper.width) / 2;
26037 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26038 top, bottom, and between upper and lower strings. */
26039 height = (metrics_upper.ascent + metrics_upper.descent
26040 + metrics_lower.ascent + metrics_lower.descent) + 5;
26041 /* Center vertically.
26042 H:base_height, D:base_descent
26043 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26045 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26046 descent = D - H/2 + h/2;
26047 lower_yoff = descent - 2 - ld;
26048 upper_yoff = lower_yoff - la - 1 - ud; */
26049 ascent = - (it->descent - (base_height + height + 1) / 2);
26050 descent = it->descent - (base_height - height) / 2;
26051 lower_yoff = descent - 2 - metrics_lower.descent;
26052 upper_yoff = (lower_yoff - metrics_lower.ascent - 1
26053 - metrics_upper.descent);
26054 /* Don't make the height shorter than the base height. */
26055 if (height > base_height)
26057 it->ascent = ascent;
26058 it->descent = descent;
26062 it->phys_ascent = it->ascent;
26063 it->phys_descent = it->descent;
26064 if (it->glyph_row)
26065 append_glyphless_glyph (it, face_id, for_no_font, len,
26066 upper_xoff, upper_yoff,
26067 lower_xoff, lower_yoff);
26068 it->nglyphs = 1;
26069 take_vertical_position_into_account (it);
26073 /* RIF:
26074 Produce glyphs/get display metrics for the display element IT is
26075 loaded with. See the description of struct it in dispextern.h
26076 for an overview of struct it. */
26078 void
26079 x_produce_glyphs (struct it *it)
26081 int extra_line_spacing = it->extra_line_spacing;
26083 it->glyph_not_available_p = 0;
26085 if (it->what == IT_CHARACTER)
26087 XChar2b char2b;
26088 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26089 struct font *font = face->font;
26090 struct font_metrics *pcm = NULL;
26091 int boff; /* Baseline offset. */
26093 if (font == NULL)
26095 /* When no suitable font is found, display this character by
26096 the method specified in the first extra slot of
26097 Vglyphless_char_display. */
26098 Lisp_Object acronym = lookup_glyphless_char_display (-1, it);
26100 eassert (it->what == IT_GLYPHLESS);
26101 produce_glyphless_glyph (it, 1, STRINGP (acronym) ? acronym : Qnil);
26102 goto done;
26105 boff = font->baseline_offset;
26106 if (font->vertical_centering)
26107 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26109 if (it->char_to_display != '\n' && it->char_to_display != '\t')
26111 int stretched_p;
26113 it->nglyphs = 1;
26115 if (it->override_ascent >= 0)
26117 it->ascent = it->override_ascent;
26118 it->descent = it->override_descent;
26119 boff = it->override_boff;
26121 else
26123 it->ascent = FONT_BASE (font) + boff;
26124 it->descent = FONT_DESCENT (font) - boff;
26127 if (get_char_glyph_code (it->char_to_display, font, &char2b))
26129 pcm = get_per_char_metric (font, &char2b);
26130 if (pcm->width == 0
26131 && pcm->rbearing == 0 && pcm->lbearing == 0)
26132 pcm = NULL;
26135 if (pcm)
26137 it->phys_ascent = pcm->ascent + boff;
26138 it->phys_descent = pcm->descent - boff;
26139 it->pixel_width = pcm->width;
26141 else
26143 it->glyph_not_available_p = 1;
26144 it->phys_ascent = it->ascent;
26145 it->phys_descent = it->descent;
26146 it->pixel_width = font->space_width;
26149 if (it->constrain_row_ascent_descent_p)
26151 if (it->descent > it->max_descent)
26153 it->ascent += it->descent - it->max_descent;
26154 it->descent = it->max_descent;
26156 if (it->ascent > it->max_ascent)
26158 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26159 it->ascent = it->max_ascent;
26161 it->phys_ascent = min (it->phys_ascent, it->ascent);
26162 it->phys_descent = min (it->phys_descent, it->descent);
26163 extra_line_spacing = 0;
26166 /* If this is a space inside a region of text with
26167 `space-width' property, change its width. */
26168 stretched_p = it->char_to_display == ' ' && !NILP (it->space_width);
26169 if (stretched_p)
26170 it->pixel_width *= XFLOATINT (it->space_width);
26172 /* If face has a box, add the box thickness to the character
26173 height. If character has a box line to the left and/or
26174 right, add the box line width to the character's width. */
26175 if (face->box != FACE_NO_BOX)
26177 int thick = face->box_line_width;
26179 if (thick > 0)
26181 it->ascent += thick;
26182 it->descent += thick;
26184 else
26185 thick = -thick;
26187 if (it->start_of_box_run_p)
26188 it->pixel_width += thick;
26189 if (it->end_of_box_run_p)
26190 it->pixel_width += thick;
26193 /* If face has an overline, add the height of the overline
26194 (1 pixel) and a 1 pixel margin to the character height. */
26195 if (face->overline_p)
26196 it->ascent += overline_margin;
26198 if (it->constrain_row_ascent_descent_p)
26200 if (it->ascent > it->max_ascent)
26201 it->ascent = it->max_ascent;
26202 if (it->descent > it->max_descent)
26203 it->descent = it->max_descent;
26206 take_vertical_position_into_account (it);
26208 /* If we have to actually produce glyphs, do it. */
26209 if (it->glyph_row)
26211 if (stretched_p)
26213 /* Translate a space with a `space-width' property
26214 into a stretch glyph. */
26215 int ascent = (((it->ascent + it->descent) * FONT_BASE (font))
26216 / FONT_HEIGHT (font));
26217 append_stretch_glyph (it, it->object, it->pixel_width,
26218 it->ascent + it->descent, ascent);
26220 else
26221 append_glyph (it);
26223 /* If characters with lbearing or rbearing are displayed
26224 in this line, record that fact in a flag of the
26225 glyph row. This is used to optimize X output code. */
26226 if (pcm && (pcm->lbearing < 0 || pcm->rbearing > pcm->width))
26227 it->glyph_row->contains_overlapping_glyphs_p = 1;
26229 if (! stretched_p && it->pixel_width == 0)
26230 /* We assure that all visible glyphs have at least 1-pixel
26231 width. */
26232 it->pixel_width = 1;
26234 else if (it->char_to_display == '\n')
26236 /* A newline has no width, but we need the height of the
26237 line. But if previous part of the line sets a height,
26238 don't increase that height. */
26240 Lisp_Object height;
26241 Lisp_Object total_height = Qnil;
26243 it->override_ascent = -1;
26244 it->pixel_width = 0;
26245 it->nglyphs = 0;
26247 height = get_it_property (it, Qline_height);
26248 /* Split (line-height total-height) list. */
26249 if (CONSP (height)
26250 && CONSP (XCDR (height))
26251 && NILP (XCDR (XCDR (height))))
26253 total_height = XCAR (XCDR (height));
26254 height = XCAR (height);
26256 height = calc_line_height_property (it, height, font, boff, 1);
26258 if (it->override_ascent >= 0)
26260 it->ascent = it->override_ascent;
26261 it->descent = it->override_descent;
26262 boff = it->override_boff;
26264 else
26266 it->ascent = FONT_BASE (font) + boff;
26267 it->descent = FONT_DESCENT (font) - boff;
26270 if (EQ (height, Qt))
26272 if (it->descent > it->max_descent)
26274 it->ascent += it->descent - it->max_descent;
26275 it->descent = it->max_descent;
26277 if (it->ascent > it->max_ascent)
26279 it->descent = min (it->max_descent, it->descent + it->ascent - it->max_ascent);
26280 it->ascent = it->max_ascent;
26282 it->phys_ascent = min (it->phys_ascent, it->ascent);
26283 it->phys_descent = min (it->phys_descent, it->descent);
26284 it->constrain_row_ascent_descent_p = 1;
26285 extra_line_spacing = 0;
26287 else
26289 Lisp_Object spacing;
26291 it->phys_ascent = it->ascent;
26292 it->phys_descent = it->descent;
26294 if ((it->max_ascent > 0 || it->max_descent > 0)
26295 && face->box != FACE_NO_BOX
26296 && face->box_line_width > 0)
26298 it->ascent += face->box_line_width;
26299 it->descent += face->box_line_width;
26301 if (!NILP (height)
26302 && XINT (height) > it->ascent + it->descent)
26303 it->ascent = XINT (height) - it->descent;
26305 if (!NILP (total_height))
26306 spacing = calc_line_height_property (it, total_height, font, boff, 0);
26307 else
26309 spacing = get_it_property (it, Qline_spacing);
26310 spacing = calc_line_height_property (it, spacing, font, boff, 0);
26312 if (INTEGERP (spacing))
26314 extra_line_spacing = XINT (spacing);
26315 if (!NILP (total_height))
26316 extra_line_spacing -= (it->phys_ascent + it->phys_descent);
26320 else /* i.e. (it->char_to_display == '\t') */
26322 if (font->space_width > 0)
26324 int tab_width = it->tab_width * font->space_width;
26325 int x = it->current_x + it->continuation_lines_width;
26326 int next_tab_x = ((1 + x + tab_width - 1) / tab_width) * tab_width;
26328 /* If the distance from the current position to the next tab
26329 stop is less than a space character width, use the
26330 tab stop after that. */
26331 if (next_tab_x - x < font->space_width)
26332 next_tab_x += tab_width;
26334 it->pixel_width = next_tab_x - x;
26335 it->nglyphs = 1;
26336 it->ascent = it->phys_ascent = FONT_BASE (font) + boff;
26337 it->descent = it->phys_descent = FONT_DESCENT (font) - boff;
26339 if (it->glyph_row)
26341 append_stretch_glyph (it, it->object, it->pixel_width,
26342 it->ascent + it->descent, it->ascent);
26345 else
26347 it->pixel_width = 0;
26348 it->nglyphs = 1;
26352 else if (it->what == IT_COMPOSITION && it->cmp_it.ch < 0)
26354 /* A static composition.
26356 Note: A composition is represented as one glyph in the
26357 glyph matrix. There are no padding glyphs.
26359 Important note: pixel_width, ascent, and descent are the
26360 values of what is drawn by draw_glyphs (i.e. the values of
26361 the overall glyphs composed). */
26362 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26363 int boff; /* baseline offset */
26364 struct composition *cmp = composition_table[it->cmp_it.id];
26365 int glyph_len = cmp->glyph_len;
26366 struct font *font = face->font;
26368 it->nglyphs = 1;
26370 /* If we have not yet calculated pixel size data of glyphs of
26371 the composition for the current face font, calculate them
26372 now. Theoretically, we have to check all fonts for the
26373 glyphs, but that requires much time and memory space. So,
26374 here we check only the font of the first glyph. This may
26375 lead to incorrect display, but it's very rare, and C-l
26376 (recenter-top-bottom) can correct the display anyway. */
26377 if (! cmp->font || cmp->font != font)
26379 /* Ascent and descent of the font of the first character
26380 of this composition (adjusted by baseline offset).
26381 Ascent and descent of overall glyphs should not be less
26382 than these, respectively. */
26383 int font_ascent, font_descent, font_height;
26384 /* Bounding box of the overall glyphs. */
26385 int leftmost, rightmost, lowest, highest;
26386 int lbearing, rbearing;
26387 int i, width, ascent, descent;
26388 int left_padded = 0, right_padded = 0;
26389 int c IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26390 XChar2b char2b;
26391 struct font_metrics *pcm;
26392 int font_not_found_p;
26393 ptrdiff_t pos;
26395 for (glyph_len = cmp->glyph_len; glyph_len > 0; glyph_len--)
26396 if ((c = COMPOSITION_GLYPH (cmp, glyph_len - 1)) != '\t')
26397 break;
26398 if (glyph_len < cmp->glyph_len)
26399 right_padded = 1;
26400 for (i = 0; i < glyph_len; i++)
26402 if ((c = COMPOSITION_GLYPH (cmp, i)) != '\t')
26403 break;
26404 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26406 if (i > 0)
26407 left_padded = 1;
26409 pos = (STRINGP (it->string) ? IT_STRING_CHARPOS (*it)
26410 : IT_CHARPOS (*it));
26411 /* If no suitable font is found, use the default font. */
26412 font_not_found_p = font == NULL;
26413 if (font_not_found_p)
26415 face = face->ascii_face;
26416 font = face->font;
26418 boff = font->baseline_offset;
26419 if (font->vertical_centering)
26420 boff = VCENTER_BASELINE_OFFSET (font, it->f) - boff;
26421 font_ascent = FONT_BASE (font) + boff;
26422 font_descent = FONT_DESCENT (font) - boff;
26423 font_height = FONT_HEIGHT (font);
26425 cmp->font = font;
26427 pcm = NULL;
26428 if (! font_not_found_p)
26430 get_char_face_and_encoding (it->f, c, it->face_id,
26431 &char2b, 0);
26432 pcm = get_per_char_metric (font, &char2b);
26435 /* Initialize the bounding box. */
26436 if (pcm)
26438 width = cmp->glyph_len > 0 ? pcm->width : 0;
26439 ascent = pcm->ascent;
26440 descent = pcm->descent;
26441 lbearing = pcm->lbearing;
26442 rbearing = pcm->rbearing;
26444 else
26446 width = cmp->glyph_len > 0 ? font->space_width : 0;
26447 ascent = FONT_BASE (font);
26448 descent = FONT_DESCENT (font);
26449 lbearing = 0;
26450 rbearing = width;
26453 rightmost = width;
26454 leftmost = 0;
26455 lowest = - descent + boff;
26456 highest = ascent + boff;
26458 if (! font_not_found_p
26459 && font->default_ascent
26460 && CHAR_TABLE_P (Vuse_default_ascent)
26461 && !NILP (Faref (Vuse_default_ascent,
26462 make_number (it->char_to_display))))
26463 highest = font->default_ascent + boff;
26465 /* Draw the first glyph at the normal position. It may be
26466 shifted to right later if some other glyphs are drawn
26467 at the left. */
26468 cmp->offsets[i * 2] = 0;
26469 cmp->offsets[i * 2 + 1] = boff;
26470 cmp->lbearing = lbearing;
26471 cmp->rbearing = rbearing;
26473 /* Set cmp->offsets for the remaining glyphs. */
26474 for (i++; i < glyph_len; i++)
26476 int left, right, btm, top;
26477 int ch = COMPOSITION_GLYPH (cmp, i);
26478 int face_id;
26479 struct face *this_face;
26481 if (ch == '\t')
26482 ch = ' ';
26483 face_id = FACE_FOR_CHAR (it->f, face, ch, pos, it->string);
26484 this_face = FACE_FROM_ID (it->f, face_id);
26485 font = this_face->font;
26487 if (font == NULL)
26488 pcm = NULL;
26489 else
26491 get_char_face_and_encoding (it->f, ch, face_id,
26492 &char2b, 0);
26493 pcm = get_per_char_metric (font, &char2b);
26495 if (! pcm)
26496 cmp->offsets[i * 2] = cmp->offsets[i * 2 + 1] = 0;
26497 else
26499 width = pcm->width;
26500 ascent = pcm->ascent;
26501 descent = pcm->descent;
26502 lbearing = pcm->lbearing;
26503 rbearing = pcm->rbearing;
26504 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
26506 /* Relative composition with or without
26507 alternate chars. */
26508 left = (leftmost + rightmost - width) / 2;
26509 btm = - descent + boff;
26510 if (font->relative_compose
26511 && (! CHAR_TABLE_P (Vignore_relative_composition)
26512 || NILP (Faref (Vignore_relative_composition,
26513 make_number (ch)))))
26516 if (- descent >= font->relative_compose)
26517 /* One extra pixel between two glyphs. */
26518 btm = highest + 1;
26519 else if (ascent <= 0)
26520 /* One extra pixel between two glyphs. */
26521 btm = lowest - 1 - ascent - descent;
26524 else
26526 /* A composition rule is specified by an integer
26527 value that encodes global and new reference
26528 points (GREF and NREF). GREF and NREF are
26529 specified by numbers as below:
26531 0---1---2 -- ascent
26535 9--10--11 -- center
26537 ---3---4---5--- baseline
26539 6---7---8 -- descent
26541 int rule = COMPOSITION_RULE (cmp, i);
26542 int gref, nref, grefx, grefy, nrefx, nrefy, xoff, yoff;
26544 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
26545 grefx = gref % 3, nrefx = nref % 3;
26546 grefy = gref / 3, nrefy = nref / 3;
26547 if (xoff)
26548 xoff = font_height * (xoff - 128) / 256;
26549 if (yoff)
26550 yoff = font_height * (yoff - 128) / 256;
26552 left = (leftmost
26553 + grefx * (rightmost - leftmost) / 2
26554 - nrefx * width / 2
26555 + xoff);
26557 btm = ((grefy == 0 ? highest
26558 : grefy == 1 ? 0
26559 : grefy == 2 ? lowest
26560 : (highest + lowest) / 2)
26561 - (nrefy == 0 ? ascent + descent
26562 : nrefy == 1 ? descent - boff
26563 : nrefy == 2 ? 0
26564 : (ascent + descent) / 2)
26565 + yoff);
26568 cmp->offsets[i * 2] = left;
26569 cmp->offsets[i * 2 + 1] = btm + descent;
26571 /* Update the bounding box of the overall glyphs. */
26572 if (width > 0)
26574 right = left + width;
26575 if (left < leftmost)
26576 leftmost = left;
26577 if (right > rightmost)
26578 rightmost = right;
26580 top = btm + descent + ascent;
26581 if (top > highest)
26582 highest = top;
26583 if (btm < lowest)
26584 lowest = btm;
26586 if (cmp->lbearing > left + lbearing)
26587 cmp->lbearing = left + lbearing;
26588 if (cmp->rbearing < left + rbearing)
26589 cmp->rbearing = left + rbearing;
26593 /* If there are glyphs whose x-offsets are negative,
26594 shift all glyphs to the right and make all x-offsets
26595 non-negative. */
26596 if (leftmost < 0)
26598 for (i = 0; i < cmp->glyph_len; i++)
26599 cmp->offsets[i * 2] -= leftmost;
26600 rightmost -= leftmost;
26601 cmp->lbearing -= leftmost;
26602 cmp->rbearing -= leftmost;
26605 if (left_padded && cmp->lbearing < 0)
26607 for (i = 0; i < cmp->glyph_len; i++)
26608 cmp->offsets[i * 2] -= cmp->lbearing;
26609 rightmost -= cmp->lbearing;
26610 cmp->rbearing -= cmp->lbearing;
26611 cmp->lbearing = 0;
26613 if (right_padded && rightmost < cmp->rbearing)
26615 rightmost = cmp->rbearing;
26618 cmp->pixel_width = rightmost;
26619 cmp->ascent = highest;
26620 cmp->descent = - lowest;
26621 if (cmp->ascent < font_ascent)
26622 cmp->ascent = font_ascent;
26623 if (cmp->descent < font_descent)
26624 cmp->descent = font_descent;
26627 if (it->glyph_row
26628 && (cmp->lbearing < 0
26629 || cmp->rbearing > cmp->pixel_width))
26630 it->glyph_row->contains_overlapping_glyphs_p = 1;
26632 it->pixel_width = cmp->pixel_width;
26633 it->ascent = it->phys_ascent = cmp->ascent;
26634 it->descent = it->phys_descent = cmp->descent;
26635 if (face->box != FACE_NO_BOX)
26637 int thick = face->box_line_width;
26639 if (thick > 0)
26641 it->ascent += thick;
26642 it->descent += thick;
26644 else
26645 thick = - thick;
26647 if (it->start_of_box_run_p)
26648 it->pixel_width += thick;
26649 if (it->end_of_box_run_p)
26650 it->pixel_width += thick;
26653 /* If face has an overline, add the height of the overline
26654 (1 pixel) and a 1 pixel margin to the character height. */
26655 if (face->overline_p)
26656 it->ascent += overline_margin;
26658 take_vertical_position_into_account (it);
26659 if (it->ascent < 0)
26660 it->ascent = 0;
26661 if (it->descent < 0)
26662 it->descent = 0;
26664 if (it->glyph_row && cmp->glyph_len > 0)
26665 append_composite_glyph (it);
26667 else if (it->what == IT_COMPOSITION)
26669 /* A dynamic (automatic) composition. */
26670 struct face *face = FACE_FROM_ID (it->f, it->face_id);
26671 Lisp_Object gstring;
26672 struct font_metrics metrics;
26674 it->nglyphs = 1;
26676 gstring = composition_gstring_from_id (it->cmp_it.id);
26677 it->pixel_width
26678 = composition_gstring_width (gstring, it->cmp_it.from, it->cmp_it.to,
26679 &metrics);
26680 if (it->glyph_row
26681 && (metrics.lbearing < 0 || metrics.rbearing > metrics.width))
26682 it->glyph_row->contains_overlapping_glyphs_p = 1;
26683 it->ascent = it->phys_ascent = metrics.ascent;
26684 it->descent = it->phys_descent = metrics.descent;
26685 if (face->box != FACE_NO_BOX)
26687 int thick = face->box_line_width;
26689 if (thick > 0)
26691 it->ascent += thick;
26692 it->descent += thick;
26694 else
26695 thick = - thick;
26697 if (it->start_of_box_run_p)
26698 it->pixel_width += thick;
26699 if (it->end_of_box_run_p)
26700 it->pixel_width += thick;
26702 /* If face has an overline, add the height of the overline
26703 (1 pixel) and a 1 pixel margin to the character height. */
26704 if (face->overline_p)
26705 it->ascent += overline_margin;
26706 take_vertical_position_into_account (it);
26707 if (it->ascent < 0)
26708 it->ascent = 0;
26709 if (it->descent < 0)
26710 it->descent = 0;
26712 if (it->glyph_row)
26713 append_composite_glyph (it);
26715 else if (it->what == IT_GLYPHLESS)
26716 produce_glyphless_glyph (it, 0, Qnil);
26717 else if (it->what == IT_IMAGE)
26718 produce_image_glyph (it);
26719 else if (it->what == IT_STRETCH)
26720 produce_stretch_glyph (it);
26722 done:
26723 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26724 because this isn't true for images with `:ascent 100'. */
26725 eassert (it->ascent >= 0 && it->descent >= 0);
26726 if (it->area == TEXT_AREA)
26727 it->current_x += it->pixel_width;
26729 if (extra_line_spacing > 0)
26731 it->descent += extra_line_spacing;
26732 if (extra_line_spacing > it->max_extra_line_spacing)
26733 it->max_extra_line_spacing = extra_line_spacing;
26736 it->max_ascent = max (it->max_ascent, it->ascent);
26737 it->max_descent = max (it->max_descent, it->descent);
26738 it->max_phys_ascent = max (it->max_phys_ascent, it->phys_ascent);
26739 it->max_phys_descent = max (it->max_phys_descent, it->phys_descent);
26742 /* EXPORT for RIF:
26743 Output LEN glyphs starting at START at the nominal cursor position.
26744 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26745 being updated, and UPDATED_AREA is the area of that row being updated. */
26747 void
26748 x_write_glyphs (struct window *w, struct glyph_row *updated_row,
26749 struct glyph *start, enum glyph_row_area updated_area, int len)
26751 int x, hpos, chpos = w->phys_cursor.hpos;
26753 eassert (updated_row);
26754 /* When the window is hscrolled, cursor hpos can legitimately be out
26755 of bounds, but we draw the cursor at the corresponding window
26756 margin in that case. */
26757 if (!updated_row->reversed_p && chpos < 0)
26758 chpos = 0;
26759 if (updated_row->reversed_p && chpos >= updated_row->used[TEXT_AREA])
26760 chpos = updated_row->used[TEXT_AREA] - 1;
26762 block_input ();
26764 /* Write glyphs. */
26766 hpos = start - updated_row->glyphs[updated_area];
26767 x = draw_glyphs (w, w->output_cursor.x,
26768 updated_row, updated_area,
26769 hpos, hpos + len,
26770 DRAW_NORMAL_TEXT, 0);
26772 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26773 if (updated_area == TEXT_AREA
26774 && w->phys_cursor_on_p
26775 && w->phys_cursor.vpos == w->output_cursor.vpos
26776 && chpos >= hpos
26777 && chpos < hpos + len)
26778 w->phys_cursor_on_p = 0;
26780 unblock_input ();
26782 /* Advance the output cursor. */
26783 w->output_cursor.hpos += len;
26784 w->output_cursor.x = x;
26788 /* EXPORT for RIF:
26789 Insert LEN glyphs from START at the nominal cursor position. */
26791 void
26792 x_insert_glyphs (struct window *w, struct glyph_row *updated_row,
26793 struct glyph *start, enum glyph_row_area updated_area, int len)
26795 struct frame *f;
26796 int line_height, shift_by_width, shifted_region_width;
26797 struct glyph_row *row;
26798 struct glyph *glyph;
26799 int frame_x, frame_y;
26800 ptrdiff_t hpos;
26802 eassert (updated_row);
26803 block_input ();
26804 f = XFRAME (WINDOW_FRAME (w));
26806 /* Get the height of the line we are in. */
26807 row = updated_row;
26808 line_height = row->height;
26810 /* Get the width of the glyphs to insert. */
26811 shift_by_width = 0;
26812 for (glyph = start; glyph < start + len; ++glyph)
26813 shift_by_width += glyph->pixel_width;
26815 /* Get the width of the region to shift right. */
26816 shifted_region_width = (window_box_width (w, updated_area)
26817 - w->output_cursor.x
26818 - shift_by_width);
26820 /* Shift right. */
26821 frame_x = window_box_left (w, updated_area) + w->output_cursor.x;
26822 frame_y = WINDOW_TO_FRAME_PIXEL_Y (w, w->output_cursor.y);
26824 FRAME_RIF (f)->shift_glyphs_for_insert (f, frame_x, frame_y, shifted_region_width,
26825 line_height, shift_by_width);
26827 /* Write the glyphs. */
26828 hpos = start - row->glyphs[updated_area];
26829 draw_glyphs (w, w->output_cursor.x, row, updated_area,
26830 hpos, hpos + len,
26831 DRAW_NORMAL_TEXT, 0);
26833 /* Advance the output cursor. */
26834 w->output_cursor.hpos += len;
26835 w->output_cursor.x += shift_by_width;
26836 unblock_input ();
26840 /* EXPORT for RIF:
26841 Erase the current text line from the nominal cursor position
26842 (inclusive) to pixel column TO_X (exclusive). The idea is that
26843 everything from TO_X onward is already erased.
26845 TO_X is a pixel position relative to UPDATED_AREA of currently
26846 updated window W. TO_X == -1 means clear to the end of this area. */
26848 void
26849 x_clear_end_of_line (struct window *w, struct glyph_row *updated_row,
26850 enum glyph_row_area updated_area, int to_x)
26852 struct frame *f;
26853 int max_x, min_y, max_y;
26854 int from_x, from_y, to_y;
26856 eassert (updated_row);
26857 f = XFRAME (w->frame);
26859 if (updated_row->full_width_p)
26860 max_x = (WINDOW_PIXEL_WIDTH (w)
26861 - (updated_row->mode_line_p ? WINDOW_RIGHT_DIVIDER_WIDTH (w) : 0));
26862 else
26863 max_x = window_box_width (w, updated_area);
26864 max_y = window_text_bottom_y (w);
26866 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26867 of window. For TO_X > 0, truncate to end of drawing area. */
26868 if (to_x == 0)
26869 return;
26870 else if (to_x < 0)
26871 to_x = max_x;
26872 else
26873 to_x = min (to_x, max_x);
26875 to_y = min (max_y, w->output_cursor.y + updated_row->height);
26877 /* Notice if the cursor will be cleared by this operation. */
26878 if (!updated_row->full_width_p)
26879 notice_overwritten_cursor (w, updated_area,
26880 w->output_cursor.x, -1,
26881 updated_row->y,
26882 MATRIX_ROW_BOTTOM_Y (updated_row));
26884 from_x = w->output_cursor.x;
26886 /* Translate to frame coordinates. */
26887 if (updated_row->full_width_p)
26889 from_x = WINDOW_TO_FRAME_PIXEL_X (w, from_x);
26890 to_x = WINDOW_TO_FRAME_PIXEL_X (w, to_x);
26892 else
26894 int area_left = window_box_left (w, updated_area);
26895 from_x += area_left;
26896 to_x += area_left;
26899 min_y = WINDOW_HEADER_LINE_HEIGHT (w);
26900 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, max (min_y, w->output_cursor.y));
26901 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, to_y);
26903 /* Prevent inadvertently clearing to end of the X window. */
26904 if (to_x > from_x && to_y > from_y)
26906 block_input ();
26907 FRAME_RIF (f)->clear_frame_area (f, from_x, from_y,
26908 to_x - from_x, to_y - from_y);
26909 unblock_input ();
26913 #endif /* HAVE_WINDOW_SYSTEM */
26917 /***********************************************************************
26918 Cursor types
26919 ***********************************************************************/
26921 /* Value is the internal representation of the specified cursor type
26922 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26923 of the bar cursor. */
26925 static enum text_cursor_kinds
26926 get_specified_cursor_type (Lisp_Object arg, int *width)
26928 enum text_cursor_kinds type;
26930 if (NILP (arg))
26931 return NO_CURSOR;
26933 if (EQ (arg, Qbox))
26934 return FILLED_BOX_CURSOR;
26936 if (EQ (arg, Qhollow))
26937 return HOLLOW_BOX_CURSOR;
26939 if (EQ (arg, Qbar))
26941 *width = 2;
26942 return BAR_CURSOR;
26945 if (CONSP (arg)
26946 && EQ (XCAR (arg), Qbar)
26947 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
26949 *width = XINT (XCDR (arg));
26950 return BAR_CURSOR;
26953 if (EQ (arg, Qhbar))
26955 *width = 2;
26956 return HBAR_CURSOR;
26959 if (CONSP (arg)
26960 && EQ (XCAR (arg), Qhbar)
26961 && RANGED_INTEGERP (0, XCDR (arg), INT_MAX))
26963 *width = XINT (XCDR (arg));
26964 return HBAR_CURSOR;
26967 /* Treat anything unknown as "hollow box cursor".
26968 It was bad to signal an error; people have trouble fixing
26969 .Xdefaults with Emacs, when it has something bad in it. */
26970 type = HOLLOW_BOX_CURSOR;
26972 return type;
26975 /* Set the default cursor types for specified frame. */
26976 void
26977 set_frame_cursor_types (struct frame *f, Lisp_Object arg)
26979 int width = 1;
26980 Lisp_Object tem;
26982 FRAME_DESIRED_CURSOR (f) = get_specified_cursor_type (arg, &width);
26983 FRAME_CURSOR_WIDTH (f) = width;
26985 /* By default, set up the blink-off state depending on the on-state. */
26987 tem = Fassoc (arg, Vblink_cursor_alist);
26988 if (!NILP (tem))
26990 FRAME_BLINK_OFF_CURSOR (f)
26991 = get_specified_cursor_type (XCDR (tem), &width);
26992 FRAME_BLINK_OFF_CURSOR_WIDTH (f) = width;
26994 else
26995 FRAME_BLINK_OFF_CURSOR (f) = DEFAULT_CURSOR;
26997 /* Make sure the cursor gets redrawn. */
26998 f->cursor_type_changed = 1;
27002 #ifdef HAVE_WINDOW_SYSTEM
27004 /* Return the cursor we want to be displayed in window W. Return
27005 width of bar/hbar cursor through WIDTH arg. Return with
27006 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27007 (i.e. if the `system caret' should track this cursor).
27009 In a mini-buffer window, we want the cursor only to appear if we
27010 are reading input from this window. For the selected window, we
27011 want the cursor type given by the frame parameter or buffer local
27012 setting of cursor-type. If explicitly marked off, draw no cursor.
27013 In all other cases, we want a hollow box cursor. */
27015 static enum text_cursor_kinds
27016 get_window_cursor_type (struct window *w, struct glyph *glyph, int *width,
27017 int *active_cursor)
27019 struct frame *f = XFRAME (w->frame);
27020 struct buffer *b = XBUFFER (w->contents);
27021 int cursor_type = DEFAULT_CURSOR;
27022 Lisp_Object alt_cursor;
27023 int non_selected = 0;
27025 *active_cursor = 1;
27027 /* Echo area */
27028 if (cursor_in_echo_area
27029 && FRAME_HAS_MINIBUF_P (f)
27030 && EQ (FRAME_MINIBUF_WINDOW (f), echo_area_window))
27032 if (w == XWINDOW (echo_area_window))
27034 if (EQ (BVAR (b, cursor_type), Qt) || NILP (BVAR (b, cursor_type)))
27036 *width = FRAME_CURSOR_WIDTH (f);
27037 return FRAME_DESIRED_CURSOR (f);
27039 else
27040 return get_specified_cursor_type (BVAR (b, cursor_type), width);
27043 *active_cursor = 0;
27044 non_selected = 1;
27047 /* Detect a nonselected window or nonselected frame. */
27048 else if (w != XWINDOW (f->selected_window)
27049 || f != FRAME_DISPLAY_INFO (f)->x_highlight_frame)
27051 *active_cursor = 0;
27053 if (MINI_WINDOW_P (w) && minibuf_level == 0)
27054 return NO_CURSOR;
27056 non_selected = 1;
27059 /* Never display a cursor in a window in which cursor-type is nil. */
27060 if (NILP (BVAR (b, cursor_type)))
27061 return NO_CURSOR;
27063 /* Get the normal cursor type for this window. */
27064 if (EQ (BVAR (b, cursor_type), Qt))
27066 cursor_type = FRAME_DESIRED_CURSOR (f);
27067 *width = FRAME_CURSOR_WIDTH (f);
27069 else
27070 cursor_type = get_specified_cursor_type (BVAR (b, cursor_type), width);
27072 /* Use cursor-in-non-selected-windows instead
27073 for non-selected window or frame. */
27074 if (non_selected)
27076 alt_cursor = BVAR (b, cursor_in_non_selected_windows);
27077 if (!EQ (Qt, alt_cursor))
27078 return get_specified_cursor_type (alt_cursor, width);
27079 /* t means modify the normal cursor type. */
27080 if (cursor_type == FILLED_BOX_CURSOR)
27081 cursor_type = HOLLOW_BOX_CURSOR;
27082 else if (cursor_type == BAR_CURSOR && *width > 1)
27083 --*width;
27084 return cursor_type;
27087 /* Use normal cursor if not blinked off. */
27088 if (!w->cursor_off_p)
27090 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
27092 if (cursor_type == FILLED_BOX_CURSOR)
27094 /* Using a block cursor on large images can be very annoying.
27095 So use a hollow cursor for "large" images.
27096 If image is not transparent (no mask), also use hollow cursor. */
27097 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
27098 if (img != NULL && IMAGEP (img->spec))
27100 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27101 where N = size of default frame font size.
27102 This should cover most of the "tiny" icons people may use. */
27103 if (!img->mask
27104 || img->width > max (32, WINDOW_FRAME_COLUMN_WIDTH (w))
27105 || img->height > max (32, WINDOW_FRAME_LINE_HEIGHT (w)))
27106 cursor_type = HOLLOW_BOX_CURSOR;
27109 else if (cursor_type != NO_CURSOR)
27111 /* Display current only supports BOX and HOLLOW cursors for images.
27112 So for now, unconditionally use a HOLLOW cursor when cursor is
27113 not a solid box cursor. */
27114 cursor_type = HOLLOW_BOX_CURSOR;
27117 return cursor_type;
27120 /* Cursor is blinked off, so determine how to "toggle" it. */
27122 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27123 if ((alt_cursor = Fassoc (BVAR (b, cursor_type), Vblink_cursor_alist), !NILP (alt_cursor)))
27124 return get_specified_cursor_type (XCDR (alt_cursor), width);
27126 /* Then see if frame has specified a specific blink off cursor type. */
27127 if (FRAME_BLINK_OFF_CURSOR (f) != DEFAULT_CURSOR)
27129 *width = FRAME_BLINK_OFF_CURSOR_WIDTH (f);
27130 return FRAME_BLINK_OFF_CURSOR (f);
27133 #if 0
27134 /* Some people liked having a permanently visible blinking cursor,
27135 while others had very strong opinions against it. So it was
27136 decided to remove it. KFS 2003-09-03 */
27138 /* Finally perform built-in cursor blinking:
27139 filled box <-> hollow box
27140 wide [h]bar <-> narrow [h]bar
27141 narrow [h]bar <-> no cursor
27142 other type <-> no cursor */
27144 if (cursor_type == FILLED_BOX_CURSOR)
27145 return HOLLOW_BOX_CURSOR;
27147 if ((cursor_type == BAR_CURSOR || cursor_type == HBAR_CURSOR) && *width > 1)
27149 *width = 1;
27150 return cursor_type;
27152 #endif
27154 return NO_CURSOR;
27158 /* Notice when the text cursor of window W has been completely
27159 overwritten by a drawing operation that outputs glyphs in AREA
27160 starting at X0 and ending at X1 in the line starting at Y0 and
27161 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27162 the rest of the line after X0 has been written. Y coordinates
27163 are window-relative. */
27165 static void
27166 notice_overwritten_cursor (struct window *w, enum glyph_row_area area,
27167 int x0, int x1, int y0, int y1)
27169 int cx0, cx1, cy0, cy1;
27170 struct glyph_row *row;
27172 if (!w->phys_cursor_on_p)
27173 return;
27174 if (area != TEXT_AREA)
27175 return;
27177 if (w->phys_cursor.vpos < 0
27178 || w->phys_cursor.vpos >= w->current_matrix->nrows
27179 || (row = w->current_matrix->rows + w->phys_cursor.vpos,
27180 !(row->enabled_p && MATRIX_ROW_DISPLAYS_TEXT_P (row))))
27181 return;
27183 if (row->cursor_in_fringe_p)
27185 row->cursor_in_fringe_p = 0;
27186 draw_fringe_bitmap (w, row, row->reversed_p);
27187 w->phys_cursor_on_p = 0;
27188 return;
27191 cx0 = w->phys_cursor.x;
27192 cx1 = cx0 + w->phys_cursor_width;
27193 if (x0 > cx0 || (x1 >= 0 && x1 < cx1))
27194 return;
27196 /* The cursor image will be completely removed from the
27197 screen if the output area intersects the cursor area in
27198 y-direction. When we draw in [y0 y1[, and some part of
27199 the cursor is at y < y0, that part must have been drawn
27200 before. When scrolling, the cursor is erased before
27201 actually scrolling, so we don't come here. When not
27202 scrolling, the rows above the old cursor row must have
27203 changed, and in this case these rows must have written
27204 over the cursor image.
27206 Likewise if part of the cursor is below y1, with the
27207 exception of the cursor being in the first blank row at
27208 the buffer and window end because update_text_area
27209 doesn't draw that row. (Except when it does, but
27210 that's handled in update_text_area.) */
27212 cy0 = w->phys_cursor.y;
27213 cy1 = cy0 + w->phys_cursor_height;
27214 if ((y0 < cy0 || y0 >= cy1) && (y1 <= cy0 || y1 >= cy1))
27215 return;
27217 w->phys_cursor_on_p = 0;
27220 #endif /* HAVE_WINDOW_SYSTEM */
27223 /************************************************************************
27224 Mouse Face
27225 ************************************************************************/
27227 #ifdef HAVE_WINDOW_SYSTEM
27229 /* EXPORT for RIF:
27230 Fix the display of area AREA of overlapping row ROW in window W
27231 with respect to the overlapping part OVERLAPS. */
27233 void
27234 x_fix_overlapping_area (struct window *w, struct glyph_row *row,
27235 enum glyph_row_area area, int overlaps)
27237 int i, x;
27239 block_input ();
27241 x = 0;
27242 for (i = 0; i < row->used[area];)
27244 if (row->glyphs[area][i].overlaps_vertically_p)
27246 int start = i, start_x = x;
27250 x += row->glyphs[area][i].pixel_width;
27251 ++i;
27253 while (i < row->used[area]
27254 && row->glyphs[area][i].overlaps_vertically_p);
27256 draw_glyphs (w, start_x, row, area,
27257 start, i,
27258 DRAW_NORMAL_TEXT, overlaps);
27260 else
27262 x += row->glyphs[area][i].pixel_width;
27263 ++i;
27267 unblock_input ();
27271 /* EXPORT:
27272 Draw the cursor glyph of window W in glyph row ROW. See the
27273 comment of draw_glyphs for the meaning of HL. */
27275 void
27276 draw_phys_cursor_glyph (struct window *w, struct glyph_row *row,
27277 enum draw_glyphs_face hl)
27279 /* If cursor hpos is out of bounds, don't draw garbage. This can
27280 happen in mini-buffer windows when switching between echo area
27281 glyphs and mini-buffer. */
27282 if ((row->reversed_p
27283 ? (w->phys_cursor.hpos >= 0)
27284 : (w->phys_cursor.hpos < row->used[TEXT_AREA])))
27286 int on_p = w->phys_cursor_on_p;
27287 int x1;
27288 int hpos = w->phys_cursor.hpos;
27290 /* When the window is hscrolled, cursor hpos can legitimately be
27291 out of bounds, but we draw the cursor at the corresponding
27292 window margin in that case. */
27293 if (!row->reversed_p && hpos < 0)
27294 hpos = 0;
27295 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27296 hpos = row->used[TEXT_AREA] - 1;
27298 x1 = draw_glyphs (w, w->phys_cursor.x, row, TEXT_AREA, hpos, hpos + 1,
27299 hl, 0);
27300 w->phys_cursor_on_p = on_p;
27302 if (hl == DRAW_CURSOR)
27303 w->phys_cursor_width = x1 - w->phys_cursor.x;
27304 /* When we erase the cursor, and ROW is overlapped by other
27305 rows, make sure that these overlapping parts of other rows
27306 are redrawn. */
27307 else if (hl == DRAW_NORMAL_TEXT && row->overlapped_p)
27309 w->phys_cursor_width = x1 - w->phys_cursor.x;
27311 if (row > w->current_matrix->rows
27312 && MATRIX_ROW_OVERLAPS_SUCC_P (row - 1))
27313 x_fix_overlapping_area (w, row - 1, TEXT_AREA,
27314 OVERLAPS_ERASED_CURSOR);
27316 if (MATRIX_ROW_BOTTOM_Y (row) < window_text_bottom_y (w)
27317 && MATRIX_ROW_OVERLAPS_PRED_P (row + 1))
27318 x_fix_overlapping_area (w, row + 1, TEXT_AREA,
27319 OVERLAPS_ERASED_CURSOR);
27325 /* Erase the image of a cursor of window W from the screen. */
27327 #ifndef HAVE_NTGUI
27328 static
27329 #endif
27330 void
27331 erase_phys_cursor (struct window *w)
27333 struct frame *f = XFRAME (w->frame);
27334 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
27335 int hpos = w->phys_cursor.hpos;
27336 int vpos = w->phys_cursor.vpos;
27337 int mouse_face_here_p = 0;
27338 struct glyph_matrix *active_glyphs = w->current_matrix;
27339 struct glyph_row *cursor_row;
27340 struct glyph *cursor_glyph;
27341 enum draw_glyphs_face hl;
27343 /* No cursor displayed or row invalidated => nothing to do on the
27344 screen. */
27345 if (w->phys_cursor_type == NO_CURSOR)
27346 goto mark_cursor_off;
27348 /* VPOS >= active_glyphs->nrows means that window has been resized.
27349 Don't bother to erase the cursor. */
27350 if (vpos >= active_glyphs->nrows)
27351 goto mark_cursor_off;
27353 /* If row containing cursor is marked invalid, there is nothing we
27354 can do. */
27355 cursor_row = MATRIX_ROW (active_glyphs, vpos);
27356 if (!cursor_row->enabled_p)
27357 goto mark_cursor_off;
27359 /* If line spacing is > 0, old cursor may only be partially visible in
27360 window after split-window. So adjust visible height. */
27361 cursor_row->visible_height = min (cursor_row->visible_height,
27362 window_text_bottom_y (w) - cursor_row->y);
27364 /* If row is completely invisible, don't attempt to delete a cursor which
27365 isn't there. This can happen if cursor is at top of a window, and
27366 we switch to a buffer with a header line in that window. */
27367 if (cursor_row->visible_height <= 0)
27368 goto mark_cursor_off;
27370 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27371 if (cursor_row->cursor_in_fringe_p)
27373 cursor_row->cursor_in_fringe_p = 0;
27374 draw_fringe_bitmap (w, cursor_row, cursor_row->reversed_p);
27375 goto mark_cursor_off;
27378 /* This can happen when the new row is shorter than the old one.
27379 In this case, either draw_glyphs or clear_end_of_line
27380 should have cleared the cursor. Note that we wouldn't be
27381 able to erase the cursor in this case because we don't have a
27382 cursor glyph at hand. */
27383 if ((cursor_row->reversed_p
27384 ? (w->phys_cursor.hpos < 0)
27385 : (w->phys_cursor.hpos >= cursor_row->used[TEXT_AREA])))
27386 goto mark_cursor_off;
27388 /* When the window is hscrolled, cursor hpos can legitimately be out
27389 of bounds, but we draw the cursor at the corresponding window
27390 margin in that case. */
27391 if (!cursor_row->reversed_p && hpos < 0)
27392 hpos = 0;
27393 if (cursor_row->reversed_p && hpos >= cursor_row->used[TEXT_AREA])
27394 hpos = cursor_row->used[TEXT_AREA] - 1;
27396 /* If the cursor is in the mouse face area, redisplay that when
27397 we clear the cursor. */
27398 if (! NILP (hlinfo->mouse_face_window)
27399 && coords_in_mouse_face_p (w, hpos, vpos)
27400 /* Don't redraw the cursor's spot in mouse face if it is at the
27401 end of a line (on a newline). The cursor appears there, but
27402 mouse highlighting does not. */
27403 && cursor_row->used[TEXT_AREA] > hpos && hpos >= 0)
27404 mouse_face_here_p = 1;
27406 /* Maybe clear the display under the cursor. */
27407 if (w->phys_cursor_type == HOLLOW_BOX_CURSOR)
27409 int x, y, left_x;
27410 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
27411 int width;
27413 cursor_glyph = get_phys_cursor_glyph (w);
27414 if (cursor_glyph == NULL)
27415 goto mark_cursor_off;
27417 width = cursor_glyph->pixel_width;
27418 left_x = window_box_left_offset (w, TEXT_AREA);
27419 x = w->phys_cursor.x;
27420 if (x < left_x)
27421 width -= left_x - x;
27422 width = min (width, window_box_width (w, TEXT_AREA) - x);
27423 y = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height, cursor_row->y));
27424 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, max (x, left_x));
27426 if (width > 0)
27427 FRAME_RIF (f)->clear_frame_area (f, x, y, width, cursor_row->visible_height);
27430 /* Erase the cursor by redrawing the character underneath it. */
27431 if (mouse_face_here_p)
27432 hl = DRAW_MOUSE_FACE;
27433 else
27434 hl = DRAW_NORMAL_TEXT;
27435 draw_phys_cursor_glyph (w, cursor_row, hl);
27437 mark_cursor_off:
27438 w->phys_cursor_on_p = 0;
27439 w->phys_cursor_type = NO_CURSOR;
27443 /* EXPORT:
27444 Display or clear cursor of window W. If ON is zero, clear the
27445 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27446 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27448 void
27449 display_and_set_cursor (struct window *w, bool on,
27450 int hpos, int vpos, int x, int y)
27452 struct frame *f = XFRAME (w->frame);
27453 int new_cursor_type;
27454 int new_cursor_width;
27455 int active_cursor;
27456 struct glyph_row *glyph_row;
27457 struct glyph *glyph;
27459 /* This is pointless on invisible frames, and dangerous on garbaged
27460 windows and frames; in the latter case, the frame or window may
27461 be in the midst of changing its size, and x and y may be off the
27462 window. */
27463 if (! FRAME_VISIBLE_P (f)
27464 || FRAME_GARBAGED_P (f)
27465 || vpos >= w->current_matrix->nrows
27466 || hpos >= w->current_matrix->matrix_w)
27467 return;
27469 /* If cursor is off and we want it off, return quickly. */
27470 if (!on && !w->phys_cursor_on_p)
27471 return;
27473 glyph_row = MATRIX_ROW (w->current_matrix, vpos);
27474 /* If cursor row is not enabled, we don't really know where to
27475 display the cursor. */
27476 if (!glyph_row->enabled_p)
27478 w->phys_cursor_on_p = 0;
27479 return;
27482 glyph = NULL;
27483 if (!glyph_row->exact_window_width_line_p
27484 || (0 <= hpos && hpos < glyph_row->used[TEXT_AREA]))
27485 glyph = glyph_row->glyphs[TEXT_AREA] + hpos;
27487 eassert (input_blocked_p ());
27489 /* Set new_cursor_type to the cursor we want to be displayed. */
27490 new_cursor_type = get_window_cursor_type (w, glyph,
27491 &new_cursor_width, &active_cursor);
27493 /* If cursor is currently being shown and we don't want it to be or
27494 it is in the wrong place, or the cursor type is not what we want,
27495 erase it. */
27496 if (w->phys_cursor_on_p
27497 && (!on
27498 || w->phys_cursor.x != x
27499 || w->phys_cursor.y != y
27500 /* HPOS can be negative in R2L rows whose
27501 exact_window_width_line_p flag is set (i.e. their newline
27502 would "overflow into the fringe"). */
27503 || hpos < 0
27504 || new_cursor_type != w->phys_cursor_type
27505 || ((new_cursor_type == BAR_CURSOR || new_cursor_type == HBAR_CURSOR)
27506 && new_cursor_width != w->phys_cursor_width)))
27507 erase_phys_cursor (w);
27509 /* Don't check phys_cursor_on_p here because that flag is only set
27510 to zero in some cases where we know that the cursor has been
27511 completely erased, to avoid the extra work of erasing the cursor
27512 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27513 still not be visible, or it has only been partly erased. */
27514 if (on)
27516 w->phys_cursor_ascent = glyph_row->ascent;
27517 w->phys_cursor_height = glyph_row->height;
27519 /* Set phys_cursor_.* before x_draw_.* is called because some
27520 of them may need the information. */
27521 w->phys_cursor.x = x;
27522 w->phys_cursor.y = glyph_row->y;
27523 w->phys_cursor.hpos = hpos;
27524 w->phys_cursor.vpos = vpos;
27527 FRAME_RIF (f)->draw_window_cursor (w, glyph_row, x, y,
27528 new_cursor_type, new_cursor_width,
27529 on, active_cursor);
27533 /* Switch the display of W's cursor on or off, according to the value
27534 of ON. */
27536 static void
27537 update_window_cursor (struct window *w, bool on)
27539 /* Don't update cursor in windows whose frame is in the process
27540 of being deleted. */
27541 if (w->current_matrix)
27543 int hpos = w->phys_cursor.hpos;
27544 int vpos = w->phys_cursor.vpos;
27545 struct glyph_row *row;
27547 if (vpos >= w->current_matrix->nrows
27548 || hpos >= w->current_matrix->matrix_w)
27549 return;
27551 row = MATRIX_ROW (w->current_matrix, vpos);
27553 /* When the window is hscrolled, cursor hpos can legitimately be
27554 out of bounds, but we draw the cursor at the corresponding
27555 window margin in that case. */
27556 if (!row->reversed_p && hpos < 0)
27557 hpos = 0;
27558 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27559 hpos = row->used[TEXT_AREA] - 1;
27561 block_input ();
27562 display_and_set_cursor (w, on, hpos, vpos,
27563 w->phys_cursor.x, w->phys_cursor.y);
27564 unblock_input ();
27569 /* Call update_window_cursor with parameter ON_P on all leaf windows
27570 in the window tree rooted at W. */
27572 static void
27573 update_cursor_in_window_tree (struct window *w, bool on_p)
27575 while (w)
27577 if (WINDOWP (w->contents))
27578 update_cursor_in_window_tree (XWINDOW (w->contents), on_p);
27579 else
27580 update_window_cursor (w, on_p);
27582 w = NILP (w->next) ? 0 : XWINDOW (w->next);
27587 /* EXPORT:
27588 Display the cursor on window W, or clear it, according to ON_P.
27589 Don't change the cursor's position. */
27591 void
27592 x_update_cursor (struct frame *f, bool on_p)
27594 update_cursor_in_window_tree (XWINDOW (f->root_window), on_p);
27598 /* EXPORT:
27599 Clear the cursor of window W to background color, and mark the
27600 cursor as not shown. This is used when the text where the cursor
27601 is about to be rewritten. */
27603 void
27604 x_clear_cursor (struct window *w)
27606 if (FRAME_VISIBLE_P (XFRAME (w->frame)) && w->phys_cursor_on_p)
27607 update_window_cursor (w, 0);
27610 #endif /* HAVE_WINDOW_SYSTEM */
27612 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27613 and MSDOS. */
27614 static void
27615 draw_row_with_mouse_face (struct window *w, int start_x, struct glyph_row *row,
27616 int start_hpos, int end_hpos,
27617 enum draw_glyphs_face draw)
27619 #ifdef HAVE_WINDOW_SYSTEM
27620 if (FRAME_WINDOW_P (XFRAME (w->frame)))
27622 draw_glyphs (w, start_x, row, TEXT_AREA, start_hpos, end_hpos, draw, 0);
27623 return;
27625 #endif
27626 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27627 tty_draw_row_with_mouse_face (w, row, start_hpos, end_hpos, draw);
27628 #endif
27631 /* Display the active region described by mouse_face_* according to DRAW. */
27633 static void
27634 show_mouse_face (Mouse_HLInfo *hlinfo, enum draw_glyphs_face draw)
27636 struct window *w = XWINDOW (hlinfo->mouse_face_window);
27637 struct frame *f = XFRAME (WINDOW_FRAME (w));
27639 if (/* If window is in the process of being destroyed, don't bother
27640 to do anything. */
27641 w->current_matrix != NULL
27642 /* Don't update mouse highlight if hidden. */
27643 && (draw != DRAW_MOUSE_FACE || !hlinfo->mouse_face_hidden)
27644 /* Recognize when we are called to operate on rows that don't exist
27645 anymore. This can happen when a window is split. */
27646 && hlinfo->mouse_face_end_row < w->current_matrix->nrows)
27648 int phys_cursor_on_p = w->phys_cursor_on_p;
27649 struct glyph_row *row, *first, *last;
27651 first = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_beg_row);
27652 last = MATRIX_ROW (w->current_matrix, hlinfo->mouse_face_end_row);
27654 for (row = first; row <= last && row->enabled_p; ++row)
27656 int start_hpos, end_hpos, start_x;
27658 /* For all but the first row, the highlight starts at column 0. */
27659 if (row == first)
27661 /* R2L rows have BEG and END in reversed order, but the
27662 screen drawing geometry is always left to right. So
27663 we need to mirror the beginning and end of the
27664 highlighted area in R2L rows. */
27665 if (!row->reversed_p)
27667 start_hpos = hlinfo->mouse_face_beg_col;
27668 start_x = hlinfo->mouse_face_beg_x;
27670 else if (row == last)
27672 start_hpos = hlinfo->mouse_face_end_col;
27673 start_x = hlinfo->mouse_face_end_x;
27675 else
27677 start_hpos = 0;
27678 start_x = 0;
27681 else if (row->reversed_p && row == last)
27683 start_hpos = hlinfo->mouse_face_end_col;
27684 start_x = hlinfo->mouse_face_end_x;
27686 else
27688 start_hpos = 0;
27689 start_x = 0;
27692 if (row == last)
27694 if (!row->reversed_p)
27695 end_hpos = hlinfo->mouse_face_end_col;
27696 else if (row == first)
27697 end_hpos = hlinfo->mouse_face_beg_col;
27698 else
27700 end_hpos = row->used[TEXT_AREA];
27701 if (draw == DRAW_NORMAL_TEXT)
27702 row->fill_line_p = 1; /* Clear to end of line */
27705 else if (row->reversed_p && row == first)
27706 end_hpos = hlinfo->mouse_face_beg_col;
27707 else
27709 end_hpos = row->used[TEXT_AREA];
27710 if (draw == DRAW_NORMAL_TEXT)
27711 row->fill_line_p = 1; /* Clear to end of line */
27714 if (end_hpos > start_hpos)
27716 draw_row_with_mouse_face (w, start_x, row,
27717 start_hpos, end_hpos, draw);
27719 row->mouse_face_p
27720 = draw == DRAW_MOUSE_FACE || draw == DRAW_IMAGE_RAISED;
27724 #ifdef HAVE_WINDOW_SYSTEM
27725 /* When we've written over the cursor, arrange for it to
27726 be displayed again. */
27727 if (FRAME_WINDOW_P (f)
27728 && phys_cursor_on_p && !w->phys_cursor_on_p)
27730 int hpos = w->phys_cursor.hpos;
27732 /* When the window is hscrolled, cursor hpos can legitimately be
27733 out of bounds, but we draw the cursor at the corresponding
27734 window margin in that case. */
27735 if (!row->reversed_p && hpos < 0)
27736 hpos = 0;
27737 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27738 hpos = row->used[TEXT_AREA] - 1;
27740 block_input ();
27741 display_and_set_cursor (w, 1, hpos, w->phys_cursor.vpos,
27742 w->phys_cursor.x, w->phys_cursor.y);
27743 unblock_input ();
27745 #endif /* HAVE_WINDOW_SYSTEM */
27748 #ifdef HAVE_WINDOW_SYSTEM
27749 /* Change the mouse cursor. */
27750 if (FRAME_WINDOW_P (f))
27752 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27753 if (draw == DRAW_NORMAL_TEXT
27754 && !EQ (hlinfo->mouse_face_window, f->tool_bar_window))
27755 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->text_cursor);
27756 else
27757 #endif
27758 if (draw == DRAW_MOUSE_FACE)
27759 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->hand_cursor);
27760 else
27761 FRAME_RIF (f)->define_frame_cursor (f, FRAME_X_OUTPUT (f)->nontext_cursor);
27763 #endif /* HAVE_WINDOW_SYSTEM */
27766 /* EXPORT:
27767 Clear out the mouse-highlighted active region.
27768 Redraw it un-highlighted first. Value is non-zero if mouse
27769 face was actually drawn unhighlighted. */
27772 clear_mouse_face (Mouse_HLInfo *hlinfo)
27774 int cleared = 0;
27776 if (!hlinfo->mouse_face_hidden && !NILP (hlinfo->mouse_face_window))
27778 show_mouse_face (hlinfo, DRAW_NORMAL_TEXT);
27779 cleared = 1;
27782 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
27783 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
27784 hlinfo->mouse_face_window = Qnil;
27785 hlinfo->mouse_face_overlay = Qnil;
27786 return cleared;
27789 /* Return true if the coordinates HPOS and VPOS on windows W are
27790 within the mouse face on that window. */
27791 static bool
27792 coords_in_mouse_face_p (struct window *w, int hpos, int vpos)
27794 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
27796 /* Quickly resolve the easy cases. */
27797 if (!(WINDOWP (hlinfo->mouse_face_window)
27798 && XWINDOW (hlinfo->mouse_face_window) == w))
27799 return false;
27800 if (vpos < hlinfo->mouse_face_beg_row
27801 || vpos > hlinfo->mouse_face_end_row)
27802 return false;
27803 if (vpos > hlinfo->mouse_face_beg_row
27804 && vpos < hlinfo->mouse_face_end_row)
27805 return true;
27807 if (!MATRIX_ROW (w->current_matrix, vpos)->reversed_p)
27809 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
27811 if (hlinfo->mouse_face_beg_col <= hpos && hpos < hlinfo->mouse_face_end_col)
27812 return true;
27814 else if ((vpos == hlinfo->mouse_face_beg_row
27815 && hpos >= hlinfo->mouse_face_beg_col)
27816 || (vpos == hlinfo->mouse_face_end_row
27817 && hpos < hlinfo->mouse_face_end_col))
27818 return true;
27820 else
27822 if (hlinfo->mouse_face_beg_row == hlinfo->mouse_face_end_row)
27824 if (hlinfo->mouse_face_end_col < hpos && hpos <= hlinfo->mouse_face_beg_col)
27825 return true;
27827 else if ((vpos == hlinfo->mouse_face_beg_row
27828 && hpos <= hlinfo->mouse_face_beg_col)
27829 || (vpos == hlinfo->mouse_face_end_row
27830 && hpos > hlinfo->mouse_face_end_col))
27831 return true;
27833 return false;
27837 /* EXPORT:
27838 True if physical cursor of window W is within mouse face. */
27840 bool
27841 cursor_in_mouse_face_p (struct window *w)
27843 int hpos = w->phys_cursor.hpos;
27844 int vpos = w->phys_cursor.vpos;
27845 struct glyph_row *row = MATRIX_ROW (w->current_matrix, vpos);
27847 /* When the window is hscrolled, cursor hpos can legitimately be out
27848 of bounds, but we draw the cursor at the corresponding window
27849 margin in that case. */
27850 if (!row->reversed_p && hpos < 0)
27851 hpos = 0;
27852 if (row->reversed_p && hpos >= row->used[TEXT_AREA])
27853 hpos = row->used[TEXT_AREA] - 1;
27855 return coords_in_mouse_face_p (w, hpos, vpos);
27860 /* Find the glyph rows START_ROW and END_ROW of window W that display
27861 characters between buffer positions START_CHARPOS and END_CHARPOS
27862 (excluding END_CHARPOS). DISP_STRING is a display string that
27863 covers these buffer positions. This is similar to
27864 row_containing_pos, but is more accurate when bidi reordering makes
27865 buffer positions change non-linearly with glyph rows. */
27866 static void
27867 rows_from_pos_range (struct window *w,
27868 ptrdiff_t start_charpos, ptrdiff_t end_charpos,
27869 Lisp_Object disp_string,
27870 struct glyph_row **start, struct glyph_row **end)
27872 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
27873 int last_y = window_text_bottom_y (w);
27874 struct glyph_row *row;
27876 *start = NULL;
27877 *end = NULL;
27879 while (!first->enabled_p
27880 && first < MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w))
27881 first++;
27883 /* Find the START row. */
27884 for (row = first;
27885 row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y;
27886 row++)
27888 /* A row can potentially be the START row if the range of the
27889 characters it displays intersects the range
27890 [START_CHARPOS..END_CHARPOS). */
27891 if (! ((start_charpos < MATRIX_ROW_START_CHARPOS (row)
27892 && end_charpos < MATRIX_ROW_START_CHARPOS (row))
27893 /* See the commentary in row_containing_pos, for the
27894 explanation of the complicated way to check whether
27895 some position is beyond the end of the characters
27896 displayed by a row. */
27897 || ((start_charpos > MATRIX_ROW_END_CHARPOS (row)
27898 || (start_charpos == MATRIX_ROW_END_CHARPOS (row)
27899 && !row->ends_at_zv_p
27900 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row)))
27901 && (end_charpos > MATRIX_ROW_END_CHARPOS (row)
27902 || (end_charpos == MATRIX_ROW_END_CHARPOS (row)
27903 && !row->ends_at_zv_p
27904 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row))))))
27906 /* Found a candidate row. Now make sure at least one of the
27907 glyphs it displays has a charpos from the range
27908 [START_CHARPOS..END_CHARPOS).
27910 This is not obvious because bidi reordering could make
27911 buffer positions of a row be 1,2,3,102,101,100, and if we
27912 want to highlight characters in [50..60), we don't want
27913 this row, even though [50..60) does intersect [1..103),
27914 the range of character positions given by the row's start
27915 and end positions. */
27916 struct glyph *g = row->glyphs[TEXT_AREA];
27917 struct glyph *e = g + row->used[TEXT_AREA];
27919 while (g < e)
27921 if (((BUFFERP (g->object) || INTEGERP (g->object))
27922 && start_charpos <= g->charpos && g->charpos < end_charpos)
27923 /* A glyph that comes from DISP_STRING is by
27924 definition to be highlighted. */
27925 || EQ (g->object, disp_string))
27926 *start = row;
27927 g++;
27929 if (*start)
27930 break;
27934 /* Find the END row. */
27935 if (!*start
27936 /* If the last row is partially visible, start looking for END
27937 from that row, instead of starting from FIRST. */
27938 && !(row->enabled_p
27939 && row->y < last_y && MATRIX_ROW_BOTTOM_Y (row) > last_y))
27940 row = first;
27941 for ( ; row->enabled_p && MATRIX_ROW_BOTTOM_Y (row) <= last_y; row++)
27943 struct glyph_row *next = row + 1;
27944 ptrdiff_t next_start = MATRIX_ROW_START_CHARPOS (next);
27946 if (!next->enabled_p
27947 || next >= MATRIX_BOTTOM_TEXT_ROW (w->current_matrix, w)
27948 /* The first row >= START whose range of displayed characters
27949 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27950 is the row END + 1. */
27951 || (start_charpos < next_start
27952 && end_charpos < next_start)
27953 || ((start_charpos > MATRIX_ROW_END_CHARPOS (next)
27954 || (start_charpos == MATRIX_ROW_END_CHARPOS (next)
27955 && !next->ends_at_zv_p
27956 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))
27957 && (end_charpos > MATRIX_ROW_END_CHARPOS (next)
27958 || (end_charpos == MATRIX_ROW_END_CHARPOS (next)
27959 && !next->ends_at_zv_p
27960 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next)))))
27962 *end = row;
27963 break;
27965 else
27967 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27968 but none of the characters it displays are in the range, it is
27969 also END + 1. */
27970 struct glyph *g = next->glyphs[TEXT_AREA];
27971 struct glyph *s = g;
27972 struct glyph *e = g + next->used[TEXT_AREA];
27974 while (g < e)
27976 if (((BUFFERP (g->object) || INTEGERP (g->object))
27977 && ((start_charpos <= g->charpos && g->charpos < end_charpos)
27978 /* If the buffer position of the first glyph in
27979 the row is equal to END_CHARPOS, it means
27980 the last character to be highlighted is the
27981 newline of ROW, and we must consider NEXT as
27982 END, not END+1. */
27983 || (((!next->reversed_p && g == s)
27984 || (next->reversed_p && g == e - 1))
27985 && (g->charpos == end_charpos
27986 /* Special case for when NEXT is an
27987 empty line at ZV. */
27988 || (g->charpos == -1
27989 && !row->ends_at_zv_p
27990 && next_start == end_charpos)))))
27991 /* A glyph that comes from DISP_STRING is by
27992 definition to be highlighted. */
27993 || EQ (g->object, disp_string))
27994 break;
27995 g++;
27997 if (g == e)
27999 *end = row;
28000 break;
28002 /* The first row that ends at ZV must be the last to be
28003 highlighted. */
28004 else if (next->ends_at_zv_p)
28006 *end = next;
28007 break;
28013 /* This function sets the mouse_face_* elements of HLINFO, assuming
28014 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28015 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28016 for the overlay or run of text properties specifying the mouse
28017 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28018 before-string and after-string that must also be highlighted.
28019 DISP_STRING, if non-nil, is a display string that may cover some
28020 or all of the highlighted text. */
28022 static void
28023 mouse_face_from_buffer_pos (Lisp_Object window,
28024 Mouse_HLInfo *hlinfo,
28025 ptrdiff_t mouse_charpos,
28026 ptrdiff_t start_charpos,
28027 ptrdiff_t end_charpos,
28028 Lisp_Object before_string,
28029 Lisp_Object after_string,
28030 Lisp_Object disp_string)
28032 struct window *w = XWINDOW (window);
28033 struct glyph_row *first = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28034 struct glyph_row *r1, *r2;
28035 struct glyph *glyph, *end;
28036 ptrdiff_t ignore, pos;
28037 int x;
28039 eassert (NILP (disp_string) || STRINGP (disp_string));
28040 eassert (NILP (before_string) || STRINGP (before_string));
28041 eassert (NILP (after_string) || STRINGP (after_string));
28043 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28044 rows_from_pos_range (w, start_charpos, end_charpos, disp_string, &r1, &r2);
28045 if (r1 == NULL)
28046 r1 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28047 /* If the before-string or display-string contains newlines,
28048 rows_from_pos_range skips to its last row. Move back. */
28049 if (!NILP (before_string) || !NILP (disp_string))
28051 struct glyph_row *prev;
28052 while ((prev = r1 - 1, prev >= first)
28053 && MATRIX_ROW_END_CHARPOS (prev) == start_charpos
28054 && prev->used[TEXT_AREA] > 0)
28056 struct glyph *beg = prev->glyphs[TEXT_AREA];
28057 glyph = beg + prev->used[TEXT_AREA];
28058 while (--glyph >= beg && INTEGERP (glyph->object));
28059 if (glyph < beg
28060 || !(EQ (glyph->object, before_string)
28061 || EQ (glyph->object, disp_string)))
28062 break;
28063 r1 = prev;
28066 if (r2 == NULL)
28068 r2 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28069 hlinfo->mouse_face_past_end = 1;
28071 else if (!NILP (after_string))
28073 /* If the after-string has newlines, advance to its last row. */
28074 struct glyph_row *next;
28075 struct glyph_row *last
28076 = MATRIX_ROW (w->current_matrix, w->window_end_vpos);
28078 for (next = r2 + 1;
28079 next <= last
28080 && next->used[TEXT_AREA] > 0
28081 && EQ (next->glyphs[TEXT_AREA]->object, after_string);
28082 ++next)
28083 r2 = next;
28085 /* The rest of the display engine assumes that mouse_face_beg_row is
28086 either above mouse_face_end_row or identical to it. But with
28087 bidi-reordered continued lines, the row for START_CHARPOS could
28088 be below the row for END_CHARPOS. If so, swap the rows and store
28089 them in correct order. */
28090 if (r1->y > r2->y)
28092 struct glyph_row *tem = r2;
28094 r2 = r1;
28095 r1 = tem;
28098 hlinfo->mouse_face_beg_row = MATRIX_ROW_VPOS (r1, w->current_matrix);
28099 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r2, w->current_matrix);
28101 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28102 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28103 could be anywhere in the row and in any order. The strategy
28104 below is to find the leftmost and the rightmost glyph that
28105 belongs to either of these 3 strings, or whose position is
28106 between START_CHARPOS and END_CHARPOS, and highlight all the
28107 glyphs between those two. This may cover more than just the text
28108 between START_CHARPOS and END_CHARPOS if the range of characters
28109 strides the bidi level boundary, e.g. if the beginning is in R2L
28110 text while the end is in L2R text or vice versa. */
28111 if (!r1->reversed_p)
28113 /* This row is in a left to right paragraph. Scan it left to
28114 right. */
28115 glyph = r1->glyphs[TEXT_AREA];
28116 end = glyph + r1->used[TEXT_AREA];
28117 x = r1->x;
28119 /* Skip truncation glyphs at the start of the glyph row. */
28120 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28121 for (; glyph < end
28122 && INTEGERP (glyph->object)
28123 && glyph->charpos < 0;
28124 ++glyph)
28125 x += glyph->pixel_width;
28127 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28128 or DISP_STRING, and the first glyph from buffer whose
28129 position is between START_CHARPOS and END_CHARPOS. */
28130 for (; glyph < end
28131 && !INTEGERP (glyph->object)
28132 && !EQ (glyph->object, disp_string)
28133 && !(BUFFERP (glyph->object)
28134 && (glyph->charpos >= start_charpos
28135 && glyph->charpos < end_charpos));
28136 ++glyph)
28138 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28139 are present at buffer positions between START_CHARPOS and
28140 END_CHARPOS, or if they come from an overlay. */
28141 if (EQ (glyph->object, before_string))
28143 pos = string_buffer_position (before_string,
28144 start_charpos);
28145 /* If pos == 0, it means before_string came from an
28146 overlay, not from a buffer position. */
28147 if (!pos || (pos >= start_charpos && pos < end_charpos))
28148 break;
28150 else if (EQ (glyph->object, after_string))
28152 pos = string_buffer_position (after_string, end_charpos);
28153 if (!pos || (pos >= start_charpos && pos < end_charpos))
28154 break;
28156 x += glyph->pixel_width;
28158 hlinfo->mouse_face_beg_x = x;
28159 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28161 else
28163 /* This row is in a right to left paragraph. Scan it right to
28164 left. */
28165 struct glyph *g;
28167 end = r1->glyphs[TEXT_AREA] - 1;
28168 glyph = end + r1->used[TEXT_AREA];
28170 /* Skip truncation glyphs at the start of the glyph row. */
28171 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1))
28172 for (; glyph > end
28173 && INTEGERP (glyph->object)
28174 && glyph->charpos < 0;
28175 --glyph)
28178 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28179 or DISP_STRING, and the first glyph from buffer whose
28180 position is between START_CHARPOS and END_CHARPOS. */
28181 for (; glyph > end
28182 && !INTEGERP (glyph->object)
28183 && !EQ (glyph->object, disp_string)
28184 && !(BUFFERP (glyph->object)
28185 && (glyph->charpos >= start_charpos
28186 && glyph->charpos < end_charpos));
28187 --glyph)
28189 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28190 are present at buffer positions between START_CHARPOS and
28191 END_CHARPOS, or if they come from an overlay. */
28192 if (EQ (glyph->object, before_string))
28194 pos = string_buffer_position (before_string, start_charpos);
28195 /* If pos == 0, it means before_string came from an
28196 overlay, not from a buffer position. */
28197 if (!pos || (pos >= start_charpos && pos < end_charpos))
28198 break;
28200 else if (EQ (glyph->object, after_string))
28202 pos = string_buffer_position (after_string, end_charpos);
28203 if (!pos || (pos >= start_charpos && pos < end_charpos))
28204 break;
28208 glyph++; /* first glyph to the right of the highlighted area */
28209 for (g = r1->glyphs[TEXT_AREA], x = r1->x; g < glyph; g++)
28210 x += g->pixel_width;
28211 hlinfo->mouse_face_beg_x = x;
28212 hlinfo->mouse_face_beg_col = glyph - r1->glyphs[TEXT_AREA];
28215 /* If the highlight ends in a different row, compute GLYPH and END
28216 for the end row. Otherwise, reuse the values computed above for
28217 the row where the highlight begins. */
28218 if (r2 != r1)
28220 if (!r2->reversed_p)
28222 glyph = r2->glyphs[TEXT_AREA];
28223 end = glyph + r2->used[TEXT_AREA];
28224 x = r2->x;
28226 else
28228 end = r2->glyphs[TEXT_AREA] - 1;
28229 glyph = end + r2->used[TEXT_AREA];
28233 if (!r2->reversed_p)
28235 /* Skip truncation and continuation glyphs near the end of the
28236 row, and also blanks and stretch glyphs inserted by
28237 extend_face_to_end_of_line. */
28238 while (end > glyph
28239 && INTEGERP ((end - 1)->object))
28240 --end;
28241 /* Scan the rest of the glyph row from the end, looking for the
28242 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28243 DISP_STRING, or whose position is between START_CHARPOS
28244 and END_CHARPOS */
28245 for (--end;
28246 end > glyph
28247 && !INTEGERP (end->object)
28248 && !EQ (end->object, disp_string)
28249 && !(BUFFERP (end->object)
28250 && (end->charpos >= start_charpos
28251 && end->charpos < end_charpos));
28252 --end)
28254 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28255 are present at buffer positions between START_CHARPOS and
28256 END_CHARPOS, or if they come from an overlay. */
28257 if (EQ (end->object, before_string))
28259 pos = string_buffer_position (before_string, start_charpos);
28260 if (!pos || (pos >= start_charpos && pos < end_charpos))
28261 break;
28263 else if (EQ (end->object, after_string))
28265 pos = string_buffer_position (after_string, end_charpos);
28266 if (!pos || (pos >= start_charpos && pos < end_charpos))
28267 break;
28270 /* Find the X coordinate of the last glyph to be highlighted. */
28271 for (; glyph <= end; ++glyph)
28272 x += glyph->pixel_width;
28274 hlinfo->mouse_face_end_x = x;
28275 hlinfo->mouse_face_end_col = glyph - r2->glyphs[TEXT_AREA];
28277 else
28279 /* Skip truncation and continuation glyphs near the end of the
28280 row, and also blanks and stretch glyphs inserted by
28281 extend_face_to_end_of_line. */
28282 x = r2->x;
28283 end++;
28284 while (end < glyph
28285 && INTEGERP (end->object))
28287 x += end->pixel_width;
28288 ++end;
28290 /* Scan the rest of the glyph row from the end, looking for the
28291 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28292 DISP_STRING, or whose position is between START_CHARPOS
28293 and END_CHARPOS */
28294 for ( ;
28295 end < glyph
28296 && !INTEGERP (end->object)
28297 && !EQ (end->object, disp_string)
28298 && !(BUFFERP (end->object)
28299 && (end->charpos >= start_charpos
28300 && end->charpos < end_charpos));
28301 ++end)
28303 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28304 are present at buffer positions between START_CHARPOS and
28305 END_CHARPOS, or if they come from an overlay. */
28306 if (EQ (end->object, before_string))
28308 pos = string_buffer_position (before_string, start_charpos);
28309 if (!pos || (pos >= start_charpos && pos < end_charpos))
28310 break;
28312 else if (EQ (end->object, after_string))
28314 pos = string_buffer_position (after_string, end_charpos);
28315 if (!pos || (pos >= start_charpos && pos < end_charpos))
28316 break;
28318 x += end->pixel_width;
28320 /* If we exited the above loop because we arrived at the last
28321 glyph of the row, and its buffer position is still not in
28322 range, it means the last character in range is the preceding
28323 newline. Bump the end column and x values to get past the
28324 last glyph. */
28325 if (end == glyph
28326 && BUFFERP (end->object)
28327 && (end->charpos < start_charpos
28328 || end->charpos >= end_charpos))
28330 x += end->pixel_width;
28331 ++end;
28333 hlinfo->mouse_face_end_x = x;
28334 hlinfo->mouse_face_end_col = end - r2->glyphs[TEXT_AREA];
28337 hlinfo->mouse_face_window = window;
28338 hlinfo->mouse_face_face_id
28339 = face_at_buffer_position (w, mouse_charpos, &ignore,
28340 mouse_charpos + 1,
28341 !hlinfo->mouse_face_hidden, -1);
28342 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
28345 /* The following function is not used anymore (replaced with
28346 mouse_face_from_string_pos), but I leave it here for the time
28347 being, in case someone would. */
28349 #if 0 /* not used */
28351 /* Find the position of the glyph for position POS in OBJECT in
28352 window W's current matrix, and return in *X, *Y the pixel
28353 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28355 RIGHT_P non-zero means return the position of the right edge of the
28356 glyph, RIGHT_P zero means return the left edge position.
28358 If no glyph for POS exists in the matrix, return the position of
28359 the glyph with the next smaller position that is in the matrix, if
28360 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28361 exists in the matrix, return the position of the glyph with the
28362 next larger position in OBJECT.
28364 Value is non-zero if a glyph was found. */
28366 static int
28367 fast_find_string_pos (struct window *w, ptrdiff_t pos, Lisp_Object object,
28368 int *hpos, int *vpos, int *x, int *y, int right_p)
28370 int yb = window_text_bottom_y (w);
28371 struct glyph_row *r;
28372 struct glyph *best_glyph = NULL;
28373 struct glyph_row *best_row = NULL;
28374 int best_x = 0;
28376 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28377 r->enabled_p && r->y < yb;
28378 ++r)
28380 struct glyph *g = r->glyphs[TEXT_AREA];
28381 struct glyph *e = g + r->used[TEXT_AREA];
28382 int gx;
28384 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28385 if (EQ (g->object, object))
28387 if (g->charpos == pos)
28389 best_glyph = g;
28390 best_x = gx;
28391 best_row = r;
28392 goto found;
28394 else if (best_glyph == NULL
28395 || ((eabs (g->charpos - pos)
28396 < eabs (best_glyph->charpos - pos))
28397 && (right_p
28398 ? g->charpos < pos
28399 : g->charpos > pos)))
28401 best_glyph = g;
28402 best_x = gx;
28403 best_row = r;
28408 found:
28410 if (best_glyph)
28412 *x = best_x;
28413 *hpos = best_glyph - best_row->glyphs[TEXT_AREA];
28415 if (right_p)
28417 *x += best_glyph->pixel_width;
28418 ++*hpos;
28421 *y = best_row->y;
28422 *vpos = MATRIX_ROW_VPOS (best_row, w->current_matrix);
28425 return best_glyph != NULL;
28427 #endif /* not used */
28429 /* Find the positions of the first and the last glyphs in window W's
28430 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28431 (assumed to be a string), and return in HLINFO's mouse_face_*
28432 members the pixel and column/row coordinates of those glyphs. */
28434 static void
28435 mouse_face_from_string_pos (struct window *w, Mouse_HLInfo *hlinfo,
28436 Lisp_Object object,
28437 ptrdiff_t startpos, ptrdiff_t endpos)
28439 int yb = window_text_bottom_y (w);
28440 struct glyph_row *r;
28441 struct glyph *g, *e;
28442 int gx;
28443 int found = 0;
28445 /* Find the glyph row with at least one position in the range
28446 [STARTPOS..ENDPOS), and the first glyph in that row whose
28447 position belongs to that range. */
28448 for (r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
28449 r->enabled_p && r->y < yb;
28450 ++r)
28452 if (!r->reversed_p)
28454 g = r->glyphs[TEXT_AREA];
28455 e = g + r->used[TEXT_AREA];
28456 for (gx = r->x; g < e; gx += g->pixel_width, ++g)
28457 if (EQ (g->object, object)
28458 && startpos <= g->charpos && g->charpos < endpos)
28460 hlinfo->mouse_face_beg_row
28461 = MATRIX_ROW_VPOS (r, w->current_matrix);
28462 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28463 hlinfo->mouse_face_beg_x = gx;
28464 found = 1;
28465 break;
28468 else
28470 struct glyph *g1;
28472 e = r->glyphs[TEXT_AREA];
28473 g = e + r->used[TEXT_AREA];
28474 for ( ; g > e; --g)
28475 if (EQ ((g-1)->object, object)
28476 && startpos <= (g-1)->charpos && (g-1)->charpos < endpos)
28478 hlinfo->mouse_face_beg_row
28479 = MATRIX_ROW_VPOS (r, w->current_matrix);
28480 hlinfo->mouse_face_beg_col = g - r->glyphs[TEXT_AREA];
28481 for (gx = r->x, g1 = r->glyphs[TEXT_AREA]; g1 < g; ++g1)
28482 gx += g1->pixel_width;
28483 hlinfo->mouse_face_beg_x = gx;
28484 found = 1;
28485 break;
28488 if (found)
28489 break;
28492 if (!found)
28493 return;
28495 /* Starting with the next row, look for the first row which does NOT
28496 include any glyphs whose positions are in the range. */
28497 for (++r; r->enabled_p && r->y < yb; ++r)
28499 g = r->glyphs[TEXT_AREA];
28500 e = g + r->used[TEXT_AREA];
28501 found = 0;
28502 for ( ; g < e; ++g)
28503 if (EQ (g->object, object)
28504 && startpos <= g->charpos && g->charpos < endpos)
28506 found = 1;
28507 break;
28509 if (!found)
28510 break;
28513 /* The highlighted region ends on the previous row. */
28514 r--;
28516 /* Set the end row. */
28517 hlinfo->mouse_face_end_row = MATRIX_ROW_VPOS (r, w->current_matrix);
28519 /* Compute and set the end column and the end column's horizontal
28520 pixel coordinate. */
28521 if (!r->reversed_p)
28523 g = r->glyphs[TEXT_AREA];
28524 e = g + r->used[TEXT_AREA];
28525 for ( ; e > g; --e)
28526 if (EQ ((e-1)->object, object)
28527 && startpos <= (e-1)->charpos && (e-1)->charpos < endpos)
28528 break;
28529 hlinfo->mouse_face_end_col = e - g;
28531 for (gx = r->x; g < e; ++g)
28532 gx += g->pixel_width;
28533 hlinfo->mouse_face_end_x = gx;
28535 else
28537 e = r->glyphs[TEXT_AREA];
28538 g = e + r->used[TEXT_AREA];
28539 for (gx = r->x ; e < g; ++e)
28541 if (EQ (e->object, object)
28542 && startpos <= e->charpos && e->charpos < endpos)
28543 break;
28544 gx += e->pixel_width;
28546 hlinfo->mouse_face_end_col = e - r->glyphs[TEXT_AREA];
28547 hlinfo->mouse_face_end_x = gx;
28551 #ifdef HAVE_WINDOW_SYSTEM
28553 /* See if position X, Y is within a hot-spot of an image. */
28555 static int
28556 on_hot_spot_p (Lisp_Object hot_spot, int x, int y)
28558 if (!CONSP (hot_spot))
28559 return 0;
28561 if (EQ (XCAR (hot_spot), Qrect))
28563 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28564 Lisp_Object rect = XCDR (hot_spot);
28565 Lisp_Object tem;
28566 if (!CONSP (rect))
28567 return 0;
28568 if (!CONSP (XCAR (rect)))
28569 return 0;
28570 if (!CONSP (XCDR (rect)))
28571 return 0;
28572 if (!(tem = XCAR (XCAR (rect)), INTEGERP (tem) && x >= XINT (tem)))
28573 return 0;
28574 if (!(tem = XCDR (XCAR (rect)), INTEGERP (tem) && y >= XINT (tem)))
28575 return 0;
28576 if (!(tem = XCAR (XCDR (rect)), INTEGERP (tem) && x <= XINT (tem)))
28577 return 0;
28578 if (!(tem = XCDR (XCDR (rect)), INTEGERP (tem) && y <= XINT (tem)))
28579 return 0;
28580 return 1;
28582 else if (EQ (XCAR (hot_spot), Qcircle))
28584 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28585 Lisp_Object circ = XCDR (hot_spot);
28586 Lisp_Object lr, lx0, ly0;
28587 if (CONSP (circ)
28588 && CONSP (XCAR (circ))
28589 && (lr = XCDR (circ), INTEGERP (lr) || FLOATP (lr))
28590 && (lx0 = XCAR (XCAR (circ)), INTEGERP (lx0))
28591 && (ly0 = XCDR (XCAR (circ)), INTEGERP (ly0)))
28593 double r = XFLOATINT (lr);
28594 double dx = XINT (lx0) - x;
28595 double dy = XINT (ly0) - y;
28596 return (dx * dx + dy * dy <= r * r);
28599 else if (EQ (XCAR (hot_spot), Qpoly))
28601 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28602 if (VECTORP (XCDR (hot_spot)))
28604 struct Lisp_Vector *v = XVECTOR (XCDR (hot_spot));
28605 Lisp_Object *poly = v->contents;
28606 ptrdiff_t n = v->header.size;
28607 ptrdiff_t i;
28608 int inside = 0;
28609 Lisp_Object lx, ly;
28610 int x0, y0;
28612 /* Need an even number of coordinates, and at least 3 edges. */
28613 if (n < 6 || n & 1)
28614 return 0;
28616 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28617 If count is odd, we are inside polygon. Pixels on edges
28618 may or may not be included depending on actual geometry of the
28619 polygon. */
28620 if ((lx = poly[n-2], !INTEGERP (lx))
28621 || (ly = poly[n-1], !INTEGERP (lx)))
28622 return 0;
28623 x0 = XINT (lx), y0 = XINT (ly);
28624 for (i = 0; i < n; i += 2)
28626 int x1 = x0, y1 = y0;
28627 if ((lx = poly[i], !INTEGERP (lx))
28628 || (ly = poly[i+1], !INTEGERP (ly)))
28629 return 0;
28630 x0 = XINT (lx), y0 = XINT (ly);
28632 /* Does this segment cross the X line? */
28633 if (x0 >= x)
28635 if (x1 >= x)
28636 continue;
28638 else if (x1 < x)
28639 continue;
28640 if (y > y0 && y > y1)
28641 continue;
28642 if (y < y0 + ((y1 - y0) * (x - x0)) / (x1 - x0))
28643 inside = !inside;
28645 return inside;
28648 return 0;
28651 Lisp_Object
28652 find_hot_spot (Lisp_Object map, int x, int y)
28654 while (CONSP (map))
28656 if (CONSP (XCAR (map))
28657 && on_hot_spot_p (XCAR (XCAR (map)), x, y))
28658 return XCAR (map);
28659 map = XCDR (map);
28662 return Qnil;
28665 DEFUN ("lookup-image-map", Flookup_image_map, Slookup_image_map,
28666 3, 3, 0,
28667 doc: /* Lookup in image map MAP coordinates X and Y.
28668 An image map is an alist where each element has the format (AREA ID PLIST).
28669 An AREA is specified as either a rectangle, a circle, or a polygon:
28670 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28671 pixel coordinates of the upper left and bottom right corners.
28672 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28673 and the radius of the circle; r may be a float or integer.
28674 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28675 vector describes one corner in the polygon.
28676 Returns the alist element for the first matching AREA in MAP. */)
28677 (Lisp_Object map, Lisp_Object x, Lisp_Object y)
28679 if (NILP (map))
28680 return Qnil;
28682 CHECK_NUMBER (x);
28683 CHECK_NUMBER (y);
28685 return find_hot_spot (map,
28686 clip_to_bounds (INT_MIN, XINT (x), INT_MAX),
28687 clip_to_bounds (INT_MIN, XINT (y), INT_MAX));
28691 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28692 static void
28693 define_frame_cursor1 (struct frame *f, Cursor cursor, Lisp_Object pointer)
28695 /* Do not change cursor shape while dragging mouse. */
28696 if (!NILP (do_mouse_tracking))
28697 return;
28699 if (!NILP (pointer))
28701 if (EQ (pointer, Qarrow))
28702 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28703 else if (EQ (pointer, Qhand))
28704 cursor = FRAME_X_OUTPUT (f)->hand_cursor;
28705 else if (EQ (pointer, Qtext))
28706 cursor = FRAME_X_OUTPUT (f)->text_cursor;
28707 else if (EQ (pointer, intern ("hdrag")))
28708 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
28709 else if (EQ (pointer, intern ("nhdrag")))
28710 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
28711 #ifdef HAVE_X_WINDOWS
28712 else if (EQ (pointer, intern ("vdrag")))
28713 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28714 #endif
28715 else if (EQ (pointer, intern ("hourglass")))
28716 cursor = FRAME_X_OUTPUT (f)->hourglass_cursor;
28717 else if (EQ (pointer, Qmodeline))
28718 cursor = FRAME_X_OUTPUT (f)->modeline_cursor;
28719 else
28720 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28723 if (cursor != No_Cursor)
28724 FRAME_RIF (f)->define_frame_cursor (f, cursor);
28727 #endif /* HAVE_WINDOW_SYSTEM */
28729 /* Take proper action when mouse has moved to the mode or header line
28730 or marginal area AREA of window W, x-position X and y-position Y.
28731 X is relative to the start of the text display area of W, so the
28732 width of bitmap areas and scroll bars must be subtracted to get a
28733 position relative to the start of the mode line. */
28735 static void
28736 note_mode_line_or_margin_highlight (Lisp_Object window, int x, int y,
28737 enum window_part area)
28739 struct window *w = XWINDOW (window);
28740 struct frame *f = XFRAME (w->frame);
28741 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
28742 #ifdef HAVE_WINDOW_SYSTEM
28743 Display_Info *dpyinfo;
28744 #endif
28745 Cursor cursor = No_Cursor;
28746 Lisp_Object pointer = Qnil;
28747 int dx, dy, width, height;
28748 ptrdiff_t charpos;
28749 Lisp_Object string, object = Qnil;
28750 Lisp_Object pos IF_LINT (= Qnil), help;
28752 Lisp_Object mouse_face;
28753 int original_x_pixel = x;
28754 struct glyph * glyph = NULL, * row_start_glyph = NULL;
28755 struct glyph_row *row IF_LINT (= 0);
28757 if (area == ON_MODE_LINE || area == ON_HEADER_LINE)
28759 int x0;
28760 struct glyph *end;
28762 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28763 returns them in row/column units! */
28764 string = mode_line_string (w, area, &x, &y, &charpos,
28765 &object, &dx, &dy, &width, &height);
28767 row = (area == ON_MODE_LINE
28768 ? MATRIX_MODE_LINE_ROW (w->current_matrix)
28769 : MATRIX_HEADER_LINE_ROW (w->current_matrix));
28771 /* Find the glyph under the mouse pointer. */
28772 if (row->mode_line_p && row->enabled_p)
28774 glyph = row_start_glyph = row->glyphs[TEXT_AREA];
28775 end = glyph + row->used[TEXT_AREA];
28777 for (x0 = original_x_pixel;
28778 glyph < end && x0 >= glyph->pixel_width;
28779 ++glyph)
28780 x0 -= glyph->pixel_width;
28782 if (glyph >= end)
28783 glyph = NULL;
28786 else
28788 x -= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w);
28789 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28790 returns them in row/column units! */
28791 string = marginal_area_string (w, area, &x, &y, &charpos,
28792 &object, &dx, &dy, &width, &height);
28795 help = Qnil;
28797 #ifdef HAVE_WINDOW_SYSTEM
28798 if (IMAGEP (object))
28800 Lisp_Object image_map, hotspot;
28801 if ((image_map = Fplist_get (XCDR (object), QCmap),
28802 !NILP (image_map))
28803 && (hotspot = find_hot_spot (image_map, dx, dy),
28804 CONSP (hotspot))
28805 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
28807 Lisp_Object plist;
28809 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28810 If so, we could look for mouse-enter, mouse-leave
28811 properties in PLIST (and do something...). */
28812 hotspot = XCDR (hotspot);
28813 if (CONSP (hotspot)
28814 && (plist = XCAR (hotspot), CONSP (plist)))
28816 pointer = Fplist_get (plist, Qpointer);
28817 if (NILP (pointer))
28818 pointer = Qhand;
28819 help = Fplist_get (plist, Qhelp_echo);
28820 if (!NILP (help))
28822 help_echo_string = help;
28823 XSETWINDOW (help_echo_window, w);
28824 help_echo_object = w->contents;
28825 help_echo_pos = charpos;
28829 if (NILP (pointer))
28830 pointer = Fplist_get (XCDR (object), QCpointer);
28832 #endif /* HAVE_WINDOW_SYSTEM */
28834 if (STRINGP (string))
28835 pos = make_number (charpos);
28837 /* Set the help text and mouse pointer. If the mouse is on a part
28838 of the mode line without any text (e.g. past the right edge of
28839 the mode line text), use the default help text and pointer. */
28840 if (STRINGP (string) || area == ON_MODE_LINE)
28842 /* Arrange to display the help by setting the global variables
28843 help_echo_string, help_echo_object, and help_echo_pos. */
28844 if (NILP (help))
28846 if (STRINGP (string))
28847 help = Fget_text_property (pos, Qhelp_echo, string);
28849 if (!NILP (help))
28851 help_echo_string = help;
28852 XSETWINDOW (help_echo_window, w);
28853 help_echo_object = string;
28854 help_echo_pos = charpos;
28856 else if (area == ON_MODE_LINE)
28858 Lisp_Object default_help
28859 = buffer_local_value_1 (Qmode_line_default_help_echo,
28860 w->contents);
28862 if (STRINGP (default_help))
28864 help_echo_string = default_help;
28865 XSETWINDOW (help_echo_window, w);
28866 help_echo_object = Qnil;
28867 help_echo_pos = -1;
28872 #ifdef HAVE_WINDOW_SYSTEM
28873 /* Change the mouse pointer according to what is under it. */
28874 if (FRAME_WINDOW_P (f))
28876 bool draggable = (! WINDOW_BOTTOMMOST_P (w)
28877 || minibuf_level
28878 || NILP (Vresize_mini_windows));
28880 dpyinfo = FRAME_DISPLAY_INFO (f);
28881 if (STRINGP (string))
28883 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
28885 if (NILP (pointer))
28886 pointer = Fget_text_property (pos, Qpointer, string);
28888 /* Change the mouse pointer according to what is under X/Y. */
28889 if (NILP (pointer)
28890 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE)))
28892 Lisp_Object map;
28893 map = Fget_text_property (pos, Qlocal_map, string);
28894 if (!KEYMAPP (map))
28895 map = Fget_text_property (pos, Qkeymap, string);
28896 if (!KEYMAPP (map) && draggable)
28897 cursor = dpyinfo->vertical_scroll_bar_cursor;
28900 else if (draggable)
28901 /* Default mode-line pointer. */
28902 cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
28904 #endif
28907 /* Change the mouse face according to what is under X/Y. */
28908 if (STRINGP (string))
28910 mouse_face = Fget_text_property (pos, Qmouse_face, string);
28911 if (!NILP (Vmouse_highlight) && !NILP (mouse_face)
28912 && ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
28913 && glyph)
28915 Lisp_Object b, e;
28917 struct glyph * tmp_glyph;
28919 int gpos;
28920 int gseq_length;
28921 int total_pixel_width;
28922 ptrdiff_t begpos, endpos, ignore;
28924 int vpos, hpos;
28926 b = Fprevious_single_property_change (make_number (charpos + 1),
28927 Qmouse_face, string, Qnil);
28928 if (NILP (b))
28929 begpos = 0;
28930 else
28931 begpos = XINT (b);
28933 e = Fnext_single_property_change (pos, Qmouse_face, string, Qnil);
28934 if (NILP (e))
28935 endpos = SCHARS (string);
28936 else
28937 endpos = XINT (e);
28939 /* Calculate the glyph position GPOS of GLYPH in the
28940 displayed string, relative to the beginning of the
28941 highlighted part of the string.
28943 Note: GPOS is different from CHARPOS. CHARPOS is the
28944 position of GLYPH in the internal string object. A mode
28945 line string format has structures which are converted to
28946 a flattened string by the Emacs Lisp interpreter. The
28947 internal string is an element of those structures. The
28948 displayed string is the flattened string. */
28949 tmp_glyph = row_start_glyph;
28950 while (tmp_glyph < glyph
28951 && (!(EQ (tmp_glyph->object, glyph->object)
28952 && begpos <= tmp_glyph->charpos
28953 && tmp_glyph->charpos < endpos)))
28954 tmp_glyph++;
28955 gpos = glyph - tmp_glyph;
28957 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28958 the highlighted part of the displayed string to which
28959 GLYPH belongs. Note: GSEQ_LENGTH is different from
28960 SCHARS (STRING), because the latter returns the length of
28961 the internal string. */
28962 for (tmp_glyph = row->glyphs[TEXT_AREA] + row->used[TEXT_AREA] - 1;
28963 tmp_glyph > glyph
28964 && (!(EQ (tmp_glyph->object, glyph->object)
28965 && begpos <= tmp_glyph->charpos
28966 && tmp_glyph->charpos < endpos));
28967 tmp_glyph--)
28969 gseq_length = gpos + (tmp_glyph - glyph) + 1;
28971 /* Calculate the total pixel width of all the glyphs between
28972 the beginning of the highlighted area and GLYPH. */
28973 total_pixel_width = 0;
28974 for (tmp_glyph = glyph - gpos; tmp_glyph != glyph; tmp_glyph++)
28975 total_pixel_width += tmp_glyph->pixel_width;
28977 /* Pre calculation of re-rendering position. Note: X is in
28978 column units here, after the call to mode_line_string or
28979 marginal_area_string. */
28980 hpos = x - gpos;
28981 vpos = (area == ON_MODE_LINE
28982 ? (w->current_matrix)->nrows - 1
28983 : 0);
28985 /* If GLYPH's position is included in the region that is
28986 already drawn in mouse face, we have nothing to do. */
28987 if ( EQ (window, hlinfo->mouse_face_window)
28988 && (!row->reversed_p
28989 ? (hlinfo->mouse_face_beg_col <= hpos
28990 && hpos < hlinfo->mouse_face_end_col)
28991 /* In R2L rows we swap BEG and END, see below. */
28992 : (hlinfo->mouse_face_end_col <= hpos
28993 && hpos < hlinfo->mouse_face_beg_col))
28994 && hlinfo->mouse_face_beg_row == vpos )
28995 return;
28997 if (clear_mouse_face (hlinfo))
28998 cursor = No_Cursor;
29000 if (!row->reversed_p)
29002 hlinfo->mouse_face_beg_col = hpos;
29003 hlinfo->mouse_face_beg_x = original_x_pixel
29004 - (total_pixel_width + dx);
29005 hlinfo->mouse_face_end_col = hpos + gseq_length;
29006 hlinfo->mouse_face_end_x = 0;
29008 else
29010 /* In R2L rows, show_mouse_face expects BEG and END
29011 coordinates to be swapped. */
29012 hlinfo->mouse_face_end_col = hpos;
29013 hlinfo->mouse_face_end_x = original_x_pixel
29014 - (total_pixel_width + dx);
29015 hlinfo->mouse_face_beg_col = hpos + gseq_length;
29016 hlinfo->mouse_face_beg_x = 0;
29019 hlinfo->mouse_face_beg_row = vpos;
29020 hlinfo->mouse_face_end_row = hlinfo->mouse_face_beg_row;
29021 hlinfo->mouse_face_past_end = 0;
29022 hlinfo->mouse_face_window = window;
29024 hlinfo->mouse_face_face_id = face_at_string_position (w, string,
29025 charpos,
29026 0, &ignore,
29027 glyph->face_id,
29029 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29031 if (NILP (pointer))
29032 pointer = Qhand;
29034 else if ((area == ON_MODE_LINE) || (area == ON_HEADER_LINE))
29035 clear_mouse_face (hlinfo);
29037 #ifdef HAVE_WINDOW_SYSTEM
29038 if (FRAME_WINDOW_P (f))
29039 define_frame_cursor1 (f, cursor, pointer);
29040 #endif
29044 /* EXPORT:
29045 Take proper action when the mouse has moved to position X, Y on
29046 frame F with regards to highlighting portions of display that have
29047 mouse-face properties. Also de-highlight portions of display where
29048 the mouse was before, set the mouse pointer shape as appropriate
29049 for the mouse coordinates, and activate help echo (tooltips).
29050 X and Y can be negative or out of range. */
29052 void
29053 note_mouse_highlight (struct frame *f, int x, int y)
29055 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29056 enum window_part part = ON_NOTHING;
29057 Lisp_Object window;
29058 struct window *w;
29059 Cursor cursor = No_Cursor;
29060 Lisp_Object pointer = Qnil; /* Takes precedence over cursor! */
29061 struct buffer *b;
29063 /* When a menu is active, don't highlight because this looks odd. */
29064 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29065 if (popup_activated ())
29066 return;
29067 #endif
29069 if (!f->glyphs_initialized_p
29070 || f->pointer_invisible)
29071 return;
29073 hlinfo->mouse_face_mouse_x = x;
29074 hlinfo->mouse_face_mouse_y = y;
29075 hlinfo->mouse_face_mouse_frame = f;
29077 if (hlinfo->mouse_face_defer)
29078 return;
29080 /* Which window is that in? */
29081 window = window_from_coordinates (f, x, y, &part, 1);
29083 /* If displaying active text in another window, clear that. */
29084 if (! EQ (window, hlinfo->mouse_face_window)
29085 /* Also clear if we move out of text area in same window. */
29086 || (!NILP (hlinfo->mouse_face_window)
29087 && !NILP (window)
29088 && part != ON_TEXT
29089 && part != ON_MODE_LINE
29090 && part != ON_HEADER_LINE))
29091 clear_mouse_face (hlinfo);
29093 /* Not on a window -> return. */
29094 if (!WINDOWP (window))
29095 return;
29097 /* Reset help_echo_string. It will get recomputed below. */
29098 help_echo_string = Qnil;
29100 /* Convert to window-relative pixel coordinates. */
29101 w = XWINDOW (window);
29102 frame_to_window_pixel_xy (w, &x, &y);
29104 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29105 /* Handle tool-bar window differently since it doesn't display a
29106 buffer. */
29107 if (EQ (window, f->tool_bar_window))
29109 note_tool_bar_highlight (f, x, y);
29110 return;
29112 #endif
29114 /* Mouse is on the mode, header line or margin? */
29115 if (part == ON_MODE_LINE || part == ON_HEADER_LINE
29116 || part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29118 note_mode_line_or_margin_highlight (window, x, y, part);
29120 #ifdef HAVE_WINDOW_SYSTEM
29121 if (part == ON_LEFT_MARGIN || part == ON_RIGHT_MARGIN)
29123 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29124 /* Show non-text cursor (Bug#16647). */
29125 goto set_cursor;
29127 else
29128 #endif
29129 return;
29132 #ifdef HAVE_WINDOW_SYSTEM
29133 if (part == ON_VERTICAL_BORDER)
29135 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29136 help_echo_string = build_string ("drag-mouse-1: resize");
29138 else if (part == ON_RIGHT_DIVIDER)
29140 cursor = FRAME_X_OUTPUT (f)->horizontal_drag_cursor;
29141 help_echo_string = build_string ("drag-mouse-1: resize");
29143 else if (part == ON_BOTTOM_DIVIDER)
29144 if (! WINDOW_BOTTOMMOST_P (w)
29145 || minibuf_level
29146 || NILP (Vresize_mini_windows))
29148 cursor = FRAME_X_OUTPUT (f)->vertical_drag_cursor;
29149 help_echo_string = build_string ("drag-mouse-1: resize");
29151 else
29152 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29153 else if (part == ON_LEFT_FRINGE || part == ON_RIGHT_FRINGE
29154 || part == ON_SCROLL_BAR)
29155 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29156 else
29157 cursor = FRAME_X_OUTPUT (f)->text_cursor;
29158 #endif
29160 /* Are we in a window whose display is up to date?
29161 And verify the buffer's text has not changed. */
29162 b = XBUFFER (w->contents);
29163 if (part == ON_TEXT && w->window_end_valid && !window_outdated (w))
29165 int hpos, vpos, dx, dy, area = LAST_AREA;
29166 ptrdiff_t pos;
29167 struct glyph *glyph;
29168 Lisp_Object object;
29169 Lisp_Object mouse_face = Qnil, position;
29170 Lisp_Object *overlay_vec = NULL;
29171 ptrdiff_t i, noverlays;
29172 struct buffer *obuf;
29173 ptrdiff_t obegv, ozv;
29174 int same_region;
29176 /* Find the glyph under X/Y. */
29177 glyph = x_y_to_hpos_vpos (w, x, y, &hpos, &vpos, &dx, &dy, &area);
29179 #ifdef HAVE_WINDOW_SYSTEM
29180 /* Look for :pointer property on image. */
29181 if (glyph != NULL && glyph->type == IMAGE_GLYPH)
29183 struct image *img = IMAGE_FROM_ID (f, glyph->u.img_id);
29184 if (img != NULL && IMAGEP (img->spec))
29186 Lisp_Object image_map, hotspot;
29187 if ((image_map = Fplist_get (XCDR (img->spec), QCmap),
29188 !NILP (image_map))
29189 && (hotspot = find_hot_spot (image_map,
29190 glyph->slice.img.x + dx,
29191 glyph->slice.img.y + dy),
29192 CONSP (hotspot))
29193 && (hotspot = XCDR (hotspot), CONSP (hotspot)))
29195 Lisp_Object plist;
29197 /* Could check XCAR (hotspot) to see if we enter/leave
29198 this hot-spot.
29199 If so, we could look for mouse-enter, mouse-leave
29200 properties in PLIST (and do something...). */
29201 hotspot = XCDR (hotspot);
29202 if (CONSP (hotspot)
29203 && (plist = XCAR (hotspot), CONSP (plist)))
29205 pointer = Fplist_get (plist, Qpointer);
29206 if (NILP (pointer))
29207 pointer = Qhand;
29208 help_echo_string = Fplist_get (plist, Qhelp_echo);
29209 if (!NILP (help_echo_string))
29211 help_echo_window = window;
29212 help_echo_object = glyph->object;
29213 help_echo_pos = glyph->charpos;
29217 if (NILP (pointer))
29218 pointer = Fplist_get (XCDR (img->spec), QCpointer);
29221 #endif /* HAVE_WINDOW_SYSTEM */
29223 /* Clear mouse face if X/Y not over text. */
29224 if (glyph == NULL
29225 || area != TEXT_AREA
29226 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w->current_matrix, vpos))
29227 /* Glyph's OBJECT is an integer for glyphs inserted by the
29228 display engine for its internal purposes, like truncation
29229 and continuation glyphs and blanks beyond the end of
29230 line's text on text terminals. If we are over such a
29231 glyph, we are not over any text. */
29232 || INTEGERP (glyph->object)
29233 /* R2L rows have a stretch glyph at their front, which
29234 stands for no text, whereas L2R rows have no glyphs at
29235 all beyond the end of text. Treat such stretch glyphs
29236 like we do with NULL glyphs in L2R rows. */
29237 || (MATRIX_ROW (w->current_matrix, vpos)->reversed_p
29238 && glyph == MATRIX_ROW_GLYPH_START (w->current_matrix, vpos)
29239 && glyph->type == STRETCH_GLYPH
29240 && glyph->avoid_cursor_p))
29242 if (clear_mouse_face (hlinfo))
29243 cursor = No_Cursor;
29244 #ifdef HAVE_WINDOW_SYSTEM
29245 if (FRAME_WINDOW_P (f) && NILP (pointer))
29247 if (area != TEXT_AREA)
29248 cursor = FRAME_X_OUTPUT (f)->nontext_cursor;
29249 else
29250 pointer = Vvoid_text_area_pointer;
29252 #endif
29253 goto set_cursor;
29256 pos = glyph->charpos;
29257 object = glyph->object;
29258 if (!STRINGP (object) && !BUFFERP (object))
29259 goto set_cursor;
29261 /* If we get an out-of-range value, return now; avoid an error. */
29262 if (BUFFERP (object) && pos > BUF_Z (b))
29263 goto set_cursor;
29265 /* Make the window's buffer temporarily current for
29266 overlays_at and compute_char_face. */
29267 obuf = current_buffer;
29268 current_buffer = b;
29269 obegv = BEGV;
29270 ozv = ZV;
29271 BEGV = BEG;
29272 ZV = Z;
29274 /* Is this char mouse-active or does it have help-echo? */
29275 position = make_number (pos);
29277 if (BUFFERP (object))
29279 /* Put all the overlays we want in a vector in overlay_vec. */
29280 GET_OVERLAYS_AT (pos, overlay_vec, noverlays, NULL, 0);
29281 /* Sort overlays into increasing priority order. */
29282 noverlays = sort_overlays (overlay_vec, noverlays, w);
29284 else
29285 noverlays = 0;
29287 if (NILP (Vmouse_highlight))
29289 clear_mouse_face (hlinfo);
29290 goto check_help_echo;
29293 same_region = coords_in_mouse_face_p (w, hpos, vpos);
29295 if (same_region)
29296 cursor = No_Cursor;
29298 /* Check mouse-face highlighting. */
29299 if (! same_region
29300 /* If there exists an overlay with mouse-face overlapping
29301 the one we are currently highlighting, we have to
29302 check if we enter the overlapping overlay, and then
29303 highlight only that. */
29304 || (OVERLAYP (hlinfo->mouse_face_overlay)
29305 && mouse_face_overlay_overlaps (hlinfo->mouse_face_overlay)))
29307 /* Find the highest priority overlay with a mouse-face. */
29308 Lisp_Object overlay = Qnil;
29309 for (i = noverlays - 1; i >= 0 && NILP (overlay); --i)
29311 mouse_face = Foverlay_get (overlay_vec[i], Qmouse_face);
29312 if (!NILP (mouse_face))
29313 overlay = overlay_vec[i];
29316 /* If we're highlighting the same overlay as before, there's
29317 no need to do that again. */
29318 if (!NILP (overlay) && EQ (overlay, hlinfo->mouse_face_overlay))
29319 goto check_help_echo;
29320 hlinfo->mouse_face_overlay = overlay;
29322 /* Clear the display of the old active region, if any. */
29323 if (clear_mouse_face (hlinfo))
29324 cursor = No_Cursor;
29326 /* If no overlay applies, get a text property. */
29327 if (NILP (overlay))
29328 mouse_face = Fget_text_property (position, Qmouse_face, object);
29330 /* Next, compute the bounds of the mouse highlighting and
29331 display it. */
29332 if (!NILP (mouse_face) && STRINGP (object))
29334 /* The mouse-highlighting comes from a display string
29335 with a mouse-face. */
29336 Lisp_Object s, e;
29337 ptrdiff_t ignore;
29339 s = Fprevious_single_property_change
29340 (make_number (pos + 1), Qmouse_face, object, Qnil);
29341 e = Fnext_single_property_change
29342 (position, Qmouse_face, object, Qnil);
29343 if (NILP (s))
29344 s = make_number (0);
29345 if (NILP (e))
29346 e = make_number (SCHARS (object));
29347 mouse_face_from_string_pos (w, hlinfo, object,
29348 XINT (s), XINT (e));
29349 hlinfo->mouse_face_past_end = 0;
29350 hlinfo->mouse_face_window = window;
29351 hlinfo->mouse_face_face_id
29352 = face_at_string_position (w, object, pos, 0, &ignore,
29353 glyph->face_id, 1);
29354 show_mouse_face (hlinfo, DRAW_MOUSE_FACE);
29355 cursor = No_Cursor;
29357 else
29359 /* The mouse-highlighting, if any, comes from an overlay
29360 or text property in the buffer. */
29361 Lisp_Object buffer IF_LINT (= Qnil);
29362 Lisp_Object disp_string IF_LINT (= Qnil);
29364 if (STRINGP (object))
29366 /* If we are on a display string with no mouse-face,
29367 check if the text under it has one. */
29368 struct glyph_row *r = MATRIX_ROW (w->current_matrix, vpos);
29369 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29370 pos = string_buffer_position (object, start);
29371 if (pos > 0)
29373 mouse_face = get_char_property_and_overlay
29374 (make_number (pos), Qmouse_face, w->contents, &overlay);
29375 buffer = w->contents;
29376 disp_string = object;
29379 else
29381 buffer = object;
29382 disp_string = Qnil;
29385 if (!NILP (mouse_face))
29387 Lisp_Object before, after;
29388 Lisp_Object before_string, after_string;
29389 /* To correctly find the limits of mouse highlight
29390 in a bidi-reordered buffer, we must not use the
29391 optimization of limiting the search in
29392 previous-single-property-change and
29393 next-single-property-change, because
29394 rows_from_pos_range needs the real start and end
29395 positions to DTRT in this case. That's because
29396 the first row visible in a window does not
29397 necessarily display the character whose position
29398 is the smallest. */
29399 Lisp_Object lim1
29400 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29401 ? Fmarker_position (w->start)
29402 : Qnil;
29403 Lisp_Object lim2
29404 = NILP (BVAR (XBUFFER (buffer), bidi_display_reordering))
29405 ? make_number (BUF_Z (XBUFFER (buffer))
29406 - w->window_end_pos)
29407 : Qnil;
29409 if (NILP (overlay))
29411 /* Handle the text property case. */
29412 before = Fprevious_single_property_change
29413 (make_number (pos + 1), Qmouse_face, buffer, lim1);
29414 after = Fnext_single_property_change
29415 (make_number (pos), Qmouse_face, buffer, lim2);
29416 before_string = after_string = Qnil;
29418 else
29420 /* Handle the overlay case. */
29421 before = Foverlay_start (overlay);
29422 after = Foverlay_end (overlay);
29423 before_string = Foverlay_get (overlay, Qbefore_string);
29424 after_string = Foverlay_get (overlay, Qafter_string);
29426 if (!STRINGP (before_string)) before_string = Qnil;
29427 if (!STRINGP (after_string)) after_string = Qnil;
29430 mouse_face_from_buffer_pos (window, hlinfo, pos,
29431 NILP (before)
29433 : XFASTINT (before),
29434 NILP (after)
29435 ? BUF_Z (XBUFFER (buffer))
29436 : XFASTINT (after),
29437 before_string, after_string,
29438 disp_string);
29439 cursor = No_Cursor;
29444 check_help_echo:
29446 /* Look for a `help-echo' property. */
29447 if (NILP (help_echo_string)) {
29448 Lisp_Object help, overlay;
29450 /* Check overlays first. */
29451 help = overlay = Qnil;
29452 for (i = noverlays - 1; i >= 0 && NILP (help); --i)
29454 overlay = overlay_vec[i];
29455 help = Foverlay_get (overlay, Qhelp_echo);
29458 if (!NILP (help))
29460 help_echo_string = help;
29461 help_echo_window = window;
29462 help_echo_object = overlay;
29463 help_echo_pos = pos;
29465 else
29467 Lisp_Object obj = glyph->object;
29468 ptrdiff_t charpos = glyph->charpos;
29470 /* Try text properties. */
29471 if (STRINGP (obj)
29472 && charpos >= 0
29473 && charpos < SCHARS (obj))
29475 help = Fget_text_property (make_number (charpos),
29476 Qhelp_echo, obj);
29477 if (NILP (help))
29479 /* If the string itself doesn't specify a help-echo,
29480 see if the buffer text ``under'' it does. */
29481 struct glyph_row *r
29482 = MATRIX_ROW (w->current_matrix, vpos);
29483 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29484 ptrdiff_t p = string_buffer_position (obj, start);
29485 if (p > 0)
29487 help = Fget_char_property (make_number (p),
29488 Qhelp_echo, w->contents);
29489 if (!NILP (help))
29491 charpos = p;
29492 obj = w->contents;
29497 else if (BUFFERP (obj)
29498 && charpos >= BEGV
29499 && charpos < ZV)
29500 help = Fget_text_property (make_number (charpos), Qhelp_echo,
29501 obj);
29503 if (!NILP (help))
29505 help_echo_string = help;
29506 help_echo_window = window;
29507 help_echo_object = obj;
29508 help_echo_pos = charpos;
29513 #ifdef HAVE_WINDOW_SYSTEM
29514 /* Look for a `pointer' property. */
29515 if (FRAME_WINDOW_P (f) && NILP (pointer))
29517 /* Check overlays first. */
29518 for (i = noverlays - 1; i >= 0 && NILP (pointer); --i)
29519 pointer = Foverlay_get (overlay_vec[i], Qpointer);
29521 if (NILP (pointer))
29523 Lisp_Object obj = glyph->object;
29524 ptrdiff_t charpos = glyph->charpos;
29526 /* Try text properties. */
29527 if (STRINGP (obj)
29528 && charpos >= 0
29529 && charpos < SCHARS (obj))
29531 pointer = Fget_text_property (make_number (charpos),
29532 Qpointer, obj);
29533 if (NILP (pointer))
29535 /* If the string itself doesn't specify a pointer,
29536 see if the buffer text ``under'' it does. */
29537 struct glyph_row *r
29538 = MATRIX_ROW (w->current_matrix, vpos);
29539 ptrdiff_t start = MATRIX_ROW_START_CHARPOS (r);
29540 ptrdiff_t p = string_buffer_position (obj, start);
29541 if (p > 0)
29542 pointer = Fget_char_property (make_number (p),
29543 Qpointer, w->contents);
29546 else if (BUFFERP (obj)
29547 && charpos >= BEGV
29548 && charpos < ZV)
29549 pointer = Fget_text_property (make_number (charpos),
29550 Qpointer, obj);
29553 #endif /* HAVE_WINDOW_SYSTEM */
29555 BEGV = obegv;
29556 ZV = ozv;
29557 current_buffer = obuf;
29560 set_cursor:
29562 #ifdef HAVE_WINDOW_SYSTEM
29563 if (FRAME_WINDOW_P (f))
29564 define_frame_cursor1 (f, cursor, pointer);
29565 #else
29566 /* This is here to prevent a compiler error, about "label at end of
29567 compound statement". */
29568 return;
29569 #endif
29573 /* EXPORT for RIF:
29574 Clear any mouse-face on window W. This function is part of the
29575 redisplay interface, and is called from try_window_id and similar
29576 functions to ensure the mouse-highlight is off. */
29578 void
29579 x_clear_window_mouse_face (struct window *w)
29581 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
29582 Lisp_Object window;
29584 block_input ();
29585 XSETWINDOW (window, w);
29586 if (EQ (window, hlinfo->mouse_face_window))
29587 clear_mouse_face (hlinfo);
29588 unblock_input ();
29592 /* EXPORT:
29593 Just discard the mouse face information for frame F, if any.
29594 This is used when the size of F is changed. */
29596 void
29597 cancel_mouse_face (struct frame *f)
29599 Lisp_Object window;
29600 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
29602 window = hlinfo->mouse_face_window;
29603 if (! NILP (window) && XFRAME (XWINDOW (window)->frame) == f)
29604 reset_mouse_highlight (hlinfo);
29609 /***********************************************************************
29610 Exposure Events
29611 ***********************************************************************/
29613 #ifdef HAVE_WINDOW_SYSTEM
29615 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29616 which intersects rectangle R. R is in window-relative coordinates. */
29618 static void
29619 expose_area (struct window *w, struct glyph_row *row, XRectangle *r,
29620 enum glyph_row_area area)
29622 struct glyph *first = row->glyphs[area];
29623 struct glyph *end = row->glyphs[area] + row->used[area];
29624 struct glyph *last;
29625 int first_x, start_x, x;
29627 if (area == TEXT_AREA && row->fill_line_p)
29628 /* If row extends face to end of line write the whole line. */
29629 draw_glyphs (w, 0, row, area,
29630 0, row->used[area],
29631 DRAW_NORMAL_TEXT, 0);
29632 else
29634 /* Set START_X to the window-relative start position for drawing glyphs of
29635 AREA. The first glyph of the text area can be partially visible.
29636 The first glyphs of other areas cannot. */
29637 start_x = window_box_left_offset (w, area);
29638 x = start_x;
29639 if (area == TEXT_AREA)
29640 x += row->x;
29642 /* Find the first glyph that must be redrawn. */
29643 while (first < end
29644 && x + first->pixel_width < r->x)
29646 x += first->pixel_width;
29647 ++first;
29650 /* Find the last one. */
29651 last = first;
29652 first_x = x;
29653 while (last < end
29654 && x < r->x + r->width)
29656 x += last->pixel_width;
29657 ++last;
29660 /* Repaint. */
29661 if (last > first)
29662 draw_glyphs (w, first_x - start_x, row, area,
29663 first - row->glyphs[area], last - row->glyphs[area],
29664 DRAW_NORMAL_TEXT, 0);
29669 /* Redraw the parts of the glyph row ROW on window W intersecting
29670 rectangle R. R is in window-relative coordinates. Value is
29671 non-zero if mouse-face was overwritten. */
29673 static int
29674 expose_line (struct window *w, struct glyph_row *row, XRectangle *r)
29676 eassert (row->enabled_p);
29678 if (row->mode_line_p || w->pseudo_window_p)
29679 draw_glyphs (w, 0, row, TEXT_AREA,
29680 0, row->used[TEXT_AREA],
29681 DRAW_NORMAL_TEXT, 0);
29682 else
29684 if (row->used[LEFT_MARGIN_AREA])
29685 expose_area (w, row, r, LEFT_MARGIN_AREA);
29686 if (row->used[TEXT_AREA])
29687 expose_area (w, row, r, TEXT_AREA);
29688 if (row->used[RIGHT_MARGIN_AREA])
29689 expose_area (w, row, r, RIGHT_MARGIN_AREA);
29690 draw_row_fringe_bitmaps (w, row);
29693 return row->mouse_face_p;
29697 /* Redraw those parts of glyphs rows during expose event handling that
29698 overlap other rows. Redrawing of an exposed line writes over parts
29699 of lines overlapping that exposed line; this function fixes that.
29701 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29702 row in W's current matrix that is exposed and overlaps other rows.
29703 LAST_OVERLAPPING_ROW is the last such row. */
29705 static void
29706 expose_overlaps (struct window *w,
29707 struct glyph_row *first_overlapping_row,
29708 struct glyph_row *last_overlapping_row,
29709 XRectangle *r)
29711 struct glyph_row *row;
29713 for (row = first_overlapping_row; row <= last_overlapping_row; ++row)
29714 if (row->overlapping_p)
29716 eassert (row->enabled_p && !row->mode_line_p);
29718 row->clip = r;
29719 if (row->used[LEFT_MARGIN_AREA])
29720 x_fix_overlapping_area (w, row, LEFT_MARGIN_AREA, OVERLAPS_BOTH);
29722 if (row->used[TEXT_AREA])
29723 x_fix_overlapping_area (w, row, TEXT_AREA, OVERLAPS_BOTH);
29725 if (row->used[RIGHT_MARGIN_AREA])
29726 x_fix_overlapping_area (w, row, RIGHT_MARGIN_AREA, OVERLAPS_BOTH);
29727 row->clip = NULL;
29732 /* Return non-zero if W's cursor intersects rectangle R. */
29734 static int
29735 phys_cursor_in_rect_p (struct window *w, XRectangle *r)
29737 XRectangle cr, result;
29738 struct glyph *cursor_glyph;
29739 struct glyph_row *row;
29741 if (w->phys_cursor.vpos >= 0
29742 && w->phys_cursor.vpos < w->current_matrix->nrows
29743 && (row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos),
29744 row->enabled_p)
29745 && row->cursor_in_fringe_p)
29747 /* Cursor is in the fringe. */
29748 cr.x = window_box_right_offset (w,
29749 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
29750 ? RIGHT_MARGIN_AREA
29751 : TEXT_AREA));
29752 cr.y = row->y;
29753 cr.width = WINDOW_RIGHT_FRINGE_WIDTH (w);
29754 cr.height = row->height;
29755 return x_intersect_rectangles (&cr, r, &result);
29758 cursor_glyph = get_phys_cursor_glyph (w);
29759 if (cursor_glyph)
29761 /* r is relative to W's box, but w->phys_cursor.x is relative
29762 to left edge of W's TEXT area. Adjust it. */
29763 cr.x = window_box_left_offset (w, TEXT_AREA) + w->phys_cursor.x;
29764 cr.y = w->phys_cursor.y;
29765 cr.width = cursor_glyph->pixel_width;
29766 cr.height = w->phys_cursor_height;
29767 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29768 I assume the effect is the same -- and this is portable. */
29769 return x_intersect_rectangles (&cr, r, &result);
29771 /* If we don't understand the format, pretend we're not in the hot-spot. */
29772 return 0;
29776 /* EXPORT:
29777 Draw a vertical window border to the right of window W if W doesn't
29778 have vertical scroll bars. */
29780 void
29781 x_draw_vertical_border (struct window *w)
29783 struct frame *f = XFRAME (WINDOW_FRAME (w));
29785 /* We could do better, if we knew what type of scroll-bar the adjacent
29786 windows (on either side) have... But we don't :-(
29787 However, I think this works ok. ++KFS 2003-04-25 */
29789 /* Redraw borders between horizontally adjacent windows. Don't
29790 do it for frames with vertical scroll bars because either the
29791 right scroll bar of a window, or the left scroll bar of its
29792 neighbor will suffice as a border. */
29793 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f) || FRAME_RIGHT_DIVIDER_WIDTH (f))
29794 return;
29796 /* Note: It is necessary to redraw both the left and the right
29797 borders, for when only this single window W is being
29798 redisplayed. */
29799 if (!WINDOW_RIGHTMOST_P (w)
29800 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
29802 int x0, x1, y0, y1;
29804 window_box_edges (w, &x0, &y0, &x1, &y1);
29805 y1 -= 1;
29807 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
29808 x1 -= 1;
29810 FRAME_RIF (f)->draw_vertical_window_border (w, x1, y0, y1);
29813 if (!WINDOW_LEFTMOST_P (w)
29814 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
29816 int x0, x1, y0, y1;
29818 window_box_edges (w, &x0, &y0, &x1, &y1);
29819 y1 -= 1;
29821 if (WINDOW_LEFT_FRINGE_WIDTH (w) == 0)
29822 x0 -= 1;
29824 FRAME_RIF (f)->draw_vertical_window_border (w, x0, y0, y1);
29829 /* Draw window dividers for window W. */
29831 void
29832 x_draw_right_divider (struct window *w)
29834 struct frame *f = WINDOW_XFRAME (w);
29836 if (w->mini || w->pseudo_window_p)
29837 return;
29838 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
29840 int x0 = WINDOW_RIGHT_EDGE_X (w) - WINDOW_RIGHT_DIVIDER_WIDTH (w);
29841 int x1 = WINDOW_RIGHT_EDGE_X (w);
29842 int y0 = WINDOW_TOP_EDGE_Y (w);
29843 /* The bottom divider prevails. */
29844 int y1 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
29846 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
29850 static void
29851 x_draw_bottom_divider (struct window *w)
29853 struct frame *f = XFRAME (WINDOW_FRAME (w));
29855 if (w->mini || w->pseudo_window_p)
29856 return;
29857 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
29859 int x0 = WINDOW_LEFT_EDGE_X (w);
29860 int x1 = WINDOW_RIGHT_EDGE_X (w);
29861 int y0 = WINDOW_BOTTOM_EDGE_Y (w) - WINDOW_BOTTOM_DIVIDER_WIDTH (w);
29862 int y1 = WINDOW_BOTTOM_EDGE_Y (w);
29864 FRAME_RIF (f)->draw_window_divider (w, x0, x1, y0, y1);
29868 /* Redraw the part of window W intersection rectangle FR. Pixel
29869 coordinates in FR are frame-relative. Call this function with
29870 input blocked. Value is non-zero if the exposure overwrites
29871 mouse-face. */
29873 static int
29874 expose_window (struct window *w, XRectangle *fr)
29876 struct frame *f = XFRAME (w->frame);
29877 XRectangle wr, r;
29878 int mouse_face_overwritten_p = 0;
29880 /* If window is not yet fully initialized, do nothing. This can
29881 happen when toolkit scroll bars are used and a window is split.
29882 Reconfiguring the scroll bar will generate an expose for a newly
29883 created window. */
29884 if (w->current_matrix == NULL)
29885 return 0;
29887 /* When we're currently updating the window, display and current
29888 matrix usually don't agree. Arrange for a thorough display
29889 later. */
29890 if (w->must_be_updated_p)
29892 SET_FRAME_GARBAGED (f);
29893 return 0;
29896 /* Frame-relative pixel rectangle of W. */
29897 wr.x = WINDOW_LEFT_EDGE_X (w);
29898 wr.y = WINDOW_TOP_EDGE_Y (w);
29899 wr.width = WINDOW_PIXEL_WIDTH (w);
29900 wr.height = WINDOW_PIXEL_HEIGHT (w);
29902 if (x_intersect_rectangles (fr, &wr, &r))
29904 int yb = window_text_bottom_y (w);
29905 struct glyph_row *row;
29906 int cursor_cleared_p, phys_cursor_on_p;
29907 struct glyph_row *first_overlapping_row, *last_overlapping_row;
29909 TRACE ((stderr, "expose_window (%d, %d, %d, %d)\n",
29910 r.x, r.y, r.width, r.height));
29912 /* Convert to window coordinates. */
29913 r.x -= WINDOW_LEFT_EDGE_X (w);
29914 r.y -= WINDOW_TOP_EDGE_Y (w);
29916 /* Turn off the cursor. */
29917 if (!w->pseudo_window_p
29918 && phys_cursor_in_rect_p (w, &r))
29920 x_clear_cursor (w);
29921 cursor_cleared_p = 1;
29923 else
29924 cursor_cleared_p = 0;
29926 /* If the row containing the cursor extends face to end of line,
29927 then expose_area might overwrite the cursor outside the
29928 rectangle and thus notice_overwritten_cursor might clear
29929 w->phys_cursor_on_p. We remember the original value and
29930 check later if it is changed. */
29931 phys_cursor_on_p = w->phys_cursor_on_p;
29933 /* Update lines intersecting rectangle R. */
29934 first_overlapping_row = last_overlapping_row = NULL;
29935 for (row = w->current_matrix->rows;
29936 row->enabled_p;
29937 ++row)
29939 int y0 = row->y;
29940 int y1 = MATRIX_ROW_BOTTOM_Y (row);
29942 if ((y0 >= r.y && y0 < r.y + r.height)
29943 || (y1 > r.y && y1 < r.y + r.height)
29944 || (r.y >= y0 && r.y < y1)
29945 || (r.y + r.height > y0 && r.y + r.height < y1))
29947 /* A header line may be overlapping, but there is no need
29948 to fix overlapping areas for them. KFS 2005-02-12 */
29949 if (row->overlapping_p && !row->mode_line_p)
29951 if (first_overlapping_row == NULL)
29952 first_overlapping_row = row;
29953 last_overlapping_row = row;
29956 row->clip = fr;
29957 if (expose_line (w, row, &r))
29958 mouse_face_overwritten_p = 1;
29959 row->clip = NULL;
29961 else if (row->overlapping_p)
29963 /* We must redraw a row overlapping the exposed area. */
29964 if (y0 < r.y
29965 ? y0 + row->phys_height > r.y
29966 : y0 + row->ascent - row->phys_ascent < r.y +r.height)
29968 if (first_overlapping_row == NULL)
29969 first_overlapping_row = row;
29970 last_overlapping_row = row;
29974 if (y1 >= yb)
29975 break;
29978 /* Display the mode line if there is one. */
29979 if (WINDOW_WANTS_MODELINE_P (w)
29980 && (row = MATRIX_MODE_LINE_ROW (w->current_matrix),
29981 row->enabled_p)
29982 && row->y < r.y + r.height)
29984 if (expose_line (w, row, &r))
29985 mouse_face_overwritten_p = 1;
29988 if (!w->pseudo_window_p)
29990 /* Fix the display of overlapping rows. */
29991 if (first_overlapping_row)
29992 expose_overlaps (w, first_overlapping_row, last_overlapping_row,
29993 fr);
29995 /* Draw border between windows. */
29996 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
29997 x_draw_right_divider (w);
29998 else
29999 x_draw_vertical_border (w);
30001 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w))
30002 x_draw_bottom_divider (w);
30004 /* Turn the cursor on again. */
30005 if (cursor_cleared_p
30006 || (phys_cursor_on_p && !w->phys_cursor_on_p))
30007 update_window_cursor (w, 1);
30011 return mouse_face_overwritten_p;
30016 /* Redraw (parts) of all windows in the window tree rooted at W that
30017 intersect R. R contains frame pixel coordinates. Value is
30018 non-zero if the exposure overwrites mouse-face. */
30020 static int
30021 expose_window_tree (struct window *w, XRectangle *r)
30023 struct frame *f = XFRAME (w->frame);
30024 int mouse_face_overwritten_p = 0;
30026 while (w && !FRAME_GARBAGED_P (f))
30028 if (WINDOWP (w->contents))
30029 mouse_face_overwritten_p
30030 |= expose_window_tree (XWINDOW (w->contents), r);
30031 else
30032 mouse_face_overwritten_p |= expose_window (w, r);
30034 w = NILP (w->next) ? NULL : XWINDOW (w->next);
30037 return mouse_face_overwritten_p;
30041 /* EXPORT:
30042 Redisplay an exposed area of frame F. X and Y are the upper-left
30043 corner of the exposed rectangle. W and H are width and height of
30044 the exposed area. All are pixel values. W or H zero means redraw
30045 the entire frame. */
30047 void
30048 expose_frame (struct frame *f, int x, int y, int w, int h)
30050 XRectangle r;
30051 int mouse_face_overwritten_p = 0;
30053 TRACE ((stderr, "expose_frame "));
30055 /* No need to redraw if frame will be redrawn soon. */
30056 if (FRAME_GARBAGED_P (f))
30058 TRACE ((stderr, " garbaged\n"));
30059 return;
30062 /* If basic faces haven't been realized yet, there is no point in
30063 trying to redraw anything. This can happen when we get an expose
30064 event while Emacs is starting, e.g. by moving another window. */
30065 if (FRAME_FACE_CACHE (f) == NULL
30066 || FRAME_FACE_CACHE (f)->used < BASIC_FACE_ID_SENTINEL)
30068 TRACE ((stderr, " no faces\n"));
30069 return;
30072 if (w == 0 || h == 0)
30074 r.x = r.y = 0;
30075 r.width = FRAME_COLUMN_WIDTH (f) * FRAME_COLS (f);
30076 r.height = FRAME_LINE_HEIGHT (f) * FRAME_LINES (f);
30078 else
30080 r.x = x;
30081 r.y = y;
30082 r.width = w;
30083 r.height = h;
30086 TRACE ((stderr, "(%d, %d, %d, %d)\n", r.x, r.y, r.width, r.height));
30087 mouse_face_overwritten_p = expose_window_tree (XWINDOW (f->root_window), &r);
30089 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30090 if (WINDOWP (f->tool_bar_window))
30091 mouse_face_overwritten_p
30092 |= expose_window (XWINDOW (f->tool_bar_window), &r);
30093 #endif
30095 #ifdef HAVE_X_WINDOWS
30096 #ifndef MSDOS
30097 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30098 if (WINDOWP (f->menu_bar_window))
30099 mouse_face_overwritten_p
30100 |= expose_window (XWINDOW (f->menu_bar_window), &r);
30101 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30102 #endif
30103 #endif
30105 /* Some window managers support a focus-follows-mouse style with
30106 delayed raising of frames. Imagine a partially obscured frame,
30107 and moving the mouse into partially obscured mouse-face on that
30108 frame. The visible part of the mouse-face will be highlighted,
30109 then the WM raises the obscured frame. With at least one WM, KDE
30110 2.1, Emacs is not getting any event for the raising of the frame
30111 (even tried with SubstructureRedirectMask), only Expose events.
30112 These expose events will draw text normally, i.e. not
30113 highlighted. Which means we must redo the highlight here.
30114 Subsume it under ``we love X''. --gerd 2001-08-15 */
30115 /* Included in Windows version because Windows most likely does not
30116 do the right thing if any third party tool offers
30117 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30118 if (mouse_face_overwritten_p && !FRAME_GARBAGED_P (f))
30120 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
30121 if (f == hlinfo->mouse_face_mouse_frame)
30123 int mouse_x = hlinfo->mouse_face_mouse_x;
30124 int mouse_y = hlinfo->mouse_face_mouse_y;
30125 clear_mouse_face (hlinfo);
30126 note_mouse_highlight (f, mouse_x, mouse_y);
30132 /* EXPORT:
30133 Determine the intersection of two rectangles R1 and R2. Return
30134 the intersection in *RESULT. Value is non-zero if RESULT is not
30135 empty. */
30138 x_intersect_rectangles (XRectangle *r1, XRectangle *r2, XRectangle *result)
30140 XRectangle *left, *right;
30141 XRectangle *upper, *lower;
30142 int intersection_p = 0;
30144 /* Rearrange so that R1 is the left-most rectangle. */
30145 if (r1->x < r2->x)
30146 left = r1, right = r2;
30147 else
30148 left = r2, right = r1;
30150 /* X0 of the intersection is right.x0, if this is inside R1,
30151 otherwise there is no intersection. */
30152 if (right->x <= left->x + left->width)
30154 result->x = right->x;
30156 /* The right end of the intersection is the minimum of
30157 the right ends of left and right. */
30158 result->width = (min (left->x + left->width, right->x + right->width)
30159 - result->x);
30161 /* Same game for Y. */
30162 if (r1->y < r2->y)
30163 upper = r1, lower = r2;
30164 else
30165 upper = r2, lower = r1;
30167 /* The upper end of the intersection is lower.y0, if this is inside
30168 of upper. Otherwise, there is no intersection. */
30169 if (lower->y <= upper->y + upper->height)
30171 result->y = lower->y;
30173 /* The lower end of the intersection is the minimum of the lower
30174 ends of upper and lower. */
30175 result->height = (min (lower->y + lower->height,
30176 upper->y + upper->height)
30177 - result->y);
30178 intersection_p = 1;
30182 return intersection_p;
30185 #endif /* HAVE_WINDOW_SYSTEM */
30188 /***********************************************************************
30189 Initialization
30190 ***********************************************************************/
30192 void
30193 syms_of_xdisp (void)
30195 Vwith_echo_area_save_vector = Qnil;
30196 staticpro (&Vwith_echo_area_save_vector);
30198 Vmessage_stack = Qnil;
30199 staticpro (&Vmessage_stack);
30201 DEFSYM (Qinhibit_redisplay, "inhibit-redisplay");
30202 DEFSYM (Qredisplay_internal, "redisplay_internal (C function)");
30204 message_dolog_marker1 = Fmake_marker ();
30205 staticpro (&message_dolog_marker1);
30206 message_dolog_marker2 = Fmake_marker ();
30207 staticpro (&message_dolog_marker2);
30208 message_dolog_marker3 = Fmake_marker ();
30209 staticpro (&message_dolog_marker3);
30211 #ifdef GLYPH_DEBUG
30212 defsubr (&Sdump_frame_glyph_matrix);
30213 defsubr (&Sdump_glyph_matrix);
30214 defsubr (&Sdump_glyph_row);
30215 defsubr (&Sdump_tool_bar_row);
30216 defsubr (&Strace_redisplay);
30217 defsubr (&Strace_to_stderr);
30218 #endif
30219 #ifdef HAVE_WINDOW_SYSTEM
30220 defsubr (&Stool_bar_height);
30221 defsubr (&Slookup_image_map);
30222 #endif
30223 defsubr (&Sline_pixel_height);
30224 defsubr (&Sformat_mode_line);
30225 defsubr (&Sinvisible_p);
30226 defsubr (&Scurrent_bidi_paragraph_direction);
30227 defsubr (&Swindow_text_pixel_size);
30228 defsubr (&Smove_point_visually);
30230 DEFSYM (Qmenu_bar_update_hook, "menu-bar-update-hook");
30231 DEFSYM (Qoverriding_terminal_local_map, "overriding-terminal-local-map");
30232 DEFSYM (Qoverriding_local_map, "overriding-local-map");
30233 DEFSYM (Qwindow_scroll_functions, "window-scroll-functions");
30234 DEFSYM (Qwindow_text_change_functions, "window-text-change-functions");
30235 DEFSYM (Qredisplay_end_trigger_functions, "redisplay-end-trigger-functions");
30236 DEFSYM (Qinhibit_point_motion_hooks, "inhibit-point-motion-hooks");
30237 DEFSYM (Qeval, "eval");
30238 DEFSYM (QCdata, ":data");
30239 DEFSYM (Qdisplay, "display");
30240 DEFSYM (Qspace_width, "space-width");
30241 DEFSYM (Qraise, "raise");
30242 DEFSYM (Qslice, "slice");
30243 DEFSYM (Qspace, "space");
30244 DEFSYM (Qmargin, "margin");
30245 DEFSYM (Qpointer, "pointer");
30246 DEFSYM (Qleft_margin, "left-margin");
30247 DEFSYM (Qright_margin, "right-margin");
30248 DEFSYM (Qcenter, "center");
30249 DEFSYM (Qline_height, "line-height");
30250 DEFSYM (QCalign_to, ":align-to");
30251 DEFSYM (QCrelative_width, ":relative-width");
30252 DEFSYM (QCrelative_height, ":relative-height");
30253 DEFSYM (QCeval, ":eval");
30254 DEFSYM (QCpropertize, ":propertize");
30255 DEFSYM (QCfile, ":file");
30256 DEFSYM (Qfontified, "fontified");
30257 DEFSYM (Qfontification_functions, "fontification-functions");
30258 DEFSYM (Qtrailing_whitespace, "trailing-whitespace");
30259 DEFSYM (Qescape_glyph, "escape-glyph");
30260 DEFSYM (Qnobreak_space, "nobreak-space");
30261 DEFSYM (Qimage, "image");
30262 DEFSYM (Qtext, "text");
30263 DEFSYM (Qboth, "both");
30264 DEFSYM (Qboth_horiz, "both-horiz");
30265 DEFSYM (Qtext_image_horiz, "text-image-horiz");
30266 DEFSYM (QCmap, ":map");
30267 DEFSYM (QCpointer, ":pointer");
30268 DEFSYM (Qrect, "rect");
30269 DEFSYM (Qcircle, "circle");
30270 DEFSYM (Qpoly, "poly");
30271 DEFSYM (Qmessage_truncate_lines, "message-truncate-lines");
30272 DEFSYM (Qgrow_only, "grow-only");
30273 DEFSYM (Qinhibit_menubar_update, "inhibit-menubar-update");
30274 DEFSYM (Qinhibit_eval_during_redisplay, "inhibit-eval-during-redisplay");
30275 DEFSYM (Qposition, "position");
30276 DEFSYM (Qbuffer_position, "buffer-position");
30277 DEFSYM (Qobject, "object");
30278 DEFSYM (Qbar, "bar");
30279 DEFSYM (Qhbar, "hbar");
30280 DEFSYM (Qbox, "box");
30281 DEFSYM (Qhollow, "hollow");
30282 DEFSYM (Qhand, "hand");
30283 DEFSYM (Qarrow, "arrow");
30284 DEFSYM (Qinhibit_free_realized_faces, "inhibit-free-realized-faces");
30286 list_of_error = list1 (list2 (intern_c_string ("error"),
30287 intern_c_string ("void-variable")));
30288 staticpro (&list_of_error);
30290 DEFSYM (Qlast_arrow_position, "last-arrow-position");
30291 DEFSYM (Qlast_arrow_string, "last-arrow-string");
30292 DEFSYM (Qoverlay_arrow_string, "overlay-arrow-string");
30293 DEFSYM (Qoverlay_arrow_bitmap, "overlay-arrow-bitmap");
30295 echo_buffer[0] = echo_buffer[1] = Qnil;
30296 staticpro (&echo_buffer[0]);
30297 staticpro (&echo_buffer[1]);
30299 echo_area_buffer[0] = echo_area_buffer[1] = Qnil;
30300 staticpro (&echo_area_buffer[0]);
30301 staticpro (&echo_area_buffer[1]);
30303 Vmessages_buffer_name = build_pure_c_string ("*Messages*");
30304 staticpro (&Vmessages_buffer_name);
30306 mode_line_proptrans_alist = Qnil;
30307 staticpro (&mode_line_proptrans_alist);
30308 mode_line_string_list = Qnil;
30309 staticpro (&mode_line_string_list);
30310 mode_line_string_face = Qnil;
30311 staticpro (&mode_line_string_face);
30312 mode_line_string_face_prop = Qnil;
30313 staticpro (&mode_line_string_face_prop);
30314 Vmode_line_unwind_vector = Qnil;
30315 staticpro (&Vmode_line_unwind_vector);
30317 DEFSYM (Qmode_line_default_help_echo, "mode-line-default-help-echo");
30319 help_echo_string = Qnil;
30320 staticpro (&help_echo_string);
30321 help_echo_object = Qnil;
30322 staticpro (&help_echo_object);
30323 help_echo_window = Qnil;
30324 staticpro (&help_echo_window);
30325 previous_help_echo_string = Qnil;
30326 staticpro (&previous_help_echo_string);
30327 help_echo_pos = -1;
30329 DEFSYM (Qright_to_left, "right-to-left");
30330 DEFSYM (Qleft_to_right, "left-to-right");
30332 #ifdef HAVE_WINDOW_SYSTEM
30333 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p,
30334 doc: /* Non-nil means draw block cursor as wide as the glyph under it.
30335 For example, if a block cursor is over a tab, it will be drawn as
30336 wide as that tab on the display. */);
30337 x_stretch_cursor_p = 0;
30338 #endif
30340 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace,
30341 doc: /* Non-nil means highlight trailing whitespace.
30342 The face used for trailing whitespace is `trailing-whitespace'. */);
30343 Vshow_trailing_whitespace = Qnil;
30345 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display,
30346 doc: /* Control highlighting of non-ASCII space and hyphen chars.
30347 If the value is t, Emacs highlights non-ASCII chars which have the
30348 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30349 or `escape-glyph' face respectively.
30351 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30352 U+2011 (non-breaking hyphen) are affected.
30354 Any other non-nil value means to display these characters as a escape
30355 glyph followed by an ordinary space or hyphen.
30357 A value of nil means no special handling of these characters. */);
30358 Vnobreak_char_display = Qt;
30360 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer,
30361 doc: /* The pointer shape to show in void text areas.
30362 A value of nil means to show the text pointer. Other options are `arrow',
30363 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30364 Vvoid_text_area_pointer = Qarrow;
30366 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay,
30367 doc: /* Non-nil means don't actually do any redisplay.
30368 This is used for internal purposes. */);
30369 Vinhibit_redisplay = Qnil;
30371 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string,
30372 doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30373 Vglobal_mode_string = Qnil;
30375 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position,
30376 doc: /* Marker for where to display an arrow on top of the buffer text.
30377 This must be the beginning of a line in order to work.
30378 See also `overlay-arrow-string'. */);
30379 Voverlay_arrow_position = Qnil;
30381 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string,
30382 doc: /* String to display as an arrow in non-window frames.
30383 See also `overlay-arrow-position'. */);
30384 Voverlay_arrow_string = build_pure_c_string ("=>");
30386 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list,
30387 doc: /* List of variables (symbols) which hold markers for overlay arrows.
30388 The symbols on this list are examined during redisplay to determine
30389 where to display overlay arrows. */);
30390 Voverlay_arrow_variable_list
30391 = list1 (intern_c_string ("overlay-arrow-position"));
30393 DEFVAR_INT ("scroll-step", emacs_scroll_step,
30394 doc: /* The number of lines to try scrolling a window by when point moves out.
30395 If that fails to bring point back on frame, point is centered instead.
30396 If this is zero, point is always centered after it moves off frame.
30397 If you want scrolling to always be a line at a time, you should set
30398 `scroll-conservatively' to a large value rather than set this to 1. */);
30400 DEFVAR_INT ("scroll-conservatively", scroll_conservatively,
30401 doc: /* Scroll up to this many lines, to bring point back on screen.
30402 If point moves off-screen, redisplay will scroll by up to
30403 `scroll-conservatively' lines in order to bring point just barely
30404 onto the screen again. If that cannot be done, then redisplay
30405 recenters point as usual.
30407 If the value is greater than 100, redisplay will never recenter point,
30408 but will always scroll just enough text to bring point into view, even
30409 if you move far away.
30411 A value of zero means always recenter point if it moves off screen. */);
30412 scroll_conservatively = 0;
30414 DEFVAR_INT ("scroll-margin", scroll_margin,
30415 doc: /* Number of lines of margin at the top and bottom of a window.
30416 Recenter the window whenever point gets within this many lines
30417 of the top or bottom of the window. */);
30418 scroll_margin = 0;
30420 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch,
30421 doc: /* Pixels per inch value for non-window system displays.
30422 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30423 Vdisplay_pixels_per_inch = make_float (72.0);
30425 #ifdef GLYPH_DEBUG
30426 DEFVAR_INT ("debug-end-pos", debug_end_pos, doc: /* Don't ask. */);
30427 #endif
30429 DEFVAR_LISP ("truncate-partial-width-windows",
30430 Vtruncate_partial_width_windows,
30431 doc: /* Non-nil means truncate lines in windows narrower than the frame.
30432 For an integer value, truncate lines in each window narrower than the
30433 full frame width, provided the window width is less than that integer;
30434 otherwise, respect the value of `truncate-lines'.
30436 For any other non-nil value, truncate lines in all windows that do
30437 not span the full frame width.
30439 A value of nil means to respect the value of `truncate-lines'.
30441 If `word-wrap' is enabled, you might want to reduce this. */);
30442 Vtruncate_partial_width_windows = make_number (50);
30444 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit,
30445 doc: /* Maximum buffer size for which line number should be displayed.
30446 If the buffer is bigger than this, the line number does not appear
30447 in the mode line. A value of nil means no limit. */);
30448 Vline_number_display_limit = Qnil;
30450 DEFVAR_INT ("line-number-display-limit-width",
30451 line_number_display_limit_width,
30452 doc: /* Maximum line width (in characters) for line number display.
30453 If the average length of the lines near point is bigger than this, then the
30454 line number may be omitted from the mode line. */);
30455 line_number_display_limit_width = 200;
30457 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows,
30458 doc: /* Non-nil means highlight region even in nonselected windows. */);
30459 highlight_nonselected_windows = 0;
30461 DEFVAR_BOOL ("multiple-frames", multiple_frames,
30462 doc: /* Non-nil if more than one frame is visible on this display.
30463 Minibuffer-only frames don't count, but iconified frames do.
30464 This variable is not guaranteed to be accurate except while processing
30465 `frame-title-format' and `icon-title-format'. */);
30467 DEFVAR_LISP ("frame-title-format", Vframe_title_format,
30468 doc: /* Template for displaying the title bar of visible frames.
30469 \(Assuming the window manager supports this feature.)
30471 This variable has the same structure as `mode-line-format', except that
30472 the %c and %l constructs are ignored. It is used only on frames for
30473 which no explicit name has been set \(see `modify-frame-parameters'). */);
30475 DEFVAR_LISP ("icon-title-format", Vicon_title_format,
30476 doc: /* Template for displaying the title bar of an iconified frame.
30477 \(Assuming the window manager supports this feature.)
30478 This variable has the same structure as `mode-line-format' (which see),
30479 and is used only on frames for which no explicit name has been set
30480 \(see `modify-frame-parameters'). */);
30481 Vicon_title_format
30482 = Vframe_title_format
30483 = listn (CONSTYPE_PURE, 3,
30484 intern_c_string ("multiple-frames"),
30485 build_pure_c_string ("%b"),
30486 listn (CONSTYPE_PURE, 4,
30487 empty_unibyte_string,
30488 intern_c_string ("invocation-name"),
30489 build_pure_c_string ("@"),
30490 intern_c_string ("system-name")));
30492 DEFVAR_LISP ("message-log-max", Vmessage_log_max,
30493 doc: /* Maximum number of lines to keep in the message log buffer.
30494 If nil, disable message logging. If t, log messages but don't truncate
30495 the buffer when it becomes large. */);
30496 Vmessage_log_max = make_number (1000);
30498 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions,
30499 doc: /* Functions called before redisplay, if window sizes have changed.
30500 The value should be a list of functions that take one argument.
30501 Just before redisplay, for each frame, if any of its windows have changed
30502 size since the last redisplay, or have been split or deleted,
30503 all the functions in the list are called, with the frame as argument. */);
30504 Vwindow_size_change_functions = Qnil;
30506 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions,
30507 doc: /* List of functions to call before redisplaying a window with scrolling.
30508 Each function is called with two arguments, the window and its new
30509 display-start position. Note that these functions are also called by
30510 `set-window-buffer'. Also note that the value of `window-end' is not
30511 valid when these functions are called.
30513 Warning: Do not use this feature to alter the way the window
30514 is scrolled. It is not designed for that, and such use probably won't
30515 work. */);
30516 Vwindow_scroll_functions = Qnil;
30518 DEFVAR_LISP ("window-text-change-functions",
30519 Vwindow_text_change_functions,
30520 doc: /* Functions to call in redisplay when text in the window might change. */);
30521 Vwindow_text_change_functions = Qnil;
30523 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions,
30524 doc: /* Functions called when redisplay of a window reaches the end trigger.
30525 Each function is called with two arguments, the window and the end trigger value.
30526 See `set-window-redisplay-end-trigger'. */);
30527 Vredisplay_end_trigger_functions = Qnil;
30529 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window,
30530 doc: /* Non-nil means autoselect window with mouse pointer.
30531 If nil, do not autoselect windows.
30532 A positive number means delay autoselection by that many seconds: a
30533 window is autoselected only after the mouse has remained in that
30534 window for the duration of the delay.
30535 A negative number has a similar effect, but causes windows to be
30536 autoselected only after the mouse has stopped moving. \(Because of
30537 the way Emacs compares mouse events, you will occasionally wait twice
30538 that time before the window gets selected.\)
30539 Any other value means to autoselect window instantaneously when the
30540 mouse pointer enters it.
30542 Autoselection selects the minibuffer only if it is active, and never
30543 unselects the minibuffer if it is active.
30545 When customizing this variable make sure that the actual value of
30546 `focus-follows-mouse' matches the behavior of your window manager. */);
30547 Vmouse_autoselect_window = Qnil;
30549 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars,
30550 doc: /* Non-nil means automatically resize tool-bars.
30551 This dynamically changes the tool-bar's height to the minimum height
30552 that is needed to make all tool-bar items visible.
30553 If value is `grow-only', the tool-bar's height is only increased
30554 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30555 Vauto_resize_tool_bars = Qt;
30557 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p,
30558 doc: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30559 auto_raise_tool_bar_buttons_p = 1;
30561 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p,
30562 doc: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30563 make_cursor_line_fully_visible_p = 1;
30565 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border,
30566 doc: /* Border below tool-bar in pixels.
30567 If an integer, use it as the height of the border.
30568 If it is one of `internal-border-width' or `border-width', use the
30569 value of the corresponding frame parameter.
30570 Otherwise, no border is added below the tool-bar. */);
30571 Vtool_bar_border = Qinternal_border_width;
30573 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin,
30574 doc: /* Margin around tool-bar buttons in pixels.
30575 If an integer, use that for both horizontal and vertical margins.
30576 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30577 HORZ specifying the horizontal margin, and VERT specifying the
30578 vertical margin. */);
30579 Vtool_bar_button_margin = make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN);
30581 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief,
30582 doc: /* Relief thickness of tool-bar buttons. */);
30583 tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
30585 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style,
30586 doc: /* Tool bar style to use.
30587 It can be one of
30588 image - show images only
30589 text - show text only
30590 both - show both, text below image
30591 both-horiz - show text to the right of the image
30592 text-image-horiz - show text to the left of the image
30593 any other - use system default or image if no system default.
30595 This variable only affects the GTK+ toolkit version of Emacs. */);
30596 Vtool_bar_style = Qnil;
30598 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size,
30599 doc: /* Maximum number of characters a label can have to be shown.
30600 The tool bar style must also show labels for this to have any effect, see
30601 `tool-bar-style'. */);
30602 tool_bar_max_label_size = DEFAULT_TOOL_BAR_LABEL_SIZE;
30604 DEFVAR_LISP ("fontification-functions", Vfontification_functions,
30605 doc: /* List of functions to call to fontify regions of text.
30606 Each function is called with one argument POS. Functions must
30607 fontify a region starting at POS in the current buffer, and give
30608 fontified regions the property `fontified'. */);
30609 Vfontification_functions = Qnil;
30610 Fmake_variable_buffer_local (Qfontification_functions);
30612 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30613 unibyte_display_via_language_environment,
30614 doc: /* Non-nil means display unibyte text according to language environment.
30615 Specifically, this means that raw bytes in the range 160-255 decimal
30616 are displayed by converting them to the equivalent multibyte characters
30617 according to the current language environment. As a result, they are
30618 displayed according to the current fontset.
30620 Note that this variable affects only how these bytes are displayed,
30621 but does not change the fact they are interpreted as raw bytes. */);
30622 unibyte_display_via_language_environment = 0;
30624 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height,
30625 doc: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30626 If a float, it specifies a fraction of the mini-window frame's height.
30627 If an integer, it specifies a number of lines. */);
30628 Vmax_mini_window_height = make_float (0.25);
30630 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows,
30631 doc: /* How to resize mini-windows (the minibuffer and the echo area).
30632 A value of nil means don't automatically resize mini-windows.
30633 A value of t means resize them to fit the text displayed in them.
30634 A value of `grow-only', the default, means let mini-windows grow only;
30635 they return to their normal size when the minibuffer is closed, or the
30636 echo area becomes empty. */);
30637 Vresize_mini_windows = Qgrow_only;
30639 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist,
30640 doc: /* Alist specifying how to blink the cursor off.
30641 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30642 `cursor-type' frame-parameter or variable equals ON-STATE,
30643 comparing using `equal', Emacs uses OFF-STATE to specify
30644 how to blink it off. ON-STATE and OFF-STATE are values for
30645 the `cursor-type' frame parameter.
30647 If a frame's ON-STATE has no entry in this list,
30648 the frame's other specifications determine how to blink the cursor off. */);
30649 Vblink_cursor_alist = Qnil;
30651 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p,
30652 doc: /* Allow or disallow automatic horizontal scrolling of windows.
30653 If non-nil, windows are automatically scrolled horizontally to make
30654 point visible. */);
30655 automatic_hscrolling_p = 1;
30656 DEFSYM (Qauto_hscroll_mode, "auto-hscroll-mode");
30658 DEFVAR_INT ("hscroll-margin", hscroll_margin,
30659 doc: /* How many columns away from the window edge point is allowed to get
30660 before automatic hscrolling will horizontally scroll the window. */);
30661 hscroll_margin = 5;
30663 DEFVAR_LISP ("hscroll-step", Vhscroll_step,
30664 doc: /* How many columns to scroll the window when point gets too close to the edge.
30665 When point is less than `hscroll-margin' columns from the window
30666 edge, automatic hscrolling will scroll the window by the amount of columns
30667 determined by this variable. If its value is a positive integer, scroll that
30668 many columns. If it's a positive floating-point number, it specifies the
30669 fraction of the window's width to scroll. If it's nil or zero, point will be
30670 centered horizontally after the scroll. Any other value, including negative
30671 numbers, are treated as if the value were zero.
30673 Automatic hscrolling always moves point outside the scroll margin, so if
30674 point was more than scroll step columns inside the margin, the window will
30675 scroll more than the value given by the scroll step.
30677 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30678 and `scroll-right' overrides this variable's effect. */);
30679 Vhscroll_step = make_number (0);
30681 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines,
30682 doc: /* If non-nil, messages are truncated instead of resizing the echo area.
30683 Bind this around calls to `message' to let it take effect. */);
30684 message_truncate_lines = 0;
30686 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook,
30687 doc: /* Normal hook run to update the menu bar definitions.
30688 Redisplay runs this hook before it redisplays the menu bar.
30689 This is used to update menus such as Buffers, whose contents depend on
30690 various data. */);
30691 Vmenu_bar_update_hook = Qnil;
30693 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame,
30694 doc: /* Frame for which we are updating a menu.
30695 The enable predicate for a menu binding should check this variable. */);
30696 Vmenu_updating_frame = Qnil;
30698 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update,
30699 doc: /* Non-nil means don't update menu bars. Internal use only. */);
30700 inhibit_menubar_update = 0;
30702 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix,
30703 doc: /* Prefix prepended to all continuation lines at display time.
30704 The value may be a string, an image, or a stretch-glyph; it is
30705 interpreted in the same way as the value of a `display' text property.
30707 This variable is overridden by any `wrap-prefix' text or overlay
30708 property.
30710 To add a prefix to non-continuation lines, use `line-prefix'. */);
30711 Vwrap_prefix = Qnil;
30712 DEFSYM (Qwrap_prefix, "wrap-prefix");
30713 Fmake_variable_buffer_local (Qwrap_prefix);
30715 DEFVAR_LISP ("line-prefix", Vline_prefix,
30716 doc: /* Prefix prepended to all non-continuation lines at display time.
30717 The value may be a string, an image, or a stretch-glyph; it is
30718 interpreted in the same way as the value of a `display' text property.
30720 This variable is overridden by any `line-prefix' text or overlay
30721 property.
30723 To add a prefix to continuation lines, use `wrap-prefix'. */);
30724 Vline_prefix = Qnil;
30725 DEFSYM (Qline_prefix, "line-prefix");
30726 Fmake_variable_buffer_local (Qline_prefix);
30728 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay,
30729 doc: /* Non-nil means don't eval Lisp during redisplay. */);
30730 inhibit_eval_during_redisplay = 0;
30732 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces,
30733 doc: /* Non-nil means don't free realized faces. Internal use only. */);
30734 inhibit_free_realized_faces = 0;
30736 #ifdef GLYPH_DEBUG
30737 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id,
30738 doc: /* Inhibit try_window_id display optimization. */);
30739 inhibit_try_window_id = 0;
30741 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing,
30742 doc: /* Inhibit try_window_reusing display optimization. */);
30743 inhibit_try_window_reusing = 0;
30745 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement,
30746 doc: /* Inhibit try_cursor_movement display optimization. */);
30747 inhibit_try_cursor_movement = 0;
30748 #endif /* GLYPH_DEBUG */
30750 DEFVAR_INT ("overline-margin", overline_margin,
30751 doc: /* Space between overline and text, in pixels.
30752 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30753 margin to the character height. */);
30754 overline_margin = 2;
30756 DEFVAR_INT ("underline-minimum-offset",
30757 underline_minimum_offset,
30758 doc: /* Minimum distance between baseline and underline.
30759 This can improve legibility of underlined text at small font sizes,
30760 particularly when using variable `x-use-underline-position-properties'
30761 with fonts that specify an UNDERLINE_POSITION relatively close to the
30762 baseline. The default value is 1. */);
30763 underline_minimum_offset = 1;
30765 DEFVAR_BOOL ("display-hourglass", display_hourglass_p,
30766 doc: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30767 This feature only works when on a window system that can change
30768 cursor shapes. */);
30769 display_hourglass_p = 1;
30771 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay,
30772 doc: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30773 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
30775 #ifdef HAVE_WINDOW_SYSTEM
30776 hourglass_atimer = NULL;
30777 hourglass_shown_p = 0;
30778 #endif /* HAVE_WINDOW_SYSTEM */
30780 DEFSYM (Qglyphless_char, "glyphless-char");
30781 DEFSYM (Qhex_code, "hex-code");
30782 DEFSYM (Qempty_box, "empty-box");
30783 DEFSYM (Qthin_space, "thin-space");
30784 DEFSYM (Qzero_width, "zero-width");
30786 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function,
30787 doc: /* Function run just before redisplay.
30788 It is called with one argument, which is the set of windows that are to
30789 be redisplayed. This set can be nil (meaning, only the selected window),
30790 or t (meaning all windows). */);
30791 Vpre_redisplay_function = intern ("ignore");
30793 DEFSYM (Qglyphless_char_display, "glyphless-char-display");
30794 Fput (Qglyphless_char_display, Qchar_table_extra_slots, make_number (1));
30796 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display,
30797 doc: /* Char-table defining glyphless characters.
30798 Each element, if non-nil, should be one of the following:
30799 an ASCII acronym string: display this string in a box
30800 `hex-code': display the hexadecimal code of a character in a box
30801 `empty-box': display as an empty box
30802 `thin-space': display as 1-pixel width space
30803 `zero-width': don't display
30804 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30805 display method for graphical terminals and text terminals respectively.
30806 GRAPHICAL and TEXT should each have one of the values listed above.
30808 The char-table has one extra slot to control the display of a character for
30809 which no font is found. This slot only takes effect on graphical terminals.
30810 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30811 `thin-space'. The default is `empty-box'.
30813 If a character has a non-nil entry in an active display table, the
30814 display table takes effect; in this case, Emacs does not consult
30815 `glyphless-char-display' at all. */);
30816 Vglyphless_char_display = Fmake_char_table (Qglyphless_char_display, Qnil);
30817 Fset_char_table_extra_slot (Vglyphless_char_display, make_number (0),
30818 Qempty_box);
30820 DEFVAR_LISP ("debug-on-message", Vdebug_on_message,
30821 doc: /* If non-nil, debug if a message matching this regexp is displayed. */);
30822 Vdebug_on_message = Qnil;
30824 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause,
30825 doc: /* */);
30826 Vredisplay__all_windows_cause
30827 = Fmake_vector (make_number (100), make_number (0));
30829 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause,
30830 doc: /* */);
30831 Vredisplay__mode_lines_cause
30832 = Fmake_vector (make_number (100), make_number (0));
30836 /* Initialize this module when Emacs starts. */
30838 void
30839 init_xdisp (void)
30841 CHARPOS (this_line_start_pos) = 0;
30843 if (!noninteractive)
30845 struct window *m = XWINDOW (minibuf_window);
30846 Lisp_Object frame = m->frame;
30847 struct frame *f = XFRAME (frame);
30848 Lisp_Object root = FRAME_ROOT_WINDOW (f);
30849 struct window *r = XWINDOW (root);
30850 int i;
30852 echo_area_window = minibuf_window;
30854 r->top_line = FRAME_TOP_MARGIN (f);
30855 r->pixel_top = r->top_line * FRAME_LINE_HEIGHT (f);
30856 r->total_cols = FRAME_COLS (f);
30857 r->pixel_width = r->total_cols * FRAME_COLUMN_WIDTH (f);
30858 r->total_lines = FRAME_LINES (f) - 1 - FRAME_TOP_MARGIN (f);
30859 r->pixel_height = r->total_lines * FRAME_LINE_HEIGHT (f);
30861 m->top_line = FRAME_LINES (f) - 1;
30862 m->pixel_top = m->top_line * FRAME_LINE_HEIGHT (f);
30863 m->total_cols = FRAME_COLS (f);
30864 m->pixel_width = m->total_cols * FRAME_COLUMN_WIDTH (f);
30865 m->total_lines = 1;
30866 m->pixel_height = m->total_lines * FRAME_LINE_HEIGHT (f);
30868 scratch_glyph_row.glyphs[TEXT_AREA] = scratch_glyphs;
30869 scratch_glyph_row.glyphs[TEXT_AREA + 1]
30870 = scratch_glyphs + MAX_SCRATCH_GLYPHS;
30872 /* The default ellipsis glyphs `...'. */
30873 for (i = 0; i < 3; ++i)
30874 default_invis_vector[i] = make_number ('.');
30878 /* Allocate the buffer for frame titles.
30879 Also used for `format-mode-line'. */
30880 int size = 100;
30881 mode_line_noprop_buf = xmalloc (size);
30882 mode_line_noprop_buf_end = mode_line_noprop_buf + size;
30883 mode_line_noprop_ptr = mode_line_noprop_buf;
30884 mode_line_target = MODE_LINE_DISPLAY;
30887 help_echo_showing_p = 0;
30890 #ifdef HAVE_WINDOW_SYSTEM
30892 /* Platform-independent portion of hourglass implementation. */
30894 /* Cancel a currently active hourglass timer, and start a new one. */
30895 void
30896 start_hourglass (void)
30898 struct timespec delay;
30900 cancel_hourglass ();
30902 if (INTEGERP (Vhourglass_delay)
30903 && XINT (Vhourglass_delay) > 0)
30904 delay = make_timespec (min (XINT (Vhourglass_delay),
30905 TYPE_MAXIMUM (time_t)),
30907 else if (FLOATP (Vhourglass_delay)
30908 && XFLOAT_DATA (Vhourglass_delay) > 0)
30909 delay = dtotimespec (XFLOAT_DATA (Vhourglass_delay));
30910 else
30911 delay = make_timespec (DEFAULT_HOURGLASS_DELAY, 0);
30913 #ifdef HAVE_NTGUI
30915 extern void w32_note_current_window (void);
30916 w32_note_current_window ();
30918 #endif /* HAVE_NTGUI */
30920 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
30921 show_hourglass, NULL);
30925 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30926 shown. */
30927 void
30928 cancel_hourglass (void)
30930 if (hourglass_atimer)
30932 cancel_atimer (hourglass_atimer);
30933 hourglass_atimer = NULL;
30936 if (hourglass_shown_p)
30937 hide_hourglass ();
30940 #endif /* HAVE_WINDOW_SYSTEM */