1 /* Display generation from window structure and buffer text.
3 Copyright (C) 1985-1988, 1993-1995, 1997-2014 Free Software Foundation,
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>.
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
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) +----------------+ |
50 +----------------------------------+ |
51 Don't use this path when called |
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
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
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
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
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.
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)
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
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).
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
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. */
295 #include "keyboard.h"
298 #include "termchar.h"
299 #include "dispextern.h"
300 #include "character.h"
304 #include "commands.h"
308 #include "termhooks.h"
309 #include "termopts.h"
310 #include "intervals.h"
313 #include "region-cache.h"
316 #include "blockinput.h"
317 #ifdef HAVE_WINDOW_SYSTEM
319 #endif /* HAVE_WINDOW_SYSTEM */
321 #ifndef FRAME_X_OUTPUT
322 #define FRAME_X_OUTPUT(f) ((f)->output_data.x)
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
;
341 Lisp_Object Qbar
, Qhbar
, Qbox
, Qhollow
;
343 /* Pointer shapes. */
344 static Lisp_Object Qarrow
, Qhand
;
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
;
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')) \
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. */
423 /* The image map types. */
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
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
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
536 int windows_or_buffers_changed
;
538 /* Nonzero after display_mode_line if %l was used and it displayed a
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
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) \
613 bidi_unshelve_cache (CACHE, 1); \
615 CACHE = bidi_shelve_cache (); \
618 #define RESTORE_IT(pITORIG,pITCOPY,CACHE) \
620 if (pITORIG != pITCOPY) \
621 *(pITORIG) = *(pITCOPY); \
622 bidi_unshelve_cache (CACHE, 0); \
626 /* Functions to mark elements as needing redisplay. */
627 enum { REDISPLAY_SOME
= 2}; /* Arbitrary choice. */
630 redisplay_other_windows (void)
632 if (!windows_or_buffers_changed
)
633 windows_or_buffers_changed
= REDISPLAY_SOME
;
637 wset_redisplay (struct window
*w
)
639 /* Beware: selected_window can be nil during early stages. */
640 if (!EQ (w
->header
.self
, selected_window
))
641 redisplay_other_windows ();
646 fset_redisplay (struct frame
*f
)
648 redisplay_other_windows ();
653 bset_redisplay (struct buffer
*b
)
655 int count
= buffer_window_count (b
);
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
664 b
->text
->redisplay
= true;
669 bset_update_mode_line (struct buffer
*b
)
671 if (!update_mode_lines
)
672 update_mode_lines
= REDISPLAY_SOME
;
673 b
->text
->redisplay
= true;
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. */
689 #define TRACE_MOVE(x) if (trace_move) fprintf x; else (void) 0
691 #define TRACE_MOVE(x) (void) 0
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). */
705 HANDLED_RECOMPUTE_PROPS
,
706 HANDLED_OVERLAY_STRING_CONSUMED
,
710 /* A description of text properties that redisplay is interested
715 /* The name of the property. */
718 /* A unique index for the property. */
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
},
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. */
756 /* Not used. Undefined value. */
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. */
765 /* Move within a line ended at the end of a line that must be
769 /* Move within a line ended at the end of a line that would
770 be displayed truncated. */
773 /* Move within a line ended at a line end. */
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
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 };
795 /* True while redisplay_internal is in progress. */
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
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
,
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
,
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
*,
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,
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,
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
*,
960 static int init_to_row_end (struct it
*, struct window
*,
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
,
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
*,
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
*,
995 static void append_stretch_glyph (struct it
*, Lisp_Object
,
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
);
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
)
1084 if (ml_row
&& ml_row
->mode_line_p
)
1085 height
-= ml_row
->height
;
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
)
1096 if (hl_row
&& hl_row
->mode_line_p
)
1097 height
-= hl_row
->height
;
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
)
1116 if (w
->pseudo_window_p
)
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
),
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
);
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
));
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. */
1190 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1191 int *box_y
, int *box_width
, int *box_height
)
1194 *box_width
= window_box_width (w
, area
);
1196 *box_height
= window_box_height (w
);
1198 *box_x
= window_box_left (w
, area
);
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
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 /***********************************************************************
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)
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
1254 struct glyph_row
*row
= it
->glyph_row
;
1256 /* Use the default character height. */
1257 it
->glyph_row
= NULL
;
1258 it
->what
= IT_CHARACTER
;
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. */)
1279 struct window
*w
= XWINDOW (selected_window
);
1280 struct buffer
*old_buffer
= NULL
;
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;
1292 result
= make_number (line_bottom_y (&it
));
1294 set_buffer_internal_1 (old_buffer
);
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
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
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
);
1325 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
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;
1339 height
+= f
->extra_line_spacing
;
1345 /* Subroutine of pos_visible_p below. Extracts a display string, if
1346 any, from the display spec given as its argument. */
1348 string_from_display_spec (Lisp_Object spec
)
1352 while (CONSP (spec
))
1354 if (STRINGP (XCAR (spec
)))
1359 else if (VECTORP (spec
))
1363 for (i
= 0; i
< ASIZE (spec
); i
++)
1365 if (STRINGP (AREF (spec
, i
)))
1366 return AREF (spec
, i
);
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. */
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
)
1402 void *itdata
= bidi_shelve_cache ();
1403 struct text_pos top
;
1405 struct buffer
*old_buffer
= NULL
;
1407 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
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
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
))
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
);
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
1453 int top_x
= it
.current_x
;
1454 int top_y
= it
.current_y
;
1455 /* Calling line_bottom_y may change it.method, it.position, etc. */
1456 enum it_method it_method
= it
.method
;
1457 int bottom_y
= (last_height
= 0, line_bottom_y (&it
));
1458 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1460 if (top_y
< window_top_y
)
1461 visible_p
= bottom_y
> window_top_y
;
1462 else if (top_y
< it
.last_visible_y
)
1464 if (bottom_y
>= it
.last_visible_y
1465 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1466 && IT_CHARPOS (it
) < charpos
)
1468 /* When the last line of the window is scanned backwards
1469 under bidi iteration, we could be duped into thinking
1470 that we have passed CHARPOS, when in fact move_it_to
1471 simply stopped short of CHARPOS because it reached
1472 last_visible_y. To see if that's what happened, we call
1473 move_it_to again with a slightly larger vertical limit,
1474 and see if it actually moved vertically; if it did, we
1475 didn't really reach CHARPOS, which is beyond window end. */
1476 struct it save_it
= it
;
1477 /* Why 10? because we don't know how many canonical lines
1478 will the height of the next line(s) be. So we guess. */
1479 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1481 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1482 MOVE_TO_POS
| MOVE_TO_Y
);
1483 if (it
.current_y
> top_y
)
1490 if (it_method
== GET_FROM_DISPLAY_VECTOR
)
1492 /* We stopped on the last glyph of a display vector.
1493 Try and recompute. Hack alert! */
1494 if (charpos
< 2 || top
.charpos
>= charpos
)
1495 top_x
= it
.glyph_row
->x
;
1498 struct it it2
, it2_prev
;
1499 /* The idea is to get to the previous buffer
1500 position, consume the character there, and use
1501 the pixel coordinates we get after that. But if
1502 the previous buffer position is also displayed
1503 from a display vector, we need to consume all of
1504 the glyphs from that display vector. */
1505 start_display (&it2
, w
, top
);
1506 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1507 /* If we didn't get to CHARPOS - 1, there's some
1508 replacing display property at that position, and
1509 we stopped after it. That is exactly the place
1510 whose coordinates we want. */
1511 if (IT_CHARPOS (it2
) != charpos
- 1)
1515 /* Iterate until we get out of the display
1516 vector that displays the character at
1519 get_next_display_element (&it2
);
1520 PRODUCE_GLYPHS (&it2
);
1522 set_iterator_to_next (&it2
, 1);
1523 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1524 && IT_CHARPOS (it2
) < charpos
);
1526 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1527 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1528 top_x
= it
.glyph_row
->x
;
1531 top_x
= it2_prev
.current_x
;
1532 top_y
= it2_prev
.current_y
;
1536 else if (IT_CHARPOS (it
) != charpos
)
1538 Lisp_Object cpos
= make_number (charpos
);
1539 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1540 Lisp_Object string
= string_from_display_spec (spec
);
1541 struct text_pos tpos
;
1542 int replacing_spec_p
;
1543 bool newline_in_string
1545 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1547 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1550 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1551 charpos
, FRAME_WINDOW_P (it
.f
)));
1552 /* The tricky code below is needed because there's a
1553 discrepancy between move_it_to and how we set cursor
1554 when PT is at the beginning of a portion of text
1555 covered by a display property or an overlay with a
1556 display property, or the display line ends in a
1557 newline from a display string. move_it_to will stop
1558 _after_ such display strings, whereas
1559 set_cursor_from_row conspires with cursor_row_p to
1560 place the cursor on the first glyph produced from the
1563 /* We have overshoot PT because it is covered by a
1564 display property that replaces the text it covers.
1565 If the string includes embedded newlines, we are also
1566 in the wrong display line. Backtrack to the correct
1567 line, where the display property begins. */
1568 if (replacing_spec_p
)
1570 Lisp_Object startpos
, endpos
;
1571 EMACS_INT start
, end
;
1575 /* Find the first and the last buffer positions
1576 covered by the display string. */
1578 Fnext_single_char_property_change (cpos
, Qdisplay
,
1581 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1583 start
= XFASTINT (startpos
);
1584 end
= XFASTINT (endpos
);
1585 /* Move to the last buffer position before the
1586 display property. */
1587 start_display (&it3
, w
, top
);
1588 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1589 /* Move forward one more line if the position before
1590 the display string is a newline or if it is the
1591 rightmost character on a line that is
1592 continued or word-wrapped. */
1593 if (it3
.method
== GET_FROM_BUFFER
1595 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1596 move_it_by_lines (&it3
, 1);
1597 else if (move_it_in_display_line_to (&it3
, -1,
1601 == MOVE_LINE_CONTINUED
)
1603 move_it_by_lines (&it3
, 1);
1604 /* When we are under word-wrap, the #$@%!
1605 move_it_by_lines moves 2 lines, so we need to
1607 if (it3
.line_wrap
== WORD_WRAP
)
1608 move_it_by_lines (&it3
, -1);
1611 /* Record the vertical coordinate of the display
1612 line where we wound up. */
1613 top_y
= it3
.current_y
;
1616 /* When characters are reordered for display,
1617 the character displayed to the left of the
1618 display string could be _after_ the display
1619 property in the logical order. Use the
1620 smallest vertical position of these two. */
1621 start_display (&it3
, w
, top
);
1622 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1623 if (it3
.current_y
< top_y
)
1624 top_y
= it3
.current_y
;
1626 /* Move from the top of the window to the beginning
1627 of the display line where the display string
1629 start_display (&it3
, w
, top
);
1630 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1631 /* If it3_moved stays zero after the 'while' loop
1632 below, that means we already were at a newline
1633 before the loop (e.g., the display string begins
1634 with a newline), so we don't need to (and cannot)
1635 inspect the glyphs of it3.glyph_row, because
1636 PRODUCE_GLYPHS will not produce anything for a
1637 newline, and thus it3.glyph_row stays at its
1638 stale content it got at top of the window. */
1640 /* Finally, advance the iterator until we hit the
1641 first display element whose character position is
1642 CHARPOS, or until the first newline from the
1643 display string, which signals the end of the
1645 while (get_next_display_element (&it3
))
1647 PRODUCE_GLYPHS (&it3
);
1648 if (IT_CHARPOS (it3
) == charpos
1649 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1652 set_iterator_to_next (&it3
, 0);
1654 top_x
= it3
.current_x
- it3
.pixel_width
;
1655 /* Normally, we would exit the above loop because we
1656 found the display element whose character
1657 position is CHARPOS. For the contingency that we
1658 didn't, and stopped at the first newline from the
1659 display string, move back over the glyphs
1660 produced from the string, until we find the
1661 rightmost glyph not from the string. */
1663 && newline_in_string
1664 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1666 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1667 + it3
.glyph_row
->used
[TEXT_AREA
];
1669 while (EQ ((g
- 1)->object
, string
))
1672 top_x
-= g
->pixel_width
;
1674 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1675 + it3
.glyph_row
->used
[TEXT_AREA
]);
1681 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1682 *rtop
= max (0, window_top_y
- top_y
);
1683 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1684 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1685 - max (top_y
, window_top_y
)));
1691 /* We were asked to provide info about WINDOW_END. */
1693 void *it2data
= NULL
;
1695 SAVE_IT (it2
, it
, it2data
);
1696 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1697 move_it_by_lines (&it
, 1);
1698 if (charpos
< IT_CHARPOS (it
)
1699 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1702 RESTORE_IT (&it2
, &it2
, it2data
);
1703 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1705 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1706 *rtop
= max (0, -it2
.current_y
);
1707 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1708 - it
.last_visible_y
));
1709 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1711 - max (it2
.current_y
,
1712 WINDOW_HEADER_LINE_HEIGHT (w
))));
1716 bidi_unshelve_cache (it2data
, 1);
1718 bidi_unshelve_cache (itdata
, 0);
1721 set_buffer_internal_1 (old_buffer
);
1723 if (visible_p
&& w
->hscroll
> 0)
1725 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1726 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1729 /* Debugging code. */
1731 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1732 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1734 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1741 /* Return the next character from STR. Return in *LEN the length of
1742 the character. This is like STRING_CHAR_AND_LENGTH but never
1743 returns an invalid character. If we find one, we return a `?', but
1744 with the length of the invalid character. */
1747 string_char_and_length (const unsigned char *str
, int *len
)
1751 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1752 if (!CHAR_VALID_P (c
))
1753 /* We may not change the length here because other places in Emacs
1754 don't use this function, i.e. they silently accept invalid
1763 /* Given a position POS containing a valid character and byte position
1764 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1766 static struct text_pos
1767 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1769 eassert (STRINGP (string
) && nchars
>= 0);
1771 if (STRING_MULTIBYTE (string
))
1773 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1778 string_char_and_length (p
, &len
);
1781 BYTEPOS (pos
) += len
;
1785 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1791 /* Value is the text position, i.e. character and byte position,
1792 for character position CHARPOS in STRING. */
1794 static struct text_pos
1795 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1797 struct text_pos pos
;
1798 eassert (STRINGP (string
));
1799 eassert (charpos
>= 0);
1800 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1805 /* Value is a text position, i.e. character and byte position, for
1806 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1807 means recognize multibyte characters. */
1809 static struct text_pos
1810 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1812 struct text_pos pos
;
1814 eassert (s
!= NULL
);
1815 eassert (charpos
>= 0);
1821 SET_TEXT_POS (pos
, 0, 0);
1824 string_char_and_length ((const unsigned char *) s
, &len
);
1827 BYTEPOS (pos
) += len
;
1831 SET_TEXT_POS (pos
, charpos
, charpos
);
1837 /* Value is the number of characters in C string S. MULTIBYTE_P
1838 non-zero means recognize multibyte characters. */
1841 number_of_chars (const char *s
, bool multibyte_p
)
1847 ptrdiff_t rest
= strlen (s
);
1849 const unsigned char *p
= (const unsigned char *) s
;
1851 for (nchars
= 0; rest
> 0; ++nchars
)
1853 string_char_and_length (p
, &len
);
1854 rest
-= len
, p
+= len
;
1858 nchars
= strlen (s
);
1864 /* Compute byte position NEWPOS->bytepos corresponding to
1865 NEWPOS->charpos. POS is a known position in string STRING.
1866 NEWPOS->charpos must be >= POS.charpos. */
1869 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1871 eassert (STRINGP (string
));
1872 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1874 if (STRING_MULTIBYTE (string
))
1875 *newpos
= string_pos_nchars_ahead (pos
, string
,
1876 CHARPOS (*newpos
) - CHARPOS (pos
));
1878 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1882 Return an estimation of the pixel height of mode or header lines on
1883 frame F. FACE_ID specifies what line's height to estimate. */
1886 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1888 #ifdef HAVE_WINDOW_SYSTEM
1889 if (FRAME_WINDOW_P (f
))
1891 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1893 /* This function is called so early when Emacs starts that the face
1894 cache and mode line face are not yet initialized. */
1895 if (FRAME_FACE_CACHE (f
))
1897 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1901 height
= FONT_HEIGHT (face
->font
);
1902 if (face
->box_line_width
> 0)
1903 height
+= 2 * face
->box_line_width
;
1914 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1915 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1916 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1917 not force the value into range. */
1920 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1921 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1924 #ifdef HAVE_WINDOW_SYSTEM
1925 if (FRAME_WINDOW_P (f
))
1927 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1928 even for negative values. */
1930 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1932 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1934 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1935 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1938 STORE_NATIVE_RECT (*bounds
,
1939 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1940 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1941 FRAME_COLUMN_WIDTH (f
) - 1,
1942 FRAME_LINE_HEIGHT (f
) - 1);
1944 /* PXW: Should we clip pixels before converting to columns/lines? */
1949 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1950 pix_x
= FRAME_TOTAL_COLS (f
);
1954 else if (pix_y
> FRAME_LINES (f
))
1955 pix_y
= FRAME_LINES (f
);
1965 /* Find the glyph under window-relative coordinates X/Y in window W.
1966 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1967 strings. Return in *HPOS and *VPOS the row and column number of
1968 the glyph found. Return in *AREA the glyph area containing X.
1969 Value is a pointer to the glyph found or null if X/Y is not on
1970 text, or we can't tell because W's current matrix is not up to
1973 static struct glyph
*
1974 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1975 int *dx
, int *dy
, int *area
)
1977 struct glyph
*glyph
, *end
;
1978 struct glyph_row
*row
= NULL
;
1981 /* Find row containing Y. Give up if some row is not enabled. */
1982 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1984 row
= MATRIX_ROW (w
->current_matrix
, i
);
1985 if (!row
->enabled_p
)
1987 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
1994 /* Give up if Y is not in the window. */
1995 if (i
== w
->current_matrix
->nrows
)
1998 /* Get the glyph area containing X. */
1999 if (w
->pseudo_window_p
)
2006 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2008 *area
= LEFT_MARGIN_AREA
;
2009 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2011 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2014 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2018 *area
= RIGHT_MARGIN_AREA
;
2019 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2023 /* Find glyph containing X. */
2024 glyph
= row
->glyphs
[*area
];
2025 end
= glyph
+ row
->used
[*area
];
2027 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2029 x
-= glyph
->pixel_width
;
2039 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2042 *hpos
= glyph
- row
->glyphs
[*area
];
2046 /* Convert frame-relative x/y to coordinates relative to window W.
2047 Takes pseudo-windows into account. */
2050 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2052 if (w
->pseudo_window_p
)
2054 /* A pseudo-window is always full-width, and starts at the
2055 left edge of the frame, plus a frame border. */
2056 struct frame
*f
= XFRAME (w
->frame
);
2057 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2058 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2062 *x
-= WINDOW_LEFT_EDGE_X (w
);
2063 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2067 #ifdef HAVE_WINDOW_SYSTEM
2070 Return in RECTS[] at most N clipping rectangles for glyph string S.
2071 Return the number of stored rectangles. */
2074 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2081 if (s
->row
->full_width_p
)
2083 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2084 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2085 if (s
->row
->mode_line_p
)
2086 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2088 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2090 /* Unless displaying a mode or menu bar line, which are always
2091 fully visible, clip to the visible part of the row. */
2092 if (s
->w
->pseudo_window_p
)
2093 r
.height
= s
->row
->visible_height
;
2095 r
.height
= s
->height
;
2099 /* This is a text line that may be partially visible. */
2100 r
.x
= window_box_left (s
->w
, s
->area
);
2101 r
.width
= window_box_width (s
->w
, s
->area
);
2102 r
.height
= s
->row
->visible_height
;
2106 if (r
.x
< s
->clip_head
->x
)
2108 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2109 r
.width
-= s
->clip_head
->x
- r
.x
;
2112 r
.x
= s
->clip_head
->x
;
2115 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2117 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2118 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2123 /* If S draws overlapping rows, it's sufficient to use the top and
2124 bottom of the window for clipping because this glyph string
2125 intentionally draws over other lines. */
2126 if (s
->for_overlaps
)
2128 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2129 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2131 /* Alas, the above simple strategy does not work for the
2132 environments with anti-aliased text: if the same text is
2133 drawn onto the same place multiple times, it gets thicker.
2134 If the overlap we are processing is for the erased cursor, we
2135 take the intersection with the rectangle of the cursor. */
2136 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2138 XRectangle rc
, r_save
= r
;
2140 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2141 rc
.y
= s
->w
->phys_cursor
.y
;
2142 rc
.width
= s
->w
->phys_cursor_width
;
2143 rc
.height
= s
->w
->phys_cursor_height
;
2145 x_intersect_rectangles (&r_save
, &rc
, &r
);
2150 /* Don't use S->y for clipping because it doesn't take partially
2151 visible lines into account. For example, it can be negative for
2152 partially visible lines at the top of a window. */
2153 if (!s
->row
->full_width_p
2154 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2155 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2157 r
.y
= max (0, s
->row
->y
);
2160 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2162 /* If drawing the cursor, don't let glyph draw outside its
2163 advertised boundaries. Cleartype does this under some circumstances. */
2164 if (s
->hl
== DRAW_CURSOR
)
2166 struct glyph
*glyph
= s
->first_glyph
;
2171 r
.width
-= s
->x
- r
.x
;
2174 r
.width
= min (r
.width
, glyph
->pixel_width
);
2176 /* If r.y is below window bottom, ensure that we still see a cursor. */
2177 height
= min (glyph
->ascent
+ glyph
->descent
,
2178 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2179 max_y
= window_text_bottom_y (s
->w
) - height
;
2180 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2181 if (s
->ybase
- glyph
->ascent
> max_y
)
2188 /* Don't draw cursor glyph taller than our actual glyph. */
2189 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2190 if (height
< r
.height
)
2192 max_y
= r
.y
+ r
.height
;
2193 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2194 r
.height
= min (max_y
- r
.y
, height
);
2201 XRectangle r_save
= r
;
2203 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2207 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2208 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2210 #ifdef CONVERT_FROM_XRECT
2211 CONVERT_FROM_XRECT (r
, *rects
);
2219 /* If we are processing overlapping and allowed to return
2220 multiple clipping rectangles, we exclude the row of the glyph
2221 string from the clipping rectangle. This is to avoid drawing
2222 the same text on the environment with anti-aliasing. */
2223 #ifdef CONVERT_FROM_XRECT
2226 XRectangle
*rs
= rects
;
2228 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2230 if (s
->for_overlaps
& OVERLAPS_PRED
)
2233 if (r
.y
+ r
.height
> row_y
)
2236 rs
[i
].height
= row_y
- r
.y
;
2242 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2245 if (r
.y
< row_y
+ s
->row
->visible_height
)
2247 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2249 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2250 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2259 #ifdef CONVERT_FROM_XRECT
2260 for (i
= 0; i
< n
; i
++)
2261 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2268 Return in *NR the clipping rectangle for glyph string S. */
2271 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2273 get_glyph_string_clip_rects (s
, nr
, 1);
2278 Return the position and height of the phys cursor in window W.
2279 Set w->phys_cursor_width to width of phys cursor.
2283 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2284 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2286 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2287 int x
, y
, wd
, h
, h0
, y0
;
2289 /* Compute the width of the rectangle to draw. If on a stretch
2290 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2291 rectangle as wide as the glyph, but use a canonical character
2293 wd
= glyph
->pixel_width
- 1;
2294 #if defined (HAVE_NTGUI) || defined (HAVE_NS)
2298 x
= w
->phys_cursor
.x
;
2305 if (glyph
->type
== STRETCH_GLYPH
2306 && !x_stretch_cursor_p
)
2307 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2308 w
->phys_cursor_width
= wd
;
2310 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2312 /* If y is below window bottom, ensure that we still see a cursor. */
2313 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2315 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2316 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2318 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2321 h
= max (h
- (y0
- y
) + 1, h0
);
2326 y0
= window_text_bottom_y (w
) - h0
;
2334 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2335 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2340 * Remember which glyph the mouse is over.
2344 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2348 struct glyph_row
*r
, *gr
, *end_row
;
2349 enum window_part part
;
2350 enum glyph_row_area area
;
2351 int x
, y
, width
, height
;
2353 /* Try to determine frame pixel position and size of the glyph under
2354 frame pixel coordinates X/Y on frame F. */
2356 if (window_resize_pixelwise
)
2361 else if (!f
->glyphs_initialized_p
2362 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2365 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2366 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2370 w
= XWINDOW (window
);
2371 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2372 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2374 x
= window_relative_x_coord (w
, part
, gx
);
2375 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2377 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2378 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2380 if (w
->pseudo_window_p
)
2383 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2389 case ON_LEFT_MARGIN
:
2390 area
= LEFT_MARGIN_AREA
;
2393 case ON_RIGHT_MARGIN
:
2394 area
= RIGHT_MARGIN_AREA
;
2397 case ON_HEADER_LINE
:
2399 gr
= (part
== ON_HEADER_LINE
2400 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2401 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2404 goto text_glyph_row_found
;
2411 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2412 if (r
->y
+ r
->height
> y
)
2418 text_glyph_row_found
:
2421 struct glyph
*g
= gr
->glyphs
[area
];
2422 struct glyph
*end
= g
+ gr
->used
[area
];
2424 height
= gr
->height
;
2425 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2426 if (gx
+ g
->pixel_width
> x
)
2431 if (g
->type
== IMAGE_GLYPH
)
2433 /* Don't remember when mouse is over image, as
2434 image may have hot-spots. */
2435 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2438 width
= g
->pixel_width
;
2442 /* Use nominal char spacing at end of line. */
2444 gx
+= (x
/ width
) * width
;
2447 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2449 gx
+= window_box_left_offset (w
, area
);
2450 /* Don't expand over the modeline to make sure the vertical
2451 drag cursor is shown early enough. */
2452 height
= min (height
,
2453 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2458 /* Use nominal line height at end of window. */
2459 gx
= (x
/ width
) * width
;
2461 gy
+= (y
/ height
) * height
;
2462 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2463 /* See comment above. */
2464 height
= min (height
,
2465 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2469 case ON_LEFT_FRINGE
:
2470 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2471 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2472 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2473 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2476 case ON_RIGHT_FRINGE
:
2477 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2478 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2479 : window_box_right_offset (w
, TEXT_AREA
));
2480 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2481 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2482 && !WINDOW_RIGHTMOST_P (w
))
2483 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2484 /* Make sure the vertical border can get her own glyph to the
2485 right of the one we build here. */
2486 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2488 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2490 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2494 case ON_VERTICAL_BORDER
:
2495 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2499 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2501 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2502 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2503 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2505 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2509 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2510 if (r
->y
+ r
->height
> y
)
2517 height
= gr
->height
;
2520 /* Use nominal line height at end of window. */
2522 gy
+= (y
/ height
) * height
;
2526 case ON_RIGHT_DIVIDER
:
2527 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2528 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2530 /* The bottom divider prevails. */
2531 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2534 case ON_BOTTOM_DIVIDER
:
2536 width
= WINDOW_PIXEL_WIDTH (w
);
2537 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2538 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2544 /* If there is no glyph under the mouse, then we divide the screen
2545 into a grid of the smallest glyph in the frame, and use that
2548 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2549 round down even for negative values. */
2555 gx
= (gx
/ width
) * width
;
2556 gy
= (gy
/ height
) * height
;
2562 gx
+= WINDOW_LEFT_EDGE_X (w
);
2563 gy
+= WINDOW_TOP_EDGE_Y (w
);
2566 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2568 /* Visible feedback for debugging. */
2571 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2572 f
->output_data
.x
->normal_gc
,
2573 gx
, gy
, width
, height
);
2579 #endif /* HAVE_WINDOW_SYSTEM */
2582 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2585 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2586 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2588 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2591 /***********************************************************************
2592 Lisp form evaluation
2593 ***********************************************************************/
2595 /* Error handler for safe_eval and safe_call. */
2598 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2600 add_to_log ("Error during redisplay: %S signaled %S",
2601 Flist (nargs
, args
), arg
);
2605 /* Call function FUNC with the rest of NARGS - 1 arguments
2606 following. Return the result, or nil if something went
2607 wrong. Prevent redisplay during the evaluation. */
2610 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2614 if (inhibit_eval_during_redisplay
)
2620 struct gcpro gcpro1
;
2621 Lisp_Object
*args
= alloca (nargs
* word_size
);
2624 for (i
= 1; i
< nargs
; i
++)
2625 args
[i
] = va_arg (ap
, Lisp_Object
);
2628 gcpro1
.nvars
= nargs
;
2629 specbind (Qinhibit_redisplay
, Qt
);
2631 specbind (Qinhibit_quit
, Qt
);
2632 /* Use Qt to ensure debugger does not run,
2633 so there is no possibility of wanting to redisplay. */
2634 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2644 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2649 va_start (ap
, func
);
2650 retval
= safe__call (false, nargs
, func
, ap
);
2655 /* Call function FN with one argument ARG.
2656 Return the result, or nil if something went wrong. */
2659 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2661 return safe_call (2, fn
, arg
);
2665 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2671 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2676 static Lisp_Object Qeval
;
2679 safe_eval (Lisp_Object sexpr
)
2681 return safe__call1 (false, Qeval
, sexpr
);
2685 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2687 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2690 /* Call function FN with two arguments ARG1 and ARG2.
2691 Return the result, or nil if something went wrong. */
2694 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2696 return safe_call (3, fn
, arg1
, arg2
);
2701 /***********************************************************************
2703 ***********************************************************************/
2707 /* Define CHECK_IT to perform sanity checks on iterators.
2708 This is for debugging. It is too slow to do unconditionally. */
2711 check_it (struct it
*it
)
2713 if (it
->method
== GET_FROM_STRING
)
2715 eassert (STRINGP (it
->string
));
2716 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2720 eassert (IT_STRING_CHARPOS (*it
) < 0);
2721 if (it
->method
== GET_FROM_BUFFER
)
2723 /* Check that character and byte positions agree. */
2724 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2729 eassert (it
->current
.dpvec_index
>= 0);
2731 eassert (it
->current
.dpvec_index
< 0);
2734 #define CHECK_IT(IT) check_it ((IT))
2738 #define CHECK_IT(IT) (void) 0
2743 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2745 /* Check that the window end of window W is what we expect it
2746 to be---the last row in the current matrix displaying text. */
2749 check_window_end (struct window
*w
)
2751 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2753 struct glyph_row
*row
;
2754 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2756 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2757 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2761 #define CHECK_WINDOW_END(W) check_window_end ((W))
2765 #define CHECK_WINDOW_END(W) (void) 0
2767 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2769 /***********************************************************************
2770 Iterator initialization
2771 ***********************************************************************/
2773 /* Initialize IT for displaying current_buffer in window W, starting
2774 at character position CHARPOS. CHARPOS < 0 means that no buffer
2775 position is specified which is useful when the iterator is assigned
2776 a position later. BYTEPOS is the byte position corresponding to
2779 If ROW is not null, calls to produce_glyphs with IT as parameter
2780 will produce glyphs in that row.
2782 BASE_FACE_ID is the id of a base face to use. It must be one of
2783 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2784 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2785 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2787 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2788 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2789 will be initialized to use the corresponding mode line glyph row of
2790 the desired matrix of W. */
2793 init_iterator (struct it
*it
, struct window
*w
,
2794 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2795 struct glyph_row
*row
, enum face_id base_face_id
)
2797 enum face_id remapped_base_face_id
= base_face_id
;
2799 /* Some precondition checks. */
2800 eassert (w
!= NULL
&& it
!= NULL
);
2801 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2804 /* If face attributes have been changed since the last redisplay,
2805 free realized faces now because they depend on face definitions
2806 that might have changed. Don't free faces while there might be
2807 desired matrices pending which reference these faces. */
2808 if (face_change_count
&& !inhibit_free_realized_faces
)
2810 face_change_count
= 0;
2811 free_all_realized_faces (Qnil
);
2814 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2815 if (! NILP (Vface_remapping_alist
))
2816 remapped_base_face_id
2817 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2819 /* Use one of the mode line rows of W's desired matrix if
2823 if (base_face_id
== MODE_LINE_FACE_ID
2824 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2825 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2826 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2827 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2831 memset (it
, 0, sizeof *it
);
2832 it
->current
.overlay_string_index
= -1;
2833 it
->current
.dpvec_index
= -1;
2834 it
->base_face_id
= remapped_base_face_id
;
2836 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2837 it
->paragraph_embedding
= L2R
;
2838 it
->bidi_it
.string
.lstring
= Qnil
;
2839 it
->bidi_it
.string
.s
= NULL
;
2840 it
->bidi_it
.string
.bufpos
= 0;
2843 /* The window in which we iterate over current_buffer: */
2844 XSETWINDOW (it
->window
, w
);
2846 it
->f
= XFRAME (w
->frame
);
2850 /* Extra space between lines (on window systems only). */
2851 if (base_face_id
== DEFAULT_FACE_ID
2852 && FRAME_WINDOW_P (it
->f
))
2854 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2855 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2856 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2857 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2858 * FRAME_LINE_HEIGHT (it
->f
));
2859 else if (it
->f
->extra_line_spacing
> 0)
2860 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2861 it
->max_extra_line_spacing
= 0;
2864 /* If realized faces have been removed, e.g. because of face
2865 attribute changes of named faces, recompute them. When running
2866 in batch mode, the face cache of the initial frame is null. If
2867 we happen to get called, make a dummy face cache. */
2868 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2869 init_frame_faces (it
->f
);
2870 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2871 recompute_basic_faces (it
->f
);
2873 /* Current value of the `slice', `space-width', and 'height' properties. */
2874 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2875 it
->space_width
= Qnil
;
2876 it
->font_height
= Qnil
;
2877 it
->override_ascent
= -1;
2879 /* Are control characters displayed as `^C'? */
2880 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2882 /* -1 means everything between a CR and the following line end
2883 is invisible. >0 means lines indented more than this value are
2885 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2887 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2889 : (!NILP (BVAR (current_buffer
, selective_display
))
2891 it
->selective_display_ellipsis_p
2892 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2894 /* Display table to use. */
2895 it
->dp
= window_display_table (w
);
2897 /* Are multibyte characters enabled in current_buffer? */
2898 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2900 /* Get the position at which the redisplay_end_trigger hook should
2901 be run, if it is to be run at all. */
2902 if (MARKERP (w
->redisplay_end_trigger
)
2903 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2904 it
->redisplay_end_trigger_charpos
2905 = marker_position (w
->redisplay_end_trigger
);
2906 else if (INTEGERP (w
->redisplay_end_trigger
))
2907 it
->redisplay_end_trigger_charpos
2908 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2911 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2913 /* Are lines in the display truncated? */
2914 if (base_face_id
!= DEFAULT_FACE_ID
2916 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2917 && ((!NILP (Vtruncate_partial_width_windows
)
2918 && !INTEGERP (Vtruncate_partial_width_windows
))
2919 || (INTEGERP (Vtruncate_partial_width_windows
)
2920 /* PXW: Shall we do something about this? */
2921 && (WINDOW_TOTAL_COLS (it
->w
)
2922 < XINT (Vtruncate_partial_width_windows
))))))
2923 it
->line_wrap
= TRUNCATE
;
2924 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2925 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2926 ? WINDOW_WRAP
: WORD_WRAP
;
2928 it
->line_wrap
= TRUNCATE
;
2930 /* Get dimensions of truncation and continuation glyphs. These are
2931 displayed as fringe bitmaps under X, but we need them for such
2932 frames when the fringes are turned off. But leave the dimensions
2933 zero for tooltip frames, as these glyphs look ugly there and also
2934 sabotage calculations of tooltip dimensions in x-show-tip. */
2935 #ifdef HAVE_WINDOW_SYSTEM
2936 if (!(FRAME_WINDOW_P (it
->f
)
2937 && FRAMEP (tip_frame
)
2938 && it
->f
== XFRAME (tip_frame
)))
2941 if (it
->line_wrap
== TRUNCATE
)
2943 /* We will need the truncation glyph. */
2944 eassert (it
->glyph_row
== NULL
);
2945 produce_special_glyphs (it
, IT_TRUNCATION
);
2946 it
->truncation_pixel_width
= it
->pixel_width
;
2950 /* We will need the continuation glyph. */
2951 eassert (it
->glyph_row
== NULL
);
2952 produce_special_glyphs (it
, IT_CONTINUATION
);
2953 it
->continuation_pixel_width
= it
->pixel_width
;
2957 /* Reset these values to zero because the produce_special_glyphs
2958 above has changed them. */
2959 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2960 it
->phys_ascent
= it
->phys_descent
= 0;
2962 /* Set this after getting the dimensions of truncation and
2963 continuation glyphs, so that we don't produce glyphs when calling
2964 produce_special_glyphs, above. */
2965 it
->glyph_row
= row
;
2966 it
->area
= TEXT_AREA
;
2968 /* Forget any previous info about this row being reversed. */
2970 it
->glyph_row
->reversed_p
= 0;
2972 /* Get the dimensions of the display area. The display area
2973 consists of the visible window area plus a horizontally scrolled
2974 part to the left of the window. All x-values are relative to the
2975 start of this total display area. */
2976 if (base_face_id
!= DEFAULT_FACE_ID
)
2978 /* Mode lines, menu bar in terminal frames. */
2979 it
->first_visible_x
= 0;
2980 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2985 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2986 it
->last_visible_x
= (it
->first_visible_x
2987 + window_box_width (w
, TEXT_AREA
));
2989 /* If we truncate lines, leave room for the truncation glyph(s) at
2990 the right margin. Otherwise, leave room for the continuation
2991 glyph(s). Done only if the window has no fringes. Since we
2992 don't know at this point whether there will be any R2L lines in
2993 the window, we reserve space for truncation/continuation glyphs
2994 even if only one of the fringes is absent. */
2995 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
2996 || (it
->bidi_p
&& WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
2998 if (it
->line_wrap
== TRUNCATE
)
2999 it
->last_visible_x
-= it
->truncation_pixel_width
;
3001 it
->last_visible_x
-= it
->continuation_pixel_width
;
3004 it
->header_line_p
= WINDOW_WANTS_HEADER_LINE_P (w
);
3005 it
->current_y
= WINDOW_HEADER_LINE_HEIGHT (w
) + w
->vscroll
;
3008 /* Leave room for a border glyph. */
3009 if (!FRAME_WINDOW_P (it
->f
)
3010 && !WINDOW_RIGHTMOST_P (it
->w
))
3011 it
->last_visible_x
-= 1;
3013 it
->last_visible_y
= window_text_bottom_y (w
);
3015 /* For mode lines and alike, arrange for the first glyph having a
3016 left box line if the face specifies a box. */
3017 if (base_face_id
!= DEFAULT_FACE_ID
)
3021 it
->face_id
= remapped_base_face_id
;
3023 /* If we have a boxed mode line, make the first character appear
3024 with a left box line. */
3025 face
= FACE_FROM_ID (it
->f
, remapped_base_face_id
);
3026 if (face
&& face
->box
!= FACE_NO_BOX
)
3027 it
->start_of_box_run_p
= true;
3030 /* If a buffer position was specified, set the iterator there,
3031 getting overlays and face properties from that position. */
3032 if (charpos
>= BUF_BEG (current_buffer
))
3034 it
->end_charpos
= ZV
;
3035 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3036 IT_CHARPOS (*it
) = charpos
;
3037 IT_BYTEPOS (*it
) = bytepos
;
3039 /* We will rely on `reseat' to set this up properly, via
3040 handle_face_prop. */
3041 it
->face_id
= it
->base_face_id
;
3043 it
->start
= it
->current
;
3044 /* Do we need to reorder bidirectional text? Not if this is a
3045 unibyte buffer: by definition, none of the single-byte
3046 characters are strong R2L, so no reordering is needed. And
3047 bidi.c doesn't support unibyte buffers anyway. Also, don't
3048 reorder while we are loading loadup.el, since the tables of
3049 character properties needed for reordering are not yet
3053 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3056 /* If we are to reorder bidirectional text, init the bidi
3060 /* Note the paragraph direction that this buffer wants to
3062 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3064 it
->paragraph_embedding
= L2R
;
3065 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3067 it
->paragraph_embedding
= R2L
;
3069 it
->paragraph_embedding
= NEUTRAL_DIR
;
3070 bidi_unshelve_cache (NULL
, 0);
3071 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3075 /* Compute faces etc. */
3076 reseat (it
, it
->current
.pos
, 1);
3083 /* Initialize IT for the display of window W with window start POS. */
3086 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3088 struct glyph_row
*row
;
3089 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3091 row
= w
->desired_matrix
->rows
+ first_vpos
;
3092 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3093 it
->first_vpos
= first_vpos
;
3095 /* Don't reseat to previous visible line start if current start
3096 position is in a string or image. */
3097 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3099 int start_at_line_beg_p
;
3100 int first_y
= it
->current_y
;
3102 /* If window start is not at a line start, skip forward to POS to
3103 get the correct continuation lines width. */
3104 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3105 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3106 if (!start_at_line_beg_p
)
3110 reseat_at_previous_visible_line_start (it
);
3111 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3113 new_x
= it
->current_x
+ it
->pixel_width
;
3115 /* If lines are continued, this line may end in the middle
3116 of a multi-glyph character (e.g. a control character
3117 displayed as \003, or in the middle of an overlay
3118 string). In this case move_it_to above will not have
3119 taken us to the start of the continuation line but to the
3120 end of the continued line. */
3121 if (it
->current_x
> 0
3122 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3123 && (/* And glyph doesn't fit on the line. */
3124 new_x
> it
->last_visible_x
3125 /* Or it fits exactly and we're on a window
3127 || (new_x
== it
->last_visible_x
3128 && FRAME_WINDOW_P (it
->f
)
3129 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3130 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3131 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3133 if ((it
->current
.dpvec_index
>= 0
3134 || it
->current
.overlay_string_index
>= 0)
3135 /* If we are on a newline from a display vector or
3136 overlay string, then we are already at the end of
3137 a screen line; no need to go to the next line in
3138 that case, as this line is not really continued.
3139 (If we do go to the next line, C-e will not DTRT.) */
3142 set_iterator_to_next (it
, 1);
3143 move_it_in_display_line_to (it
, -1, -1, 0);
3146 it
->continuation_lines_width
+= it
->current_x
;
3148 /* If the character at POS is displayed via a display
3149 vector, move_it_to above stops at the final glyph of
3150 IT->dpvec. To make the caller redisplay that character
3151 again (a.k.a. start at POS), we need to reset the
3152 dpvec_index to the beginning of IT->dpvec. */
3153 else if (it
->current
.dpvec_index
>= 0)
3154 it
->current
.dpvec_index
= 0;
3156 /* We're starting a new display line, not affected by the
3157 height of the continued line, so clear the appropriate
3158 fields in the iterator structure. */
3159 it
->max_ascent
= it
->max_descent
= 0;
3160 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3162 it
->current_y
= first_y
;
3164 it
->current_x
= it
->hpos
= 0;
3170 /* Return 1 if POS is a position in ellipses displayed for invisible
3171 text. W is the window we display, for text property lookup. */
3174 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3176 Lisp_Object prop
, window
;
3178 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3180 /* If POS specifies a position in a display vector, this might
3181 be for an ellipsis displayed for invisible text. We won't
3182 get the iterator set up for delivering that ellipsis unless
3183 we make sure that it gets aware of the invisible text. */
3184 if (pos
->dpvec_index
>= 0
3185 && pos
->overlay_string_index
< 0
3186 && CHARPOS (pos
->string_pos
) < 0
3188 && (XSETWINDOW (window
, w
),
3189 prop
= Fget_char_property (make_number (charpos
),
3190 Qinvisible
, window
),
3191 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3193 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3195 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3202 /* Initialize IT for stepping through current_buffer in window W,
3203 starting at position POS that includes overlay string and display
3204 vector/ control character translation position information. Value
3205 is zero if there are overlay strings with newlines at POS. */
3208 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3210 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3211 int i
, overlay_strings_with_newlines
= 0;
3213 /* If POS specifies a position in a display vector, this might
3214 be for an ellipsis displayed for invisible text. We won't
3215 get the iterator set up for delivering that ellipsis unless
3216 we make sure that it gets aware of the invisible text. */
3217 if (in_ellipses_for_invisible_text_p (pos
, w
))
3223 /* Keep in mind: the call to reseat in init_iterator skips invisible
3224 text, so we might end up at a position different from POS. This
3225 is only a problem when POS is a row start after a newline and an
3226 overlay starts there with an after-string, and the overlay has an
3227 invisible property. Since we don't skip invisible text in
3228 display_line and elsewhere immediately after consuming the
3229 newline before the row start, such a POS will not be in a string,
3230 but the call to init_iterator below will move us to the
3232 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3234 /* This only scans the current chunk -- it should scan all chunks.
3235 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3236 to 16 in 22.1 to make this a lesser problem. */
3237 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3239 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3240 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3242 while (s
< e
&& *s
!= '\n')
3247 overlay_strings_with_newlines
= 1;
3252 /* If position is within an overlay string, set up IT to the right
3254 if (pos
->overlay_string_index
>= 0)
3258 /* If the first overlay string happens to have a `display'
3259 property for an image, the iterator will be set up for that
3260 image, and we have to undo that setup first before we can
3261 correct the overlay string index. */
3262 if (it
->method
== GET_FROM_IMAGE
)
3265 /* We already have the first chunk of overlay strings in
3266 IT->overlay_strings. Load more until the one for
3267 pos->overlay_string_index is in IT->overlay_strings. */
3268 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3270 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3271 it
->current
.overlay_string_index
= 0;
3274 load_overlay_strings (it
, 0);
3275 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3279 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3280 relative_index
= (it
->current
.overlay_string_index
3281 % OVERLAY_STRING_CHUNK_SIZE
);
3282 it
->string
= it
->overlay_strings
[relative_index
];
3283 eassert (STRINGP (it
->string
));
3284 it
->current
.string_pos
= pos
->string_pos
;
3285 it
->method
= GET_FROM_STRING
;
3286 it
->end_charpos
= SCHARS (it
->string
);
3287 /* Set up the bidi iterator for this overlay string. */
3290 it
->bidi_it
.string
.lstring
= it
->string
;
3291 it
->bidi_it
.string
.s
= NULL
;
3292 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3293 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3294 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3295 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3296 it
->bidi_it
.w
= it
->w
;
3297 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3298 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3300 /* Synchronize the state of the bidi iterator with
3301 pos->string_pos. For any string position other than
3302 zero, this will be done automagically when we resume
3303 iteration over the string and get_visually_first_element
3304 is called. But if string_pos is zero, and the string is
3305 to be reordered for display, we need to resync manually,
3306 since it could be that the iteration state recorded in
3307 pos ended at string_pos of 0 moving backwards in string. */
3308 if (CHARPOS (pos
->string_pos
) == 0)
3310 get_visually_first_element (it
);
3311 if (IT_STRING_CHARPOS (*it
) != 0)
3314 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3315 bidi_move_to_visually_next (&it
->bidi_it
);
3316 } while (it
->bidi_it
.charpos
!= 0);
3318 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3319 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3323 if (CHARPOS (pos
->string_pos
) >= 0)
3325 /* Recorded position is not in an overlay string, but in another
3326 string. This can only be a string from a `display' property.
3327 IT should already be filled with that string. */
3328 it
->current
.string_pos
= pos
->string_pos
;
3329 eassert (STRINGP (it
->string
));
3331 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3332 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3335 /* Restore position in display vector translations, control
3336 character translations or ellipses. */
3337 if (pos
->dpvec_index
>= 0)
3339 if (it
->dpvec
== NULL
)
3340 get_next_display_element (it
);
3341 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3342 it
->current
.dpvec_index
= pos
->dpvec_index
;
3346 return !overlay_strings_with_newlines
;
3350 /* Initialize IT for stepping through current_buffer in window W
3351 starting at ROW->start. */
3354 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3356 init_from_display_pos (it
, w
, &row
->start
);
3357 it
->start
= row
->start
;
3358 it
->continuation_lines_width
= row
->continuation_lines_width
;
3363 /* Initialize IT for stepping through current_buffer in window W
3364 starting in the line following ROW, i.e. starting at ROW->end.
3365 Value is zero if there are overlay strings with newlines at ROW's
3369 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3373 if (init_from_display_pos (it
, w
, &row
->end
))
3375 if (row
->continued_p
)
3376 it
->continuation_lines_width
3377 = row
->continuation_lines_width
+ row
->pixel_width
;
3388 /***********************************************************************
3390 ***********************************************************************/
3392 /* Called when IT reaches IT->stop_charpos. Handle text property and
3393 overlay changes. Set IT->stop_charpos to the next position where
3397 handle_stop (struct it
*it
)
3399 enum prop_handled handled
;
3400 int handle_overlay_change_p
;
3404 it
->current
.dpvec_index
= -1;
3405 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3406 it
->ignore_overlay_strings_at_pos_p
= 0;
3409 /* Use face of preceding text for ellipsis (if invisible) */
3410 if (it
->selective_display_ellipsis_p
)
3411 it
->saved_face_id
= it
->face_id
;
3415 handled
= HANDLED_NORMALLY
;
3417 /* Call text property handlers. */
3418 for (p
= it_props
; p
->handler
; ++p
)
3420 handled
= p
->handler (it
);
3422 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3424 else if (handled
== HANDLED_RETURN
)
3426 /* We still want to show before and after strings from
3427 overlays even if the actual buffer text is replaced. */
3428 if (!handle_overlay_change_p
3430 /* Don't call get_overlay_strings_1 if we already
3431 have overlay strings loaded, because doing so
3432 will load them again and push the iterator state
3433 onto the stack one more time, which is not
3434 expected by the rest of the code that processes
3436 || (it
->current
.overlay_string_index
< 0
3437 ? !get_overlay_strings_1 (it
, 0, 0)
3441 setup_for_ellipsis (it
, 0);
3442 /* When handling a display spec, we might load an
3443 empty string. In that case, discard it here. We
3444 used to discard it in handle_single_display_spec,
3445 but that causes get_overlay_strings_1, above, to
3446 ignore overlay strings that we must check. */
3447 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3451 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3455 it
->ignore_overlay_strings_at_pos_p
= true;
3456 it
->string_from_display_prop_p
= 0;
3457 it
->from_disp_prop_p
= 0;
3458 handle_overlay_change_p
= 0;
3460 handled
= HANDLED_RECOMPUTE_PROPS
;
3463 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3464 handle_overlay_change_p
= 0;
3467 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3469 /* Don't check for overlay strings below when set to deliver
3470 characters from a display vector. */
3471 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3472 handle_overlay_change_p
= 0;
3474 /* Handle overlay changes.
3475 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3476 if it finds overlays. */
3477 if (handle_overlay_change_p
)
3478 handled
= handle_overlay_change (it
);
3483 setup_for_ellipsis (it
, 0);
3487 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3489 /* Determine where to stop next. */
3490 if (handled
== HANDLED_NORMALLY
)
3491 compute_stop_pos (it
);
3495 /* Compute IT->stop_charpos from text property and overlay change
3496 information for IT's current position. */
3499 compute_stop_pos (struct it
*it
)
3501 register INTERVAL iv
, next_iv
;
3502 Lisp_Object object
, limit
, position
;
3503 ptrdiff_t charpos
, bytepos
;
3505 if (STRINGP (it
->string
))
3507 /* Strings are usually short, so don't limit the search for
3509 it
->stop_charpos
= it
->end_charpos
;
3510 object
= it
->string
;
3512 charpos
= IT_STRING_CHARPOS (*it
);
3513 bytepos
= IT_STRING_BYTEPOS (*it
);
3519 /* If end_charpos is out of range for some reason, such as a
3520 misbehaving display function, rationalize it (Bug#5984). */
3521 if (it
->end_charpos
> ZV
)
3522 it
->end_charpos
= ZV
;
3523 it
->stop_charpos
= it
->end_charpos
;
3525 /* If next overlay change is in front of the current stop pos
3526 (which is IT->end_charpos), stop there. Note: value of
3527 next_overlay_change is point-max if no overlay change
3529 charpos
= IT_CHARPOS (*it
);
3530 bytepos
= IT_BYTEPOS (*it
);
3531 pos
= next_overlay_change (charpos
);
3532 if (pos
< it
->stop_charpos
)
3533 it
->stop_charpos
= pos
;
3535 /* Set up variables for computing the stop position from text
3536 property changes. */
3537 XSETBUFFER (object
, current_buffer
);
3538 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3541 /* Get the interval containing IT's position. Value is a null
3542 interval if there isn't such an interval. */
3543 position
= make_number (charpos
);
3544 iv
= validate_interval_range (object
, &position
, &position
, 0);
3547 Lisp_Object values_here
[LAST_PROP_IDX
];
3550 /* Get properties here. */
3551 for (p
= it_props
; p
->handler
; ++p
)
3552 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3554 /* Look for an interval following iv that has different
3556 for (next_iv
= next_interval (iv
);
3559 || XFASTINT (limit
) > next_iv
->position
));
3560 next_iv
= next_interval (next_iv
))
3562 for (p
= it_props
; p
->handler
; ++p
)
3564 Lisp_Object new_value
;
3566 new_value
= textget (next_iv
->plist
, *p
->name
);
3567 if (!EQ (values_here
[p
->idx
], new_value
))
3577 if (INTEGERP (limit
)
3578 && next_iv
->position
>= XFASTINT (limit
))
3579 /* No text property change up to limit. */
3580 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3582 /* Text properties change in next_iv. */
3583 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3587 if (it
->cmp_it
.id
< 0)
3589 ptrdiff_t stoppos
= it
->end_charpos
;
3591 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3593 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3594 stoppos
, it
->string
);
3597 eassert (STRINGP (it
->string
)
3598 || (it
->stop_charpos
>= BEGV
3599 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3603 /* Return the position of the next overlay change after POS in
3604 current_buffer. Value is point-max if no overlay change
3605 follows. This is like `next-overlay-change' but doesn't use
3609 next_overlay_change (ptrdiff_t pos
)
3611 ptrdiff_t i
, noverlays
;
3613 Lisp_Object
*overlays
;
3615 /* Get all overlays at the given position. */
3616 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3618 /* If any of these overlays ends before endpos,
3619 use its ending point instead. */
3620 for (i
= 0; i
< noverlays
; ++i
)
3625 oend
= OVERLAY_END (overlays
[i
]);
3626 oendpos
= OVERLAY_POSITION (oend
);
3627 endpos
= min (endpos
, oendpos
);
3633 /* How many characters forward to search for a display property or
3634 display string. Searching too far forward makes the bidi display
3635 sluggish, especially in small windows. */
3636 #define MAX_DISP_SCAN 250
3638 /* Return the character position of a display string at or after
3639 position specified by POSITION. If no display string exists at or
3640 after POSITION, return ZV. A display string is either an overlay
3641 with `display' property whose value is a string, or a `display'
3642 text property whose value is a string. STRING is data about the
3643 string to iterate; if STRING->lstring is nil, we are iterating a
3644 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3645 on a GUI frame. DISP_PROP is set to zero if we searched
3646 MAX_DISP_SCAN characters forward without finding any display
3647 strings, non-zero otherwise. It is set to 2 if the display string
3648 uses any kind of `(space ...)' spec that will produce a stretch of
3649 white space in the text area. */
3651 compute_display_string_pos (struct text_pos
*position
,
3652 struct bidi_string_data
*string
,
3654 int frame_window_p
, int *disp_prop
)
3656 /* OBJECT = nil means current buffer. */
3657 Lisp_Object object
, object1
;
3658 Lisp_Object pos
, spec
, limpos
;
3659 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3660 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3661 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3662 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3664 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3665 struct text_pos tpos
;
3668 if (string
&& STRINGP (string
->lstring
))
3669 object1
= object
= string
->lstring
;
3670 else if (w
&& !string_p
)
3672 XSETWINDOW (object
, w
);
3676 object1
= object
= Qnil
;
3681 /* We don't support display properties whose values are strings
3682 that have display string properties. */
3683 || string
->from_disp_str
3684 /* C strings cannot have display properties. */
3685 || (string
->s
&& !STRINGP (object
)))
3691 /* If the character at CHARPOS is where the display string begins,
3693 pos
= make_number (charpos
);
3694 if (STRINGP (object
))
3695 bufpos
= string
->bufpos
;
3699 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3701 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3704 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3712 /* Look forward for the first character with a `display' property
3713 that will replace the underlying text when displayed. */
3714 limpos
= make_number (lim
);
3716 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3717 CHARPOS (tpos
) = XFASTINT (pos
);
3718 if (CHARPOS (tpos
) >= lim
)
3723 if (STRINGP (object
))
3724 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3726 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3727 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3728 if (!STRINGP (object
))
3729 bufpos
= CHARPOS (tpos
);
3730 } while (NILP (spec
)
3731 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3732 bufpos
, frame_window_p
)));
3736 return CHARPOS (tpos
);
3739 /* Return the character position of the end of the display string that
3740 started at CHARPOS. If there's no display string at CHARPOS,
3741 return -1. A display string is either an overlay with `display'
3742 property whose value is a string or a `display' text property whose
3743 value is a string. */
3745 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3747 /* OBJECT = nil means current buffer. */
3748 Lisp_Object object
=
3749 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3750 Lisp_Object pos
= make_number (charpos
);
3752 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3754 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3757 /* It could happen that the display property or overlay was removed
3758 since we found it in compute_display_string_pos above. One way
3759 this can happen is if JIT font-lock was called (through
3760 handle_fontified_prop), and jit-lock-functions remove text
3761 properties or overlays from the portion of buffer that includes
3762 CHARPOS. Muse mode is known to do that, for example. In this
3763 case, we return -1 to the caller, to signal that no display
3764 string is actually present at CHARPOS. See bidi_fetch_char for
3765 how this is handled.
3767 An alternative would be to never look for display properties past
3768 it->stop_charpos. But neither compute_display_string_pos nor
3769 bidi_fetch_char that calls it know or care where the next
3771 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3774 /* Look forward for the first character where the `display' property
3776 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3778 return XFASTINT (pos
);
3783 /***********************************************************************
3785 ***********************************************************************/
3787 /* Handle changes in the `fontified' property of the current buffer by
3788 calling hook functions from Qfontification_functions to fontify
3791 static enum prop_handled
3792 handle_fontified_prop (struct it
*it
)
3794 Lisp_Object prop
, pos
;
3795 enum prop_handled handled
= HANDLED_NORMALLY
;
3797 if (!NILP (Vmemory_full
))
3800 /* Get the value of the `fontified' property at IT's current buffer
3801 position. (The `fontified' property doesn't have a special
3802 meaning in strings.) If the value is nil, call functions from
3803 Qfontification_functions. */
3804 if (!STRINGP (it
->string
)
3806 && !NILP (Vfontification_functions
)
3807 && !NILP (Vrun_hooks
)
3808 && (pos
= make_number (IT_CHARPOS (*it
)),
3809 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3810 /* Ignore the special cased nil value always present at EOB since
3811 no amount of fontifying will be able to change it. */
3812 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3816 struct buffer
*obuf
= current_buffer
;
3817 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3818 bool old_clip_changed
= current_buffer
->clip_changed
;
3820 val
= Vfontification_functions
;
3821 specbind (Qfontification_functions
, Qnil
);
3823 eassert (it
->end_charpos
== ZV
);
3825 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3826 safe_call1 (val
, pos
);
3829 Lisp_Object fns
, fn
;
3830 struct gcpro gcpro1
, gcpro2
;
3835 for (; CONSP (val
); val
= XCDR (val
))
3841 /* A value of t indicates this hook has a local
3842 binding; it means to run the global binding too.
3843 In a global value, t should not occur. If it
3844 does, we must ignore it to avoid an endless
3846 for (fns
= Fdefault_value (Qfontification_functions
);
3852 safe_call1 (fn
, pos
);
3856 safe_call1 (fn
, pos
);
3864 /* Fontification functions routinely call `save-restriction'.
3865 Normally, this tags clip_changed, which can confuse redisplay
3866 (see discussion in Bug#6671). Since we don't perform any
3867 special handling of fontification changes in the case where
3868 `save-restriction' isn't called, there's no point doing so in
3869 this case either. So, if the buffer's restrictions are
3870 actually left unchanged, reset clip_changed. */
3871 if (obuf
== current_buffer
)
3873 if (begv
== BEGV
&& zv
== ZV
)
3874 current_buffer
->clip_changed
= old_clip_changed
;
3876 /* There isn't much we can reasonably do to protect against
3877 misbehaving fontification, but here's a fig leaf. */
3878 else if (BUFFER_LIVE_P (obuf
))
3879 set_buffer_internal_1 (obuf
);
3881 /* The fontification code may have added/removed text.
3882 It could do even a lot worse, but let's at least protect against
3883 the most obvious case where only the text past `pos' gets changed',
3884 as is/was done in grep.el where some escapes sequences are turned
3885 into face properties (bug#7876). */
3886 it
->end_charpos
= ZV
;
3888 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3889 something. This avoids an endless loop if they failed to
3890 fontify the text for which reason ever. */
3891 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3892 handled
= HANDLED_RECOMPUTE_PROPS
;
3900 /***********************************************************************
3902 ***********************************************************************/
3904 /* Set up iterator IT from face properties at its current position.
3905 Called from handle_stop. */
3907 static enum prop_handled
3908 handle_face_prop (struct it
*it
)
3911 ptrdiff_t next_stop
;
3913 if (!STRINGP (it
->string
))
3916 = face_at_buffer_position (it
->w
,
3920 + TEXT_PROP_DISTANCE_LIMIT
),
3921 0, it
->base_face_id
);
3923 /* Is this a start of a run of characters with box face?
3924 Caveat: this can be called for a freshly initialized
3925 iterator; face_id is -1 in this case. We know that the new
3926 face will not change until limit, i.e. if the new face has a
3927 box, all characters up to limit will have one. But, as
3928 usual, we don't know whether limit is really the end. */
3929 if (new_face_id
!= it
->face_id
)
3931 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3932 /* If it->face_id is -1, old_face below will be NULL, see
3933 the definition of FACE_FROM_ID. This will happen if this
3934 is the initial call that gets the face. */
3935 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3937 /* If the value of face_id of the iterator is -1, we have to
3938 look in front of IT's position and see whether there is a
3939 face there that's different from new_face_id. */
3940 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
3942 int prev_face_id
= face_before_it_pos (it
);
3944 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
3947 /* If the new face has a box, but the old face does not,
3948 this is the start of a run of characters with box face,
3949 i.e. this character has a shadow on the left side. */
3950 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
3951 && (old_face
== NULL
|| !old_face
->box
));
3952 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
3960 Lisp_Object from_overlay
3961 = (it
->current
.overlay_string_index
>= 0
3962 ? it
->string_overlays
[it
->current
.overlay_string_index
3963 % OVERLAY_STRING_CHUNK_SIZE
]
3966 /* See if we got to this string directly or indirectly from
3967 an overlay property. That includes the before-string or
3968 after-string of an overlay, strings in display properties
3969 provided by an overlay, their text properties, etc.
3971 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
3972 if (! NILP (from_overlay
))
3973 for (i
= it
->sp
- 1; i
>= 0; i
--)
3975 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
3977 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
3978 % OVERLAY_STRING_CHUNK_SIZE
];
3979 else if (! NILP (it
->stack
[i
].from_overlay
))
3980 from_overlay
= it
->stack
[i
].from_overlay
;
3982 if (!NILP (from_overlay
))
3986 if (! NILP (from_overlay
))
3988 bufpos
= IT_CHARPOS (*it
);
3989 /* For a string from an overlay, the base face depends
3990 only on text properties and ignores overlays. */
3992 = face_for_overlay_string (it
->w
,
3996 + TEXT_PROP_DISTANCE_LIMIT
),
4004 /* For strings from a `display' property, use the face at
4005 IT's current buffer position as the base face to merge
4006 with, so that overlay strings appear in the same face as
4007 surrounding text, unless they specify their own faces.
4008 For strings from wrap-prefix and line-prefix properties,
4009 use the default face, possibly remapped via
4010 Vface_remapping_alist. */
4011 /* Note that the fact that we use the face at _buffer_
4012 position means that a 'display' property on an overlay
4013 string will not inherit the face of that overlay string,
4014 but will instead revert to the face of buffer text
4015 covered by the overlay. This is visible, e.g., when the
4016 overlay specifies a box face, but neither the buffer nor
4017 the display string do. This sounds like a design bug,
4018 but Emacs always did that since v21.1, so changing that
4019 might be a big deal. */
4020 base_face_id
= it
->string_from_prefix_prop_p
4021 ? (!NILP (Vface_remapping_alist
)
4022 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4024 : underlying_face_id (it
);
4027 new_face_id
= face_at_string_position (it
->w
,
4029 IT_STRING_CHARPOS (*it
),
4034 /* Is this a start of a run of characters with box? Caveat:
4035 this can be called for a freshly allocated iterator; face_id
4036 is -1 is this case. We know that the new face will not
4037 change until the next check pos, i.e. if the new face has a
4038 box, all characters up to that position will have a
4039 box. But, as usual, we don't know whether that position
4040 is really the end. */
4041 if (new_face_id
!= it
->face_id
)
4043 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4044 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4046 /* If new face has a box but old face hasn't, this is the
4047 start of a run of characters with box, i.e. it has a
4048 shadow on the left side. */
4049 it
->start_of_box_run_p
4050 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4051 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4055 it
->face_id
= new_face_id
;
4056 return HANDLED_NORMALLY
;
4060 /* Return the ID of the face ``underlying'' IT's current position,
4061 which is in a string. If the iterator is associated with a
4062 buffer, return the face at IT's current buffer position.
4063 Otherwise, use the iterator's base_face_id. */
4066 underlying_face_id (struct it
*it
)
4068 int face_id
= it
->base_face_id
, i
;
4070 eassert (STRINGP (it
->string
));
4072 for (i
= it
->sp
- 1; i
>= 0; --i
)
4073 if (NILP (it
->stack
[i
].string
))
4074 face_id
= it
->stack
[i
].face_id
;
4080 /* Compute the face one character before or after the current position
4081 of IT, in the visual order. BEFORE_P non-zero means get the face
4082 in front (to the left in L2R paragraphs, to the right in R2L
4083 paragraphs) of IT's screen position. Value is the ID of the face. */
4086 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4089 ptrdiff_t next_check_charpos
;
4091 void *it_copy_data
= NULL
;
4093 eassert (it
->s
== NULL
);
4095 if (STRINGP (it
->string
))
4097 ptrdiff_t bufpos
, charpos
;
4100 /* No face change past the end of the string (for the case
4101 we are padding with spaces). No face change before the
4103 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4104 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4109 /* Set charpos to the position before or after IT's current
4110 position, in the logical order, which in the non-bidi
4111 case is the same as the visual order. */
4113 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4114 else if (it
->what
== IT_COMPOSITION
)
4115 /* For composition, we must check the character after the
4117 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4119 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4125 /* With bidi iteration, the character before the current
4126 in the visual order cannot be found by simple
4127 iteration, because "reverse" reordering is not
4128 supported. Instead, we need to use the move_it_*
4129 family of functions. */
4130 /* Ignore face changes before the first visible
4131 character on this display line. */
4132 if (it
->current_x
<= it
->first_visible_x
)
4134 SAVE_IT (it_copy
, *it
, it_copy_data
);
4135 /* Implementation note: Since move_it_in_display_line
4136 works in the iterator geometry, and thinks the first
4137 character is always the leftmost, even in R2L lines,
4138 we don't need to distinguish between the R2L and L2R
4140 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4141 it_copy
.current_x
- 1, MOVE_TO_X
);
4142 charpos
= IT_STRING_CHARPOS (it_copy
);
4143 RESTORE_IT (it
, it
, it_copy_data
);
4147 /* Set charpos to the string position of the character
4148 that comes after IT's current position in the visual
4150 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4154 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4156 charpos
= it_copy
.bidi_it
.charpos
;
4159 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4161 if (it
->current
.overlay_string_index
>= 0)
4162 bufpos
= IT_CHARPOS (*it
);
4166 base_face_id
= underlying_face_id (it
);
4168 /* Get the face for ASCII, or unibyte. */
4169 face_id
= face_at_string_position (it
->w
,
4173 &next_check_charpos
,
4176 /* Correct the face for charsets different from ASCII. Do it
4177 for the multibyte case only. The face returned above is
4178 suitable for unibyte text if IT->string is unibyte. */
4179 if (STRING_MULTIBYTE (it
->string
))
4181 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4182 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4184 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4186 c
= string_char_and_length (p
, &len
);
4187 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4192 struct text_pos pos
;
4194 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4195 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4198 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4199 pos
= it
->current
.pos
;
4204 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4207 if (it
->what
== IT_COMPOSITION
)
4209 /* For composition, we must check the position after
4211 pos
.charpos
+= it
->cmp_it
.nchars
;
4212 pos
.bytepos
+= it
->len
;
4215 INC_TEXT_POS (pos
, it
->multibyte_p
);
4222 /* With bidi iteration, the character before the current
4223 in the visual order cannot be found by simple
4224 iteration, because "reverse" reordering is not
4225 supported. Instead, we need to use the move_it_*
4226 family of functions. */
4227 /* Ignore face changes before the first visible
4228 character on this display line. */
4229 if (it
->current_x
<= it
->first_visible_x
)
4231 SAVE_IT (it_copy
, *it
, it_copy_data
);
4232 /* Implementation note: Since move_it_in_display_line
4233 works in the iterator geometry, and thinks the first
4234 character is always the leftmost, even in R2L lines,
4235 we don't need to distinguish between the R2L and L2R
4237 move_it_in_display_line (&it_copy
, ZV
,
4238 it_copy
.current_x
- 1, MOVE_TO_X
);
4239 pos
= it_copy
.current
.pos
;
4240 RESTORE_IT (it
, it
, it_copy_data
);
4244 /* Set charpos to the buffer position of the character
4245 that comes after IT's current position in the visual
4247 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4251 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4254 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4257 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4259 /* Determine face for CHARSET_ASCII, or unibyte. */
4260 face_id
= face_at_buffer_position (it
->w
,
4262 &next_check_charpos
,
4265 /* Correct the face for charsets different from ASCII. Do it
4266 for the multibyte case only. The face returned above is
4267 suitable for unibyte text if current_buffer is unibyte. */
4268 if (it
->multibyte_p
)
4270 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4271 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4272 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4281 /***********************************************************************
4283 ***********************************************************************/
4285 /* Set up iterator IT from invisible properties at its current
4286 position. Called from handle_stop. */
4288 static enum prop_handled
4289 handle_invisible_prop (struct it
*it
)
4291 enum prop_handled handled
= HANDLED_NORMALLY
;
4295 if (STRINGP (it
->string
))
4297 Lisp_Object end_charpos
, limit
, charpos
;
4299 /* Get the value of the invisible text property at the
4300 current position. Value will be nil if there is no such
4302 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4303 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4304 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4306 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4308 /* Record whether we have to display an ellipsis for the
4310 int display_ellipsis_p
= (invis_p
== 2);
4311 ptrdiff_t len
, endpos
;
4313 handled
= HANDLED_RECOMPUTE_PROPS
;
4315 /* Get the position at which the next visible text can be
4316 found in IT->string, if any. */
4317 endpos
= len
= SCHARS (it
->string
);
4318 XSETINT (limit
, len
);
4321 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4323 if (INTEGERP (end_charpos
))
4325 endpos
= XFASTINT (end_charpos
);
4326 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4327 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4329 display_ellipsis_p
= true;
4332 while (invis_p
&& endpos
< len
);
4334 if (display_ellipsis_p
)
4335 it
->ellipsis_p
= true;
4339 /* Text at END_CHARPOS is visible. Move IT there. */
4340 struct text_pos old
;
4343 old
= it
->current
.string_pos
;
4344 oldpos
= CHARPOS (old
);
4347 if (it
->bidi_it
.first_elt
4348 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4349 bidi_paragraph_init (it
->paragraph_embedding
,
4351 /* Bidi-iterate out of the invisible text. */
4354 bidi_move_to_visually_next (&it
->bidi_it
);
4356 while (oldpos
<= it
->bidi_it
.charpos
4357 && it
->bidi_it
.charpos
< endpos
);
4359 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4360 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4361 if (IT_CHARPOS (*it
) >= endpos
)
4362 it
->prev_stop
= endpos
;
4366 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4367 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4372 /* The rest of the string is invisible. If this is an
4373 overlay string, proceed with the next overlay string
4374 or whatever comes and return a character from there. */
4375 if (it
->current
.overlay_string_index
>= 0
4376 && !display_ellipsis_p
)
4378 next_overlay_string (it
);
4379 /* Don't check for overlay strings when we just
4380 finished processing them. */
4381 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4385 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4386 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4393 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4394 Lisp_Object pos
, overlay
;
4396 /* First of all, is there invisible text at this position? */
4397 tem
= start_charpos
= IT_CHARPOS (*it
);
4398 pos
= make_number (tem
);
4399 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4401 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4403 /* If we are on invisible text, skip over it. */
4404 if (invis_p
&& start_charpos
< it
->end_charpos
)
4406 /* Record whether we have to display an ellipsis for the
4408 int display_ellipsis_p
= invis_p
== 2;
4410 handled
= HANDLED_RECOMPUTE_PROPS
;
4412 /* Loop skipping over invisible text. The loop is left at
4413 ZV or with IT on the first char being visible again. */
4416 /* Try to skip some invisible text. Return value is the
4417 position reached which can be equal to where we start
4418 if there is nothing invisible there. This skips both
4419 over invisible text properties and overlays with
4420 invisible property. */
4421 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4423 /* If we skipped nothing at all we weren't at invisible
4424 text in the first place. If everything to the end of
4425 the buffer was skipped, end the loop. */
4426 if (newpos
== tem
|| newpos
>= ZV
)
4430 /* We skipped some characters but not necessarily
4431 all there are. Check if we ended up on visible
4432 text. Fget_char_property returns the property of
4433 the char before the given position, i.e. if we
4434 get invis_p = 0, this means that the char at
4435 newpos is visible. */
4436 pos
= make_number (newpos
);
4437 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4438 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4441 /* If we ended up on invisible text, proceed to
4442 skip starting with next_stop. */
4446 /* If there are adjacent invisible texts, don't lose the
4447 second one's ellipsis. */
4449 display_ellipsis_p
= true;
4453 /* The position newpos is now either ZV or on visible text. */
4456 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4458 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4460 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4462 /* If the invisible text ends on a newline or on a
4463 character after a newline, we can avoid the costly,
4464 character by character, bidi iteration to NEWPOS, and
4465 instead simply reseat the iterator there. That's
4466 because all bidi reordering information is tossed at
4467 the newline. This is a big win for modes that hide
4468 complete lines, like Outline, Org, etc. */
4469 if (on_newline
|| after_newline
)
4471 struct text_pos tpos
;
4472 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4474 SET_TEXT_POS (tpos
, newpos
, bpos
);
4475 reseat_1 (it
, tpos
, 0);
4476 /* If we reseat on a newline/ZV, we need to prep the
4477 bidi iterator for advancing to the next character
4478 after the newline/EOB, keeping the current paragraph
4479 direction (so that PRODUCE_GLYPHS does TRT wrt
4480 prepending/appending glyphs to a glyph row). */
4483 it
->bidi_it
.first_elt
= 0;
4484 it
->bidi_it
.paragraph_dir
= pdir
;
4485 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4486 it
->bidi_it
.nchars
= 1;
4487 it
->bidi_it
.ch_len
= 1;
4490 else /* Must use the slow method. */
4492 /* With bidi iteration, the region of invisible text
4493 could start and/or end in the middle of a
4494 non-base embedding level. Therefore, we need to
4495 skip invisible text using the bidi iterator,
4496 starting at IT's current position, until we find
4497 ourselves outside of the invisible text.
4498 Skipping invisible text _after_ bidi iteration
4499 avoids affecting the visual order of the
4500 displayed text when invisible properties are
4501 added or removed. */
4502 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4504 /* If we were `reseat'ed to a new paragraph,
4505 determine the paragraph base direction. We
4506 need to do it now because
4507 next_element_from_buffer may not have a
4508 chance to do it, if we are going to skip any
4509 text at the beginning, which resets the
4511 bidi_paragraph_init (it
->paragraph_embedding
,
4516 bidi_move_to_visually_next (&it
->bidi_it
);
4518 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4519 && it
->bidi_it
.charpos
< newpos
);
4520 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4521 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4522 /* If we overstepped NEWPOS, record its position in
4523 the iterator, so that we skip invisible text if
4524 later the bidi iteration lands us in the
4525 invisible region again. */
4526 if (IT_CHARPOS (*it
) >= newpos
)
4527 it
->prev_stop
= newpos
;
4532 IT_CHARPOS (*it
) = newpos
;
4533 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4536 /* If there are before-strings at the start of invisible
4537 text, and the text is invisible because of a text
4538 property, arrange to show before-strings because 20.x did
4539 it that way. (If the text is invisible because of an
4540 overlay property instead of a text property, this is
4541 already handled in the overlay code.) */
4543 && get_overlay_strings (it
, it
->stop_charpos
))
4545 handled
= HANDLED_RECOMPUTE_PROPS
;
4546 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4548 else if (display_ellipsis_p
)
4550 /* Make sure that the glyphs of the ellipsis will get
4551 correct `charpos' values. If we would not update
4552 it->position here, the glyphs would belong to the
4553 last visible character _before_ the invisible
4554 text, which confuses `set_cursor_from_row'.
4556 We use the last invisible position instead of the
4557 first because this way the cursor is always drawn on
4558 the first "." of the ellipsis, whenever PT is inside
4559 the invisible text. Otherwise the cursor would be
4560 placed _after_ the ellipsis when the point is after the
4561 first invisible character. */
4562 if (!STRINGP (it
->object
))
4564 it
->position
.charpos
= newpos
- 1;
4565 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4567 it
->ellipsis_p
= true;
4568 /* Let the ellipsis display before
4569 considering any properties of the following char.
4570 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4571 handled
= HANDLED_RETURN
;
4580 /* Make iterator IT return `...' next.
4581 Replaces LEN characters from buffer. */
4584 setup_for_ellipsis (struct it
*it
, int len
)
4586 /* Use the display table definition for `...'. Invalid glyphs
4587 will be handled by the method returning elements from dpvec. */
4588 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4590 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4591 it
->dpvec
= v
->contents
;
4592 it
->dpend
= v
->contents
+ v
->header
.size
;
4596 /* Default `...'. */
4597 it
->dpvec
= default_invis_vector
;
4598 it
->dpend
= default_invis_vector
+ 3;
4601 it
->dpvec_char_len
= len
;
4602 it
->current
.dpvec_index
= 0;
4603 it
->dpvec_face_id
= -1;
4605 /* Remember the current face id in case glyphs specify faces.
4606 IT's face is restored in set_iterator_to_next.
4607 saved_face_id was set to preceding char's face in handle_stop. */
4608 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4609 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4611 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4612 it
->ellipsis_p
= true;
4617 /***********************************************************************
4619 ***********************************************************************/
4621 /* Set up iterator IT from `display' property at its current position.
4622 Called from handle_stop.
4623 We return HANDLED_RETURN if some part of the display property
4624 overrides the display of the buffer text itself.
4625 Otherwise we return HANDLED_NORMALLY. */
4627 static enum prop_handled
4628 handle_display_prop (struct it
*it
)
4630 Lisp_Object propval
, object
, overlay
;
4631 struct text_pos
*position
;
4633 /* Nonzero if some property replaces the display of the text itself. */
4634 int display_replaced_p
= 0;
4636 if (STRINGP (it
->string
))
4638 object
= it
->string
;
4639 position
= &it
->current
.string_pos
;
4640 bufpos
= CHARPOS (it
->current
.pos
);
4644 XSETWINDOW (object
, it
->w
);
4645 position
= &it
->current
.pos
;
4646 bufpos
= CHARPOS (*position
);
4649 /* Reset those iterator values set from display property values. */
4650 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4651 it
->space_width
= Qnil
;
4652 it
->font_height
= Qnil
;
4655 /* We don't support recursive `display' properties, i.e. string
4656 values that have a string `display' property, that have a string
4657 `display' property etc. */
4658 if (!it
->string_from_display_prop_p
)
4659 it
->area
= TEXT_AREA
;
4661 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4662 Qdisplay
, object
, &overlay
);
4664 return HANDLED_NORMALLY
;
4665 /* Now OVERLAY is the overlay that gave us this property, or nil
4666 if it was a text property. */
4668 if (!STRINGP (it
->string
))
4669 object
= it
->w
->contents
;
4671 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4673 FRAME_WINDOW_P (it
->f
));
4675 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4678 /* Subroutine of handle_display_prop. Returns non-zero if the display
4679 specification in SPEC is a replacing specification, i.e. it would
4680 replace the text covered by `display' property with something else,
4681 such as an image or a display string. If SPEC includes any kind or
4682 `(space ...) specification, the value is 2; this is used by
4683 compute_display_string_pos, which see.
4685 See handle_single_display_spec for documentation of arguments.
4686 frame_window_p is non-zero if the window being redisplayed is on a
4687 GUI frame; this argument is used only if IT is NULL, see below.
4689 IT can be NULL, if this is called by the bidi reordering code
4690 through compute_display_string_pos, which see. In that case, this
4691 function only examines SPEC, but does not otherwise "handle" it, in
4692 the sense that it doesn't set up members of IT from the display
4695 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4696 Lisp_Object overlay
, struct text_pos
*position
,
4697 ptrdiff_t bufpos
, int frame_window_p
)
4699 int replacing_p
= 0;
4703 /* Simple specifications. */
4704 && !EQ (XCAR (spec
), Qimage
)
4705 && !EQ (XCAR (spec
), Qspace
)
4706 && !EQ (XCAR (spec
), Qwhen
)
4707 && !EQ (XCAR (spec
), Qslice
)
4708 && !EQ (XCAR (spec
), Qspace_width
)
4709 && !EQ (XCAR (spec
), Qheight
)
4710 && !EQ (XCAR (spec
), Qraise
)
4711 /* Marginal area specifications. */
4712 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4713 && !EQ (XCAR (spec
), Qleft_fringe
)
4714 && !EQ (XCAR (spec
), Qright_fringe
)
4715 && !NILP (XCAR (spec
)))
4717 for (; CONSP (spec
); spec
= XCDR (spec
))
4719 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4720 overlay
, position
, bufpos
,
4721 replacing_p
, frame_window_p
)))
4724 /* If some text in a string is replaced, `position' no
4725 longer points to the position of `object'. */
4726 if (!it
|| STRINGP (object
))
4731 else if (VECTORP (spec
))
4734 for (i
= 0; i
< ASIZE (spec
); ++i
)
4735 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4736 overlay
, position
, bufpos
,
4737 replacing_p
, frame_window_p
)))
4740 /* If some text in a string is replaced, `position' no
4741 longer points to the position of `object'. */
4742 if (!it
|| STRINGP (object
))
4748 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4749 position
, bufpos
, 0,
4757 /* Value is the position of the end of the `display' property starting
4758 at START_POS in OBJECT. */
4760 static struct text_pos
4761 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4764 struct text_pos end_pos
;
4766 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4767 Qdisplay
, object
, Qnil
);
4768 CHARPOS (end_pos
) = XFASTINT (end
);
4769 if (STRINGP (object
))
4770 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4772 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4778 /* Set up IT from a single `display' property specification SPEC. OBJECT
4779 is the object in which the `display' property was found. *POSITION
4780 is the position in OBJECT at which the `display' property was found.
4781 BUFPOS is the buffer position of OBJECT (different from POSITION if
4782 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4783 previously saw a display specification which already replaced text
4784 display with something else, for example an image; we ignore such
4785 properties after the first one has been processed.
4787 OVERLAY is the overlay this `display' property came from,
4788 or nil if it was a text property.
4790 If SPEC is a `space' or `image' specification, and in some other
4791 cases too, set *POSITION to the position where the `display'
4794 If IT is NULL, only examine the property specification in SPEC, but
4795 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4796 is intended to be displayed in a window on a GUI frame.
4798 Value is non-zero if something was found which replaces the display
4799 of buffer or string text. */
4802 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4803 Lisp_Object overlay
, struct text_pos
*position
,
4804 ptrdiff_t bufpos
, int display_replaced_p
,
4808 Lisp_Object location
, value
;
4809 struct text_pos start_pos
= *position
;
4812 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4813 If the result is non-nil, use VALUE instead of SPEC. */
4815 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4824 if (!NILP (form
) && !EQ (form
, Qt
))
4827 struct gcpro gcpro1
;
4829 /* Bind `object' to the object having the `display' property, a
4830 buffer or string. Bind `position' to the position in the
4831 object where the property was found, and `buffer-position'
4832 to the current position in the buffer. */
4835 XSETBUFFER (object
, current_buffer
);
4836 specbind (Qobject
, object
);
4837 specbind (Qposition
, make_number (CHARPOS (*position
)));
4838 specbind (Qbuffer_position
, make_number (bufpos
));
4840 form
= safe_eval (form
);
4848 /* Handle `(height HEIGHT)' specifications. */
4850 && EQ (XCAR (spec
), Qheight
)
4851 && CONSP (XCDR (spec
)))
4855 if (!FRAME_WINDOW_P (it
->f
))
4858 it
->font_height
= XCAR (XCDR (spec
));
4859 if (!NILP (it
->font_height
))
4861 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4862 int new_height
= -1;
4864 if (CONSP (it
->font_height
)
4865 && (EQ (XCAR (it
->font_height
), Qplus
)
4866 || EQ (XCAR (it
->font_height
), Qminus
))
4867 && CONSP (XCDR (it
->font_height
))
4868 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4870 /* `(+ N)' or `(- N)' where N is an integer. */
4871 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4872 if (EQ (XCAR (it
->font_height
), Qplus
))
4874 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4876 else if (FUNCTIONP (it
->font_height
))
4878 /* Call function with current height as argument.
4879 Value is the new height. */
4881 height
= safe_call1 (it
->font_height
,
4882 face
->lface
[LFACE_HEIGHT_INDEX
]);
4883 if (NUMBERP (height
))
4884 new_height
= XFLOATINT (height
);
4886 else if (NUMBERP (it
->font_height
))
4888 /* Value is a multiple of the canonical char height. */
4891 f
= FACE_FROM_ID (it
->f
,
4892 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4893 new_height
= (XFLOATINT (it
->font_height
)
4894 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4898 /* Evaluate IT->font_height with `height' bound to the
4899 current specified height to get the new height. */
4902 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4903 value
= safe_eval (it
->font_height
);
4906 if (NUMBERP (value
))
4907 new_height
= XFLOATINT (value
);
4911 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4918 /* Handle `(space-width WIDTH)'. */
4920 && EQ (XCAR (spec
), Qspace_width
)
4921 && CONSP (XCDR (spec
)))
4925 if (!FRAME_WINDOW_P (it
->f
))
4928 value
= XCAR (XCDR (spec
));
4929 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
4930 it
->space_width
= value
;
4936 /* Handle `(slice X Y WIDTH HEIGHT)'. */
4938 && EQ (XCAR (spec
), Qslice
))
4944 if (!FRAME_WINDOW_P (it
->f
))
4947 if (tem
= XCDR (spec
), CONSP (tem
))
4949 it
->slice
.x
= XCAR (tem
);
4950 if (tem
= XCDR (tem
), CONSP (tem
))
4952 it
->slice
.y
= XCAR (tem
);
4953 if (tem
= XCDR (tem
), CONSP (tem
))
4955 it
->slice
.width
= XCAR (tem
);
4956 if (tem
= XCDR (tem
), CONSP (tem
))
4957 it
->slice
.height
= XCAR (tem
);
4966 /* Handle `(raise FACTOR)'. */
4968 && EQ (XCAR (spec
), Qraise
)
4969 && CONSP (XCDR (spec
)))
4973 if (!FRAME_WINDOW_P (it
->f
))
4976 #ifdef HAVE_WINDOW_SYSTEM
4977 value
= XCAR (XCDR (spec
));
4978 if (NUMBERP (value
))
4980 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4981 it
->voffset
= - (XFLOATINT (value
)
4982 * (FONT_HEIGHT (face
->font
)));
4984 #endif /* HAVE_WINDOW_SYSTEM */
4990 /* Don't handle the other kinds of display specifications
4991 inside a string that we got from a `display' property. */
4992 if (it
&& it
->string_from_display_prop_p
)
4995 /* Characters having this form of property are not displayed, so
4996 we have to find the end of the property. */
4999 start_pos
= *position
;
5000 *position
= display_prop_end (it
, object
, start_pos
);
5004 /* Stop the scan at that end position--we assume that all
5005 text properties change there. */
5007 it
->stop_charpos
= position
->charpos
;
5009 /* Handle `(left-fringe BITMAP [FACE])'
5010 and `(right-fringe BITMAP [FACE])'. */
5012 && (EQ (XCAR (spec
), Qleft_fringe
)
5013 || EQ (XCAR (spec
), Qright_fringe
))
5014 && CONSP (XCDR (spec
)))
5020 if (!FRAME_WINDOW_P (it
->f
))
5021 /* If we return here, POSITION has been advanced
5022 across the text with this property. */
5024 /* Synchronize the bidi iterator with POSITION. This is
5025 needed because we are not going to push the iterator
5026 on behalf of this display property, so there will be
5027 no pop_it call to do this synchronization for us. */
5030 it
->position
= *position
;
5031 iterate_out_of_display_property (it
);
5032 *position
= it
->position
;
5037 else if (!frame_window_p
)
5040 #ifdef HAVE_WINDOW_SYSTEM
5041 value
= XCAR (XCDR (spec
));
5042 if (!SYMBOLP (value
)
5043 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5044 /* If we return here, POSITION has been advanced
5045 across the text with this property. */
5047 if (it
&& it
->bidi_p
)
5049 it
->position
= *position
;
5050 iterate_out_of_display_property (it
);
5051 *position
= it
->position
;
5058 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);;
5060 if (CONSP (XCDR (XCDR (spec
))))
5062 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5063 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5069 /* Save current settings of IT so that we can restore them
5070 when we are finished with the glyph property value. */
5071 push_it (it
, position
);
5073 it
->area
= TEXT_AREA
;
5074 it
->what
= IT_IMAGE
;
5075 it
->image_id
= -1; /* no image */
5076 it
->position
= start_pos
;
5077 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5078 it
->method
= GET_FROM_IMAGE
;
5079 it
->from_overlay
= Qnil
;
5080 it
->face_id
= face_id
;
5081 it
->from_disp_prop_p
= true;
5083 /* Say that we haven't consumed the characters with
5084 `display' property yet. The call to pop_it in
5085 set_iterator_to_next will clean this up. */
5086 *position
= start_pos
;
5088 if (EQ (XCAR (spec
), Qleft_fringe
))
5090 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5091 it
->left_user_fringe_face_id
= face_id
;
5095 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5096 it
->right_user_fringe_face_id
= face_id
;
5099 #endif /* HAVE_WINDOW_SYSTEM */
5103 /* Prepare to handle `((margin left-margin) ...)',
5104 `((margin right-margin) ...)' and `((margin nil) ...)'
5105 prefixes for display specifications. */
5106 location
= Qunbound
;
5107 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5111 value
= XCDR (spec
);
5113 value
= XCAR (value
);
5116 if (EQ (XCAR (tem
), Qmargin
)
5117 && (tem
= XCDR (tem
),
5118 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5120 || EQ (tem
, Qleft_margin
)
5121 || EQ (tem
, Qright_margin
))))
5125 if (EQ (location
, Qunbound
))
5131 /* After this point, VALUE is the property after any
5132 margin prefix has been stripped. It must be a string,
5133 an image specification, or `(space ...)'.
5135 LOCATION specifies where to display: `left-margin',
5136 `right-margin' or nil. */
5138 valid_p
= (STRINGP (value
)
5139 #ifdef HAVE_WINDOW_SYSTEM
5140 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5141 && valid_image_p (value
))
5142 #endif /* not HAVE_WINDOW_SYSTEM */
5143 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5145 if (valid_p
&& !display_replaced_p
)
5151 /* Callers need to know whether the display spec is any kind
5152 of `(space ...)' spec that is about to affect text-area
5154 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5159 /* Save current settings of IT so that we can restore them
5160 when we are finished with the glyph property value. */
5161 push_it (it
, position
);
5162 it
->from_overlay
= overlay
;
5163 it
->from_disp_prop_p
= true;
5165 if (NILP (location
))
5166 it
->area
= TEXT_AREA
;
5167 else if (EQ (location
, Qleft_margin
))
5168 it
->area
= LEFT_MARGIN_AREA
;
5170 it
->area
= RIGHT_MARGIN_AREA
;
5172 if (STRINGP (value
))
5175 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5176 it
->current
.overlay_string_index
= -1;
5177 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5178 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5179 it
->method
= GET_FROM_STRING
;
5180 it
->stop_charpos
= 0;
5182 it
->base_level_stop
= 0;
5183 it
->string_from_display_prop_p
= true;
5184 /* Say that we haven't consumed the characters with
5185 `display' property yet. The call to pop_it in
5186 set_iterator_to_next will clean this up. */
5187 if (BUFFERP (object
))
5188 *position
= start_pos
;
5190 /* Force paragraph direction to be that of the parent
5191 object. If the parent object's paragraph direction is
5192 not yet determined, default to L2R. */
5193 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5194 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5196 it
->paragraph_embedding
= L2R
;
5198 /* Set up the bidi iterator for this display string. */
5201 it
->bidi_it
.string
.lstring
= it
->string
;
5202 it
->bidi_it
.string
.s
= NULL
;
5203 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5204 it
->bidi_it
.string
.bufpos
= bufpos
;
5205 it
->bidi_it
.string
.from_disp_str
= 1;
5206 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5207 it
->bidi_it
.w
= it
->w
;
5208 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5211 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5213 it
->method
= GET_FROM_STRETCH
;
5215 *position
= it
->position
= start_pos
;
5216 retval
= 1 + (it
->area
== TEXT_AREA
);
5218 #ifdef HAVE_WINDOW_SYSTEM
5221 it
->what
= IT_IMAGE
;
5222 it
->image_id
= lookup_image (it
->f
, value
);
5223 it
->position
= start_pos
;
5224 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5225 it
->method
= GET_FROM_IMAGE
;
5227 /* Say that we haven't consumed the characters with
5228 `display' property yet. The call to pop_it in
5229 set_iterator_to_next will clean this up. */
5230 *position
= start_pos
;
5232 #endif /* HAVE_WINDOW_SYSTEM */
5237 /* Invalid property or property not supported. Restore
5238 POSITION to what it was before. */
5239 *position
= start_pos
;
5243 /* Check if PROP is a display property value whose text should be
5244 treated as intangible. OVERLAY is the overlay from which PROP
5245 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5246 specify the buffer position covered by PROP. */
5249 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5250 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5252 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5253 struct text_pos position
;
5255 SET_TEXT_POS (position
, charpos
, bytepos
);
5256 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5257 &position
, charpos
, frame_window_p
);
5261 /* Return 1 if PROP is a display sub-property value containing STRING.
5263 Implementation note: this and the following function are really
5264 special cases of handle_display_spec and
5265 handle_single_display_spec, and should ideally use the same code.
5266 Until they do, these two pairs must be consistent and must be
5267 modified in sync. */
5270 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5272 if (EQ (string
, prop
))
5275 /* Skip over `when FORM'. */
5276 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5281 /* Actually, the condition following `when' should be eval'ed,
5282 like handle_single_display_spec does, and we should return
5283 zero if it evaluates to nil. However, this function is
5284 called only when the buffer was already displayed and some
5285 glyph in the glyph matrix was found to come from a display
5286 string. Therefore, the condition was already evaluated, and
5287 the result was non-nil, otherwise the display string wouldn't
5288 have been displayed and we would have never been called for
5289 this property. Thus, we can skip the evaluation and assume
5290 its result is non-nil. */
5295 /* Skip over `margin LOCATION'. */
5296 if (EQ (XCAR (prop
), Qmargin
))
5307 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5311 /* Return 1 if STRING appears in the `display' property PROP. */
5314 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5317 && !EQ (XCAR (prop
), Qwhen
)
5318 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5320 /* A list of sub-properties. */
5321 while (CONSP (prop
))
5323 if (single_display_spec_string_p (XCAR (prop
), string
))
5328 else if (VECTORP (prop
))
5330 /* A vector of sub-properties. */
5332 for (i
= 0; i
< ASIZE (prop
); ++i
)
5333 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5337 return single_display_spec_string_p (prop
, string
);
5342 /* Look for STRING in overlays and text properties in the current
5343 buffer, between character positions FROM and TO (excluding TO).
5344 BACK_P non-zero means look back (in this case, TO is supposed to be
5346 Value is the first character position where STRING was found, or
5347 zero if it wasn't found before hitting TO.
5349 This function may only use code that doesn't eval because it is
5350 called asynchronously from note_mouse_highlight. */
5353 string_buffer_position_lim (Lisp_Object string
,
5354 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5356 Lisp_Object limit
, prop
, pos
;
5359 pos
= make_number (max (from
, BEGV
));
5361 if (!back_p
) /* looking forward */
5363 limit
= make_number (min (to
, ZV
));
5364 while (!found
&& !EQ (pos
, limit
))
5366 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5367 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5370 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5374 else /* looking back */
5376 limit
= make_number (max (to
, BEGV
));
5377 while (!found
&& !EQ (pos
, limit
))
5379 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5380 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5383 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5388 return found
? XINT (pos
) : 0;
5391 /* Determine which buffer position in current buffer STRING comes from.
5392 AROUND_CHARPOS is an approximate position where it could come from.
5393 Value is the buffer position or 0 if it couldn't be determined.
5395 This function is necessary because we don't record buffer positions
5396 in glyphs generated from strings (to keep struct glyph small).
5397 This function may only use code that doesn't eval because it is
5398 called asynchronously from note_mouse_highlight. */
5401 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5403 const int MAX_DISTANCE
= 1000;
5404 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5405 around_charpos
+ MAX_DISTANCE
,
5409 found
= string_buffer_position_lim (string
, around_charpos
,
5410 around_charpos
- MAX_DISTANCE
, 1);
5416 /***********************************************************************
5417 `composition' property
5418 ***********************************************************************/
5420 /* Set up iterator IT from `composition' property at its current
5421 position. Called from handle_stop. */
5423 static enum prop_handled
5424 handle_composition_prop (struct it
*it
)
5426 Lisp_Object prop
, string
;
5427 ptrdiff_t pos
, pos_byte
, start
, end
;
5429 if (STRINGP (it
->string
))
5433 pos
= IT_STRING_CHARPOS (*it
);
5434 pos_byte
= IT_STRING_BYTEPOS (*it
);
5435 string
= it
->string
;
5436 s
= SDATA (string
) + pos_byte
;
5437 it
->c
= STRING_CHAR (s
);
5441 pos
= IT_CHARPOS (*it
);
5442 pos_byte
= IT_BYTEPOS (*it
);
5444 it
->c
= FETCH_CHAR (pos_byte
);
5447 /* If there's a valid composition and point is not inside of the
5448 composition (in the case that the composition is from the current
5449 buffer), draw a glyph composed from the composition components. */
5450 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5451 && composition_valid_p (start
, end
, prop
)
5452 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5455 /* As we can't handle this situation (perhaps font-lock added
5456 a new composition), we just return here hoping that next
5457 redisplay will detect this composition much earlier. */
5458 return HANDLED_NORMALLY
;
5461 if (STRINGP (it
->string
))
5462 pos_byte
= string_char_to_byte (it
->string
, start
);
5464 pos_byte
= CHAR_TO_BYTE (start
);
5466 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5469 if (it
->cmp_it
.id
>= 0)
5472 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5473 it
->cmp_it
.nglyphs
= -1;
5477 return HANDLED_NORMALLY
;
5482 /***********************************************************************
5484 ***********************************************************************/
5486 /* The following structure is used to record overlay strings for
5487 later sorting in load_overlay_strings. */
5489 struct overlay_entry
5491 Lisp_Object overlay
;
5498 /* Set up iterator IT from overlay strings at its current position.
5499 Called from handle_stop. */
5501 static enum prop_handled
5502 handle_overlay_change (struct it
*it
)
5504 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5505 return HANDLED_RECOMPUTE_PROPS
;
5507 return HANDLED_NORMALLY
;
5511 /* Set up the next overlay string for delivery by IT, if there is an
5512 overlay string to deliver. Called by set_iterator_to_next when the
5513 end of the current overlay string is reached. If there are more
5514 overlay strings to display, IT->string and
5515 IT->current.overlay_string_index are set appropriately here.
5516 Otherwise IT->string is set to nil. */
5519 next_overlay_string (struct it
*it
)
5521 ++it
->current
.overlay_string_index
;
5522 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5524 /* No more overlay strings. Restore IT's settings to what
5525 they were before overlay strings were processed, and
5526 continue to deliver from current_buffer. */
5528 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5531 || (NILP (it
->string
)
5532 && it
->method
== GET_FROM_BUFFER
5533 && it
->stop_charpos
>= BEGV
5534 && it
->stop_charpos
<= it
->end_charpos
));
5535 it
->current
.overlay_string_index
= -1;
5536 it
->n_overlay_strings
= 0;
5537 it
->overlay_strings_charpos
= -1;
5538 /* If there's an empty display string on the stack, pop the
5539 stack, to resync the bidi iterator with IT's position. Such
5540 empty strings are pushed onto the stack in
5541 get_overlay_strings_1. */
5542 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5545 /* If we're at the end of the buffer, record that we have
5546 processed the overlay strings there already, so that
5547 next_element_from_buffer doesn't try it again. */
5548 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5549 it
->overlay_strings_at_end_processed_p
= true;
5553 /* There are more overlay strings to process. If
5554 IT->current.overlay_string_index has advanced to a position
5555 where we must load IT->overlay_strings with more strings, do
5556 it. We must load at the IT->overlay_strings_charpos where
5557 IT->n_overlay_strings was originally computed; when invisible
5558 text is present, this might not be IT_CHARPOS (Bug#7016). */
5559 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5561 if (it
->current
.overlay_string_index
&& i
== 0)
5562 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5564 /* Initialize IT to deliver display elements from the overlay
5566 it
->string
= it
->overlay_strings
[i
];
5567 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5568 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5569 it
->method
= GET_FROM_STRING
;
5570 it
->stop_charpos
= 0;
5571 it
->end_charpos
= SCHARS (it
->string
);
5572 if (it
->cmp_it
.stop_pos
>= 0)
5573 it
->cmp_it
.stop_pos
= 0;
5575 it
->base_level_stop
= 0;
5577 /* Set up the bidi iterator for this overlay string. */
5580 it
->bidi_it
.string
.lstring
= it
->string
;
5581 it
->bidi_it
.string
.s
= NULL
;
5582 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5583 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5584 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5585 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5586 it
->bidi_it
.w
= it
->w
;
5587 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5595 /* Compare two overlay_entry structures E1 and E2. Used as a
5596 comparison function for qsort in load_overlay_strings. Overlay
5597 strings for the same position are sorted so that
5599 1. All after-strings come in front of before-strings, except
5600 when they come from the same overlay.
5602 2. Within after-strings, strings are sorted so that overlay strings
5603 from overlays with higher priorities come first.
5605 2. Within before-strings, strings are sorted so that overlay
5606 strings from overlays with higher priorities come last.
5608 Value is analogous to strcmp. */
5612 compare_overlay_entries (const void *e1
, const void *e2
)
5614 struct overlay_entry
const *entry1
= e1
;
5615 struct overlay_entry
const *entry2
= e2
;
5618 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5620 /* Let after-strings appear in front of before-strings if
5621 they come from different overlays. */
5622 if (EQ (entry1
->overlay
, entry2
->overlay
))
5623 result
= entry1
->after_string_p
? 1 : -1;
5625 result
= entry1
->after_string_p
? -1 : 1;
5627 else if (entry1
->priority
!= entry2
->priority
)
5629 if (entry1
->after_string_p
)
5630 /* After-strings sorted in order of decreasing priority. */
5631 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5633 /* Before-strings sorted in order of increasing priority. */
5634 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5643 /* Load the vector IT->overlay_strings with overlay strings from IT's
5644 current buffer position, or from CHARPOS if that is > 0. Set
5645 IT->n_overlays to the total number of overlay strings found.
5647 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5648 a time. On entry into load_overlay_strings,
5649 IT->current.overlay_string_index gives the number of overlay
5650 strings that have already been loaded by previous calls to this
5653 IT->add_overlay_start contains an additional overlay start
5654 position to consider for taking overlay strings from, if non-zero.
5655 This position comes into play when the overlay has an `invisible'
5656 property, and both before and after-strings. When we've skipped to
5657 the end of the overlay, because of its `invisible' property, we
5658 nevertheless want its before-string to appear.
5659 IT->add_overlay_start will contain the overlay start position
5662 Overlay strings are sorted so that after-string strings come in
5663 front of before-string strings. Within before and after-strings,
5664 strings are sorted by overlay priority. See also function
5665 compare_overlay_entries. */
5668 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5670 Lisp_Object overlay
, window
, str
, invisible
;
5671 struct Lisp_Overlay
*ov
;
5672 ptrdiff_t start
, end
;
5673 ptrdiff_t size
= 20;
5674 ptrdiff_t n
= 0, i
, j
;
5676 struct overlay_entry
*entries
= alloca (size
* sizeof *entries
);
5680 charpos
= IT_CHARPOS (*it
);
5682 /* Append the overlay string STRING of overlay OVERLAY to vector
5683 `entries' which has size `size' and currently contains `n'
5684 elements. AFTER_P non-zero means STRING is an after-string of
5686 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5689 Lisp_Object priority; \
5693 struct overlay_entry *old = entries; \
5694 SAFE_NALLOCA (entries, 2, size); \
5695 memcpy (entries, old, size * sizeof *entries); \
5699 entries[n].string = (STRING); \
5700 entries[n].overlay = (OVERLAY); \
5701 priority = Foverlay_get ((OVERLAY), Qpriority); \
5702 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5703 entries[n].after_string_p = (AFTER_P); \
5708 /* Process overlay before the overlay center. */
5709 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5711 XSETMISC (overlay
, ov
);
5712 eassert (OVERLAYP (overlay
));
5713 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5714 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5719 /* Skip this overlay if it doesn't start or end at IT's current
5721 if (end
!= charpos
&& start
!= charpos
)
5724 /* Skip this overlay if it doesn't apply to IT->w. */
5725 window
= Foverlay_get (overlay
, Qwindow
);
5726 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5729 /* If the text ``under'' the overlay is invisible, both before-
5730 and after-strings from this overlay are visible; start and
5731 end position are indistinguishable. */
5732 invisible
= Foverlay_get (overlay
, Qinvisible
);
5733 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5735 /* If overlay has a non-empty before-string, record it. */
5736 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5737 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5739 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5741 /* If overlay has a non-empty after-string, record it. */
5742 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5743 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5745 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5748 /* Process overlays after the overlay center. */
5749 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5751 XSETMISC (overlay
, ov
);
5752 eassert (OVERLAYP (overlay
));
5753 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5754 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5756 if (start
> charpos
)
5759 /* Skip this overlay if it doesn't start or end at IT's current
5761 if (end
!= charpos
&& start
!= charpos
)
5764 /* Skip this overlay if it doesn't apply to IT->w. */
5765 window
= Foverlay_get (overlay
, Qwindow
);
5766 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5769 /* If the text ``under'' the overlay is invisible, it has a zero
5770 dimension, and both before- and after-strings apply. */
5771 invisible
= Foverlay_get (overlay
, Qinvisible
);
5772 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5774 /* If overlay has a non-empty before-string, record it. */
5775 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5776 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5778 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5780 /* If overlay has a non-empty after-string, record it. */
5781 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5782 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5784 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5787 #undef RECORD_OVERLAY_STRING
5791 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5793 /* Record number of overlay strings, and where we computed it. */
5794 it
->n_overlay_strings
= n
;
5795 it
->overlay_strings_charpos
= charpos
;
5797 /* IT->current.overlay_string_index is the number of overlay strings
5798 that have already been consumed by IT. Copy some of the
5799 remaining overlay strings to IT->overlay_strings. */
5801 j
= it
->current
.overlay_string_index
;
5802 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5804 it
->overlay_strings
[i
] = entries
[j
].string
;
5805 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5813 /* Get the first chunk of overlay strings at IT's current buffer
5814 position, or at CHARPOS if that is > 0. Value is non-zero if at
5815 least one overlay string was found. */
5818 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5820 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5821 process. This fills IT->overlay_strings with strings, and sets
5822 IT->n_overlay_strings to the total number of strings to process.
5823 IT->pos.overlay_string_index has to be set temporarily to zero
5824 because load_overlay_strings needs this; it must be set to -1
5825 when no overlay strings are found because a zero value would
5826 indicate a position in the first overlay string. */
5827 it
->current
.overlay_string_index
= 0;
5828 load_overlay_strings (it
, charpos
);
5830 /* If we found overlay strings, set up IT to deliver display
5831 elements from the first one. Otherwise set up IT to deliver
5832 from current_buffer. */
5833 if (it
->n_overlay_strings
)
5835 /* Make sure we know settings in current_buffer, so that we can
5836 restore meaningful values when we're done with the overlay
5839 compute_stop_pos (it
);
5840 eassert (it
->face_id
>= 0);
5842 /* Save IT's settings. They are restored after all overlay
5843 strings have been processed. */
5844 eassert (!compute_stop_p
|| it
->sp
== 0);
5846 /* When called from handle_stop, there might be an empty display
5847 string loaded. In that case, don't bother saving it. But
5848 don't use this optimization with the bidi iterator, since we
5849 need the corresponding pop_it call to resync the bidi
5850 iterator's position with IT's position, after we are done
5851 with the overlay strings. (The corresponding call to pop_it
5852 in case of an empty display string is in
5853 next_overlay_string.) */
5855 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5858 /* Set up IT to deliver display elements from the first overlay
5860 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5861 it
->string
= it
->overlay_strings
[0];
5862 it
->from_overlay
= Qnil
;
5863 it
->stop_charpos
= 0;
5864 eassert (STRINGP (it
->string
));
5865 it
->end_charpos
= SCHARS (it
->string
);
5867 it
->base_level_stop
= 0;
5868 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5869 it
->method
= GET_FROM_STRING
;
5870 it
->from_disp_prop_p
= 0;
5872 /* Force paragraph direction to be that of the parent
5874 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5875 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5877 it
->paragraph_embedding
= L2R
;
5879 /* Set up the bidi iterator for this overlay string. */
5882 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5884 it
->bidi_it
.string
.lstring
= it
->string
;
5885 it
->bidi_it
.string
.s
= NULL
;
5886 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5887 it
->bidi_it
.string
.bufpos
= pos
;
5888 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5889 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5890 it
->bidi_it
.w
= it
->w
;
5891 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5896 it
->current
.overlay_string_index
= -1;
5901 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5904 it
->method
= GET_FROM_BUFFER
;
5906 (void) get_overlay_strings_1 (it
, charpos
, 1);
5910 /* Value is non-zero if we found at least one overlay string. */
5911 return STRINGP (it
->string
);
5916 /***********************************************************************
5917 Saving and restoring state
5918 ***********************************************************************/
5920 /* Save current settings of IT on IT->stack. Called, for example,
5921 before setting up IT for an overlay string, to be able to restore
5922 IT's settings to what they were after the overlay string has been
5923 processed. If POSITION is non-NULL, it is the position to save on
5924 the stack instead of IT->position. */
5927 push_it (struct it
*it
, struct text_pos
*position
)
5929 struct iterator_stack_entry
*p
;
5931 eassert (it
->sp
< IT_STACK_SIZE
);
5932 p
= it
->stack
+ it
->sp
;
5934 p
->stop_charpos
= it
->stop_charpos
;
5935 p
->prev_stop
= it
->prev_stop
;
5936 p
->base_level_stop
= it
->base_level_stop
;
5937 p
->cmp_it
= it
->cmp_it
;
5938 eassert (it
->face_id
>= 0);
5939 p
->face_id
= it
->face_id
;
5940 p
->string
= it
->string
;
5941 p
->method
= it
->method
;
5942 p
->from_overlay
= it
->from_overlay
;
5945 case GET_FROM_IMAGE
:
5946 p
->u
.image
.object
= it
->object
;
5947 p
->u
.image
.image_id
= it
->image_id
;
5948 p
->u
.image
.slice
= it
->slice
;
5950 case GET_FROM_STRETCH
:
5951 p
->u
.stretch
.object
= it
->object
;
5954 p
->position
= position
? *position
: it
->position
;
5955 p
->current
= it
->current
;
5956 p
->end_charpos
= it
->end_charpos
;
5957 p
->string_nchars
= it
->string_nchars
;
5959 p
->multibyte_p
= it
->multibyte_p
;
5960 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
5961 p
->space_width
= it
->space_width
;
5962 p
->font_height
= it
->font_height
;
5963 p
->voffset
= it
->voffset
;
5964 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
5965 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
5966 p
->display_ellipsis_p
= 0;
5967 p
->line_wrap
= it
->line_wrap
;
5968 p
->bidi_p
= it
->bidi_p
;
5969 p
->paragraph_embedding
= it
->paragraph_embedding
;
5970 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
5973 /* Save the state of the bidi iterator as well. */
5975 bidi_push_it (&it
->bidi_it
);
5979 iterate_out_of_display_property (struct it
*it
)
5981 int buffer_p
= !STRINGP (it
->string
);
5982 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
5983 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
5985 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
5987 /* Maybe initialize paragraph direction. If we are at the beginning
5988 of a new paragraph, next_element_from_buffer may not have a
5989 chance to do that. */
5990 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
5991 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
5992 /* prev_stop can be zero, so check against BEGV as well. */
5993 while (it
->bidi_it
.charpos
>= bob
5994 && it
->prev_stop
<= it
->bidi_it
.charpos
5995 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
5996 && it
->bidi_it
.charpos
< eob
)
5997 bidi_move_to_visually_next (&it
->bidi_it
);
5998 /* Record the stop_pos we just crossed, for when we cross it
6000 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6001 it
->prev_stop
= CHARPOS (it
->position
);
6002 /* If we ended up not where pop_it put us, resync IT's
6003 positional members with the bidi iterator. */
6004 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6005 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6007 it
->current
.pos
= it
->position
;
6009 it
->current
.string_pos
= it
->position
;
6012 /* Restore IT's settings from IT->stack. Called, for example, when no
6013 more overlay strings must be processed, and we return to delivering
6014 display elements from a buffer, or when the end of a string from a
6015 `display' property is reached and we return to delivering display
6016 elements from an overlay string, or from a buffer. */
6019 pop_it (struct it
*it
)
6021 struct iterator_stack_entry
*p
;
6022 int from_display_prop
= it
->from_disp_prop_p
;
6024 eassert (it
->sp
> 0);
6026 p
= it
->stack
+ it
->sp
;
6027 it
->stop_charpos
= p
->stop_charpos
;
6028 it
->prev_stop
= p
->prev_stop
;
6029 it
->base_level_stop
= p
->base_level_stop
;
6030 it
->cmp_it
= p
->cmp_it
;
6031 it
->face_id
= p
->face_id
;
6032 it
->current
= p
->current
;
6033 it
->position
= p
->position
;
6034 it
->string
= p
->string
;
6035 it
->from_overlay
= p
->from_overlay
;
6036 if (NILP (it
->string
))
6037 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6038 it
->method
= p
->method
;
6041 case GET_FROM_IMAGE
:
6042 it
->image_id
= p
->u
.image
.image_id
;
6043 it
->object
= p
->u
.image
.object
;
6044 it
->slice
= p
->u
.image
.slice
;
6046 case GET_FROM_STRETCH
:
6047 it
->object
= p
->u
.stretch
.object
;
6049 case GET_FROM_BUFFER
:
6050 it
->object
= it
->w
->contents
;
6052 case GET_FROM_STRING
:
6054 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6056 /* Restore the face_box_p flag, since it could have been
6057 overwritten by the face of the object that we just finished
6060 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6061 it
->object
= it
->string
;
6064 case GET_FROM_DISPLAY_VECTOR
:
6066 it
->method
= GET_FROM_C_STRING
;
6067 else if (STRINGP (it
->string
))
6068 it
->method
= GET_FROM_STRING
;
6071 it
->method
= GET_FROM_BUFFER
;
6072 it
->object
= it
->w
->contents
;
6075 it
->end_charpos
= p
->end_charpos
;
6076 it
->string_nchars
= p
->string_nchars
;
6078 it
->multibyte_p
= p
->multibyte_p
;
6079 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6080 it
->space_width
= p
->space_width
;
6081 it
->font_height
= p
->font_height
;
6082 it
->voffset
= p
->voffset
;
6083 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6084 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6085 it
->line_wrap
= p
->line_wrap
;
6086 it
->bidi_p
= p
->bidi_p
;
6087 it
->paragraph_embedding
= p
->paragraph_embedding
;
6088 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6091 bidi_pop_it (&it
->bidi_it
);
6092 /* Bidi-iterate until we get out of the portion of text, if any,
6093 covered by a `display' text property or by an overlay with
6094 `display' property. (We cannot just jump there, because the
6095 internal coherency of the bidi iterator state can not be
6096 preserved across such jumps.) We also must determine the
6097 paragraph base direction if the overlay we just processed is
6098 at the beginning of a new paragraph. */
6099 if (from_display_prop
6100 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6101 iterate_out_of_display_property (it
);
6103 eassert ((BUFFERP (it
->object
)
6104 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6105 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6106 || (STRINGP (it
->object
)
6107 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6108 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6109 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6115 /***********************************************************************
6117 ***********************************************************************/
6119 /* Set IT's current position to the previous line start. */
6122 back_to_previous_line_start (struct it
*it
)
6124 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6127 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6131 /* Move IT to the next line start.
6133 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6134 we skipped over part of the text (as opposed to moving the iterator
6135 continuously over the text). Otherwise, don't change the value
6138 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6139 iterator on the newline, if it was found.
6141 Newlines may come from buffer text, overlay strings, or strings
6142 displayed via the `display' property. That's the reason we can't
6143 simply use find_newline_no_quit.
6145 Note that this function may not skip over invisible text that is so
6146 because of text properties and immediately follows a newline. If
6147 it would, function reseat_at_next_visible_line_start, when called
6148 from set_iterator_to_next, would effectively make invisible
6149 characters following a newline part of the wrong glyph row, which
6150 leads to wrong cursor motion. */
6153 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6154 struct bidi_it
*bidi_it_prev
)
6156 ptrdiff_t old_selective
;
6157 int newline_found_p
, n
;
6158 const int MAX_NEWLINE_DISTANCE
= 500;
6160 /* If already on a newline, just consume it to avoid unintended
6161 skipping over invisible text below. */
6162 if (it
->what
== IT_CHARACTER
6164 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6166 if (it
->bidi_p
&& bidi_it_prev
)
6167 *bidi_it_prev
= it
->bidi_it
;
6168 set_iterator_to_next (it
, 0);
6173 /* Don't handle selective display in the following. It's (a)
6174 unnecessary because it's done by the caller, and (b) leads to an
6175 infinite recursion because next_element_from_ellipsis indirectly
6176 calls this function. */
6177 old_selective
= it
->selective
;
6180 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6181 from buffer text. */
6182 for (n
= newline_found_p
= 0;
6183 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6184 n
+= STRINGP (it
->string
) ? 0 : 1)
6186 if (!get_next_display_element (it
))
6188 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6189 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6190 *bidi_it_prev
= it
->bidi_it
;
6191 set_iterator_to_next (it
, 0);
6194 /* If we didn't find a newline near enough, see if we can use a
6196 if (!newline_found_p
)
6198 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6199 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6203 eassert (!STRINGP (it
->string
));
6205 /* If there isn't any `display' property in sight, and no
6206 overlays, we can just use the position of the newline in
6208 if (it
->stop_charpos
>= limit
6209 || ((pos
= Fnext_single_property_change (make_number (start
),
6211 make_number (limit
)),
6213 && next_overlay_change (start
) == ZV
))
6217 IT_CHARPOS (*it
) = limit
;
6218 IT_BYTEPOS (*it
) = bytepos
;
6222 struct bidi_it bprev
;
6224 /* Help bidi.c avoid expensive searches for display
6225 properties and overlays, by telling it that there are
6226 none up to `limit'. */
6227 if (it
->bidi_it
.disp_pos
< limit
)
6229 it
->bidi_it
.disp_pos
= limit
;
6230 it
->bidi_it
.disp_prop
= 0;
6233 bprev
= it
->bidi_it
;
6234 bidi_move_to_visually_next (&it
->bidi_it
);
6235 } while (it
->bidi_it
.charpos
!= limit
);
6236 IT_CHARPOS (*it
) = limit
;
6237 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6239 *bidi_it_prev
= bprev
;
6241 *skipped_p
= newline_found_p
= true;
6245 while (get_next_display_element (it
)
6246 && !newline_found_p
)
6248 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6249 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6250 *bidi_it_prev
= it
->bidi_it
;
6251 set_iterator_to_next (it
, 0);
6256 it
->selective
= old_selective
;
6257 return newline_found_p
;
6261 /* Set IT's current position to the previous visible line start. Skip
6262 invisible text that is so either due to text properties or due to
6263 selective display. Caution: this does not change IT->current_x and
6267 back_to_previous_visible_line_start (struct it
*it
)
6269 while (IT_CHARPOS (*it
) > BEGV
)
6271 back_to_previous_line_start (it
);
6273 if (IT_CHARPOS (*it
) <= BEGV
)
6276 /* If selective > 0, then lines indented more than its value are
6278 if (it
->selective
> 0
6279 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6283 /* Check the newline before point for invisibility. */
6286 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6287 Qinvisible
, it
->window
);
6288 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6292 if (IT_CHARPOS (*it
) <= BEGV
)
6297 void *it2data
= NULL
;
6300 Lisp_Object val
, overlay
;
6302 SAVE_IT (it2
, *it
, it2data
);
6304 /* If newline is part of a composition, continue from start of composition */
6305 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6306 && beg
< IT_CHARPOS (*it
))
6309 /* If newline is replaced by a display property, find start of overlay
6310 or interval and continue search from that point. */
6311 pos
= --IT_CHARPOS (it2
);
6314 bidi_unshelve_cache (NULL
, 0);
6315 it2
.string_from_display_prop_p
= 0;
6316 it2
.from_disp_prop_p
= 0;
6317 if (handle_display_prop (&it2
) == HANDLED_RETURN
6318 && !NILP (val
= get_char_property_and_overlay
6319 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6320 && (OVERLAYP (overlay
)
6321 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6322 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6324 RESTORE_IT (it
, it
, it2data
);
6328 /* Newline is not replaced by anything -- so we are done. */
6329 RESTORE_IT (it
, it
, it2data
);
6335 IT_CHARPOS (*it
) = beg
;
6336 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6340 it
->continuation_lines_width
= 0;
6342 eassert (IT_CHARPOS (*it
) >= BEGV
);
6343 eassert (IT_CHARPOS (*it
) == BEGV
6344 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6349 /* Reseat iterator IT at the previous visible line start. Skip
6350 invisible text that is so either due to text properties or due to
6351 selective display. At the end, update IT's overlay information,
6352 face information etc. */
6355 reseat_at_previous_visible_line_start (struct it
*it
)
6357 back_to_previous_visible_line_start (it
);
6358 reseat (it
, it
->current
.pos
, 1);
6363 /* Reseat iterator IT on the next visible line start in the current
6364 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6365 preceding the line start. Skip over invisible text that is so
6366 because of selective display. Compute faces, overlays etc at the
6367 new position. Note that this function does not skip over text that
6368 is invisible because of text properties. */
6371 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6373 int newline_found_p
, skipped_p
= 0;
6374 struct bidi_it bidi_it_prev
;
6376 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6378 /* Skip over lines that are invisible because they are indented
6379 more than the value of IT->selective. */
6380 if (it
->selective
> 0)
6381 while (IT_CHARPOS (*it
) < ZV
6382 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6385 eassert (IT_BYTEPOS (*it
) == BEGV
6386 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6388 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6391 /* Position on the newline if that's what's requested. */
6392 if (on_newline_p
&& newline_found_p
)
6394 if (STRINGP (it
->string
))
6396 if (IT_STRING_CHARPOS (*it
) > 0)
6400 --IT_STRING_CHARPOS (*it
);
6401 --IT_STRING_BYTEPOS (*it
);
6405 /* We need to restore the bidi iterator to the state
6406 it had on the newline, and resync the IT's
6407 position with that. */
6408 it
->bidi_it
= bidi_it_prev
;
6409 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6410 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6414 else if (IT_CHARPOS (*it
) > BEGV
)
6423 /* We need to restore the bidi iterator to the state it
6424 had on the newline and resync IT with that. */
6425 it
->bidi_it
= bidi_it_prev
;
6426 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6427 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6429 reseat (it
, it
->current
.pos
, 0);
6433 reseat (it
, it
->current
.pos
, 0);
6440 /***********************************************************************
6441 Changing an iterator's position
6442 ***********************************************************************/
6444 /* Change IT's current position to POS in current_buffer. If FORCE_P
6445 is non-zero, always check for text properties at the new position.
6446 Otherwise, text properties are only looked up if POS >=
6447 IT->check_charpos of a property. */
6450 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6452 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6454 reseat_1 (it
, pos
, 0);
6456 /* Determine where to check text properties. Avoid doing it
6457 where possible because text property lookup is very expensive. */
6459 || CHARPOS (pos
) > it
->stop_charpos
6460 || CHARPOS (pos
) < original_pos
)
6464 /* For bidi iteration, we need to prime prev_stop and
6465 base_level_stop with our best estimations. */
6466 /* Implementation note: Of course, POS is not necessarily a
6467 stop position, so assigning prev_pos to it is a lie; we
6468 should have called compute_stop_backwards. However, if
6469 the current buffer does not include any R2L characters,
6470 that call would be a waste of cycles, because the
6471 iterator will never move back, and thus never cross this
6472 "fake" stop position. So we delay that backward search
6473 until the time we really need it, in next_element_from_buffer. */
6474 if (CHARPOS (pos
) != it
->prev_stop
)
6475 it
->prev_stop
= CHARPOS (pos
);
6476 if (CHARPOS (pos
) < it
->base_level_stop
)
6477 it
->base_level_stop
= 0; /* meaning it's unknown */
6483 it
->prev_stop
= it
->base_level_stop
= 0;
6492 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6493 IT->stop_pos to POS, also. */
6496 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6498 /* Don't call this function when scanning a C string. */
6499 eassert (it
->s
== NULL
);
6501 /* POS must be a reasonable value. */
6502 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6504 it
->current
.pos
= it
->position
= pos
;
6505 it
->end_charpos
= ZV
;
6507 it
->current
.dpvec_index
= -1;
6508 it
->current
.overlay_string_index
= -1;
6509 IT_STRING_CHARPOS (*it
) = -1;
6510 IT_STRING_BYTEPOS (*it
) = -1;
6512 it
->method
= GET_FROM_BUFFER
;
6513 it
->object
= it
->w
->contents
;
6514 it
->area
= TEXT_AREA
;
6515 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6517 it
->string_from_display_prop_p
= 0;
6518 it
->string_from_prefix_prop_p
= 0;
6520 it
->from_disp_prop_p
= 0;
6521 it
->face_before_selective_p
= 0;
6524 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6526 bidi_unshelve_cache (NULL
, 0);
6527 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6528 it
->bidi_it
.string
.s
= NULL
;
6529 it
->bidi_it
.string
.lstring
= Qnil
;
6530 it
->bidi_it
.string
.bufpos
= 0;
6531 it
->bidi_it
.string
.from_disp_str
= 0;
6532 it
->bidi_it
.string
.unibyte
= 0;
6533 it
->bidi_it
.w
= it
->w
;
6538 it
->stop_charpos
= CHARPOS (pos
);
6539 it
->base_level_stop
= CHARPOS (pos
);
6541 /* This make the information stored in it->cmp_it invalidate. */
6546 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6547 If S is non-null, it is a C string to iterate over. Otherwise,
6548 STRING gives a Lisp string to iterate over.
6550 If PRECISION > 0, don't return more then PRECISION number of
6551 characters from the string.
6553 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6554 characters have been returned. FIELD_WIDTH < 0 means an infinite
6557 MULTIBYTE = 0 means disable processing of multibyte characters,
6558 MULTIBYTE > 0 means enable it,
6559 MULTIBYTE < 0 means use IT->multibyte_p.
6561 IT must be initialized via a prior call to init_iterator before
6562 calling this function. */
6565 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6566 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6569 /* No text property checks performed by default, but see below. */
6570 it
->stop_charpos
= -1;
6572 /* Set iterator position and end position. */
6573 memset (&it
->current
, 0, sizeof it
->current
);
6574 it
->current
.overlay_string_index
= -1;
6575 it
->current
.dpvec_index
= -1;
6576 eassert (charpos
>= 0);
6578 /* If STRING is specified, use its multibyteness, otherwise use the
6579 setting of MULTIBYTE, if specified. */
6581 it
->multibyte_p
= multibyte
> 0;
6583 /* Bidirectional reordering of strings is controlled by the default
6584 value of bidi-display-reordering. Don't try to reorder while
6585 loading loadup.el, as the necessary character property tables are
6586 not yet available. */
6589 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6593 eassert (STRINGP (string
));
6594 it
->string
= string
;
6596 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6597 it
->method
= GET_FROM_STRING
;
6598 it
->current
.string_pos
= string_pos (charpos
, string
);
6602 it
->bidi_it
.string
.lstring
= string
;
6603 it
->bidi_it
.string
.s
= NULL
;
6604 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6605 it
->bidi_it
.string
.bufpos
= 0;
6606 it
->bidi_it
.string
.from_disp_str
= 0;
6607 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6608 it
->bidi_it
.w
= it
->w
;
6609 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6610 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6615 it
->s
= (const unsigned char *) s
;
6618 /* Note that we use IT->current.pos, not it->current.string_pos,
6619 for displaying C strings. */
6620 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6621 if (it
->multibyte_p
)
6623 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6624 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6628 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6629 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6634 it
->bidi_it
.string
.lstring
= Qnil
;
6635 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6636 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6637 it
->bidi_it
.string
.bufpos
= 0;
6638 it
->bidi_it
.string
.from_disp_str
= 0;
6639 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6640 it
->bidi_it
.w
= it
->w
;
6641 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6644 it
->method
= GET_FROM_C_STRING
;
6647 /* PRECISION > 0 means don't return more than PRECISION characters
6649 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6651 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6653 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6656 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6657 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6658 FIELD_WIDTH < 0 means infinite field width. This is useful for
6659 padding with `-' at the end of a mode line. */
6660 if (field_width
< 0)
6661 field_width
= INFINITY
;
6662 /* Implementation note: We deliberately don't enlarge
6663 it->bidi_it.string.schars here to fit it->end_charpos, because
6664 the bidi iterator cannot produce characters out of thin air. */
6665 if (field_width
> it
->end_charpos
- charpos
)
6666 it
->end_charpos
= charpos
+ field_width
;
6668 /* Use the standard display table for displaying strings. */
6669 if (DISP_TABLE_P (Vstandard_display_table
))
6670 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6672 it
->stop_charpos
= charpos
;
6673 it
->prev_stop
= charpos
;
6674 it
->base_level_stop
= 0;
6677 it
->bidi_it
.first_elt
= 1;
6678 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6679 it
->bidi_it
.disp_pos
= -1;
6681 if (s
== NULL
&& it
->multibyte_p
)
6683 ptrdiff_t endpos
= SCHARS (it
->string
);
6684 if (endpos
> it
->end_charpos
)
6685 endpos
= it
->end_charpos
;
6686 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6694 /***********************************************************************
6696 ***********************************************************************/
6698 /* Map enum it_method value to corresponding next_element_from_* function. */
6700 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6702 next_element_from_buffer
,
6703 next_element_from_display_vector
,
6704 next_element_from_string
,
6705 next_element_from_c_string
,
6706 next_element_from_image
,
6707 next_element_from_stretch
6710 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6713 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6714 (possibly with the following characters). */
6716 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6717 ((IT)->cmp_it.id >= 0 \
6718 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6719 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6720 END_CHARPOS, (IT)->w, \
6721 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6725 /* Lookup the char-table Vglyphless_char_display for character C (-1
6726 if we want information for no-font case), and return the display
6727 method symbol. By side-effect, update it->what and
6728 it->glyphless_method. This function is called from
6729 get_next_display_element for each character element, and from
6730 x_produce_glyphs when no suitable font was found. */
6733 lookup_glyphless_char_display (int c
, struct it
*it
)
6735 Lisp_Object glyphless_method
= Qnil
;
6737 if (CHAR_TABLE_P (Vglyphless_char_display
)
6738 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6742 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6743 if (CONSP (glyphless_method
))
6744 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6745 ? XCAR (glyphless_method
)
6746 : XCDR (glyphless_method
);
6749 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6753 if (NILP (glyphless_method
))
6756 /* The default is to display the character by a proper font. */
6758 /* The default for the no-font case is to display an empty box. */
6759 glyphless_method
= Qempty_box
;
6761 if (EQ (glyphless_method
, Qzero_width
))
6764 return glyphless_method
;
6765 /* This method can't be used for the no-font case. */
6766 glyphless_method
= Qempty_box
;
6768 if (EQ (glyphless_method
, Qthin_space
))
6769 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6770 else if (EQ (glyphless_method
, Qempty_box
))
6771 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6772 else if (EQ (glyphless_method
, Qhex_code
))
6773 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6774 else if (STRINGP (glyphless_method
))
6775 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6778 /* Invalid value. We use the default method. */
6779 glyphless_method
= Qnil
;
6782 it
->what
= IT_GLYPHLESS
;
6783 return glyphless_method
;
6786 /* Merge escape glyph face and cache the result. */
6788 static struct frame
*last_escape_glyph_frame
= NULL
;
6789 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6790 static int last_escape_glyph_merged_face_id
= 0;
6793 merge_escape_glyph_face (struct it
*it
)
6797 if (it
->f
== last_escape_glyph_frame
6798 && it
->face_id
== last_escape_glyph_face_id
)
6799 face_id
= last_escape_glyph_merged_face_id
;
6802 /* Merge the `escape-glyph' face into the current face. */
6803 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6804 last_escape_glyph_frame
= it
->f
;
6805 last_escape_glyph_face_id
= it
->face_id
;
6806 last_escape_glyph_merged_face_id
= face_id
;
6811 /* Likewise for glyphless glyph face. */
6813 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6814 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6815 static int last_glyphless_glyph_merged_face_id
= 0;
6818 merge_glyphless_glyph_face (struct it
*it
)
6822 if (it
->f
== last_glyphless_glyph_frame
6823 && it
->face_id
== last_glyphless_glyph_face_id
)
6824 face_id
= last_glyphless_glyph_merged_face_id
;
6827 /* Merge the `glyphless-char' face into the current face. */
6828 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6829 last_glyphless_glyph_frame
= it
->f
;
6830 last_glyphless_glyph_face_id
= it
->face_id
;
6831 last_glyphless_glyph_merged_face_id
= face_id
;
6836 /* Load IT's display element fields with information about the next
6837 display element from the current position of IT. Value is zero if
6838 end of buffer (or C string) is reached. */
6841 get_next_display_element (struct it
*it
)
6843 /* Non-zero means that we found a display element. Zero means that
6844 we hit the end of what we iterate over. Performance note: the
6845 function pointer `method' used here turns out to be faster than
6846 using a sequence of if-statements. */
6850 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6852 if (it
->what
== IT_CHARACTER
)
6854 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6855 and only if (a) the resolved directionality of that character
6857 /* FIXME: Do we need an exception for characters from display
6859 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
)
6860 it
->c
= bidi_mirror_char (it
->c
);
6861 /* Map via display table or translate control characters.
6862 IT->c, IT->len etc. have been set to the next character by
6863 the function call above. If we have a display table, and it
6864 contains an entry for IT->c, translate it. Don't do this if
6865 IT->c itself comes from a display table, otherwise we could
6866 end up in an infinite recursion. (An alternative could be to
6867 count the recursion depth of this function and signal an
6868 error when a certain maximum depth is reached.) Is it worth
6870 if (success_p
&& it
->dpvec
== NULL
)
6873 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6874 int nonascii_space_p
= 0;
6875 int nonascii_hyphen_p
= 0;
6876 int c
= it
->c
; /* This is the character to display. */
6878 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6880 eassert (SINGLE_BYTE_CHAR_P (c
));
6881 if (unibyte_display_via_language_environment
)
6883 c
= DECODE_CHAR (unibyte
, c
);
6885 c
= BYTE8_TO_CHAR (it
->c
);
6888 c
= BYTE8_TO_CHAR (it
->c
);
6892 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6895 struct Lisp_Vector
*v
= XVECTOR (dv
);
6897 /* Return the first character from the display table
6898 entry, if not empty. If empty, don't display the
6899 current character. */
6902 it
->dpvec_char_len
= it
->len
;
6903 it
->dpvec
= v
->contents
;
6904 it
->dpend
= v
->contents
+ v
->header
.size
;
6905 it
->current
.dpvec_index
= 0;
6906 it
->dpvec_face_id
= -1;
6907 it
->saved_face_id
= it
->face_id
;
6908 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6913 set_iterator_to_next (it
, 0);
6918 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6920 if (it
->what
== IT_GLYPHLESS
)
6922 /* Don't display this character. */
6923 set_iterator_to_next (it
, 0);
6927 /* If `nobreak-char-display' is non-nil, we display
6928 non-ASCII spaces and hyphens specially. */
6929 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
6932 nonascii_space_p
= true;
6933 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
6934 nonascii_hyphen_p
= true;
6937 /* Translate control characters into `\003' or `^C' form.
6938 Control characters coming from a display table entry are
6939 currently not translated because we use IT->dpvec to hold
6940 the translation. This could easily be changed but I
6941 don't believe that it is worth doing.
6943 The characters handled by `nobreak-char-display' must be
6946 Non-printable characters and raw-byte characters are also
6947 translated to octal form. */
6948 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
6949 ? (it
->area
!= TEXT_AREA
6950 /* In mode line, treat \n, \t like other crl chars. */
6953 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
6954 || (c
!= '\n' && c
!= '\t'))
6956 || nonascii_hyphen_p
6958 || ! CHAR_PRINTABLE_P (c
))))
6960 /* C is a control character, non-ASCII space/hyphen,
6961 raw-byte, or a non-printable character which must be
6962 displayed either as '\003' or as `^C' where the '\\'
6963 and '^' can be defined in the display table. Fill
6964 IT->ctl_chars with glyphs for what we have to
6965 display. Then, set IT->dpvec to these glyphs. */
6972 /* Handle control characters with ^. */
6974 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
6978 g
= '^'; /* default glyph for Control */
6979 /* Set IT->ctl_chars[0] to the glyph for `^'. */
6981 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
6983 g
= GLYPH_CODE_CHAR (gc
);
6984 lface_id
= GLYPH_CODE_FACE (gc
);
6988 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
6989 : merge_escape_glyph_face (it
));
6991 XSETINT (it
->ctl_chars
[0], g
);
6992 XSETINT (it
->ctl_chars
[1], c
^ 0100);
6994 goto display_control
;
6997 /* Handle non-ascii space in the mode where it only gets
7000 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7002 /* Merge `nobreak-space' into the current face. */
7003 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7005 XSETINT (it
->ctl_chars
[0], ' ');
7007 goto display_control
;
7010 /* Handle sequences that start with the "escape glyph". */
7012 /* the default escape glyph is \. */
7013 escape_glyph
= '\\';
7016 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7018 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7019 lface_id
= GLYPH_CODE_FACE (gc
);
7023 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7024 : merge_escape_glyph_face (it
));
7026 /* Draw non-ASCII hyphen with just highlighting: */
7028 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7030 XSETINT (it
->ctl_chars
[0], '-');
7032 goto display_control
;
7035 /* Draw non-ASCII space/hyphen with escape glyph: */
7037 if (nonascii_space_p
|| nonascii_hyphen_p
)
7039 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7040 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7042 goto display_control
;
7049 if (CHAR_BYTE8_P (c
))
7050 /* Display \200 instead of \17777600. */
7051 c
= CHAR_TO_BYTE8 (c
);
7052 len
= sprintf (str
, "%03o", c
);
7054 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7055 for (i
= 0; i
< len
; i
++)
7056 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7061 /* Set up IT->dpvec and return first character from it. */
7062 it
->dpvec_char_len
= it
->len
;
7063 it
->dpvec
= it
->ctl_chars
;
7064 it
->dpend
= it
->dpvec
+ ctl_len
;
7065 it
->current
.dpvec_index
= 0;
7066 it
->dpvec_face_id
= face_id
;
7067 it
->saved_face_id
= it
->face_id
;
7068 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7072 it
->char_to_display
= c
;
7076 it
->char_to_display
= it
->c
;
7080 #ifdef HAVE_WINDOW_SYSTEM
7081 /* Adjust face id for a multibyte character. There are no multibyte
7082 character in unibyte text. */
7083 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7086 && FRAME_WINDOW_P (it
->f
))
7088 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7090 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7092 /* Automatic composition with glyph-string. */
7093 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7095 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7099 ptrdiff_t pos
= (it
->s
? -1
7100 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7101 : IT_CHARPOS (*it
));
7104 if (it
->what
== IT_CHARACTER
)
7105 c
= it
->char_to_display
;
7108 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7112 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7113 /* TAB in a composition means display glyphs with
7114 padding space on the left or right. */
7115 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7118 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7121 #endif /* HAVE_WINDOW_SYSTEM */
7124 /* Is this character the last one of a run of characters with
7125 box? If yes, set IT->end_of_box_run_p to 1. */
7129 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7131 int face_id
= underlying_face_id (it
);
7132 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7136 if (face
->box
== FACE_NO_BOX
)
7138 /* If the box comes from face properties in a
7139 display string, check faces in that string. */
7140 int string_face_id
= face_after_it_pos (it
);
7141 it
->end_of_box_run_p
7142 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7145 /* Otherwise, the box comes from the underlying face.
7146 If this is the last string character displayed, check
7147 the next buffer location. */
7148 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7149 /* n_overlay_strings is unreliable unless
7150 overlay_string_index is non-negative. */
7151 && ((it
->current
.overlay_string_index
>= 0
7152 && (it
->current
.overlay_string_index
7153 == it
->n_overlay_strings
- 1))
7154 /* A string from display property. */
7155 || it
->from_disp_prop_p
))
7159 struct text_pos pos
= it
->current
.pos
;
7161 /* For a string from a display property, the next
7162 buffer position is stored in the 'position'
7163 member of the iteration stack slot below the
7164 current one, see handle_single_display_spec. By
7165 contrast, it->current.pos was is not yet updated
7166 to point to that buffer position; that will
7167 happen in pop_it, after we finish displaying the
7168 current string. Note that we already checked
7169 above that it->sp is positive, so subtracting one
7171 if (it
->from_disp_prop_p
)
7172 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7174 INC_TEXT_POS (pos
, it
->multibyte_p
);
7176 if (CHARPOS (pos
) >= ZV
)
7177 it
->end_of_box_run_p
= true;
7180 next_face_id
= face_at_buffer_position
7181 (it
->w
, CHARPOS (pos
), &ignore
,
7182 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7183 it
->end_of_box_run_p
7184 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7190 /* next_element_from_display_vector sets this flag according to
7191 faces of the display vector glyphs, see there. */
7192 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7194 int face_id
= face_after_it_pos (it
);
7195 it
->end_of_box_run_p
7196 = (face_id
!= it
->face_id
7197 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7200 /* If we reached the end of the object we've been iterating (e.g., a
7201 display string or an overlay string), and there's something on
7202 IT->stack, proceed with what's on the stack. It doesn't make
7203 sense to return zero if there's unprocessed stuff on the stack,
7204 because otherwise that stuff will never be displayed. */
7205 if (!success_p
&& it
->sp
> 0)
7207 set_iterator_to_next (it
, 0);
7208 success_p
= get_next_display_element (it
);
7211 /* Value is 0 if end of buffer or string reached. */
7216 /* Move IT to the next display element.
7218 RESEAT_P non-zero means if called on a newline in buffer text,
7219 skip to the next visible line start.
7221 Functions get_next_display_element and set_iterator_to_next are
7222 separate because I find this arrangement easier to handle than a
7223 get_next_display_element function that also increments IT's
7224 position. The way it is we can first look at an iterator's current
7225 display element, decide whether it fits on a line, and if it does,
7226 increment the iterator position. The other way around we probably
7227 would either need a flag indicating whether the iterator has to be
7228 incremented the next time, or we would have to implement a
7229 decrement position function which would not be easy to write. */
7232 set_iterator_to_next (struct it
*it
, int reseat_p
)
7234 /* Reset flags indicating start and end of a sequence of characters
7235 with box. Reset them at the start of this function because
7236 moving the iterator to a new position might set them. */
7237 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7241 case GET_FROM_BUFFER
:
7242 /* The current display element of IT is a character from
7243 current_buffer. Advance in the buffer, and maybe skip over
7244 invisible lines that are so because of selective display. */
7245 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7246 reseat_at_next_visible_line_start (it
, 0);
7247 else if (it
->cmp_it
.id
>= 0)
7249 /* We are currently getting glyphs from a composition. */
7254 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7255 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7256 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7258 it
->cmp_it
.from
= it
->cmp_it
.to
;
7263 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7265 it
->end_charpos
, Qnil
);
7268 else if (! it
->cmp_it
.reversed_p
)
7270 /* Composition created while scanning forward. */
7271 /* Update IT's char/byte positions to point to the first
7272 character of the next grapheme cluster, or to the
7273 character visually after the current composition. */
7274 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7275 bidi_move_to_visually_next (&it
->bidi_it
);
7276 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7277 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7279 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7281 /* Proceed to the next grapheme cluster. */
7282 it
->cmp_it
.from
= it
->cmp_it
.to
;
7286 /* No more grapheme clusters in this composition.
7287 Find the next stop position. */
7288 ptrdiff_t stop
= it
->end_charpos
;
7289 if (it
->bidi_it
.scan_dir
< 0)
7290 /* Now we are scanning backward and don't know
7293 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7294 IT_BYTEPOS (*it
), stop
, Qnil
);
7299 /* Composition created while scanning backward. */
7300 /* Update IT's char/byte positions to point to the last
7301 character of the previous grapheme cluster, or the
7302 character visually after the current composition. */
7303 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7304 bidi_move_to_visually_next (&it
->bidi_it
);
7305 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7306 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7307 if (it
->cmp_it
.from
> 0)
7309 /* Proceed to the previous grapheme cluster. */
7310 it
->cmp_it
.to
= it
->cmp_it
.from
;
7314 /* No more grapheme clusters in this composition.
7315 Find the next stop position. */
7316 ptrdiff_t stop
= it
->end_charpos
;
7317 if (it
->bidi_it
.scan_dir
< 0)
7318 /* Now we are scanning backward and don't know
7321 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7322 IT_BYTEPOS (*it
), stop
, Qnil
);
7328 eassert (it
->len
!= 0);
7332 IT_BYTEPOS (*it
) += it
->len
;
7333 IT_CHARPOS (*it
) += 1;
7337 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7338 /* If this is a new paragraph, determine its base
7339 direction (a.k.a. its base embedding level). */
7340 if (it
->bidi_it
.new_paragraph
)
7341 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7342 bidi_move_to_visually_next (&it
->bidi_it
);
7343 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7344 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7345 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7347 /* As the scan direction was changed, we must
7348 re-compute the stop position for composition. */
7349 ptrdiff_t stop
= it
->end_charpos
;
7350 if (it
->bidi_it
.scan_dir
< 0)
7352 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7353 IT_BYTEPOS (*it
), stop
, Qnil
);
7356 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7360 case GET_FROM_C_STRING
:
7361 /* Current display element of IT is from a C string. */
7363 /* If the string position is beyond string's end, it means
7364 next_element_from_c_string is padding the string with
7365 blanks, in which case we bypass the bidi iterator,
7366 because it cannot deal with such virtual characters. */
7367 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7369 IT_BYTEPOS (*it
) += it
->len
;
7370 IT_CHARPOS (*it
) += 1;
7374 bidi_move_to_visually_next (&it
->bidi_it
);
7375 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7376 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7380 case GET_FROM_DISPLAY_VECTOR
:
7381 /* Current display element of IT is from a display table entry.
7382 Advance in the display table definition. Reset it to null if
7383 end reached, and continue with characters from buffers/
7385 ++it
->current
.dpvec_index
;
7387 /* Restore face of the iterator to what they were before the
7388 display vector entry (these entries may contain faces). */
7389 it
->face_id
= it
->saved_face_id
;
7391 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7393 int recheck_faces
= it
->ellipsis_p
;
7396 it
->method
= GET_FROM_C_STRING
;
7397 else if (STRINGP (it
->string
))
7398 it
->method
= GET_FROM_STRING
;
7401 it
->method
= GET_FROM_BUFFER
;
7402 it
->object
= it
->w
->contents
;
7406 it
->current
.dpvec_index
= -1;
7408 /* Skip over characters which were displayed via IT->dpvec. */
7409 if (it
->dpvec_char_len
< 0)
7410 reseat_at_next_visible_line_start (it
, 1);
7411 else if (it
->dpvec_char_len
> 0)
7413 if (it
->method
== GET_FROM_STRING
7414 && it
->current
.overlay_string_index
>= 0
7415 && it
->n_overlay_strings
> 0)
7416 it
->ignore_overlay_strings_at_pos_p
= true;
7417 it
->len
= it
->dpvec_char_len
;
7418 set_iterator_to_next (it
, reseat_p
);
7421 /* Maybe recheck faces after display vector. */
7423 it
->stop_charpos
= IT_CHARPOS (*it
);
7427 case GET_FROM_STRING
:
7428 /* Current display element is a character from a Lisp string. */
7429 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7430 /* Don't advance past string end. These conditions are true
7431 when set_iterator_to_next is called at the end of
7432 get_next_display_element, in which case the Lisp string is
7433 already exhausted, and all we want is pop the iterator
7435 if (it
->current
.overlay_string_index
>= 0)
7437 /* This is an overlay string, so there's no padding with
7438 spaces, and the number of characters in the string is
7439 where the string ends. */
7440 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7441 goto consider_string_end
;
7445 /* Not an overlay string. There could be padding, so test
7446 against it->end_charpos. */
7447 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7448 goto consider_string_end
;
7450 if (it
->cmp_it
.id
>= 0)
7456 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7457 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7458 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7459 it
->cmp_it
.from
= it
->cmp_it
.to
;
7463 composition_compute_stop_pos (&it
->cmp_it
,
7464 IT_STRING_CHARPOS (*it
),
7465 IT_STRING_BYTEPOS (*it
),
7466 it
->end_charpos
, it
->string
);
7469 else if (! it
->cmp_it
.reversed_p
)
7471 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7472 bidi_move_to_visually_next (&it
->bidi_it
);
7473 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7474 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7476 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7477 it
->cmp_it
.from
= it
->cmp_it
.to
;
7480 ptrdiff_t stop
= it
->end_charpos
;
7481 if (it
->bidi_it
.scan_dir
< 0)
7483 composition_compute_stop_pos (&it
->cmp_it
,
7484 IT_STRING_CHARPOS (*it
),
7485 IT_STRING_BYTEPOS (*it
), stop
,
7491 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7492 bidi_move_to_visually_next (&it
->bidi_it
);
7493 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7494 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7495 if (it
->cmp_it
.from
> 0)
7496 it
->cmp_it
.to
= it
->cmp_it
.from
;
7499 ptrdiff_t stop
= it
->end_charpos
;
7500 if (it
->bidi_it
.scan_dir
< 0)
7502 composition_compute_stop_pos (&it
->cmp_it
,
7503 IT_STRING_CHARPOS (*it
),
7504 IT_STRING_BYTEPOS (*it
), stop
,
7512 /* If the string position is beyond string's end, it
7513 means next_element_from_string is padding the string
7514 with blanks, in which case we bypass the bidi
7515 iterator, because it cannot deal with such virtual
7517 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7519 IT_STRING_BYTEPOS (*it
) += it
->len
;
7520 IT_STRING_CHARPOS (*it
) += 1;
7524 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7526 bidi_move_to_visually_next (&it
->bidi_it
);
7527 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7528 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7529 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7531 ptrdiff_t stop
= it
->end_charpos
;
7533 if (it
->bidi_it
.scan_dir
< 0)
7535 composition_compute_stop_pos (&it
->cmp_it
,
7536 IT_STRING_CHARPOS (*it
),
7537 IT_STRING_BYTEPOS (*it
), stop
,
7543 consider_string_end
:
7545 if (it
->current
.overlay_string_index
>= 0)
7547 /* IT->string is an overlay string. Advance to the
7548 next, if there is one. */
7549 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7552 next_overlay_string (it
);
7554 setup_for_ellipsis (it
, 0);
7559 /* IT->string is not an overlay string. If we reached
7560 its end, and there is something on IT->stack, proceed
7561 with what is on the stack. This can be either another
7562 string, this time an overlay string, or a buffer. */
7563 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7567 if (it
->method
== GET_FROM_STRING
)
7568 goto consider_string_end
;
7573 case GET_FROM_IMAGE
:
7574 case GET_FROM_STRETCH
:
7575 /* The position etc with which we have to proceed are on
7576 the stack. The position may be at the end of a string,
7577 if the `display' property takes up the whole string. */
7578 eassert (it
->sp
> 0);
7580 if (it
->method
== GET_FROM_STRING
)
7581 goto consider_string_end
;
7585 /* There are no other methods defined, so this should be a bug. */
7589 eassert (it
->method
!= GET_FROM_STRING
7590 || (STRINGP (it
->string
)
7591 && IT_STRING_CHARPOS (*it
) >= 0));
7594 /* Load IT's display element fields with information about the next
7595 display element which comes from a display table entry or from the
7596 result of translating a control character to one of the forms `^C'
7599 IT->dpvec holds the glyphs to return as characters.
7600 IT->saved_face_id holds the face id before the display vector--it
7601 is restored into IT->face_id in set_iterator_to_next. */
7604 next_element_from_display_vector (struct it
*it
)
7607 int prev_face_id
= it
->face_id
;
7611 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7613 it
->face_id
= it
->saved_face_id
;
7615 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7616 That seemed totally bogus - so I changed it... */
7617 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7619 if (GLYPH_CODE_P (gc
))
7621 struct face
*this_face
, *prev_face
, *next_face
;
7623 it
->c
= GLYPH_CODE_CHAR (gc
);
7624 it
->len
= CHAR_BYTES (it
->c
);
7626 /* The entry may contain a face id to use. Such a face id is
7627 the id of a Lisp face, not a realized face. A face id of
7628 zero means no face is specified. */
7629 if (it
->dpvec_face_id
>= 0)
7630 it
->face_id
= it
->dpvec_face_id
;
7633 int lface_id
= GLYPH_CODE_FACE (gc
);
7635 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7639 /* Glyphs in the display vector could have the box face, so we
7640 need to set the related flags in the iterator, as
7642 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7643 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7645 /* Is this character the first character of a box-face run? */
7646 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7648 || prev_face
->box
== FACE_NO_BOX
));
7650 /* For the last character of the box-face run, we need to look
7651 either at the next glyph from the display vector, or at the
7652 face we saw before the display vector. */
7653 next_face_id
= it
->saved_face_id
;
7654 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7656 if (it
->dpvec_face_id
>= 0)
7657 next_face_id
= it
->dpvec_face_id
;
7661 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7664 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7668 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7669 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7671 || next_face
->box
== FACE_NO_BOX
));
7672 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7675 /* Display table entry is invalid. Return a space. */
7676 it
->c
= ' ', it
->len
= 1;
7678 /* Don't change position and object of the iterator here. They are
7679 still the values of the character that had this display table
7680 entry or was translated, and that's what we want. */
7681 it
->what
= IT_CHARACTER
;
7685 /* Get the first element of string/buffer in the visual order, after
7686 being reseated to a new position in a string or a buffer. */
7688 get_visually_first_element (struct it
*it
)
7690 int string_p
= STRINGP (it
->string
) || it
->s
;
7691 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7692 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7694 if (STRINGP (it
->string
))
7696 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7697 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7701 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7702 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7705 if (it
->bidi_it
.charpos
== eob
)
7707 /* Nothing to do, but reset the FIRST_ELT flag, like
7708 bidi_paragraph_init does, because we are not going to
7710 it
->bidi_it
.first_elt
= 0;
7712 else if (it
->bidi_it
.charpos
== bob
7714 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7715 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7717 /* If we are at the beginning of a line/string, we can produce
7718 the next element right away. */
7719 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7720 bidi_move_to_visually_next (&it
->bidi_it
);
7724 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7726 /* We need to prime the bidi iterator starting at the line's or
7727 string's beginning, before we will be able to produce the
7730 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7732 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7733 IT_BYTEPOS (*it
), -1,
7734 &it
->bidi_it
.bytepos
);
7735 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7738 /* Now return to buffer/string position where we were asked
7739 to get the next display element, and produce that. */
7740 bidi_move_to_visually_next (&it
->bidi_it
);
7742 while (it
->bidi_it
.bytepos
!= orig_bytepos
7743 && it
->bidi_it
.charpos
< eob
);
7746 /* Adjust IT's position information to where we ended up. */
7747 if (STRINGP (it
->string
))
7749 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7750 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7754 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7755 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7758 if (STRINGP (it
->string
) || !it
->s
)
7760 ptrdiff_t stop
, charpos
, bytepos
;
7762 if (STRINGP (it
->string
))
7765 stop
= SCHARS (it
->string
);
7766 if (stop
> it
->end_charpos
)
7767 stop
= it
->end_charpos
;
7768 charpos
= IT_STRING_CHARPOS (*it
);
7769 bytepos
= IT_STRING_BYTEPOS (*it
);
7773 stop
= it
->end_charpos
;
7774 charpos
= IT_CHARPOS (*it
);
7775 bytepos
= IT_BYTEPOS (*it
);
7777 if (it
->bidi_it
.scan_dir
< 0)
7779 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7784 /* Load IT with the next display element from Lisp string IT->string.
7785 IT->current.string_pos is the current position within the string.
7786 If IT->current.overlay_string_index >= 0, the Lisp string is an
7790 next_element_from_string (struct it
*it
)
7792 struct text_pos position
;
7794 eassert (STRINGP (it
->string
));
7795 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7796 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7797 position
= it
->current
.string_pos
;
7799 /* With bidi reordering, the character to display might not be the
7800 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7801 that we were reseat()ed to a new string, whose paragraph
7802 direction is not known. */
7803 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7805 get_visually_first_element (it
);
7806 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7809 /* Time to check for invisible text? */
7810 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7812 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7815 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7816 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7818 /* With bidi non-linear iteration, we could find
7819 ourselves far beyond the last computed stop_charpos,
7820 with several other stop positions in between that we
7821 missed. Scan them all now, in buffer's logical
7822 order, until we find and handle the last stop_charpos
7823 that precedes our current position. */
7824 handle_stop_backwards (it
, it
->stop_charpos
);
7825 return GET_NEXT_DISPLAY_ELEMENT (it
);
7831 /* Take note of the stop position we just moved
7832 across, for when we will move back across it. */
7833 it
->prev_stop
= it
->stop_charpos
;
7834 /* If we are at base paragraph embedding level, take
7835 note of the last stop position seen at this
7837 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7838 it
->base_level_stop
= it
->stop_charpos
;
7842 /* Since a handler may have changed IT->method, we must
7844 return GET_NEXT_DISPLAY_ELEMENT (it
);
7848 /* If we are before prev_stop, we may have overstepped
7849 on our way backwards a stop_pos, and if so, we need
7850 to handle that stop_pos. */
7851 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7852 /* We can sometimes back up for reasons that have nothing
7853 to do with bidi reordering. E.g., compositions. The
7854 code below is only needed when we are above the base
7855 embedding level, so test for that explicitly. */
7856 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7858 /* If we lost track of base_level_stop, we have no better
7859 place for handle_stop_backwards to start from than string
7860 beginning. This happens, e.g., when we were reseated to
7861 the previous screenful of text by vertical-motion. */
7862 if (it
->base_level_stop
<= 0
7863 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7864 it
->base_level_stop
= 0;
7865 handle_stop_backwards (it
, it
->base_level_stop
);
7866 return GET_NEXT_DISPLAY_ELEMENT (it
);
7870 if (it
->current
.overlay_string_index
>= 0)
7872 /* Get the next character from an overlay string. In overlay
7873 strings, there is no field width or padding with spaces to
7875 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7880 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7881 IT_STRING_BYTEPOS (*it
),
7882 it
->bidi_it
.scan_dir
< 0
7884 : SCHARS (it
->string
))
7885 && next_element_from_composition (it
))
7889 else if (STRING_MULTIBYTE (it
->string
))
7891 const unsigned char *s
= (SDATA (it
->string
)
7892 + IT_STRING_BYTEPOS (*it
));
7893 it
->c
= string_char_and_length (s
, &it
->len
);
7897 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7903 /* Get the next character from a Lisp string that is not an
7904 overlay string. Such strings come from the mode line, for
7905 example. We may have to pad with spaces, or truncate the
7906 string. See also next_element_from_c_string. */
7907 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7912 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7914 /* Pad with spaces. */
7915 it
->c
= ' ', it
->len
= 1;
7916 CHARPOS (position
) = BYTEPOS (position
) = -1;
7918 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7919 IT_STRING_BYTEPOS (*it
),
7920 it
->bidi_it
.scan_dir
< 0
7922 : it
->string_nchars
)
7923 && next_element_from_composition (it
))
7927 else if (STRING_MULTIBYTE (it
->string
))
7929 const unsigned char *s
= (SDATA (it
->string
)
7930 + IT_STRING_BYTEPOS (*it
));
7931 it
->c
= string_char_and_length (s
, &it
->len
);
7935 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7940 /* Record what we have and where it came from. */
7941 it
->what
= IT_CHARACTER
;
7942 it
->object
= it
->string
;
7943 it
->position
= position
;
7948 /* Load IT with next display element from C string IT->s.
7949 IT->string_nchars is the maximum number of characters to return
7950 from the string. IT->end_charpos may be greater than
7951 IT->string_nchars when this function is called, in which case we
7952 may have to return padding spaces. Value is zero if end of string
7953 reached, including padding spaces. */
7956 next_element_from_c_string (struct it
*it
)
7958 bool success_p
= true;
7961 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
7962 it
->what
= IT_CHARACTER
;
7963 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
7966 /* With bidi reordering, the character to display might not be the
7967 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
7968 we were reseated to a new string, whose paragraph direction is
7970 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7971 get_visually_first_element (it
);
7973 /* IT's position can be greater than IT->string_nchars in case a
7974 field width or precision has been specified when the iterator was
7976 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
7978 /* End of the game. */
7982 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
7984 /* Pad with spaces. */
7985 it
->c
= ' ', it
->len
= 1;
7986 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
7988 else if (it
->multibyte_p
)
7989 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
7991 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
7997 /* Set up IT to return characters from an ellipsis, if appropriate.
7998 The definition of the ellipsis glyphs may come from a display table
7999 entry. This function fills IT with the first glyph from the
8000 ellipsis if an ellipsis is to be displayed. */
8003 next_element_from_ellipsis (struct it
*it
)
8005 if (it
->selective_display_ellipsis_p
)
8006 setup_for_ellipsis (it
, it
->len
);
8009 /* The face at the current position may be different from the
8010 face we find after the invisible text. Remember what it
8011 was in IT->saved_face_id, and signal that it's there by
8012 setting face_before_selective_p. */
8013 it
->saved_face_id
= it
->face_id
;
8014 it
->method
= GET_FROM_BUFFER
;
8015 it
->object
= it
->w
->contents
;
8016 reseat_at_next_visible_line_start (it
, 1);
8017 it
->face_before_selective_p
= true;
8020 return GET_NEXT_DISPLAY_ELEMENT (it
);
8024 /* Deliver an image display element. The iterator IT is already
8025 filled with image information (done in handle_display_prop). Value
8030 next_element_from_image (struct it
*it
)
8032 it
->what
= IT_IMAGE
;
8033 it
->ignore_overlay_strings_at_pos_p
= 0;
8038 /* Fill iterator IT with next display element from a stretch glyph
8039 property. IT->object is the value of the text property. Value is
8043 next_element_from_stretch (struct it
*it
)
8045 it
->what
= IT_STRETCH
;
8049 /* Scan backwards from IT's current position until we find a stop
8050 position, or until BEGV. This is called when we find ourself
8051 before both the last known prev_stop and base_level_stop while
8052 reordering bidirectional text. */
8055 compute_stop_pos_backwards (struct it
*it
)
8057 const int SCAN_BACK_LIMIT
= 1000;
8058 struct text_pos pos
;
8059 struct display_pos save_current
= it
->current
;
8060 struct text_pos save_position
= it
->position
;
8061 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8062 ptrdiff_t where_we_are
= charpos
;
8063 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8064 ptrdiff_t save_end_pos
= it
->end_charpos
;
8066 eassert (NILP (it
->string
) && !it
->s
);
8067 eassert (it
->bidi_p
);
8071 it
->end_charpos
= min (charpos
+ 1, ZV
);
8072 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8073 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8074 reseat_1 (it
, pos
, 0);
8075 compute_stop_pos (it
);
8076 /* We must advance forward, right? */
8077 if (it
->stop_charpos
<= charpos
)
8080 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8082 if (it
->stop_charpos
<= where_we_are
)
8083 it
->prev_stop
= it
->stop_charpos
;
8085 it
->prev_stop
= BEGV
;
8087 it
->current
= save_current
;
8088 it
->position
= save_position
;
8089 it
->stop_charpos
= save_stop_pos
;
8090 it
->end_charpos
= save_end_pos
;
8093 /* Scan forward from CHARPOS in the current buffer/string, until we
8094 find a stop position > current IT's position. Then handle the stop
8095 position before that. This is called when we bump into a stop
8096 position while reordering bidirectional text. CHARPOS should be
8097 the last previously processed stop_pos (or BEGV/0, if none were
8098 processed yet) whose position is less that IT's current
8102 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8104 int bufp
= !STRINGP (it
->string
);
8105 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8106 struct display_pos save_current
= it
->current
;
8107 struct text_pos save_position
= it
->position
;
8108 struct text_pos pos1
;
8109 ptrdiff_t next_stop
;
8111 /* Scan in strict logical order. */
8112 eassert (it
->bidi_p
);
8116 it
->prev_stop
= charpos
;
8119 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8120 reseat_1 (it
, pos1
, 0);
8123 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8124 compute_stop_pos (it
);
8125 /* We must advance forward, right? */
8126 if (it
->stop_charpos
<= it
->prev_stop
)
8128 charpos
= it
->stop_charpos
;
8130 while (charpos
<= where_we_are
);
8133 it
->current
= save_current
;
8134 it
->position
= save_position
;
8135 next_stop
= it
->stop_charpos
;
8136 it
->stop_charpos
= it
->prev_stop
;
8138 it
->stop_charpos
= next_stop
;
8141 /* Load IT with the next display element from current_buffer. Value
8142 is zero if end of buffer reached. IT->stop_charpos is the next
8143 position at which to stop and check for text properties or buffer
8147 next_element_from_buffer (struct it
*it
)
8149 bool success_p
= true;
8151 eassert (IT_CHARPOS (*it
) >= BEGV
);
8152 eassert (NILP (it
->string
) && !it
->s
);
8153 eassert (!it
->bidi_p
8154 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8155 && it
->bidi_it
.string
.s
== NULL
));
8157 /* With bidi reordering, the character to display might not be the
8158 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8159 we were reseat()ed to a new buffer position, which is potentially
8160 a different paragraph. */
8161 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8163 get_visually_first_element (it
);
8164 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8167 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8169 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8171 int overlay_strings_follow_p
;
8173 /* End of the game, except when overlay strings follow that
8174 haven't been returned yet. */
8175 if (it
->overlay_strings_at_end_processed_p
)
8176 overlay_strings_follow_p
= 0;
8179 it
->overlay_strings_at_end_processed_p
= true;
8180 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8183 if (overlay_strings_follow_p
)
8184 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8188 it
->position
= it
->current
.pos
;
8192 else if (!(!it
->bidi_p
8193 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8194 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8196 /* With bidi non-linear iteration, we could find ourselves
8197 far beyond the last computed stop_charpos, with several
8198 other stop positions in between that we missed. Scan
8199 them all now, in buffer's logical order, until we find
8200 and handle the last stop_charpos that precedes our
8201 current position. */
8202 handle_stop_backwards (it
, it
->stop_charpos
);
8203 return GET_NEXT_DISPLAY_ELEMENT (it
);
8209 /* Take note of the stop position we just moved across,
8210 for when we will move back across it. */
8211 it
->prev_stop
= it
->stop_charpos
;
8212 /* If we are at base paragraph embedding level, take
8213 note of the last stop position seen at this
8215 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8216 it
->base_level_stop
= it
->stop_charpos
;
8219 return GET_NEXT_DISPLAY_ELEMENT (it
);
8223 /* If we are before prev_stop, we may have overstepped on
8224 our way backwards a stop_pos, and if so, we need to
8225 handle that stop_pos. */
8226 && IT_CHARPOS (*it
) < it
->prev_stop
8227 /* We can sometimes back up for reasons that have nothing
8228 to do with bidi reordering. E.g., compositions. The
8229 code below is only needed when we are above the base
8230 embedding level, so test for that explicitly. */
8231 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8233 if (it
->base_level_stop
<= 0
8234 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8236 /* If we lost track of base_level_stop, we need to find
8237 prev_stop by looking backwards. This happens, e.g., when
8238 we were reseated to the previous screenful of text by
8240 it
->base_level_stop
= BEGV
;
8241 compute_stop_pos_backwards (it
);
8242 handle_stop_backwards (it
, it
->prev_stop
);
8245 handle_stop_backwards (it
, it
->base_level_stop
);
8246 return GET_NEXT_DISPLAY_ELEMENT (it
);
8250 /* No face changes, overlays etc. in sight, so just return a
8251 character from current_buffer. */
8255 /* Maybe run the redisplay end trigger hook. Performance note:
8256 This doesn't seem to cost measurable time. */
8257 if (it
->redisplay_end_trigger_charpos
8259 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8260 run_redisplay_end_trigger_hook (it
);
8262 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8263 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8265 && next_element_from_composition (it
))
8270 /* Get the next character, maybe multibyte. */
8271 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8272 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8273 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8275 it
->c
= *p
, it
->len
= 1;
8277 /* Record what we have and where it came from. */
8278 it
->what
= IT_CHARACTER
;
8279 it
->object
= it
->w
->contents
;
8280 it
->position
= it
->current
.pos
;
8282 /* Normally we return the character found above, except when we
8283 really want to return an ellipsis for selective display. */
8288 /* A value of selective > 0 means hide lines indented more
8289 than that number of columns. */
8290 if (it
->selective
> 0
8291 && IT_CHARPOS (*it
) + 1 < ZV
8292 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8293 IT_BYTEPOS (*it
) + 1,
8296 success_p
= next_element_from_ellipsis (it
);
8297 it
->dpvec_char_len
= -1;
8300 else if (it
->c
== '\r' && it
->selective
== -1)
8302 /* A value of selective == -1 means that everything from the
8303 CR to the end of the line is invisible, with maybe an
8304 ellipsis displayed for it. */
8305 success_p
= next_element_from_ellipsis (it
);
8306 it
->dpvec_char_len
= -1;
8311 /* Value is zero if end of buffer reached. */
8312 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8317 /* Run the redisplay end trigger hook for IT. */
8320 run_redisplay_end_trigger_hook (struct it
*it
)
8322 Lisp_Object args
[3];
8324 /* IT->glyph_row should be non-null, i.e. we should be actually
8325 displaying something, or otherwise we should not run the hook. */
8326 eassert (it
->glyph_row
);
8328 /* Set up hook arguments. */
8329 args
[0] = Qredisplay_end_trigger_functions
;
8330 args
[1] = it
->window
;
8331 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8332 it
->redisplay_end_trigger_charpos
= 0;
8334 /* Since we are *trying* to run these functions, don't try to run
8335 them again, even if they get an error. */
8336 wset_redisplay_end_trigger (it
->w
, Qnil
);
8337 Frun_hook_with_args (3, args
);
8339 /* Notice if it changed the face of the character we are on. */
8340 handle_face_prop (it
);
8344 /* Deliver a composition display element. Unlike the other
8345 next_element_from_XXX, this function is not registered in the array
8346 get_next_element[]. It is called from next_element_from_buffer and
8347 next_element_from_string when necessary. */
8350 next_element_from_composition (struct it
*it
)
8352 it
->what
= IT_COMPOSITION
;
8353 it
->len
= it
->cmp_it
.nbytes
;
8354 if (STRINGP (it
->string
))
8358 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8359 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8362 it
->position
= it
->current
.string_pos
;
8363 it
->object
= it
->string
;
8364 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8365 IT_STRING_BYTEPOS (*it
), it
->string
);
8371 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8372 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8375 if (it
->bidi_it
.new_paragraph
)
8376 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8377 /* Resync the bidi iterator with IT's new position.
8378 FIXME: this doesn't support bidirectional text. */
8379 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8380 bidi_move_to_visually_next (&it
->bidi_it
);
8384 it
->position
= it
->current
.pos
;
8385 it
->object
= it
->w
->contents
;
8386 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8387 IT_BYTEPOS (*it
), Qnil
);
8394 /***********************************************************************
8395 Moving an iterator without producing glyphs
8396 ***********************************************************************/
8398 /* Check if iterator is at a position corresponding to a valid buffer
8399 position after some move_it_ call. */
8401 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8402 ((it)->method == GET_FROM_STRING \
8403 ? IT_STRING_CHARPOS (*it) == 0 \
8407 /* Move iterator IT to a specified buffer or X position within one
8408 line on the display without producing glyphs.
8410 OP should be a bit mask including some or all of these bits:
8411 MOVE_TO_X: Stop upon reaching x-position TO_X.
8412 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8413 Regardless of OP's value, stop upon reaching the end of the display line.
8415 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8416 This means, in particular, that TO_X includes window's horizontal
8419 The return value has several possible values that
8420 say what condition caused the scan to stop:
8422 MOVE_POS_MATCH_OR_ZV
8423 - when TO_POS or ZV was reached.
8426 -when TO_X was reached before TO_POS or ZV were reached.
8429 - when we reached the end of the display area and the line must
8433 - when we reached the end of the display area and the line is
8437 - when we stopped at a line end, i.e. a newline or a CR and selective
8440 static enum move_it_result
8441 move_it_in_display_line_to (struct it
*it
,
8442 ptrdiff_t to_charpos
, int to_x
,
8443 enum move_operation_enum op
)
8445 enum move_it_result result
= MOVE_UNDEFINED
;
8446 struct glyph_row
*saved_glyph_row
;
8447 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8448 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8449 void *ppos_data
= NULL
;
8451 enum it_method prev_method
= it
->method
;
8452 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8453 int saw_smaller_pos
= prev_pos
< to_charpos
;
8455 /* Don't produce glyphs in produce_glyphs. */
8456 saved_glyph_row
= it
->glyph_row
;
8457 it
->glyph_row
= NULL
;
8459 /* Use wrap_it to save a copy of IT wherever a word wrap could
8460 occur. Use atpos_it to save a copy of IT at the desired buffer
8461 position, if found, so that we can scan ahead and check if the
8462 word later overshoots the window edge. Use atx_it similarly, for
8468 /* Use ppos_it under bidi reordering to save a copy of IT for the
8469 initial position. We restore that position in IT when we have
8470 scanned the entire display line without finding a match for
8471 TO_CHARPOS and all the character positions are greater than
8472 TO_CHARPOS. We then restart the scan from the initial position,
8473 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8474 the closest to TO_CHARPOS. */
8477 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8479 SAVE_IT (ppos_it
, *it
, ppos_data
);
8480 closest_pos
= IT_CHARPOS (*it
);
8486 #define BUFFER_POS_REACHED_P() \
8487 ((op & MOVE_TO_POS) != 0 \
8488 && BUFFERP (it->object) \
8489 && (IT_CHARPOS (*it) == to_charpos \
8491 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8492 && IT_CHARPOS (*it) > to_charpos) \
8493 || (it->what == IT_COMPOSITION \
8494 && ((IT_CHARPOS (*it) > to_charpos \
8495 && to_charpos >= it->cmp_it.charpos) \
8496 || (IT_CHARPOS (*it) < to_charpos \
8497 && to_charpos <= it->cmp_it.charpos)))) \
8498 && (it->method == GET_FROM_BUFFER \
8499 || (it->method == GET_FROM_DISPLAY_VECTOR \
8500 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8502 /* If there's a line-/wrap-prefix, handle it. */
8503 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8504 && it
->current_y
< it
->last_visible_y
)
8505 handle_line_prefix (it
);
8507 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8508 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8512 int x
, i
, ascent
= 0, descent
= 0;
8514 /* Utility macro to reset an iterator with x, ascent, and descent. */
8515 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8516 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8517 (IT)->max_descent = descent)
8519 /* Stop if we move beyond TO_CHARPOS (after an image or a
8520 display string or stretch glyph). */
8521 if ((op
& MOVE_TO_POS
) != 0
8522 && BUFFERP (it
->object
)
8523 && it
->method
== GET_FROM_BUFFER
8525 /* When the iterator is at base embedding level, we
8526 are guaranteed that characters are delivered for
8527 display in strictly increasing order of their
8528 buffer positions. */
8529 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8530 && IT_CHARPOS (*it
) > to_charpos
)
8532 && (prev_method
== GET_FROM_IMAGE
8533 || prev_method
== GET_FROM_STRETCH
8534 || prev_method
== GET_FROM_STRING
)
8535 /* Passed TO_CHARPOS from left to right. */
8536 && ((prev_pos
< to_charpos
8537 && IT_CHARPOS (*it
) > to_charpos
)
8538 /* Passed TO_CHARPOS from right to left. */
8539 || (prev_pos
> to_charpos
8540 && IT_CHARPOS (*it
) < to_charpos
)))))
8542 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8544 result
= MOVE_POS_MATCH_OR_ZV
;
8547 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8548 /* If wrap_it is valid, the current position might be in a
8549 word that is wrapped. So, save the iterator in
8550 atpos_it and continue to see if wrapping happens. */
8551 SAVE_IT (atpos_it
, *it
, atpos_data
);
8554 /* Stop when ZV reached.
8555 We used to stop here when TO_CHARPOS reached as well, but that is
8556 too soon if this glyph does not fit on this line. So we handle it
8557 explicitly below. */
8558 if (!get_next_display_element (it
))
8560 result
= MOVE_POS_MATCH_OR_ZV
;
8564 if (it
->line_wrap
== TRUNCATE
)
8566 if (BUFFER_POS_REACHED_P ())
8568 result
= MOVE_POS_MATCH_OR_ZV
;
8574 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8576 if (IT_DISPLAYING_WHITESPACE (it
))
8580 /* We have reached a glyph that follows one or more
8581 whitespace characters. If the position is
8582 already found, we are done. */
8583 if (atpos_it
.sp
>= 0)
8585 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8586 result
= MOVE_POS_MATCH_OR_ZV
;
8591 RESTORE_IT (it
, &atx_it
, atx_data
);
8592 result
= MOVE_X_REACHED
;
8595 /* Otherwise, we can wrap here. */
8596 SAVE_IT (wrap_it
, *it
, wrap_data
);
8602 /* Remember the line height for the current line, in case
8603 the next element doesn't fit on the line. */
8604 ascent
= it
->max_ascent
;
8605 descent
= it
->max_descent
;
8607 /* The call to produce_glyphs will get the metrics of the
8608 display element IT is loaded with. Record the x-position
8609 before this display element, in case it doesn't fit on the
8613 PRODUCE_GLYPHS (it
);
8615 if (it
->area
!= TEXT_AREA
)
8617 prev_method
= it
->method
;
8618 if (it
->method
== GET_FROM_BUFFER
)
8619 prev_pos
= IT_CHARPOS (*it
);
8620 set_iterator_to_next (it
, 1);
8621 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8622 SET_TEXT_POS (this_line_min_pos
,
8623 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8625 && (op
& MOVE_TO_POS
)
8626 && IT_CHARPOS (*it
) > to_charpos
8627 && IT_CHARPOS (*it
) < closest_pos
)
8628 closest_pos
= IT_CHARPOS (*it
);
8632 /* The number of glyphs we get back in IT->nglyphs will normally
8633 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8634 character on a terminal frame, or (iii) a line end. For the
8635 second case, IT->nglyphs - 1 padding glyphs will be present.
8636 (On X frames, there is only one glyph produced for a
8637 composite character.)
8639 The behavior implemented below means, for continuation lines,
8640 that as many spaces of a TAB as fit on the current line are
8641 displayed there. For terminal frames, as many glyphs of a
8642 multi-glyph character are displayed in the current line, too.
8643 This is what the old redisplay code did, and we keep it that
8644 way. Under X, the whole shape of a complex character must
8645 fit on the line or it will be completely displayed in the
8648 Note that both for tabs and padding glyphs, all glyphs have
8652 /* More than one glyph or glyph doesn't fit on line. All
8653 glyphs have the same width. */
8654 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8656 int x_before_this_char
= x
;
8657 int hpos_before_this_char
= it
->hpos
;
8659 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8661 new_x
= x
+ single_glyph_width
;
8663 /* We want to leave anything reaching TO_X to the caller. */
8664 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8666 if (BUFFER_POS_REACHED_P ())
8668 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8669 goto buffer_pos_reached
;
8670 if (atpos_it
.sp
< 0)
8672 SAVE_IT (atpos_it
, *it
, atpos_data
);
8673 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8678 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8681 result
= MOVE_X_REACHED
;
8686 SAVE_IT (atx_it
, *it
, atx_data
);
8687 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8692 if (/* Lines are continued. */
8693 it
->line_wrap
!= TRUNCATE
8694 && (/* And glyph doesn't fit on the line. */
8695 new_x
> it
->last_visible_x
8696 /* Or it fits exactly and we're on a window
8698 || (new_x
== it
->last_visible_x
8699 && FRAME_WINDOW_P (it
->f
)
8700 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8701 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8702 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8704 if (/* IT->hpos == 0 means the very first glyph
8705 doesn't fit on the line, e.g. a wide image. */
8707 || (new_x
== it
->last_visible_x
8708 && FRAME_WINDOW_P (it
->f
)
8709 /* When word-wrap is ON and we have a valid
8710 wrap point, we don't allow the last glyph
8711 to "just barely fit" on the line. */
8712 && (it
->line_wrap
!= WORD_WRAP
8713 || wrap_it
.sp
< 0)))
8716 it
->current_x
= new_x
;
8718 /* The character's last glyph just barely fits
8720 if (i
== it
->nglyphs
- 1)
8722 /* If this is the destination position,
8723 return a position *before* it in this row,
8724 now that we know it fits in this row. */
8725 if (BUFFER_POS_REACHED_P ())
8727 if (it
->line_wrap
!= WORD_WRAP
8730 it
->hpos
= hpos_before_this_char
;
8731 it
->current_x
= x_before_this_char
;
8732 result
= MOVE_POS_MATCH_OR_ZV
;
8735 if (it
->line_wrap
== WORD_WRAP
8738 SAVE_IT (atpos_it
, *it
, atpos_data
);
8739 atpos_it
.current_x
= x_before_this_char
;
8740 atpos_it
.hpos
= hpos_before_this_char
;
8744 prev_method
= it
->method
;
8745 if (it
->method
== GET_FROM_BUFFER
)
8746 prev_pos
= IT_CHARPOS (*it
);
8747 set_iterator_to_next (it
, 1);
8748 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8749 SET_TEXT_POS (this_line_min_pos
,
8750 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8751 /* On graphical terminals, newlines may
8752 "overflow" into the fringe if
8753 overflow-newline-into-fringe is non-nil.
8754 On text terminals, and on graphical
8755 terminals with no right margin, newlines
8756 may overflow into the last glyph on the
8758 if (!FRAME_WINDOW_P (it
->f
)
8760 && it
->bidi_it
.paragraph_dir
== R2L
)
8761 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8762 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8763 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8765 if (!get_next_display_element (it
))
8767 result
= MOVE_POS_MATCH_OR_ZV
;
8770 if (BUFFER_POS_REACHED_P ())
8772 if (ITERATOR_AT_END_OF_LINE_P (it
))
8773 result
= MOVE_POS_MATCH_OR_ZV
;
8775 result
= MOVE_LINE_CONTINUED
;
8778 if (ITERATOR_AT_END_OF_LINE_P (it
)
8779 && (it
->line_wrap
!= WORD_WRAP
8782 result
= MOVE_NEWLINE_OR_CR
;
8789 IT_RESET_X_ASCENT_DESCENT (it
);
8791 if (wrap_it
.sp
>= 0)
8793 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8798 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8800 result
= MOVE_LINE_CONTINUED
;
8804 if (BUFFER_POS_REACHED_P ())
8806 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8807 goto buffer_pos_reached
;
8808 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8810 SAVE_IT (atpos_it
, *it
, atpos_data
);
8811 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8815 if (new_x
> it
->first_visible_x
)
8817 /* Glyph is visible. Increment number of glyphs that
8818 would be displayed. */
8823 if (result
!= MOVE_UNDEFINED
)
8826 else if (BUFFER_POS_REACHED_P ())
8829 IT_RESET_X_ASCENT_DESCENT (it
);
8830 result
= MOVE_POS_MATCH_OR_ZV
;
8833 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8835 /* Stop when TO_X specified and reached. This check is
8836 necessary here because of lines consisting of a line end,
8837 only. The line end will not produce any glyphs and we
8838 would never get MOVE_X_REACHED. */
8839 eassert (it
->nglyphs
== 0);
8840 result
= MOVE_X_REACHED
;
8844 /* Is this a line end? If yes, we're done. */
8845 if (ITERATOR_AT_END_OF_LINE_P (it
))
8847 /* If we are past TO_CHARPOS, but never saw any character
8848 positions smaller than TO_CHARPOS, return
8849 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8851 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8853 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8855 if (closest_pos
< ZV
)
8857 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8858 /* Don't recurse if closest_pos is equal to
8859 to_charpos, since we have just tried that. */
8860 if (closest_pos
!= to_charpos
)
8861 move_it_in_display_line_to (it
, closest_pos
, -1,
8863 result
= MOVE_POS_MATCH_OR_ZV
;
8866 goto buffer_pos_reached
;
8868 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8869 && IT_CHARPOS (*it
) > to_charpos
)
8870 goto buffer_pos_reached
;
8872 result
= MOVE_NEWLINE_OR_CR
;
8875 result
= MOVE_NEWLINE_OR_CR
;
8879 prev_method
= it
->method
;
8880 if (it
->method
== GET_FROM_BUFFER
)
8881 prev_pos
= IT_CHARPOS (*it
);
8882 /* The current display element has been consumed. Advance
8884 set_iterator_to_next (it
, 1);
8885 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8886 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8887 if (IT_CHARPOS (*it
) < to_charpos
)
8888 saw_smaller_pos
= 1;
8890 && (op
& MOVE_TO_POS
)
8891 && IT_CHARPOS (*it
) >= to_charpos
8892 && IT_CHARPOS (*it
) < closest_pos
)
8893 closest_pos
= IT_CHARPOS (*it
);
8895 /* Stop if lines are truncated and IT's current x-position is
8896 past the right edge of the window now. */
8897 if (it
->line_wrap
== TRUNCATE
8898 && it
->current_x
>= it
->last_visible_x
)
8900 if (!FRAME_WINDOW_P (it
->f
)
8901 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8902 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8903 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8904 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8908 if ((at_eob_p
= !get_next_display_element (it
))
8909 || BUFFER_POS_REACHED_P ()
8910 /* If we are past TO_CHARPOS, but never saw any
8911 character positions smaller than TO_CHARPOS,
8912 return MOVE_POS_MATCH_OR_ZV, like the
8913 unidirectional display did. */
8914 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8916 && IT_CHARPOS (*it
) > to_charpos
))
8919 && !BUFFER_POS_REACHED_P ()
8920 && !at_eob_p
&& closest_pos
< ZV
)
8922 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8923 if (closest_pos
!= to_charpos
)
8924 move_it_in_display_line_to (it
, closest_pos
, -1,
8927 result
= MOVE_POS_MATCH_OR_ZV
;
8930 if (ITERATOR_AT_END_OF_LINE_P (it
))
8932 result
= MOVE_NEWLINE_OR_CR
;
8936 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8938 && IT_CHARPOS (*it
) > to_charpos
)
8940 if (closest_pos
< ZV
)
8942 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8943 if (closest_pos
!= to_charpos
)
8944 move_it_in_display_line_to (it
, closest_pos
, -1,
8947 result
= MOVE_POS_MATCH_OR_ZV
;
8950 result
= MOVE_LINE_TRUNCATED
;
8953 #undef IT_RESET_X_ASCENT_DESCENT
8956 #undef BUFFER_POS_REACHED_P
8958 /* If we scanned beyond to_pos and didn't find a point to wrap at,
8959 restore the saved iterator. */
8960 if (atpos_it
.sp
>= 0)
8961 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8962 else if (atx_it
.sp
>= 0)
8963 RESTORE_IT (it
, &atx_it
, atx_data
);
8968 bidi_unshelve_cache (atpos_data
, 1);
8970 bidi_unshelve_cache (atx_data
, 1);
8972 bidi_unshelve_cache (wrap_data
, 1);
8974 bidi_unshelve_cache (ppos_data
, 1);
8976 /* Restore the iterator settings altered at the beginning of this
8978 it
->glyph_row
= saved_glyph_row
;
8982 /* For external use. */
8984 move_it_in_display_line (struct it
*it
,
8985 ptrdiff_t to_charpos
, int to_x
,
8986 enum move_operation_enum op
)
8988 if (it
->line_wrap
== WORD_WRAP
8989 && (op
& MOVE_TO_X
))
8992 void *save_data
= NULL
;
8995 SAVE_IT (save_it
, *it
, save_data
);
8996 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
8997 /* When word-wrap is on, TO_X may lie past the end
8998 of a wrapped line. Then it->current is the
8999 character on the next line, so backtrack to the
9000 space before the wrap point. */
9001 if (skip
== MOVE_LINE_CONTINUED
)
9003 int prev_x
= max (it
->current_x
- 1, 0);
9004 RESTORE_IT (it
, &save_it
, save_data
);
9005 move_it_in_display_line_to
9006 (it
, -1, prev_x
, MOVE_TO_X
);
9009 bidi_unshelve_cache (save_data
, 1);
9012 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9016 /* Move IT forward until it satisfies one or more of the criteria in
9017 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9019 OP is a bit-mask that specifies where to stop, and in particular,
9020 which of those four position arguments makes a difference. See the
9021 description of enum move_operation_enum.
9023 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9024 screen line, this function will set IT to the next position that is
9025 displayed to the right of TO_CHARPOS on the screen.
9027 Return the maximum pixel length of any line scanned but never more
9028 than it.last_visible_x. */
9031 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9033 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9034 int line_height
, line_start_x
= 0, reached
= 0;
9035 int max_current_x
= 0;
9036 void *backup_data
= NULL
;
9040 if (op
& MOVE_TO_VPOS
)
9042 /* If no TO_CHARPOS and no TO_X specified, stop at the
9043 start of the line TO_VPOS. */
9044 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9046 if (it
->vpos
== to_vpos
)
9052 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9056 /* TO_VPOS >= 0 means stop at TO_X in the line at
9057 TO_VPOS, or at TO_POS, whichever comes first. */
9058 if (it
->vpos
== to_vpos
)
9064 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9066 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9071 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9073 /* We have reached TO_X but not in the line we want. */
9074 skip
= move_it_in_display_line_to (it
, to_charpos
,
9076 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9084 else if (op
& MOVE_TO_Y
)
9086 struct it it_backup
;
9088 if (it
->line_wrap
== WORD_WRAP
)
9089 SAVE_IT (it_backup
, *it
, backup_data
);
9091 /* TO_Y specified means stop at TO_X in the line containing
9092 TO_Y---or at TO_CHARPOS if this is reached first. The
9093 problem is that we can't really tell whether the line
9094 contains TO_Y before we have completely scanned it, and
9095 this may skip past TO_X. What we do is to first scan to
9098 If TO_X is not specified, use a TO_X of zero. The reason
9099 is to make the outcome of this function more predictable.
9100 If we didn't use TO_X == 0, we would stop at the end of
9101 the line which is probably not what a caller would expect
9103 skip
= move_it_in_display_line_to
9104 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9105 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9107 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9108 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9110 else if (skip
== MOVE_X_REACHED
)
9112 /* If TO_X was reached, we want to know whether TO_Y is
9113 in the line. We know this is the case if the already
9114 scanned glyphs make the line tall enough. Otherwise,
9115 we must check by scanning the rest of the line. */
9116 line_height
= it
->max_ascent
+ it
->max_descent
;
9117 if (to_y
>= it
->current_y
9118 && to_y
< it
->current_y
+ line_height
)
9123 SAVE_IT (it_backup
, *it
, backup_data
);
9124 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9125 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9127 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9128 line_height
= it
->max_ascent
+ it
->max_descent
;
9129 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9131 if (to_y
>= it
->current_y
9132 && to_y
< it
->current_y
+ line_height
)
9134 /* If TO_Y is in this line and TO_X was reached
9135 above, we scanned too far. We have to restore
9136 IT's settings to the ones before skipping. But
9137 keep the more accurate values of max_ascent and
9138 max_descent we've found while skipping the rest
9139 of the line, for the sake of callers, such as
9140 pos_visible_p, that need to know the line
9142 int max_ascent
= it
->max_ascent
;
9143 int max_descent
= it
->max_descent
;
9145 RESTORE_IT (it
, &it_backup
, backup_data
);
9146 it
->max_ascent
= max_ascent
;
9147 it
->max_descent
= max_descent
;
9153 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9159 /* Check whether TO_Y is in this line. */
9160 line_height
= it
->max_ascent
+ it
->max_descent
;
9161 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9163 if (to_y
>= it
->current_y
9164 && to_y
< it
->current_y
+ line_height
)
9166 if (to_y
> it
->current_y
)
9167 max_current_x
= max (it
->current_x
, max_current_x
);
9169 /* When word-wrap is on, TO_X may lie past the end
9170 of a wrapped line. Then it->current is the
9171 character on the next line, so backtrack to the
9172 space before the wrap point. */
9173 if (skip
== MOVE_LINE_CONTINUED
9174 && it
->line_wrap
== WORD_WRAP
)
9176 int prev_x
= max (it
->current_x
- 1, 0);
9177 RESTORE_IT (it
, &it_backup
, backup_data
);
9178 skip
= move_it_in_display_line_to
9179 (it
, -1, prev_x
, MOVE_TO_X
);
9188 max_current_x
= max (it
->current_x
, max_current_x
);
9192 else if (BUFFERP (it
->object
)
9193 && (it
->method
== GET_FROM_BUFFER
9194 || it
->method
== GET_FROM_STRETCH
)
9195 && IT_CHARPOS (*it
) >= to_charpos
9196 /* Under bidi iteration, a call to set_iterator_to_next
9197 can scan far beyond to_charpos if the initial
9198 portion of the next line needs to be reordered. In
9199 that case, give move_it_in_display_line_to another
9202 && it
->bidi_it
.scan_dir
== -1))
9203 skip
= MOVE_POS_MATCH_OR_ZV
;
9205 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9209 case MOVE_POS_MATCH_OR_ZV
:
9210 max_current_x
= max (it
->current_x
, max_current_x
);
9214 case MOVE_NEWLINE_OR_CR
:
9215 max_current_x
= max (it
->current_x
, max_current_x
);
9216 set_iterator_to_next (it
, 1);
9217 it
->continuation_lines_width
= 0;
9220 case MOVE_LINE_TRUNCATED
:
9221 max_current_x
= it
->last_visible_x
;
9222 it
->continuation_lines_width
= 0;
9223 reseat_at_next_visible_line_start (it
, 0);
9224 if ((op
& MOVE_TO_POS
) != 0
9225 && IT_CHARPOS (*it
) > to_charpos
)
9232 case MOVE_LINE_CONTINUED
:
9233 max_current_x
= it
->last_visible_x
;
9234 /* For continued lines ending in a tab, some of the glyphs
9235 associated with the tab are displayed on the current
9236 line. Since it->current_x does not include these glyphs,
9237 we use it->last_visible_x instead. */
9240 it
->continuation_lines_width
+= it
->last_visible_x
;
9241 /* When moving by vpos, ensure that the iterator really
9242 advances to the next line (bug#847, bug#969). Fixme:
9243 do we need to do this in other circumstances? */
9244 if (it
->current_x
!= it
->last_visible_x
9245 && (op
& MOVE_TO_VPOS
)
9246 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9248 line_start_x
= it
->current_x
+ it
->pixel_width
9249 - it
->last_visible_x
;
9250 set_iterator_to_next (it
, 0);
9254 it
->continuation_lines_width
+= it
->current_x
;
9261 /* Reset/increment for the next run. */
9262 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9263 it
->current_x
= line_start_x
;
9266 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9268 last_height
= it
->max_ascent
+ it
->max_descent
;
9269 it
->max_ascent
= it
->max_descent
= 0;
9274 /* On text terminals, we may stop at the end of a line in the middle
9275 of a multi-character glyph. If the glyph itself is continued,
9276 i.e. it is actually displayed on the next line, don't treat this
9277 stopping point as valid; move to the next line instead (unless
9278 that brings us offscreen). */
9279 if (!FRAME_WINDOW_P (it
->f
)
9281 && IT_CHARPOS (*it
) == to_charpos
9282 && it
->what
== IT_CHARACTER
9284 && it
->line_wrap
== WINDOW_WRAP
9285 && it
->current_x
== it
->last_visible_x
- 1
9288 && it
->vpos
< it
->w
->window_end_vpos
)
9290 it
->continuation_lines_width
+= it
->current_x
;
9291 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9292 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9294 last_height
= it
->max_ascent
+ it
->max_descent
;
9298 bidi_unshelve_cache (backup_data
, 1);
9300 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9302 return max_current_x
;
9306 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9308 If DY > 0, move IT backward at least that many pixels. DY = 0
9309 means move IT backward to the preceding line start or BEGV. This
9310 function may move over more than DY pixels if IT->current_y - DY
9311 ends up in the middle of a line; in this case IT->current_y will be
9312 set to the top of the line moved to. */
9315 move_it_vertically_backward (struct it
*it
, int dy
)
9319 void *it2data
= NULL
, *it3data
= NULL
;
9320 ptrdiff_t start_pos
;
9322 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9323 ptrdiff_t pos_limit
;
9328 start_pos
= IT_CHARPOS (*it
);
9330 /* Estimate how many newlines we must move back. */
9331 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9332 if (it
->line_wrap
== TRUNCATE
)
9335 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9337 /* Set the iterator's position that many lines back. But don't go
9338 back more than NLINES full screen lines -- this wins a day with
9339 buffers which have very long lines. */
9340 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9341 back_to_previous_visible_line_start (it
);
9343 /* Reseat the iterator here. When moving backward, we don't want
9344 reseat to skip forward over invisible text, set up the iterator
9345 to deliver from overlay strings at the new position etc. So,
9346 use reseat_1 here. */
9347 reseat_1 (it
, it
->current
.pos
, 1);
9349 /* We are now surely at a line start. */
9350 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9351 reordering is in effect. */
9352 it
->continuation_lines_width
= 0;
9354 /* Move forward and see what y-distance we moved. First move to the
9355 start of the next line so that we get its height. We need this
9356 height to be able to tell whether we reached the specified
9358 SAVE_IT (it2
, *it
, it2data
);
9359 it2
.max_ascent
= it2
.max_descent
= 0;
9362 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9363 MOVE_TO_POS
| MOVE_TO_VPOS
);
9365 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9366 /* If we are in a display string which starts at START_POS,
9367 and that display string includes a newline, and we are
9368 right after that newline (i.e. at the beginning of a
9369 display line), exit the loop, because otherwise we will
9370 infloop, since move_it_to will see that it is already at
9371 START_POS and will not move. */
9372 || (it2
.method
== GET_FROM_STRING
9373 && IT_CHARPOS (it2
) == start_pos
9374 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9375 eassert (IT_CHARPOS (*it
) >= BEGV
);
9376 SAVE_IT (it3
, it2
, it3data
);
9378 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9379 eassert (IT_CHARPOS (*it
) >= BEGV
);
9380 /* H is the actual vertical distance from the position in *IT
9381 and the starting position. */
9382 h
= it2
.current_y
- it
->current_y
;
9383 /* NLINES is the distance in number of lines. */
9384 nlines
= it2
.vpos
- it
->vpos
;
9386 /* Correct IT's y and vpos position
9387 so that they are relative to the starting point. */
9393 /* DY == 0 means move to the start of the screen line. The
9394 value of nlines is > 0 if continuation lines were involved,
9395 or if the original IT position was at start of a line. */
9396 RESTORE_IT (it
, it
, it2data
);
9398 move_it_by_lines (it
, nlines
);
9399 /* The above code moves us to some position NLINES down,
9400 usually to its first glyph (leftmost in an L2R line), but
9401 that's not necessarily the start of the line, under bidi
9402 reordering. We want to get to the character position
9403 that is immediately after the newline of the previous
9406 && !it
->continuation_lines_width
9407 && !STRINGP (it
->string
)
9408 && IT_CHARPOS (*it
) > BEGV
9409 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9411 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9414 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9415 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9417 bidi_unshelve_cache (it3data
, 1);
9421 /* The y-position we try to reach, relative to *IT.
9422 Note that H has been subtracted in front of the if-statement. */
9423 int target_y
= it
->current_y
+ h
- dy
;
9424 int y0
= it3
.current_y
;
9428 RESTORE_IT (&it3
, &it3
, it3data
);
9429 y1
= line_bottom_y (&it3
);
9430 line_height
= y1
- y0
;
9431 RESTORE_IT (it
, it
, it2data
);
9432 /* If we did not reach target_y, try to move further backward if
9433 we can. If we moved too far backward, try to move forward. */
9434 if (target_y
< it
->current_y
9435 /* This is heuristic. In a window that's 3 lines high, with
9436 a line height of 13 pixels each, recentering with point
9437 on the bottom line will try to move -39/2 = 19 pixels
9438 backward. Try to avoid moving into the first line. */
9439 && (it
->current_y
- target_y
9440 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9441 && IT_CHARPOS (*it
) > BEGV
)
9443 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9444 target_y
- it
->current_y
));
9445 dy
= it
->current_y
- target_y
;
9446 goto move_further_back
;
9448 else if (target_y
>= it
->current_y
+ line_height
9449 && IT_CHARPOS (*it
) < ZV
)
9451 /* Should move forward by at least one line, maybe more.
9453 Note: Calling move_it_by_lines can be expensive on
9454 terminal frames, where compute_motion is used (via
9455 vmotion) to do the job, when there are very long lines
9456 and truncate-lines is nil. That's the reason for
9457 treating terminal frames specially here. */
9459 if (!FRAME_WINDOW_P (it
->f
))
9460 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9465 move_it_by_lines (it
, 1);
9467 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9474 /* Move IT by a specified amount of pixel lines DY. DY negative means
9475 move backwards. DY = 0 means move to start of screen line. At the
9476 end, IT will be on the start of a screen line. */
9479 move_it_vertically (struct it
*it
, int dy
)
9482 move_it_vertically_backward (it
, -dy
);
9485 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9486 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9487 MOVE_TO_POS
| MOVE_TO_Y
);
9488 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9490 /* If buffer ends in ZV without a newline, move to the start of
9491 the line to satisfy the post-condition. */
9492 if (IT_CHARPOS (*it
) == ZV
9494 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9495 move_it_by_lines (it
, 0);
9500 /* Move iterator IT past the end of the text line it is in. */
9503 move_it_past_eol (struct it
*it
)
9505 enum move_it_result rc
;
9507 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9508 if (rc
== MOVE_NEWLINE_OR_CR
)
9509 set_iterator_to_next (it
, 0);
9513 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9514 negative means move up. DVPOS == 0 means move to the start of the
9517 Optimization idea: If we would know that IT->f doesn't use
9518 a face with proportional font, we could be faster for
9519 truncate-lines nil. */
9522 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9525 /* The commented-out optimization uses vmotion on terminals. This
9526 gives bad results, because elements like it->what, on which
9527 callers such as pos_visible_p rely, aren't updated. */
9528 /* struct position pos;
9529 if (!FRAME_WINDOW_P (it->f))
9531 struct text_pos textpos;
9533 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9534 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9535 reseat (it, textpos, 1);
9536 it->vpos += pos.vpos;
9537 it->current_y += pos.vpos;
9543 /* DVPOS == 0 means move to the start of the screen line. */
9544 move_it_vertically_backward (it
, 0);
9545 /* Let next call to line_bottom_y calculate real line height. */
9550 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9551 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9553 /* Only move to the next buffer position if we ended up in a
9554 string from display property, not in an overlay string
9555 (before-string or after-string). That is because the
9556 latter don't conceal the underlying buffer position, so
9557 we can ask to move the iterator to the exact position we
9558 are interested in. Note that, even if we are already at
9559 IT_CHARPOS (*it), the call below is not a no-op, as it
9560 will detect that we are at the end of the string, pop the
9561 iterator, and compute it->current_x and it->hpos
9563 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9564 -1, -1, -1, MOVE_TO_POS
);
9570 void *it2data
= NULL
;
9571 ptrdiff_t start_charpos
, i
;
9573 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9574 bool hit_pos_limit
= false;
9575 ptrdiff_t pos_limit
;
9577 /* Start at the beginning of the screen line containing IT's
9578 position. This may actually move vertically backwards,
9579 in case of overlays, so adjust dvpos accordingly. */
9581 move_it_vertically_backward (it
, 0);
9584 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9585 screen lines, and reseat the iterator there. */
9586 start_charpos
= IT_CHARPOS (*it
);
9587 if (it
->line_wrap
== TRUNCATE
)
9590 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9592 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9593 back_to_previous_visible_line_start (it
);
9594 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9595 hit_pos_limit
= true;
9596 reseat (it
, it
->current
.pos
, 1);
9598 /* Move further back if we end up in a string or an image. */
9599 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9601 /* First try to move to start of display line. */
9603 move_it_vertically_backward (it
, 0);
9605 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9607 /* If start of line is still in string or image,
9608 move further back. */
9609 back_to_previous_visible_line_start (it
);
9610 reseat (it
, it
->current
.pos
, 1);
9614 it
->current_x
= it
->hpos
= 0;
9616 /* Above call may have moved too far if continuation lines
9617 are involved. Scan forward and see if it did. */
9618 SAVE_IT (it2
, *it
, it2data
);
9619 it2
.vpos
= it2
.current_y
= 0;
9620 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9621 it
->vpos
-= it2
.vpos
;
9622 it
->current_y
-= it2
.current_y
;
9623 it
->current_x
= it
->hpos
= 0;
9625 /* If we moved too far back, move IT some lines forward. */
9626 if (it2
.vpos
> -dvpos
)
9628 int delta
= it2
.vpos
+ dvpos
;
9630 RESTORE_IT (&it2
, &it2
, it2data
);
9631 SAVE_IT (it2
, *it
, it2data
);
9632 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9633 /* Move back again if we got too far ahead. */
9634 if (IT_CHARPOS (*it
) >= start_charpos
)
9635 RESTORE_IT (it
, &it2
, it2data
);
9637 bidi_unshelve_cache (it2data
, 1);
9639 else if (hit_pos_limit
&& pos_limit
> BEGV
9640 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9642 /* If we hit the limit, but still didn't make it far enough
9643 back, that means there's a display string with a newline
9644 covering a large chunk of text, and that caused
9645 back_to_previous_visible_line_start try to go too far.
9646 Punish those who commit such atrocities by going back
9647 until we've reached DVPOS, after lifting the limit, which
9648 could make it slow for very long lines. "If it hurts,
9651 RESTORE_IT (it
, it
, it2data
);
9652 for (i
= -dvpos
; i
> 0; --i
)
9654 back_to_previous_visible_line_start (it
);
9659 RESTORE_IT (it
, it
, it2data
);
9663 /* Return true if IT points into the middle of a display vector. */
9666 in_display_vector_p (struct it
*it
)
9668 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9669 && it
->current
.dpvec_index
> 0
9670 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9673 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9674 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9675 WINDOW must be a live window and defaults to the selected one. The
9676 return value is a cons of the maximum pixel-width of any text line and
9677 the maximum pixel-height of all text lines.
9679 The optional argument FROM, if non-nil, specifies the first text
9680 position and defaults to the minimum accessible position of the buffer.
9681 If FROM is t, use the minimum accessible position that is not a newline
9682 character. TO, if non-nil, specifies the last text position and
9683 defaults to the maximum accessible position of the buffer. If TO is t,
9684 use the maximum accessible position that is not a newline character.
9686 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9687 width that can be returned. X-LIMIT nil or omitted, means to use the
9688 pixel-width of WINDOW's body; use this if you do not intend to change
9689 the width of WINDOW. Use the maximum width WINDOW may assume if you
9690 intend to change WINDOW's width. In any case, text whose x-coordinate
9691 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9692 can take some time, it's always a good idea to make this argument as
9693 small as possible; in particular, if the buffer contains long lines that
9694 shall be truncated anyway.
9696 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9697 height that can be returned. Text lines whose y-coordinate is beyond
9698 Y-LIMIT are ignored. Since calculating the text height of a large
9699 buffer can take some time, it makes sense to specify this argument if
9700 the size of the buffer is unknown.
9702 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9703 include the height of the mode- or header-line of WINDOW in the return
9704 value. If it is either the symbol `mode-line' or `header-line', include
9705 only the height of that line, if present, in the return value. If t,
9706 include the height of both, if present, in the return value. */)
9707 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9708 Lisp_Object mode_and_header_line
)
9710 struct window
*w
= decode_live_window (window
);
9714 struct buffer
*old_buffer
= NULL
;
9715 ptrdiff_t start
, end
, pos
;
9716 struct text_pos startp
;
9717 void *itdata
= NULL
;
9718 int c
, max_y
= -1, x
= 0, y
= 0;
9724 if (b
!= current_buffer
)
9726 old_buffer
= current_buffer
;
9727 set_buffer_internal (b
);
9732 else if (EQ (from
, Qt
))
9735 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9736 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9738 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9743 CHECK_NUMBER_COERCE_MARKER (from
);
9744 start
= min (max (XINT (from
), BEGV
), ZV
);
9749 else if (EQ (to
, Qt
))
9752 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9753 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9755 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9760 CHECK_NUMBER_COERCE_MARKER (to
);
9761 end
= max (start
, min (XINT (to
), ZV
));
9764 if (!NILP (y_limit
))
9766 CHECK_NUMBER (y_limit
);
9767 max_y
= min (XINT (y_limit
), INT_MAX
);
9770 itdata
= bidi_shelve_cache ();
9771 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9772 start_display (&it
, w
, startp
);
9775 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9778 CHECK_NUMBER (x_limit
);
9779 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9780 /* Actually, we never want move_it_to stop at to_x. But to make
9781 sure that move_it_in_display_line_to always moves far enough,
9782 we set it to INT_MAX and specify MOVE_TO_X. */
9783 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9784 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9787 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9789 if (!EQ (mode_and_header_line
, Qheader_line
)
9790 && !EQ (mode_and_header_line
, Qt
))
9791 /* Do not count the header-line which was counted automatically by
9793 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9795 if (EQ (mode_and_header_line
, Qmode_line
)
9796 || EQ (mode_and_header_line
, Qt
))
9797 /* Do count the mode-line which is not included automatically by
9799 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9801 bidi_unshelve_cache (itdata
, 0);
9804 set_buffer_internal (old_buffer
);
9806 return Fcons (make_number (x
), make_number (y
));
9809 /***********************************************************************
9811 ***********************************************************************/
9814 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9818 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9820 Lisp_Object args
[3];
9821 Lisp_Object msg
, fmt
;
9824 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9828 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9830 args
[0] = fmt
= build_string (format
);
9833 msg
= Fformat (3, args
);
9835 len
= SBYTES (msg
) + 1;
9836 buffer
= SAFE_ALLOCA (len
);
9837 memcpy (buffer
, SDATA (msg
), len
);
9839 message_dolog (buffer
, len
- 1, 1, 0);
9846 /* Output a newline in the *Messages* buffer if "needs" one. */
9849 message_log_maybe_newline (void)
9851 if (message_log_need_newline
)
9852 message_dolog ("", 0, 1, 0);
9856 /* Add a string M of length NBYTES to the message log, optionally
9857 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9858 true, means interpret the contents of M as multibyte. This
9859 function calls low-level routines in order to bypass text property
9860 hooks, etc. which might not be safe to run.
9862 This may GC (insert may run before/after change hooks),
9863 so the buffer M must NOT point to a Lisp string. */
9866 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9868 const unsigned char *msg
= (const unsigned char *) m
;
9870 if (!NILP (Vmemory_full
))
9873 if (!NILP (Vmessage_log_max
))
9875 struct buffer
*oldbuf
;
9876 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9877 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9878 ptrdiff_t point_at_end
= 0;
9879 ptrdiff_t zv_at_end
= 0;
9880 Lisp_Object old_deactivate_mark
;
9881 struct gcpro gcpro1
;
9883 old_deactivate_mark
= Vdeactivate_mark
;
9884 oldbuf
= current_buffer
;
9886 /* Ensure the Messages buffer exists, and switch to it.
9887 If we created it, set the major-mode. */
9890 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9892 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9895 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9896 call0 (intern ("messages-buffer-mode"));
9899 bset_undo_list (current_buffer
, Qt
);
9900 bset_cache_long_scans (current_buffer
, Qnil
);
9902 oldpoint
= message_dolog_marker1
;
9903 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
9904 oldbegv
= message_dolog_marker2
;
9905 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
9906 oldzv
= message_dolog_marker3
;
9907 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
9908 GCPRO1 (old_deactivate_mark
);
9916 BEGV_BYTE
= BEG_BYTE
;
9919 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
9921 /* Insert the string--maybe converting multibyte to single byte
9922 or vice versa, so that all the text fits the buffer. */
9924 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9930 /* Convert a multibyte string to single-byte
9931 for the *Message* buffer. */
9932 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
9934 c
= string_char_and_length (msg
+ i
, &char_bytes
);
9935 work
[0] = CHAR_TO_BYTE8 (c
);
9936 insert_1_both (work
, 1, 1, 1, 0, 0);
9939 else if (! multibyte
9940 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
9944 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
9945 /* Convert a single-byte string to multibyte
9946 for the *Message* buffer. */
9947 for (i
= 0; i
< nbytes
; i
++)
9950 MAKE_CHAR_MULTIBYTE (c
);
9951 char_bytes
= CHAR_STRING (c
, str
);
9952 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
9956 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
9960 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
9963 insert_1_both ("\n", 1, 1, 1, 0, 0);
9965 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9967 this_bol_byte
= PT_BYTE
;
9969 /* See if this line duplicates the previous one.
9970 If so, combine duplicates. */
9973 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
9975 prev_bol_byte
= PT_BYTE
;
9977 dups
= message_log_check_duplicate (prev_bol_byte
,
9981 del_range_both (prev_bol
, prev_bol_byte
,
9982 this_bol
, this_bol_byte
, 0);
9985 char dupstr
[sizeof " [ times]"
9986 + INT_STRLEN_BOUND (printmax_t
)];
9988 /* If you change this format, don't forget to also
9989 change message_log_check_duplicate. */
9990 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
9991 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
9992 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
9997 /* If we have more than the desired maximum number of lines
9998 in the *Messages* buffer now, delete the oldest ones.
9999 This is safe because we don't have undo in this buffer. */
10001 if (NATNUMP (Vmessage_log_max
))
10003 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10004 -XFASTINT (Vmessage_log_max
) - 1, 0);
10005 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10008 BEGV
= marker_position (oldbegv
);
10009 BEGV_BYTE
= marker_byte_position (oldbegv
);
10018 ZV
= marker_position (oldzv
);
10019 ZV_BYTE
= marker_byte_position (oldzv
);
10023 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10025 /* We can't do Fgoto_char (oldpoint) because it will run some
10027 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10028 marker_byte_position (oldpoint
));
10031 unchain_marker (XMARKER (oldpoint
));
10032 unchain_marker (XMARKER (oldbegv
));
10033 unchain_marker (XMARKER (oldzv
));
10035 /* We called insert_1_both above with its 5th argument (PREPARE)
10036 zero, which prevents insert_1_both from calling
10037 prepare_to_modify_buffer, which in turns prevents us from
10038 incrementing windows_or_buffers_changed even if *Messages* is
10039 shown in some window. So we must manually set
10040 windows_or_buffers_changed here to make up for that. */
10041 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10042 bset_redisplay (current_buffer
);
10044 set_buffer_internal (oldbuf
);
10046 message_log_need_newline
= !nlflag
;
10047 Vdeactivate_mark
= old_deactivate_mark
;
10052 /* We are at the end of the buffer after just having inserted a newline.
10053 (Note: We depend on the fact we won't be crossing the gap.)
10054 Check to see if the most recent message looks a lot like the previous one.
10055 Return 0 if different, 1 if the new one should just replace it, or a
10056 value N > 1 if we should also append " [N times]". */
10059 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10062 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10064 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10065 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10067 for (i
= 0; i
< len
; i
++)
10069 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10071 if (p1
[i
] != p2
[i
])
10077 if (*p1
++ == ' ' && *p1
++ == '[')
10080 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10081 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10088 /* Display an echo area message M with a specified length of NBYTES
10089 bytes. The string may include null characters. If M is not a
10090 string, clear out any existing message, and let the mini-buffer
10093 This function cancels echoing. */
10096 message3 (Lisp_Object m
)
10098 struct gcpro gcpro1
;
10101 clear_message (true, true);
10104 /* First flush out any partial line written with print. */
10105 message_log_maybe_newline ();
10108 ptrdiff_t nbytes
= SBYTES (m
);
10109 bool multibyte
= STRING_MULTIBYTE (m
);
10111 char *buffer
= SAFE_ALLOCA (nbytes
);
10112 memcpy (buffer
, SDATA (m
), nbytes
);
10113 message_dolog (buffer
, nbytes
, 1, multibyte
);
10116 message3_nolog (m
);
10122 /* The non-logging version of message3.
10123 This does not cancel echoing, because it is used for echoing.
10124 Perhaps we need to make a separate function for echoing
10125 and make this cancel echoing. */
10128 message3_nolog (Lisp_Object m
)
10130 struct frame
*sf
= SELECTED_FRAME ();
10132 if (FRAME_INITIAL_P (sf
))
10134 if (noninteractive_need_newline
)
10135 putc ('\n', stderr
);
10136 noninteractive_need_newline
= 0;
10139 Lisp_Object s
= ENCODE_SYSTEM (m
);
10141 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10143 if (cursor_in_echo_area
== 0)
10144 fprintf (stderr
, "\n");
10147 /* Error messages get reported properly by cmd_error, so this must be just an
10148 informative message; if the frame hasn't really been initialized yet, just
10150 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10152 /* Get the frame containing the mini-buffer
10153 that the selected frame is using. */
10154 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10155 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10156 struct frame
*f
= XFRAME (frame
);
10158 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10159 Fmake_frame_visible (frame
);
10161 if (STRINGP (m
) && SCHARS (m
) > 0)
10164 if (minibuffer_auto_raise
)
10165 Fraise_frame (frame
);
10166 /* Assume we are not echoing.
10167 (If we are, echo_now will override this.) */
10168 echo_message_buffer
= Qnil
;
10171 clear_message (true, true);
10173 do_pending_window_change (0);
10174 echo_area_display (1);
10175 do_pending_window_change (0);
10176 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10177 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10182 /* Display a null-terminated echo area message M. If M is 0, clear
10183 out any existing message, and let the mini-buffer text show through.
10185 The buffer M must continue to exist until after the echo area gets
10186 cleared or some other message gets displayed there. Do not pass
10187 text that is stored in a Lisp string. Do not pass text in a buffer
10188 that was alloca'd. */
10191 message1 (const char *m
)
10193 message3 (m
? build_unibyte_string (m
) : Qnil
);
10197 /* The non-logging counterpart of message1. */
10200 message1_nolog (const char *m
)
10202 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10205 /* Display a message M which contains a single %s
10206 which gets replaced with STRING. */
10209 message_with_string (const char *m
, Lisp_Object string
, int log
)
10211 CHECK_STRING (string
);
10213 if (noninteractive
)
10217 /* ENCODE_SYSTEM below can GC and/or relocate the
10218 Lisp data, so make sure we don't use it here. */
10219 eassert (relocatable_string_data_p (m
) != 1);
10221 if (noninteractive_need_newline
)
10222 putc ('\n', stderr
);
10223 noninteractive_need_newline
= 0;
10224 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10225 if (!cursor_in_echo_area
)
10226 fprintf (stderr
, "\n");
10230 else if (INTERACTIVE
)
10232 /* The frame whose minibuffer we're going to display the message on.
10233 It may be larger than the selected frame, so we need
10234 to use its buffer, not the selected frame's buffer. */
10235 Lisp_Object mini_window
;
10236 struct frame
*f
, *sf
= SELECTED_FRAME ();
10238 /* Get the frame containing the minibuffer
10239 that the selected frame is using. */
10240 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10241 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10243 /* Error messages get reported properly by cmd_error, so this must be
10244 just an informative message; if the frame hasn't really been
10245 initialized yet, just toss it. */
10246 if (f
->glyphs_initialized_p
)
10248 Lisp_Object args
[2], msg
;
10249 struct gcpro gcpro1
, gcpro2
;
10251 args
[0] = build_string (m
);
10252 args
[1] = msg
= string
;
10253 GCPRO2 (args
[0], msg
);
10256 msg
= Fformat (2, args
);
10261 message3_nolog (msg
);
10265 /* Print should start at the beginning of the message
10266 buffer next time. */
10267 message_buf_print
= 0;
10273 /* Dump an informative message to the minibuf. If M is 0, clear out
10274 any existing message, and let the mini-buffer text show through. */
10277 vmessage (const char *m
, va_list ap
)
10279 if (noninteractive
)
10283 if (noninteractive_need_newline
)
10284 putc ('\n', stderr
);
10285 noninteractive_need_newline
= 0;
10286 vfprintf (stderr
, m
, ap
);
10287 if (cursor_in_echo_area
== 0)
10288 fprintf (stderr
, "\n");
10292 else if (INTERACTIVE
)
10294 /* The frame whose mini-buffer we're going to display the message
10295 on. It may be larger than the selected frame, so we need to
10296 use its buffer, not the selected frame's buffer. */
10297 Lisp_Object mini_window
;
10298 struct frame
*f
, *sf
= SELECTED_FRAME ();
10300 /* Get the frame containing the mini-buffer
10301 that the selected frame is using. */
10302 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10303 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10305 /* Error messages get reported properly by cmd_error, so this must be
10306 just an informative message; if the frame hasn't really been
10307 initialized yet, just toss it. */
10308 if (f
->glyphs_initialized_p
)
10313 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10314 char *message_buf
= alloca (maxsize
+ 1);
10316 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10318 message3 (make_string (message_buf
, len
));
10323 /* Print should start at the beginning of the message
10324 buffer next time. */
10325 message_buf_print
= 0;
10331 message (const char *m
, ...)
10341 /* The non-logging version of message. */
10344 message_nolog (const char *m
, ...)
10346 Lisp_Object old_log_max
;
10349 old_log_max
= Vmessage_log_max
;
10350 Vmessage_log_max
= Qnil
;
10352 Vmessage_log_max
= old_log_max
;
10358 /* Display the current message in the current mini-buffer. This is
10359 only called from error handlers in process.c, and is not time
10363 update_echo_area (void)
10365 if (!NILP (echo_area_buffer
[0]))
10367 Lisp_Object string
;
10368 string
= Fcurrent_message ();
10374 /* Make sure echo area buffers in `echo_buffers' are live.
10375 If they aren't, make new ones. */
10378 ensure_echo_area_buffers (void)
10382 for (i
= 0; i
< 2; ++i
)
10383 if (!BUFFERP (echo_buffer
[i
])
10384 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10387 Lisp_Object old_buffer
;
10390 old_buffer
= echo_buffer
[i
];
10391 echo_buffer
[i
] = Fget_buffer_create
10392 (make_formatted_string (name
, " *Echo Area %d*", i
));
10393 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10394 /* to force word wrap in echo area -
10395 it was decided to postpone this*/
10396 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10398 for (j
= 0; j
< 2; ++j
)
10399 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10400 echo_area_buffer
[j
] = echo_buffer
[i
];
10405 /* Call FN with args A1..A2 with either the current or last displayed
10406 echo_area_buffer as current buffer.
10408 WHICH zero means use the current message buffer
10409 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10410 from echo_buffer[] and clear it.
10412 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10413 suitable buffer from echo_buffer[] and clear it.
10415 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10416 that the current message becomes the last displayed one, make
10417 choose a suitable buffer for echo_area_buffer[0], and clear it.
10419 Value is what FN returns. */
10422 with_echo_area_buffer (struct window
*w
, int which
,
10423 int (*fn
) (ptrdiff_t, Lisp_Object
),
10424 ptrdiff_t a1
, Lisp_Object a2
)
10426 Lisp_Object buffer
;
10427 int this_one
, the_other
, clear_buffer_p
, rc
;
10430 /* If buffers aren't live, make new ones. */
10431 ensure_echo_area_buffers ();
10433 clear_buffer_p
= 0;
10436 this_one
= 0, the_other
= 1;
10437 else if (which
> 0)
10438 this_one
= 1, the_other
= 0;
10441 this_one
= 0, the_other
= 1;
10442 clear_buffer_p
= true;
10444 /* We need a fresh one in case the current echo buffer equals
10445 the one containing the last displayed echo area message. */
10446 if (!NILP (echo_area_buffer
[this_one
])
10447 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10448 echo_area_buffer
[this_one
] = Qnil
;
10451 /* Choose a suitable buffer from echo_buffer[] is we don't
10453 if (NILP (echo_area_buffer
[this_one
]))
10455 echo_area_buffer
[this_one
]
10456 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10457 ? echo_buffer
[the_other
]
10458 : echo_buffer
[this_one
]);
10459 clear_buffer_p
= true;
10462 buffer
= echo_area_buffer
[this_one
];
10464 /* Don't get confused by reusing the buffer used for echoing
10465 for a different purpose. */
10466 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10469 record_unwind_protect (unwind_with_echo_area_buffer
,
10470 with_echo_area_buffer_unwind_data (w
));
10472 /* Make the echo area buffer current. Note that for display
10473 purposes, it is not necessary that the displayed window's buffer
10474 == current_buffer, except for text property lookup. So, let's
10475 only set that buffer temporarily here without doing a full
10476 Fset_window_buffer. We must also change w->pointm, though,
10477 because otherwise an assertions in unshow_buffer fails, and Emacs
10479 set_buffer_internal_1 (XBUFFER (buffer
));
10482 wset_buffer (w
, buffer
);
10483 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10486 bset_undo_list (current_buffer
, Qt
);
10487 bset_read_only (current_buffer
, Qnil
);
10488 specbind (Qinhibit_read_only
, Qt
);
10489 specbind (Qinhibit_modification_hooks
, Qt
);
10491 if (clear_buffer_p
&& Z
> BEG
)
10492 del_range (BEG
, Z
);
10494 eassert (BEGV
>= BEG
);
10495 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10499 eassert (BEGV
>= BEG
);
10500 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10507 /* Save state that should be preserved around the call to the function
10508 FN called in with_echo_area_buffer. */
10511 with_echo_area_buffer_unwind_data (struct window
*w
)
10514 Lisp_Object vector
, tmp
;
10516 /* Reduce consing by keeping one vector in
10517 Vwith_echo_area_save_vector. */
10518 vector
= Vwith_echo_area_save_vector
;
10519 Vwith_echo_area_save_vector
= Qnil
;
10522 vector
= Fmake_vector (make_number (9), Qnil
);
10524 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10525 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10526 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10530 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10531 ASET (vector
, i
, w
->contents
); ++i
;
10532 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10533 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10534 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10535 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10540 for (; i
< end
; ++i
)
10541 ASET (vector
, i
, Qnil
);
10544 eassert (i
== ASIZE (vector
));
10549 /* Restore global state from VECTOR which was created by
10550 with_echo_area_buffer_unwind_data. */
10553 unwind_with_echo_area_buffer (Lisp_Object vector
)
10555 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10556 Vdeactivate_mark
= AREF (vector
, 1);
10557 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10559 if (WINDOWP (AREF (vector
, 3)))
10562 Lisp_Object buffer
;
10564 w
= XWINDOW (AREF (vector
, 3));
10565 buffer
= AREF (vector
, 4);
10567 wset_buffer (w
, buffer
);
10568 set_marker_both (w
->pointm
, buffer
,
10569 XFASTINT (AREF (vector
, 5)),
10570 XFASTINT (AREF (vector
, 6)));
10571 set_marker_both (w
->start
, buffer
,
10572 XFASTINT (AREF (vector
, 7)),
10573 XFASTINT (AREF (vector
, 8)));
10576 Vwith_echo_area_save_vector
= vector
;
10580 /* Set up the echo area for use by print functions. MULTIBYTE_P
10581 non-zero means we will print multibyte. */
10584 setup_echo_area_for_printing (int multibyte_p
)
10586 /* If we can't find an echo area any more, exit. */
10587 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10588 Fkill_emacs (Qnil
);
10590 ensure_echo_area_buffers ();
10592 if (!message_buf_print
)
10594 /* A message has been output since the last time we printed.
10595 Choose a fresh echo area buffer. */
10596 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10597 echo_area_buffer
[0] = echo_buffer
[1];
10599 echo_area_buffer
[0] = echo_buffer
[0];
10601 /* Switch to that buffer and clear it. */
10602 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10603 bset_truncate_lines (current_buffer
, Qnil
);
10608 specbind (Qinhibit_read_only
, Qt
);
10609 /* Note that undo recording is always disabled. */
10610 del_range (BEG
, Z
);
10613 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10615 /* Set up the buffer for the multibyteness we need. */
10617 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10618 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10620 /* Raise the frame containing the echo area. */
10621 if (minibuffer_auto_raise
)
10623 struct frame
*sf
= SELECTED_FRAME ();
10624 Lisp_Object mini_window
;
10625 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10626 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10629 message_log_maybe_newline ();
10630 message_buf_print
= 1;
10634 if (NILP (echo_area_buffer
[0]))
10636 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10637 echo_area_buffer
[0] = echo_buffer
[1];
10639 echo_area_buffer
[0] = echo_buffer
[0];
10642 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10644 /* Someone switched buffers between print requests. */
10645 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10646 bset_truncate_lines (current_buffer
, Qnil
);
10652 /* Display an echo area message in window W. Value is non-zero if W's
10653 height is changed. If display_last_displayed_message_p is
10654 non-zero, display the message that was last displayed, otherwise
10655 display the current message. */
10658 display_echo_area (struct window
*w
)
10660 int i
, no_message_p
, window_height_changed_p
;
10662 /* If there is no message, we must call display_echo_area_1
10663 nevertheless because it resizes the window. But we will have to
10664 reset the echo_area_buffer in question to nil at the end because
10665 with_echo_area_buffer will sets it to an empty buffer. */
10666 i
= display_last_displayed_message_p
? 1 : 0;
10667 no_message_p
= NILP (echo_area_buffer
[i
]);
10669 window_height_changed_p
10670 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10671 display_echo_area_1
,
10672 (intptr_t) w
, Qnil
);
10675 echo_area_buffer
[i
] = Qnil
;
10677 return window_height_changed_p
;
10681 /* Helper for display_echo_area. Display the current buffer which
10682 contains the current echo area message in window W, a mini-window,
10683 a pointer to which is passed in A1. A2..A4 are currently not used.
10684 Change the height of W so that all of the message is displayed.
10685 Value is non-zero if height of W was changed. */
10688 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10691 struct window
*w
= (struct window
*) i1
;
10692 Lisp_Object window
;
10693 struct text_pos start
;
10694 int window_height_changed_p
= 0;
10696 /* Do this before displaying, so that we have a large enough glyph
10697 matrix for the display. If we can't get enough space for the
10698 whole text, display the last N lines. That works by setting w->start. */
10699 window_height_changed_p
= resize_mini_window (w
, 0);
10701 /* Use the starting position chosen by resize_mini_window. */
10702 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10705 clear_glyph_matrix (w
->desired_matrix
);
10706 XSETWINDOW (window
, w
);
10707 try_window (window
, start
, 0);
10709 return window_height_changed_p
;
10713 /* Resize the echo area window to exactly the size needed for the
10714 currently displayed message, if there is one. If a mini-buffer
10715 is active, don't shrink it. */
10718 resize_echo_area_exactly (void)
10720 if (BUFFERP (echo_area_buffer
[0])
10721 && WINDOWP (echo_area_window
))
10723 struct window
*w
= XWINDOW (echo_area_window
);
10724 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10725 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10726 (intptr_t) w
, resize_exactly
);
10729 windows_or_buffers_changed
= 42;
10730 update_mode_lines
= 30;
10731 redisplay_internal ();
10737 /* Callback function for with_echo_area_buffer, when used from
10738 resize_echo_area_exactly. A1 contains a pointer to the window to
10739 resize, EXACTLY non-nil means resize the mini-window exactly to the
10740 size of the text displayed. A3 and A4 are not used. Value is what
10741 resize_mini_window returns. */
10744 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10747 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10751 /* Resize mini-window W to fit the size of its contents. EXACT_P
10752 means size the window exactly to the size needed. Otherwise, it's
10753 only enlarged until W's buffer is empty.
10755 Set W->start to the right place to begin display. If the whole
10756 contents fit, start at the beginning. Otherwise, start so as
10757 to make the end of the contents appear. This is particularly
10758 important for y-or-n-p, but seems desirable generally.
10760 Value is non-zero if the window height has been changed. */
10763 resize_mini_window (struct window
*w
, int exact_p
)
10765 struct frame
*f
= XFRAME (w
->frame
);
10766 int window_height_changed_p
= 0;
10768 eassert (MINI_WINDOW_P (w
));
10770 /* By default, start display at the beginning. */
10771 set_marker_both (w
->start
, w
->contents
,
10772 BUF_BEGV (XBUFFER (w
->contents
)),
10773 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10775 /* Don't resize windows while redisplaying a window; it would
10776 confuse redisplay functions when the size of the window they are
10777 displaying changes from under them. Such a resizing can happen,
10778 for instance, when which-func prints a long message while
10779 we are running fontification-functions. We're running these
10780 functions with safe_call which binds inhibit-redisplay to t. */
10781 if (!NILP (Vinhibit_redisplay
))
10784 /* Nil means don't try to resize. */
10785 if (NILP (Vresize_mini_windows
)
10786 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10789 if (!FRAME_MINIBUF_ONLY_P (f
))
10792 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10793 + WINDOW_PIXEL_HEIGHT (w
));
10794 int unit
= FRAME_LINE_HEIGHT (f
);
10795 int height
, max_height
;
10796 struct text_pos start
;
10797 struct buffer
*old_current_buffer
= NULL
;
10799 if (current_buffer
!= XBUFFER (w
->contents
))
10801 old_current_buffer
= current_buffer
;
10802 set_buffer_internal (XBUFFER (w
->contents
));
10805 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10807 /* Compute the max. number of lines specified by the user. */
10808 if (FLOATP (Vmax_mini_window_height
))
10809 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10810 else if (INTEGERP (Vmax_mini_window_height
))
10811 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10813 max_height
= total_height
/ 4;
10815 /* Correct that max. height if it's bogus. */
10816 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10818 /* Find out the height of the text in the window. */
10819 if (it
.line_wrap
== TRUNCATE
)
10824 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10825 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10826 height
= it
.current_y
+ last_height
;
10828 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10829 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10832 /* Compute a suitable window start. */
10833 if (height
> max_height
)
10835 height
= (max_height
/ unit
) * unit
;
10836 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10837 move_it_vertically_backward (&it
, height
- unit
);
10838 start
= it
.current
.pos
;
10841 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10842 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10844 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10846 /* Let it grow only, until we display an empty message, in which
10847 case the window shrinks again. */
10848 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10850 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10852 FRAME_WINDOWS_FROZEN (f
) = 1;
10853 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10854 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10856 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10857 && (exact_p
|| BEGV
== ZV
))
10859 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10861 FRAME_WINDOWS_FROZEN (f
) = 0;
10862 shrink_mini_window (w
, 1);
10863 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10868 /* Always resize to exact size needed. */
10869 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10871 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10873 FRAME_WINDOWS_FROZEN (f
) = 1;
10874 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10875 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10877 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10879 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10881 FRAME_WINDOWS_FROZEN (f
) = 0;
10882 shrink_mini_window (w
, 1);
10886 FRAME_WINDOWS_FROZEN (f
) = 1;
10887 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10890 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10894 if (old_current_buffer
)
10895 set_buffer_internal (old_current_buffer
);
10898 return window_height_changed_p
;
10902 /* Value is the current message, a string, or nil if there is no
10903 current message. */
10906 current_message (void)
10910 if (!BUFFERP (echo_area_buffer
[0]))
10914 with_echo_area_buffer (0, 0, current_message_1
,
10915 (intptr_t) &msg
, Qnil
);
10917 echo_area_buffer
[0] = Qnil
;
10925 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
10928 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
10931 *msg
= make_buffer_string (BEG
, Z
, 1);
10938 /* Push the current message on Vmessage_stack for later restoration
10939 by restore_message. Value is non-zero if the current message isn't
10940 empty. This is a relatively infrequent operation, so it's not
10941 worth optimizing. */
10944 push_message (void)
10946 Lisp_Object msg
= current_message ();
10947 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
10948 return STRINGP (msg
);
10952 /* Restore message display from the top of Vmessage_stack. */
10955 restore_message (void)
10957 eassert (CONSP (Vmessage_stack
));
10958 message3_nolog (XCAR (Vmessage_stack
));
10962 /* Handler for unwind-protect calling pop_message. */
10965 pop_message_unwind (void)
10967 /* Pop the top-most entry off Vmessage_stack. */
10968 eassert (CONSP (Vmessage_stack
));
10969 Vmessage_stack
= XCDR (Vmessage_stack
);
10973 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
10974 exits. If the stack is not empty, we have a missing pop_message
10978 check_message_stack (void)
10980 if (!NILP (Vmessage_stack
))
10985 /* Truncate to NCHARS what will be displayed in the echo area the next
10986 time we display it---but don't redisplay it now. */
10989 truncate_echo_area (ptrdiff_t nchars
)
10992 echo_area_buffer
[0] = Qnil
;
10993 else if (!noninteractive
10995 && !NILP (echo_area_buffer
[0]))
10997 struct frame
*sf
= SELECTED_FRAME ();
10998 /* Error messages get reported properly by cmd_error, so this must be
10999 just an informative message; if the frame hasn't really been
11000 initialized yet, just toss it. */
11001 if (sf
->glyphs_initialized_p
)
11002 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11007 /* Helper function for truncate_echo_area. Truncate the current
11008 message to at most NCHARS characters. */
11011 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11013 if (BEG
+ nchars
< Z
)
11014 del_range (BEG
+ nchars
, Z
);
11016 echo_area_buffer
[0] = Qnil
;
11020 /* Set the current message to STRING. */
11023 set_message (Lisp_Object string
)
11025 eassert (STRINGP (string
));
11027 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11029 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11030 message_buf_print
= 0;
11031 help_echo_showing_p
= 0;
11033 if (STRINGP (Vdebug_on_message
)
11034 && STRINGP (string
)
11035 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11036 call_debugger (list2 (Qerror
, string
));
11040 /* Helper function for set_message. First argument is ignored and second
11041 argument has the same meaning as for set_message.
11042 This function is called with the echo area buffer being current. */
11045 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11047 eassert (STRINGP (string
));
11049 /* Change multibyteness of the echo buffer appropriately. */
11050 if (message_enable_multibyte
11051 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11052 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11054 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11055 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11056 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11058 /* Insert new message at BEG. */
11059 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11061 /* This function takes care of single/multibyte conversion.
11062 We just have to ensure that the echo area buffer has the right
11063 setting of enable_multibyte_characters. */
11064 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11070 /* Clear messages. CURRENT_P non-zero means clear the current
11071 message. LAST_DISPLAYED_P non-zero means clear the message
11075 clear_message (bool current_p
, bool last_displayed_p
)
11079 echo_area_buffer
[0] = Qnil
;
11080 message_cleared_p
= true;
11083 if (last_displayed_p
)
11084 echo_area_buffer
[1] = Qnil
;
11086 message_buf_print
= 0;
11089 /* Clear garbaged frames.
11091 This function is used where the old redisplay called
11092 redraw_garbaged_frames which in turn called redraw_frame which in
11093 turn called clear_frame. The call to clear_frame was a source of
11094 flickering. I believe a clear_frame is not necessary. It should
11095 suffice in the new redisplay to invalidate all current matrices,
11096 and ensure a complete redisplay of all windows. */
11099 clear_garbaged_frames (void)
11101 if (frame_garbaged
)
11103 Lisp_Object tail
, frame
;
11105 FOR_EACH_FRAME (tail
, frame
)
11107 struct frame
*f
= XFRAME (frame
);
11109 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11114 clear_current_matrices (f
);
11115 fset_redisplay (f
);
11116 f
->garbaged
= false;
11117 f
->resized_p
= false;
11121 frame_garbaged
= false;
11126 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11127 is non-zero update selected_frame. Value is non-zero if the
11128 mini-windows height has been changed. */
11131 echo_area_display (int update_frame_p
)
11133 Lisp_Object mini_window
;
11136 int window_height_changed_p
= 0;
11137 struct frame
*sf
= SELECTED_FRAME ();
11139 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11140 w
= XWINDOW (mini_window
);
11141 f
= XFRAME (WINDOW_FRAME (w
));
11143 /* Don't display if frame is invisible or not yet initialized. */
11144 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11147 #ifdef HAVE_WINDOW_SYSTEM
11148 /* When Emacs starts, selected_frame may be the initial terminal
11149 frame. If we let this through, a message would be displayed on
11151 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11153 #endif /* HAVE_WINDOW_SYSTEM */
11155 /* Redraw garbaged frames. */
11156 clear_garbaged_frames ();
11158 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11160 echo_area_window
= mini_window
;
11161 window_height_changed_p
= display_echo_area (w
);
11162 w
->must_be_updated_p
= true;
11164 /* Update the display, unless called from redisplay_internal.
11165 Also don't update the screen during redisplay itself. The
11166 update will happen at the end of redisplay, and an update
11167 here could cause confusion. */
11168 if (update_frame_p
&& !redisplaying_p
)
11172 /* If the display update has been interrupted by pending
11173 input, update mode lines in the frame. Due to the
11174 pending input, it might have been that redisplay hasn't
11175 been called, so that mode lines above the echo area are
11176 garbaged. This looks odd, so we prevent it here. */
11177 if (!display_completed
)
11178 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11180 if (window_height_changed_p
11181 /* Don't do this if Emacs is shutting down. Redisplay
11182 needs to run hooks. */
11183 && !NILP (Vrun_hooks
))
11185 /* Must update other windows. Likewise as in other
11186 cases, don't let this update be interrupted by
11189 specbind (Qredisplay_dont_pause
, Qt
);
11190 windows_or_buffers_changed
= 44;
11191 redisplay_internal ();
11194 else if (FRAME_WINDOW_P (f
) && n
== 0)
11196 /* Window configuration is the same as before.
11197 Can do with a display update of the echo area,
11198 unless we displayed some mode lines. */
11199 update_single_window (w
, 1);
11203 update_frame (f
, 1, 1);
11205 /* If cursor is in the echo area, make sure that the next
11206 redisplay displays the minibuffer, so that the cursor will
11207 be replaced with what the minibuffer wants. */
11208 if (cursor_in_echo_area
)
11209 wset_redisplay (XWINDOW (mini_window
));
11212 else if (!EQ (mini_window
, selected_window
))
11213 wset_redisplay (XWINDOW (mini_window
));
11215 /* Last displayed message is now the current message. */
11216 echo_area_buffer
[1] = echo_area_buffer
[0];
11217 /* Inform read_char that we're not echoing. */
11218 echo_message_buffer
= Qnil
;
11220 /* Prevent redisplay optimization in redisplay_internal by resetting
11221 this_line_start_pos. This is done because the mini-buffer now
11222 displays the message instead of its buffer text. */
11223 if (EQ (mini_window
, selected_window
))
11224 CHARPOS (this_line_start_pos
) = 0;
11226 return window_height_changed_p
;
11229 /* Nonzero if W's buffer was changed but not saved. */
11232 window_buffer_changed (struct window
*w
)
11234 struct buffer
*b
= XBUFFER (w
->contents
);
11236 eassert (BUFFER_LIVE_P (b
));
11238 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11241 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11244 mode_line_update_needed (struct window
*w
)
11246 return (w
->column_number_displayed
!= -1
11247 && !(PT
== w
->last_point
&& !window_outdated (w
))
11248 && (w
->column_number_displayed
!= current_column ()));
11251 /* Nonzero if window start of W is frozen and may not be changed during
11255 window_frozen_p (struct window
*w
)
11257 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11259 Lisp_Object window
;
11261 XSETWINDOW (window
, w
);
11262 if (MINI_WINDOW_P (w
))
11264 else if (EQ (window
, selected_window
))
11266 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11267 && EQ (window
, Vminibuf_scroll_window
))
11268 /* This special window can't be frozen too. */
11276 /***********************************************************************
11277 Mode Lines and Frame Titles
11278 ***********************************************************************/
11280 /* A buffer for constructing non-propertized mode-line strings and
11281 frame titles in it; allocated from the heap in init_xdisp and
11282 resized as needed in store_mode_line_noprop_char. */
11284 static char *mode_line_noprop_buf
;
11286 /* The buffer's end, and a current output position in it. */
11288 static char *mode_line_noprop_buf_end
;
11289 static char *mode_line_noprop_ptr
;
11291 #define MODE_LINE_NOPROP_LEN(start) \
11292 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11295 MODE_LINE_DISPLAY
= 0,
11299 } mode_line_target
;
11301 /* Alist that caches the results of :propertize.
11302 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11303 static Lisp_Object mode_line_proptrans_alist
;
11305 /* List of strings making up the mode-line. */
11306 static Lisp_Object mode_line_string_list
;
11308 /* Base face property when building propertized mode line string. */
11309 static Lisp_Object mode_line_string_face
;
11310 static Lisp_Object mode_line_string_face_prop
;
11313 /* Unwind data for mode line strings */
11315 static Lisp_Object Vmode_line_unwind_vector
;
11318 format_mode_line_unwind_data (struct frame
*target_frame
,
11319 struct buffer
*obuf
,
11321 int save_proptrans
)
11323 Lisp_Object vector
, tmp
;
11325 /* Reduce consing by keeping one vector in
11326 Vwith_echo_area_save_vector. */
11327 vector
= Vmode_line_unwind_vector
;
11328 Vmode_line_unwind_vector
= Qnil
;
11331 vector
= Fmake_vector (make_number (10), Qnil
);
11333 ASET (vector
, 0, make_number (mode_line_target
));
11334 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11335 ASET (vector
, 2, mode_line_string_list
);
11336 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11337 ASET (vector
, 4, mode_line_string_face
);
11338 ASET (vector
, 5, mode_line_string_face_prop
);
11341 XSETBUFFER (tmp
, obuf
);
11344 ASET (vector
, 6, tmp
);
11345 ASET (vector
, 7, owin
);
11348 /* Similarly to `with-selected-window', if the operation selects
11349 a window on another frame, we must restore that frame's
11350 selected window, and (for a tty) the top-frame. */
11351 ASET (vector
, 8, target_frame
->selected_window
);
11352 if (FRAME_TERMCAP_P (target_frame
))
11353 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11360 unwind_format_mode_line (Lisp_Object vector
)
11362 Lisp_Object old_window
= AREF (vector
, 7);
11363 Lisp_Object target_frame_window
= AREF (vector
, 8);
11364 Lisp_Object old_top_frame
= AREF (vector
, 9);
11366 mode_line_target
= XINT (AREF (vector
, 0));
11367 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11368 mode_line_string_list
= AREF (vector
, 2);
11369 if (! EQ (AREF (vector
, 3), Qt
))
11370 mode_line_proptrans_alist
= AREF (vector
, 3);
11371 mode_line_string_face
= AREF (vector
, 4);
11372 mode_line_string_face_prop
= AREF (vector
, 5);
11374 /* Select window before buffer, since it may change the buffer. */
11375 if (!NILP (old_window
))
11377 /* If the operation that we are unwinding had selected a window
11378 on a different frame, reset its frame-selected-window. For a
11379 text terminal, reset its top-frame if necessary. */
11380 if (!NILP (target_frame_window
))
11383 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11385 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11386 Fselect_window (target_frame_window
, Qt
);
11388 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11389 Fselect_frame (old_top_frame
, Qt
);
11392 Fselect_window (old_window
, Qt
);
11395 if (!NILP (AREF (vector
, 6)))
11397 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11398 ASET (vector
, 6, Qnil
);
11401 Vmode_line_unwind_vector
= vector
;
11405 /* Store a single character C for the frame title in mode_line_noprop_buf.
11406 Re-allocate mode_line_noprop_buf if necessary. */
11409 store_mode_line_noprop_char (char c
)
11411 /* If output position has reached the end of the allocated buffer,
11412 increase the buffer's size. */
11413 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11415 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11416 ptrdiff_t size
= len
;
11417 mode_line_noprop_buf
=
11418 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11419 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11420 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11423 *mode_line_noprop_ptr
++ = c
;
11427 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11428 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11429 characters that yield more columns than PRECISION; PRECISION <= 0
11430 means copy the whole string. Pad with spaces until FIELD_WIDTH
11431 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11432 pad. Called from display_mode_element when it is used to build a
11436 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11438 const unsigned char *str
= (const unsigned char *) string
;
11440 ptrdiff_t dummy
, nbytes
;
11442 /* Copy at most PRECISION chars from STR. */
11443 nbytes
= strlen (string
);
11444 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11446 store_mode_line_noprop_char (*str
++);
11448 /* Fill up with spaces until FIELD_WIDTH reached. */
11449 while (field_width
> 0
11450 && n
< field_width
)
11452 store_mode_line_noprop_char (' ');
11459 /***********************************************************************
11461 ***********************************************************************/
11463 #ifdef HAVE_WINDOW_SYSTEM
11465 /* Set the title of FRAME, if it has changed. The title format is
11466 Vicon_title_format if FRAME is iconified, otherwise it is
11467 frame_title_format. */
11470 x_consider_frame_title (Lisp_Object frame
)
11472 struct frame
*f
= XFRAME (frame
);
11474 if (FRAME_WINDOW_P (f
)
11475 || FRAME_MINIBUF_ONLY_P (f
)
11476 || f
->explicit_name
)
11478 /* Do we have more than one visible frame on this X display? */
11479 Lisp_Object tail
, other_frame
, fmt
;
11480 ptrdiff_t title_start
;
11486 FOR_EACH_FRAME (tail
, other_frame
)
11488 struct frame
*tf
= XFRAME (other_frame
);
11491 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11492 && !FRAME_MINIBUF_ONLY_P (tf
)
11493 && !EQ (other_frame
, tip_frame
)
11494 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11498 /* Set global variable indicating that multiple frames exist. */
11499 multiple_frames
= CONSP (tail
);
11501 /* Switch to the buffer of selected window of the frame. Set up
11502 mode_line_target so that display_mode_element will output into
11503 mode_line_noprop_buf; then display the title. */
11504 record_unwind_protect (unwind_format_mode_line
,
11505 format_mode_line_unwind_data
11506 (f
, current_buffer
, selected_window
, 0));
11508 Fselect_window (f
->selected_window
, Qt
);
11509 set_buffer_internal_1
11510 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11511 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11513 mode_line_target
= MODE_LINE_TITLE
;
11514 title_start
= MODE_LINE_NOPROP_LEN (0);
11515 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11516 NULL
, DEFAULT_FACE_ID
);
11517 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11518 len
= MODE_LINE_NOPROP_LEN (title_start
);
11519 title
= mode_line_noprop_buf
+ title_start
;
11522 /* Set the title only if it's changed. This avoids consing in
11523 the common case where it hasn't. (If it turns out that we've
11524 already wasted too much time by walking through the list with
11525 display_mode_element, then we might need to optimize at a
11526 higher level than this.) */
11527 if (! STRINGP (f
->name
)
11528 || SBYTES (f
->name
) != len
11529 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11530 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11534 #endif /* not HAVE_WINDOW_SYSTEM */
11537 /***********************************************************************
11539 ***********************************************************************/
11541 /* Non-zero if we will not redisplay all visible windows. */
11542 #define REDISPLAY_SOME_P() \
11543 ((windows_or_buffers_changed == 0 \
11544 || windows_or_buffers_changed == REDISPLAY_SOME) \
11545 && (update_mode_lines == 0 \
11546 || update_mode_lines == REDISPLAY_SOME))
11548 /* Prepare for redisplay by updating menu-bar item lists when
11549 appropriate. This can call eval. */
11552 prepare_menu_bars (void)
11554 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11555 bool some_windows
= REDISPLAY_SOME_P ();
11556 struct gcpro gcpro1
, gcpro2
;
11557 Lisp_Object tooltip_frame
;
11559 #ifdef HAVE_WINDOW_SYSTEM
11560 tooltip_frame
= tip_frame
;
11562 tooltip_frame
= Qnil
;
11565 if (FUNCTIONP (Vpre_redisplay_function
))
11567 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11568 if (all_windows
&& some_windows
)
11570 Lisp_Object ws
= window_list ();
11571 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11573 Lisp_Object
this = XCAR (ws
);
11574 struct window
*w
= XWINDOW (this);
11576 || XFRAME (w
->frame
)->redisplay
11577 || XBUFFER (w
->contents
)->text
->redisplay
)
11579 windows
= Fcons (this, windows
);
11583 safe__call1 (true, Vpre_redisplay_function
, windows
);
11586 /* Update all frame titles based on their buffer names, etc. We do
11587 this before the menu bars so that the buffer-menu will show the
11588 up-to-date frame titles. */
11589 #ifdef HAVE_WINDOW_SYSTEM
11592 Lisp_Object tail
, frame
;
11594 FOR_EACH_FRAME (tail
, frame
)
11596 struct frame
*f
= XFRAME (frame
);
11597 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11601 && !XBUFFER (w
->contents
)->text
->redisplay
)
11604 if (!EQ (frame
, tooltip_frame
)
11605 && (FRAME_ICONIFIED_P (f
)
11606 || FRAME_VISIBLE_P (f
) == 1
11607 /* Exclude TTY frames that are obscured because they
11608 are not the top frame on their console. This is
11609 because x_consider_frame_title actually switches
11610 to the frame, which for TTY frames means it is
11611 marked as garbaged, and will be completely
11612 redrawn on the next redisplay cycle. This causes
11613 TTY frames to be completely redrawn, when there
11614 are more than one of them, even though nothing
11615 should be changed on display. */
11616 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11617 x_consider_frame_title (frame
);
11620 #endif /* HAVE_WINDOW_SYSTEM */
11622 /* Update the menu bar item lists, if appropriate. This has to be
11623 done before any actual redisplay or generation of display lines. */
11627 Lisp_Object tail
, frame
;
11629 /* 1 means that update_menu_bar has run its hooks
11630 so any further calls to update_menu_bar shouldn't do so again. */
11631 int menu_bar_hooks_run
= 0;
11633 record_unwind_save_match_data ();
11635 FOR_EACH_FRAME (tail
, frame
)
11637 struct frame
*f
= XFRAME (frame
);
11638 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11640 /* Ignore tooltip frame. */
11641 if (EQ (frame
, tooltip_frame
))
11647 && !XBUFFER (w
->contents
)->text
->redisplay
)
11650 /* If a window on this frame changed size, report that to
11651 the user and clear the size-change flag. */
11652 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11654 Lisp_Object functions
;
11656 /* Clear flag first in case we get an error below. */
11657 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11658 functions
= Vwindow_size_change_functions
;
11659 GCPRO2 (tail
, functions
);
11661 while (CONSP (functions
))
11663 if (!EQ (XCAR (functions
), Qt
))
11664 call1 (XCAR (functions
), frame
);
11665 functions
= XCDR (functions
);
11671 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11672 #ifdef HAVE_WINDOW_SYSTEM
11673 update_tool_bar (f
, 0);
11676 if (windows_or_buffers_changed
11679 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11688 struct frame
*sf
= SELECTED_FRAME ();
11689 update_menu_bar (sf
, 1, 0);
11690 #ifdef HAVE_WINDOW_SYSTEM
11691 update_tool_bar (sf
, 1);
11697 /* Update the menu bar item list for frame F. This has to be done
11698 before we start to fill in any display lines, because it can call
11701 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11703 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11704 already ran the menu bar hooks for this redisplay, so there
11705 is no need to run them again. The return value is the
11706 updated value of this flag, to pass to the next call. */
11709 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11711 Lisp_Object window
;
11712 register struct window
*w
;
11714 /* If called recursively during a menu update, do nothing. This can
11715 happen when, for instance, an activate-menubar-hook causes a
11717 if (inhibit_menubar_update
)
11720 window
= FRAME_SELECTED_WINDOW (f
);
11721 w
= XWINDOW (window
);
11723 if (FRAME_WINDOW_P (f
)
11725 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11726 || defined (HAVE_NS) || defined (USE_GTK)
11727 FRAME_EXTERNAL_MENU_BAR (f
)
11729 FRAME_MENU_BAR_LINES (f
) > 0
11731 : FRAME_MENU_BAR_LINES (f
) > 0)
11733 /* If the user has switched buffers or windows, we need to
11734 recompute to reflect the new bindings. But we'll
11735 recompute when update_mode_lines is set too; that means
11736 that people can use force-mode-line-update to request
11737 that the menu bar be recomputed. The adverse effect on
11738 the rest of the redisplay algorithm is about the same as
11739 windows_or_buffers_changed anyway. */
11740 if (windows_or_buffers_changed
11741 /* This used to test w->update_mode_line, but we believe
11742 there is no need to recompute the menu in that case. */
11743 || update_mode_lines
11744 || window_buffer_changed (w
))
11746 struct buffer
*prev
= current_buffer
;
11749 specbind (Qinhibit_menubar_update
, Qt
);
11751 set_buffer_internal_1 (XBUFFER (w
->contents
));
11752 if (save_match_data
)
11753 record_unwind_save_match_data ();
11754 if (NILP (Voverriding_local_map_menu_flag
))
11756 specbind (Qoverriding_terminal_local_map
, Qnil
);
11757 specbind (Qoverriding_local_map
, Qnil
);
11762 /* Run the Lucid hook. */
11763 safe_run_hooks (Qactivate_menubar_hook
);
11765 /* If it has changed current-menubar from previous value,
11766 really recompute the menu-bar from the value. */
11767 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11768 call0 (Qrecompute_lucid_menubar
);
11770 safe_run_hooks (Qmenu_bar_update_hook
);
11775 XSETFRAME (Vmenu_updating_frame
, f
);
11776 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11778 /* Redisplay the menu bar in case we changed it. */
11779 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11780 || defined (HAVE_NS) || defined (USE_GTK)
11781 if (FRAME_WINDOW_P (f
))
11783 #if defined (HAVE_NS)
11784 /* All frames on Mac OS share the same menubar. So only
11785 the selected frame should be allowed to set it. */
11786 if (f
== SELECTED_FRAME ())
11788 set_frame_menubar (f
, 0, 0);
11791 /* On a terminal screen, the menu bar is an ordinary screen
11792 line, and this makes it get updated. */
11793 w
->update_mode_line
= 1;
11794 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11795 /* In the non-toolkit version, the menu bar is an ordinary screen
11796 line, and this makes it get updated. */
11797 w
->update_mode_line
= 1;
11798 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11801 set_buffer_internal_1 (prev
);
11808 /***********************************************************************
11810 ***********************************************************************/
11812 #ifdef HAVE_WINDOW_SYSTEM
11814 /* Select `frame' temporarily without running all the code in
11816 FIXME: Maybe do_switch_frame should be trimmed down similarly
11817 when `norecord' is set. */
11819 fast_set_selected_frame (Lisp_Object frame
)
11821 if (!EQ (selected_frame
, frame
))
11823 selected_frame
= frame
;
11824 selected_window
= XFRAME (frame
)->selected_window
;
11828 /* Update the tool-bar item list for frame F. This has to be done
11829 before we start to fill in any display lines. Called from
11830 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11831 and restore it here. */
11834 update_tool_bar (struct frame
*f
, int save_match_data
)
11836 #if defined (USE_GTK) || defined (HAVE_NS)
11837 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11839 int do_update
= (WINDOWP (f
->tool_bar_window
)
11840 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0);
11845 Lisp_Object window
;
11848 window
= FRAME_SELECTED_WINDOW (f
);
11849 w
= XWINDOW (window
);
11851 /* If the user has switched buffers or windows, we need to
11852 recompute to reflect the new bindings. But we'll
11853 recompute when update_mode_lines is set too; that means
11854 that people can use force-mode-line-update to request
11855 that the menu bar be recomputed. The adverse effect on
11856 the rest of the redisplay algorithm is about the same as
11857 windows_or_buffers_changed anyway. */
11858 if (windows_or_buffers_changed
11859 || w
->update_mode_line
11860 || update_mode_lines
11861 || window_buffer_changed (w
))
11863 struct buffer
*prev
= current_buffer
;
11865 Lisp_Object frame
, new_tool_bar
;
11866 int new_n_tool_bar
;
11867 struct gcpro gcpro1
;
11869 /* Set current_buffer to the buffer of the selected
11870 window of the frame, so that we get the right local
11872 set_buffer_internal_1 (XBUFFER (w
->contents
));
11874 /* Save match data, if we must. */
11875 if (save_match_data
)
11876 record_unwind_save_match_data ();
11878 /* Make sure that we don't accidentally use bogus keymaps. */
11879 if (NILP (Voverriding_local_map_menu_flag
))
11881 specbind (Qoverriding_terminal_local_map
, Qnil
);
11882 specbind (Qoverriding_local_map
, Qnil
);
11885 GCPRO1 (new_tool_bar
);
11887 /* We must temporarily set the selected frame to this frame
11888 before calling tool_bar_items, because the calculation of
11889 the tool-bar keymap uses the selected frame (see
11890 `tool-bar-make-keymap' in tool-bar.el). */
11891 eassert (EQ (selected_window
,
11892 /* Since we only explicitly preserve selected_frame,
11893 check that selected_window would be redundant. */
11894 XFRAME (selected_frame
)->selected_window
));
11895 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
11896 XSETFRAME (frame
, f
);
11897 fast_set_selected_frame (frame
);
11899 /* Build desired tool-bar items from keymaps. */
11901 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
11904 /* Redisplay the tool-bar if we changed it. */
11905 if (new_n_tool_bar
!= f
->n_tool_bar_items
11906 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
11908 /* Redisplay that happens asynchronously due to an expose event
11909 may access f->tool_bar_items. Make sure we update both
11910 variables within BLOCK_INPUT so no such event interrupts. */
11912 fset_tool_bar_items (f
, new_tool_bar
);
11913 f
->n_tool_bar_items
= new_n_tool_bar
;
11914 w
->update_mode_line
= 1;
11921 set_buffer_internal_1 (prev
);
11926 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
11928 /* Set F->desired_tool_bar_string to a Lisp string representing frame
11929 F's desired tool-bar contents. F->tool_bar_items must have
11930 been set up previously by calling prepare_menu_bars. */
11933 build_desired_tool_bar_string (struct frame
*f
)
11935 int i
, size
, size_needed
;
11936 struct gcpro gcpro1
, gcpro2
, gcpro3
;
11937 Lisp_Object image
, plist
, props
;
11939 image
= plist
= props
= Qnil
;
11940 GCPRO3 (image
, plist
, props
);
11942 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
11943 Otherwise, make a new string. */
11945 /* The size of the string we might be able to reuse. */
11946 size
= (STRINGP (f
->desired_tool_bar_string
)
11947 ? SCHARS (f
->desired_tool_bar_string
)
11950 /* We need one space in the string for each image. */
11951 size_needed
= f
->n_tool_bar_items
;
11953 /* Reuse f->desired_tool_bar_string, if possible. */
11954 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
11955 fset_desired_tool_bar_string
11956 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
11959 props
= list4 (Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
11960 Fremove_text_properties (make_number (0), make_number (size
),
11961 props
, f
->desired_tool_bar_string
);
11964 /* Put a `display' property on the string for the images to display,
11965 put a `menu_item' property on tool-bar items with a value that
11966 is the index of the item in F's tool-bar item vector. */
11967 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
11969 #define PROP(IDX) \
11970 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
11972 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
11973 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
11974 int hmargin
, vmargin
, relief
, idx
, end
;
11976 /* If image is a vector, choose the image according to the
11978 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
11979 if (VECTORP (image
))
11983 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
11984 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
11987 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
11988 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
11990 eassert (ASIZE (image
) >= idx
);
11991 image
= AREF (image
, idx
);
11996 /* Ignore invalid image specifications. */
11997 if (!valid_image_p (image
))
12000 /* Display the tool-bar button pressed, or depressed. */
12001 plist
= Fcopy_sequence (XCDR (image
));
12003 /* Compute margin and relief to draw. */
12004 relief
= (tool_bar_button_relief
>= 0
12005 ? tool_bar_button_relief
12006 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12007 hmargin
= vmargin
= relief
;
12009 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12010 INT_MAX
- max (hmargin
, vmargin
)))
12012 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12013 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12015 else if (CONSP (Vtool_bar_button_margin
))
12017 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12018 INT_MAX
- hmargin
))
12019 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12021 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12022 INT_MAX
- vmargin
))
12023 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12026 if (auto_raise_tool_bar_buttons_p
)
12028 /* Add a `:relief' property to the image spec if the item is
12032 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12039 /* If image is selected, display it pressed, i.e. with a
12040 negative relief. If it's not selected, display it with a
12042 plist
= Fplist_put (plist
, QCrelief
,
12044 ? make_number (-relief
)
12045 : make_number (relief
)));
12050 /* Put a margin around the image. */
12051 if (hmargin
|| vmargin
)
12053 if (hmargin
== vmargin
)
12054 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12056 plist
= Fplist_put (plist
, QCmargin
,
12057 Fcons (make_number (hmargin
),
12058 make_number (vmargin
)));
12061 /* If button is not enabled, and we don't have special images
12062 for the disabled state, make the image appear disabled by
12063 applying an appropriate algorithm to it. */
12064 if (!enabled_p
&& idx
< 0)
12065 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12067 /* Put a `display' text property on the string for the image to
12068 display. Put a `menu-item' property on the string that gives
12069 the start of this item's properties in the tool-bar items
12071 image
= Fcons (Qimage
, plist
);
12072 props
= list4 (Qdisplay
, image
,
12073 Qmenu_item
, make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12075 /* Let the last image hide all remaining spaces in the tool bar
12076 string. The string can be longer than needed when we reuse a
12077 previous string. */
12078 if (i
+ 1 == f
->n_tool_bar_items
)
12079 end
= SCHARS (f
->desired_tool_bar_string
);
12082 Fadd_text_properties (make_number (i
), make_number (end
),
12083 props
, f
->desired_tool_bar_string
);
12091 /* Display one line of the tool-bar of frame IT->f.
12093 HEIGHT specifies the desired height of the tool-bar line.
12094 If the actual height of the glyph row is less than HEIGHT, the
12095 row's height is increased to HEIGHT, and the icons are centered
12096 vertically in the new height.
12098 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12099 count a final empty row in case the tool-bar width exactly matches
12104 display_tool_bar_line (struct it
*it
, int height
)
12106 struct glyph_row
*row
= it
->glyph_row
;
12107 int max_x
= it
->last_visible_x
;
12108 struct glyph
*last
;
12110 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12111 clear_glyph_row (row
);
12112 row
->enabled_p
= true;
12113 row
->y
= it
->current_y
;
12115 /* Note that this isn't made use of if the face hasn't a box,
12116 so there's no need to check the face here. */
12117 it
->start_of_box_run_p
= 1;
12119 while (it
->current_x
< max_x
)
12121 int x
, n_glyphs_before
, i
, nglyphs
;
12122 struct it it_before
;
12124 /* Get the next display element. */
12125 if (!get_next_display_element (it
))
12127 /* Don't count empty row if we are counting needed tool-bar lines. */
12128 if (height
< 0 && !it
->hpos
)
12133 /* Produce glyphs. */
12134 n_glyphs_before
= row
->used
[TEXT_AREA
];
12137 PRODUCE_GLYPHS (it
);
12139 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12141 x
= it_before
.current_x
;
12142 while (i
< nglyphs
)
12144 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12146 if (x
+ glyph
->pixel_width
> max_x
)
12148 /* Glyph doesn't fit on line. Backtrack. */
12149 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12151 /* If this is the only glyph on this line, it will never fit on the
12152 tool-bar, so skip it. But ensure there is at least one glyph,
12153 so we don't accidentally disable the tool-bar. */
12154 if (n_glyphs_before
== 0
12155 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12161 x
+= glyph
->pixel_width
;
12165 /* Stop at line end. */
12166 if (ITERATOR_AT_END_OF_LINE_P (it
))
12169 set_iterator_to_next (it
, 1);
12174 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12176 /* Use default face for the border below the tool bar.
12178 FIXME: When auto-resize-tool-bars is grow-only, there is
12179 no additional border below the possibly empty tool-bar lines.
12180 So to make the extra empty lines look "normal", we have to
12181 use the tool-bar face for the border too. */
12182 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12183 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12184 it
->face_id
= DEFAULT_FACE_ID
;
12186 extend_face_to_end_of_line (it
);
12187 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12188 last
->right_box_line_p
= 1;
12189 if (last
== row
->glyphs
[TEXT_AREA
])
12190 last
->left_box_line_p
= 1;
12192 /* Make line the desired height and center it vertically. */
12193 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12195 /* Don't add more than one line height. */
12196 height
%= FRAME_LINE_HEIGHT (it
->f
);
12197 it
->max_ascent
+= height
/ 2;
12198 it
->max_descent
+= (height
+ 1) / 2;
12201 compute_line_metrics (it
);
12203 /* If line is empty, make it occupy the rest of the tool-bar. */
12204 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12206 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12207 row
->visible_height
= row
->height
;
12208 row
->ascent
= row
->phys_ascent
= 0;
12209 row
->extra_line_spacing
= 0;
12212 row
->full_width_p
= 1;
12213 row
->continued_p
= 0;
12214 row
->truncated_on_left_p
= 0;
12215 row
->truncated_on_right_p
= 0;
12217 it
->current_x
= it
->hpos
= 0;
12218 it
->current_y
+= row
->height
;
12224 /* Max tool-bar height. Basically, this is what makes all other windows
12225 disappear when the frame gets too small. Rethink this! */
12227 #define MAX_FRAME_TOOL_BAR_HEIGHT(f) \
12228 ((FRAME_LINE_HEIGHT (f) * FRAME_LINES (f)))
12230 /* Value is the number of pixels needed to make all tool-bar items of
12231 frame F visible. The actual number of glyph rows needed is
12232 returned in *N_ROWS if non-NULL. */
12235 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12237 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12239 /* tool_bar_height is called from redisplay_tool_bar after building
12240 the desired matrix, so use (unused) mode-line row as temporary row to
12241 avoid destroying the first tool-bar row. */
12242 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12244 /* Initialize an iterator for iteration over
12245 F->desired_tool_bar_string in the tool-bar window of frame F. */
12246 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12247 it
.first_visible_x
= 0;
12248 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12249 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12250 it
.paragraph_embedding
= L2R
;
12252 while (!ITERATOR_AT_END_P (&it
))
12254 clear_glyph_row (temp_row
);
12255 it
.glyph_row
= temp_row
;
12256 display_tool_bar_line (&it
, -1);
12258 clear_glyph_row (temp_row
);
12260 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12262 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12265 return it
.current_y
;
12267 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12270 #endif /* !USE_GTK && !HAVE_NS */
12272 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12274 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12275 If FRAME is nil or omitted, use the selected frame. Optional argument
12276 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12277 (Lisp_Object frame
, Lisp_Object pixelwise
)
12281 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12282 struct frame
*f
= decode_any_frame (frame
);
12284 if (WINDOWP (f
->tool_bar_window
)
12285 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12287 update_tool_bar (f
, 1);
12288 if (f
->n_tool_bar_items
)
12290 build_desired_tool_bar_string (f
);
12291 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12296 return make_number (height
);
12300 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12301 height should be changed. */
12304 redisplay_tool_bar (struct frame
*f
)
12306 #if defined (USE_GTK) || defined (HAVE_NS)
12308 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12309 update_frame_tool_bar (f
);
12312 #else /* !USE_GTK && !HAVE_NS */
12316 struct glyph_row
*row
;
12318 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12319 do anything. This means you must start with tool-bar-lines
12320 non-zero to get the auto-sizing effect. Or in other words, you
12321 can turn off tool-bars by specifying tool-bar-lines zero. */
12322 if (!WINDOWP (f
->tool_bar_window
)
12323 || (w
= XWINDOW (f
->tool_bar_window
),
12324 WINDOW_PIXEL_HEIGHT (w
) == 0))
12327 /* Set up an iterator for the tool-bar window. */
12328 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12329 it
.first_visible_x
= 0;
12330 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12331 row
= it
.glyph_row
;
12333 /* Build a string that represents the contents of the tool-bar. */
12334 build_desired_tool_bar_string (f
);
12335 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12336 /* FIXME: This should be controlled by a user option. But it
12337 doesn't make sense to have an R2L tool bar if the menu bar cannot
12338 be drawn also R2L, and making the menu bar R2L is tricky due
12339 toolkit-specific code that implements it. If an R2L tool bar is
12340 ever supported, display_tool_bar_line should also be augmented to
12341 call unproduce_glyphs like display_line and display_string
12343 it
.paragraph_embedding
= L2R
;
12345 if (f
->n_tool_bar_rows
== 0)
12347 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12349 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12352 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12353 / FRAME_LINE_HEIGHT (f
));
12355 XSETFRAME (frame
, f
);
12356 Fmodify_frame_parameters (frame
,
12357 list1 (Fcons (Qtool_bar_lines
,
12358 make_number (new_lines
))));
12359 /* Always do that now. */
12360 clear_glyph_matrix (w
->desired_matrix
);
12361 f
->fonts_changed
= 1;
12366 /* Display as many lines as needed to display all tool-bar items. */
12368 if (f
->n_tool_bar_rows
> 0)
12370 int border
, rows
, height
, extra
;
12372 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12373 border
= XINT (Vtool_bar_border
);
12374 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12375 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12376 else if (EQ (Vtool_bar_border
, Qborder_width
))
12377 border
= f
->border_width
;
12383 rows
= f
->n_tool_bar_rows
;
12384 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12385 extra
= it
.last_visible_y
- border
- height
* rows
;
12387 while (it
.current_y
< it
.last_visible_y
)
12390 if (extra
> 0 && rows
-- > 0)
12392 h
= (extra
+ rows
- 1) / rows
;
12395 display_tool_bar_line (&it
, height
+ h
);
12400 while (it
.current_y
< it
.last_visible_y
)
12401 display_tool_bar_line (&it
, 0);
12404 /* It doesn't make much sense to try scrolling in the tool-bar
12405 window, so don't do it. */
12406 w
->desired_matrix
->no_scrolling_p
= 1;
12407 w
->must_be_updated_p
= 1;
12409 if (!NILP (Vauto_resize_tool_bars
))
12411 /* Do we really allow the toolbar to occupy the whole frame? */
12412 int max_tool_bar_height
= MAX_FRAME_TOOL_BAR_HEIGHT (f
);
12413 int change_height_p
= 0;
12415 /* If we couldn't display everything, change the tool-bar's
12416 height if there is room for more. */
12417 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
12418 && it
.current_y
< max_tool_bar_height
)
12419 change_height_p
= 1;
12421 /* We subtract 1 because display_tool_bar_line advances the
12422 glyph_row pointer before returning to its caller. We want to
12423 examine the last glyph row produced by
12424 display_tool_bar_line. */
12425 row
= it
.glyph_row
- 1;
12427 /* If there are blank lines at the end, except for a partially
12428 visible blank line at the end that is smaller than
12429 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12430 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12431 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12432 change_height_p
= 1;
12434 /* If row displays tool-bar items, but is partially visible,
12435 change the tool-bar's height. */
12436 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12437 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
12438 && MATRIX_ROW_BOTTOM_Y (row
) < max_tool_bar_height
)
12439 change_height_p
= 1;
12441 /* Resize windows as needed by changing the `tool-bar-lines'
12442 frame parameter. */
12443 if (change_height_p
)
12447 int new_height
= tool_bar_height (f
, &nrows
, 1);
12449 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12450 && !f
->minimize_tool_bar_window_p
)
12451 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12452 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12453 f
->minimize_tool_bar_window_p
= 0;
12455 if (change_height_p
)
12457 /* Current size of the tool-bar window in canonical line
12459 int old_lines
= WINDOW_TOTAL_LINES (w
);
12460 /* Required size of the tool-bar window in canonical
12462 int new_lines
= ((new_height
+ FRAME_LINE_HEIGHT (f
) - 1)
12463 / FRAME_LINE_HEIGHT (f
));
12464 /* Maximum size of the tool-bar window in canonical line
12465 units that this frame can allow. */
12467 WINDOW_TOTAL_LINES (XWINDOW (FRAME_ROOT_WINDOW (f
))) - 1;
12469 /* Don't try to change the tool-bar window size and set
12470 the fonts_changed flag unless really necessary. That
12471 flag causes redisplay to give up and retry
12472 redisplaying the frame from scratch, so setting it
12473 unnecessarily can lead to nasty redisplay loops. */
12474 if (new_lines
<= max_lines
12475 && eabs (new_lines
- old_lines
) >= 1)
12477 XSETFRAME (frame
, f
);
12478 Fmodify_frame_parameters (frame
,
12479 list1 (Fcons (Qtool_bar_lines
,
12480 make_number (new_lines
))));
12481 clear_glyph_matrix (w
->desired_matrix
);
12482 f
->n_tool_bar_rows
= nrows
;
12483 f
->fonts_changed
= 1;
12490 f
->minimize_tool_bar_window_p
= 0;
12493 #endif /* USE_GTK || HAVE_NS */
12496 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12498 /* Get information about the tool-bar item which is displayed in GLYPH
12499 on frame F. Return in *PROP_IDX the index where tool-bar item
12500 properties start in F->tool_bar_items. Value is zero if
12501 GLYPH doesn't display a tool-bar item. */
12504 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12510 /* This function can be called asynchronously, which means we must
12511 exclude any possibility that Fget_text_property signals an
12513 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12514 charpos
= max (0, charpos
);
12516 /* Get the text property `menu-item' at pos. The value of that
12517 property is the start index of this item's properties in
12518 F->tool_bar_items. */
12519 prop
= Fget_text_property (make_number (charpos
),
12520 Qmenu_item
, f
->current_tool_bar_string
);
12521 if (INTEGERP (prop
))
12523 *prop_idx
= XINT (prop
);
12533 /* Get information about the tool-bar item at position X/Y on frame F.
12534 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12535 the current matrix of the tool-bar window of F, or NULL if not
12536 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12537 item in F->tool_bar_items. Value is
12539 -1 if X/Y is not on a tool-bar item
12540 0 if X/Y is on the same item that was highlighted before.
12544 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12545 int *hpos
, int *vpos
, int *prop_idx
)
12547 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12548 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12551 /* Find the glyph under X/Y. */
12552 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12553 if (*glyph
== NULL
)
12556 /* Get the start of this tool-bar item's properties in
12557 f->tool_bar_items. */
12558 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12561 /* Is mouse on the highlighted item? */
12562 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12563 && *vpos
>= hlinfo
->mouse_face_beg_row
12564 && *vpos
<= hlinfo
->mouse_face_end_row
12565 && (*vpos
> hlinfo
->mouse_face_beg_row
12566 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12567 && (*vpos
< hlinfo
->mouse_face_end_row
12568 || *hpos
< hlinfo
->mouse_face_end_col
12569 || hlinfo
->mouse_face_past_end
))
12577 Handle mouse button event on the tool-bar of frame F, at
12578 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12579 0 for button release. MODIFIERS is event modifiers for button
12583 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12586 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12587 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12588 int hpos
, vpos
, prop_idx
;
12589 struct glyph
*glyph
;
12590 Lisp_Object enabled_p
;
12593 /* If not on the highlighted tool-bar item, and mouse-highlight is
12594 non-nil, return. This is so we generate the tool-bar button
12595 click only when the mouse button is released on the same item as
12596 where it was pressed. However, when mouse-highlight is disabled,
12597 generate the click when the button is released regardless of the
12598 highlight, since tool-bar items are not highlighted in that
12600 frame_to_window_pixel_xy (w
, &x
, &y
);
12601 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12603 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12606 /* When mouse-highlight is off, generate the click for the item
12607 where the button was pressed, disregarding where it was
12609 if (NILP (Vmouse_highlight
) && !down_p
)
12610 prop_idx
= f
->last_tool_bar_item
;
12612 /* If item is disabled, do nothing. */
12613 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12614 if (NILP (enabled_p
))
12619 /* Show item in pressed state. */
12620 if (!NILP (Vmouse_highlight
))
12621 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12622 f
->last_tool_bar_item
= prop_idx
;
12626 Lisp_Object key
, frame
;
12627 struct input_event event
;
12628 EVENT_INIT (event
);
12630 /* Show item in released state. */
12631 if (!NILP (Vmouse_highlight
))
12632 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12634 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12636 XSETFRAME (frame
, f
);
12637 event
.kind
= TOOL_BAR_EVENT
;
12638 event
.frame_or_window
= frame
;
12640 kbd_buffer_store_event (&event
);
12642 event
.kind
= TOOL_BAR_EVENT
;
12643 event
.frame_or_window
= frame
;
12645 event
.modifiers
= modifiers
;
12646 kbd_buffer_store_event (&event
);
12647 f
->last_tool_bar_item
= -1;
12652 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12653 tool-bar window-relative coordinates X/Y. Called from
12654 note_mouse_highlight. */
12657 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12659 Lisp_Object window
= f
->tool_bar_window
;
12660 struct window
*w
= XWINDOW (window
);
12661 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12662 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12664 struct glyph
*glyph
;
12665 struct glyph_row
*row
;
12667 Lisp_Object enabled_p
;
12669 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12670 int mouse_down_p
, rc
;
12672 /* Function note_mouse_highlight is called with negative X/Y
12673 values when mouse moves outside of the frame. */
12674 if (x
<= 0 || y
<= 0)
12676 clear_mouse_face (hlinfo
);
12680 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12683 /* Not on tool-bar item. */
12684 clear_mouse_face (hlinfo
);
12688 /* On same tool-bar item as before. */
12689 goto set_help_echo
;
12691 clear_mouse_face (hlinfo
);
12693 /* Mouse is down, but on different tool-bar item? */
12694 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12695 && f
== dpyinfo
->last_mouse_frame
);
12697 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12700 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12702 /* If tool-bar item is not enabled, don't highlight it. */
12703 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12704 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12706 /* Compute the x-position of the glyph. In front and past the
12707 image is a space. We include this in the highlighted area. */
12708 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12709 for (i
= x
= 0; i
< hpos
; ++i
)
12710 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12712 /* Record this as the current active region. */
12713 hlinfo
->mouse_face_beg_col
= hpos
;
12714 hlinfo
->mouse_face_beg_row
= vpos
;
12715 hlinfo
->mouse_face_beg_x
= x
;
12716 hlinfo
->mouse_face_past_end
= 0;
12718 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12719 hlinfo
->mouse_face_end_row
= vpos
;
12720 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12721 hlinfo
->mouse_face_window
= window
;
12722 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12724 /* Display it as active. */
12725 show_mouse_face (hlinfo
, draw
);
12730 /* Set help_echo_string to a help string to display for this tool-bar item.
12731 XTread_socket does the rest. */
12732 help_echo_object
= help_echo_window
= Qnil
;
12733 help_echo_pos
= -1;
12734 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12735 if (NILP (help_echo_string
))
12736 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12739 #endif /* !USE_GTK && !HAVE_NS */
12741 #endif /* HAVE_WINDOW_SYSTEM */
12745 /************************************************************************
12746 Horizontal scrolling
12747 ************************************************************************/
12749 static int hscroll_window_tree (Lisp_Object
);
12750 static int hscroll_windows (Lisp_Object
);
12752 /* For all leaf windows in the window tree rooted at WINDOW, set their
12753 hscroll value so that PT is (i) visible in the window, and (ii) so
12754 that it is not within a certain margin at the window's left and
12755 right border. Value is non-zero if any window's hscroll has been
12759 hscroll_window_tree (Lisp_Object window
)
12761 int hscrolled_p
= 0;
12762 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12763 int hscroll_step_abs
= 0;
12764 double hscroll_step_rel
= 0;
12766 if (hscroll_relative_p
)
12768 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12769 if (hscroll_step_rel
< 0)
12771 hscroll_relative_p
= 0;
12772 hscroll_step_abs
= 0;
12775 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12777 hscroll_step_abs
= XINT (Vhscroll_step
);
12778 if (hscroll_step_abs
< 0)
12779 hscroll_step_abs
= 0;
12782 hscroll_step_abs
= 0;
12784 while (WINDOWP (window
))
12786 struct window
*w
= XWINDOW (window
);
12788 if (WINDOWP (w
->contents
))
12789 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12790 else if (w
->cursor
.vpos
>= 0)
12793 int text_area_width
;
12794 struct glyph_row
*cursor_row
;
12795 struct glyph_row
*bottom_row
;
12798 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12799 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12800 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12802 cursor_row
= bottom_row
- 1;
12804 if (!cursor_row
->enabled_p
)
12806 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12807 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12808 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12810 cursor_row
= bottom_row
- 1;
12812 row_r2l_p
= cursor_row
->reversed_p
;
12814 text_area_width
= window_box_width (w
, TEXT_AREA
);
12816 /* Scroll when cursor is inside this scroll margin. */
12817 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12819 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12820 /* For left-to-right rows, hscroll when cursor is either
12821 (i) inside the right hscroll margin, or (ii) if it is
12822 inside the left margin and the window is already
12826 && w
->cursor
.x
<= h_margin
)
12827 || (cursor_row
->enabled_p
12828 && cursor_row
->truncated_on_right_p
12829 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12830 /* For right-to-left rows, the logic is similar,
12831 except that rules for scrolling to left and right
12832 are reversed. E.g., if cursor.x <= h_margin, we
12833 need to hscroll "to the right" unconditionally,
12834 and that will scroll the screen to the left so as
12835 to reveal the next portion of the row. */
12837 && ((cursor_row
->enabled_p
12838 /* FIXME: It is confusing to set the
12839 truncated_on_right_p flag when R2L rows
12840 are actually truncated on the left. */
12841 && cursor_row
->truncated_on_right_p
12842 && w
->cursor
.x
<= h_margin
)
12844 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12848 struct buffer
*saved_current_buffer
;
12852 /* Find point in a display of infinite width. */
12853 saved_current_buffer
= current_buffer
;
12854 current_buffer
= XBUFFER (w
->contents
);
12856 if (w
== XWINDOW (selected_window
))
12859 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12861 /* Move iterator to pt starting at cursor_row->start in
12862 a line with infinite width. */
12863 init_to_row_start (&it
, w
, cursor_row
);
12864 it
.last_visible_x
= INFINITY
;
12865 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12866 current_buffer
= saved_current_buffer
;
12868 /* Position cursor in window. */
12869 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12870 hscroll
= max (0, (it
.current_x
12871 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12872 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12873 : (text_area_width
/ 2))))
12874 / FRAME_COLUMN_WIDTH (it
.f
);
12875 else if ((!row_r2l_p
12876 && w
->cursor
.x
>= text_area_width
- h_margin
)
12877 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12879 if (hscroll_relative_p
)
12880 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12883 wanted_x
= text_area_width
12884 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12887 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12891 if (hscroll_relative_p
)
12892 wanted_x
= text_area_width
* hscroll_step_rel
12895 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12898 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12900 hscroll
= max (hscroll
, w
->min_hscroll
);
12902 /* Don't prevent redisplay optimizations if hscroll
12903 hasn't changed, as it will unnecessarily slow down
12905 if (w
->hscroll
!= hscroll
)
12907 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
12908 w
->hscroll
= hscroll
;
12917 /* Value is non-zero if hscroll of any leaf window has been changed. */
12918 return hscrolled_p
;
12922 /* Set hscroll so that cursor is visible and not inside horizontal
12923 scroll margins for all windows in the tree rooted at WINDOW. See
12924 also hscroll_window_tree above. Value is non-zero if any window's
12925 hscroll has been changed. If it has, desired matrices on the frame
12926 of WINDOW are cleared. */
12929 hscroll_windows (Lisp_Object window
)
12931 int hscrolled_p
= hscroll_window_tree (window
);
12933 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
12934 return hscrolled_p
;
12939 /************************************************************************
12941 ************************************************************************/
12943 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
12944 to a non-zero value. This is sometimes handy to have in a debugger
12949 /* First and last unchanged row for try_window_id. */
12951 static int debug_first_unchanged_at_end_vpos
;
12952 static int debug_last_unchanged_at_beg_vpos
;
12954 /* Delta vpos and y. */
12956 static int debug_dvpos
, debug_dy
;
12958 /* Delta in characters and bytes for try_window_id. */
12960 static ptrdiff_t debug_delta
, debug_delta_bytes
;
12962 /* Values of window_end_pos and window_end_vpos at the end of
12965 static ptrdiff_t debug_end_vpos
;
12967 /* Append a string to W->desired_matrix->method. FMT is a printf
12968 format string. If trace_redisplay_p is true also printf the
12969 resulting string to stderr. */
12971 static void debug_method_add (struct window
*, char const *, ...)
12972 ATTRIBUTE_FORMAT_PRINTF (2, 3);
12975 debug_method_add (struct window
*w
, char const *fmt
, ...)
12978 char *method
= w
->desired_matrix
->method
;
12979 int len
= strlen (method
);
12980 int size
= sizeof w
->desired_matrix
->method
;
12981 int remaining
= size
- len
- 1;
12984 if (len
&& remaining
)
12987 --remaining
, ++len
;
12990 va_start (ap
, fmt
);
12991 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
12994 if (trace_redisplay_p
)
12995 fprintf (stderr
, "%p (%s): %s\n",
12997 ((BUFFERP (w
->contents
)
12998 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
12999 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13004 #endif /* GLYPH_DEBUG */
13007 /* Value is non-zero if all changes in window W, which displays
13008 current_buffer, are in the text between START and END. START is a
13009 buffer position, END is given as a distance from Z. Used in
13010 redisplay_internal for display optimization. */
13013 text_outside_line_unchanged_p (struct window
*w
,
13014 ptrdiff_t start
, ptrdiff_t end
)
13016 int unchanged_p
= 1;
13018 /* If text or overlays have changed, see where. */
13019 if (window_outdated (w
))
13021 /* Gap in the line? */
13022 if (GPT
< start
|| Z
- GPT
< end
)
13025 /* Changes start in front of the line, or end after it? */
13027 && (BEG_UNCHANGED
< start
- 1
13028 || END_UNCHANGED
< end
))
13031 /* If selective display, can't optimize if changes start at the
13032 beginning of the line. */
13034 && INTEGERP (BVAR (current_buffer
, selective_display
))
13035 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13036 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13039 /* If there are overlays at the start or end of the line, these
13040 may have overlay strings with newlines in them. A change at
13041 START, for instance, may actually concern the display of such
13042 overlay strings as well, and they are displayed on different
13043 lines. So, quickly rule out this case. (For the future, it
13044 might be desirable to implement something more telling than
13045 just BEG/END_UNCHANGED.) */
13048 if (BEG
+ BEG_UNCHANGED
== start
13049 && overlay_touches_p (start
))
13051 if (END_UNCHANGED
== end
13052 && overlay_touches_p (Z
- end
))
13056 /* Under bidi reordering, adding or deleting a character in the
13057 beginning of a paragraph, before the first strong directional
13058 character, can change the base direction of the paragraph (unless
13059 the buffer specifies a fixed paragraph direction), which will
13060 require to redisplay the whole paragraph. It might be worthwhile
13061 to find the paragraph limits and widen the range of redisplayed
13062 lines to that, but for now just give up this optimization. */
13063 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13064 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13068 return unchanged_p
;
13072 /* Do a frame update, taking possible shortcuts into account. This is
13073 the main external entry point for redisplay.
13075 If the last redisplay displayed an echo area message and that message
13076 is no longer requested, we clear the echo area or bring back the
13077 mini-buffer if that is in use. */
13082 redisplay_internal ();
13087 overlay_arrow_string_or_property (Lisp_Object var
)
13091 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13094 return Voverlay_arrow_string
;
13097 /* Return 1 if there are any overlay-arrows in current_buffer. */
13099 overlay_arrow_in_current_buffer_p (void)
13103 for (vlist
= Voverlay_arrow_variable_list
;
13105 vlist
= XCDR (vlist
))
13107 Lisp_Object var
= XCAR (vlist
);
13110 if (!SYMBOLP (var
))
13112 val
= find_symbol_value (var
);
13114 && current_buffer
== XMARKER (val
)->buffer
)
13121 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13125 overlay_arrows_changed_p (void)
13129 for (vlist
= Voverlay_arrow_variable_list
;
13131 vlist
= XCDR (vlist
))
13133 Lisp_Object var
= XCAR (vlist
);
13134 Lisp_Object val
, pstr
;
13136 if (!SYMBOLP (var
))
13138 val
= find_symbol_value (var
);
13139 if (!MARKERP (val
))
13141 if (! EQ (COERCE_MARKER (val
),
13142 Fget (var
, Qlast_arrow_position
))
13143 || ! (pstr
= overlay_arrow_string_or_property (var
),
13144 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13150 /* Mark overlay arrows to be updated on next redisplay. */
13153 update_overlay_arrows (int up_to_date
)
13157 for (vlist
= Voverlay_arrow_variable_list
;
13159 vlist
= XCDR (vlist
))
13161 Lisp_Object var
= XCAR (vlist
);
13163 if (!SYMBOLP (var
))
13166 if (up_to_date
> 0)
13168 Lisp_Object val
= find_symbol_value (var
);
13169 Fput (var
, Qlast_arrow_position
,
13170 COERCE_MARKER (val
));
13171 Fput (var
, Qlast_arrow_string
,
13172 overlay_arrow_string_or_property (var
));
13174 else if (up_to_date
< 0
13175 || !NILP (Fget (var
, Qlast_arrow_position
)))
13177 Fput (var
, Qlast_arrow_position
, Qt
);
13178 Fput (var
, Qlast_arrow_string
, Qt
);
13184 /* Return overlay arrow string to display at row.
13185 Return integer (bitmap number) for arrow bitmap in left fringe.
13186 Return nil if no overlay arrow. */
13189 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13193 for (vlist
= Voverlay_arrow_variable_list
;
13195 vlist
= XCDR (vlist
))
13197 Lisp_Object var
= XCAR (vlist
);
13200 if (!SYMBOLP (var
))
13203 val
= find_symbol_value (var
);
13206 && current_buffer
== XMARKER (val
)->buffer
13207 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13209 if (FRAME_WINDOW_P (it
->f
)
13210 /* FIXME: if ROW->reversed_p is set, this should test
13211 the right fringe, not the left one. */
13212 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13214 #ifdef HAVE_WINDOW_SYSTEM
13215 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13218 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13219 return make_number (fringe_bitmap
);
13222 return make_number (-1); /* Use default arrow bitmap. */
13224 return overlay_arrow_string_or_property (var
);
13231 /* Return 1 if point moved out of or into a composition. Otherwise
13232 return 0. PREV_BUF and PREV_PT are the last point buffer and
13233 position. BUF and PT are the current point buffer and position. */
13236 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13237 struct buffer
*buf
, ptrdiff_t pt
)
13239 ptrdiff_t start
, end
;
13241 Lisp_Object buffer
;
13243 XSETBUFFER (buffer
, buf
);
13244 /* Check a composition at the last point if point moved within the
13246 if (prev_buf
== buf
)
13249 /* Point didn't move. */
13252 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13253 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13254 && composition_valid_p (start
, end
, prop
)
13255 && start
< prev_pt
&& end
> prev_pt
)
13256 /* The last point was within the composition. Return 1 iff
13257 point moved out of the composition. */
13258 return (pt
<= start
|| pt
>= end
);
13261 /* Check a composition at the current point. */
13262 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13263 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13264 && composition_valid_p (start
, end
, prop
)
13265 && start
< pt
&& end
> pt
);
13268 /* Reconsider the clip changes of buffer which is displayed in W. */
13271 reconsider_clip_changes (struct window
*w
)
13273 struct buffer
*b
= XBUFFER (w
->contents
);
13275 if (b
->clip_changed
13276 && w
->window_end_valid
13277 && w
->current_matrix
->buffer
== b
13278 && w
->current_matrix
->zv
== BUF_ZV (b
)
13279 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13280 b
->clip_changed
= 0;
13282 /* If display wasn't paused, and W is not a tool bar window, see if
13283 point has been moved into or out of a composition. In that case,
13284 we set b->clip_changed to 1 to force updating the screen. If
13285 b->clip_changed has already been set to 1, we can skip this
13287 if (!b
->clip_changed
&& w
->window_end_valid
)
13289 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13290 ? PT
: marker_position (w
->pointm
));
13292 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13293 && check_point_in_composition (w
->current_matrix
->buffer
,
13294 w
->last_point
, b
, pt
))
13295 b
->clip_changed
= 1;
13300 propagate_buffer_redisplay (void)
13301 { /* Resetting b->text->redisplay is problematic!
13302 We can't just reset it in the case that some window that displays
13303 it has not been redisplayed; and such a window can stay
13304 unredisplayed for a long time if it's currently invisible.
13305 But we do want to reset it at the end of redisplay otherwise
13306 its displayed windows will keep being redisplayed over and over
13308 So we copy all b->text->redisplay flags up to their windows here,
13309 such that mark_window_display_accurate can safely reset
13310 b->text->redisplay. */
13311 Lisp_Object ws
= window_list ();
13312 for (; CONSP (ws
); ws
= XCDR (ws
))
13314 struct window
*thisw
= XWINDOW (XCAR (ws
));
13315 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13316 if (thisb
->text
->redisplay
)
13317 thisw
->redisplay
= true;
13321 /* Perhaps in the future avoid recentering windows if it
13322 is not necessary; currently that causes some problems. */
13325 redisplay_internal (void)
13327 struct window
*w
= XWINDOW (selected_window
);
13331 bool must_finish
= 0, match_p
;
13332 struct text_pos tlbufpos
, tlendpos
;
13333 int number_of_visible_frames
;
13336 int polling_stopped_here
= 0;
13337 Lisp_Object tail
, frame
;
13339 /* True means redisplay has to consider all windows on all
13340 frames. False, only selected_window is considered. */
13341 bool consider_all_windows_p
;
13343 /* True means redisplay has to redisplay the miniwindow. */
13344 bool update_miniwindow_p
= false;
13346 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13348 /* No redisplay if running in batch mode or frame is not yet fully
13349 initialized, or redisplay is explicitly turned off by setting
13350 Vinhibit_redisplay. */
13351 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13352 || !NILP (Vinhibit_redisplay
))
13355 /* Don't examine these until after testing Vinhibit_redisplay.
13356 When Emacs is shutting down, perhaps because its connection to
13357 X has dropped, we should not look at them at all. */
13358 fr
= XFRAME (w
->frame
);
13359 sf
= SELECTED_FRAME ();
13361 if (!fr
->glyphs_initialized_p
)
13364 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13365 if (popup_activated ())
13369 /* I don't think this happens but let's be paranoid. */
13370 if (redisplaying_p
)
13373 /* Record a function that clears redisplaying_p
13374 when we leave this function. */
13376 record_unwind_protect_void (unwind_redisplay
);
13377 redisplaying_p
= 1;
13378 specbind (Qinhibit_free_realized_faces
, Qnil
);
13380 /* Record this function, so it appears on the profiler's backtraces. */
13381 /*record_in_backtrace (Qredisplay_internal, &Qnil, 0);*/
13383 FOR_EACH_FRAME (tail
, frame
)
13384 XFRAME (frame
)->already_hscrolled_p
= 0;
13387 /* Remember the currently selected window. */
13391 last_escape_glyph_frame
= NULL
;
13392 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13393 last_glyphless_glyph_frame
= NULL
;
13394 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13396 /* If face_change_count is non-zero, init_iterator will free all
13397 realized faces, which includes the faces referenced from current
13398 matrices. So, we can't reuse current matrices in this case. */
13399 if (face_change_count
)
13400 windows_or_buffers_changed
= 47;
13402 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13403 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13405 /* Since frames on a single ASCII terminal share the same
13406 display area, displaying a different frame means redisplay
13407 the whole thing. */
13408 SET_FRAME_GARBAGED (sf
);
13410 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13412 FRAME_TTY (sf
)->previous_frame
= sf
;
13415 /* Set the visible flags for all frames. Do this before checking for
13416 resized or garbaged frames; they want to know if their frames are
13417 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13418 number_of_visible_frames
= 0;
13420 FOR_EACH_FRAME (tail
, frame
)
13422 struct frame
*f
= XFRAME (frame
);
13424 if (FRAME_VISIBLE_P (f
))
13426 ++number_of_visible_frames
;
13427 /* Adjust matrices for visible frames only. */
13428 if (f
->fonts_changed
)
13430 adjust_frame_glyphs (f
);
13431 f
->fonts_changed
= 0;
13433 /* If cursor type has been changed on the frame
13434 other than selected, consider all frames. */
13435 if (f
!= sf
&& f
->cursor_type_changed
)
13436 update_mode_lines
= 31;
13438 clear_desired_matrices (f
);
13441 /* Notice any pending interrupt request to change frame size. */
13442 do_pending_window_change (1);
13444 /* do_pending_window_change could change the selected_window due to
13445 frame resizing which makes the selected window too small. */
13446 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13449 /* Clear frames marked as garbaged. */
13450 clear_garbaged_frames ();
13452 /* Build menubar and tool-bar items. */
13453 if (NILP (Vmemory_full
))
13454 prepare_menu_bars ();
13456 reconsider_clip_changes (w
);
13458 /* In most cases selected window displays current buffer. */
13459 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13462 /* Detect case that we need to write or remove a star in the mode line. */
13463 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13464 w
->update_mode_line
= 1;
13466 if (mode_line_update_needed (w
))
13467 w
->update_mode_line
= 1;
13470 /* Normally the message* functions will have already displayed and
13471 updated the echo area, but the frame may have been trashed, or
13472 the update may have been preempted, so display the echo area
13473 again here. Checking message_cleared_p captures the case that
13474 the echo area should be cleared. */
13475 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13476 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13477 || (message_cleared_p
13478 && minibuf_level
== 0
13479 /* If the mini-window is currently selected, this means the
13480 echo-area doesn't show through. */
13481 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13483 int window_height_changed_p
= echo_area_display (0);
13485 if (message_cleared_p
)
13486 update_miniwindow_p
= true;
13490 /* If we don't display the current message, don't clear the
13491 message_cleared_p flag, because, if we did, we wouldn't clear
13492 the echo area in the next redisplay which doesn't preserve
13494 if (!display_last_displayed_message_p
)
13495 message_cleared_p
= 0;
13497 if (window_height_changed_p
)
13499 windows_or_buffers_changed
= 50;
13501 /* If window configuration was changed, frames may have been
13502 marked garbaged. Clear them or we will experience
13503 surprises wrt scrolling. */
13504 clear_garbaged_frames ();
13507 else if (EQ (selected_window
, minibuf_window
)
13508 && (current_buffer
->clip_changed
|| window_outdated (w
))
13509 && resize_mini_window (w
, 0))
13511 /* Resized active mini-window to fit the size of what it is
13512 showing if its contents might have changed. */
13515 /* If window configuration was changed, frames may have been
13516 marked garbaged. Clear them or we will experience
13517 surprises wrt scrolling. */
13518 clear_garbaged_frames ();
13521 if (windows_or_buffers_changed
&& !update_mode_lines
)
13522 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13523 only the windows's contents needs to be refreshed, or whether the
13524 mode-lines also need a refresh. */
13525 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13526 ? REDISPLAY_SOME
: 32);
13528 /* If specs for an arrow have changed, do thorough redisplay
13529 to ensure we remove any arrow that should no longer exist. */
13530 if (overlay_arrows_changed_p ())
13531 /* Apparently, this is the only case where we update other windows,
13532 without updating other mode-lines. */
13533 windows_or_buffers_changed
= 49;
13535 consider_all_windows_p
= (update_mode_lines
13536 || windows_or_buffers_changed
);
13538 #define AINC(a,i) \
13539 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13540 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13542 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13543 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13545 /* Optimize the case that only the line containing the cursor in the
13546 selected window has changed. Variables starting with this_ are
13547 set in display_line and record information about the line
13548 containing the cursor. */
13549 tlbufpos
= this_line_start_pos
;
13550 tlendpos
= this_line_end_pos
;
13551 if (!consider_all_windows_p
13552 && CHARPOS (tlbufpos
) > 0
13553 && !w
->update_mode_line
13554 && !current_buffer
->clip_changed
13555 && !current_buffer
->prevent_redisplay_optimizations_p
13556 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13557 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13558 && !XFRAME (w
->frame
)->cursor_type_changed
13559 /* Make sure recorded data applies to current buffer, etc. */
13560 && this_line_buffer
== current_buffer
13563 && !w
->optional_new_start
13564 /* Point must be on the line that we have info recorded about. */
13565 && PT
>= CHARPOS (tlbufpos
)
13566 && PT
<= Z
- CHARPOS (tlendpos
)
13567 /* All text outside that line, including its final newline,
13568 must be unchanged. */
13569 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13570 CHARPOS (tlendpos
)))
13572 if (CHARPOS (tlbufpos
) > BEGV
13573 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13574 && (CHARPOS (tlbufpos
) == ZV
13575 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13576 /* Former continuation line has disappeared by becoming empty. */
13578 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13580 /* We have to handle the case of continuation around a
13581 wide-column character (see the comment in indent.c around
13584 For instance, in the following case:
13586 -------- Insert --------
13587 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13588 J_I_ ==> J_I_ `^^' are cursors.
13592 As we have to redraw the line above, we cannot use this
13596 int line_height_before
= this_line_pixel_height
;
13598 /* Note that start_display will handle the case that the
13599 line starting at tlbufpos is a continuation line. */
13600 start_display (&it
, w
, tlbufpos
);
13602 /* Implementation note: It this still necessary? */
13603 if (it
.current_x
!= this_line_start_x
)
13606 TRACE ((stderr
, "trying display optimization 1\n"));
13607 w
->cursor
.vpos
= -1;
13608 overlay_arrow_seen
= 0;
13609 it
.vpos
= this_line_vpos
;
13610 it
.current_y
= this_line_y
;
13611 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13612 display_line (&it
);
13614 /* If line contains point, is not continued,
13615 and ends at same distance from eob as before, we win. */
13616 if (w
->cursor
.vpos
>= 0
13617 /* Line is not continued, otherwise this_line_start_pos
13618 would have been set to 0 in display_line. */
13619 && CHARPOS (this_line_start_pos
)
13620 /* Line ends as before. */
13621 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13622 /* Line has same height as before. Otherwise other lines
13623 would have to be shifted up or down. */
13624 && this_line_pixel_height
== line_height_before
)
13626 /* If this is not the window's last line, we must adjust
13627 the charstarts of the lines below. */
13628 if (it
.current_y
< it
.last_visible_y
)
13630 struct glyph_row
*row
13631 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13632 ptrdiff_t delta
, delta_bytes
;
13634 /* We used to distinguish between two cases here,
13635 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13636 when the line ends in a newline or the end of the
13637 buffer's accessible portion. But both cases did
13638 the same, so they were collapsed. */
13640 - CHARPOS (tlendpos
)
13641 - MATRIX_ROW_START_CHARPOS (row
));
13642 delta_bytes
= (Z_BYTE
13643 - BYTEPOS (tlendpos
)
13644 - MATRIX_ROW_START_BYTEPOS (row
));
13646 increment_matrix_positions (w
->current_matrix
,
13647 this_line_vpos
+ 1,
13648 w
->current_matrix
->nrows
,
13649 delta
, delta_bytes
);
13652 /* If this row displays text now but previously didn't,
13653 or vice versa, w->window_end_vpos may have to be
13655 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13657 if (w
->window_end_vpos
< this_line_vpos
)
13658 w
->window_end_vpos
= this_line_vpos
;
13660 else if (w
->window_end_vpos
== this_line_vpos
13661 && this_line_vpos
> 0)
13662 w
->window_end_vpos
= this_line_vpos
- 1;
13663 w
->window_end_valid
= 0;
13665 /* Update hint: No need to try to scroll in update_window. */
13666 w
->desired_matrix
->no_scrolling_p
= 1;
13669 *w
->desired_matrix
->method
= 0;
13670 debug_method_add (w
, "optimization 1");
13672 #ifdef HAVE_WINDOW_SYSTEM
13673 update_window_fringes (w
, 0);
13680 else if (/* Cursor position hasn't changed. */
13681 PT
== w
->last_point
13682 /* Make sure the cursor was last displayed
13683 in this window. Otherwise we have to reposition it. */
13685 /* PXW: Must be converted to pixels, probably. */
13686 && 0 <= w
->cursor
.vpos
13687 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13691 do_pending_window_change (1);
13692 /* If selected_window changed, redisplay again. */
13693 if (WINDOWP (selected_window
)
13694 && (w
= XWINDOW (selected_window
)) != sw
)
13697 /* We used to always goto end_of_redisplay here, but this
13698 isn't enough if we have a blinking cursor. */
13699 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13700 goto end_of_redisplay
;
13704 /* If highlighting the region, or if the cursor is in the echo area,
13705 then we can't just move the cursor. */
13706 else if (NILP (Vshow_trailing_whitespace
)
13707 && !cursor_in_echo_area
)
13710 struct glyph_row
*row
;
13712 /* Skip from tlbufpos to PT and see where it is. Note that
13713 PT may be in invisible text. If so, we will end at the
13714 next visible position. */
13715 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13716 NULL
, DEFAULT_FACE_ID
);
13717 it
.current_x
= this_line_start_x
;
13718 it
.current_y
= this_line_y
;
13719 it
.vpos
= this_line_vpos
;
13721 /* The call to move_it_to stops in front of PT, but
13722 moves over before-strings. */
13723 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13725 if (it
.vpos
== this_line_vpos
13726 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13729 eassert (this_line_vpos
== it
.vpos
);
13730 eassert (this_line_y
== it
.current_y
);
13731 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13733 *w
->desired_matrix
->method
= 0;
13734 debug_method_add (w
, "optimization 3");
13743 /* Text changed drastically or point moved off of line. */
13744 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13747 CHARPOS (this_line_start_pos
) = 0;
13748 ++clear_face_cache_count
;
13749 #ifdef HAVE_WINDOW_SYSTEM
13750 ++clear_image_cache_count
;
13753 /* Build desired matrices, and update the display. If
13754 consider_all_windows_p is non-zero, do it for all windows on all
13755 frames. Otherwise do it for selected_window, only. */
13757 if (consider_all_windows_p
)
13759 FOR_EACH_FRAME (tail
, frame
)
13760 XFRAME (frame
)->updated_p
= 0;
13762 propagate_buffer_redisplay ();
13764 FOR_EACH_FRAME (tail
, frame
)
13766 struct frame
*f
= XFRAME (frame
);
13768 /* We don't have to do anything for unselected terminal
13770 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13771 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13776 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13779 /* Only GC scrollbars when we redisplay the whole frame. */
13780 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13781 /* Mark all the scroll bars to be removed; we'll redeem
13782 the ones we want when we redisplay their windows. */
13783 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13784 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13786 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13787 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13788 /* Remember that the invisible frames need to be redisplayed next
13789 time they're visible. */
13790 else if (!REDISPLAY_SOME_P ())
13791 f
->redisplay
= true;
13793 /* The X error handler may have deleted that frame. */
13794 if (!FRAME_LIVE_P (f
))
13797 /* Any scroll bars which redisplay_windows should have
13798 nuked should now go away. */
13799 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13800 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13802 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13804 /* If fonts changed on visible frame, display again. */
13805 if (f
->fonts_changed
)
13807 adjust_frame_glyphs (f
);
13808 f
->fonts_changed
= 0;
13812 /* See if we have to hscroll. */
13813 if (!f
->already_hscrolled_p
)
13815 f
->already_hscrolled_p
= 1;
13816 if (hscroll_windows (f
->root_window
))
13820 pending
|= update_frame (f
, 0, 0);
13821 f
->cursor_type_changed
= 0;
13827 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13831 /* Do the mark_window_display_accurate after all windows have
13832 been redisplayed because this call resets flags in buffers
13833 which are needed for proper redisplay. */
13834 FOR_EACH_FRAME (tail
, frame
)
13836 struct frame
*f
= XFRAME (frame
);
13839 f
->redisplay
= false;
13840 mark_window_display_accurate (f
->root_window
, 1);
13841 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13842 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13847 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13849 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13850 struct frame
*mini_frame
;
13852 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13853 /* Use list_of_error, not Qerror, so that
13854 we catch only errors and don't run the debugger. */
13855 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13857 redisplay_window_error
);
13858 if (update_miniwindow_p
)
13859 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13861 redisplay_window_error
);
13863 /* Compare desired and current matrices, perform output. */
13866 /* If fonts changed, display again. */
13867 if (sf
->fonts_changed
)
13870 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13872 if (hscroll_windows (selected_window
))
13875 XWINDOW (selected_window
)->must_be_updated_p
= true;
13876 pending
= update_frame (sf
, 0, 0);
13877 sf
->cursor_type_changed
= 0;
13880 /* We may have called echo_area_display at the top of this
13881 function. If the echo area is on another frame, that may
13882 have put text on a frame other than the selected one, so the
13883 above call to update_frame would not have caught it. Catch
13885 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13886 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
13888 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
13890 XWINDOW (mini_window
)->must_be_updated_p
= true;
13891 pending
|= update_frame (mini_frame
, 0, 0);
13892 mini_frame
->cursor_type_changed
= 0;
13893 if (!pending
&& hscroll_windows (mini_window
))
13898 /* If display was paused because of pending input, make sure we do a
13899 thorough update the next time. */
13902 /* Prevent the optimization at the beginning of
13903 redisplay_internal that tries a single-line update of the
13904 line containing the cursor in the selected window. */
13905 CHARPOS (this_line_start_pos
) = 0;
13907 /* Let the overlay arrow be updated the next time. */
13908 update_overlay_arrows (0);
13910 /* If we pause after scrolling, some rows in the current
13911 matrices of some windows are not valid. */
13912 if (!WINDOW_FULL_WIDTH_P (w
)
13913 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
13914 update_mode_lines
= 36;
13918 if (!consider_all_windows_p
)
13920 /* This has already been done above if
13921 consider_all_windows_p is set. */
13922 if (XBUFFER (w
->contents
)->text
->redisplay
13923 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
13924 /* This can happen if b->text->redisplay was set during
13926 propagate_buffer_redisplay ();
13927 mark_window_display_accurate_1 (w
, 1);
13929 /* Say overlay arrows are up to date. */
13930 update_overlay_arrows (1);
13932 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
13933 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
13936 update_mode_lines
= 0;
13937 windows_or_buffers_changed
= 0;
13940 /* If a frame has become visible which was not before, redisplay
13941 again, so that we display it. Expose events for such a frame
13942 (which it gets when becoming visible) don't call the parts of
13943 redisplay constructing glyphs, so simply exposing a frame won't
13944 display anything in this case. So, we have to display these
13945 frames here explicitly. */
13950 FOR_EACH_FRAME (tail
, frame
)
13952 if (XFRAME (frame
)->visible
)
13956 if (new_count
!= number_of_visible_frames
)
13957 windows_or_buffers_changed
= 52;
13960 /* Change frame size now if a change is pending. */
13961 do_pending_window_change (1);
13963 /* If we just did a pending size change, or have additional
13964 visible frames, or selected_window changed, redisplay again. */
13965 if ((windows_or_buffers_changed
&& !pending
)
13966 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
13969 /* Clear the face and image caches.
13971 We used to do this only if consider_all_windows_p. But the cache
13972 needs to be cleared if a timer creates images in the current
13973 buffer (e.g. the test case in Bug#6230). */
13975 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
13977 clear_face_cache (0);
13978 clear_face_cache_count
= 0;
13981 #ifdef HAVE_WINDOW_SYSTEM
13982 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
13984 clear_image_caches (Qnil
);
13985 clear_image_cache_count
= 0;
13987 #endif /* HAVE_WINDOW_SYSTEM */
13994 /* Redisplay, but leave alone any recent echo area message unless
13995 another message has been requested in its place.
13997 This is useful in situations where you need to redisplay but no
13998 user action has occurred, making it inappropriate for the message
13999 area to be cleared. See tracking_off and
14000 wait_reading_process_output for examples of these situations.
14002 FROM_WHERE is an integer saying from where this function was
14003 called. This is useful for debugging. */
14006 redisplay_preserve_echo_area (int from_where
)
14008 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14010 if (!NILP (echo_area_buffer
[1]))
14012 /* We have a previously displayed message, but no current
14013 message. Redisplay the previous message. */
14014 display_last_displayed_message_p
= 1;
14015 redisplay_internal ();
14016 display_last_displayed_message_p
= 0;
14019 redisplay_internal ();
14021 flush_frame (SELECTED_FRAME ());
14025 /* Function registered with record_unwind_protect in redisplay_internal. */
14028 unwind_redisplay (void)
14030 redisplaying_p
= 0;
14034 /* Mark the display of leaf window W as accurate or inaccurate.
14035 If ACCURATE_P is non-zero mark display of W as accurate. If
14036 ACCURATE_P is zero, arrange for W to be redisplayed the next
14037 time redisplay_internal is called. */
14040 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14042 struct buffer
*b
= XBUFFER (w
->contents
);
14044 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14045 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14046 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14050 b
->clip_changed
= false;
14051 b
->prevent_redisplay_optimizations_p
= false;
14052 eassert (buffer_window_count (b
) > 0);
14053 /* Resetting b->text->redisplay is problematic!
14054 In order to make it safer to do it here, redisplay_internal must
14055 have copied all b->text->redisplay to their respective windows. */
14056 b
->text
->redisplay
= false;
14058 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14059 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14060 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14061 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14063 w
->current_matrix
->buffer
= b
;
14064 w
->current_matrix
->begv
= BUF_BEGV (b
);
14065 w
->current_matrix
->zv
= BUF_ZV (b
);
14067 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14068 w
->last_cursor_off_p
= w
->cursor_off_p
;
14070 if (w
== XWINDOW (selected_window
))
14071 w
->last_point
= BUF_PT (b
);
14073 w
->last_point
= marker_position (w
->pointm
);
14075 w
->window_end_valid
= true;
14076 w
->update_mode_line
= false;
14079 w
->redisplay
= !accurate_p
;
14083 /* Mark the display of windows in the window tree rooted at WINDOW as
14084 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14085 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14086 be redisplayed the next time redisplay_internal is called. */
14089 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14093 for (; !NILP (window
); window
= w
->next
)
14095 w
= XWINDOW (window
);
14096 if (WINDOWP (w
->contents
))
14097 mark_window_display_accurate (w
->contents
, accurate_p
);
14099 mark_window_display_accurate_1 (w
, accurate_p
);
14103 update_overlay_arrows (1);
14105 /* Force a thorough redisplay the next time by setting
14106 last_arrow_position and last_arrow_string to t, which is
14107 unequal to any useful value of Voverlay_arrow_... */
14108 update_overlay_arrows (-1);
14112 /* Return value in display table DP (Lisp_Char_Table *) for character
14113 C. Since a display table doesn't have any parent, we don't have to
14114 follow parent. Do not call this function directly but use the
14115 macro DISP_CHAR_VECTOR. */
14118 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14122 if (ASCII_CHAR_P (c
))
14125 if (SUB_CHAR_TABLE_P (val
))
14126 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14132 XSETCHAR_TABLE (table
, dp
);
14133 val
= char_table_ref (table
, c
);
14142 /***********************************************************************
14144 ***********************************************************************/
14146 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14149 redisplay_windows (Lisp_Object window
)
14151 while (!NILP (window
))
14153 struct window
*w
= XWINDOW (window
);
14155 if (WINDOWP (w
->contents
))
14156 redisplay_windows (w
->contents
);
14157 else if (BUFFERP (w
->contents
))
14159 displayed_buffer
= XBUFFER (w
->contents
);
14160 /* Use list_of_error, not Qerror, so that
14161 we catch only errors and don't run the debugger. */
14162 internal_condition_case_1 (redisplay_window_0
, window
,
14164 redisplay_window_error
);
14172 redisplay_window_error (Lisp_Object ignore
)
14174 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14179 redisplay_window_0 (Lisp_Object window
)
14181 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14182 redisplay_window (window
, false);
14187 redisplay_window_1 (Lisp_Object window
)
14189 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14190 redisplay_window (window
, true);
14195 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14196 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14197 which positions recorded in ROW differ from current buffer
14200 Return 0 if cursor is not on this row, 1 otherwise. */
14203 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14204 struct glyph_matrix
*matrix
,
14205 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14208 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14209 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14210 struct glyph
*cursor
= NULL
;
14211 /* The last known character position in row. */
14212 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14214 ptrdiff_t pt_old
= PT
- delta
;
14215 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14216 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14217 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14218 /* A glyph beyond the edge of TEXT_AREA which we should never
14220 struct glyph
*glyphs_end
= end
;
14221 /* Non-zero means we've found a match for cursor position, but that
14222 glyph has the avoid_cursor_p flag set. */
14223 int match_with_avoid_cursor
= 0;
14224 /* Non-zero means we've seen at least one glyph that came from a
14226 int string_seen
= 0;
14227 /* Largest and smallest buffer positions seen so far during scan of
14229 ptrdiff_t bpos_max
= pos_before
;
14230 ptrdiff_t bpos_min
= pos_after
;
14231 /* Last buffer position covered by an overlay string with an integer
14232 `cursor' property. */
14233 ptrdiff_t bpos_covered
= 0;
14234 /* Non-zero means the display string on which to display the cursor
14235 comes from a text property, not from an overlay. */
14236 int string_from_text_prop
= 0;
14238 /* Don't even try doing anything if called for a mode-line or
14239 header-line row, since the rest of the code isn't prepared to
14240 deal with such calamities. */
14241 eassert (!row
->mode_line_p
);
14242 if (row
->mode_line_p
)
14245 /* Skip over glyphs not having an object at the start and the end of
14246 the row. These are special glyphs like truncation marks on
14247 terminal frames. */
14248 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14250 if (!row
->reversed_p
)
14253 && INTEGERP (glyph
->object
)
14254 && glyph
->charpos
< 0)
14256 x
+= glyph
->pixel_width
;
14260 && INTEGERP ((end
- 1)->object
)
14261 /* CHARPOS is zero for blanks and stretch glyphs
14262 inserted by extend_face_to_end_of_line. */
14263 && (end
- 1)->charpos
<= 0)
14265 glyph_before
= glyph
- 1;
14272 /* If the glyph row is reversed, we need to process it from back
14273 to front, so swap the edge pointers. */
14274 glyphs_end
= end
= glyph
- 1;
14275 glyph
+= row
->used
[TEXT_AREA
] - 1;
14277 while (glyph
> end
+ 1
14278 && INTEGERP (glyph
->object
)
14279 && glyph
->charpos
< 0)
14282 x
-= glyph
->pixel_width
;
14284 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14286 /* By default, in reversed rows we put the cursor on the
14287 rightmost (first in the reading order) glyph. */
14288 for (g
= end
+ 1; g
< glyph
; g
++)
14289 x
+= g
->pixel_width
;
14291 && INTEGERP ((end
+ 1)->object
)
14292 && (end
+ 1)->charpos
<= 0)
14294 glyph_before
= glyph
+ 1;
14298 else if (row
->reversed_p
)
14300 /* In R2L rows that don't display text, put the cursor on the
14301 rightmost glyph. Case in point: an empty last line that is
14302 part of an R2L paragraph. */
14304 /* Avoid placing the cursor on the last glyph of the row, where
14305 on terminal frames we hold the vertical border between
14306 adjacent windows. */
14307 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14308 && !WINDOW_RIGHTMOST_P (w
)
14309 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14311 x
= -1; /* will be computed below, at label compute_x */
14314 /* Step 1: Try to find the glyph whose character position
14315 corresponds to point. If that's not possible, find 2 glyphs
14316 whose character positions are the closest to point, one before
14317 point, the other after it. */
14318 if (!row
->reversed_p
)
14319 while (/* not marched to end of glyph row */
14321 /* glyph was not inserted by redisplay for internal purposes */
14322 && !INTEGERP (glyph
->object
))
14324 if (BUFFERP (glyph
->object
))
14326 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14328 if (glyph
->charpos
> bpos_max
)
14329 bpos_max
= glyph
->charpos
;
14330 if (glyph
->charpos
< bpos_min
)
14331 bpos_min
= glyph
->charpos
;
14332 if (!glyph
->avoid_cursor_p
)
14334 /* If we hit point, we've found the glyph on which to
14335 display the cursor. */
14338 match_with_avoid_cursor
= 0;
14341 /* See if we've found a better approximation to
14342 POS_BEFORE or to POS_AFTER. */
14343 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14345 pos_before
= glyph
->charpos
;
14346 glyph_before
= glyph
;
14348 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14350 pos_after
= glyph
->charpos
;
14351 glyph_after
= glyph
;
14354 else if (dpos
== 0)
14355 match_with_avoid_cursor
= 1;
14357 else if (STRINGP (glyph
->object
))
14359 Lisp_Object chprop
;
14360 ptrdiff_t glyph_pos
= glyph
->charpos
;
14362 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14364 if (!NILP (chprop
))
14366 /* If the string came from a `display' text property,
14367 look up the buffer position of that property and
14368 use that position to update bpos_max, as if we
14369 actually saw such a position in one of the row's
14370 glyphs. This helps with supporting integer values
14371 of `cursor' property on the display string in
14372 situations where most or all of the row's buffer
14373 text is completely covered by display properties,
14374 so that no glyph with valid buffer positions is
14375 ever seen in the row. */
14376 ptrdiff_t prop_pos
=
14377 string_buffer_position_lim (glyph
->object
, pos_before
,
14380 if (prop_pos
>= pos_before
)
14381 bpos_max
= prop_pos
;
14383 if (INTEGERP (chprop
))
14385 bpos_covered
= bpos_max
+ XINT (chprop
);
14386 /* If the `cursor' property covers buffer positions up
14387 to and including point, we should display cursor on
14388 this glyph. Note that, if a `cursor' property on one
14389 of the string's characters has an integer value, we
14390 will break out of the loop below _before_ we get to
14391 the position match above. IOW, integer values of
14392 the `cursor' property override the "exact match for
14393 point" strategy of positioning the cursor. */
14394 /* Implementation note: bpos_max == pt_old when, e.g.,
14395 we are in an empty line, where bpos_max is set to
14396 MATRIX_ROW_START_CHARPOS, see above. */
14397 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14406 x
+= glyph
->pixel_width
;
14409 else if (glyph
> end
) /* row is reversed */
14410 while (!INTEGERP (glyph
->object
))
14412 if (BUFFERP (glyph
->object
))
14414 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14416 if (glyph
->charpos
> bpos_max
)
14417 bpos_max
= glyph
->charpos
;
14418 if (glyph
->charpos
< bpos_min
)
14419 bpos_min
= glyph
->charpos
;
14420 if (!glyph
->avoid_cursor_p
)
14424 match_with_avoid_cursor
= 0;
14427 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14429 pos_before
= glyph
->charpos
;
14430 glyph_before
= glyph
;
14432 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14434 pos_after
= glyph
->charpos
;
14435 glyph_after
= glyph
;
14438 else if (dpos
== 0)
14439 match_with_avoid_cursor
= 1;
14441 else if (STRINGP (glyph
->object
))
14443 Lisp_Object chprop
;
14444 ptrdiff_t glyph_pos
= glyph
->charpos
;
14446 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14448 if (!NILP (chprop
))
14450 ptrdiff_t prop_pos
=
14451 string_buffer_position_lim (glyph
->object
, pos_before
,
14454 if (prop_pos
>= pos_before
)
14455 bpos_max
= prop_pos
;
14457 if (INTEGERP (chprop
))
14459 bpos_covered
= bpos_max
+ XINT (chprop
);
14460 /* If the `cursor' property covers buffer positions up
14461 to and including point, we should display cursor on
14463 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14472 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14474 x
--; /* can't use any pixel_width */
14477 x
-= glyph
->pixel_width
;
14480 /* Step 2: If we didn't find an exact match for point, we need to
14481 look for a proper place to put the cursor among glyphs between
14482 GLYPH_BEFORE and GLYPH_AFTER. */
14483 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14484 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14485 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14487 /* An empty line has a single glyph whose OBJECT is zero and
14488 whose CHARPOS is the position of a newline on that line.
14489 Note that on a TTY, there are more glyphs after that, which
14490 were produced by extend_face_to_end_of_line, but their
14491 CHARPOS is zero or negative. */
14493 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14494 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14495 /* On a TTY, continued and truncated rows also have a glyph at
14496 their end whose OBJECT is zero and whose CHARPOS is
14497 positive (the continuation and truncation glyphs), but such
14498 rows are obviously not "empty". */
14499 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14501 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14503 ptrdiff_t ellipsis_pos
;
14505 /* Scan back over the ellipsis glyphs. */
14506 if (!row
->reversed_p
)
14508 ellipsis_pos
= (glyph
- 1)->charpos
;
14509 while (glyph
> row
->glyphs
[TEXT_AREA
]
14510 && (glyph
- 1)->charpos
== ellipsis_pos
)
14511 glyph
--, x
-= glyph
->pixel_width
;
14512 /* That loop always goes one position too far, including
14513 the glyph before the ellipsis. So scan forward over
14515 x
+= glyph
->pixel_width
;
14518 else /* row is reversed */
14520 ellipsis_pos
= (glyph
+ 1)->charpos
;
14521 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14522 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14523 glyph
++, x
+= glyph
->pixel_width
;
14524 x
-= glyph
->pixel_width
;
14528 else if (match_with_avoid_cursor
)
14530 cursor
= glyph_after
;
14533 else if (string_seen
)
14535 int incr
= row
->reversed_p
? -1 : +1;
14537 /* Need to find the glyph that came out of a string which is
14538 present at point. That glyph is somewhere between
14539 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14540 positioned between POS_BEFORE and POS_AFTER in the
14542 struct glyph
*start
, *stop
;
14543 ptrdiff_t pos
= pos_before
;
14547 /* If the row ends in a newline from a display string,
14548 reordering could have moved the glyphs belonging to the
14549 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14550 in this case we extend the search to the last glyph in
14551 the row that was not inserted by redisplay. */
14552 if (row
->ends_in_newline_from_string_p
)
14555 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14558 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14559 correspond to POS_BEFORE and POS_AFTER, respectively. We
14560 need START and STOP in the order that corresponds to the
14561 row's direction as given by its reversed_p flag. If the
14562 directionality of characters between POS_BEFORE and
14563 POS_AFTER is the opposite of the row's base direction,
14564 these characters will have been reordered for display,
14565 and we need to reverse START and STOP. */
14566 if (!row
->reversed_p
)
14568 start
= min (glyph_before
, glyph_after
);
14569 stop
= max (glyph_before
, glyph_after
);
14573 start
= max (glyph_before
, glyph_after
);
14574 stop
= min (glyph_before
, glyph_after
);
14576 for (glyph
= start
+ incr
;
14577 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14580 /* Any glyphs that come from the buffer are here because
14581 of bidi reordering. Skip them, and only pay
14582 attention to glyphs that came from some string. */
14583 if (STRINGP (glyph
->object
))
14587 /* If the display property covers the newline, we
14588 need to search for it one position farther. */
14589 ptrdiff_t lim
= pos_after
14590 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14592 string_from_text_prop
= 0;
14593 str
= glyph
->object
;
14594 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14595 if (tem
== 0 /* from overlay */
14598 /* If the string from which this glyph came is
14599 found in the buffer at point, or at position
14600 that is closer to point than pos_after, then
14601 we've found the glyph we've been looking for.
14602 If it comes from an overlay (tem == 0), and
14603 it has the `cursor' property on one of its
14604 glyphs, record that glyph as a candidate for
14605 displaying the cursor. (As in the
14606 unidirectional version, we will display the
14607 cursor on the last candidate we find.) */
14610 || (tem
- pt_old
> 0 && tem
< pos_after
))
14612 /* The glyphs from this string could have
14613 been reordered. Find the one with the
14614 smallest string position. Or there could
14615 be a character in the string with the
14616 `cursor' property, which means display
14617 cursor on that character's glyph. */
14618 ptrdiff_t strpos
= glyph
->charpos
;
14623 string_from_text_prop
= 1;
14626 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14627 && EQ (glyph
->object
, str
);
14631 ptrdiff_t gpos
= glyph
->charpos
;
14633 cprop
= Fget_char_property (make_number (gpos
),
14641 if (tem
&& glyph
->charpos
< strpos
)
14643 strpos
= glyph
->charpos
;
14649 || (tem
- pt_old
> 0 && tem
< pos_after
))
14653 pos
= tem
+ 1; /* don't find previous instances */
14655 /* This string is not what we want; skip all of the
14656 glyphs that came from it. */
14657 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14658 && EQ (glyph
->object
, str
))
14665 /* If we reached the end of the line, and END was from a string,
14666 the cursor is not on this line. */
14668 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14669 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14670 && STRINGP (end
->object
)
14671 && row
->continued_p
)
14674 /* A truncated row may not include PT among its character positions.
14675 Setting the cursor inside the scroll margin will trigger
14676 recalculation of hscroll in hscroll_window_tree. But if a
14677 display string covers point, defer to the string-handling
14678 code below to figure this out. */
14679 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14681 cursor
= glyph_before
;
14684 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14685 /* Zero-width characters produce no glyphs. */
14687 && (row
->reversed_p
14688 ? glyph_after
> glyphs_end
14689 : glyph_after
< glyphs_end
)))
14691 cursor
= glyph_after
;
14697 if (cursor
!= NULL
)
14699 else if (glyph
== glyphs_end
14700 && pos_before
== pos_after
14701 && STRINGP ((row
->reversed_p
14702 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14703 : row
->glyphs
[TEXT_AREA
])->object
))
14705 /* If all the glyphs of this row came from strings, put the
14706 cursor on the first glyph of the row. This avoids having the
14707 cursor outside of the text area in this very rare and hard
14711 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14712 : row
->glyphs
[TEXT_AREA
];
14718 /* Need to compute x that corresponds to GLYPH. */
14719 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14721 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14723 x
+= g
->pixel_width
;
14727 /* ROW could be part of a continued line, which, under bidi
14728 reordering, might have other rows whose start and end charpos
14729 occlude point. Only set w->cursor if we found a better
14730 approximation to the cursor position than we have from previously
14731 examined candidate rows belonging to the same continued line. */
14732 if (/* We already have a candidate row. */
14733 w
->cursor
.vpos
>= 0
14734 /* That candidate is not the row we are processing. */
14735 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14736 /* Make sure cursor.vpos specifies a row whose start and end
14737 charpos occlude point, and it is valid candidate for being a
14738 cursor-row. This is because some callers of this function
14739 leave cursor.vpos at the row where the cursor was displayed
14740 during the last redisplay cycle. */
14741 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14742 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14743 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14746 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14748 /* Don't consider glyphs that are outside TEXT_AREA. */
14749 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14751 /* Keep the candidate whose buffer position is the closest to
14752 point or has the `cursor' property. */
14753 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14754 w
->cursor
.hpos
>= 0
14755 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14756 && ((BUFFERP (g1
->object
)
14757 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14758 || (BUFFERP (glyph
->object
)
14759 && eabs (g1
->charpos
- pt_old
)
14760 < eabs (glyph
->charpos
- pt_old
))))
14761 /* Previous candidate is a glyph from a string that has
14762 a non-nil `cursor' property. */
14763 || (STRINGP (g1
->object
)
14764 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14765 Qcursor
, g1
->object
))
14766 /* Previous candidate is from the same display
14767 string as this one, and the display string
14768 came from a text property. */
14769 || (EQ (g1
->object
, glyph
->object
)
14770 && string_from_text_prop
)
14771 /* this candidate is from newline and its
14772 position is not an exact match */
14773 || (INTEGERP (glyph
->object
)
14774 && glyph
->charpos
!= pt_old
)))))
14776 /* If this candidate gives an exact match, use that. */
14777 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14778 /* If this candidate is a glyph created for the
14779 terminating newline of a line, and point is on that
14780 newline, it wins because it's an exact match. */
14781 || (!row
->continued_p
14782 && INTEGERP (glyph
->object
)
14783 && glyph
->charpos
== 0
14784 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14785 /* Otherwise, keep the candidate that comes from a row
14786 spanning less buffer positions. This may win when one or
14787 both candidate positions are on glyphs that came from
14788 display strings, for which we cannot compare buffer
14790 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14791 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14792 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14795 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14797 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14798 w
->cursor
.y
= row
->y
+ dy
;
14800 if (w
== XWINDOW (selected_window
))
14802 if (!row
->continued_p
14803 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14806 this_line_buffer
= XBUFFER (w
->contents
);
14808 CHARPOS (this_line_start_pos
)
14809 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14810 BYTEPOS (this_line_start_pos
)
14811 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14813 CHARPOS (this_line_end_pos
)
14814 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14815 BYTEPOS (this_line_end_pos
)
14816 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14818 this_line_y
= w
->cursor
.y
;
14819 this_line_pixel_height
= row
->height
;
14820 this_line_vpos
= w
->cursor
.vpos
;
14821 this_line_start_x
= row
->x
;
14824 CHARPOS (this_line_start_pos
) = 0;
14831 /* Run window scroll functions, if any, for WINDOW with new window
14832 start STARTP. Sets the window start of WINDOW to that position.
14834 We assume that the window's buffer is really current. */
14836 static struct text_pos
14837 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14839 struct window
*w
= XWINDOW (window
);
14840 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14842 eassert (current_buffer
== XBUFFER (w
->contents
));
14844 if (!NILP (Vwindow_scroll_functions
))
14846 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14847 make_number (CHARPOS (startp
)));
14848 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14849 /* In case the hook functions switch buffers. */
14850 set_buffer_internal (XBUFFER (w
->contents
));
14857 /* Make sure the line containing the cursor is fully visible.
14858 A value of 1 means there is nothing to be done.
14859 (Either the line is fully visible, or it cannot be made so,
14860 or we cannot tell.)
14862 If FORCE_P is non-zero, return 0 even if partial visible cursor row
14863 is higher than window.
14865 A value of 0 means the caller should do scrolling
14866 as if point had gone off the screen. */
14869 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
14871 struct glyph_matrix
*matrix
;
14872 struct glyph_row
*row
;
14875 if (!make_cursor_line_fully_visible_p
)
14878 /* It's not always possible to find the cursor, e.g, when a window
14879 is full of overlay strings. Don't do anything in that case. */
14880 if (w
->cursor
.vpos
< 0)
14883 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
14884 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
14886 /* If the cursor row is not partially visible, there's nothing to do. */
14887 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
14890 /* If the row the cursor is in is taller than the window's height,
14891 it's not clear what to do, so do nothing. */
14892 window_height
= window_box_height (w
);
14893 if (row
->height
>= window_height
)
14895 if (!force_p
|| MINI_WINDOW_P (w
)
14896 || w
->vscroll
|| w
->cursor
.vpos
== 0)
14903 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
14904 non-zero means only WINDOW is redisplayed in redisplay_internal.
14905 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
14906 in redisplay_window to bring a partially visible line into view in
14907 the case that only the cursor has moved.
14909 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
14910 last screen line's vertical height extends past the end of the screen.
14914 1 if scrolling succeeded
14916 0 if scrolling didn't find point.
14918 -1 if new fonts have been loaded so that we must interrupt
14919 redisplay, adjust glyph matrices, and try again. */
14925 SCROLLING_NEED_LARGER_MATRICES
14928 /* If scroll-conservatively is more than this, never recenter.
14930 If you change this, don't forget to update the doc string of
14931 `scroll-conservatively' and the Emacs manual. */
14932 #define SCROLL_LIMIT 100
14935 try_scrolling (Lisp_Object window
, int just_this_one_p
,
14936 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
14937 int temp_scroll_step
, int last_line_misfit
)
14939 struct window
*w
= XWINDOW (window
);
14940 struct frame
*f
= XFRAME (w
->frame
);
14941 struct text_pos pos
, startp
;
14943 int this_scroll_margin
, scroll_max
, rc
, height
;
14944 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
14945 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
14946 Lisp_Object aggressive
;
14947 /* We will never try scrolling more than this number of lines. */
14948 int scroll_limit
= SCROLL_LIMIT
;
14949 int frame_line_height
= default_line_pixel_height (w
);
14950 int window_total_lines
14951 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
14954 debug_method_add (w
, "try_scrolling");
14957 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14959 /* Compute scroll margin height in pixels. We scroll when point is
14960 within this distance from the top or bottom of the window. */
14961 if (scroll_margin
> 0)
14962 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
14963 * frame_line_height
;
14965 this_scroll_margin
= 0;
14967 /* Force arg_scroll_conservatively to have a reasonable value, to
14968 avoid scrolling too far away with slow move_it_* functions. Note
14969 that the user can supply scroll-conservatively equal to
14970 `most-positive-fixnum', which can be larger than INT_MAX. */
14971 if (arg_scroll_conservatively
> scroll_limit
)
14973 arg_scroll_conservatively
= scroll_limit
+ 1;
14974 scroll_max
= scroll_limit
* frame_line_height
;
14976 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
14977 /* Compute how much we should try to scroll maximally to bring
14978 point into view. */
14979 scroll_max
= (max (scroll_step
,
14980 max (arg_scroll_conservatively
, temp_scroll_step
))
14981 * frame_line_height
);
14982 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
14983 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
14984 /* We're trying to scroll because of aggressive scrolling but no
14985 scroll_step is set. Choose an arbitrary one. */
14986 scroll_max
= 10 * frame_line_height
;
14992 /* Decide whether to scroll down. */
14993 if (PT
> CHARPOS (startp
))
14995 int scroll_margin_y
;
14997 /* Compute the pixel ypos of the scroll margin, then move IT to
14998 either that ypos or PT, whichever comes first. */
14999 start_display (&it
, w
, startp
);
15000 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15001 - frame_line_height
* extra_scroll_margin_lines
;
15002 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15003 (MOVE_TO_POS
| MOVE_TO_Y
));
15005 if (PT
> CHARPOS (it
.current
.pos
))
15007 int y0
= line_bottom_y (&it
);
15008 /* Compute how many pixels below window bottom to stop searching
15009 for PT. This avoids costly search for PT that is far away if
15010 the user limited scrolling by a small number of lines, but
15011 always finds PT if scroll_conservatively is set to a large
15012 number, such as most-positive-fixnum. */
15013 int slack
= max (scroll_max
, 10 * frame_line_height
);
15014 int y_to_move
= it
.last_visible_y
+ slack
;
15016 /* Compute the distance from the scroll margin to PT or to
15017 the scroll limit, whichever comes first. This should
15018 include the height of the cursor line, to make that line
15020 move_it_to (&it
, PT
, -1, y_to_move
,
15021 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15022 dy
= line_bottom_y (&it
) - y0
;
15024 if (dy
> scroll_max
)
15025 return SCROLLING_FAILED
;
15034 /* Point is in or below the bottom scroll margin, so move the
15035 window start down. If scrolling conservatively, move it just
15036 enough down to make point visible. If scroll_step is set,
15037 move it down by scroll_step. */
15038 if (arg_scroll_conservatively
)
15040 = min (max (dy
, frame_line_height
),
15041 frame_line_height
* arg_scroll_conservatively
);
15042 else if (scroll_step
|| temp_scroll_step
)
15043 amount_to_scroll
= scroll_max
;
15046 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15047 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15048 if (NUMBERP (aggressive
))
15050 double float_amount
= XFLOATINT (aggressive
) * height
;
15051 int aggressive_scroll
= float_amount
;
15052 if (aggressive_scroll
== 0 && float_amount
> 0)
15053 aggressive_scroll
= 1;
15054 /* Don't let point enter the scroll margin near top of
15055 the window. This could happen if the value of
15056 scroll_up_aggressively is too large and there are
15057 non-zero margins, because scroll_up_aggressively
15058 means put point that fraction of window height
15059 _from_the_bottom_margin_. */
15060 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15061 aggressive_scroll
= height
- 2*this_scroll_margin
;
15062 amount_to_scroll
= dy
+ aggressive_scroll
;
15066 if (amount_to_scroll
<= 0)
15067 return SCROLLING_FAILED
;
15069 start_display (&it
, w
, startp
);
15070 if (arg_scroll_conservatively
<= scroll_limit
)
15071 move_it_vertically (&it
, amount_to_scroll
);
15074 /* Extra precision for users who set scroll-conservatively
15075 to a large number: make sure the amount we scroll
15076 the window start is never less than amount_to_scroll,
15077 which was computed as distance from window bottom to
15078 point. This matters when lines at window top and lines
15079 below window bottom have different height. */
15081 void *it1data
= NULL
;
15082 /* We use a temporary it1 because line_bottom_y can modify
15083 its argument, if it moves one line down; see there. */
15086 SAVE_IT (it1
, it
, it1data
);
15087 start_y
= line_bottom_y (&it1
);
15089 RESTORE_IT (&it
, &it
, it1data
);
15090 move_it_by_lines (&it
, 1);
15091 SAVE_IT (it1
, it
, it1data
);
15092 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15095 /* If STARTP is unchanged, move it down another screen line. */
15096 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15097 move_it_by_lines (&it
, 1);
15098 startp
= it
.current
.pos
;
15102 struct text_pos scroll_margin_pos
= startp
;
15105 /* See if point is inside the scroll margin at the top of the
15107 if (this_scroll_margin
)
15111 start_display (&it
, w
, startp
);
15112 y_start
= it
.current_y
;
15113 move_it_vertically (&it
, this_scroll_margin
);
15114 scroll_margin_pos
= it
.current
.pos
;
15115 /* If we didn't move enough before hitting ZV, request
15116 additional amount of scroll, to move point out of the
15118 if (IT_CHARPOS (it
) == ZV
15119 && it
.current_y
- y_start
< this_scroll_margin
)
15120 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15123 if (PT
< CHARPOS (scroll_margin_pos
))
15125 /* Point is in the scroll margin at the top of the window or
15126 above what is displayed in the window. */
15129 /* Compute the vertical distance from PT to the scroll
15130 margin position. Move as far as scroll_max allows, or
15131 one screenful, or 10 screen lines, whichever is largest.
15132 Give up if distance is greater than scroll_max or if we
15133 didn't reach the scroll margin position. */
15134 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15135 start_display (&it
, w
, pos
);
15137 y_to_move
= max (it
.last_visible_y
,
15138 max (scroll_max
, 10 * frame_line_height
));
15139 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15141 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15142 dy
= it
.current_y
- y0
;
15143 if (dy
> scroll_max
15144 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15145 return SCROLLING_FAILED
;
15147 /* Additional scroll for when ZV was too close to point. */
15150 /* Compute new window start. */
15151 start_display (&it
, w
, startp
);
15153 if (arg_scroll_conservatively
)
15154 amount_to_scroll
= max (dy
, frame_line_height
*
15155 max (scroll_step
, temp_scroll_step
));
15156 else if (scroll_step
|| temp_scroll_step
)
15157 amount_to_scroll
= scroll_max
;
15160 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15161 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15162 if (NUMBERP (aggressive
))
15164 double float_amount
= XFLOATINT (aggressive
) * height
;
15165 int aggressive_scroll
= float_amount
;
15166 if (aggressive_scroll
== 0 && float_amount
> 0)
15167 aggressive_scroll
= 1;
15168 /* Don't let point enter the scroll margin near
15169 bottom of the window, if the value of
15170 scroll_down_aggressively happens to be too
15172 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15173 aggressive_scroll
= height
- 2*this_scroll_margin
;
15174 amount_to_scroll
= dy
+ aggressive_scroll
;
15178 if (amount_to_scroll
<= 0)
15179 return SCROLLING_FAILED
;
15181 move_it_vertically_backward (&it
, amount_to_scroll
);
15182 startp
= it
.current
.pos
;
15186 /* Run window scroll functions. */
15187 startp
= run_window_scroll_functions (window
, startp
);
15189 /* Display the window. Give up if new fonts are loaded, or if point
15191 if (!try_window (window
, startp
, 0))
15192 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15193 else if (w
->cursor
.vpos
< 0)
15195 clear_glyph_matrix (w
->desired_matrix
);
15196 rc
= SCROLLING_FAILED
;
15200 /* Maybe forget recorded base line for line number display. */
15201 if (!just_this_one_p
15202 || current_buffer
->clip_changed
15203 || BEG_UNCHANGED
< CHARPOS (startp
))
15204 w
->base_line_number
= 0;
15206 /* If cursor ends up on a partially visible line,
15207 treat that as being off the bottom of the screen. */
15208 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15209 /* It's possible that the cursor is on the first line of the
15210 buffer, which is partially obscured due to a vscroll
15211 (Bug#7537). In that case, avoid looping forever. */
15212 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15214 clear_glyph_matrix (w
->desired_matrix
);
15215 ++extra_scroll_margin_lines
;
15218 rc
= SCROLLING_SUCCESS
;
15225 /* Compute a suitable window start for window W if display of W starts
15226 on a continuation line. Value is non-zero if a new window start
15229 The new window start will be computed, based on W's width, starting
15230 from the start of the continued line. It is the start of the
15231 screen line with the minimum distance from the old start W->start. */
15234 compute_window_start_on_continuation_line (struct window
*w
)
15236 struct text_pos pos
, start_pos
;
15237 int window_start_changed_p
= 0;
15239 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15241 /* If window start is on a continuation line... Window start may be
15242 < BEGV in case there's invisible text at the start of the
15243 buffer (M-x rmail, for example). */
15244 if (CHARPOS (start_pos
) > BEGV
15245 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15248 struct glyph_row
*row
;
15250 /* Handle the case that the window start is out of range. */
15251 if (CHARPOS (start_pos
) < BEGV
)
15252 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15253 else if (CHARPOS (start_pos
) > ZV
)
15254 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15256 /* Find the start of the continued line. This should be fast
15257 because find_newline is fast (newline cache). */
15258 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15259 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15260 row
, DEFAULT_FACE_ID
);
15261 reseat_at_previous_visible_line_start (&it
);
15263 /* If the line start is "too far" away from the window start,
15264 say it takes too much time to compute a new window start. */
15265 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15266 /* PXW: Do we need upper bounds here? */
15267 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15269 int min_distance
, distance
;
15271 /* Move forward by display lines to find the new window
15272 start. If window width was enlarged, the new start can
15273 be expected to be > the old start. If window width was
15274 decreased, the new window start will be < the old start.
15275 So, we're looking for the display line start with the
15276 minimum distance from the old window start. */
15277 pos
= it
.current
.pos
;
15278 min_distance
= INFINITY
;
15279 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15280 distance
< min_distance
)
15282 min_distance
= distance
;
15283 pos
= it
.current
.pos
;
15284 if (it
.line_wrap
== WORD_WRAP
)
15286 /* Under WORD_WRAP, move_it_by_lines is likely to
15287 overshoot and stop not at the first, but the
15288 second character from the left margin. So in
15289 that case, we need a more tight control on the X
15290 coordinate of the iterator than move_it_by_lines
15291 promises in its contract. The method is to first
15292 go to the last (rightmost) visible character of a
15293 line, then move to the leftmost character on the
15294 next line in a separate call. */
15295 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15296 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15297 move_it_to (&it
, ZV
, 0,
15298 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15299 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15302 move_it_by_lines (&it
, 1);
15305 /* Set the window start there. */
15306 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15307 window_start_changed_p
= 1;
15311 return window_start_changed_p
;
15315 /* Try cursor movement in case text has not changed in window WINDOW,
15316 with window start STARTP. Value is
15318 CURSOR_MOVEMENT_SUCCESS if successful
15320 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15322 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15323 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15324 we want to scroll as if scroll-step were set to 1. See the code.
15326 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15327 which case we have to abort this redisplay, and adjust matrices
15332 CURSOR_MOVEMENT_SUCCESS
,
15333 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15334 CURSOR_MOVEMENT_MUST_SCROLL
,
15335 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15339 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15341 struct window
*w
= XWINDOW (window
);
15342 struct frame
*f
= XFRAME (w
->frame
);
15343 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15346 if (inhibit_try_cursor_movement
)
15350 /* Previously, there was a check for Lisp integer in the
15351 if-statement below. Now, this field is converted to
15352 ptrdiff_t, thus zero means invalid position in a buffer. */
15353 eassert (w
->last_point
> 0);
15354 /* Likewise there was a check whether window_end_vpos is nil or larger
15355 than the window. Now window_end_vpos is int and so never nil, but
15356 let's leave eassert to check whether it fits in the window. */
15357 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15359 /* Handle case where text has not changed, only point, and it has
15360 not moved off the frame. */
15361 if (/* Point may be in this window. */
15362 PT
>= CHARPOS (startp
)
15363 /* Selective display hasn't changed. */
15364 && !current_buffer
->clip_changed
15365 /* Function force-mode-line-update is used to force a thorough
15366 redisplay. It sets either windows_or_buffers_changed or
15367 update_mode_lines. So don't take a shortcut here for these
15369 && !update_mode_lines
15370 && !windows_or_buffers_changed
15371 && !f
->cursor_type_changed
15372 && NILP (Vshow_trailing_whitespace
)
15373 /* This code is not used for mini-buffer for the sake of the case
15374 of redisplaying to replace an echo area message; since in
15375 that case the mini-buffer contents per se are usually
15376 unchanged. This code is of no real use in the mini-buffer
15377 since the handling of this_line_start_pos, etc., in redisplay
15378 handles the same cases. */
15379 && !EQ (window
, minibuf_window
)
15380 && (FRAME_WINDOW_P (f
)
15381 || !overlay_arrow_in_current_buffer_p ()))
15383 int this_scroll_margin
, top_scroll_margin
;
15384 struct glyph_row
*row
= NULL
;
15385 int frame_line_height
= default_line_pixel_height (w
);
15386 int window_total_lines
15387 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15390 debug_method_add (w
, "cursor movement");
15393 /* Scroll if point within this distance from the top or bottom
15394 of the window. This is a pixel value. */
15395 if (scroll_margin
> 0)
15397 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15398 this_scroll_margin
*= frame_line_height
;
15401 this_scroll_margin
= 0;
15403 top_scroll_margin
= this_scroll_margin
;
15404 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15405 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15407 /* Start with the row the cursor was displayed during the last
15408 not paused redisplay. Give up if that row is not valid. */
15409 if (w
->last_cursor_vpos
< 0
15410 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15411 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15414 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15415 if (row
->mode_line_p
)
15417 if (!row
->enabled_p
)
15418 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15421 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15423 int scroll_p
= 0, must_scroll
= 0;
15424 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15426 if (PT
> w
->last_point
)
15428 /* Point has moved forward. */
15429 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15430 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15432 eassert (row
->enabled_p
);
15436 /* If the end position of a row equals the start
15437 position of the next row, and PT is at that position,
15438 we would rather display cursor in the next line. */
15439 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15440 && MATRIX_ROW_END_CHARPOS (row
) == PT
15441 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15442 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15443 && !cursor_row_p (row
))
15446 /* If within the scroll margin, scroll. Note that
15447 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15448 the next line would be drawn, and that
15449 this_scroll_margin can be zero. */
15450 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15451 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15452 /* Line is completely visible last line in window
15453 and PT is to be set in the next line. */
15454 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15455 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15456 && !row
->ends_at_zv_p
15457 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15460 else if (PT
< w
->last_point
)
15462 /* Cursor has to be moved backward. Note that PT >=
15463 CHARPOS (startp) because of the outer if-statement. */
15464 while (!row
->mode_line_p
15465 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15466 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15467 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15468 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15469 row
> w
->current_matrix
->rows
15470 && (row
-1)->ends_in_newline_from_string_p
))))
15471 && (row
->y
> top_scroll_margin
15472 || CHARPOS (startp
) == BEGV
))
15474 eassert (row
->enabled_p
);
15478 /* Consider the following case: Window starts at BEGV,
15479 there is invisible, intangible text at BEGV, so that
15480 display starts at some point START > BEGV. It can
15481 happen that we are called with PT somewhere between
15482 BEGV and START. Try to handle that case. */
15483 if (row
< w
->current_matrix
->rows
15484 || row
->mode_line_p
)
15486 row
= w
->current_matrix
->rows
;
15487 if (row
->mode_line_p
)
15491 /* Due to newlines in overlay strings, we may have to
15492 skip forward over overlay strings. */
15493 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15494 && MATRIX_ROW_END_CHARPOS (row
) == PT
15495 && !cursor_row_p (row
))
15498 /* If within the scroll margin, scroll. */
15499 if (row
->y
< top_scroll_margin
15500 && CHARPOS (startp
) != BEGV
)
15505 /* Cursor did not move. So don't scroll even if cursor line
15506 is partially visible, as it was so before. */
15507 rc
= CURSOR_MOVEMENT_SUCCESS
;
15510 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15511 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15513 /* if PT is not in the glyph row, give up. */
15514 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15517 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15518 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15520 struct glyph_row
*row1
;
15522 /* If rows are bidi-reordered and point moved, back up
15523 until we find a row that does not belong to a
15524 continuation line. This is because we must consider
15525 all rows of a continued line as candidates for the
15526 new cursor positioning, since row start and end
15527 positions change non-linearly with vertical position
15529 /* FIXME: Revisit this when glyph ``spilling'' in
15530 continuation lines' rows is implemented for
15531 bidi-reordered rows. */
15532 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15533 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15536 /* If we hit the beginning of the displayed portion
15537 without finding the first row of a continued
15541 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15544 eassert (row
->enabled_p
);
15549 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15550 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15551 /* Make sure this isn't a header line by any chance, since
15552 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15553 && !row
->mode_line_p
15554 && make_cursor_line_fully_visible_p
)
15556 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15557 && !row
->ends_at_zv_p
15558 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15559 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15560 else if (row
->height
> window_box_height (w
))
15562 /* If we end up in a partially visible line, let's
15563 make it fully visible, except when it's taller
15564 than the window, in which case we can't do much
15567 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15571 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15572 if (!cursor_row_fully_visible_p (w
, 0, 1))
15573 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15575 rc
= CURSOR_MOVEMENT_SUCCESS
;
15579 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15580 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15581 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15583 /* With bidi-reordered rows, there could be more than
15584 one candidate row whose start and end positions
15585 occlude point. We need to let set_cursor_from_row
15586 find the best candidate. */
15587 /* FIXME: Revisit this when glyph ``spilling'' in
15588 continuation lines' rows is implemented for
15589 bidi-reordered rows. */
15594 int at_zv_p
= 0, exact_match_p
= 0;
15596 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15597 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15598 && cursor_row_p (row
))
15599 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15601 /* As soon as we've found the exact match for point,
15602 or the first suitable row whose ends_at_zv_p flag
15603 is set, we are done. */
15606 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15607 w
->cursor
.vpos
)->ends_at_zv_p
;
15609 && w
->cursor
.hpos
>= 0
15610 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15613 struct glyph_row
*candidate
=
15614 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15616 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15617 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15620 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15621 || (INTEGERP (g
->object
)
15622 && (g
->charpos
== PT
15623 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15625 if (at_zv_p
|| exact_match_p
)
15627 rc
= CURSOR_MOVEMENT_SUCCESS
;
15631 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15635 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15636 || row
->continued_p
)
15637 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15638 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15639 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15640 /* If we didn't find any candidate rows, or exited the
15641 loop before all the candidates were examined, signal
15642 to the caller that this method failed. */
15643 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15645 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15646 && !row
->continued_p
))
15647 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15649 rc
= CURSOR_MOVEMENT_SUCCESS
;
15655 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15657 rc
= CURSOR_MOVEMENT_SUCCESS
;
15662 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15663 && MATRIX_ROW_START_CHARPOS (row
) == PT
15664 && cursor_row_p (row
));
15673 set_vertical_scroll_bar (struct window
*w
)
15675 ptrdiff_t start
, end
, whole
;
15677 /* Calculate the start and end positions for the current window.
15678 At some point, it would be nice to choose between scrollbars
15679 which reflect the whole buffer size, with special markers
15680 indicating narrowing, and scrollbars which reflect only the
15683 Note that mini-buffers sometimes aren't displaying any text. */
15684 if (!MINI_WINDOW_P (w
)
15685 || (w
== XWINDOW (minibuf_window
)
15686 && NILP (echo_area_buffer
[0])))
15688 struct buffer
*buf
= XBUFFER (w
->contents
);
15689 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15690 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15691 /* I don't think this is guaranteed to be right. For the
15692 moment, we'll pretend it is. */
15693 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15697 if (whole
< (end
- start
))
15698 whole
= end
- start
;
15701 start
= end
= whole
= 0;
15703 /* Indicate what this scroll bar ought to be displaying now. */
15704 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15705 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15706 (w
, end
- start
, whole
, start
);
15710 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15711 selected_window is redisplayed.
15713 We can return without actually redisplaying the window if fonts has been
15714 changed on window's frame. In that case, redisplay_internal will retry.
15716 As one of the important parts of redisplaying a window, we need to
15717 decide whether the previous window-start position (stored in the
15718 window's w->start marker position) is still valid, and if it isn't,
15719 recompute it. Some details about that:
15721 . The previous window-start could be in a continuation line, in
15722 which case we need to recompute it when the window width
15723 changes. See compute_window_start_on_continuation_line and its
15726 . The text that changed since last redisplay could include the
15727 previous window-start position. In that case, we try to salvage
15728 what we can from the current glyph matrix by calling
15729 try_scrolling, which see.
15731 . Some Emacs command could force us to use a specific window-start
15732 position by setting the window's force_start flag, or gently
15733 propose doing that by setting the window's optional_new_start
15734 flag. In these cases, we try using the specified start point if
15735 that succeeds (i.e. the window desired matrix is successfully
15736 recomputed, and point location is within the window). In case
15737 of optional_new_start, we first check if the specified start
15738 position is feasible, i.e. if it will allow point to be
15739 displayed in the window. If using the specified start point
15740 fails, e.g., if new fonts are needed to be loaded, we abort the
15741 redisplay cycle and leave it up to the next cycle to figure out
15744 . Note that the window's force_start flag is sometimes set by
15745 redisplay itself, when it decides that the previous window start
15746 point is fine and should be kept. Search for "goto force_start"
15747 below to see the details. Like the values of window-start
15748 specified outside of redisplay, these internally-deduced values
15749 are tested for feasibility, and ignored if found to be
15752 . Note that the function try_window, used to completely redisplay
15753 a window, accepts the window's start point as its argument.
15754 This is used several times in the redisplay code to control
15755 where the window start will be, according to user options such
15756 as scroll-conservatively, and also to ensure the screen line
15757 showing point will be fully (as opposed to partially) visible on
15761 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15763 struct window
*w
= XWINDOW (window
);
15764 struct frame
*f
= XFRAME (w
->frame
);
15765 struct buffer
*buffer
= XBUFFER (w
->contents
);
15766 struct buffer
*old
= current_buffer
;
15767 struct text_pos lpoint
, opoint
, startp
;
15768 int update_mode_line
;
15771 /* Record it now because it's overwritten. */
15772 bool current_matrix_up_to_date_p
= false;
15773 bool used_current_matrix_p
= false;
15774 /* This is less strict than current_matrix_up_to_date_p.
15775 It indicates that the buffer contents and narrowing are unchanged. */
15776 bool buffer_unchanged_p
= false;
15777 int temp_scroll_step
= 0;
15779 int centering_position
= -1;
15780 int last_line_misfit
= 0;
15781 ptrdiff_t beg_unchanged
, end_unchanged
;
15782 int frame_line_height
;
15784 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15788 *w
->desired_matrix
->method
= 0;
15791 if (!just_this_one_p
15792 && REDISPLAY_SOME_P ()
15795 && !buffer
->text
->redisplay
15796 && BUF_PT (buffer
) == w
->last_point
)
15799 /* Make sure that both W's markers are valid. */
15800 eassert (XMARKER (w
->start
)->buffer
== buffer
);
15801 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
15805 /* We come here again if we need to run window-text-change-functions
15808 reconsider_clip_changes (w
);
15809 frame_line_height
= default_line_pixel_height (w
);
15811 /* Has the mode line to be updated? */
15812 update_mode_line
= (w
->update_mode_line
15813 || update_mode_lines
15814 || buffer
->clip_changed
15815 || buffer
->prevent_redisplay_optimizations_p
);
15817 if (!just_this_one_p
)
15818 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
15819 cleverly elsewhere. */
15820 w
->must_be_updated_p
= true;
15822 if (MINI_WINDOW_P (w
))
15824 if (w
== XWINDOW (echo_area_window
)
15825 && !NILP (echo_area_buffer
[0]))
15827 if (update_mode_line
)
15828 /* We may have to update a tty frame's menu bar or a
15829 tool-bar. Example `M-x C-h C-h C-g'. */
15830 goto finish_menu_bars
;
15832 /* We've already displayed the echo area glyphs in this window. */
15833 goto finish_scroll_bars
;
15835 else if ((w
!= XWINDOW (minibuf_window
)
15836 || minibuf_level
== 0)
15837 /* When buffer is nonempty, redisplay window normally. */
15838 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
15839 /* Quail displays non-mini buffers in minibuffer window.
15840 In that case, redisplay the window normally. */
15841 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
15843 /* W is a mini-buffer window, but it's not active, so clear
15845 int yb
= window_text_bottom_y (w
);
15846 struct glyph_row
*row
;
15849 for (y
= 0, row
= w
->desired_matrix
->rows
;
15851 y
+= row
->height
, ++row
)
15852 blank_row (w
, row
, y
);
15853 goto finish_scroll_bars
;
15856 clear_glyph_matrix (w
->desired_matrix
);
15859 /* Otherwise set up data on this window; select its buffer and point
15861 /* Really select the buffer, for the sake of buffer-local
15863 set_buffer_internal_1 (XBUFFER (w
->contents
));
15865 current_matrix_up_to_date_p
15866 = (w
->window_end_valid
15867 && !current_buffer
->clip_changed
15868 && !current_buffer
->prevent_redisplay_optimizations_p
15869 && !window_outdated (w
));
15871 /* Run the window-text-change-functions
15872 if it is possible that the text on the screen has changed
15873 (either due to modification of the text, or any other reason). */
15874 if (!current_matrix_up_to_date_p
15875 && !NILP (Vwindow_text_change_functions
))
15877 safe_run_hooks (Qwindow_text_change_functions
);
15881 beg_unchanged
= BEG_UNCHANGED
;
15882 end_unchanged
= END_UNCHANGED
;
15884 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
15886 specbind (Qinhibit_point_motion_hooks
, Qt
);
15889 = (w
->window_end_valid
15890 && !current_buffer
->clip_changed
15891 && !window_outdated (w
));
15893 /* When windows_or_buffers_changed is non-zero, we can't rely
15894 on the window end being valid, so set it to zero there. */
15895 if (windows_or_buffers_changed
)
15897 /* If window starts on a continuation line, maybe adjust the
15898 window start in case the window's width changed. */
15899 if (XMARKER (w
->start
)->buffer
== current_buffer
)
15900 compute_window_start_on_continuation_line (w
);
15902 w
->window_end_valid
= false;
15903 /* If so, we also can't rely on current matrix
15904 and should not fool try_cursor_movement below. */
15905 current_matrix_up_to_date_p
= false;
15908 /* Some sanity checks. */
15909 CHECK_WINDOW_END (w
);
15910 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
15912 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
15915 if (mode_line_update_needed (w
))
15916 update_mode_line
= 1;
15918 /* Point refers normally to the selected window. For any other
15919 window, set up appropriate value. */
15920 if (!EQ (window
, selected_window
))
15922 ptrdiff_t new_pt
= marker_position (w
->pointm
);
15923 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
15927 new_pt_byte
= BEGV_BYTE
;
15928 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
15930 else if (new_pt
> (ZV
- 1))
15933 new_pt_byte
= ZV_BYTE
;
15934 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
15937 /* We don't use SET_PT so that the point-motion hooks don't run. */
15938 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
15941 /* If any of the character widths specified in the display table
15942 have changed, invalidate the width run cache. It's true that
15943 this may be a bit late to catch such changes, but the rest of
15944 redisplay goes (non-fatally) haywire when the display table is
15945 changed, so why should we worry about doing any better? */
15946 if (current_buffer
->width_run_cache
15947 || (current_buffer
->base_buffer
15948 && current_buffer
->base_buffer
->width_run_cache
))
15950 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
15952 if (! disptab_matches_widthtab
15953 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
15955 struct buffer
*buf
= current_buffer
;
15957 if (buf
->base_buffer
)
15958 buf
= buf
->base_buffer
;
15959 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
15960 recompute_width_table (current_buffer
, disptab
);
15964 /* If window-start is screwed up, choose a new one. */
15965 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
15968 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15970 /* If someone specified a new starting point but did not insist,
15971 check whether it can be used. */
15972 if (w
->optional_new_start
15973 && CHARPOS (startp
) >= BEGV
15974 && CHARPOS (startp
) <= ZV
)
15976 w
->optional_new_start
= 0;
15977 start_display (&it
, w
, startp
);
15978 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
15979 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15980 if (IT_CHARPOS (it
) == PT
)
15981 w
->force_start
= 1;
15982 /* IT may overshoot PT if text at PT is invisible. */
15983 else if (IT_CHARPOS (it
) > PT
&& CHARPOS (startp
) <= PT
)
15984 w
->force_start
= 1;
15989 /* Handle case where place to start displaying has been specified,
15990 unless the specified location is outside the accessible range. */
15991 if (w
->force_start
|| window_frozen_p (w
))
15993 /* We set this later on if we have to adjust point. */
15996 w
->force_start
= 0;
15998 w
->window_end_valid
= 0;
16000 /* Forget any recorded base line for line number display. */
16001 if (!buffer_unchanged_p
)
16002 w
->base_line_number
= 0;
16004 /* Redisplay the mode line. Select the buffer properly for that.
16005 Also, run the hook window-scroll-functions
16006 because we have scrolled. */
16007 /* Note, we do this after clearing force_start because
16008 if there's an error, it is better to forget about force_start
16009 than to get into an infinite loop calling the hook functions
16010 and having them get more errors. */
16011 if (!update_mode_line
16012 || ! NILP (Vwindow_scroll_functions
))
16014 update_mode_line
= 1;
16015 w
->update_mode_line
= 1;
16016 startp
= run_window_scroll_functions (window
, startp
);
16019 if (CHARPOS (startp
) < BEGV
)
16020 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16021 else if (CHARPOS (startp
) > ZV
)
16022 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16024 /* Redisplay, then check if cursor has been set during the
16025 redisplay. Give up if new fonts were loaded. */
16026 /* We used to issue a CHECK_MARGINS argument to try_window here,
16027 but this causes scrolling to fail when point begins inside
16028 the scroll margin (bug#148) -- cyd */
16029 if (!try_window (window
, startp
, 0))
16031 w
->force_start
= 1;
16032 clear_glyph_matrix (w
->desired_matrix
);
16033 goto need_larger_matrices
;
16036 if (w
->cursor
.vpos
< 0 && !window_frozen_p (w
))
16038 /* If point does not appear, try to move point so it does
16039 appear. The desired matrix has been built above, so we
16040 can use it here. */
16041 new_vpos
= window_box_height (w
) / 2;
16044 if (!cursor_row_fully_visible_p (w
, 0, 0))
16046 /* Point does appear, but on a line partly visible at end of window.
16047 Move it back to a fully-visible line. */
16048 new_vpos
= window_box_height (w
);
16050 else if (w
->cursor
.vpos
>= 0)
16052 /* Some people insist on not letting point enter the scroll
16053 margin, even though this part handles windows that didn't
16055 int window_total_lines
16056 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16057 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16058 int pixel_margin
= margin
* frame_line_height
;
16059 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16061 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16062 below, which finds the row to move point to, advances by
16063 the Y coordinate of the _next_ row, see the definition of
16064 MATRIX_ROW_BOTTOM_Y. */
16065 if (w
->cursor
.vpos
< margin
+ header_line
)
16067 w
->cursor
.vpos
= -1;
16068 clear_glyph_matrix (w
->desired_matrix
);
16069 goto try_to_scroll
;
16073 int window_height
= window_box_height (w
);
16076 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16077 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16079 w
->cursor
.vpos
= -1;
16080 clear_glyph_matrix (w
->desired_matrix
);
16081 goto try_to_scroll
;
16086 /* If we need to move point for either of the above reasons,
16087 now actually do it. */
16090 struct glyph_row
*row
;
16092 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16093 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16096 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16097 MATRIX_ROW_START_BYTEPOS (row
));
16099 if (w
!= XWINDOW (selected_window
))
16100 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16101 else if (current_buffer
== old
)
16102 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16104 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16106 /* If we are highlighting the region, then we just changed
16107 the region, so redisplay to show it. */
16108 /* FIXME: We need to (re)run pre-redisplay-function! */
16109 /* if (markpos_of_region () >= 0)
16111 clear_glyph_matrix (w->desired_matrix);
16112 if (!try_window (window, startp, 0))
16113 goto need_larger_matrices;
16119 debug_method_add (w
, "forced window start");
16124 /* Handle case where text has not changed, only point, and it has
16125 not moved off the frame, and we are not retrying after hscroll.
16126 (current_matrix_up_to_date_p is nonzero when retrying.) */
16127 if (current_matrix_up_to_date_p
16128 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16129 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16133 case CURSOR_MOVEMENT_SUCCESS
:
16134 used_current_matrix_p
= 1;
16137 case CURSOR_MOVEMENT_MUST_SCROLL
:
16138 goto try_to_scroll
;
16144 /* If current starting point was originally the beginning of a line
16145 but no longer is, find a new starting point. */
16146 else if (w
->start_at_line_beg
16147 && !(CHARPOS (startp
) <= BEGV
16148 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16151 debug_method_add (w
, "recenter 1");
16156 /* Try scrolling with try_window_id. Value is > 0 if update has
16157 been done, it is -1 if we know that the same window start will
16158 not work. It is 0 if unsuccessful for some other reason. */
16159 else if ((tem
= try_window_id (w
)) != 0)
16162 debug_method_add (w
, "try_window_id %d", tem
);
16165 if (f
->fonts_changed
)
16166 goto need_larger_matrices
;
16170 /* Otherwise try_window_id has returned -1 which means that we
16171 don't want the alternative below this comment to execute. */
16173 else if (CHARPOS (startp
) >= BEGV
16174 && CHARPOS (startp
) <= ZV
16175 && PT
>= CHARPOS (startp
)
16176 && (CHARPOS (startp
) < ZV
16177 /* Avoid starting at end of buffer. */
16178 || CHARPOS (startp
) == BEGV
16179 || !window_outdated (w
)))
16181 int d1
, d2
, d3
, d4
, d5
, d6
;
16183 /* If first window line is a continuation line, and window start
16184 is inside the modified region, but the first change is before
16185 current window start, we must select a new window start.
16187 However, if this is the result of a down-mouse event (e.g. by
16188 extending the mouse-drag-overlay), we don't want to select a
16189 new window start, since that would change the position under
16190 the mouse, resulting in an unwanted mouse-movement rather
16191 than a simple mouse-click. */
16192 if (!w
->start_at_line_beg
16193 && NILP (do_mouse_tracking
)
16194 && CHARPOS (startp
) > BEGV
16195 && CHARPOS (startp
) > BEG
+ beg_unchanged
16196 && CHARPOS (startp
) <= Z
- end_unchanged
16197 /* Even if w->start_at_line_beg is nil, a new window may
16198 start at a line_beg, since that's how set_buffer_window
16199 sets it. So, we need to check the return value of
16200 compute_window_start_on_continuation_line. (See also
16202 && XMARKER (w
->start
)->buffer
== current_buffer
16203 && compute_window_start_on_continuation_line (w
)
16204 /* It doesn't make sense to force the window start like we
16205 do at label force_start if it is already known that point
16206 will not be visible in the resulting window, because
16207 doing so will move point from its correct position
16208 instead of scrolling the window to bring point into view.
16210 && pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &d6
))
16212 w
->force_start
= 1;
16213 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16218 debug_method_add (w
, "same window start");
16221 /* Try to redisplay starting at same place as before.
16222 If point has not moved off frame, accept the results. */
16223 if (!current_matrix_up_to_date_p
16224 /* Don't use try_window_reusing_current_matrix in this case
16225 because a window scroll function can have changed the
16227 || !NILP (Vwindow_scroll_functions
)
16228 || MINI_WINDOW_P (w
)
16229 || !(used_current_matrix_p
16230 = try_window_reusing_current_matrix (w
)))
16232 IF_DEBUG (debug_method_add (w
, "1"));
16233 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16234 /* -1 means we need to scroll.
16235 0 means we need new matrices, but fonts_changed
16236 is set in that case, so we will detect it below. */
16237 goto try_to_scroll
;
16240 if (f
->fonts_changed
)
16241 goto need_larger_matrices
;
16243 if (w
->cursor
.vpos
>= 0)
16245 if (!just_this_one_p
16246 || current_buffer
->clip_changed
16247 || BEG_UNCHANGED
< CHARPOS (startp
))
16248 /* Forget any recorded base line for line number display. */
16249 w
->base_line_number
= 0;
16251 if (!cursor_row_fully_visible_p (w
, 1, 0))
16253 clear_glyph_matrix (w
->desired_matrix
);
16254 last_line_misfit
= 1;
16256 /* Drop through and scroll. */
16261 clear_glyph_matrix (w
->desired_matrix
);
16266 /* Redisplay the mode line. Select the buffer properly for that. */
16267 if (!update_mode_line
)
16269 update_mode_line
= 1;
16270 w
->update_mode_line
= 1;
16273 /* Try to scroll by specified few lines. */
16274 if ((scroll_conservatively
16275 || emacs_scroll_step
16276 || temp_scroll_step
16277 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16278 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16279 && CHARPOS (startp
) >= BEGV
16280 && CHARPOS (startp
) <= ZV
)
16282 /* The function returns -1 if new fonts were loaded, 1 if
16283 successful, 0 if not successful. */
16284 int ss
= try_scrolling (window
, just_this_one_p
,
16285 scroll_conservatively
,
16287 temp_scroll_step
, last_line_misfit
);
16290 case SCROLLING_SUCCESS
:
16293 case SCROLLING_NEED_LARGER_MATRICES
:
16294 goto need_larger_matrices
;
16296 case SCROLLING_FAILED
:
16304 /* Finally, just choose a place to start which positions point
16305 according to user preferences. */
16310 debug_method_add (w
, "recenter");
16313 /* Forget any previously recorded base line for line number display. */
16314 if (!buffer_unchanged_p
)
16315 w
->base_line_number
= 0;
16317 /* Determine the window start relative to point. */
16318 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16319 it
.current_y
= it
.last_visible_y
;
16320 if (centering_position
< 0)
16322 int window_total_lines
16323 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16326 ? min (scroll_margin
, window_total_lines
/ 4)
16328 ptrdiff_t margin_pos
= CHARPOS (startp
);
16329 Lisp_Object aggressive
;
16332 /* If there is a scroll margin at the top of the window, find
16333 its character position. */
16335 /* Cannot call start_display if startp is not in the
16336 accessible region of the buffer. This can happen when we
16337 have just switched to a different buffer and/or changed
16338 its restriction. In that case, startp is initialized to
16339 the character position 1 (BEGV) because we did not yet
16340 have chance to display the buffer even once. */
16341 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16344 void *it1data
= NULL
;
16346 SAVE_IT (it1
, it
, it1data
);
16347 start_display (&it1
, w
, startp
);
16348 move_it_vertically (&it1
, margin
* frame_line_height
);
16349 margin_pos
= IT_CHARPOS (it1
);
16350 RESTORE_IT (&it
, &it
, it1data
);
16352 scrolling_up
= PT
> margin_pos
;
16355 ? BVAR (current_buffer
, scroll_up_aggressively
)
16356 : BVAR (current_buffer
, scroll_down_aggressively
);
16358 if (!MINI_WINDOW_P (w
)
16359 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16363 /* Setting scroll-conservatively overrides
16364 scroll-*-aggressively. */
16365 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16367 double float_amount
= XFLOATINT (aggressive
);
16369 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16370 if (pt_offset
== 0 && float_amount
> 0)
16372 if (pt_offset
&& margin
> 0)
16375 /* Compute how much to move the window start backward from
16376 point so that point will be displayed where the user
16380 centering_position
= it
.last_visible_y
;
16382 centering_position
-= pt_offset
;
16383 centering_position
-=
16384 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16385 + WINDOW_HEADER_LINE_HEIGHT (w
);
16386 /* Don't let point enter the scroll margin near top of
16388 if (centering_position
< margin
* frame_line_height
)
16389 centering_position
= margin
* frame_line_height
;
16392 centering_position
= margin
* frame_line_height
+ pt_offset
;
16395 /* Set the window start half the height of the window backward
16397 centering_position
= window_box_height (w
) / 2;
16399 move_it_vertically_backward (&it
, centering_position
);
16401 eassert (IT_CHARPOS (it
) >= BEGV
);
16403 /* The function move_it_vertically_backward may move over more
16404 than the specified y-distance. If it->w is small, e.g. a
16405 mini-buffer window, we may end up in front of the window's
16406 display area. Start displaying at the start of the line
16407 containing PT in this case. */
16408 if (it
.current_y
<= 0)
16410 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16411 move_it_vertically_backward (&it
, 0);
16415 it
.current_x
= it
.hpos
= 0;
16417 /* Set the window start position here explicitly, to avoid an
16418 infinite loop in case the functions in window-scroll-functions
16420 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16422 /* Run scroll hooks. */
16423 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16425 /* Redisplay the window. */
16426 if (!current_matrix_up_to_date_p
16427 || windows_or_buffers_changed
16428 || f
->cursor_type_changed
16429 /* Don't use try_window_reusing_current_matrix in this case
16430 because it can have changed the buffer. */
16431 || !NILP (Vwindow_scroll_functions
)
16432 || !just_this_one_p
16433 || MINI_WINDOW_P (w
)
16434 || !(used_current_matrix_p
16435 = try_window_reusing_current_matrix (w
)))
16436 try_window (window
, startp
, 0);
16438 /* If new fonts have been loaded (due to fontsets), give up. We
16439 have to start a new redisplay since we need to re-adjust glyph
16441 if (f
->fonts_changed
)
16442 goto need_larger_matrices
;
16444 /* If cursor did not appear assume that the middle of the window is
16445 in the first line of the window. Do it again with the next line.
16446 (Imagine a window of height 100, displaying two lines of height
16447 60. Moving back 50 from it->last_visible_y will end in the first
16449 if (w
->cursor
.vpos
< 0)
16451 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16453 clear_glyph_matrix (w
->desired_matrix
);
16454 move_it_by_lines (&it
, 1);
16455 try_window (window
, it
.current
.pos
, 0);
16457 else if (PT
< IT_CHARPOS (it
))
16459 clear_glyph_matrix (w
->desired_matrix
);
16460 move_it_by_lines (&it
, -1);
16461 try_window (window
, it
.current
.pos
, 0);
16465 /* Not much we can do about it. */
16469 /* Consider the following case: Window starts at BEGV, there is
16470 invisible, intangible text at BEGV, so that display starts at
16471 some point START > BEGV. It can happen that we are called with
16472 PT somewhere between BEGV and START. Try to handle that case,
16473 and similar ones. */
16474 if (w
->cursor
.vpos
< 0)
16476 /* First, try locating the proper glyph row for PT. */
16477 struct glyph_row
*row
=
16478 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16480 /* Sometimes point is at the beginning of invisible text that is
16481 before the 1st character displayed in the row. In that case,
16482 row_containing_pos fails to find the row, because no glyphs
16483 with appropriate buffer positions are present in the row.
16484 Therefore, we next try to find the row which shows the 1st
16485 position after the invisible text. */
16489 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16492 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16495 Lisp_Object invis_end
=
16496 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16499 if (NATNUMP (invis_end
))
16500 alt_pos
= XFASTINT (invis_end
);
16503 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16507 /* Finally, fall back on the first row of the window after the
16508 header line (if any). This is slightly better than not
16509 displaying the cursor at all. */
16512 row
= w
->current_matrix
->rows
;
16513 if (row
->mode_line_p
)
16516 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16519 if (!cursor_row_fully_visible_p (w
, 0, 0))
16521 /* If vscroll is enabled, disable it and try again. */
16525 clear_glyph_matrix (w
->desired_matrix
);
16529 /* Users who set scroll-conservatively to a large number want
16530 point just above/below the scroll margin. If we ended up
16531 with point's row partially visible, move the window start to
16532 make that row fully visible and out of the margin. */
16533 if (scroll_conservatively
> SCROLL_LIMIT
)
16535 int window_total_lines
16536 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16539 ? min (scroll_margin
, window_total_lines
/ 4)
16541 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16543 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16544 clear_glyph_matrix (w
->desired_matrix
);
16545 if (1 == try_window (window
, it
.current
.pos
,
16546 TRY_WINDOW_CHECK_MARGINS
))
16550 /* If centering point failed to make the whole line visible,
16551 put point at the top instead. That has to make the whole line
16552 visible, if it can be done. */
16553 if (centering_position
== 0)
16556 clear_glyph_matrix (w
->desired_matrix
);
16557 centering_position
= 0;
16563 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16564 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16565 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16567 /* Display the mode line, if we must. */
16568 if ((update_mode_line
16569 /* If window not full width, must redo its mode line
16570 if (a) the window to its side is being redone and
16571 (b) we do a frame-based redisplay. This is a consequence
16572 of how inverted lines are drawn in frame-based redisplay. */
16573 || (!just_this_one_p
16574 && !FRAME_WINDOW_P (f
)
16575 && !WINDOW_FULL_WIDTH_P (w
))
16576 /* Line number to display. */
16577 || w
->base_line_pos
> 0
16578 /* Column number is displayed and different from the one displayed. */
16579 || (w
->column_number_displayed
!= -1
16580 && (w
->column_number_displayed
!= current_column ())))
16581 /* This means that the window has a mode line. */
16582 && (WINDOW_WANTS_MODELINE_P (w
)
16583 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16586 display_mode_lines (w
);
16588 /* If mode line height has changed, arrange for a thorough
16589 immediate redisplay using the correct mode line height. */
16590 if (WINDOW_WANTS_MODELINE_P (w
)
16591 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16593 f
->fonts_changed
= 1;
16594 w
->mode_line_height
= -1;
16595 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16596 = DESIRED_MODE_LINE_HEIGHT (w
);
16599 /* If header line height has changed, arrange for a thorough
16600 immediate redisplay using the correct header line height. */
16601 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16602 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16604 f
->fonts_changed
= 1;
16605 w
->header_line_height
= -1;
16606 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16607 = DESIRED_HEADER_LINE_HEIGHT (w
);
16610 if (f
->fonts_changed
)
16611 goto need_larger_matrices
;
16614 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16616 w
->base_line_pos
= 0;
16617 w
->base_line_number
= 0;
16622 /* When we reach a frame's selected window, redo the frame's menu bar. */
16623 if (update_mode_line
16624 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16626 int redisplay_menu_p
= 0;
16628 if (FRAME_WINDOW_P (f
))
16630 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16631 || defined (HAVE_NS) || defined (USE_GTK)
16632 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16634 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16638 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16640 if (redisplay_menu_p
)
16641 display_menu_bar (w
);
16643 #ifdef HAVE_WINDOW_SYSTEM
16644 if (FRAME_WINDOW_P (f
))
16646 #if defined (USE_GTK) || defined (HAVE_NS)
16647 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16648 redisplay_tool_bar (f
);
16650 if (WINDOWP (f
->tool_bar_window
)
16651 && (FRAME_TOOL_BAR_HEIGHT (f
) > 0
16652 || !NILP (Vauto_resize_tool_bars
))
16653 && redisplay_tool_bar (f
))
16654 ignore_mouse_drag_p
= 1;
16660 #ifdef HAVE_WINDOW_SYSTEM
16661 if (FRAME_WINDOW_P (f
)
16662 && update_window_fringes (w
, (just_this_one_p
16663 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16664 || w
->pseudo_window_p
)))
16668 if (draw_window_fringes (w
, 1))
16670 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16671 x_draw_right_divider (w
);
16673 x_draw_vertical_border (w
);
16679 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16680 x_draw_bottom_divider (w
);
16681 #endif /* HAVE_WINDOW_SYSTEM */
16683 /* We go to this label, with fonts_changed set, if it is
16684 necessary to try again using larger glyph matrices.
16685 We have to redeem the scroll bar even in this case,
16686 because the loop in redisplay_internal expects that. */
16687 need_larger_matrices
:
16689 finish_scroll_bars
:
16691 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16693 /* Set the thumb's position and size. */
16694 set_vertical_scroll_bar (w
);
16696 /* Note that we actually used the scroll bar attached to this
16697 window, so it shouldn't be deleted at the end of redisplay. */
16698 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16699 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16702 /* Restore current_buffer and value of point in it. The window
16703 update may have changed the buffer, so first make sure `opoint'
16704 is still valid (Bug#6177). */
16705 if (CHARPOS (opoint
) < BEGV
)
16706 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16707 else if (CHARPOS (opoint
) > ZV
)
16708 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16710 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16712 set_buffer_internal_1 (old
);
16713 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16714 shorter. This can be caused by log truncation in *Messages*. */
16715 if (CHARPOS (lpoint
) <= ZV
)
16716 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16722 /* Build the complete desired matrix of WINDOW with a window start
16723 buffer position POS.
16725 Value is 1 if successful. It is zero if fonts were loaded during
16726 redisplay which makes re-adjusting glyph matrices necessary, and -1
16727 if point would appear in the scroll margins.
16728 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16729 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16733 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16735 struct window
*w
= XWINDOW (window
);
16737 struct glyph_row
*last_text_row
= NULL
;
16738 struct frame
*f
= XFRAME (w
->frame
);
16739 int frame_line_height
= default_line_pixel_height (w
);
16741 /* Make POS the new window start. */
16742 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
16744 /* Mark cursor position as unknown. No overlay arrow seen. */
16745 w
->cursor
.vpos
= -1;
16746 overlay_arrow_seen
= 0;
16748 /* Initialize iterator and info to start at POS. */
16749 start_display (&it
, w
, pos
);
16751 /* Display all lines of W. */
16752 while (it
.current_y
< it
.last_visible_y
)
16754 if (display_line (&it
))
16755 last_text_row
= it
.glyph_row
- 1;
16756 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
16760 /* Don't let the cursor end in the scroll margins. */
16761 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
16762 && !MINI_WINDOW_P (w
))
16764 int this_scroll_margin
;
16765 int window_total_lines
16766 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16768 if (scroll_margin
> 0)
16770 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
16771 this_scroll_margin
*= frame_line_height
;
16774 this_scroll_margin
= 0;
16776 if ((w
->cursor
.y
>= 0 /* not vscrolled */
16777 && w
->cursor
.y
< this_scroll_margin
16778 && CHARPOS (pos
) > BEGV
16779 && IT_CHARPOS (it
) < ZV
)
16780 /* rms: considering make_cursor_line_fully_visible_p here
16781 seems to give wrong results. We don't want to recenter
16782 when the last line is partly visible, we want to allow
16783 that case to be handled in the usual way. */
16784 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
16786 w
->cursor
.vpos
= -1;
16787 clear_glyph_matrix (w
->desired_matrix
);
16792 /* If bottom moved off end of frame, change mode line percentage. */
16793 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
16794 w
->update_mode_line
= 1;
16796 /* Set window_end_pos to the offset of the last character displayed
16797 on the window from the end of current_buffer. Set
16798 window_end_vpos to its row number. */
16801 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
16802 adjust_window_ends (w
, last_text_row
, 0);
16804 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
16805 w
->window_end_vpos
)));
16809 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
16810 w
->window_end_pos
= Z
- ZV
;
16811 w
->window_end_vpos
= 0;
16814 /* But that is not valid info until redisplay finishes. */
16815 w
->window_end_valid
= 0;
16821 /************************************************************************
16822 Window redisplay reusing current matrix when buffer has not changed
16823 ************************************************************************/
16825 /* Try redisplay of window W showing an unchanged buffer with a
16826 different window start than the last time it was displayed by
16827 reusing its current matrix. Value is non-zero if successful.
16828 W->start is the new window start. */
16831 try_window_reusing_current_matrix (struct window
*w
)
16833 struct frame
*f
= XFRAME (w
->frame
);
16834 struct glyph_row
*bottom_row
;
16837 struct text_pos start
, new_start
;
16838 int nrows_scrolled
, i
;
16839 struct glyph_row
*last_text_row
;
16840 struct glyph_row
*last_reused_text_row
;
16841 struct glyph_row
*start_row
;
16842 int start_vpos
, min_y
, max_y
;
16845 if (inhibit_try_window_reusing
)
16849 if (/* This function doesn't handle terminal frames. */
16850 !FRAME_WINDOW_P (f
)
16851 /* Don't try to reuse the display if windows have been split
16853 || windows_or_buffers_changed
16854 || f
->cursor_type_changed
)
16857 /* Can't do this if showing trailing whitespace. */
16858 if (!NILP (Vshow_trailing_whitespace
))
16861 /* If top-line visibility has changed, give up. */
16862 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16863 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
16866 /* Give up if old or new display is scrolled vertically. We could
16867 make this function handle this, but right now it doesn't. */
16868 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16869 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
16872 /* The variable new_start now holds the new window start. The old
16873 start `start' can be determined from the current matrix. */
16874 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
16875 start
= start_row
->minpos
;
16876 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16878 /* Clear the desired matrix for the display below. */
16879 clear_glyph_matrix (w
->desired_matrix
);
16881 if (CHARPOS (new_start
) <= CHARPOS (start
))
16883 /* Don't use this method if the display starts with an ellipsis
16884 displayed for invisible text. It's not easy to handle that case
16885 below, and it's certainly not worth the effort since this is
16886 not a frequent case. */
16887 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
16890 IF_DEBUG (debug_method_add (w
, "twu1"));
16892 /* Display up to a row that can be reused. The variable
16893 last_text_row is set to the last row displayed that displays
16894 text. Note that it.vpos == 0 if or if not there is a
16895 header-line; it's not the same as the MATRIX_ROW_VPOS! */
16896 start_display (&it
, w
, new_start
);
16897 w
->cursor
.vpos
= -1;
16898 last_text_row
= last_reused_text_row
= NULL
;
16900 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
16902 /* If we have reached into the characters in the START row,
16903 that means the line boundaries have changed. So we
16904 can't start copying with the row START. Maybe it will
16905 work to start copying with the following row. */
16906 while (IT_CHARPOS (it
) > CHARPOS (start
))
16908 /* Advance to the next row as the "start". */
16910 start
= start_row
->minpos
;
16911 /* If there are no more rows to try, or just one, give up. */
16912 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
16913 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
16914 || CHARPOS (start
) == ZV
)
16916 clear_glyph_matrix (w
->desired_matrix
);
16920 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
16922 /* If we have reached alignment, we can copy the rest of the
16924 if (IT_CHARPOS (it
) == CHARPOS (start
)
16925 /* Don't accept "alignment" inside a display vector,
16926 since start_row could have started in the middle of
16927 that same display vector (thus their character
16928 positions match), and we have no way of telling if
16929 that is the case. */
16930 && it
.current
.dpvec_index
< 0)
16933 if (display_line (&it
))
16934 last_text_row
= it
.glyph_row
- 1;
16938 /* A value of current_y < last_visible_y means that we stopped
16939 at the previous window start, which in turn means that we
16940 have at least one reusable row. */
16941 if (it
.current_y
< it
.last_visible_y
)
16943 struct glyph_row
*row
;
16945 /* IT.vpos always starts from 0; it counts text lines. */
16946 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
16948 /* Find PT if not already found in the lines displayed. */
16949 if (w
->cursor
.vpos
< 0)
16951 int dy
= it
.current_y
- start_row
->y
;
16953 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
16954 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
16956 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
16957 dy
, nrows_scrolled
);
16960 clear_glyph_matrix (w
->desired_matrix
);
16965 /* Scroll the display. Do it before the current matrix is
16966 changed. The problem here is that update has not yet
16967 run, i.e. part of the current matrix is not up to date.
16968 scroll_run_hook will clear the cursor, and use the
16969 current matrix to get the height of the row the cursor is
16971 run
.current_y
= start_row
->y
;
16972 run
.desired_y
= it
.current_y
;
16973 run
.height
= it
.last_visible_y
- it
.current_y
;
16975 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
16978 FRAME_RIF (f
)->update_window_begin_hook (w
);
16979 FRAME_RIF (f
)->clear_window_mouse_face (w
);
16980 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
16981 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
16985 /* Shift current matrix down by nrows_scrolled lines. */
16986 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
16987 rotate_matrix (w
->current_matrix
,
16989 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
16992 /* Disable lines that must be updated. */
16993 for (i
= 0; i
< nrows_scrolled
; ++i
)
16994 (start_row
+ i
)->enabled_p
= false;
16996 /* Re-compute Y positions. */
16997 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
16998 max_y
= it
.last_visible_y
;
16999 for (row
= start_row
+ nrows_scrolled
;
17003 row
->y
= it
.current_y
;
17004 row
->visible_height
= row
->height
;
17006 if (row
->y
< min_y
)
17007 row
->visible_height
-= min_y
- row
->y
;
17008 if (row
->y
+ row
->height
> max_y
)
17009 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17010 if (row
->fringe_bitmap_periodic_p
)
17011 row
->redraw_fringe_bitmaps_p
= 1;
17013 it
.current_y
+= row
->height
;
17015 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17016 last_reused_text_row
= row
;
17017 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17021 /* Disable lines in the current matrix which are now
17022 below the window. */
17023 for (++row
; row
< bottom_row
; ++row
)
17024 row
->enabled_p
= row
->mode_line_p
= 0;
17027 /* Update window_end_pos etc.; last_reused_text_row is the last
17028 reused row from the current matrix containing text, if any.
17029 The value of last_text_row is the last displayed line
17030 containing text. */
17031 if (last_reused_text_row
)
17032 adjust_window_ends (w
, last_reused_text_row
, 1);
17033 else if (last_text_row
)
17034 adjust_window_ends (w
, last_text_row
, 0);
17037 /* This window must be completely empty. */
17038 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17039 w
->window_end_pos
= Z
- ZV
;
17040 w
->window_end_vpos
= 0;
17042 w
->window_end_valid
= 0;
17044 /* Update hint: don't try scrolling again in update_window. */
17045 w
->desired_matrix
->no_scrolling_p
= 1;
17048 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17052 else if (CHARPOS (new_start
) > CHARPOS (start
))
17054 struct glyph_row
*pt_row
, *row
;
17055 struct glyph_row
*first_reusable_row
;
17056 struct glyph_row
*first_row_to_display
;
17058 int yb
= window_text_bottom_y (w
);
17060 /* Find the row starting at new_start, if there is one. Don't
17061 reuse a partially visible line at the end. */
17062 first_reusable_row
= start_row
;
17063 while (first_reusable_row
->enabled_p
17064 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17065 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17066 < CHARPOS (new_start
)))
17067 ++first_reusable_row
;
17069 /* Give up if there is no row to reuse. */
17070 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17071 || !first_reusable_row
->enabled_p
17072 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17073 != CHARPOS (new_start
)))
17076 /* We can reuse fully visible rows beginning with
17077 first_reusable_row to the end of the window. Set
17078 first_row_to_display to the first row that cannot be reused.
17079 Set pt_row to the row containing point, if there is any. */
17081 for (first_row_to_display
= first_reusable_row
;
17082 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17083 ++first_row_to_display
)
17085 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17086 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17087 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17088 && first_row_to_display
->ends_at_zv_p
17089 && pt_row
== NULL
)))
17090 pt_row
= first_row_to_display
;
17093 /* Start displaying at the start of first_row_to_display. */
17094 eassert (first_row_to_display
->y
< yb
);
17095 init_to_row_start (&it
, w
, first_row_to_display
);
17097 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17099 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17101 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17102 + WINDOW_HEADER_LINE_HEIGHT (w
));
17104 /* Display lines beginning with first_row_to_display in the
17105 desired matrix. Set last_text_row to the last row displayed
17106 that displays text. */
17107 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17108 if (pt_row
== NULL
)
17109 w
->cursor
.vpos
= -1;
17110 last_text_row
= NULL
;
17111 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17112 if (display_line (&it
))
17113 last_text_row
= it
.glyph_row
- 1;
17115 /* If point is in a reused row, adjust y and vpos of the cursor
17119 w
->cursor
.vpos
-= nrows_scrolled
;
17120 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17123 /* Give up if point isn't in a row displayed or reused. (This
17124 also handles the case where w->cursor.vpos < nrows_scrolled
17125 after the calls to display_line, which can happen with scroll
17126 margins. See bug#1295.) */
17127 if (w
->cursor
.vpos
< 0)
17129 clear_glyph_matrix (w
->desired_matrix
);
17133 /* Scroll the display. */
17134 run
.current_y
= first_reusable_row
->y
;
17135 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17136 run
.height
= it
.last_visible_y
- run
.current_y
;
17137 dy
= run
.current_y
- run
.desired_y
;
17142 FRAME_RIF (f
)->update_window_begin_hook (w
);
17143 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17144 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17145 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17149 /* Adjust Y positions of reused rows. */
17150 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17151 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17152 max_y
= it
.last_visible_y
;
17153 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17156 row
->visible_height
= row
->height
;
17157 if (row
->y
< min_y
)
17158 row
->visible_height
-= min_y
- row
->y
;
17159 if (row
->y
+ row
->height
> max_y
)
17160 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17161 if (row
->fringe_bitmap_periodic_p
)
17162 row
->redraw_fringe_bitmaps_p
= 1;
17165 /* Scroll the current matrix. */
17166 eassert (nrows_scrolled
> 0);
17167 rotate_matrix (w
->current_matrix
,
17169 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17172 /* Disable rows not reused. */
17173 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17174 row
->enabled_p
= false;
17176 /* Point may have moved to a different line, so we cannot assume that
17177 the previous cursor position is valid; locate the correct row. */
17180 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17182 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17183 && !row
->ends_at_zv_p
;
17187 w
->cursor
.y
= row
->y
;
17189 if (row
< bottom_row
)
17191 /* Can't simply scan the row for point with
17192 bidi-reordered glyph rows. Let set_cursor_from_row
17193 figure out where to put the cursor, and if it fails,
17195 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17197 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17200 clear_glyph_matrix (w
->desired_matrix
);
17206 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17207 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17210 && (!BUFFERP (glyph
->object
)
17211 || glyph
->charpos
< PT
);
17215 w
->cursor
.x
+= glyph
->pixel_width
;
17221 /* Adjust window end. A null value of last_text_row means that
17222 the window end is in reused rows which in turn means that
17223 only its vpos can have changed. */
17225 adjust_window_ends (w
, last_text_row
, 0);
17227 w
->window_end_vpos
-= nrows_scrolled
;
17229 w
->window_end_valid
= 0;
17230 w
->desired_matrix
->no_scrolling_p
= 1;
17233 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17243 /************************************************************************
17244 Window redisplay reusing current matrix when buffer has changed
17245 ************************************************************************/
17247 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17248 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17249 ptrdiff_t *, ptrdiff_t *);
17250 static struct glyph_row
*
17251 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17252 struct glyph_row
*);
17255 /* Return the last row in MATRIX displaying text. If row START is
17256 non-null, start searching with that row. IT gives the dimensions
17257 of the display. Value is null if matrix is empty; otherwise it is
17258 a pointer to the row found. */
17260 static struct glyph_row
*
17261 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17262 struct glyph_row
*start
)
17264 struct glyph_row
*row
, *row_found
;
17266 /* Set row_found to the last row in IT->w's current matrix
17267 displaying text. The loop looks funny but think of partially
17270 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17271 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17273 eassert (row
->enabled_p
);
17275 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17284 /* Return the last row in the current matrix of W that is not affected
17285 by changes at the start of current_buffer that occurred since W's
17286 current matrix was built. Value is null if no such row exists.
17288 BEG_UNCHANGED us the number of characters unchanged at the start of
17289 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17290 first changed character in current_buffer. Characters at positions <
17291 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17292 when the current matrix was built. */
17294 static struct glyph_row
*
17295 find_last_unchanged_at_beg_row (struct window
*w
)
17297 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17298 struct glyph_row
*row
;
17299 struct glyph_row
*row_found
= NULL
;
17300 int yb
= window_text_bottom_y (w
);
17302 /* Find the last row displaying unchanged text. */
17303 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17304 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17305 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17308 if (/* If row ends before first_changed_pos, it is unchanged,
17309 except in some case. */
17310 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17311 /* When row ends in ZV and we write at ZV it is not
17313 && !row
->ends_at_zv_p
17314 /* When first_changed_pos is the end of a continued line,
17315 row is not unchanged because it may be no longer
17317 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17318 && (row
->continued_p
17319 || row
->exact_window_width_line_p
))
17320 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17321 needs to be recomputed, so don't consider this row as
17322 unchanged. This happens when the last line was
17323 bidi-reordered and was killed immediately before this
17324 redisplay cycle. In that case, ROW->end stores the
17325 buffer position of the first visual-order character of
17326 the killed text, which is now beyond ZV. */
17327 && CHARPOS (row
->end
.pos
) <= ZV
)
17330 /* Stop if last visible row. */
17331 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17339 /* Find the first glyph row in the current matrix of W that is not
17340 affected by changes at the end of current_buffer since the
17341 time W's current matrix was built.
17343 Return in *DELTA the number of chars by which buffer positions in
17344 unchanged text at the end of current_buffer must be adjusted.
17346 Return in *DELTA_BYTES the corresponding number of bytes.
17348 Value is null if no such row exists, i.e. all rows are affected by
17351 static struct glyph_row
*
17352 find_first_unchanged_at_end_row (struct window
*w
,
17353 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17355 struct glyph_row
*row
;
17356 struct glyph_row
*row_found
= NULL
;
17358 *delta
= *delta_bytes
= 0;
17360 /* Display must not have been paused, otherwise the current matrix
17361 is not up to date. */
17362 eassert (w
->window_end_valid
);
17364 /* A value of window_end_pos >= END_UNCHANGED means that the window
17365 end is in the range of changed text. If so, there is no
17366 unchanged row at the end of W's current matrix. */
17367 if (w
->window_end_pos
>= END_UNCHANGED
)
17370 /* Set row to the last row in W's current matrix displaying text. */
17371 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17373 /* If matrix is entirely empty, no unchanged row exists. */
17374 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17376 /* The value of row is the last glyph row in the matrix having a
17377 meaningful buffer position in it. The end position of row
17378 corresponds to window_end_pos. This allows us to translate
17379 buffer positions in the current matrix to current buffer
17380 positions for characters not in changed text. */
17382 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17383 ptrdiff_t Z_BYTE_old
=
17384 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17385 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17386 struct glyph_row
*first_text_row
17387 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17389 *delta
= Z
- Z_old
;
17390 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17392 /* Set last_unchanged_pos to the buffer position of the last
17393 character in the buffer that has not been changed. Z is the
17394 index + 1 of the last character in current_buffer, i.e. by
17395 subtracting END_UNCHANGED we get the index of the last
17396 unchanged character, and we have to add BEG to get its buffer
17398 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17399 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17401 /* Search backward from ROW for a row displaying a line that
17402 starts at a minimum position >= last_unchanged_pos_old. */
17403 for (; row
> first_text_row
; --row
)
17405 /* This used to abort, but it can happen.
17406 It is ok to just stop the search instead here. KFS. */
17407 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17410 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17415 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17421 /* Make sure that glyph rows in the current matrix of window W
17422 reference the same glyph memory as corresponding rows in the
17423 frame's frame matrix. This function is called after scrolling W's
17424 current matrix on a terminal frame in try_window_id and
17425 try_window_reusing_current_matrix. */
17428 sync_frame_with_window_matrix_rows (struct window
*w
)
17430 struct frame
*f
= XFRAME (w
->frame
);
17431 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17433 /* Preconditions: W must be a leaf window and full-width. Its frame
17434 must have a frame matrix. */
17435 eassert (BUFFERP (w
->contents
));
17436 eassert (WINDOW_FULL_WIDTH_P (w
));
17437 eassert (!FRAME_WINDOW_P (f
));
17439 /* If W is a full-width window, glyph pointers in W's current matrix
17440 have, by definition, to be the same as glyph pointers in the
17441 corresponding frame matrix. Note that frame matrices have no
17442 marginal areas (see build_frame_matrix). */
17443 window_row
= w
->current_matrix
->rows
;
17444 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17445 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17446 while (window_row
< window_row_end
)
17448 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17449 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17451 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17452 frame_row
->glyphs
[TEXT_AREA
] = start
;
17453 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17454 frame_row
->glyphs
[LAST_AREA
] = end
;
17456 /* Disable frame rows whose corresponding window rows have
17457 been disabled in try_window_id. */
17458 if (!window_row
->enabled_p
)
17459 frame_row
->enabled_p
= false;
17461 ++window_row
, ++frame_row
;
17466 /* Find the glyph row in window W containing CHARPOS. Consider all
17467 rows between START and END (not inclusive). END null means search
17468 all rows to the end of the display area of W. Value is the row
17469 containing CHARPOS or null. */
17472 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17473 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17475 struct glyph_row
*row
= start
;
17476 struct glyph_row
*best_row
= NULL
;
17477 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17480 /* If we happen to start on a header-line, skip that. */
17481 if (row
->mode_line_p
)
17484 if ((end
&& row
>= end
) || !row
->enabled_p
)
17487 last_y
= window_text_bottom_y (w
) - dy
;
17491 /* Give up if we have gone too far. */
17492 if (end
&& row
>= end
)
17494 /* This formerly returned if they were equal.
17495 I think that both quantities are of a "last plus one" type;
17496 if so, when they are equal, the row is within the screen. -- rms. */
17497 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17500 /* If it is in this row, return this row. */
17501 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17502 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17503 /* The end position of a row equals the start
17504 position of the next row. If CHARPOS is there, we
17505 would rather consider it displayed in the next
17506 line, except when this line ends in ZV. */
17507 && !row_for_charpos_p (row
, charpos
)))
17508 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17512 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17513 || (!best_row
&& !row
->continued_p
))
17515 /* In bidi-reordered rows, there could be several rows whose
17516 edges surround CHARPOS, all of these rows belonging to
17517 the same continued line. We need to find the row which
17518 fits CHARPOS the best. */
17519 for (g
= row
->glyphs
[TEXT_AREA
];
17520 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17523 if (!STRINGP (g
->object
))
17525 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17527 mindif
= eabs (g
->charpos
- charpos
);
17529 /* Exact match always wins. */
17536 else if (best_row
&& !row
->continued_p
)
17543 /* Try to redisplay window W by reusing its existing display. W's
17544 current matrix must be up to date when this function is called,
17545 i.e. window_end_valid must be nonzero.
17549 >= 1 if successful, i.e. display has been updated
17551 1 means the changes were in front of a newline that precedes
17552 the window start, and the whole current matrix was reused
17553 2 means the changes were after the last position displayed
17554 in the window, and the whole current matrix was reused
17555 3 means portions of the current matrix were reused, while
17556 some of the screen lines were redrawn
17557 -1 if redisplay with same window start is known not to succeed
17558 0 if otherwise unsuccessful
17560 The following steps are performed:
17562 1. Find the last row in the current matrix of W that is not
17563 affected by changes at the start of current_buffer. If no such row
17566 2. Find the first row in W's current matrix that is not affected by
17567 changes at the end of current_buffer. Maybe there is no such row.
17569 3. Display lines beginning with the row + 1 found in step 1 to the
17570 row found in step 2 or, if step 2 didn't find a row, to the end of
17573 4. If cursor is not known to appear on the window, give up.
17575 5. If display stopped at the row found in step 2, scroll the
17576 display and current matrix as needed.
17578 6. Maybe display some lines at the end of W, if we must. This can
17579 happen under various circumstances, like a partially visible line
17580 becoming fully visible, or because newly displayed lines are displayed
17581 in smaller font sizes.
17583 7. Update W's window end information. */
17586 try_window_id (struct window
*w
)
17588 struct frame
*f
= XFRAME (w
->frame
);
17589 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17590 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17591 struct glyph_row
*last_unchanged_at_beg_row
;
17592 struct glyph_row
*first_unchanged_at_end_row
;
17593 struct glyph_row
*row
;
17594 struct glyph_row
*bottom_row
;
17597 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17599 struct text_pos start_pos
;
17601 int first_unchanged_at_end_vpos
= 0;
17602 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17603 struct text_pos start
;
17604 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17607 if (inhibit_try_window_id
)
17611 /* This is handy for debugging. */
17613 #define GIVE_UP(X) \
17615 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17619 #define GIVE_UP(X) return 0
17622 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17624 /* Don't use this for mini-windows because these can show
17625 messages and mini-buffers, and we don't handle that here. */
17626 if (MINI_WINDOW_P (w
))
17629 /* This flag is used to prevent redisplay optimizations. */
17630 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17633 /* This function's optimizations cannot be used if overlays have
17634 changed in the buffer displayed by the window, so give up if they
17636 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17639 /* Verify that narrowing has not changed.
17640 Also verify that we were not told to prevent redisplay optimizations.
17641 It would be nice to further
17642 reduce the number of cases where this prevents try_window_id. */
17643 if (current_buffer
->clip_changed
17644 || current_buffer
->prevent_redisplay_optimizations_p
)
17647 /* Window must either use window-based redisplay or be full width. */
17648 if (!FRAME_WINDOW_P (f
)
17649 && (!FRAME_LINE_INS_DEL_OK (f
)
17650 || !WINDOW_FULL_WIDTH_P (w
)))
17653 /* Give up if point is known NOT to appear in W. */
17654 if (PT
< CHARPOS (start
))
17657 /* Another way to prevent redisplay optimizations. */
17658 if (w
->last_modified
== 0)
17661 /* Verify that window is not hscrolled. */
17662 if (w
->hscroll
!= 0)
17665 /* Verify that display wasn't paused. */
17666 if (!w
->window_end_valid
)
17669 /* Likewise if highlighting trailing whitespace. */
17670 if (!NILP (Vshow_trailing_whitespace
))
17673 /* Can't use this if overlay arrow position and/or string have
17675 if (overlay_arrows_changed_p ())
17678 /* When word-wrap is on, adding a space to the first word of a
17679 wrapped line can change the wrap position, altering the line
17680 above it. It might be worthwhile to handle this more
17681 intelligently, but for now just redisplay from scratch. */
17682 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17685 /* Under bidi reordering, adding or deleting a character in the
17686 beginning of a paragraph, before the first strong directional
17687 character, can change the base direction of the paragraph (unless
17688 the buffer specifies a fixed paragraph direction), which will
17689 require to redisplay the whole paragraph. It might be worthwhile
17690 to find the paragraph limits and widen the range of redisplayed
17691 lines to that, but for now just give up this optimization and
17692 redisplay from scratch. */
17693 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17694 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17697 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17698 only if buffer has really changed. The reason is that the gap is
17699 initially at Z for freshly visited files. The code below would
17700 set end_unchanged to 0 in that case. */
17701 if (MODIFF
> SAVE_MODIFF
17702 /* This seems to happen sometimes after saving a buffer. */
17703 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17705 if (GPT
- BEG
< BEG_UNCHANGED
)
17706 BEG_UNCHANGED
= GPT
- BEG
;
17707 if (Z
- GPT
< END_UNCHANGED
)
17708 END_UNCHANGED
= Z
- GPT
;
17711 /* The position of the first and last character that has been changed. */
17712 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17713 last_changed_charpos
= Z
- END_UNCHANGED
;
17715 /* If window starts after a line end, and the last change is in
17716 front of that newline, then changes don't affect the display.
17717 This case happens with stealth-fontification. Note that although
17718 the display is unchanged, glyph positions in the matrix have to
17719 be adjusted, of course. */
17720 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17721 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17722 && ((last_changed_charpos
< CHARPOS (start
)
17723 && CHARPOS (start
) == BEGV
)
17724 || (last_changed_charpos
< CHARPOS (start
) - 1
17725 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17727 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17728 struct glyph_row
*r0
;
17730 /* Compute how many chars/bytes have been added to or removed
17731 from the buffer. */
17732 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17733 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17734 Z_delta
= Z
- Z_old
;
17735 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17737 /* Give up if PT is not in the window. Note that it already has
17738 been checked at the start of try_window_id that PT is not in
17739 front of the window start. */
17740 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
17743 /* If window start is unchanged, we can reuse the whole matrix
17744 as is, after adjusting glyph positions. No need to compute
17745 the window end again, since its offset from Z hasn't changed. */
17746 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17747 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
17748 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
17749 /* PT must not be in a partially visible line. */
17750 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
17751 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17753 /* Adjust positions in the glyph matrix. */
17754 if (Z_delta
|| Z_delta_bytes
)
17756 struct glyph_row
*r1
17757 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
17758 increment_matrix_positions (w
->current_matrix
,
17759 MATRIX_ROW_VPOS (r0
, current_matrix
),
17760 MATRIX_ROW_VPOS (r1
, current_matrix
),
17761 Z_delta
, Z_delta_bytes
);
17764 /* Set the cursor. */
17765 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17767 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17772 /* Handle the case that changes are all below what is displayed in
17773 the window, and that PT is in the window. This shortcut cannot
17774 be taken if ZV is visible in the window, and text has been added
17775 there that is visible in the window. */
17776 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
17777 /* ZV is not visible in the window, or there are no
17778 changes at ZV, actually. */
17779 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
17780 || first_changed_charpos
== last_changed_charpos
))
17782 struct glyph_row
*r0
;
17784 /* Give up if PT is not in the window. Note that it already has
17785 been checked at the start of try_window_id that PT is not in
17786 front of the window start. */
17787 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
17790 /* If window start is unchanged, we can reuse the whole matrix
17791 as is, without changing glyph positions since no text has
17792 been added/removed in front of the window end. */
17793 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17794 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
17795 /* PT must not be in a partially visible line. */
17796 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
17797 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
17799 /* We have to compute the window end anew since text
17800 could have been added/removed after it. */
17801 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
17802 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
17804 /* Set the cursor. */
17805 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
17807 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
17812 /* Give up if window start is in the changed area.
17814 The condition used to read
17816 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
17818 but why that was tested escapes me at the moment. */
17819 if (CHARPOS (start
) >= first_changed_charpos
17820 && CHARPOS (start
) <= last_changed_charpos
)
17823 /* Check that window start agrees with the start of the first glyph
17824 row in its current matrix. Check this after we know the window
17825 start is not in changed text, otherwise positions would not be
17827 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
17828 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
17831 /* Give up if the window ends in strings. Overlay strings
17832 at the end are difficult to handle, so don't try. */
17833 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
17834 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
17837 /* Compute the position at which we have to start displaying new
17838 lines. Some of the lines at the top of the window might be
17839 reusable because they are not displaying changed text. Find the
17840 last row in W's current matrix not affected by changes at the
17841 start of current_buffer. Value is null if changes start in the
17842 first line of window. */
17843 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
17844 if (last_unchanged_at_beg_row
)
17846 /* Avoid starting to display in the middle of a character, a TAB
17847 for instance. This is easier than to set up the iterator
17848 exactly, and it's not a frequent case, so the additional
17849 effort wouldn't really pay off. */
17850 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
17851 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
17852 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
17853 --last_unchanged_at_beg_row
;
17855 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
17858 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
17860 start_pos
= it
.current
.pos
;
17862 /* Start displaying new lines in the desired matrix at the same
17863 vpos we would use in the current matrix, i.e. below
17864 last_unchanged_at_beg_row. */
17865 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
17867 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
17868 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
17870 eassert (it
.hpos
== 0 && it
.current_x
== 0);
17874 /* There are no reusable lines at the start of the window.
17875 Start displaying in the first text line. */
17876 start_display (&it
, w
, start
);
17877 it
.vpos
= it
.first_vpos
;
17878 start_pos
= it
.current
.pos
;
17881 /* Find the first row that is not affected by changes at the end of
17882 the buffer. Value will be null if there is no unchanged row, in
17883 which case we must redisplay to the end of the window. delta
17884 will be set to the value by which buffer positions beginning with
17885 first_unchanged_at_end_row have to be adjusted due to text
17887 first_unchanged_at_end_row
17888 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
17889 IF_DEBUG (debug_delta
= delta
);
17890 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
17892 /* Set stop_pos to the buffer position up to which we will have to
17893 display new lines. If first_unchanged_at_end_row != NULL, this
17894 is the buffer position of the start of the line displayed in that
17895 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
17896 that we don't stop at a buffer position. */
17898 if (first_unchanged_at_end_row
)
17900 eassert (last_unchanged_at_beg_row
== NULL
17901 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
17903 /* If this is a continuation line, move forward to the next one
17904 that isn't. Changes in lines above affect this line.
17905 Caution: this may move first_unchanged_at_end_row to a row
17906 not displaying text. */
17907 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
17908 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17909 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17910 < it
.last_visible_y
))
17911 ++first_unchanged_at_end_row
;
17913 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
17914 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
17915 >= it
.last_visible_y
))
17916 first_unchanged_at_end_row
= NULL
;
17919 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
17921 first_unchanged_at_end_vpos
17922 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
17923 eassert (stop_pos
>= Z
- END_UNCHANGED
);
17926 else if (last_unchanged_at_beg_row
== NULL
)
17932 /* Either there is no unchanged row at the end, or the one we have
17933 now displays text. This is a necessary condition for the window
17934 end pos calculation at the end of this function. */
17935 eassert (first_unchanged_at_end_row
== NULL
17936 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
17938 debug_last_unchanged_at_beg_vpos
17939 = (last_unchanged_at_beg_row
17940 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
17942 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
17944 #endif /* GLYPH_DEBUG */
17947 /* Display new lines. Set last_text_row to the last new line
17948 displayed which has text on it, i.e. might end up as being the
17949 line where the window_end_vpos is. */
17950 w
->cursor
.vpos
= -1;
17951 last_text_row
= NULL
;
17952 overlay_arrow_seen
= 0;
17953 while (it
.current_y
< it
.last_visible_y
17954 && !f
->fonts_changed
17955 && (first_unchanged_at_end_row
== NULL
17956 || IT_CHARPOS (it
) < stop_pos
))
17958 if (display_line (&it
))
17959 last_text_row
= it
.glyph_row
- 1;
17962 if (f
->fonts_changed
)
17966 /* Compute differences in buffer positions, y-positions etc. for
17967 lines reused at the bottom of the window. Compute what we can
17969 if (first_unchanged_at_end_row
17970 /* No lines reused because we displayed everything up to the
17971 bottom of the window. */
17972 && it
.current_y
< it
.last_visible_y
)
17975 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
17977 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
17978 run
.current_y
= first_unchanged_at_end_row
->y
;
17979 run
.desired_y
= run
.current_y
+ dy
;
17980 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
17984 delta
= delta_bytes
= dvpos
= dy
17985 = run
.current_y
= run
.desired_y
= run
.height
= 0;
17986 first_unchanged_at_end_row
= NULL
;
17988 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
17991 /* Find the cursor if not already found. We have to decide whether
17992 PT will appear on this window (it sometimes doesn't, but this is
17993 not a very frequent case.) This decision has to be made before
17994 the current matrix is altered. A value of cursor.vpos < 0 means
17995 that PT is either in one of the lines beginning at
17996 first_unchanged_at_end_row or below the window. Don't care for
17997 lines that might be displayed later at the window end; as
17998 mentioned, this is not a frequent case. */
17999 if (w
->cursor
.vpos
< 0)
18001 /* Cursor in unchanged rows at the top? */
18002 if (PT
< CHARPOS (start_pos
)
18003 && last_unchanged_at_beg_row
)
18005 row
= row_containing_pos (w
, PT
,
18006 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18007 last_unchanged_at_beg_row
+ 1, 0);
18009 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18012 /* Start from first_unchanged_at_end_row looking for PT. */
18013 else if (first_unchanged_at_end_row
)
18015 row
= row_containing_pos (w
, PT
- delta
,
18016 first_unchanged_at_end_row
, NULL
, 0);
18018 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18019 delta_bytes
, dy
, dvpos
);
18022 /* Give up if cursor was not found. */
18023 if (w
->cursor
.vpos
< 0)
18025 clear_glyph_matrix (w
->desired_matrix
);
18030 /* Don't let the cursor end in the scroll margins. */
18032 int this_scroll_margin
, cursor_height
;
18033 int frame_line_height
= default_line_pixel_height (w
);
18034 int window_total_lines
18035 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18037 this_scroll_margin
=
18038 max (0, min (scroll_margin
, window_total_lines
/ 4));
18039 this_scroll_margin
*= frame_line_height
;
18040 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18042 if ((w
->cursor
.y
< this_scroll_margin
18043 && CHARPOS (start
) > BEGV
)
18044 /* Old redisplay didn't take scroll margin into account at the bottom,
18045 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18046 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18047 ? cursor_height
+ this_scroll_margin
18048 : 1)) > it
.last_visible_y
)
18050 w
->cursor
.vpos
= -1;
18051 clear_glyph_matrix (w
->desired_matrix
);
18056 /* Scroll the display. Do it before changing the current matrix so
18057 that xterm.c doesn't get confused about where the cursor glyph is
18059 if (dy
&& run
.height
)
18063 if (FRAME_WINDOW_P (f
))
18065 FRAME_RIF (f
)->update_window_begin_hook (w
);
18066 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18067 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18068 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18072 /* Terminal frame. In this case, dvpos gives the number of
18073 lines to scroll by; dvpos < 0 means scroll up. */
18075 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18076 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18077 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18078 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18079 + window_internal_height (w
));
18081 #if defined (HAVE_GPM) || defined (MSDOS)
18082 x_clear_window_mouse_face (w
);
18084 /* Perform the operation on the screen. */
18087 /* Scroll last_unchanged_at_beg_row to the end of the
18088 window down dvpos lines. */
18089 set_terminal_window (f
, end
);
18091 /* On dumb terminals delete dvpos lines at the end
18092 before inserting dvpos empty lines. */
18093 if (!FRAME_SCROLL_REGION_OK (f
))
18094 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18096 /* Insert dvpos empty lines in front of
18097 last_unchanged_at_beg_row. */
18098 ins_del_lines (f
, from
, dvpos
);
18100 else if (dvpos
< 0)
18102 /* Scroll up last_unchanged_at_beg_vpos to the end of
18103 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18104 set_terminal_window (f
, end
);
18106 /* Delete dvpos lines in front of
18107 last_unchanged_at_beg_vpos. ins_del_lines will set
18108 the cursor to the given vpos and emit |dvpos| delete
18110 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18112 /* On a dumb terminal insert dvpos empty lines at the
18114 if (!FRAME_SCROLL_REGION_OK (f
))
18115 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18118 set_terminal_window (f
, 0);
18124 /* Shift reused rows of the current matrix to the right position.
18125 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18127 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18128 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18131 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18132 bottom_vpos
, dvpos
);
18133 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18136 else if (dvpos
> 0)
18138 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18139 bottom_vpos
, dvpos
);
18140 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18141 first_unchanged_at_end_vpos
+ dvpos
);
18144 /* For frame-based redisplay, make sure that current frame and window
18145 matrix are in sync with respect to glyph memory. */
18146 if (!FRAME_WINDOW_P (f
))
18147 sync_frame_with_window_matrix_rows (w
);
18149 /* Adjust buffer positions in reused rows. */
18150 if (delta
|| delta_bytes
)
18151 increment_matrix_positions (current_matrix
,
18152 first_unchanged_at_end_vpos
+ dvpos
,
18153 bottom_vpos
, delta
, delta_bytes
);
18155 /* Adjust Y positions. */
18157 shift_glyph_matrix (w
, current_matrix
,
18158 first_unchanged_at_end_vpos
+ dvpos
,
18161 if (first_unchanged_at_end_row
)
18163 first_unchanged_at_end_row
+= dvpos
;
18164 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18165 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18166 first_unchanged_at_end_row
= NULL
;
18169 /* If scrolling up, there may be some lines to display at the end of
18171 last_text_row_at_end
= NULL
;
18174 /* Scrolling up can leave for example a partially visible line
18175 at the end of the window to be redisplayed. */
18176 /* Set last_row to the glyph row in the current matrix where the
18177 window end line is found. It has been moved up or down in
18178 the matrix by dvpos. */
18179 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18180 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18182 /* If last_row is the window end line, it should display text. */
18183 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18185 /* If window end line was partially visible before, begin
18186 displaying at that line. Otherwise begin displaying with the
18187 line following it. */
18188 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18190 init_to_row_start (&it
, w
, last_row
);
18191 it
.vpos
= last_vpos
;
18192 it
.current_y
= last_row
->y
;
18196 init_to_row_end (&it
, w
, last_row
);
18197 it
.vpos
= 1 + last_vpos
;
18198 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18202 /* We may start in a continuation line. If so, we have to
18203 get the right continuation_lines_width and current_x. */
18204 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18205 it
.hpos
= it
.current_x
= 0;
18207 /* Display the rest of the lines at the window end. */
18208 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18209 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18211 /* Is it always sure that the display agrees with lines in
18212 the current matrix? I don't think so, so we mark rows
18213 displayed invalid in the current matrix by setting their
18214 enabled_p flag to zero. */
18215 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18216 if (display_line (&it
))
18217 last_text_row_at_end
= it
.glyph_row
- 1;
18221 /* Update window_end_pos and window_end_vpos. */
18222 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18224 /* Window end line if one of the preserved rows from the current
18225 matrix. Set row to the last row displaying text in current
18226 matrix starting at first_unchanged_at_end_row, after
18228 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18229 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18230 first_unchanged_at_end_row
);
18231 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18232 adjust_window_ends (w
, row
, 1);
18233 eassert (w
->window_end_bytepos
>= 0);
18234 IF_DEBUG (debug_method_add (w
, "A"));
18236 else if (last_text_row_at_end
)
18238 adjust_window_ends (w
, last_text_row_at_end
, 0);
18239 eassert (w
->window_end_bytepos
>= 0);
18240 IF_DEBUG (debug_method_add (w
, "B"));
18242 else if (last_text_row
)
18244 /* We have displayed either to the end of the window or at the
18245 end of the window, i.e. the last row with text is to be found
18246 in the desired matrix. */
18247 adjust_window_ends (w
, last_text_row
, 0);
18248 eassert (w
->window_end_bytepos
>= 0);
18250 else if (first_unchanged_at_end_row
== NULL
18251 && last_text_row
== NULL
18252 && last_text_row_at_end
== NULL
)
18254 /* Displayed to end of window, but no line containing text was
18255 displayed. Lines were deleted at the end of the window. */
18256 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18257 int vpos
= w
->window_end_vpos
;
18258 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18259 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18262 row
== NULL
&& vpos
>= first_vpos
;
18263 --vpos
, --current_row
, --desired_row
)
18265 if (desired_row
->enabled_p
)
18267 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18270 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18274 eassert (row
!= NULL
);
18275 w
->window_end_vpos
= vpos
+ 1;
18276 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18277 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18278 eassert (w
->window_end_bytepos
>= 0);
18279 IF_DEBUG (debug_method_add (w
, "C"));
18284 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18285 debug_end_vpos
= w
->window_end_vpos
));
18287 /* Record that display has not been completed. */
18288 w
->window_end_valid
= 0;
18289 w
->desired_matrix
->no_scrolling_p
= 1;
18297 /***********************************************************************
18298 More debugging support
18299 ***********************************************************************/
18303 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18304 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18305 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18308 /* Dump the contents of glyph matrix MATRIX on stderr.
18310 GLYPHS 0 means don't show glyph contents.
18311 GLYPHS 1 means show glyphs in short form
18312 GLYPHS > 1 means show glyphs in long form. */
18315 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18318 for (i
= 0; i
< matrix
->nrows
; ++i
)
18319 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18323 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18324 the glyph row and area where the glyph comes from. */
18327 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18329 if (glyph
->type
== CHAR_GLYPH
18330 || glyph
->type
== GLYPHLESS_GLYPH
)
18333 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18334 glyph
- row
->glyphs
[TEXT_AREA
],
18335 (glyph
->type
== CHAR_GLYPH
18339 (BUFFERP (glyph
->object
)
18341 : (STRINGP (glyph
->object
)
18343 : (INTEGERP (glyph
->object
)
18346 glyph
->pixel_width
,
18348 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18352 glyph
->left_box_line_p
,
18353 glyph
->right_box_line_p
);
18355 else if (glyph
->type
== STRETCH_GLYPH
)
18358 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18359 glyph
- row
->glyphs
[TEXT_AREA
],
18362 (BUFFERP (glyph
->object
)
18364 : (STRINGP (glyph
->object
)
18366 : (INTEGERP (glyph
->object
)
18369 glyph
->pixel_width
,
18373 glyph
->left_box_line_p
,
18374 glyph
->right_box_line_p
);
18376 else if (glyph
->type
== IMAGE_GLYPH
)
18379 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18380 glyph
- row
->glyphs
[TEXT_AREA
],
18383 (BUFFERP (glyph
->object
)
18385 : (STRINGP (glyph
->object
)
18387 : (INTEGERP (glyph
->object
)
18390 glyph
->pixel_width
,
18394 glyph
->left_box_line_p
,
18395 glyph
->right_box_line_p
);
18397 else if (glyph
->type
== COMPOSITE_GLYPH
)
18400 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18401 glyph
- row
->glyphs
[TEXT_AREA
],
18404 (BUFFERP (glyph
->object
)
18406 : (STRINGP (glyph
->object
)
18408 : (INTEGERP (glyph
->object
)
18411 glyph
->pixel_width
,
18413 if (glyph
->u
.cmp
.automatic
)
18416 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18417 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18419 glyph
->left_box_line_p
,
18420 glyph
->right_box_line_p
);
18425 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18426 GLYPHS 0 means don't show glyph contents.
18427 GLYPHS 1 means show glyphs in short form
18428 GLYPHS > 1 means show glyphs in long form. */
18431 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18435 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18436 fprintf (stderr
, "==============================================================================\n");
18438 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18439 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18441 MATRIX_ROW_START_CHARPOS (row
),
18442 MATRIX_ROW_END_CHARPOS (row
),
18443 row
->used
[TEXT_AREA
],
18444 row
->contains_overlapping_glyphs_p
,
18446 row
->truncated_on_left_p
,
18447 row
->truncated_on_right_p
,
18449 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18450 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18453 row
->ends_in_middle_of_char_p
,
18454 row
->starts_in_middle_of_char_p
,
18460 row
->visible_height
,
18463 /* The next 3 lines should align to "Start" in the header. */
18464 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18465 row
->end
.overlay_string_index
,
18466 row
->continuation_lines_width
);
18467 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18468 CHARPOS (row
->start
.string_pos
),
18469 CHARPOS (row
->end
.string_pos
));
18470 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18471 row
->end
.dpvec_index
);
18478 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18480 struct glyph
*glyph
= row
->glyphs
[area
];
18481 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18483 /* Glyph for a line end in text. */
18484 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18487 if (glyph
< glyph_end
)
18488 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18490 for (; glyph
< glyph_end
; ++glyph
)
18491 dump_glyph (row
, glyph
, area
);
18494 else if (glyphs
== 1)
18498 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18500 char *s
= alloca (row
->used
[area
] + 4);
18503 for (i
= 0; i
< row
->used
[area
]; ++i
)
18505 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18506 if (i
== row
->used
[area
] - 1
18507 && area
== TEXT_AREA
18508 && INTEGERP (glyph
->object
)
18509 && glyph
->type
== CHAR_GLYPH
18510 && glyph
->u
.ch
== ' ')
18512 strcpy (&s
[i
], "[\\n]");
18515 else if (glyph
->type
== CHAR_GLYPH
18516 && glyph
->u
.ch
< 0x80
18517 && glyph
->u
.ch
>= ' ')
18518 s
[i
] = glyph
->u
.ch
;
18524 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18530 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18531 Sdump_glyph_matrix
, 0, 1, "p",
18532 doc
: /* Dump the current matrix of the selected window to stderr.
18533 Shows contents of glyph row structures. With non-nil
18534 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18535 glyphs in short form, otherwise show glyphs in long form. */)
18536 (Lisp_Object glyphs
)
18538 struct window
*w
= XWINDOW (selected_window
);
18539 struct buffer
*buffer
= XBUFFER (w
->contents
);
18541 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18542 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18543 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18544 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18545 fprintf (stderr
, "=============================================\n");
18546 dump_glyph_matrix (w
->current_matrix
,
18547 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18552 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18553 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18556 struct frame
*f
= XFRAME (selected_frame
);
18557 dump_glyph_matrix (f
->current_matrix
, 1);
18562 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18563 doc
: /* Dump glyph row ROW to stderr.
18564 GLYPH 0 means don't dump glyphs.
18565 GLYPH 1 means dump glyphs in short form.
18566 GLYPH > 1 or omitted means dump glyphs in long form. */)
18567 (Lisp_Object row
, Lisp_Object glyphs
)
18569 struct glyph_matrix
*matrix
;
18572 CHECK_NUMBER (row
);
18573 matrix
= XWINDOW (selected_window
)->current_matrix
;
18575 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18576 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18578 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18583 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18584 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18585 GLYPH 0 means don't dump glyphs.
18586 GLYPH 1 means dump glyphs in short form.
18587 GLYPH > 1 or omitted means dump glyphs in long form.
18589 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18591 (Lisp_Object row
, Lisp_Object glyphs
)
18593 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18594 struct frame
*sf
= SELECTED_FRAME ();
18595 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18598 CHECK_NUMBER (row
);
18600 if (vpos
>= 0 && vpos
< m
->nrows
)
18601 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18602 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18608 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18609 doc
: /* Toggle tracing of redisplay.
18610 With ARG, turn tracing on if and only if ARG is positive. */)
18614 trace_redisplay_p
= !trace_redisplay_p
;
18617 arg
= Fprefix_numeric_value (arg
);
18618 trace_redisplay_p
= XINT (arg
) > 0;
18625 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18626 doc
: /* Like `format', but print result to stderr.
18627 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18628 (ptrdiff_t nargs
, Lisp_Object
*args
)
18630 Lisp_Object s
= Fformat (nargs
, args
);
18631 fprintf (stderr
, "%s", SDATA (s
));
18635 #endif /* GLYPH_DEBUG */
18639 /***********************************************************************
18640 Building Desired Matrix Rows
18641 ***********************************************************************/
18643 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18644 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18646 static struct glyph_row
*
18647 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18649 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18650 struct buffer
*buffer
= XBUFFER (w
->contents
);
18651 struct buffer
*old
= current_buffer
;
18652 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18653 int arrow_len
= SCHARS (overlay_arrow_string
);
18654 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18655 const unsigned char *p
;
18658 int n_glyphs_before
;
18660 set_buffer_temp (buffer
);
18661 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18662 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18663 SET_TEXT_POS (it
.position
, 0, 0);
18665 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18667 while (p
< arrow_end
)
18669 Lisp_Object face
, ilisp
;
18671 /* Get the next character. */
18673 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18676 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18677 if (! ASCII_CHAR_P (it
.c
))
18678 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18682 /* Get its face. */
18683 ilisp
= make_number (p
- arrow_string
);
18684 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18685 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18687 /* Compute its width, get its glyphs. */
18688 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18689 SET_TEXT_POS (it
.position
, -1, -1);
18690 PRODUCE_GLYPHS (&it
);
18692 /* If this character doesn't fit any more in the line, we have
18693 to remove some glyphs. */
18694 if (it
.current_x
> it
.last_visible_x
)
18696 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18701 set_buffer_temp (old
);
18702 return it
.glyph_row
;
18706 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18707 glyphs to insert is determined by produce_special_glyphs. */
18710 insert_left_trunc_glyphs (struct it
*it
)
18712 struct it truncate_it
;
18713 struct glyph
*from
, *end
, *to
, *toend
;
18715 eassert (!FRAME_WINDOW_P (it
->f
)
18716 || (!it
->glyph_row
->reversed_p
18717 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18718 || (it
->glyph_row
->reversed_p
18719 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18721 /* Get the truncation glyphs. */
18723 truncate_it
.current_x
= 0;
18724 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18725 truncate_it
.glyph_row
= &scratch_glyph_row
;
18726 truncate_it
.area
= TEXT_AREA
;
18727 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18728 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18729 truncate_it
.object
= make_number (0);
18730 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18732 /* Overwrite glyphs from IT with truncation glyphs. */
18733 if (!it
->glyph_row
->reversed_p
)
18735 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18737 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18738 end
= from
+ tused
;
18739 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18740 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
18741 if (FRAME_WINDOW_P (it
->f
))
18743 /* On GUI frames, when variable-size fonts are displayed,
18744 the truncation glyphs may need more pixels than the row's
18745 glyphs they overwrite. We overwrite more glyphs to free
18746 enough screen real estate, and enlarge the stretch glyph
18747 on the right (see display_line), if there is one, to
18748 preserve the screen position of the truncation glyphs on
18751 struct glyph
*g
= to
;
18754 /* The first glyph could be partially visible, in which case
18755 it->glyph_row->x will be negative. But we want the left
18756 truncation glyphs to be aligned at the left margin of the
18757 window, so we override the x coordinate at which the row
18759 it
->glyph_row
->x
= 0;
18760 while (g
< toend
&& w
< it
->truncation_pixel_width
)
18762 w
+= g
->pixel_width
;
18765 if (g
- to
- tused
> 0)
18767 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
18768 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
18770 used
= it
->glyph_row
->used
[TEXT_AREA
];
18771 if (it
->glyph_row
->truncated_on_right_p
18772 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
18773 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
18776 int extra
= w
- it
->truncation_pixel_width
;
18778 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
18785 /* There may be padding glyphs left over. Overwrite them too. */
18786 if (!FRAME_WINDOW_P (it
->f
))
18788 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
18790 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18797 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
18801 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
18803 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
18804 that back to front. */
18805 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
18806 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18807 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18808 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18809 if (FRAME_WINDOW_P (it
->f
))
18812 struct glyph
*g
= to
;
18814 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
18816 w
+= g
->pixel_width
;
18819 if (to
- g
- tused
> 0)
18821 if (it
->glyph_row
->truncated_on_right_p
18822 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
18823 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
18825 int extra
= w
- it
->truncation_pixel_width
;
18827 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
18831 while (from
>= end
&& to
>= toend
)
18833 if (!FRAME_WINDOW_P (it
->f
))
18835 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
18838 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
18839 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
18840 while (from
>= end
&& to
>= toend
)
18846 /* Need to free some room before prepending additional
18848 int move_by
= from
- end
+ 1;
18849 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
18850 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
18852 for ( ; g
>= g0
; g
--)
18854 while (from
>= end
)
18856 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
18861 /* Compute the hash code for ROW. */
18863 row_hash (struct glyph_row
*row
)
18866 unsigned hashval
= 0;
18868 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18869 for (k
= 0; k
< row
->used
[area
]; ++k
)
18870 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
18871 + row
->glyphs
[area
][k
].u
.val
18872 + row
->glyphs
[area
][k
].face_id
18873 + row
->glyphs
[area
][k
].padding_p
18874 + (row
->glyphs
[area
][k
].type
<< 2));
18879 /* Compute the pixel height and width of IT->glyph_row.
18881 Most of the time, ascent and height of a display line will be equal
18882 to the max_ascent and max_height values of the display iterator
18883 structure. This is not the case if
18885 1. We hit ZV without displaying anything. In this case, max_ascent
18886 and max_height will be zero.
18888 2. We have some glyphs that don't contribute to the line height.
18889 (The glyph row flag contributes_to_line_height_p is for future
18890 pixmap extensions).
18892 The first case is easily covered by using default values because in
18893 these cases, the line height does not really matter, except that it
18894 must not be zero. */
18897 compute_line_metrics (struct it
*it
)
18899 struct glyph_row
*row
= it
->glyph_row
;
18901 if (FRAME_WINDOW_P (it
->f
))
18903 int i
, min_y
, max_y
;
18905 /* The line may consist of one space only, that was added to
18906 place the cursor on it. If so, the row's height hasn't been
18908 if (row
->height
== 0)
18910 if (it
->max_ascent
+ it
->max_descent
== 0)
18911 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
18912 row
->ascent
= it
->max_ascent
;
18913 row
->height
= it
->max_ascent
+ it
->max_descent
;
18914 row
->phys_ascent
= it
->max_phys_ascent
;
18915 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
18916 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
18919 /* Compute the width of this line. */
18920 row
->pixel_width
= row
->x
;
18921 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
18922 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
18924 eassert (row
->pixel_width
>= 0);
18925 eassert (row
->ascent
>= 0 && row
->height
> 0);
18927 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
18928 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
18930 /* If first line's physical ascent is larger than its logical
18931 ascent, use the physical ascent, and make the row taller.
18932 This makes accented characters fully visible. */
18933 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
18934 && row
->phys_ascent
> row
->ascent
)
18936 row
->height
+= row
->phys_ascent
- row
->ascent
;
18937 row
->ascent
= row
->phys_ascent
;
18940 /* Compute how much of the line is visible. */
18941 row
->visible_height
= row
->height
;
18943 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
18944 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
18946 if (row
->y
< min_y
)
18947 row
->visible_height
-= min_y
- row
->y
;
18948 if (row
->y
+ row
->height
> max_y
)
18949 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
18953 row
->pixel_width
= row
->used
[TEXT_AREA
];
18954 if (row
->continued_p
)
18955 row
->pixel_width
-= it
->continuation_pixel_width
;
18956 else if (row
->truncated_on_right_p
)
18957 row
->pixel_width
-= it
->truncation_pixel_width
;
18958 row
->ascent
= row
->phys_ascent
= 0;
18959 row
->height
= row
->phys_height
= row
->visible_height
= 1;
18960 row
->extra_line_spacing
= 0;
18963 /* Compute a hash code for this row. */
18964 row
->hash
= row_hash (row
);
18966 it
->max_ascent
= it
->max_descent
= 0;
18967 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
18971 /* Append one space to the glyph row of iterator IT if doing a
18972 window-based redisplay. The space has the same face as
18973 IT->face_id. Value is non-zero if a space was added.
18975 This function is called to make sure that there is always one glyph
18976 at the end of a glyph row that the cursor can be set on under
18977 window-systems. (If there weren't such a glyph we would not know
18978 how wide and tall a box cursor should be displayed).
18980 At the same time this space let's a nicely handle clearing to the
18981 end of the line if the row ends in italic text. */
18984 append_space_for_newline (struct it
*it
, int default_face_p
)
18986 if (FRAME_WINDOW_P (it
->f
))
18988 int n
= it
->glyph_row
->used
[TEXT_AREA
];
18990 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
18991 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
18993 /* Save some values that must not be changed.
18994 Must save IT->c and IT->len because otherwise
18995 ITERATOR_AT_END_P wouldn't work anymore after
18996 append_space_for_newline has been called. */
18997 enum display_element_type saved_what
= it
->what
;
18998 int saved_c
= it
->c
, saved_len
= it
->len
;
18999 int saved_char_to_display
= it
->char_to_display
;
19000 int saved_x
= it
->current_x
;
19001 int saved_face_id
= it
->face_id
;
19002 int saved_box_end
= it
->end_of_box_run_p
;
19003 struct text_pos saved_pos
;
19004 Lisp_Object saved_object
;
19007 saved_object
= it
->object
;
19008 saved_pos
= it
->position
;
19010 it
->what
= IT_CHARACTER
;
19011 memset (&it
->position
, 0, sizeof it
->position
);
19012 it
->object
= make_number (0);
19013 it
->c
= it
->char_to_display
= ' ';
19016 /* If the default face was remapped, be sure to use the
19017 remapped face for the appended newline. */
19018 if (default_face_p
)
19019 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19020 else if (it
->face_before_selective_p
)
19021 it
->face_id
= it
->saved_face_id
;
19022 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19023 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19024 /* In R2L rows, we will prepend a stretch glyph that will
19025 have the end_of_box_run_p flag set for it, so there's no
19026 need for the appended newline glyph to have that flag
19028 if (it
->glyph_row
->reversed_p
19029 /* But if the appended newline glyph goes all the way to
19030 the end of the row, there will be no stretch glyph,
19031 so leave the box flag set. */
19032 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19033 it
->end_of_box_run_p
= 0;
19035 PRODUCE_GLYPHS (it
);
19037 it
->override_ascent
= -1;
19038 it
->constrain_row_ascent_descent_p
= 0;
19039 it
->current_x
= saved_x
;
19040 it
->object
= saved_object
;
19041 it
->position
= saved_pos
;
19042 it
->what
= saved_what
;
19043 it
->face_id
= saved_face_id
;
19044 it
->len
= saved_len
;
19046 it
->char_to_display
= saved_char_to_display
;
19047 it
->end_of_box_run_p
= saved_box_end
;
19056 /* Extend the face of the last glyph in the text area of IT->glyph_row
19057 to the end of the display line. Called from display_line. If the
19058 glyph row is empty, add a space glyph to it so that we know the
19059 face to draw. Set the glyph row flag fill_line_p. If the glyph
19060 row is R2L, prepend a stretch glyph to cover the empty space to the
19061 left of the leftmost glyph. */
19064 extend_face_to_end_of_line (struct it
*it
)
19066 struct face
*face
, *default_face
;
19067 struct frame
*f
= it
->f
;
19069 /* If line is already filled, do nothing. Non window-system frames
19070 get a grace of one more ``pixel'' because their characters are
19071 1-``pixel'' wide, so they hit the equality too early. This grace
19072 is needed only for R2L rows that are not continued, to produce
19073 one extra blank where we could display the cursor. */
19074 if ((it
->current_x
>= it
->last_visible_x
19075 + (!FRAME_WINDOW_P (f
)
19076 && it
->glyph_row
->reversed_p
19077 && !it
->glyph_row
->continued_p
))
19078 /* If the window has display margins, we will need to extend
19079 their face even if the text area is filled. */
19080 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19081 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19084 /* The default face, possibly remapped. */
19085 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19087 /* Face extension extends the background and box of IT->face_id
19088 to the end of the line. If the background equals the background
19089 of the frame, we don't have to do anything. */
19090 if (it
->face_before_selective_p
)
19091 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19093 face
= FACE_FROM_ID (f
, it
->face_id
);
19095 if (FRAME_WINDOW_P (f
)
19096 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19097 && face
->box
== FACE_NO_BOX
19098 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19099 #ifdef HAVE_WINDOW_SYSTEM
19102 && !it
->glyph_row
->reversed_p
)
19105 /* Set the glyph row flag indicating that the face of the last glyph
19106 in the text area has to be drawn to the end of the text area. */
19107 it
->glyph_row
->fill_line_p
= 1;
19109 /* If current character of IT is not ASCII, make sure we have the
19110 ASCII face. This will be automatically undone the next time
19111 get_next_display_element returns a multibyte character. Note
19112 that the character will always be single byte in unibyte
19114 if (!ASCII_CHAR_P (it
->c
))
19116 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19119 if (FRAME_WINDOW_P (f
))
19121 /* If the row is empty, add a space with the current face of IT,
19122 so that we know which face to draw. */
19123 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19125 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19126 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19127 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19129 /* Mode line and the header line don't have margins, and
19130 likewise the frame's tool-bar window, if there is any. */
19131 if (!(it
->glyph_row
->mode_line_p
19132 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19133 || (WINDOWP (f
->tool_bar_window
)
19134 && it
->w
== XWINDOW (f
->tool_bar_window
))
19138 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19139 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19141 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19142 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19144 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19146 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19147 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19149 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19150 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19152 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19155 #ifdef HAVE_WINDOW_SYSTEM
19156 if (it
->glyph_row
->reversed_p
)
19158 /* Prepend a stretch glyph to the row, such that the
19159 rightmost glyph will be drawn flushed all the way to the
19160 right margin of the window. The stretch glyph that will
19161 occupy the empty space, if any, to the left of the
19163 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19164 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19165 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19167 int row_width
, stretch_ascent
, stretch_width
;
19168 struct text_pos saved_pos
;
19169 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19171 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19172 row_width
+= g
->pixel_width
;
19173 stretch_width
= window_box_width (it
->w
, TEXT_AREA
) - row_width
;
19174 if (stretch_width
> 0)
19177 (((it
->ascent
+ it
->descent
)
19178 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19179 saved_pos
= it
->position
;
19180 memset (&it
->position
, 0, sizeof it
->position
);
19181 saved_avoid_cursor
= it
->avoid_cursor_p
;
19182 it
->avoid_cursor_p
= 1;
19183 saved_face_id
= it
->face_id
;
19184 saved_box_start
= it
->start_of_box_run_p
;
19185 /* The last row's stretch glyph should get the default
19186 face, to avoid painting the rest of the window with
19187 the region face, if the region ends at ZV. */
19188 if (it
->glyph_row
->ends_at_zv_p
)
19189 it
->face_id
= default_face
->id
;
19191 it
->face_id
= face
->id
;
19192 it
->start_of_box_run_p
= 0;
19193 append_stretch_glyph (it
, make_number (0), stretch_width
,
19194 it
->ascent
+ it
->descent
, stretch_ascent
);
19195 it
->position
= saved_pos
;
19196 it
->avoid_cursor_p
= saved_avoid_cursor
;
19197 it
->face_id
= saved_face_id
;
19198 it
->start_of_box_run_p
= saved_box_start
;
19201 #endif /* HAVE_WINDOW_SYSTEM */
19205 /* Save some values that must not be changed. */
19206 int saved_x
= it
->current_x
;
19207 struct text_pos saved_pos
;
19208 Lisp_Object saved_object
;
19209 enum display_element_type saved_what
= it
->what
;
19210 int saved_face_id
= it
->face_id
;
19212 saved_object
= it
->object
;
19213 saved_pos
= it
->position
;
19215 it
->what
= IT_CHARACTER
;
19216 memset (&it
->position
, 0, sizeof it
->position
);
19217 it
->object
= make_number (0);
19218 it
->c
= it
->char_to_display
= ' ';
19221 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19222 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19223 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19224 && !it
->glyph_row
->mode_line_p
19225 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19227 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19228 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19230 for (it
->current_x
= 0; g
< e
; g
++)
19231 it
->current_x
+= g
->pixel_width
;
19233 it
->area
= LEFT_MARGIN_AREA
;
19234 it
->face_id
= default_face
->id
;
19235 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19236 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19238 PRODUCE_GLYPHS (it
);
19239 /* term.c:produce_glyphs advances it->current_x only for
19241 it
->current_x
+= it
->pixel_width
;
19244 it
->current_x
= saved_x
;
19245 it
->area
= TEXT_AREA
;
19248 /* The last row's blank glyphs should get the default face, to
19249 avoid painting the rest of the window with the region face,
19250 if the region ends at ZV. */
19251 if (it
->glyph_row
->ends_at_zv_p
)
19252 it
->face_id
= default_face
->id
;
19254 it
->face_id
= face
->id
;
19255 PRODUCE_GLYPHS (it
);
19257 while (it
->current_x
<= it
->last_visible_x
)
19258 PRODUCE_GLYPHS (it
);
19260 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19261 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19262 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19263 && !it
->glyph_row
->mode_line_p
19264 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19266 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19267 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19269 for ( ; g
< e
; g
++)
19270 it
->current_x
+= g
->pixel_width
;
19272 it
->area
= RIGHT_MARGIN_AREA
;
19273 it
->face_id
= default_face
->id
;
19274 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19275 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19277 PRODUCE_GLYPHS (it
);
19278 it
->current_x
+= it
->pixel_width
;
19281 it
->area
= TEXT_AREA
;
19284 /* Don't count these blanks really. It would let us insert a left
19285 truncation glyph below and make us set the cursor on them, maybe. */
19286 it
->current_x
= saved_x
;
19287 it
->object
= saved_object
;
19288 it
->position
= saved_pos
;
19289 it
->what
= saved_what
;
19290 it
->face_id
= saved_face_id
;
19295 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19296 trailing whitespace. */
19299 trailing_whitespace_p (ptrdiff_t charpos
)
19301 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19304 while (bytepos
< ZV_BYTE
19305 && (c
= FETCH_CHAR (bytepos
),
19306 c
== ' ' || c
== '\t'))
19309 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19311 if (bytepos
!= PT_BYTE
)
19318 /* Highlight trailing whitespace, if any, in ROW. */
19321 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19323 int used
= row
->used
[TEXT_AREA
];
19327 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19328 struct glyph
*glyph
= start
+ used
- 1;
19330 if (row
->reversed_p
)
19332 /* Right-to-left rows need to be processed in the opposite
19333 direction, so swap the edge pointers. */
19335 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19338 /* Skip over glyphs inserted to display the cursor at the
19339 end of a line, for extending the face of the last glyph
19340 to the end of the line on terminals, and for truncation
19341 and continuation glyphs. */
19342 if (!row
->reversed_p
)
19344 while (glyph
>= start
19345 && glyph
->type
== CHAR_GLYPH
19346 && INTEGERP (glyph
->object
))
19351 while (glyph
<= start
19352 && glyph
->type
== CHAR_GLYPH
19353 && INTEGERP (glyph
->object
))
19357 /* If last glyph is a space or stretch, and it's trailing
19358 whitespace, set the face of all trailing whitespace glyphs in
19359 IT->glyph_row to `trailing-whitespace'. */
19360 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19361 && BUFFERP (glyph
->object
)
19362 && (glyph
->type
== STRETCH_GLYPH
19363 || (glyph
->type
== CHAR_GLYPH
19364 && glyph
->u
.ch
== ' '))
19365 && trailing_whitespace_p (glyph
->charpos
))
19367 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19371 if (!row
->reversed_p
)
19373 while (glyph
>= start
19374 && BUFFERP (glyph
->object
)
19375 && (glyph
->type
== STRETCH_GLYPH
19376 || (glyph
->type
== CHAR_GLYPH
19377 && glyph
->u
.ch
== ' ')))
19378 (glyph
--)->face_id
= face_id
;
19382 while (glyph
<= start
19383 && BUFFERP (glyph
->object
)
19384 && (glyph
->type
== STRETCH_GLYPH
19385 || (glyph
->type
== CHAR_GLYPH
19386 && glyph
->u
.ch
== ' ')))
19387 (glyph
++)->face_id
= face_id
;
19394 /* Value is non-zero if glyph row ROW should be
19395 considered to hold the buffer position CHARPOS. */
19398 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19402 if (charpos
== CHARPOS (row
->end
.pos
)
19403 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19405 /* Suppose the row ends on a string.
19406 Unless the row is continued, that means it ends on a newline
19407 in the string. If it's anything other than a display string
19408 (e.g., a before-string from an overlay), we don't want the
19409 cursor there. (This heuristic seems to give the optimal
19410 behavior for the various types of multi-line strings.)
19411 One exception: if the string has `cursor' property on one of
19412 its characters, we _do_ want the cursor there. */
19413 if (CHARPOS (row
->end
.string_pos
) >= 0)
19415 if (row
->continued_p
)
19419 /* Check for `display' property. */
19420 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19421 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19422 struct glyph
*glyph
;
19425 for (glyph
= end
; glyph
>= beg
; --glyph
)
19426 if (STRINGP (glyph
->object
))
19429 = Fget_char_property (make_number (charpos
),
19433 && display_prop_string_p (prop
, glyph
->object
));
19434 /* If there's a `cursor' property on one of the
19435 string's characters, this row is a cursor row,
19436 even though this is not a display string. */
19439 Lisp_Object s
= glyph
->object
;
19441 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19443 ptrdiff_t gpos
= glyph
->charpos
;
19445 if (!NILP (Fget_char_property (make_number (gpos
),
19457 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19459 /* If the row ends in middle of a real character,
19460 and the line is continued, we want the cursor here.
19461 That's because CHARPOS (ROW->end.pos) would equal
19462 PT if PT is before the character. */
19463 if (!row
->ends_in_ellipsis_p
)
19464 result
= row
->continued_p
;
19466 /* If the row ends in an ellipsis, then
19467 CHARPOS (ROW->end.pos) will equal point after the
19468 invisible text. We want that position to be displayed
19469 after the ellipsis. */
19472 /* If the row ends at ZV, display the cursor at the end of that
19473 row instead of at the start of the row below. */
19474 else if (row
->ends_at_zv_p
)
19483 /* Value is non-zero if glyph row ROW should be
19484 used to hold the cursor. */
19487 cursor_row_p (struct glyph_row
*row
)
19489 return row_for_charpos_p (row
, PT
);
19494 /* Push the property PROP so that it will be rendered at the current
19495 position in IT. Return 1 if PROP was successfully pushed, 0
19496 otherwise. Called from handle_line_prefix to handle the
19497 `line-prefix' and `wrap-prefix' properties. */
19500 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19502 struct text_pos pos
=
19503 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19505 eassert (it
->method
== GET_FROM_BUFFER
19506 || it
->method
== GET_FROM_DISPLAY_VECTOR
19507 || it
->method
== GET_FROM_STRING
);
19509 /* We need to save the current buffer/string position, so it will be
19510 restored by pop_it, because iterate_out_of_display_property
19511 depends on that being set correctly, but some situations leave
19512 it->position not yet set when this function is called. */
19513 push_it (it
, &pos
);
19515 if (STRINGP (prop
))
19517 if (SCHARS (prop
) == 0)
19524 it
->string_from_prefix_prop_p
= 1;
19525 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19526 it
->current
.overlay_string_index
= -1;
19527 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19528 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19529 it
->method
= GET_FROM_STRING
;
19530 it
->stop_charpos
= 0;
19532 it
->base_level_stop
= 0;
19534 /* Force paragraph direction to be that of the parent
19536 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19537 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19539 it
->paragraph_embedding
= L2R
;
19541 /* Set up the bidi iterator for this display string. */
19544 it
->bidi_it
.string
.lstring
= it
->string
;
19545 it
->bidi_it
.string
.s
= NULL
;
19546 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19547 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19548 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19549 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19550 it
->bidi_it
.w
= it
->w
;
19551 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19554 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19556 it
->method
= GET_FROM_STRETCH
;
19559 #ifdef HAVE_WINDOW_SYSTEM
19560 else if (IMAGEP (prop
))
19562 it
->what
= IT_IMAGE
;
19563 it
->image_id
= lookup_image (it
->f
, prop
);
19564 it
->method
= GET_FROM_IMAGE
;
19566 #endif /* HAVE_WINDOW_SYSTEM */
19569 pop_it (it
); /* bogus display property, give up */
19576 /* Return the character-property PROP at the current position in IT. */
19579 get_it_property (struct it
*it
, Lisp_Object prop
)
19581 Lisp_Object position
, object
= it
->object
;
19583 if (STRINGP (object
))
19584 position
= make_number (IT_STRING_CHARPOS (*it
));
19585 else if (BUFFERP (object
))
19587 position
= make_number (IT_CHARPOS (*it
));
19588 object
= it
->window
;
19593 return Fget_char_property (position
, prop
, object
);
19596 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19599 handle_line_prefix (struct it
*it
)
19601 Lisp_Object prefix
;
19603 if (it
->continuation_lines_width
> 0)
19605 prefix
= get_it_property (it
, Qwrap_prefix
);
19607 prefix
= Vwrap_prefix
;
19611 prefix
= get_it_property (it
, Qline_prefix
);
19613 prefix
= Vline_prefix
;
19615 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19617 /* If the prefix is wider than the window, and we try to wrap
19618 it, it would acquire its own wrap prefix, and so on till the
19619 iterator stack overflows. So, don't wrap the prefix. */
19620 it
->line_wrap
= TRUNCATE
;
19621 it
->avoid_cursor_p
= 1;
19627 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19628 only for R2L lines from display_line and display_string, when they
19629 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19630 the line/string needs to be continued on the next glyph row. */
19632 unproduce_glyphs (struct it
*it
, int n
)
19634 struct glyph
*glyph
, *end
;
19636 eassert (it
->glyph_row
);
19637 eassert (it
->glyph_row
->reversed_p
);
19638 eassert (it
->area
== TEXT_AREA
);
19639 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19641 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19642 n
= it
->glyph_row
->used
[TEXT_AREA
];
19643 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19644 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19645 for ( ; glyph
< end
; glyph
++)
19646 glyph
[-n
] = *glyph
;
19649 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19650 and ROW->maxpos. */
19652 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19653 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19654 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19656 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19657 lines' rows is implemented for bidi-reordered rows. */
19659 /* ROW->minpos is the value of min_pos, the minimal buffer position
19660 we have in ROW, or ROW->start.pos if that is smaller. */
19661 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19662 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19664 /* We didn't find buffer positions smaller than ROW->start, or
19665 didn't find _any_ valid buffer positions in any of the glyphs,
19666 so we must trust the iterator's computed positions. */
19667 row
->minpos
= row
->start
.pos
;
19670 max_pos
= CHARPOS (it
->current
.pos
);
19671 max_bpos
= BYTEPOS (it
->current
.pos
);
19674 /* Here are the various use-cases for ending the row, and the
19675 corresponding values for ROW->maxpos:
19677 Line ends in a newline from buffer eol_pos + 1
19678 Line is continued from buffer max_pos + 1
19679 Line is truncated on right it->current.pos
19680 Line ends in a newline from string max_pos + 1(*)
19681 (*) + 1 only when line ends in a forward scan
19682 Line is continued from string max_pos
19683 Line is continued from display vector max_pos
19684 Line is entirely from a string min_pos == max_pos
19685 Line is entirely from a display vector min_pos == max_pos
19686 Line that ends at ZV ZV
19688 If you discover other use-cases, please add them here as
19690 if (row
->ends_at_zv_p
)
19691 row
->maxpos
= it
->current
.pos
;
19692 else if (row
->used
[TEXT_AREA
])
19694 int seen_this_string
= 0;
19695 struct glyph_row
*r1
= row
- 1;
19697 /* Did we see the same display string on the previous row? */
19698 if (STRINGP (it
->object
)
19699 /* this is not the first row */
19700 && row
> it
->w
->desired_matrix
->rows
19701 /* previous row is not the header line */
19702 && !r1
->mode_line_p
19703 /* previous row also ends in a newline from a string */
19704 && r1
->ends_in_newline_from_string_p
)
19706 struct glyph
*start
, *end
;
19708 /* Search for the last glyph of the previous row that came
19709 from buffer or string. Depending on whether the row is
19710 L2R or R2L, we need to process it front to back or the
19711 other way round. */
19712 if (!r1
->reversed_p
)
19714 start
= r1
->glyphs
[TEXT_AREA
];
19715 end
= start
+ r1
->used
[TEXT_AREA
];
19716 /* Glyphs inserted by redisplay have an integer (zero)
19717 as their object. */
19719 && INTEGERP ((end
- 1)->object
)
19720 && (end
- 1)->charpos
<= 0)
19724 if (EQ ((end
- 1)->object
, it
->object
))
19725 seen_this_string
= 1;
19728 /* If all the glyphs of the previous row were inserted
19729 by redisplay, it means the previous row was
19730 produced from a single newline, which is only
19731 possible if that newline came from the same string
19732 as the one which produced this ROW. */
19733 seen_this_string
= 1;
19737 end
= r1
->glyphs
[TEXT_AREA
] - 1;
19738 start
= end
+ r1
->used
[TEXT_AREA
];
19740 && INTEGERP ((end
+ 1)->object
)
19741 && (end
+ 1)->charpos
<= 0)
19745 if (EQ ((end
+ 1)->object
, it
->object
))
19746 seen_this_string
= 1;
19749 seen_this_string
= 1;
19752 /* Take note of each display string that covers a newline only
19753 once, the first time we see it. This is for when a display
19754 string includes more than one newline in it. */
19755 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
19757 /* If we were scanning the buffer forward when we displayed
19758 the string, we want to account for at least one buffer
19759 position that belongs to this row (position covered by
19760 the display string), so that cursor positioning will
19761 consider this row as a candidate when point is at the end
19762 of the visual line represented by this row. This is not
19763 required when scanning back, because max_pos will already
19764 have a much larger value. */
19765 if (CHARPOS (row
->end
.pos
) > max_pos
)
19766 INC_BOTH (max_pos
, max_bpos
);
19767 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19769 else if (CHARPOS (it
->eol_pos
) > 0)
19770 SET_TEXT_POS (row
->maxpos
,
19771 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
19772 else if (row
->continued_p
)
19774 /* If max_pos is different from IT's current position, it
19775 means IT->method does not belong to the display element
19776 at max_pos. However, it also means that the display
19777 element at max_pos was displayed in its entirety on this
19778 line, which is equivalent to saying that the next line
19779 starts at the next buffer position. */
19780 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
19781 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19784 INC_BOTH (max_pos
, max_bpos
);
19785 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
19788 else if (row
->truncated_on_right_p
)
19789 /* display_line already called reseat_at_next_visible_line_start,
19790 which puts the iterator at the beginning of the next line, in
19791 the logical order. */
19792 row
->maxpos
= it
->current
.pos
;
19793 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
19794 /* A line that is entirely from a string/image/stretch... */
19795 row
->maxpos
= row
->minpos
;
19800 row
->maxpos
= it
->current
.pos
;
19803 /* Construct the glyph row IT->glyph_row in the desired matrix of
19804 IT->w from text at the current position of IT. See dispextern.h
19805 for an overview of struct it. Value is non-zero if
19806 IT->glyph_row displays text, as opposed to a line displaying ZV
19810 display_line (struct it
*it
)
19812 struct glyph_row
*row
= it
->glyph_row
;
19813 Lisp_Object overlay_arrow_string
;
19815 void *wrap_data
= NULL
;
19816 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
19817 int wrap_row_used
= -1;
19818 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
19819 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
19820 int wrap_row_extra_line_spacing
IF_LINT (= 0);
19821 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
19822 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
19824 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
19825 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
19827 /* We always start displaying at hpos zero even if hscrolled. */
19828 eassert (it
->hpos
== 0 && it
->current_x
== 0);
19830 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
19831 >= it
->w
->desired_matrix
->nrows
)
19833 it
->w
->nrows_scale_factor
++;
19834 it
->f
->fonts_changed
= 1;
19838 /* Clear the result glyph row and enable it. */
19839 prepare_desired_row (row
);
19841 row
->y
= it
->current_y
;
19842 row
->start
= it
->start
;
19843 row
->continuation_lines_width
= it
->continuation_lines_width
;
19844 row
->displays_text_p
= 1;
19845 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
19846 it
->starts_in_middle_of_char_p
= 0;
19848 /* Arrange the overlays nicely for our purposes. Usually, we call
19849 display_line on only one line at a time, in which case this
19850 can't really hurt too much, or we call it on lines which appear
19851 one after another in the buffer, in which case all calls to
19852 recenter_overlay_lists but the first will be pretty cheap. */
19853 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
19855 /* Move over display elements that are not visible because we are
19856 hscrolled. This may stop at an x-position < IT->first_visible_x
19857 if the first glyph is partially visible or if we hit a line end. */
19858 if (it
->current_x
< it
->first_visible_x
)
19860 enum move_it_result move_result
;
19862 this_line_min_pos
= row
->start
.pos
;
19863 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
19864 MOVE_TO_POS
| MOVE_TO_X
);
19865 /* If we are under a large hscroll, move_it_in_display_line_to
19866 could hit the end of the line without reaching
19867 it->first_visible_x. Pretend that we did reach it. This is
19868 especially important on a TTY, where we will call
19869 extend_face_to_end_of_line, which needs to know how many
19870 blank glyphs to produce. */
19871 if (it
->current_x
< it
->first_visible_x
19872 && (move_result
== MOVE_NEWLINE_OR_CR
19873 || move_result
== MOVE_POS_MATCH_OR_ZV
))
19874 it
->current_x
= it
->first_visible_x
;
19876 /* Record the smallest positions seen while we moved over
19877 display elements that are not visible. This is needed by
19878 redisplay_internal for optimizing the case where the cursor
19879 stays inside the same line. The rest of this function only
19880 considers positions that are actually displayed, so
19881 RECORD_MAX_MIN_POS will not otherwise record positions that
19882 are hscrolled to the left of the left edge of the window. */
19883 min_pos
= CHARPOS (this_line_min_pos
);
19884 min_bpos
= BYTEPOS (this_line_min_pos
);
19888 /* We only do this when not calling `move_it_in_display_line_to'
19889 above, because move_it_in_display_line_to calls
19890 handle_line_prefix itself. */
19891 handle_line_prefix (it
);
19894 /* Get the initial row height. This is either the height of the
19895 text hscrolled, if there is any, or zero. */
19896 row
->ascent
= it
->max_ascent
;
19897 row
->height
= it
->max_ascent
+ it
->max_descent
;
19898 row
->phys_ascent
= it
->max_phys_ascent
;
19899 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19900 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19902 /* Utility macro to record max and min buffer positions seen until now. */
19903 #define RECORD_MAX_MIN_POS(IT) \
19906 int composition_p = !STRINGP ((IT)->string) \
19907 && ((IT)->what == IT_COMPOSITION); \
19908 ptrdiff_t current_pos = \
19909 composition_p ? (IT)->cmp_it.charpos \
19910 : IT_CHARPOS (*(IT)); \
19911 ptrdiff_t current_bpos = \
19912 composition_p ? CHAR_TO_BYTE (current_pos) \
19913 : IT_BYTEPOS (*(IT)); \
19914 if (current_pos < min_pos) \
19916 min_pos = current_pos; \
19917 min_bpos = current_bpos; \
19919 if (IT_CHARPOS (*it) > max_pos) \
19921 max_pos = IT_CHARPOS (*it); \
19922 max_bpos = IT_BYTEPOS (*it); \
19927 /* Loop generating characters. The loop is left with IT on the next
19928 character to display. */
19931 int n_glyphs_before
, hpos_before
, x_before
;
19933 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
19935 /* Retrieve the next thing to display. Value is zero if end of
19937 if (!get_next_display_element (it
))
19939 /* Maybe add a space at the end of this line that is used to
19940 display the cursor there under X. Set the charpos of the
19941 first glyph of blank lines not corresponding to any text
19943 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
19944 row
->exact_window_width_line_p
= 1;
19945 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
19946 || row
->used
[TEXT_AREA
] == 0)
19948 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
19949 row
->displays_text_p
= 0;
19951 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
19952 && (!MINI_WINDOW_P (it
->w
)
19953 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
19954 row
->indicate_empty_line_p
= 1;
19957 it
->continuation_lines_width
= 0;
19958 row
->ends_at_zv_p
= 1;
19959 /* A row that displays right-to-left text must always have
19960 its last face extended all the way to the end of line,
19961 even if this row ends in ZV, because we still write to
19962 the screen left to right. We also need to extend the
19963 last face if the default face is remapped to some
19964 different face, otherwise the functions that clear
19965 portions of the screen will clear with the default face's
19966 background color. */
19967 if (row
->reversed_p
19968 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
19969 extend_face_to_end_of_line (it
);
19973 /* Now, get the metrics of what we want to display. This also
19974 generates glyphs in `row' (which is IT->glyph_row). */
19975 n_glyphs_before
= row
->used
[TEXT_AREA
];
19978 /* Remember the line height so far in case the next element doesn't
19979 fit on the line. */
19980 if (it
->line_wrap
!= TRUNCATE
)
19982 ascent
= it
->max_ascent
;
19983 descent
= it
->max_descent
;
19984 phys_ascent
= it
->max_phys_ascent
;
19985 phys_descent
= it
->max_phys_descent
;
19987 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
19989 if (IT_DISPLAYING_WHITESPACE (it
))
19993 SAVE_IT (wrap_it
, *it
, wrap_data
);
19995 wrap_row_used
= row
->used
[TEXT_AREA
];
19996 wrap_row_ascent
= row
->ascent
;
19997 wrap_row_height
= row
->height
;
19998 wrap_row_phys_ascent
= row
->phys_ascent
;
19999 wrap_row_phys_height
= row
->phys_height
;
20000 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20001 wrap_row_min_pos
= min_pos
;
20002 wrap_row_min_bpos
= min_bpos
;
20003 wrap_row_max_pos
= max_pos
;
20004 wrap_row_max_bpos
= max_bpos
;
20010 PRODUCE_GLYPHS (it
);
20012 /* If this display element was in marginal areas, continue with
20014 if (it
->area
!= TEXT_AREA
)
20016 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20017 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20018 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20019 row
->phys_height
= max (row
->phys_height
,
20020 it
->max_phys_ascent
+ it
->max_phys_descent
);
20021 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20022 it
->max_extra_line_spacing
);
20023 set_iterator_to_next (it
, 1);
20027 /* Does the display element fit on the line? If we truncate
20028 lines, we should draw past the right edge of the window. If
20029 we don't truncate, we want to stop so that we can display the
20030 continuation glyph before the right margin. If lines are
20031 continued, there are two possible strategies for characters
20032 resulting in more than 1 glyph (e.g. tabs): Display as many
20033 glyphs as possible in this line and leave the rest for the
20034 continuation line, or display the whole element in the next
20035 line. Original redisplay did the former, so we do it also. */
20036 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20037 hpos_before
= it
->hpos
;
20040 if (/* Not a newline. */
20042 /* Glyphs produced fit entirely in the line. */
20043 && it
->current_x
< it
->last_visible_x
)
20045 it
->hpos
+= nglyphs
;
20046 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20047 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20048 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20049 row
->phys_height
= max (row
->phys_height
,
20050 it
->max_phys_ascent
+ it
->max_phys_descent
);
20051 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20052 it
->max_extra_line_spacing
);
20053 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
)
20054 row
->x
= x
- it
->first_visible_x
;
20055 /* Record the maximum and minimum buffer positions seen so
20056 far in glyphs that will be displayed by this row. */
20058 RECORD_MAX_MIN_POS (it
);
20063 struct glyph
*glyph
;
20065 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20067 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20068 new_x
= x
+ glyph
->pixel_width
;
20070 if (/* Lines are continued. */
20071 it
->line_wrap
!= TRUNCATE
20072 && (/* Glyph doesn't fit on the line. */
20073 new_x
> it
->last_visible_x
20074 /* Or it fits exactly on a window system frame. */
20075 || (new_x
== it
->last_visible_x
20076 && FRAME_WINDOW_P (it
->f
)
20077 && (row
->reversed_p
20078 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20079 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20081 /* End of a continued line. */
20084 || (new_x
== it
->last_visible_x
20085 && FRAME_WINDOW_P (it
->f
)
20086 && (row
->reversed_p
20087 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20088 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20090 /* Current glyph is the only one on the line or
20091 fits exactly on the line. We must continue
20092 the line because we can't draw the cursor
20093 after the glyph. */
20094 row
->continued_p
= 1;
20095 it
->current_x
= new_x
;
20096 it
->continuation_lines_width
+= new_x
;
20098 if (i
== nglyphs
- 1)
20100 /* If line-wrap is on, check if a previous
20101 wrap point was found. */
20102 if (wrap_row_used
> 0
20103 /* Even if there is a previous wrap
20104 point, continue the line here as
20105 usual, if (i) the previous character
20106 was a space or tab AND (ii) the
20107 current character is not. */
20109 || IT_DISPLAYING_WHITESPACE (it
)))
20112 /* Record the maximum and minimum buffer
20113 positions seen so far in glyphs that will be
20114 displayed by this row. */
20116 RECORD_MAX_MIN_POS (it
);
20117 set_iterator_to_next (it
, 1);
20118 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20120 if (!get_next_display_element (it
))
20122 row
->exact_window_width_line_p
= 1;
20123 it
->continuation_lines_width
= 0;
20124 row
->continued_p
= 0;
20125 row
->ends_at_zv_p
= 1;
20127 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20129 row
->continued_p
= 0;
20130 row
->exact_window_width_line_p
= 1;
20134 else if (it
->bidi_p
)
20135 RECORD_MAX_MIN_POS (it
);
20136 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20137 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20138 extend_face_to_end_of_line (it
);
20140 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20141 && !FRAME_WINDOW_P (it
->f
))
20143 /* A padding glyph that doesn't fit on this line.
20144 This means the whole character doesn't fit
20146 if (row
->reversed_p
)
20147 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20148 - n_glyphs_before
);
20149 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20151 /* Fill the rest of the row with continuation
20152 glyphs like in 20.x. */
20153 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20154 < row
->glyphs
[1 + TEXT_AREA
])
20155 produce_special_glyphs (it
, IT_CONTINUATION
);
20157 row
->continued_p
= 1;
20158 it
->current_x
= x_before
;
20159 it
->continuation_lines_width
+= x_before
;
20161 /* Restore the height to what it was before the
20162 element not fitting on the line. */
20163 it
->max_ascent
= ascent
;
20164 it
->max_descent
= descent
;
20165 it
->max_phys_ascent
= phys_ascent
;
20166 it
->max_phys_descent
= phys_descent
;
20167 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20168 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20169 extend_face_to_end_of_line (it
);
20171 else if (wrap_row_used
> 0)
20174 if (row
->reversed_p
)
20175 unproduce_glyphs (it
,
20176 row
->used
[TEXT_AREA
] - wrap_row_used
);
20177 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20178 it
->continuation_lines_width
+= wrap_x
;
20179 row
->used
[TEXT_AREA
] = wrap_row_used
;
20180 row
->ascent
= wrap_row_ascent
;
20181 row
->height
= wrap_row_height
;
20182 row
->phys_ascent
= wrap_row_phys_ascent
;
20183 row
->phys_height
= wrap_row_phys_height
;
20184 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20185 min_pos
= wrap_row_min_pos
;
20186 min_bpos
= wrap_row_min_bpos
;
20187 max_pos
= wrap_row_max_pos
;
20188 max_bpos
= wrap_row_max_bpos
;
20189 row
->continued_p
= 1;
20190 row
->ends_at_zv_p
= 0;
20191 row
->exact_window_width_line_p
= 0;
20192 it
->continuation_lines_width
+= x
;
20194 /* Make sure that a non-default face is extended
20195 up to the right margin of the window. */
20196 extend_face_to_end_of_line (it
);
20198 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20200 /* A TAB that extends past the right edge of the
20201 window. This produces a single glyph on
20202 window system frames. We leave the glyph in
20203 this row and let it fill the row, but don't
20204 consume the TAB. */
20205 if ((row
->reversed_p
20206 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20207 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20208 produce_special_glyphs (it
, IT_CONTINUATION
);
20209 it
->continuation_lines_width
+= it
->last_visible_x
;
20210 row
->ends_in_middle_of_char_p
= 1;
20211 row
->continued_p
= 1;
20212 glyph
->pixel_width
= it
->last_visible_x
- x
;
20213 it
->starts_in_middle_of_char_p
= 1;
20214 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20215 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20216 extend_face_to_end_of_line (it
);
20220 /* Something other than a TAB that draws past
20221 the right edge of the window. Restore
20222 positions to values before the element. */
20223 if (row
->reversed_p
)
20224 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20225 - (n_glyphs_before
+ i
));
20226 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20228 /* Display continuation glyphs. */
20229 it
->current_x
= x_before
;
20230 it
->continuation_lines_width
+= x
;
20231 if (!FRAME_WINDOW_P (it
->f
)
20232 || (row
->reversed_p
20233 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20234 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20235 produce_special_glyphs (it
, IT_CONTINUATION
);
20236 row
->continued_p
= 1;
20238 extend_face_to_end_of_line (it
);
20240 if (nglyphs
> 1 && i
> 0)
20242 row
->ends_in_middle_of_char_p
= 1;
20243 it
->starts_in_middle_of_char_p
= 1;
20246 /* Restore the height to what it was before the
20247 element not fitting on the line. */
20248 it
->max_ascent
= ascent
;
20249 it
->max_descent
= descent
;
20250 it
->max_phys_ascent
= phys_ascent
;
20251 it
->max_phys_descent
= phys_descent
;
20256 else if (new_x
> it
->first_visible_x
)
20258 /* Increment number of glyphs actually displayed. */
20261 /* Record the maximum and minimum buffer positions
20262 seen so far in glyphs that will be displayed by
20265 RECORD_MAX_MIN_POS (it
);
20267 if (x
< it
->first_visible_x
)
20268 /* Glyph is partially visible, i.e. row starts at
20269 negative X position. */
20270 row
->x
= x
- it
->first_visible_x
;
20274 /* Glyph is completely off the left margin of the
20275 window. This should not happen because of the
20276 move_it_in_display_line at the start of this
20277 function, unless the text display area of the
20278 window is empty. */
20279 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20282 /* Even if this display element produced no glyphs at all,
20283 we want to record its position. */
20284 if (it
->bidi_p
&& nglyphs
== 0)
20285 RECORD_MAX_MIN_POS (it
);
20287 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20288 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20289 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20290 row
->phys_height
= max (row
->phys_height
,
20291 it
->max_phys_ascent
+ it
->max_phys_descent
);
20292 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20293 it
->max_extra_line_spacing
);
20295 /* End of this display line if row is continued. */
20296 if (row
->continued_p
|| row
->ends_at_zv_p
)
20301 /* Is this a line end? If yes, we're also done, after making
20302 sure that a non-default face is extended up to the right
20303 margin of the window. */
20304 if (ITERATOR_AT_END_OF_LINE_P (it
))
20306 int used_before
= row
->used
[TEXT_AREA
];
20308 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20310 /* Add a space at the end of the line that is used to
20311 display the cursor there. */
20312 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20313 append_space_for_newline (it
, 0);
20315 /* Extend the face to the end of the line. */
20316 extend_face_to_end_of_line (it
);
20318 /* Make sure we have the position. */
20319 if (used_before
== 0)
20320 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20322 /* Record the position of the newline, for use in
20324 it
->eol_pos
= it
->current
.pos
;
20326 /* Consume the line end. This skips over invisible lines. */
20327 set_iterator_to_next (it
, 1);
20328 it
->continuation_lines_width
= 0;
20332 /* Proceed with next display element. Note that this skips
20333 over lines invisible because of selective display. */
20334 set_iterator_to_next (it
, 1);
20336 /* If we truncate lines, we are done when the last displayed
20337 glyphs reach past the right margin of the window. */
20338 if (it
->line_wrap
== TRUNCATE
20339 && ((FRAME_WINDOW_P (it
->f
)
20340 /* Images are preprocessed in produce_image_glyph such
20341 that they are cropped at the right edge of the
20342 window, so an image glyph will always end exactly at
20343 last_visible_x, even if there's no right fringe. */
20344 && (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) || it
->what
== IT_IMAGE
))
20345 ? (it
->current_x
>= it
->last_visible_x
)
20346 : (it
->current_x
> it
->last_visible_x
)))
20348 /* Maybe add truncation glyphs. */
20349 if (!FRAME_WINDOW_P (it
->f
)
20350 || (row
->reversed_p
20351 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20352 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20356 if (!row
->reversed_p
)
20358 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20359 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20364 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20365 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20367 /* Remove any padding glyphs at the front of ROW, to
20368 make room for the truncation glyphs we will be
20369 adding below. The loop below always inserts at
20370 least one truncation glyph, so also remove the
20371 last glyph added to ROW. */
20372 unproduce_glyphs (it
, i
+ 1);
20373 /* Adjust i for the loop below. */
20374 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20377 /* produce_special_glyphs overwrites the last glyph, so
20378 we don't want that if we want to keep that last
20379 glyph, which means it's an image. */
20380 if (it
->current_x
> it
->last_visible_x
)
20382 it
->current_x
= x_before
;
20383 if (!FRAME_WINDOW_P (it
->f
))
20385 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20387 row
->used
[TEXT_AREA
] = i
;
20388 produce_special_glyphs (it
, IT_TRUNCATION
);
20393 row
->used
[TEXT_AREA
] = i
;
20394 produce_special_glyphs (it
, IT_TRUNCATION
);
20396 it
->hpos
= hpos_before
;
20399 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20401 /* Don't truncate if we can overflow newline into fringe. */
20402 if (!get_next_display_element (it
))
20404 it
->continuation_lines_width
= 0;
20405 row
->ends_at_zv_p
= 1;
20406 row
->exact_window_width_line_p
= 1;
20409 if (ITERATOR_AT_END_OF_LINE_P (it
))
20411 row
->exact_window_width_line_p
= 1;
20412 goto at_end_of_line
;
20414 it
->current_x
= x_before
;
20415 it
->hpos
= hpos_before
;
20418 row
->truncated_on_right_p
= 1;
20419 it
->continuation_lines_width
= 0;
20420 reseat_at_next_visible_line_start (it
, 0);
20421 row
->ends_at_zv_p
= FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n';
20427 bidi_unshelve_cache (wrap_data
, 1);
20429 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20430 at the left window margin. */
20431 if (it
->first_visible_x
20432 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20434 if (!FRAME_WINDOW_P (it
->f
)
20435 || (((row
->reversed_p
20436 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20437 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20438 /* Don't let insert_left_trunc_glyphs overwrite the
20439 first glyph of the row if it is an image. */
20440 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20441 insert_left_trunc_glyphs (it
);
20442 row
->truncated_on_left_p
= 1;
20445 /* Remember the position at which this line ends.
20447 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20448 cannot be before the call to find_row_edges below, since that is
20449 where these positions are determined. */
20450 row
->end
= it
->current
;
20453 row
->minpos
= row
->start
.pos
;
20454 row
->maxpos
= row
->end
.pos
;
20458 /* ROW->minpos and ROW->maxpos must be the smallest and
20459 `1 + the largest' buffer positions in ROW. But if ROW was
20460 bidi-reordered, these two positions can be anywhere in the
20461 row, so we must determine them now. */
20462 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20465 /* If the start of this line is the overlay arrow-position, then
20466 mark this glyph row as the one containing the overlay arrow.
20467 This is clearly a mess with variable size fonts. It would be
20468 better to let it be displayed like cursors under X. */
20469 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20470 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20471 !NILP (overlay_arrow_string
)))
20473 /* Overlay arrow in window redisplay is a fringe bitmap. */
20474 if (STRINGP (overlay_arrow_string
))
20476 struct glyph_row
*arrow_row
20477 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20478 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20479 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20480 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20481 struct glyph
*p2
, *end
;
20483 /* Copy the arrow glyphs. */
20484 while (glyph
< arrow_end
)
20487 /* Throw away padding glyphs. */
20489 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20490 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20496 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20501 eassert (INTEGERP (overlay_arrow_string
));
20502 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20504 overlay_arrow_seen
= 1;
20507 /* Highlight trailing whitespace. */
20508 if (!NILP (Vshow_trailing_whitespace
))
20509 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20511 /* Compute pixel dimensions of this line. */
20512 compute_line_metrics (it
);
20514 /* Implementation note: No changes in the glyphs of ROW or in their
20515 faces can be done past this point, because compute_line_metrics
20516 computes ROW's hash value and stores it within the glyph_row
20519 /* Record whether this row ends inside an ellipsis. */
20520 row
->ends_in_ellipsis_p
20521 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20522 && it
->ellipsis_p
);
20524 /* Save fringe bitmaps in this row. */
20525 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20526 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20527 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20528 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20530 it
->left_user_fringe_bitmap
= 0;
20531 it
->left_user_fringe_face_id
= 0;
20532 it
->right_user_fringe_bitmap
= 0;
20533 it
->right_user_fringe_face_id
= 0;
20535 /* Maybe set the cursor. */
20536 cvpos
= it
->w
->cursor
.vpos
;
20538 /* In bidi-reordered rows, keep checking for proper cursor
20539 position even if one has been found already, because buffer
20540 positions in such rows change non-linearly with ROW->VPOS,
20541 when a line is continued. One exception: when we are at ZV,
20542 display cursor on the first suitable glyph row, since all
20543 the empty rows after that also have their position set to ZV. */
20544 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20545 lines' rows is implemented for bidi-reordered rows. */
20547 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20548 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20549 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20550 && cursor_row_p (row
))
20551 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20553 /* Prepare for the next line. This line starts horizontally at (X
20554 HPOS) = (0 0). Vertical positions are incremented. As a
20555 convenience for the caller, IT->glyph_row is set to the next
20557 it
->current_x
= it
->hpos
= 0;
20558 it
->current_y
+= row
->height
;
20559 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20562 /* The next row should by default use the same value of the
20563 reversed_p flag as this one. set_iterator_to_next decides when
20564 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20565 the flag accordingly. */
20566 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20567 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20568 it
->start
= row
->end
;
20569 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20571 #undef RECORD_MAX_MIN_POS
20574 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20575 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20576 doc
: /* Return paragraph direction at point in BUFFER.
20577 Value is either `left-to-right' or `right-to-left'.
20578 If BUFFER is omitted or nil, it defaults to the current buffer.
20580 Paragraph direction determines how the text in the paragraph is displayed.
20581 In left-to-right paragraphs, text begins at the left margin of the window
20582 and the reading direction is generally left to right. In right-to-left
20583 paragraphs, text begins at the right margin and is read from right to left.
20585 See also `bidi-paragraph-direction'. */)
20586 (Lisp_Object buffer
)
20588 struct buffer
*buf
= current_buffer
;
20589 struct buffer
*old
= buf
;
20591 if (! NILP (buffer
))
20593 CHECK_BUFFER (buffer
);
20594 buf
= XBUFFER (buffer
);
20597 if (NILP (BVAR (buf
, bidi_display_reordering
))
20598 || NILP (BVAR (buf
, enable_multibyte_characters
))
20599 /* When we are loading loadup.el, the character property tables
20600 needed for bidi iteration are not yet available. */
20601 || !NILP (Vpurify_flag
))
20602 return Qleft_to_right
;
20603 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20604 return BVAR (buf
, bidi_paragraph_direction
);
20607 /* Determine the direction from buffer text. We could try to
20608 use current_matrix if it is up to date, but this seems fast
20609 enough as it is. */
20610 struct bidi_it itb
;
20611 ptrdiff_t pos
= BUF_PT (buf
);
20612 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20614 void *itb_data
= bidi_shelve_cache ();
20616 set_buffer_temp (buf
);
20617 /* bidi_paragraph_init finds the base direction of the paragraph
20618 by searching forward from paragraph start. We need the base
20619 direction of the current or _previous_ paragraph, so we need
20620 to make sure we are within that paragraph. To that end, find
20621 the previous non-empty line. */
20622 if (pos
>= ZV
&& pos
> BEGV
)
20623 DEC_BOTH (pos
, bytepos
);
20624 if (fast_looking_at (build_string ("[\f\t ]*\n"),
20625 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20627 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20628 || c
== ' ' || c
== '\t' || c
== '\f')
20630 if (bytepos
<= BEGV_BYTE
)
20635 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20638 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20639 itb
.paragraph_dir
= NEUTRAL_DIR
;
20640 itb
.string
.s
= NULL
;
20641 itb
.string
.lstring
= Qnil
;
20642 itb
.string
.bufpos
= 0;
20643 itb
.string
.from_disp_str
= 0;
20644 itb
.string
.unibyte
= 0;
20645 /* We have no window to use here for ignoring window-specific
20646 overlays. Using NULL for window pointer will cause
20647 compute_display_string_pos to use the current buffer. */
20649 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20650 bidi_unshelve_cache (itb_data
, 0);
20651 set_buffer_temp (old
);
20652 switch (itb
.paragraph_dir
)
20655 return Qleft_to_right
;
20658 return Qright_to_left
;
20666 DEFUN ("move-point-visually", Fmove_point_visually
,
20667 Smove_point_visually
, 1, 1, 0,
20668 doc
: /* Move point in the visual order in the specified DIRECTION.
20669 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
20672 Value is the new character position of point. */)
20673 (Lisp_Object direction
)
20675 struct window
*w
= XWINDOW (selected_window
);
20676 struct buffer
*b
= XBUFFER (w
->contents
);
20677 struct glyph_row
*row
;
20679 Lisp_Object paragraph_dir
;
20681 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
20682 (!(ROW)->continued_p \
20683 && INTEGERP ((GLYPH)->object) \
20684 && (GLYPH)->type == CHAR_GLYPH \
20685 && (GLYPH)->u.ch == ' ' \
20686 && (GLYPH)->charpos >= 0 \
20687 && !(GLYPH)->avoid_cursor_p)
20689 CHECK_NUMBER (direction
);
20690 dir
= XINT (direction
);
20696 /* If current matrix is up-to-date, we can use the information
20697 recorded in the glyphs, at least as long as the goal is on the
20699 if (w
->window_end_valid
20700 && !windows_or_buffers_changed
20702 && !b
->clip_changed
20703 && !b
->prevent_redisplay_optimizations_p
20704 && !window_outdated (w
)
20705 /* We rely below on the cursor coordinates to be up to date, but
20706 we cannot trust them if some command moved point since the
20707 last complete redisplay. */
20708 && w
->last_point
== BUF_PT (b
)
20709 && w
->cursor
.vpos
>= 0
20710 && w
->cursor
.vpos
< w
->current_matrix
->nrows
20711 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
20713 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
20714 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
20715 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
20717 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
20719 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
20721 SET_PT (g
->charpos
);
20722 w
->cursor
.vpos
= -1;
20723 return make_number (PT
);
20725 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
20729 if (BUFFERP (gpt
->object
))
20732 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
20733 new_pos
+= (row
->reversed_p
? -dir
: dir
);
20735 new_pos
-= (row
->reversed_p
? -dir
: dir
);;
20737 else if (BUFFERP (g
->object
))
20738 new_pos
= g
->charpos
;
20742 w
->cursor
.vpos
= -1;
20743 return make_number (PT
);
20745 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
20747 /* Glyphs inserted at the end of a non-empty line for
20748 positioning the cursor have zero charpos, so we must
20749 deduce the value of point by other means. */
20750 if (g
->charpos
> 0)
20751 SET_PT (g
->charpos
);
20752 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
20754 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
20755 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20758 w
->cursor
.vpos
= -1;
20759 return make_number (PT
);
20762 if (g
== e
|| INTEGERP (g
->object
))
20764 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
20765 goto simulate_display
;
20766 if (!row
->reversed_p
)
20770 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
20771 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
20772 goto simulate_display
;
20776 if (row
->reversed_p
&& !row
->continued_p
)
20778 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20779 w
->cursor
.vpos
= -1;
20780 return make_number (PT
);
20782 g
= row
->glyphs
[TEXT_AREA
];
20783 e
= g
+ row
->used
[TEXT_AREA
];
20784 for ( ; g
< e
; g
++)
20786 if (BUFFERP (g
->object
)
20787 /* Empty lines have only one glyph, which stands
20788 for the newline, and whose charpos is the
20789 buffer position of the newline. */
20790 || ROW_GLYPH_NEWLINE_P (row
, g
)
20791 /* When the buffer ends in a newline, the line at
20792 EOB also has one glyph, but its charpos is -1. */
20793 || (row
->ends_at_zv_p
20794 && !row
->reversed_p
20795 && INTEGERP (g
->object
)
20796 && g
->type
== CHAR_GLYPH
20797 && g
->u
.ch
== ' '))
20799 if (g
->charpos
> 0)
20800 SET_PT (g
->charpos
);
20801 else if (!row
->reversed_p
20802 && row
->ends_at_zv_p
20807 w
->cursor
.vpos
= -1;
20808 return make_number (PT
);
20814 if (!row
->reversed_p
&& !row
->continued_p
)
20816 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
20817 w
->cursor
.vpos
= -1;
20818 return make_number (PT
);
20820 e
= row
->glyphs
[TEXT_AREA
];
20821 g
= e
+ row
->used
[TEXT_AREA
] - 1;
20822 for ( ; g
>= e
; g
--)
20824 if (BUFFERP (g
->object
)
20825 || (ROW_GLYPH_NEWLINE_P (row
, g
)
20827 /* Empty R2L lines on GUI frames have the buffer
20828 position of the newline stored in the stretch
20830 || g
->type
== STRETCH_GLYPH
20831 || (row
->ends_at_zv_p
20833 && INTEGERP (g
->object
)
20834 && g
->type
== CHAR_GLYPH
20835 && g
->u
.ch
== ' '))
20837 if (g
->charpos
> 0)
20838 SET_PT (g
->charpos
);
20839 else if (row
->reversed_p
20840 && row
->ends_at_zv_p
20845 w
->cursor
.vpos
= -1;
20846 return make_number (PT
);
20855 /* If we wind up here, we failed to move by using the glyphs, so we
20856 need to simulate display instead. */
20859 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
20861 paragraph_dir
= Qleft_to_right
;
20862 if (EQ (paragraph_dir
, Qright_to_left
))
20864 if (PT
<= BEGV
&& dir
< 0)
20865 xsignal0 (Qbeginning_of_buffer
);
20866 else if (PT
>= ZV
&& dir
> 0)
20867 xsignal0 (Qend_of_buffer
);
20870 struct text_pos pt
;
20872 int pt_x
, target_x
, pixel_width
, pt_vpos
;
20874 bool overshoot_expected
= false;
20875 bool target_is_eol_p
= false;
20877 /* Setup the arena. */
20878 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
20879 start_display (&it
, w
, pt
);
20881 if (it
.cmp_it
.id
< 0
20882 && it
.method
== GET_FROM_STRING
20883 && it
.area
== TEXT_AREA
20884 && it
.string_from_display_prop_p
20885 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
20886 overshoot_expected
= true;
20888 /* Find the X coordinate of point. We start from the beginning
20889 of this or previous line to make sure we are before point in
20890 the logical order (since the move_it_* functions can only
20893 reseat_at_previous_visible_line_start (&it
);
20894 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
20895 if (IT_CHARPOS (it
) != PT
)
20897 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
20898 -1, -1, -1, MOVE_TO_POS
);
20899 /* If we missed point because the character there is
20900 displayed out of a display vector that has more than one
20901 glyph, retry expecting overshoot. */
20902 if (it
.method
== GET_FROM_DISPLAY_VECTOR
20903 && it
.current
.dpvec_index
> 0
20904 && !overshoot_expected
)
20906 overshoot_expected
= true;
20909 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
20910 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
20912 pt_x
= it
.current_x
;
20914 if (dir
> 0 || overshoot_expected
)
20916 struct glyph_row
*row
= it
.glyph_row
;
20918 /* When point is at beginning of line, we don't have
20919 information about the glyph there loaded into struct
20920 it. Calling get_next_display_element fixes that. */
20922 get_next_display_element (&it
);
20923 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20924 it
.glyph_row
= NULL
;
20925 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
20926 it
.glyph_row
= row
;
20927 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
20928 it, lest it will become out of sync with it's buffer
20930 it
.current_x
= pt_x
;
20933 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
20934 pixel_width
= it
.pixel_width
;
20935 if (overshoot_expected
&& at_eol_p
)
20937 else if (pixel_width
<= 0)
20940 /* If there's a display string (or something similar) at point,
20941 we are actually at the glyph to the left of point, so we need
20942 to correct the X coordinate. */
20943 if (overshoot_expected
)
20946 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
20948 pt_x
+= pixel_width
;
20951 /* Compute target X coordinate, either to the left or to the
20952 right of point. On TTY frames, all characters have the same
20953 pixel width of 1, so we can use that. On GUI frames we don't
20954 have an easy way of getting at the pixel width of the
20955 character to the left of point, so we use a different method
20956 of getting to that place. */
20958 target_x
= pt_x
+ pixel_width
;
20960 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
20962 /* Target X coordinate could be one line above or below the line
20963 of point, in which case we need to adjust the target X
20964 coordinate. Also, if moving to the left, we need to begin at
20965 the left edge of the point's screen line. */
20970 start_display (&it
, w
, pt
);
20971 reseat_at_previous_visible_line_start (&it
);
20972 it
.current_x
= it
.current_y
= it
.hpos
= 0;
20974 move_it_by_lines (&it
, pt_vpos
);
20978 move_it_by_lines (&it
, -1);
20979 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
20980 target_is_eol_p
= true;
20981 /* Under word-wrap, we don't know the x coordinate of
20982 the last character displayed on the previous line,
20983 which immediately precedes the wrap point. To find
20984 out its x coordinate, we try moving to the right
20985 margin of the window, which will stop at the wrap
20986 point, and then reset target_x to point at the
20987 character that precedes the wrap point. This is not
20988 needed on GUI frames, because (see below) there we
20989 move from the left margin one grapheme cluster at a
20990 time, and stop when we hit the wrap point. */
20991 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
20993 void *it_data
= NULL
;
20996 SAVE_IT (it2
, it
, it_data
);
20997 move_it_in_display_line_to (&it
, ZV
, target_x
,
20998 MOVE_TO_POS
| MOVE_TO_X
);
20999 /* If we arrived at target_x, that _is_ the last
21000 character on the previous line. */
21001 if (it
.current_x
!= target_x
)
21002 target_x
= it
.current_x
- 1;
21003 RESTORE_IT (&it
, &it2
, it_data
);
21010 || (target_x
>= it
.last_visible_x
21011 && it
.line_wrap
!= TRUNCATE
))
21014 move_it_by_lines (&it
, 0);
21015 move_it_by_lines (&it
, 1);
21020 /* Move to the target X coordinate. */
21021 #ifdef HAVE_WINDOW_SYSTEM
21022 /* On GUI frames, as we don't know the X coordinate of the
21023 character to the left of point, moving point to the left
21024 requires walking, one grapheme cluster at a time, until we
21025 find ourself at a place immediately to the left of the
21026 character at point. */
21027 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21029 struct text_pos new_pos
;
21030 enum move_it_result rc
= MOVE_X_REACHED
;
21032 if (it
.current_x
== 0)
21033 get_next_display_element (&it
);
21034 if (it
.what
== IT_COMPOSITION
)
21036 new_pos
.charpos
= it
.cmp_it
.charpos
;
21037 new_pos
.bytepos
= -1;
21040 new_pos
= it
.current
.pos
;
21042 while (it
.current_x
+ it
.pixel_width
<= target_x
21043 && (rc
== MOVE_X_REACHED
21044 /* Under word-wrap, move_it_in_display_line_to
21045 stops at correct coordinates, but sometimes
21046 returns MOVE_POS_MATCH_OR_ZV. */
21047 || (it
.line_wrap
== WORD_WRAP
21048 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21050 int new_x
= it
.current_x
+ it
.pixel_width
;
21052 /* For composed characters, we want the position of the
21053 first character in the grapheme cluster (usually, the
21054 composition's base character), whereas it.current
21055 might give us the position of the _last_ one, e.g. if
21056 the composition is rendered in reverse due to bidi
21058 if (it
.what
== IT_COMPOSITION
)
21060 new_pos
.charpos
= it
.cmp_it
.charpos
;
21061 new_pos
.bytepos
= -1;
21064 new_pos
= it
.current
.pos
;
21065 if (new_x
== it
.current_x
)
21067 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21068 MOVE_TO_POS
| MOVE_TO_X
);
21069 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21072 /* The previous position we saw in the loop is the one we
21074 if (new_pos
.bytepos
== -1)
21075 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21076 it
.current
.pos
= new_pos
;
21080 if (it
.current_x
!= target_x
)
21081 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21083 /* When lines are truncated, the above loop will stop at the
21084 window edge. But we want to get to the end of line, even if
21085 it is beyond the window edge; automatic hscroll will then
21086 scroll the window to show point as appropriate. */
21087 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21088 && get_next_display_element (&it
))
21090 struct text_pos new_pos
= it
.current
.pos
;
21092 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21094 set_iterator_to_next (&it
, 0);
21095 if (it
.method
== GET_FROM_BUFFER
)
21096 new_pos
= it
.current
.pos
;
21097 if (!get_next_display_element (&it
))
21101 it
.current
.pos
= new_pos
;
21104 /* If we ended up in a display string that covers point, move to
21105 buffer position to the right in the visual order. */
21108 while (IT_CHARPOS (it
) == PT
)
21110 set_iterator_to_next (&it
, 0);
21111 if (!get_next_display_element (&it
))
21116 /* Move point to that position. */
21117 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21120 return make_number (PT
);
21122 #undef ROW_GLYPH_NEWLINE_P
21126 /***********************************************************************
21128 ***********************************************************************/
21130 /* Redisplay the menu bar in the frame for window W.
21132 The menu bar of X frames that don't have X toolkit support is
21133 displayed in a special window W->frame->menu_bar_window.
21135 The menu bar of terminal frames is treated specially as far as
21136 glyph matrices are concerned. Menu bar lines are not part of
21137 windows, so the update is done directly on the frame matrix rows
21138 for the menu bar. */
21141 display_menu_bar (struct window
*w
)
21143 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21148 /* Don't do all this for graphical frames. */
21150 if (FRAME_W32_P (f
))
21153 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21159 if (FRAME_NS_P (f
))
21161 #endif /* HAVE_NS */
21163 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21164 eassert (!FRAME_WINDOW_P (f
));
21165 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21166 it
.first_visible_x
= 0;
21167 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21168 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21169 if (FRAME_WINDOW_P (f
))
21171 /* Menu bar lines are displayed in the desired matrix of the
21172 dummy window menu_bar_window. */
21173 struct window
*menu_w
;
21174 menu_w
= XWINDOW (f
->menu_bar_window
);
21175 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21177 it
.first_visible_x
= 0;
21178 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21181 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21183 /* This is a TTY frame, i.e. character hpos/vpos are used as
21185 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21187 it
.first_visible_x
= 0;
21188 it
.last_visible_x
= FRAME_COLS (f
);
21191 /* FIXME: This should be controlled by a user option. See the
21192 comments in redisplay_tool_bar and display_mode_line about
21194 it
.paragraph_embedding
= L2R
;
21196 /* Clear all rows of the menu bar. */
21197 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21199 struct glyph_row
*row
= it
.glyph_row
+ i
;
21200 clear_glyph_row (row
);
21201 row
->enabled_p
= true;
21202 row
->full_width_p
= 1;
21205 /* Display all items of the menu bar. */
21206 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21207 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21209 Lisp_Object string
;
21211 /* Stop at nil string. */
21212 string
= AREF (items
, i
+ 1);
21216 /* Remember where item was displayed. */
21217 ASET (items
, i
+ 3, make_number (it
.hpos
));
21219 /* Display the item, pad with one space. */
21220 if (it
.current_x
< it
.last_visible_x
)
21221 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21222 SCHARS (string
) + 1, 0, 0, -1);
21225 /* Fill out the line with spaces. */
21226 if (it
.current_x
< it
.last_visible_x
)
21227 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21229 /* Compute the total height of the lines. */
21230 compute_line_metrics (&it
);
21233 /* Deep copy of a glyph row, including the glyphs. */
21235 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21237 struct glyph
*pointers
[1 + LAST_AREA
];
21238 int to_used
= to
->used
[TEXT_AREA
];
21240 /* Save glyph pointers of TO. */
21241 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21243 /* Do a structure assignment. */
21246 /* Restore original glyph pointers of TO. */
21247 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21249 /* Copy the glyphs. */
21250 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21251 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21253 /* If we filled only part of the TO row, fill the rest with
21254 space_glyph (which will display as empty space). */
21255 if (to_used
> from
->used
[TEXT_AREA
])
21256 fill_up_frame_row_with_spaces (to
, to_used
);
21259 /* Display one menu item on a TTY, by overwriting the glyphs in the
21260 frame F's desired glyph matrix with glyphs produced from the menu
21261 item text. Called from term.c to display TTY drop-down menus one
21264 ITEM_TEXT is the menu item text as a C string.
21266 FACE_ID is the face ID to be used for this menu item. FACE_ID
21267 could specify one of 3 faces: a face for an enabled item, a face
21268 for a disabled item, or a face for a selected item.
21270 X and Y are coordinates of the first glyph in the frame's desired
21271 matrix to be overwritten by the menu item. Since this is a TTY, Y
21272 is the zero-based number of the glyph row and X is the zero-based
21273 glyph number in the row, starting from left, where to start
21274 displaying the item.
21276 SUBMENU non-zero means this menu item drops down a submenu, which
21277 should be indicated by displaying a proper visual cue after the
21281 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21282 int x
, int y
, int submenu
)
21285 struct frame
*f
= SELECTED_FRAME ();
21286 struct window
*w
= XWINDOW (f
->selected_window
);
21287 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21288 struct glyph_row
*row
;
21289 size_t item_len
= strlen (item_text
);
21291 eassert (FRAME_TERMCAP_P (f
));
21293 /* Don't write beyond the matrix's last row. This can happen for
21294 TTY screens that are not high enough to show the entire menu.
21295 (This is actually a bit of defensive programming, as
21296 tty_menu_display already limits the number of menu items to one
21297 less than the number of screen lines.) */
21298 if (y
>= f
->desired_matrix
->nrows
)
21301 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21302 it
.first_visible_x
= 0;
21303 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21304 row
= it
.glyph_row
;
21305 /* Start with the row contents from the current matrix. */
21306 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21307 saved_width
= row
->full_width_p
;
21308 row
->full_width_p
= 1;
21309 saved_reversed
= row
->reversed_p
;
21310 row
->reversed_p
= 0;
21311 row
->enabled_p
= true;
21313 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21315 eassert (x
< f
->desired_matrix
->matrix_w
);
21316 it
.current_x
= it
.hpos
= x
;
21317 it
.current_y
= it
.vpos
= y
;
21318 saved_used
= row
->used
[TEXT_AREA
];
21319 saved_truncated
= row
->truncated_on_right_p
;
21320 row
->used
[TEXT_AREA
] = x
;
21321 it
.face_id
= face_id
;
21322 it
.line_wrap
= TRUNCATE
;
21324 /* FIXME: This should be controlled by a user option. See the
21325 comments in redisplay_tool_bar and display_mode_line about this.
21326 Also, if paragraph_embedding could ever be R2L, changes will be
21327 needed to avoid shifting to the right the row characters in
21328 term.c:append_glyph. */
21329 it
.paragraph_embedding
= L2R
;
21331 /* Pad with a space on the left. */
21332 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21334 /* Display the menu item, pad with spaces to WIDTH. */
21337 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21338 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21340 /* Indicate with " >" that there's a submenu. */
21341 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21342 FRAME_COLS (f
) - 1, -1);
21345 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21346 width
, 0, FRAME_COLS (f
) - 1, -1);
21348 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21349 row
->truncated_on_right_p
= saved_truncated
;
21350 row
->hash
= row_hash (row
);
21351 row
->full_width_p
= saved_width
;
21352 row
->reversed_p
= saved_reversed
;
21355 /***********************************************************************
21357 ***********************************************************************/
21359 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21360 FORCE is non-zero, redisplay mode lines unconditionally.
21361 Otherwise, redisplay only mode lines that are garbaged. Value is
21362 the number of windows whose mode lines were redisplayed. */
21365 redisplay_mode_lines (Lisp_Object window
, bool force
)
21369 while (!NILP (window
))
21371 struct window
*w
= XWINDOW (window
);
21373 if (WINDOWP (w
->contents
))
21374 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21376 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21377 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21379 struct text_pos lpoint
;
21380 struct buffer
*old
= current_buffer
;
21382 /* Set the window's buffer for the mode line display. */
21383 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21384 set_buffer_internal_1 (XBUFFER (w
->contents
));
21386 /* Point refers normally to the selected window. For any
21387 other window, set up appropriate value. */
21388 if (!EQ (window
, selected_window
))
21390 struct text_pos pt
;
21392 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21393 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21396 /* Display mode lines. */
21397 clear_glyph_matrix (w
->desired_matrix
);
21398 if (display_mode_lines (w
))
21401 /* Restore old settings. */
21402 set_buffer_internal_1 (old
);
21403 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21413 /* Display the mode and/or header line of window W. Value is the
21414 sum number of mode lines and header lines displayed. */
21417 display_mode_lines (struct window
*w
)
21419 Lisp_Object old_selected_window
= selected_window
;
21420 Lisp_Object old_selected_frame
= selected_frame
;
21421 Lisp_Object new_frame
= w
->frame
;
21422 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21425 selected_frame
= new_frame
;
21426 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21427 or window's point, then we'd need select_window_1 here as well. */
21428 XSETWINDOW (selected_window
, w
);
21429 XFRAME (new_frame
)->selected_window
= selected_window
;
21431 /* These will be set while the mode line specs are processed. */
21432 line_number_displayed
= 0;
21433 w
->column_number_displayed
= -1;
21435 if (WINDOW_WANTS_MODELINE_P (w
))
21437 struct window
*sel_w
= XWINDOW (old_selected_window
);
21439 /* Select mode line face based on the real selected window. */
21440 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21441 BVAR (current_buffer
, mode_line_format
));
21445 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21447 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21448 BVAR (current_buffer
, header_line_format
));
21452 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21453 selected_frame
= old_selected_frame
;
21454 selected_window
= old_selected_window
;
21456 w
->must_be_updated_p
= true;
21461 /* Display mode or header line of window W. FACE_ID specifies which
21462 line to display; it is either MODE_LINE_FACE_ID or
21463 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21464 display. Value is the pixel height of the mode/header line
21468 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21474 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21475 /* Don't extend on a previously drawn mode-line.
21476 This may happen if called from pos_visible_p. */
21477 it
.glyph_row
->enabled_p
= false;
21478 prepare_desired_row (it
.glyph_row
);
21480 it
.glyph_row
->mode_line_p
= 1;
21482 /* FIXME: This should be controlled by a user option. But
21483 supporting such an option is not trivial, since the mode line is
21484 made up of many separate strings. */
21485 it
.paragraph_embedding
= L2R
;
21487 record_unwind_protect (unwind_format_mode_line
,
21488 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21490 mode_line_target
= MODE_LINE_DISPLAY
;
21492 /* Temporarily make frame's keyboard the current kboard so that
21493 kboard-local variables in the mode_line_format will get the right
21495 push_kboard (FRAME_KBOARD (it
.f
));
21496 record_unwind_save_match_data ();
21497 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21502 /* Fill up with spaces. */
21503 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21505 compute_line_metrics (&it
);
21506 it
.glyph_row
->full_width_p
= 1;
21507 it
.glyph_row
->continued_p
= 0;
21508 it
.glyph_row
->truncated_on_left_p
= 0;
21509 it
.glyph_row
->truncated_on_right_p
= 0;
21511 /* Make a 3D mode-line have a shadow at its right end. */
21512 face
= FACE_FROM_ID (it
.f
, face_id
);
21513 extend_face_to_end_of_line (&it
);
21514 if (face
->box
!= FACE_NO_BOX
)
21516 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21517 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21518 last
->right_box_line_p
= 1;
21521 return it
.glyph_row
->height
;
21524 /* Move element ELT in LIST to the front of LIST.
21525 Return the updated list. */
21528 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21530 register Lisp_Object tail
, prev
;
21531 register Lisp_Object tem
;
21535 while (CONSP (tail
))
21541 /* Splice out the link TAIL. */
21543 list
= XCDR (tail
);
21545 Fsetcdr (prev
, XCDR (tail
));
21547 /* Now make it the first. */
21548 Fsetcdr (tail
, list
);
21553 tail
= XCDR (tail
);
21557 /* Not found--return unchanged LIST. */
21561 /* Contribute ELT to the mode line for window IT->w. How it
21562 translates into text depends on its data type.
21564 IT describes the display environment in which we display, as usual.
21566 DEPTH is the depth in recursion. It is used to prevent
21567 infinite recursion here.
21569 FIELD_WIDTH is the number of characters the display of ELT should
21570 occupy in the mode line, and PRECISION is the maximum number of
21571 characters to display from ELT's representation. See
21572 display_string for details.
21574 Returns the hpos of the end of the text generated by ELT.
21576 PROPS is a property list to add to any string we encounter.
21578 If RISKY is nonzero, remove (disregard) any properties in any string
21579 we encounter, and ignore :eval and :propertize.
21581 The global variable `mode_line_target' determines whether the
21582 output is passed to `store_mode_line_noprop',
21583 `store_mode_line_string', or `display_string'. */
21586 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
21587 Lisp_Object elt
, Lisp_Object props
, int risky
)
21589 int n
= 0, field
, prec
;
21594 elt
= build_string ("*too-deep*");
21598 switch (XTYPE (elt
))
21602 /* A string: output it and check for %-constructs within it. */
21604 ptrdiff_t offset
= 0;
21606 if (SCHARS (elt
) > 0
21607 && (!NILP (props
) || risky
))
21609 Lisp_Object oprops
, aelt
;
21610 oprops
= Ftext_properties_at (make_number (0), elt
);
21612 /* If the starting string's properties are not what
21613 we want, translate the string. Also, if the string
21614 is risky, do that anyway. */
21616 if (NILP (Fequal (props
, oprops
)) || risky
)
21618 /* If the starting string has properties,
21619 merge the specified ones onto the existing ones. */
21620 if (! NILP (oprops
) && !risky
)
21624 oprops
= Fcopy_sequence (oprops
);
21626 while (CONSP (tem
))
21628 oprops
= Fplist_put (oprops
, XCAR (tem
),
21629 XCAR (XCDR (tem
)));
21630 tem
= XCDR (XCDR (tem
));
21635 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
21636 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
21638 /* AELT is what we want. Move it to the front
21639 without consing. */
21641 mode_line_proptrans_alist
21642 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
21648 /* If AELT has the wrong props, it is useless.
21649 so get rid of it. */
21651 mode_line_proptrans_alist
21652 = Fdelq (aelt
, mode_line_proptrans_alist
);
21654 elt
= Fcopy_sequence (elt
);
21655 Fset_text_properties (make_number (0), Flength (elt
),
21657 /* Add this item to mode_line_proptrans_alist. */
21658 mode_line_proptrans_alist
21659 = Fcons (Fcons (elt
, props
),
21660 mode_line_proptrans_alist
);
21661 /* Truncate mode_line_proptrans_alist
21662 to at most 50 elements. */
21663 tem
= Fnthcdr (make_number (50),
21664 mode_line_proptrans_alist
);
21666 XSETCDR (tem
, Qnil
);
21675 prec
= precision
- n
;
21676 switch (mode_line_target
)
21678 case MODE_LINE_NOPROP
:
21679 case MODE_LINE_TITLE
:
21680 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
21682 case MODE_LINE_STRING
:
21683 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
21685 case MODE_LINE_DISPLAY
:
21686 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
21687 0, prec
, 0, STRING_MULTIBYTE (elt
));
21694 /* Handle the non-literal case. */
21696 while ((precision
<= 0 || n
< precision
)
21697 && SREF (elt
, offset
) != 0
21698 && (mode_line_target
!= MODE_LINE_DISPLAY
21699 || it
->current_x
< it
->last_visible_x
))
21701 ptrdiff_t last_offset
= offset
;
21703 /* Advance to end of string or next format specifier. */
21704 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
21707 if (offset
- 1 != last_offset
)
21709 ptrdiff_t nchars
, nbytes
;
21711 /* Output to end of string or up to '%'. Field width
21712 is length of string. Don't output more than
21713 PRECISION allows us. */
21716 prec
= c_string_width (SDATA (elt
) + last_offset
,
21717 offset
- last_offset
, precision
- n
,
21720 switch (mode_line_target
)
21722 case MODE_LINE_NOPROP
:
21723 case MODE_LINE_TITLE
:
21724 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
21726 case MODE_LINE_STRING
:
21728 ptrdiff_t bytepos
= last_offset
;
21729 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21730 ptrdiff_t endpos
= (precision
<= 0
21731 ? string_byte_to_char (elt
, offset
)
21732 : charpos
+ nchars
);
21734 n
+= store_mode_line_string (NULL
,
21735 Fsubstring (elt
, make_number (charpos
),
21736 make_number (endpos
)),
21740 case MODE_LINE_DISPLAY
:
21742 ptrdiff_t bytepos
= last_offset
;
21743 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
21745 if (precision
<= 0)
21746 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
21747 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
21749 STRING_MULTIBYTE (elt
));
21754 else /* c == '%' */
21756 ptrdiff_t percent_position
= offset
;
21758 /* Get the specified minimum width. Zero means
21761 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
21762 field
= field
* 10 + c
- '0';
21764 /* Don't pad beyond the total padding allowed. */
21765 if (field_width
- n
> 0 && field
> field_width
- n
)
21766 field
= field_width
- n
;
21768 /* Note that either PRECISION <= 0 or N < PRECISION. */
21769 prec
= precision
- n
;
21772 n
+= display_mode_element (it
, depth
, field
, prec
,
21773 Vglobal_mode_string
, props
,
21778 ptrdiff_t bytepos
, charpos
;
21780 Lisp_Object string
;
21782 bytepos
= percent_position
;
21783 charpos
= (STRING_MULTIBYTE (elt
)
21784 ? string_byte_to_char (elt
, bytepos
)
21786 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
21787 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
21789 switch (mode_line_target
)
21791 case MODE_LINE_NOPROP
:
21792 case MODE_LINE_TITLE
:
21793 n
+= store_mode_line_noprop (spec
, field
, prec
);
21795 case MODE_LINE_STRING
:
21797 Lisp_Object tem
= build_string (spec
);
21798 props
= Ftext_properties_at (make_number (charpos
), elt
);
21799 /* Should only keep face property in props */
21800 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
21803 case MODE_LINE_DISPLAY
:
21805 int nglyphs_before
, nwritten
;
21807 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
21808 nwritten
= display_string (spec
, string
, elt
,
21813 /* Assign to the glyphs written above the
21814 string where the `%x' came from, position
21818 struct glyph
*glyph
21819 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
21823 for (i
= 0; i
< nwritten
; ++i
)
21825 glyph
[i
].object
= elt
;
21826 glyph
[i
].charpos
= charpos
;
21843 /* A symbol: process the value of the symbol recursively
21844 as if it appeared here directly. Avoid error if symbol void.
21845 Special case: if value of symbol is a string, output the string
21848 register Lisp_Object tem
;
21850 /* If the variable is not marked as risky to set
21851 then its contents are risky to use. */
21852 if (NILP (Fget (elt
, Qrisky_local_variable
)))
21855 tem
= Fboundp (elt
);
21858 tem
= Fsymbol_value (elt
);
21859 /* If value is a string, output that string literally:
21860 don't check for % within it. */
21864 if (!EQ (tem
, elt
))
21866 /* Give up right away for nil or t. */
21876 register Lisp_Object car
, tem
;
21878 /* A cons cell: five distinct cases.
21879 If first element is :eval or :propertize, do something special.
21880 If first element is a string or a cons, process all the elements
21881 and effectively concatenate them.
21882 If first element is a negative number, truncate displaying cdr to
21883 at most that many characters. If positive, pad (with spaces)
21884 to at least that many characters.
21885 If first element is a symbol, process the cadr or caddr recursively
21886 according to whether the symbol's value is non-nil or nil. */
21888 if (EQ (car
, QCeval
))
21890 /* An element of the form (:eval FORM) means evaluate FORM
21891 and use the result as mode line elements. */
21896 if (CONSP (XCDR (elt
)))
21899 spec
= safe__eval (true, XCAR (XCDR (elt
)));
21900 n
+= display_mode_element (it
, depth
, field_width
- n
,
21901 precision
- n
, spec
, props
,
21905 else if (EQ (car
, QCpropertize
))
21907 /* An element of the form (:propertize ELT PROPS...)
21908 means display ELT but applying properties PROPS. */
21913 if (CONSP (XCDR (elt
)))
21914 n
+= display_mode_element (it
, depth
, field_width
- n
,
21915 precision
- n
, XCAR (XCDR (elt
)),
21916 XCDR (XCDR (elt
)), risky
);
21918 else if (SYMBOLP (car
))
21920 tem
= Fboundp (car
);
21924 /* elt is now the cdr, and we know it is a cons cell.
21925 Use its car if CAR has a non-nil value. */
21928 tem
= Fsymbol_value (car
);
21935 /* Symbol's value is nil (or symbol is unbound)
21936 Get the cddr of the original list
21937 and if possible find the caddr and use that. */
21941 else if (!CONSP (elt
))
21946 else if (INTEGERP (car
))
21948 register int lim
= XINT (car
);
21952 /* Negative int means reduce maximum width. */
21953 if (precision
<= 0)
21956 precision
= min (precision
, -lim
);
21960 /* Padding specified. Don't let it be more than
21961 current maximum. */
21963 lim
= min (precision
, lim
);
21965 /* If that's more padding than already wanted, queue it.
21966 But don't reduce padding already specified even if
21967 that is beyond the current truncation point. */
21968 field_width
= max (lim
, field_width
);
21972 else if (STRINGP (car
) || CONSP (car
))
21974 Lisp_Object halftail
= elt
;
21978 && (precision
<= 0 || n
< precision
))
21980 n
+= display_mode_element (it
, depth
,
21981 /* Do padding only after the last
21982 element in the list. */
21983 (! CONSP (XCDR (elt
))
21986 precision
- n
, XCAR (elt
),
21990 if ((len
& 1) == 0)
21991 halftail
= XCDR (halftail
);
21992 /* Check for cycle. */
21993 if (EQ (halftail
, elt
))
22002 elt
= build_string ("*invalid*");
22006 /* Pad to FIELD_WIDTH. */
22007 if (field_width
> 0 && n
< field_width
)
22009 switch (mode_line_target
)
22011 case MODE_LINE_NOPROP
:
22012 case MODE_LINE_TITLE
:
22013 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22015 case MODE_LINE_STRING
:
22016 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22018 case MODE_LINE_DISPLAY
:
22019 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22028 /* Store a mode-line string element in mode_line_string_list.
22030 If STRING is non-null, display that C string. Otherwise, the Lisp
22031 string LISP_STRING is displayed.
22033 FIELD_WIDTH is the minimum number of output glyphs to produce.
22034 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22035 with spaces. FIELD_WIDTH <= 0 means don't pad.
22037 PRECISION is the maximum number of characters to output from
22038 STRING. PRECISION <= 0 means don't truncate the string.
22040 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22041 properties to the string.
22043 PROPS are the properties to add to the string.
22044 The mode_line_string_face face property is always added to the string.
22048 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22049 int field_width
, int precision
, Lisp_Object props
)
22054 if (string
!= NULL
)
22056 len
= strlen (string
);
22057 if (precision
> 0 && len
> precision
)
22059 lisp_string
= make_string (string
, len
);
22061 props
= mode_line_string_face_prop
;
22062 else if (!NILP (mode_line_string_face
))
22064 Lisp_Object face
= Fplist_get (props
, Qface
);
22065 props
= Fcopy_sequence (props
);
22067 face
= mode_line_string_face
;
22069 face
= list2 (face
, mode_line_string_face
);
22070 props
= Fplist_put (props
, Qface
, face
);
22072 Fadd_text_properties (make_number (0), make_number (len
),
22073 props
, lisp_string
);
22077 len
= XFASTINT (Flength (lisp_string
));
22078 if (precision
> 0 && len
> precision
)
22081 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22084 if (!NILP (mode_line_string_face
))
22088 props
= Ftext_properties_at (make_number (0), lisp_string
);
22089 face
= Fplist_get (props
, Qface
);
22091 face
= mode_line_string_face
;
22093 face
= list2 (face
, mode_line_string_face
);
22094 props
= list2 (Qface
, face
);
22096 lisp_string
= Fcopy_sequence (lisp_string
);
22099 Fadd_text_properties (make_number (0), make_number (len
),
22100 props
, lisp_string
);
22105 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22109 if (field_width
> len
)
22111 field_width
-= len
;
22112 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22114 Fadd_text_properties (make_number (0), make_number (field_width
),
22115 props
, lisp_string
);
22116 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22124 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22126 doc
: /* Format a string out of a mode line format specification.
22127 First arg FORMAT specifies the mode line format (see `mode-line-format'
22128 for details) to use.
22130 By default, the format is evaluated for the currently selected window.
22132 Optional second arg FACE specifies the face property to put on all
22133 characters for which no face is specified. The value nil means the
22134 default face. The value t means whatever face the window's mode line
22135 currently uses (either `mode-line' or `mode-line-inactive',
22136 depending on whether the window is the selected window or not).
22137 An integer value means the value string has no text
22140 Optional third and fourth args WINDOW and BUFFER specify the window
22141 and buffer to use as the context for the formatting (defaults
22142 are the selected window and the WINDOW's buffer). */)
22143 (Lisp_Object format
, Lisp_Object face
,
22144 Lisp_Object window
, Lisp_Object buffer
)
22149 struct buffer
*old_buffer
= NULL
;
22151 int no_props
= INTEGERP (face
);
22154 int string_start
= 0;
22156 w
= decode_any_window (window
);
22157 XSETWINDOW (window
, w
);
22160 buffer
= w
->contents
;
22161 CHECK_BUFFER (buffer
);
22163 /* Make formatting the modeline a non-op when noninteractive, otherwise
22164 there will be problems later caused by a partially initialized frame. */
22165 if (NILP (format
) || noninteractive
) {
22167 return empty_unibyte_string
;
22173 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22174 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22175 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22176 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22177 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22178 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22179 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22182 old_buffer
= current_buffer
;
22184 /* Save things including mode_line_proptrans_alist,
22185 and set that to nil so that we don't alter the outer value. */
22186 record_unwind_protect (unwind_format_mode_line
,
22187 format_mode_line_unwind_data
22188 (XFRAME (WINDOW_FRAME (w
)),
22189 old_buffer
, selected_window
, 1));
22190 mode_line_proptrans_alist
= Qnil
;
22192 Fselect_window (window
, Qt
);
22193 set_buffer_internal_1 (XBUFFER (buffer
));
22195 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22199 mode_line_target
= MODE_LINE_NOPROP
;
22200 mode_line_string_face_prop
= Qnil
;
22201 mode_line_string_list
= Qnil
;
22202 string_start
= MODE_LINE_NOPROP_LEN (0);
22206 mode_line_target
= MODE_LINE_STRING
;
22207 mode_line_string_list
= Qnil
;
22208 mode_line_string_face
= face
;
22209 mode_line_string_face_prop
22210 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22213 push_kboard (FRAME_KBOARD (it
.f
));
22214 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22219 len
= MODE_LINE_NOPROP_LEN (string_start
);
22220 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22224 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22225 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22226 empty_unibyte_string
);
22233 /* Write a null-terminated, right justified decimal representation of
22234 the positive integer D to BUF using a minimal field width WIDTH. */
22237 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22239 register char *p
= buf
;
22247 *p
++ = d
% 10 + '0';
22252 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22263 /* Write a null-terminated, right justified decimal and "human
22264 readable" representation of the nonnegative integer D to BUF using
22265 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22267 static const char power_letter
[] =
22281 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22283 /* We aim to represent the nonnegative integer D as
22284 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22285 ptrdiff_t quotient
= d
;
22287 /* -1 means: do not use TENTHS. */
22291 /* Length of QUOTIENT.TENTHS as a string. */
22297 if (quotient
>= 1000)
22299 /* Scale to the appropriate EXPONENT. */
22302 remainder
= quotient
% 1000;
22306 while (quotient
>= 1000);
22308 /* Round to nearest and decide whether to use TENTHS or not. */
22311 tenths
= remainder
/ 100;
22312 if (remainder
% 100 >= 50)
22319 if (quotient
== 10)
22327 if (remainder
>= 500)
22329 if (quotient
< 999)
22340 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22341 if (tenths
== -1 && quotient
<= 99)
22348 p
= psuffix
= buf
+ max (width
, length
);
22350 /* Print EXPONENT. */
22351 *psuffix
++ = power_letter
[exponent
];
22354 /* Print TENTHS. */
22357 *--p
= '0' + tenths
;
22361 /* Print QUOTIENT. */
22364 int digit
= quotient
% 10;
22365 *--p
= '0' + digit
;
22367 while ((quotient
/= 10) != 0);
22369 /* Print leading spaces. */
22374 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22375 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22376 type of CODING_SYSTEM. Return updated pointer into BUF. */
22378 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22381 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22384 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22385 const unsigned char *eol_str
;
22387 /* The EOL conversion we are using. */
22388 Lisp_Object eoltype
;
22390 val
= CODING_SYSTEM_SPEC (coding_system
);
22393 if (!VECTORP (val
)) /* Not yet decided. */
22395 *buf
++ = multibyte
? '-' : ' ';
22397 eoltype
= eol_mnemonic_undecided
;
22398 /* Don't mention EOL conversion if it isn't decided. */
22403 Lisp_Object eolvalue
;
22405 attrs
= AREF (val
, 0);
22406 eolvalue
= AREF (val
, 2);
22409 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22414 /* The EOL conversion that is normal on this system. */
22416 if (NILP (eolvalue
)) /* Not yet decided. */
22417 eoltype
= eol_mnemonic_undecided
;
22418 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22419 eoltype
= eol_mnemonic_undecided
;
22420 else /* eolvalue is Qunix, Qdos, or Qmac. */
22421 eoltype
= (EQ (eolvalue
, Qunix
)
22422 ? eol_mnemonic_unix
22423 : (EQ (eolvalue
, Qdos
) == 1
22424 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22430 /* Mention the EOL conversion if it is not the usual one. */
22431 if (STRINGP (eoltype
))
22433 eol_str
= SDATA (eoltype
);
22434 eol_str_len
= SBYTES (eoltype
);
22436 else if (CHARACTERP (eoltype
))
22438 unsigned char *tmp
= alloca (MAX_MULTIBYTE_LENGTH
);
22439 int c
= XFASTINT (eoltype
);
22440 eol_str_len
= CHAR_STRING (c
, tmp
);
22445 eol_str
= invalid_eol_type
;
22446 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22448 memcpy (buf
, eol_str
, eol_str_len
);
22449 buf
+= eol_str_len
;
22455 /* Return a string for the output of a mode line %-spec for window W,
22456 generated by character C. FIELD_WIDTH > 0 means pad the string
22457 returned with spaces to that value. Return a Lisp string in
22458 *STRING if the resulting string is taken from that Lisp string.
22460 Note we operate on the current buffer for most purposes. */
22462 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22464 static const char *
22465 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22466 Lisp_Object
*string
)
22469 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22470 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22471 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22472 produce strings from numerical values, so limit preposterously
22473 large values of FIELD_WIDTH to avoid overrunning the buffer's
22474 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22475 bytes plus the terminating null. */
22476 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22477 struct buffer
*b
= current_buffer
;
22485 if (!NILP (BVAR (b
, read_only
)))
22487 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22492 /* This differs from %* only for a modified read-only buffer. */
22493 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22495 if (!NILP (BVAR (b
, read_only
)))
22500 /* This differs from %* in ignoring read-only-ness. */
22501 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22513 if (command_loop_level
> 5)
22515 p
= decode_mode_spec_buf
;
22516 for (i
= 0; i
< command_loop_level
; i
++)
22519 return decode_mode_spec_buf
;
22527 if (command_loop_level
> 5)
22529 p
= decode_mode_spec_buf
;
22530 for (i
= 0; i
< command_loop_level
; i
++)
22533 return decode_mode_spec_buf
;
22540 /* Let lots_of_dashes be a string of infinite length. */
22541 if (mode_line_target
== MODE_LINE_NOPROP
22542 || mode_line_target
== MODE_LINE_STRING
)
22544 if (field_width
<= 0
22545 || field_width
> sizeof (lots_of_dashes
))
22547 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22548 decode_mode_spec_buf
[i
] = '-';
22549 decode_mode_spec_buf
[i
] = '\0';
22550 return decode_mode_spec_buf
;
22553 return lots_of_dashes
;
22557 obj
= BVAR (b
, name
);
22561 /* %c and %l are ignored in `frame-title-format'.
22562 (In redisplay_internal, the frame title is drawn _before_ the
22563 windows are updated, so the stuff which depends on actual
22564 window contents (such as %l) may fail to render properly, or
22565 even crash emacs.) */
22566 if (mode_line_target
== MODE_LINE_TITLE
)
22570 ptrdiff_t col
= current_column ();
22571 w
->column_number_displayed
= col
;
22572 pint2str (decode_mode_spec_buf
, width
, col
);
22573 return decode_mode_spec_buf
;
22577 #ifndef SYSTEM_MALLOC
22579 if (NILP (Vmemory_full
))
22582 return "!MEM FULL! ";
22589 /* %F displays the frame name. */
22590 if (!NILP (f
->title
))
22591 return SSDATA (f
->title
);
22592 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
22593 return SSDATA (f
->name
);
22597 obj
= BVAR (b
, filename
);
22602 ptrdiff_t size
= ZV
- BEGV
;
22603 pint2str (decode_mode_spec_buf
, width
, size
);
22604 return decode_mode_spec_buf
;
22609 ptrdiff_t size
= ZV
- BEGV
;
22610 pint2hrstr (decode_mode_spec_buf
, width
, size
);
22611 return decode_mode_spec_buf
;
22616 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
22617 ptrdiff_t topline
, nlines
, height
;
22620 /* %c and %l are ignored in `frame-title-format'. */
22621 if (mode_line_target
== MODE_LINE_TITLE
)
22624 startpos
= marker_position (w
->start
);
22625 startpos_byte
= marker_byte_position (w
->start
);
22626 height
= WINDOW_TOTAL_LINES (w
);
22628 /* If we decided that this buffer isn't suitable for line numbers,
22629 don't forget that too fast. */
22630 if (w
->base_line_pos
== -1)
22633 /* If the buffer is very big, don't waste time. */
22634 if (INTEGERP (Vline_number_display_limit
)
22635 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
22637 w
->base_line_pos
= 0;
22638 w
->base_line_number
= 0;
22642 if (w
->base_line_number
> 0
22643 && w
->base_line_pos
> 0
22644 && w
->base_line_pos
<= startpos
)
22646 line
= w
->base_line_number
;
22647 linepos
= w
->base_line_pos
;
22648 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
22653 linepos
= BUF_BEGV (b
);
22654 linepos_byte
= BUF_BEGV_BYTE (b
);
22657 /* Count lines from base line to window start position. */
22658 nlines
= display_count_lines (linepos_byte
,
22662 topline
= nlines
+ line
;
22664 /* Determine a new base line, if the old one is too close
22665 or too far away, or if we did not have one.
22666 "Too close" means it's plausible a scroll-down would
22667 go back past it. */
22668 if (startpos
== BUF_BEGV (b
))
22670 w
->base_line_number
= topline
;
22671 w
->base_line_pos
= BUF_BEGV (b
);
22673 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
22674 || linepos
== BUF_BEGV (b
))
22676 ptrdiff_t limit
= BUF_BEGV (b
);
22677 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
22678 ptrdiff_t position
;
22679 ptrdiff_t distance
=
22680 (height
* 2 + 30) * line_number_display_limit_width
;
22682 if (startpos
- distance
> limit
)
22684 limit
= startpos
- distance
;
22685 limit_byte
= CHAR_TO_BYTE (limit
);
22688 nlines
= display_count_lines (startpos_byte
,
22690 - (height
* 2 + 30),
22692 /* If we couldn't find the lines we wanted within
22693 line_number_display_limit_width chars per line,
22694 give up on line numbers for this window. */
22695 if (position
== limit_byte
&& limit
== startpos
- distance
)
22697 w
->base_line_pos
= -1;
22698 w
->base_line_number
= 0;
22702 w
->base_line_number
= topline
- nlines
;
22703 w
->base_line_pos
= BYTE_TO_CHAR (position
);
22706 /* Now count lines from the start pos to point. */
22707 nlines
= display_count_lines (startpos_byte
,
22708 PT_BYTE
, PT
, &junk
);
22710 /* Record that we did display the line number. */
22711 line_number_displayed
= 1;
22713 /* Make the string to show. */
22714 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
22715 return decode_mode_spec_buf
;
22718 char *p
= decode_mode_spec_buf
;
22719 int pad
= width
- 2;
22725 return decode_mode_spec_buf
;
22731 obj
= BVAR (b
, mode_name
);
22735 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
22741 ptrdiff_t pos
= marker_position (w
->start
);
22742 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22744 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
22746 if (pos
<= BUF_BEGV (b
))
22751 else if (pos
<= BUF_BEGV (b
))
22755 if (total
> 1000000)
22756 /* Do it differently for a large value, to avoid overflow. */
22757 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22759 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22760 /* We can't normally display a 3-digit number,
22761 so get us a 2-digit number that is close. */
22764 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22765 return decode_mode_spec_buf
;
22769 /* Display percentage of size above the bottom of the screen. */
22772 ptrdiff_t toppos
= marker_position (w
->start
);
22773 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
22774 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
22776 if (botpos
>= BUF_ZV (b
))
22778 if (toppos
<= BUF_BEGV (b
))
22785 if (total
> 1000000)
22786 /* Do it differently for a large value, to avoid overflow. */
22787 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
22789 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
22790 /* We can't normally display a 3-digit number,
22791 so get us a 2-digit number that is close. */
22794 if (toppos
<= BUF_BEGV (b
))
22795 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
22797 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
22798 return decode_mode_spec_buf
;
22803 /* status of process */
22804 obj
= Fget_buffer_process (Fcurrent_buffer ());
22806 return "no process";
22808 obj
= Fsymbol_name (Fprocess_status (obj
));
22814 Lisp_Object val
= call1 (intern ("file-remote-p"),
22815 BVAR (current_buffer
, directory
));
22824 /* coding-system (not including end-of-line format) */
22826 /* coding-system (including end-of-line type) */
22828 int eol_flag
= (c
== 'Z');
22829 char *p
= decode_mode_spec_buf
;
22831 if (! FRAME_WINDOW_P (f
))
22833 /* No need to mention EOL here--the terminal never needs
22834 to do EOL conversion. */
22835 p
= decode_mode_spec_coding (CODING_ID_NAME
22836 (FRAME_KEYBOARD_CODING (f
)->id
),
22838 p
= decode_mode_spec_coding (CODING_ID_NAME
22839 (FRAME_TERMINAL_CODING (f
)->id
),
22842 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
22845 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
22846 #ifdef subprocesses
22847 obj
= Fget_buffer_process (Fcurrent_buffer ());
22848 if (PROCESSP (obj
))
22850 p
= decode_mode_spec_coding
22851 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
22852 p
= decode_mode_spec_coding
22853 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
22855 #endif /* subprocesses */
22858 return decode_mode_spec_buf
;
22865 return SSDATA (obj
);
22872 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
22873 means count lines back from START_BYTE. But don't go beyond
22874 LIMIT_BYTE. Return the number of lines thus found (always
22877 Set *BYTE_POS_PTR to the byte position where we stopped. This is
22878 either the position COUNT lines after/before START_BYTE, if we
22879 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
22883 display_count_lines (ptrdiff_t start_byte
,
22884 ptrdiff_t limit_byte
, ptrdiff_t count
,
22885 ptrdiff_t *byte_pos_ptr
)
22887 register unsigned char *cursor
;
22888 unsigned char *base
;
22890 register ptrdiff_t ceiling
;
22891 register unsigned char *ceiling_addr
;
22892 ptrdiff_t orig_count
= count
;
22894 /* If we are not in selective display mode,
22895 check only for newlines. */
22896 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
22897 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
22901 while (start_byte
< limit_byte
)
22903 ceiling
= BUFFER_CEILING_OF (start_byte
);
22904 ceiling
= min (limit_byte
- 1, ceiling
);
22905 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
22906 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
22910 if (selective_display
)
22912 while (*cursor
!= '\n' && *cursor
!= 015
22913 && ++cursor
!= ceiling_addr
)
22915 if (cursor
== ceiling_addr
)
22920 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
22929 start_byte
+= cursor
- base
;
22930 *byte_pos_ptr
= start_byte
;
22934 while (cursor
< ceiling_addr
);
22936 start_byte
+= ceiling_addr
- base
;
22941 while (start_byte
> limit_byte
)
22943 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
22944 ceiling
= max (limit_byte
, ceiling
);
22945 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
22946 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
22949 if (selective_display
)
22951 while (--cursor
>= ceiling_addr
22952 && *cursor
!= '\n' && *cursor
!= 015)
22954 if (cursor
< ceiling_addr
)
22959 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
22966 start_byte
+= cursor
- base
+ 1;
22967 *byte_pos_ptr
= start_byte
;
22968 /* When scanning backwards, we should
22969 not count the newline posterior to which we stop. */
22970 return - orig_count
- 1;
22973 start_byte
+= ceiling_addr
- base
;
22977 *byte_pos_ptr
= limit_byte
;
22980 return - orig_count
+ count
;
22981 return orig_count
- count
;
22987 /***********************************************************************
22989 ***********************************************************************/
22991 /* Display a NUL-terminated string, starting with index START.
22993 If STRING is non-null, display that C string. Otherwise, the Lisp
22994 string LISP_STRING is displayed. There's a case that STRING is
22995 non-null and LISP_STRING is not nil. It means STRING is a string
22996 data of LISP_STRING. In that case, we display LISP_STRING while
22997 ignoring its text properties.
22999 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23000 FACE_STRING. Display STRING or LISP_STRING with the face at
23001 FACE_STRING_POS in FACE_STRING:
23003 Display the string in the environment given by IT, but use the
23004 standard display table, temporarily.
23006 FIELD_WIDTH is the minimum number of output glyphs to produce.
23007 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23008 with spaces. If STRING has more characters, more than FIELD_WIDTH
23009 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23011 PRECISION is the maximum number of characters to output from
23012 STRING. PRECISION < 0 means don't truncate the string.
23014 This is roughly equivalent to printf format specifiers:
23016 FIELD_WIDTH PRECISION PRINTF
23017 ----------------------------------------
23023 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23024 display them, and < 0 means obey the current buffer's value of
23025 enable_multibyte_characters.
23027 Value is the number of columns displayed. */
23030 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23031 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23032 int field_width
, int precision
, int max_x
, int multibyte
)
23034 int hpos_at_start
= it
->hpos
;
23035 int saved_face_id
= it
->face_id
;
23036 struct glyph_row
*row
= it
->glyph_row
;
23037 ptrdiff_t it_charpos
;
23039 /* Initialize the iterator IT for iteration over STRING beginning
23040 with index START. */
23041 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23042 precision
, field_width
, multibyte
);
23043 if (string
&& STRINGP (lisp_string
))
23044 /* LISP_STRING is the one returned by decode_mode_spec. We should
23045 ignore its text properties. */
23046 it
->stop_charpos
= it
->end_charpos
;
23048 /* If displaying STRING, set up the face of the iterator from
23049 FACE_STRING, if that's given. */
23050 if (STRINGP (face_string
))
23056 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23057 0, &endptr
, it
->base_face_id
, 0);
23058 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23059 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23062 /* Set max_x to the maximum allowed X position. Don't let it go
23063 beyond the right edge of the window. */
23065 max_x
= it
->last_visible_x
;
23067 max_x
= min (max_x
, it
->last_visible_x
);
23069 /* Skip over display elements that are not visible. because IT->w is
23071 if (it
->current_x
< it
->first_visible_x
)
23072 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23073 MOVE_TO_POS
| MOVE_TO_X
);
23075 row
->ascent
= it
->max_ascent
;
23076 row
->height
= it
->max_ascent
+ it
->max_descent
;
23077 row
->phys_ascent
= it
->max_phys_ascent
;
23078 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23079 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23081 if (STRINGP (it
->string
))
23082 it_charpos
= IT_STRING_CHARPOS (*it
);
23084 it_charpos
= IT_CHARPOS (*it
);
23086 /* This condition is for the case that we are called with current_x
23087 past last_visible_x. */
23088 while (it
->current_x
< max_x
)
23090 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23092 /* Get the next display element. */
23093 if (!get_next_display_element (it
))
23096 /* Produce glyphs. */
23097 x_before
= it
->current_x
;
23098 n_glyphs_before
= row
->used
[TEXT_AREA
];
23099 PRODUCE_GLYPHS (it
);
23101 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23104 while (i
< nglyphs
)
23106 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23108 if (it
->line_wrap
!= TRUNCATE
23109 && x
+ glyph
->pixel_width
> max_x
)
23111 /* End of continued line or max_x reached. */
23112 if (CHAR_GLYPH_PADDING_P (*glyph
))
23114 /* A wide character is unbreakable. */
23115 if (row
->reversed_p
)
23116 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23117 - n_glyphs_before
);
23118 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23119 it
->current_x
= x_before
;
23123 if (row
->reversed_p
)
23124 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23125 - (n_glyphs_before
+ i
));
23126 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23131 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23133 /* Glyph is at least partially visible. */
23135 if (x
< it
->first_visible_x
)
23136 row
->x
= x
- it
->first_visible_x
;
23140 /* Glyph is off the left margin of the display area.
23141 Should not happen. */
23145 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23146 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23147 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23148 row
->phys_height
= max (row
->phys_height
,
23149 it
->max_phys_ascent
+ it
->max_phys_descent
);
23150 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23151 it
->max_extra_line_spacing
);
23152 x
+= glyph
->pixel_width
;
23156 /* Stop if max_x reached. */
23160 /* Stop at line ends. */
23161 if (ITERATOR_AT_END_OF_LINE_P (it
))
23163 it
->continuation_lines_width
= 0;
23167 set_iterator_to_next (it
, 1);
23168 if (STRINGP (it
->string
))
23169 it_charpos
= IT_STRING_CHARPOS (*it
);
23171 it_charpos
= IT_CHARPOS (*it
);
23173 /* Stop if truncating at the right edge. */
23174 if (it
->line_wrap
== TRUNCATE
23175 && it
->current_x
>= it
->last_visible_x
)
23177 /* Add truncation mark, but don't do it if the line is
23178 truncated at a padding space. */
23179 if (it_charpos
< it
->string_nchars
)
23181 if (!FRAME_WINDOW_P (it
->f
))
23185 if (it
->current_x
> it
->last_visible_x
)
23187 if (!row
->reversed_p
)
23189 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23190 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23195 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23196 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23198 unproduce_glyphs (it
, ii
+ 1);
23199 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23201 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23203 row
->used
[TEXT_AREA
] = ii
;
23204 produce_special_glyphs (it
, IT_TRUNCATION
);
23207 produce_special_glyphs (it
, IT_TRUNCATION
);
23209 row
->truncated_on_right_p
= 1;
23215 /* Maybe insert a truncation at the left. */
23216 if (it
->first_visible_x
23219 if (!FRAME_WINDOW_P (it
->f
)
23220 || (row
->reversed_p
23221 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23222 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23223 insert_left_trunc_glyphs (it
);
23224 row
->truncated_on_left_p
= 1;
23227 it
->face_id
= saved_face_id
;
23229 /* Value is number of columns displayed. */
23230 return it
->hpos
- hpos_at_start
;
23235 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23236 appears as an element of LIST or as the car of an element of LIST.
23237 If PROPVAL is a list, compare each element against LIST in that
23238 way, and return 1/2 if any element of PROPVAL is found in LIST.
23239 Otherwise return 0. This function cannot quit.
23240 The return value is 2 if the text is invisible but with an ellipsis
23241 and 1 if it's invisible and without an ellipsis. */
23244 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23246 register Lisp_Object tail
, proptail
;
23248 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23250 register Lisp_Object tem
;
23252 if (EQ (propval
, tem
))
23254 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23255 return NILP (XCDR (tem
)) ? 1 : 2;
23258 if (CONSP (propval
))
23260 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23262 Lisp_Object propelt
;
23263 propelt
= XCAR (proptail
);
23264 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23266 register Lisp_Object tem
;
23268 if (EQ (propelt
, tem
))
23270 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23271 return NILP (XCDR (tem
)) ? 1 : 2;
23279 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23280 doc
: /* Non-nil if the property makes the text invisible.
23281 POS-OR-PROP can be a marker or number, in which case it is taken to be
23282 a position in the current buffer and the value of the `invisible' property
23283 is checked; or it can be some other value, which is then presumed to be the
23284 value of the `invisible' property of the text of interest.
23285 The non-nil value returned can be t for truly invisible text or something
23286 else if the text is replaced by an ellipsis. */)
23287 (Lisp_Object pos_or_prop
)
23290 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23291 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23293 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23294 return (invis
== 0 ? Qnil
23296 : make_number (invis
));
23299 /* Calculate a width or height in pixels from a specification using
23300 the following elements:
23303 NUM - a (fractional) multiple of the default font width/height
23304 (NUM) - specifies exactly NUM pixels
23305 UNIT - a fixed number of pixels, see below.
23306 ELEMENT - size of a display element in pixels, see below.
23307 (NUM . SPEC) - equals NUM * SPEC
23308 (+ SPEC SPEC ...) - add pixel values
23309 (- SPEC SPEC ...) - subtract pixel values
23310 (- SPEC) - negate pixel value
23313 INT or FLOAT - a number constant
23314 SYMBOL - use symbol's (buffer local) variable binding.
23317 in - pixels per inch *)
23318 mm - pixels per 1/1000 meter *)
23319 cm - pixels per 1/100 meter *)
23320 width - width of current font in pixels.
23321 height - height of current font in pixels.
23323 *) using the ratio(s) defined in display-pixels-per-inch.
23327 left-fringe - left fringe width in pixels
23328 right-fringe - right fringe width in pixels
23330 left-margin - left margin width in pixels
23331 right-margin - right margin width in pixels
23333 scroll-bar - scroll-bar area width in pixels
23337 Pixels corresponding to 5 inches:
23340 Total width of non-text areas on left side of window (if scroll-bar is on left):
23341 '(space :width (+ left-fringe left-margin scroll-bar))
23343 Align to first text column (in header line):
23344 '(space :align-to 0)
23346 Align to middle of text area minus half the width of variable `my-image'
23347 containing a loaded image:
23348 '(space :align-to (0.5 . (- text my-image)))
23350 Width of left margin minus width of 1 character in the default font:
23351 '(space :width (- left-margin 1))
23353 Width of left margin minus width of 2 characters in the current font:
23354 '(space :width (- left-margin (2 . width)))
23356 Center 1 character over left-margin (in header line):
23357 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23359 Different ways to express width of left fringe plus left margin minus one pixel:
23360 '(space :width (- (+ left-fringe left-margin) (1)))
23361 '(space :width (+ left-fringe left-margin (- (1))))
23362 '(space :width (+ left-fringe left-margin (-1)))
23367 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23368 struct font
*font
, int width_p
, int *align_to
)
23372 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23373 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23376 return OK_PIXELS (0);
23378 eassert (FRAME_LIVE_P (it
->f
));
23380 if (SYMBOLP (prop
))
23382 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23384 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23386 if (unit
[0] == 'i' && unit
[1] == 'n')
23388 else if (unit
[0] == 'm' && unit
[1] == 'm')
23390 else if (unit
[0] == 'c' && unit
[1] == 'm')
23396 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23397 : FRAME_RES_Y (it
->f
));
23400 return OK_PIXELS (ppi
/ pixels
);
23405 #ifdef HAVE_WINDOW_SYSTEM
23406 if (EQ (prop
, Qheight
))
23407 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23408 if (EQ (prop
, Qwidth
))
23409 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23411 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23412 return OK_PIXELS (1);
23415 if (EQ (prop
, Qtext
))
23416 return OK_PIXELS (width_p
23417 ? window_box_width (it
->w
, TEXT_AREA
)
23418 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23420 if (align_to
&& *align_to
< 0)
23423 if (EQ (prop
, Qleft
))
23424 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23425 if (EQ (prop
, Qright
))
23426 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23427 if (EQ (prop
, Qcenter
))
23428 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23429 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23430 if (EQ (prop
, Qleft_fringe
))
23431 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23432 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23433 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23434 if (EQ (prop
, Qright_fringe
))
23435 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23436 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23437 : window_box_right_offset (it
->w
, TEXT_AREA
));
23438 if (EQ (prop
, Qleft_margin
))
23439 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23440 if (EQ (prop
, Qright_margin
))
23441 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23442 if (EQ (prop
, Qscroll_bar
))
23443 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23445 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23446 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23447 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23452 if (EQ (prop
, Qleft_fringe
))
23453 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23454 if (EQ (prop
, Qright_fringe
))
23455 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23456 if (EQ (prop
, Qleft_margin
))
23457 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23458 if (EQ (prop
, Qright_margin
))
23459 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23460 if (EQ (prop
, Qscroll_bar
))
23461 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23464 prop
= buffer_local_value (prop
, it
->w
->contents
);
23465 if (EQ (prop
, Qunbound
))
23469 if (INTEGERP (prop
) || FLOATP (prop
))
23471 int base_unit
= (width_p
23472 ? FRAME_COLUMN_WIDTH (it
->f
)
23473 : FRAME_LINE_HEIGHT (it
->f
));
23474 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23479 Lisp_Object car
= XCAR (prop
);
23480 Lisp_Object cdr
= XCDR (prop
);
23484 #ifdef HAVE_WINDOW_SYSTEM
23485 if (FRAME_WINDOW_P (it
->f
)
23486 && valid_image_p (prop
))
23488 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23489 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23491 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23494 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23500 while (CONSP (cdr
))
23502 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23503 font
, width_p
, align_to
))
23506 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23511 if (EQ (car
, Qminus
))
23513 return OK_PIXELS (pixels
);
23516 car
= buffer_local_value (car
, it
->w
->contents
);
23517 if (EQ (car
, Qunbound
))
23521 if (INTEGERP (car
) || FLOATP (car
))
23524 pixels
= XFLOATINT (car
);
23526 return OK_PIXELS (pixels
);
23527 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23528 font
, width_p
, align_to
))
23529 return OK_PIXELS (pixels
* fact
);
23540 /***********************************************************************
23542 ***********************************************************************/
23544 #ifdef HAVE_WINDOW_SYSTEM
23549 dump_glyph_string (struct glyph_string
*s
)
23551 fprintf (stderr
, "glyph string\n");
23552 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
23553 s
->x
, s
->y
, s
->width
, s
->height
);
23554 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
23555 fprintf (stderr
, " hl = %d\n", s
->hl
);
23556 fprintf (stderr
, " left overhang = %d, right = %d\n",
23557 s
->left_overhang
, s
->right_overhang
);
23558 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
23559 fprintf (stderr
, " extends to end of line = %d\n",
23560 s
->extends_to_end_of_line_p
);
23561 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
23562 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
23565 #endif /* GLYPH_DEBUG */
23567 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
23568 of XChar2b structures for S; it can't be allocated in
23569 init_glyph_string because it must be allocated via `alloca'. W
23570 is the window on which S is drawn. ROW and AREA are the glyph row
23571 and area within the row from which S is constructed. START is the
23572 index of the first glyph structure covered by S. HL is a
23573 face-override for drawing S. */
23576 #define OPTIONAL_HDC(hdc) HDC hdc,
23577 #define DECLARE_HDC(hdc) HDC hdc;
23578 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
23579 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
23582 #ifndef OPTIONAL_HDC
23583 #define OPTIONAL_HDC(hdc)
23584 #define DECLARE_HDC(hdc)
23585 #define ALLOCATE_HDC(hdc, f)
23586 #define RELEASE_HDC(hdc, f)
23590 init_glyph_string (struct glyph_string
*s
,
23592 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
23593 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
23595 memset (s
, 0, sizeof *s
);
23597 s
->f
= XFRAME (w
->frame
);
23601 s
->display
= FRAME_X_DISPLAY (s
->f
);
23602 s
->window
= FRAME_X_WINDOW (s
->f
);
23603 s
->char2b
= char2b
;
23607 s
->first_glyph
= row
->glyphs
[area
] + start
;
23608 s
->height
= row
->height
;
23609 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
23610 s
->ybase
= s
->y
+ row
->ascent
;
23614 /* Append the list of glyph strings with head H and tail T to the list
23615 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
23618 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23619 struct glyph_string
*h
, struct glyph_string
*t
)
23633 /* Prepend the list of glyph strings with head H and tail T to the
23634 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
23638 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
23639 struct glyph_string
*h
, struct glyph_string
*t
)
23653 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
23654 Set *HEAD and *TAIL to the resulting list. */
23657 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
23658 struct glyph_string
*s
)
23660 s
->next
= s
->prev
= NULL
;
23661 append_glyph_string_lists (head
, tail
, s
, s
);
23665 /* Get face and two-byte form of character C in face FACE_ID on frame F.
23666 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
23667 make sure that X resources for the face returned are allocated.
23668 Value is a pointer to a realized face that is ready for display if
23669 DISPLAY_P is non-zero. */
23671 static struct face
*
23672 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
23673 XChar2b
*char2b
, int display_p
)
23675 struct face
*face
= FACE_FROM_ID (f
, face_id
);
23680 code
= face
->font
->driver
->encode_char (face
->font
, c
);
23682 if (code
== FONT_INVALID_CODE
)
23685 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23687 /* Make sure X resources of the face are allocated. */
23688 #ifdef HAVE_X_WINDOWS
23692 eassert (face
!= NULL
);
23693 prepare_face_for_display (f
, face
);
23700 /* Get face and two-byte form of character glyph GLYPH on frame F.
23701 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
23702 a pointer to a realized face that is ready for display. */
23704 static struct face
*
23705 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
23706 XChar2b
*char2b
, int *two_byte_p
)
23711 eassert (glyph
->type
== CHAR_GLYPH
);
23712 face
= FACE_FROM_ID (f
, glyph
->face_id
);
23714 /* Make sure X resources of the face are allocated. */
23715 eassert (face
!= NULL
);
23716 prepare_face_for_display (f
, face
);
23723 if (CHAR_BYTE8_P (glyph
->u
.ch
))
23724 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
23726 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
23728 if (code
== FONT_INVALID_CODE
)
23732 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23737 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
23738 Return 1 if FONT has a glyph for C, otherwise return 0. */
23741 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
23745 if (CHAR_BYTE8_P (c
))
23746 code
= CHAR_TO_BYTE8 (c
);
23748 code
= font
->driver
->encode_char (font
, c
);
23750 if (code
== FONT_INVALID_CODE
)
23752 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
23757 /* Fill glyph string S with composition components specified by S->cmp.
23759 BASE_FACE is the base face of the composition.
23760 S->cmp_from is the index of the first component for S.
23762 OVERLAPS non-zero means S should draw the foreground only, and use
23763 its physical height for clipping. See also draw_glyphs.
23765 Value is the index of a component not in S. */
23768 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
23772 /* For all glyphs of this composition, starting at the offset
23773 S->cmp_from, until we reach the end of the definition or encounter a
23774 glyph that requires the different face, add it to S. */
23779 s
->for_overlaps
= overlaps
;
23782 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
23784 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
23786 /* TAB in a composition means display glyphs with padding space
23787 on the left or right. */
23790 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
23793 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
23800 s
->font
= s
->face
->font
;
23802 else if (s
->face
!= face
)
23810 if (s
->face
== NULL
)
23812 s
->face
= base_face
->ascii_face
;
23813 s
->font
= s
->face
->font
;
23816 /* All glyph strings for the same composition has the same width,
23817 i.e. the width set for the first component of the composition. */
23818 s
->width
= s
->first_glyph
->pixel_width
;
23820 /* If the specified font could not be loaded, use the frame's
23821 default font, but record the fact that we couldn't load it in
23822 the glyph string so that we can draw rectangles for the
23823 characters of the glyph string. */
23824 if (s
->font
== NULL
)
23826 s
->font_not_found_p
= 1;
23827 s
->font
= FRAME_FONT (s
->f
);
23830 /* Adjust base line for subscript/superscript text. */
23831 s
->ybase
+= s
->first_glyph
->voffset
;
23833 /* This glyph string must always be drawn with 16-bit functions. */
23840 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
23841 int start
, int end
, int overlaps
)
23843 struct glyph
*glyph
, *last
;
23844 Lisp_Object lgstring
;
23847 s
->for_overlaps
= overlaps
;
23848 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23849 last
= s
->row
->glyphs
[s
->area
] + end
;
23850 s
->cmp_id
= glyph
->u
.cmp
.id
;
23851 s
->cmp_from
= glyph
->slice
.cmp
.from
;
23852 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
23853 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23854 lgstring
= composition_gstring_from_id (s
->cmp_id
);
23855 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
23857 while (glyph
< last
23858 && glyph
->u
.cmp
.automatic
23859 && glyph
->u
.cmp
.id
== s
->cmp_id
23860 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
23861 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
23863 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
23865 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
23866 unsigned code
= LGLYPH_CODE (lglyph
);
23868 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
23870 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
23871 return glyph
- s
->row
->glyphs
[s
->area
];
23875 /* Fill glyph string S from a sequence glyphs for glyphless characters.
23876 See the comment of fill_glyph_string for arguments.
23877 Value is the index of the first glyph not in S. */
23881 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
23882 int start
, int end
, int overlaps
)
23884 struct glyph
*glyph
, *last
;
23887 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
23888 s
->for_overlaps
= overlaps
;
23889 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23890 last
= s
->row
->glyphs
[s
->area
] + end
;
23891 voffset
= glyph
->voffset
;
23892 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
23893 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
23895 s
->width
= glyph
->pixel_width
;
23897 while (glyph
< last
23898 && glyph
->type
== GLYPHLESS_GLYPH
23899 && glyph
->voffset
== voffset
23900 && glyph
->face_id
== face_id
)
23903 s
->width
+= glyph
->pixel_width
;
23906 s
->ybase
+= voffset
;
23907 return glyph
- s
->row
->glyphs
[s
->area
];
23911 /* Fill glyph string S from a sequence of character glyphs.
23913 FACE_ID is the face id of the string. START is the index of the
23914 first glyph to consider, END is the index of the last + 1.
23915 OVERLAPS non-zero means S should draw the foreground only, and use
23916 its physical height for clipping. See also draw_glyphs.
23918 Value is the index of the first glyph not in S. */
23921 fill_glyph_string (struct glyph_string
*s
, int face_id
,
23922 int start
, int end
, int overlaps
)
23924 struct glyph
*glyph
, *last
;
23926 int glyph_not_available_p
;
23928 eassert (s
->f
== XFRAME (s
->w
->frame
));
23929 eassert (s
->nchars
== 0);
23930 eassert (start
>= 0 && end
> start
);
23932 s
->for_overlaps
= overlaps
;
23933 glyph
= s
->row
->glyphs
[s
->area
] + start
;
23934 last
= s
->row
->glyphs
[s
->area
] + end
;
23935 voffset
= glyph
->voffset
;
23936 s
->padding_p
= glyph
->padding_p
;
23937 glyph_not_available_p
= glyph
->glyph_not_available_p
;
23939 while (glyph
< last
23940 && glyph
->type
== CHAR_GLYPH
23941 && glyph
->voffset
== voffset
23942 /* Same face id implies same font, nowadays. */
23943 && glyph
->face_id
== face_id
23944 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
23948 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
23949 s
->char2b
+ s
->nchars
,
23951 s
->two_byte_p
= two_byte_p
;
23953 eassert (s
->nchars
<= end
- start
);
23954 s
->width
+= glyph
->pixel_width
;
23955 if (glyph
++->padding_p
!= s
->padding_p
)
23959 s
->font
= s
->face
->font
;
23961 /* If the specified font could not be loaded, use the frame's font,
23962 but record the fact that we couldn't load it in
23963 S->font_not_found_p so that we can draw rectangles for the
23964 characters of the glyph string. */
23965 if (s
->font
== NULL
|| glyph_not_available_p
)
23967 s
->font_not_found_p
= 1;
23968 s
->font
= FRAME_FONT (s
->f
);
23971 /* Adjust base line for subscript/superscript text. */
23972 s
->ybase
+= voffset
;
23974 eassert (s
->face
&& s
->face
->gc
);
23975 return glyph
- s
->row
->glyphs
[s
->area
];
23979 /* Fill glyph string S from image glyph S->first_glyph. */
23982 fill_image_glyph_string (struct glyph_string
*s
)
23984 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
23985 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
23987 s
->slice
= s
->first_glyph
->slice
.img
;
23988 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
23989 s
->font
= s
->face
->font
;
23990 s
->width
= s
->first_glyph
->pixel_width
;
23992 /* Adjust base line for subscript/superscript text. */
23993 s
->ybase
+= s
->first_glyph
->voffset
;
23997 /* Fill glyph string S from a sequence of stretch glyphs.
23999 START is the index of the first glyph to consider,
24000 END is the index of the last + 1.
24002 Value is the index of the first glyph not in S. */
24005 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24007 struct glyph
*glyph
, *last
;
24008 int voffset
, face_id
;
24010 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24012 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24013 last
= s
->row
->glyphs
[s
->area
] + end
;
24014 face_id
= glyph
->face_id
;
24015 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24016 s
->font
= s
->face
->font
;
24017 s
->width
= glyph
->pixel_width
;
24019 voffset
= glyph
->voffset
;
24023 && glyph
->type
== STRETCH_GLYPH
24024 && glyph
->voffset
== voffset
24025 && glyph
->face_id
== face_id
);
24027 s
->width
+= glyph
->pixel_width
;
24029 /* Adjust base line for subscript/superscript text. */
24030 s
->ybase
+= voffset
;
24032 /* The case that face->gc == 0 is handled when drawing the glyph
24033 string by calling prepare_face_for_display. */
24035 return glyph
- s
->row
->glyphs
[s
->area
];
24038 static struct font_metrics
*
24039 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24041 static struct font_metrics metrics
;
24046 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24047 if (code
== FONT_INVALID_CODE
)
24049 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24054 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24055 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24056 assumed to be zero. */
24059 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24061 *left
= *right
= 0;
24063 if (glyph
->type
== CHAR_GLYPH
)
24067 struct font_metrics
*pcm
;
24069 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24070 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24072 if (pcm
->rbearing
> pcm
->width
)
24073 *right
= pcm
->rbearing
- pcm
->width
;
24074 if (pcm
->lbearing
< 0)
24075 *left
= -pcm
->lbearing
;
24078 else if (glyph
->type
== COMPOSITE_GLYPH
)
24080 if (! glyph
->u
.cmp
.automatic
)
24082 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24084 if (cmp
->rbearing
> cmp
->pixel_width
)
24085 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24086 if (cmp
->lbearing
< 0)
24087 *left
= - cmp
->lbearing
;
24091 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24092 struct font_metrics metrics
;
24094 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24095 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24096 if (metrics
.rbearing
> metrics
.width
)
24097 *right
= metrics
.rbearing
- metrics
.width
;
24098 if (metrics
.lbearing
< 0)
24099 *left
= - metrics
.lbearing
;
24105 /* Return the index of the first glyph preceding glyph string S that
24106 is overwritten by S because of S's left overhang. Value is -1
24107 if no glyphs are overwritten. */
24110 left_overwritten (struct glyph_string
*s
)
24114 if (s
->left_overhang
)
24117 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24118 int first
= s
->first_glyph
- glyphs
;
24120 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24121 x
-= glyphs
[i
].pixel_width
;
24132 /* Return the index of the first glyph preceding glyph string S that
24133 is overwriting S because of its right overhang. Value is -1 if no
24134 glyph in front of S overwrites S. */
24137 left_overwriting (struct glyph_string
*s
)
24140 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24141 int first
= s
->first_glyph
- glyphs
;
24145 for (i
= first
- 1; i
>= 0; --i
)
24148 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24151 x
-= glyphs
[i
].pixel_width
;
24158 /* Return the index of the last glyph following glyph string S that is
24159 overwritten by S because of S's right overhang. Value is -1 if
24160 no such glyph is found. */
24163 right_overwritten (struct glyph_string
*s
)
24167 if (s
->right_overhang
)
24170 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24171 int first
= (s
->first_glyph
- glyphs
24172 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24173 int end
= s
->row
->used
[s
->area
];
24175 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24176 x
+= glyphs
[i
].pixel_width
;
24185 /* Return the index of the last glyph following glyph string S that
24186 overwrites S because of its left overhang. Value is negative
24187 if no such glyph is found. */
24190 right_overwriting (struct glyph_string
*s
)
24193 int end
= s
->row
->used
[s
->area
];
24194 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24195 int first
= (s
->first_glyph
- glyphs
24196 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24200 for (i
= first
; i
< end
; ++i
)
24203 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24206 x
+= glyphs
[i
].pixel_width
;
24213 /* Set background width of glyph string S. START is the index of the
24214 first glyph following S. LAST_X is the right-most x-position + 1
24215 in the drawing area. */
24218 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24220 /* If the face of this glyph string has to be drawn to the end of
24221 the drawing area, set S->extends_to_end_of_line_p. */
24223 if (start
== s
->row
->used
[s
->area
]
24224 && ((s
->row
->fill_line_p
24225 && (s
->hl
== DRAW_NORMAL_TEXT
24226 || s
->hl
== DRAW_IMAGE_RAISED
24227 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24228 || s
->hl
== DRAW_MOUSE_FACE
))
24229 s
->extends_to_end_of_line_p
= 1;
24231 /* If S extends its face to the end of the line, set its
24232 background_width to the distance to the right edge of the drawing
24234 if (s
->extends_to_end_of_line_p
)
24235 s
->background_width
= last_x
- s
->x
+ 1;
24237 s
->background_width
= s
->width
;
24241 /* Compute overhangs and x-positions for glyph string S and its
24242 predecessors, or successors. X is the starting x-position for S.
24243 BACKWARD_P non-zero means process predecessors. */
24246 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24252 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24253 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24263 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24264 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24274 /* The following macros are only called from draw_glyphs below.
24275 They reference the following parameters of that function directly:
24276 `w', `row', `area', and `overlap_p'
24277 as well as the following local variables:
24278 `s', `f', and `hdc' (in W32) */
24281 /* On W32, silently add local `hdc' variable to argument list of
24282 init_glyph_string. */
24283 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24284 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24286 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24287 init_glyph_string (s, char2b, w, row, area, start, hl)
24290 /* Add a glyph string for a stretch glyph to the list of strings
24291 between HEAD and TAIL. START is the index of the stretch glyph in
24292 row area AREA of glyph row ROW. END is the index of the last glyph
24293 in that glyph row area. X is the current output position assigned
24294 to the new glyph string constructed. HL overrides that face of the
24295 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24296 is the right-most x-position of the drawing area. */
24298 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24299 and below -- keep them on one line. */
24300 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24303 s = alloca (sizeof *s); \
24304 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24305 START = fill_stretch_glyph_string (s, START, END); \
24306 append_glyph_string (&HEAD, &TAIL, s); \
24312 /* Add a glyph string for an image glyph to the list of strings
24313 between HEAD and TAIL. START is the index of the image glyph in
24314 row area AREA of glyph row ROW. END is the index of the last glyph
24315 in that glyph row area. X is the current output position assigned
24316 to the new glyph string constructed. HL overrides that face of the
24317 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24318 is the right-most x-position of the drawing area. */
24320 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24323 s = alloca (sizeof *s); \
24324 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24325 fill_image_glyph_string (s); \
24326 append_glyph_string (&HEAD, &TAIL, s); \
24333 /* Add a glyph string for a sequence of character glyphs to the list
24334 of strings between HEAD and TAIL. START is the index of the first
24335 glyph in row area AREA of glyph row ROW that is part of the new
24336 glyph string. END is the index of the last glyph in that glyph row
24337 area. X is the current output position assigned to the new glyph
24338 string constructed. HL overrides that face of the glyph; e.g. it
24339 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24340 right-most x-position of the drawing area. */
24342 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24348 face_id = (row)->glyphs[area][START].face_id; \
24350 s = alloca (sizeof *s); \
24351 char2b = alloca ((END - START) * sizeof *char2b); \
24352 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24353 append_glyph_string (&HEAD, &TAIL, s); \
24355 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24360 /* Add a glyph string for a composite sequence to the list of strings
24361 between HEAD and TAIL. START is the index of the first glyph in
24362 row area AREA of glyph row ROW that is part of the new glyph
24363 string. END is the index of the last glyph in that glyph row area.
24364 X is the current output position assigned to the new glyph string
24365 constructed. HL overrides that face of the glyph; e.g. it is
24366 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24367 x-position of the drawing area. */
24369 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24371 int face_id = (row)->glyphs[area][START].face_id; \
24372 struct face *base_face = FACE_FROM_ID (f, face_id); \
24373 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24374 struct composition *cmp = composition_table[cmp_id]; \
24376 struct glyph_string *first_s = NULL; \
24379 char2b = alloca (cmp->glyph_len * sizeof *char2b); \
24381 /* Make glyph_strings for each glyph sequence that is drawable by \
24382 the same face, and append them to HEAD/TAIL. */ \
24383 for (n = 0; n < cmp->glyph_len;) \
24385 s = alloca (sizeof *s); \
24386 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24387 append_glyph_string (&(HEAD), &(TAIL), s); \
24393 n = fill_composite_glyph_string (s, base_face, overlaps); \
24401 /* Add a glyph string for a glyph-string sequence to the list of strings
24402 between HEAD and TAIL. */
24404 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24408 Lisp_Object gstring; \
24410 face_id = (row)->glyphs[area][START].face_id; \
24411 gstring = (composition_gstring_from_id \
24412 ((row)->glyphs[area][START].u.cmp.id)); \
24413 s = alloca (sizeof *s); \
24414 char2b = alloca (LGSTRING_GLYPH_LEN (gstring) * sizeof *char2b); \
24415 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24416 append_glyph_string (&(HEAD), &(TAIL), s); \
24418 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24422 /* Add a glyph string for a sequence of glyphless character's glyphs
24423 to the list of strings between HEAD and TAIL. The meanings of
24424 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24426 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24431 face_id = (row)->glyphs[area][START].face_id; \
24433 s = alloca (sizeof *s); \
24434 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24435 append_glyph_string (&HEAD, &TAIL, s); \
24437 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24443 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24444 of AREA of glyph row ROW on window W between indices START and END.
24445 HL overrides the face for drawing glyph strings, e.g. it is
24446 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24447 x-positions of the drawing area.
24449 This is an ugly monster macro construct because we must use alloca
24450 to allocate glyph strings (because draw_glyphs can be called
24451 asynchronously). */
24453 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24456 HEAD = TAIL = NULL; \
24457 while (START < END) \
24459 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24460 switch (first_glyph->type) \
24463 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24467 case COMPOSITE_GLYPH: \
24468 if (first_glyph->u.cmp.automatic) \
24469 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24472 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24476 case STRETCH_GLYPH: \
24477 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24481 case IMAGE_GLYPH: \
24482 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24486 case GLYPHLESS_GLYPH: \
24487 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24497 set_glyph_string_background_width (s, START, LAST_X); \
24504 /* Draw glyphs between START and END in AREA of ROW on window W,
24505 starting at x-position X. X is relative to AREA in W. HL is a
24506 face-override with the following meaning:
24508 DRAW_NORMAL_TEXT draw normally
24509 DRAW_CURSOR draw in cursor face
24510 DRAW_MOUSE_FACE draw in mouse face.
24511 DRAW_INVERSE_VIDEO draw in mode line face
24512 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24513 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24515 If OVERLAPS is non-zero, draw only the foreground of characters and
24516 clip to the physical height of ROW. Non-zero value also defines
24517 the overlapping part to be drawn:
24519 OVERLAPS_PRED overlap with preceding rows
24520 OVERLAPS_SUCC overlap with succeeding rows
24521 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24522 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24524 Value is the x-position reached, relative to AREA of W. */
24527 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24528 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24529 enum draw_glyphs_face hl
, int overlaps
)
24531 struct glyph_string
*head
, *tail
;
24532 struct glyph_string
*s
;
24533 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24534 int i
, j
, x_reached
, last_x
, area_left
= 0;
24535 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24538 ALLOCATE_HDC (hdc
, f
);
24540 /* Let's rather be paranoid than getting a SEGV. */
24541 end
= min (end
, row
->used
[area
]);
24542 start
= clip_to_bounds (0, start
, end
);
24544 /* Translate X to frame coordinates. Set last_x to the right
24545 end of the drawing area. */
24546 if (row
->full_width_p
)
24548 /* X is relative to the left edge of W, without scroll bars
24550 area_left
= WINDOW_LEFT_EDGE_X (w
);
24551 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
24552 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
24556 area_left
= window_box_left (w
, area
);
24557 last_x
= area_left
+ window_box_width (w
, area
);
24561 /* Build a doubly-linked list of glyph_string structures between
24562 head and tail from what we have to draw. Note that the macro
24563 BUILD_GLYPH_STRINGS will modify its start parameter. That's
24564 the reason we use a separate variable `i'. */
24566 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
24568 x_reached
= tail
->x
+ tail
->background_width
;
24572 /* If there are any glyphs with lbearing < 0 or rbearing > width in
24573 the row, redraw some glyphs in front or following the glyph
24574 strings built above. */
24575 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
24577 struct glyph_string
*h
, *t
;
24578 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
24579 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
24580 int check_mouse_face
= 0;
24583 /* If mouse highlighting is on, we may need to draw adjacent
24584 glyphs using mouse-face highlighting. */
24585 if (area
== TEXT_AREA
&& row
->mouse_face_p
24586 && hlinfo
->mouse_face_beg_row
>= 0
24587 && hlinfo
->mouse_face_end_row
>= 0)
24589 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
24591 if (row_vpos
>= hlinfo
->mouse_face_beg_row
24592 && row_vpos
<= hlinfo
->mouse_face_end_row
)
24594 check_mouse_face
= 1;
24595 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
24596 ? hlinfo
->mouse_face_beg_col
: 0;
24597 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
24598 ? hlinfo
->mouse_face_end_col
24599 : row
->used
[TEXT_AREA
];
24603 /* Compute overhangs for all glyph strings. */
24604 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
24605 for (s
= head
; s
; s
= s
->next
)
24606 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
24608 /* Prepend glyph strings for glyphs in front of the first glyph
24609 string that are overwritten because of the first glyph
24610 string's left overhang. The background of all strings
24611 prepended must be drawn because the first glyph string
24613 i
= left_overwritten (head
);
24616 enum draw_glyphs_face overlap_hl
;
24618 /* If this row contains mouse highlighting, attempt to draw
24619 the overlapped glyphs with the correct highlight. This
24620 code fails if the overlap encompasses more than one glyph
24621 and mouse-highlight spans only some of these glyphs.
24622 However, making it work perfectly involves a lot more
24623 code, and I don't know if the pathological case occurs in
24624 practice, so we'll stick to this for now. --- cyd */
24625 if (check_mouse_face
24626 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24627 overlap_hl
= DRAW_MOUSE_FACE
;
24629 overlap_hl
= DRAW_NORMAL_TEXT
;
24631 if (hl
!= overlap_hl
)
24634 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
24635 overlap_hl
, dummy_x
, last_x
);
24637 compute_overhangs_and_x (t
, head
->x
, 1);
24638 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24639 if (clip_head
== NULL
)
24643 /* Prepend glyph strings for glyphs in front of the first glyph
24644 string that overwrite that glyph string because of their
24645 right overhang. For these strings, only the foreground must
24646 be drawn, because it draws over the glyph string at `head'.
24647 The background must not be drawn because this would overwrite
24648 right overhangs of preceding glyphs for which no glyph
24650 i
= left_overwriting (head
);
24653 enum draw_glyphs_face overlap_hl
;
24655 if (check_mouse_face
24656 && mouse_beg_col
< start
&& mouse_end_col
> i
)
24657 overlap_hl
= DRAW_MOUSE_FACE
;
24659 overlap_hl
= DRAW_NORMAL_TEXT
;
24661 if (hl
== overlap_hl
|| clip_head
== NULL
)
24663 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
24664 overlap_hl
, dummy_x
, last_x
);
24665 for (s
= h
; s
; s
= s
->next
)
24666 s
->background_filled_p
= 1;
24667 compute_overhangs_and_x (t
, head
->x
, 1);
24668 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
24671 /* Append glyphs strings for glyphs following the last glyph
24672 string tail that are overwritten by tail. The background of
24673 these strings has to be drawn because tail's foreground draws
24675 i
= right_overwritten (tail
);
24678 enum draw_glyphs_face overlap_hl
;
24680 if (check_mouse_face
24681 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24682 overlap_hl
= DRAW_MOUSE_FACE
;
24684 overlap_hl
= DRAW_NORMAL_TEXT
;
24686 if (hl
!= overlap_hl
)
24688 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24689 overlap_hl
, x
, last_x
);
24690 /* Because BUILD_GLYPH_STRINGS updates the first argument,
24691 we don't have `end = i;' here. */
24692 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24693 append_glyph_string_lists (&head
, &tail
, h
, t
);
24694 if (clip_tail
== NULL
)
24698 /* Append glyph strings for glyphs following the last glyph
24699 string tail that overwrite tail. The foreground of such
24700 glyphs has to be drawn because it writes into the background
24701 of tail. The background must not be drawn because it could
24702 paint over the foreground of following glyphs. */
24703 i
= right_overwriting (tail
);
24706 enum draw_glyphs_face overlap_hl
;
24707 if (check_mouse_face
24708 && mouse_beg_col
< i
&& mouse_end_col
> end
)
24709 overlap_hl
= DRAW_MOUSE_FACE
;
24711 overlap_hl
= DRAW_NORMAL_TEXT
;
24713 if (hl
== overlap_hl
|| clip_tail
== NULL
)
24715 i
++; /* We must include the Ith glyph. */
24716 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
24717 overlap_hl
, x
, last_x
);
24718 for (s
= h
; s
; s
= s
->next
)
24719 s
->background_filled_p
= 1;
24720 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
24721 append_glyph_string_lists (&head
, &tail
, h
, t
);
24723 if (clip_head
|| clip_tail
)
24724 for (s
= head
; s
; s
= s
->next
)
24726 s
->clip_head
= clip_head
;
24727 s
->clip_tail
= clip_tail
;
24731 /* Draw all strings. */
24732 for (s
= head
; s
; s
= s
->next
)
24733 FRAME_RIF (f
)->draw_glyph_string (s
);
24736 /* When focus a sole frame and move horizontally, this sets on_p to 0
24737 causing a failure to erase prev cursor position. */
24738 if (area
== TEXT_AREA
24739 && !row
->full_width_p
24740 /* When drawing overlapping rows, only the glyph strings'
24741 foreground is drawn, which doesn't erase a cursor
24745 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
24746 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
24747 : (tail
? tail
->x
+ tail
->background_width
: x
));
24751 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
24752 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
24756 /* Value is the x-position up to which drawn, relative to AREA of W.
24757 This doesn't include parts drawn because of overhangs. */
24758 if (row
->full_width_p
)
24759 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
24761 x_reached
-= area_left
;
24763 RELEASE_HDC (hdc
, f
);
24768 /* Expand row matrix if too narrow. Don't expand if area
24771 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
24773 if (!it->f->fonts_changed \
24774 && (it->glyph_row->glyphs[area] \
24775 < it->glyph_row->glyphs[area + 1])) \
24777 it->w->ncols_scale_factor++; \
24778 it->f->fonts_changed = 1; \
24782 /* Store one glyph for IT->char_to_display in IT->glyph_row.
24783 Called from x_produce_glyphs when IT->glyph_row is non-null. */
24786 append_glyph (struct it
*it
)
24788 struct glyph
*glyph
;
24789 enum glyph_row_area area
= it
->area
;
24791 eassert (it
->glyph_row
);
24792 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
24794 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24795 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24797 /* If the glyph row is reversed, we need to prepend the glyph
24798 rather than append it. */
24799 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24803 /* Make room for the additional glyph. */
24804 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
24806 glyph
= it
->glyph_row
->glyphs
[area
];
24808 glyph
->charpos
= CHARPOS (it
->position
);
24809 glyph
->object
= it
->object
;
24810 if (it
->pixel_width
> 0)
24812 glyph
->pixel_width
= it
->pixel_width
;
24813 glyph
->padding_p
= 0;
24817 /* Assure at least 1-pixel width. Otherwise, cursor can't
24818 be displayed correctly. */
24819 glyph
->pixel_width
= 1;
24820 glyph
->padding_p
= 1;
24822 glyph
->ascent
= it
->ascent
;
24823 glyph
->descent
= it
->descent
;
24824 glyph
->voffset
= it
->voffset
;
24825 glyph
->type
= CHAR_GLYPH
;
24826 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24827 glyph
->multibyte_p
= it
->multibyte_p
;
24828 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24830 /* In R2L rows, the left and the right box edges need to be
24831 drawn in reverse direction. */
24832 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24833 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24837 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24838 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24840 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24841 || it
->phys_descent
> it
->descent
);
24842 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
24843 glyph
->face_id
= it
->face_id
;
24844 glyph
->u
.ch
= it
->char_to_display
;
24845 glyph
->slice
.img
= null_glyph_slice
;
24846 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24849 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24850 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24852 glyph
->bidi_type
= it
->bidi_it
.type
;
24856 glyph
->resolved_level
= 0;
24857 glyph
->bidi_type
= UNKNOWN_BT
;
24859 ++it
->glyph_row
->used
[area
];
24862 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24865 /* Store one glyph for the composition IT->cmp_it.id in
24866 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
24870 append_composite_glyph (struct it
*it
)
24872 struct glyph
*glyph
;
24873 enum glyph_row_area area
= it
->area
;
24875 eassert (it
->glyph_row
);
24877 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
24878 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
24880 /* If the glyph row is reversed, we need to prepend the glyph
24881 rather than append it. */
24882 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
24886 /* Make room for the new glyph. */
24887 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
24889 glyph
= it
->glyph_row
->glyphs
[it
->area
];
24891 glyph
->charpos
= it
->cmp_it
.charpos
;
24892 glyph
->object
= it
->object
;
24893 glyph
->pixel_width
= it
->pixel_width
;
24894 glyph
->ascent
= it
->ascent
;
24895 glyph
->descent
= it
->descent
;
24896 glyph
->voffset
= it
->voffset
;
24897 glyph
->type
= COMPOSITE_GLYPH
;
24898 if (it
->cmp_it
.ch
< 0)
24900 glyph
->u
.cmp
.automatic
= 0;
24901 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24902 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
24906 glyph
->u
.cmp
.automatic
= 1;
24907 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
24908 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
24909 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
24911 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
24912 glyph
->multibyte_p
= it
->multibyte_p
;
24913 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
24915 /* In R2L rows, the left and the right box edges need to be
24916 drawn in reverse direction. */
24917 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
24918 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
24922 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
24923 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
24925 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
24926 || it
->phys_descent
> it
->descent
);
24927 glyph
->padding_p
= 0;
24928 glyph
->glyph_not_available_p
= 0;
24929 glyph
->face_id
= it
->face_id
;
24930 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
24933 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
24934 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
24936 glyph
->bidi_type
= it
->bidi_it
.type
;
24938 ++it
->glyph_row
->used
[area
];
24941 IT_EXPAND_MATRIX_WIDTH (it
, area
);
24945 /* Change IT->ascent and IT->height according to the setting of
24949 take_vertical_position_into_account (struct it
*it
)
24953 if (it
->voffset
< 0)
24954 /* Increase the ascent so that we can display the text higher
24956 it
->ascent
-= it
->voffset
;
24958 /* Increase the descent so that we can display the text lower
24960 it
->descent
+= it
->voffset
;
24965 /* Produce glyphs/get display metrics for the image IT is loaded with.
24966 See the description of struct display_iterator in dispextern.h for
24967 an overview of struct display_iterator. */
24970 produce_image_glyph (struct it
*it
)
24974 int glyph_ascent
, crop
;
24975 struct glyph_slice slice
;
24977 eassert (it
->what
== IT_IMAGE
);
24979 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
24981 /* Make sure X resources of the face is loaded. */
24982 prepare_face_for_display (it
->f
, face
);
24984 if (it
->image_id
< 0)
24986 /* Fringe bitmap. */
24987 it
->ascent
= it
->phys_ascent
= 0;
24988 it
->descent
= it
->phys_descent
= 0;
24989 it
->pixel_width
= 0;
24994 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
24996 /* Make sure X resources of the image is loaded. */
24997 prepare_image_for_display (it
->f
, img
);
24999 slice
.x
= slice
.y
= 0;
25000 slice
.width
= img
->width
;
25001 slice
.height
= img
->height
;
25003 if (INTEGERP (it
->slice
.x
))
25004 slice
.x
= XINT (it
->slice
.x
);
25005 else if (FLOATP (it
->slice
.x
))
25006 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25008 if (INTEGERP (it
->slice
.y
))
25009 slice
.y
= XINT (it
->slice
.y
);
25010 else if (FLOATP (it
->slice
.y
))
25011 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25013 if (INTEGERP (it
->slice
.width
))
25014 slice
.width
= XINT (it
->slice
.width
);
25015 else if (FLOATP (it
->slice
.width
))
25016 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25018 if (INTEGERP (it
->slice
.height
))
25019 slice
.height
= XINT (it
->slice
.height
);
25020 else if (FLOATP (it
->slice
.height
))
25021 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25023 if (slice
.x
>= img
->width
)
25024 slice
.x
= img
->width
;
25025 if (slice
.y
>= img
->height
)
25026 slice
.y
= img
->height
;
25027 if (slice
.x
+ slice
.width
>= img
->width
)
25028 slice
.width
= img
->width
- slice
.x
;
25029 if (slice
.y
+ slice
.height
> img
->height
)
25030 slice
.height
= img
->height
- slice
.y
;
25032 if (slice
.width
== 0 || slice
.height
== 0)
25035 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25037 it
->descent
= slice
.height
- glyph_ascent
;
25039 it
->descent
+= img
->vmargin
;
25040 if (slice
.y
+ slice
.height
== img
->height
)
25041 it
->descent
+= img
->vmargin
;
25042 it
->phys_descent
= it
->descent
;
25044 it
->pixel_width
= slice
.width
;
25046 it
->pixel_width
+= img
->hmargin
;
25047 if (slice
.x
+ slice
.width
== img
->width
)
25048 it
->pixel_width
+= img
->hmargin
;
25050 /* It's quite possible for images to have an ascent greater than
25051 their height, so don't get confused in that case. */
25052 if (it
->descent
< 0)
25057 if (face
->box
!= FACE_NO_BOX
)
25059 if (face
->box_line_width
> 0)
25062 it
->ascent
+= face
->box_line_width
;
25063 if (slice
.y
+ slice
.height
== img
->height
)
25064 it
->descent
+= face
->box_line_width
;
25067 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25068 it
->pixel_width
+= eabs (face
->box_line_width
);
25069 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25070 it
->pixel_width
+= eabs (face
->box_line_width
);
25073 take_vertical_position_into_account (it
);
25075 /* Automatically crop wide image glyphs at right edge so we can
25076 draw the cursor on same display row. */
25077 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25078 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25080 it
->pixel_width
-= crop
;
25081 slice
.width
-= crop
;
25086 struct glyph
*glyph
;
25087 enum glyph_row_area area
= it
->area
;
25089 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25090 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25092 glyph
->charpos
= CHARPOS (it
->position
);
25093 glyph
->object
= it
->object
;
25094 glyph
->pixel_width
= it
->pixel_width
;
25095 glyph
->ascent
= glyph_ascent
;
25096 glyph
->descent
= it
->descent
;
25097 glyph
->voffset
= it
->voffset
;
25098 glyph
->type
= IMAGE_GLYPH
;
25099 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25100 glyph
->multibyte_p
= it
->multibyte_p
;
25101 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25103 /* In R2L rows, the left and the right box edges need to be
25104 drawn in reverse direction. */
25105 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25106 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25110 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25111 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25113 glyph
->overlaps_vertically_p
= 0;
25114 glyph
->padding_p
= 0;
25115 glyph
->glyph_not_available_p
= 0;
25116 glyph
->face_id
= it
->face_id
;
25117 glyph
->u
.img_id
= img
->id
;
25118 glyph
->slice
.img
= slice
;
25119 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25122 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25123 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25125 glyph
->bidi_type
= it
->bidi_it
.type
;
25127 ++it
->glyph_row
->used
[area
];
25130 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25135 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25136 of the glyph, WIDTH and HEIGHT are the width and height of the
25137 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25140 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25141 int width
, int height
, int ascent
)
25143 struct glyph
*glyph
;
25144 enum glyph_row_area area
= it
->area
;
25146 eassert (ascent
>= 0 && ascent
<= height
);
25148 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25149 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25151 /* If the glyph row is reversed, we need to prepend the glyph
25152 rather than append it. */
25153 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25157 /* Make room for the additional glyph. */
25158 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25160 glyph
= it
->glyph_row
->glyphs
[area
];
25162 glyph
->charpos
= CHARPOS (it
->position
);
25163 glyph
->object
= object
;
25164 glyph
->pixel_width
= width
;
25165 glyph
->ascent
= ascent
;
25166 glyph
->descent
= height
- ascent
;
25167 glyph
->voffset
= it
->voffset
;
25168 glyph
->type
= STRETCH_GLYPH
;
25169 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25170 glyph
->multibyte_p
= it
->multibyte_p
;
25171 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25173 /* In R2L rows, the left and the right box edges need to be
25174 drawn in reverse direction. */
25175 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25176 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25180 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25181 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25183 glyph
->overlaps_vertically_p
= 0;
25184 glyph
->padding_p
= 0;
25185 glyph
->glyph_not_available_p
= 0;
25186 glyph
->face_id
= it
->face_id
;
25187 glyph
->u
.stretch
.ascent
= ascent
;
25188 glyph
->u
.stretch
.height
= height
;
25189 glyph
->slice
.img
= null_glyph_slice
;
25190 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25193 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25194 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25196 glyph
->bidi_type
= it
->bidi_it
.type
;
25200 glyph
->resolved_level
= 0;
25201 glyph
->bidi_type
= UNKNOWN_BT
;
25203 ++it
->glyph_row
->used
[area
];
25206 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25209 #endif /* HAVE_WINDOW_SYSTEM */
25211 /* Produce a stretch glyph for iterator IT. IT->object is the value
25212 of the glyph property displayed. The value must be a list
25213 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25216 1. `:width WIDTH' specifies that the space should be WIDTH *
25217 canonical char width wide. WIDTH may be an integer or floating
25220 2. `:relative-width FACTOR' specifies that the width of the stretch
25221 should be computed from the width of the first character having the
25222 `glyph' property, and should be FACTOR times that width.
25224 3. `:align-to HPOS' specifies that the space should be wide enough
25225 to reach HPOS, a value in canonical character units.
25227 Exactly one of the above pairs must be present.
25229 4. `:height HEIGHT' specifies that the height of the stretch produced
25230 should be HEIGHT, measured in canonical character units.
25232 5. `:relative-height FACTOR' specifies that the height of the
25233 stretch should be FACTOR times the height of the characters having
25234 the glyph property.
25236 Either none or exactly one of 4 or 5 must be present.
25238 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25239 of the stretch should be used for the ascent of the stretch.
25240 ASCENT must be in the range 0 <= ASCENT <= 100. */
25243 produce_stretch_glyph (struct it
*it
)
25245 /* (space :width WIDTH :height HEIGHT ...) */
25246 Lisp_Object prop
, plist
;
25247 int width
= 0, height
= 0, align_to
= -1;
25248 int zero_width_ok_p
= 0;
25250 struct font
*font
= NULL
;
25252 #ifdef HAVE_WINDOW_SYSTEM
25254 int zero_height_ok_p
= 0;
25256 if (FRAME_WINDOW_P (it
->f
))
25258 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25259 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25260 prepare_face_for_display (it
->f
, face
);
25264 /* List should start with `space'. */
25265 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25266 plist
= XCDR (it
->object
);
25268 /* Compute the width of the stretch. */
25269 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25270 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25272 /* Absolute width `:width WIDTH' specified and valid. */
25273 zero_width_ok_p
= 1;
25276 #ifdef HAVE_WINDOW_SYSTEM
25277 else if (FRAME_WINDOW_P (it
->f
)
25278 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25280 /* Relative width `:relative-width FACTOR' specified and valid.
25281 Compute the width of the characters having the `glyph'
25284 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25287 if (it
->multibyte_p
)
25288 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25291 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25292 if (! ASCII_CHAR_P (it2
.c
))
25293 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25296 it2
.glyph_row
= NULL
;
25297 it2
.what
= IT_CHARACTER
;
25298 x_produce_glyphs (&it2
);
25299 width
= NUMVAL (prop
) * it2
.pixel_width
;
25301 #endif /* HAVE_WINDOW_SYSTEM */
25302 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25303 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25305 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25306 align_to
= (align_to
< 0
25308 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25309 else if (align_to
< 0)
25310 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25311 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25312 zero_width_ok_p
= 1;
25315 /* Nothing specified -> width defaults to canonical char width. */
25316 width
= FRAME_COLUMN_WIDTH (it
->f
);
25318 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25321 #ifdef HAVE_WINDOW_SYSTEM
25322 /* Compute height. */
25323 if (FRAME_WINDOW_P (it
->f
))
25325 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25326 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25329 zero_height_ok_p
= 1;
25331 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25333 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25335 height
= FONT_HEIGHT (font
);
25337 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25340 /* Compute percentage of height used for ascent. If
25341 `:ascent ASCENT' is present and valid, use that. Otherwise,
25342 derive the ascent from the font in use. */
25343 if (prop
= Fplist_get (plist
, QCascent
),
25344 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25345 ascent
= height
* NUMVAL (prop
) / 100.0;
25346 else if (!NILP (prop
)
25347 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25348 ascent
= min (max (0, (int)tem
), height
);
25350 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25353 #endif /* HAVE_WINDOW_SYSTEM */
25356 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25357 && it
->current_x
+ width
> it
->last_visible_x
)
25359 width
= it
->last_visible_x
- it
->current_x
;
25360 #ifdef HAVE_WINDOW_SYSTEM
25361 /* Subtract one more pixel from the stretch width, but only on
25362 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25363 width
-= FRAME_WINDOW_P (it
->f
);
25367 if (width
> 0 && height
> 0 && it
->glyph_row
)
25369 Lisp_Object o_object
= it
->object
;
25370 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25373 if (!STRINGP (object
))
25374 object
= it
->w
->contents
;
25375 #ifdef HAVE_WINDOW_SYSTEM
25376 if (FRAME_WINDOW_P (it
->f
))
25377 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25381 it
->object
= object
;
25382 it
->char_to_display
= ' ';
25383 it
->pixel_width
= it
->len
= 1;
25385 tty_append_glyph (it
);
25386 it
->object
= o_object
;
25390 it
->pixel_width
= width
;
25391 #ifdef HAVE_WINDOW_SYSTEM
25392 if (FRAME_WINDOW_P (it
->f
))
25394 it
->ascent
= it
->phys_ascent
= ascent
;
25395 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25396 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25397 take_vertical_position_into_account (it
);
25401 it
->nglyphs
= width
;
25404 /* Get information about special display element WHAT in an
25405 environment described by IT. WHAT is one of IT_TRUNCATION or
25406 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25407 non-null glyph_row member. This function ensures that fields like
25408 face_id, c, len of IT are left untouched. */
25411 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25418 temp_it
.object
= make_number (0);
25419 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25421 if (what
== IT_CONTINUATION
)
25423 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25424 if (it
->bidi_it
.paragraph_dir
== R2L
)
25425 SET_GLYPH_FROM_CHAR (glyph
, '/');
25427 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25429 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25431 /* FIXME: Should we mirror GC for R2L lines? */
25432 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25433 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25436 else if (what
== IT_TRUNCATION
)
25438 /* Truncation glyph. */
25439 SET_GLYPH_FROM_CHAR (glyph
, '$');
25441 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25443 /* FIXME: Should we mirror GC for R2L lines? */
25444 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25445 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25451 #ifdef HAVE_WINDOW_SYSTEM
25452 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25453 is turned off, we precede the truncation/continuation glyphs by a
25454 stretch glyph whose width is computed such that these special
25455 glyphs are aligned at the window margin, even when very different
25456 fonts are used in different glyph rows. */
25457 if (FRAME_WINDOW_P (temp_it
.f
)
25458 /* init_iterator calls this with it->glyph_row == NULL, and it
25459 wants only the pixel width of the truncation/continuation
25461 && temp_it
.glyph_row
25462 /* insert_left_trunc_glyphs calls us at the beginning of the
25463 row, and it has its own calculation of the stretch glyph
25465 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25466 && (temp_it
.glyph_row
->reversed_p
25467 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25468 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25470 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25472 if (stretch_width
> 0)
25474 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25475 struct font
*font
=
25476 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25477 int stretch_ascent
=
25478 (((temp_it
.ascent
+ temp_it
.descent
)
25479 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25481 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25482 temp_it
.ascent
+ temp_it
.descent
,
25489 temp_it
.what
= IT_CHARACTER
;
25491 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25492 temp_it
.face_id
= GLYPH_FACE (glyph
);
25493 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25495 PRODUCE_GLYPHS (&temp_it
);
25496 it
->pixel_width
= temp_it
.pixel_width
;
25497 it
->nglyphs
= temp_it
.pixel_width
;
25500 #ifdef HAVE_WINDOW_SYSTEM
25502 /* Calculate line-height and line-spacing properties.
25503 An integer value specifies explicit pixel value.
25504 A float value specifies relative value to current face height.
25505 A cons (float . face-name) specifies relative value to
25506 height of specified face font.
25508 Returns height in pixels, or nil. */
25512 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25513 int boff
, int override
)
25515 Lisp_Object face_name
= Qnil
;
25516 int ascent
, descent
, height
;
25518 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25523 face_name
= XCAR (val
);
25525 if (!NUMBERP (val
))
25526 val
= make_number (1);
25527 if (NILP (face_name
))
25529 height
= it
->ascent
+ it
->descent
;
25534 if (NILP (face_name
))
25536 font
= FRAME_FONT (it
->f
);
25537 boff
= FRAME_BASELINE_OFFSET (it
->f
);
25539 else if (EQ (face_name
, Qt
))
25548 face_id
= lookup_named_face (it
->f
, face_name
, 0);
25550 return make_number (-1);
25552 face
= FACE_FROM_ID (it
->f
, face_id
);
25555 return make_number (-1);
25556 boff
= font
->baseline_offset
;
25557 if (font
->vertical_centering
)
25558 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25561 ascent
= FONT_BASE (font
) + boff
;
25562 descent
= FONT_DESCENT (font
) - boff
;
25566 it
->override_ascent
= ascent
;
25567 it
->override_descent
= descent
;
25568 it
->override_boff
= boff
;
25571 height
= ascent
+ descent
;
25575 height
= (int)(XFLOAT_DATA (val
) * height
);
25576 else if (INTEGERP (val
))
25577 height
*= XINT (val
);
25579 return make_number (height
);
25583 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
25584 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
25585 and only if this is for a character for which no font was found.
25587 If the display method (it->glyphless_method) is
25588 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
25589 length of the acronym or the hexadecimal string, UPPER_XOFF and
25590 UPPER_YOFF are pixel offsets for the upper part of the string,
25591 LOWER_XOFF and LOWER_YOFF are for the lower part.
25593 For the other display methods, LEN through LOWER_YOFF are zero. */
25596 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
25597 short upper_xoff
, short upper_yoff
,
25598 short lower_xoff
, short lower_yoff
)
25600 struct glyph
*glyph
;
25601 enum glyph_row_area area
= it
->area
;
25603 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25604 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25606 /* If the glyph row is reversed, we need to prepend the glyph
25607 rather than append it. */
25608 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25612 /* Make room for the additional glyph. */
25613 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25615 glyph
= it
->glyph_row
->glyphs
[area
];
25617 glyph
->charpos
= CHARPOS (it
->position
);
25618 glyph
->object
= it
->object
;
25619 glyph
->pixel_width
= it
->pixel_width
;
25620 glyph
->ascent
= it
->ascent
;
25621 glyph
->descent
= it
->descent
;
25622 glyph
->voffset
= it
->voffset
;
25623 glyph
->type
= GLYPHLESS_GLYPH
;
25624 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
25625 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
25626 glyph
->u
.glyphless
.len
= len
;
25627 glyph
->u
.glyphless
.ch
= it
->c
;
25628 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
25629 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
25630 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
25631 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
25632 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25633 glyph
->multibyte_p
= it
->multibyte_p
;
25634 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25636 /* In R2L rows, the left and the right box edges need to be
25637 drawn in reverse direction. */
25638 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25639 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25643 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25644 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25646 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25647 || it
->phys_descent
> it
->descent
);
25648 glyph
->padding_p
= 0;
25649 glyph
->glyph_not_available_p
= 0;
25650 glyph
->face_id
= face_id
;
25651 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25654 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25655 if ((it
->bidi_it
.type
& 7) != it
->bidi_it
.type
)
25657 glyph
->bidi_type
= it
->bidi_it
.type
;
25659 ++it
->glyph_row
->used
[area
];
25662 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25666 /* Produce a glyph for a glyphless character for iterator IT.
25667 IT->glyphless_method specifies which method to use for displaying
25668 the character. See the description of enum
25669 glyphless_display_method in dispextern.h for the detail.
25671 FOR_NO_FONT is nonzero if and only if this is for a character for
25672 which no font was found. ACRONYM, if non-nil, is an acronym string
25673 for the character. */
25676 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
25681 int base_width
, base_height
, width
, height
;
25682 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
25685 /* Get the metrics of the base font. We always refer to the current
25687 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
25688 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25689 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
25690 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
25691 base_height
= it
->ascent
+ it
->descent
;
25692 base_width
= font
->average_width
;
25694 face_id
= merge_glyphless_glyph_face (it
);
25696 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
25698 it
->pixel_width
= THIN_SPACE_WIDTH
;
25700 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25702 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
25704 width
= CHAR_WIDTH (it
->c
);
25707 else if (width
> 4)
25709 it
->pixel_width
= base_width
* width
;
25711 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
25717 unsigned int code
[6];
25719 int ascent
, descent
;
25720 struct font_metrics metrics_upper
, metrics_lower
;
25722 face
= FACE_FROM_ID (it
->f
, face_id
);
25723 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25724 prepare_face_for_display (it
->f
, face
);
25726 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
25728 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
25729 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
25730 if (CONSP (acronym
))
25731 acronym
= XCAR (acronym
);
25732 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
25736 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
25737 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
25740 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
25741 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
25742 upper_len
= (len
+ 1) / 2;
25743 font
->driver
->text_extents (font
, code
, upper_len
,
25745 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
25750 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
25751 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
25752 upper_xoff
= upper_yoff
= 2; /* the typical case */
25753 if (base_width
>= width
)
25755 /* Align the upper to the left, the lower to the right. */
25756 it
->pixel_width
= base_width
;
25757 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
25761 /* Center the shorter one. */
25762 it
->pixel_width
= width
;
25763 if (metrics_upper
.width
>= metrics_lower
.width
)
25764 lower_xoff
= (width
- metrics_lower
.width
) / 2;
25767 /* FIXME: This code doesn't look right. It formerly was
25768 missing the "lower_xoff = 0;", which couldn't have
25769 been right since it left lower_xoff uninitialized. */
25771 upper_xoff
= (width
- metrics_upper
.width
) / 2;
25775 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
25776 top, bottom, and between upper and lower strings. */
25777 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
25778 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
25779 /* Center vertically.
25780 H:base_height, D:base_descent
25781 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
25783 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
25784 descent = D - H/2 + h/2;
25785 lower_yoff = descent - 2 - ld;
25786 upper_yoff = lower_yoff - la - 1 - ud; */
25787 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
25788 descent
= it
->descent
- (base_height
- height
) / 2;
25789 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
25790 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
25791 - metrics_upper
.descent
);
25792 /* Don't make the height shorter than the base height. */
25793 if (height
> base_height
)
25795 it
->ascent
= ascent
;
25796 it
->descent
= descent
;
25800 it
->phys_ascent
= it
->ascent
;
25801 it
->phys_descent
= it
->descent
;
25803 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
25804 upper_xoff
, upper_yoff
,
25805 lower_xoff
, lower_yoff
);
25807 take_vertical_position_into_account (it
);
25812 Produce glyphs/get display metrics for the display element IT is
25813 loaded with. See the description of struct it in dispextern.h
25814 for an overview of struct it. */
25817 x_produce_glyphs (struct it
*it
)
25819 int extra_line_spacing
= it
->extra_line_spacing
;
25821 it
->glyph_not_available_p
= 0;
25823 if (it
->what
== IT_CHARACTER
)
25826 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25827 struct font
*font
= face
->font
;
25828 struct font_metrics
*pcm
= NULL
;
25829 int boff
; /* Baseline offset. */
25833 /* When no suitable font is found, display this character by
25834 the method specified in the first extra slot of
25835 Vglyphless_char_display. */
25836 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
25838 eassert (it
->what
== IT_GLYPHLESS
);
25839 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
25843 boff
= font
->baseline_offset
;
25844 if (font
->vertical_centering
)
25845 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
25847 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
25853 if (it
->override_ascent
>= 0)
25855 it
->ascent
= it
->override_ascent
;
25856 it
->descent
= it
->override_descent
;
25857 boff
= it
->override_boff
;
25861 it
->ascent
= FONT_BASE (font
) + boff
;
25862 it
->descent
= FONT_DESCENT (font
) - boff
;
25865 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
25867 pcm
= get_per_char_metric (font
, &char2b
);
25868 if (pcm
->width
== 0
25869 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
25875 it
->phys_ascent
= pcm
->ascent
+ boff
;
25876 it
->phys_descent
= pcm
->descent
- boff
;
25877 it
->pixel_width
= pcm
->width
;
25881 it
->glyph_not_available_p
= 1;
25882 it
->phys_ascent
= it
->ascent
;
25883 it
->phys_descent
= it
->descent
;
25884 it
->pixel_width
= font
->space_width
;
25887 if (it
->constrain_row_ascent_descent_p
)
25889 if (it
->descent
> it
->max_descent
)
25891 it
->ascent
+= it
->descent
- it
->max_descent
;
25892 it
->descent
= it
->max_descent
;
25894 if (it
->ascent
> it
->max_ascent
)
25896 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
25897 it
->ascent
= it
->max_ascent
;
25899 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
25900 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
25901 extra_line_spacing
= 0;
25904 /* If this is a space inside a region of text with
25905 `space-width' property, change its width. */
25906 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
25908 it
->pixel_width
*= XFLOATINT (it
->space_width
);
25910 /* If face has a box, add the box thickness to the character
25911 height. If character has a box line to the left and/or
25912 right, add the box line width to the character's width. */
25913 if (face
->box
!= FACE_NO_BOX
)
25915 int thick
= face
->box_line_width
;
25919 it
->ascent
+= thick
;
25920 it
->descent
+= thick
;
25925 if (it
->start_of_box_run_p
)
25926 it
->pixel_width
+= thick
;
25927 if (it
->end_of_box_run_p
)
25928 it
->pixel_width
+= thick
;
25931 /* If face has an overline, add the height of the overline
25932 (1 pixel) and a 1 pixel margin to the character height. */
25933 if (face
->overline_p
)
25934 it
->ascent
+= overline_margin
;
25936 if (it
->constrain_row_ascent_descent_p
)
25938 if (it
->ascent
> it
->max_ascent
)
25939 it
->ascent
= it
->max_ascent
;
25940 if (it
->descent
> it
->max_descent
)
25941 it
->descent
= it
->max_descent
;
25944 take_vertical_position_into_account (it
);
25946 /* If we have to actually produce glyphs, do it. */
25951 /* Translate a space with a `space-width' property
25952 into a stretch glyph. */
25953 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
25954 / FONT_HEIGHT (font
));
25955 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
25956 it
->ascent
+ it
->descent
, ascent
);
25961 /* If characters with lbearing or rbearing are displayed
25962 in this line, record that fact in a flag of the
25963 glyph row. This is used to optimize X output code. */
25964 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
25965 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
25967 if (! stretched_p
&& it
->pixel_width
== 0)
25968 /* We assure that all visible glyphs have at least 1-pixel
25970 it
->pixel_width
= 1;
25972 else if (it
->char_to_display
== '\n')
25974 /* A newline has no width, but we need the height of the
25975 line. But if previous part of the line sets a height,
25976 don't increase that height. */
25978 Lisp_Object height
;
25979 Lisp_Object total_height
= Qnil
;
25981 it
->override_ascent
= -1;
25982 it
->pixel_width
= 0;
25985 height
= get_it_property (it
, Qline_height
);
25986 /* Split (line-height total-height) list. */
25988 && CONSP (XCDR (height
))
25989 && NILP (XCDR (XCDR (height
))))
25991 total_height
= XCAR (XCDR (height
));
25992 height
= XCAR (height
);
25994 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
25996 if (it
->override_ascent
>= 0)
25998 it
->ascent
= it
->override_ascent
;
25999 it
->descent
= it
->override_descent
;
26000 boff
= it
->override_boff
;
26004 it
->ascent
= FONT_BASE (font
) + boff
;
26005 it
->descent
= FONT_DESCENT (font
) - boff
;
26008 if (EQ (height
, Qt
))
26010 if (it
->descent
> it
->max_descent
)
26012 it
->ascent
+= it
->descent
- it
->max_descent
;
26013 it
->descent
= it
->max_descent
;
26015 if (it
->ascent
> it
->max_ascent
)
26017 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26018 it
->ascent
= it
->max_ascent
;
26020 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26021 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26022 it
->constrain_row_ascent_descent_p
= 1;
26023 extra_line_spacing
= 0;
26027 Lisp_Object spacing
;
26029 it
->phys_ascent
= it
->ascent
;
26030 it
->phys_descent
= it
->descent
;
26032 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26033 && face
->box
!= FACE_NO_BOX
26034 && face
->box_line_width
> 0)
26036 it
->ascent
+= face
->box_line_width
;
26037 it
->descent
+= face
->box_line_width
;
26040 && XINT (height
) > it
->ascent
+ it
->descent
)
26041 it
->ascent
= XINT (height
) - it
->descent
;
26043 if (!NILP (total_height
))
26044 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26047 spacing
= get_it_property (it
, Qline_spacing
);
26048 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26050 if (INTEGERP (spacing
))
26052 extra_line_spacing
= XINT (spacing
);
26053 if (!NILP (total_height
))
26054 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26058 else /* i.e. (it->char_to_display == '\t') */
26060 if (font
->space_width
> 0)
26062 int tab_width
= it
->tab_width
* font
->space_width
;
26063 int x
= it
->current_x
+ it
->continuation_lines_width
;
26064 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26066 /* If the distance from the current position to the next tab
26067 stop is less than a space character width, use the
26068 tab stop after that. */
26069 if (next_tab_x
- x
< font
->space_width
)
26070 next_tab_x
+= tab_width
;
26072 it
->pixel_width
= next_tab_x
- x
;
26074 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26075 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26079 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26080 it
->ascent
+ it
->descent
, it
->ascent
);
26085 it
->pixel_width
= 0;
26090 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26092 /* A static composition.
26094 Note: A composition is represented as one glyph in the
26095 glyph matrix. There are no padding glyphs.
26097 Important note: pixel_width, ascent, and descent are the
26098 values of what is drawn by draw_glyphs (i.e. the values of
26099 the overall glyphs composed). */
26100 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26101 int boff
; /* baseline offset */
26102 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26103 int glyph_len
= cmp
->glyph_len
;
26104 struct font
*font
= face
->font
;
26108 /* If we have not yet calculated pixel size data of glyphs of
26109 the composition for the current face font, calculate them
26110 now. Theoretically, we have to check all fonts for the
26111 glyphs, but that requires much time and memory space. So,
26112 here we check only the font of the first glyph. This may
26113 lead to incorrect display, but it's very rare, and C-l
26114 (recenter-top-bottom) can correct the display anyway. */
26115 if (! cmp
->font
|| cmp
->font
!= font
)
26117 /* Ascent and descent of the font of the first character
26118 of this composition (adjusted by baseline offset).
26119 Ascent and descent of overall glyphs should not be less
26120 than these, respectively. */
26121 int font_ascent
, font_descent
, font_height
;
26122 /* Bounding box of the overall glyphs. */
26123 int leftmost
, rightmost
, lowest
, highest
;
26124 int lbearing
, rbearing
;
26125 int i
, width
, ascent
, descent
;
26126 int left_padded
= 0, right_padded
= 0;
26127 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26129 struct font_metrics
*pcm
;
26130 int font_not_found_p
;
26133 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26134 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26136 if (glyph_len
< cmp
->glyph_len
)
26138 for (i
= 0; i
< glyph_len
; i
++)
26140 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26142 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26147 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26148 : IT_CHARPOS (*it
));
26149 /* If no suitable font is found, use the default font. */
26150 font_not_found_p
= font
== NULL
;
26151 if (font_not_found_p
)
26153 face
= face
->ascii_face
;
26156 boff
= font
->baseline_offset
;
26157 if (font
->vertical_centering
)
26158 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26159 font_ascent
= FONT_BASE (font
) + boff
;
26160 font_descent
= FONT_DESCENT (font
) - boff
;
26161 font_height
= FONT_HEIGHT (font
);
26166 if (! font_not_found_p
)
26168 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26170 pcm
= get_per_char_metric (font
, &char2b
);
26173 /* Initialize the bounding box. */
26176 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26177 ascent
= pcm
->ascent
;
26178 descent
= pcm
->descent
;
26179 lbearing
= pcm
->lbearing
;
26180 rbearing
= pcm
->rbearing
;
26184 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26185 ascent
= FONT_BASE (font
);
26186 descent
= FONT_DESCENT (font
);
26193 lowest
= - descent
+ boff
;
26194 highest
= ascent
+ boff
;
26196 if (! font_not_found_p
26197 && font
->default_ascent
26198 && CHAR_TABLE_P (Vuse_default_ascent
)
26199 && !NILP (Faref (Vuse_default_ascent
,
26200 make_number (it
->char_to_display
))))
26201 highest
= font
->default_ascent
+ boff
;
26203 /* Draw the first glyph at the normal position. It may be
26204 shifted to right later if some other glyphs are drawn
26206 cmp
->offsets
[i
* 2] = 0;
26207 cmp
->offsets
[i
* 2 + 1] = boff
;
26208 cmp
->lbearing
= lbearing
;
26209 cmp
->rbearing
= rbearing
;
26211 /* Set cmp->offsets for the remaining glyphs. */
26212 for (i
++; i
< glyph_len
; i
++)
26214 int left
, right
, btm
, top
;
26215 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26217 struct face
*this_face
;
26221 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26222 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26223 font
= this_face
->font
;
26229 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26231 pcm
= get_per_char_metric (font
, &char2b
);
26234 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26237 width
= pcm
->width
;
26238 ascent
= pcm
->ascent
;
26239 descent
= pcm
->descent
;
26240 lbearing
= pcm
->lbearing
;
26241 rbearing
= pcm
->rbearing
;
26242 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26244 /* Relative composition with or without
26245 alternate chars. */
26246 left
= (leftmost
+ rightmost
- width
) / 2;
26247 btm
= - descent
+ boff
;
26248 if (font
->relative_compose
26249 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26250 || NILP (Faref (Vignore_relative_composition
,
26251 make_number (ch
)))))
26254 if (- descent
>= font
->relative_compose
)
26255 /* One extra pixel between two glyphs. */
26257 else if (ascent
<= 0)
26258 /* One extra pixel between two glyphs. */
26259 btm
= lowest
- 1 - ascent
- descent
;
26264 /* A composition rule is specified by an integer
26265 value that encodes global and new reference
26266 points (GREF and NREF). GREF and NREF are
26267 specified by numbers as below:
26269 0---1---2 -- ascent
26273 9--10--11 -- center
26275 ---3---4---5--- baseline
26277 6---7---8 -- descent
26279 int rule
= COMPOSITION_RULE (cmp
, i
);
26280 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26282 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26283 grefx
= gref
% 3, nrefx
= nref
% 3;
26284 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26286 xoff
= font_height
* (xoff
- 128) / 256;
26288 yoff
= font_height
* (yoff
- 128) / 256;
26291 + grefx
* (rightmost
- leftmost
) / 2
26292 - nrefx
* width
/ 2
26295 btm
= ((grefy
== 0 ? highest
26297 : grefy
== 2 ? lowest
26298 : (highest
+ lowest
) / 2)
26299 - (nrefy
== 0 ? ascent
+ descent
26300 : nrefy
== 1 ? descent
- boff
26302 : (ascent
+ descent
) / 2)
26306 cmp
->offsets
[i
* 2] = left
;
26307 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26309 /* Update the bounding box of the overall glyphs. */
26312 right
= left
+ width
;
26313 if (left
< leftmost
)
26315 if (right
> rightmost
)
26318 top
= btm
+ descent
+ ascent
;
26324 if (cmp
->lbearing
> left
+ lbearing
)
26325 cmp
->lbearing
= left
+ lbearing
;
26326 if (cmp
->rbearing
< left
+ rbearing
)
26327 cmp
->rbearing
= left
+ rbearing
;
26331 /* If there are glyphs whose x-offsets are negative,
26332 shift all glyphs to the right and make all x-offsets
26336 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26337 cmp
->offsets
[i
* 2] -= leftmost
;
26338 rightmost
-= leftmost
;
26339 cmp
->lbearing
-= leftmost
;
26340 cmp
->rbearing
-= leftmost
;
26343 if (left_padded
&& cmp
->lbearing
< 0)
26345 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26346 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26347 rightmost
-= cmp
->lbearing
;
26348 cmp
->rbearing
-= cmp
->lbearing
;
26351 if (right_padded
&& rightmost
< cmp
->rbearing
)
26353 rightmost
= cmp
->rbearing
;
26356 cmp
->pixel_width
= rightmost
;
26357 cmp
->ascent
= highest
;
26358 cmp
->descent
= - lowest
;
26359 if (cmp
->ascent
< font_ascent
)
26360 cmp
->ascent
= font_ascent
;
26361 if (cmp
->descent
< font_descent
)
26362 cmp
->descent
= font_descent
;
26366 && (cmp
->lbearing
< 0
26367 || cmp
->rbearing
> cmp
->pixel_width
))
26368 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26370 it
->pixel_width
= cmp
->pixel_width
;
26371 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26372 it
->descent
= it
->phys_descent
= cmp
->descent
;
26373 if (face
->box
!= FACE_NO_BOX
)
26375 int thick
= face
->box_line_width
;
26379 it
->ascent
+= thick
;
26380 it
->descent
+= thick
;
26385 if (it
->start_of_box_run_p
)
26386 it
->pixel_width
+= thick
;
26387 if (it
->end_of_box_run_p
)
26388 it
->pixel_width
+= thick
;
26391 /* If face has an overline, add the height of the overline
26392 (1 pixel) and a 1 pixel margin to the character height. */
26393 if (face
->overline_p
)
26394 it
->ascent
+= overline_margin
;
26396 take_vertical_position_into_account (it
);
26397 if (it
->ascent
< 0)
26399 if (it
->descent
< 0)
26402 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26403 append_composite_glyph (it
);
26405 else if (it
->what
== IT_COMPOSITION
)
26407 /* A dynamic (automatic) composition. */
26408 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26409 Lisp_Object gstring
;
26410 struct font_metrics metrics
;
26414 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26416 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26419 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26420 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26421 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26422 it
->descent
= it
->phys_descent
= metrics
.descent
;
26423 if (face
->box
!= FACE_NO_BOX
)
26425 int thick
= face
->box_line_width
;
26429 it
->ascent
+= thick
;
26430 it
->descent
+= thick
;
26435 if (it
->start_of_box_run_p
)
26436 it
->pixel_width
+= thick
;
26437 if (it
->end_of_box_run_p
)
26438 it
->pixel_width
+= thick
;
26440 /* If face has an overline, add the height of the overline
26441 (1 pixel) and a 1 pixel margin to the character height. */
26442 if (face
->overline_p
)
26443 it
->ascent
+= overline_margin
;
26444 take_vertical_position_into_account (it
);
26445 if (it
->ascent
< 0)
26447 if (it
->descent
< 0)
26451 append_composite_glyph (it
);
26453 else if (it
->what
== IT_GLYPHLESS
)
26454 produce_glyphless_glyph (it
, 0, Qnil
);
26455 else if (it
->what
== IT_IMAGE
)
26456 produce_image_glyph (it
);
26457 else if (it
->what
== IT_STRETCH
)
26458 produce_stretch_glyph (it
);
26461 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26462 because this isn't true for images with `:ascent 100'. */
26463 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26464 if (it
->area
== TEXT_AREA
)
26465 it
->current_x
+= it
->pixel_width
;
26467 if (extra_line_spacing
> 0)
26469 it
->descent
+= extra_line_spacing
;
26470 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26471 it
->max_extra_line_spacing
= extra_line_spacing
;
26474 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26475 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26476 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26477 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26481 Output LEN glyphs starting at START at the nominal cursor position.
26482 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26483 being updated, and UPDATED_AREA is the area of that row being updated. */
26486 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26487 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26489 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26491 eassert (updated_row
);
26492 /* When the window is hscrolled, cursor hpos can legitimately be out
26493 of bounds, but we draw the cursor at the corresponding window
26494 margin in that case. */
26495 if (!updated_row
->reversed_p
&& chpos
< 0)
26497 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26498 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26502 /* Write glyphs. */
26504 hpos
= start
- updated_row
->glyphs
[updated_area
];
26505 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26506 updated_row
, updated_area
,
26508 DRAW_NORMAL_TEXT
, 0);
26510 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26511 if (updated_area
== TEXT_AREA
26512 && w
->phys_cursor_on_p
26513 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26515 && chpos
< hpos
+ len
)
26516 w
->phys_cursor_on_p
= 0;
26520 /* Advance the output cursor. */
26521 w
->output_cursor
.hpos
+= len
;
26522 w
->output_cursor
.x
= x
;
26527 Insert LEN glyphs from START at the nominal cursor position. */
26530 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26531 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26534 int line_height
, shift_by_width
, shifted_region_width
;
26535 struct glyph_row
*row
;
26536 struct glyph
*glyph
;
26537 int frame_x
, frame_y
;
26540 eassert (updated_row
);
26542 f
= XFRAME (WINDOW_FRAME (w
));
26544 /* Get the height of the line we are in. */
26546 line_height
= row
->height
;
26548 /* Get the width of the glyphs to insert. */
26549 shift_by_width
= 0;
26550 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
26551 shift_by_width
+= glyph
->pixel_width
;
26553 /* Get the width of the region to shift right. */
26554 shifted_region_width
= (window_box_width (w
, updated_area
)
26555 - w
->output_cursor
.x
26559 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
26560 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
26562 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
26563 line_height
, shift_by_width
);
26565 /* Write the glyphs. */
26566 hpos
= start
- row
->glyphs
[updated_area
];
26567 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
26569 DRAW_NORMAL_TEXT
, 0);
26571 /* Advance the output cursor. */
26572 w
->output_cursor
.hpos
+= len
;
26573 w
->output_cursor
.x
+= shift_by_width
;
26579 Erase the current text line from the nominal cursor position
26580 (inclusive) to pixel column TO_X (exclusive). The idea is that
26581 everything from TO_X onward is already erased.
26583 TO_X is a pixel position relative to UPDATED_AREA of currently
26584 updated window W. TO_X == -1 means clear to the end of this area. */
26587 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
26588 enum glyph_row_area updated_area
, int to_x
)
26591 int max_x
, min_y
, max_y
;
26592 int from_x
, from_y
, to_y
;
26594 eassert (updated_row
);
26595 f
= XFRAME (w
->frame
);
26597 if (updated_row
->full_width_p
)
26598 max_x
= (WINDOW_PIXEL_WIDTH (w
)
26599 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
26601 max_x
= window_box_width (w
, updated_area
);
26602 max_y
= window_text_bottom_y (w
);
26604 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
26605 of window. For TO_X > 0, truncate to end of drawing area. */
26611 to_x
= min (to_x
, max_x
);
26613 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
26615 /* Notice if the cursor will be cleared by this operation. */
26616 if (!updated_row
->full_width_p
)
26617 notice_overwritten_cursor (w
, updated_area
,
26618 w
->output_cursor
.x
, -1,
26620 MATRIX_ROW_BOTTOM_Y (updated_row
));
26622 from_x
= w
->output_cursor
.x
;
26624 /* Translate to frame coordinates. */
26625 if (updated_row
->full_width_p
)
26627 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
26628 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
26632 int area_left
= window_box_left (w
, updated_area
);
26633 from_x
+= area_left
;
26637 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
26638 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
26639 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
26641 /* Prevent inadvertently clearing to end of the X window. */
26642 if (to_x
> from_x
&& to_y
> from_y
)
26645 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
26646 to_x
- from_x
, to_y
- from_y
);
26651 #endif /* HAVE_WINDOW_SYSTEM */
26655 /***********************************************************************
26657 ***********************************************************************/
26659 /* Value is the internal representation of the specified cursor type
26660 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
26661 of the bar cursor. */
26663 static enum text_cursor_kinds
26664 get_specified_cursor_type (Lisp_Object arg
, int *width
)
26666 enum text_cursor_kinds type
;
26671 if (EQ (arg
, Qbox
))
26672 return FILLED_BOX_CURSOR
;
26674 if (EQ (arg
, Qhollow
))
26675 return HOLLOW_BOX_CURSOR
;
26677 if (EQ (arg
, Qbar
))
26684 && EQ (XCAR (arg
), Qbar
)
26685 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26687 *width
= XINT (XCDR (arg
));
26691 if (EQ (arg
, Qhbar
))
26694 return HBAR_CURSOR
;
26698 && EQ (XCAR (arg
), Qhbar
)
26699 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
26701 *width
= XINT (XCDR (arg
));
26702 return HBAR_CURSOR
;
26705 /* Treat anything unknown as "hollow box cursor".
26706 It was bad to signal an error; people have trouble fixing
26707 .Xdefaults with Emacs, when it has something bad in it. */
26708 type
= HOLLOW_BOX_CURSOR
;
26713 /* Set the default cursor types for specified frame. */
26715 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
26720 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
26721 FRAME_CURSOR_WIDTH (f
) = width
;
26723 /* By default, set up the blink-off state depending on the on-state. */
26725 tem
= Fassoc (arg
, Vblink_cursor_alist
);
26728 FRAME_BLINK_OFF_CURSOR (f
)
26729 = get_specified_cursor_type (XCDR (tem
), &width
);
26730 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
26733 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
26735 /* Make sure the cursor gets redrawn. */
26736 f
->cursor_type_changed
= 1;
26740 #ifdef HAVE_WINDOW_SYSTEM
26742 /* Return the cursor we want to be displayed in window W. Return
26743 width of bar/hbar cursor through WIDTH arg. Return with
26744 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
26745 (i.e. if the `system caret' should track this cursor).
26747 In a mini-buffer window, we want the cursor only to appear if we
26748 are reading input from this window. For the selected window, we
26749 want the cursor type given by the frame parameter or buffer local
26750 setting of cursor-type. If explicitly marked off, draw no cursor.
26751 In all other cases, we want a hollow box cursor. */
26753 static enum text_cursor_kinds
26754 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
26755 int *active_cursor
)
26757 struct frame
*f
= XFRAME (w
->frame
);
26758 struct buffer
*b
= XBUFFER (w
->contents
);
26759 int cursor_type
= DEFAULT_CURSOR
;
26760 Lisp_Object alt_cursor
;
26761 int non_selected
= 0;
26763 *active_cursor
= 1;
26766 if (cursor_in_echo_area
26767 && FRAME_HAS_MINIBUF_P (f
)
26768 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
26770 if (w
== XWINDOW (echo_area_window
))
26772 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
26774 *width
= FRAME_CURSOR_WIDTH (f
);
26775 return FRAME_DESIRED_CURSOR (f
);
26778 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26781 *active_cursor
= 0;
26785 /* Detect a nonselected window or nonselected frame. */
26786 else if (w
!= XWINDOW (f
->selected_window
)
26787 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
26789 *active_cursor
= 0;
26791 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
26797 /* Never display a cursor in a window in which cursor-type is nil. */
26798 if (NILP (BVAR (b
, cursor_type
)))
26801 /* Get the normal cursor type for this window. */
26802 if (EQ (BVAR (b
, cursor_type
), Qt
))
26804 cursor_type
= FRAME_DESIRED_CURSOR (f
);
26805 *width
= FRAME_CURSOR_WIDTH (f
);
26808 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
26810 /* Use cursor-in-non-selected-windows instead
26811 for non-selected window or frame. */
26814 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
26815 if (!EQ (Qt
, alt_cursor
))
26816 return get_specified_cursor_type (alt_cursor
, width
);
26817 /* t means modify the normal cursor type. */
26818 if (cursor_type
== FILLED_BOX_CURSOR
)
26819 cursor_type
= HOLLOW_BOX_CURSOR
;
26820 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
26822 return cursor_type
;
26825 /* Use normal cursor if not blinked off. */
26826 if (!w
->cursor_off_p
)
26828 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
26830 if (cursor_type
== FILLED_BOX_CURSOR
)
26832 /* Using a block cursor on large images can be very annoying.
26833 So use a hollow cursor for "large" images.
26834 If image is not transparent (no mask), also use hollow cursor. */
26835 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
26836 if (img
!= NULL
&& IMAGEP (img
->spec
))
26838 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
26839 where N = size of default frame font size.
26840 This should cover most of the "tiny" icons people may use. */
26842 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
26843 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
26844 cursor_type
= HOLLOW_BOX_CURSOR
;
26847 else if (cursor_type
!= NO_CURSOR
)
26849 /* Display current only supports BOX and HOLLOW cursors for images.
26850 So for now, unconditionally use a HOLLOW cursor when cursor is
26851 not a solid box cursor. */
26852 cursor_type
= HOLLOW_BOX_CURSOR
;
26855 return cursor_type
;
26858 /* Cursor is blinked off, so determine how to "toggle" it. */
26860 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
26861 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
26862 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
26864 /* Then see if frame has specified a specific blink off cursor type. */
26865 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
26867 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
26868 return FRAME_BLINK_OFF_CURSOR (f
);
26872 /* Some people liked having a permanently visible blinking cursor,
26873 while others had very strong opinions against it. So it was
26874 decided to remove it. KFS 2003-09-03 */
26876 /* Finally perform built-in cursor blinking:
26877 filled box <-> hollow box
26878 wide [h]bar <-> narrow [h]bar
26879 narrow [h]bar <-> no cursor
26880 other type <-> no cursor */
26882 if (cursor_type
== FILLED_BOX_CURSOR
)
26883 return HOLLOW_BOX_CURSOR
;
26885 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
26888 return cursor_type
;
26896 /* Notice when the text cursor of window W has been completely
26897 overwritten by a drawing operation that outputs glyphs in AREA
26898 starting at X0 and ending at X1 in the line starting at Y0 and
26899 ending at Y1. X coordinates are area-relative. X1 < 0 means all
26900 the rest of the line after X0 has been written. Y coordinates
26901 are window-relative. */
26904 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
26905 int x0
, int x1
, int y0
, int y1
)
26907 int cx0
, cx1
, cy0
, cy1
;
26908 struct glyph_row
*row
;
26910 if (!w
->phys_cursor_on_p
)
26912 if (area
!= TEXT_AREA
)
26915 if (w
->phys_cursor
.vpos
< 0
26916 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
26917 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
26918 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
26921 if (row
->cursor_in_fringe_p
)
26923 row
->cursor_in_fringe_p
= 0;
26924 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
26925 w
->phys_cursor_on_p
= 0;
26929 cx0
= w
->phys_cursor
.x
;
26930 cx1
= cx0
+ w
->phys_cursor_width
;
26931 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
26934 /* The cursor image will be completely removed from the
26935 screen if the output area intersects the cursor area in
26936 y-direction. When we draw in [y0 y1[, and some part of
26937 the cursor is at y < y0, that part must have been drawn
26938 before. When scrolling, the cursor is erased before
26939 actually scrolling, so we don't come here. When not
26940 scrolling, the rows above the old cursor row must have
26941 changed, and in this case these rows must have written
26942 over the cursor image.
26944 Likewise if part of the cursor is below y1, with the
26945 exception of the cursor being in the first blank row at
26946 the buffer and window end because update_text_area
26947 doesn't draw that row. (Except when it does, but
26948 that's handled in update_text_area.) */
26950 cy0
= w
->phys_cursor
.y
;
26951 cy1
= cy0
+ w
->phys_cursor_height
;
26952 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
26955 w
->phys_cursor_on_p
= 0;
26958 #endif /* HAVE_WINDOW_SYSTEM */
26961 /************************************************************************
26963 ************************************************************************/
26965 #ifdef HAVE_WINDOW_SYSTEM
26968 Fix the display of area AREA of overlapping row ROW in window W
26969 with respect to the overlapping part OVERLAPS. */
26972 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
26973 enum glyph_row_area area
, int overlaps
)
26980 for (i
= 0; i
< row
->used
[area
];)
26982 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
26984 int start
= i
, start_x
= x
;
26988 x
+= row
->glyphs
[area
][i
].pixel_width
;
26991 while (i
< row
->used
[area
]
26992 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
26994 draw_glyphs (w
, start_x
, row
, area
,
26996 DRAW_NORMAL_TEXT
, overlaps
);
27000 x
+= row
->glyphs
[area
][i
].pixel_width
;
27010 Draw the cursor glyph of window W in glyph row ROW. See the
27011 comment of draw_glyphs for the meaning of HL. */
27014 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27015 enum draw_glyphs_face hl
)
27017 /* If cursor hpos is out of bounds, don't draw garbage. This can
27018 happen in mini-buffer windows when switching between echo area
27019 glyphs and mini-buffer. */
27020 if ((row
->reversed_p
27021 ? (w
->phys_cursor
.hpos
>= 0)
27022 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27024 int on_p
= w
->phys_cursor_on_p
;
27026 int hpos
= w
->phys_cursor
.hpos
;
27028 /* When the window is hscrolled, cursor hpos can legitimately be
27029 out of bounds, but we draw the cursor at the corresponding
27030 window margin in that case. */
27031 if (!row
->reversed_p
&& hpos
< 0)
27033 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27034 hpos
= row
->used
[TEXT_AREA
] - 1;
27036 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27038 w
->phys_cursor_on_p
= on_p
;
27040 if (hl
== DRAW_CURSOR
)
27041 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27042 /* When we erase the cursor, and ROW is overlapped by other
27043 rows, make sure that these overlapping parts of other rows
27045 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27047 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27049 if (row
> w
->current_matrix
->rows
27050 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27051 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27052 OVERLAPS_ERASED_CURSOR
);
27054 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27055 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27056 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27057 OVERLAPS_ERASED_CURSOR
);
27063 /* Erase the image of a cursor of window W from the screen. */
27066 erase_phys_cursor (struct window
*w
)
27068 struct frame
*f
= XFRAME (w
->frame
);
27069 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27070 int hpos
= w
->phys_cursor
.hpos
;
27071 int vpos
= w
->phys_cursor
.vpos
;
27072 int mouse_face_here_p
= 0;
27073 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27074 struct glyph_row
*cursor_row
;
27075 struct glyph
*cursor_glyph
;
27076 enum draw_glyphs_face hl
;
27078 /* No cursor displayed or row invalidated => nothing to do on the
27080 if (w
->phys_cursor_type
== NO_CURSOR
)
27081 goto mark_cursor_off
;
27083 /* VPOS >= active_glyphs->nrows means that window has been resized.
27084 Don't bother to erase the cursor. */
27085 if (vpos
>= active_glyphs
->nrows
)
27086 goto mark_cursor_off
;
27088 /* If row containing cursor is marked invalid, there is nothing we
27090 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27091 if (!cursor_row
->enabled_p
)
27092 goto mark_cursor_off
;
27094 /* If line spacing is > 0, old cursor may only be partially visible in
27095 window after split-window. So adjust visible height. */
27096 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27097 window_text_bottom_y (w
) - cursor_row
->y
);
27099 /* If row is completely invisible, don't attempt to delete a cursor which
27100 isn't there. This can happen if cursor is at top of a window, and
27101 we switch to a buffer with a header line in that window. */
27102 if (cursor_row
->visible_height
<= 0)
27103 goto mark_cursor_off
;
27105 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27106 if (cursor_row
->cursor_in_fringe_p
)
27108 cursor_row
->cursor_in_fringe_p
= 0;
27109 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27110 goto mark_cursor_off
;
27113 /* This can happen when the new row is shorter than the old one.
27114 In this case, either draw_glyphs or clear_end_of_line
27115 should have cleared the cursor. Note that we wouldn't be
27116 able to erase the cursor in this case because we don't have a
27117 cursor glyph at hand. */
27118 if ((cursor_row
->reversed_p
27119 ? (w
->phys_cursor
.hpos
< 0)
27120 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27121 goto mark_cursor_off
;
27123 /* When the window is hscrolled, cursor hpos can legitimately be out
27124 of bounds, but we draw the cursor at the corresponding window
27125 margin in that case. */
27126 if (!cursor_row
->reversed_p
&& hpos
< 0)
27128 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27129 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27131 /* If the cursor is in the mouse face area, redisplay that when
27132 we clear the cursor. */
27133 if (! NILP (hlinfo
->mouse_face_window
)
27134 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27135 /* Don't redraw the cursor's spot in mouse face if it is at the
27136 end of a line (on a newline). The cursor appears there, but
27137 mouse highlighting does not. */
27138 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27139 mouse_face_here_p
= 1;
27141 /* Maybe clear the display under the cursor. */
27142 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27145 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27148 cursor_glyph
= get_phys_cursor_glyph (w
);
27149 if (cursor_glyph
== NULL
)
27150 goto mark_cursor_off
;
27152 width
= cursor_glyph
->pixel_width
;
27153 left_x
= window_box_left_offset (w
, TEXT_AREA
);
27154 x
= w
->phys_cursor
.x
;
27156 width
-= left_x
- x
;
27157 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27158 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27159 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, max (x
, left_x
));
27162 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27165 /* Erase the cursor by redrawing the character underneath it. */
27166 if (mouse_face_here_p
)
27167 hl
= DRAW_MOUSE_FACE
;
27169 hl
= DRAW_NORMAL_TEXT
;
27170 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27173 w
->phys_cursor_on_p
= 0;
27174 w
->phys_cursor_type
= NO_CURSOR
;
27179 Display or clear cursor of window W. If ON is zero, clear the
27180 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27181 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27184 display_and_set_cursor (struct window
*w
, bool on
,
27185 int hpos
, int vpos
, int x
, int y
)
27187 struct frame
*f
= XFRAME (w
->frame
);
27188 int new_cursor_type
;
27189 int new_cursor_width
;
27191 struct glyph_row
*glyph_row
;
27192 struct glyph
*glyph
;
27194 /* This is pointless on invisible frames, and dangerous on garbaged
27195 windows and frames; in the latter case, the frame or window may
27196 be in the midst of changing its size, and x and y may be off the
27198 if (! FRAME_VISIBLE_P (f
)
27199 || FRAME_GARBAGED_P (f
)
27200 || vpos
>= w
->current_matrix
->nrows
27201 || hpos
>= w
->current_matrix
->matrix_w
)
27204 /* If cursor is off and we want it off, return quickly. */
27205 if (!on
&& !w
->phys_cursor_on_p
)
27208 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27209 /* If cursor row is not enabled, we don't really know where to
27210 display the cursor. */
27211 if (!glyph_row
->enabled_p
)
27213 w
->phys_cursor_on_p
= 0;
27218 if (!glyph_row
->exact_window_width_line_p
27219 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27220 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27222 eassert (input_blocked_p ());
27224 /* Set new_cursor_type to the cursor we want to be displayed. */
27225 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27226 &new_cursor_width
, &active_cursor
);
27228 /* If cursor is currently being shown and we don't want it to be or
27229 it is in the wrong place, or the cursor type is not what we want,
27231 if (w
->phys_cursor_on_p
27233 || w
->phys_cursor
.x
!= x
27234 || w
->phys_cursor
.y
!= y
27235 || new_cursor_type
!= w
->phys_cursor_type
27236 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27237 && new_cursor_width
!= w
->phys_cursor_width
)))
27238 erase_phys_cursor (w
);
27240 /* Don't check phys_cursor_on_p here because that flag is only set
27241 to zero in some cases where we know that the cursor has been
27242 completely erased, to avoid the extra work of erasing the cursor
27243 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27244 still not be visible, or it has only been partly erased. */
27247 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27248 w
->phys_cursor_height
= glyph_row
->height
;
27250 /* Set phys_cursor_.* before x_draw_.* is called because some
27251 of them may need the information. */
27252 w
->phys_cursor
.x
= x
;
27253 w
->phys_cursor
.y
= glyph_row
->y
;
27254 w
->phys_cursor
.hpos
= hpos
;
27255 w
->phys_cursor
.vpos
= vpos
;
27258 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27259 new_cursor_type
, new_cursor_width
,
27260 on
, active_cursor
);
27264 /* Switch the display of W's cursor on or off, according to the value
27268 update_window_cursor (struct window
*w
, bool on
)
27270 /* Don't update cursor in windows whose frame is in the process
27271 of being deleted. */
27272 if (w
->current_matrix
)
27274 int hpos
= w
->phys_cursor
.hpos
;
27275 int vpos
= w
->phys_cursor
.vpos
;
27276 struct glyph_row
*row
;
27278 if (vpos
>= w
->current_matrix
->nrows
27279 || hpos
>= w
->current_matrix
->matrix_w
)
27282 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27284 /* When the window is hscrolled, cursor hpos can legitimately be
27285 out of bounds, but we draw the cursor at the corresponding
27286 window margin in that case. */
27287 if (!row
->reversed_p
&& hpos
< 0)
27289 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27290 hpos
= row
->used
[TEXT_AREA
] - 1;
27293 display_and_set_cursor (w
, on
, hpos
, vpos
,
27294 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27300 /* Call update_window_cursor with parameter ON_P on all leaf windows
27301 in the window tree rooted at W. */
27304 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27308 if (WINDOWP (w
->contents
))
27309 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27311 update_window_cursor (w
, on_p
);
27313 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27319 Display the cursor on window W, or clear it, according to ON_P.
27320 Don't change the cursor's position. */
27323 x_update_cursor (struct frame
*f
, bool on_p
)
27325 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27330 Clear the cursor of window W to background color, and mark the
27331 cursor as not shown. This is used when the text where the cursor
27332 is about to be rewritten. */
27335 x_clear_cursor (struct window
*w
)
27337 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27338 update_window_cursor (w
, 0);
27341 #endif /* HAVE_WINDOW_SYSTEM */
27343 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27346 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27347 int start_hpos
, int end_hpos
,
27348 enum draw_glyphs_face draw
)
27350 #ifdef HAVE_WINDOW_SYSTEM
27351 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27353 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27357 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27358 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27362 /* Display the active region described by mouse_face_* according to DRAW. */
27365 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27367 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27368 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27370 if (/* If window is in the process of being destroyed, don't bother
27372 w
->current_matrix
!= NULL
27373 /* Don't update mouse highlight if hidden. */
27374 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27375 /* Recognize when we are called to operate on rows that don't exist
27376 anymore. This can happen when a window is split. */
27377 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27379 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27380 struct glyph_row
*row
, *first
, *last
;
27382 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27383 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27385 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27387 int start_hpos
, end_hpos
, start_x
;
27389 /* For all but the first row, the highlight starts at column 0. */
27392 /* R2L rows have BEG and END in reversed order, but the
27393 screen drawing geometry is always left to right. So
27394 we need to mirror the beginning and end of the
27395 highlighted area in R2L rows. */
27396 if (!row
->reversed_p
)
27398 start_hpos
= hlinfo
->mouse_face_beg_col
;
27399 start_x
= hlinfo
->mouse_face_beg_x
;
27401 else if (row
== last
)
27403 start_hpos
= hlinfo
->mouse_face_end_col
;
27404 start_x
= hlinfo
->mouse_face_end_x
;
27412 else if (row
->reversed_p
&& row
== last
)
27414 start_hpos
= hlinfo
->mouse_face_end_col
;
27415 start_x
= hlinfo
->mouse_face_end_x
;
27425 if (!row
->reversed_p
)
27426 end_hpos
= hlinfo
->mouse_face_end_col
;
27427 else if (row
== first
)
27428 end_hpos
= hlinfo
->mouse_face_beg_col
;
27431 end_hpos
= row
->used
[TEXT_AREA
];
27432 if (draw
== DRAW_NORMAL_TEXT
)
27433 row
->fill_line_p
= 1; /* Clear to end of line */
27436 else if (row
->reversed_p
&& row
== first
)
27437 end_hpos
= hlinfo
->mouse_face_beg_col
;
27440 end_hpos
= row
->used
[TEXT_AREA
];
27441 if (draw
== DRAW_NORMAL_TEXT
)
27442 row
->fill_line_p
= 1; /* Clear to end of line */
27445 if (end_hpos
> start_hpos
)
27447 draw_row_with_mouse_face (w
, start_x
, row
,
27448 start_hpos
, end_hpos
, draw
);
27451 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27455 #ifdef HAVE_WINDOW_SYSTEM
27456 /* When we've written over the cursor, arrange for it to
27457 be displayed again. */
27458 if (FRAME_WINDOW_P (f
)
27459 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27461 int hpos
= w
->phys_cursor
.hpos
;
27463 /* When the window is hscrolled, cursor hpos can legitimately be
27464 out of bounds, but we draw the cursor at the corresponding
27465 window margin in that case. */
27466 if (!row
->reversed_p
&& hpos
< 0)
27468 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27469 hpos
= row
->used
[TEXT_AREA
] - 1;
27472 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27473 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27476 #endif /* HAVE_WINDOW_SYSTEM */
27479 #ifdef HAVE_WINDOW_SYSTEM
27480 /* Change the mouse cursor. */
27481 if (FRAME_WINDOW_P (f
))
27483 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27484 if (draw
== DRAW_NORMAL_TEXT
27485 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27486 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27489 if (draw
== DRAW_MOUSE_FACE
)
27490 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27492 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27494 #endif /* HAVE_WINDOW_SYSTEM */
27498 Clear out the mouse-highlighted active region.
27499 Redraw it un-highlighted first. Value is non-zero if mouse
27500 face was actually drawn unhighlighted. */
27503 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27507 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27509 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27513 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27514 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27515 hlinfo
->mouse_face_window
= Qnil
;
27516 hlinfo
->mouse_face_overlay
= Qnil
;
27520 /* Return true if the coordinates HPOS and VPOS on windows W are
27521 within the mouse face on that window. */
27523 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
27525 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
27527 /* Quickly resolve the easy cases. */
27528 if (!(WINDOWP (hlinfo
->mouse_face_window
)
27529 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
27531 if (vpos
< hlinfo
->mouse_face_beg_row
27532 || vpos
> hlinfo
->mouse_face_end_row
)
27534 if (vpos
> hlinfo
->mouse_face_beg_row
27535 && vpos
< hlinfo
->mouse_face_end_row
)
27538 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
27540 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27542 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
27545 else if ((vpos
== hlinfo
->mouse_face_beg_row
27546 && hpos
>= hlinfo
->mouse_face_beg_col
)
27547 || (vpos
== hlinfo
->mouse_face_end_row
27548 && hpos
< hlinfo
->mouse_face_end_col
))
27553 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
27555 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
27558 else if ((vpos
== hlinfo
->mouse_face_beg_row
27559 && hpos
<= hlinfo
->mouse_face_beg_col
)
27560 || (vpos
== hlinfo
->mouse_face_end_row
27561 && hpos
> hlinfo
->mouse_face_end_col
))
27569 True if physical cursor of window W is within mouse face. */
27572 cursor_in_mouse_face_p (struct window
*w
)
27574 int hpos
= w
->phys_cursor
.hpos
;
27575 int vpos
= w
->phys_cursor
.vpos
;
27576 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27578 /* When the window is hscrolled, cursor hpos can legitimately be out
27579 of bounds, but we draw the cursor at the corresponding window
27580 margin in that case. */
27581 if (!row
->reversed_p
&& hpos
< 0)
27583 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27584 hpos
= row
->used
[TEXT_AREA
] - 1;
27586 return coords_in_mouse_face_p (w
, hpos
, vpos
);
27591 /* Find the glyph rows START_ROW and END_ROW of window W that display
27592 characters between buffer positions START_CHARPOS and END_CHARPOS
27593 (excluding END_CHARPOS). DISP_STRING is a display string that
27594 covers these buffer positions. This is similar to
27595 row_containing_pos, but is more accurate when bidi reordering makes
27596 buffer positions change non-linearly with glyph rows. */
27598 rows_from_pos_range (struct window
*w
,
27599 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
27600 Lisp_Object disp_string
,
27601 struct glyph_row
**start
, struct glyph_row
**end
)
27603 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27604 int last_y
= window_text_bottom_y (w
);
27605 struct glyph_row
*row
;
27610 while (!first
->enabled_p
27611 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
27614 /* Find the START row. */
27616 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
27619 /* A row can potentially be the START row if the range of the
27620 characters it displays intersects the range
27621 [START_CHARPOS..END_CHARPOS). */
27622 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
27623 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
27624 /* See the commentary in row_containing_pos, for the
27625 explanation of the complicated way to check whether
27626 some position is beyond the end of the characters
27627 displayed by a row. */
27628 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27629 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27630 && !row
->ends_at_zv_p
27631 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
27632 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
27633 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
27634 && !row
->ends_at_zv_p
27635 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
27637 /* Found a candidate row. Now make sure at least one of the
27638 glyphs it displays has a charpos from the range
27639 [START_CHARPOS..END_CHARPOS).
27641 This is not obvious because bidi reordering could make
27642 buffer positions of a row be 1,2,3,102,101,100, and if we
27643 want to highlight characters in [50..60), we don't want
27644 this row, even though [50..60) does intersect [1..103),
27645 the range of character positions given by the row's start
27646 and end positions. */
27647 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
27648 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
27652 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27653 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27654 /* A glyph that comes from DISP_STRING is by
27655 definition to be highlighted. */
27656 || EQ (g
->object
, disp_string
))
27665 /* Find the END row. */
27667 /* If the last row is partially visible, start looking for END
27668 from that row, instead of starting from FIRST. */
27669 && !(row
->enabled_p
27670 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
27672 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
27674 struct glyph_row
*next
= row
+ 1;
27675 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
27677 if (!next
->enabled_p
27678 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
27679 /* The first row >= START whose range of displayed characters
27680 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
27681 is the row END + 1. */
27682 || (start_charpos
< next_start
27683 && end_charpos
< next_start
)
27684 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27685 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27686 && !next
->ends_at_zv_p
27687 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
27688 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
27689 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
27690 && !next
->ends_at_zv_p
27691 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
27698 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
27699 but none of the characters it displays are in the range, it is
27701 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
27702 struct glyph
*s
= g
;
27703 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
27707 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
27708 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
27709 /* If the buffer position of the first glyph in
27710 the row is equal to END_CHARPOS, it means
27711 the last character to be highlighted is the
27712 newline of ROW, and we must consider NEXT as
27714 || (((!next
->reversed_p
&& g
== s
)
27715 || (next
->reversed_p
&& g
== e
- 1))
27716 && (g
->charpos
== end_charpos
27717 /* Special case for when NEXT is an
27718 empty line at ZV. */
27719 || (g
->charpos
== -1
27720 && !row
->ends_at_zv_p
27721 && next_start
== end_charpos
)))))
27722 /* A glyph that comes from DISP_STRING is by
27723 definition to be highlighted. */
27724 || EQ (g
->object
, disp_string
))
27733 /* The first row that ends at ZV must be the last to be
27735 else if (next
->ends_at_zv_p
)
27744 /* This function sets the mouse_face_* elements of HLINFO, assuming
27745 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
27746 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
27747 for the overlay or run of text properties specifying the mouse
27748 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
27749 before-string and after-string that must also be highlighted.
27750 DISP_STRING, if non-nil, is a display string that may cover some
27751 or all of the highlighted text. */
27754 mouse_face_from_buffer_pos (Lisp_Object window
,
27755 Mouse_HLInfo
*hlinfo
,
27756 ptrdiff_t mouse_charpos
,
27757 ptrdiff_t start_charpos
,
27758 ptrdiff_t end_charpos
,
27759 Lisp_Object before_string
,
27760 Lisp_Object after_string
,
27761 Lisp_Object disp_string
)
27763 struct window
*w
= XWINDOW (window
);
27764 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
27765 struct glyph_row
*r1
, *r2
;
27766 struct glyph
*glyph
, *end
;
27767 ptrdiff_t ignore
, pos
;
27770 eassert (NILP (disp_string
) || STRINGP (disp_string
));
27771 eassert (NILP (before_string
) || STRINGP (before_string
));
27772 eassert (NILP (after_string
) || STRINGP (after_string
));
27774 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
27775 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
27777 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27778 /* If the before-string or display-string contains newlines,
27779 rows_from_pos_range skips to its last row. Move back. */
27780 if (!NILP (before_string
) || !NILP (disp_string
))
27782 struct glyph_row
*prev
;
27783 while ((prev
= r1
- 1, prev
>= first
)
27784 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
27785 && prev
->used
[TEXT_AREA
] > 0)
27787 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
27788 glyph
= beg
+ prev
->used
[TEXT_AREA
];
27789 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
27791 || !(EQ (glyph
->object
, before_string
)
27792 || EQ (glyph
->object
, disp_string
)))
27799 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27800 hlinfo
->mouse_face_past_end
= 1;
27802 else if (!NILP (after_string
))
27804 /* If the after-string has newlines, advance to its last row. */
27805 struct glyph_row
*next
;
27806 struct glyph_row
*last
27807 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
27809 for (next
= r2
+ 1;
27811 && next
->used
[TEXT_AREA
] > 0
27812 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
27816 /* The rest of the display engine assumes that mouse_face_beg_row is
27817 either above mouse_face_end_row or identical to it. But with
27818 bidi-reordered continued lines, the row for START_CHARPOS could
27819 be below the row for END_CHARPOS. If so, swap the rows and store
27820 them in correct order. */
27823 struct glyph_row
*tem
= r2
;
27829 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
27830 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
27832 /* For a bidi-reordered row, the positions of BEFORE_STRING,
27833 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
27834 could be anywhere in the row and in any order. The strategy
27835 below is to find the leftmost and the rightmost glyph that
27836 belongs to either of these 3 strings, or whose position is
27837 between START_CHARPOS and END_CHARPOS, and highlight all the
27838 glyphs between those two. This may cover more than just the text
27839 between START_CHARPOS and END_CHARPOS if the range of characters
27840 strides the bidi level boundary, e.g. if the beginning is in R2L
27841 text while the end is in L2R text or vice versa. */
27842 if (!r1
->reversed_p
)
27844 /* This row is in a left to right paragraph. Scan it left to
27846 glyph
= r1
->glyphs
[TEXT_AREA
];
27847 end
= glyph
+ r1
->used
[TEXT_AREA
];
27850 /* Skip truncation glyphs at the start of the glyph row. */
27851 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27853 && INTEGERP (glyph
->object
)
27854 && glyph
->charpos
< 0;
27856 x
+= glyph
->pixel_width
;
27858 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27859 or DISP_STRING, and the first glyph from buffer whose
27860 position is between START_CHARPOS and END_CHARPOS. */
27862 && !INTEGERP (glyph
->object
)
27863 && !EQ (glyph
->object
, disp_string
)
27864 && !(BUFFERP (glyph
->object
)
27865 && (glyph
->charpos
>= start_charpos
27866 && glyph
->charpos
< end_charpos
));
27869 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27870 are present at buffer positions between START_CHARPOS and
27871 END_CHARPOS, or if they come from an overlay. */
27872 if (EQ (glyph
->object
, before_string
))
27874 pos
= string_buffer_position (before_string
,
27876 /* If pos == 0, it means before_string came from an
27877 overlay, not from a buffer position. */
27878 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27881 else if (EQ (glyph
->object
, after_string
))
27883 pos
= string_buffer_position (after_string
, end_charpos
);
27884 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27887 x
+= glyph
->pixel_width
;
27889 hlinfo
->mouse_face_beg_x
= x
;
27890 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27894 /* This row is in a right to left paragraph. Scan it right to
27898 end
= r1
->glyphs
[TEXT_AREA
] - 1;
27899 glyph
= end
+ r1
->used
[TEXT_AREA
];
27901 /* Skip truncation glyphs at the start of the glyph row. */
27902 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
27904 && INTEGERP (glyph
->object
)
27905 && glyph
->charpos
< 0;
27909 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
27910 or DISP_STRING, and the first glyph from buffer whose
27911 position is between START_CHARPOS and END_CHARPOS. */
27913 && !INTEGERP (glyph
->object
)
27914 && !EQ (glyph
->object
, disp_string
)
27915 && !(BUFFERP (glyph
->object
)
27916 && (glyph
->charpos
>= start_charpos
27917 && glyph
->charpos
< end_charpos
));
27920 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27921 are present at buffer positions between START_CHARPOS and
27922 END_CHARPOS, or if they come from an overlay. */
27923 if (EQ (glyph
->object
, before_string
))
27925 pos
= string_buffer_position (before_string
, start_charpos
);
27926 /* If pos == 0, it means before_string came from an
27927 overlay, not from a buffer position. */
27928 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27931 else if (EQ (glyph
->object
, after_string
))
27933 pos
= string_buffer_position (after_string
, end_charpos
);
27934 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27939 glyph
++; /* first glyph to the right of the highlighted area */
27940 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
27941 x
+= g
->pixel_width
;
27942 hlinfo
->mouse_face_beg_x
= x
;
27943 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
27946 /* If the highlight ends in a different row, compute GLYPH and END
27947 for the end row. Otherwise, reuse the values computed above for
27948 the row where the highlight begins. */
27951 if (!r2
->reversed_p
)
27953 glyph
= r2
->glyphs
[TEXT_AREA
];
27954 end
= glyph
+ r2
->used
[TEXT_AREA
];
27959 end
= r2
->glyphs
[TEXT_AREA
] - 1;
27960 glyph
= end
+ r2
->used
[TEXT_AREA
];
27964 if (!r2
->reversed_p
)
27966 /* Skip truncation and continuation glyphs near the end of the
27967 row, and also blanks and stretch glyphs inserted by
27968 extend_face_to_end_of_line. */
27970 && INTEGERP ((end
- 1)->object
))
27972 /* Scan the rest of the glyph row from the end, looking for the
27973 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
27974 DISP_STRING, or whose position is between START_CHARPOS
27978 && !INTEGERP (end
->object
)
27979 && !EQ (end
->object
, disp_string
)
27980 && !(BUFFERP (end
->object
)
27981 && (end
->charpos
>= start_charpos
27982 && end
->charpos
< end_charpos
));
27985 /* BEFORE_STRING or AFTER_STRING are only relevant if they
27986 are present at buffer positions between START_CHARPOS and
27987 END_CHARPOS, or if they come from an overlay. */
27988 if (EQ (end
->object
, before_string
))
27990 pos
= string_buffer_position (before_string
, start_charpos
);
27991 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
27994 else if (EQ (end
->object
, after_string
))
27996 pos
= string_buffer_position (after_string
, end_charpos
);
27997 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28001 /* Find the X coordinate of the last glyph to be highlighted. */
28002 for (; glyph
<= end
; ++glyph
)
28003 x
+= glyph
->pixel_width
;
28005 hlinfo
->mouse_face_end_x
= x
;
28006 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28010 /* Skip truncation and continuation glyphs near the end of the
28011 row, and also blanks and stretch glyphs inserted by
28012 extend_face_to_end_of_line. */
28016 && INTEGERP (end
->object
))
28018 x
+= end
->pixel_width
;
28021 /* Scan the rest of the glyph row from the end, looking for the
28022 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28023 DISP_STRING, or whose position is between START_CHARPOS
28027 && !INTEGERP (end
->object
)
28028 && !EQ (end
->object
, disp_string
)
28029 && !(BUFFERP (end
->object
)
28030 && (end
->charpos
>= start_charpos
28031 && end
->charpos
< end_charpos
));
28034 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28035 are present at buffer positions between START_CHARPOS and
28036 END_CHARPOS, or if they come from an overlay. */
28037 if (EQ (end
->object
, before_string
))
28039 pos
= string_buffer_position (before_string
, start_charpos
);
28040 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28043 else if (EQ (end
->object
, after_string
))
28045 pos
= string_buffer_position (after_string
, end_charpos
);
28046 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28049 x
+= end
->pixel_width
;
28051 /* If we exited the above loop because we arrived at the last
28052 glyph of the row, and its buffer position is still not in
28053 range, it means the last character in range is the preceding
28054 newline. Bump the end column and x values to get past the
28057 && BUFFERP (end
->object
)
28058 && (end
->charpos
< start_charpos
28059 || end
->charpos
>= end_charpos
))
28061 x
+= end
->pixel_width
;
28064 hlinfo
->mouse_face_end_x
= x
;
28065 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28068 hlinfo
->mouse_face_window
= window
;
28069 hlinfo
->mouse_face_face_id
28070 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28072 !hlinfo
->mouse_face_hidden
, -1);
28073 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28076 /* The following function is not used anymore (replaced with
28077 mouse_face_from_string_pos), but I leave it here for the time
28078 being, in case someone would. */
28080 #if 0 /* not used */
28082 /* Find the position of the glyph for position POS in OBJECT in
28083 window W's current matrix, and return in *X, *Y the pixel
28084 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28086 RIGHT_P non-zero means return the position of the right edge of the
28087 glyph, RIGHT_P zero means return the left edge position.
28089 If no glyph for POS exists in the matrix, return the position of
28090 the glyph with the next smaller position that is in the matrix, if
28091 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28092 exists in the matrix, return the position of the glyph with the
28093 next larger position in OBJECT.
28095 Value is non-zero if a glyph was found. */
28098 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28099 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28101 int yb
= window_text_bottom_y (w
);
28102 struct glyph_row
*r
;
28103 struct glyph
*best_glyph
= NULL
;
28104 struct glyph_row
*best_row
= NULL
;
28107 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28108 r
->enabled_p
&& r
->y
< yb
;
28111 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28112 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28115 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28116 if (EQ (g
->object
, object
))
28118 if (g
->charpos
== pos
)
28125 else if (best_glyph
== NULL
28126 || ((eabs (g
->charpos
- pos
)
28127 < eabs (best_glyph
->charpos
- pos
))
28130 : g
->charpos
> pos
)))
28144 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28148 *x
+= best_glyph
->pixel_width
;
28153 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28156 return best_glyph
!= NULL
;
28158 #endif /* not used */
28160 /* Find the positions of the first and the last glyphs in window W's
28161 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28162 (assumed to be a string), and return in HLINFO's mouse_face_*
28163 members the pixel and column/row coordinates of those glyphs. */
28166 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28167 Lisp_Object object
,
28168 ptrdiff_t startpos
, ptrdiff_t endpos
)
28170 int yb
= window_text_bottom_y (w
);
28171 struct glyph_row
*r
;
28172 struct glyph
*g
, *e
;
28176 /* Find the glyph row with at least one position in the range
28177 [STARTPOS..ENDPOS), and the first glyph in that row whose
28178 position belongs to that range. */
28179 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28180 r
->enabled_p
&& r
->y
< yb
;
28183 if (!r
->reversed_p
)
28185 g
= r
->glyphs
[TEXT_AREA
];
28186 e
= g
+ r
->used
[TEXT_AREA
];
28187 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28188 if (EQ (g
->object
, object
)
28189 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28191 hlinfo
->mouse_face_beg_row
28192 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28193 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28194 hlinfo
->mouse_face_beg_x
= gx
;
28203 e
= r
->glyphs
[TEXT_AREA
];
28204 g
= e
+ r
->used
[TEXT_AREA
];
28205 for ( ; g
> e
; --g
)
28206 if (EQ ((g
-1)->object
, object
)
28207 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28209 hlinfo
->mouse_face_beg_row
28210 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28211 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28212 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28213 gx
+= g1
->pixel_width
;
28214 hlinfo
->mouse_face_beg_x
= gx
;
28226 /* Starting with the next row, look for the first row which does NOT
28227 include any glyphs whose positions are in the range. */
28228 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28230 g
= r
->glyphs
[TEXT_AREA
];
28231 e
= g
+ r
->used
[TEXT_AREA
];
28233 for ( ; g
< e
; ++g
)
28234 if (EQ (g
->object
, object
)
28235 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28244 /* The highlighted region ends on the previous row. */
28247 /* Set the end row. */
28248 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28250 /* Compute and set the end column and the end column's horizontal
28251 pixel coordinate. */
28252 if (!r
->reversed_p
)
28254 g
= r
->glyphs
[TEXT_AREA
];
28255 e
= g
+ r
->used
[TEXT_AREA
];
28256 for ( ; e
> g
; --e
)
28257 if (EQ ((e
-1)->object
, object
)
28258 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28260 hlinfo
->mouse_face_end_col
= e
- g
;
28262 for (gx
= r
->x
; g
< e
; ++g
)
28263 gx
+= g
->pixel_width
;
28264 hlinfo
->mouse_face_end_x
= gx
;
28268 e
= r
->glyphs
[TEXT_AREA
];
28269 g
= e
+ r
->used
[TEXT_AREA
];
28270 for (gx
= r
->x
; e
< g
; ++e
)
28272 if (EQ (e
->object
, object
)
28273 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28275 gx
+= e
->pixel_width
;
28277 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28278 hlinfo
->mouse_face_end_x
= gx
;
28282 #ifdef HAVE_WINDOW_SYSTEM
28284 /* See if position X, Y is within a hot-spot of an image. */
28287 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28289 if (!CONSP (hot_spot
))
28292 if (EQ (XCAR (hot_spot
), Qrect
))
28294 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28295 Lisp_Object rect
= XCDR (hot_spot
);
28299 if (!CONSP (XCAR (rect
)))
28301 if (!CONSP (XCDR (rect
)))
28303 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28305 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28307 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28309 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28313 else if (EQ (XCAR (hot_spot
), Qcircle
))
28315 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28316 Lisp_Object circ
= XCDR (hot_spot
);
28317 Lisp_Object lr
, lx0
, ly0
;
28319 && CONSP (XCAR (circ
))
28320 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28321 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28322 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28324 double r
= XFLOATINT (lr
);
28325 double dx
= XINT (lx0
) - x
;
28326 double dy
= XINT (ly0
) - y
;
28327 return (dx
* dx
+ dy
* dy
<= r
* r
);
28330 else if (EQ (XCAR (hot_spot
), Qpoly
))
28332 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28333 if (VECTORP (XCDR (hot_spot
)))
28335 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28336 Lisp_Object
*poly
= v
->contents
;
28337 ptrdiff_t n
= v
->header
.size
;
28340 Lisp_Object lx
, ly
;
28343 /* Need an even number of coordinates, and at least 3 edges. */
28344 if (n
< 6 || n
& 1)
28347 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28348 If count is odd, we are inside polygon. Pixels on edges
28349 may or may not be included depending on actual geometry of the
28351 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28352 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28354 x0
= XINT (lx
), y0
= XINT (ly
);
28355 for (i
= 0; i
< n
; i
+= 2)
28357 int x1
= x0
, y1
= y0
;
28358 if ((lx
= poly
[i
], !INTEGERP (lx
))
28359 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28361 x0
= XINT (lx
), y0
= XINT (ly
);
28363 /* Does this segment cross the X line? */
28371 if (y
> y0
&& y
> y1
)
28373 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28383 find_hot_spot (Lisp_Object map
, int x
, int y
)
28385 while (CONSP (map
))
28387 if (CONSP (XCAR (map
))
28388 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28396 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28398 doc
: /* Lookup in image map MAP coordinates X and Y.
28399 An image map is an alist where each element has the format (AREA ID PLIST).
28400 An AREA is specified as either a rectangle, a circle, or a polygon:
28401 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28402 pixel coordinates of the upper left and bottom right corners.
28403 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28404 and the radius of the circle; r may be a float or integer.
28405 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28406 vector describes one corner in the polygon.
28407 Returns the alist element for the first matching AREA in MAP. */)
28408 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28416 return find_hot_spot (map
,
28417 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28418 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28422 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28424 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28426 /* Do not change cursor shape while dragging mouse. */
28427 if (!NILP (do_mouse_tracking
))
28430 if (!NILP (pointer
))
28432 if (EQ (pointer
, Qarrow
))
28433 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28434 else if (EQ (pointer
, Qhand
))
28435 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28436 else if (EQ (pointer
, Qtext
))
28437 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28438 else if (EQ (pointer
, intern ("hdrag")))
28439 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28440 else if (EQ (pointer
, intern ("nhdrag")))
28441 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28442 #ifdef HAVE_X_WINDOWS
28443 else if (EQ (pointer
, intern ("vdrag")))
28444 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28446 else if (EQ (pointer
, intern ("hourglass")))
28447 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28448 else if (EQ (pointer
, Qmodeline
))
28449 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28451 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28454 if (cursor
!= No_Cursor
)
28455 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28458 #endif /* HAVE_WINDOW_SYSTEM */
28460 /* Take proper action when mouse has moved to the mode or header line
28461 or marginal area AREA of window W, x-position X and y-position Y.
28462 X is relative to the start of the text display area of W, so the
28463 width of bitmap areas and scroll bars must be subtracted to get a
28464 position relative to the start of the mode line. */
28467 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28468 enum window_part area
)
28470 struct window
*w
= XWINDOW (window
);
28471 struct frame
*f
= XFRAME (w
->frame
);
28472 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28473 #ifdef HAVE_WINDOW_SYSTEM
28474 Display_Info
*dpyinfo
;
28476 Cursor cursor
= No_Cursor
;
28477 Lisp_Object pointer
= Qnil
;
28478 int dx
, dy
, width
, height
;
28480 Lisp_Object string
, object
= Qnil
;
28481 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28483 Lisp_Object mouse_face
;
28484 int original_x_pixel
= x
;
28485 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28486 struct glyph_row
*row
IF_LINT (= 0);
28488 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28493 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28494 returns them in row/column units! */
28495 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28496 &object
, &dx
, &dy
, &width
, &height
);
28498 row
= (area
== ON_MODE_LINE
28499 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28500 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28502 /* Find the glyph under the mouse pointer. */
28503 if (row
->mode_line_p
&& row
->enabled_p
)
28505 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28506 end
= glyph
+ row
->used
[TEXT_AREA
];
28508 for (x0
= original_x_pixel
;
28509 glyph
< end
&& x0
>= glyph
->pixel_width
;
28511 x0
-= glyph
->pixel_width
;
28519 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28520 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28521 returns them in row/column units! */
28522 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28523 &object
, &dx
, &dy
, &width
, &height
);
28528 #ifdef HAVE_WINDOW_SYSTEM
28529 if (IMAGEP (object
))
28531 Lisp_Object image_map
, hotspot
;
28532 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
28534 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
28536 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28540 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
28541 If so, we could look for mouse-enter, mouse-leave
28542 properties in PLIST (and do something...). */
28543 hotspot
= XCDR (hotspot
);
28544 if (CONSP (hotspot
)
28545 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28547 pointer
= Fplist_get (plist
, Qpointer
);
28548 if (NILP (pointer
))
28550 help
= Fplist_get (plist
, Qhelp_echo
);
28553 help_echo_string
= help
;
28554 XSETWINDOW (help_echo_window
, w
);
28555 help_echo_object
= w
->contents
;
28556 help_echo_pos
= charpos
;
28560 if (NILP (pointer
))
28561 pointer
= Fplist_get (XCDR (object
), QCpointer
);
28563 #endif /* HAVE_WINDOW_SYSTEM */
28565 if (STRINGP (string
))
28566 pos
= make_number (charpos
);
28568 /* Set the help text and mouse pointer. If the mouse is on a part
28569 of the mode line without any text (e.g. past the right edge of
28570 the mode line text), use the default help text and pointer. */
28571 if (STRINGP (string
) || area
== ON_MODE_LINE
)
28573 /* Arrange to display the help by setting the global variables
28574 help_echo_string, help_echo_object, and help_echo_pos. */
28577 if (STRINGP (string
))
28578 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
28582 help_echo_string
= help
;
28583 XSETWINDOW (help_echo_window
, w
);
28584 help_echo_object
= string
;
28585 help_echo_pos
= charpos
;
28587 else if (area
== ON_MODE_LINE
)
28589 Lisp_Object default_help
28590 = buffer_local_value (Qmode_line_default_help_echo
,
28593 if (STRINGP (default_help
))
28595 help_echo_string
= default_help
;
28596 XSETWINDOW (help_echo_window
, w
);
28597 help_echo_object
= Qnil
;
28598 help_echo_pos
= -1;
28603 #ifdef HAVE_WINDOW_SYSTEM
28604 /* Change the mouse pointer according to what is under it. */
28605 if (FRAME_WINDOW_P (f
))
28607 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
28609 || NILP (Vresize_mini_windows
));
28611 dpyinfo
= FRAME_DISPLAY_INFO (f
);
28612 if (STRINGP (string
))
28614 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28616 if (NILP (pointer
))
28617 pointer
= Fget_text_property (pos
, Qpointer
, string
);
28619 /* Change the mouse pointer according to what is under X/Y. */
28621 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
28624 map
= Fget_text_property (pos
, Qlocal_map
, string
);
28625 if (!KEYMAPP (map
))
28626 map
= Fget_text_property (pos
, Qkeymap
, string
);
28627 if (!KEYMAPP (map
) && draggable
)
28628 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
28631 else if (draggable
)
28632 /* Default mode-line pointer. */
28633 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28638 /* Change the mouse face according to what is under X/Y. */
28639 if (STRINGP (string
))
28641 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
28642 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
28643 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28648 struct glyph
* tmp_glyph
;
28652 int total_pixel_width
;
28653 ptrdiff_t begpos
, endpos
, ignore
;
28657 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
28658 Qmouse_face
, string
, Qnil
);
28664 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
28666 endpos
= SCHARS (string
);
28670 /* Calculate the glyph position GPOS of GLYPH in the
28671 displayed string, relative to the beginning of the
28672 highlighted part of the string.
28674 Note: GPOS is different from CHARPOS. CHARPOS is the
28675 position of GLYPH in the internal string object. A mode
28676 line string format has structures which are converted to
28677 a flattened string by the Emacs Lisp interpreter. The
28678 internal string is an element of those structures. The
28679 displayed string is the flattened string. */
28680 tmp_glyph
= row_start_glyph
;
28681 while (tmp_glyph
< glyph
28682 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28683 && begpos
<= tmp_glyph
->charpos
28684 && tmp_glyph
->charpos
< endpos
)))
28686 gpos
= glyph
- tmp_glyph
;
28688 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
28689 the highlighted part of the displayed string to which
28690 GLYPH belongs. Note: GSEQ_LENGTH is different from
28691 SCHARS (STRING), because the latter returns the length of
28692 the internal string. */
28693 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
28695 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
28696 && begpos
<= tmp_glyph
->charpos
28697 && tmp_glyph
->charpos
< endpos
));
28700 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
28702 /* Calculate the total pixel width of all the glyphs between
28703 the beginning of the highlighted area and GLYPH. */
28704 total_pixel_width
= 0;
28705 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
28706 total_pixel_width
+= tmp_glyph
->pixel_width
;
28708 /* Pre calculation of re-rendering position. Note: X is in
28709 column units here, after the call to mode_line_string or
28710 marginal_area_string. */
28712 vpos
= (area
== ON_MODE_LINE
28713 ? (w
->current_matrix
)->nrows
- 1
28716 /* If GLYPH's position is included in the region that is
28717 already drawn in mouse face, we have nothing to do. */
28718 if ( EQ (window
, hlinfo
->mouse_face_window
)
28719 && (!row
->reversed_p
28720 ? (hlinfo
->mouse_face_beg_col
<= hpos
28721 && hpos
< hlinfo
->mouse_face_end_col
)
28722 /* In R2L rows we swap BEG and END, see below. */
28723 : (hlinfo
->mouse_face_end_col
<= hpos
28724 && hpos
< hlinfo
->mouse_face_beg_col
))
28725 && hlinfo
->mouse_face_beg_row
== vpos
)
28728 if (clear_mouse_face (hlinfo
))
28729 cursor
= No_Cursor
;
28731 if (!row
->reversed_p
)
28733 hlinfo
->mouse_face_beg_col
= hpos
;
28734 hlinfo
->mouse_face_beg_x
= original_x_pixel
28735 - (total_pixel_width
+ dx
);
28736 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
28737 hlinfo
->mouse_face_end_x
= 0;
28741 /* In R2L rows, show_mouse_face expects BEG and END
28742 coordinates to be swapped. */
28743 hlinfo
->mouse_face_end_col
= hpos
;
28744 hlinfo
->mouse_face_end_x
= original_x_pixel
28745 - (total_pixel_width
+ dx
);
28746 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
28747 hlinfo
->mouse_face_beg_x
= 0;
28750 hlinfo
->mouse_face_beg_row
= vpos
;
28751 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
28752 hlinfo
->mouse_face_past_end
= 0;
28753 hlinfo
->mouse_face_window
= window
;
28755 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
28760 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28762 if (NILP (pointer
))
28765 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
28766 clear_mouse_face (hlinfo
);
28768 #ifdef HAVE_WINDOW_SYSTEM
28769 if (FRAME_WINDOW_P (f
))
28770 define_frame_cursor1 (f
, cursor
, pointer
);
28776 Take proper action when the mouse has moved to position X, Y on
28777 frame F with regards to highlighting portions of display that have
28778 mouse-face properties. Also de-highlight portions of display where
28779 the mouse was before, set the mouse pointer shape as appropriate
28780 for the mouse coordinates, and activate help echo (tooltips).
28781 X and Y can be negative or out of range. */
28784 note_mouse_highlight (struct frame
*f
, int x
, int y
)
28786 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28787 enum window_part part
= ON_NOTHING
;
28788 Lisp_Object window
;
28790 Cursor cursor
= No_Cursor
;
28791 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
28794 /* When a menu is active, don't highlight because this looks odd. */
28795 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
28796 if (popup_activated ())
28800 if (!f
->glyphs_initialized_p
28801 || f
->pointer_invisible
)
28804 hlinfo
->mouse_face_mouse_x
= x
;
28805 hlinfo
->mouse_face_mouse_y
= y
;
28806 hlinfo
->mouse_face_mouse_frame
= f
;
28808 if (hlinfo
->mouse_face_defer
)
28811 /* Which window is that in? */
28812 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
28814 /* If displaying active text in another window, clear that. */
28815 if (! EQ (window
, hlinfo
->mouse_face_window
)
28816 /* Also clear if we move out of text area in same window. */
28817 || (!NILP (hlinfo
->mouse_face_window
)
28820 && part
!= ON_MODE_LINE
28821 && part
!= ON_HEADER_LINE
))
28822 clear_mouse_face (hlinfo
);
28824 /* Not on a window -> return. */
28825 if (!WINDOWP (window
))
28828 /* Reset help_echo_string. It will get recomputed below. */
28829 help_echo_string
= Qnil
;
28831 /* Convert to window-relative pixel coordinates. */
28832 w
= XWINDOW (window
);
28833 frame_to_window_pixel_xy (w
, &x
, &y
);
28835 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
28836 /* Handle tool-bar window differently since it doesn't display a
28838 if (EQ (window
, f
->tool_bar_window
))
28840 note_tool_bar_highlight (f
, x
, y
);
28845 /* Mouse is on the mode, header line or margin? */
28846 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
28847 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28849 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
28851 #ifdef HAVE_WINDOW_SYSTEM
28852 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
28854 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28855 /* Show non-text cursor (Bug#16647). */
28863 #ifdef HAVE_WINDOW_SYSTEM
28864 if (part
== ON_VERTICAL_BORDER
)
28866 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28867 help_echo_string
= build_string ("drag-mouse-1: resize");
28869 else if (part
== ON_RIGHT_DIVIDER
)
28871 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28872 help_echo_string
= build_string ("drag-mouse-1: resize");
28874 else if (part
== ON_BOTTOM_DIVIDER
)
28875 if (! WINDOW_BOTTOMMOST_P (w
)
28877 || NILP (Vresize_mini_windows
))
28879 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28880 help_echo_string
= build_string ("drag-mouse-1: resize");
28883 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28884 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
28885 || part
== ON_SCROLL_BAR
)
28886 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28888 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28891 /* Are we in a window whose display is up to date?
28892 And verify the buffer's text has not changed. */
28893 b
= XBUFFER (w
->contents
);
28894 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
28896 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
28898 struct glyph
*glyph
;
28899 Lisp_Object object
;
28900 Lisp_Object mouse_face
= Qnil
, position
;
28901 Lisp_Object
*overlay_vec
= NULL
;
28902 ptrdiff_t i
, noverlays
;
28903 struct buffer
*obuf
;
28904 ptrdiff_t obegv
, ozv
;
28907 /* Find the glyph under X/Y. */
28908 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
28910 #ifdef HAVE_WINDOW_SYSTEM
28911 /* Look for :pointer property on image. */
28912 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
28914 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
28915 if (img
!= NULL
&& IMAGEP (img
->spec
))
28917 Lisp_Object image_map
, hotspot
;
28918 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
28920 && (hotspot
= find_hot_spot (image_map
,
28921 glyph
->slice
.img
.x
+ dx
,
28922 glyph
->slice
.img
.y
+ dy
),
28924 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
28928 /* Could check XCAR (hotspot) to see if we enter/leave
28930 If so, we could look for mouse-enter, mouse-leave
28931 properties in PLIST (and do something...). */
28932 hotspot
= XCDR (hotspot
);
28933 if (CONSP (hotspot
)
28934 && (plist
= XCAR (hotspot
), CONSP (plist
)))
28936 pointer
= Fplist_get (plist
, Qpointer
);
28937 if (NILP (pointer
))
28939 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
28940 if (!NILP (help_echo_string
))
28942 help_echo_window
= window
;
28943 help_echo_object
= glyph
->object
;
28944 help_echo_pos
= glyph
->charpos
;
28948 if (NILP (pointer
))
28949 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
28952 #endif /* HAVE_WINDOW_SYSTEM */
28954 /* Clear mouse face if X/Y not over text. */
28956 || area
!= TEXT_AREA
28957 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
28958 /* Glyph's OBJECT is an integer for glyphs inserted by the
28959 display engine for its internal purposes, like truncation
28960 and continuation glyphs and blanks beyond the end of
28961 line's text on text terminals. If we are over such a
28962 glyph, we are not over any text. */
28963 || INTEGERP (glyph
->object
)
28964 /* R2L rows have a stretch glyph at their front, which
28965 stands for no text, whereas L2R rows have no glyphs at
28966 all beyond the end of text. Treat such stretch glyphs
28967 like we do with NULL glyphs in L2R rows. */
28968 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
28969 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
28970 && glyph
->type
== STRETCH_GLYPH
28971 && glyph
->avoid_cursor_p
))
28973 if (clear_mouse_face (hlinfo
))
28974 cursor
= No_Cursor
;
28975 #ifdef HAVE_WINDOW_SYSTEM
28976 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
28978 if (area
!= TEXT_AREA
)
28979 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28981 pointer
= Vvoid_text_area_pointer
;
28987 pos
= glyph
->charpos
;
28988 object
= glyph
->object
;
28989 if (!STRINGP (object
) && !BUFFERP (object
))
28992 /* If we get an out-of-range value, return now; avoid an error. */
28993 if (BUFFERP (object
) && pos
> BUF_Z (b
))
28996 /* Make the window's buffer temporarily current for
28997 overlays_at and compute_char_face. */
28998 obuf
= current_buffer
;
28999 current_buffer
= b
;
29005 /* Is this char mouse-active or does it have help-echo? */
29006 position
= make_number (pos
);
29008 if (BUFFERP (object
))
29010 /* Put all the overlays we want in a vector in overlay_vec. */
29011 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29012 /* Sort overlays into increasing priority order. */
29013 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29018 if (NILP (Vmouse_highlight
))
29020 clear_mouse_face (hlinfo
);
29021 goto check_help_echo
;
29024 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29027 cursor
= No_Cursor
;
29029 /* Check mouse-face highlighting. */
29031 /* If there exists an overlay with mouse-face overlapping
29032 the one we are currently highlighting, we have to
29033 check if we enter the overlapping overlay, and then
29034 highlight only that. */
29035 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29036 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29038 /* Find the highest priority overlay with a mouse-face. */
29039 Lisp_Object overlay
= Qnil
;
29040 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29042 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29043 if (!NILP (mouse_face
))
29044 overlay
= overlay_vec
[i
];
29047 /* If we're highlighting the same overlay as before, there's
29048 no need to do that again. */
29049 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29050 goto check_help_echo
;
29051 hlinfo
->mouse_face_overlay
= overlay
;
29053 /* Clear the display of the old active region, if any. */
29054 if (clear_mouse_face (hlinfo
))
29055 cursor
= No_Cursor
;
29057 /* If no overlay applies, get a text property. */
29058 if (NILP (overlay
))
29059 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29061 /* Next, compute the bounds of the mouse highlighting and
29063 if (!NILP (mouse_face
) && STRINGP (object
))
29065 /* The mouse-highlighting comes from a display string
29066 with a mouse-face. */
29070 s
= Fprevious_single_property_change
29071 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29072 e
= Fnext_single_property_change
29073 (position
, Qmouse_face
, object
, Qnil
);
29075 s
= make_number (0);
29077 e
= make_number (SCHARS (object
));
29078 mouse_face_from_string_pos (w
, hlinfo
, object
,
29079 XINT (s
), XINT (e
));
29080 hlinfo
->mouse_face_past_end
= 0;
29081 hlinfo
->mouse_face_window
= window
;
29082 hlinfo
->mouse_face_face_id
29083 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29084 glyph
->face_id
, 1);
29085 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29086 cursor
= No_Cursor
;
29090 /* The mouse-highlighting, if any, comes from an overlay
29091 or text property in the buffer. */
29092 Lisp_Object buffer
IF_LINT (= Qnil
);
29093 Lisp_Object disp_string
IF_LINT (= Qnil
);
29095 if (STRINGP (object
))
29097 /* If we are on a display string with no mouse-face,
29098 check if the text under it has one. */
29099 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29100 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29101 pos
= string_buffer_position (object
, start
);
29104 mouse_face
= get_char_property_and_overlay
29105 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29106 buffer
= w
->contents
;
29107 disp_string
= object
;
29113 disp_string
= Qnil
;
29116 if (!NILP (mouse_face
))
29118 Lisp_Object before
, after
;
29119 Lisp_Object before_string
, after_string
;
29120 /* To correctly find the limits of mouse highlight
29121 in a bidi-reordered buffer, we must not use the
29122 optimization of limiting the search in
29123 previous-single-property-change and
29124 next-single-property-change, because
29125 rows_from_pos_range needs the real start and end
29126 positions to DTRT in this case. That's because
29127 the first row visible in a window does not
29128 necessarily display the character whose position
29129 is the smallest. */
29131 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29132 ? Fmarker_position (w
->start
)
29135 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29136 ? make_number (BUF_Z (XBUFFER (buffer
))
29137 - w
->window_end_pos
)
29140 if (NILP (overlay
))
29142 /* Handle the text property case. */
29143 before
= Fprevious_single_property_change
29144 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29145 after
= Fnext_single_property_change
29146 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29147 before_string
= after_string
= Qnil
;
29151 /* Handle the overlay case. */
29152 before
= Foverlay_start (overlay
);
29153 after
= Foverlay_end (overlay
);
29154 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29155 after_string
= Foverlay_get (overlay
, Qafter_string
);
29157 if (!STRINGP (before_string
)) before_string
= Qnil
;
29158 if (!STRINGP (after_string
)) after_string
= Qnil
;
29161 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29164 : XFASTINT (before
),
29166 ? BUF_Z (XBUFFER (buffer
))
29167 : XFASTINT (after
),
29168 before_string
, after_string
,
29170 cursor
= No_Cursor
;
29177 /* Look for a `help-echo' property. */
29178 if (NILP (help_echo_string
)) {
29179 Lisp_Object help
, overlay
;
29181 /* Check overlays first. */
29182 help
= overlay
= Qnil
;
29183 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29185 overlay
= overlay_vec
[i
];
29186 help
= Foverlay_get (overlay
, Qhelp_echo
);
29191 help_echo_string
= help
;
29192 help_echo_window
= window
;
29193 help_echo_object
= overlay
;
29194 help_echo_pos
= pos
;
29198 Lisp_Object obj
= glyph
->object
;
29199 ptrdiff_t charpos
= glyph
->charpos
;
29201 /* Try text properties. */
29204 && charpos
< SCHARS (obj
))
29206 help
= Fget_text_property (make_number (charpos
),
29210 /* If the string itself doesn't specify a help-echo,
29211 see if the buffer text ``under'' it does. */
29212 struct glyph_row
*r
29213 = MATRIX_ROW (w
->current_matrix
, vpos
);
29214 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29215 ptrdiff_t p
= string_buffer_position (obj
, start
);
29218 help
= Fget_char_property (make_number (p
),
29219 Qhelp_echo
, w
->contents
);
29228 else if (BUFFERP (obj
)
29231 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29236 help_echo_string
= help
;
29237 help_echo_window
= window
;
29238 help_echo_object
= obj
;
29239 help_echo_pos
= charpos
;
29244 #ifdef HAVE_WINDOW_SYSTEM
29245 /* Look for a `pointer' property. */
29246 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29248 /* Check overlays first. */
29249 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29250 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29252 if (NILP (pointer
))
29254 Lisp_Object obj
= glyph
->object
;
29255 ptrdiff_t charpos
= glyph
->charpos
;
29257 /* Try text properties. */
29260 && charpos
< SCHARS (obj
))
29262 pointer
= Fget_text_property (make_number (charpos
),
29264 if (NILP (pointer
))
29266 /* If the string itself doesn't specify a pointer,
29267 see if the buffer text ``under'' it does. */
29268 struct glyph_row
*r
29269 = MATRIX_ROW (w
->current_matrix
, vpos
);
29270 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29271 ptrdiff_t p
= string_buffer_position (obj
, start
);
29273 pointer
= Fget_char_property (make_number (p
),
29274 Qpointer
, w
->contents
);
29277 else if (BUFFERP (obj
)
29280 pointer
= Fget_text_property (make_number (charpos
),
29284 #endif /* HAVE_WINDOW_SYSTEM */
29288 current_buffer
= obuf
;
29293 #ifdef HAVE_WINDOW_SYSTEM
29294 if (FRAME_WINDOW_P (f
))
29295 define_frame_cursor1 (f
, cursor
, pointer
);
29297 /* This is here to prevent a compiler error, about "label at end of
29298 compound statement". */
29305 Clear any mouse-face on window W. This function is part of the
29306 redisplay interface, and is called from try_window_id and similar
29307 functions to ensure the mouse-highlight is off. */
29310 x_clear_window_mouse_face (struct window
*w
)
29312 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29313 Lisp_Object window
;
29316 XSETWINDOW (window
, w
);
29317 if (EQ (window
, hlinfo
->mouse_face_window
))
29318 clear_mouse_face (hlinfo
);
29324 Just discard the mouse face information for frame F, if any.
29325 This is used when the size of F is changed. */
29328 cancel_mouse_face (struct frame
*f
)
29330 Lisp_Object window
;
29331 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29333 window
= hlinfo
->mouse_face_window
;
29334 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29335 reset_mouse_highlight (hlinfo
);
29340 /***********************************************************************
29342 ***********************************************************************/
29344 #ifdef HAVE_WINDOW_SYSTEM
29346 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29347 which intersects rectangle R. R is in window-relative coordinates. */
29350 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29351 enum glyph_row_area area
)
29353 struct glyph
*first
= row
->glyphs
[area
];
29354 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29355 struct glyph
*last
;
29356 int first_x
, start_x
, x
;
29358 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29359 /* If row extends face to end of line write the whole line. */
29360 draw_glyphs (w
, 0, row
, area
,
29361 0, row
->used
[area
],
29362 DRAW_NORMAL_TEXT
, 0);
29365 /* Set START_X to the window-relative start position for drawing glyphs of
29366 AREA. The first glyph of the text area can be partially visible.
29367 The first glyphs of other areas cannot. */
29368 start_x
= window_box_left_offset (w
, area
);
29370 if (area
== TEXT_AREA
)
29373 /* Find the first glyph that must be redrawn. */
29375 && x
+ first
->pixel_width
< r
->x
)
29377 x
+= first
->pixel_width
;
29381 /* Find the last one. */
29385 && x
< r
->x
+ r
->width
)
29387 x
+= last
->pixel_width
;
29393 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29394 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29395 DRAW_NORMAL_TEXT
, 0);
29400 /* Redraw the parts of the glyph row ROW on window W intersecting
29401 rectangle R. R is in window-relative coordinates. Value is
29402 non-zero if mouse-face was overwritten. */
29405 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29407 eassert (row
->enabled_p
);
29409 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29410 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29411 0, row
->used
[TEXT_AREA
],
29412 DRAW_NORMAL_TEXT
, 0);
29415 if (row
->used
[LEFT_MARGIN_AREA
])
29416 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29417 if (row
->used
[TEXT_AREA
])
29418 expose_area (w
, row
, r
, TEXT_AREA
);
29419 if (row
->used
[RIGHT_MARGIN_AREA
])
29420 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29421 draw_row_fringe_bitmaps (w
, row
);
29424 return row
->mouse_face_p
;
29428 /* Redraw those parts of glyphs rows during expose event handling that
29429 overlap other rows. Redrawing of an exposed line writes over parts
29430 of lines overlapping that exposed line; this function fixes that.
29432 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29433 row in W's current matrix that is exposed and overlaps other rows.
29434 LAST_OVERLAPPING_ROW is the last such row. */
29437 expose_overlaps (struct window
*w
,
29438 struct glyph_row
*first_overlapping_row
,
29439 struct glyph_row
*last_overlapping_row
,
29442 struct glyph_row
*row
;
29444 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29445 if (row
->overlapping_p
)
29447 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29450 if (row
->used
[LEFT_MARGIN_AREA
])
29451 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29453 if (row
->used
[TEXT_AREA
])
29454 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29456 if (row
->used
[RIGHT_MARGIN_AREA
])
29457 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29463 /* Return non-zero if W's cursor intersects rectangle R. */
29466 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29468 XRectangle cr
, result
;
29469 struct glyph
*cursor_glyph
;
29470 struct glyph_row
*row
;
29472 if (w
->phys_cursor
.vpos
>= 0
29473 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29474 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29476 && row
->cursor_in_fringe_p
)
29478 /* Cursor is in the fringe. */
29479 cr
.x
= window_box_right_offset (w
,
29480 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29481 ? RIGHT_MARGIN_AREA
29484 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29485 cr
.height
= row
->height
;
29486 return x_intersect_rectangles (&cr
, r
, &result
);
29489 cursor_glyph
= get_phys_cursor_glyph (w
);
29492 /* r is relative to W's box, but w->phys_cursor.x is relative
29493 to left edge of W's TEXT area. Adjust it. */
29494 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29495 cr
.y
= w
->phys_cursor
.y
;
29496 cr
.width
= cursor_glyph
->pixel_width
;
29497 cr
.height
= w
->phys_cursor_height
;
29498 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29499 I assume the effect is the same -- and this is portable. */
29500 return x_intersect_rectangles (&cr
, r
, &result
);
29502 /* If we don't understand the format, pretend we're not in the hot-spot. */
29508 Draw a vertical window border to the right of window W if W doesn't
29509 have vertical scroll bars. */
29512 x_draw_vertical_border (struct window
*w
)
29514 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29516 /* We could do better, if we knew what type of scroll-bar the adjacent
29517 windows (on either side) have... But we don't :-(
29518 However, I think this works ok. ++KFS 2003-04-25 */
29520 /* Redraw borders between horizontally adjacent windows. Don't
29521 do it for frames with vertical scroll bars because either the
29522 right scroll bar of a window, or the left scroll bar of its
29523 neighbor will suffice as a border. */
29524 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
29527 /* Note: It is necessary to redraw both the left and the right
29528 borders, for when only this single window W is being
29530 if (!WINDOW_RIGHTMOST_P (w
)
29531 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
29533 int x0
, x1
, y0
, y1
;
29535 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29538 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29541 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
29544 if (!WINDOW_LEFTMOST_P (w
)
29545 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
29547 int x0
, x1
, y0
, y1
;
29549 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
29552 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
29555 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
29560 /* Draw window dividers for window W. */
29563 x_draw_right_divider (struct window
*w
)
29565 struct frame
*f
= WINDOW_XFRAME (w
);
29567 if (w
->mini
|| w
->pseudo_window_p
)
29569 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29571 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
29572 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29573 int y0
= WINDOW_TOP_EDGE_Y (w
);
29574 /* The bottom divider prevails. */
29575 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29577 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29582 x_draw_bottom_divider (struct window
*w
)
29584 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29586 if (w
->mini
|| w
->pseudo_window_p
)
29588 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29590 int x0
= WINDOW_LEFT_EDGE_X (w
);
29591 int x1
= WINDOW_RIGHT_EDGE_X (w
);
29592 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
29593 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
29595 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
29599 /* Redraw the part of window W intersection rectangle FR. Pixel
29600 coordinates in FR are frame-relative. Call this function with
29601 input blocked. Value is non-zero if the exposure overwrites
29605 expose_window (struct window
*w
, XRectangle
*fr
)
29607 struct frame
*f
= XFRAME (w
->frame
);
29609 int mouse_face_overwritten_p
= 0;
29611 /* If window is not yet fully initialized, do nothing. This can
29612 happen when toolkit scroll bars are used and a window is split.
29613 Reconfiguring the scroll bar will generate an expose for a newly
29615 if (w
->current_matrix
== NULL
)
29618 /* When we're currently updating the window, display and current
29619 matrix usually don't agree. Arrange for a thorough display
29621 if (w
->must_be_updated_p
)
29623 SET_FRAME_GARBAGED (f
);
29627 /* Frame-relative pixel rectangle of W. */
29628 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
29629 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
29630 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
29631 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
29633 if (x_intersect_rectangles (fr
, &wr
, &r
))
29635 int yb
= window_text_bottom_y (w
);
29636 struct glyph_row
*row
;
29637 int cursor_cleared_p
, phys_cursor_on_p
;
29638 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
29640 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
29641 r
.x
, r
.y
, r
.width
, r
.height
));
29643 /* Convert to window coordinates. */
29644 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
29645 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
29647 /* Turn off the cursor. */
29648 if (!w
->pseudo_window_p
29649 && phys_cursor_in_rect_p (w
, &r
))
29651 x_clear_cursor (w
);
29652 cursor_cleared_p
= 1;
29655 cursor_cleared_p
= 0;
29657 /* If the row containing the cursor extends face to end of line,
29658 then expose_area might overwrite the cursor outside the
29659 rectangle and thus notice_overwritten_cursor might clear
29660 w->phys_cursor_on_p. We remember the original value and
29661 check later if it is changed. */
29662 phys_cursor_on_p
= w
->phys_cursor_on_p
;
29664 /* Update lines intersecting rectangle R. */
29665 first_overlapping_row
= last_overlapping_row
= NULL
;
29666 for (row
= w
->current_matrix
->rows
;
29671 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
29673 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
29674 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
29675 || (r
.y
>= y0
&& r
.y
< y1
)
29676 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
29678 /* A header line may be overlapping, but there is no need
29679 to fix overlapping areas for them. KFS 2005-02-12 */
29680 if (row
->overlapping_p
&& !row
->mode_line_p
)
29682 if (first_overlapping_row
== NULL
)
29683 first_overlapping_row
= row
;
29684 last_overlapping_row
= row
;
29688 if (expose_line (w
, row
, &r
))
29689 mouse_face_overwritten_p
= 1;
29692 else if (row
->overlapping_p
)
29694 /* We must redraw a row overlapping the exposed area. */
29696 ? y0
+ row
->phys_height
> r
.y
29697 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
29699 if (first_overlapping_row
== NULL
)
29700 first_overlapping_row
= row
;
29701 last_overlapping_row
= row
;
29709 /* Display the mode line if there is one. */
29710 if (WINDOW_WANTS_MODELINE_P (w
)
29711 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
29713 && row
->y
< r
.y
+ r
.height
)
29715 if (expose_line (w
, row
, &r
))
29716 mouse_face_overwritten_p
= 1;
29719 if (!w
->pseudo_window_p
)
29721 /* Fix the display of overlapping rows. */
29722 if (first_overlapping_row
)
29723 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
29726 /* Draw border between windows. */
29727 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
29728 x_draw_right_divider (w
);
29730 x_draw_vertical_border (w
);
29732 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
29733 x_draw_bottom_divider (w
);
29735 /* Turn the cursor on again. */
29736 if (cursor_cleared_p
29737 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
29738 update_window_cursor (w
, 1);
29742 return mouse_face_overwritten_p
;
29747 /* Redraw (parts) of all windows in the window tree rooted at W that
29748 intersect R. R contains frame pixel coordinates. Value is
29749 non-zero if the exposure overwrites mouse-face. */
29752 expose_window_tree (struct window
*w
, XRectangle
*r
)
29754 struct frame
*f
= XFRAME (w
->frame
);
29755 int mouse_face_overwritten_p
= 0;
29757 while (w
&& !FRAME_GARBAGED_P (f
))
29759 if (WINDOWP (w
->contents
))
29760 mouse_face_overwritten_p
29761 |= expose_window_tree (XWINDOW (w
->contents
), r
);
29763 mouse_face_overwritten_p
|= expose_window (w
, r
);
29765 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
29768 return mouse_face_overwritten_p
;
29773 Redisplay an exposed area of frame F. X and Y are the upper-left
29774 corner of the exposed rectangle. W and H are width and height of
29775 the exposed area. All are pixel values. W or H zero means redraw
29776 the entire frame. */
29779 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
29782 int mouse_face_overwritten_p
= 0;
29784 TRACE ((stderr
, "expose_frame "));
29786 /* No need to redraw if frame will be redrawn soon. */
29787 if (FRAME_GARBAGED_P (f
))
29789 TRACE ((stderr
, " garbaged\n"));
29793 /* If basic faces haven't been realized yet, there is no point in
29794 trying to redraw anything. This can happen when we get an expose
29795 event while Emacs is starting, e.g. by moving another window. */
29796 if (FRAME_FACE_CACHE (f
) == NULL
29797 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
29799 TRACE ((stderr
, " no faces\n"));
29803 if (w
== 0 || h
== 0)
29806 r
.width
= FRAME_COLUMN_WIDTH (f
) * FRAME_COLS (f
);
29807 r
.height
= FRAME_LINE_HEIGHT (f
) * FRAME_LINES (f
);
29817 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
29818 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
29820 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
29821 if (WINDOWP (f
->tool_bar_window
))
29822 mouse_face_overwritten_p
29823 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
29826 #ifdef HAVE_X_WINDOWS
29828 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
29829 if (WINDOWP (f
->menu_bar_window
))
29830 mouse_face_overwritten_p
29831 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
29832 #endif /* not USE_X_TOOLKIT and not USE_GTK */
29836 /* Some window managers support a focus-follows-mouse style with
29837 delayed raising of frames. Imagine a partially obscured frame,
29838 and moving the mouse into partially obscured mouse-face on that
29839 frame. The visible part of the mouse-face will be highlighted,
29840 then the WM raises the obscured frame. With at least one WM, KDE
29841 2.1, Emacs is not getting any event for the raising of the frame
29842 (even tried with SubstructureRedirectMask), only Expose events.
29843 These expose events will draw text normally, i.e. not
29844 highlighted. Which means we must redo the highlight here.
29845 Subsume it under ``we love X''. --gerd 2001-08-15 */
29846 /* Included in Windows version because Windows most likely does not
29847 do the right thing if any third party tool offers
29848 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
29849 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
29851 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29852 if (f
== hlinfo
->mouse_face_mouse_frame
)
29854 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
29855 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
29856 clear_mouse_face (hlinfo
);
29857 note_mouse_highlight (f
, mouse_x
, mouse_y
);
29864 Determine the intersection of two rectangles R1 and R2. Return
29865 the intersection in *RESULT. Value is non-zero if RESULT is not
29869 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
29871 XRectangle
*left
, *right
;
29872 XRectangle
*upper
, *lower
;
29873 int intersection_p
= 0;
29875 /* Rearrange so that R1 is the left-most rectangle. */
29877 left
= r1
, right
= r2
;
29879 left
= r2
, right
= r1
;
29881 /* X0 of the intersection is right.x0, if this is inside R1,
29882 otherwise there is no intersection. */
29883 if (right
->x
<= left
->x
+ left
->width
)
29885 result
->x
= right
->x
;
29887 /* The right end of the intersection is the minimum of
29888 the right ends of left and right. */
29889 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
29892 /* Same game for Y. */
29894 upper
= r1
, lower
= r2
;
29896 upper
= r2
, lower
= r1
;
29898 /* The upper end of the intersection is lower.y0, if this is inside
29899 of upper. Otherwise, there is no intersection. */
29900 if (lower
->y
<= upper
->y
+ upper
->height
)
29902 result
->y
= lower
->y
;
29904 /* The lower end of the intersection is the minimum of the lower
29905 ends of upper and lower. */
29906 result
->height
= (min (lower
->y
+ lower
->height
,
29907 upper
->y
+ upper
->height
)
29909 intersection_p
= 1;
29913 return intersection_p
;
29916 #endif /* HAVE_WINDOW_SYSTEM */
29919 /***********************************************************************
29921 ***********************************************************************/
29924 syms_of_xdisp (void)
29928 Vwith_echo_area_save_vector
= Qnil
;
29929 staticpro (&Vwith_echo_area_save_vector
);
29931 Vmessage_stack
= Qnil
;
29932 staticpro (&Vmessage_stack
);
29934 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
29935 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
29937 message_dolog_marker1
= Fmake_marker ();
29938 staticpro (&message_dolog_marker1
);
29939 message_dolog_marker2
= Fmake_marker ();
29940 staticpro (&message_dolog_marker2
);
29941 message_dolog_marker3
= Fmake_marker ();
29942 staticpro (&message_dolog_marker3
);
29944 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
29945 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
29946 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
29947 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
29948 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
29949 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
29950 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
29951 DEFSYM (Qeval
, "eval");
29952 DEFSYM (QCdata
, ":data");
29953 DEFSYM (Qdisplay
, "display");
29954 DEFSYM (Qspace_width
, "space-width");
29955 DEFSYM (Qraise
, "raise");
29956 DEFSYM (Qslice
, "slice");
29957 DEFSYM (Qspace
, "space");
29958 DEFSYM (Qmargin
, "margin");
29959 DEFSYM (Qpointer
, "pointer");
29960 DEFSYM (Qleft_margin
, "left-margin");
29961 DEFSYM (Qright_margin
, "right-margin");
29962 DEFSYM (Qcenter
, "center");
29963 DEFSYM (Qline_height
, "line-height");
29964 DEFSYM (QCalign_to
, ":align-to");
29965 DEFSYM (QCrelative_width
, ":relative-width");
29966 DEFSYM (QCrelative_height
, ":relative-height");
29967 DEFSYM (QCeval
, ":eval");
29968 DEFSYM (QCpropertize
, ":propertize");
29969 DEFSYM (QCfile
, ":file");
29970 DEFSYM (Qfontified
, "fontified");
29971 DEFSYM (Qfontification_functions
, "fontification-functions");
29972 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
29973 DEFSYM (Qescape_glyph
, "escape-glyph");
29974 DEFSYM (Qnobreak_space
, "nobreak-space");
29975 DEFSYM (Qimage
, "image");
29976 DEFSYM (Qtext
, "text");
29977 DEFSYM (Qboth
, "both");
29978 DEFSYM (Qboth_horiz
, "both-horiz");
29979 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
29980 DEFSYM (QCmap
, ":map");
29981 DEFSYM (QCpointer
, ":pointer");
29982 DEFSYM (Qrect
, "rect");
29983 DEFSYM (Qcircle
, "circle");
29984 DEFSYM (Qpoly
, "poly");
29985 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
29986 DEFSYM (Qgrow_only
, "grow-only");
29987 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
29988 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
29989 DEFSYM (Qposition
, "position");
29990 DEFSYM (Qbuffer_position
, "buffer-position");
29991 DEFSYM (Qobject
, "object");
29992 DEFSYM (Qbar
, "bar");
29993 DEFSYM (Qhbar
, "hbar");
29994 DEFSYM (Qbox
, "box");
29995 DEFSYM (Qhollow
, "hollow");
29996 DEFSYM (Qhand
, "hand");
29997 DEFSYM (Qarrow
, "arrow");
29998 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30000 list_of_error
= list1 (list2 (intern_c_string ("error"),
30001 intern_c_string ("void-variable")));
30002 staticpro (&list_of_error
);
30004 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30005 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30006 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30007 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30009 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30010 staticpro (&echo_buffer
[0]);
30011 staticpro (&echo_buffer
[1]);
30013 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30014 staticpro (&echo_area_buffer
[0]);
30015 staticpro (&echo_area_buffer
[1]);
30017 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30018 staticpro (&Vmessages_buffer_name
);
30020 mode_line_proptrans_alist
= Qnil
;
30021 staticpro (&mode_line_proptrans_alist
);
30022 mode_line_string_list
= Qnil
;
30023 staticpro (&mode_line_string_list
);
30024 mode_line_string_face
= Qnil
;
30025 staticpro (&mode_line_string_face
);
30026 mode_line_string_face_prop
= Qnil
;
30027 staticpro (&mode_line_string_face_prop
);
30028 Vmode_line_unwind_vector
= Qnil
;
30029 staticpro (&Vmode_line_unwind_vector
);
30031 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30033 help_echo_string
= Qnil
;
30034 staticpro (&help_echo_string
);
30035 help_echo_object
= Qnil
;
30036 staticpro (&help_echo_object
);
30037 help_echo_window
= Qnil
;
30038 staticpro (&help_echo_window
);
30039 previous_help_echo_string
= Qnil
;
30040 staticpro (&previous_help_echo_string
);
30041 help_echo_pos
= -1;
30043 DEFSYM (Qright_to_left
, "right-to-left");
30044 DEFSYM (Qleft_to_right
, "left-to-right");
30046 #ifdef HAVE_WINDOW_SYSTEM
30047 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30048 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30049 For example, if a block cursor is over a tab, it will be drawn as
30050 wide as that tab on the display. */);
30051 x_stretch_cursor_p
= 0;
30054 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30055 doc
: /* Non-nil means highlight trailing whitespace.
30056 The face used for trailing whitespace is `trailing-whitespace'. */);
30057 Vshow_trailing_whitespace
= Qnil
;
30059 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30060 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30061 If the value is t, Emacs highlights non-ASCII chars which have the
30062 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30063 or `escape-glyph' face respectively.
30065 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30066 U+2011 (non-breaking hyphen) are affected.
30068 Any other non-nil value means to display these characters as a escape
30069 glyph followed by an ordinary space or hyphen.
30071 A value of nil means no special handling of these characters. */);
30072 Vnobreak_char_display
= Qt
;
30074 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30075 doc
: /* The pointer shape to show in void text areas.
30076 A value of nil means to show the text pointer. Other options are `arrow',
30077 `text', `hand', `vdrag', `hdrag', `modeline', and `hourglass'. */);
30078 Vvoid_text_area_pointer
= Qarrow
;
30080 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30081 doc
: /* Non-nil means don't actually do any redisplay.
30082 This is used for internal purposes. */);
30083 Vinhibit_redisplay
= Qnil
;
30085 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30086 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30087 Vglobal_mode_string
= Qnil
;
30089 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30090 doc
: /* Marker for where to display an arrow on top of the buffer text.
30091 This must be the beginning of a line in order to work.
30092 See also `overlay-arrow-string'. */);
30093 Voverlay_arrow_position
= Qnil
;
30095 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30096 doc
: /* String to display as an arrow in non-window frames.
30097 See also `overlay-arrow-position'. */);
30098 Voverlay_arrow_string
= build_pure_c_string ("=>");
30100 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30101 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30102 The symbols on this list are examined during redisplay to determine
30103 where to display overlay arrows. */);
30104 Voverlay_arrow_variable_list
30105 = list1 (intern_c_string ("overlay-arrow-position"));
30107 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30108 doc
: /* The number of lines to try scrolling a window by when point moves out.
30109 If that fails to bring point back on frame, point is centered instead.
30110 If this is zero, point is always centered after it moves off frame.
30111 If you want scrolling to always be a line at a time, you should set
30112 `scroll-conservatively' to a large value rather than set this to 1. */);
30114 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30115 doc
: /* Scroll up to this many lines, to bring point back on screen.
30116 If point moves off-screen, redisplay will scroll by up to
30117 `scroll-conservatively' lines in order to bring point just barely
30118 onto the screen again. If that cannot be done, then redisplay
30119 recenters point as usual.
30121 If the value is greater than 100, redisplay will never recenter point,
30122 but will always scroll just enough text to bring point into view, even
30123 if you move far away.
30125 A value of zero means always recenter point if it moves off screen. */);
30126 scroll_conservatively
= 0;
30128 DEFVAR_INT ("scroll-margin", scroll_margin
,
30129 doc
: /* Number of lines of margin at the top and bottom of a window.
30130 Recenter the window whenever point gets within this many lines
30131 of the top or bottom of the window. */);
30134 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30135 doc
: /* Pixels per inch value for non-window system displays.
30136 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30137 Vdisplay_pixels_per_inch
= make_float (72.0);
30140 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30143 DEFVAR_LISP ("truncate-partial-width-windows",
30144 Vtruncate_partial_width_windows
,
30145 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30146 For an integer value, truncate lines in each window narrower than the
30147 full frame width, provided the window width is less than that integer;
30148 otherwise, respect the value of `truncate-lines'.
30150 For any other non-nil value, truncate lines in all windows that do
30151 not span the full frame width.
30153 A value of nil means to respect the value of `truncate-lines'.
30155 If `word-wrap' is enabled, you might want to reduce this. */);
30156 Vtruncate_partial_width_windows
= make_number (50);
30158 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30159 doc
: /* Maximum buffer size for which line number should be displayed.
30160 If the buffer is bigger than this, the line number does not appear
30161 in the mode line. A value of nil means no limit. */);
30162 Vline_number_display_limit
= Qnil
;
30164 DEFVAR_INT ("line-number-display-limit-width",
30165 line_number_display_limit_width
,
30166 doc
: /* Maximum line width (in characters) for line number display.
30167 If the average length of the lines near point is bigger than this, then the
30168 line number may be omitted from the mode line. */);
30169 line_number_display_limit_width
= 200;
30171 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30172 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30173 highlight_nonselected_windows
= 0;
30175 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30176 doc
: /* Non-nil if more than one frame is visible on this display.
30177 Minibuffer-only frames don't count, but iconified frames do.
30178 This variable is not guaranteed to be accurate except while processing
30179 `frame-title-format' and `icon-title-format'. */);
30181 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30182 doc
: /* Template for displaying the title bar of visible frames.
30183 \(Assuming the window manager supports this feature.)
30185 This variable has the same structure as `mode-line-format', except that
30186 the %c and %l constructs are ignored. It is used only on frames for
30187 which no explicit name has been set \(see `modify-frame-parameters'). */);
30189 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30190 doc
: /* Template for displaying the title bar of an iconified frame.
30191 \(Assuming the window manager supports this feature.)
30192 This variable has the same structure as `mode-line-format' (which see),
30193 and is used only on frames for which no explicit name has been set
30194 \(see `modify-frame-parameters'). */);
30196 = Vframe_title_format
30197 = listn (CONSTYPE_PURE
, 3,
30198 intern_c_string ("multiple-frames"),
30199 build_pure_c_string ("%b"),
30200 listn (CONSTYPE_PURE
, 4,
30201 empty_unibyte_string
,
30202 intern_c_string ("invocation-name"),
30203 build_pure_c_string ("@"),
30204 intern_c_string ("system-name")));
30206 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30207 doc
: /* Maximum number of lines to keep in the message log buffer.
30208 If nil, disable message logging. If t, log messages but don't truncate
30209 the buffer when it becomes large. */);
30210 Vmessage_log_max
= make_number (1000);
30212 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30213 doc
: /* Functions called before redisplay, if window sizes have changed.
30214 The value should be a list of functions that take one argument.
30215 Just before redisplay, for each frame, if any of its windows have changed
30216 size since the last redisplay, or have been split or deleted,
30217 all the functions in the list are called, with the frame as argument. */);
30218 Vwindow_size_change_functions
= Qnil
;
30220 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30221 doc
: /* List of functions to call before redisplaying a window with scrolling.
30222 Each function is called with two arguments, the window and its new
30223 display-start position. Note that these functions are also called by
30224 `set-window-buffer'. Also note that the value of `window-end' is not
30225 valid when these functions are called.
30227 Warning: Do not use this feature to alter the way the window
30228 is scrolled. It is not designed for that, and such use probably won't
30230 Vwindow_scroll_functions
= Qnil
;
30232 DEFVAR_LISP ("window-text-change-functions",
30233 Vwindow_text_change_functions
,
30234 doc
: /* Functions to call in redisplay when text in the window might change. */);
30235 Vwindow_text_change_functions
= Qnil
;
30237 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30238 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30239 Each function is called with two arguments, the window and the end trigger value.
30240 See `set-window-redisplay-end-trigger'. */);
30241 Vredisplay_end_trigger_functions
= Qnil
;
30243 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30244 doc
: /* Non-nil means autoselect window with mouse pointer.
30245 If nil, do not autoselect windows.
30246 A positive number means delay autoselection by that many seconds: a
30247 window is autoselected only after the mouse has remained in that
30248 window for the duration of the delay.
30249 A negative number has a similar effect, but causes windows to be
30250 autoselected only after the mouse has stopped moving. \(Because of
30251 the way Emacs compares mouse events, you will occasionally wait twice
30252 that time before the window gets selected.\)
30253 Any other value means to autoselect window instantaneously when the
30254 mouse pointer enters it.
30256 Autoselection selects the minibuffer only if it is active, and never
30257 unselects the minibuffer if it is active.
30259 When customizing this variable make sure that the actual value of
30260 `focus-follows-mouse' matches the behavior of your window manager. */);
30261 Vmouse_autoselect_window
= Qnil
;
30263 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30264 doc
: /* Non-nil means automatically resize tool-bars.
30265 This dynamically changes the tool-bar's height to the minimum height
30266 that is needed to make all tool-bar items visible.
30267 If value is `grow-only', the tool-bar's height is only increased
30268 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30269 Vauto_resize_tool_bars
= Qt
;
30271 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30272 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30273 auto_raise_tool_bar_buttons_p
= 1;
30275 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30276 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30277 make_cursor_line_fully_visible_p
= 1;
30279 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30280 doc
: /* Border below tool-bar in pixels.
30281 If an integer, use it as the height of the border.
30282 If it is one of `internal-border-width' or `border-width', use the
30283 value of the corresponding frame parameter.
30284 Otherwise, no border is added below the tool-bar. */);
30285 Vtool_bar_border
= Qinternal_border_width
;
30287 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30288 doc
: /* Margin around tool-bar buttons in pixels.
30289 If an integer, use that for both horizontal and vertical margins.
30290 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30291 HORZ specifying the horizontal margin, and VERT specifying the
30292 vertical margin. */);
30293 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30295 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30296 doc
: /* Relief thickness of tool-bar buttons. */);
30297 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30299 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30300 doc
: /* Tool bar style to use.
30302 image - show images only
30303 text - show text only
30304 both - show both, text below image
30305 both-horiz - show text to the right of the image
30306 text-image-horiz - show text to the left of the image
30307 any other - use system default or image if no system default.
30309 This variable only affects the GTK+ toolkit version of Emacs. */);
30310 Vtool_bar_style
= Qnil
;
30312 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30313 doc
: /* Maximum number of characters a label can have to be shown.
30314 The tool bar style must also show labels for this to have any effect, see
30315 `tool-bar-style'. */);
30316 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30318 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30319 doc
: /* List of functions to call to fontify regions of text.
30320 Each function is called with one argument POS. Functions must
30321 fontify a region starting at POS in the current buffer, and give
30322 fontified regions the property `fontified'. */);
30323 Vfontification_functions
= Qnil
;
30324 Fmake_variable_buffer_local (Qfontification_functions
);
30326 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30327 unibyte_display_via_language_environment
,
30328 doc
: /* Non-nil means display unibyte text according to language environment.
30329 Specifically, this means that raw bytes in the range 160-255 decimal
30330 are displayed by converting them to the equivalent multibyte characters
30331 according to the current language environment. As a result, they are
30332 displayed according to the current fontset.
30334 Note that this variable affects only how these bytes are displayed,
30335 but does not change the fact they are interpreted as raw bytes. */);
30336 unibyte_display_via_language_environment
= 0;
30338 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30339 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30340 If a float, it specifies a fraction of the mini-window frame's height.
30341 If an integer, it specifies a number of lines. */);
30342 Vmax_mini_window_height
= make_float (0.25);
30344 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30345 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30346 A value of nil means don't automatically resize mini-windows.
30347 A value of t means resize them to fit the text displayed in them.
30348 A value of `grow-only', the default, means let mini-windows grow only;
30349 they return to their normal size when the minibuffer is closed, or the
30350 echo area becomes empty. */);
30351 Vresize_mini_windows
= Qgrow_only
;
30353 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30354 doc
: /* Alist specifying how to blink the cursor off.
30355 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30356 `cursor-type' frame-parameter or variable equals ON-STATE,
30357 comparing using `equal', Emacs uses OFF-STATE to specify
30358 how to blink it off. ON-STATE and OFF-STATE are values for
30359 the `cursor-type' frame parameter.
30361 If a frame's ON-STATE has no entry in this list,
30362 the frame's other specifications determine how to blink the cursor off. */);
30363 Vblink_cursor_alist
= Qnil
;
30365 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30366 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30367 If non-nil, windows are automatically scrolled horizontally to make
30368 point visible. */);
30369 automatic_hscrolling_p
= 1;
30370 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30372 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30373 doc
: /* How many columns away from the window edge point is allowed to get
30374 before automatic hscrolling will horizontally scroll the window. */);
30375 hscroll_margin
= 5;
30377 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30378 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30379 When point is less than `hscroll-margin' columns from the window
30380 edge, automatic hscrolling will scroll the window by the amount of columns
30381 determined by this variable. If its value is a positive integer, scroll that
30382 many columns. If it's a positive floating-point number, it specifies the
30383 fraction of the window's width to scroll. If it's nil or zero, point will be
30384 centered horizontally after the scroll. Any other value, including negative
30385 numbers, are treated as if the value were zero.
30387 Automatic hscrolling always moves point outside the scroll margin, so if
30388 point was more than scroll step columns inside the margin, the window will
30389 scroll more than the value given by the scroll step.
30391 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30392 and `scroll-right' overrides this variable's effect. */);
30393 Vhscroll_step
= make_number (0);
30395 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30396 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30397 Bind this around calls to `message' to let it take effect. */);
30398 message_truncate_lines
= 0;
30400 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30401 doc
: /* Normal hook run to update the menu bar definitions.
30402 Redisplay runs this hook before it redisplays the menu bar.
30403 This is used to update menus such as Buffers, whose contents depend on
30405 Vmenu_bar_update_hook
= Qnil
;
30407 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30408 doc
: /* Frame for which we are updating a menu.
30409 The enable predicate for a menu binding should check this variable. */);
30410 Vmenu_updating_frame
= Qnil
;
30412 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30413 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30414 inhibit_menubar_update
= 0;
30416 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30417 doc
: /* Prefix prepended to all continuation lines at display time.
30418 The value may be a string, an image, or a stretch-glyph; it is
30419 interpreted in the same way as the value of a `display' text property.
30421 This variable is overridden by any `wrap-prefix' text or overlay
30424 To add a prefix to non-continuation lines, use `line-prefix'. */);
30425 Vwrap_prefix
= Qnil
;
30426 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30427 Fmake_variable_buffer_local (Qwrap_prefix
);
30429 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30430 doc
: /* Prefix prepended to all non-continuation lines at display time.
30431 The value may be a string, an image, or a stretch-glyph; it is
30432 interpreted in the same way as the value of a `display' text property.
30434 This variable is overridden by any `line-prefix' text or overlay
30437 To add a prefix to continuation lines, use `wrap-prefix'. */);
30438 Vline_prefix
= Qnil
;
30439 DEFSYM (Qline_prefix
, "line-prefix");
30440 Fmake_variable_buffer_local (Qline_prefix
);
30442 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30443 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30444 inhibit_eval_during_redisplay
= 0;
30446 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30447 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30448 inhibit_free_realized_faces
= 0;
30451 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30452 doc
: /* Inhibit try_window_id display optimization. */);
30453 inhibit_try_window_id
= 0;
30455 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30456 doc
: /* Inhibit try_window_reusing display optimization. */);
30457 inhibit_try_window_reusing
= 0;
30459 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30460 doc
: /* Inhibit try_cursor_movement display optimization. */);
30461 inhibit_try_cursor_movement
= 0;
30462 #endif /* GLYPH_DEBUG */
30464 DEFVAR_INT ("overline-margin", overline_margin
,
30465 doc
: /* Space between overline and text, in pixels.
30466 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30467 margin to the character height. */);
30468 overline_margin
= 2;
30470 DEFVAR_INT ("underline-minimum-offset",
30471 underline_minimum_offset
,
30472 doc
: /* Minimum distance between baseline and underline.
30473 This can improve legibility of underlined text at small font sizes,
30474 particularly when using variable `x-use-underline-position-properties'
30475 with fonts that specify an UNDERLINE_POSITION relatively close to the
30476 baseline. The default value is 1. */);
30477 underline_minimum_offset
= 1;
30479 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30480 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30481 This feature only works when on a window system that can change
30482 cursor shapes. */);
30483 display_hourglass_p
= 1;
30485 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30486 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30487 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30489 #ifdef HAVE_WINDOW_SYSTEM
30490 hourglass_atimer
= NULL
;
30491 hourglass_shown_p
= 0;
30492 #endif /* HAVE_WINDOW_SYSTEM */
30494 DEFSYM (Qglyphless_char
, "glyphless-char");
30495 DEFSYM (Qhex_code
, "hex-code");
30496 DEFSYM (Qempty_box
, "empty-box");
30497 DEFSYM (Qthin_space
, "thin-space");
30498 DEFSYM (Qzero_width
, "zero-width");
30500 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
30501 doc
: /* Function run just before redisplay.
30502 It is called with one argument, which is the set of windows that are to
30503 be redisplayed. This set can be nil (meaning, only the selected window),
30504 or t (meaning all windows). */);
30505 Vpre_redisplay_function
= intern ("ignore");
30507 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
30508 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
30510 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
30511 doc
: /* Char-table defining glyphless characters.
30512 Each element, if non-nil, should be one of the following:
30513 an ASCII acronym string: display this string in a box
30514 `hex-code': display the hexadecimal code of a character in a box
30515 `empty-box': display as an empty box
30516 `thin-space': display as 1-pixel width space
30517 `zero-width': don't display
30518 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
30519 display method for graphical terminals and text terminals respectively.
30520 GRAPHICAL and TEXT should each have one of the values listed above.
30522 The char-table has one extra slot to control the display of a character for
30523 which no font is found. This slot only takes effect on graphical terminals.
30524 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
30525 `thin-space'. The default is `empty-box'.
30527 If a character has a non-nil entry in an active display table, the
30528 display table takes effect; in this case, Emacs does not consult
30529 `glyphless-char-display' at all. */);
30530 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
30531 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
30534 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
30535 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
30536 Vdebug_on_message
= Qnil
;
30538 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
30540 Vredisplay__all_windows_cause
30541 = Fmake_vector (make_number (100), make_number (0));
30543 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
30545 Vredisplay__mode_lines_cause
30546 = Fmake_vector (make_number (100), make_number (0));
30550 /* Initialize this module when Emacs starts. */
30555 CHARPOS (this_line_start_pos
) = 0;
30557 if (!noninteractive
)
30559 struct window
*m
= XWINDOW (minibuf_window
);
30560 Lisp_Object frame
= m
->frame
;
30561 struct frame
*f
= XFRAME (frame
);
30562 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
30563 struct window
*r
= XWINDOW (root
);
30566 echo_area_window
= minibuf_window
;
30568 r
->top_line
= FRAME_TOP_MARGIN (f
);
30569 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
30570 r
->total_cols
= FRAME_COLS (f
);
30571 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30572 r
->total_lines
= FRAME_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
30573 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
30575 m
->top_line
= FRAME_LINES (f
) - 1;
30576 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
30577 m
->total_cols
= FRAME_COLS (f
);
30578 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
30579 m
->total_lines
= 1;
30580 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
30582 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
30583 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
30584 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
30586 /* The default ellipsis glyphs `...'. */
30587 for (i
= 0; i
< 3; ++i
)
30588 default_invis_vector
[i
] = make_number ('.');
30592 /* Allocate the buffer for frame titles.
30593 Also used for `format-mode-line'. */
30595 mode_line_noprop_buf
= xmalloc_atomic (size
);
30596 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
30597 mode_line_noprop_ptr
= mode_line_noprop_buf
;
30598 mode_line_target
= MODE_LINE_DISPLAY
;
30601 help_echo_showing_p
= 0;
30604 #ifdef HAVE_WINDOW_SYSTEM
30606 /* Platform-independent portion of hourglass implementation. */
30608 /* Cancel a currently active hourglass timer, and start a new one. */
30610 start_hourglass (void)
30612 struct timespec delay
;
30614 cancel_hourglass ();
30616 if (INTEGERP (Vhourglass_delay
)
30617 && XINT (Vhourglass_delay
) > 0)
30618 delay
= make_timespec (min (XINT (Vhourglass_delay
),
30619 TYPE_MAXIMUM (time_t)),
30621 else if (FLOATP (Vhourglass_delay
)
30622 && XFLOAT_DATA (Vhourglass_delay
) > 0)
30623 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
30625 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
30629 extern void w32_note_current_window (void);
30630 w32_note_current_window ();
30632 #endif /* HAVE_NTGUI */
30634 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
30635 show_hourglass
, NULL
);
30639 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
30642 cancel_hourglass (void)
30644 if (hourglass_atimer
)
30646 cancel_atimer (hourglass_atimer
);
30647 hourglass_atimer
= NULL
;
30650 if (hourglass_shown_p
)
30654 #endif /* HAVE_WINDOW_SYSTEM */