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 (make_lisp_ptr (w
, Lisp_Vectorlike
), 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 static bool hourglass_shown_p
;
821 /* If non-null, an asynchronous timer that, when it expires, displays
822 an hourglass cursor on all frames. */
823 static struct atimer
*hourglass_atimer
;
825 #endif /* HAVE_WINDOW_SYSTEM */
827 /* Name of the face used to display glyphless characters. */
828 static Lisp_Object Qglyphless_char
;
830 /* Symbol for the purpose of Vglyphless_char_display. */
831 static Lisp_Object Qglyphless_char_display
;
833 /* Method symbols for Vglyphless_char_display. */
834 static Lisp_Object Qhex_code
, Qempty_box
, Qthin_space
, Qzero_width
;
836 /* Default number of seconds to wait before displaying an hourglass
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
);
1027 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
1032 /* Return the pixel width of display area AREA of window W.
1033 ANY_AREA means return the total width of W, not including
1034 fringes to the left and right of the window. */
1037 window_box_width (struct window
*w
, enum glyph_row_area area
)
1039 int width
= w
->pixel_width
;
1041 if (!w
->pseudo_window_p
)
1043 width
-= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
1044 width
-= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
1046 if (area
== TEXT_AREA
)
1047 width
-= (WINDOW_MARGINS_WIDTH (w
)
1048 + WINDOW_FRINGES_WIDTH (w
));
1049 else if (area
== LEFT_MARGIN_AREA
)
1050 width
= WINDOW_LEFT_MARGIN_WIDTH (w
);
1051 else if (area
== RIGHT_MARGIN_AREA
)
1052 width
= WINDOW_RIGHT_MARGIN_WIDTH (w
);
1055 /* With wide margins, fringes, etc. we might end up with a negative
1056 width, correct that here. */
1057 return max (0, width
);
1061 /* Return the pixel height of the display area of window W, not
1062 including mode lines of W, if any. */
1065 window_box_height (struct window
*w
)
1067 struct frame
*f
= XFRAME (w
->frame
);
1068 int height
= WINDOW_PIXEL_HEIGHT (w
);
1070 eassert (height
>= 0);
1072 height
-= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
1073 height
-= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
1075 /* Note: the code below that determines the mode-line/header-line
1076 height is essentially the same as that contained in the macro
1077 CURRENT_{MODE,HEADER}_LINE_HEIGHT, except that it checks whether
1078 the appropriate glyph row has its `mode_line_p' flag set,
1079 and if it doesn't, uses estimate_mode_line_height instead. */
1081 if (WINDOW_WANTS_MODELINE_P (w
))
1083 struct glyph_row
*ml_row
1084 = (w
->current_matrix
&& w
->current_matrix
->rows
1085 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
1087 if (ml_row
&& ml_row
->mode_line_p
)
1088 height
-= ml_row
->height
;
1090 height
-= estimate_mode_line_height (f
, CURRENT_MODE_LINE_FACE_ID (w
));
1093 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1095 struct glyph_row
*hl_row
1096 = (w
->current_matrix
&& w
->current_matrix
->rows
1097 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
1099 if (hl_row
&& hl_row
->mode_line_p
)
1100 height
-= hl_row
->height
;
1102 height
-= estimate_mode_line_height (f
, HEADER_LINE_FACE_ID
);
1105 /* With a very small font and a mode-line that's taller than
1106 default, we might end up with a negative height. */
1107 return max (0, height
);
1110 /* Return the window-relative coordinate of the left edge of display
1111 area AREA of window W. ANY_AREA means return the left edge of the
1112 whole window, to the right of the left fringe of W. */
1115 window_box_left_offset (struct window
*w
, enum glyph_row_area area
)
1119 if (w
->pseudo_window_p
)
1122 x
= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
1124 if (area
== TEXT_AREA
)
1125 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1126 + window_box_width (w
, LEFT_MARGIN_AREA
));
1127 else if (area
== RIGHT_MARGIN_AREA
)
1128 x
+= (WINDOW_LEFT_FRINGE_WIDTH (w
)
1129 + window_box_width (w
, LEFT_MARGIN_AREA
)
1130 + window_box_width (w
, TEXT_AREA
)
1131 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
1133 : WINDOW_RIGHT_FRINGE_WIDTH (w
)));
1134 else if (area
== LEFT_MARGIN_AREA
1135 && WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
))
1136 x
+= WINDOW_LEFT_FRINGE_WIDTH (w
);
1138 /* Don't return more than the window's pixel width. */
1139 return min (x
, w
->pixel_width
);
1143 /* Return the window-relative coordinate of the right edge of display
1144 area AREA of window W. ANY_AREA means return the right edge of the
1145 whole window, to the left of the right fringe of W. */
1148 window_box_right_offset (struct window
*w
, enum glyph_row_area area
)
1150 /* Don't return more than the window's pixel width. */
1151 return min (window_box_left_offset (w
, area
) + window_box_width (w
, area
),
1155 /* Return the frame-relative coordinate of the left edge of display
1156 area AREA of window W. ANY_AREA means return the left edge of the
1157 whole window, to the right of the left fringe of W. */
1160 window_box_left (struct window
*w
, enum glyph_row_area area
)
1162 struct frame
*f
= XFRAME (w
->frame
);
1165 if (w
->pseudo_window_p
)
1166 return FRAME_INTERNAL_BORDER_WIDTH (f
);
1168 x
= (WINDOW_LEFT_EDGE_X (w
)
1169 + window_box_left_offset (w
, area
));
1175 /* Return the frame-relative coordinate of the right edge of display
1176 area AREA of window W. ANY_AREA means return the right edge of the
1177 whole window, to the left of the right fringe of W. */
1180 window_box_right (struct window
*w
, enum glyph_row_area area
)
1182 return window_box_left (w
, area
) + window_box_width (w
, area
);
1185 /* Get the bounding box of the display area AREA of window W, without
1186 mode lines, in frame-relative coordinates. ANY_AREA means the
1187 whole window, not including the left and right fringes of
1188 the window. Return in *BOX_X and *BOX_Y the frame-relative pixel
1189 coordinates of the upper-left corner of the box. Return in
1190 *BOX_WIDTH, and *BOX_HEIGHT the pixel width and height of the box. */
1193 window_box (struct window
*w
, enum glyph_row_area area
, int *box_x
,
1194 int *box_y
, int *box_width
, int *box_height
)
1197 *box_width
= window_box_width (w
, area
);
1199 *box_height
= window_box_height (w
);
1201 *box_x
= window_box_left (w
, area
);
1204 *box_y
= WINDOW_TOP_EDGE_Y (w
);
1205 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1206 *box_y
+= CURRENT_HEADER_LINE_HEIGHT (w
);
1210 #ifdef HAVE_WINDOW_SYSTEM
1212 /* Get the bounding box of the display area AREA of window W, without
1213 mode lines and both fringes of the window. Return in *TOP_LEFT_X
1214 and TOP_LEFT_Y the frame-relative pixel coordinates of the
1215 upper-left corner of the box. Return in *BOTTOM_RIGHT_X, and
1216 *BOTTOM_RIGHT_Y the coordinates of the bottom-right corner of the
1220 window_box_edges (struct window
*w
, int *top_left_x
, int *top_left_y
,
1221 int *bottom_right_x
, int *bottom_right_y
)
1223 window_box (w
, ANY_AREA
, top_left_x
, top_left_y
,
1224 bottom_right_x
, bottom_right_y
);
1225 *bottom_right_x
+= *top_left_x
;
1226 *bottom_right_y
+= *top_left_y
;
1229 #endif /* HAVE_WINDOW_SYSTEM */
1231 /***********************************************************************
1233 ***********************************************************************/
1235 /* Return the bottom y-position of the line the iterator IT is in.
1236 This can modify IT's settings. */
1239 line_bottom_y (struct it
*it
)
1241 int line_height
= it
->max_ascent
+ it
->max_descent
;
1242 int line_top_y
= it
->current_y
;
1244 if (line_height
== 0)
1247 line_height
= last_height
;
1248 else if (IT_CHARPOS (*it
) < ZV
)
1250 move_it_by_lines (it
, 1);
1251 line_height
= (it
->max_ascent
|| it
->max_descent
1252 ? it
->max_ascent
+ it
->max_descent
1257 struct glyph_row
*row
= it
->glyph_row
;
1259 /* Use the default character height. */
1260 it
->glyph_row
= NULL
;
1261 it
->what
= IT_CHARACTER
;
1264 PRODUCE_GLYPHS (it
);
1265 line_height
= it
->ascent
+ it
->descent
;
1266 it
->glyph_row
= row
;
1270 return line_top_y
+ line_height
;
1273 DEFUN ("line-pixel-height", Fline_pixel_height
,
1274 Sline_pixel_height
, 0, 0, 0,
1275 doc
: /* Return height in pixels of text line in the selected window.
1277 Value is the height in pixels of the line at point. */)
1282 struct window
*w
= XWINDOW (selected_window
);
1283 struct buffer
*old_buffer
= NULL
;
1286 if (XBUFFER (w
->contents
) != current_buffer
)
1288 old_buffer
= current_buffer
;
1289 set_buffer_internal_1 (XBUFFER (w
->contents
));
1291 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
1292 start_display (&it
, w
, pt
);
1293 it
.vpos
= it
.current_y
= 0;
1295 result
= make_number (line_bottom_y (&it
));
1297 set_buffer_internal_1 (old_buffer
);
1302 /* Return the default pixel height of text lines in window W. The
1303 value is the canonical height of the W frame's default font, plus
1304 any extra space required by the line-spacing variable or frame
1307 Implementation note: this ignores any line-spacing text properties
1308 put on the newline characters. This is because those properties
1309 only affect the _screen_ line ending in the newline (i.e., in a
1310 continued line, only the last screen line will be affected), which
1311 means only a small number of lines in a buffer can ever use this
1312 feature. Since this function is used to compute the default pixel
1313 equivalent of text lines in a window, we can safely ignore those
1314 few lines. For the same reasons, we ignore the line-height
1317 default_line_pixel_height (struct window
*w
)
1319 struct frame
*f
= WINDOW_XFRAME (w
);
1320 int height
= FRAME_LINE_HEIGHT (f
);
1322 if (!FRAME_INITIAL_P (f
) && BUFFERP (w
->contents
))
1324 struct buffer
*b
= XBUFFER (w
->contents
);
1325 Lisp_Object val
= BVAR (b
, extra_line_spacing
);
1328 val
= BVAR (&buffer_defaults
, extra_line_spacing
);
1331 if (RANGED_INTEGERP (0, val
, INT_MAX
))
1332 height
+= XFASTINT (val
);
1333 else if (FLOATP (val
))
1335 int addon
= XFLOAT_DATA (val
) * height
+ 0.5;
1342 height
+= f
->extra_line_spacing
;
1348 /* Subroutine of pos_visible_p below. Extracts a display string, if
1349 any, from the display spec given as its argument. */
1351 string_from_display_spec (Lisp_Object spec
)
1355 while (CONSP (spec
))
1357 if (STRINGP (XCAR (spec
)))
1362 else if (VECTORP (spec
))
1366 for (i
= 0; i
< ASIZE (spec
); i
++)
1368 if (STRINGP (AREF (spec
, i
)))
1369 return AREF (spec
, i
);
1378 /* Limit insanely large values of W->hscroll on frame F to the largest
1379 value that will still prevent first_visible_x and last_visible_x of
1380 'struct it' from overflowing an int. */
1382 window_hscroll_limited (struct window
*w
, struct frame
*f
)
1384 ptrdiff_t window_hscroll
= w
->hscroll
;
1385 int window_text_width
= window_box_width (w
, TEXT_AREA
);
1386 int colwidth
= FRAME_COLUMN_WIDTH (f
);
1388 if (window_hscroll
> (INT_MAX
- window_text_width
) / colwidth
- 1)
1389 window_hscroll
= (INT_MAX
- window_text_width
) / colwidth
- 1;
1391 return window_hscroll
;
1394 /* Return 1 if position CHARPOS is visible in window W.
1395 CHARPOS < 0 means return info about WINDOW_END position.
1396 If visible, set *X and *Y to pixel coordinates of top left corner.
1397 Set *RTOP and *RBOT to pixel height of an invisible area of glyph at POS.
1398 Set *ROWH and *VPOS to row's visible height and VPOS (row number). */
1401 pos_visible_p (struct window
*w
, ptrdiff_t charpos
, int *x
, int *y
,
1402 int *rtop
, int *rbot
, int *rowh
, int *vpos
)
1405 void *itdata
= bidi_shelve_cache ();
1406 struct text_pos top
;
1408 struct buffer
*old_buffer
= NULL
;
1410 if (FRAME_INITIAL_P (XFRAME (WINDOW_FRAME (w
))))
1413 if (XBUFFER (w
->contents
) != current_buffer
)
1415 old_buffer
= current_buffer
;
1416 set_buffer_internal_1 (XBUFFER (w
->contents
));
1419 SET_TEXT_POS_FROM_MARKER (top
, w
->start
);
1420 /* Scrolling a minibuffer window via scroll bar when the echo area
1421 shows long text sometimes resets the minibuffer contents behind
1423 if (CHARPOS (top
) > ZV
)
1424 SET_TEXT_POS (top
, BEGV
, BEGV_BYTE
);
1426 /* Compute exact mode line heights. */
1427 if (WINDOW_WANTS_MODELINE_P (w
))
1429 = display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID (w
),
1430 BVAR (current_buffer
, mode_line_format
));
1432 if (WINDOW_WANTS_HEADER_LINE_P (w
))
1433 w
->header_line_height
1434 = display_mode_line (w
, HEADER_LINE_FACE_ID
,
1435 BVAR (current_buffer
, header_line_format
));
1437 start_display (&it
, w
, top
);
1438 move_it_to (&it
, charpos
, -1, it
.last_visible_y
- 1, -1,
1439 (charpos
>= 0 ? MOVE_TO_POS
: 0) | MOVE_TO_Y
);
1442 && (((!it
.bidi_p
|| it
.bidi_it
.scan_dir
!= -1)
1443 && IT_CHARPOS (it
) >= charpos
)
1444 /* When scanning backwards under bidi iteration, move_it_to
1445 stops at or _before_ CHARPOS, because it stops at or to
1446 the _right_ of the character at CHARPOS. */
1447 || (it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1448 && IT_CHARPOS (it
) <= charpos
)))
1450 /* We have reached CHARPOS, or passed it. How the call to
1451 move_it_to can overshoot: (i) If CHARPOS is on invisible text
1452 or covered by a display property, move_it_to stops at the end
1453 of the invisible text, to the right of CHARPOS. (ii) If
1454 CHARPOS is in a display vector, move_it_to stops on its last
1456 int top_x
= it
.current_x
;
1457 int top_y
= it
.current_y
;
1458 int window_top_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
1461 void *save_it_data
= NULL
;
1463 /* Calling line_bottom_y may change it.method, it.position, etc. */
1464 SAVE_IT (save_it
, it
, save_it_data
);
1466 bottom_y
= line_bottom_y (&it
);
1467 if (top_y
< window_top_y
)
1468 visible_p
= bottom_y
> window_top_y
;
1469 else if (top_y
< it
.last_visible_y
)
1471 if (bottom_y
>= it
.last_visible_y
1472 && it
.bidi_p
&& it
.bidi_it
.scan_dir
== -1
1473 && IT_CHARPOS (it
) < charpos
)
1475 /* When the last line of the window is scanned backwards
1476 under bidi iteration, we could be duped into thinking
1477 that we have passed CHARPOS, when in fact move_it_to
1478 simply stopped short of CHARPOS because it reached
1479 last_visible_y. To see if that's what happened, we call
1480 move_it_to again with a slightly larger vertical limit,
1481 and see if it actually moved vertically; if it did, we
1482 didn't really reach CHARPOS, which is beyond window end. */
1483 /* Why 10? because we don't know how many canonical lines
1484 will the height of the next line(s) be. So we guess. */
1485 int ten_more_lines
= 10 * default_line_pixel_height (w
);
1487 move_it_to (&it
, charpos
, -1, bottom_y
+ ten_more_lines
, -1,
1488 MOVE_TO_POS
| MOVE_TO_Y
);
1489 if (it
.current_y
> top_y
)
1493 RESTORE_IT (&it
, &save_it
, save_it_data
);
1496 if (it
.method
== GET_FROM_DISPLAY_VECTOR
)
1498 /* We stopped on the last glyph of a display vector.
1499 Try and recompute. Hack alert! */
1500 if (charpos
< 2 || top
.charpos
>= charpos
)
1501 top_x
= it
.glyph_row
->x
;
1504 struct it it2
, it2_prev
;
1505 /* The idea is to get to the previous buffer
1506 position, consume the character there, and use
1507 the pixel coordinates we get after that. But if
1508 the previous buffer position is also displayed
1509 from a display vector, we need to consume all of
1510 the glyphs from that display vector. */
1511 start_display (&it2
, w
, top
);
1512 move_it_to (&it2
, charpos
- 1, -1, -1, -1, MOVE_TO_POS
);
1513 /* If we didn't get to CHARPOS - 1, there's some
1514 replacing display property at that position, and
1515 we stopped after it. That is exactly the place
1516 whose coordinates we want. */
1517 if (IT_CHARPOS (it2
) != charpos
- 1)
1521 /* Iterate until we get out of the display
1522 vector that displays the character at
1525 get_next_display_element (&it2
);
1526 PRODUCE_GLYPHS (&it2
);
1528 set_iterator_to_next (&it2
, 1);
1529 } while (it2
.method
== GET_FROM_DISPLAY_VECTOR
1530 && IT_CHARPOS (it2
) < charpos
);
1532 if (ITERATOR_AT_END_OF_LINE_P (&it2_prev
)
1533 || it2_prev
.current_x
> it2_prev
.last_visible_x
)
1534 top_x
= it
.glyph_row
->x
;
1537 top_x
= it2_prev
.current_x
;
1538 top_y
= it2_prev
.current_y
;
1542 else if (IT_CHARPOS (it
) != charpos
)
1544 Lisp_Object cpos
= make_number (charpos
);
1545 Lisp_Object spec
= Fget_char_property (cpos
, Qdisplay
, Qnil
);
1546 Lisp_Object string
= string_from_display_spec (spec
);
1547 struct text_pos tpos
;
1548 int replacing_spec_p
;
1549 bool newline_in_string
1551 && memchr (SDATA (string
), '\n', SBYTES (string
)));
1553 SET_TEXT_POS (tpos
, charpos
, CHAR_TO_BYTE (charpos
));
1556 && handle_display_spec (NULL
, spec
, Qnil
, Qnil
, &tpos
,
1557 charpos
, FRAME_WINDOW_P (it
.f
)));
1558 /* The tricky code below is needed because there's a
1559 discrepancy between move_it_to and how we set cursor
1560 when PT is at the beginning of a portion of text
1561 covered by a display property or an overlay with a
1562 display property, or the display line ends in a
1563 newline from a display string. move_it_to will stop
1564 _after_ such display strings, whereas
1565 set_cursor_from_row conspires with cursor_row_p to
1566 place the cursor on the first glyph produced from the
1569 /* We have overshoot PT because it is covered by a
1570 display property that replaces the text it covers.
1571 If the string includes embedded newlines, we are also
1572 in the wrong display line. Backtrack to the correct
1573 line, where the display property begins. */
1574 if (replacing_spec_p
)
1576 Lisp_Object startpos
, endpos
;
1577 EMACS_INT start
, end
;
1581 /* Find the first and the last buffer positions
1582 covered by the display string. */
1584 Fnext_single_char_property_change (cpos
, Qdisplay
,
1587 Fprevious_single_char_property_change (endpos
, Qdisplay
,
1589 start
= XFASTINT (startpos
);
1590 end
= XFASTINT (endpos
);
1591 /* Move to the last buffer position before the
1592 display property. */
1593 start_display (&it3
, w
, top
);
1594 if (start
> CHARPOS (top
))
1595 move_it_to (&it3
, start
- 1, -1, -1, -1, MOVE_TO_POS
);
1596 /* Move forward one more line if the position before
1597 the display string is a newline or if it is the
1598 rightmost character on a line that is
1599 continued or word-wrapped. */
1600 if (it3
.method
== GET_FROM_BUFFER
1602 || FETCH_BYTE (IT_BYTEPOS (it3
)) == '\n'))
1603 move_it_by_lines (&it3
, 1);
1604 else if (move_it_in_display_line_to (&it3
, -1,
1608 == MOVE_LINE_CONTINUED
)
1610 move_it_by_lines (&it3
, 1);
1611 /* When we are under word-wrap, the #$@%!
1612 move_it_by_lines moves 2 lines, so we need to
1614 if (it3
.line_wrap
== WORD_WRAP
)
1615 move_it_by_lines (&it3
, -1);
1618 /* Record the vertical coordinate of the display
1619 line where we wound up. */
1620 top_y
= it3
.current_y
;
1623 /* When characters are reordered for display,
1624 the character displayed to the left of the
1625 display string could be _after_ the display
1626 property in the logical order. Use the
1627 smallest vertical position of these two. */
1628 start_display (&it3
, w
, top
);
1629 move_it_to (&it3
, end
+ 1, -1, -1, -1, MOVE_TO_POS
);
1630 if (it3
.current_y
< top_y
)
1631 top_y
= it3
.current_y
;
1633 /* Move from the top of the window to the beginning
1634 of the display line where the display string
1636 start_display (&it3
, w
, top
);
1637 move_it_to (&it3
, -1, 0, top_y
, -1, MOVE_TO_X
| MOVE_TO_Y
);
1638 /* If it3_moved stays zero after the 'while' loop
1639 below, that means we already were at a newline
1640 before the loop (e.g., the display string begins
1641 with a newline), so we don't need to (and cannot)
1642 inspect the glyphs of it3.glyph_row, because
1643 PRODUCE_GLYPHS will not produce anything for a
1644 newline, and thus it3.glyph_row stays at its
1645 stale content it got at top of the window. */
1647 /* Finally, advance the iterator until we hit the
1648 first display element whose character position is
1649 CHARPOS, or until the first newline from the
1650 display string, which signals the end of the
1652 while (get_next_display_element (&it3
))
1654 PRODUCE_GLYPHS (&it3
);
1655 if (IT_CHARPOS (it3
) == charpos
1656 || ITERATOR_AT_END_OF_LINE_P (&it3
))
1659 set_iterator_to_next (&it3
, 0);
1661 top_x
= it3
.current_x
- it3
.pixel_width
;
1662 /* Normally, we would exit the above loop because we
1663 found the display element whose character
1664 position is CHARPOS. For the contingency that we
1665 didn't, and stopped at the first newline from the
1666 display string, move back over the glyphs
1667 produced from the string, until we find the
1668 rightmost glyph not from the string. */
1670 && newline_in_string
1671 && IT_CHARPOS (it3
) != charpos
&& EQ (it3
.object
, string
))
1673 struct glyph
*g
= it3
.glyph_row
->glyphs
[TEXT_AREA
]
1674 + it3
.glyph_row
->used
[TEXT_AREA
];
1676 while (EQ ((g
- 1)->object
, string
))
1679 top_x
-= g
->pixel_width
;
1681 eassert (g
< it3
.glyph_row
->glyphs
[TEXT_AREA
]
1682 + it3
.glyph_row
->used
[TEXT_AREA
]);
1688 *y
= max (top_y
+ max (0, it
.max_ascent
- it
.ascent
), window_top_y
);
1689 *rtop
= max (0, window_top_y
- top_y
);
1690 *rbot
= max (0, bottom_y
- it
.last_visible_y
);
1691 *rowh
= max (0, (min (bottom_y
, it
.last_visible_y
)
1692 - max (top_y
, window_top_y
)));
1698 /* Either we were asked to provide info about WINDOW_END, or
1699 CHARPOS is in the partially visible glyph row at end of
1702 void *it2data
= NULL
;
1704 SAVE_IT (it2
, it
, it2data
);
1705 if (IT_CHARPOS (it
) < ZV
&& FETCH_BYTE (IT_BYTEPOS (it
)) != '\n')
1706 move_it_by_lines (&it
, 1);
1707 if (charpos
< IT_CHARPOS (it
)
1708 || (it
.what
== IT_EOB
&& charpos
== IT_CHARPOS (it
)))
1711 RESTORE_IT (&it2
, &it2
, it2data
);
1712 move_it_to (&it2
, charpos
, -1, -1, -1, MOVE_TO_POS
);
1714 *y
= it2
.current_y
+ it2
.max_ascent
- it2
.ascent
;
1715 *rtop
= max (0, -it2
.current_y
);
1716 *rbot
= max (0, ((it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
)
1717 - it
.last_visible_y
));
1718 *rowh
= max (0, (min (it2
.current_y
+ it2
.max_ascent
+ it2
.max_descent
,
1720 - max (it2
.current_y
,
1721 WINDOW_HEADER_LINE_HEIGHT (w
))));
1725 bidi_unshelve_cache (it2data
, 1);
1727 bidi_unshelve_cache (itdata
, 0);
1730 set_buffer_internal_1 (old_buffer
);
1732 if (visible_p
&& w
->hscroll
> 0)
1734 window_hscroll_limited (w
, WINDOW_XFRAME (w
))
1735 * WINDOW_FRAME_COLUMN_WIDTH (w
);
1738 /* Debugging code. */
1740 fprintf (stderr
, "+pv pt=%d vs=%d --> x=%d y=%d rt=%d rb=%d rh=%d vp=%d\n",
1741 charpos
, w
->vscroll
, *x
, *y
, *rtop
, *rbot
, *rowh
, *vpos
);
1743 fprintf (stderr
, "-pv pt=%d vs=%d\n", charpos
, w
->vscroll
);
1750 /* Return the next character from STR. Return in *LEN the length of
1751 the character. This is like STRING_CHAR_AND_LENGTH but never
1752 returns an invalid character. If we find one, we return a `?', but
1753 with the length of the invalid character. */
1756 string_char_and_length (const unsigned char *str
, int *len
)
1760 c
= STRING_CHAR_AND_LENGTH (str
, *len
);
1761 if (!CHAR_VALID_P (c
))
1762 /* We may not change the length here because other places in Emacs
1763 don't use this function, i.e. they silently accept invalid
1772 /* Given a position POS containing a valid character and byte position
1773 in STRING, return the position NCHARS ahead (NCHARS >= 0). */
1775 static struct text_pos
1776 string_pos_nchars_ahead (struct text_pos pos
, Lisp_Object string
, ptrdiff_t nchars
)
1778 eassert (STRINGP (string
) && nchars
>= 0);
1780 if (STRING_MULTIBYTE (string
))
1782 const unsigned char *p
= SDATA (string
) + BYTEPOS (pos
);
1787 string_char_and_length (p
, &len
);
1790 BYTEPOS (pos
) += len
;
1794 SET_TEXT_POS (pos
, CHARPOS (pos
) + nchars
, BYTEPOS (pos
) + nchars
);
1800 /* Value is the text position, i.e. character and byte position,
1801 for character position CHARPOS in STRING. */
1803 static struct text_pos
1804 string_pos (ptrdiff_t charpos
, Lisp_Object string
)
1806 struct text_pos pos
;
1807 eassert (STRINGP (string
));
1808 eassert (charpos
>= 0);
1809 SET_TEXT_POS (pos
, charpos
, string_char_to_byte (string
, charpos
));
1814 /* Value is a text position, i.e. character and byte position, for
1815 character position CHARPOS in C string S. MULTIBYTE_P non-zero
1816 means recognize multibyte characters. */
1818 static struct text_pos
1819 c_string_pos (ptrdiff_t charpos
, const char *s
, bool multibyte_p
)
1821 struct text_pos pos
;
1823 eassert (s
!= NULL
);
1824 eassert (charpos
>= 0);
1830 SET_TEXT_POS (pos
, 0, 0);
1833 string_char_and_length ((const unsigned char *) s
, &len
);
1836 BYTEPOS (pos
) += len
;
1840 SET_TEXT_POS (pos
, charpos
, charpos
);
1846 /* Value is the number of characters in C string S. MULTIBYTE_P
1847 non-zero means recognize multibyte characters. */
1850 number_of_chars (const char *s
, bool multibyte_p
)
1856 ptrdiff_t rest
= strlen (s
);
1858 const unsigned char *p
= (const unsigned char *) s
;
1860 for (nchars
= 0; rest
> 0; ++nchars
)
1862 string_char_and_length (p
, &len
);
1863 rest
-= len
, p
+= len
;
1867 nchars
= strlen (s
);
1873 /* Compute byte position NEWPOS->bytepos corresponding to
1874 NEWPOS->charpos. POS is a known position in string STRING.
1875 NEWPOS->charpos must be >= POS.charpos. */
1878 compute_string_pos (struct text_pos
*newpos
, struct text_pos pos
, Lisp_Object string
)
1880 eassert (STRINGP (string
));
1881 eassert (CHARPOS (*newpos
) >= CHARPOS (pos
));
1883 if (STRING_MULTIBYTE (string
))
1884 *newpos
= string_pos_nchars_ahead (pos
, string
,
1885 CHARPOS (*newpos
) - CHARPOS (pos
));
1887 BYTEPOS (*newpos
) = CHARPOS (*newpos
);
1891 Return an estimation of the pixel height of mode or header lines on
1892 frame F. FACE_ID specifies what line's height to estimate. */
1895 estimate_mode_line_height (struct frame
*f
, enum face_id face_id
)
1897 #ifdef HAVE_WINDOW_SYSTEM
1898 if (FRAME_WINDOW_P (f
))
1900 int height
= FONT_HEIGHT (FRAME_FONT (f
));
1902 /* This function is called so early when Emacs starts that the face
1903 cache and mode line face are not yet initialized. */
1904 if (FRAME_FACE_CACHE (f
))
1906 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1910 height
= FONT_HEIGHT (face
->font
);
1911 if (face
->box_line_width
> 0)
1912 height
+= 2 * face
->box_line_width
;
1923 /* Given a pixel position (PIX_X, PIX_Y) on frame F, return glyph
1924 co-ordinates in (*X, *Y). Set *BOUNDS to the rectangle that the
1925 glyph at X, Y occupies, if BOUNDS != 0. If NOCLIP is non-zero, do
1926 not force the value into range. */
1929 pixel_to_glyph_coords (struct frame
*f
, register int pix_x
, register int pix_y
,
1930 int *x
, int *y
, NativeRectangle
*bounds
, int noclip
)
1933 #ifdef HAVE_WINDOW_SYSTEM
1934 if (FRAME_WINDOW_P (f
))
1936 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to round down
1937 even for negative values. */
1939 pix_x
-= FRAME_COLUMN_WIDTH (f
) - 1;
1941 pix_y
-= FRAME_LINE_HEIGHT (f
) - 1;
1943 pix_x
= FRAME_PIXEL_X_TO_COL (f
, pix_x
);
1944 pix_y
= FRAME_PIXEL_Y_TO_LINE (f
, pix_y
);
1947 STORE_NATIVE_RECT (*bounds
,
1948 FRAME_COL_TO_PIXEL_X (f
, pix_x
),
1949 FRAME_LINE_TO_PIXEL_Y (f
, pix_y
),
1950 FRAME_COLUMN_WIDTH (f
) - 1,
1951 FRAME_LINE_HEIGHT (f
) - 1);
1953 /* PXW: Should we clip pixels before converting to columns/lines? */
1958 else if (pix_x
> FRAME_TOTAL_COLS (f
))
1959 pix_x
= FRAME_TOTAL_COLS (f
);
1963 else if (pix_y
> FRAME_TOTAL_LINES (f
))
1964 pix_y
= FRAME_TOTAL_LINES (f
);
1974 /* Find the glyph under window-relative coordinates X/Y in window W.
1975 Consider only glyphs from buffer text, i.e. no glyphs from overlay
1976 strings. Return in *HPOS and *VPOS the row and column number of
1977 the glyph found. Return in *AREA the glyph area containing X.
1978 Value is a pointer to the glyph found or null if X/Y is not on
1979 text, or we can't tell because W's current matrix is not up to
1982 static struct glyph
*
1983 x_y_to_hpos_vpos (struct window
*w
, int x
, int y
, int *hpos
, int *vpos
,
1984 int *dx
, int *dy
, int *area
)
1986 struct glyph
*glyph
, *end
;
1987 struct glyph_row
*row
= NULL
;
1990 /* Find row containing Y. Give up if some row is not enabled. */
1991 for (i
= 0; i
< w
->current_matrix
->nrows
; ++i
)
1993 row
= MATRIX_ROW (w
->current_matrix
, i
);
1994 if (!row
->enabled_p
)
1996 if (y
>= row
->y
&& y
< MATRIX_ROW_BOTTOM_Y (row
))
2003 /* Give up if Y is not in the window. */
2004 if (i
== w
->current_matrix
->nrows
)
2007 /* Get the glyph area containing X. */
2008 if (w
->pseudo_window_p
)
2015 if (x
< window_box_left_offset (w
, TEXT_AREA
))
2017 *area
= LEFT_MARGIN_AREA
;
2018 x0
= window_box_left_offset (w
, LEFT_MARGIN_AREA
);
2020 else if (x
< window_box_right_offset (w
, TEXT_AREA
))
2023 x0
= window_box_left_offset (w
, TEXT_AREA
) + min (row
->x
, 0);
2027 *area
= RIGHT_MARGIN_AREA
;
2028 x0
= window_box_left_offset (w
, RIGHT_MARGIN_AREA
);
2032 /* Find glyph containing X. */
2033 glyph
= row
->glyphs
[*area
];
2034 end
= glyph
+ row
->used
[*area
];
2036 while (glyph
< end
&& x
>= glyph
->pixel_width
)
2038 x
-= glyph
->pixel_width
;
2048 *dy
= y
- (row
->y
+ row
->ascent
- glyph
->ascent
);
2051 *hpos
= glyph
- row
->glyphs
[*area
];
2055 /* Convert frame-relative x/y to coordinates relative to window W.
2056 Takes pseudo-windows into account. */
2059 frame_to_window_pixel_xy (struct window
*w
, int *x
, int *y
)
2061 if (w
->pseudo_window_p
)
2063 /* A pseudo-window is always full-width, and starts at the
2064 left edge of the frame, plus a frame border. */
2065 struct frame
*f
= XFRAME (w
->frame
);
2066 *x
-= FRAME_INTERNAL_BORDER_WIDTH (f
);
2067 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2071 *x
-= WINDOW_LEFT_EDGE_X (w
);
2072 *y
= FRAME_TO_WINDOW_PIXEL_Y (w
, *y
);
2076 #ifdef HAVE_WINDOW_SYSTEM
2079 Return in RECTS[] at most N clipping rectangles for glyph string S.
2080 Return the number of stored rectangles. */
2083 get_glyph_string_clip_rects (struct glyph_string
*s
, NativeRectangle
*rects
, int n
)
2090 if (s
->row
->full_width_p
)
2092 /* Draw full-width. X coordinates are relative to S->w->left_col. */
2093 r
.x
= WINDOW_LEFT_EDGE_X (s
->w
);
2094 if (s
->row
->mode_line_p
)
2095 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
) - WINDOW_RIGHT_DIVIDER_WIDTH (s
->w
);
2097 r
.width
= WINDOW_PIXEL_WIDTH (s
->w
);
2099 /* Unless displaying a mode or menu bar line, which are always
2100 fully visible, clip to the visible part of the row. */
2101 if (s
->w
->pseudo_window_p
)
2102 r
.height
= s
->row
->visible_height
;
2104 r
.height
= s
->height
;
2108 /* This is a text line that may be partially visible. */
2109 r
.x
= window_box_left (s
->w
, s
->area
);
2110 r
.width
= window_box_width (s
->w
, s
->area
);
2111 r
.height
= s
->row
->visible_height
;
2115 if (r
.x
< s
->clip_head
->x
)
2117 if (r
.width
>= s
->clip_head
->x
- r
.x
)
2118 r
.width
-= s
->clip_head
->x
- r
.x
;
2121 r
.x
= s
->clip_head
->x
;
2124 if (r
.x
+ r
.width
> s
->clip_tail
->x
+ s
->clip_tail
->background_width
)
2126 if (s
->clip_tail
->x
+ s
->clip_tail
->background_width
>= r
.x
)
2127 r
.width
= s
->clip_tail
->x
+ s
->clip_tail
->background_width
- r
.x
;
2132 /* If S draws overlapping rows, it's sufficient to use the top and
2133 bottom of the window for clipping because this glyph string
2134 intentionally draws over other lines. */
2135 if (s
->for_overlaps
)
2137 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2138 r
.height
= window_text_bottom_y (s
->w
) - r
.y
;
2140 /* Alas, the above simple strategy does not work for the
2141 environments with anti-aliased text: if the same text is
2142 drawn onto the same place multiple times, it gets thicker.
2143 If the overlap we are processing is for the erased cursor, we
2144 take the intersection with the rectangle of the cursor. */
2145 if (s
->for_overlaps
& OVERLAPS_ERASED_CURSOR
)
2147 XRectangle rc
, r_save
= r
;
2149 rc
.x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (s
->w
, s
->w
->phys_cursor
.x
);
2150 rc
.y
= s
->w
->phys_cursor
.y
;
2151 rc
.width
= s
->w
->phys_cursor_width
;
2152 rc
.height
= s
->w
->phys_cursor_height
;
2154 x_intersect_rectangles (&r_save
, &rc
, &r
);
2159 /* Don't use S->y for clipping because it doesn't take partially
2160 visible lines into account. For example, it can be negative for
2161 partially visible lines at the top of a window. */
2162 if (!s
->row
->full_width_p
2163 && MATRIX_ROW_PARTIALLY_VISIBLE_AT_TOP_P (s
->w
, s
->row
))
2164 r
.y
= WINDOW_HEADER_LINE_HEIGHT (s
->w
);
2166 r
.y
= max (0, s
->row
->y
);
2169 r
.y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, r
.y
);
2171 /* If drawing the cursor, don't let glyph draw outside its
2172 advertised boundaries. Cleartype does this under some circumstances. */
2173 if (s
->hl
== DRAW_CURSOR
)
2175 struct glyph
*glyph
= s
->first_glyph
;
2180 if (r
.width
>= s
->x
- r
.x
)
2181 r
.width
-= s
->x
- r
.x
;
2182 else /* R2L hscrolled row with cursor outside text area */
2186 r
.width
= min (r
.width
, glyph
->pixel_width
);
2188 /* If r.y is below window bottom, ensure that we still see a cursor. */
2189 height
= min (glyph
->ascent
+ glyph
->descent
,
2190 min (FRAME_LINE_HEIGHT (s
->f
), s
->row
->visible_height
));
2191 max_y
= window_text_bottom_y (s
->w
) - height
;
2192 max_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, max_y
);
2193 if (s
->ybase
- glyph
->ascent
> max_y
)
2200 /* Don't draw cursor glyph taller than our actual glyph. */
2201 height
= max (FRAME_LINE_HEIGHT (s
->f
), glyph
->ascent
+ glyph
->descent
);
2202 if (height
< r
.height
)
2204 max_y
= r
.y
+ r
.height
;
2205 r
.y
= min (max_y
, max (r
.y
, s
->ybase
+ glyph
->descent
- height
));
2206 r
.height
= min (max_y
- r
.y
, height
);
2213 XRectangle r_save
= r
;
2215 if (! x_intersect_rectangles (&r_save
, s
->row
->clip
, &r
))
2219 if ((s
->for_overlaps
& OVERLAPS_BOTH
) == 0
2220 || ((s
->for_overlaps
& OVERLAPS_BOTH
) == OVERLAPS_BOTH
&& n
== 1))
2222 #ifdef CONVERT_FROM_XRECT
2223 CONVERT_FROM_XRECT (r
, *rects
);
2231 /* If we are processing overlapping and allowed to return
2232 multiple clipping rectangles, we exclude the row of the glyph
2233 string from the clipping rectangle. This is to avoid drawing
2234 the same text on the environment with anti-aliasing. */
2235 #ifdef CONVERT_FROM_XRECT
2238 XRectangle
*rs
= rects
;
2240 int i
= 0, row_y
= WINDOW_TO_FRAME_PIXEL_Y (s
->w
, s
->row
->y
);
2242 if (s
->for_overlaps
& OVERLAPS_PRED
)
2245 if (r
.y
+ r
.height
> row_y
)
2248 rs
[i
].height
= row_y
- r
.y
;
2254 if (s
->for_overlaps
& OVERLAPS_SUCC
)
2257 if (r
.y
< row_y
+ s
->row
->visible_height
)
2259 if (r
.y
+ r
.height
> row_y
+ s
->row
->visible_height
)
2261 rs
[i
].y
= row_y
+ s
->row
->visible_height
;
2262 rs
[i
].height
= r
.y
+ r
.height
- rs
[i
].y
;
2271 #ifdef CONVERT_FROM_XRECT
2272 for (i
= 0; i
< n
; i
++)
2273 CONVERT_FROM_XRECT (rs
[i
], rects
[i
]);
2280 Return in *NR the clipping rectangle for glyph string S. */
2283 get_glyph_string_clip_rect (struct glyph_string
*s
, NativeRectangle
*nr
)
2285 get_glyph_string_clip_rects (s
, nr
, 1);
2290 Return the position and height of the phys cursor in window W.
2291 Set w->phys_cursor_width to width of phys cursor.
2295 get_phys_cursor_geometry (struct window
*w
, struct glyph_row
*row
,
2296 struct glyph
*glyph
, int *xp
, int *yp
, int *heightp
)
2298 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
2299 int x
, y
, wd
, h
, h0
, y0
;
2301 /* Compute the width of the rectangle to draw. If on a stretch
2302 glyph, and `x-stretch-block-cursor' is nil, don't draw a
2303 rectangle as wide as the glyph, but use a canonical character
2305 wd
= glyph
->pixel_width
;
2307 x
= w
->phys_cursor
.x
;
2314 if (glyph
->type
== STRETCH_GLYPH
2315 && !x_stretch_cursor_p
)
2316 wd
= min (FRAME_COLUMN_WIDTH (f
), wd
);
2317 w
->phys_cursor_width
= wd
;
2319 y
= w
->phys_cursor
.y
+ row
->ascent
- glyph
->ascent
;
2321 /* If y is below window bottom, ensure that we still see a cursor. */
2322 h0
= min (FRAME_LINE_HEIGHT (f
), row
->visible_height
);
2324 h
= max (h0
, glyph
->ascent
+ glyph
->descent
);
2325 h0
= min (h0
, glyph
->ascent
+ glyph
->descent
);
2327 y0
= WINDOW_HEADER_LINE_HEIGHT (w
);
2330 h
= max (h
- (y0
- y
) + 1, h0
);
2335 y0
= window_text_bottom_y (w
) - h0
;
2343 *xp
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
2344 *yp
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
);
2349 * Remember which glyph the mouse is over.
2353 remember_mouse_glyph (struct frame
*f
, int gx
, int gy
, NativeRectangle
*rect
)
2357 struct glyph_row
*r
, *gr
, *end_row
;
2358 enum window_part part
;
2359 enum glyph_row_area area
;
2360 int x
, y
, width
, height
;
2362 /* Try to determine frame pixel position and size of the glyph under
2363 frame pixel coordinates X/Y on frame F. */
2365 if (window_resize_pixelwise
)
2370 else if (!f
->glyphs_initialized_p
2371 || (window
= window_from_coordinates (f
, gx
, gy
, &part
, 0),
2374 width
= FRAME_SMALLEST_CHAR_WIDTH (f
);
2375 height
= FRAME_SMALLEST_FONT_HEIGHT (f
);
2379 w
= XWINDOW (window
);
2380 width
= WINDOW_FRAME_COLUMN_WIDTH (w
);
2381 height
= WINDOW_FRAME_LINE_HEIGHT (w
);
2383 x
= window_relative_x_coord (w
, part
, gx
);
2384 y
= gy
- WINDOW_TOP_EDGE_Y (w
);
2386 r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
2387 end_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
2389 if (w
->pseudo_window_p
)
2392 part
= ON_MODE_LINE
; /* Don't adjust margin. */
2398 case ON_LEFT_MARGIN
:
2399 area
= LEFT_MARGIN_AREA
;
2402 case ON_RIGHT_MARGIN
:
2403 area
= RIGHT_MARGIN_AREA
;
2406 case ON_HEADER_LINE
:
2408 gr
= (part
== ON_HEADER_LINE
2409 ? MATRIX_HEADER_LINE_ROW (w
->current_matrix
)
2410 : MATRIX_MODE_LINE_ROW (w
->current_matrix
));
2413 goto text_glyph_row_found
;
2420 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2421 if (r
->y
+ r
->height
> y
)
2427 text_glyph_row_found
:
2430 struct glyph
*g
= gr
->glyphs
[area
];
2431 struct glyph
*end
= g
+ gr
->used
[area
];
2433 height
= gr
->height
;
2434 for (gx
= gr
->x
; g
< end
; gx
+= g
->pixel_width
, ++g
)
2435 if (gx
+ g
->pixel_width
> x
)
2440 if (g
->type
== IMAGE_GLYPH
)
2442 /* Don't remember when mouse is over image, as
2443 image may have hot-spots. */
2444 STORE_NATIVE_RECT (*rect
, 0, 0, 0, 0);
2447 width
= g
->pixel_width
;
2451 /* Use nominal char spacing at end of line. */
2453 gx
+= (x
/ width
) * width
;
2456 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2458 gx
+= window_box_left_offset (w
, area
);
2459 /* Don't expand over the modeline to make sure the vertical
2460 drag cursor is shown early enough. */
2461 height
= min (height
,
2462 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2467 /* Use nominal line height at end of window. */
2468 gx
= (x
/ width
) * width
;
2470 gy
+= (y
/ height
) * height
;
2471 if (part
!= ON_MODE_LINE
&& part
!= ON_HEADER_LINE
)
2472 /* See comment above. */
2473 height
= min (height
,
2474 max (0, WINDOW_BOX_HEIGHT_NO_MODE_LINE (w
) - gy
));
2478 case ON_LEFT_FRINGE
:
2479 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2480 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
)
2481 : window_box_right_offset (w
, LEFT_MARGIN_AREA
));
2482 width
= WINDOW_LEFT_FRINGE_WIDTH (w
);
2485 case ON_RIGHT_FRINGE
:
2486 gx
= (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2487 ? window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2488 : window_box_right_offset (w
, TEXT_AREA
));
2489 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
) == 0
2490 && !WINDOW_HAS_VERTICAL_SCROLL_BAR (w
)
2491 && !WINDOW_RIGHTMOST_P (w
))
2492 if (gx
< WINDOW_PIXEL_WIDTH (w
) - width
)
2493 /* Make sure the vertical border can get her own glyph to the
2494 right of the one we build here. */
2495 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
) - width
;
2497 width
= WINDOW_PIXEL_WIDTH (w
) - gx
;
2499 width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
2503 case ON_VERTICAL_BORDER
:
2504 gx
= WINDOW_PIXEL_WIDTH (w
) - width
;
2507 case ON_VERTICAL_SCROLL_BAR
:
2508 gx
= (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
)
2510 : (window_box_right_offset (w
, RIGHT_MARGIN_AREA
)
2511 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
2512 ? WINDOW_RIGHT_FRINGE_WIDTH (w
)
2514 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
2518 for (; r
<= end_row
&& r
->enabled_p
; ++r
)
2519 if (r
->y
+ r
->height
> y
)
2526 height
= gr
->height
;
2529 /* Use nominal line height at end of window. */
2531 gy
+= (y
/ height
) * height
;
2535 case ON_RIGHT_DIVIDER
:
2536 gx
= WINDOW_PIXEL_WIDTH (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2537 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
2539 /* The bottom divider prevails. */
2540 height
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2543 case ON_BOTTOM_DIVIDER
:
2545 width
= WINDOW_PIXEL_WIDTH (w
);
2546 gy
= WINDOW_PIXEL_HEIGHT (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2547 height
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
2553 /* If there is no glyph under the mouse, then we divide the screen
2554 into a grid of the smallest glyph in the frame, and use that
2557 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
2558 round down even for negative values. */
2564 gx
= (gx
/ width
) * width
;
2565 gy
= (gy
/ height
) * height
;
2571 gx
+= WINDOW_LEFT_EDGE_X (w
);
2572 gy
+= WINDOW_TOP_EDGE_Y (w
);
2575 STORE_NATIVE_RECT (*rect
, gx
, gy
, width
, height
);
2577 /* Visible feedback for debugging. */
2580 XDrawRectangle (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2581 f
->output_data
.x
->normal_gc
,
2582 gx
, gy
, width
, height
);
2588 #endif /* HAVE_WINDOW_SYSTEM */
2591 adjust_window_ends (struct window
*w
, struct glyph_row
*row
, bool current
)
2594 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
2595 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
2597 = MATRIX_ROW_VPOS (row
, current
? w
->current_matrix
: w
->desired_matrix
);
2600 /***********************************************************************
2601 Lisp form evaluation
2602 ***********************************************************************/
2604 /* Error handler for safe_eval and safe_call. */
2607 safe_eval_handler (Lisp_Object arg
, ptrdiff_t nargs
, Lisp_Object
*args
)
2609 add_to_log ("Error during redisplay: %S signaled %S",
2610 Flist (nargs
, args
), arg
);
2614 /* Call function FUNC with the rest of NARGS - 1 arguments
2615 following. Return the result, or nil if something went
2616 wrong. Prevent redisplay during the evaluation. */
2619 safe__call (bool inhibit_quit
, ptrdiff_t nargs
, Lisp_Object func
, va_list ap
)
2623 if (inhibit_eval_during_redisplay
)
2628 ptrdiff_t count
= SPECPDL_INDEX ();
2631 SAFE_ALLOCA_LISP (args
, nargs
);
2634 for (i
= 1; i
< nargs
; i
++)
2635 args
[i
] = va_arg (ap
, Lisp_Object
);
2637 specbind (Qinhibit_redisplay
, Qt
);
2639 specbind (Qinhibit_quit
, Qt
);
2640 /* Use Qt to ensure debugger does not run,
2641 so there is no possibility of wanting to redisplay. */
2642 val
= internal_condition_case_n (Ffuncall
, nargs
, args
, Qt
,
2645 val
= unbind_to (count
, val
);
2652 safe_call (ptrdiff_t nargs
, Lisp_Object func
, ...)
2657 va_start (ap
, func
);
2658 retval
= safe__call (false, nargs
, func
, ap
);
2663 /* Call function FN with one argument ARG.
2664 Return the result, or nil if something went wrong. */
2667 safe_call1 (Lisp_Object fn
, Lisp_Object arg
)
2669 return safe_call (2, fn
, arg
);
2673 safe__call1 (bool inhibit_quit
, Lisp_Object fn
, ...)
2679 retval
= safe__call (inhibit_quit
, 2, fn
, ap
);
2684 static Lisp_Object Qeval
;
2687 safe_eval (Lisp_Object sexpr
)
2689 return safe__call1 (false, Qeval
, sexpr
);
2693 safe__eval (bool inhibit_quit
, Lisp_Object sexpr
)
2695 return safe__call1 (inhibit_quit
, Qeval
, sexpr
);
2698 /* Call function FN with two arguments ARG1 and ARG2.
2699 Return the result, or nil if something went wrong. */
2702 safe_call2 (Lisp_Object fn
, Lisp_Object arg1
, Lisp_Object arg2
)
2704 return safe_call (3, fn
, arg1
, arg2
);
2709 /***********************************************************************
2711 ***********************************************************************/
2715 /* Define CHECK_IT to perform sanity checks on iterators.
2716 This is for debugging. It is too slow to do unconditionally. */
2719 check_it (struct it
*it
)
2721 if (it
->method
== GET_FROM_STRING
)
2723 eassert (STRINGP (it
->string
));
2724 eassert (IT_STRING_CHARPOS (*it
) >= 0);
2728 eassert (IT_STRING_CHARPOS (*it
) < 0);
2729 if (it
->method
== GET_FROM_BUFFER
)
2731 /* Check that character and byte positions agree. */
2732 eassert (IT_CHARPOS (*it
) == BYTE_TO_CHAR (IT_BYTEPOS (*it
)));
2737 eassert (it
->current
.dpvec_index
>= 0);
2739 eassert (it
->current
.dpvec_index
< 0);
2742 #define CHECK_IT(IT) check_it ((IT))
2746 #define CHECK_IT(IT) (void) 0
2751 #if defined GLYPH_DEBUG && defined ENABLE_CHECKING
2753 /* Check that the window end of window W is what we expect it
2754 to be---the last row in the current matrix displaying text. */
2757 check_window_end (struct window
*w
)
2759 if (!MINI_WINDOW_P (w
) && w
->window_end_valid
)
2761 struct glyph_row
*row
;
2762 eassert ((row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
),
2764 || MATRIX_ROW_DISPLAYS_TEXT_P (row
)
2765 || MATRIX_ROW_VPOS (row
, w
->current_matrix
) == 0));
2769 #define CHECK_WINDOW_END(W) check_window_end ((W))
2773 #define CHECK_WINDOW_END(W) (void) 0
2775 #endif /* GLYPH_DEBUG and ENABLE_CHECKING */
2777 /***********************************************************************
2778 Iterator initialization
2779 ***********************************************************************/
2781 /* Initialize IT for displaying current_buffer in window W, starting
2782 at character position CHARPOS. CHARPOS < 0 means that no buffer
2783 position is specified which is useful when the iterator is assigned
2784 a position later. BYTEPOS is the byte position corresponding to
2787 If ROW is not null, calls to produce_glyphs with IT as parameter
2788 will produce glyphs in that row.
2790 BASE_FACE_ID is the id of a base face to use. It must be one of
2791 DEFAULT_FACE_ID for normal text, MODE_LINE_FACE_ID,
2792 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID for displaying
2793 mode lines, or TOOL_BAR_FACE_ID for displaying the tool-bar.
2795 If ROW is null and BASE_FACE_ID is equal to MODE_LINE_FACE_ID,
2796 MODE_LINE_INACTIVE_FACE_ID, or HEADER_LINE_FACE_ID, the iterator
2797 will be initialized to use the corresponding mode line glyph row of
2798 the desired matrix of W. */
2801 init_iterator (struct it
*it
, struct window
*w
,
2802 ptrdiff_t charpos
, ptrdiff_t bytepos
,
2803 struct glyph_row
*row
, enum face_id base_face_id
)
2805 enum face_id remapped_base_face_id
= base_face_id
;
2807 /* Some precondition checks. */
2808 eassert (w
!= NULL
&& it
!= NULL
);
2809 eassert (charpos
< 0 || (charpos
>= BUF_BEG (current_buffer
)
2812 /* If face attributes have been changed since the last redisplay,
2813 free realized faces now because they depend on face definitions
2814 that might have changed. Don't free faces while there might be
2815 desired matrices pending which reference these faces. */
2816 if (face_change_count
&& !inhibit_free_realized_faces
)
2818 face_change_count
= 0;
2819 free_all_realized_faces (Qnil
);
2822 /* Perhaps remap BASE_FACE_ID to a user-specified alternative. */
2823 if (! NILP (Vface_remapping_alist
))
2824 remapped_base_face_id
2825 = lookup_basic_face (XFRAME (w
->frame
), base_face_id
);
2827 /* Use one of the mode line rows of W's desired matrix if
2831 if (base_face_id
== MODE_LINE_FACE_ID
2832 || base_face_id
== MODE_LINE_INACTIVE_FACE_ID
)
2833 row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
2834 else if (base_face_id
== HEADER_LINE_FACE_ID
)
2835 row
= MATRIX_HEADER_LINE_ROW (w
->desired_matrix
);
2839 memset (it
, 0, sizeof *it
);
2840 it
->current
.overlay_string_index
= -1;
2841 it
->current
.dpvec_index
= -1;
2842 it
->base_face_id
= remapped_base_face_id
;
2844 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
2845 it
->paragraph_embedding
= L2R
;
2846 it
->bidi_it
.string
.lstring
= Qnil
;
2847 it
->bidi_it
.string
.s
= NULL
;
2848 it
->bidi_it
.string
.bufpos
= 0;
2851 /* The window in which we iterate over current_buffer: */
2852 XSETWINDOW (it
->window
, w
);
2854 it
->f
= XFRAME (w
->frame
);
2858 /* Extra space between lines (on window systems only). */
2859 if (base_face_id
== DEFAULT_FACE_ID
2860 && FRAME_WINDOW_P (it
->f
))
2862 if (NATNUMP (BVAR (current_buffer
, extra_line_spacing
)))
2863 it
->extra_line_spacing
= XFASTINT (BVAR (current_buffer
, extra_line_spacing
));
2864 else if (FLOATP (BVAR (current_buffer
, extra_line_spacing
)))
2865 it
->extra_line_spacing
= (XFLOAT_DATA (BVAR (current_buffer
, extra_line_spacing
))
2866 * FRAME_LINE_HEIGHT (it
->f
));
2867 else if (it
->f
->extra_line_spacing
> 0)
2868 it
->extra_line_spacing
= it
->f
->extra_line_spacing
;
2869 it
->max_extra_line_spacing
= 0;
2872 /* If realized faces have been removed, e.g. because of face
2873 attribute changes of named faces, recompute them. When running
2874 in batch mode, the face cache of the initial frame is null. If
2875 we happen to get called, make a dummy face cache. */
2876 if (FRAME_FACE_CACHE (it
->f
) == NULL
)
2877 init_frame_faces (it
->f
);
2878 if (FRAME_FACE_CACHE (it
->f
)->used
== 0)
2879 recompute_basic_faces (it
->f
);
2881 /* Current value of the `slice', `space-width', and 'height' properties. */
2882 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
2883 it
->space_width
= Qnil
;
2884 it
->font_height
= Qnil
;
2885 it
->override_ascent
= -1;
2887 /* Are control characters displayed as `^C'? */
2888 it
->ctl_arrow_p
= !NILP (BVAR (current_buffer
, ctl_arrow
));
2890 /* -1 means everything between a CR and the following line end
2891 is invisible. >0 means lines indented more than this value are
2893 it
->selective
= (INTEGERP (BVAR (current_buffer
, selective_display
))
2895 (-1, XINT (BVAR (current_buffer
, selective_display
)),
2897 : (!NILP (BVAR (current_buffer
, selective_display
))
2899 it
->selective_display_ellipsis_p
2900 = !NILP (BVAR (current_buffer
, selective_display_ellipses
));
2902 /* Display table to use. */
2903 it
->dp
= window_display_table (w
);
2905 /* Are multibyte characters enabled in current_buffer? */
2906 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
2908 /* Get the position at which the redisplay_end_trigger hook should
2909 be run, if it is to be run at all. */
2910 if (MARKERP (w
->redisplay_end_trigger
)
2911 && XMARKER (w
->redisplay_end_trigger
)->buffer
!= 0)
2912 it
->redisplay_end_trigger_charpos
2913 = marker_position (w
->redisplay_end_trigger
);
2914 else if (INTEGERP (w
->redisplay_end_trigger
))
2915 it
->redisplay_end_trigger_charpos
2916 = clip_to_bounds (PTRDIFF_MIN
, XINT (w
->redisplay_end_trigger
),
2919 it
->tab_width
= SANE_TAB_WIDTH (current_buffer
);
2921 /* Are lines in the display truncated? */
2922 if (base_face_id
!= DEFAULT_FACE_ID
2924 || (! WINDOW_FULL_WIDTH_P (it
->w
)
2925 && ((!NILP (Vtruncate_partial_width_windows
)
2926 && !INTEGERP (Vtruncate_partial_width_windows
))
2927 || (INTEGERP (Vtruncate_partial_width_windows
)
2928 /* PXW: Shall we do something about this? */
2929 && (WINDOW_TOTAL_COLS (it
->w
)
2930 < XINT (Vtruncate_partial_width_windows
))))))
2931 it
->line_wrap
= TRUNCATE
;
2932 else if (NILP (BVAR (current_buffer
, truncate_lines
)))
2933 it
->line_wrap
= NILP (BVAR (current_buffer
, word_wrap
))
2934 ? WINDOW_WRAP
: WORD_WRAP
;
2936 it
->line_wrap
= TRUNCATE
;
2938 /* Get dimensions of truncation and continuation glyphs. These are
2939 displayed as fringe bitmaps under X, but we need them for such
2940 frames when the fringes are turned off. But leave the dimensions
2941 zero for tooltip frames, as these glyphs look ugly there and also
2942 sabotage calculations of tooltip dimensions in x-show-tip. */
2943 #ifdef HAVE_WINDOW_SYSTEM
2944 if (!(FRAME_WINDOW_P (it
->f
)
2945 && FRAMEP (tip_frame
)
2946 && it
->f
== XFRAME (tip_frame
)))
2949 if (it
->line_wrap
== TRUNCATE
)
2951 /* We will need the truncation glyph. */
2952 eassert (it
->glyph_row
== NULL
);
2953 produce_special_glyphs (it
, IT_TRUNCATION
);
2954 it
->truncation_pixel_width
= it
->pixel_width
;
2958 /* We will need the continuation glyph. */
2959 eassert (it
->glyph_row
== NULL
);
2960 produce_special_glyphs (it
, IT_CONTINUATION
);
2961 it
->continuation_pixel_width
= it
->pixel_width
;
2965 /* Reset these values to zero because the produce_special_glyphs
2966 above has changed them. */
2967 it
->pixel_width
= it
->ascent
= it
->descent
= 0;
2968 it
->phys_ascent
= it
->phys_descent
= 0;
2970 /* Set this after getting the dimensions of truncation and
2971 continuation glyphs, so that we don't produce glyphs when calling
2972 produce_special_glyphs, above. */
2973 it
->glyph_row
= row
;
2974 it
->area
= TEXT_AREA
;
2976 /* Get the dimensions of the display area. The display area
2977 consists of the visible window area plus a horizontally scrolled
2978 part to the left of the window. All x-values are relative to the
2979 start of this total display area. */
2980 if (base_face_id
!= DEFAULT_FACE_ID
)
2982 /* Mode lines, menu bar in terminal frames. */
2983 it
->first_visible_x
= 0;
2984 it
->last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
2989 = window_hscroll_limited (it
->w
, it
->f
) * FRAME_COLUMN_WIDTH (it
->f
);
2990 it
->last_visible_x
= (it
->first_visible_x
2991 + window_box_width (w
, TEXT_AREA
));
2993 /* If we truncate lines, leave room for the truncation glyph(s) at
2994 the right margin. Otherwise, leave room for the continuation
2995 glyph(s). Done only if the window has no right fringe. */
2996 if (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
2998 if (it
->line_wrap
== TRUNCATE
)
2999 it
->last_visible_x
-= it
->truncation_pixel_width
;
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
->stop_charpos
= charpos
;
3035 it
->end_charpos
= ZV
;
3036 eassert (charpos
== BYTE_TO_CHAR (bytepos
));
3037 IT_CHARPOS (*it
) = charpos
;
3038 IT_BYTEPOS (*it
) = bytepos
;
3040 /* We will rely on `reseat' to set this up properly, via
3041 handle_face_prop. */
3042 it
->face_id
= it
->base_face_id
;
3044 it
->start
= it
->current
;
3045 /* Do we need to reorder bidirectional text? Not if this is a
3046 unibyte buffer: by definition, none of the single-byte
3047 characters are strong R2L, so no reordering is needed. And
3048 bidi.c doesn't support unibyte buffers anyway. Also, don't
3049 reorder while we are loading loadup.el, since the tables of
3050 character properties needed for reordering are not yet
3054 && !NILP (BVAR (current_buffer
, bidi_display_reordering
))
3057 /* If we are to reorder bidirectional text, init the bidi
3061 /* Since we don't know at this point whether there will be
3062 any R2L lines in the window, we reserve space for
3063 truncation/continuation glyphs even if only the left
3064 fringe is absent. */
3065 if (base_face_id
== DEFAULT_FACE_ID
3066 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
3067 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
3069 if (it
->line_wrap
== TRUNCATE
)
3070 it
->last_visible_x
-= it
->truncation_pixel_width
;
3072 it
->last_visible_x
-= it
->continuation_pixel_width
;
3074 /* Note the paragraph direction that this buffer wants to
3076 if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3078 it
->paragraph_embedding
= L2R
;
3079 else if (EQ (BVAR (current_buffer
, bidi_paragraph_direction
),
3081 it
->paragraph_embedding
= R2L
;
3083 it
->paragraph_embedding
= NEUTRAL_DIR
;
3084 bidi_unshelve_cache (NULL
, 0);
3085 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
3089 /* Compute faces etc. */
3090 reseat (it
, it
->current
.pos
, 1);
3097 /* Initialize IT for the display of window W with window start POS. */
3100 start_display (struct it
*it
, struct window
*w
, struct text_pos pos
)
3102 struct glyph_row
*row
;
3103 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
3105 row
= w
->desired_matrix
->rows
+ first_vpos
;
3106 init_iterator (it
, w
, CHARPOS (pos
), BYTEPOS (pos
), row
, DEFAULT_FACE_ID
);
3107 it
->first_vpos
= first_vpos
;
3109 /* Don't reseat to previous visible line start if current start
3110 position is in a string or image. */
3111 if (it
->method
== GET_FROM_BUFFER
&& it
->line_wrap
!= TRUNCATE
)
3113 int start_at_line_beg_p
;
3114 int first_y
= it
->current_y
;
3116 /* If window start is not at a line start, skip forward to POS to
3117 get the correct continuation lines width. */
3118 start_at_line_beg_p
= (CHARPOS (pos
) == BEGV
3119 || FETCH_BYTE (BYTEPOS (pos
) - 1) == '\n');
3120 if (!start_at_line_beg_p
)
3124 reseat_at_previous_visible_line_start (it
);
3125 move_it_to (it
, CHARPOS (pos
), -1, -1, -1, MOVE_TO_POS
);
3127 new_x
= it
->current_x
+ it
->pixel_width
;
3129 /* If lines are continued, this line may end in the middle
3130 of a multi-glyph character (e.g. a control character
3131 displayed as \003, or in the middle of an overlay
3132 string). In this case move_it_to above will not have
3133 taken us to the start of the continuation line but to the
3134 end of the continued line. */
3135 if (it
->current_x
> 0
3136 && it
->line_wrap
!= TRUNCATE
/* Lines are continued. */
3137 && (/* And glyph doesn't fit on the line. */
3138 new_x
> it
->last_visible_x
3139 /* Or it fits exactly and we're on a window
3141 || (new_x
== it
->last_visible_x
3142 && FRAME_WINDOW_P (it
->f
)
3143 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
3144 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
3145 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
3147 if ((it
->current
.dpvec_index
>= 0
3148 || it
->current
.overlay_string_index
>= 0)
3149 /* If we are on a newline from a display vector or
3150 overlay string, then we are already at the end of
3151 a screen line; no need to go to the next line in
3152 that case, as this line is not really continued.
3153 (If we do go to the next line, C-e will not DTRT.) */
3156 set_iterator_to_next (it
, 1);
3157 move_it_in_display_line_to (it
, -1, -1, 0);
3160 it
->continuation_lines_width
+= it
->current_x
;
3162 /* If the character at POS is displayed via a display
3163 vector, move_it_to above stops at the final glyph of
3164 IT->dpvec. To make the caller redisplay that character
3165 again (a.k.a. start at POS), we need to reset the
3166 dpvec_index to the beginning of IT->dpvec. */
3167 else if (it
->current
.dpvec_index
>= 0)
3168 it
->current
.dpvec_index
= 0;
3170 /* We're starting a new display line, not affected by the
3171 height of the continued line, so clear the appropriate
3172 fields in the iterator structure. */
3173 it
->max_ascent
= it
->max_descent
= 0;
3174 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
3176 it
->current_y
= first_y
;
3178 it
->current_x
= it
->hpos
= 0;
3184 /* Return 1 if POS is a position in ellipses displayed for invisible
3185 text. W is the window we display, for text property lookup. */
3188 in_ellipses_for_invisible_text_p (struct display_pos
*pos
, struct window
*w
)
3190 Lisp_Object prop
, window
;
3192 ptrdiff_t charpos
= CHARPOS (pos
->pos
);
3194 /* If POS specifies a position in a display vector, this might
3195 be for an ellipsis displayed for invisible text. We won't
3196 get the iterator set up for delivering that ellipsis unless
3197 we make sure that it gets aware of the invisible text. */
3198 if (pos
->dpvec_index
>= 0
3199 && pos
->overlay_string_index
< 0
3200 && CHARPOS (pos
->string_pos
) < 0
3202 && (XSETWINDOW (window
, w
),
3203 prop
= Fget_char_property (make_number (charpos
),
3204 Qinvisible
, window
),
3205 !TEXT_PROP_MEANS_INVISIBLE (prop
)))
3207 prop
= Fget_char_property (make_number (charpos
- 1), Qinvisible
,
3209 ellipses_p
= 2 == TEXT_PROP_MEANS_INVISIBLE (prop
);
3216 /* Initialize IT for stepping through current_buffer in window W,
3217 starting at position POS that includes overlay string and display
3218 vector/ control character translation position information. Value
3219 is zero if there are overlay strings with newlines at POS. */
3222 init_from_display_pos (struct it
*it
, struct window
*w
, struct display_pos
*pos
)
3224 ptrdiff_t charpos
= CHARPOS (pos
->pos
), bytepos
= BYTEPOS (pos
->pos
);
3225 int i
, overlay_strings_with_newlines
= 0;
3227 /* If POS specifies a position in a display vector, this might
3228 be for an ellipsis displayed for invisible text. We won't
3229 get the iterator set up for delivering that ellipsis unless
3230 we make sure that it gets aware of the invisible text. */
3231 if (in_ellipses_for_invisible_text_p (pos
, w
))
3237 /* Keep in mind: the call to reseat in init_iterator skips invisible
3238 text, so we might end up at a position different from POS. This
3239 is only a problem when POS is a row start after a newline and an
3240 overlay starts there with an after-string, and the overlay has an
3241 invisible property. Since we don't skip invisible text in
3242 display_line and elsewhere immediately after consuming the
3243 newline before the row start, such a POS will not be in a string,
3244 but the call to init_iterator below will move us to the
3246 init_iterator (it
, w
, charpos
, bytepos
, NULL
, DEFAULT_FACE_ID
);
3248 /* This only scans the current chunk -- it should scan all chunks.
3249 However, OVERLAY_STRING_CHUNK_SIZE has been increased from 3 in 21.1
3250 to 16 in 22.1 to make this a lesser problem. */
3251 for (i
= 0; i
< it
->n_overlay_strings
&& i
< OVERLAY_STRING_CHUNK_SIZE
; ++i
)
3253 const char *s
= SSDATA (it
->overlay_strings
[i
]);
3254 const char *e
= s
+ SBYTES (it
->overlay_strings
[i
]);
3256 while (s
< e
&& *s
!= '\n')
3261 overlay_strings_with_newlines
= 1;
3266 /* If position is within an overlay string, set up IT to the right
3268 if (pos
->overlay_string_index
>= 0)
3272 /* If the first overlay string happens to have a `display'
3273 property for an image, the iterator will be set up for that
3274 image, and we have to undo that setup first before we can
3275 correct the overlay string index. */
3276 if (it
->method
== GET_FROM_IMAGE
)
3279 /* We already have the first chunk of overlay strings in
3280 IT->overlay_strings. Load more until the one for
3281 pos->overlay_string_index is in IT->overlay_strings. */
3282 if (pos
->overlay_string_index
>= OVERLAY_STRING_CHUNK_SIZE
)
3284 ptrdiff_t n
= pos
->overlay_string_index
/ OVERLAY_STRING_CHUNK_SIZE
;
3285 it
->current
.overlay_string_index
= 0;
3288 load_overlay_strings (it
, 0);
3289 it
->current
.overlay_string_index
+= OVERLAY_STRING_CHUNK_SIZE
;
3293 it
->current
.overlay_string_index
= pos
->overlay_string_index
;
3294 relative_index
= (it
->current
.overlay_string_index
3295 % OVERLAY_STRING_CHUNK_SIZE
);
3296 it
->string
= it
->overlay_strings
[relative_index
];
3297 eassert (STRINGP (it
->string
));
3298 it
->current
.string_pos
= pos
->string_pos
;
3299 it
->method
= GET_FROM_STRING
;
3300 it
->end_charpos
= SCHARS (it
->string
);
3301 /* Set up the bidi iterator for this overlay string. */
3304 it
->bidi_it
.string
.lstring
= it
->string
;
3305 it
->bidi_it
.string
.s
= NULL
;
3306 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
3307 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
3308 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
3309 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
3310 it
->bidi_it
.w
= it
->w
;
3311 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3312 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3314 /* Synchronize the state of the bidi iterator with
3315 pos->string_pos. For any string position other than
3316 zero, this will be done automagically when we resume
3317 iteration over the string and get_visually_first_element
3318 is called. But if string_pos is zero, and the string is
3319 to be reordered for display, we need to resync manually,
3320 since it could be that the iteration state recorded in
3321 pos ended at string_pos of 0 moving backwards in string. */
3322 if (CHARPOS (pos
->string_pos
) == 0)
3324 get_visually_first_element (it
);
3325 if (IT_STRING_CHARPOS (*it
) != 0)
3328 eassert (it
->bidi_it
.charpos
< it
->bidi_it
.string
.schars
);
3329 bidi_move_to_visually_next (&it
->bidi_it
);
3330 } while (it
->bidi_it
.charpos
!= 0);
3332 eassert (IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
3333 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
);
3337 if (CHARPOS (pos
->string_pos
) >= 0)
3339 /* Recorded position is not in an overlay string, but in another
3340 string. This can only be a string from a `display' property.
3341 IT should already be filled with that string. */
3342 it
->current
.string_pos
= pos
->string_pos
;
3343 eassert (STRINGP (it
->string
));
3345 bidi_init_it (IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
),
3346 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
3349 /* Restore position in display vector translations, control
3350 character translations or ellipses. */
3351 if (pos
->dpvec_index
>= 0)
3353 if (it
->dpvec
== NULL
)
3354 get_next_display_element (it
);
3355 eassert (it
->dpvec
&& it
->current
.dpvec_index
== 0);
3356 it
->current
.dpvec_index
= pos
->dpvec_index
;
3360 return !overlay_strings_with_newlines
;
3364 /* Initialize IT for stepping through current_buffer in window W
3365 starting at ROW->start. */
3368 init_to_row_start (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3370 init_from_display_pos (it
, w
, &row
->start
);
3371 it
->start
= row
->start
;
3372 it
->continuation_lines_width
= row
->continuation_lines_width
;
3377 /* Initialize IT for stepping through current_buffer in window W
3378 starting in the line following ROW, i.e. starting at ROW->end.
3379 Value is zero if there are overlay strings with newlines at ROW's
3383 init_to_row_end (struct it
*it
, struct window
*w
, struct glyph_row
*row
)
3387 if (init_from_display_pos (it
, w
, &row
->end
))
3389 if (row
->continued_p
)
3390 it
->continuation_lines_width
3391 = row
->continuation_lines_width
+ row
->pixel_width
;
3402 /***********************************************************************
3404 ***********************************************************************/
3406 /* Called when IT reaches IT->stop_charpos. Handle text property and
3407 overlay changes. Set IT->stop_charpos to the next position where
3411 handle_stop (struct it
*it
)
3413 enum prop_handled handled
;
3414 int handle_overlay_change_p
;
3418 it
->current
.dpvec_index
= -1;
3419 handle_overlay_change_p
= !it
->ignore_overlay_strings_at_pos_p
;
3420 it
->ignore_overlay_strings_at_pos_p
= 0;
3423 /* Use face of preceding text for ellipsis (if invisible) */
3424 if (it
->selective_display_ellipsis_p
)
3425 it
->saved_face_id
= it
->face_id
;
3427 /* Here's the description of the semantics of, and the logic behind,
3428 the various HANDLED_* statuses:
3430 HANDLED_NORMALLY means the handler did its job, and the loop
3431 should proceed to calling the next handler in order.
3433 HANDLED_RECOMPUTE_PROPS means the handler caused a significant
3434 change in the properties and overlays at current position, so the
3435 loop should be restarted, to re-invoke the handlers that were
3436 already called. This happens when fontification-functions were
3437 called by handle_fontified_prop, and actually fontified
3438 something. Another case where HANDLED_RECOMPUTE_PROPS is
3439 returned is when we discover overlay strings that need to be
3440 displayed right away. The loop below will continue for as long
3441 as the status is HANDLED_RECOMPUTE_PROPS.
3443 HANDLED_RETURN means return immediately to the caller, to
3444 continue iteration without calling any further handlers. This is
3445 used when we need to act on some property right away, for example
3446 when we need to display the ellipsis or a replacing display
3447 property, such as display string or image.
3449 HANDLED_OVERLAY_STRING_CONSUMED means an overlay string was just
3450 consumed, and the handler switched to the next overlay string.
3451 This signals the loop below to refrain from looking for more
3452 overlays before all the overlay strings of the current overlay
3455 Some of the handlers called by the loop push the iterator state
3456 onto the stack (see 'push_it'), and arrange for the iteration to
3457 continue with another object, such as an image, a display string,
3458 or an overlay string. In most such cases, it->stop_charpos is
3459 set to the first character of the string, so that when the
3460 iteration resumes, this function will immediately be called
3461 again, to examine the properties at the beginning of the string.
3463 When a display or overlay string is exhausted, the iterator state
3464 is popped (see 'pop_it'), and iteration continues with the
3465 previous object. Again, in many such cases this function is
3466 called again to find the next position where properties might
3471 handled
= HANDLED_NORMALLY
;
3473 /* Call text property handlers. */
3474 for (p
= it_props
; p
->handler
; ++p
)
3476 handled
= p
->handler (it
);
3478 if (handled
== HANDLED_RECOMPUTE_PROPS
)
3480 else if (handled
== HANDLED_RETURN
)
3482 /* We still want to show before and after strings from
3483 overlays even if the actual buffer text is replaced. */
3484 if (!handle_overlay_change_p
3486 /* Don't call get_overlay_strings_1 if we already
3487 have overlay strings loaded, because doing so
3488 will load them again and push the iterator state
3489 onto the stack one more time, which is not
3490 expected by the rest of the code that processes
3492 || (it
->current
.overlay_string_index
< 0
3493 ? !get_overlay_strings_1 (it
, 0, 0)
3497 setup_for_ellipsis (it
, 0);
3498 /* When handling a display spec, we might load an
3499 empty string. In that case, discard it here. We
3500 used to discard it in handle_single_display_spec,
3501 but that causes get_overlay_strings_1, above, to
3502 ignore overlay strings that we must check. */
3503 if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3507 else if (STRINGP (it
->string
) && !SCHARS (it
->string
))
3511 it
->ignore_overlay_strings_at_pos_p
= true;
3512 it
->string_from_display_prop_p
= 0;
3513 it
->from_disp_prop_p
= 0;
3514 handle_overlay_change_p
= 0;
3516 handled
= HANDLED_RECOMPUTE_PROPS
;
3519 else if (handled
== HANDLED_OVERLAY_STRING_CONSUMED
)
3520 handle_overlay_change_p
= 0;
3523 if (handled
!= HANDLED_RECOMPUTE_PROPS
)
3525 /* Don't check for overlay strings below when set to deliver
3526 characters from a display vector. */
3527 if (it
->method
== GET_FROM_DISPLAY_VECTOR
)
3528 handle_overlay_change_p
= 0;
3530 /* Handle overlay changes.
3531 This sets HANDLED to HANDLED_RECOMPUTE_PROPS
3532 if it finds overlays. */
3533 if (handle_overlay_change_p
)
3534 handled
= handle_overlay_change (it
);
3539 setup_for_ellipsis (it
, 0);
3543 while (handled
== HANDLED_RECOMPUTE_PROPS
);
3545 /* Determine where to stop next. */
3546 if (handled
== HANDLED_NORMALLY
)
3547 compute_stop_pos (it
);
3551 /* Compute IT->stop_charpos from text property and overlay change
3552 information for IT's current position. */
3555 compute_stop_pos (struct it
*it
)
3557 register INTERVAL iv
, next_iv
;
3558 Lisp_Object object
, limit
, position
;
3559 ptrdiff_t charpos
, bytepos
;
3561 if (STRINGP (it
->string
))
3563 /* Strings are usually short, so don't limit the search for
3565 it
->stop_charpos
= it
->end_charpos
;
3566 object
= it
->string
;
3568 charpos
= IT_STRING_CHARPOS (*it
);
3569 bytepos
= IT_STRING_BYTEPOS (*it
);
3575 /* If end_charpos is out of range for some reason, such as a
3576 misbehaving display function, rationalize it (Bug#5984). */
3577 if (it
->end_charpos
> ZV
)
3578 it
->end_charpos
= ZV
;
3579 it
->stop_charpos
= it
->end_charpos
;
3581 /* If next overlay change is in front of the current stop pos
3582 (which is IT->end_charpos), stop there. Note: value of
3583 next_overlay_change is point-max if no overlay change
3585 charpos
= IT_CHARPOS (*it
);
3586 bytepos
= IT_BYTEPOS (*it
);
3587 pos
= next_overlay_change (charpos
);
3588 if (pos
< it
->stop_charpos
)
3589 it
->stop_charpos
= pos
;
3591 /* Set up variables for computing the stop position from text
3592 property changes. */
3593 XSETBUFFER (object
, current_buffer
);
3594 limit
= make_number (IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
);
3597 /* Get the interval containing IT's position. Value is a null
3598 interval if there isn't such an interval. */
3599 position
= make_number (charpos
);
3600 iv
= validate_interval_range (object
, &position
, &position
, 0);
3603 Lisp_Object values_here
[LAST_PROP_IDX
];
3606 /* Get properties here. */
3607 for (p
= it_props
; p
->handler
; ++p
)
3608 values_here
[p
->idx
] = textget (iv
->plist
, *p
->name
);
3610 /* Look for an interval following iv that has different
3612 for (next_iv
= next_interval (iv
);
3615 || XFASTINT (limit
) > next_iv
->position
));
3616 next_iv
= next_interval (next_iv
))
3618 for (p
= it_props
; p
->handler
; ++p
)
3620 Lisp_Object new_value
;
3622 new_value
= textget (next_iv
->plist
, *p
->name
);
3623 if (!EQ (values_here
[p
->idx
], new_value
))
3633 if (INTEGERP (limit
)
3634 && next_iv
->position
>= XFASTINT (limit
))
3635 /* No text property change up to limit. */
3636 it
->stop_charpos
= min (XFASTINT (limit
), it
->stop_charpos
);
3638 /* Text properties change in next_iv. */
3639 it
->stop_charpos
= min (it
->stop_charpos
, next_iv
->position
);
3643 if (it
->cmp_it
.id
< 0)
3645 ptrdiff_t stoppos
= it
->end_charpos
;
3647 if (it
->bidi_p
&& it
->bidi_it
.scan_dir
< 0)
3649 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
,
3650 stoppos
, it
->string
);
3653 eassert (STRINGP (it
->string
)
3654 || (it
->stop_charpos
>= BEGV
3655 && it
->stop_charpos
>= IT_CHARPOS (*it
)));
3659 /* Return the position of the next overlay change after POS in
3660 current_buffer. Value is point-max if no overlay change
3661 follows. This is like `next-overlay-change' but doesn't use
3665 next_overlay_change (ptrdiff_t pos
)
3667 ptrdiff_t i
, noverlays
;
3669 Lisp_Object
*overlays
;
3672 /* Get all overlays at the given position. */
3673 GET_OVERLAYS_AT (pos
, overlays
, noverlays
, &endpos
, 1);
3675 /* If any of these overlays ends before endpos,
3676 use its ending point instead. */
3677 for (i
= 0; i
< noverlays
; ++i
)
3682 oend
= OVERLAY_END (overlays
[i
]);
3683 oendpos
= OVERLAY_POSITION (oend
);
3684 endpos
= min (endpos
, oendpos
);
3691 /* How many characters forward to search for a display property or
3692 display string. Searching too far forward makes the bidi display
3693 sluggish, especially in small windows. */
3694 #define MAX_DISP_SCAN 250
3696 /* Return the character position of a display string at or after
3697 position specified by POSITION. If no display string exists at or
3698 after POSITION, return ZV. A display string is either an overlay
3699 with `display' property whose value is a string, or a `display'
3700 text property whose value is a string. STRING is data about the
3701 string to iterate; if STRING->lstring is nil, we are iterating a
3702 buffer. FRAME_WINDOW_P is non-zero when we are displaying a window
3703 on a GUI frame. DISP_PROP is set to zero if we searched
3704 MAX_DISP_SCAN characters forward without finding any display
3705 strings, non-zero otherwise. It is set to 2 if the display string
3706 uses any kind of `(space ...)' spec that will produce a stretch of
3707 white space in the text area. */
3709 compute_display_string_pos (struct text_pos
*position
,
3710 struct bidi_string_data
*string
,
3712 int frame_window_p
, int *disp_prop
)
3714 /* OBJECT = nil means current buffer. */
3715 Lisp_Object object
, object1
;
3716 Lisp_Object pos
, spec
, limpos
;
3717 int string_p
= (string
&& (STRINGP (string
->lstring
) || string
->s
));
3718 ptrdiff_t eob
= string_p
? string
->schars
: ZV
;
3719 ptrdiff_t begb
= string_p
? 0 : BEGV
;
3720 ptrdiff_t bufpos
, charpos
= CHARPOS (*position
);
3722 (charpos
< eob
- MAX_DISP_SCAN
) ? charpos
+ MAX_DISP_SCAN
: eob
;
3723 struct text_pos tpos
;
3726 if (string
&& STRINGP (string
->lstring
))
3727 object1
= object
= string
->lstring
;
3728 else if (w
&& !string_p
)
3730 XSETWINDOW (object
, w
);
3734 object1
= object
= Qnil
;
3739 /* We don't support display properties whose values are strings
3740 that have display string properties. */
3741 || string
->from_disp_str
3742 /* C strings cannot have display properties. */
3743 || (string
->s
&& !STRINGP (object
)))
3749 /* If the character at CHARPOS is where the display string begins,
3751 pos
= make_number (charpos
);
3752 if (STRINGP (object
))
3753 bufpos
= string
->bufpos
;
3757 if (!NILP (spec
= Fget_char_property (pos
, Qdisplay
, object
))
3759 || !EQ (Fget_char_property (make_number (charpos
- 1), Qdisplay
,
3762 && (rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
, bufpos
,
3770 /* Look forward for the first character with a `display' property
3771 that will replace the underlying text when displayed. */
3772 limpos
= make_number (lim
);
3774 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object1
, limpos
);
3775 CHARPOS (tpos
) = XFASTINT (pos
);
3776 if (CHARPOS (tpos
) >= lim
)
3781 if (STRINGP (object
))
3782 BYTEPOS (tpos
) = string_char_to_byte (object
, CHARPOS (tpos
));
3784 BYTEPOS (tpos
) = CHAR_TO_BYTE (CHARPOS (tpos
));
3785 spec
= Fget_char_property (pos
, Qdisplay
, object
);
3786 if (!STRINGP (object
))
3787 bufpos
= CHARPOS (tpos
);
3788 } while (NILP (spec
)
3789 || !(rv
= handle_display_spec (NULL
, spec
, object
, Qnil
, &tpos
,
3790 bufpos
, frame_window_p
)));
3794 return CHARPOS (tpos
);
3797 /* Return the character position of the end of the display string that
3798 started at CHARPOS. If there's no display string at CHARPOS,
3799 return -1. A display string is either an overlay with `display'
3800 property whose value is a string or a `display' text property whose
3801 value is a string. */
3803 compute_display_string_end (ptrdiff_t charpos
, struct bidi_string_data
*string
)
3805 /* OBJECT = nil means current buffer. */
3806 Lisp_Object object
=
3807 (string
&& STRINGP (string
->lstring
)) ? string
->lstring
: Qnil
;
3808 Lisp_Object pos
= make_number (charpos
);
3810 (STRINGP (object
) || (string
&& string
->s
)) ? string
->schars
: ZV
;
3812 if (charpos
>= eob
|| (string
->s
&& !STRINGP (object
)))
3815 /* It could happen that the display property or overlay was removed
3816 since we found it in compute_display_string_pos above. One way
3817 this can happen is if JIT font-lock was called (through
3818 handle_fontified_prop), and jit-lock-functions remove text
3819 properties or overlays from the portion of buffer that includes
3820 CHARPOS. Muse mode is known to do that, for example. In this
3821 case, we return -1 to the caller, to signal that no display
3822 string is actually present at CHARPOS. See bidi_fetch_char for
3823 how this is handled.
3825 An alternative would be to never look for display properties past
3826 it->stop_charpos. But neither compute_display_string_pos nor
3827 bidi_fetch_char that calls it know or care where the next
3829 if (NILP (Fget_char_property (pos
, Qdisplay
, object
)))
3832 /* Look forward for the first character where the `display' property
3834 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, object
, Qnil
);
3836 return XFASTINT (pos
);
3841 /***********************************************************************
3843 ***********************************************************************/
3845 /* Handle changes in the `fontified' property of the current buffer by
3846 calling hook functions from Qfontification_functions to fontify
3849 static enum prop_handled
3850 handle_fontified_prop (struct it
*it
)
3852 Lisp_Object prop
, pos
;
3853 enum prop_handled handled
= HANDLED_NORMALLY
;
3855 if (!NILP (Vmemory_full
))
3858 /* Get the value of the `fontified' property at IT's current buffer
3859 position. (The `fontified' property doesn't have a special
3860 meaning in strings.) If the value is nil, call functions from
3861 Qfontification_functions. */
3862 if (!STRINGP (it
->string
)
3864 && !NILP (Vfontification_functions
)
3865 && !NILP (Vrun_hooks
)
3866 && (pos
= make_number (IT_CHARPOS (*it
)),
3867 prop
= Fget_char_property (pos
, Qfontified
, Qnil
),
3868 /* Ignore the special cased nil value always present at EOB since
3869 no amount of fontifying will be able to change it. */
3870 NILP (prop
) && IT_CHARPOS (*it
) < Z
))
3872 ptrdiff_t count
= SPECPDL_INDEX ();
3874 struct buffer
*obuf
= current_buffer
;
3875 ptrdiff_t begv
= BEGV
, zv
= ZV
;
3876 bool old_clip_changed
= current_buffer
->clip_changed
;
3878 val
= Vfontification_functions
;
3879 specbind (Qfontification_functions
, Qnil
);
3881 eassert (it
->end_charpos
== ZV
);
3883 if (!CONSP (val
) || EQ (XCAR (val
), Qlambda
))
3884 safe_call1 (val
, pos
);
3887 Lisp_Object fns
, fn
;
3888 struct gcpro gcpro1
, gcpro2
;
3893 for (; CONSP (val
); val
= XCDR (val
))
3899 /* A value of t indicates this hook has a local
3900 binding; it means to run the global binding too.
3901 In a global value, t should not occur. If it
3902 does, we must ignore it to avoid an endless
3904 for (fns
= Fdefault_value (Qfontification_functions
);
3910 safe_call1 (fn
, pos
);
3914 safe_call1 (fn
, pos
);
3920 unbind_to (count
, Qnil
);
3922 /* Fontification functions routinely call `save-restriction'.
3923 Normally, this tags clip_changed, which can confuse redisplay
3924 (see discussion in Bug#6671). Since we don't perform any
3925 special handling of fontification changes in the case where
3926 `save-restriction' isn't called, there's no point doing so in
3927 this case either. So, if the buffer's restrictions are
3928 actually left unchanged, reset clip_changed. */
3929 if (obuf
== current_buffer
)
3931 if (begv
== BEGV
&& zv
== ZV
)
3932 current_buffer
->clip_changed
= old_clip_changed
;
3934 /* There isn't much we can reasonably do to protect against
3935 misbehaving fontification, but here's a fig leaf. */
3936 else if (BUFFER_LIVE_P (obuf
))
3937 set_buffer_internal_1 (obuf
);
3939 /* The fontification code may have added/removed text.
3940 It could do even a lot worse, but let's at least protect against
3941 the most obvious case where only the text past `pos' gets changed',
3942 as is/was done in grep.el where some escapes sequences are turned
3943 into face properties (bug#7876). */
3944 it
->end_charpos
= ZV
;
3946 /* Return HANDLED_RECOMPUTE_PROPS only if function fontified
3947 something. This avoids an endless loop if they failed to
3948 fontify the text for which reason ever. */
3949 if (!NILP (Fget_char_property (pos
, Qfontified
, Qnil
)))
3950 handled
= HANDLED_RECOMPUTE_PROPS
;
3958 /***********************************************************************
3960 ***********************************************************************/
3962 /* Set up iterator IT from face properties at its current position.
3963 Called from handle_stop. */
3965 static enum prop_handled
3966 handle_face_prop (struct it
*it
)
3969 ptrdiff_t next_stop
;
3971 if (!STRINGP (it
->string
))
3974 = face_at_buffer_position (it
->w
,
3978 + TEXT_PROP_DISTANCE_LIMIT
),
3979 0, it
->base_face_id
);
3981 /* Is this a start of a run of characters with box face?
3982 Caveat: this can be called for a freshly initialized
3983 iterator; face_id is -1 in this case. We know that the new
3984 face will not change until limit, i.e. if the new face has a
3985 box, all characters up to limit will have one. But, as
3986 usual, we don't know whether limit is really the end. */
3987 if (new_face_id
!= it
->face_id
)
3989 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
3990 /* If it->face_id is -1, old_face below will be NULL, see
3991 the definition of FACE_FROM_ID. This will happen if this
3992 is the initial call that gets the face. */
3993 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
3995 /* If the value of face_id of the iterator is -1, we have to
3996 look in front of IT's position and see whether there is a
3997 face there that's different from new_face_id. */
3998 if (!old_face
&& IT_CHARPOS (*it
) > BEG
)
4000 int prev_face_id
= face_before_it_pos (it
);
4002 old_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
4005 /* If the new face has a box, but the old face does not,
4006 this is the start of a run of characters with box face,
4007 i.e. this character has a shadow on the left side. */
4008 it
->start_of_box_run_p
= (new_face
->box
!= FACE_NO_BOX
4009 && (old_face
== NULL
|| !old_face
->box
));
4010 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4018 Lisp_Object from_overlay
4019 = (it
->current
.overlay_string_index
>= 0
4020 ? it
->string_overlays
[it
->current
.overlay_string_index
4021 % OVERLAY_STRING_CHUNK_SIZE
]
4024 /* See if we got to this string directly or indirectly from
4025 an overlay property. That includes the before-string or
4026 after-string of an overlay, strings in display properties
4027 provided by an overlay, their text properties, etc.
4029 FROM_OVERLAY is the overlay that brought us here, or nil if none. */
4030 if (! NILP (from_overlay
))
4031 for (i
= it
->sp
- 1; i
>= 0; i
--)
4033 if (it
->stack
[i
].current
.overlay_string_index
>= 0)
4035 = it
->string_overlays
[it
->stack
[i
].current
.overlay_string_index
4036 % OVERLAY_STRING_CHUNK_SIZE
];
4037 else if (! NILP (it
->stack
[i
].from_overlay
))
4038 from_overlay
= it
->stack
[i
].from_overlay
;
4040 if (!NILP (from_overlay
))
4044 if (! NILP (from_overlay
))
4046 bufpos
= IT_CHARPOS (*it
);
4047 /* For a string from an overlay, the base face depends
4048 only on text properties and ignores overlays. */
4050 = face_for_overlay_string (it
->w
,
4054 + TEXT_PROP_DISTANCE_LIMIT
),
4062 /* For strings from a `display' property, use the face at
4063 IT's current buffer position as the base face to merge
4064 with, so that overlay strings appear in the same face as
4065 surrounding text, unless they specify their own faces.
4066 For strings from wrap-prefix and line-prefix properties,
4067 use the default face, possibly remapped via
4068 Vface_remapping_alist. */
4069 /* Note that the fact that we use the face at _buffer_
4070 position means that a 'display' property on an overlay
4071 string will not inherit the face of that overlay string,
4072 but will instead revert to the face of buffer text
4073 covered by the overlay. This is visible, e.g., when the
4074 overlay specifies a box face, but neither the buffer nor
4075 the display string do. This sounds like a design bug,
4076 but Emacs always did that since v21.1, so changing that
4077 might be a big deal. */
4078 base_face_id
= it
->string_from_prefix_prop_p
4079 ? (!NILP (Vface_remapping_alist
)
4080 ? lookup_basic_face (it
->f
, DEFAULT_FACE_ID
)
4082 : underlying_face_id (it
);
4085 new_face_id
= face_at_string_position (it
->w
,
4087 IT_STRING_CHARPOS (*it
),
4092 /* Is this a start of a run of characters with box? Caveat:
4093 this can be called for a freshly allocated iterator; face_id
4094 is -1 is this case. We know that the new face will not
4095 change until the next check pos, i.e. if the new face has a
4096 box, all characters up to that position will have a
4097 box. But, as usual, we don't know whether that position
4098 is really the end. */
4099 if (new_face_id
!= it
->face_id
)
4101 struct face
*new_face
= FACE_FROM_ID (it
->f
, new_face_id
);
4102 struct face
*old_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4104 /* If new face has a box but old face hasn't, this is the
4105 start of a run of characters with box, i.e. it has a
4106 shadow on the left side. */
4107 it
->start_of_box_run_p
4108 = new_face
->box
&& (old_face
== NULL
|| !old_face
->box
);
4109 it
->face_box_p
= new_face
->box
!= FACE_NO_BOX
;
4113 it
->face_id
= new_face_id
;
4114 return HANDLED_NORMALLY
;
4118 /* Return the ID of the face ``underlying'' IT's current position,
4119 which is in a string. If the iterator is associated with a
4120 buffer, return the face at IT's current buffer position.
4121 Otherwise, use the iterator's base_face_id. */
4124 underlying_face_id (struct it
*it
)
4126 int face_id
= it
->base_face_id
, i
;
4128 eassert (STRINGP (it
->string
));
4130 for (i
= it
->sp
- 1; i
>= 0; --i
)
4131 if (NILP (it
->stack
[i
].string
))
4132 face_id
= it
->stack
[i
].face_id
;
4138 /* Compute the face one character before or after the current position
4139 of IT, in the visual order. BEFORE_P non-zero means get the face
4140 in front (to the left in L2R paragraphs, to the right in R2L
4141 paragraphs) of IT's screen position. Value is the ID of the face. */
4144 face_before_or_after_it_pos (struct it
*it
, int before_p
)
4147 ptrdiff_t next_check_charpos
;
4149 void *it_copy_data
= NULL
;
4151 eassert (it
->s
== NULL
);
4153 if (STRINGP (it
->string
))
4155 ptrdiff_t bufpos
, charpos
;
4158 /* No face change past the end of the string (for the case
4159 we are padding with spaces). No face change before the
4161 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
)
4162 || (IT_STRING_CHARPOS (*it
) == 0 && before_p
))
4167 /* Set charpos to the position before or after IT's current
4168 position, in the logical order, which in the non-bidi
4169 case is the same as the visual order. */
4171 charpos
= IT_STRING_CHARPOS (*it
) - 1;
4172 else if (it
->what
== IT_COMPOSITION
)
4173 /* For composition, we must check the character after the
4175 charpos
= IT_STRING_CHARPOS (*it
) + it
->cmp_it
.nchars
;
4177 charpos
= IT_STRING_CHARPOS (*it
) + 1;
4183 /* With bidi iteration, the character before the current
4184 in the visual order cannot be found by simple
4185 iteration, because "reverse" reordering is not
4186 supported. Instead, we need to use the move_it_*
4187 family of functions. */
4188 /* Ignore face changes before the first visible
4189 character on this display line. */
4190 if (it
->current_x
<= it
->first_visible_x
)
4192 SAVE_IT (it_copy
, *it
, it_copy_data
);
4193 /* Implementation note: Since move_it_in_display_line
4194 works in the iterator geometry, and thinks the first
4195 character is always the leftmost, even in R2L lines,
4196 we don't need to distinguish between the R2L and L2R
4198 move_it_in_display_line (&it_copy
, SCHARS (it_copy
.string
),
4199 it_copy
.current_x
- 1, MOVE_TO_X
);
4200 charpos
= IT_STRING_CHARPOS (it_copy
);
4201 RESTORE_IT (it
, it
, it_copy_data
);
4205 /* Set charpos to the string position of the character
4206 that comes after IT's current position in the visual
4208 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4212 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4214 charpos
= it_copy
.bidi_it
.charpos
;
4217 eassert (0 <= charpos
&& charpos
<= SCHARS (it
->string
));
4219 if (it
->current
.overlay_string_index
>= 0)
4220 bufpos
= IT_CHARPOS (*it
);
4224 base_face_id
= underlying_face_id (it
);
4226 /* Get the face for ASCII, or unibyte. */
4227 face_id
= face_at_string_position (it
->w
,
4231 &next_check_charpos
,
4234 /* Correct the face for charsets different from ASCII. Do it
4235 for the multibyte case only. The face returned above is
4236 suitable for unibyte text if IT->string is unibyte. */
4237 if (STRING_MULTIBYTE (it
->string
))
4239 struct text_pos pos1
= string_pos (charpos
, it
->string
);
4240 const unsigned char *p
= SDATA (it
->string
) + BYTEPOS (pos1
);
4242 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4244 c
= string_char_and_length (p
, &len
);
4245 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, charpos
, it
->string
);
4250 struct text_pos pos
;
4252 if ((IT_CHARPOS (*it
) >= ZV
&& !before_p
)
4253 || (IT_CHARPOS (*it
) <= BEGV
&& before_p
))
4256 limit
= IT_CHARPOS (*it
) + TEXT_PROP_DISTANCE_LIMIT
;
4257 pos
= it
->current
.pos
;
4262 DEC_TEXT_POS (pos
, it
->multibyte_p
);
4265 if (it
->what
== IT_COMPOSITION
)
4267 /* For composition, we must check the position after
4269 pos
.charpos
+= it
->cmp_it
.nchars
;
4270 pos
.bytepos
+= it
->len
;
4273 INC_TEXT_POS (pos
, it
->multibyte_p
);
4280 /* With bidi iteration, the character before the current
4281 in the visual order cannot be found by simple
4282 iteration, because "reverse" reordering is not
4283 supported. Instead, we need to use the move_it_*
4284 family of functions. */
4285 /* Ignore face changes before the first visible
4286 character on this display line. */
4287 if (it
->current_x
<= it
->first_visible_x
)
4289 SAVE_IT (it_copy
, *it
, it_copy_data
);
4290 /* Implementation note: Since move_it_in_display_line
4291 works in the iterator geometry, and thinks the first
4292 character is always the leftmost, even in R2L lines,
4293 we don't need to distinguish between the R2L and L2R
4295 move_it_in_display_line (&it_copy
, ZV
,
4296 it_copy
.current_x
- 1, MOVE_TO_X
);
4297 pos
= it_copy
.current
.pos
;
4298 RESTORE_IT (it
, it
, it_copy_data
);
4302 /* Set charpos to the buffer position of the character
4303 that comes after IT's current position in the visual
4305 int n
= (it
->what
== IT_COMPOSITION
? it
->cmp_it
.nchars
: 1);
4309 bidi_move_to_visually_next (&it_copy
.bidi_it
);
4312 it_copy
.bidi_it
.charpos
, it_copy
.bidi_it
.bytepos
);
4315 eassert (BEGV
<= CHARPOS (pos
) && CHARPOS (pos
) <= ZV
);
4317 /* Determine face for CHARSET_ASCII, or unibyte. */
4318 face_id
= face_at_buffer_position (it
->w
,
4320 &next_check_charpos
,
4323 /* Correct the face for charsets different from ASCII. Do it
4324 for the multibyte case only. The face returned above is
4325 suitable for unibyte text if current_buffer is unibyte. */
4326 if (it
->multibyte_p
)
4328 int c
= FETCH_MULTIBYTE_CHAR (BYTEPOS (pos
));
4329 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
4330 face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, CHARPOS (pos
), Qnil
);
4339 /***********************************************************************
4341 ***********************************************************************/
4343 /* Set up iterator IT from invisible properties at its current
4344 position. Called from handle_stop. */
4346 static enum prop_handled
4347 handle_invisible_prop (struct it
*it
)
4349 enum prop_handled handled
= HANDLED_NORMALLY
;
4353 if (STRINGP (it
->string
))
4355 Lisp_Object end_charpos
, limit
, charpos
;
4357 /* Get the value of the invisible text property at the
4358 current position. Value will be nil if there is no such
4360 charpos
= make_number (IT_STRING_CHARPOS (*it
));
4361 prop
= Fget_text_property (charpos
, Qinvisible
, it
->string
);
4362 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4364 if (invis_p
&& IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
4366 /* Record whether we have to display an ellipsis for the
4368 int display_ellipsis_p
= (invis_p
== 2);
4369 ptrdiff_t len
, endpos
;
4371 handled
= HANDLED_RECOMPUTE_PROPS
;
4373 /* Get the position at which the next visible text can be
4374 found in IT->string, if any. */
4375 endpos
= len
= SCHARS (it
->string
);
4376 XSETINT (limit
, len
);
4379 end_charpos
= Fnext_single_property_change (charpos
, Qinvisible
,
4381 if (INTEGERP (end_charpos
))
4383 endpos
= XFASTINT (end_charpos
);
4384 prop
= Fget_text_property (end_charpos
, Qinvisible
, it
->string
);
4385 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4387 display_ellipsis_p
= true;
4390 while (invis_p
&& endpos
< len
);
4392 if (display_ellipsis_p
)
4393 it
->ellipsis_p
= true;
4397 /* Text at END_CHARPOS is visible. Move IT there. */
4398 struct text_pos old
;
4401 old
= it
->current
.string_pos
;
4402 oldpos
= CHARPOS (old
);
4405 if (it
->bidi_it
.first_elt
4406 && it
->bidi_it
.charpos
< SCHARS (it
->string
))
4407 bidi_paragraph_init (it
->paragraph_embedding
,
4409 /* Bidi-iterate out of the invisible text. */
4412 bidi_move_to_visually_next (&it
->bidi_it
);
4414 while (oldpos
<= it
->bidi_it
.charpos
4415 && it
->bidi_it
.charpos
< endpos
);
4417 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4418 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4419 if (IT_CHARPOS (*it
) >= endpos
)
4420 it
->prev_stop
= endpos
;
4424 IT_STRING_CHARPOS (*it
) = XFASTINT (end_charpos
);
4425 compute_string_pos (&it
->current
.string_pos
, old
, it
->string
);
4430 /* The rest of the string is invisible. If this is an
4431 overlay string, proceed with the next overlay string
4432 or whatever comes and return a character from there. */
4433 if (it
->current
.overlay_string_index
>= 0
4434 && !display_ellipsis_p
)
4436 next_overlay_string (it
);
4437 /* Don't check for overlay strings when we just
4438 finished processing them. */
4439 handled
= HANDLED_OVERLAY_STRING_CONSUMED
;
4443 IT_STRING_CHARPOS (*it
) = SCHARS (it
->string
);
4444 IT_STRING_BYTEPOS (*it
) = SBYTES (it
->string
);
4451 ptrdiff_t newpos
, next_stop
, start_charpos
, tem
;
4452 Lisp_Object pos
, overlay
;
4454 /* First of all, is there invisible text at this position? */
4455 tem
= start_charpos
= IT_CHARPOS (*it
);
4456 pos
= make_number (tem
);
4457 prop
= get_char_property_and_overlay (pos
, Qinvisible
, it
->window
,
4459 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4461 /* If we are on invisible text, skip over it. */
4462 if (invis_p
&& start_charpos
< it
->end_charpos
)
4464 /* Record whether we have to display an ellipsis for the
4466 int display_ellipsis_p
= invis_p
== 2;
4468 handled
= HANDLED_RECOMPUTE_PROPS
;
4470 /* Loop skipping over invisible text. The loop is left at
4471 ZV or with IT on the first char being visible again. */
4474 /* Try to skip some invisible text. Return value is the
4475 position reached which can be equal to where we start
4476 if there is nothing invisible there. This skips both
4477 over invisible text properties and overlays with
4478 invisible property. */
4479 newpos
= skip_invisible (tem
, &next_stop
, ZV
, it
->window
);
4481 /* If we skipped nothing at all we weren't at invisible
4482 text in the first place. If everything to the end of
4483 the buffer was skipped, end the loop. */
4484 if (newpos
== tem
|| newpos
>= ZV
)
4488 /* We skipped some characters but not necessarily
4489 all there are. Check if we ended up on visible
4490 text. Fget_char_property returns the property of
4491 the char before the given position, i.e. if we
4492 get invis_p = 0, this means that the char at
4493 newpos is visible. */
4494 pos
= make_number (newpos
);
4495 prop
= Fget_char_property (pos
, Qinvisible
, it
->window
);
4496 invis_p
= TEXT_PROP_MEANS_INVISIBLE (prop
);
4499 /* If we ended up on invisible text, proceed to
4500 skip starting with next_stop. */
4504 /* If there are adjacent invisible texts, don't lose the
4505 second one's ellipsis. */
4507 display_ellipsis_p
= true;
4511 /* The position newpos is now either ZV or on visible text. */
4514 ptrdiff_t bpos
= CHAR_TO_BYTE (newpos
);
4516 = bpos
== ZV_BYTE
|| FETCH_BYTE (bpos
) == '\n';
4518 = newpos
<= BEGV
|| FETCH_BYTE (bpos
- 1) == '\n';
4520 /* If the invisible text ends on a newline or on a
4521 character after a newline, we can avoid the costly,
4522 character by character, bidi iteration to NEWPOS, and
4523 instead simply reseat the iterator there. That's
4524 because all bidi reordering information is tossed at
4525 the newline. This is a big win for modes that hide
4526 complete lines, like Outline, Org, etc. */
4527 if (on_newline
|| after_newline
)
4529 struct text_pos tpos
;
4530 bidi_dir_t pdir
= it
->bidi_it
.paragraph_dir
;
4532 SET_TEXT_POS (tpos
, newpos
, bpos
);
4533 reseat_1 (it
, tpos
, 0);
4534 /* If we reseat on a newline/ZV, we need to prep the
4535 bidi iterator for advancing to the next character
4536 after the newline/EOB, keeping the current paragraph
4537 direction (so that PRODUCE_GLYPHS does TRT wrt
4538 prepending/appending glyphs to a glyph row). */
4541 it
->bidi_it
.first_elt
= 0;
4542 it
->bidi_it
.paragraph_dir
= pdir
;
4543 it
->bidi_it
.ch
= (bpos
== ZV_BYTE
) ? -1 : '\n';
4544 it
->bidi_it
.nchars
= 1;
4545 it
->bidi_it
.ch_len
= 1;
4548 else /* Must use the slow method. */
4550 /* With bidi iteration, the region of invisible text
4551 could start and/or end in the middle of a
4552 non-base embedding level. Therefore, we need to
4553 skip invisible text using the bidi iterator,
4554 starting at IT's current position, until we find
4555 ourselves outside of the invisible text.
4556 Skipping invisible text _after_ bidi iteration
4557 avoids affecting the visual order of the
4558 displayed text when invisible properties are
4559 added or removed. */
4560 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< ZV
)
4562 /* If we were `reseat'ed to a new paragraph,
4563 determine the paragraph base direction. We
4564 need to do it now because
4565 next_element_from_buffer may not have a
4566 chance to do it, if we are going to skip any
4567 text at the beginning, which resets the
4569 bidi_paragraph_init (it
->paragraph_embedding
,
4574 bidi_move_to_visually_next (&it
->bidi_it
);
4576 while (it
->stop_charpos
<= it
->bidi_it
.charpos
4577 && it
->bidi_it
.charpos
< newpos
);
4578 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
4579 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
4580 /* If we overstepped NEWPOS, record its position in
4581 the iterator, so that we skip invisible text if
4582 later the bidi iteration lands us in the
4583 invisible region again. */
4584 if (IT_CHARPOS (*it
) >= newpos
)
4585 it
->prev_stop
= newpos
;
4590 IT_CHARPOS (*it
) = newpos
;
4591 IT_BYTEPOS (*it
) = CHAR_TO_BYTE (newpos
);
4594 /* If there are before-strings at the start of invisible
4595 text, and the text is invisible because of a text
4596 property, arrange to show before-strings because 20.x did
4597 it that way. (If the text is invisible because of an
4598 overlay property instead of a text property, this is
4599 already handled in the overlay code.) */
4601 && get_overlay_strings (it
, it
->stop_charpos
))
4603 handled
= HANDLED_RECOMPUTE_PROPS
;
4606 it
->stack
[it
->sp
- 1].display_ellipsis_p
= display_ellipsis_p
;
4607 /* The call to get_overlay_strings above recomputes
4608 it->stop_charpos, but it only considers changes
4609 in properties and overlays beyond iterator's
4610 current position. This causes us to miss changes
4611 that happen exactly where the invisible property
4612 ended. So we play it safe here and force the
4613 iterator to check for potential stop positions
4614 immediately after the invisible text. Note that
4615 if get_overlay_strings returns non-zero, it
4616 normally also pushed the iterator stack, so we
4617 need to update the stop position in the slot
4618 below the current one. */
4619 it
->stack
[it
->sp
- 1].stop_charpos
4620 = CHARPOS (it
->stack
[it
->sp
- 1].current
.pos
);
4623 else if (display_ellipsis_p
)
4625 /* Make sure that the glyphs of the ellipsis will get
4626 correct `charpos' values. If we would not update
4627 it->position here, the glyphs would belong to the
4628 last visible character _before_ the invisible
4629 text, which confuses `set_cursor_from_row'.
4631 We use the last invisible position instead of the
4632 first because this way the cursor is always drawn on
4633 the first "." of the ellipsis, whenever PT is inside
4634 the invisible text. Otherwise the cursor would be
4635 placed _after_ the ellipsis when the point is after the
4636 first invisible character. */
4637 if (!STRINGP (it
->object
))
4639 it
->position
.charpos
= newpos
- 1;
4640 it
->position
.bytepos
= CHAR_TO_BYTE (it
->position
.charpos
);
4642 it
->ellipsis_p
= true;
4643 /* Let the ellipsis display before
4644 considering any properties of the following char.
4645 Fixes jasonr@gnu.org 01 Oct 07 bug. */
4646 handled
= HANDLED_RETURN
;
4655 /* Make iterator IT return `...' next.
4656 Replaces LEN characters from buffer. */
4659 setup_for_ellipsis (struct it
*it
, int len
)
4661 /* Use the display table definition for `...'. Invalid glyphs
4662 will be handled by the method returning elements from dpvec. */
4663 if (it
->dp
&& VECTORP (DISP_INVIS_VECTOR (it
->dp
)))
4665 struct Lisp_Vector
*v
= XVECTOR (DISP_INVIS_VECTOR (it
->dp
));
4666 it
->dpvec
= v
->contents
;
4667 it
->dpend
= v
->contents
+ v
->header
.size
;
4671 /* Default `...'. */
4672 it
->dpvec
= default_invis_vector
;
4673 it
->dpend
= default_invis_vector
+ 3;
4676 it
->dpvec_char_len
= len
;
4677 it
->current
.dpvec_index
= 0;
4678 it
->dpvec_face_id
= -1;
4680 /* Remember the current face id in case glyphs specify faces.
4681 IT's face is restored in set_iterator_to_next.
4682 saved_face_id was set to preceding char's face in handle_stop. */
4683 if (it
->saved_face_id
< 0 || it
->saved_face_id
!= it
->face_id
)
4684 it
->saved_face_id
= it
->face_id
= DEFAULT_FACE_ID
;
4686 it
->method
= GET_FROM_DISPLAY_VECTOR
;
4687 it
->ellipsis_p
= true;
4692 /***********************************************************************
4694 ***********************************************************************/
4696 /* Set up iterator IT from `display' property at its current position.
4697 Called from handle_stop.
4698 We return HANDLED_RETURN if some part of the display property
4699 overrides the display of the buffer text itself.
4700 Otherwise we return HANDLED_NORMALLY. */
4702 static enum prop_handled
4703 handle_display_prop (struct it
*it
)
4705 Lisp_Object propval
, object
, overlay
;
4706 struct text_pos
*position
;
4708 /* Nonzero if some property replaces the display of the text itself. */
4709 int display_replaced_p
= 0;
4711 if (STRINGP (it
->string
))
4713 object
= it
->string
;
4714 position
= &it
->current
.string_pos
;
4715 bufpos
= CHARPOS (it
->current
.pos
);
4719 XSETWINDOW (object
, it
->w
);
4720 position
= &it
->current
.pos
;
4721 bufpos
= CHARPOS (*position
);
4724 /* Reset those iterator values set from display property values. */
4725 it
->slice
.x
= it
->slice
.y
= it
->slice
.width
= it
->slice
.height
= Qnil
;
4726 it
->space_width
= Qnil
;
4727 it
->font_height
= Qnil
;
4730 /* We don't support recursive `display' properties, i.e. string
4731 values that have a string `display' property, that have a string
4732 `display' property etc. */
4733 if (!it
->string_from_display_prop_p
)
4734 it
->area
= TEXT_AREA
;
4736 propval
= get_char_property_and_overlay (make_number (position
->charpos
),
4737 Qdisplay
, object
, &overlay
);
4739 return HANDLED_NORMALLY
;
4740 /* Now OVERLAY is the overlay that gave us this property, or nil
4741 if it was a text property. */
4743 if (!STRINGP (it
->string
))
4744 object
= it
->w
->contents
;
4746 display_replaced_p
= handle_display_spec (it
, propval
, object
, overlay
,
4748 FRAME_WINDOW_P (it
->f
));
4750 return display_replaced_p
? HANDLED_RETURN
: HANDLED_NORMALLY
;
4753 /* Subroutine of handle_display_prop. Returns non-zero if the display
4754 specification in SPEC is a replacing specification, i.e. it would
4755 replace the text covered by `display' property with something else,
4756 such as an image or a display string. If SPEC includes any kind or
4757 `(space ...) specification, the value is 2; this is used by
4758 compute_display_string_pos, which see.
4760 See handle_single_display_spec for documentation of arguments.
4761 frame_window_p is non-zero if the window being redisplayed is on a
4762 GUI frame; this argument is used only if IT is NULL, see below.
4764 IT can be NULL, if this is called by the bidi reordering code
4765 through compute_display_string_pos, which see. In that case, this
4766 function only examines SPEC, but does not otherwise "handle" it, in
4767 the sense that it doesn't set up members of IT from the display
4770 handle_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4771 Lisp_Object overlay
, struct text_pos
*position
,
4772 ptrdiff_t bufpos
, int frame_window_p
)
4774 int replacing_p
= 0;
4778 /* Simple specifications. */
4779 && !EQ (XCAR (spec
), Qimage
)
4780 && !EQ (XCAR (spec
), Qspace
)
4781 && !EQ (XCAR (spec
), Qwhen
)
4782 && !EQ (XCAR (spec
), Qslice
)
4783 && !EQ (XCAR (spec
), Qspace_width
)
4784 && !EQ (XCAR (spec
), Qheight
)
4785 && !EQ (XCAR (spec
), Qraise
)
4786 /* Marginal area specifications. */
4787 && !(CONSP (XCAR (spec
)) && EQ (XCAR (XCAR (spec
)), Qmargin
))
4788 && !EQ (XCAR (spec
), Qleft_fringe
)
4789 && !EQ (XCAR (spec
), Qright_fringe
)
4790 && !NILP (XCAR (spec
)))
4792 for (; CONSP (spec
); spec
= XCDR (spec
))
4794 if ((rv
= handle_single_display_spec (it
, XCAR (spec
), object
,
4795 overlay
, position
, bufpos
,
4796 replacing_p
, frame_window_p
)))
4799 /* If some text in a string is replaced, `position' no
4800 longer points to the position of `object'. */
4801 if (!it
|| STRINGP (object
))
4806 else if (VECTORP (spec
))
4809 for (i
= 0; i
< ASIZE (spec
); ++i
)
4810 if ((rv
= handle_single_display_spec (it
, AREF (spec
, i
), object
,
4811 overlay
, position
, bufpos
,
4812 replacing_p
, frame_window_p
)))
4815 /* If some text in a string is replaced, `position' no
4816 longer points to the position of `object'. */
4817 if (!it
|| STRINGP (object
))
4823 if ((rv
= handle_single_display_spec (it
, spec
, object
, overlay
,
4824 position
, bufpos
, 0,
4832 /* Value is the position of the end of the `display' property starting
4833 at START_POS in OBJECT. */
4835 static struct text_pos
4836 display_prop_end (struct it
*it
, Lisp_Object object
, struct text_pos start_pos
)
4839 struct text_pos end_pos
;
4841 end
= Fnext_single_char_property_change (make_number (CHARPOS (start_pos
)),
4842 Qdisplay
, object
, Qnil
);
4843 CHARPOS (end_pos
) = XFASTINT (end
);
4844 if (STRINGP (object
))
4845 compute_string_pos (&end_pos
, start_pos
, it
->string
);
4847 BYTEPOS (end_pos
) = CHAR_TO_BYTE (XFASTINT (end
));
4853 /* Set up IT from a single `display' property specification SPEC. OBJECT
4854 is the object in which the `display' property was found. *POSITION
4855 is the position in OBJECT at which the `display' property was found.
4856 BUFPOS is the buffer position of OBJECT (different from POSITION if
4857 OBJECT is not a buffer). DISPLAY_REPLACED_P non-zero means that we
4858 previously saw a display specification which already replaced text
4859 display with something else, for example an image; we ignore such
4860 properties after the first one has been processed.
4862 OVERLAY is the overlay this `display' property came from,
4863 or nil if it was a text property.
4865 If SPEC is a `space' or `image' specification, and in some other
4866 cases too, set *POSITION to the position where the `display'
4869 If IT is NULL, only examine the property specification in SPEC, but
4870 don't set up IT. In that case, FRAME_WINDOW_P non-zero means SPEC
4871 is intended to be displayed in a window on a GUI frame.
4873 Value is non-zero if something was found which replaces the display
4874 of buffer or string text. */
4877 handle_single_display_spec (struct it
*it
, Lisp_Object spec
, Lisp_Object object
,
4878 Lisp_Object overlay
, struct text_pos
*position
,
4879 ptrdiff_t bufpos
, int display_replaced_p
,
4883 Lisp_Object location
, value
;
4884 struct text_pos start_pos
= *position
;
4887 /* If SPEC is a list of the form `(when FORM . VALUE)', evaluate FORM.
4888 If the result is non-nil, use VALUE instead of SPEC. */
4890 if (CONSP (spec
) && EQ (XCAR (spec
), Qwhen
))
4899 if (!NILP (form
) && !EQ (form
, Qt
))
4901 ptrdiff_t count
= SPECPDL_INDEX ();
4902 struct gcpro gcpro1
;
4904 /* Bind `object' to the object having the `display' property, a
4905 buffer or string. Bind `position' to the position in the
4906 object where the property was found, and `buffer-position'
4907 to the current position in the buffer. */
4910 XSETBUFFER (object
, current_buffer
);
4911 specbind (Qobject
, object
);
4912 specbind (Qposition
, make_number (CHARPOS (*position
)));
4913 specbind (Qbuffer_position
, make_number (bufpos
));
4915 form
= safe_eval (form
);
4917 unbind_to (count
, Qnil
);
4923 /* Handle `(height HEIGHT)' specifications. */
4925 && EQ (XCAR (spec
), Qheight
)
4926 && CONSP (XCDR (spec
)))
4930 if (!FRAME_WINDOW_P (it
->f
))
4933 it
->font_height
= XCAR (XCDR (spec
));
4934 if (!NILP (it
->font_height
))
4936 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
4937 int new_height
= -1;
4939 if (CONSP (it
->font_height
)
4940 && (EQ (XCAR (it
->font_height
), Qplus
)
4941 || EQ (XCAR (it
->font_height
), Qminus
))
4942 && CONSP (XCDR (it
->font_height
))
4943 && RANGED_INTEGERP (0, XCAR (XCDR (it
->font_height
)), INT_MAX
))
4945 /* `(+ N)' or `(- N)' where N is an integer. */
4946 int steps
= XINT (XCAR (XCDR (it
->font_height
)));
4947 if (EQ (XCAR (it
->font_height
), Qplus
))
4949 it
->face_id
= smaller_face (it
->f
, it
->face_id
, steps
);
4951 else if (FUNCTIONP (it
->font_height
))
4953 /* Call function with current height as argument.
4954 Value is the new height. */
4956 height
= safe_call1 (it
->font_height
,
4957 face
->lface
[LFACE_HEIGHT_INDEX
]);
4958 if (NUMBERP (height
))
4959 new_height
= XFLOATINT (height
);
4961 else if (NUMBERP (it
->font_height
))
4963 /* Value is a multiple of the canonical char height. */
4966 f
= FACE_FROM_ID (it
->f
,
4967 lookup_basic_face (it
->f
, DEFAULT_FACE_ID
));
4968 new_height
= (XFLOATINT (it
->font_height
)
4969 * XINT (f
->lface
[LFACE_HEIGHT_INDEX
]));
4973 /* Evaluate IT->font_height with `height' bound to the
4974 current specified height to get the new height. */
4975 ptrdiff_t count
= SPECPDL_INDEX ();
4977 specbind (Qheight
, face
->lface
[LFACE_HEIGHT_INDEX
]);
4978 value
= safe_eval (it
->font_height
);
4979 unbind_to (count
, Qnil
);
4981 if (NUMBERP (value
))
4982 new_height
= XFLOATINT (value
);
4986 it
->face_id
= face_with_height (it
->f
, it
->face_id
, new_height
);
4993 /* Handle `(space-width WIDTH)'. */
4995 && EQ (XCAR (spec
), Qspace_width
)
4996 && CONSP (XCDR (spec
)))
5000 if (!FRAME_WINDOW_P (it
->f
))
5003 value
= XCAR (XCDR (spec
));
5004 if (NUMBERP (value
) && XFLOATINT (value
) > 0)
5005 it
->space_width
= value
;
5011 /* Handle `(slice X Y WIDTH HEIGHT)'. */
5013 && EQ (XCAR (spec
), Qslice
))
5019 if (!FRAME_WINDOW_P (it
->f
))
5022 if (tem
= XCDR (spec
), CONSP (tem
))
5024 it
->slice
.x
= XCAR (tem
);
5025 if (tem
= XCDR (tem
), CONSP (tem
))
5027 it
->slice
.y
= XCAR (tem
);
5028 if (tem
= XCDR (tem
), CONSP (tem
))
5030 it
->slice
.width
= XCAR (tem
);
5031 if (tem
= XCDR (tem
), CONSP (tem
))
5032 it
->slice
.height
= XCAR (tem
);
5041 /* Handle `(raise FACTOR)'. */
5043 && EQ (XCAR (spec
), Qraise
)
5044 && CONSP (XCDR (spec
)))
5048 if (!FRAME_WINDOW_P (it
->f
))
5051 #ifdef HAVE_WINDOW_SYSTEM
5052 value
= XCAR (XCDR (spec
));
5053 if (NUMBERP (value
))
5055 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
5056 it
->voffset
= - (XFLOATINT (value
)
5057 * (FONT_HEIGHT (face
->font
)));
5059 #endif /* HAVE_WINDOW_SYSTEM */
5065 /* Don't handle the other kinds of display specifications
5066 inside a string that we got from a `display' property. */
5067 if (it
&& it
->string_from_display_prop_p
)
5070 /* Characters having this form of property are not displayed, so
5071 we have to find the end of the property. */
5074 start_pos
= *position
;
5075 *position
= display_prop_end (it
, object
, start_pos
);
5079 /* Stop the scan at that end position--we assume that all
5080 text properties change there. */
5082 it
->stop_charpos
= position
->charpos
;
5084 /* Handle `(left-fringe BITMAP [FACE])'
5085 and `(right-fringe BITMAP [FACE])'. */
5087 && (EQ (XCAR (spec
), Qleft_fringe
)
5088 || EQ (XCAR (spec
), Qright_fringe
))
5089 && CONSP (XCDR (spec
)))
5095 if (!FRAME_WINDOW_P (it
->f
))
5096 /* If we return here, POSITION has been advanced
5097 across the text with this property. */
5099 /* Synchronize the bidi iterator with POSITION. This is
5100 needed because we are not going to push the iterator
5101 on behalf of this display property, so there will be
5102 no pop_it call to do this synchronization for us. */
5105 it
->position
= *position
;
5106 iterate_out_of_display_property (it
);
5107 *position
= it
->position
;
5112 else if (!frame_window_p
)
5115 #ifdef HAVE_WINDOW_SYSTEM
5116 value
= XCAR (XCDR (spec
));
5117 if (!SYMBOLP (value
)
5118 || !(fringe_bitmap
= lookup_fringe_bitmap (value
)))
5119 /* If we return here, POSITION has been advanced
5120 across the text with this property. */
5122 if (it
&& it
->bidi_p
)
5124 it
->position
= *position
;
5125 iterate_out_of_display_property (it
);
5126 *position
= it
->position
;
5133 int face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
5135 if (CONSP (XCDR (XCDR (spec
))))
5137 Lisp_Object face_name
= XCAR (XCDR (XCDR (spec
)));
5138 int face_id2
= lookup_derived_face (it
->f
, face_name
,
5144 /* Save current settings of IT so that we can restore them
5145 when we are finished with the glyph property value. */
5146 push_it (it
, position
);
5148 it
->area
= TEXT_AREA
;
5149 it
->what
= IT_IMAGE
;
5150 it
->image_id
= -1; /* no image */
5151 it
->position
= start_pos
;
5152 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5153 it
->method
= GET_FROM_IMAGE
;
5154 it
->from_overlay
= Qnil
;
5155 it
->face_id
= face_id
;
5156 it
->from_disp_prop_p
= true;
5158 /* Say that we haven't consumed the characters with
5159 `display' property yet. The call to pop_it in
5160 set_iterator_to_next will clean this up. */
5161 *position
= start_pos
;
5163 if (EQ (XCAR (spec
), Qleft_fringe
))
5165 it
->left_user_fringe_bitmap
= fringe_bitmap
;
5166 it
->left_user_fringe_face_id
= face_id
;
5170 it
->right_user_fringe_bitmap
= fringe_bitmap
;
5171 it
->right_user_fringe_face_id
= face_id
;
5174 #endif /* HAVE_WINDOW_SYSTEM */
5178 /* Prepare to handle `((margin left-margin) ...)',
5179 `((margin right-margin) ...)' and `((margin nil) ...)'
5180 prefixes for display specifications. */
5181 location
= Qunbound
;
5182 if (CONSP (spec
) && CONSP (XCAR (spec
)))
5186 value
= XCDR (spec
);
5188 value
= XCAR (value
);
5191 if (EQ (XCAR (tem
), Qmargin
)
5192 && (tem
= XCDR (tem
),
5193 tem
= CONSP (tem
) ? XCAR (tem
) : Qnil
,
5195 || EQ (tem
, Qleft_margin
)
5196 || EQ (tem
, Qright_margin
))))
5200 if (EQ (location
, Qunbound
))
5206 /* After this point, VALUE is the property after any
5207 margin prefix has been stripped. It must be a string,
5208 an image specification, or `(space ...)'.
5210 LOCATION specifies where to display: `left-margin',
5211 `right-margin' or nil. */
5213 valid_p
= (STRINGP (value
)
5214 #ifdef HAVE_WINDOW_SYSTEM
5215 || ((it
? FRAME_WINDOW_P (it
->f
) : frame_window_p
)
5216 && valid_image_p (value
))
5217 #endif /* not HAVE_WINDOW_SYSTEM */
5218 || (CONSP (value
) && EQ (XCAR (value
), Qspace
)));
5220 if (valid_p
&& !display_replaced_p
)
5226 /* Callers need to know whether the display spec is any kind
5227 of `(space ...)' spec that is about to affect text-area
5229 if (CONSP (value
) && EQ (XCAR (value
), Qspace
) && NILP (location
))
5234 /* Save current settings of IT so that we can restore them
5235 when we are finished with the glyph property value. */
5236 push_it (it
, position
);
5237 it
->from_overlay
= overlay
;
5238 it
->from_disp_prop_p
= true;
5240 if (NILP (location
))
5241 it
->area
= TEXT_AREA
;
5242 else if (EQ (location
, Qleft_margin
))
5243 it
->area
= LEFT_MARGIN_AREA
;
5245 it
->area
= RIGHT_MARGIN_AREA
;
5247 if (STRINGP (value
))
5250 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5251 it
->current
.overlay_string_index
= -1;
5252 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5253 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
5254 it
->method
= GET_FROM_STRING
;
5255 it
->stop_charpos
= 0;
5257 it
->base_level_stop
= 0;
5258 it
->string_from_display_prop_p
= true;
5259 /* Say that we haven't consumed the characters with
5260 `display' property yet. The call to pop_it in
5261 set_iterator_to_next will clean this up. */
5262 if (BUFFERP (object
))
5263 *position
= start_pos
;
5265 /* Force paragraph direction to be that of the parent
5266 object. If the parent object's paragraph direction is
5267 not yet determined, default to L2R. */
5268 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5269 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5271 it
->paragraph_embedding
= L2R
;
5273 /* Set up the bidi iterator for this display string. */
5276 it
->bidi_it
.string
.lstring
= it
->string
;
5277 it
->bidi_it
.string
.s
= NULL
;
5278 it
->bidi_it
.string
.schars
= it
->end_charpos
;
5279 it
->bidi_it
.string
.bufpos
= bufpos
;
5280 it
->bidi_it
.string
.from_disp_str
= 1;
5281 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5282 it
->bidi_it
.w
= it
->w
;
5283 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5286 else if (CONSP (value
) && EQ (XCAR (value
), Qspace
))
5288 it
->method
= GET_FROM_STRETCH
;
5290 *position
= it
->position
= start_pos
;
5291 retval
= 1 + (it
->area
== TEXT_AREA
);
5293 #ifdef HAVE_WINDOW_SYSTEM
5296 it
->what
= IT_IMAGE
;
5297 it
->image_id
= lookup_image (it
->f
, value
);
5298 it
->position
= start_pos
;
5299 it
->object
= NILP (object
) ? it
->w
->contents
: object
;
5300 it
->method
= GET_FROM_IMAGE
;
5302 /* Say that we haven't consumed the characters with
5303 `display' property yet. The call to pop_it in
5304 set_iterator_to_next will clean this up. */
5305 *position
= start_pos
;
5307 #endif /* HAVE_WINDOW_SYSTEM */
5312 /* Invalid property or property not supported. Restore
5313 POSITION to what it was before. */
5314 *position
= start_pos
;
5318 /* Check if PROP is a display property value whose text should be
5319 treated as intangible. OVERLAY is the overlay from which PROP
5320 came, or nil if it came from a text property. CHARPOS and BYTEPOS
5321 specify the buffer position covered by PROP. */
5324 display_prop_intangible_p (Lisp_Object prop
, Lisp_Object overlay
,
5325 ptrdiff_t charpos
, ptrdiff_t bytepos
)
5327 int frame_window_p
= FRAME_WINDOW_P (XFRAME (selected_frame
));
5328 struct text_pos position
;
5330 SET_TEXT_POS (position
, charpos
, bytepos
);
5331 return handle_display_spec (NULL
, prop
, Qnil
, overlay
,
5332 &position
, charpos
, frame_window_p
);
5336 /* Return 1 if PROP is a display sub-property value containing STRING.
5338 Implementation note: this and the following function are really
5339 special cases of handle_display_spec and
5340 handle_single_display_spec, and should ideally use the same code.
5341 Until they do, these two pairs must be consistent and must be
5342 modified in sync. */
5345 single_display_spec_string_p (Lisp_Object prop
, Lisp_Object string
)
5347 if (EQ (string
, prop
))
5350 /* Skip over `when FORM'. */
5351 if (CONSP (prop
) && EQ (XCAR (prop
), Qwhen
))
5356 /* Actually, the condition following `when' should be eval'ed,
5357 like handle_single_display_spec does, and we should return
5358 zero if it evaluates to nil. However, this function is
5359 called only when the buffer was already displayed and some
5360 glyph in the glyph matrix was found to come from a display
5361 string. Therefore, the condition was already evaluated, and
5362 the result was non-nil, otherwise the display string wouldn't
5363 have been displayed and we would have never been called for
5364 this property. Thus, we can skip the evaluation and assume
5365 its result is non-nil. */
5370 /* Skip over `margin LOCATION'. */
5371 if (EQ (XCAR (prop
), Qmargin
))
5382 return EQ (prop
, string
) || (CONSP (prop
) && EQ (XCAR (prop
), string
));
5386 /* Return 1 if STRING appears in the `display' property PROP. */
5389 display_prop_string_p (Lisp_Object prop
, Lisp_Object string
)
5392 && !EQ (XCAR (prop
), Qwhen
)
5393 && !(CONSP (XCAR (prop
)) && EQ (Qmargin
, XCAR (XCAR (prop
)))))
5395 /* A list of sub-properties. */
5396 while (CONSP (prop
))
5398 if (single_display_spec_string_p (XCAR (prop
), string
))
5403 else if (VECTORP (prop
))
5405 /* A vector of sub-properties. */
5407 for (i
= 0; i
< ASIZE (prop
); ++i
)
5408 if (single_display_spec_string_p (AREF (prop
, i
), string
))
5412 return single_display_spec_string_p (prop
, string
);
5417 /* Look for STRING in overlays and text properties in the current
5418 buffer, between character positions FROM and TO (excluding TO).
5419 BACK_P non-zero means look back (in this case, TO is supposed to be
5421 Value is the first character position where STRING was found, or
5422 zero if it wasn't found before hitting TO.
5424 This function may only use code that doesn't eval because it is
5425 called asynchronously from note_mouse_highlight. */
5428 string_buffer_position_lim (Lisp_Object string
,
5429 ptrdiff_t from
, ptrdiff_t to
, int back_p
)
5431 Lisp_Object limit
, prop
, pos
;
5434 pos
= make_number (max (from
, BEGV
));
5436 if (!back_p
) /* looking forward */
5438 limit
= make_number (min (to
, ZV
));
5439 while (!found
&& !EQ (pos
, limit
))
5441 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5442 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5445 pos
= Fnext_single_char_property_change (pos
, Qdisplay
, Qnil
,
5449 else /* looking back */
5451 limit
= make_number (max (to
, BEGV
));
5452 while (!found
&& !EQ (pos
, limit
))
5454 prop
= Fget_char_property (pos
, Qdisplay
, Qnil
);
5455 if (!NILP (prop
) && display_prop_string_p (prop
, string
))
5458 pos
= Fprevious_single_char_property_change (pos
, Qdisplay
, Qnil
,
5463 return found
? XINT (pos
) : 0;
5466 /* Determine which buffer position in current buffer STRING comes from.
5467 AROUND_CHARPOS is an approximate position where it could come from.
5468 Value is the buffer position or 0 if it couldn't be determined.
5470 This function is necessary because we don't record buffer positions
5471 in glyphs generated from strings (to keep struct glyph small).
5472 This function may only use code that doesn't eval because it is
5473 called asynchronously from note_mouse_highlight. */
5476 string_buffer_position (Lisp_Object string
, ptrdiff_t around_charpos
)
5478 const int MAX_DISTANCE
= 1000;
5479 ptrdiff_t found
= string_buffer_position_lim (string
, around_charpos
,
5480 around_charpos
+ MAX_DISTANCE
,
5484 found
= string_buffer_position_lim (string
, around_charpos
,
5485 around_charpos
- MAX_DISTANCE
, 1);
5491 /***********************************************************************
5492 `composition' property
5493 ***********************************************************************/
5495 /* Set up iterator IT from `composition' property at its current
5496 position. Called from handle_stop. */
5498 static enum prop_handled
5499 handle_composition_prop (struct it
*it
)
5501 Lisp_Object prop
, string
;
5502 ptrdiff_t pos
, pos_byte
, start
, end
;
5504 if (STRINGP (it
->string
))
5508 pos
= IT_STRING_CHARPOS (*it
);
5509 pos_byte
= IT_STRING_BYTEPOS (*it
);
5510 string
= it
->string
;
5511 s
= SDATA (string
) + pos_byte
;
5512 it
->c
= STRING_CHAR (s
);
5516 pos
= IT_CHARPOS (*it
);
5517 pos_byte
= IT_BYTEPOS (*it
);
5519 it
->c
= FETCH_CHAR (pos_byte
);
5522 /* If there's a valid composition and point is not inside of the
5523 composition (in the case that the composition is from the current
5524 buffer), draw a glyph composed from the composition components. */
5525 if (find_composition (pos
, -1, &start
, &end
, &prop
, string
)
5526 && composition_valid_p (start
, end
, prop
)
5527 && (STRINGP (it
->string
) || (PT
<= start
|| PT
>= end
)))
5530 /* As we can't handle this situation (perhaps font-lock added
5531 a new composition), we just return here hoping that next
5532 redisplay will detect this composition much earlier. */
5533 return HANDLED_NORMALLY
;
5536 if (STRINGP (it
->string
))
5537 pos_byte
= string_char_to_byte (it
->string
, start
);
5539 pos_byte
= CHAR_TO_BYTE (start
);
5541 it
->cmp_it
.id
= get_composition_id (start
, pos_byte
, end
- start
,
5544 if (it
->cmp_it
.id
>= 0)
5547 it
->cmp_it
.nchars
= COMPOSITION_LENGTH (prop
);
5548 it
->cmp_it
.nglyphs
= -1;
5552 return HANDLED_NORMALLY
;
5557 /***********************************************************************
5559 ***********************************************************************/
5561 /* The following structure is used to record overlay strings for
5562 later sorting in load_overlay_strings. */
5564 struct overlay_entry
5566 Lisp_Object overlay
;
5573 /* Set up iterator IT from overlay strings at its current position.
5574 Called from handle_stop. */
5576 static enum prop_handled
5577 handle_overlay_change (struct it
*it
)
5579 if (!STRINGP (it
->string
) && get_overlay_strings (it
, 0))
5580 return HANDLED_RECOMPUTE_PROPS
;
5582 return HANDLED_NORMALLY
;
5586 /* Set up the next overlay string for delivery by IT, if there is an
5587 overlay string to deliver. Called by set_iterator_to_next when the
5588 end of the current overlay string is reached. If there are more
5589 overlay strings to display, IT->string and
5590 IT->current.overlay_string_index are set appropriately here.
5591 Otherwise IT->string is set to nil. */
5594 next_overlay_string (struct it
*it
)
5596 ++it
->current
.overlay_string_index
;
5597 if (it
->current
.overlay_string_index
== it
->n_overlay_strings
)
5599 /* No more overlay strings. Restore IT's settings to what
5600 they were before overlay strings were processed, and
5601 continue to deliver from current_buffer. */
5603 it
->ellipsis_p
= (it
->stack
[it
->sp
- 1].display_ellipsis_p
!= 0);
5606 || (NILP (it
->string
)
5607 && it
->method
== GET_FROM_BUFFER
5608 && it
->stop_charpos
>= BEGV
5609 && it
->stop_charpos
<= it
->end_charpos
));
5610 it
->current
.overlay_string_index
= -1;
5611 it
->n_overlay_strings
= 0;
5612 it
->overlay_strings_charpos
= -1;
5613 /* If there's an empty display string on the stack, pop the
5614 stack, to resync the bidi iterator with IT's position. Such
5615 empty strings are pushed onto the stack in
5616 get_overlay_strings_1. */
5617 if (it
->sp
> 0 && STRINGP (it
->string
) && !SCHARS (it
->string
))
5620 /* If we're at the end of the buffer, record that we have
5621 processed the overlay strings there already, so that
5622 next_element_from_buffer doesn't try it again. */
5623 if (NILP (it
->string
) && IT_CHARPOS (*it
) >= it
->end_charpos
)
5624 it
->overlay_strings_at_end_processed_p
= true;
5628 /* There are more overlay strings to process. If
5629 IT->current.overlay_string_index has advanced to a position
5630 where we must load IT->overlay_strings with more strings, do
5631 it. We must load at the IT->overlay_strings_charpos where
5632 IT->n_overlay_strings was originally computed; when invisible
5633 text is present, this might not be IT_CHARPOS (Bug#7016). */
5634 int i
= it
->current
.overlay_string_index
% OVERLAY_STRING_CHUNK_SIZE
;
5636 if (it
->current
.overlay_string_index
&& i
== 0)
5637 load_overlay_strings (it
, it
->overlay_strings_charpos
);
5639 /* Initialize IT to deliver display elements from the overlay
5641 it
->string
= it
->overlay_strings
[i
];
5642 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5643 SET_TEXT_POS (it
->current
.string_pos
, 0, 0);
5644 it
->method
= GET_FROM_STRING
;
5645 it
->stop_charpos
= 0;
5646 it
->end_charpos
= SCHARS (it
->string
);
5647 if (it
->cmp_it
.stop_pos
>= 0)
5648 it
->cmp_it
.stop_pos
= 0;
5650 it
->base_level_stop
= 0;
5652 /* Set up the bidi iterator for this overlay string. */
5655 it
->bidi_it
.string
.lstring
= it
->string
;
5656 it
->bidi_it
.string
.s
= NULL
;
5657 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5658 it
->bidi_it
.string
.bufpos
= it
->overlay_strings_charpos
;
5659 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5660 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5661 it
->bidi_it
.w
= it
->w
;
5662 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5670 /* Compare two overlay_entry structures E1 and E2. Used as a
5671 comparison function for qsort in load_overlay_strings. Overlay
5672 strings for the same position are sorted so that
5674 1. All after-strings come in front of before-strings, except
5675 when they come from the same overlay.
5677 2. Within after-strings, strings are sorted so that overlay strings
5678 from overlays with higher priorities come first.
5680 2. Within before-strings, strings are sorted so that overlay
5681 strings from overlays with higher priorities come last.
5683 Value is analogous to strcmp. */
5687 compare_overlay_entries (const void *e1
, const void *e2
)
5689 struct overlay_entry
const *entry1
= e1
;
5690 struct overlay_entry
const *entry2
= e2
;
5693 if (entry1
->after_string_p
!= entry2
->after_string_p
)
5695 /* Let after-strings appear in front of before-strings if
5696 they come from different overlays. */
5697 if (EQ (entry1
->overlay
, entry2
->overlay
))
5698 result
= entry1
->after_string_p
? 1 : -1;
5700 result
= entry1
->after_string_p
? -1 : 1;
5702 else if (entry1
->priority
!= entry2
->priority
)
5704 if (entry1
->after_string_p
)
5705 /* After-strings sorted in order of decreasing priority. */
5706 result
= entry2
->priority
< entry1
->priority
? -1 : 1;
5708 /* Before-strings sorted in order of increasing priority. */
5709 result
= entry1
->priority
< entry2
->priority
? -1 : 1;
5718 /* Load the vector IT->overlay_strings with overlay strings from IT's
5719 current buffer position, or from CHARPOS if that is > 0. Set
5720 IT->n_overlays to the total number of overlay strings found.
5722 Overlay strings are processed OVERLAY_STRING_CHUNK_SIZE strings at
5723 a time. On entry into load_overlay_strings,
5724 IT->current.overlay_string_index gives the number of overlay
5725 strings that have already been loaded by previous calls to this
5728 IT->add_overlay_start contains an additional overlay start
5729 position to consider for taking overlay strings from, if non-zero.
5730 This position comes into play when the overlay has an `invisible'
5731 property, and both before and after-strings. When we've skipped to
5732 the end of the overlay, because of its `invisible' property, we
5733 nevertheless want its before-string to appear.
5734 IT->add_overlay_start will contain the overlay start position
5737 Overlay strings are sorted so that after-string strings come in
5738 front of before-string strings. Within before and after-strings,
5739 strings are sorted by overlay priority. See also function
5740 compare_overlay_entries. */
5743 load_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5745 Lisp_Object overlay
, window
, str
, invisible
;
5746 struct Lisp_Overlay
*ov
;
5747 ptrdiff_t start
, end
;
5748 ptrdiff_t n
= 0, i
, j
;
5750 struct overlay_entry entriesbuf
[20];
5751 ptrdiff_t size
= ARRAYELTS (entriesbuf
);
5752 struct overlay_entry
*entries
= entriesbuf
;
5756 charpos
= IT_CHARPOS (*it
);
5758 /* Append the overlay string STRING of overlay OVERLAY to vector
5759 `entries' which has size `size' and currently contains `n'
5760 elements. AFTER_P non-zero means STRING is an after-string of
5762 #define RECORD_OVERLAY_STRING(OVERLAY, STRING, AFTER_P) \
5765 Lisp_Object priority; \
5769 struct overlay_entry *old = entries; \
5770 SAFE_NALLOCA (entries, 2, size); \
5771 memcpy (entries, old, size * sizeof *entries); \
5775 entries[n].string = (STRING); \
5776 entries[n].overlay = (OVERLAY); \
5777 priority = Foverlay_get ((OVERLAY), Qpriority); \
5778 entries[n].priority = INTEGERP (priority) ? XINT (priority) : 0; \
5779 entries[n].after_string_p = (AFTER_P); \
5784 /* Process overlay before the overlay center. */
5785 for (ov
= current_buffer
->overlays_before
; ov
; ov
= ov
->next
)
5787 XSETMISC (overlay
, ov
);
5788 eassert (OVERLAYP (overlay
));
5789 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5790 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5795 /* Skip this overlay if it doesn't start or end at IT's current
5797 if (end
!= charpos
&& start
!= charpos
)
5800 /* Skip this overlay if it doesn't apply to IT->w. */
5801 window
= Foverlay_get (overlay
, Qwindow
);
5802 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5805 /* If the text ``under'' the overlay is invisible, both before-
5806 and after-strings from this overlay are visible; start and
5807 end position are indistinguishable. */
5808 invisible
= Foverlay_get (overlay
, Qinvisible
);
5809 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5811 /* If overlay has a non-empty before-string, record it. */
5812 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5813 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5815 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5817 /* If overlay has a non-empty after-string, record it. */
5818 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5819 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5821 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5824 /* Process overlays after the overlay center. */
5825 for (ov
= current_buffer
->overlays_after
; ov
; ov
= ov
->next
)
5827 XSETMISC (overlay
, ov
);
5828 eassert (OVERLAYP (overlay
));
5829 start
= OVERLAY_POSITION (OVERLAY_START (overlay
));
5830 end
= OVERLAY_POSITION (OVERLAY_END (overlay
));
5832 if (start
> charpos
)
5835 /* Skip this overlay if it doesn't start or end at IT's current
5837 if (end
!= charpos
&& start
!= charpos
)
5840 /* Skip this overlay if it doesn't apply to IT->w. */
5841 window
= Foverlay_get (overlay
, Qwindow
);
5842 if (WINDOWP (window
) && XWINDOW (window
) != it
->w
)
5845 /* If the text ``under'' the overlay is invisible, it has a zero
5846 dimension, and both before- and after-strings apply. */
5847 invisible
= Foverlay_get (overlay
, Qinvisible
);
5848 invis_p
= TEXT_PROP_MEANS_INVISIBLE (invisible
);
5850 /* If overlay has a non-empty before-string, record it. */
5851 if ((start
== charpos
|| (end
== charpos
&& invis_p
))
5852 && (str
= Foverlay_get (overlay
, Qbefore_string
), STRINGP (str
))
5854 RECORD_OVERLAY_STRING (overlay
, str
, 0);
5856 /* If overlay has a non-empty after-string, record it. */
5857 if ((end
== charpos
|| (start
== charpos
&& invis_p
))
5858 && (str
= Foverlay_get (overlay
, Qafter_string
), STRINGP (str
))
5860 RECORD_OVERLAY_STRING (overlay
, str
, 1);
5863 #undef RECORD_OVERLAY_STRING
5867 qsort (entries
, n
, sizeof *entries
, compare_overlay_entries
);
5869 /* Record number of overlay strings, and where we computed it. */
5870 it
->n_overlay_strings
= n
;
5871 it
->overlay_strings_charpos
= charpos
;
5873 /* IT->current.overlay_string_index is the number of overlay strings
5874 that have already been consumed by IT. Copy some of the
5875 remaining overlay strings to IT->overlay_strings. */
5877 j
= it
->current
.overlay_string_index
;
5878 while (i
< OVERLAY_STRING_CHUNK_SIZE
&& j
< n
)
5880 it
->overlay_strings
[i
] = entries
[j
].string
;
5881 it
->string_overlays
[i
++] = entries
[j
++].overlay
;
5889 /* Get the first chunk of overlay strings at IT's current buffer
5890 position, or at CHARPOS if that is > 0. Value is non-zero if at
5891 least one overlay string was found. */
5894 get_overlay_strings_1 (struct it
*it
, ptrdiff_t charpos
, int compute_stop_p
)
5896 /* Get the first OVERLAY_STRING_CHUNK_SIZE overlay strings to
5897 process. This fills IT->overlay_strings with strings, and sets
5898 IT->n_overlay_strings to the total number of strings to process.
5899 IT->pos.overlay_string_index has to be set temporarily to zero
5900 because load_overlay_strings needs this; it must be set to -1
5901 when no overlay strings are found because a zero value would
5902 indicate a position in the first overlay string. */
5903 it
->current
.overlay_string_index
= 0;
5904 load_overlay_strings (it
, charpos
);
5906 /* If we found overlay strings, set up IT to deliver display
5907 elements from the first one. Otherwise set up IT to deliver
5908 from current_buffer. */
5909 if (it
->n_overlay_strings
)
5911 /* Make sure we know settings in current_buffer, so that we can
5912 restore meaningful values when we're done with the overlay
5915 compute_stop_pos (it
);
5916 eassert (it
->face_id
>= 0);
5918 /* Save IT's settings. They are restored after all overlay
5919 strings have been processed. */
5920 eassert (!compute_stop_p
|| it
->sp
== 0);
5922 /* When called from handle_stop, there might be an empty display
5923 string loaded. In that case, don't bother saving it. But
5924 don't use this optimization with the bidi iterator, since we
5925 need the corresponding pop_it call to resync the bidi
5926 iterator's position with IT's position, after we are done
5927 with the overlay strings. (The corresponding call to pop_it
5928 in case of an empty display string is in
5929 next_overlay_string.) */
5931 && STRINGP (it
->string
) && !SCHARS (it
->string
)))
5934 /* Set up IT to deliver display elements from the first overlay
5936 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
5937 it
->string
= it
->overlay_strings
[0];
5938 it
->from_overlay
= Qnil
;
5939 it
->stop_charpos
= 0;
5940 eassert (STRINGP (it
->string
));
5941 it
->end_charpos
= SCHARS (it
->string
);
5943 it
->base_level_stop
= 0;
5944 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
5945 it
->method
= GET_FROM_STRING
;
5946 it
->from_disp_prop_p
= 0;
5948 /* Force paragraph direction to be that of the parent
5950 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
5951 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
5953 it
->paragraph_embedding
= L2R
;
5955 /* Set up the bidi iterator for this overlay string. */
5958 ptrdiff_t pos
= (charpos
> 0 ? charpos
: IT_CHARPOS (*it
));
5960 it
->bidi_it
.string
.lstring
= it
->string
;
5961 it
->bidi_it
.string
.s
= NULL
;
5962 it
->bidi_it
.string
.schars
= SCHARS (it
->string
);
5963 it
->bidi_it
.string
.bufpos
= pos
;
5964 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
5965 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
5966 it
->bidi_it
.w
= it
->w
;
5967 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
5972 it
->current
.overlay_string_index
= -1;
5977 get_overlay_strings (struct it
*it
, ptrdiff_t charpos
)
5980 it
->method
= GET_FROM_BUFFER
;
5982 (void) get_overlay_strings_1 (it
, charpos
, 1);
5986 /* Value is non-zero if we found at least one overlay string. */
5987 return STRINGP (it
->string
);
5992 /***********************************************************************
5993 Saving and restoring state
5994 ***********************************************************************/
5996 /* Save current settings of IT on IT->stack. Called, for example,
5997 before setting up IT for an overlay string, to be able to restore
5998 IT's settings to what they were after the overlay string has been
5999 processed. If POSITION is non-NULL, it is the position to save on
6000 the stack instead of IT->position. */
6003 push_it (struct it
*it
, struct text_pos
*position
)
6005 struct iterator_stack_entry
*p
;
6007 eassert (it
->sp
< IT_STACK_SIZE
);
6008 p
= it
->stack
+ it
->sp
;
6010 p
->stop_charpos
= it
->stop_charpos
;
6011 p
->prev_stop
= it
->prev_stop
;
6012 p
->base_level_stop
= it
->base_level_stop
;
6013 p
->cmp_it
= it
->cmp_it
;
6014 eassert (it
->face_id
>= 0);
6015 p
->face_id
= it
->face_id
;
6016 p
->string
= it
->string
;
6017 p
->method
= it
->method
;
6018 p
->from_overlay
= it
->from_overlay
;
6021 case GET_FROM_IMAGE
:
6022 p
->u
.image
.object
= it
->object
;
6023 p
->u
.image
.image_id
= it
->image_id
;
6024 p
->u
.image
.slice
= it
->slice
;
6026 case GET_FROM_STRETCH
:
6027 p
->u
.stretch
.object
= it
->object
;
6030 p
->position
= position
? *position
: it
->position
;
6031 p
->current
= it
->current
;
6032 p
->end_charpos
= it
->end_charpos
;
6033 p
->string_nchars
= it
->string_nchars
;
6035 p
->multibyte_p
= it
->multibyte_p
;
6036 p
->avoid_cursor_p
= it
->avoid_cursor_p
;
6037 p
->space_width
= it
->space_width
;
6038 p
->font_height
= it
->font_height
;
6039 p
->voffset
= it
->voffset
;
6040 p
->string_from_display_prop_p
= it
->string_from_display_prop_p
;
6041 p
->string_from_prefix_prop_p
= it
->string_from_prefix_prop_p
;
6042 p
->display_ellipsis_p
= 0;
6043 p
->line_wrap
= it
->line_wrap
;
6044 p
->bidi_p
= it
->bidi_p
;
6045 p
->paragraph_embedding
= it
->paragraph_embedding
;
6046 p
->from_disp_prop_p
= it
->from_disp_prop_p
;
6049 /* Save the state of the bidi iterator as well. */
6051 bidi_push_it (&it
->bidi_it
);
6055 iterate_out_of_display_property (struct it
*it
)
6057 int buffer_p
= !STRINGP (it
->string
);
6058 ptrdiff_t eob
= (buffer_p
? ZV
: it
->end_charpos
);
6059 ptrdiff_t bob
= (buffer_p
? BEGV
: 0);
6061 eassert (eob
>= CHARPOS (it
->position
) && CHARPOS (it
->position
) >= bob
);
6063 /* Maybe initialize paragraph direction. If we are at the beginning
6064 of a new paragraph, next_element_from_buffer may not have a
6065 chance to do that. */
6066 if (it
->bidi_it
.first_elt
&& it
->bidi_it
.charpos
< eob
)
6067 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
6068 /* prev_stop can be zero, so check against BEGV as well. */
6069 while (it
->bidi_it
.charpos
>= bob
6070 && it
->prev_stop
<= it
->bidi_it
.charpos
6071 && it
->bidi_it
.charpos
< CHARPOS (it
->position
)
6072 && it
->bidi_it
.charpos
< eob
)
6073 bidi_move_to_visually_next (&it
->bidi_it
);
6074 /* Record the stop_pos we just crossed, for when we cross it
6076 if (it
->bidi_it
.charpos
> CHARPOS (it
->position
))
6077 it
->prev_stop
= CHARPOS (it
->position
);
6078 /* If we ended up not where pop_it put us, resync IT's
6079 positional members with the bidi iterator. */
6080 if (it
->bidi_it
.charpos
!= CHARPOS (it
->position
))
6081 SET_TEXT_POS (it
->position
, it
->bidi_it
.charpos
, it
->bidi_it
.bytepos
);
6083 it
->current
.pos
= it
->position
;
6085 it
->current
.string_pos
= it
->position
;
6088 /* Restore IT's settings from IT->stack. Called, for example, when no
6089 more overlay strings must be processed, and we return to delivering
6090 display elements from a buffer, or when the end of a string from a
6091 `display' property is reached and we return to delivering display
6092 elements from an overlay string, or from a buffer. */
6095 pop_it (struct it
*it
)
6097 struct iterator_stack_entry
*p
;
6098 int from_display_prop
= it
->from_disp_prop_p
;
6100 eassert (it
->sp
> 0);
6102 p
= it
->stack
+ it
->sp
;
6103 it
->stop_charpos
= p
->stop_charpos
;
6104 it
->prev_stop
= p
->prev_stop
;
6105 it
->base_level_stop
= p
->base_level_stop
;
6106 it
->cmp_it
= p
->cmp_it
;
6107 it
->face_id
= p
->face_id
;
6108 it
->current
= p
->current
;
6109 it
->position
= p
->position
;
6110 it
->string
= p
->string
;
6111 it
->from_overlay
= p
->from_overlay
;
6112 if (NILP (it
->string
))
6113 SET_TEXT_POS (it
->current
.string_pos
, -1, -1);
6114 it
->method
= p
->method
;
6117 case GET_FROM_IMAGE
:
6118 it
->image_id
= p
->u
.image
.image_id
;
6119 it
->object
= p
->u
.image
.object
;
6120 it
->slice
= p
->u
.image
.slice
;
6122 case GET_FROM_STRETCH
:
6123 it
->object
= p
->u
.stretch
.object
;
6125 case GET_FROM_BUFFER
:
6126 it
->object
= it
->w
->contents
;
6128 case GET_FROM_STRING
:
6130 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
6132 /* Restore the face_box_p flag, since it could have been
6133 overwritten by the face of the object that we just finished
6136 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
6137 it
->object
= it
->string
;
6140 case GET_FROM_DISPLAY_VECTOR
:
6142 it
->method
= GET_FROM_C_STRING
;
6143 else if (STRINGP (it
->string
))
6144 it
->method
= GET_FROM_STRING
;
6147 it
->method
= GET_FROM_BUFFER
;
6148 it
->object
= it
->w
->contents
;
6151 it
->end_charpos
= p
->end_charpos
;
6152 it
->string_nchars
= p
->string_nchars
;
6154 it
->multibyte_p
= p
->multibyte_p
;
6155 it
->avoid_cursor_p
= p
->avoid_cursor_p
;
6156 it
->space_width
= p
->space_width
;
6157 it
->font_height
= p
->font_height
;
6158 it
->voffset
= p
->voffset
;
6159 it
->string_from_display_prop_p
= p
->string_from_display_prop_p
;
6160 it
->string_from_prefix_prop_p
= p
->string_from_prefix_prop_p
;
6161 it
->line_wrap
= p
->line_wrap
;
6162 it
->bidi_p
= p
->bidi_p
;
6163 it
->paragraph_embedding
= p
->paragraph_embedding
;
6164 it
->from_disp_prop_p
= p
->from_disp_prop_p
;
6167 bidi_pop_it (&it
->bidi_it
);
6168 /* Bidi-iterate until we get out of the portion of text, if any,
6169 covered by a `display' text property or by an overlay with
6170 `display' property. (We cannot just jump there, because the
6171 internal coherency of the bidi iterator state can not be
6172 preserved across such jumps.) We also must determine the
6173 paragraph base direction if the overlay we just processed is
6174 at the beginning of a new paragraph. */
6175 if (from_display_prop
6176 && (it
->method
== GET_FROM_BUFFER
|| it
->method
== GET_FROM_STRING
))
6177 iterate_out_of_display_property (it
);
6179 eassert ((BUFFERP (it
->object
)
6180 && IT_CHARPOS (*it
) == it
->bidi_it
.charpos
6181 && IT_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6182 || (STRINGP (it
->object
)
6183 && IT_STRING_CHARPOS (*it
) == it
->bidi_it
.charpos
6184 && IT_STRING_BYTEPOS (*it
) == it
->bidi_it
.bytepos
)
6185 || (CONSP (it
->object
) && it
->method
== GET_FROM_STRETCH
));
6191 /***********************************************************************
6193 ***********************************************************************/
6195 /* Set IT's current position to the previous line start. */
6198 back_to_previous_line_start (struct it
*it
)
6200 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
6203 IT_CHARPOS (*it
) = find_newline_no_quit (cp
, bp
, -1, &IT_BYTEPOS (*it
));
6207 /* Move IT to the next line start.
6209 Value is non-zero if a newline was found. Set *SKIPPED_P to 1 if
6210 we skipped over part of the text (as opposed to moving the iterator
6211 continuously over the text). Otherwise, don't change the value
6214 If BIDI_IT_PREV is non-NULL, store into it the state of the bidi
6215 iterator on the newline, if it was found.
6217 Newlines may come from buffer text, overlay strings, or strings
6218 displayed via the `display' property. That's the reason we can't
6219 simply use find_newline_no_quit.
6221 Note that this function may not skip over invisible text that is so
6222 because of text properties and immediately follows a newline. If
6223 it would, function reseat_at_next_visible_line_start, when called
6224 from set_iterator_to_next, would effectively make invisible
6225 characters following a newline part of the wrong glyph row, which
6226 leads to wrong cursor motion. */
6229 forward_to_next_line_start (struct it
*it
, int *skipped_p
,
6230 struct bidi_it
*bidi_it_prev
)
6232 ptrdiff_t old_selective
;
6233 int newline_found_p
, n
;
6234 const int MAX_NEWLINE_DISTANCE
= 500;
6236 /* If already on a newline, just consume it to avoid unintended
6237 skipping over invisible text below. */
6238 if (it
->what
== IT_CHARACTER
6240 && CHARPOS (it
->position
) == IT_CHARPOS (*it
))
6242 if (it
->bidi_p
&& bidi_it_prev
)
6243 *bidi_it_prev
= it
->bidi_it
;
6244 set_iterator_to_next (it
, 0);
6249 /* Don't handle selective display in the following. It's (a)
6250 unnecessary because it's done by the caller, and (b) leads to an
6251 infinite recursion because next_element_from_ellipsis indirectly
6252 calls this function. */
6253 old_selective
= it
->selective
;
6256 /* Scan for a newline within MAX_NEWLINE_DISTANCE display elements
6257 from buffer text. */
6258 for (n
= newline_found_p
= 0;
6259 !newline_found_p
&& n
< MAX_NEWLINE_DISTANCE
;
6260 n
+= STRINGP (it
->string
) ? 0 : 1)
6262 if (!get_next_display_element (it
))
6264 newline_found_p
= it
->what
== IT_CHARACTER
&& it
->c
== '\n';
6265 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6266 *bidi_it_prev
= it
->bidi_it
;
6267 set_iterator_to_next (it
, 0);
6270 /* If we didn't find a newline near enough, see if we can use a
6272 if (!newline_found_p
)
6274 ptrdiff_t bytepos
, start
= IT_CHARPOS (*it
);
6275 ptrdiff_t limit
= find_newline_no_quit (start
, IT_BYTEPOS (*it
),
6279 eassert (!STRINGP (it
->string
));
6281 /* If there isn't any `display' property in sight, and no
6282 overlays, we can just use the position of the newline in
6284 if (it
->stop_charpos
>= limit
6285 || ((pos
= Fnext_single_property_change (make_number (start
),
6287 make_number (limit
)),
6289 && next_overlay_change (start
) == ZV
))
6293 IT_CHARPOS (*it
) = limit
;
6294 IT_BYTEPOS (*it
) = bytepos
;
6298 struct bidi_it bprev
;
6300 /* Help bidi.c avoid expensive searches for display
6301 properties and overlays, by telling it that there are
6302 none up to `limit'. */
6303 if (it
->bidi_it
.disp_pos
< limit
)
6305 it
->bidi_it
.disp_pos
= limit
;
6306 it
->bidi_it
.disp_prop
= 0;
6309 bprev
= it
->bidi_it
;
6310 bidi_move_to_visually_next (&it
->bidi_it
);
6311 } while (it
->bidi_it
.charpos
!= limit
);
6312 IT_CHARPOS (*it
) = limit
;
6313 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6315 *bidi_it_prev
= bprev
;
6317 *skipped_p
= newline_found_p
= true;
6321 while (get_next_display_element (it
)
6322 && !newline_found_p
)
6324 newline_found_p
= ITERATOR_AT_END_OF_LINE_P (it
);
6325 if (newline_found_p
&& it
->bidi_p
&& bidi_it_prev
)
6326 *bidi_it_prev
= it
->bidi_it
;
6327 set_iterator_to_next (it
, 0);
6332 it
->selective
= old_selective
;
6333 return newline_found_p
;
6337 /* Set IT's current position to the previous visible line start. Skip
6338 invisible text that is so either due to text properties or due to
6339 selective display. Caution: this does not change IT->current_x and
6343 back_to_previous_visible_line_start (struct it
*it
)
6345 while (IT_CHARPOS (*it
) > BEGV
)
6347 back_to_previous_line_start (it
);
6349 if (IT_CHARPOS (*it
) <= BEGV
)
6352 /* If selective > 0, then lines indented more than its value are
6354 if (it
->selective
> 0
6355 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6359 /* Check the newline before point for invisibility. */
6362 prop
= Fget_char_property (make_number (IT_CHARPOS (*it
) - 1),
6363 Qinvisible
, it
->window
);
6364 if (TEXT_PROP_MEANS_INVISIBLE (prop
))
6368 if (IT_CHARPOS (*it
) <= BEGV
)
6373 void *it2data
= NULL
;
6376 Lisp_Object val
, overlay
;
6378 SAVE_IT (it2
, *it
, it2data
);
6380 /* If newline is part of a composition, continue from start of composition */
6381 if (find_composition (IT_CHARPOS (*it
), -1, &beg
, &end
, &val
, Qnil
)
6382 && beg
< IT_CHARPOS (*it
))
6385 /* If newline is replaced by a display property, find start of overlay
6386 or interval and continue search from that point. */
6387 pos
= --IT_CHARPOS (it2
);
6390 bidi_unshelve_cache (NULL
, 0);
6391 it2
.string_from_display_prop_p
= 0;
6392 it2
.from_disp_prop_p
= 0;
6393 if (handle_display_prop (&it2
) == HANDLED_RETURN
6394 && !NILP (val
= get_char_property_and_overlay
6395 (make_number (pos
), Qdisplay
, Qnil
, &overlay
))
6396 && (OVERLAYP (overlay
)
6397 ? (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)))
6398 : get_property_and_range (pos
, Qdisplay
, &val
, &beg
, &end
, Qnil
)))
6400 RESTORE_IT (it
, it
, it2data
);
6404 /* Newline is not replaced by anything -- so we are done. */
6405 RESTORE_IT (it
, it
, it2data
);
6411 IT_CHARPOS (*it
) = beg
;
6412 IT_BYTEPOS (*it
) = buf_charpos_to_bytepos (current_buffer
, beg
);
6416 it
->continuation_lines_width
= 0;
6418 eassert (IT_CHARPOS (*it
) >= BEGV
);
6419 eassert (IT_CHARPOS (*it
) == BEGV
6420 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6425 /* Reseat iterator IT at the previous visible line start. Skip
6426 invisible text that is so either due to text properties or due to
6427 selective display. At the end, update IT's overlay information,
6428 face information etc. */
6431 reseat_at_previous_visible_line_start (struct it
*it
)
6433 back_to_previous_visible_line_start (it
);
6434 reseat (it
, it
->current
.pos
, 1);
6439 /* Reseat iterator IT on the next visible line start in the current
6440 buffer. ON_NEWLINE_P non-zero means position IT on the newline
6441 preceding the line start. Skip over invisible text that is so
6442 because of selective display. Compute faces, overlays etc at the
6443 new position. Note that this function does not skip over text that
6444 is invisible because of text properties. */
6447 reseat_at_next_visible_line_start (struct it
*it
, int on_newline_p
)
6449 int newline_found_p
, skipped_p
= 0;
6450 struct bidi_it bidi_it_prev
;
6452 newline_found_p
= forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6454 /* Skip over lines that are invisible because they are indented
6455 more than the value of IT->selective. */
6456 if (it
->selective
> 0)
6457 while (IT_CHARPOS (*it
) < ZV
6458 && indented_beyond_p (IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
6461 eassert (IT_BYTEPOS (*it
) == BEGV
6462 || FETCH_BYTE (IT_BYTEPOS (*it
) - 1) == '\n');
6464 forward_to_next_line_start (it
, &skipped_p
, &bidi_it_prev
);
6467 /* Position on the newline if that's what's requested. */
6468 if (on_newline_p
&& newline_found_p
)
6470 if (STRINGP (it
->string
))
6472 if (IT_STRING_CHARPOS (*it
) > 0)
6476 --IT_STRING_CHARPOS (*it
);
6477 --IT_STRING_BYTEPOS (*it
);
6481 /* We need to restore the bidi iterator to the state
6482 it had on the newline, and resync the IT's
6483 position with that. */
6484 it
->bidi_it
= bidi_it_prev
;
6485 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6486 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6490 else if (IT_CHARPOS (*it
) > BEGV
)
6499 /* We need to restore the bidi iterator to the state it
6500 had on the newline and resync IT with that. */
6501 it
->bidi_it
= bidi_it_prev
;
6502 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
6503 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
6505 reseat (it
, it
->current
.pos
, 0);
6509 reseat (it
, it
->current
.pos
, 0);
6516 /***********************************************************************
6517 Changing an iterator's position
6518 ***********************************************************************/
6520 /* Change IT's current position to POS in current_buffer. If FORCE_P
6521 is non-zero, always check for text properties at the new position.
6522 Otherwise, text properties are only looked up if POS >=
6523 IT->check_charpos of a property. */
6526 reseat (struct it
*it
, struct text_pos pos
, int force_p
)
6528 ptrdiff_t original_pos
= IT_CHARPOS (*it
);
6530 reseat_1 (it
, pos
, 0);
6532 /* Determine where to check text properties. Avoid doing it
6533 where possible because text property lookup is very expensive. */
6535 || CHARPOS (pos
) > it
->stop_charpos
6536 || CHARPOS (pos
) < original_pos
)
6540 /* For bidi iteration, we need to prime prev_stop and
6541 base_level_stop with our best estimations. */
6542 /* Implementation note: Of course, POS is not necessarily a
6543 stop position, so assigning prev_pos to it is a lie; we
6544 should have called compute_stop_backwards. However, if
6545 the current buffer does not include any R2L characters,
6546 that call would be a waste of cycles, because the
6547 iterator will never move back, and thus never cross this
6548 "fake" stop position. So we delay that backward search
6549 until the time we really need it, in next_element_from_buffer. */
6550 if (CHARPOS (pos
) != it
->prev_stop
)
6551 it
->prev_stop
= CHARPOS (pos
);
6552 if (CHARPOS (pos
) < it
->base_level_stop
)
6553 it
->base_level_stop
= 0; /* meaning it's unknown */
6559 it
->prev_stop
= it
->base_level_stop
= 0;
6568 /* Change IT's buffer position to POS. SET_STOP_P non-zero means set
6569 IT->stop_pos to POS, also. */
6572 reseat_1 (struct it
*it
, struct text_pos pos
, int set_stop_p
)
6574 /* Don't call this function when scanning a C string. */
6575 eassert (it
->s
== NULL
);
6577 /* POS must be a reasonable value. */
6578 eassert (CHARPOS (pos
) >= BEGV
&& CHARPOS (pos
) <= ZV
);
6580 it
->current
.pos
= it
->position
= pos
;
6581 it
->end_charpos
= ZV
;
6583 it
->current
.dpvec_index
= -1;
6584 it
->current
.overlay_string_index
= -1;
6585 IT_STRING_CHARPOS (*it
) = -1;
6586 IT_STRING_BYTEPOS (*it
) = -1;
6588 it
->method
= GET_FROM_BUFFER
;
6589 it
->object
= it
->w
->contents
;
6590 it
->area
= TEXT_AREA
;
6591 it
->multibyte_p
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
6593 it
->string_from_display_prop_p
= 0;
6594 it
->string_from_prefix_prop_p
= 0;
6596 it
->from_disp_prop_p
= 0;
6597 it
->face_before_selective_p
= 0;
6600 bidi_init_it (IT_CHARPOS (*it
), IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6602 bidi_unshelve_cache (NULL
, 0);
6603 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6604 it
->bidi_it
.string
.s
= NULL
;
6605 it
->bidi_it
.string
.lstring
= Qnil
;
6606 it
->bidi_it
.string
.bufpos
= 0;
6607 it
->bidi_it
.string
.from_disp_str
= 0;
6608 it
->bidi_it
.string
.unibyte
= 0;
6609 it
->bidi_it
.w
= it
->w
;
6614 it
->stop_charpos
= CHARPOS (pos
);
6615 it
->base_level_stop
= CHARPOS (pos
);
6617 /* This make the information stored in it->cmp_it invalidate. */
6622 /* Set up IT for displaying a string, starting at CHARPOS in window W.
6623 If S is non-null, it is a C string to iterate over. Otherwise,
6624 STRING gives a Lisp string to iterate over.
6626 If PRECISION > 0, don't return more then PRECISION number of
6627 characters from the string.
6629 If FIELD_WIDTH > 0, return padding spaces until FIELD_WIDTH
6630 characters have been returned. FIELD_WIDTH < 0 means an infinite
6633 MULTIBYTE = 0 means disable processing of multibyte characters,
6634 MULTIBYTE > 0 means enable it,
6635 MULTIBYTE < 0 means use IT->multibyte_p.
6637 IT must be initialized via a prior call to init_iterator before
6638 calling this function. */
6641 reseat_to_string (struct it
*it
, const char *s
, Lisp_Object string
,
6642 ptrdiff_t charpos
, ptrdiff_t precision
, int field_width
,
6645 /* No text property checks performed by default, but see below. */
6646 it
->stop_charpos
= -1;
6648 /* Set iterator position and end position. */
6649 memset (&it
->current
, 0, sizeof it
->current
);
6650 it
->current
.overlay_string_index
= -1;
6651 it
->current
.dpvec_index
= -1;
6652 eassert (charpos
>= 0);
6654 /* If STRING is specified, use its multibyteness, otherwise use the
6655 setting of MULTIBYTE, if specified. */
6657 it
->multibyte_p
= multibyte
> 0;
6659 /* Bidirectional reordering of strings is controlled by the default
6660 value of bidi-display-reordering. Don't try to reorder while
6661 loading loadup.el, as the necessary character property tables are
6662 not yet available. */
6665 && !NILP (BVAR (&buffer_defaults
, bidi_display_reordering
));
6669 eassert (STRINGP (string
));
6670 it
->string
= string
;
6672 it
->end_charpos
= it
->string_nchars
= SCHARS (string
);
6673 it
->method
= GET_FROM_STRING
;
6674 it
->current
.string_pos
= string_pos (charpos
, string
);
6678 it
->bidi_it
.string
.lstring
= string
;
6679 it
->bidi_it
.string
.s
= NULL
;
6680 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6681 it
->bidi_it
.string
.bufpos
= 0;
6682 it
->bidi_it
.string
.from_disp_str
= 0;
6683 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6684 it
->bidi_it
.w
= it
->w
;
6685 bidi_init_it (charpos
, IT_STRING_BYTEPOS (*it
),
6686 FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
6691 it
->s
= (const unsigned char *) s
;
6694 /* Note that we use IT->current.pos, not it->current.string_pos,
6695 for displaying C strings. */
6696 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = -1;
6697 if (it
->multibyte_p
)
6699 it
->current
.pos
= c_string_pos (charpos
, s
, 1);
6700 it
->end_charpos
= it
->string_nchars
= number_of_chars (s
, 1);
6704 IT_CHARPOS (*it
) = IT_BYTEPOS (*it
) = charpos
;
6705 it
->end_charpos
= it
->string_nchars
= strlen (s
);
6710 it
->bidi_it
.string
.lstring
= Qnil
;
6711 it
->bidi_it
.string
.s
= (const unsigned char *) s
;
6712 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6713 it
->bidi_it
.string
.bufpos
= 0;
6714 it
->bidi_it
.string
.from_disp_str
= 0;
6715 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
6716 it
->bidi_it
.w
= it
->w
;
6717 bidi_init_it (charpos
, IT_BYTEPOS (*it
), FRAME_WINDOW_P (it
->f
),
6720 it
->method
= GET_FROM_C_STRING
;
6723 /* PRECISION > 0 means don't return more than PRECISION characters
6725 if (precision
> 0 && it
->end_charpos
- charpos
> precision
)
6727 it
->end_charpos
= it
->string_nchars
= charpos
+ precision
;
6729 it
->bidi_it
.string
.schars
= it
->end_charpos
;
6732 /* FIELD_WIDTH > 0 means pad with spaces until FIELD_WIDTH
6733 characters have been returned. FIELD_WIDTH == 0 means don't pad,
6734 FIELD_WIDTH < 0 means infinite field width. This is useful for
6735 padding with `-' at the end of a mode line. */
6736 if (field_width
< 0)
6737 field_width
= INFINITY
;
6738 /* Implementation note: We deliberately don't enlarge
6739 it->bidi_it.string.schars here to fit it->end_charpos, because
6740 the bidi iterator cannot produce characters out of thin air. */
6741 if (field_width
> it
->end_charpos
- charpos
)
6742 it
->end_charpos
= charpos
+ field_width
;
6744 /* Use the standard display table for displaying strings. */
6745 if (DISP_TABLE_P (Vstandard_display_table
))
6746 it
->dp
= XCHAR_TABLE (Vstandard_display_table
);
6748 it
->stop_charpos
= charpos
;
6749 it
->prev_stop
= charpos
;
6750 it
->base_level_stop
= 0;
6753 it
->bidi_it
.first_elt
= 1;
6754 it
->bidi_it
.paragraph_dir
= NEUTRAL_DIR
;
6755 it
->bidi_it
.disp_pos
= -1;
6757 if (s
== NULL
&& it
->multibyte_p
)
6759 ptrdiff_t endpos
= SCHARS (it
->string
);
6760 if (endpos
> it
->end_charpos
)
6761 endpos
= it
->end_charpos
;
6762 composition_compute_stop_pos (&it
->cmp_it
, charpos
, -1, endpos
,
6770 /***********************************************************************
6772 ***********************************************************************/
6774 /* Map enum it_method value to corresponding next_element_from_* function. */
6776 static int (* get_next_element
[NUM_IT_METHODS
]) (struct it
*it
) =
6778 next_element_from_buffer
,
6779 next_element_from_display_vector
,
6780 next_element_from_string
,
6781 next_element_from_c_string
,
6782 next_element_from_image
,
6783 next_element_from_stretch
6786 #define GET_NEXT_DISPLAY_ELEMENT(it) (*get_next_element[(it)->method]) (it)
6789 /* Return 1 iff a character at CHARPOS (and BYTEPOS) is composed
6790 (possibly with the following characters). */
6792 #define CHAR_COMPOSED_P(IT,CHARPOS,BYTEPOS,END_CHARPOS) \
6793 ((IT)->cmp_it.id >= 0 \
6794 || ((IT)->cmp_it.stop_pos == (CHARPOS) \
6795 && composition_reseat_it (&(IT)->cmp_it, CHARPOS, BYTEPOS, \
6796 END_CHARPOS, (IT)->w, \
6797 FACE_FROM_ID ((IT)->f, (IT)->face_id), \
6801 /* Lookup the char-table Vglyphless_char_display for character C (-1
6802 if we want information for no-font case), and return the display
6803 method symbol. By side-effect, update it->what and
6804 it->glyphless_method. This function is called from
6805 get_next_display_element for each character element, and from
6806 x_produce_glyphs when no suitable font was found. */
6809 lookup_glyphless_char_display (int c
, struct it
*it
)
6811 Lisp_Object glyphless_method
= Qnil
;
6813 if (CHAR_TABLE_P (Vglyphless_char_display
)
6814 && CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display
)) >= 1)
6818 glyphless_method
= CHAR_TABLE_REF (Vglyphless_char_display
, c
);
6819 if (CONSP (glyphless_method
))
6820 glyphless_method
= FRAME_WINDOW_P (it
->f
)
6821 ? XCAR (glyphless_method
)
6822 : XCDR (glyphless_method
);
6825 glyphless_method
= XCHAR_TABLE (Vglyphless_char_display
)->extras
[0];
6829 if (NILP (glyphless_method
))
6832 /* The default is to display the character by a proper font. */
6834 /* The default for the no-font case is to display an empty box. */
6835 glyphless_method
= Qempty_box
;
6837 if (EQ (glyphless_method
, Qzero_width
))
6840 return glyphless_method
;
6841 /* This method can't be used for the no-font case. */
6842 glyphless_method
= Qempty_box
;
6844 if (EQ (glyphless_method
, Qthin_space
))
6845 it
->glyphless_method
= GLYPHLESS_DISPLAY_THIN_SPACE
;
6846 else if (EQ (glyphless_method
, Qempty_box
))
6847 it
->glyphless_method
= GLYPHLESS_DISPLAY_EMPTY_BOX
;
6848 else if (EQ (glyphless_method
, Qhex_code
))
6849 it
->glyphless_method
= GLYPHLESS_DISPLAY_HEX_CODE
;
6850 else if (STRINGP (glyphless_method
))
6851 it
->glyphless_method
= GLYPHLESS_DISPLAY_ACRONYM
;
6854 /* Invalid value. We use the default method. */
6855 glyphless_method
= Qnil
;
6858 it
->what
= IT_GLYPHLESS
;
6859 return glyphless_method
;
6862 /* Merge escape glyph face and cache the result. */
6864 static struct frame
*last_escape_glyph_frame
= NULL
;
6865 static int last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
6866 static int last_escape_glyph_merged_face_id
= 0;
6869 merge_escape_glyph_face (struct it
*it
)
6873 if (it
->f
== last_escape_glyph_frame
6874 && it
->face_id
== last_escape_glyph_face_id
)
6875 face_id
= last_escape_glyph_merged_face_id
;
6878 /* Merge the `escape-glyph' face into the current face. */
6879 face_id
= merge_faces (it
->f
, Qescape_glyph
, 0, it
->face_id
);
6880 last_escape_glyph_frame
= it
->f
;
6881 last_escape_glyph_face_id
= it
->face_id
;
6882 last_escape_glyph_merged_face_id
= face_id
;
6887 /* Likewise for glyphless glyph face. */
6889 static struct frame
*last_glyphless_glyph_frame
= NULL
;
6890 static int last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
6891 static int last_glyphless_glyph_merged_face_id
= 0;
6894 merge_glyphless_glyph_face (struct it
*it
)
6898 if (it
->f
== last_glyphless_glyph_frame
6899 && it
->face_id
== last_glyphless_glyph_face_id
)
6900 face_id
= last_glyphless_glyph_merged_face_id
;
6903 /* Merge the `glyphless-char' face into the current face. */
6904 face_id
= merge_faces (it
->f
, Qglyphless_char
, 0, it
->face_id
);
6905 last_glyphless_glyph_frame
= it
->f
;
6906 last_glyphless_glyph_face_id
= it
->face_id
;
6907 last_glyphless_glyph_merged_face_id
= face_id
;
6912 /* Load IT's display element fields with information about the next
6913 display element from the current position of IT. Value is zero if
6914 end of buffer (or C string) is reached. */
6917 get_next_display_element (struct it
*it
)
6919 /* Non-zero means that we found a display element. Zero means that
6920 we hit the end of what we iterate over. Performance note: the
6921 function pointer `method' used here turns out to be faster than
6922 using a sequence of if-statements. */
6926 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
6928 if (it
->what
== IT_CHARACTER
)
6930 /* UAX#9, L4: "A character is depicted by a mirrored glyph if
6931 and only if (a) the resolved directionality of that character
6933 /* FIXME: Do we need an exception for characters from display
6935 if (it
->bidi_p
&& it
->bidi_it
.type
== STRONG_R
6936 && !inhibit_bidi_mirroring
)
6937 it
->c
= bidi_mirror_char (it
->c
);
6938 /* Map via display table or translate control characters.
6939 IT->c, IT->len etc. have been set to the next character by
6940 the function call above. If we have a display table, and it
6941 contains an entry for IT->c, translate it. Don't do this if
6942 IT->c itself comes from a display table, otherwise we could
6943 end up in an infinite recursion. (An alternative could be to
6944 count the recursion depth of this function and signal an
6945 error when a certain maximum depth is reached.) Is it worth
6947 if (success_p
&& it
->dpvec
== NULL
)
6950 struct charset
*unibyte
= CHARSET_FROM_ID (charset_unibyte
);
6951 int nonascii_space_p
= 0;
6952 int nonascii_hyphen_p
= 0;
6953 int c
= it
->c
; /* This is the character to display. */
6955 if (! it
->multibyte_p
&& ! ASCII_CHAR_P (c
))
6957 eassert (SINGLE_BYTE_CHAR_P (c
));
6958 if (unibyte_display_via_language_environment
)
6960 c
= DECODE_CHAR (unibyte
, c
);
6962 c
= BYTE8_TO_CHAR (it
->c
);
6965 c
= BYTE8_TO_CHAR (it
->c
);
6969 && (dv
= DISP_CHAR_VECTOR (it
->dp
, c
),
6972 struct Lisp_Vector
*v
= XVECTOR (dv
);
6974 /* Return the first character from the display table
6975 entry, if not empty. If empty, don't display the
6976 current character. */
6979 it
->dpvec_char_len
= it
->len
;
6980 it
->dpvec
= v
->contents
;
6981 it
->dpend
= v
->contents
+ v
->header
.size
;
6982 it
->current
.dpvec_index
= 0;
6983 it
->dpvec_face_id
= -1;
6984 it
->saved_face_id
= it
->face_id
;
6985 it
->method
= GET_FROM_DISPLAY_VECTOR
;
6990 set_iterator_to_next (it
, 0);
6995 if (! NILP (lookup_glyphless_char_display (c
, it
)))
6997 if (it
->what
== IT_GLYPHLESS
)
6999 /* Don't display this character. */
7000 set_iterator_to_next (it
, 0);
7004 /* If `nobreak-char-display' is non-nil, we display
7005 non-ASCII spaces and hyphens specially. */
7006 if (! ASCII_CHAR_P (c
) && ! NILP (Vnobreak_char_display
))
7009 nonascii_space_p
= true;
7010 else if (c
== 0xAD || c
== 0x2010 || c
== 0x2011)
7011 nonascii_hyphen_p
= true;
7014 /* Translate control characters into `\003' or `^C' form.
7015 Control characters coming from a display table entry are
7016 currently not translated because we use IT->dpvec to hold
7017 the translation. This could easily be changed but I
7018 don't believe that it is worth doing.
7020 The characters handled by `nobreak-char-display' must be
7023 Non-printable characters and raw-byte characters are also
7024 translated to octal form. */
7025 if (((c
< ' ' || c
== 127) /* ASCII control chars. */
7026 ? (it
->area
!= TEXT_AREA
7027 /* In mode line, treat \n, \t like other crl chars. */
7030 && (it
->glyph_row
->mode_line_p
|| it
->avoid_cursor_p
))
7031 || (c
!= '\n' && c
!= '\t'))
7033 || nonascii_hyphen_p
7035 || ! CHAR_PRINTABLE_P (c
))))
7037 /* C is a control character, non-ASCII space/hyphen,
7038 raw-byte, or a non-printable character which must be
7039 displayed either as '\003' or as `^C' where the '\\'
7040 and '^' can be defined in the display table. Fill
7041 IT->ctl_chars with glyphs for what we have to
7042 display. Then, set IT->dpvec to these glyphs. */
7049 /* Handle control characters with ^. */
7051 if (ASCII_CHAR_P (c
) && it
->ctl_arrow_p
)
7055 g
= '^'; /* default glyph for Control */
7056 /* Set IT->ctl_chars[0] to the glyph for `^'. */
7058 && (gc
= DISP_CTRL_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7060 g
= GLYPH_CODE_CHAR (gc
);
7061 lface_id
= GLYPH_CODE_FACE (gc
);
7065 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7066 : merge_escape_glyph_face (it
));
7068 XSETINT (it
->ctl_chars
[0], g
);
7069 XSETINT (it
->ctl_chars
[1], c
^ 0100);
7071 goto display_control
;
7074 /* Handle non-ascii space in the mode where it only gets
7077 if (nonascii_space_p
&& EQ (Vnobreak_char_display
, Qt
))
7079 /* Merge `nobreak-space' into the current face. */
7080 face_id
= merge_faces (it
->f
, Qnobreak_space
, 0,
7082 XSETINT (it
->ctl_chars
[0], ' ');
7084 goto display_control
;
7087 /* Handle sequences that start with the "escape glyph". */
7089 /* the default escape glyph is \. */
7090 escape_glyph
= '\\';
7093 && (gc
= DISP_ESCAPE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
7095 escape_glyph
= GLYPH_CODE_CHAR (gc
);
7096 lface_id
= GLYPH_CODE_FACE (gc
);
7100 ? merge_faces (it
->f
, Qt
, lface_id
, it
->face_id
)
7101 : merge_escape_glyph_face (it
));
7103 /* Draw non-ASCII hyphen with just highlighting: */
7105 if (nonascii_hyphen_p
&& EQ (Vnobreak_char_display
, Qt
))
7107 XSETINT (it
->ctl_chars
[0], '-');
7109 goto display_control
;
7112 /* Draw non-ASCII space/hyphen with escape glyph: */
7114 if (nonascii_space_p
|| nonascii_hyphen_p
)
7116 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7117 XSETINT (it
->ctl_chars
[1], nonascii_space_p
? ' ' : '-');
7119 goto display_control
;
7126 if (CHAR_BYTE8_P (c
))
7127 /* Display \200 instead of \17777600. */
7128 c
= CHAR_TO_BYTE8 (c
);
7129 len
= sprintf (str
, "%03o", c
);
7131 XSETINT (it
->ctl_chars
[0], escape_glyph
);
7132 for (i
= 0; i
< len
; i
++)
7133 XSETINT (it
->ctl_chars
[i
+ 1], str
[i
]);
7138 /* Set up IT->dpvec and return first character from it. */
7139 it
->dpvec_char_len
= it
->len
;
7140 it
->dpvec
= it
->ctl_chars
;
7141 it
->dpend
= it
->dpvec
+ ctl_len
;
7142 it
->current
.dpvec_index
= 0;
7143 it
->dpvec_face_id
= face_id
;
7144 it
->saved_face_id
= it
->face_id
;
7145 it
->method
= GET_FROM_DISPLAY_VECTOR
;
7149 it
->char_to_display
= c
;
7153 it
->char_to_display
= it
->c
;
7157 #ifdef HAVE_WINDOW_SYSTEM
7158 /* Adjust face id for a multibyte character. There are no multibyte
7159 character in unibyte text. */
7160 if ((it
->what
== IT_CHARACTER
|| it
->what
== IT_COMPOSITION
)
7163 && FRAME_WINDOW_P (it
->f
))
7165 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7167 if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
>= 0)
7169 /* Automatic composition with glyph-string. */
7170 Lisp_Object gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
7172 it
->face_id
= face_for_font (it
->f
, LGSTRING_FONT (gstring
), face
);
7176 ptrdiff_t pos
= (it
->s
? -1
7177 : STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
7178 : IT_CHARPOS (*it
));
7181 if (it
->what
== IT_CHARACTER
)
7182 c
= it
->char_to_display
;
7185 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
7189 for (i
= 0; i
< cmp
->glyph_len
; i
++)
7190 /* TAB in a composition means display glyphs with
7191 padding space on the left or right. */
7192 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
7195 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, c
, pos
, it
->string
);
7198 #endif /* HAVE_WINDOW_SYSTEM */
7201 /* Is this character the last one of a run of characters with
7202 box? If yes, set IT->end_of_box_run_p to 1. */
7206 if (it
->method
== GET_FROM_STRING
&& it
->sp
)
7208 int face_id
= underlying_face_id (it
);
7209 struct face
*face
= FACE_FROM_ID (it
->f
, face_id
);
7213 if (face
->box
== FACE_NO_BOX
)
7215 /* If the box comes from face properties in a
7216 display string, check faces in that string. */
7217 int string_face_id
= face_after_it_pos (it
);
7218 it
->end_of_box_run_p
7219 = (FACE_FROM_ID (it
->f
, string_face_id
)->box
7222 /* Otherwise, the box comes from the underlying face.
7223 If this is the last string character displayed, check
7224 the next buffer location. */
7225 else if ((IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
) - 1)
7226 /* n_overlay_strings is unreliable unless
7227 overlay_string_index is non-negative. */
7228 && ((it
->current
.overlay_string_index
>= 0
7229 && (it
->current
.overlay_string_index
7230 == it
->n_overlay_strings
- 1))
7231 /* A string from display property. */
7232 || it
->from_disp_prop_p
))
7236 struct text_pos pos
= it
->current
.pos
;
7238 /* For a string from a display property, the next
7239 buffer position is stored in the 'position'
7240 member of the iteration stack slot below the
7241 current one, see handle_single_display_spec. By
7242 contrast, it->current.pos was is not yet updated
7243 to point to that buffer position; that will
7244 happen in pop_it, after we finish displaying the
7245 current string. Note that we already checked
7246 above that it->sp is positive, so subtracting one
7248 if (it
->from_disp_prop_p
)
7249 pos
= (it
->stack
+ it
->sp
- 1)->position
;
7251 INC_TEXT_POS (pos
, it
->multibyte_p
);
7253 if (CHARPOS (pos
) >= ZV
)
7254 it
->end_of_box_run_p
= true;
7257 next_face_id
= face_at_buffer_position
7258 (it
->w
, CHARPOS (pos
), &ignore
,
7259 CHARPOS (pos
) + TEXT_PROP_DISTANCE_LIMIT
, 0, -1);
7260 it
->end_of_box_run_p
7261 = (FACE_FROM_ID (it
->f
, next_face_id
)->box
7267 /* next_element_from_display_vector sets this flag according to
7268 faces of the display vector glyphs, see there. */
7269 else if (it
->method
!= GET_FROM_DISPLAY_VECTOR
)
7271 int face_id
= face_after_it_pos (it
);
7272 it
->end_of_box_run_p
7273 = (face_id
!= it
->face_id
7274 && FACE_FROM_ID (it
->f
, face_id
)->box
== FACE_NO_BOX
);
7277 /* If we reached the end of the object we've been iterating (e.g., a
7278 display string or an overlay string), and there's something on
7279 IT->stack, proceed with what's on the stack. It doesn't make
7280 sense to return zero if there's unprocessed stuff on the stack,
7281 because otherwise that stuff will never be displayed. */
7282 if (!success_p
&& it
->sp
> 0)
7284 set_iterator_to_next (it
, 0);
7285 success_p
= get_next_display_element (it
);
7288 /* Value is 0 if end of buffer or string reached. */
7293 /* Move IT to the next display element.
7295 RESEAT_P non-zero means if called on a newline in buffer text,
7296 skip to the next visible line start.
7298 Functions get_next_display_element and set_iterator_to_next are
7299 separate because I find this arrangement easier to handle than a
7300 get_next_display_element function that also increments IT's
7301 position. The way it is we can first look at an iterator's current
7302 display element, decide whether it fits on a line, and if it does,
7303 increment the iterator position. The other way around we probably
7304 would either need a flag indicating whether the iterator has to be
7305 incremented the next time, or we would have to implement a
7306 decrement position function which would not be easy to write. */
7309 set_iterator_to_next (struct it
*it
, int reseat_p
)
7311 /* Reset flags indicating start and end of a sequence of characters
7312 with box. Reset them at the start of this function because
7313 moving the iterator to a new position might set them. */
7314 it
->start_of_box_run_p
= it
->end_of_box_run_p
= 0;
7318 case GET_FROM_BUFFER
:
7319 /* The current display element of IT is a character from
7320 current_buffer. Advance in the buffer, and maybe skip over
7321 invisible lines that are so because of selective display. */
7322 if (ITERATOR_AT_END_OF_LINE_P (it
) && reseat_p
)
7323 reseat_at_next_visible_line_start (it
, 0);
7324 else if (it
->cmp_it
.id
>= 0)
7326 /* We are currently getting glyphs from a composition. */
7331 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7332 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7333 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7335 it
->cmp_it
.from
= it
->cmp_it
.to
;
7340 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7342 it
->end_charpos
, Qnil
);
7345 else if (! it
->cmp_it
.reversed_p
)
7347 /* Composition created while scanning forward. */
7348 /* Update IT's char/byte positions to point to the first
7349 character of the next grapheme cluster, or to the
7350 character visually after the current composition. */
7351 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7352 bidi_move_to_visually_next (&it
->bidi_it
);
7353 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7354 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7356 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7358 /* Proceed to the next grapheme cluster. */
7359 it
->cmp_it
.from
= it
->cmp_it
.to
;
7363 /* No more grapheme clusters in this composition.
7364 Find the next stop position. */
7365 ptrdiff_t stop
= it
->end_charpos
;
7366 if (it
->bidi_it
.scan_dir
< 0)
7367 /* Now we are scanning backward and don't know
7370 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7371 IT_BYTEPOS (*it
), stop
, Qnil
);
7376 /* Composition created while scanning backward. */
7377 /* Update IT's char/byte positions to point to the last
7378 character of the previous grapheme cluster, or the
7379 character visually after the current composition. */
7380 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7381 bidi_move_to_visually_next (&it
->bidi_it
);
7382 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7383 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7384 if (it
->cmp_it
.from
> 0)
7386 /* Proceed to the previous grapheme cluster. */
7387 it
->cmp_it
.to
= it
->cmp_it
.from
;
7391 /* No more grapheme clusters in this composition.
7392 Find the next stop position. */
7393 ptrdiff_t stop
= it
->end_charpos
;
7394 if (it
->bidi_it
.scan_dir
< 0)
7395 /* Now we are scanning backward and don't know
7398 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7399 IT_BYTEPOS (*it
), stop
, Qnil
);
7405 eassert (it
->len
!= 0);
7409 IT_BYTEPOS (*it
) += it
->len
;
7410 IT_CHARPOS (*it
) += 1;
7414 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7415 /* If this is a new paragraph, determine its base
7416 direction (a.k.a. its base embedding level). */
7417 if (it
->bidi_it
.new_paragraph
)
7418 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
7419 bidi_move_to_visually_next (&it
->bidi_it
);
7420 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7421 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7422 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7424 /* As the scan direction was changed, we must
7425 re-compute the stop position for composition. */
7426 ptrdiff_t stop
= it
->end_charpos
;
7427 if (it
->bidi_it
.scan_dir
< 0)
7429 composition_compute_stop_pos (&it
->cmp_it
, IT_CHARPOS (*it
),
7430 IT_BYTEPOS (*it
), stop
, Qnil
);
7433 eassert (IT_BYTEPOS (*it
) == CHAR_TO_BYTE (IT_CHARPOS (*it
)));
7437 case GET_FROM_C_STRING
:
7438 /* Current display element of IT is from a C string. */
7440 /* If the string position is beyond string's end, it means
7441 next_element_from_c_string is padding the string with
7442 blanks, in which case we bypass the bidi iterator,
7443 because it cannot deal with such virtual characters. */
7444 || IT_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7446 IT_BYTEPOS (*it
) += it
->len
;
7447 IT_CHARPOS (*it
) += 1;
7451 bidi_move_to_visually_next (&it
->bidi_it
);
7452 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7453 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7457 case GET_FROM_DISPLAY_VECTOR
:
7458 /* Current display element of IT is from a display table entry.
7459 Advance in the display table definition. Reset it to null if
7460 end reached, and continue with characters from buffers/
7462 ++it
->current
.dpvec_index
;
7464 /* Restore face of the iterator to what they were before the
7465 display vector entry (these entries may contain faces). */
7466 it
->face_id
= it
->saved_face_id
;
7468 if (it
->dpvec
+ it
->current
.dpvec_index
>= it
->dpend
)
7470 int recheck_faces
= it
->ellipsis_p
;
7473 it
->method
= GET_FROM_C_STRING
;
7474 else if (STRINGP (it
->string
))
7475 it
->method
= GET_FROM_STRING
;
7478 it
->method
= GET_FROM_BUFFER
;
7479 it
->object
= it
->w
->contents
;
7483 it
->current
.dpvec_index
= -1;
7485 /* Skip over characters which were displayed via IT->dpvec. */
7486 if (it
->dpvec_char_len
< 0)
7487 reseat_at_next_visible_line_start (it
, 1);
7488 else if (it
->dpvec_char_len
> 0)
7490 if (it
->method
== GET_FROM_STRING
7491 && it
->current
.overlay_string_index
>= 0
7492 && it
->n_overlay_strings
> 0)
7493 it
->ignore_overlay_strings_at_pos_p
= true;
7494 it
->len
= it
->dpvec_char_len
;
7495 set_iterator_to_next (it
, reseat_p
);
7498 /* Maybe recheck faces after display vector. */
7500 it
->stop_charpos
= IT_CHARPOS (*it
);
7504 case GET_FROM_STRING
:
7505 /* Current display element is a character from a Lisp string. */
7506 eassert (it
->s
== NULL
&& STRINGP (it
->string
));
7507 /* Don't advance past string end. These conditions are true
7508 when set_iterator_to_next is called at the end of
7509 get_next_display_element, in which case the Lisp string is
7510 already exhausted, and all we want is pop the iterator
7512 if (it
->current
.overlay_string_index
>= 0)
7514 /* This is an overlay string, so there's no padding with
7515 spaces, and the number of characters in the string is
7516 where the string ends. */
7517 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7518 goto consider_string_end
;
7522 /* Not an overlay string. There could be padding, so test
7523 against it->end_charpos. */
7524 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7525 goto consider_string_end
;
7527 if (it
->cmp_it
.id
>= 0)
7533 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
7534 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
7535 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7536 it
->cmp_it
.from
= it
->cmp_it
.to
;
7540 composition_compute_stop_pos (&it
->cmp_it
,
7541 IT_STRING_CHARPOS (*it
),
7542 IT_STRING_BYTEPOS (*it
),
7543 it
->end_charpos
, it
->string
);
7546 else if (! it
->cmp_it
.reversed_p
)
7548 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7549 bidi_move_to_visually_next (&it
->bidi_it
);
7550 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7551 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7553 if (it
->cmp_it
.to
< it
->cmp_it
.nglyphs
)
7554 it
->cmp_it
.from
= it
->cmp_it
.to
;
7557 ptrdiff_t stop
= it
->end_charpos
;
7558 if (it
->bidi_it
.scan_dir
< 0)
7560 composition_compute_stop_pos (&it
->cmp_it
,
7561 IT_STRING_CHARPOS (*it
),
7562 IT_STRING_BYTEPOS (*it
), stop
,
7568 for (i
= 0; i
< it
->cmp_it
.nchars
; i
++)
7569 bidi_move_to_visually_next (&it
->bidi_it
);
7570 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7571 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7572 if (it
->cmp_it
.from
> 0)
7573 it
->cmp_it
.to
= it
->cmp_it
.from
;
7576 ptrdiff_t stop
= it
->end_charpos
;
7577 if (it
->bidi_it
.scan_dir
< 0)
7579 composition_compute_stop_pos (&it
->cmp_it
,
7580 IT_STRING_CHARPOS (*it
),
7581 IT_STRING_BYTEPOS (*it
), stop
,
7589 /* If the string position is beyond string's end, it
7590 means next_element_from_string is padding the string
7591 with blanks, in which case we bypass the bidi
7592 iterator, because it cannot deal with such virtual
7594 || IT_STRING_CHARPOS (*it
) >= it
->bidi_it
.string
.schars
)
7596 IT_STRING_BYTEPOS (*it
) += it
->len
;
7597 IT_STRING_CHARPOS (*it
) += 1;
7601 int prev_scan_dir
= it
->bidi_it
.scan_dir
;
7603 bidi_move_to_visually_next (&it
->bidi_it
);
7604 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7605 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7606 if (prev_scan_dir
!= it
->bidi_it
.scan_dir
)
7608 ptrdiff_t stop
= it
->end_charpos
;
7610 if (it
->bidi_it
.scan_dir
< 0)
7612 composition_compute_stop_pos (&it
->cmp_it
,
7613 IT_STRING_CHARPOS (*it
),
7614 IT_STRING_BYTEPOS (*it
), stop
,
7620 consider_string_end
:
7622 if (it
->current
.overlay_string_index
>= 0)
7624 /* IT->string is an overlay string. Advance to the
7625 next, if there is one. */
7626 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7629 next_overlay_string (it
);
7631 setup_for_ellipsis (it
, 0);
7636 /* IT->string is not an overlay string. If we reached
7637 its end, and there is something on IT->stack, proceed
7638 with what is on the stack. This can be either another
7639 string, this time an overlay string, or a buffer. */
7640 if (IT_STRING_CHARPOS (*it
) == SCHARS (it
->string
)
7644 if (it
->method
== GET_FROM_STRING
)
7645 goto consider_string_end
;
7650 case GET_FROM_IMAGE
:
7651 case GET_FROM_STRETCH
:
7652 /* The position etc with which we have to proceed are on
7653 the stack. The position may be at the end of a string,
7654 if the `display' property takes up the whole string. */
7655 eassert (it
->sp
> 0);
7657 if (it
->method
== GET_FROM_STRING
)
7658 goto consider_string_end
;
7662 /* There are no other methods defined, so this should be a bug. */
7666 eassert (it
->method
!= GET_FROM_STRING
7667 || (STRINGP (it
->string
)
7668 && IT_STRING_CHARPOS (*it
) >= 0));
7671 /* Load IT's display element fields with information about the next
7672 display element which comes from a display table entry or from the
7673 result of translating a control character to one of the forms `^C'
7676 IT->dpvec holds the glyphs to return as characters.
7677 IT->saved_face_id holds the face id before the display vector--it
7678 is restored into IT->face_id in set_iterator_to_next. */
7681 next_element_from_display_vector (struct it
*it
)
7684 int prev_face_id
= it
->face_id
;
7688 eassert (it
->dpvec
&& it
->current
.dpvec_index
>= 0);
7690 it
->face_id
= it
->saved_face_id
;
7692 /* KFS: This code used to check ip->dpvec[0] instead of the current element.
7693 That seemed totally bogus - so I changed it... */
7694 gc
= it
->dpvec
[it
->current
.dpvec_index
];
7696 if (GLYPH_CODE_P (gc
))
7698 struct face
*this_face
, *prev_face
, *next_face
;
7700 it
->c
= GLYPH_CODE_CHAR (gc
);
7701 it
->len
= CHAR_BYTES (it
->c
);
7703 /* The entry may contain a face id to use. Such a face id is
7704 the id of a Lisp face, not a realized face. A face id of
7705 zero means no face is specified. */
7706 if (it
->dpvec_face_id
>= 0)
7707 it
->face_id
= it
->dpvec_face_id
;
7710 int lface_id
= GLYPH_CODE_FACE (gc
);
7712 it
->face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7716 /* Glyphs in the display vector could have the box face, so we
7717 need to set the related flags in the iterator, as
7719 this_face
= FACE_FROM_ID (it
->f
, it
->face_id
);
7720 prev_face
= FACE_FROM_ID (it
->f
, prev_face_id
);
7722 /* Is this character the first character of a box-face run? */
7723 it
->start_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7725 || prev_face
->box
== FACE_NO_BOX
));
7727 /* For the last character of the box-face run, we need to look
7728 either at the next glyph from the display vector, or at the
7729 face we saw before the display vector. */
7730 next_face_id
= it
->saved_face_id
;
7731 if (it
->current
.dpvec_index
< it
->dpend
- it
->dpvec
- 1)
7733 if (it
->dpvec_face_id
>= 0)
7734 next_face_id
= it
->dpvec_face_id
;
7738 GLYPH_CODE_FACE (it
->dpvec
[it
->current
.dpvec_index
+ 1]);
7741 next_face_id
= merge_faces (it
->f
, Qt
, lface_id
,
7745 next_face
= FACE_FROM_ID (it
->f
, next_face_id
);
7746 it
->end_of_box_run_p
= (this_face
&& this_face
->box
!= FACE_NO_BOX
7748 || next_face
->box
== FACE_NO_BOX
));
7749 it
->face_box_p
= this_face
&& this_face
->box
!= FACE_NO_BOX
;
7752 /* Display table entry is invalid. Return a space. */
7753 it
->c
= ' ', it
->len
= 1;
7755 /* Don't change position and object of the iterator here. They are
7756 still the values of the character that had this display table
7757 entry or was translated, and that's what we want. */
7758 it
->what
= IT_CHARACTER
;
7762 /* Get the first element of string/buffer in the visual order, after
7763 being reseated to a new position in a string or a buffer. */
7765 get_visually_first_element (struct it
*it
)
7767 int string_p
= STRINGP (it
->string
) || it
->s
;
7768 ptrdiff_t eob
= (string_p
? it
->bidi_it
.string
.schars
: ZV
);
7769 ptrdiff_t bob
= (string_p
? 0 : BEGV
);
7771 if (STRINGP (it
->string
))
7773 it
->bidi_it
.charpos
= IT_STRING_CHARPOS (*it
);
7774 it
->bidi_it
.bytepos
= IT_STRING_BYTEPOS (*it
);
7778 it
->bidi_it
.charpos
= IT_CHARPOS (*it
);
7779 it
->bidi_it
.bytepos
= IT_BYTEPOS (*it
);
7782 if (it
->bidi_it
.charpos
== eob
)
7784 /* Nothing to do, but reset the FIRST_ELT flag, like
7785 bidi_paragraph_init does, because we are not going to
7787 it
->bidi_it
.first_elt
= 0;
7789 else if (it
->bidi_it
.charpos
== bob
7791 && (FETCH_CHAR (it
->bidi_it
.bytepos
- 1) == '\n'
7792 || FETCH_CHAR (it
->bidi_it
.bytepos
) == '\n')))
7794 /* If we are at the beginning of a line/string, we can produce
7795 the next element right away. */
7796 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7797 bidi_move_to_visually_next (&it
->bidi_it
);
7801 ptrdiff_t orig_bytepos
= it
->bidi_it
.bytepos
;
7803 /* We need to prime the bidi iterator starting at the line's or
7804 string's beginning, before we will be able to produce the
7807 it
->bidi_it
.charpos
= it
->bidi_it
.bytepos
= 0;
7809 it
->bidi_it
.charpos
= find_newline_no_quit (IT_CHARPOS (*it
),
7810 IT_BYTEPOS (*it
), -1,
7811 &it
->bidi_it
.bytepos
);
7812 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 1);
7815 /* Now return to buffer/string position where we were asked
7816 to get the next display element, and produce that. */
7817 bidi_move_to_visually_next (&it
->bidi_it
);
7819 while (it
->bidi_it
.bytepos
!= orig_bytepos
7820 && it
->bidi_it
.charpos
< eob
);
7823 /* Adjust IT's position information to where we ended up. */
7824 if (STRINGP (it
->string
))
7826 IT_STRING_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7827 IT_STRING_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7831 IT_CHARPOS (*it
) = it
->bidi_it
.charpos
;
7832 IT_BYTEPOS (*it
) = it
->bidi_it
.bytepos
;
7835 if (STRINGP (it
->string
) || !it
->s
)
7837 ptrdiff_t stop
, charpos
, bytepos
;
7839 if (STRINGP (it
->string
))
7842 stop
= SCHARS (it
->string
);
7843 if (stop
> it
->end_charpos
)
7844 stop
= it
->end_charpos
;
7845 charpos
= IT_STRING_CHARPOS (*it
);
7846 bytepos
= IT_STRING_BYTEPOS (*it
);
7850 stop
= it
->end_charpos
;
7851 charpos
= IT_CHARPOS (*it
);
7852 bytepos
= IT_BYTEPOS (*it
);
7854 if (it
->bidi_it
.scan_dir
< 0)
7856 composition_compute_stop_pos (&it
->cmp_it
, charpos
, bytepos
, stop
,
7861 /* Load IT with the next display element from Lisp string IT->string.
7862 IT->current.string_pos is the current position within the string.
7863 If IT->current.overlay_string_index >= 0, the Lisp string is an
7867 next_element_from_string (struct it
*it
)
7869 struct text_pos position
;
7871 eassert (STRINGP (it
->string
));
7872 eassert (!it
->bidi_p
|| EQ (it
->string
, it
->bidi_it
.string
.lstring
));
7873 eassert (IT_STRING_CHARPOS (*it
) >= 0);
7874 position
= it
->current
.string_pos
;
7876 /* With bidi reordering, the character to display might not be the
7877 character at IT_STRING_CHARPOS. BIDI_IT.FIRST_ELT non-zero means
7878 that we were reseat()ed to a new string, whose paragraph
7879 direction is not known. */
7880 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
7882 get_visually_first_element (it
);
7883 SET_TEXT_POS (position
, IT_STRING_CHARPOS (*it
), IT_STRING_BYTEPOS (*it
));
7886 /* Time to check for invisible text? */
7887 if (IT_STRING_CHARPOS (*it
) < it
->end_charpos
)
7889 if (IT_STRING_CHARPOS (*it
) >= it
->stop_charpos
)
7892 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
7893 || IT_STRING_CHARPOS (*it
) == it
->stop_charpos
))
7895 /* With bidi non-linear iteration, we could find
7896 ourselves far beyond the last computed stop_charpos,
7897 with several other stop positions in between that we
7898 missed. Scan them all now, in buffer's logical
7899 order, until we find and handle the last stop_charpos
7900 that precedes our current position. */
7901 handle_stop_backwards (it
, it
->stop_charpos
);
7902 return GET_NEXT_DISPLAY_ELEMENT (it
);
7908 /* Take note of the stop position we just moved
7909 across, for when we will move back across it. */
7910 it
->prev_stop
= it
->stop_charpos
;
7911 /* If we are at base paragraph embedding level, take
7912 note of the last stop position seen at this
7914 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7915 it
->base_level_stop
= it
->stop_charpos
;
7919 /* Since a handler may have changed IT->method, we must
7921 return GET_NEXT_DISPLAY_ELEMENT (it
);
7925 /* If we are before prev_stop, we may have overstepped
7926 on our way backwards a stop_pos, and if so, we need
7927 to handle that stop_pos. */
7928 && IT_STRING_CHARPOS (*it
) < it
->prev_stop
7929 /* We can sometimes back up for reasons that have nothing
7930 to do with bidi reordering. E.g., compositions. The
7931 code below is only needed when we are above the base
7932 embedding level, so test for that explicitly. */
7933 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
7935 /* If we lost track of base_level_stop, we have no better
7936 place for handle_stop_backwards to start from than string
7937 beginning. This happens, e.g., when we were reseated to
7938 the previous screenful of text by vertical-motion. */
7939 if (it
->base_level_stop
<= 0
7940 || IT_STRING_CHARPOS (*it
) < it
->base_level_stop
)
7941 it
->base_level_stop
= 0;
7942 handle_stop_backwards (it
, it
->base_level_stop
);
7943 return GET_NEXT_DISPLAY_ELEMENT (it
);
7947 if (it
->current
.overlay_string_index
>= 0)
7949 /* Get the next character from an overlay string. In overlay
7950 strings, there is no field width or padding with spaces to
7952 if (IT_STRING_CHARPOS (*it
) >= SCHARS (it
->string
))
7957 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7958 IT_STRING_BYTEPOS (*it
),
7959 it
->bidi_it
.scan_dir
< 0
7961 : SCHARS (it
->string
))
7962 && next_element_from_composition (it
))
7966 else if (STRING_MULTIBYTE (it
->string
))
7968 const unsigned char *s
= (SDATA (it
->string
)
7969 + IT_STRING_BYTEPOS (*it
));
7970 it
->c
= string_char_and_length (s
, &it
->len
);
7974 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
7980 /* Get the next character from a Lisp string that is not an
7981 overlay string. Such strings come from the mode line, for
7982 example. We may have to pad with spaces, or truncate the
7983 string. See also next_element_from_c_string. */
7984 if (IT_STRING_CHARPOS (*it
) >= it
->end_charpos
)
7989 else if (IT_STRING_CHARPOS (*it
) >= it
->string_nchars
)
7991 /* Pad with spaces. */
7992 it
->c
= ' ', it
->len
= 1;
7993 CHARPOS (position
) = BYTEPOS (position
) = -1;
7995 else if (CHAR_COMPOSED_P (it
, IT_STRING_CHARPOS (*it
),
7996 IT_STRING_BYTEPOS (*it
),
7997 it
->bidi_it
.scan_dir
< 0
7999 : it
->string_nchars
)
8000 && next_element_from_composition (it
))
8004 else if (STRING_MULTIBYTE (it
->string
))
8006 const unsigned char *s
= (SDATA (it
->string
)
8007 + IT_STRING_BYTEPOS (*it
));
8008 it
->c
= string_char_and_length (s
, &it
->len
);
8012 it
->c
= SREF (it
->string
, IT_STRING_BYTEPOS (*it
));
8017 /* Record what we have and where it came from. */
8018 it
->what
= IT_CHARACTER
;
8019 it
->object
= it
->string
;
8020 it
->position
= position
;
8025 /* Load IT with next display element from C string IT->s.
8026 IT->string_nchars is the maximum number of characters to return
8027 from the string. IT->end_charpos may be greater than
8028 IT->string_nchars when this function is called, in which case we
8029 may have to return padding spaces. Value is zero if end of string
8030 reached, including padding spaces. */
8033 next_element_from_c_string (struct it
*it
)
8035 bool success_p
= true;
8038 eassert (!it
->bidi_p
|| it
->s
== it
->bidi_it
.string
.s
);
8039 it
->what
= IT_CHARACTER
;
8040 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = 0;
8043 /* With bidi reordering, the character to display might not be the
8044 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8045 we were reseated to a new string, whose paragraph direction is
8047 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8048 get_visually_first_element (it
);
8050 /* IT's position can be greater than IT->string_nchars in case a
8051 field width or precision has been specified when the iterator was
8053 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8055 /* End of the game. */
8059 else if (IT_CHARPOS (*it
) >= it
->string_nchars
)
8061 /* Pad with spaces. */
8062 it
->c
= ' ', it
->len
= 1;
8063 BYTEPOS (it
->position
) = CHARPOS (it
->position
) = -1;
8065 else if (it
->multibyte_p
)
8066 it
->c
= string_char_and_length (it
->s
+ IT_BYTEPOS (*it
), &it
->len
);
8068 it
->c
= it
->s
[IT_BYTEPOS (*it
)], it
->len
= 1;
8074 /* Set up IT to return characters from an ellipsis, if appropriate.
8075 The definition of the ellipsis glyphs may come from a display table
8076 entry. This function fills IT with the first glyph from the
8077 ellipsis if an ellipsis is to be displayed. */
8080 next_element_from_ellipsis (struct it
*it
)
8082 if (it
->selective_display_ellipsis_p
)
8083 setup_for_ellipsis (it
, it
->len
);
8086 /* The face at the current position may be different from the
8087 face we find after the invisible text. Remember what it
8088 was in IT->saved_face_id, and signal that it's there by
8089 setting face_before_selective_p. */
8090 it
->saved_face_id
= it
->face_id
;
8091 it
->method
= GET_FROM_BUFFER
;
8092 it
->object
= it
->w
->contents
;
8093 reseat_at_next_visible_line_start (it
, 1);
8094 it
->face_before_selective_p
= true;
8097 return GET_NEXT_DISPLAY_ELEMENT (it
);
8101 /* Deliver an image display element. The iterator IT is already
8102 filled with image information (done in handle_display_prop). Value
8107 next_element_from_image (struct it
*it
)
8109 it
->what
= IT_IMAGE
;
8110 it
->ignore_overlay_strings_at_pos_p
= 0;
8115 /* Fill iterator IT with next display element from a stretch glyph
8116 property. IT->object is the value of the text property. Value is
8120 next_element_from_stretch (struct it
*it
)
8122 it
->what
= IT_STRETCH
;
8126 /* Scan backwards from IT's current position until we find a stop
8127 position, or until BEGV. This is called when we find ourself
8128 before both the last known prev_stop and base_level_stop while
8129 reordering bidirectional text. */
8132 compute_stop_pos_backwards (struct it
*it
)
8134 const int SCAN_BACK_LIMIT
= 1000;
8135 struct text_pos pos
;
8136 struct display_pos save_current
= it
->current
;
8137 struct text_pos save_position
= it
->position
;
8138 ptrdiff_t charpos
= IT_CHARPOS (*it
);
8139 ptrdiff_t where_we_are
= charpos
;
8140 ptrdiff_t save_stop_pos
= it
->stop_charpos
;
8141 ptrdiff_t save_end_pos
= it
->end_charpos
;
8143 eassert (NILP (it
->string
) && !it
->s
);
8144 eassert (it
->bidi_p
);
8148 it
->end_charpos
= min (charpos
+ 1, ZV
);
8149 charpos
= max (charpos
- SCAN_BACK_LIMIT
, BEGV
);
8150 SET_TEXT_POS (pos
, charpos
, CHAR_TO_BYTE (charpos
));
8151 reseat_1 (it
, pos
, 0);
8152 compute_stop_pos (it
);
8153 /* We must advance forward, right? */
8154 if (it
->stop_charpos
<= charpos
)
8157 while (charpos
> BEGV
&& it
->stop_charpos
>= it
->end_charpos
);
8159 if (it
->stop_charpos
<= where_we_are
)
8160 it
->prev_stop
= it
->stop_charpos
;
8162 it
->prev_stop
= BEGV
;
8164 it
->current
= save_current
;
8165 it
->position
= save_position
;
8166 it
->stop_charpos
= save_stop_pos
;
8167 it
->end_charpos
= save_end_pos
;
8170 /* Scan forward from CHARPOS in the current buffer/string, until we
8171 find a stop position > current IT's position. Then handle the stop
8172 position before that. This is called when we bump into a stop
8173 position while reordering bidirectional text. CHARPOS should be
8174 the last previously processed stop_pos (or BEGV/0, if none were
8175 processed yet) whose position is less that IT's current
8179 handle_stop_backwards (struct it
*it
, ptrdiff_t charpos
)
8181 int bufp
= !STRINGP (it
->string
);
8182 ptrdiff_t where_we_are
= (bufp
? IT_CHARPOS (*it
) : IT_STRING_CHARPOS (*it
));
8183 struct display_pos save_current
= it
->current
;
8184 struct text_pos save_position
= it
->position
;
8185 struct text_pos pos1
;
8186 ptrdiff_t next_stop
;
8188 /* Scan in strict logical order. */
8189 eassert (it
->bidi_p
);
8193 it
->prev_stop
= charpos
;
8196 SET_TEXT_POS (pos1
, charpos
, CHAR_TO_BYTE (charpos
));
8197 reseat_1 (it
, pos1
, 0);
8200 it
->current
.string_pos
= string_pos (charpos
, it
->string
);
8201 compute_stop_pos (it
);
8202 /* We must advance forward, right? */
8203 if (it
->stop_charpos
<= it
->prev_stop
)
8205 charpos
= it
->stop_charpos
;
8207 while (charpos
<= where_we_are
);
8210 it
->current
= save_current
;
8211 it
->position
= save_position
;
8212 next_stop
= it
->stop_charpos
;
8213 it
->stop_charpos
= it
->prev_stop
;
8215 it
->stop_charpos
= next_stop
;
8218 /* Load IT with the next display element from current_buffer. Value
8219 is zero if end of buffer reached. IT->stop_charpos is the next
8220 position at which to stop and check for text properties or buffer
8224 next_element_from_buffer (struct it
*it
)
8226 bool success_p
= true;
8228 eassert (IT_CHARPOS (*it
) >= BEGV
);
8229 eassert (NILP (it
->string
) && !it
->s
);
8230 eassert (!it
->bidi_p
8231 || (EQ (it
->bidi_it
.string
.lstring
, Qnil
)
8232 && it
->bidi_it
.string
.s
== NULL
));
8234 /* With bidi reordering, the character to display might not be the
8235 character at IT_CHARPOS. BIDI_IT.FIRST_ELT non-zero means that
8236 we were reseat()ed to a new buffer position, which is potentially
8237 a different paragraph. */
8238 if (it
->bidi_p
&& it
->bidi_it
.first_elt
)
8240 get_visually_first_element (it
);
8241 SET_TEXT_POS (it
->position
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8244 if (IT_CHARPOS (*it
) >= it
->stop_charpos
)
8246 if (IT_CHARPOS (*it
) >= it
->end_charpos
)
8248 int overlay_strings_follow_p
;
8250 /* End of the game, except when overlay strings follow that
8251 haven't been returned yet. */
8252 if (it
->overlay_strings_at_end_processed_p
)
8253 overlay_strings_follow_p
= 0;
8256 it
->overlay_strings_at_end_processed_p
= true;
8257 overlay_strings_follow_p
= get_overlay_strings (it
, 0);
8260 if (overlay_strings_follow_p
)
8261 success_p
= GET_NEXT_DISPLAY_ELEMENT (it
);
8265 it
->position
= it
->current
.pos
;
8269 else if (!(!it
->bidi_p
8270 || BIDI_AT_BASE_LEVEL (it
->bidi_it
)
8271 || IT_CHARPOS (*it
) == it
->stop_charpos
))
8273 /* With bidi non-linear iteration, we could find ourselves
8274 far beyond the last computed stop_charpos, with several
8275 other stop positions in between that we missed. Scan
8276 them all now, in buffer's logical order, until we find
8277 and handle the last stop_charpos that precedes our
8278 current position. */
8279 handle_stop_backwards (it
, it
->stop_charpos
);
8280 return GET_NEXT_DISPLAY_ELEMENT (it
);
8286 /* Take note of the stop position we just moved across,
8287 for when we will move back across it. */
8288 it
->prev_stop
= it
->stop_charpos
;
8289 /* If we are at base paragraph embedding level, take
8290 note of the last stop position seen at this
8292 if (BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8293 it
->base_level_stop
= it
->stop_charpos
;
8296 return GET_NEXT_DISPLAY_ELEMENT (it
);
8300 /* If we are before prev_stop, we may have overstepped on
8301 our way backwards a stop_pos, and if so, we need to
8302 handle that stop_pos. */
8303 && IT_CHARPOS (*it
) < it
->prev_stop
8304 /* We can sometimes back up for reasons that have nothing
8305 to do with bidi reordering. E.g., compositions. The
8306 code below is only needed when we are above the base
8307 embedding level, so test for that explicitly. */
8308 && !BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8310 if (it
->base_level_stop
<= 0
8311 || IT_CHARPOS (*it
) < it
->base_level_stop
)
8313 /* If we lost track of base_level_stop, we need to find
8314 prev_stop by looking backwards. This happens, e.g., when
8315 we were reseated to the previous screenful of text by
8317 it
->base_level_stop
= BEGV
;
8318 compute_stop_pos_backwards (it
);
8319 handle_stop_backwards (it
, it
->prev_stop
);
8322 handle_stop_backwards (it
, it
->base_level_stop
);
8323 return GET_NEXT_DISPLAY_ELEMENT (it
);
8327 /* No face changes, overlays etc. in sight, so just return a
8328 character from current_buffer. */
8332 /* Maybe run the redisplay end trigger hook. Performance note:
8333 This doesn't seem to cost measurable time. */
8334 if (it
->redisplay_end_trigger_charpos
8336 && IT_CHARPOS (*it
) >= it
->redisplay_end_trigger_charpos
)
8337 run_redisplay_end_trigger_hook (it
);
8339 stop
= it
->bidi_it
.scan_dir
< 0 ? -1 : it
->end_charpos
;
8340 if (CHAR_COMPOSED_P (it
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
),
8342 && next_element_from_composition (it
))
8347 /* Get the next character, maybe multibyte. */
8348 p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
8349 if (it
->multibyte_p
&& !ASCII_CHAR_P (*p
))
8350 it
->c
= STRING_CHAR_AND_LENGTH (p
, it
->len
);
8352 it
->c
= *p
, it
->len
= 1;
8354 /* Record what we have and where it came from. */
8355 it
->what
= IT_CHARACTER
;
8356 it
->object
= it
->w
->contents
;
8357 it
->position
= it
->current
.pos
;
8359 /* Normally we return the character found above, except when we
8360 really want to return an ellipsis for selective display. */
8365 /* A value of selective > 0 means hide lines indented more
8366 than that number of columns. */
8367 if (it
->selective
> 0
8368 && IT_CHARPOS (*it
) + 1 < ZV
8369 && indented_beyond_p (IT_CHARPOS (*it
) + 1,
8370 IT_BYTEPOS (*it
) + 1,
8373 success_p
= next_element_from_ellipsis (it
);
8374 it
->dpvec_char_len
= -1;
8377 else if (it
->c
== '\r' && it
->selective
== -1)
8379 /* A value of selective == -1 means that everything from the
8380 CR to the end of the line is invisible, with maybe an
8381 ellipsis displayed for it. */
8382 success_p
= next_element_from_ellipsis (it
);
8383 it
->dpvec_char_len
= -1;
8388 /* Value is zero if end of buffer reached. */
8389 eassert (!success_p
|| it
->what
!= IT_CHARACTER
|| it
->len
> 0);
8394 /* Run the redisplay end trigger hook for IT. */
8397 run_redisplay_end_trigger_hook (struct it
*it
)
8399 Lisp_Object args
[3];
8401 /* IT->glyph_row should be non-null, i.e. we should be actually
8402 displaying something, or otherwise we should not run the hook. */
8403 eassert (it
->glyph_row
);
8405 /* Set up hook arguments. */
8406 args
[0] = Qredisplay_end_trigger_functions
;
8407 args
[1] = it
->window
;
8408 XSETINT (args
[2], it
->redisplay_end_trigger_charpos
);
8409 it
->redisplay_end_trigger_charpos
= 0;
8411 /* Since we are *trying* to run these functions, don't try to run
8412 them again, even if they get an error. */
8413 wset_redisplay_end_trigger (it
->w
, Qnil
);
8414 Frun_hook_with_args (3, args
);
8416 /* Notice if it changed the face of the character we are on. */
8417 handle_face_prop (it
);
8421 /* Deliver a composition display element. Unlike the other
8422 next_element_from_XXX, this function is not registered in the array
8423 get_next_element[]. It is called from next_element_from_buffer and
8424 next_element_from_string when necessary. */
8427 next_element_from_composition (struct it
*it
)
8429 it
->what
= IT_COMPOSITION
;
8430 it
->len
= it
->cmp_it
.nbytes
;
8431 if (STRINGP (it
->string
))
8435 IT_STRING_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8436 IT_STRING_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8439 it
->position
= it
->current
.string_pos
;
8440 it
->object
= it
->string
;
8441 it
->c
= composition_update_it (&it
->cmp_it
, IT_STRING_CHARPOS (*it
),
8442 IT_STRING_BYTEPOS (*it
), it
->string
);
8448 IT_CHARPOS (*it
) += it
->cmp_it
.nchars
;
8449 IT_BYTEPOS (*it
) += it
->cmp_it
.nbytes
;
8452 if (it
->bidi_it
.new_paragraph
)
8453 bidi_paragraph_init (it
->paragraph_embedding
, &it
->bidi_it
, 0);
8454 /* Resync the bidi iterator with IT's new position.
8455 FIXME: this doesn't support bidirectional text. */
8456 while (it
->bidi_it
.charpos
< IT_CHARPOS (*it
))
8457 bidi_move_to_visually_next (&it
->bidi_it
);
8461 it
->position
= it
->current
.pos
;
8462 it
->object
= it
->w
->contents
;
8463 it
->c
= composition_update_it (&it
->cmp_it
, IT_CHARPOS (*it
),
8464 IT_BYTEPOS (*it
), Qnil
);
8471 /***********************************************************************
8472 Moving an iterator without producing glyphs
8473 ***********************************************************************/
8475 /* Check if iterator is at a position corresponding to a valid buffer
8476 position after some move_it_ call. */
8478 #define IT_POS_VALID_AFTER_MOVE_P(it) \
8479 ((it)->method == GET_FROM_STRING \
8480 ? IT_STRING_CHARPOS (*it) == 0 \
8484 /* Move iterator IT to a specified buffer or X position within one
8485 line on the display without producing glyphs.
8487 OP should be a bit mask including some or all of these bits:
8488 MOVE_TO_X: Stop upon reaching x-position TO_X.
8489 MOVE_TO_POS: Stop upon reaching buffer or string position TO_CHARPOS.
8490 Regardless of OP's value, stop upon reaching the end of the display line.
8492 TO_X is normally a value 0 <= TO_X <= IT->last_visible_x.
8493 This means, in particular, that TO_X includes window's horizontal
8496 The return value has several possible values that
8497 say what condition caused the scan to stop:
8499 MOVE_POS_MATCH_OR_ZV
8500 - when TO_POS or ZV was reached.
8503 -when TO_X was reached before TO_POS or ZV were reached.
8506 - when we reached the end of the display area and the line must
8510 - when we reached the end of the display area and the line is
8514 - when we stopped at a line end, i.e. a newline or a CR and selective
8517 static enum move_it_result
8518 move_it_in_display_line_to (struct it
*it
,
8519 ptrdiff_t to_charpos
, int to_x
,
8520 enum move_operation_enum op
)
8522 enum move_it_result result
= MOVE_UNDEFINED
;
8523 struct glyph_row
*saved_glyph_row
;
8524 struct it wrap_it
, atpos_it
, atx_it
, ppos_it
;
8525 void *wrap_data
= NULL
, *atpos_data
= NULL
, *atx_data
= NULL
;
8526 void *ppos_data
= NULL
;
8528 enum it_method prev_method
= it
->method
;
8529 ptrdiff_t closest_pos
IF_LINT (= 0), prev_pos
= IT_CHARPOS (*it
);
8530 int saw_smaller_pos
= prev_pos
< to_charpos
;
8532 /* Don't produce glyphs in produce_glyphs. */
8533 saved_glyph_row
= it
->glyph_row
;
8534 it
->glyph_row
= NULL
;
8536 /* Use wrap_it to save a copy of IT wherever a word wrap could
8537 occur. Use atpos_it to save a copy of IT at the desired buffer
8538 position, if found, so that we can scan ahead and check if the
8539 word later overshoots the window edge. Use atx_it similarly, for
8545 /* Use ppos_it under bidi reordering to save a copy of IT for the
8546 initial position. We restore that position in IT when we have
8547 scanned the entire display line without finding a match for
8548 TO_CHARPOS and all the character positions are greater than
8549 TO_CHARPOS. We then restart the scan from the initial position,
8550 and stop at CLOSEST_POS, which is a position > TO_CHARPOS that is
8551 the closest to TO_CHARPOS. */
8554 if ((op
& MOVE_TO_POS
) && IT_CHARPOS (*it
) >= to_charpos
)
8556 SAVE_IT (ppos_it
, *it
, ppos_data
);
8557 closest_pos
= IT_CHARPOS (*it
);
8563 #define BUFFER_POS_REACHED_P() \
8564 ((op & MOVE_TO_POS) != 0 \
8565 && BUFFERP (it->object) \
8566 && (IT_CHARPOS (*it) == to_charpos \
8568 || BIDI_AT_BASE_LEVEL (it->bidi_it)) \
8569 && IT_CHARPOS (*it) > to_charpos) \
8570 || (it->what == IT_COMPOSITION \
8571 && ((IT_CHARPOS (*it) > to_charpos \
8572 && to_charpos >= it->cmp_it.charpos) \
8573 || (IT_CHARPOS (*it) < to_charpos \
8574 && to_charpos <= it->cmp_it.charpos)))) \
8575 && (it->method == GET_FROM_BUFFER \
8576 || (it->method == GET_FROM_DISPLAY_VECTOR \
8577 && it->dpvec + it->current.dpvec_index + 1 >= it->dpend)))
8579 /* If there's a line-/wrap-prefix, handle it. */
8580 if (it
->hpos
== 0 && it
->method
== GET_FROM_BUFFER
8581 && it
->current_y
< it
->last_visible_y
)
8582 handle_line_prefix (it
);
8584 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8585 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8589 int x
, i
, ascent
= 0, descent
= 0;
8591 /* Utility macro to reset an iterator with x, ascent, and descent. */
8592 #define IT_RESET_X_ASCENT_DESCENT(IT) \
8593 ((IT)->current_x = x, (IT)->max_ascent = ascent, \
8594 (IT)->max_descent = descent)
8596 /* Stop if we move beyond TO_CHARPOS (after an image or a
8597 display string or stretch glyph). */
8598 if ((op
& MOVE_TO_POS
) != 0
8599 && BUFFERP (it
->object
)
8600 && it
->method
== GET_FROM_BUFFER
8602 /* When the iterator is at base embedding level, we
8603 are guaranteed that characters are delivered for
8604 display in strictly increasing order of their
8605 buffer positions. */
8606 || BIDI_AT_BASE_LEVEL (it
->bidi_it
))
8607 && IT_CHARPOS (*it
) > to_charpos
)
8609 && (prev_method
== GET_FROM_IMAGE
8610 || prev_method
== GET_FROM_STRETCH
8611 || prev_method
== GET_FROM_STRING
)
8612 /* Passed TO_CHARPOS from left to right. */
8613 && ((prev_pos
< to_charpos
8614 && IT_CHARPOS (*it
) > to_charpos
)
8615 /* Passed TO_CHARPOS from right to left. */
8616 || (prev_pos
> to_charpos
8617 && IT_CHARPOS (*it
) < to_charpos
)))))
8619 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8621 result
= MOVE_POS_MATCH_OR_ZV
;
8624 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8625 /* If wrap_it is valid, the current position might be in a
8626 word that is wrapped. So, save the iterator in
8627 atpos_it and continue to see if wrapping happens. */
8628 SAVE_IT (atpos_it
, *it
, atpos_data
);
8631 /* Stop when ZV reached.
8632 We used to stop here when TO_CHARPOS reached as well, but that is
8633 too soon if this glyph does not fit on this line. So we handle it
8634 explicitly below. */
8635 if (!get_next_display_element (it
))
8637 result
= MOVE_POS_MATCH_OR_ZV
;
8641 if (it
->line_wrap
== TRUNCATE
)
8643 if (BUFFER_POS_REACHED_P ())
8645 result
= MOVE_POS_MATCH_OR_ZV
;
8651 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
8653 if (IT_DISPLAYING_WHITESPACE (it
))
8657 /* We have reached a glyph that follows one or more
8658 whitespace characters. If the position is
8659 already found, we are done. */
8660 if (atpos_it
.sp
>= 0)
8662 RESTORE_IT (it
, &atpos_it
, atpos_data
);
8663 result
= MOVE_POS_MATCH_OR_ZV
;
8668 RESTORE_IT (it
, &atx_it
, atx_data
);
8669 result
= MOVE_X_REACHED
;
8672 /* Otherwise, we can wrap here. */
8673 SAVE_IT (wrap_it
, *it
, wrap_data
);
8679 /* Remember the line height for the current line, in case
8680 the next element doesn't fit on the line. */
8681 ascent
= it
->max_ascent
;
8682 descent
= it
->max_descent
;
8684 /* The call to produce_glyphs will get the metrics of the
8685 display element IT is loaded with. Record the x-position
8686 before this display element, in case it doesn't fit on the
8690 PRODUCE_GLYPHS (it
);
8692 if (it
->area
!= TEXT_AREA
)
8694 prev_method
= it
->method
;
8695 if (it
->method
== GET_FROM_BUFFER
)
8696 prev_pos
= IT_CHARPOS (*it
);
8697 set_iterator_to_next (it
, 1);
8698 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8699 SET_TEXT_POS (this_line_min_pos
,
8700 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8702 && (op
& MOVE_TO_POS
)
8703 && IT_CHARPOS (*it
) > to_charpos
8704 && IT_CHARPOS (*it
) < closest_pos
)
8705 closest_pos
= IT_CHARPOS (*it
);
8709 /* The number of glyphs we get back in IT->nglyphs will normally
8710 be 1 except when IT->c is (i) a TAB, or (ii) a multi-glyph
8711 character on a terminal frame, or (iii) a line end. For the
8712 second case, IT->nglyphs - 1 padding glyphs will be present.
8713 (On X frames, there is only one glyph produced for a
8714 composite character.)
8716 The behavior implemented below means, for continuation lines,
8717 that as many spaces of a TAB as fit on the current line are
8718 displayed there. For terminal frames, as many glyphs of a
8719 multi-glyph character are displayed in the current line, too.
8720 This is what the old redisplay code did, and we keep it that
8721 way. Under X, the whole shape of a complex character must
8722 fit on the line or it will be completely displayed in the
8725 Note that both for tabs and padding glyphs, all glyphs have
8729 /* More than one glyph or glyph doesn't fit on line. All
8730 glyphs have the same width. */
8731 int single_glyph_width
= it
->pixel_width
/ it
->nglyphs
;
8733 int x_before_this_char
= x
;
8734 int hpos_before_this_char
= it
->hpos
;
8736 for (i
= 0; i
< it
->nglyphs
; ++i
, x
= new_x
)
8738 new_x
= x
+ single_glyph_width
;
8740 /* We want to leave anything reaching TO_X to the caller. */
8741 if ((op
& MOVE_TO_X
) && new_x
> to_x
)
8743 if (BUFFER_POS_REACHED_P ())
8745 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8746 goto buffer_pos_reached
;
8747 if (atpos_it
.sp
< 0)
8749 SAVE_IT (atpos_it
, *it
, atpos_data
);
8750 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8755 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8758 result
= MOVE_X_REACHED
;
8763 SAVE_IT (atx_it
, *it
, atx_data
);
8764 IT_RESET_X_ASCENT_DESCENT (&atx_it
);
8769 if (/* Lines are continued. */
8770 it
->line_wrap
!= TRUNCATE
8771 && (/* And glyph doesn't fit on the line. */
8772 new_x
> it
->last_visible_x
8773 /* Or it fits exactly and we're on a window
8775 || (new_x
== it
->last_visible_x
8776 && FRAME_WINDOW_P (it
->f
)
8777 && ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8778 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8779 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
8781 if (/* IT->hpos == 0 means the very first glyph
8782 doesn't fit on the line, e.g. a wide image. */
8784 || (new_x
== it
->last_visible_x
8785 && FRAME_WINDOW_P (it
->f
)
8786 /* When word-wrap is ON and we have a valid
8787 wrap point, we don't allow the last glyph
8788 to "just barely fit" on the line. */
8789 && (it
->line_wrap
!= WORD_WRAP
8790 || wrap_it
.sp
< 0)))
8793 it
->current_x
= new_x
;
8795 /* The character's last glyph just barely fits
8797 if (i
== it
->nglyphs
- 1)
8799 /* If this is the destination position,
8800 return a position *before* it in this row,
8801 now that we know it fits in this row. */
8802 if (BUFFER_POS_REACHED_P ())
8804 if (it
->line_wrap
!= WORD_WRAP
8807 it
->hpos
= hpos_before_this_char
;
8808 it
->current_x
= x_before_this_char
;
8809 result
= MOVE_POS_MATCH_OR_ZV
;
8812 if (it
->line_wrap
== WORD_WRAP
8815 SAVE_IT (atpos_it
, *it
, atpos_data
);
8816 atpos_it
.current_x
= x_before_this_char
;
8817 atpos_it
.hpos
= hpos_before_this_char
;
8821 prev_method
= it
->method
;
8822 if (it
->method
== GET_FROM_BUFFER
)
8823 prev_pos
= IT_CHARPOS (*it
);
8824 set_iterator_to_next (it
, 1);
8825 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8826 SET_TEXT_POS (this_line_min_pos
,
8827 IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8828 /* On graphical terminals, newlines may
8829 "overflow" into the fringe if
8830 overflow-newline-into-fringe is non-nil.
8831 On text terminals, and on graphical
8832 terminals with no right margin, newlines
8833 may overflow into the last glyph on the
8835 if (!FRAME_WINDOW_P (it
->f
)
8837 && it
->bidi_it
.paragraph_dir
== R2L
)
8838 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8839 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8840 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8842 if (!get_next_display_element (it
))
8844 result
= MOVE_POS_MATCH_OR_ZV
;
8847 if (BUFFER_POS_REACHED_P ())
8849 if (ITERATOR_AT_END_OF_LINE_P (it
))
8850 result
= MOVE_POS_MATCH_OR_ZV
;
8852 result
= MOVE_LINE_CONTINUED
;
8855 if (ITERATOR_AT_END_OF_LINE_P (it
)
8856 && (it
->line_wrap
!= WORD_WRAP
8859 result
= MOVE_NEWLINE_OR_CR
;
8866 IT_RESET_X_ASCENT_DESCENT (it
);
8868 if (wrap_it
.sp
>= 0)
8870 RESTORE_IT (it
, &wrap_it
, wrap_data
);
8875 TRACE_MOVE ((stderr
, "move_it_in: continued at %d\n",
8877 result
= MOVE_LINE_CONTINUED
;
8881 if (BUFFER_POS_REACHED_P ())
8883 if (it
->line_wrap
!= WORD_WRAP
|| wrap_it
.sp
< 0)
8884 goto buffer_pos_reached
;
8885 if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
< 0)
8887 SAVE_IT (atpos_it
, *it
, atpos_data
);
8888 IT_RESET_X_ASCENT_DESCENT (&atpos_it
);
8892 if (new_x
> it
->first_visible_x
)
8894 /* Glyph is visible. Increment number of glyphs that
8895 would be displayed. */
8900 if (result
!= MOVE_UNDEFINED
)
8903 else if (BUFFER_POS_REACHED_P ())
8906 IT_RESET_X_ASCENT_DESCENT (it
);
8907 result
= MOVE_POS_MATCH_OR_ZV
;
8910 else if ((op
& MOVE_TO_X
) && it
->current_x
>= to_x
)
8912 /* Stop when TO_X specified and reached. This check is
8913 necessary here because of lines consisting of a line end,
8914 only. The line end will not produce any glyphs and we
8915 would never get MOVE_X_REACHED. */
8916 eassert (it
->nglyphs
== 0);
8917 result
= MOVE_X_REACHED
;
8921 /* Is this a line end? If yes, we're done. */
8922 if (ITERATOR_AT_END_OF_LINE_P (it
))
8924 /* If we are past TO_CHARPOS, but never saw any character
8925 positions smaller than TO_CHARPOS, return
8926 MOVE_POS_MATCH_OR_ZV, like the unidirectional display
8928 if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0)
8930 if (!saw_smaller_pos
&& IT_CHARPOS (*it
) > to_charpos
)
8932 if (closest_pos
< ZV
)
8934 RESTORE_IT (it
, &ppos_it
, ppos_data
);
8935 /* Don't recurse if closest_pos is equal to
8936 to_charpos, since we have just tried that. */
8937 if (closest_pos
!= to_charpos
)
8938 move_it_in_display_line_to (it
, closest_pos
, -1,
8940 result
= MOVE_POS_MATCH_OR_ZV
;
8943 goto buffer_pos_reached
;
8945 else if (it
->line_wrap
== WORD_WRAP
&& atpos_it
.sp
>= 0
8946 && IT_CHARPOS (*it
) > to_charpos
)
8947 goto buffer_pos_reached
;
8949 result
= MOVE_NEWLINE_OR_CR
;
8952 result
= MOVE_NEWLINE_OR_CR
;
8956 prev_method
= it
->method
;
8957 if (it
->method
== GET_FROM_BUFFER
)
8958 prev_pos
= IT_CHARPOS (*it
);
8959 /* The current display element has been consumed. Advance
8961 set_iterator_to_next (it
, 1);
8962 if (IT_CHARPOS (*it
) < CHARPOS (this_line_min_pos
))
8963 SET_TEXT_POS (this_line_min_pos
, IT_CHARPOS (*it
), IT_BYTEPOS (*it
));
8964 if (IT_CHARPOS (*it
) < to_charpos
)
8965 saw_smaller_pos
= 1;
8967 && (op
& MOVE_TO_POS
)
8968 && IT_CHARPOS (*it
) >= to_charpos
8969 && IT_CHARPOS (*it
) < closest_pos
)
8970 closest_pos
= IT_CHARPOS (*it
);
8972 /* Stop if lines are truncated and IT's current x-position is
8973 past the right edge of the window now. */
8974 if (it
->line_wrap
== TRUNCATE
8975 && it
->current_x
>= it
->last_visible_x
)
8977 if (!FRAME_WINDOW_P (it
->f
)
8978 || ((it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
8979 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
8980 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0
8981 || IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
8985 if ((at_eob_p
= !get_next_display_element (it
))
8986 || BUFFER_POS_REACHED_P ()
8987 /* If we are past TO_CHARPOS, but never saw any
8988 character positions smaller than TO_CHARPOS,
8989 return MOVE_POS_MATCH_OR_ZV, like the
8990 unidirectional display did. */
8991 || (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
8993 && IT_CHARPOS (*it
) > to_charpos
))
8996 && !BUFFER_POS_REACHED_P ()
8997 && !at_eob_p
&& closest_pos
< ZV
)
8999 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9000 if (closest_pos
!= to_charpos
)
9001 move_it_in_display_line_to (it
, closest_pos
, -1,
9004 result
= MOVE_POS_MATCH_OR_ZV
;
9007 if (ITERATOR_AT_END_OF_LINE_P (it
))
9009 result
= MOVE_NEWLINE_OR_CR
;
9013 else if (it
->bidi_p
&& (op
& MOVE_TO_POS
) != 0
9015 && IT_CHARPOS (*it
) > to_charpos
)
9017 if (closest_pos
< ZV
)
9019 RESTORE_IT (it
, &ppos_it
, ppos_data
);
9020 if (closest_pos
!= to_charpos
)
9021 move_it_in_display_line_to (it
, closest_pos
, -1,
9024 result
= MOVE_POS_MATCH_OR_ZV
;
9027 result
= MOVE_LINE_TRUNCATED
;
9030 #undef IT_RESET_X_ASCENT_DESCENT
9033 #undef BUFFER_POS_REACHED_P
9035 /* If we scanned beyond to_pos and didn't find a point to wrap at,
9036 restore the saved iterator. */
9037 if (atpos_it
.sp
>= 0)
9038 RESTORE_IT (it
, &atpos_it
, atpos_data
);
9039 else if (atx_it
.sp
>= 0)
9040 RESTORE_IT (it
, &atx_it
, atx_data
);
9045 bidi_unshelve_cache (atpos_data
, 1);
9047 bidi_unshelve_cache (atx_data
, 1);
9049 bidi_unshelve_cache (wrap_data
, 1);
9051 bidi_unshelve_cache (ppos_data
, 1);
9053 /* Restore the iterator settings altered at the beginning of this
9055 it
->glyph_row
= saved_glyph_row
;
9059 /* For external use. */
9061 move_it_in_display_line (struct it
*it
,
9062 ptrdiff_t to_charpos
, int to_x
,
9063 enum move_operation_enum op
)
9065 if (it
->line_wrap
== WORD_WRAP
9066 && (op
& MOVE_TO_X
))
9069 void *save_data
= NULL
;
9072 SAVE_IT (save_it
, *it
, save_data
);
9073 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9074 /* When word-wrap is on, TO_X may lie past the end
9075 of a wrapped line. Then it->current is the
9076 character on the next line, so backtrack to the
9077 space before the wrap point. */
9078 if (skip
== MOVE_LINE_CONTINUED
)
9080 int prev_x
= max (it
->current_x
- 1, 0);
9081 RESTORE_IT (it
, &save_it
, save_data
);
9082 move_it_in_display_line_to
9083 (it
, -1, prev_x
, MOVE_TO_X
);
9086 bidi_unshelve_cache (save_data
, 1);
9089 move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9093 /* Move IT forward until it satisfies one or more of the criteria in
9094 TO_CHARPOS, TO_X, TO_Y, and TO_VPOS.
9096 OP is a bit-mask that specifies where to stop, and in particular,
9097 which of those four position arguments makes a difference. See the
9098 description of enum move_operation_enum.
9100 If TO_CHARPOS is in invisible text, e.g. a truncated part of a
9101 screen line, this function will set IT to the next position that is
9102 displayed to the right of TO_CHARPOS on the screen.
9104 Return the maximum pixel length of any line scanned but never more
9105 than it.last_visible_x. */
9108 move_it_to (struct it
*it
, ptrdiff_t to_charpos
, int to_x
, int to_y
, int to_vpos
, int op
)
9110 enum move_it_result skip
, skip2
= MOVE_X_REACHED
;
9111 int line_height
, line_start_x
= 0, reached
= 0;
9112 int max_current_x
= 0;
9113 void *backup_data
= NULL
;
9117 if (op
& MOVE_TO_VPOS
)
9119 /* If no TO_CHARPOS and no TO_X specified, stop at the
9120 start of the line TO_VPOS. */
9121 if ((op
& (MOVE_TO_X
| MOVE_TO_POS
)) == 0)
9123 if (it
->vpos
== to_vpos
)
9129 skip
= move_it_in_display_line_to (it
, -1, -1, 0);
9133 /* TO_VPOS >= 0 means stop at TO_X in the line at
9134 TO_VPOS, or at TO_POS, whichever comes first. */
9135 if (it
->vpos
== to_vpos
)
9141 skip
= move_it_in_display_line_to (it
, to_charpos
, to_x
, op
);
9143 if (skip
== MOVE_POS_MATCH_OR_ZV
|| it
->vpos
== to_vpos
)
9148 else if (skip
== MOVE_X_REACHED
&& it
->vpos
!= to_vpos
)
9150 /* We have reached TO_X but not in the line we want. */
9151 skip
= move_it_in_display_line_to (it
, to_charpos
,
9153 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9161 else if (op
& MOVE_TO_Y
)
9163 struct it it_backup
;
9165 if (it
->line_wrap
== WORD_WRAP
)
9166 SAVE_IT (it_backup
, *it
, backup_data
);
9168 /* TO_Y specified means stop at TO_X in the line containing
9169 TO_Y---or at TO_CHARPOS if this is reached first. The
9170 problem is that we can't really tell whether the line
9171 contains TO_Y before we have completely scanned it, and
9172 this may skip past TO_X. What we do is to first scan to
9175 If TO_X is not specified, use a TO_X of zero. The reason
9176 is to make the outcome of this function more predictable.
9177 If we didn't use TO_X == 0, we would stop at the end of
9178 the line which is probably not what a caller would expect
9180 skip
= move_it_in_display_line_to
9181 (it
, to_charpos
, ((op
& MOVE_TO_X
) ? to_x
: 0),
9182 (MOVE_TO_X
| (op
& MOVE_TO_POS
)));
9184 /* If TO_CHARPOS is reached or ZV, we don't have to do more. */
9185 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9187 else if (skip
== MOVE_X_REACHED
)
9189 /* If TO_X was reached, we want to know whether TO_Y is
9190 in the line. We know this is the case if the already
9191 scanned glyphs make the line tall enough. Otherwise,
9192 we must check by scanning the rest of the line. */
9193 line_height
= it
->max_ascent
+ it
->max_descent
;
9194 if (to_y
>= it
->current_y
9195 && to_y
< it
->current_y
+ line_height
)
9200 SAVE_IT (it_backup
, *it
, backup_data
);
9201 TRACE_MOVE ((stderr
, "move_it: from %d\n", IT_CHARPOS (*it
)));
9202 skip2
= move_it_in_display_line_to (it
, to_charpos
, -1,
9204 TRACE_MOVE ((stderr
, "move_it: to %d\n", IT_CHARPOS (*it
)));
9205 line_height
= it
->max_ascent
+ it
->max_descent
;
9206 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9208 if (to_y
>= it
->current_y
9209 && to_y
< it
->current_y
+ line_height
)
9211 /* If TO_Y is in this line and TO_X was reached
9212 above, we scanned too far. We have to restore
9213 IT's settings to the ones before skipping. But
9214 keep the more accurate values of max_ascent and
9215 max_descent we've found while skipping the rest
9216 of the line, for the sake of callers, such as
9217 pos_visible_p, that need to know the line
9219 int max_ascent
= it
->max_ascent
;
9220 int max_descent
= it
->max_descent
;
9222 RESTORE_IT (it
, &it_backup
, backup_data
);
9223 it
->max_ascent
= max_ascent
;
9224 it
->max_descent
= max_descent
;
9230 if (skip
== MOVE_POS_MATCH_OR_ZV
)
9236 /* Check whether TO_Y is in this line. */
9237 line_height
= it
->max_ascent
+ it
->max_descent
;
9238 TRACE_MOVE ((stderr
, "move_it: line_height = %d\n", line_height
));
9240 if (to_y
>= it
->current_y
9241 && to_y
< it
->current_y
+ line_height
)
9243 if (to_y
> it
->current_y
)
9244 max_current_x
= max (it
->current_x
, max_current_x
);
9246 /* When word-wrap is on, TO_X may lie past the end
9247 of a wrapped line. Then it->current is the
9248 character on the next line, so backtrack to the
9249 space before the wrap point. */
9250 if (skip
== MOVE_LINE_CONTINUED
9251 && it
->line_wrap
== WORD_WRAP
)
9253 int prev_x
= max (it
->current_x
- 1, 0);
9254 RESTORE_IT (it
, &it_backup
, backup_data
);
9255 skip
= move_it_in_display_line_to
9256 (it
, -1, prev_x
, MOVE_TO_X
);
9265 max_current_x
= max (it
->current_x
, max_current_x
);
9269 else if (BUFFERP (it
->object
)
9270 && (it
->method
== GET_FROM_BUFFER
9271 || it
->method
== GET_FROM_STRETCH
)
9272 && IT_CHARPOS (*it
) >= to_charpos
9273 /* Under bidi iteration, a call to set_iterator_to_next
9274 can scan far beyond to_charpos if the initial
9275 portion of the next line needs to be reordered. In
9276 that case, give move_it_in_display_line_to another
9279 && it
->bidi_it
.scan_dir
== -1))
9280 skip
= MOVE_POS_MATCH_OR_ZV
;
9282 skip
= move_it_in_display_line_to (it
, to_charpos
, -1, MOVE_TO_POS
);
9286 case MOVE_POS_MATCH_OR_ZV
:
9287 max_current_x
= max (it
->current_x
, max_current_x
);
9291 case MOVE_NEWLINE_OR_CR
:
9292 max_current_x
= max (it
->current_x
, max_current_x
);
9293 set_iterator_to_next (it
, 1);
9294 it
->continuation_lines_width
= 0;
9297 case MOVE_LINE_TRUNCATED
:
9298 max_current_x
= it
->last_visible_x
;
9299 it
->continuation_lines_width
= 0;
9300 reseat_at_next_visible_line_start (it
, 0);
9301 if ((op
& MOVE_TO_POS
) != 0
9302 && IT_CHARPOS (*it
) > to_charpos
)
9309 case MOVE_LINE_CONTINUED
:
9310 max_current_x
= it
->last_visible_x
;
9311 /* For continued lines ending in a tab, some of the glyphs
9312 associated with the tab are displayed on the current
9313 line. Since it->current_x does not include these glyphs,
9314 we use it->last_visible_x instead. */
9317 it
->continuation_lines_width
+= it
->last_visible_x
;
9318 /* When moving by vpos, ensure that the iterator really
9319 advances to the next line (bug#847, bug#969). Fixme:
9320 do we need to do this in other circumstances? */
9321 if (it
->current_x
!= it
->last_visible_x
9322 && (op
& MOVE_TO_VPOS
)
9323 && !(op
& (MOVE_TO_X
| MOVE_TO_POS
)))
9325 line_start_x
= it
->current_x
+ it
->pixel_width
9326 - it
->last_visible_x
;
9327 if (FRAME_WINDOW_P (it
->f
))
9329 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
9330 struct font
*face_font
= face
->font
;
9332 /* When display_line produces a continued line
9333 that ends in a TAB, it skips a tab stop that
9334 is closer than the font's space character
9335 width (see x_produce_glyphs where it produces
9336 the stretch glyph which represents a TAB).
9337 We need to reproduce the same logic here. */
9338 eassert (face_font
);
9341 if (line_start_x
< face_font
->space_width
)
9343 += it
->tab_width
* face_font
->space_width
;
9346 set_iterator_to_next (it
, 0);
9350 it
->continuation_lines_width
+= it
->current_x
;
9357 /* Reset/increment for the next run. */
9358 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
9359 it
->current_x
= line_start_x
;
9362 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9364 last_height
= it
->max_ascent
+ it
->max_descent
;
9365 it
->max_ascent
= it
->max_descent
= 0;
9370 /* On text terminals, we may stop at the end of a line in the middle
9371 of a multi-character glyph. If the glyph itself is continued,
9372 i.e. it is actually displayed on the next line, don't treat this
9373 stopping point as valid; move to the next line instead (unless
9374 that brings us offscreen). */
9375 if (!FRAME_WINDOW_P (it
->f
)
9377 && IT_CHARPOS (*it
) == to_charpos
9378 && it
->what
== IT_CHARACTER
9380 && it
->line_wrap
== WINDOW_WRAP
9381 && it
->current_x
== it
->last_visible_x
- 1
9384 && it
->vpos
< it
->w
->window_end_vpos
)
9386 it
->continuation_lines_width
+= it
->current_x
;
9387 it
->current_x
= it
->hpos
= it
->max_ascent
= it
->max_descent
= 0;
9388 it
->current_y
+= it
->max_ascent
+ it
->max_descent
;
9390 last_height
= it
->max_ascent
+ it
->max_descent
;
9394 bidi_unshelve_cache (backup_data
, 1);
9396 TRACE_MOVE ((stderr
, "move_it_to: reached %d\n", reached
));
9398 return max_current_x
;
9402 /* Move iterator IT backward by a specified y-distance DY, DY >= 0.
9404 If DY > 0, move IT backward at least that many pixels. DY = 0
9405 means move IT backward to the preceding line start or BEGV. This
9406 function may move over more than DY pixels if IT->current_y - DY
9407 ends up in the middle of a line; in this case IT->current_y will be
9408 set to the top of the line moved to. */
9411 move_it_vertically_backward (struct it
*it
, int dy
)
9415 void *it2data
= NULL
, *it3data
= NULL
;
9416 ptrdiff_t start_pos
;
9418 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9419 ptrdiff_t pos_limit
;
9424 start_pos
= IT_CHARPOS (*it
);
9426 /* Estimate how many newlines we must move back. */
9427 nlines
= max (1, dy
/ default_line_pixel_height (it
->w
));
9428 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9431 pos_limit
= max (start_pos
- nlines
* nchars_per_row
, BEGV
);
9433 /* Set the iterator's position that many lines back. But don't go
9434 back more than NLINES full screen lines -- this wins a day with
9435 buffers which have very long lines. */
9436 while (nlines
-- && IT_CHARPOS (*it
) > pos_limit
)
9437 back_to_previous_visible_line_start (it
);
9439 /* Reseat the iterator here. When moving backward, we don't want
9440 reseat to skip forward over invisible text, set up the iterator
9441 to deliver from overlay strings at the new position etc. So,
9442 use reseat_1 here. */
9443 reseat_1 (it
, it
->current
.pos
, 1);
9445 /* We are now surely at a line start. */
9446 it
->current_x
= it
->hpos
= 0; /* FIXME: this is incorrect when bidi
9447 reordering is in effect. */
9448 it
->continuation_lines_width
= 0;
9450 /* Move forward and see what y-distance we moved. First move to the
9451 start of the next line so that we get its height. We need this
9452 height to be able to tell whether we reached the specified
9454 SAVE_IT (it2
, *it
, it2data
);
9455 it2
.max_ascent
= it2
.max_descent
= 0;
9458 move_it_to (&it2
, start_pos
, -1, -1, it2
.vpos
+ 1,
9459 MOVE_TO_POS
| MOVE_TO_VPOS
);
9461 while (!(IT_POS_VALID_AFTER_MOVE_P (&it2
)
9462 /* If we are in a display string which starts at START_POS,
9463 and that display string includes a newline, and we are
9464 right after that newline (i.e. at the beginning of a
9465 display line), exit the loop, because otherwise we will
9466 infloop, since move_it_to will see that it is already at
9467 START_POS and will not move. */
9468 || (it2
.method
== GET_FROM_STRING
9469 && IT_CHARPOS (it2
) == start_pos
9470 && SREF (it2
.string
, IT_STRING_BYTEPOS (it2
) - 1) == '\n')));
9471 eassert (IT_CHARPOS (*it
) >= BEGV
);
9472 SAVE_IT (it3
, it2
, it3data
);
9474 move_it_to (&it2
, start_pos
, -1, -1, -1, MOVE_TO_POS
);
9475 eassert (IT_CHARPOS (*it
) >= BEGV
);
9476 /* H is the actual vertical distance from the position in *IT
9477 and the starting position. */
9478 h
= it2
.current_y
- it
->current_y
;
9479 /* NLINES is the distance in number of lines. */
9480 nlines
= it2
.vpos
- it
->vpos
;
9482 /* Correct IT's y and vpos position
9483 so that they are relative to the starting point. */
9489 /* DY == 0 means move to the start of the screen line. The
9490 value of nlines is > 0 if continuation lines were involved,
9491 or if the original IT position was at start of a line. */
9492 RESTORE_IT (it
, it
, it2data
);
9494 move_it_by_lines (it
, nlines
);
9495 /* The above code moves us to some position NLINES down,
9496 usually to its first glyph (leftmost in an L2R line), but
9497 that's not necessarily the start of the line, under bidi
9498 reordering. We want to get to the character position
9499 that is immediately after the newline of the previous
9502 && !it
->continuation_lines_width
9503 && !STRINGP (it
->string
)
9504 && IT_CHARPOS (*it
) > BEGV
9505 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9507 ptrdiff_t cp
= IT_CHARPOS (*it
), bp
= IT_BYTEPOS (*it
);
9510 cp
= find_newline_no_quit (cp
, bp
, -1, NULL
);
9511 move_it_to (it
, cp
, -1, -1, -1, MOVE_TO_POS
);
9513 bidi_unshelve_cache (it3data
, 1);
9517 /* The y-position we try to reach, relative to *IT.
9518 Note that H has been subtracted in front of the if-statement. */
9519 int target_y
= it
->current_y
+ h
- dy
;
9520 int y0
= it3
.current_y
;
9524 RESTORE_IT (&it3
, &it3
, it3data
);
9525 y1
= line_bottom_y (&it3
);
9526 line_height
= y1
- y0
;
9527 RESTORE_IT (it
, it
, it2data
);
9528 /* If we did not reach target_y, try to move further backward if
9529 we can. If we moved too far backward, try to move forward. */
9530 if (target_y
< it
->current_y
9531 /* This is heuristic. In a window that's 3 lines high, with
9532 a line height of 13 pixels each, recentering with point
9533 on the bottom line will try to move -39/2 = 19 pixels
9534 backward. Try to avoid moving into the first line. */
9535 && (it
->current_y
- target_y
9536 > min (window_box_height (it
->w
), line_height
* 2 / 3))
9537 && IT_CHARPOS (*it
) > BEGV
)
9539 TRACE_MOVE ((stderr
, " not far enough -> move_vert %d\n",
9540 target_y
- it
->current_y
));
9541 dy
= it
->current_y
- target_y
;
9542 goto move_further_back
;
9544 else if (target_y
>= it
->current_y
+ line_height
9545 && IT_CHARPOS (*it
) < ZV
)
9547 /* Should move forward by at least one line, maybe more.
9549 Note: Calling move_it_by_lines can be expensive on
9550 terminal frames, where compute_motion is used (via
9551 vmotion) to do the job, when there are very long lines
9552 and truncate-lines is nil. That's the reason for
9553 treating terminal frames specially here. */
9555 if (!FRAME_WINDOW_P (it
->f
))
9556 move_it_vertically (it
, target_y
- (it
->current_y
+ line_height
));
9561 move_it_by_lines (it
, 1);
9563 while (target_y
>= line_bottom_y (it
) && IT_CHARPOS (*it
) < ZV
);
9570 /* Move IT by a specified amount of pixel lines DY. DY negative means
9571 move backwards. DY = 0 means move to start of screen line. At the
9572 end, IT will be on the start of a screen line. */
9575 move_it_vertically (struct it
*it
, int dy
)
9578 move_it_vertically_backward (it
, -dy
);
9581 TRACE_MOVE ((stderr
, "move_it_v: from %d, %d\n", IT_CHARPOS (*it
), dy
));
9582 move_it_to (it
, ZV
, -1, it
->current_y
+ dy
, -1,
9583 MOVE_TO_POS
| MOVE_TO_Y
);
9584 TRACE_MOVE ((stderr
, "move_it_v: to %d\n", IT_CHARPOS (*it
)));
9586 /* If buffer ends in ZV without a newline, move to the start of
9587 the line to satisfy the post-condition. */
9588 if (IT_CHARPOS (*it
) == ZV
9590 && FETCH_BYTE (IT_BYTEPOS (*it
) - 1) != '\n')
9591 move_it_by_lines (it
, 0);
9596 /* Move iterator IT past the end of the text line it is in. */
9599 move_it_past_eol (struct it
*it
)
9601 enum move_it_result rc
;
9603 rc
= move_it_in_display_line_to (it
, Z
, 0, MOVE_TO_POS
);
9604 if (rc
== MOVE_NEWLINE_OR_CR
)
9605 set_iterator_to_next (it
, 0);
9609 /* Move IT by a specified number DVPOS of screen lines down. DVPOS
9610 negative means move up. DVPOS == 0 means move to the start of the
9613 Optimization idea: If we would know that IT->f doesn't use
9614 a face with proportional font, we could be faster for
9615 truncate-lines nil. */
9618 move_it_by_lines (struct it
*it
, ptrdiff_t dvpos
)
9621 /* The commented-out optimization uses vmotion on terminals. This
9622 gives bad results, because elements like it->what, on which
9623 callers such as pos_visible_p rely, aren't updated. */
9624 /* struct position pos;
9625 if (!FRAME_WINDOW_P (it->f))
9627 struct text_pos textpos;
9629 pos = *vmotion (IT_CHARPOS (*it), dvpos, it->w);
9630 SET_TEXT_POS (textpos, pos.bufpos, pos.bytepos);
9631 reseat (it, textpos, 1);
9632 it->vpos += pos.vpos;
9633 it->current_y += pos.vpos;
9639 /* DVPOS == 0 means move to the start of the screen line. */
9640 move_it_vertically_backward (it
, 0);
9641 /* Let next call to line_bottom_y calculate real line height. */
9646 move_it_to (it
, -1, -1, -1, it
->vpos
+ dvpos
, MOVE_TO_VPOS
);
9647 if (!IT_POS_VALID_AFTER_MOVE_P (it
))
9649 /* Only move to the next buffer position if we ended up in a
9650 string from display property, not in an overlay string
9651 (before-string or after-string). That is because the
9652 latter don't conceal the underlying buffer position, so
9653 we can ask to move the iterator to the exact position we
9654 are interested in. Note that, even if we are already at
9655 IT_CHARPOS (*it), the call below is not a no-op, as it
9656 will detect that we are at the end of the string, pop the
9657 iterator, and compute it->current_x and it->hpos
9659 move_it_to (it
, IT_CHARPOS (*it
) + it
->string_from_display_prop_p
,
9660 -1, -1, -1, MOVE_TO_POS
);
9666 void *it2data
= NULL
;
9667 ptrdiff_t start_charpos
, i
;
9669 = (it
->last_visible_x
- it
->first_visible_x
) / FRAME_COLUMN_WIDTH (it
->f
);
9670 bool hit_pos_limit
= false;
9671 ptrdiff_t pos_limit
;
9673 /* Start at the beginning of the screen line containing IT's
9674 position. This may actually move vertically backwards,
9675 in case of overlays, so adjust dvpos accordingly. */
9677 move_it_vertically_backward (it
, 0);
9680 /* Go back -DVPOS buffer lines, but no farther than -DVPOS full
9681 screen lines, and reseat the iterator there. */
9682 start_charpos
= IT_CHARPOS (*it
);
9683 if (it
->line_wrap
== TRUNCATE
|| nchars_per_row
== 0)
9686 pos_limit
= max (start_charpos
+ dvpos
* nchars_per_row
, BEGV
);
9688 for (i
= -dvpos
; i
> 0 && IT_CHARPOS (*it
) > pos_limit
; --i
)
9689 back_to_previous_visible_line_start (it
);
9690 if (i
> 0 && IT_CHARPOS (*it
) <= pos_limit
)
9691 hit_pos_limit
= true;
9692 reseat (it
, it
->current
.pos
, 1);
9694 /* Move further back if we end up in a string or an image. */
9695 while (!IT_POS_VALID_AFTER_MOVE_P (it
))
9697 /* First try to move to start of display line. */
9699 move_it_vertically_backward (it
, 0);
9701 if (IT_POS_VALID_AFTER_MOVE_P (it
))
9703 /* If start of line is still in string or image,
9704 move further back. */
9705 back_to_previous_visible_line_start (it
);
9706 reseat (it
, it
->current
.pos
, 1);
9710 it
->current_x
= it
->hpos
= 0;
9712 /* Above call may have moved too far if continuation lines
9713 are involved. Scan forward and see if it did. */
9714 SAVE_IT (it2
, *it
, it2data
);
9715 it2
.vpos
= it2
.current_y
= 0;
9716 move_it_to (&it2
, start_charpos
, -1, -1, -1, MOVE_TO_POS
);
9717 it
->vpos
-= it2
.vpos
;
9718 it
->current_y
-= it2
.current_y
;
9719 it
->current_x
= it
->hpos
= 0;
9721 /* If we moved too far back, move IT some lines forward. */
9722 if (it2
.vpos
> -dvpos
)
9724 int delta
= it2
.vpos
+ dvpos
;
9726 RESTORE_IT (&it2
, &it2
, it2data
);
9727 SAVE_IT (it2
, *it
, it2data
);
9728 move_it_to (it
, -1, -1, -1, it
->vpos
+ delta
, MOVE_TO_VPOS
);
9729 /* Move back again if we got too far ahead. */
9730 if (IT_CHARPOS (*it
) >= start_charpos
)
9731 RESTORE_IT (it
, &it2
, it2data
);
9733 bidi_unshelve_cache (it2data
, 1);
9735 else if (hit_pos_limit
&& pos_limit
> BEGV
9736 && dvpos
< 0 && it2
.vpos
< -dvpos
)
9738 /* If we hit the limit, but still didn't make it far enough
9739 back, that means there's a display string with a newline
9740 covering a large chunk of text, and that caused
9741 back_to_previous_visible_line_start try to go too far.
9742 Punish those who commit such atrocities by going back
9743 until we've reached DVPOS, after lifting the limit, which
9744 could make it slow for very long lines. "If it hurts,
9747 RESTORE_IT (it
, it
, it2data
);
9748 for (i
= -dvpos
; i
> 0; --i
)
9750 back_to_previous_visible_line_start (it
);
9753 reseat_1 (it
, it
->current
.pos
, 1);
9756 RESTORE_IT (it
, it
, it2data
);
9760 /* Return true if IT points into the middle of a display vector. */
9763 in_display_vector_p (struct it
*it
)
9765 return (it
->method
== GET_FROM_DISPLAY_VECTOR
9766 && it
->current
.dpvec_index
> 0
9767 && it
->dpvec
+ it
->current
.dpvec_index
!= it
->dpend
);
9770 DEFUN ("window-text-pixel-size", Fwindow_text_pixel_size
, Swindow_text_pixel_size
, 0, 6, 0,
9771 doc
: /* Return the size of the text of WINDOW's buffer in pixels.
9772 WINDOW must be a live window and defaults to the selected one. The
9773 return value is a cons of the maximum pixel-width of any text line and
9774 the maximum pixel-height of all text lines.
9776 The optional argument FROM, if non-nil, specifies the first text
9777 position and defaults to the minimum accessible position of the buffer.
9778 If FROM is t, use the minimum accessible position that is not a newline
9779 character. TO, if non-nil, specifies the last text position and
9780 defaults to the maximum accessible position of the buffer. If TO is t,
9781 use the maximum accessible position that is not a newline character.
9783 The optional argument X-LIMIT, if non-nil, specifies the maximum text
9784 width that can be returned. X-LIMIT nil or omitted, means to use the
9785 pixel-width of WINDOW's body; use this if you do not intend to change
9786 the width of WINDOW. Use the maximum width WINDOW may assume if you
9787 intend to change WINDOW's width. In any case, text whose x-coordinate
9788 is beyond X-LIMIT is ignored. Since calculating the width of long lines
9789 can take some time, it's always a good idea to make this argument as
9790 small as possible; in particular, if the buffer contains long lines that
9791 shall be truncated anyway.
9793 The optional argument Y-LIMIT, if non-nil, specifies the maximum text
9794 height that can be returned. Text lines whose y-coordinate is beyond
9795 Y-LIMIT are ignored. Since calculating the text height of a large
9796 buffer can take some time, it makes sense to specify this argument if
9797 the size of the buffer is unknown.
9799 Optional argument MODE-AND-HEADER-LINE nil or omitted means do not
9800 include the height of the mode- or header-line of WINDOW in the return
9801 value. If it is either the symbol `mode-line' or `header-line', include
9802 only the height of that line, if present, in the return value. If t,
9803 include the height of both, if present, in the return value. */)
9804 (Lisp_Object window
, Lisp_Object from
, Lisp_Object to
, Lisp_Object x_limit
, Lisp_Object y_limit
,
9805 Lisp_Object mode_and_header_line
)
9807 struct window
*w
= decode_live_window (window
);
9811 struct buffer
*old_buffer
= NULL
;
9812 ptrdiff_t start
, end
, pos
;
9813 struct text_pos startp
;
9814 void *itdata
= NULL
;
9815 int c
, max_y
= -1, x
= 0, y
= 0;
9821 if (b
!= current_buffer
)
9823 old_buffer
= current_buffer
;
9824 set_buffer_internal (b
);
9829 else if (EQ (from
, Qt
))
9832 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
))
9833 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9835 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9840 CHECK_NUMBER_COERCE_MARKER (from
);
9841 start
= min (max (XINT (from
), BEGV
), ZV
);
9846 else if (EQ (to
, Qt
))
9849 while ((pos
-- > BEGV
) && (c
= FETCH_CHAR (pos
))
9850 && (c
== ' ' || c
== '\t' || c
== '\n' || c
== '\r'))
9852 while ((pos
++ < ZV
) && (c
= FETCH_CHAR (pos
)) && (c
== ' ' || c
== '\t'))
9857 CHECK_NUMBER_COERCE_MARKER (to
);
9858 end
= max (start
, min (XINT (to
), ZV
));
9861 if (!NILP (y_limit
))
9863 CHECK_NUMBER (y_limit
);
9864 max_y
= min (XINT (y_limit
), INT_MAX
);
9867 itdata
= bidi_shelve_cache ();
9868 SET_TEXT_POS (startp
, start
, CHAR_TO_BYTE (start
));
9869 start_display (&it
, w
, startp
);
9872 x
= move_it_to (&it
, end
, -1, max_y
, -1, MOVE_TO_POS
| MOVE_TO_Y
);
9875 CHECK_NUMBER (x_limit
);
9876 it
.last_visible_x
= min (XINT (x_limit
), INFINITY
);
9877 /* Actually, we never want move_it_to stop at to_x. But to make
9878 sure that move_it_in_display_line_to always moves far enough,
9879 we set it to INT_MAX and specify MOVE_TO_X. */
9880 x
= move_it_to (&it
, end
, INT_MAX
, max_y
, -1,
9881 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
9884 y
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
9886 if (!EQ (mode_and_header_line
, Qheader_line
)
9887 && !EQ (mode_and_header_line
, Qt
))
9888 /* Do not count the header-line which was counted automatically by
9890 y
= y
- WINDOW_HEADER_LINE_HEIGHT (w
);
9892 if (EQ (mode_and_header_line
, Qmode_line
)
9893 || EQ (mode_and_header_line
, Qt
))
9894 /* Do count the mode-line which is not included automatically by
9896 y
= y
+ WINDOW_MODE_LINE_HEIGHT (w
);
9898 bidi_unshelve_cache (itdata
, 0);
9901 set_buffer_internal (old_buffer
);
9903 return Fcons (make_number (x
), make_number (y
));
9906 /***********************************************************************
9908 ***********************************************************************/
9911 /* Add a message with format string FORMAT and arguments ARG1 and ARG2
9915 add_to_log (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
9917 Lisp_Object args
[3];
9918 Lisp_Object msg
, fmt
;
9921 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9925 GCPRO4 (fmt
, msg
, arg1
, arg2
);
9927 args
[0] = fmt
= build_string (format
);
9930 msg
= Fformat (3, args
);
9932 len
= SBYTES (msg
) + 1;
9933 buffer
= SAFE_ALLOCA (len
);
9934 memcpy (buffer
, SDATA (msg
), len
);
9936 message_dolog (buffer
, len
- 1, 1, 0);
9943 /* Output a newline in the *Messages* buffer if "needs" one. */
9946 message_log_maybe_newline (void)
9948 if (message_log_need_newline
)
9949 message_dolog ("", 0, 1, 0);
9953 /* Add a string M of length NBYTES to the message log, optionally
9954 terminated with a newline when NLFLAG is true. MULTIBYTE, if
9955 true, means interpret the contents of M as multibyte. This
9956 function calls low-level routines in order to bypass text property
9957 hooks, etc. which might not be safe to run.
9959 This may GC (insert may run before/after change hooks),
9960 so the buffer M must NOT point to a Lisp string. */
9963 message_dolog (const char *m
, ptrdiff_t nbytes
, bool nlflag
, bool multibyte
)
9965 const unsigned char *msg
= (const unsigned char *) m
;
9967 if (!NILP (Vmemory_full
))
9970 if (!NILP (Vmessage_log_max
))
9972 struct buffer
*oldbuf
;
9973 Lisp_Object oldpoint
, oldbegv
, oldzv
;
9974 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
9975 ptrdiff_t point_at_end
= 0;
9976 ptrdiff_t zv_at_end
= 0;
9977 Lisp_Object old_deactivate_mark
;
9978 struct gcpro gcpro1
;
9980 old_deactivate_mark
= Vdeactivate_mark
;
9981 oldbuf
= current_buffer
;
9983 /* Ensure the Messages buffer exists, and switch to it.
9984 If we created it, set the major-mode. */
9987 if (NILP (Fget_buffer (Vmessages_buffer_name
))) newbuffer
= 1;
9989 Fset_buffer (Fget_buffer_create (Vmessages_buffer_name
));
9992 && !NILP (Ffboundp (intern ("messages-buffer-mode"))))
9993 call0 (intern ("messages-buffer-mode"));
9996 bset_undo_list (current_buffer
, Qt
);
9997 bset_cache_long_scans (current_buffer
, Qnil
);
9999 oldpoint
= message_dolog_marker1
;
10000 set_marker_restricted_both (oldpoint
, Qnil
, PT
, PT_BYTE
);
10001 oldbegv
= message_dolog_marker2
;
10002 set_marker_restricted_both (oldbegv
, Qnil
, BEGV
, BEGV_BYTE
);
10003 oldzv
= message_dolog_marker3
;
10004 set_marker_restricted_both (oldzv
, Qnil
, ZV
, ZV_BYTE
);
10005 GCPRO1 (old_deactivate_mark
);
10013 BEGV_BYTE
= BEG_BYTE
;
10016 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10018 /* Insert the string--maybe converting multibyte to single byte
10019 or vice versa, so that all the text fits the buffer. */
10021 && NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10027 /* Convert a multibyte string to single-byte
10028 for the *Message* buffer. */
10029 for (i
= 0; i
< nbytes
; i
+= char_bytes
)
10031 c
= string_char_and_length (msg
+ i
, &char_bytes
);
10032 work
[0] = CHAR_TO_BYTE8 (c
);
10033 insert_1_both (work
, 1, 1, 1, 0, 0);
10036 else if (! multibyte
10037 && ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10041 unsigned char str
[MAX_MULTIBYTE_LENGTH
];
10042 /* Convert a single-byte string to multibyte
10043 for the *Message* buffer. */
10044 for (i
= 0; i
< nbytes
; i
++)
10047 MAKE_CHAR_MULTIBYTE (c
);
10048 char_bytes
= CHAR_STRING (c
, str
);
10049 insert_1_both ((char *) str
, 1, char_bytes
, 1, 0, 0);
10053 insert_1_both (m
, chars_in_text (msg
, nbytes
), nbytes
, 1, 0, 0);
10057 ptrdiff_t this_bol
, this_bol_byte
, prev_bol
, prev_bol_byte
;
10060 insert_1_both ("\n", 1, 1, 1, 0, 0);
10062 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10064 this_bol_byte
= PT_BYTE
;
10066 /* See if this line duplicates the previous one.
10067 If so, combine duplicates. */
10068 if (this_bol
> BEG
)
10070 scan_newline (PT
, PT_BYTE
, BEG
, BEG_BYTE
, -2, 0);
10072 prev_bol_byte
= PT_BYTE
;
10074 dups
= message_log_check_duplicate (prev_bol_byte
,
10078 del_range_both (prev_bol
, prev_bol_byte
,
10079 this_bol
, this_bol_byte
, 0);
10082 char dupstr
[sizeof " [ times]"
10083 + INT_STRLEN_BOUND (printmax_t
)];
10085 /* If you change this format, don't forget to also
10086 change message_log_check_duplicate. */
10087 int duplen
= sprintf (dupstr
, " [%"pMd
" times]", dups
);
10088 TEMP_SET_PT_BOTH (Z
- 1, Z_BYTE
- 1);
10089 insert_1_both (dupstr
, duplen
, duplen
, 1, 0, 1);
10094 /* If we have more than the desired maximum number of lines
10095 in the *Messages* buffer now, delete the oldest ones.
10096 This is safe because we don't have undo in this buffer. */
10098 if (NATNUMP (Vmessage_log_max
))
10100 scan_newline (Z
, Z_BYTE
, BEG
, BEG_BYTE
,
10101 -XFASTINT (Vmessage_log_max
) - 1, 0);
10102 del_range_both (BEG
, BEG_BYTE
, PT
, PT_BYTE
, 0);
10105 BEGV
= marker_position (oldbegv
);
10106 BEGV_BYTE
= marker_byte_position (oldbegv
);
10115 ZV
= marker_position (oldzv
);
10116 ZV_BYTE
= marker_byte_position (oldzv
);
10120 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
10122 /* We can't do Fgoto_char (oldpoint) because it will run some
10124 TEMP_SET_PT_BOTH (marker_position (oldpoint
),
10125 marker_byte_position (oldpoint
));
10128 unchain_marker (XMARKER (oldpoint
));
10129 unchain_marker (XMARKER (oldbegv
));
10130 unchain_marker (XMARKER (oldzv
));
10132 /* We called insert_1_both above with its 5th argument (PREPARE)
10133 zero, which prevents insert_1_both from calling
10134 prepare_to_modify_buffer, which in turns prevents us from
10135 incrementing windows_or_buffers_changed even if *Messages* is
10136 shown in some window. So we must manually set
10137 windows_or_buffers_changed here to make up for that. */
10138 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10139 bset_redisplay (current_buffer
);
10141 set_buffer_internal (oldbuf
);
10143 message_log_need_newline
= !nlflag
;
10144 Vdeactivate_mark
= old_deactivate_mark
;
10149 /* We are at the end of the buffer after just having inserted a newline.
10150 (Note: We depend on the fact we won't be crossing the gap.)
10151 Check to see if the most recent message looks a lot like the previous one.
10152 Return 0 if different, 1 if the new one should just replace it, or a
10153 value N > 1 if we should also append " [N times]". */
10156 message_log_check_duplicate (ptrdiff_t prev_bol_byte
, ptrdiff_t this_bol_byte
)
10159 ptrdiff_t len
= Z_BYTE
- 1 - this_bol_byte
;
10161 unsigned char *p1
= BUF_BYTE_ADDRESS (current_buffer
, prev_bol_byte
);
10162 unsigned char *p2
= BUF_BYTE_ADDRESS (current_buffer
, this_bol_byte
);
10164 for (i
= 0; i
< len
; i
++)
10166 if (i
>= 3 && p1
[i
- 3] == '.' && p1
[i
- 2] == '.' && p1
[i
- 1] == '.')
10168 if (p1
[i
] != p2
[i
])
10174 if (*p1
++ == ' ' && *p1
++ == '[')
10177 intmax_t n
= strtoimax ((char *) p1
, &pend
, 10);
10178 if (0 < n
&& n
< INTMAX_MAX
&& strncmp (pend
, " times]\n", 8) == 0)
10185 /* Display an echo area message M with a specified length of NBYTES
10186 bytes. The string may include null characters. If M is not a
10187 string, clear out any existing message, and let the mini-buffer
10190 This function cancels echoing. */
10193 message3 (Lisp_Object m
)
10195 struct gcpro gcpro1
;
10198 clear_message (true, true);
10201 /* First flush out any partial line written with print. */
10202 message_log_maybe_newline ();
10205 ptrdiff_t nbytes
= SBYTES (m
);
10206 bool multibyte
= STRING_MULTIBYTE (m
);
10209 SAFE_ALLOCA_STRING (buffer
, m
);
10210 message_dolog (buffer
, nbytes
, 1, multibyte
);
10213 message3_nolog (m
);
10219 /* The non-logging version of message3.
10220 This does not cancel echoing, because it is used for echoing.
10221 Perhaps we need to make a separate function for echoing
10222 and make this cancel echoing. */
10225 message3_nolog (Lisp_Object m
)
10227 struct frame
*sf
= SELECTED_FRAME ();
10229 if (FRAME_INITIAL_P (sf
))
10231 if (noninteractive_need_newline
)
10232 putc ('\n', stderr
);
10233 noninteractive_need_newline
= 0;
10236 Lisp_Object s
= ENCODE_SYSTEM (m
);
10238 fwrite (SDATA (s
), SBYTES (s
), 1, stderr
);
10240 if (cursor_in_echo_area
== 0)
10241 fprintf (stderr
, "\n");
10244 /* Error messages get reported properly by cmd_error, so this must be just an
10245 informative message; if the frame hasn't really been initialized yet, just
10247 else if (INTERACTIVE
&& sf
->glyphs_initialized_p
)
10249 /* Get the frame containing the mini-buffer
10250 that the selected frame is using. */
10251 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10252 Lisp_Object frame
= XWINDOW (mini_window
)->frame
;
10253 struct frame
*f
= XFRAME (frame
);
10255 if (FRAME_VISIBLE_P (sf
) && !FRAME_VISIBLE_P (f
))
10256 Fmake_frame_visible (frame
);
10258 if (STRINGP (m
) && SCHARS (m
) > 0)
10261 if (minibuffer_auto_raise
)
10262 Fraise_frame (frame
);
10263 /* Assume we are not echoing.
10264 (If we are, echo_now will override this.) */
10265 echo_message_buffer
= Qnil
;
10268 clear_message (true, true);
10270 do_pending_window_change (0);
10271 echo_area_display (1);
10272 do_pending_window_change (0);
10273 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
10274 (*FRAME_TERMINAL (f
)->frame_up_to_date_hook
) (f
);
10279 /* Display a null-terminated echo area message M. If M is 0, clear
10280 out any existing message, and let the mini-buffer text show through.
10282 The buffer M must continue to exist until after the echo area gets
10283 cleared or some other message gets displayed there. Do not pass
10284 text that is stored in a Lisp string. Do not pass text in a buffer
10285 that was alloca'd. */
10288 message1 (const char *m
)
10290 message3 (m
? build_unibyte_string (m
) : Qnil
);
10294 /* The non-logging counterpart of message1. */
10297 message1_nolog (const char *m
)
10299 message3_nolog (m
? build_unibyte_string (m
) : Qnil
);
10302 /* Display a message M which contains a single %s
10303 which gets replaced with STRING. */
10306 message_with_string (const char *m
, Lisp_Object string
, int log
)
10308 CHECK_STRING (string
);
10310 if (noninteractive
)
10314 /* ENCODE_SYSTEM below can GC and/or relocate the
10315 Lisp data, so make sure we don't use it here. */
10316 eassert (relocatable_string_data_p (m
) != 1);
10318 if (noninteractive_need_newline
)
10319 putc ('\n', stderr
);
10320 noninteractive_need_newline
= 0;
10321 fprintf (stderr
, m
, SDATA (ENCODE_SYSTEM (string
)));
10322 if (!cursor_in_echo_area
)
10323 fprintf (stderr
, "\n");
10327 else if (INTERACTIVE
)
10329 /* The frame whose minibuffer we're going to display the message on.
10330 It may be larger than the selected frame, so we need
10331 to use its buffer, not the selected frame's buffer. */
10332 Lisp_Object mini_window
;
10333 struct frame
*f
, *sf
= SELECTED_FRAME ();
10335 /* Get the frame containing the minibuffer
10336 that the selected frame is using. */
10337 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10338 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10340 /* Error messages get reported properly by cmd_error, so this must be
10341 just an informative message; if the frame hasn't really been
10342 initialized yet, just toss it. */
10343 if (f
->glyphs_initialized_p
)
10345 Lisp_Object args
[2], msg
;
10346 struct gcpro gcpro1
, gcpro2
;
10348 args
[0] = build_string (m
);
10349 args
[1] = msg
= string
;
10350 GCPRO2 (args
[0], msg
);
10353 msg
= Fformat (2, args
);
10358 message3_nolog (msg
);
10362 /* Print should start at the beginning of the message
10363 buffer next time. */
10364 message_buf_print
= 0;
10370 /* Dump an informative message to the minibuf. If M is 0, clear out
10371 any existing message, and let the mini-buffer text show through. */
10374 vmessage (const char *m
, va_list ap
)
10376 if (noninteractive
)
10380 if (noninteractive_need_newline
)
10381 putc ('\n', stderr
);
10382 noninteractive_need_newline
= 0;
10383 vfprintf (stderr
, m
, ap
);
10384 if (cursor_in_echo_area
== 0)
10385 fprintf (stderr
, "\n");
10389 else if (INTERACTIVE
)
10391 /* The frame whose mini-buffer we're going to display the message
10392 on. It may be larger than the selected frame, so we need to
10393 use its buffer, not the selected frame's buffer. */
10394 Lisp_Object mini_window
;
10395 struct frame
*f
, *sf
= SELECTED_FRAME ();
10397 /* Get the frame containing the mini-buffer
10398 that the selected frame is using. */
10399 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10400 f
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
10402 /* Error messages get reported properly by cmd_error, so this must be
10403 just an informative message; if the frame hasn't really been
10404 initialized yet, just toss it. */
10405 if (f
->glyphs_initialized_p
)
10410 ptrdiff_t maxsize
= FRAME_MESSAGE_BUF_SIZE (f
);
10412 char *message_buf
= SAFE_ALLOCA (maxsize
+ 1);
10414 len
= doprnt (message_buf
, maxsize
, m
, 0, ap
);
10416 message3 (make_string (message_buf
, len
));
10422 /* Print should start at the beginning of the message
10423 buffer next time. */
10424 message_buf_print
= 0;
10430 message (const char *m
, ...)
10440 /* The non-logging version of message. */
10443 message_nolog (const char *m
, ...)
10445 Lisp_Object old_log_max
;
10448 old_log_max
= Vmessage_log_max
;
10449 Vmessage_log_max
= Qnil
;
10451 Vmessage_log_max
= old_log_max
;
10457 /* Display the current message in the current mini-buffer. This is
10458 only called from error handlers in process.c, and is not time
10462 update_echo_area (void)
10464 if (!NILP (echo_area_buffer
[0]))
10466 Lisp_Object string
;
10467 string
= Fcurrent_message ();
10473 /* Make sure echo area buffers in `echo_buffers' are live.
10474 If they aren't, make new ones. */
10477 ensure_echo_area_buffers (void)
10481 for (i
= 0; i
< 2; ++i
)
10482 if (!BUFFERP (echo_buffer
[i
])
10483 || !BUFFER_LIVE_P (XBUFFER (echo_buffer
[i
])))
10486 Lisp_Object old_buffer
;
10489 old_buffer
= echo_buffer
[i
];
10490 echo_buffer
[i
] = Fget_buffer_create
10491 (make_formatted_string (name
, " *Echo Area %d*", i
));
10492 bset_truncate_lines (XBUFFER (echo_buffer
[i
]), Qnil
);
10493 /* to force word wrap in echo area -
10494 it was decided to postpone this*/
10495 /* XBUFFER (echo_buffer[i])->word_wrap = Qt; */
10497 for (j
= 0; j
< 2; ++j
)
10498 if (EQ (old_buffer
, echo_area_buffer
[j
]))
10499 echo_area_buffer
[j
] = echo_buffer
[i
];
10504 /* Call FN with args A1..A2 with either the current or last displayed
10505 echo_area_buffer as current buffer.
10507 WHICH zero means use the current message buffer
10508 echo_area_buffer[0]. If that is nil, choose a suitable buffer
10509 from echo_buffer[] and clear it.
10511 WHICH > 0 means use echo_area_buffer[1]. If that is nil, choose a
10512 suitable buffer from echo_buffer[] and clear it.
10514 If WHICH < 0, set echo_area_buffer[1] to echo_area_buffer[0], so
10515 that the current message becomes the last displayed one, make
10516 choose a suitable buffer for echo_area_buffer[0], and clear it.
10518 Value is what FN returns. */
10521 with_echo_area_buffer (struct window
*w
, int which
,
10522 int (*fn
) (ptrdiff_t, Lisp_Object
),
10523 ptrdiff_t a1
, Lisp_Object a2
)
10525 Lisp_Object buffer
;
10526 int this_one
, the_other
, clear_buffer_p
, rc
;
10527 ptrdiff_t count
= SPECPDL_INDEX ();
10529 /* If buffers aren't live, make new ones. */
10530 ensure_echo_area_buffers ();
10532 clear_buffer_p
= 0;
10535 this_one
= 0, the_other
= 1;
10536 else if (which
> 0)
10537 this_one
= 1, the_other
= 0;
10540 this_one
= 0, the_other
= 1;
10541 clear_buffer_p
= true;
10543 /* We need a fresh one in case the current echo buffer equals
10544 the one containing the last displayed echo area message. */
10545 if (!NILP (echo_area_buffer
[this_one
])
10546 && EQ (echo_area_buffer
[this_one
], echo_area_buffer
[the_other
]))
10547 echo_area_buffer
[this_one
] = Qnil
;
10550 /* Choose a suitable buffer from echo_buffer[] is we don't
10552 if (NILP (echo_area_buffer
[this_one
]))
10554 echo_area_buffer
[this_one
]
10555 = (EQ (echo_area_buffer
[the_other
], echo_buffer
[this_one
])
10556 ? echo_buffer
[the_other
]
10557 : echo_buffer
[this_one
]);
10558 clear_buffer_p
= true;
10561 buffer
= echo_area_buffer
[this_one
];
10563 /* Don't get confused by reusing the buffer used for echoing
10564 for a different purpose. */
10565 if (echo_kboard
== NULL
&& EQ (buffer
, echo_message_buffer
))
10568 record_unwind_protect (unwind_with_echo_area_buffer
,
10569 with_echo_area_buffer_unwind_data (w
));
10571 /* Make the echo area buffer current. Note that for display
10572 purposes, it is not necessary that the displayed window's buffer
10573 == current_buffer, except for text property lookup. So, let's
10574 only set that buffer temporarily here without doing a full
10575 Fset_window_buffer. We must also change w->pointm, though,
10576 because otherwise an assertions in unshow_buffer fails, and Emacs
10578 set_buffer_internal_1 (XBUFFER (buffer
));
10581 wset_buffer (w
, buffer
);
10582 set_marker_both (w
->pointm
, buffer
, BEG
, BEG_BYTE
);
10583 set_marker_both (w
->old_pointm
, buffer
, BEG
, BEG_BYTE
);
10586 bset_undo_list (current_buffer
, Qt
);
10587 bset_read_only (current_buffer
, Qnil
);
10588 specbind (Qinhibit_read_only
, Qt
);
10589 specbind (Qinhibit_modification_hooks
, Qt
);
10591 if (clear_buffer_p
&& Z
> BEG
)
10592 del_range (BEG
, Z
);
10594 eassert (BEGV
>= BEG
);
10595 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10599 eassert (BEGV
>= BEG
);
10600 eassert (ZV
<= Z
&& ZV
>= BEGV
);
10602 unbind_to (count
, Qnil
);
10607 /* Save state that should be preserved around the call to the function
10608 FN called in with_echo_area_buffer. */
10611 with_echo_area_buffer_unwind_data (struct window
*w
)
10614 Lisp_Object vector
, tmp
;
10616 /* Reduce consing by keeping one vector in
10617 Vwith_echo_area_save_vector. */
10618 vector
= Vwith_echo_area_save_vector
;
10619 Vwith_echo_area_save_vector
= Qnil
;
10622 vector
= Fmake_vector (make_number (11), Qnil
);
10624 XSETBUFFER (tmp
, current_buffer
); ASET (vector
, i
, tmp
); ++i
;
10625 ASET (vector
, i
, Vdeactivate_mark
); ++i
;
10626 ASET (vector
, i
, make_number (windows_or_buffers_changed
)); ++i
;
10630 XSETWINDOW (tmp
, w
); ASET (vector
, i
, tmp
); ++i
;
10631 ASET (vector
, i
, w
->contents
); ++i
;
10632 ASET (vector
, i
, make_number (marker_position (w
->pointm
))); ++i
;
10633 ASET (vector
, i
, make_number (marker_byte_position (w
->pointm
))); ++i
;
10634 ASET (vector
, i
, make_number (marker_position (w
->old_pointm
))); ++i
;
10635 ASET (vector
, i
, make_number (marker_byte_position (w
->old_pointm
))); ++i
;
10636 ASET (vector
, i
, make_number (marker_position (w
->start
))); ++i
;
10637 ASET (vector
, i
, make_number (marker_byte_position (w
->start
))); ++i
;
10642 for (; i
< end
; ++i
)
10643 ASET (vector
, i
, Qnil
);
10646 eassert (i
== ASIZE (vector
));
10651 /* Restore global state from VECTOR which was created by
10652 with_echo_area_buffer_unwind_data. */
10655 unwind_with_echo_area_buffer (Lisp_Object vector
)
10657 set_buffer_internal_1 (XBUFFER (AREF (vector
, 0)));
10658 Vdeactivate_mark
= AREF (vector
, 1);
10659 windows_or_buffers_changed
= XFASTINT (AREF (vector
, 2));
10661 if (WINDOWP (AREF (vector
, 3)))
10664 Lisp_Object buffer
;
10666 w
= XWINDOW (AREF (vector
, 3));
10667 buffer
= AREF (vector
, 4);
10669 wset_buffer (w
, buffer
);
10670 set_marker_both (w
->pointm
, buffer
,
10671 XFASTINT (AREF (vector
, 5)),
10672 XFASTINT (AREF (vector
, 6)));
10673 set_marker_both (w
->old_pointm
, buffer
,
10674 XFASTINT (AREF (vector
, 7)),
10675 XFASTINT (AREF (vector
, 8)));
10676 set_marker_both (w
->start
, buffer
,
10677 XFASTINT (AREF (vector
, 9)),
10678 XFASTINT (AREF (vector
, 10)));
10681 Vwith_echo_area_save_vector
= vector
;
10685 /* Set up the echo area for use by print functions. MULTIBYTE_P
10686 non-zero means we will print multibyte. */
10689 setup_echo_area_for_printing (int multibyte_p
)
10691 /* If we can't find an echo area any more, exit. */
10692 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
10693 Fkill_emacs (Qnil
);
10695 ensure_echo_area_buffers ();
10697 if (!message_buf_print
)
10699 /* A message has been output since the last time we printed.
10700 Choose a fresh echo area buffer. */
10701 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10702 echo_area_buffer
[0] = echo_buffer
[1];
10704 echo_area_buffer
[0] = echo_buffer
[0];
10706 /* Switch to that buffer and clear it. */
10707 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10708 bset_truncate_lines (current_buffer
, Qnil
);
10712 ptrdiff_t count
= SPECPDL_INDEX ();
10713 specbind (Qinhibit_read_only
, Qt
);
10714 /* Note that undo recording is always disabled. */
10715 del_range (BEG
, Z
);
10716 unbind_to (count
, Qnil
);
10718 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
10720 /* Set up the buffer for the multibyteness we need. */
10722 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
10723 Fset_buffer_multibyte (multibyte_p
? Qt
: Qnil
);
10725 /* Raise the frame containing the echo area. */
10726 if (minibuffer_auto_raise
)
10728 struct frame
*sf
= SELECTED_FRAME ();
10729 Lisp_Object mini_window
;
10730 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
10731 Fraise_frame (WINDOW_FRAME (XWINDOW (mini_window
)));
10734 message_log_maybe_newline ();
10735 message_buf_print
= 1;
10739 if (NILP (echo_area_buffer
[0]))
10741 if (EQ (echo_area_buffer
[1], echo_buffer
[0]))
10742 echo_area_buffer
[0] = echo_buffer
[1];
10744 echo_area_buffer
[0] = echo_buffer
[0];
10747 if (current_buffer
!= XBUFFER (echo_area_buffer
[0]))
10749 /* Someone switched buffers between print requests. */
10750 set_buffer_internal (XBUFFER (echo_area_buffer
[0]));
10751 bset_truncate_lines (current_buffer
, Qnil
);
10757 /* Display an echo area message in window W. Value is non-zero if W's
10758 height is changed. If display_last_displayed_message_p is
10759 non-zero, display the message that was last displayed, otherwise
10760 display the current message. */
10763 display_echo_area (struct window
*w
)
10765 int i
, no_message_p
, window_height_changed_p
;
10767 /* Temporarily disable garbage collections while displaying the echo
10768 area. This is done because a GC can print a message itself.
10769 That message would modify the echo area buffer's contents while a
10770 redisplay of the buffer is going on, and seriously confuse
10772 ptrdiff_t count
= inhibit_garbage_collection ();
10774 /* If there is no message, we must call display_echo_area_1
10775 nevertheless because it resizes the window. But we will have to
10776 reset the echo_area_buffer in question to nil at the end because
10777 with_echo_area_buffer will sets it to an empty buffer. */
10778 i
= display_last_displayed_message_p
? 1 : 0;
10779 no_message_p
= NILP (echo_area_buffer
[i
]);
10781 window_height_changed_p
10782 = with_echo_area_buffer (w
, display_last_displayed_message_p
,
10783 display_echo_area_1
,
10784 (intptr_t) w
, Qnil
);
10787 echo_area_buffer
[i
] = Qnil
;
10789 unbind_to (count
, Qnil
);
10790 return window_height_changed_p
;
10794 /* Helper for display_echo_area. Display the current buffer which
10795 contains the current echo area message in window W, a mini-window,
10796 a pointer to which is passed in A1. A2..A4 are currently not used.
10797 Change the height of W so that all of the message is displayed.
10798 Value is non-zero if height of W was changed. */
10801 display_echo_area_1 (ptrdiff_t a1
, Lisp_Object a2
)
10804 struct window
*w
= (struct window
*) i1
;
10805 Lisp_Object window
;
10806 struct text_pos start
;
10807 int window_height_changed_p
= 0;
10809 /* Do this before displaying, so that we have a large enough glyph
10810 matrix for the display. If we can't get enough space for the
10811 whole text, display the last N lines. That works by setting w->start. */
10812 window_height_changed_p
= resize_mini_window (w
, 0);
10814 /* Use the starting position chosen by resize_mini_window. */
10815 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
10818 clear_glyph_matrix (w
->desired_matrix
);
10819 XSETWINDOW (window
, w
);
10820 try_window (window
, start
, 0);
10822 return window_height_changed_p
;
10826 /* Resize the echo area window to exactly the size needed for the
10827 currently displayed message, if there is one. If a mini-buffer
10828 is active, don't shrink it. */
10831 resize_echo_area_exactly (void)
10833 if (BUFFERP (echo_area_buffer
[0])
10834 && WINDOWP (echo_area_window
))
10836 struct window
*w
= XWINDOW (echo_area_window
);
10837 Lisp_Object resize_exactly
= (minibuf_level
== 0 ? Qt
: Qnil
);
10838 int resized_p
= with_echo_area_buffer (w
, 0, resize_mini_window_1
,
10839 (intptr_t) w
, resize_exactly
);
10842 windows_or_buffers_changed
= 42;
10843 update_mode_lines
= 30;
10844 redisplay_internal ();
10850 /* Callback function for with_echo_area_buffer, when used from
10851 resize_echo_area_exactly. A1 contains a pointer to the window to
10852 resize, EXACTLY non-nil means resize the mini-window exactly to the
10853 size of the text displayed. A3 and A4 are not used. Value is what
10854 resize_mini_window returns. */
10857 resize_mini_window_1 (ptrdiff_t a1
, Lisp_Object exactly
)
10860 return resize_mini_window ((struct window
*) i1
, !NILP (exactly
));
10864 /* Resize mini-window W to fit the size of its contents. EXACT_P
10865 means size the window exactly to the size needed. Otherwise, it's
10866 only enlarged until W's buffer is empty.
10868 Set W->start to the right place to begin display. If the whole
10869 contents fit, start at the beginning. Otherwise, start so as
10870 to make the end of the contents appear. This is particularly
10871 important for y-or-n-p, but seems desirable generally.
10873 Value is non-zero if the window height has been changed. */
10876 resize_mini_window (struct window
*w
, int exact_p
)
10878 struct frame
*f
= XFRAME (w
->frame
);
10879 int window_height_changed_p
= 0;
10881 eassert (MINI_WINDOW_P (w
));
10883 /* By default, start display at the beginning. */
10884 set_marker_both (w
->start
, w
->contents
,
10885 BUF_BEGV (XBUFFER (w
->contents
)),
10886 BUF_BEGV_BYTE (XBUFFER (w
->contents
)));
10888 /* Don't resize windows while redisplaying a window; it would
10889 confuse redisplay functions when the size of the window they are
10890 displaying changes from under them. Such a resizing can happen,
10891 for instance, when which-func prints a long message while
10892 we are running fontification-functions. We're running these
10893 functions with safe_call which binds inhibit-redisplay to t. */
10894 if (!NILP (Vinhibit_redisplay
))
10897 /* Nil means don't try to resize. */
10898 if (NILP (Vresize_mini_windows
)
10899 || (FRAME_X_P (f
) && FRAME_X_OUTPUT (f
) == NULL
))
10902 if (!FRAME_MINIBUF_ONLY_P (f
))
10905 int total_height
= (WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f
)))
10906 + WINDOW_PIXEL_HEIGHT (w
));
10907 int unit
= FRAME_LINE_HEIGHT (f
);
10908 int height
, max_height
;
10909 struct text_pos start
;
10910 struct buffer
*old_current_buffer
= NULL
;
10912 if (current_buffer
!= XBUFFER (w
->contents
))
10914 old_current_buffer
= current_buffer
;
10915 set_buffer_internal (XBUFFER (w
->contents
));
10918 init_iterator (&it
, w
, BEGV
, BEGV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10920 /* Compute the max. number of lines specified by the user. */
10921 if (FLOATP (Vmax_mini_window_height
))
10922 max_height
= XFLOATINT (Vmax_mini_window_height
) * total_height
;
10923 else if (INTEGERP (Vmax_mini_window_height
))
10924 max_height
= XINT (Vmax_mini_window_height
) * unit
;
10926 max_height
= total_height
/ 4;
10928 /* Correct that max. height if it's bogus. */
10929 max_height
= clip_to_bounds (unit
, max_height
, total_height
);
10931 /* Find out the height of the text in the window. */
10932 if (it
.line_wrap
== TRUNCATE
)
10937 move_it_to (&it
, ZV
, -1, -1, -1, MOVE_TO_POS
);
10938 if (it
.max_ascent
== 0 && it
.max_descent
== 0)
10939 height
= it
.current_y
+ last_height
;
10941 height
= it
.current_y
+ it
.max_ascent
+ it
.max_descent
;
10942 height
-= min (it
.extra_line_spacing
, it
.max_extra_line_spacing
);
10945 /* Compute a suitable window start. */
10946 if (height
> max_height
)
10948 height
= (max_height
/ unit
) * unit
;
10949 init_iterator (&it
, w
, ZV
, ZV_BYTE
, NULL
, DEFAULT_FACE_ID
);
10950 move_it_vertically_backward (&it
, height
- unit
);
10951 start
= it
.current
.pos
;
10954 SET_TEXT_POS (start
, BEGV
, BEGV_BYTE
);
10955 SET_MARKER_FROM_TEXT_POS (w
->start
, start
);
10957 if (EQ (Vresize_mini_windows
, Qgrow_only
))
10959 /* Let it grow only, until we display an empty message, in which
10960 case the window shrinks again. */
10961 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10963 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10965 FRAME_WINDOWS_FROZEN (f
) = 1;
10966 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10967 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10969 else if (height
< WINDOW_PIXEL_HEIGHT (w
)
10970 && (exact_p
|| BEGV
== ZV
))
10972 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10974 FRAME_WINDOWS_FROZEN (f
) = 0;
10975 shrink_mini_window (w
, 1);
10976 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10981 /* Always resize to exact size needed. */
10982 if (height
> WINDOW_PIXEL_HEIGHT (w
))
10984 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10986 FRAME_WINDOWS_FROZEN (f
) = 1;
10987 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
10988 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
10990 else if (height
< WINDOW_PIXEL_HEIGHT (w
))
10992 int old_height
= WINDOW_PIXEL_HEIGHT (w
);
10994 FRAME_WINDOWS_FROZEN (f
) = 0;
10995 shrink_mini_window (w
, 1);
10999 FRAME_WINDOWS_FROZEN (f
) = 1;
11000 grow_mini_window (w
, height
- WINDOW_PIXEL_HEIGHT (w
), 1);
11003 window_height_changed_p
= WINDOW_PIXEL_HEIGHT (w
) != old_height
;
11007 if (old_current_buffer
)
11008 set_buffer_internal (old_current_buffer
);
11011 return window_height_changed_p
;
11015 /* Value is the current message, a string, or nil if there is no
11016 current message. */
11019 current_message (void)
11023 if (!BUFFERP (echo_area_buffer
[0]))
11027 with_echo_area_buffer (0, 0, current_message_1
,
11028 (intptr_t) &msg
, Qnil
);
11030 echo_area_buffer
[0] = Qnil
;
11038 current_message_1 (ptrdiff_t a1
, Lisp_Object a2
)
11041 Lisp_Object
*msg
= (Lisp_Object
*) i1
;
11044 *msg
= make_buffer_string (BEG
, Z
, 1);
11051 /* Push the current message on Vmessage_stack for later restoration
11052 by restore_message. Value is non-zero if the current message isn't
11053 empty. This is a relatively infrequent operation, so it's not
11054 worth optimizing. */
11057 push_message (void)
11059 Lisp_Object msg
= current_message ();
11060 Vmessage_stack
= Fcons (msg
, Vmessage_stack
);
11061 return STRINGP (msg
);
11065 /* Restore message display from the top of Vmessage_stack. */
11068 restore_message (void)
11070 eassert (CONSP (Vmessage_stack
));
11071 message3_nolog (XCAR (Vmessage_stack
));
11075 /* Handler for unwind-protect calling pop_message. */
11078 pop_message_unwind (void)
11080 /* Pop the top-most entry off Vmessage_stack. */
11081 eassert (CONSP (Vmessage_stack
));
11082 Vmessage_stack
= XCDR (Vmessage_stack
);
11086 /* Check that Vmessage_stack is nil. Called from emacs.c when Emacs
11087 exits. If the stack is not empty, we have a missing pop_message
11091 check_message_stack (void)
11093 if (!NILP (Vmessage_stack
))
11098 /* Truncate to NCHARS what will be displayed in the echo area the next
11099 time we display it---but don't redisplay it now. */
11102 truncate_echo_area (ptrdiff_t nchars
)
11105 echo_area_buffer
[0] = Qnil
;
11106 else if (!noninteractive
11108 && !NILP (echo_area_buffer
[0]))
11110 struct frame
*sf
= SELECTED_FRAME ();
11111 /* Error messages get reported properly by cmd_error, so this must be
11112 just an informative message; if the frame hasn't really been
11113 initialized yet, just toss it. */
11114 if (sf
->glyphs_initialized_p
)
11115 with_echo_area_buffer (0, 0, truncate_message_1
, nchars
, Qnil
);
11120 /* Helper function for truncate_echo_area. Truncate the current
11121 message to at most NCHARS characters. */
11124 truncate_message_1 (ptrdiff_t nchars
, Lisp_Object a2
)
11126 if (BEG
+ nchars
< Z
)
11127 del_range (BEG
+ nchars
, Z
);
11129 echo_area_buffer
[0] = Qnil
;
11133 /* Set the current message to STRING. */
11136 set_message (Lisp_Object string
)
11138 eassert (STRINGP (string
));
11140 message_enable_multibyte
= STRING_MULTIBYTE (string
);
11142 with_echo_area_buffer (0, -1, set_message_1
, 0, string
);
11143 message_buf_print
= 0;
11144 help_echo_showing_p
= 0;
11146 if (STRINGP (Vdebug_on_message
)
11147 && STRINGP (string
)
11148 && fast_string_match (Vdebug_on_message
, string
) >= 0)
11149 call_debugger (list2 (Qerror
, string
));
11153 /* Helper function for set_message. First argument is ignored and second
11154 argument has the same meaning as for set_message.
11155 This function is called with the echo area buffer being current. */
11158 set_message_1 (ptrdiff_t a1
, Lisp_Object string
)
11160 eassert (STRINGP (string
));
11162 /* Change multibyteness of the echo buffer appropriately. */
11163 if (message_enable_multibyte
11164 != !NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
11165 Fset_buffer_multibyte (message_enable_multibyte
? Qt
: Qnil
);
11167 bset_truncate_lines (current_buffer
, message_truncate_lines
? Qt
: Qnil
);
11168 if (!NILP (BVAR (current_buffer
, bidi_display_reordering
)))
11169 bset_bidi_paragraph_direction (current_buffer
, Qleft_to_right
);
11171 /* Insert new message at BEG. */
11172 TEMP_SET_PT_BOTH (BEG
, BEG_BYTE
);
11174 /* This function takes care of single/multibyte conversion.
11175 We just have to ensure that the echo area buffer has the right
11176 setting of enable_multibyte_characters. */
11177 insert_from_string (string
, 0, 0, SCHARS (string
), SBYTES (string
), 1);
11183 /* Clear messages. CURRENT_P non-zero means clear the current
11184 message. LAST_DISPLAYED_P non-zero means clear the message
11188 clear_message (bool current_p
, bool last_displayed_p
)
11192 echo_area_buffer
[0] = Qnil
;
11193 message_cleared_p
= true;
11196 if (last_displayed_p
)
11197 echo_area_buffer
[1] = Qnil
;
11199 message_buf_print
= 0;
11202 /* Clear garbaged frames.
11204 This function is used where the old redisplay called
11205 redraw_garbaged_frames which in turn called redraw_frame which in
11206 turn called clear_frame. The call to clear_frame was a source of
11207 flickering. I believe a clear_frame is not necessary. It should
11208 suffice in the new redisplay to invalidate all current matrices,
11209 and ensure a complete redisplay of all windows. */
11212 clear_garbaged_frames (void)
11214 if (frame_garbaged
)
11216 Lisp_Object tail
, frame
;
11218 FOR_EACH_FRAME (tail
, frame
)
11220 struct frame
*f
= XFRAME (frame
);
11222 if (FRAME_VISIBLE_P (f
) && FRAME_GARBAGED_P (f
))
11227 clear_current_matrices (f
);
11228 fset_redisplay (f
);
11229 f
->garbaged
= false;
11230 f
->resized_p
= false;
11234 frame_garbaged
= false;
11239 /* Redisplay the echo area of the selected frame. If UPDATE_FRAME_P
11240 is non-zero update selected_frame. Value is non-zero if the
11241 mini-windows height has been changed. */
11244 echo_area_display (int update_frame_p
)
11246 Lisp_Object mini_window
;
11249 int window_height_changed_p
= 0;
11250 struct frame
*sf
= SELECTED_FRAME ();
11252 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
11253 w
= XWINDOW (mini_window
);
11254 f
= XFRAME (WINDOW_FRAME (w
));
11256 /* Don't display if frame is invisible or not yet initialized. */
11257 if (!FRAME_VISIBLE_P (f
) || !f
->glyphs_initialized_p
)
11260 #ifdef HAVE_WINDOW_SYSTEM
11261 /* When Emacs starts, selected_frame may be the initial terminal
11262 frame. If we let this through, a message would be displayed on
11264 if (FRAME_INITIAL_P (XFRAME (selected_frame
)))
11266 #endif /* HAVE_WINDOW_SYSTEM */
11268 /* Redraw garbaged frames. */
11269 clear_garbaged_frames ();
11271 if (!NILP (echo_area_buffer
[0]) || minibuf_level
== 0)
11273 echo_area_window
= mini_window
;
11274 window_height_changed_p
= display_echo_area (w
);
11275 w
->must_be_updated_p
= true;
11277 /* Update the display, unless called from redisplay_internal.
11278 Also don't update the screen during redisplay itself. The
11279 update will happen at the end of redisplay, and an update
11280 here could cause confusion. */
11281 if (update_frame_p
&& !redisplaying_p
)
11285 /* If the display update has been interrupted by pending
11286 input, update mode lines in the frame. Due to the
11287 pending input, it might have been that redisplay hasn't
11288 been called, so that mode lines above the echo area are
11289 garbaged. This looks odd, so we prevent it here. */
11290 if (!display_completed
)
11291 n
= redisplay_mode_lines (FRAME_ROOT_WINDOW (f
), false);
11293 if (window_height_changed_p
11294 /* Don't do this if Emacs is shutting down. Redisplay
11295 needs to run hooks. */
11296 && !NILP (Vrun_hooks
))
11298 /* Must update other windows. Likewise as in other
11299 cases, don't let this update be interrupted by
11301 ptrdiff_t count
= SPECPDL_INDEX ();
11302 specbind (Qredisplay_dont_pause
, Qt
);
11303 windows_or_buffers_changed
= 44;
11304 redisplay_internal ();
11305 unbind_to (count
, Qnil
);
11307 else if (FRAME_WINDOW_P (f
) && n
== 0)
11309 /* Window configuration is the same as before.
11310 Can do with a display update of the echo area,
11311 unless we displayed some mode lines. */
11312 update_single_window (w
, 1);
11316 update_frame (f
, 1, 1);
11318 /* If cursor is in the echo area, make sure that the next
11319 redisplay displays the minibuffer, so that the cursor will
11320 be replaced with what the minibuffer wants. */
11321 if (cursor_in_echo_area
)
11322 wset_redisplay (XWINDOW (mini_window
));
11325 else if (!EQ (mini_window
, selected_window
))
11326 wset_redisplay (XWINDOW (mini_window
));
11328 /* Last displayed message is now the current message. */
11329 echo_area_buffer
[1] = echo_area_buffer
[0];
11330 /* Inform read_char that we're not echoing. */
11331 echo_message_buffer
= Qnil
;
11333 /* Prevent redisplay optimization in redisplay_internal by resetting
11334 this_line_start_pos. This is done because the mini-buffer now
11335 displays the message instead of its buffer text. */
11336 if (EQ (mini_window
, selected_window
))
11337 CHARPOS (this_line_start_pos
) = 0;
11339 return window_height_changed_p
;
11342 /* Nonzero if W's buffer was changed but not saved. */
11345 window_buffer_changed (struct window
*w
)
11347 struct buffer
*b
= XBUFFER (w
->contents
);
11349 eassert (BUFFER_LIVE_P (b
));
11351 return (((BUF_SAVE_MODIFF (b
) < BUF_MODIFF (b
)) != w
->last_had_star
));
11354 /* Nonzero if W has %c in its mode line and mode line should be updated. */
11357 mode_line_update_needed (struct window
*w
)
11359 return (w
->column_number_displayed
!= -1
11360 && !(PT
== w
->last_point
&& !window_outdated (w
))
11361 && (w
->column_number_displayed
!= current_column ()));
11364 /* Nonzero if window start of W is frozen and may not be changed during
11368 window_frozen_p (struct window
*w
)
11370 if (FRAME_WINDOWS_FROZEN (XFRAME (WINDOW_FRAME (w
))))
11372 Lisp_Object window
;
11374 XSETWINDOW (window
, w
);
11375 if (MINI_WINDOW_P (w
))
11377 else if (EQ (window
, selected_window
))
11379 else if (MINI_WINDOW_P (XWINDOW (selected_window
))
11380 && EQ (window
, Vminibuf_scroll_window
))
11381 /* This special window can't be frozen too. */
11389 /***********************************************************************
11390 Mode Lines and Frame Titles
11391 ***********************************************************************/
11393 /* A buffer for constructing non-propertized mode-line strings and
11394 frame titles in it; allocated from the heap in init_xdisp and
11395 resized as needed in store_mode_line_noprop_char. */
11397 static char *mode_line_noprop_buf
;
11399 /* The buffer's end, and a current output position in it. */
11401 static char *mode_line_noprop_buf_end
;
11402 static char *mode_line_noprop_ptr
;
11404 #define MODE_LINE_NOPROP_LEN(start) \
11405 ((mode_line_noprop_ptr - mode_line_noprop_buf) - start)
11408 MODE_LINE_DISPLAY
= 0,
11412 } mode_line_target
;
11414 /* Alist that caches the results of :propertize.
11415 Each element is (PROPERTIZED-STRING . PROPERTY-LIST). */
11416 static Lisp_Object mode_line_proptrans_alist
;
11418 /* List of strings making up the mode-line. */
11419 static Lisp_Object mode_line_string_list
;
11421 /* Base face property when building propertized mode line string. */
11422 static Lisp_Object mode_line_string_face
;
11423 static Lisp_Object mode_line_string_face_prop
;
11426 /* Unwind data for mode line strings */
11428 static Lisp_Object Vmode_line_unwind_vector
;
11431 format_mode_line_unwind_data (struct frame
*target_frame
,
11432 struct buffer
*obuf
,
11434 int save_proptrans
)
11436 Lisp_Object vector
, tmp
;
11438 /* Reduce consing by keeping one vector in
11439 Vwith_echo_area_save_vector. */
11440 vector
= Vmode_line_unwind_vector
;
11441 Vmode_line_unwind_vector
= Qnil
;
11444 vector
= Fmake_vector (make_number (10), Qnil
);
11446 ASET (vector
, 0, make_number (mode_line_target
));
11447 ASET (vector
, 1, make_number (MODE_LINE_NOPROP_LEN (0)));
11448 ASET (vector
, 2, mode_line_string_list
);
11449 ASET (vector
, 3, save_proptrans
? mode_line_proptrans_alist
: Qt
);
11450 ASET (vector
, 4, mode_line_string_face
);
11451 ASET (vector
, 5, mode_line_string_face_prop
);
11454 XSETBUFFER (tmp
, obuf
);
11457 ASET (vector
, 6, tmp
);
11458 ASET (vector
, 7, owin
);
11461 /* Similarly to `with-selected-window', if the operation selects
11462 a window on another frame, we must restore that frame's
11463 selected window, and (for a tty) the top-frame. */
11464 ASET (vector
, 8, target_frame
->selected_window
);
11465 if (FRAME_TERMCAP_P (target_frame
))
11466 ASET (vector
, 9, FRAME_TTY (target_frame
)->top_frame
);
11473 unwind_format_mode_line (Lisp_Object vector
)
11475 Lisp_Object old_window
= AREF (vector
, 7);
11476 Lisp_Object target_frame_window
= AREF (vector
, 8);
11477 Lisp_Object old_top_frame
= AREF (vector
, 9);
11479 mode_line_target
= XINT (AREF (vector
, 0));
11480 mode_line_noprop_ptr
= mode_line_noprop_buf
+ XINT (AREF (vector
, 1));
11481 mode_line_string_list
= AREF (vector
, 2);
11482 if (! EQ (AREF (vector
, 3), Qt
))
11483 mode_line_proptrans_alist
= AREF (vector
, 3);
11484 mode_line_string_face
= AREF (vector
, 4);
11485 mode_line_string_face_prop
= AREF (vector
, 5);
11487 /* Select window before buffer, since it may change the buffer. */
11488 if (!NILP (old_window
))
11490 /* If the operation that we are unwinding had selected a window
11491 on a different frame, reset its frame-selected-window. For a
11492 text terminal, reset its top-frame if necessary. */
11493 if (!NILP (target_frame_window
))
11496 = WINDOW_FRAME (XWINDOW (target_frame_window
));
11498 if (!EQ (frame
, WINDOW_FRAME (XWINDOW (old_window
))))
11499 Fselect_window (target_frame_window
, Qt
);
11501 if (!NILP (old_top_frame
) && !EQ (old_top_frame
, frame
))
11502 Fselect_frame (old_top_frame
, Qt
);
11505 Fselect_window (old_window
, Qt
);
11508 if (!NILP (AREF (vector
, 6)))
11510 set_buffer_internal_1 (XBUFFER (AREF (vector
, 6)));
11511 ASET (vector
, 6, Qnil
);
11514 Vmode_line_unwind_vector
= vector
;
11518 /* Store a single character C for the frame title in mode_line_noprop_buf.
11519 Re-allocate mode_line_noprop_buf if necessary. */
11522 store_mode_line_noprop_char (char c
)
11524 /* If output position has reached the end of the allocated buffer,
11525 increase the buffer's size. */
11526 if (mode_line_noprop_ptr
== mode_line_noprop_buf_end
)
11528 ptrdiff_t len
= MODE_LINE_NOPROP_LEN (0);
11529 ptrdiff_t size
= len
;
11530 mode_line_noprop_buf
=
11531 xpalloc (mode_line_noprop_buf
, &size
, 1, STRING_BYTES_BOUND
, 1);
11532 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
11533 mode_line_noprop_ptr
= mode_line_noprop_buf
+ len
;
11536 *mode_line_noprop_ptr
++ = c
;
11540 /* Store part of a frame title in mode_line_noprop_buf, beginning at
11541 mode_line_noprop_ptr. STRING is the string to store. Do not copy
11542 characters that yield more columns than PRECISION; PRECISION <= 0
11543 means copy the whole string. Pad with spaces until FIELD_WIDTH
11544 number of characters have been copied; FIELD_WIDTH <= 0 means don't
11545 pad. Called from display_mode_element when it is used to build a
11549 store_mode_line_noprop (const char *string
, int field_width
, int precision
)
11551 const unsigned char *str
= (const unsigned char *) string
;
11553 ptrdiff_t dummy
, nbytes
;
11555 /* Copy at most PRECISION chars from STR. */
11556 nbytes
= strlen (string
);
11557 n
+= c_string_width (str
, nbytes
, precision
, &dummy
, &nbytes
);
11559 store_mode_line_noprop_char (*str
++);
11561 /* Fill up with spaces until FIELD_WIDTH reached. */
11562 while (field_width
> 0
11563 && n
< field_width
)
11565 store_mode_line_noprop_char (' ');
11572 /***********************************************************************
11574 ***********************************************************************/
11576 #ifdef HAVE_WINDOW_SYSTEM
11578 /* Set the title of FRAME, if it has changed. The title format is
11579 Vicon_title_format if FRAME is iconified, otherwise it is
11580 frame_title_format. */
11583 x_consider_frame_title (Lisp_Object frame
)
11585 struct frame
*f
= XFRAME (frame
);
11587 if (FRAME_WINDOW_P (f
)
11588 || FRAME_MINIBUF_ONLY_P (f
)
11589 || f
->explicit_name
)
11591 /* Do we have more than one visible frame on this X display? */
11592 Lisp_Object tail
, other_frame
, fmt
;
11593 ptrdiff_t title_start
;
11597 ptrdiff_t count
= SPECPDL_INDEX ();
11599 FOR_EACH_FRAME (tail
, other_frame
)
11601 struct frame
*tf
= XFRAME (other_frame
);
11604 && FRAME_KBOARD (tf
) == FRAME_KBOARD (f
)
11605 && !FRAME_MINIBUF_ONLY_P (tf
)
11606 && !EQ (other_frame
, tip_frame
)
11607 && (FRAME_VISIBLE_P (tf
) || FRAME_ICONIFIED_P (tf
)))
11611 /* Set global variable indicating that multiple frames exist. */
11612 multiple_frames
= CONSP (tail
);
11614 /* Switch to the buffer of selected window of the frame. Set up
11615 mode_line_target so that display_mode_element will output into
11616 mode_line_noprop_buf; then display the title. */
11617 record_unwind_protect (unwind_format_mode_line
,
11618 format_mode_line_unwind_data
11619 (f
, current_buffer
, selected_window
, 0));
11621 Fselect_window (f
->selected_window
, Qt
);
11622 set_buffer_internal_1
11623 (XBUFFER (XWINDOW (f
->selected_window
)->contents
));
11624 fmt
= FRAME_ICONIFIED_P (f
) ? Vicon_title_format
: Vframe_title_format
;
11626 mode_line_target
= MODE_LINE_TITLE
;
11627 title_start
= MODE_LINE_NOPROP_LEN (0);
11628 init_iterator (&it
, XWINDOW (f
->selected_window
), -1, -1,
11629 NULL
, DEFAULT_FACE_ID
);
11630 display_mode_element (&it
, 0, -1, -1, fmt
, Qnil
, 0);
11631 len
= MODE_LINE_NOPROP_LEN (title_start
);
11632 title
= mode_line_noprop_buf
+ title_start
;
11633 unbind_to (count
, Qnil
);
11635 /* Set the title only if it's changed. This avoids consing in
11636 the common case where it hasn't. (If it turns out that we've
11637 already wasted too much time by walking through the list with
11638 display_mode_element, then we might need to optimize at a
11639 higher level than this.) */
11640 if (! STRINGP (f
->name
)
11641 || SBYTES (f
->name
) != len
11642 || memcmp (title
, SDATA (f
->name
), len
) != 0)
11643 x_implicitly_set_name (f
, make_string (title
, len
), Qnil
);
11647 #endif /* not HAVE_WINDOW_SYSTEM */
11650 /***********************************************************************
11652 ***********************************************************************/
11654 /* Non-zero if we will not redisplay all visible windows. */
11655 #define REDISPLAY_SOME_P() \
11656 ((windows_or_buffers_changed == 0 \
11657 || windows_or_buffers_changed == REDISPLAY_SOME) \
11658 && (update_mode_lines == 0 \
11659 || update_mode_lines == REDISPLAY_SOME))
11661 /* Prepare for redisplay by updating menu-bar item lists when
11662 appropriate. This can call eval. */
11665 prepare_menu_bars (void)
11667 bool all_windows
= windows_or_buffers_changed
|| update_mode_lines
;
11668 bool some_windows
= REDISPLAY_SOME_P ();
11669 struct gcpro gcpro1
, gcpro2
;
11670 Lisp_Object tooltip_frame
;
11672 #ifdef HAVE_WINDOW_SYSTEM
11673 tooltip_frame
= tip_frame
;
11675 tooltip_frame
= Qnil
;
11678 if (FUNCTIONP (Vpre_redisplay_function
))
11680 Lisp_Object windows
= all_windows
? Qt
: Qnil
;
11681 if (all_windows
&& some_windows
)
11683 Lisp_Object ws
= window_list ();
11684 for (windows
= Qnil
; CONSP (ws
); ws
= XCDR (ws
))
11686 Lisp_Object
this = XCAR (ws
);
11687 struct window
*w
= XWINDOW (this);
11689 || XFRAME (w
->frame
)->redisplay
11690 || XBUFFER (w
->contents
)->text
->redisplay
)
11692 windows
= Fcons (this, windows
);
11696 safe__call1 (true, Vpre_redisplay_function
, windows
);
11699 /* Update all frame titles based on their buffer names, etc. We do
11700 this before the menu bars so that the buffer-menu will show the
11701 up-to-date frame titles. */
11702 #ifdef HAVE_WINDOW_SYSTEM
11705 Lisp_Object tail
, frame
;
11707 FOR_EACH_FRAME (tail
, frame
)
11709 struct frame
*f
= XFRAME (frame
);
11710 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11714 && !XBUFFER (w
->contents
)->text
->redisplay
)
11717 if (!EQ (frame
, tooltip_frame
)
11718 && (FRAME_ICONIFIED_P (f
)
11719 || FRAME_VISIBLE_P (f
) == 1
11720 /* Exclude TTY frames that are obscured because they
11721 are not the top frame on their console. This is
11722 because x_consider_frame_title actually switches
11723 to the frame, which for TTY frames means it is
11724 marked as garbaged, and will be completely
11725 redrawn on the next redisplay cycle. This causes
11726 TTY frames to be completely redrawn, when there
11727 are more than one of them, even though nothing
11728 should be changed on display. */
11729 || (FRAME_VISIBLE_P (f
) == 2 && FRAME_WINDOW_P (f
))))
11730 x_consider_frame_title (frame
);
11733 #endif /* HAVE_WINDOW_SYSTEM */
11735 /* Update the menu bar item lists, if appropriate. This has to be
11736 done before any actual redisplay or generation of display lines. */
11740 Lisp_Object tail
, frame
;
11741 ptrdiff_t count
= SPECPDL_INDEX ();
11742 /* 1 means that update_menu_bar has run its hooks
11743 so any further calls to update_menu_bar shouldn't do so again. */
11744 int menu_bar_hooks_run
= 0;
11746 record_unwind_save_match_data ();
11748 FOR_EACH_FRAME (tail
, frame
)
11750 struct frame
*f
= XFRAME (frame
);
11751 struct window
*w
= XWINDOW (FRAME_SELECTED_WINDOW (f
));
11753 /* Ignore tooltip frame. */
11754 if (EQ (frame
, tooltip_frame
))
11760 && !XBUFFER (w
->contents
)->text
->redisplay
)
11763 /* If a window on this frame changed size, report that to
11764 the user and clear the size-change flag. */
11765 if (FRAME_WINDOW_SIZES_CHANGED (f
))
11767 Lisp_Object functions
;
11769 /* Clear flag first in case we get an error below. */
11770 FRAME_WINDOW_SIZES_CHANGED (f
) = 0;
11771 functions
= Vwindow_size_change_functions
;
11772 GCPRO2 (tail
, functions
);
11774 while (CONSP (functions
))
11776 if (!EQ (XCAR (functions
), Qt
))
11777 call1 (XCAR (functions
), frame
);
11778 functions
= XCDR (functions
);
11784 menu_bar_hooks_run
= update_menu_bar (f
, 0, menu_bar_hooks_run
);
11785 #ifdef HAVE_WINDOW_SYSTEM
11786 update_tool_bar (f
, 0);
11789 if (windows_or_buffers_changed
11792 (f
, Fbuffer_modified_p (XWINDOW (f
->selected_window
)->contents
));
11797 unbind_to (count
, Qnil
);
11801 struct frame
*sf
= SELECTED_FRAME ();
11802 update_menu_bar (sf
, 1, 0);
11803 #ifdef HAVE_WINDOW_SYSTEM
11804 update_tool_bar (sf
, 1);
11810 /* Update the menu bar item list for frame F. This has to be done
11811 before we start to fill in any display lines, because it can call
11814 If SAVE_MATCH_DATA is non-zero, we must save and restore it here.
11816 If HOOKS_RUN is 1, that means a previous call to update_menu_bar
11817 already ran the menu bar hooks for this redisplay, so there
11818 is no need to run them again. The return value is the
11819 updated value of this flag, to pass to the next call. */
11822 update_menu_bar (struct frame
*f
, int save_match_data
, int hooks_run
)
11824 Lisp_Object window
;
11825 register struct window
*w
;
11827 /* If called recursively during a menu update, do nothing. This can
11828 happen when, for instance, an activate-menubar-hook causes a
11830 if (inhibit_menubar_update
)
11833 window
= FRAME_SELECTED_WINDOW (f
);
11834 w
= XWINDOW (window
);
11836 if (FRAME_WINDOW_P (f
)
11838 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11839 || defined (HAVE_NS) || defined (USE_GTK)
11840 FRAME_EXTERNAL_MENU_BAR (f
)
11842 FRAME_MENU_BAR_LINES (f
) > 0
11844 : FRAME_MENU_BAR_LINES (f
) > 0)
11846 /* If the user has switched buffers or windows, we need to
11847 recompute to reflect the new bindings. But we'll
11848 recompute when update_mode_lines is set too; that means
11849 that people can use force-mode-line-update to request
11850 that the menu bar be recomputed. The adverse effect on
11851 the rest of the redisplay algorithm is about the same as
11852 windows_or_buffers_changed anyway. */
11853 if (windows_or_buffers_changed
11854 /* This used to test w->update_mode_line, but we believe
11855 there is no need to recompute the menu in that case. */
11856 || update_mode_lines
11857 || window_buffer_changed (w
))
11859 struct buffer
*prev
= current_buffer
;
11860 ptrdiff_t count
= SPECPDL_INDEX ();
11862 specbind (Qinhibit_menubar_update
, Qt
);
11864 set_buffer_internal_1 (XBUFFER (w
->contents
));
11865 if (save_match_data
)
11866 record_unwind_save_match_data ();
11867 if (NILP (Voverriding_local_map_menu_flag
))
11869 specbind (Qoverriding_terminal_local_map
, Qnil
);
11870 specbind (Qoverriding_local_map
, Qnil
);
11875 /* Run the Lucid hook. */
11876 safe_run_hooks (Qactivate_menubar_hook
);
11878 /* If it has changed current-menubar from previous value,
11879 really recompute the menu-bar from the value. */
11880 if (! NILP (Vlucid_menu_bar_dirty_flag
))
11881 call0 (Qrecompute_lucid_menubar
);
11883 safe_run_hooks (Qmenu_bar_update_hook
);
11888 XSETFRAME (Vmenu_updating_frame
, f
);
11889 fset_menu_bar_items (f
, menu_bar_items (FRAME_MENU_BAR_ITEMS (f
)));
11891 /* Redisplay the menu bar in case we changed it. */
11892 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
11893 || defined (HAVE_NS) || defined (USE_GTK)
11894 if (FRAME_WINDOW_P (f
))
11896 #if defined (HAVE_NS)
11897 /* All frames on Mac OS share the same menubar. So only
11898 the selected frame should be allowed to set it. */
11899 if (f
== SELECTED_FRAME ())
11901 set_frame_menubar (f
, 0, 0);
11904 /* On a terminal screen, the menu bar is an ordinary screen
11905 line, and this makes it get updated. */
11906 w
->update_mode_line
= 1;
11907 #else /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11908 /* In the non-toolkit version, the menu bar is an ordinary screen
11909 line, and this makes it get updated. */
11910 w
->update_mode_line
= 1;
11911 #endif /* ! (USE_X_TOOLKIT || HAVE_NTGUI || HAVE_NS || USE_GTK) */
11913 unbind_to (count
, Qnil
);
11914 set_buffer_internal_1 (prev
);
11921 /***********************************************************************
11923 ***********************************************************************/
11925 #ifdef HAVE_WINDOW_SYSTEM
11927 /* Select `frame' temporarily without running all the code in
11929 FIXME: Maybe do_switch_frame should be trimmed down similarly
11930 when `norecord' is set. */
11932 fast_set_selected_frame (Lisp_Object frame
)
11934 if (!EQ (selected_frame
, frame
))
11936 selected_frame
= frame
;
11937 selected_window
= XFRAME (frame
)->selected_window
;
11941 /* Update the tool-bar item list for frame F. This has to be done
11942 before we start to fill in any display lines. Called from
11943 prepare_menu_bars. If SAVE_MATCH_DATA is non-zero, we must save
11944 and restore it here. */
11947 update_tool_bar (struct frame
*f
, int save_match_data
)
11949 #if defined (USE_GTK) || defined (HAVE_NS)
11950 int do_update
= FRAME_EXTERNAL_TOOL_BAR (f
);
11952 int do_update
= (WINDOWP (f
->tool_bar_window
)
11953 && WINDOW_TOTAL_LINES (XWINDOW (f
->tool_bar_window
)) > 0);
11958 Lisp_Object window
;
11961 window
= FRAME_SELECTED_WINDOW (f
);
11962 w
= XWINDOW (window
);
11964 /* If the user has switched buffers or windows, we need to
11965 recompute to reflect the new bindings. But we'll
11966 recompute when update_mode_lines is set too; that means
11967 that people can use force-mode-line-update to request
11968 that the menu bar be recomputed. The adverse effect on
11969 the rest of the redisplay algorithm is about the same as
11970 windows_or_buffers_changed anyway. */
11971 if (windows_or_buffers_changed
11972 || w
->update_mode_line
11973 || update_mode_lines
11974 || window_buffer_changed (w
))
11976 struct buffer
*prev
= current_buffer
;
11977 ptrdiff_t count
= SPECPDL_INDEX ();
11978 Lisp_Object frame
, new_tool_bar
;
11979 int new_n_tool_bar
;
11980 struct gcpro gcpro1
;
11982 /* Set current_buffer to the buffer of the selected
11983 window of the frame, so that we get the right local
11985 set_buffer_internal_1 (XBUFFER (w
->contents
));
11987 /* Save match data, if we must. */
11988 if (save_match_data
)
11989 record_unwind_save_match_data ();
11991 /* Make sure that we don't accidentally use bogus keymaps. */
11992 if (NILP (Voverriding_local_map_menu_flag
))
11994 specbind (Qoverriding_terminal_local_map
, Qnil
);
11995 specbind (Qoverriding_local_map
, Qnil
);
11998 GCPRO1 (new_tool_bar
);
12000 /* We must temporarily set the selected frame to this frame
12001 before calling tool_bar_items, because the calculation of
12002 the tool-bar keymap uses the selected frame (see
12003 `tool-bar-make-keymap' in tool-bar.el). */
12004 eassert (EQ (selected_window
,
12005 /* Since we only explicitly preserve selected_frame,
12006 check that selected_window would be redundant. */
12007 XFRAME (selected_frame
)->selected_window
));
12008 record_unwind_protect (fast_set_selected_frame
, selected_frame
);
12009 XSETFRAME (frame
, f
);
12010 fast_set_selected_frame (frame
);
12012 /* Build desired tool-bar items from keymaps. */
12014 = tool_bar_items (Fcopy_sequence (f
->tool_bar_items
),
12017 /* Redisplay the tool-bar if we changed it. */
12018 if (new_n_tool_bar
!= f
->n_tool_bar_items
12019 || NILP (Fequal (new_tool_bar
, f
->tool_bar_items
)))
12021 /* Redisplay that happens asynchronously due to an expose event
12022 may access f->tool_bar_items. Make sure we update both
12023 variables within BLOCK_INPUT so no such event interrupts. */
12025 fset_tool_bar_items (f
, new_tool_bar
);
12026 f
->n_tool_bar_items
= new_n_tool_bar
;
12027 w
->update_mode_line
= 1;
12033 unbind_to (count
, Qnil
);
12034 set_buffer_internal_1 (prev
);
12039 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12041 /* Set F->desired_tool_bar_string to a Lisp string representing frame
12042 F's desired tool-bar contents. F->tool_bar_items must have
12043 been set up previously by calling prepare_menu_bars. */
12046 build_desired_tool_bar_string (struct frame
*f
)
12048 int i
, size
, size_needed
;
12049 struct gcpro gcpro1
, gcpro2
;
12050 Lisp_Object image
, plist
;
12052 image
= plist
= Qnil
;
12053 GCPRO2 (image
, plist
);
12055 /* Prepare F->desired_tool_bar_string. If we can reuse it, do so.
12056 Otherwise, make a new string. */
12058 /* The size of the string we might be able to reuse. */
12059 size
= (STRINGP (f
->desired_tool_bar_string
)
12060 ? SCHARS (f
->desired_tool_bar_string
)
12063 /* We need one space in the string for each image. */
12064 size_needed
= f
->n_tool_bar_items
;
12066 /* Reuse f->desired_tool_bar_string, if possible. */
12067 if (size
< size_needed
|| NILP (f
->desired_tool_bar_string
))
12068 fset_desired_tool_bar_string
12069 (f
, Fmake_string (make_number (size_needed
), make_number (' ')));
12072 AUTO_LIST4 (props
, Qdisplay
, Qnil
, Qmenu_item
, Qnil
);
12073 struct gcpro gcpro1
;
12075 Fremove_text_properties (make_number (0), make_number (size
),
12076 props
, f
->desired_tool_bar_string
);
12080 /* Put a `display' property on the string for the images to display,
12081 put a `menu_item' property on tool-bar items with a value that
12082 is the index of the item in F's tool-bar item vector. */
12083 for (i
= 0; i
< f
->n_tool_bar_items
; ++i
)
12085 #define PROP(IDX) \
12086 AREF (f->tool_bar_items, i * TOOL_BAR_ITEM_NSLOTS + (IDX))
12088 int enabled_p
= !NILP (PROP (TOOL_BAR_ITEM_ENABLED_P
));
12089 int selected_p
= !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
));
12090 int hmargin
, vmargin
, relief
, idx
, end
;
12092 /* If image is a vector, choose the image according to the
12094 image
= PROP (TOOL_BAR_ITEM_IMAGES
);
12095 if (VECTORP (image
))
12099 ? TOOL_BAR_IMAGE_ENABLED_SELECTED
12100 : TOOL_BAR_IMAGE_ENABLED_DESELECTED
);
12103 ? TOOL_BAR_IMAGE_DISABLED_SELECTED
12104 : TOOL_BAR_IMAGE_DISABLED_DESELECTED
);
12106 eassert (ASIZE (image
) >= idx
);
12107 image
= AREF (image
, idx
);
12112 /* Ignore invalid image specifications. */
12113 if (!valid_image_p (image
))
12116 /* Display the tool-bar button pressed, or depressed. */
12117 plist
= Fcopy_sequence (XCDR (image
));
12119 /* Compute margin and relief to draw. */
12120 relief
= (tool_bar_button_relief
>= 0
12121 ? tool_bar_button_relief
12122 : DEFAULT_TOOL_BAR_BUTTON_RELIEF
);
12123 hmargin
= vmargin
= relief
;
12125 if (RANGED_INTEGERP (1, Vtool_bar_button_margin
,
12126 INT_MAX
- max (hmargin
, vmargin
)))
12128 hmargin
+= XFASTINT (Vtool_bar_button_margin
);
12129 vmargin
+= XFASTINT (Vtool_bar_button_margin
);
12131 else if (CONSP (Vtool_bar_button_margin
))
12133 if (RANGED_INTEGERP (1, XCAR (Vtool_bar_button_margin
),
12134 INT_MAX
- hmargin
))
12135 hmargin
+= XFASTINT (XCAR (Vtool_bar_button_margin
));
12137 if (RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin
),
12138 INT_MAX
- vmargin
))
12139 vmargin
+= XFASTINT (XCDR (Vtool_bar_button_margin
));
12142 if (auto_raise_tool_bar_buttons_p
)
12144 /* Add a `:relief' property to the image spec if the item is
12148 plist
= Fplist_put (plist
, QCrelief
, make_number (-relief
));
12155 /* If image is selected, display it pressed, i.e. with a
12156 negative relief. If it's not selected, display it with a
12158 plist
= Fplist_put (plist
, QCrelief
,
12160 ? make_number (-relief
)
12161 : make_number (relief
)));
12166 /* Put a margin around the image. */
12167 if (hmargin
|| vmargin
)
12169 if (hmargin
== vmargin
)
12170 plist
= Fplist_put (plist
, QCmargin
, make_number (hmargin
));
12172 plist
= Fplist_put (plist
, QCmargin
,
12173 Fcons (make_number (hmargin
),
12174 make_number (vmargin
)));
12177 /* If button is not enabled, and we don't have special images
12178 for the disabled state, make the image appear disabled by
12179 applying an appropriate algorithm to it. */
12180 if (!enabled_p
&& idx
< 0)
12181 plist
= Fplist_put (plist
, QCconversion
, Qdisabled
);
12183 /* Put a `display' text property on the string for the image to
12184 display. Put a `menu-item' property on the string that gives
12185 the start of this item's properties in the tool-bar items
12187 image
= Fcons (Qimage
, plist
);
12188 AUTO_LIST4 (props
, Qdisplay
, image
, Qmenu_item
,
12189 make_number (i
* TOOL_BAR_ITEM_NSLOTS
));
12190 struct gcpro gcpro1
;
12193 /* Let the last image hide all remaining spaces in the tool bar
12194 string. The string can be longer than needed when we reuse a
12195 previous string. */
12196 if (i
+ 1 == f
->n_tool_bar_items
)
12197 end
= SCHARS (f
->desired_tool_bar_string
);
12200 Fadd_text_properties (make_number (i
), make_number (end
),
12201 props
, f
->desired_tool_bar_string
);
12210 /* Display one line of the tool-bar of frame IT->f.
12212 HEIGHT specifies the desired height of the tool-bar line.
12213 If the actual height of the glyph row is less than HEIGHT, the
12214 row's height is increased to HEIGHT, and the icons are centered
12215 vertically in the new height.
12217 If HEIGHT is -1, we are counting needed tool-bar lines, so don't
12218 count a final empty row in case the tool-bar width exactly matches
12223 display_tool_bar_line (struct it
*it
, int height
)
12225 struct glyph_row
*row
= it
->glyph_row
;
12226 int max_x
= it
->last_visible_x
;
12227 struct glyph
*last
;
12229 /* Don't extend on a previously drawn tool bar items (Bug#16058). */
12230 clear_glyph_row (row
);
12231 row
->enabled_p
= true;
12232 row
->y
= it
->current_y
;
12234 /* Note that this isn't made use of if the face hasn't a box,
12235 so there's no need to check the face here. */
12236 it
->start_of_box_run_p
= 1;
12238 while (it
->current_x
< max_x
)
12240 int x
, n_glyphs_before
, i
, nglyphs
;
12241 struct it it_before
;
12243 /* Get the next display element. */
12244 if (!get_next_display_element (it
))
12246 /* Don't count empty row if we are counting needed tool-bar lines. */
12247 if (height
< 0 && !it
->hpos
)
12252 /* Produce glyphs. */
12253 n_glyphs_before
= row
->used
[TEXT_AREA
];
12256 PRODUCE_GLYPHS (it
);
12258 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
12260 x
= it_before
.current_x
;
12261 while (i
< nglyphs
)
12263 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
12265 if (x
+ glyph
->pixel_width
> max_x
)
12267 /* Glyph doesn't fit on line. Backtrack. */
12268 row
->used
[TEXT_AREA
] = n_glyphs_before
;
12270 /* If this is the only glyph on this line, it will never fit on the
12271 tool-bar, so skip it. But ensure there is at least one glyph,
12272 so we don't accidentally disable the tool-bar. */
12273 if (n_glyphs_before
== 0
12274 && (it
->vpos
> 0 || IT_STRING_CHARPOS (*it
) < it
->end_charpos
-1))
12280 x
+= glyph
->pixel_width
;
12284 /* Stop at line end. */
12285 if (ITERATOR_AT_END_OF_LINE_P (it
))
12288 set_iterator_to_next (it
, 1);
12293 row
->displays_text_p
= row
->used
[TEXT_AREA
] != 0;
12295 /* Use default face for the border below the tool bar.
12297 FIXME: When auto-resize-tool-bars is grow-only, there is
12298 no additional border below the possibly empty tool-bar lines.
12299 So to make the extra empty lines look "normal", we have to
12300 use the tool-bar face for the border too. */
12301 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12302 && !EQ (Vauto_resize_tool_bars
, Qgrow_only
))
12303 it
->face_id
= DEFAULT_FACE_ID
;
12305 extend_face_to_end_of_line (it
);
12306 last
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
12307 last
->right_box_line_p
= 1;
12308 if (last
== row
->glyphs
[TEXT_AREA
])
12309 last
->left_box_line_p
= 1;
12311 /* Make line the desired height and center it vertically. */
12312 if ((height
-= it
->max_ascent
+ it
->max_descent
) > 0)
12314 /* Don't add more than one line height. */
12315 height
%= FRAME_LINE_HEIGHT (it
->f
);
12316 it
->max_ascent
+= height
/ 2;
12317 it
->max_descent
+= (height
+ 1) / 2;
12320 compute_line_metrics (it
);
12322 /* If line is empty, make it occupy the rest of the tool-bar. */
12323 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
))
12325 row
->height
= row
->phys_height
= it
->last_visible_y
- row
->y
;
12326 row
->visible_height
= row
->height
;
12327 row
->ascent
= row
->phys_ascent
= 0;
12328 row
->extra_line_spacing
= 0;
12331 row
->full_width_p
= 1;
12332 row
->continued_p
= 0;
12333 row
->truncated_on_left_p
= 0;
12334 row
->truncated_on_right_p
= 0;
12336 it
->current_x
= it
->hpos
= 0;
12337 it
->current_y
+= row
->height
;
12343 /* Value is the number of pixels needed to make all tool-bar items of
12344 frame F visible. The actual number of glyph rows needed is
12345 returned in *N_ROWS if non-NULL. */
12347 tool_bar_height (struct frame
*f
, int *n_rows
, bool pixelwise
)
12349 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12351 /* tool_bar_height is called from redisplay_tool_bar after building
12352 the desired matrix, so use (unused) mode-line row as temporary row to
12353 avoid destroying the first tool-bar row. */
12354 struct glyph_row
*temp_row
= MATRIX_MODE_LINE_ROW (w
->desired_matrix
);
12356 /* Initialize an iterator for iteration over
12357 F->desired_tool_bar_string in the tool-bar window of frame F. */
12358 init_iterator (&it
, w
, -1, -1, temp_row
, TOOL_BAR_FACE_ID
);
12359 temp_row
->reversed_p
= false;
12360 it
.first_visible_x
= 0;
12361 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12362 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12363 it
.paragraph_embedding
= L2R
;
12365 while (!ITERATOR_AT_END_P (&it
))
12367 clear_glyph_row (temp_row
);
12368 it
.glyph_row
= temp_row
;
12369 display_tool_bar_line (&it
, -1);
12371 clear_glyph_row (temp_row
);
12373 /* f->n_tool_bar_rows == 0 means "unknown"; -1 means no tool-bar. */
12375 *n_rows
= it
.vpos
> 0 ? it
.vpos
: -1;
12378 return it
.current_y
;
12380 return (it
.current_y
+ FRAME_LINE_HEIGHT (f
) - 1) / FRAME_LINE_HEIGHT (f
);
12383 #endif /* !USE_GTK && !HAVE_NS */
12385 DEFUN ("tool-bar-height", Ftool_bar_height
, Stool_bar_height
,
12387 doc
: /* Return the number of lines occupied by the tool bar of FRAME.
12388 If FRAME is nil or omitted, use the selected frame. Optional argument
12389 PIXELWISE non-nil means return the height of the tool bar in pixels. */)
12390 (Lisp_Object frame
, Lisp_Object pixelwise
)
12394 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12395 struct frame
*f
= decode_any_frame (frame
);
12397 if (WINDOWP (f
->tool_bar_window
)
12398 && WINDOW_PIXEL_HEIGHT (XWINDOW (f
->tool_bar_window
)) > 0)
12400 update_tool_bar (f
, 1);
12401 if (f
->n_tool_bar_items
)
12403 build_desired_tool_bar_string (f
);
12404 height
= tool_bar_height (f
, NULL
, NILP (pixelwise
) ? 0 : 1);
12409 return make_number (height
);
12413 /* Display the tool-bar of frame F. Value is non-zero if tool-bar's
12414 height should be changed. */
12416 redisplay_tool_bar (struct frame
*f
)
12418 #if defined (USE_GTK) || defined (HAVE_NS)
12420 if (FRAME_EXTERNAL_TOOL_BAR (f
))
12421 update_frame_tool_bar (f
);
12424 #else /* !USE_GTK && !HAVE_NS */
12428 struct glyph_row
*row
;
12430 /* If frame hasn't a tool-bar window or if it is zero-height, don't
12431 do anything. This means you must start with tool-bar-lines
12432 non-zero to get the auto-sizing effect. Or in other words, you
12433 can turn off tool-bars by specifying tool-bar-lines zero. */
12434 if (!WINDOWP (f
->tool_bar_window
)
12435 || (w
= XWINDOW (f
->tool_bar_window
),
12436 WINDOW_TOTAL_LINES (w
) == 0))
12439 /* Set up an iterator for the tool-bar window. */
12440 init_iterator (&it
, w
, -1, -1, w
->desired_matrix
->rows
, TOOL_BAR_FACE_ID
);
12441 it
.first_visible_x
= 0;
12442 it
.last_visible_x
= WINDOW_PIXEL_WIDTH (w
);
12443 row
= it
.glyph_row
;
12444 row
->reversed_p
= false;
12446 /* Build a string that represents the contents of the tool-bar. */
12447 build_desired_tool_bar_string (f
);
12448 reseat_to_string (&it
, NULL
, f
->desired_tool_bar_string
, 0, 0, 0, -1);
12449 /* FIXME: This should be controlled by a user option. But it
12450 doesn't make sense to have an R2L tool bar if the menu bar cannot
12451 be drawn also R2L, and making the menu bar R2L is tricky due
12452 toolkit-specific code that implements it. If an R2L tool bar is
12453 ever supported, display_tool_bar_line should also be augmented to
12454 call unproduce_glyphs like display_line and display_string
12456 it
.paragraph_embedding
= L2R
;
12458 if (f
->n_tool_bar_rows
== 0)
12460 int new_height
= tool_bar_height (f
, &f
->n_tool_bar_rows
, 1);
12462 if (new_height
!= WINDOW_PIXEL_HEIGHT (w
))
12464 x_change_tool_bar_height (f
, new_height
);
12465 /* Always do that now. */
12466 clear_glyph_matrix (w
->desired_matrix
);
12467 f
->fonts_changed
= 1;
12472 /* Display as many lines as needed to display all tool-bar items. */
12474 if (f
->n_tool_bar_rows
> 0)
12476 int border
, rows
, height
, extra
;
12478 if (TYPE_RANGED_INTEGERP (int, Vtool_bar_border
))
12479 border
= XINT (Vtool_bar_border
);
12480 else if (EQ (Vtool_bar_border
, Qinternal_border_width
))
12481 border
= FRAME_INTERNAL_BORDER_WIDTH (f
);
12482 else if (EQ (Vtool_bar_border
, Qborder_width
))
12483 border
= f
->border_width
;
12489 rows
= f
->n_tool_bar_rows
;
12490 height
= max (1, (it
.last_visible_y
- border
) / rows
);
12491 extra
= it
.last_visible_y
- border
- height
* rows
;
12493 while (it
.current_y
< it
.last_visible_y
)
12496 if (extra
> 0 && rows
-- > 0)
12498 h
= (extra
+ rows
- 1) / rows
;
12501 display_tool_bar_line (&it
, height
+ h
);
12506 while (it
.current_y
< it
.last_visible_y
)
12507 display_tool_bar_line (&it
, 0);
12510 /* It doesn't make much sense to try scrolling in the tool-bar
12511 window, so don't do it. */
12512 w
->desired_matrix
->no_scrolling_p
= 1;
12513 w
->must_be_updated_p
= 1;
12515 if (!NILP (Vauto_resize_tool_bars
))
12517 int change_height_p
= 0;
12519 /* If we couldn't display everything, change the tool-bar's
12520 height if there is room for more. */
12521 if (IT_STRING_CHARPOS (it
) < it
.end_charpos
)
12522 change_height_p
= 1;
12524 /* We subtract 1 because display_tool_bar_line advances the
12525 glyph_row pointer before returning to its caller. We want to
12526 examine the last glyph row produced by
12527 display_tool_bar_line. */
12528 row
= it
.glyph_row
- 1;
12530 /* If there are blank lines at the end, except for a partially
12531 visible blank line at the end that is smaller than
12532 FRAME_LINE_HEIGHT, change the tool-bar's height. */
12533 if (!MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12534 && row
->height
>= FRAME_LINE_HEIGHT (f
))
12535 change_height_p
= 1;
12537 /* If row displays tool-bar items, but is partially visible,
12538 change the tool-bar's height. */
12539 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
12540 && MATRIX_ROW_BOTTOM_Y (row
) > it
.last_visible_y
)
12541 change_height_p
= 1;
12543 /* Resize windows as needed by changing the `tool-bar-lines'
12544 frame parameter. */
12545 if (change_height_p
)
12548 int new_height
= tool_bar_height (f
, &nrows
, 1);
12550 change_height_p
= ((EQ (Vauto_resize_tool_bars
, Qgrow_only
)
12551 && !f
->minimize_tool_bar_window_p
)
12552 ? (new_height
> WINDOW_PIXEL_HEIGHT (w
))
12553 : (new_height
!= WINDOW_PIXEL_HEIGHT (w
)));
12554 f
->minimize_tool_bar_window_p
= 0;
12556 if (change_height_p
)
12558 x_change_tool_bar_height (f
, new_height
);
12559 clear_glyph_matrix (w
->desired_matrix
);
12560 f
->n_tool_bar_rows
= nrows
;
12561 f
->fonts_changed
= 1;
12568 f
->minimize_tool_bar_window_p
= 0;
12571 #endif /* USE_GTK || HAVE_NS */
12574 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
12576 /* Get information about the tool-bar item which is displayed in GLYPH
12577 on frame F. Return in *PROP_IDX the index where tool-bar item
12578 properties start in F->tool_bar_items. Value is zero if
12579 GLYPH doesn't display a tool-bar item. */
12582 tool_bar_item_info (struct frame
*f
, struct glyph
*glyph
, int *prop_idx
)
12588 /* This function can be called asynchronously, which means we must
12589 exclude any possibility that Fget_text_property signals an
12591 charpos
= min (SCHARS (f
->current_tool_bar_string
), glyph
->charpos
);
12592 charpos
= max (0, charpos
);
12594 /* Get the text property `menu-item' at pos. The value of that
12595 property is the start index of this item's properties in
12596 F->tool_bar_items. */
12597 prop
= Fget_text_property (make_number (charpos
),
12598 Qmenu_item
, f
->current_tool_bar_string
);
12599 if (INTEGERP (prop
))
12601 *prop_idx
= XINT (prop
);
12611 /* Get information about the tool-bar item at position X/Y on frame F.
12612 Return in *GLYPH a pointer to the glyph of the tool-bar item in
12613 the current matrix of the tool-bar window of F, or NULL if not
12614 on a tool-bar item. Return in *PROP_IDX the index of the tool-bar
12615 item in F->tool_bar_items. Value is
12617 -1 if X/Y is not on a tool-bar item
12618 0 if X/Y is on the same item that was highlighted before.
12622 get_tool_bar_item (struct frame
*f
, int x
, int y
, struct glyph
**glyph
,
12623 int *hpos
, int *vpos
, int *prop_idx
)
12625 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12626 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12629 /* Find the glyph under X/Y. */
12630 *glyph
= x_y_to_hpos_vpos (w
, x
, y
, hpos
, vpos
, 0, 0, &area
);
12631 if (*glyph
== NULL
)
12634 /* Get the start of this tool-bar item's properties in
12635 f->tool_bar_items. */
12636 if (!tool_bar_item_info (f
, *glyph
, prop_idx
))
12639 /* Is mouse on the highlighted item? */
12640 if (EQ (f
->tool_bar_window
, hlinfo
->mouse_face_window
)
12641 && *vpos
>= hlinfo
->mouse_face_beg_row
12642 && *vpos
<= hlinfo
->mouse_face_end_row
12643 && (*vpos
> hlinfo
->mouse_face_beg_row
12644 || *hpos
>= hlinfo
->mouse_face_beg_col
)
12645 && (*vpos
< hlinfo
->mouse_face_end_row
12646 || *hpos
< hlinfo
->mouse_face_end_col
12647 || hlinfo
->mouse_face_past_end
))
12655 Handle mouse button event on the tool-bar of frame F, at
12656 frame-relative coordinates X/Y. DOWN_P is 1 for a button press,
12657 0 for button release. MODIFIERS is event modifiers for button
12661 handle_tool_bar_click (struct frame
*f
, int x
, int y
, int down_p
,
12664 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12665 struct window
*w
= XWINDOW (f
->tool_bar_window
);
12666 int hpos
, vpos
, prop_idx
;
12667 struct glyph
*glyph
;
12668 Lisp_Object enabled_p
;
12671 /* If not on the highlighted tool-bar item, and mouse-highlight is
12672 non-nil, return. This is so we generate the tool-bar button
12673 click only when the mouse button is released on the same item as
12674 where it was pressed. However, when mouse-highlight is disabled,
12675 generate the click when the button is released regardless of the
12676 highlight, since tool-bar items are not highlighted in that
12678 frame_to_window_pixel_xy (w
, &x
, &y
);
12679 ts
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12681 || (ts
!= 0 && !NILP (Vmouse_highlight
)))
12684 /* When mouse-highlight is off, generate the click for the item
12685 where the button was pressed, disregarding where it was
12687 if (NILP (Vmouse_highlight
) && !down_p
)
12688 prop_idx
= f
->last_tool_bar_item
;
12690 /* If item is disabled, do nothing. */
12691 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12692 if (NILP (enabled_p
))
12697 /* Show item in pressed state. */
12698 if (!NILP (Vmouse_highlight
))
12699 show_mouse_face (hlinfo
, DRAW_IMAGE_SUNKEN
);
12700 f
->last_tool_bar_item
= prop_idx
;
12704 Lisp_Object key
, frame
;
12705 struct input_event event
;
12706 EVENT_INIT (event
);
12708 /* Show item in released state. */
12709 if (!NILP (Vmouse_highlight
))
12710 show_mouse_face (hlinfo
, DRAW_IMAGE_RAISED
);
12712 key
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_KEY
);
12714 XSETFRAME (frame
, f
);
12715 event
.kind
= TOOL_BAR_EVENT
;
12716 event
.frame_or_window
= frame
;
12718 kbd_buffer_store_event (&event
);
12720 event
.kind
= TOOL_BAR_EVENT
;
12721 event
.frame_or_window
= frame
;
12723 event
.modifiers
= modifiers
;
12724 kbd_buffer_store_event (&event
);
12725 f
->last_tool_bar_item
= -1;
12730 /* Possibly highlight a tool-bar item on frame F when mouse moves to
12731 tool-bar window-relative coordinates X/Y. Called from
12732 note_mouse_highlight. */
12735 note_tool_bar_highlight (struct frame
*f
, int x
, int y
)
12737 Lisp_Object window
= f
->tool_bar_window
;
12738 struct window
*w
= XWINDOW (window
);
12739 Display_Info
*dpyinfo
= FRAME_DISPLAY_INFO (f
);
12740 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
12742 struct glyph
*glyph
;
12743 struct glyph_row
*row
;
12745 Lisp_Object enabled_p
;
12747 enum draw_glyphs_face draw
= DRAW_IMAGE_RAISED
;
12748 int mouse_down_p
, rc
;
12750 /* Function note_mouse_highlight is called with negative X/Y
12751 values when mouse moves outside of the frame. */
12752 if (x
<= 0 || y
<= 0)
12754 clear_mouse_face (hlinfo
);
12758 rc
= get_tool_bar_item (f
, x
, y
, &glyph
, &hpos
, &vpos
, &prop_idx
);
12761 /* Not on tool-bar item. */
12762 clear_mouse_face (hlinfo
);
12766 /* On same tool-bar item as before. */
12767 goto set_help_echo
;
12769 clear_mouse_face (hlinfo
);
12771 /* Mouse is down, but on different tool-bar item? */
12772 mouse_down_p
= (x_mouse_grabbed (dpyinfo
)
12773 && f
== dpyinfo
->last_mouse_frame
);
12775 if (mouse_down_p
&& f
->last_tool_bar_item
!= prop_idx
)
12778 draw
= mouse_down_p
? DRAW_IMAGE_SUNKEN
: DRAW_IMAGE_RAISED
;
12780 /* If tool-bar item is not enabled, don't highlight it. */
12781 enabled_p
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_ENABLED_P
);
12782 if (!NILP (enabled_p
) && !NILP (Vmouse_highlight
))
12784 /* Compute the x-position of the glyph. In front and past the
12785 image is a space. We include this in the highlighted area. */
12786 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
12787 for (i
= x
= 0; i
< hpos
; ++i
)
12788 x
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
12790 /* Record this as the current active region. */
12791 hlinfo
->mouse_face_beg_col
= hpos
;
12792 hlinfo
->mouse_face_beg_row
= vpos
;
12793 hlinfo
->mouse_face_beg_x
= x
;
12794 hlinfo
->mouse_face_past_end
= 0;
12796 hlinfo
->mouse_face_end_col
= hpos
+ 1;
12797 hlinfo
->mouse_face_end_row
= vpos
;
12798 hlinfo
->mouse_face_end_x
= x
+ glyph
->pixel_width
;
12799 hlinfo
->mouse_face_window
= window
;
12800 hlinfo
->mouse_face_face_id
= TOOL_BAR_FACE_ID
;
12802 /* Display it as active. */
12803 show_mouse_face (hlinfo
, draw
);
12808 /* Set help_echo_string to a help string to display for this tool-bar item.
12809 XTread_socket does the rest. */
12810 help_echo_object
= help_echo_window
= Qnil
;
12811 help_echo_pos
= -1;
12812 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_HELP
);
12813 if (NILP (help_echo_string
))
12814 help_echo_string
= AREF (f
->tool_bar_items
, prop_idx
+ TOOL_BAR_ITEM_CAPTION
);
12817 #endif /* !USE_GTK && !HAVE_NS */
12819 #endif /* HAVE_WINDOW_SYSTEM */
12823 /************************************************************************
12824 Horizontal scrolling
12825 ************************************************************************/
12827 static int hscroll_window_tree (Lisp_Object
);
12828 static int hscroll_windows (Lisp_Object
);
12830 /* For all leaf windows in the window tree rooted at WINDOW, set their
12831 hscroll value so that PT is (i) visible in the window, and (ii) so
12832 that it is not within a certain margin at the window's left and
12833 right border. Value is non-zero if any window's hscroll has been
12837 hscroll_window_tree (Lisp_Object window
)
12839 int hscrolled_p
= 0;
12840 int hscroll_relative_p
= FLOATP (Vhscroll_step
);
12841 int hscroll_step_abs
= 0;
12842 double hscroll_step_rel
= 0;
12844 if (hscroll_relative_p
)
12846 hscroll_step_rel
= XFLOAT_DATA (Vhscroll_step
);
12847 if (hscroll_step_rel
< 0)
12849 hscroll_relative_p
= 0;
12850 hscroll_step_abs
= 0;
12853 else if (TYPE_RANGED_INTEGERP (int, Vhscroll_step
))
12855 hscroll_step_abs
= XINT (Vhscroll_step
);
12856 if (hscroll_step_abs
< 0)
12857 hscroll_step_abs
= 0;
12860 hscroll_step_abs
= 0;
12862 while (WINDOWP (window
))
12864 struct window
*w
= XWINDOW (window
);
12866 if (WINDOWP (w
->contents
))
12867 hscrolled_p
|= hscroll_window_tree (w
->contents
);
12868 else if (w
->cursor
.vpos
>= 0)
12871 int text_area_width
;
12872 struct glyph_row
*cursor_row
;
12873 struct glyph_row
*bottom_row
;
12876 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->desired_matrix
, w
);
12877 if (w
->cursor
.vpos
< bottom_row
- w
->desired_matrix
->rows
)
12878 cursor_row
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
);
12880 cursor_row
= bottom_row
- 1;
12882 if (!cursor_row
->enabled_p
)
12884 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
12885 if (w
->cursor
.vpos
< bottom_row
- w
->current_matrix
->rows
)
12886 cursor_row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
12888 cursor_row
= bottom_row
- 1;
12890 row_r2l_p
= cursor_row
->reversed_p
;
12892 text_area_width
= window_box_width (w
, TEXT_AREA
);
12894 /* Scroll when cursor is inside this scroll margin. */
12895 h_margin
= hscroll_margin
* WINDOW_FRAME_COLUMN_WIDTH (w
);
12897 /* If the position of this window's point has explicitly
12898 changed, no more suspend auto hscrolling. */
12899 if (NILP (Fequal (Fwindow_point (window
), Fwindow_old_point (window
))))
12900 w
->suspend_auto_hscroll
= 0;
12902 /* Remember window point. */
12903 Fset_marker (w
->old_pointm
,
12904 ((w
== XWINDOW (selected_window
))
12905 ? make_number (BUF_PT (XBUFFER (w
->contents
)))
12906 : Fmarker_position (w
->pointm
)),
12909 if (!NILP (Fbuffer_local_value (Qauto_hscroll_mode
, w
->contents
))
12910 && w
->suspend_auto_hscroll
== 0
12911 /* In some pathological cases, like restoring a window
12912 configuration into a frame that is much smaller than
12913 the one from which the configuration was saved, we
12914 get glyph rows whose start and end have zero buffer
12915 positions, which we cannot handle below. Just skip
12917 && CHARPOS (cursor_row
->start
.pos
) >= BUF_BEG (w
->contents
)
12918 /* For left-to-right rows, hscroll when cursor is either
12919 (i) inside the right hscroll margin, or (ii) if it is
12920 inside the left margin and the window is already
12923 && ((w
->hscroll
&& w
->cursor
.x
<= h_margin
)
12924 || (cursor_row
->enabled_p
12925 && cursor_row
->truncated_on_right_p
12926 && (w
->cursor
.x
>= text_area_width
- h_margin
))))
12927 /* For right-to-left rows, the logic is similar,
12928 except that rules for scrolling to left and right
12929 are reversed. E.g., if cursor.x <= h_margin, we
12930 need to hscroll "to the right" unconditionally,
12931 and that will scroll the screen to the left so as
12932 to reveal the next portion of the row. */
12934 && ((cursor_row
->enabled_p
12935 /* FIXME: It is confusing to set the
12936 truncated_on_right_p flag when R2L rows
12937 are actually truncated on the left. */
12938 && cursor_row
->truncated_on_right_p
12939 && w
->cursor
.x
<= h_margin
)
12941 && (w
->cursor
.x
>= text_area_width
- h_margin
))))))
12945 struct buffer
*saved_current_buffer
;
12949 /* Find point in a display of infinite width. */
12950 saved_current_buffer
= current_buffer
;
12951 current_buffer
= XBUFFER (w
->contents
);
12953 if (w
== XWINDOW (selected_window
))
12956 pt
= clip_to_bounds (BEGV
, marker_position (w
->pointm
), ZV
);
12958 /* Move iterator to pt starting at cursor_row->start in
12959 a line with infinite width. */
12960 init_to_row_start (&it
, w
, cursor_row
);
12961 it
.last_visible_x
= INFINITY
;
12962 move_it_in_display_line_to (&it
, pt
, -1, MOVE_TO_POS
);
12963 current_buffer
= saved_current_buffer
;
12965 /* Position cursor in window. */
12966 if (!hscroll_relative_p
&& hscroll_step_abs
== 0)
12967 hscroll
= max (0, (it
.current_x
12968 - (ITERATOR_AT_END_OF_LINE_P (&it
)
12969 ? (text_area_width
- 4 * FRAME_COLUMN_WIDTH (it
.f
))
12970 : (text_area_width
/ 2))))
12971 / FRAME_COLUMN_WIDTH (it
.f
);
12972 else if ((!row_r2l_p
12973 && w
->cursor
.x
>= text_area_width
- h_margin
)
12974 || (row_r2l_p
&& w
->cursor
.x
<= h_margin
))
12976 if (hscroll_relative_p
)
12977 wanted_x
= text_area_width
* (1 - hscroll_step_rel
)
12980 wanted_x
= text_area_width
12981 - hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12984 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12988 if (hscroll_relative_p
)
12989 wanted_x
= text_area_width
* hscroll_step_rel
12992 wanted_x
= hscroll_step_abs
* FRAME_COLUMN_WIDTH (it
.f
)
12995 = max (0, it
.current_x
- wanted_x
) / FRAME_COLUMN_WIDTH (it
.f
);
12997 hscroll
= max (hscroll
, w
->min_hscroll
);
12999 /* Don't prevent redisplay optimizations if hscroll
13000 hasn't changed, as it will unnecessarily slow down
13002 if (w
->hscroll
!= hscroll
)
13004 XBUFFER (w
->contents
)->prevent_redisplay_optimizations_p
= 1;
13005 w
->hscroll
= hscroll
;
13014 /* Value is non-zero if hscroll of any leaf window has been changed. */
13015 return hscrolled_p
;
13019 /* Set hscroll so that cursor is visible and not inside horizontal
13020 scroll margins for all windows in the tree rooted at WINDOW. See
13021 also hscroll_window_tree above. Value is non-zero if any window's
13022 hscroll has been changed. If it has, desired matrices on the frame
13023 of WINDOW are cleared. */
13026 hscroll_windows (Lisp_Object window
)
13028 int hscrolled_p
= hscroll_window_tree (window
);
13030 clear_desired_matrices (XFRAME (WINDOW_FRAME (XWINDOW (window
))));
13031 return hscrolled_p
;
13036 /************************************************************************
13038 ************************************************************************/
13040 /* Variables holding some state of redisplay if GLYPH_DEBUG is defined
13041 to a non-zero value. This is sometimes handy to have in a debugger
13046 /* First and last unchanged row for try_window_id. */
13048 static int debug_first_unchanged_at_end_vpos
;
13049 static int debug_last_unchanged_at_beg_vpos
;
13051 /* Delta vpos and y. */
13053 static int debug_dvpos
, debug_dy
;
13055 /* Delta in characters and bytes for try_window_id. */
13057 static ptrdiff_t debug_delta
, debug_delta_bytes
;
13059 /* Values of window_end_pos and window_end_vpos at the end of
13062 static ptrdiff_t debug_end_vpos
;
13064 /* Append a string to W->desired_matrix->method. FMT is a printf
13065 format string. If trace_redisplay_p is true also printf the
13066 resulting string to stderr. */
13068 static void debug_method_add (struct window
*, char const *, ...)
13069 ATTRIBUTE_FORMAT_PRINTF (2, 3);
13072 debug_method_add (struct window
*w
, char const *fmt
, ...)
13075 char *method
= w
->desired_matrix
->method
;
13076 int len
= strlen (method
);
13077 int size
= sizeof w
->desired_matrix
->method
;
13078 int remaining
= size
- len
- 1;
13081 if (len
&& remaining
)
13084 --remaining
, ++len
;
13087 va_start (ap
, fmt
);
13088 vsnprintf (method
+ len
, remaining
+ 1, fmt
, ap
);
13091 if (trace_redisplay_p
)
13092 fprintf (stderr
, "%p (%s): %s\n",
13094 ((BUFFERP (w
->contents
)
13095 && STRINGP (BVAR (XBUFFER (w
->contents
), name
)))
13096 ? SSDATA (BVAR (XBUFFER (w
->contents
), name
))
13101 #endif /* GLYPH_DEBUG */
13104 /* Value is non-zero if all changes in window W, which displays
13105 current_buffer, are in the text between START and END. START is a
13106 buffer position, END is given as a distance from Z. Used in
13107 redisplay_internal for display optimization. */
13110 text_outside_line_unchanged_p (struct window
*w
,
13111 ptrdiff_t start
, ptrdiff_t end
)
13113 int unchanged_p
= 1;
13115 /* If text or overlays have changed, see where. */
13116 if (window_outdated (w
))
13118 /* Gap in the line? */
13119 if (GPT
< start
|| Z
- GPT
< end
)
13122 /* Changes start in front of the line, or end after it? */
13124 && (BEG_UNCHANGED
< start
- 1
13125 || END_UNCHANGED
< end
))
13128 /* If selective display, can't optimize if changes start at the
13129 beginning of the line. */
13131 && INTEGERP (BVAR (current_buffer
, selective_display
))
13132 && XINT (BVAR (current_buffer
, selective_display
)) > 0
13133 && (BEG_UNCHANGED
< start
|| GPT
<= start
))
13136 /* If there are overlays at the start or end of the line, these
13137 may have overlay strings with newlines in them. A change at
13138 START, for instance, may actually concern the display of such
13139 overlay strings as well, and they are displayed on different
13140 lines. So, quickly rule out this case. (For the future, it
13141 might be desirable to implement something more telling than
13142 just BEG/END_UNCHANGED.) */
13145 if (BEG
+ BEG_UNCHANGED
== start
13146 && overlay_touches_p (start
))
13148 if (END_UNCHANGED
== end
13149 && overlay_touches_p (Z
- end
))
13153 /* Under bidi reordering, adding or deleting a character in the
13154 beginning of a paragraph, before the first strong directional
13155 character, can change the base direction of the paragraph (unless
13156 the buffer specifies a fixed paragraph direction), which will
13157 require to redisplay the whole paragraph. It might be worthwhile
13158 to find the paragraph limits and widen the range of redisplayed
13159 lines to that, but for now just give up this optimization. */
13160 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
13161 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
13165 return unchanged_p
;
13169 /* Do a frame update, taking possible shortcuts into account. This is
13170 the main external entry point for redisplay.
13172 If the last redisplay displayed an echo area message and that message
13173 is no longer requested, we clear the echo area or bring back the
13174 mini-buffer if that is in use. */
13179 redisplay_internal ();
13184 overlay_arrow_string_or_property (Lisp_Object var
)
13188 if (val
= Fget (var
, Qoverlay_arrow_string
), STRINGP (val
))
13191 return Voverlay_arrow_string
;
13194 /* Return 1 if there are any overlay-arrows in current_buffer. */
13196 overlay_arrow_in_current_buffer_p (void)
13200 for (vlist
= Voverlay_arrow_variable_list
;
13202 vlist
= XCDR (vlist
))
13204 Lisp_Object var
= XCAR (vlist
);
13207 if (!SYMBOLP (var
))
13209 val
= find_symbol_value (var
);
13211 && current_buffer
== XMARKER (val
)->buffer
)
13218 /* Return 1 if any overlay_arrows have moved or overlay-arrow-string
13222 overlay_arrows_changed_p (void)
13226 for (vlist
= Voverlay_arrow_variable_list
;
13228 vlist
= XCDR (vlist
))
13230 Lisp_Object var
= XCAR (vlist
);
13231 Lisp_Object val
, pstr
;
13233 if (!SYMBOLP (var
))
13235 val
= find_symbol_value (var
);
13236 if (!MARKERP (val
))
13238 if (! EQ (COERCE_MARKER (val
),
13239 Fget (var
, Qlast_arrow_position
))
13240 || ! (pstr
= overlay_arrow_string_or_property (var
),
13241 EQ (pstr
, Fget (var
, Qlast_arrow_string
))))
13247 /* Mark overlay arrows to be updated on next redisplay. */
13250 update_overlay_arrows (int up_to_date
)
13254 for (vlist
= Voverlay_arrow_variable_list
;
13256 vlist
= XCDR (vlist
))
13258 Lisp_Object var
= XCAR (vlist
);
13260 if (!SYMBOLP (var
))
13263 if (up_to_date
> 0)
13265 Lisp_Object val
= find_symbol_value (var
);
13266 Fput (var
, Qlast_arrow_position
,
13267 COERCE_MARKER (val
));
13268 Fput (var
, Qlast_arrow_string
,
13269 overlay_arrow_string_or_property (var
));
13271 else if (up_to_date
< 0
13272 || !NILP (Fget (var
, Qlast_arrow_position
)))
13274 Fput (var
, Qlast_arrow_position
, Qt
);
13275 Fput (var
, Qlast_arrow_string
, Qt
);
13281 /* Return overlay arrow string to display at row.
13282 Return integer (bitmap number) for arrow bitmap in left fringe.
13283 Return nil if no overlay arrow. */
13286 overlay_arrow_at_row (struct it
*it
, struct glyph_row
*row
)
13290 for (vlist
= Voverlay_arrow_variable_list
;
13292 vlist
= XCDR (vlist
))
13294 Lisp_Object var
= XCAR (vlist
);
13297 if (!SYMBOLP (var
))
13300 val
= find_symbol_value (var
);
13303 && current_buffer
== XMARKER (val
)->buffer
13304 && (MATRIX_ROW_START_CHARPOS (row
) == marker_position (val
)))
13306 if (FRAME_WINDOW_P (it
->f
)
13307 /* FIXME: if ROW->reversed_p is set, this should test
13308 the right fringe, not the left one. */
13309 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) > 0)
13311 #ifdef HAVE_WINDOW_SYSTEM
13312 if (val
= Fget (var
, Qoverlay_arrow_bitmap
), SYMBOLP (val
))
13315 if ((fringe_bitmap
= lookup_fringe_bitmap (val
)) != 0)
13316 return make_number (fringe_bitmap
);
13319 return make_number (-1); /* Use default arrow bitmap. */
13321 return overlay_arrow_string_or_property (var
);
13328 /* Return 1 if point moved out of or into a composition. Otherwise
13329 return 0. PREV_BUF and PREV_PT are the last point buffer and
13330 position. BUF and PT are the current point buffer and position. */
13333 check_point_in_composition (struct buffer
*prev_buf
, ptrdiff_t prev_pt
,
13334 struct buffer
*buf
, ptrdiff_t pt
)
13336 ptrdiff_t start
, end
;
13338 Lisp_Object buffer
;
13340 XSETBUFFER (buffer
, buf
);
13341 /* Check a composition at the last point if point moved within the
13343 if (prev_buf
== buf
)
13346 /* Point didn't move. */
13349 if (prev_pt
> BUF_BEGV (buf
) && prev_pt
< BUF_ZV (buf
)
13350 && find_composition (prev_pt
, -1, &start
, &end
, &prop
, buffer
)
13351 && composition_valid_p (start
, end
, prop
)
13352 && start
< prev_pt
&& end
> prev_pt
)
13353 /* The last point was within the composition. Return 1 iff
13354 point moved out of the composition. */
13355 return (pt
<= start
|| pt
>= end
);
13358 /* Check a composition at the current point. */
13359 return (pt
> BUF_BEGV (buf
) && pt
< BUF_ZV (buf
)
13360 && find_composition (pt
, -1, &start
, &end
, &prop
, buffer
)
13361 && composition_valid_p (start
, end
, prop
)
13362 && start
< pt
&& end
> pt
);
13365 /* Reconsider the clip changes of buffer which is displayed in W. */
13368 reconsider_clip_changes (struct window
*w
)
13370 struct buffer
*b
= XBUFFER (w
->contents
);
13372 if (b
->clip_changed
13373 && w
->window_end_valid
13374 && w
->current_matrix
->buffer
== b
13375 && w
->current_matrix
->zv
== BUF_ZV (b
)
13376 && w
->current_matrix
->begv
== BUF_BEGV (b
))
13377 b
->clip_changed
= 0;
13379 /* If display wasn't paused, and W is not a tool bar window, see if
13380 point has been moved into or out of a composition. In that case,
13381 we set b->clip_changed to 1 to force updating the screen. If
13382 b->clip_changed has already been set to 1, we can skip this
13384 if (!b
->clip_changed
&& w
->window_end_valid
)
13386 ptrdiff_t pt
= (w
== XWINDOW (selected_window
)
13387 ? PT
: marker_position (w
->pointm
));
13389 if ((w
->current_matrix
->buffer
!= b
|| pt
!= w
->last_point
)
13390 && check_point_in_composition (w
->current_matrix
->buffer
,
13391 w
->last_point
, b
, pt
))
13392 b
->clip_changed
= 1;
13397 propagate_buffer_redisplay (void)
13398 { /* Resetting b->text->redisplay is problematic!
13399 We can't just reset it in the case that some window that displays
13400 it has not been redisplayed; and such a window can stay
13401 unredisplayed for a long time if it's currently invisible.
13402 But we do want to reset it at the end of redisplay otherwise
13403 its displayed windows will keep being redisplayed over and over
13405 So we copy all b->text->redisplay flags up to their windows here,
13406 such that mark_window_display_accurate can safely reset
13407 b->text->redisplay. */
13408 Lisp_Object ws
= window_list ();
13409 for (; CONSP (ws
); ws
= XCDR (ws
))
13411 struct window
*thisw
= XWINDOW (XCAR (ws
));
13412 struct buffer
*thisb
= XBUFFER (thisw
->contents
);
13413 if (thisb
->text
->redisplay
)
13414 thisw
->redisplay
= true;
13418 #define STOP_POLLING \
13419 do { if (! polling_stopped_here) stop_polling (); \
13420 polling_stopped_here = 1; } while (0)
13422 #define RESUME_POLLING \
13423 do { if (polling_stopped_here) start_polling (); \
13424 polling_stopped_here = 0; } while (0)
13427 /* Perhaps in the future avoid recentering windows if it
13428 is not necessary; currently that causes some problems. */
13431 redisplay_internal (void)
13433 struct window
*w
= XWINDOW (selected_window
);
13437 bool must_finish
= 0, match_p
;
13438 struct text_pos tlbufpos
, tlendpos
;
13439 int number_of_visible_frames
;
13442 int polling_stopped_here
= 0;
13443 Lisp_Object tail
, frame
;
13445 /* True means redisplay has to consider all windows on all
13446 frames. False, only selected_window is considered. */
13447 bool consider_all_windows_p
;
13449 /* True means redisplay has to redisplay the miniwindow. */
13450 bool update_miniwindow_p
= false;
13452 TRACE ((stderr
, "redisplay_internal %d\n", redisplaying_p
));
13454 /* No redisplay if running in batch mode or frame is not yet fully
13455 initialized, or redisplay is explicitly turned off by setting
13456 Vinhibit_redisplay. */
13457 if (FRAME_INITIAL_P (SELECTED_FRAME ())
13458 || !NILP (Vinhibit_redisplay
))
13461 /* Don't examine these until after testing Vinhibit_redisplay.
13462 When Emacs is shutting down, perhaps because its connection to
13463 X has dropped, we should not look at them at all. */
13464 fr
= XFRAME (w
->frame
);
13465 sf
= SELECTED_FRAME ();
13467 if (!fr
->glyphs_initialized_p
)
13470 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
13471 if (popup_activated ())
13475 /* I don't think this happens but let's be paranoid. */
13476 if (redisplaying_p
)
13479 /* Record a function that clears redisplaying_p
13480 when we leave this function. */
13481 count
= SPECPDL_INDEX ();
13482 record_unwind_protect_void (unwind_redisplay
);
13483 redisplaying_p
= 1;
13484 specbind (Qinhibit_free_realized_faces
, Qnil
);
13486 /* Record this function, so it appears on the profiler's backtraces. */
13487 record_in_backtrace (Qredisplay_internal
, &Qnil
, 0);
13489 FOR_EACH_FRAME (tail
, frame
)
13490 XFRAME (frame
)->already_hscrolled_p
= 0;
13493 /* Remember the currently selected window. */
13497 last_escape_glyph_frame
= NULL
;
13498 last_escape_glyph_face_id
= (1 << FACE_ID_BITS
);
13499 last_glyphless_glyph_frame
= NULL
;
13500 last_glyphless_glyph_face_id
= (1 << FACE_ID_BITS
);
13502 /* If face_change_count is non-zero, init_iterator will free all
13503 realized faces, which includes the faces referenced from current
13504 matrices. So, we can't reuse current matrices in this case. */
13505 if (face_change_count
)
13506 windows_or_buffers_changed
= 47;
13508 if ((FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
13509 && FRAME_TTY (sf
)->previous_frame
!= sf
)
13511 /* Since frames on a single ASCII terminal share the same
13512 display area, displaying a different frame means redisplay
13513 the whole thing. */
13514 SET_FRAME_GARBAGED (sf
);
13516 set_tty_color_mode (FRAME_TTY (sf
), sf
);
13518 FRAME_TTY (sf
)->previous_frame
= sf
;
13521 /* Set the visible flags for all frames. Do this before checking for
13522 resized or garbaged frames; they want to know if their frames are
13523 visible. See the comment in frame.h for FRAME_SAMPLE_VISIBILITY. */
13524 number_of_visible_frames
= 0;
13526 FOR_EACH_FRAME (tail
, frame
)
13528 struct frame
*f
= XFRAME (frame
);
13530 if (FRAME_VISIBLE_P (f
))
13532 ++number_of_visible_frames
;
13533 /* Adjust matrices for visible frames only. */
13534 if (f
->fonts_changed
)
13536 adjust_frame_glyphs (f
);
13537 f
->fonts_changed
= 0;
13539 /* If cursor type has been changed on the frame
13540 other than selected, consider all frames. */
13541 if (f
!= sf
&& f
->cursor_type_changed
)
13542 update_mode_lines
= 31;
13544 clear_desired_matrices (f
);
13547 /* Notice any pending interrupt request to change frame size. */
13548 do_pending_window_change (1);
13550 /* do_pending_window_change could change the selected_window due to
13551 frame resizing which makes the selected window too small. */
13552 if (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
)
13555 /* Clear frames marked as garbaged. */
13556 clear_garbaged_frames ();
13558 /* Build menubar and tool-bar items. */
13559 if (NILP (Vmemory_full
))
13560 prepare_menu_bars ();
13562 reconsider_clip_changes (w
);
13564 /* In most cases selected window displays current buffer. */
13565 match_p
= XBUFFER (w
->contents
) == current_buffer
;
13568 /* Detect case that we need to write or remove a star in the mode line. */
13569 if ((SAVE_MODIFF
< MODIFF
) != w
->last_had_star
)
13570 w
->update_mode_line
= 1;
13572 if (mode_line_update_needed (w
))
13573 w
->update_mode_line
= 1;
13575 /* If reconsider_clip_changes above decided that the narrowing
13576 in the current buffer changed, make sure all other windows
13577 showing that buffer will be redisplayed. */
13578 if (current_buffer
->clip_changed
)
13579 bset_update_mode_line (current_buffer
);
13582 /* Normally the message* functions will have already displayed and
13583 updated the echo area, but the frame may have been trashed, or
13584 the update may have been preempted, so display the echo area
13585 again here. Checking message_cleared_p captures the case that
13586 the echo area should be cleared. */
13587 if ((!NILP (echo_area_buffer
[0]) && !display_last_displayed_message_p
)
13588 || (!NILP (echo_area_buffer
[1]) && display_last_displayed_message_p
)
13589 || (message_cleared_p
13590 && minibuf_level
== 0
13591 /* If the mini-window is currently selected, this means the
13592 echo-area doesn't show through. */
13593 && !MINI_WINDOW_P (XWINDOW (selected_window
))))
13595 int window_height_changed_p
= echo_area_display (0);
13597 if (message_cleared_p
)
13598 update_miniwindow_p
= true;
13602 /* If we don't display the current message, don't clear the
13603 message_cleared_p flag, because, if we did, we wouldn't clear
13604 the echo area in the next redisplay which doesn't preserve
13606 if (!display_last_displayed_message_p
)
13607 message_cleared_p
= 0;
13609 if (window_height_changed_p
)
13611 windows_or_buffers_changed
= 50;
13613 /* If window configuration was changed, frames may have been
13614 marked garbaged. Clear them or we will experience
13615 surprises wrt scrolling. */
13616 clear_garbaged_frames ();
13619 else if (EQ (selected_window
, minibuf_window
)
13620 && (current_buffer
->clip_changed
|| window_outdated (w
))
13621 && resize_mini_window (w
, 0))
13623 /* Resized active mini-window to fit the size of what it is
13624 showing if its contents might have changed. */
13627 /* If window configuration was changed, frames may have been
13628 marked garbaged. Clear them or we will experience
13629 surprises wrt scrolling. */
13630 clear_garbaged_frames ();
13633 if (windows_or_buffers_changed
&& !update_mode_lines
)
13634 /* Code that sets windows_or_buffers_changed doesn't distinguish whether
13635 only the windows's contents needs to be refreshed, or whether the
13636 mode-lines also need a refresh. */
13637 update_mode_lines
= (windows_or_buffers_changed
== REDISPLAY_SOME
13638 ? REDISPLAY_SOME
: 32);
13640 /* If specs for an arrow have changed, do thorough redisplay
13641 to ensure we remove any arrow that should no longer exist. */
13642 if (overlay_arrows_changed_p ())
13643 /* Apparently, this is the only case where we update other windows,
13644 without updating other mode-lines. */
13645 windows_or_buffers_changed
= 49;
13647 consider_all_windows_p
= (update_mode_lines
13648 || windows_or_buffers_changed
);
13650 #define AINC(a,i) \
13651 if (VECTORP (a) && i >= 0 && i < ASIZE (a) && INTEGERP (AREF (a, i))) \
13652 ASET (a, i, make_number (1 + XINT (AREF (a, i))))
13654 AINC (Vredisplay__all_windows_cause
, windows_or_buffers_changed
);
13655 AINC (Vredisplay__mode_lines_cause
, update_mode_lines
);
13657 /* Optimize the case that only the line containing the cursor in the
13658 selected window has changed. Variables starting with this_ are
13659 set in display_line and record information about the line
13660 containing the cursor. */
13661 tlbufpos
= this_line_start_pos
;
13662 tlendpos
= this_line_end_pos
;
13663 if (!consider_all_windows_p
13664 && CHARPOS (tlbufpos
) > 0
13665 && !w
->update_mode_line
13666 && !current_buffer
->clip_changed
13667 && !current_buffer
->prevent_redisplay_optimizations_p
13668 && FRAME_VISIBLE_P (XFRAME (w
->frame
))
13669 && !FRAME_OBSCURED_P (XFRAME (w
->frame
))
13670 && !XFRAME (w
->frame
)->cursor_type_changed
13671 /* Make sure recorded data applies to current buffer, etc. */
13672 && this_line_buffer
== current_buffer
13675 && !w
->optional_new_start
13676 /* Point must be on the line that we have info recorded about. */
13677 && PT
>= CHARPOS (tlbufpos
)
13678 && PT
<= Z
- CHARPOS (tlendpos
)
13679 /* All text outside that line, including its final newline,
13680 must be unchanged. */
13681 && text_outside_line_unchanged_p (w
, CHARPOS (tlbufpos
),
13682 CHARPOS (tlendpos
)))
13684 if (CHARPOS (tlbufpos
) > BEGV
13685 && FETCH_BYTE (BYTEPOS (tlbufpos
) - 1) != '\n'
13686 && (CHARPOS (tlbufpos
) == ZV
13687 || FETCH_BYTE (BYTEPOS (tlbufpos
)) == '\n'))
13688 /* Former continuation line has disappeared by becoming empty. */
13690 else if (window_outdated (w
) || MINI_WINDOW_P (w
))
13692 /* We have to handle the case of continuation around a
13693 wide-column character (see the comment in indent.c around
13696 For instance, in the following case:
13698 -------- Insert --------
13699 K_A_N_\\ `a' K_A_N_a\ `X_' are wide-column chars.
13700 J_I_ ==> J_I_ `^^' are cursors.
13704 As we have to redraw the line above, we cannot use this
13708 int line_height_before
= this_line_pixel_height
;
13710 /* Note that start_display will handle the case that the
13711 line starting at tlbufpos is a continuation line. */
13712 start_display (&it
, w
, tlbufpos
);
13714 /* Implementation note: It this still necessary? */
13715 if (it
.current_x
!= this_line_start_x
)
13718 TRACE ((stderr
, "trying display optimization 1\n"));
13719 w
->cursor
.vpos
= -1;
13720 overlay_arrow_seen
= 0;
13721 it
.vpos
= this_line_vpos
;
13722 it
.current_y
= this_line_y
;
13723 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, this_line_vpos
);
13724 display_line (&it
);
13726 /* If line contains point, is not continued,
13727 and ends at same distance from eob as before, we win. */
13728 if (w
->cursor
.vpos
>= 0
13729 /* Line is not continued, otherwise this_line_start_pos
13730 would have been set to 0 in display_line. */
13731 && CHARPOS (this_line_start_pos
)
13732 /* Line ends as before. */
13733 && CHARPOS (this_line_end_pos
) == CHARPOS (tlendpos
)
13734 /* Line has same height as before. Otherwise other lines
13735 would have to be shifted up or down. */
13736 && this_line_pixel_height
== line_height_before
)
13738 /* If this is not the window's last line, we must adjust
13739 the charstarts of the lines below. */
13740 if (it
.current_y
< it
.last_visible_y
)
13742 struct glyph_row
*row
13743 = MATRIX_ROW (w
->current_matrix
, this_line_vpos
+ 1);
13744 ptrdiff_t delta
, delta_bytes
;
13746 /* We used to distinguish between two cases here,
13747 conditioned by Z - CHARPOS (tlendpos) == ZV, for
13748 when the line ends in a newline or the end of the
13749 buffer's accessible portion. But both cases did
13750 the same, so they were collapsed. */
13752 - CHARPOS (tlendpos
)
13753 - MATRIX_ROW_START_CHARPOS (row
));
13754 delta_bytes
= (Z_BYTE
13755 - BYTEPOS (tlendpos
)
13756 - MATRIX_ROW_START_BYTEPOS (row
));
13758 increment_matrix_positions (w
->current_matrix
,
13759 this_line_vpos
+ 1,
13760 w
->current_matrix
->nrows
,
13761 delta
, delta_bytes
);
13764 /* If this row displays text now but previously didn't,
13765 or vice versa, w->window_end_vpos may have to be
13767 if (MATRIX_ROW_DISPLAYS_TEXT_P (it
.glyph_row
- 1))
13769 if (w
->window_end_vpos
< this_line_vpos
)
13770 w
->window_end_vpos
= this_line_vpos
;
13772 else if (w
->window_end_vpos
== this_line_vpos
13773 && this_line_vpos
> 0)
13774 w
->window_end_vpos
= this_line_vpos
- 1;
13775 w
->window_end_valid
= 0;
13777 /* Update hint: No need to try to scroll in update_window. */
13778 w
->desired_matrix
->no_scrolling_p
= 1;
13781 *w
->desired_matrix
->method
= 0;
13782 debug_method_add (w
, "optimization 1");
13784 #ifdef HAVE_WINDOW_SYSTEM
13785 update_window_fringes (w
, 0);
13792 else if (/* Cursor position hasn't changed. */
13793 PT
== w
->last_point
13794 /* Make sure the cursor was last displayed
13795 in this window. Otherwise we have to reposition it. */
13797 /* PXW: Must be converted to pixels, probably. */
13798 && 0 <= w
->cursor
.vpos
13799 && w
->cursor
.vpos
< WINDOW_TOTAL_LINES (w
))
13803 do_pending_window_change (1);
13804 /* If selected_window changed, redisplay again. */
13805 if (WINDOWP (selected_window
)
13806 && (w
= XWINDOW (selected_window
)) != sw
)
13809 /* We used to always goto end_of_redisplay here, but this
13810 isn't enough if we have a blinking cursor. */
13811 if (w
->cursor_off_p
== w
->last_cursor_off_p
)
13812 goto end_of_redisplay
;
13816 /* If highlighting the region, or if the cursor is in the echo area,
13817 then we can't just move the cursor. */
13818 else if (NILP (Vshow_trailing_whitespace
)
13819 && !cursor_in_echo_area
)
13822 struct glyph_row
*row
;
13824 /* Skip from tlbufpos to PT and see where it is. Note that
13825 PT may be in invisible text. If so, we will end at the
13826 next visible position. */
13827 init_iterator (&it
, w
, CHARPOS (tlbufpos
), BYTEPOS (tlbufpos
),
13828 NULL
, DEFAULT_FACE_ID
);
13829 it
.current_x
= this_line_start_x
;
13830 it
.current_y
= this_line_y
;
13831 it
.vpos
= this_line_vpos
;
13833 /* The call to move_it_to stops in front of PT, but
13834 moves over before-strings. */
13835 move_it_to (&it
, PT
, -1, -1, -1, MOVE_TO_POS
);
13837 if (it
.vpos
== this_line_vpos
13838 && (row
= MATRIX_ROW (w
->current_matrix
, this_line_vpos
),
13841 eassert (this_line_vpos
== it
.vpos
);
13842 eassert (this_line_y
== it
.current_y
);
13843 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
13845 *w
->desired_matrix
->method
= 0;
13846 debug_method_add (w
, "optimization 3");
13855 /* Text changed drastically or point moved off of line. */
13856 SET_MATRIX_ROW_ENABLED_P (w
->desired_matrix
, this_line_vpos
, false);
13859 CHARPOS (this_line_start_pos
) = 0;
13860 ++clear_face_cache_count
;
13861 #ifdef HAVE_WINDOW_SYSTEM
13862 ++clear_image_cache_count
;
13865 /* Build desired matrices, and update the display. If
13866 consider_all_windows_p is non-zero, do it for all windows on all
13867 frames. Otherwise do it for selected_window, only. */
13869 if (consider_all_windows_p
)
13871 FOR_EACH_FRAME (tail
, frame
)
13872 XFRAME (frame
)->updated_p
= 0;
13874 propagate_buffer_redisplay ();
13876 FOR_EACH_FRAME (tail
, frame
)
13878 struct frame
*f
= XFRAME (frame
);
13880 /* We don't have to do anything for unselected terminal
13882 if ((FRAME_TERMCAP_P (f
) || FRAME_MSDOS_P (f
))
13883 && !EQ (FRAME_TTY (f
)->top_frame
, frame
))
13888 if (FRAME_WINDOW_P (f
) || FRAME_TERMCAP_P (f
) || f
== sf
)
13891 /* Only GC scrollbars when we redisplay the whole frame. */
13892 = f
->redisplay
|| !REDISPLAY_SOME_P ();
13893 /* Mark all the scroll bars to be removed; we'll redeem
13894 the ones we want when we redisplay their windows. */
13895 if (gcscrollbars
&& FRAME_TERMINAL (f
)->condemn_scroll_bars_hook
)
13896 FRAME_TERMINAL (f
)->condemn_scroll_bars_hook (f
);
13898 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13899 redisplay_windows (FRAME_ROOT_WINDOW (f
));
13900 /* Remember that the invisible frames need to be redisplayed next
13901 time they're visible. */
13902 else if (!REDISPLAY_SOME_P ())
13903 f
->redisplay
= true;
13905 /* The X error handler may have deleted that frame. */
13906 if (!FRAME_LIVE_P (f
))
13909 /* Any scroll bars which redisplay_windows should have
13910 nuked should now go away. */
13911 if (gcscrollbars
&& FRAME_TERMINAL (f
)->judge_scroll_bars_hook
)
13912 FRAME_TERMINAL (f
)->judge_scroll_bars_hook (f
);
13914 if (FRAME_VISIBLE_P (f
) && !FRAME_OBSCURED_P (f
))
13916 /* If fonts changed on visible frame, display again. */
13917 if (f
->fonts_changed
)
13919 adjust_frame_glyphs (f
);
13920 f
->fonts_changed
= 0;
13924 /* See if we have to hscroll. */
13925 if (!f
->already_hscrolled_p
)
13927 f
->already_hscrolled_p
= 1;
13928 if (hscroll_windows (f
->root_window
))
13932 /* Prevent various kinds of signals during display
13933 update. stdio is not robust about handling
13934 signals, which can cause an apparent I/O error. */
13935 if (interrupt_input
)
13936 unrequest_sigio ();
13939 pending
|= update_frame (f
, 0, 0);
13940 f
->cursor_type_changed
= 0;
13946 eassert (EQ (XFRAME (selected_frame
)->selected_window
, selected_window
));
13950 /* Do the mark_window_display_accurate after all windows have
13951 been redisplayed because this call resets flags in buffers
13952 which are needed for proper redisplay. */
13953 FOR_EACH_FRAME (tail
, frame
)
13955 struct frame
*f
= XFRAME (frame
);
13958 f
->redisplay
= false;
13959 mark_window_display_accurate (f
->root_window
, 1);
13960 if (FRAME_TERMINAL (f
)->frame_up_to_date_hook
)
13961 FRAME_TERMINAL (f
)->frame_up_to_date_hook (f
);
13966 else if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13968 Lisp_Object mini_window
= FRAME_MINIBUF_WINDOW (sf
);
13969 struct frame
*mini_frame
;
13971 displayed_buffer
= XBUFFER (XWINDOW (selected_window
)->contents
);
13972 /* Use list_of_error, not Qerror, so that
13973 we catch only errors and don't run the debugger. */
13974 internal_condition_case_1 (redisplay_window_1
, selected_window
,
13976 redisplay_window_error
);
13977 if (update_miniwindow_p
)
13978 internal_condition_case_1 (redisplay_window_1
, mini_window
,
13980 redisplay_window_error
);
13982 /* Compare desired and current matrices, perform output. */
13985 /* If fonts changed, display again. */
13986 if (sf
->fonts_changed
)
13989 /* Prevent various kinds of signals during display update.
13990 stdio is not robust about handling signals,
13991 which can cause an apparent I/O error. */
13992 if (interrupt_input
)
13993 unrequest_sigio ();
13996 if (FRAME_VISIBLE_P (sf
) && !FRAME_OBSCURED_P (sf
))
13998 if (hscroll_windows (selected_window
))
14001 XWINDOW (selected_window
)->must_be_updated_p
= true;
14002 pending
= update_frame (sf
, 0, 0);
14003 sf
->cursor_type_changed
= 0;
14006 /* We may have called echo_area_display at the top of this
14007 function. If the echo area is on another frame, that may
14008 have put text on a frame other than the selected one, so the
14009 above call to update_frame would not have caught it. Catch
14011 mini_window
= FRAME_MINIBUF_WINDOW (sf
);
14012 mini_frame
= XFRAME (WINDOW_FRAME (XWINDOW (mini_window
)));
14014 if (mini_frame
!= sf
&& FRAME_WINDOW_P (mini_frame
))
14016 XWINDOW (mini_window
)->must_be_updated_p
= true;
14017 pending
|= update_frame (mini_frame
, 0, 0);
14018 mini_frame
->cursor_type_changed
= 0;
14019 if (!pending
&& hscroll_windows (mini_window
))
14024 /* If display was paused because of pending input, make sure we do a
14025 thorough update the next time. */
14028 /* Prevent the optimization at the beginning of
14029 redisplay_internal that tries a single-line update of the
14030 line containing the cursor in the selected window. */
14031 CHARPOS (this_line_start_pos
) = 0;
14033 /* Let the overlay arrow be updated the next time. */
14034 update_overlay_arrows (0);
14036 /* If we pause after scrolling, some rows in the current
14037 matrices of some windows are not valid. */
14038 if (!WINDOW_FULL_WIDTH_P (w
)
14039 && !FRAME_WINDOW_P (XFRAME (w
->frame
)))
14040 update_mode_lines
= 36;
14044 if (!consider_all_windows_p
)
14046 /* This has already been done above if
14047 consider_all_windows_p is set. */
14048 if (XBUFFER (w
->contents
)->text
->redisplay
14049 && buffer_window_count (XBUFFER (w
->contents
)) > 1)
14050 /* This can happen if b->text->redisplay was set during
14052 propagate_buffer_redisplay ();
14053 mark_window_display_accurate_1 (w
, 1);
14055 /* Say overlay arrows are up to date. */
14056 update_overlay_arrows (1);
14058 if (FRAME_TERMINAL (sf
)->frame_up_to_date_hook
!= 0)
14059 FRAME_TERMINAL (sf
)->frame_up_to_date_hook (sf
);
14062 update_mode_lines
= 0;
14063 windows_or_buffers_changed
= 0;
14066 /* Start SIGIO interrupts coming again. Having them off during the
14067 code above makes it less likely one will discard output, but not
14068 impossible, since there might be stuff in the system buffer here.
14069 But it is much hairier to try to do anything about that. */
14070 if (interrupt_input
)
14074 /* If a frame has become visible which was not before, redisplay
14075 again, so that we display it. Expose events for such a frame
14076 (which it gets when becoming visible) don't call the parts of
14077 redisplay constructing glyphs, so simply exposing a frame won't
14078 display anything in this case. So, we have to display these
14079 frames here explicitly. */
14084 FOR_EACH_FRAME (tail
, frame
)
14086 if (XFRAME (frame
)->visible
)
14090 if (new_count
!= number_of_visible_frames
)
14091 windows_or_buffers_changed
= 52;
14094 /* Change frame size now if a change is pending. */
14095 do_pending_window_change (1);
14097 /* If we just did a pending size change, or have additional
14098 visible frames, or selected_window changed, redisplay again. */
14099 if ((windows_or_buffers_changed
&& !pending
)
14100 || (WINDOWP (selected_window
) && (w
= XWINDOW (selected_window
)) != sw
))
14103 /* Clear the face and image caches.
14105 We used to do this only if consider_all_windows_p. But the cache
14106 needs to be cleared if a timer creates images in the current
14107 buffer (e.g. the test case in Bug#6230). */
14109 if (clear_face_cache_count
> CLEAR_FACE_CACHE_COUNT
)
14111 clear_face_cache (0);
14112 clear_face_cache_count
= 0;
14115 #ifdef HAVE_WINDOW_SYSTEM
14116 if (clear_image_cache_count
> CLEAR_IMAGE_CACHE_COUNT
)
14118 clear_image_caches (Qnil
);
14119 clear_image_cache_count
= 0;
14121 #endif /* HAVE_WINDOW_SYSTEM */
14124 if (interrupt_input
&& interrupts_deferred
)
14127 unbind_to (count
, Qnil
);
14132 /* Redisplay, but leave alone any recent echo area message unless
14133 another message has been requested in its place.
14135 This is useful in situations where you need to redisplay but no
14136 user action has occurred, making it inappropriate for the message
14137 area to be cleared. See tracking_off and
14138 wait_reading_process_output for examples of these situations.
14140 FROM_WHERE is an integer saying from where this function was
14141 called. This is useful for debugging. */
14144 redisplay_preserve_echo_area (int from_where
)
14146 TRACE ((stderr
, "redisplay_preserve_echo_area (%d)\n", from_where
));
14148 if (!NILP (echo_area_buffer
[1]))
14150 /* We have a previously displayed message, but no current
14151 message. Redisplay the previous message. */
14152 display_last_displayed_message_p
= 1;
14153 redisplay_internal ();
14154 display_last_displayed_message_p
= 0;
14157 redisplay_internal ();
14159 flush_frame (SELECTED_FRAME ());
14163 /* Function registered with record_unwind_protect in redisplay_internal. */
14166 unwind_redisplay (void)
14168 redisplaying_p
= 0;
14172 /* Mark the display of leaf window W as accurate or inaccurate.
14173 If ACCURATE_P is non-zero mark display of W as accurate. If
14174 ACCURATE_P is zero, arrange for W to be redisplayed the next
14175 time redisplay_internal is called. */
14178 mark_window_display_accurate_1 (struct window
*w
, int accurate_p
)
14180 struct buffer
*b
= XBUFFER (w
->contents
);
14182 w
->last_modified
= accurate_p
? BUF_MODIFF (b
) : 0;
14183 w
->last_overlay_modified
= accurate_p
? BUF_OVERLAY_MODIFF (b
) : 0;
14184 w
->last_had_star
= BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
);
14188 b
->clip_changed
= false;
14189 b
->prevent_redisplay_optimizations_p
= false;
14190 eassert (buffer_window_count (b
) > 0);
14191 /* Resetting b->text->redisplay is problematic!
14192 In order to make it safer to do it here, redisplay_internal must
14193 have copied all b->text->redisplay to their respective windows. */
14194 b
->text
->redisplay
= false;
14196 BUF_UNCHANGED_MODIFIED (b
) = BUF_MODIFF (b
);
14197 BUF_OVERLAY_UNCHANGED_MODIFIED (b
) = BUF_OVERLAY_MODIFF (b
);
14198 BUF_BEG_UNCHANGED (b
) = BUF_GPT (b
) - BUF_BEG (b
);
14199 BUF_END_UNCHANGED (b
) = BUF_Z (b
) - BUF_GPT (b
);
14201 w
->current_matrix
->buffer
= b
;
14202 w
->current_matrix
->begv
= BUF_BEGV (b
);
14203 w
->current_matrix
->zv
= BUF_ZV (b
);
14205 w
->last_cursor_vpos
= w
->cursor
.vpos
;
14206 w
->last_cursor_off_p
= w
->cursor_off_p
;
14208 if (w
== XWINDOW (selected_window
))
14209 w
->last_point
= BUF_PT (b
);
14211 w
->last_point
= marker_position (w
->pointm
);
14213 w
->window_end_valid
= true;
14214 w
->update_mode_line
= false;
14217 w
->redisplay
= !accurate_p
;
14221 /* Mark the display of windows in the window tree rooted at WINDOW as
14222 accurate or inaccurate. If ACCURATE_P is non-zero mark display of
14223 windows as accurate. If ACCURATE_P is zero, arrange for windows to
14224 be redisplayed the next time redisplay_internal is called. */
14227 mark_window_display_accurate (Lisp_Object window
, int accurate_p
)
14231 for (; !NILP (window
); window
= w
->next
)
14233 w
= XWINDOW (window
);
14234 if (WINDOWP (w
->contents
))
14235 mark_window_display_accurate (w
->contents
, accurate_p
);
14237 mark_window_display_accurate_1 (w
, accurate_p
);
14241 update_overlay_arrows (1);
14243 /* Force a thorough redisplay the next time by setting
14244 last_arrow_position and last_arrow_string to t, which is
14245 unequal to any useful value of Voverlay_arrow_... */
14246 update_overlay_arrows (-1);
14250 /* Return value in display table DP (Lisp_Char_Table *) for character
14251 C. Since a display table doesn't have any parent, we don't have to
14252 follow parent. Do not call this function directly but use the
14253 macro DISP_CHAR_VECTOR. */
14256 disp_char_vector (struct Lisp_Char_Table
*dp
, int c
)
14260 if (ASCII_CHAR_P (c
))
14263 if (SUB_CHAR_TABLE_P (val
))
14264 val
= XSUB_CHAR_TABLE (val
)->contents
[c
];
14270 XSETCHAR_TABLE (table
, dp
);
14271 val
= char_table_ref (table
, c
);
14280 /***********************************************************************
14282 ***********************************************************************/
14284 /* Redisplay all leaf windows in the window tree rooted at WINDOW. */
14287 redisplay_windows (Lisp_Object window
)
14289 while (!NILP (window
))
14291 struct window
*w
= XWINDOW (window
);
14293 if (WINDOWP (w
->contents
))
14294 redisplay_windows (w
->contents
);
14295 else if (BUFFERP (w
->contents
))
14297 displayed_buffer
= XBUFFER (w
->contents
);
14298 /* Use list_of_error, not Qerror, so that
14299 we catch only errors and don't run the debugger. */
14300 internal_condition_case_1 (redisplay_window_0
, window
,
14302 redisplay_window_error
);
14310 redisplay_window_error (Lisp_Object ignore
)
14312 displayed_buffer
->display_error_modiff
= BUF_MODIFF (displayed_buffer
);
14317 redisplay_window_0 (Lisp_Object window
)
14319 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14320 redisplay_window (window
, false);
14325 redisplay_window_1 (Lisp_Object window
)
14327 if (displayed_buffer
->display_error_modiff
< BUF_MODIFF (displayed_buffer
))
14328 redisplay_window (window
, true);
14333 /* Set cursor position of W. PT is assumed to be displayed in ROW.
14334 DELTA and DELTA_BYTES are the numbers of characters and bytes by
14335 which positions recorded in ROW differ from current buffer
14338 Return 0 if cursor is not on this row, 1 otherwise. */
14341 set_cursor_from_row (struct window
*w
, struct glyph_row
*row
,
14342 struct glyph_matrix
*matrix
,
14343 ptrdiff_t delta
, ptrdiff_t delta_bytes
,
14346 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
];
14347 struct glyph
*end
= glyph
+ row
->used
[TEXT_AREA
];
14348 struct glyph
*cursor
= NULL
;
14349 /* The last known character position in row. */
14350 ptrdiff_t last_pos
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14352 ptrdiff_t pt_old
= PT
- delta
;
14353 ptrdiff_t pos_before
= MATRIX_ROW_START_CHARPOS (row
) + delta
;
14354 ptrdiff_t pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14355 struct glyph
*glyph_before
= glyph
- 1, *glyph_after
= end
;
14356 /* A glyph beyond the edge of TEXT_AREA which we should never
14358 struct glyph
*glyphs_end
= end
;
14359 /* Non-zero means we've found a match for cursor position, but that
14360 glyph has the avoid_cursor_p flag set. */
14361 int match_with_avoid_cursor
= 0;
14362 /* Non-zero means we've seen at least one glyph that came from a
14364 int string_seen
= 0;
14365 /* Largest and smallest buffer positions seen so far during scan of
14367 ptrdiff_t bpos_max
= pos_before
;
14368 ptrdiff_t bpos_min
= pos_after
;
14369 /* Last buffer position covered by an overlay string with an integer
14370 `cursor' property. */
14371 ptrdiff_t bpos_covered
= 0;
14372 /* Non-zero means the display string on which to display the cursor
14373 comes from a text property, not from an overlay. */
14374 int string_from_text_prop
= 0;
14376 /* Don't even try doing anything if called for a mode-line or
14377 header-line row, since the rest of the code isn't prepared to
14378 deal with such calamities. */
14379 eassert (!row
->mode_line_p
);
14380 if (row
->mode_line_p
)
14383 /* Skip over glyphs not having an object at the start and the end of
14384 the row. These are special glyphs like truncation marks on
14385 terminal frames. */
14386 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
14388 if (!row
->reversed_p
)
14391 && INTEGERP (glyph
->object
)
14392 && glyph
->charpos
< 0)
14394 x
+= glyph
->pixel_width
;
14398 && INTEGERP ((end
- 1)->object
)
14399 /* CHARPOS is zero for blanks and stretch glyphs
14400 inserted by extend_face_to_end_of_line. */
14401 && (end
- 1)->charpos
<= 0)
14403 glyph_before
= glyph
- 1;
14410 /* If the glyph row is reversed, we need to process it from back
14411 to front, so swap the edge pointers. */
14412 glyphs_end
= end
= glyph
- 1;
14413 glyph
+= row
->used
[TEXT_AREA
] - 1;
14415 while (glyph
> end
+ 1
14416 && INTEGERP (glyph
->object
)
14417 && glyph
->charpos
< 0)
14420 x
-= glyph
->pixel_width
;
14422 if (INTEGERP (glyph
->object
) && glyph
->charpos
< 0)
14424 /* By default, in reversed rows we put the cursor on the
14425 rightmost (first in the reading order) glyph. */
14426 for (g
= end
+ 1; g
< glyph
; g
++)
14427 x
+= g
->pixel_width
;
14429 && INTEGERP ((end
+ 1)->object
)
14430 && (end
+ 1)->charpos
<= 0)
14432 glyph_before
= glyph
+ 1;
14436 else if (row
->reversed_p
)
14438 /* In R2L rows that don't display text, put the cursor on the
14439 rightmost glyph. Case in point: an empty last line that is
14440 part of an R2L paragraph. */
14442 /* Avoid placing the cursor on the last glyph of the row, where
14443 on terminal frames we hold the vertical border between
14444 adjacent windows. */
14445 if (!FRAME_WINDOW_P (WINDOW_XFRAME (w
))
14446 && !WINDOW_RIGHTMOST_P (w
)
14447 && cursor
== row
->glyphs
[LAST_AREA
] - 1)
14449 x
= -1; /* will be computed below, at label compute_x */
14452 /* Step 1: Try to find the glyph whose character position
14453 corresponds to point. If that's not possible, find 2 glyphs
14454 whose character positions are the closest to point, one before
14455 point, the other after it. */
14456 if (!row
->reversed_p
)
14457 while (/* not marched to end of glyph row */
14459 /* glyph was not inserted by redisplay for internal purposes */
14460 && !INTEGERP (glyph
->object
))
14462 if (BUFFERP (glyph
->object
))
14464 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14466 if (glyph
->charpos
> bpos_max
)
14467 bpos_max
= glyph
->charpos
;
14468 if (glyph
->charpos
< bpos_min
)
14469 bpos_min
= glyph
->charpos
;
14470 if (!glyph
->avoid_cursor_p
)
14472 /* If we hit point, we've found the glyph on which to
14473 display the cursor. */
14476 match_with_avoid_cursor
= 0;
14479 /* See if we've found a better approximation to
14480 POS_BEFORE or to POS_AFTER. */
14481 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14483 pos_before
= glyph
->charpos
;
14484 glyph_before
= glyph
;
14486 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14488 pos_after
= glyph
->charpos
;
14489 glyph_after
= glyph
;
14492 else if (dpos
== 0)
14493 match_with_avoid_cursor
= 1;
14495 else if (STRINGP (glyph
->object
))
14497 Lisp_Object chprop
;
14498 ptrdiff_t glyph_pos
= glyph
->charpos
;
14500 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14502 if (!NILP (chprop
))
14504 /* If the string came from a `display' text property,
14505 look up the buffer position of that property and
14506 use that position to update bpos_max, as if we
14507 actually saw such a position in one of the row's
14508 glyphs. This helps with supporting integer values
14509 of `cursor' property on the display string in
14510 situations where most or all of the row's buffer
14511 text is completely covered by display properties,
14512 so that no glyph with valid buffer positions is
14513 ever seen in the row. */
14514 ptrdiff_t prop_pos
=
14515 string_buffer_position_lim (glyph
->object
, pos_before
,
14518 if (prop_pos
>= pos_before
)
14519 bpos_max
= prop_pos
;
14521 if (INTEGERP (chprop
))
14523 bpos_covered
= bpos_max
+ XINT (chprop
);
14524 /* If the `cursor' property covers buffer positions up
14525 to and including point, we should display cursor on
14526 this glyph. Note that, if a `cursor' property on one
14527 of the string's characters has an integer value, we
14528 will break out of the loop below _before_ we get to
14529 the position match above. IOW, integer values of
14530 the `cursor' property override the "exact match for
14531 point" strategy of positioning the cursor. */
14532 /* Implementation note: bpos_max == pt_old when, e.g.,
14533 we are in an empty line, where bpos_max is set to
14534 MATRIX_ROW_START_CHARPOS, see above. */
14535 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14544 x
+= glyph
->pixel_width
;
14547 else if (glyph
> end
) /* row is reversed */
14548 while (!INTEGERP (glyph
->object
))
14550 if (BUFFERP (glyph
->object
))
14552 ptrdiff_t dpos
= glyph
->charpos
- pt_old
;
14554 if (glyph
->charpos
> bpos_max
)
14555 bpos_max
= glyph
->charpos
;
14556 if (glyph
->charpos
< bpos_min
)
14557 bpos_min
= glyph
->charpos
;
14558 if (!glyph
->avoid_cursor_p
)
14562 match_with_avoid_cursor
= 0;
14565 if (0 > dpos
&& dpos
> pos_before
- pt_old
)
14567 pos_before
= glyph
->charpos
;
14568 glyph_before
= glyph
;
14570 else if (0 < dpos
&& dpos
< pos_after
- pt_old
)
14572 pos_after
= glyph
->charpos
;
14573 glyph_after
= glyph
;
14576 else if (dpos
== 0)
14577 match_with_avoid_cursor
= 1;
14579 else if (STRINGP (glyph
->object
))
14581 Lisp_Object chprop
;
14582 ptrdiff_t glyph_pos
= glyph
->charpos
;
14584 chprop
= Fget_char_property (make_number (glyph_pos
), Qcursor
,
14586 if (!NILP (chprop
))
14588 ptrdiff_t prop_pos
=
14589 string_buffer_position_lim (glyph
->object
, pos_before
,
14592 if (prop_pos
>= pos_before
)
14593 bpos_max
= prop_pos
;
14595 if (INTEGERP (chprop
))
14597 bpos_covered
= bpos_max
+ XINT (chprop
);
14598 /* If the `cursor' property covers buffer positions up
14599 to and including point, we should display cursor on
14601 if (bpos_max
<= pt_old
&& bpos_covered
>= pt_old
)
14610 if (glyph
== glyphs_end
) /* don't dereference outside TEXT_AREA */
14612 x
--; /* can't use any pixel_width */
14615 x
-= glyph
->pixel_width
;
14618 /* Step 2: If we didn't find an exact match for point, we need to
14619 look for a proper place to put the cursor among glyphs between
14620 GLYPH_BEFORE and GLYPH_AFTER. */
14621 if (!((row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14622 && BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14623 && !(bpos_max
<= pt_old
&& pt_old
<= bpos_covered
))
14625 /* An empty line has a single glyph whose OBJECT is zero and
14626 whose CHARPOS is the position of a newline on that line.
14627 Note that on a TTY, there are more glyphs after that, which
14628 were produced by extend_face_to_end_of_line, but their
14629 CHARPOS is zero or negative. */
14631 (row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
)
14632 && INTEGERP (glyph
->object
) && glyph
->charpos
> 0
14633 /* On a TTY, continued and truncated rows also have a glyph at
14634 their end whose OBJECT is zero and whose CHARPOS is
14635 positive (the continuation and truncation glyphs), but such
14636 rows are obviously not "empty". */
14637 && !(row
->continued_p
|| row
->truncated_on_right_p
);
14639 if (row
->ends_in_ellipsis_p
&& pos_after
== last_pos
)
14641 ptrdiff_t ellipsis_pos
;
14643 /* Scan back over the ellipsis glyphs. */
14644 if (!row
->reversed_p
)
14646 ellipsis_pos
= (glyph
- 1)->charpos
;
14647 while (glyph
> row
->glyphs
[TEXT_AREA
]
14648 && (glyph
- 1)->charpos
== ellipsis_pos
)
14649 glyph
--, x
-= glyph
->pixel_width
;
14650 /* That loop always goes one position too far, including
14651 the glyph before the ellipsis. So scan forward over
14653 x
+= glyph
->pixel_width
;
14656 else /* row is reversed */
14658 ellipsis_pos
= (glyph
+ 1)->charpos
;
14659 while (glyph
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14660 && (glyph
+ 1)->charpos
== ellipsis_pos
)
14661 glyph
++, x
+= glyph
->pixel_width
;
14662 x
-= glyph
->pixel_width
;
14666 else if (match_with_avoid_cursor
)
14668 cursor
= glyph_after
;
14671 else if (string_seen
)
14673 int incr
= row
->reversed_p
? -1 : +1;
14675 /* Need to find the glyph that came out of a string which is
14676 present at point. That glyph is somewhere between
14677 GLYPH_BEFORE and GLYPH_AFTER, and it came from a string
14678 positioned between POS_BEFORE and POS_AFTER in the
14680 struct glyph
*start
, *stop
;
14681 ptrdiff_t pos
= pos_before
;
14685 /* If the row ends in a newline from a display string,
14686 reordering could have moved the glyphs belonging to the
14687 string out of the [GLYPH_BEFORE..GLYPH_AFTER] range. So
14688 in this case we extend the search to the last glyph in
14689 the row that was not inserted by redisplay. */
14690 if (row
->ends_in_newline_from_string_p
)
14693 pos_after
= MATRIX_ROW_END_CHARPOS (row
) + delta
;
14696 /* GLYPH_BEFORE and GLYPH_AFTER are the glyphs that
14697 correspond to POS_BEFORE and POS_AFTER, respectively. We
14698 need START and STOP in the order that corresponds to the
14699 row's direction as given by its reversed_p flag. If the
14700 directionality of characters between POS_BEFORE and
14701 POS_AFTER is the opposite of the row's base direction,
14702 these characters will have been reordered for display,
14703 and we need to reverse START and STOP. */
14704 if (!row
->reversed_p
)
14706 start
= min (glyph_before
, glyph_after
);
14707 stop
= max (glyph_before
, glyph_after
);
14711 start
= max (glyph_before
, glyph_after
);
14712 stop
= min (glyph_before
, glyph_after
);
14714 for (glyph
= start
+ incr
;
14715 row
->reversed_p
? glyph
> stop
: glyph
< stop
; )
14718 /* Any glyphs that come from the buffer are here because
14719 of bidi reordering. Skip them, and only pay
14720 attention to glyphs that came from some string. */
14721 if (STRINGP (glyph
->object
))
14725 /* If the display property covers the newline, we
14726 need to search for it one position farther. */
14727 ptrdiff_t lim
= pos_after
14728 + (pos_after
== MATRIX_ROW_END_CHARPOS (row
) + delta
);
14730 string_from_text_prop
= 0;
14731 str
= glyph
->object
;
14732 tem
= string_buffer_position_lim (str
, pos
, lim
, 0);
14733 if (tem
== 0 /* from overlay */
14736 /* If the string from which this glyph came is
14737 found in the buffer at point, or at position
14738 that is closer to point than pos_after, then
14739 we've found the glyph we've been looking for.
14740 If it comes from an overlay (tem == 0), and
14741 it has the `cursor' property on one of its
14742 glyphs, record that glyph as a candidate for
14743 displaying the cursor. (As in the
14744 unidirectional version, we will display the
14745 cursor on the last candidate we find.) */
14748 || (tem
- pt_old
> 0 && tem
< pos_after
))
14750 /* The glyphs from this string could have
14751 been reordered. Find the one with the
14752 smallest string position. Or there could
14753 be a character in the string with the
14754 `cursor' property, which means display
14755 cursor on that character's glyph. */
14756 ptrdiff_t strpos
= glyph
->charpos
;
14761 string_from_text_prop
= 1;
14764 (row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14765 && EQ (glyph
->object
, str
);
14769 ptrdiff_t gpos
= glyph
->charpos
;
14771 cprop
= Fget_char_property (make_number (gpos
),
14779 if (tem
&& glyph
->charpos
< strpos
)
14781 strpos
= glyph
->charpos
;
14787 || (tem
- pt_old
> 0 && tem
< pos_after
))
14791 pos
= tem
+ 1; /* don't find previous instances */
14793 /* This string is not what we want; skip all of the
14794 glyphs that came from it. */
14795 while ((row
->reversed_p
? glyph
> stop
: glyph
< stop
)
14796 && EQ (glyph
->object
, str
))
14803 /* If we reached the end of the line, and END was from a string,
14804 the cursor is not on this line. */
14806 && (row
->reversed_p
? glyph
<= end
: glyph
>= end
)
14807 && (row
->reversed_p
? end
> glyphs_end
: end
< glyphs_end
)
14808 && STRINGP (end
->object
)
14809 && row
->continued_p
)
14812 /* A truncated row may not include PT among its character positions.
14813 Setting the cursor inside the scroll margin will trigger
14814 recalculation of hscroll in hscroll_window_tree. But if a
14815 display string covers point, defer to the string-handling
14816 code below to figure this out. */
14817 else if (row
->truncated_on_left_p
&& pt_old
< bpos_min
)
14819 cursor
= glyph_before
;
14822 else if ((row
->truncated_on_right_p
&& pt_old
> bpos_max
)
14823 /* Zero-width characters produce no glyphs. */
14825 && (row
->reversed_p
14826 ? glyph_after
> glyphs_end
14827 : glyph_after
< glyphs_end
)))
14829 cursor
= glyph_after
;
14835 if (cursor
!= NULL
)
14837 else if (glyph
== glyphs_end
14838 && pos_before
== pos_after
14839 && STRINGP ((row
->reversed_p
14840 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14841 : row
->glyphs
[TEXT_AREA
])->object
))
14843 /* If all the glyphs of this row came from strings, put the
14844 cursor on the first glyph of the row. This avoids having the
14845 cursor outside of the text area in this very rare and hard
14849 ? row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1
14850 : row
->glyphs
[TEXT_AREA
];
14856 /* Need to compute x that corresponds to GLYPH. */
14857 for (g
= row
->glyphs
[TEXT_AREA
], x
= row
->x
; g
< glyph
; g
++)
14859 if (g
>= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
])
14861 x
+= g
->pixel_width
;
14865 /* ROW could be part of a continued line, which, under bidi
14866 reordering, might have other rows whose start and end charpos
14867 occlude point. Only set w->cursor if we found a better
14868 approximation to the cursor position than we have from previously
14869 examined candidate rows belonging to the same continued line. */
14870 if (/* We already have a candidate row. */
14871 w
->cursor
.vpos
>= 0
14872 /* That candidate is not the row we are processing. */
14873 && MATRIX_ROW (matrix
, w
->cursor
.vpos
) != row
14874 /* Make sure cursor.vpos specifies a row whose start and end
14875 charpos occlude point, and it is valid candidate for being a
14876 cursor-row. This is because some callers of this function
14877 leave cursor.vpos at the row where the cursor was displayed
14878 during the last redisplay cycle. */
14879 && MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
)) <= pt_old
14880 && pt_old
<= MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14881 && cursor_row_p (MATRIX_ROW (matrix
, w
->cursor
.vpos
)))
14884 = MATRIX_ROW_GLYPH_START (matrix
, w
->cursor
.vpos
) + w
->cursor
.hpos
;
14886 /* Don't consider glyphs that are outside TEXT_AREA. */
14887 if (!(row
->reversed_p
? glyph
> glyphs_end
: glyph
< glyphs_end
))
14889 /* Keep the candidate whose buffer position is the closest to
14890 point or has the `cursor' property. */
14891 if (/* Previous candidate is a glyph in TEXT_AREA of that row. */
14892 w
->cursor
.hpos
>= 0
14893 && w
->cursor
.hpos
< MATRIX_ROW_USED (matrix
, w
->cursor
.vpos
)
14894 && ((BUFFERP (g1
->object
)
14895 && (g1
->charpos
== pt_old
/* An exact match always wins. */
14896 || (BUFFERP (glyph
->object
)
14897 && eabs (g1
->charpos
- pt_old
)
14898 < eabs (glyph
->charpos
- pt_old
))))
14899 /* Previous candidate is a glyph from a string that has
14900 a non-nil `cursor' property. */
14901 || (STRINGP (g1
->object
)
14902 && (!NILP (Fget_char_property (make_number (g1
->charpos
),
14903 Qcursor
, g1
->object
))
14904 /* Previous candidate is from the same display
14905 string as this one, and the display string
14906 came from a text property. */
14907 || (EQ (g1
->object
, glyph
->object
)
14908 && string_from_text_prop
)
14909 /* this candidate is from newline and its
14910 position is not an exact match */
14911 || (INTEGERP (glyph
->object
)
14912 && glyph
->charpos
!= pt_old
)))))
14914 /* If this candidate gives an exact match, use that. */
14915 if (!((BUFFERP (glyph
->object
) && glyph
->charpos
== pt_old
)
14916 /* If this candidate is a glyph created for the
14917 terminating newline of a line, and point is on that
14918 newline, it wins because it's an exact match. */
14919 || (!row
->continued_p
14920 && INTEGERP (glyph
->object
)
14921 && glyph
->charpos
== 0
14922 && pt_old
== MATRIX_ROW_END_CHARPOS (row
) - 1))
14923 /* Otherwise, keep the candidate that comes from a row
14924 spanning less buffer positions. This may win when one or
14925 both candidate positions are on glyphs that came from
14926 display strings, for which we cannot compare buffer
14928 && MATRIX_ROW_END_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14929 - MATRIX_ROW_START_CHARPOS (MATRIX_ROW (matrix
, w
->cursor
.vpos
))
14930 < MATRIX_ROW_END_CHARPOS (row
) - MATRIX_ROW_START_CHARPOS (row
))
14933 w
->cursor
.hpos
= glyph
- row
->glyphs
[TEXT_AREA
];
14935 w
->cursor
.vpos
= MATRIX_ROW_VPOS (row
, matrix
) + dvpos
;
14936 w
->cursor
.y
= row
->y
+ dy
;
14938 if (w
== XWINDOW (selected_window
))
14940 if (!row
->continued_p
14941 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
14944 this_line_buffer
= XBUFFER (w
->contents
);
14946 CHARPOS (this_line_start_pos
)
14947 = MATRIX_ROW_START_CHARPOS (row
) + delta
;
14948 BYTEPOS (this_line_start_pos
)
14949 = MATRIX_ROW_START_BYTEPOS (row
) + delta_bytes
;
14951 CHARPOS (this_line_end_pos
)
14952 = Z
- (MATRIX_ROW_END_CHARPOS (row
) + delta
);
14953 BYTEPOS (this_line_end_pos
)
14954 = Z_BYTE
- (MATRIX_ROW_END_BYTEPOS (row
) + delta_bytes
);
14956 this_line_y
= w
->cursor
.y
;
14957 this_line_pixel_height
= row
->height
;
14958 this_line_vpos
= w
->cursor
.vpos
;
14959 this_line_start_x
= row
->x
;
14962 CHARPOS (this_line_start_pos
) = 0;
14969 /* Run window scroll functions, if any, for WINDOW with new window
14970 start STARTP. Sets the window start of WINDOW to that position.
14972 We assume that the window's buffer is really current. */
14974 static struct text_pos
14975 run_window_scroll_functions (Lisp_Object window
, struct text_pos startp
)
14977 struct window
*w
= XWINDOW (window
);
14978 SET_MARKER_FROM_TEXT_POS (w
->start
, startp
);
14980 eassert (current_buffer
== XBUFFER (w
->contents
));
14982 if (!NILP (Vwindow_scroll_functions
))
14984 run_hook_with_args_2 (Qwindow_scroll_functions
, window
,
14985 make_number (CHARPOS (startp
)));
14986 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
14987 /* In case the hook functions switch buffers. */
14988 set_buffer_internal (XBUFFER (w
->contents
));
14995 /* Make sure the line containing the cursor is fully visible.
14996 A value of 1 means there is nothing to be done.
14997 (Either the line is fully visible, or it cannot be made so,
14998 or we cannot tell.)
15000 If FORCE_P is non-zero, return 0 even if partial visible cursor row
15001 is higher than window.
15003 If CURRENT_MATRIX_P is non-zero, use the information from the
15004 window's current glyph matrix; otherwise use the desired glyph
15007 A value of 0 means the caller should do scrolling
15008 as if point had gone off the screen. */
15011 cursor_row_fully_visible_p (struct window
*w
, int force_p
, int current_matrix_p
)
15013 struct glyph_matrix
*matrix
;
15014 struct glyph_row
*row
;
15017 if (!make_cursor_line_fully_visible_p
)
15020 /* It's not always possible to find the cursor, e.g, when a window
15021 is full of overlay strings. Don't do anything in that case. */
15022 if (w
->cursor
.vpos
< 0)
15025 matrix
= current_matrix_p
? w
->current_matrix
: w
->desired_matrix
;
15026 row
= MATRIX_ROW (matrix
, w
->cursor
.vpos
);
15028 /* If the cursor row is not partially visible, there's nothing to do. */
15029 if (!MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
))
15032 /* If the row the cursor is in is taller than the window's height,
15033 it's not clear what to do, so do nothing. */
15034 window_height
= window_box_height (w
);
15035 if (row
->height
>= window_height
)
15037 if (!force_p
|| MINI_WINDOW_P (w
)
15038 || w
->vscroll
|| w
->cursor
.vpos
== 0)
15045 /* Try scrolling PT into view in window WINDOW. JUST_THIS_ONE_P
15046 non-zero means only WINDOW is redisplayed in redisplay_internal.
15047 TEMP_SCROLL_STEP has the same meaning as emacs_scroll_step, and is used
15048 in redisplay_window to bring a partially visible line into view in
15049 the case that only the cursor has moved.
15051 LAST_LINE_MISFIT should be nonzero if we're scrolling because the
15052 last screen line's vertical height extends past the end of the screen.
15056 1 if scrolling succeeded
15058 0 if scrolling didn't find point.
15060 -1 if new fonts have been loaded so that we must interrupt
15061 redisplay, adjust glyph matrices, and try again. */
15067 SCROLLING_NEED_LARGER_MATRICES
15070 /* If scroll-conservatively is more than this, never recenter.
15072 If you change this, don't forget to update the doc string of
15073 `scroll-conservatively' and the Emacs manual. */
15074 #define SCROLL_LIMIT 100
15077 try_scrolling (Lisp_Object window
, int just_this_one_p
,
15078 ptrdiff_t arg_scroll_conservatively
, ptrdiff_t scroll_step
,
15079 int temp_scroll_step
, int last_line_misfit
)
15081 struct window
*w
= XWINDOW (window
);
15082 struct frame
*f
= XFRAME (w
->frame
);
15083 struct text_pos pos
, startp
;
15085 int this_scroll_margin
, scroll_max
, rc
, height
;
15086 int dy
= 0, amount_to_scroll
= 0, scroll_down_p
= 0;
15087 int extra_scroll_margin_lines
= last_line_misfit
? 1 : 0;
15088 Lisp_Object aggressive
;
15089 /* We will never try scrolling more than this number of lines. */
15090 int scroll_limit
= SCROLL_LIMIT
;
15091 int frame_line_height
= default_line_pixel_height (w
);
15092 int window_total_lines
15093 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15096 debug_method_add (w
, "try_scrolling");
15099 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15101 /* Compute scroll margin height in pixels. We scroll when point is
15102 within this distance from the top or bottom of the window. */
15103 if (scroll_margin
> 0)
15104 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4)
15105 * frame_line_height
;
15107 this_scroll_margin
= 0;
15109 /* Force arg_scroll_conservatively to have a reasonable value, to
15110 avoid scrolling too far away with slow move_it_* functions. Note
15111 that the user can supply scroll-conservatively equal to
15112 `most-positive-fixnum', which can be larger than INT_MAX. */
15113 if (arg_scroll_conservatively
> scroll_limit
)
15115 arg_scroll_conservatively
= scroll_limit
+ 1;
15116 scroll_max
= scroll_limit
* frame_line_height
;
15118 else if (scroll_step
|| arg_scroll_conservatively
|| temp_scroll_step
)
15119 /* Compute how much we should try to scroll maximally to bring
15120 point into view. */
15121 scroll_max
= (max (scroll_step
,
15122 max (arg_scroll_conservatively
, temp_scroll_step
))
15123 * frame_line_height
);
15124 else if (NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
))
15125 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
)))
15126 /* We're trying to scroll because of aggressive scrolling but no
15127 scroll_step is set. Choose an arbitrary one. */
15128 scroll_max
= 10 * frame_line_height
;
15134 /* Decide whether to scroll down. */
15135 if (PT
> CHARPOS (startp
))
15137 int scroll_margin_y
;
15139 /* Compute the pixel ypos of the scroll margin, then move IT to
15140 either that ypos or PT, whichever comes first. */
15141 start_display (&it
, w
, startp
);
15142 scroll_margin_y
= it
.last_visible_y
- this_scroll_margin
15143 - frame_line_height
* extra_scroll_margin_lines
;
15144 move_it_to (&it
, PT
, -1, scroll_margin_y
- 1, -1,
15145 (MOVE_TO_POS
| MOVE_TO_Y
));
15147 if (PT
> CHARPOS (it
.current
.pos
))
15149 int y0
= line_bottom_y (&it
);
15150 /* Compute how many pixels below window bottom to stop searching
15151 for PT. This avoids costly search for PT that is far away if
15152 the user limited scrolling by a small number of lines, but
15153 always finds PT if scroll_conservatively is set to a large
15154 number, such as most-positive-fixnum. */
15155 int slack
= max (scroll_max
, 10 * frame_line_height
);
15156 int y_to_move
= it
.last_visible_y
+ slack
;
15158 /* Compute the distance from the scroll margin to PT or to
15159 the scroll limit, whichever comes first. This should
15160 include the height of the cursor line, to make that line
15162 move_it_to (&it
, PT
, -1, y_to_move
,
15163 -1, MOVE_TO_POS
| MOVE_TO_Y
);
15164 dy
= line_bottom_y (&it
) - y0
;
15166 if (dy
> scroll_max
)
15167 return SCROLLING_FAILED
;
15176 /* Point is in or below the bottom scroll margin, so move the
15177 window start down. If scrolling conservatively, move it just
15178 enough down to make point visible. If scroll_step is set,
15179 move it down by scroll_step. */
15180 if (arg_scroll_conservatively
)
15182 = min (max (dy
, frame_line_height
),
15183 frame_line_height
* arg_scroll_conservatively
);
15184 else if (scroll_step
|| temp_scroll_step
)
15185 amount_to_scroll
= scroll_max
;
15188 aggressive
= BVAR (current_buffer
, scroll_up_aggressively
);
15189 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15190 if (NUMBERP (aggressive
))
15192 double float_amount
= XFLOATINT (aggressive
) * height
;
15193 int aggressive_scroll
= float_amount
;
15194 if (aggressive_scroll
== 0 && float_amount
> 0)
15195 aggressive_scroll
= 1;
15196 /* Don't let point enter the scroll margin near top of
15197 the window. This could happen if the value of
15198 scroll_up_aggressively is too large and there are
15199 non-zero margins, because scroll_up_aggressively
15200 means put point that fraction of window height
15201 _from_the_bottom_margin_. */
15202 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15203 aggressive_scroll
= height
- 2*this_scroll_margin
;
15204 amount_to_scroll
= dy
+ aggressive_scroll
;
15208 if (amount_to_scroll
<= 0)
15209 return SCROLLING_FAILED
;
15211 start_display (&it
, w
, startp
);
15212 if (arg_scroll_conservatively
<= scroll_limit
)
15213 move_it_vertically (&it
, amount_to_scroll
);
15216 /* Extra precision for users who set scroll-conservatively
15217 to a large number: make sure the amount we scroll
15218 the window start is never less than amount_to_scroll,
15219 which was computed as distance from window bottom to
15220 point. This matters when lines at window top and lines
15221 below window bottom have different height. */
15223 void *it1data
= NULL
;
15224 /* We use a temporary it1 because line_bottom_y can modify
15225 its argument, if it moves one line down; see there. */
15228 SAVE_IT (it1
, it
, it1data
);
15229 start_y
= line_bottom_y (&it1
);
15231 RESTORE_IT (&it
, &it
, it1data
);
15232 move_it_by_lines (&it
, 1);
15233 SAVE_IT (it1
, it
, it1data
);
15234 } while (line_bottom_y (&it1
) - start_y
< amount_to_scroll
);
15237 /* If STARTP is unchanged, move it down another screen line. */
15238 if (CHARPOS (it
.current
.pos
) == CHARPOS (startp
))
15239 move_it_by_lines (&it
, 1);
15240 startp
= it
.current
.pos
;
15244 struct text_pos scroll_margin_pos
= startp
;
15247 /* See if point is inside the scroll margin at the top of the
15249 if (this_scroll_margin
)
15253 start_display (&it
, w
, startp
);
15254 y_start
= it
.current_y
;
15255 move_it_vertically (&it
, this_scroll_margin
);
15256 scroll_margin_pos
= it
.current
.pos
;
15257 /* If we didn't move enough before hitting ZV, request
15258 additional amount of scroll, to move point out of the
15260 if (IT_CHARPOS (it
) == ZV
15261 && it
.current_y
- y_start
< this_scroll_margin
)
15262 y_offset
= this_scroll_margin
- (it
.current_y
- y_start
);
15265 if (PT
< CHARPOS (scroll_margin_pos
))
15267 /* Point is in the scroll margin at the top of the window or
15268 above what is displayed in the window. */
15271 /* Compute the vertical distance from PT to the scroll
15272 margin position. Move as far as scroll_max allows, or
15273 one screenful, or 10 screen lines, whichever is largest.
15274 Give up if distance is greater than scroll_max or if we
15275 didn't reach the scroll margin position. */
15276 SET_TEXT_POS (pos
, PT
, PT_BYTE
);
15277 start_display (&it
, w
, pos
);
15279 y_to_move
= max (it
.last_visible_y
,
15280 max (scroll_max
, 10 * frame_line_height
));
15281 move_it_to (&it
, CHARPOS (scroll_margin_pos
), 0,
15283 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15284 dy
= it
.current_y
- y0
;
15285 if (dy
> scroll_max
15286 || IT_CHARPOS (it
) < CHARPOS (scroll_margin_pos
))
15287 return SCROLLING_FAILED
;
15289 /* Additional scroll for when ZV was too close to point. */
15292 /* Compute new window start. */
15293 start_display (&it
, w
, startp
);
15295 if (arg_scroll_conservatively
)
15296 amount_to_scroll
= max (dy
, frame_line_height
*
15297 max (scroll_step
, temp_scroll_step
));
15298 else if (scroll_step
|| temp_scroll_step
)
15299 amount_to_scroll
= scroll_max
;
15302 aggressive
= BVAR (current_buffer
, scroll_down_aggressively
);
15303 height
= WINDOW_BOX_TEXT_HEIGHT (w
);
15304 if (NUMBERP (aggressive
))
15306 double float_amount
= XFLOATINT (aggressive
) * height
;
15307 int aggressive_scroll
= float_amount
;
15308 if (aggressive_scroll
== 0 && float_amount
> 0)
15309 aggressive_scroll
= 1;
15310 /* Don't let point enter the scroll margin near
15311 bottom of the window, if the value of
15312 scroll_down_aggressively happens to be too
15314 if (aggressive_scroll
+ 2*this_scroll_margin
> height
)
15315 aggressive_scroll
= height
- 2*this_scroll_margin
;
15316 amount_to_scroll
= dy
+ aggressive_scroll
;
15320 if (amount_to_scroll
<= 0)
15321 return SCROLLING_FAILED
;
15323 move_it_vertically_backward (&it
, amount_to_scroll
);
15324 startp
= it
.current
.pos
;
15328 /* Run window scroll functions. */
15329 startp
= run_window_scroll_functions (window
, startp
);
15331 /* Display the window. Give up if new fonts are loaded, or if point
15333 if (!try_window (window
, startp
, 0))
15334 rc
= SCROLLING_NEED_LARGER_MATRICES
;
15335 else if (w
->cursor
.vpos
< 0)
15337 clear_glyph_matrix (w
->desired_matrix
);
15338 rc
= SCROLLING_FAILED
;
15342 /* Maybe forget recorded base line for line number display. */
15343 if (!just_this_one_p
15344 || current_buffer
->clip_changed
15345 || BEG_UNCHANGED
< CHARPOS (startp
))
15346 w
->base_line_number
= 0;
15348 /* If cursor ends up on a partially visible line,
15349 treat that as being off the bottom of the screen. */
15350 if (! cursor_row_fully_visible_p (w
, extra_scroll_margin_lines
<= 1, 0)
15351 /* It's possible that the cursor is on the first line of the
15352 buffer, which is partially obscured due to a vscroll
15353 (Bug#7537). In that case, avoid looping forever. */
15354 && extra_scroll_margin_lines
< w
->desired_matrix
->nrows
- 1)
15356 clear_glyph_matrix (w
->desired_matrix
);
15357 ++extra_scroll_margin_lines
;
15360 rc
= SCROLLING_SUCCESS
;
15367 /* Compute a suitable window start for window W if display of W starts
15368 on a continuation line. Value is non-zero if a new window start
15371 The new window start will be computed, based on W's width, starting
15372 from the start of the continued line. It is the start of the
15373 screen line with the minimum distance from the old start W->start. */
15376 compute_window_start_on_continuation_line (struct window
*w
)
15378 struct text_pos pos
, start_pos
;
15379 int window_start_changed_p
= 0;
15381 SET_TEXT_POS_FROM_MARKER (start_pos
, w
->start
);
15383 /* If window start is on a continuation line... Window start may be
15384 < BEGV in case there's invisible text at the start of the
15385 buffer (M-x rmail, for example). */
15386 if (CHARPOS (start_pos
) > BEGV
15387 && FETCH_BYTE (BYTEPOS (start_pos
) - 1) != '\n')
15390 struct glyph_row
*row
;
15392 /* Handle the case that the window start is out of range. */
15393 if (CHARPOS (start_pos
) < BEGV
)
15394 SET_TEXT_POS (start_pos
, BEGV
, BEGV_BYTE
);
15395 else if (CHARPOS (start_pos
) > ZV
)
15396 SET_TEXT_POS (start_pos
, ZV
, ZV_BYTE
);
15398 /* Find the start of the continued line. This should be fast
15399 because find_newline is fast (newline cache). */
15400 row
= w
->desired_matrix
->rows
+ (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0);
15401 init_iterator (&it
, w
, CHARPOS (start_pos
), BYTEPOS (start_pos
),
15402 row
, DEFAULT_FACE_ID
);
15403 reseat_at_previous_visible_line_start (&it
);
15405 /* If the line start is "too far" away from the window start,
15406 say it takes too much time to compute a new window start. */
15407 if (CHARPOS (start_pos
) - IT_CHARPOS (it
)
15408 /* PXW: Do we need upper bounds here? */
15409 < WINDOW_TOTAL_LINES (w
) * WINDOW_TOTAL_COLS (w
))
15411 int min_distance
, distance
;
15413 /* Move forward by display lines to find the new window
15414 start. If window width was enlarged, the new start can
15415 be expected to be > the old start. If window width was
15416 decreased, the new window start will be < the old start.
15417 So, we're looking for the display line start with the
15418 minimum distance from the old window start. */
15419 pos
= it
.current
.pos
;
15420 min_distance
= INFINITY
;
15421 while ((distance
= eabs (CHARPOS (start_pos
) - IT_CHARPOS (it
))),
15422 distance
< min_distance
)
15424 min_distance
= distance
;
15425 pos
= it
.current
.pos
;
15426 if (it
.line_wrap
== WORD_WRAP
)
15428 /* Under WORD_WRAP, move_it_by_lines is likely to
15429 overshoot and stop not at the first, but the
15430 second character from the left margin. So in
15431 that case, we need a more tight control on the X
15432 coordinate of the iterator than move_it_by_lines
15433 promises in its contract. The method is to first
15434 go to the last (rightmost) visible character of a
15435 line, then move to the leftmost character on the
15436 next line in a separate call. */
15437 move_it_to (&it
, ZV
, it
.last_visible_x
, it
.current_y
, -1,
15438 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15439 move_it_to (&it
, ZV
, 0,
15440 it
.current_y
+ it
.max_ascent
+ it
.max_descent
, -1,
15441 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
15444 move_it_by_lines (&it
, 1);
15447 /* Set the window start there. */
15448 SET_MARKER_FROM_TEXT_POS (w
->start
, pos
);
15449 window_start_changed_p
= 1;
15453 return window_start_changed_p
;
15457 /* Try cursor movement in case text has not changed in window WINDOW,
15458 with window start STARTP. Value is
15460 CURSOR_MOVEMENT_SUCCESS if successful
15462 CURSOR_MOVEMENT_CANNOT_BE_USED if this method cannot be used
15464 CURSOR_MOVEMENT_MUST_SCROLL if we know we have to scroll the
15465 display. *SCROLL_STEP is set to 1, under certain circumstances, if
15466 we want to scroll as if scroll-step were set to 1. See the code.
15468 CURSOR_MOVEMENT_NEED_LARGER_MATRICES if we need larger matrices, in
15469 which case we have to abort this redisplay, and adjust matrices
15474 CURSOR_MOVEMENT_SUCCESS
,
15475 CURSOR_MOVEMENT_CANNOT_BE_USED
,
15476 CURSOR_MOVEMENT_MUST_SCROLL
,
15477 CURSOR_MOVEMENT_NEED_LARGER_MATRICES
15481 try_cursor_movement (Lisp_Object window
, struct text_pos startp
, int *scroll_step
)
15483 struct window
*w
= XWINDOW (window
);
15484 struct frame
*f
= XFRAME (w
->frame
);
15485 int rc
= CURSOR_MOVEMENT_CANNOT_BE_USED
;
15488 if (inhibit_try_cursor_movement
)
15492 /* Previously, there was a check for Lisp integer in the
15493 if-statement below. Now, this field is converted to
15494 ptrdiff_t, thus zero means invalid position in a buffer. */
15495 eassert (w
->last_point
> 0);
15496 /* Likewise there was a check whether window_end_vpos is nil or larger
15497 than the window. Now window_end_vpos is int and so never nil, but
15498 let's leave eassert to check whether it fits in the window. */
15499 eassert (w
->window_end_vpos
< w
->current_matrix
->nrows
);
15501 /* Handle case where text has not changed, only point, and it has
15502 not moved off the frame. */
15503 if (/* Point may be in this window. */
15504 PT
>= CHARPOS (startp
)
15505 /* Selective display hasn't changed. */
15506 && !current_buffer
->clip_changed
15507 /* Function force-mode-line-update is used to force a thorough
15508 redisplay. It sets either windows_or_buffers_changed or
15509 update_mode_lines. So don't take a shortcut here for these
15511 && !update_mode_lines
15512 && !windows_or_buffers_changed
15513 && !f
->cursor_type_changed
15514 && NILP (Vshow_trailing_whitespace
)
15515 /* This code is not used for mini-buffer for the sake of the case
15516 of redisplaying to replace an echo area message; since in
15517 that case the mini-buffer contents per se are usually
15518 unchanged. This code is of no real use in the mini-buffer
15519 since the handling of this_line_start_pos, etc., in redisplay
15520 handles the same cases. */
15521 && !EQ (window
, minibuf_window
)
15522 && (FRAME_WINDOW_P (f
)
15523 || !overlay_arrow_in_current_buffer_p ()))
15525 int this_scroll_margin
, top_scroll_margin
;
15526 struct glyph_row
*row
= NULL
;
15527 int frame_line_height
= default_line_pixel_height (w
);
15528 int window_total_lines
15529 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
15532 debug_method_add (w
, "cursor movement");
15535 /* Scroll if point within this distance from the top or bottom
15536 of the window. This is a pixel value. */
15537 if (scroll_margin
> 0)
15539 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
15540 this_scroll_margin
*= frame_line_height
;
15543 this_scroll_margin
= 0;
15545 top_scroll_margin
= this_scroll_margin
;
15546 if (WINDOW_WANTS_HEADER_LINE_P (w
))
15547 top_scroll_margin
+= CURRENT_HEADER_LINE_HEIGHT (w
);
15549 /* Start with the row the cursor was displayed during the last
15550 not paused redisplay. Give up if that row is not valid. */
15551 if (w
->last_cursor_vpos
< 0
15552 || w
->last_cursor_vpos
>= w
->current_matrix
->nrows
)
15553 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15556 row
= MATRIX_ROW (w
->current_matrix
, w
->last_cursor_vpos
);
15557 if (row
->mode_line_p
)
15559 if (!row
->enabled_p
)
15560 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15563 if (rc
== CURSOR_MOVEMENT_CANNOT_BE_USED
)
15565 int scroll_p
= 0, must_scroll
= 0;
15566 int last_y
= window_text_bottom_y (w
) - this_scroll_margin
;
15568 if (PT
> w
->last_point
)
15570 /* Point has moved forward. */
15571 while (MATRIX_ROW_END_CHARPOS (row
) < PT
15572 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
)
15574 eassert (row
->enabled_p
);
15578 /* If the end position of a row equals the start
15579 position of the next row, and PT is at that position,
15580 we would rather display cursor in the next line. */
15581 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15582 && MATRIX_ROW_END_CHARPOS (row
) == PT
15583 && row
< MATRIX_MODE_LINE_ROW (w
->current_matrix
)
15584 && MATRIX_ROW_START_CHARPOS (row
+1) == PT
15585 && !cursor_row_p (row
))
15588 /* If within the scroll margin, scroll. Note that
15589 MATRIX_ROW_BOTTOM_Y gives the pixel position at which
15590 the next line would be drawn, and that
15591 this_scroll_margin can be zero. */
15592 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
15593 || PT
> MATRIX_ROW_END_CHARPOS (row
)
15594 /* Line is completely visible last line in window
15595 and PT is to be set in the next line. */
15596 || (MATRIX_ROW_BOTTOM_Y (row
) == last_y
15597 && PT
== MATRIX_ROW_END_CHARPOS (row
)
15598 && !row
->ends_at_zv_p
15599 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
15602 else if (PT
< w
->last_point
)
15604 /* Cursor has to be moved backward. Note that PT >=
15605 CHARPOS (startp) because of the outer if-statement. */
15606 while (!row
->mode_line_p
15607 && (MATRIX_ROW_START_CHARPOS (row
) > PT
15608 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15609 && (MATRIX_ROW_STARTS_IN_MIDDLE_OF_CHAR_P (row
)
15610 || (/* STARTS_IN_MIDDLE_OF_STRING_P (row) */
15611 row
> w
->current_matrix
->rows
15612 && (row
-1)->ends_in_newline_from_string_p
))))
15613 && (row
->y
> top_scroll_margin
15614 || CHARPOS (startp
) == BEGV
))
15616 eassert (row
->enabled_p
);
15620 /* Consider the following case: Window starts at BEGV,
15621 there is invisible, intangible text at BEGV, so that
15622 display starts at some point START > BEGV. It can
15623 happen that we are called with PT somewhere between
15624 BEGV and START. Try to handle that case. */
15625 if (row
< w
->current_matrix
->rows
15626 || row
->mode_line_p
)
15628 row
= w
->current_matrix
->rows
;
15629 if (row
->mode_line_p
)
15633 /* Due to newlines in overlay strings, we may have to
15634 skip forward over overlay strings. */
15635 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15636 && MATRIX_ROW_END_CHARPOS (row
) == PT
15637 && !cursor_row_p (row
))
15640 /* If within the scroll margin, scroll. */
15641 if (row
->y
< top_scroll_margin
15642 && CHARPOS (startp
) != BEGV
)
15647 /* Cursor did not move. So don't scroll even if cursor line
15648 is partially visible, as it was so before. */
15649 rc
= CURSOR_MOVEMENT_SUCCESS
;
15652 if (PT
< MATRIX_ROW_START_CHARPOS (row
)
15653 || PT
> MATRIX_ROW_END_CHARPOS (row
))
15655 /* if PT is not in the glyph row, give up. */
15656 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15659 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15660 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15662 struct glyph_row
*row1
;
15664 /* If rows are bidi-reordered and point moved, back up
15665 until we find a row that does not belong to a
15666 continuation line. This is because we must consider
15667 all rows of a continued line as candidates for the
15668 new cursor positioning, since row start and end
15669 positions change non-linearly with vertical position
15671 /* FIXME: Revisit this when glyph ``spilling'' in
15672 continuation lines' rows is implemented for
15673 bidi-reordered rows. */
15674 for (row1
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
15675 MATRIX_ROW_CONTINUATION_LINE_P (row
);
15678 /* If we hit the beginning of the displayed portion
15679 without finding the first row of a continued
15683 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15686 eassert (row
->enabled_p
);
15691 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15692 && MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, row
)
15693 /* Make sure this isn't a header line by any chance, since
15694 then MATRIX_ROW_PARTIALLY_VISIBLE_P might yield non-zero. */
15695 && !row
->mode_line_p
15696 && make_cursor_line_fully_visible_p
)
15698 if (PT
== MATRIX_ROW_END_CHARPOS (row
)
15699 && !row
->ends_at_zv_p
15700 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
15701 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15702 else if (row
->height
> window_box_height (w
))
15704 /* If we end up in a partially visible line, let's
15705 make it fully visible, except when it's taller
15706 than the window, in which case we can't do much
15709 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15713 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
15714 if (!cursor_row_fully_visible_p (w
, 0, 1))
15715 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15717 rc
= CURSOR_MOVEMENT_SUCCESS
;
15721 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15722 else if (rc
!= CURSOR_MOVEMENT_SUCCESS
15723 && !NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
15725 /* With bidi-reordered rows, there could be more than
15726 one candidate row whose start and end positions
15727 occlude point. We need to let set_cursor_from_row
15728 find the best candidate. */
15729 /* FIXME: Revisit this when glyph ``spilling'' in
15730 continuation lines' rows is implemented for
15731 bidi-reordered rows. */
15736 int at_zv_p
= 0, exact_match_p
= 0;
15738 if (MATRIX_ROW_START_CHARPOS (row
) <= PT
15739 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
15740 && cursor_row_p (row
))
15741 rv
|= set_cursor_from_row (w
, row
, w
->current_matrix
,
15743 /* As soon as we've found the exact match for point,
15744 or the first suitable row whose ends_at_zv_p flag
15745 is set, we are done. */
15748 at_zv_p
= MATRIX_ROW (w
->current_matrix
,
15749 w
->cursor
.vpos
)->ends_at_zv_p
;
15751 && w
->cursor
.hpos
>= 0
15752 && w
->cursor
.hpos
< MATRIX_ROW_USED (w
->current_matrix
,
15755 struct glyph_row
*candidate
=
15756 MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
15758 candidate
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
15759 ptrdiff_t endpos
= MATRIX_ROW_END_CHARPOS (candidate
);
15762 (BUFFERP (g
->object
) && g
->charpos
== PT
)
15763 || (INTEGERP (g
->object
)
15764 && (g
->charpos
== PT
15765 || (g
->charpos
== 0 && endpos
- 1 == PT
)));
15767 if (at_zv_p
|| exact_match_p
)
15769 rc
= CURSOR_MOVEMENT_SUCCESS
;
15773 if (MATRIX_ROW_BOTTOM_Y (row
) == last_y
)
15777 while (((MATRIX_ROW_CONTINUATION_LINE_P (row
)
15778 || row
->continued_p
)
15779 && MATRIX_ROW_BOTTOM_Y (row
) <= last_y
)
15780 || (MATRIX_ROW_START_CHARPOS (row
) == PT
15781 && MATRIX_ROW_BOTTOM_Y (row
) < last_y
));
15782 /* If we didn't find any candidate rows, or exited the
15783 loop before all the candidates were examined, signal
15784 to the caller that this method failed. */
15785 if (rc
!= CURSOR_MOVEMENT_SUCCESS
15787 && !MATRIX_ROW_CONTINUATION_LINE_P (row
)
15788 && !row
->continued_p
))
15789 rc
= CURSOR_MOVEMENT_MUST_SCROLL
;
15791 rc
= CURSOR_MOVEMENT_SUCCESS
;
15797 if (set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0))
15799 rc
= CURSOR_MOVEMENT_SUCCESS
;
15804 while (MATRIX_ROW_BOTTOM_Y (row
) < last_y
15805 && MATRIX_ROW_START_CHARPOS (row
) == PT
15806 && cursor_row_p (row
));
15816 set_vertical_scroll_bar (struct window
*w
)
15818 ptrdiff_t start
, end
, whole
;
15820 /* Calculate the start and end positions for the current window.
15821 At some point, it would be nice to choose between scrollbars
15822 which reflect the whole buffer size, with special markers
15823 indicating narrowing, and scrollbars which reflect only the
15826 Note that mini-buffers sometimes aren't displaying any text. */
15827 if (!MINI_WINDOW_P (w
)
15828 || (w
== XWINDOW (minibuf_window
)
15829 && NILP (echo_area_buffer
[0])))
15831 struct buffer
*buf
= XBUFFER (w
->contents
);
15832 whole
= BUF_ZV (buf
) - BUF_BEGV (buf
);
15833 start
= marker_position (w
->start
) - BUF_BEGV (buf
);
15834 /* I don't think this is guaranteed to be right. For the
15835 moment, we'll pretend it is. */
15836 end
= BUF_Z (buf
) - w
->window_end_pos
- BUF_BEGV (buf
);
15840 if (whole
< (end
- start
))
15841 whole
= end
- start
;
15844 start
= end
= whole
= 0;
15846 /* Indicate what this scroll bar ought to be displaying now. */
15847 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15848 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_vertical_scroll_bar_hook
)
15849 (w
, end
- start
, whole
, start
);
15854 set_horizontal_scroll_bar (struct window
*w
)
15856 int start
, end
, whole
, portion
;
15858 if (!MINI_WINDOW_P (w
)
15859 || (w
== XWINDOW (minibuf_window
)
15860 && NILP (echo_area_buffer
[0])))
15862 struct buffer
*b
= XBUFFER (w
->contents
);
15863 struct buffer
*old_buffer
= NULL
;
15865 struct text_pos startp
;
15867 if (b
!= current_buffer
)
15869 old_buffer
= current_buffer
;
15870 set_buffer_internal (b
);
15873 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
15874 start_display (&it
, w
, startp
);
15875 it
.last_visible_x
= INT_MAX
;
15876 whole
= move_it_to (&it
, -1, INT_MAX
, window_box_height (w
), -1,
15877 MOVE_TO_X
| MOVE_TO_Y
);
15878 /* whole = move_it_to (&it, w->window_end_pos, INT_MAX,
15879 window_box_height (w), -1,
15880 MOVE_TO_POS | MOVE_TO_X | MOVE_TO_Y); */
15882 start
= w
->hscroll
* FRAME_COLUMN_WIDTH (WINDOW_XFRAME (w
));
15883 end
= start
+ window_box_width (w
, TEXT_AREA
);
15884 portion
= end
- start
;
15885 /* After enlarging a horizontally scrolled window such that it
15886 gets at least as wide as the text it contains, make sure that
15887 the thumb doesn't fill the entire scroll bar so we can still
15888 drag it back to see the entire text. */
15889 whole
= max (whole
, end
);
15895 pdir
= Fcurrent_bidi_paragraph_direction (Qnil
);
15896 if (EQ (pdir
, Qright_to_left
))
15898 start
= whole
- end
;
15899 end
= start
+ portion
;
15904 set_buffer_internal (old_buffer
);
15907 start
= end
= whole
= portion
= 0;
15909 w
->hscroll_whole
= whole
;
15911 /* Indicate what this scroll bar ought to be displaying now. */
15912 if (FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15913 (*FRAME_TERMINAL (XFRAME (w
->frame
))->set_horizontal_scroll_bar_hook
)
15914 (w
, portion
, whole
, start
);
15918 /* Redisplay leaf window WINDOW. JUST_THIS_ONE_P non-zero means only
15919 selected_window is redisplayed.
15921 We can return without actually redisplaying the window if fonts has been
15922 changed on window's frame. In that case, redisplay_internal will retry.
15924 As one of the important parts of redisplaying a window, we need to
15925 decide whether the previous window-start position (stored in the
15926 window's w->start marker position) is still valid, and if it isn't,
15927 recompute it. Some details about that:
15929 . The previous window-start could be in a continuation line, in
15930 which case we need to recompute it when the window width
15931 changes. See compute_window_start_on_continuation_line and its
15934 . The text that changed since last redisplay could include the
15935 previous window-start position. In that case, we try to salvage
15936 what we can from the current glyph matrix by calling
15937 try_scrolling, which see.
15939 . Some Emacs command could force us to use a specific window-start
15940 position by setting the window's force_start flag, or gently
15941 propose doing that by setting the window's optional_new_start
15942 flag. In these cases, we try using the specified start point if
15943 that succeeds (i.e. the window desired matrix is successfully
15944 recomputed, and point location is within the window). In case
15945 of optional_new_start, we first check if the specified start
15946 position is feasible, i.e. if it will allow point to be
15947 displayed in the window. If using the specified start point
15948 fails, e.g., if new fonts are needed to be loaded, we abort the
15949 redisplay cycle and leave it up to the next cycle to figure out
15952 . Note that the window's force_start flag is sometimes set by
15953 redisplay itself, when it decides that the previous window start
15954 point is fine and should be kept. Search for "goto force_start"
15955 below to see the details. Like the values of window-start
15956 specified outside of redisplay, these internally-deduced values
15957 are tested for feasibility, and ignored if found to be
15960 . Note that the function try_window, used to completely redisplay
15961 a window, accepts the window's start point as its argument.
15962 This is used several times in the redisplay code to control
15963 where the window start will be, according to user options such
15964 as scroll-conservatively, and also to ensure the screen line
15965 showing point will be fully (as opposed to partially) visible on
15969 redisplay_window (Lisp_Object window
, bool just_this_one_p
)
15971 struct window
*w
= XWINDOW (window
);
15972 struct frame
*f
= XFRAME (w
->frame
);
15973 struct buffer
*buffer
= XBUFFER (w
->contents
);
15974 struct buffer
*old
= current_buffer
;
15975 struct text_pos lpoint
, opoint
, startp
;
15976 int update_mode_line
;
15979 /* Record it now because it's overwritten. */
15980 bool current_matrix_up_to_date_p
= false;
15981 bool used_current_matrix_p
= false;
15982 /* This is less strict than current_matrix_up_to_date_p.
15983 It indicates that the buffer contents and narrowing are unchanged. */
15984 bool buffer_unchanged_p
= false;
15985 int temp_scroll_step
= 0;
15986 ptrdiff_t count
= SPECPDL_INDEX ();
15988 int centering_position
= -1;
15989 int last_line_misfit
= 0;
15990 ptrdiff_t beg_unchanged
, end_unchanged
;
15991 int frame_line_height
;
15993 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
15997 *w
->desired_matrix
->method
= 0;
16000 if (!just_this_one_p
16001 && REDISPLAY_SOME_P ()
16004 && !buffer
->text
->redisplay
16005 && BUF_PT (buffer
) == w
->last_point
)
16008 /* Make sure that both W's markers are valid. */
16009 eassert (XMARKER (w
->start
)->buffer
== buffer
);
16010 eassert (XMARKER (w
->pointm
)->buffer
== buffer
);
16012 /* We come here again if we need to run window-text-change-functions
16015 reconsider_clip_changes (w
);
16016 frame_line_height
= default_line_pixel_height (w
);
16018 /* Has the mode line to be updated? */
16019 update_mode_line
= (w
->update_mode_line
16020 || update_mode_lines
16021 || buffer
->clip_changed
16022 || buffer
->prevent_redisplay_optimizations_p
);
16024 if (!just_this_one_p
)
16025 /* If `just_this_one_p' is set, we apparently set must_be_updated_p more
16026 cleverly elsewhere. */
16027 w
->must_be_updated_p
= true;
16029 if (MINI_WINDOW_P (w
))
16031 if (w
== XWINDOW (echo_area_window
)
16032 && !NILP (echo_area_buffer
[0]))
16034 if (update_mode_line
)
16035 /* We may have to update a tty frame's menu bar or a
16036 tool-bar. Example `M-x C-h C-h C-g'. */
16037 goto finish_menu_bars
;
16039 /* We've already displayed the echo area glyphs in this window. */
16040 goto finish_scroll_bars
;
16042 else if ((w
!= XWINDOW (minibuf_window
)
16043 || minibuf_level
== 0)
16044 /* When buffer is nonempty, redisplay window normally. */
16045 && BUF_Z (XBUFFER (w
->contents
)) == BUF_BEG (XBUFFER (w
->contents
))
16046 /* Quail displays non-mini buffers in minibuffer window.
16047 In that case, redisplay the window normally. */
16048 && !NILP (Fmemq (w
->contents
, Vminibuffer_list
)))
16050 /* W is a mini-buffer window, but it's not active, so clear
16052 int yb
= window_text_bottom_y (w
);
16053 struct glyph_row
*row
;
16056 for (y
= 0, row
= w
->desired_matrix
->rows
;
16058 y
+= row
->height
, ++row
)
16059 blank_row (w
, row
, y
);
16060 goto finish_scroll_bars
;
16063 clear_glyph_matrix (w
->desired_matrix
);
16066 /* Otherwise set up data on this window; select its buffer and point
16068 /* Really select the buffer, for the sake of buffer-local
16070 set_buffer_internal_1 (XBUFFER (w
->contents
));
16072 current_matrix_up_to_date_p
16073 = (w
->window_end_valid
16074 && !current_buffer
->clip_changed
16075 && !current_buffer
->prevent_redisplay_optimizations_p
16076 && !window_outdated (w
));
16078 /* Run the window-text-change-functions
16079 if it is possible that the text on the screen has changed
16080 (either due to modification of the text, or any other reason). */
16081 if (!current_matrix_up_to_date_p
16082 && !NILP (Vwindow_text_change_functions
))
16084 safe_run_hooks (Qwindow_text_change_functions
);
16088 beg_unchanged
= BEG_UNCHANGED
;
16089 end_unchanged
= END_UNCHANGED
;
16091 SET_TEXT_POS (opoint
, PT
, PT_BYTE
);
16093 specbind (Qinhibit_point_motion_hooks
, Qt
);
16096 = (w
->window_end_valid
16097 && !current_buffer
->clip_changed
16098 && !window_outdated (w
));
16100 /* When windows_or_buffers_changed is non-zero, we can't rely
16101 on the window end being valid, so set it to zero there. */
16102 if (windows_or_buffers_changed
)
16104 /* If window starts on a continuation line, maybe adjust the
16105 window start in case the window's width changed. */
16106 if (XMARKER (w
->start
)->buffer
== current_buffer
)
16107 compute_window_start_on_continuation_line (w
);
16109 w
->window_end_valid
= false;
16110 /* If so, we also can't rely on current matrix
16111 and should not fool try_cursor_movement below. */
16112 current_matrix_up_to_date_p
= false;
16115 /* Some sanity checks. */
16116 CHECK_WINDOW_END (w
);
16117 if (Z
== Z_BYTE
&& CHARPOS (opoint
) != BYTEPOS (opoint
))
16119 if (BYTEPOS (opoint
) < CHARPOS (opoint
))
16122 if (mode_line_update_needed (w
))
16123 update_mode_line
= 1;
16125 /* Point refers normally to the selected window. For any other
16126 window, set up appropriate value. */
16127 if (!EQ (window
, selected_window
))
16129 ptrdiff_t new_pt
= marker_position (w
->pointm
);
16130 ptrdiff_t new_pt_byte
= marker_byte_position (w
->pointm
);
16135 new_pt_byte
= BEGV_BYTE
;
16136 set_marker_both (w
->pointm
, Qnil
, BEGV
, BEGV_BYTE
);
16138 else if (new_pt
> (ZV
- 1))
16141 new_pt_byte
= ZV_BYTE
;
16142 set_marker_both (w
->pointm
, Qnil
, ZV
, ZV_BYTE
);
16145 /* We don't use SET_PT so that the point-motion hooks don't run. */
16146 TEMP_SET_PT_BOTH (new_pt
, new_pt_byte
);
16149 /* If any of the character widths specified in the display table
16150 have changed, invalidate the width run cache. It's true that
16151 this may be a bit late to catch such changes, but the rest of
16152 redisplay goes (non-fatally) haywire when the display table is
16153 changed, so why should we worry about doing any better? */
16154 if (current_buffer
->width_run_cache
16155 || (current_buffer
->base_buffer
16156 && current_buffer
->base_buffer
->width_run_cache
))
16158 struct Lisp_Char_Table
*disptab
= buffer_display_table ();
16160 if (! disptab_matches_widthtab
16161 (disptab
, XVECTOR (BVAR (current_buffer
, width_table
))))
16163 struct buffer
*buf
= current_buffer
;
16165 if (buf
->base_buffer
)
16166 buf
= buf
->base_buffer
;
16167 invalidate_region_cache (buf
, buf
->width_run_cache
, BEG
, Z
);
16168 recompute_width_table (current_buffer
, disptab
);
16172 /* If window-start is screwed up, choose a new one. */
16173 if (XMARKER (w
->start
)->buffer
!= current_buffer
)
16176 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16178 /* If someone specified a new starting point but did not insist,
16179 check whether it can be used. */
16180 if ((w
->optional_new_start
|| window_frozen_p (w
))
16181 && CHARPOS (startp
) >= BEGV
16182 && CHARPOS (startp
) <= ZV
)
16184 ptrdiff_t it_charpos
;
16186 w
->optional_new_start
= 0;
16187 start_display (&it
, w
, startp
);
16188 move_it_to (&it
, PT
, 0, it
.last_visible_y
, -1,
16189 MOVE_TO_POS
| MOVE_TO_X
| MOVE_TO_Y
);
16190 /* Record IT's position now, since line_bottom_y might change
16192 it_charpos
= IT_CHARPOS (it
);
16193 /* Make sure we set the force_start flag only if the cursor row
16194 will be fully visible. Otherwise, the code under force_start
16195 label below will try to move point back into view, which is
16196 not what the code which sets optional_new_start wants. */
16197 if ((it
.current_y
== 0 || line_bottom_y (&it
) < it
.last_visible_y
)
16198 && !w
->force_start
)
16200 if (it_charpos
== PT
)
16201 w
->force_start
= 1;
16202 /* IT may overshoot PT if text at PT is invisible. */
16203 else if (it_charpos
> PT
&& CHARPOS (startp
) <= PT
)
16204 w
->force_start
= 1;
16206 if (w
->force_start
)
16208 if (window_frozen_p (w
))
16209 debug_method_add (w
, "set force_start from frozen window start");
16211 debug_method_add (w
, "set force_start from optional_new_start");
16219 /* Handle case where place to start displaying has been specified,
16220 unless the specified location is outside the accessible range. */
16221 if (w
->force_start
)
16223 /* We set this later on if we have to adjust point. */
16226 w
->force_start
= 0;
16228 w
->window_end_valid
= 0;
16230 /* Forget any recorded base line for line number display. */
16231 if (!buffer_unchanged_p
)
16232 w
->base_line_number
= 0;
16234 /* Redisplay the mode line. Select the buffer properly for that.
16235 Also, run the hook window-scroll-functions
16236 because we have scrolled. */
16237 /* Note, we do this after clearing force_start because
16238 if there's an error, it is better to forget about force_start
16239 than to get into an infinite loop calling the hook functions
16240 and having them get more errors. */
16241 if (!update_mode_line
16242 || ! NILP (Vwindow_scroll_functions
))
16244 update_mode_line
= 1;
16245 w
->update_mode_line
= 1;
16246 startp
= run_window_scroll_functions (window
, startp
);
16249 if (CHARPOS (startp
) < BEGV
)
16250 SET_TEXT_POS (startp
, BEGV
, BEGV_BYTE
);
16251 else if (CHARPOS (startp
) > ZV
)
16252 SET_TEXT_POS (startp
, ZV
, ZV_BYTE
);
16254 /* Redisplay, then check if cursor has been set during the
16255 redisplay. Give up if new fonts were loaded. */
16256 /* We used to issue a CHECK_MARGINS argument to try_window here,
16257 but this causes scrolling to fail when point begins inside
16258 the scroll margin (bug#148) -- cyd */
16259 if (!try_window (window
, startp
, 0))
16261 w
->force_start
= 1;
16262 clear_glyph_matrix (w
->desired_matrix
);
16263 goto need_larger_matrices
;
16266 if (w
->cursor
.vpos
< 0)
16268 /* If point does not appear, try to move point so it does
16269 appear. The desired matrix has been built above, so we
16270 can use it here. */
16271 new_vpos
= window_box_height (w
) / 2;
16274 if (!cursor_row_fully_visible_p (w
, 0, 0))
16276 /* Point does appear, but on a line partly visible at end of window.
16277 Move it back to a fully-visible line. */
16278 new_vpos
= window_box_height (w
);
16279 /* But if window_box_height suggests a Y coordinate that is
16280 not less than we already have, that line will clearly not
16281 be fully visible, so give up and scroll the display.
16282 This can happen when the default face uses a font whose
16283 dimensions are different from the frame's default
16285 if (new_vpos
>= w
->cursor
.y
)
16287 w
->cursor
.vpos
= -1;
16288 clear_glyph_matrix (w
->desired_matrix
);
16289 goto try_to_scroll
;
16292 else if (w
->cursor
.vpos
>= 0)
16294 /* Some people insist on not letting point enter the scroll
16295 margin, even though this part handles windows that didn't
16297 int window_total_lines
16298 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16299 int margin
= min (scroll_margin
, window_total_lines
/ 4);
16300 int pixel_margin
= margin
* frame_line_height
;
16301 bool header_line
= WINDOW_WANTS_HEADER_LINE_P (w
);
16303 /* Note: We add an extra FRAME_LINE_HEIGHT, because the loop
16304 below, which finds the row to move point to, advances by
16305 the Y coordinate of the _next_ row, see the definition of
16306 MATRIX_ROW_BOTTOM_Y. */
16307 if (w
->cursor
.vpos
< margin
+ header_line
)
16309 w
->cursor
.vpos
= -1;
16310 clear_glyph_matrix (w
->desired_matrix
);
16311 goto try_to_scroll
;
16315 int window_height
= window_box_height (w
);
16318 window_height
+= CURRENT_HEADER_LINE_HEIGHT (w
);
16319 if (w
->cursor
.y
>= window_height
- pixel_margin
)
16321 w
->cursor
.vpos
= -1;
16322 clear_glyph_matrix (w
->desired_matrix
);
16323 goto try_to_scroll
;
16328 /* If we need to move point for either of the above reasons,
16329 now actually do it. */
16332 struct glyph_row
*row
;
16334 row
= MATRIX_FIRST_TEXT_ROW (w
->desired_matrix
);
16335 while (MATRIX_ROW_BOTTOM_Y (row
) < new_vpos
)
16338 TEMP_SET_PT_BOTH (MATRIX_ROW_START_CHARPOS (row
),
16339 MATRIX_ROW_START_BYTEPOS (row
));
16341 if (w
!= XWINDOW (selected_window
))
16342 set_marker_both (w
->pointm
, Qnil
, PT
, PT_BYTE
);
16343 else if (current_buffer
== old
)
16344 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
16346 set_cursor_from_row (w
, row
, w
->desired_matrix
, 0, 0, 0, 0);
16348 /* If we are highlighting the region, then we just changed
16349 the region, so redisplay to show it. */
16350 /* FIXME: We need to (re)run pre-redisplay-function! */
16351 /* if (markpos_of_region () >= 0)
16353 clear_glyph_matrix (w->desired_matrix);
16354 if (!try_window (window, startp, 0))
16355 goto need_larger_matrices;
16359 if (w
->cursor
.vpos
< 0 || !cursor_row_fully_visible_p (w
, 0, 0))
16361 clear_glyph_matrix (w
->desired_matrix
);
16362 goto try_to_scroll
;
16366 debug_method_add (w
, "forced window start");
16371 /* Handle case where text has not changed, only point, and it has
16372 not moved off the frame, and we are not retrying after hscroll.
16373 (current_matrix_up_to_date_p is nonzero when retrying.) */
16374 if (current_matrix_up_to_date_p
16375 && (rc
= try_cursor_movement (window
, startp
, &temp_scroll_step
),
16376 rc
!= CURSOR_MOVEMENT_CANNOT_BE_USED
))
16380 case CURSOR_MOVEMENT_SUCCESS
:
16381 used_current_matrix_p
= 1;
16384 case CURSOR_MOVEMENT_MUST_SCROLL
:
16385 goto try_to_scroll
;
16391 /* If current starting point was originally the beginning of a line
16392 but no longer is, find a new starting point. */
16393 else if (w
->start_at_line_beg
16394 && !(CHARPOS (startp
) <= BEGV
16395 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n'))
16398 debug_method_add (w
, "recenter 1");
16403 /* Try scrolling with try_window_id. Value is > 0 if update has
16404 been done, it is -1 if we know that the same window start will
16405 not work. It is 0 if unsuccessful for some other reason. */
16406 else if ((tem
= try_window_id (w
)) != 0)
16409 debug_method_add (w
, "try_window_id %d", tem
);
16412 if (f
->fonts_changed
)
16413 goto need_larger_matrices
;
16417 /* Otherwise try_window_id has returned -1 which means that we
16418 don't want the alternative below this comment to execute. */
16420 else if (CHARPOS (startp
) >= BEGV
16421 && CHARPOS (startp
) <= ZV
16422 && PT
>= CHARPOS (startp
)
16423 && (CHARPOS (startp
) < ZV
16424 /* Avoid starting at end of buffer. */
16425 || CHARPOS (startp
) == BEGV
16426 || !window_outdated (w
)))
16428 int d1
, d2
, d5
, d6
;
16431 /* If first window line is a continuation line, and window start
16432 is inside the modified region, but the first change is before
16433 current window start, we must select a new window start.
16435 However, if this is the result of a down-mouse event (e.g. by
16436 extending the mouse-drag-overlay), we don't want to select a
16437 new window start, since that would change the position under
16438 the mouse, resulting in an unwanted mouse-movement rather
16439 than a simple mouse-click. */
16440 if (!w
->start_at_line_beg
16441 && NILP (do_mouse_tracking
)
16442 && CHARPOS (startp
) > BEGV
16443 && CHARPOS (startp
) > BEG
+ beg_unchanged
16444 && CHARPOS (startp
) <= Z
- end_unchanged
16445 /* Even if w->start_at_line_beg is nil, a new window may
16446 start at a line_beg, since that's how set_buffer_window
16447 sets it. So, we need to check the return value of
16448 compute_window_start_on_continuation_line. (See also
16450 && XMARKER (w
->start
)->buffer
== current_buffer
16451 && compute_window_start_on_continuation_line (w
)
16452 /* It doesn't make sense to force the window start like we
16453 do at label force_start if it is already known that point
16454 will not be fully visible in the resulting window, because
16455 doing so will move point from its correct position
16456 instead of scrolling the window to bring point into view.
16458 && pos_visible_p (w
, PT
, &d1
, &d2
, &rtop
, &rbot
, &d5
, &d6
)
16459 /* A very tall row could need more than the window height,
16460 in which case we accept that it is partially visible. */
16461 && (rtop
!= 0) == (rbot
!= 0))
16463 w
->force_start
= 1;
16464 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16466 debug_method_add (w
, "recomputed window start in continuation line");
16472 debug_method_add (w
, "same window start");
16475 /* Try to redisplay starting at same place as before.
16476 If point has not moved off frame, accept the results. */
16477 if (!current_matrix_up_to_date_p
16478 /* Don't use try_window_reusing_current_matrix in this case
16479 because a window scroll function can have changed the
16481 || !NILP (Vwindow_scroll_functions
)
16482 || MINI_WINDOW_P (w
)
16483 || !(used_current_matrix_p
16484 = try_window_reusing_current_matrix (w
)))
16486 IF_DEBUG (debug_method_add (w
, "1"));
16487 if (try_window (window
, startp
, TRY_WINDOW_CHECK_MARGINS
) < 0)
16488 /* -1 means we need to scroll.
16489 0 means we need new matrices, but fonts_changed
16490 is set in that case, so we will detect it below. */
16491 goto try_to_scroll
;
16494 if (f
->fonts_changed
)
16495 goto need_larger_matrices
;
16497 if (w
->cursor
.vpos
>= 0)
16499 if (!just_this_one_p
16500 || current_buffer
->clip_changed
16501 || BEG_UNCHANGED
< CHARPOS (startp
))
16502 /* Forget any recorded base line for line number display. */
16503 w
->base_line_number
= 0;
16505 if (!cursor_row_fully_visible_p (w
, 1, 0))
16507 clear_glyph_matrix (w
->desired_matrix
);
16508 last_line_misfit
= 1;
16510 /* Drop through and scroll. */
16515 clear_glyph_matrix (w
->desired_matrix
);
16520 /* Redisplay the mode line. Select the buffer properly for that. */
16521 if (!update_mode_line
)
16523 update_mode_line
= 1;
16524 w
->update_mode_line
= 1;
16527 /* Try to scroll by specified few lines. */
16528 if ((scroll_conservatively
16529 || emacs_scroll_step
16530 || temp_scroll_step
16531 || NUMBERP (BVAR (current_buffer
, scroll_up_aggressively
))
16532 || NUMBERP (BVAR (current_buffer
, scroll_down_aggressively
)))
16533 && CHARPOS (startp
) >= BEGV
16534 && CHARPOS (startp
) <= ZV
)
16536 /* The function returns -1 if new fonts were loaded, 1 if
16537 successful, 0 if not successful. */
16538 int ss
= try_scrolling (window
, just_this_one_p
,
16539 scroll_conservatively
,
16541 temp_scroll_step
, last_line_misfit
);
16544 case SCROLLING_SUCCESS
:
16547 case SCROLLING_NEED_LARGER_MATRICES
:
16548 goto need_larger_matrices
;
16550 case SCROLLING_FAILED
:
16558 /* Finally, just choose a place to start which positions point
16559 according to user preferences. */
16564 debug_method_add (w
, "recenter");
16567 /* Forget any previously recorded base line for line number display. */
16568 if (!buffer_unchanged_p
)
16569 w
->base_line_number
= 0;
16571 /* Determine the window start relative to point. */
16572 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16573 it
.current_y
= it
.last_visible_y
;
16574 if (centering_position
< 0)
16576 int window_total_lines
16577 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
16580 ? min (scroll_margin
, window_total_lines
/ 4)
16582 ptrdiff_t margin_pos
= CHARPOS (startp
);
16583 Lisp_Object aggressive
;
16586 /* If there is a scroll margin at the top of the window, find
16587 its character position. */
16589 /* Cannot call start_display if startp is not in the
16590 accessible region of the buffer. This can happen when we
16591 have just switched to a different buffer and/or changed
16592 its restriction. In that case, startp is initialized to
16593 the character position 1 (BEGV) because we did not yet
16594 have chance to display the buffer even once. */
16595 && BEGV
<= CHARPOS (startp
) && CHARPOS (startp
) <= ZV
)
16598 void *it1data
= NULL
;
16600 SAVE_IT (it1
, it
, it1data
);
16601 start_display (&it1
, w
, startp
);
16602 move_it_vertically (&it1
, margin
* frame_line_height
);
16603 margin_pos
= IT_CHARPOS (it1
);
16604 RESTORE_IT (&it
, &it
, it1data
);
16606 scrolling_up
= PT
> margin_pos
;
16609 ? BVAR (current_buffer
, scroll_up_aggressively
)
16610 : BVAR (current_buffer
, scroll_down_aggressively
);
16612 if (!MINI_WINDOW_P (w
)
16613 && (scroll_conservatively
> SCROLL_LIMIT
|| NUMBERP (aggressive
)))
16617 /* Setting scroll-conservatively overrides
16618 scroll-*-aggressively. */
16619 if (!scroll_conservatively
&& NUMBERP (aggressive
))
16621 double float_amount
= XFLOATINT (aggressive
);
16623 pt_offset
= float_amount
* WINDOW_BOX_TEXT_HEIGHT (w
);
16624 if (pt_offset
== 0 && float_amount
> 0)
16626 if (pt_offset
&& margin
> 0)
16629 /* Compute how much to move the window start backward from
16630 point so that point will be displayed where the user
16634 centering_position
= it
.last_visible_y
;
16636 centering_position
-= pt_offset
;
16637 centering_position
-=
16638 frame_line_height
* (1 + margin
+ (last_line_misfit
!= 0))
16639 + WINDOW_HEADER_LINE_HEIGHT (w
);
16640 /* Don't let point enter the scroll margin near top of
16642 if (centering_position
< margin
* frame_line_height
)
16643 centering_position
= margin
* frame_line_height
;
16646 centering_position
= margin
* frame_line_height
+ pt_offset
;
16649 /* Set the window start half the height of the window backward
16651 centering_position
= window_box_height (w
) / 2;
16653 move_it_vertically_backward (&it
, centering_position
);
16655 eassert (IT_CHARPOS (it
) >= BEGV
);
16657 /* The function move_it_vertically_backward may move over more
16658 than the specified y-distance. If it->w is small, e.g. a
16659 mini-buffer window, we may end up in front of the window's
16660 display area. Start displaying at the start of the line
16661 containing PT in this case. */
16662 if (it
.current_y
<= 0)
16664 init_iterator (&it
, w
, PT
, PT_BYTE
, NULL
, DEFAULT_FACE_ID
);
16665 move_it_vertically_backward (&it
, 0);
16669 it
.current_x
= it
.hpos
= 0;
16671 /* Set the window start position here explicitly, to avoid an
16672 infinite loop in case the functions in window-scroll-functions
16674 set_marker_both (w
->start
, Qnil
, IT_CHARPOS (it
), IT_BYTEPOS (it
));
16676 /* Run scroll hooks. */
16677 startp
= run_window_scroll_functions (window
, it
.current
.pos
);
16679 /* Redisplay the window. */
16680 if (!current_matrix_up_to_date_p
16681 || windows_or_buffers_changed
16682 || f
->cursor_type_changed
16683 /* Don't use try_window_reusing_current_matrix in this case
16684 because it can have changed the buffer. */
16685 || !NILP (Vwindow_scroll_functions
)
16686 || !just_this_one_p
16687 || MINI_WINDOW_P (w
)
16688 || !(used_current_matrix_p
16689 = try_window_reusing_current_matrix (w
)))
16690 try_window (window
, startp
, 0);
16692 /* If new fonts have been loaded (due to fontsets), give up. We
16693 have to start a new redisplay since we need to re-adjust glyph
16695 if (f
->fonts_changed
)
16696 goto need_larger_matrices
;
16698 /* If cursor did not appear assume that the middle of the window is
16699 in the first line of the window. Do it again with the next line.
16700 (Imagine a window of height 100, displaying two lines of height
16701 60. Moving back 50 from it->last_visible_y will end in the first
16703 if (w
->cursor
.vpos
< 0)
16705 if (w
->window_end_valid
&& PT
>= Z
- w
->window_end_pos
)
16707 clear_glyph_matrix (w
->desired_matrix
);
16708 move_it_by_lines (&it
, 1);
16709 try_window (window
, it
.current
.pos
, 0);
16711 else if (PT
< IT_CHARPOS (it
))
16713 clear_glyph_matrix (w
->desired_matrix
);
16714 move_it_by_lines (&it
, -1);
16715 try_window (window
, it
.current
.pos
, 0);
16719 /* Not much we can do about it. */
16723 /* Consider the following case: Window starts at BEGV, there is
16724 invisible, intangible text at BEGV, so that display starts at
16725 some point START > BEGV. It can happen that we are called with
16726 PT somewhere between BEGV and START. Try to handle that case,
16727 and similar ones. */
16728 if (w
->cursor
.vpos
< 0)
16730 /* First, try locating the proper glyph row for PT. */
16731 struct glyph_row
*row
=
16732 row_containing_pos (w
, PT
, w
->current_matrix
->rows
, NULL
, 0);
16734 /* Sometimes point is at the beginning of invisible text that is
16735 before the 1st character displayed in the row. In that case,
16736 row_containing_pos fails to find the row, because no glyphs
16737 with appropriate buffer positions are present in the row.
16738 Therefore, we next try to find the row which shows the 1st
16739 position after the invisible text. */
16743 get_char_property_and_overlay (make_number (PT
), Qinvisible
,
16746 if (TEXT_PROP_MEANS_INVISIBLE (val
))
16749 Lisp_Object invis_end
=
16750 Fnext_single_char_property_change (make_number (PT
), Qinvisible
,
16753 if (NATNUMP (invis_end
))
16754 alt_pos
= XFASTINT (invis_end
);
16757 row
= row_containing_pos (w
, alt_pos
, w
->current_matrix
->rows
,
16761 /* Finally, fall back on the first row of the window after the
16762 header line (if any). This is slightly better than not
16763 displaying the cursor at all. */
16766 row
= w
->current_matrix
->rows
;
16767 if (row
->mode_line_p
)
16770 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
16773 if (!cursor_row_fully_visible_p (w
, 0, 0))
16775 /* If vscroll is enabled, disable it and try again. */
16779 clear_glyph_matrix (w
->desired_matrix
);
16783 /* Users who set scroll-conservatively to a large number want
16784 point just above/below the scroll margin. If we ended up
16785 with point's row partially visible, move the window start to
16786 make that row fully visible and out of the margin. */
16787 if (scroll_conservatively
> SCROLL_LIMIT
)
16789 int window_total_lines
16790 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) * frame_line_height
;
16793 ? min (scroll_margin
, window_total_lines
/ 4)
16795 int move_down
= w
->cursor
.vpos
>= window_total_lines
/ 2;
16797 move_it_by_lines (&it
, move_down
? margin
+ 1 : -(margin
+ 1));
16798 clear_glyph_matrix (w
->desired_matrix
);
16799 if (1 == try_window (window
, it
.current
.pos
,
16800 TRY_WINDOW_CHECK_MARGINS
))
16804 /* If centering point failed to make the whole line visible,
16805 put point at the top instead. That has to make the whole line
16806 visible, if it can be done. */
16807 if (centering_position
== 0)
16810 clear_glyph_matrix (w
->desired_matrix
);
16811 centering_position
= 0;
16817 SET_TEXT_POS_FROM_MARKER (startp
, w
->start
);
16818 w
->start_at_line_beg
= (CHARPOS (startp
) == BEGV
16819 || FETCH_BYTE (BYTEPOS (startp
) - 1) == '\n');
16821 /* Display the mode line, if we must. */
16822 if ((update_mode_line
16823 /* If window not full width, must redo its mode line
16824 if (a) the window to its side is being redone and
16825 (b) we do a frame-based redisplay. This is a consequence
16826 of how inverted lines are drawn in frame-based redisplay. */
16827 || (!just_this_one_p
16828 && !FRAME_WINDOW_P (f
)
16829 && !WINDOW_FULL_WIDTH_P (w
))
16830 /* Line number to display. */
16831 || w
->base_line_pos
> 0
16832 /* Column number is displayed and different from the one displayed. */
16833 || (w
->column_number_displayed
!= -1
16834 && (w
->column_number_displayed
!= current_column ())))
16835 /* This means that the window has a mode line. */
16836 && (WINDOW_WANTS_MODELINE_P (w
)
16837 || WINDOW_WANTS_HEADER_LINE_P (w
)))
16840 display_mode_lines (w
);
16842 /* If mode line height has changed, arrange for a thorough
16843 immediate redisplay using the correct mode line height. */
16844 if (WINDOW_WANTS_MODELINE_P (w
)
16845 && CURRENT_MODE_LINE_HEIGHT (w
) != DESIRED_MODE_LINE_HEIGHT (w
))
16847 f
->fonts_changed
= 1;
16848 w
->mode_line_height
= -1;
16849 MATRIX_MODE_LINE_ROW (w
->current_matrix
)->height
16850 = DESIRED_MODE_LINE_HEIGHT (w
);
16853 /* If header line height has changed, arrange for a thorough
16854 immediate redisplay using the correct header line height. */
16855 if (WINDOW_WANTS_HEADER_LINE_P (w
)
16856 && CURRENT_HEADER_LINE_HEIGHT (w
) != DESIRED_HEADER_LINE_HEIGHT (w
))
16858 f
->fonts_changed
= 1;
16859 w
->header_line_height
= -1;
16860 MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->height
16861 = DESIRED_HEADER_LINE_HEIGHT (w
);
16864 if (f
->fonts_changed
)
16865 goto need_larger_matrices
;
16868 if (!line_number_displayed
&& w
->base_line_pos
!= -1)
16870 w
->base_line_pos
= 0;
16871 w
->base_line_number
= 0;
16876 /* When we reach a frame's selected window, redo the frame's menu bar. */
16877 if (update_mode_line
16878 && EQ (FRAME_SELECTED_WINDOW (f
), window
))
16880 int redisplay_menu_p
= 0;
16882 if (FRAME_WINDOW_P (f
))
16884 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
16885 || defined (HAVE_NS) || defined (USE_GTK)
16886 redisplay_menu_p
= FRAME_EXTERNAL_MENU_BAR (f
);
16888 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16892 redisplay_menu_p
= FRAME_MENU_BAR_LINES (f
) > 0;
16894 if (redisplay_menu_p
)
16895 display_menu_bar (w
);
16897 #ifdef HAVE_WINDOW_SYSTEM
16898 if (FRAME_WINDOW_P (f
))
16900 #if defined (USE_GTK) || defined (HAVE_NS)
16901 if (FRAME_EXTERNAL_TOOL_BAR (f
))
16902 redisplay_tool_bar (f
);
16904 if (WINDOWP (f
->tool_bar_window
)
16905 && (FRAME_TOOL_BAR_LINES (f
) > 0
16906 || !NILP (Vauto_resize_tool_bars
))
16907 && redisplay_tool_bar (f
))
16908 ignore_mouse_drag_p
= 1;
16914 #ifdef HAVE_WINDOW_SYSTEM
16915 if (FRAME_WINDOW_P (f
)
16916 && update_window_fringes (w
, (just_this_one_p
16917 || (!used_current_matrix_p
&& !overlay_arrow_seen
)
16918 || w
->pseudo_window_p
)))
16922 if (draw_window_fringes (w
, 1))
16924 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
16925 x_draw_right_divider (w
);
16927 x_draw_vertical_border (w
);
16933 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
16934 x_draw_bottom_divider (w
);
16935 #endif /* HAVE_WINDOW_SYSTEM */
16937 /* We go to this label, with fonts_changed set, if it is
16938 necessary to try again using larger glyph matrices.
16939 We have to redeem the scroll bar even in this case,
16940 because the loop in redisplay_internal expects that. */
16941 need_larger_matrices
:
16943 finish_scroll_bars
:
16945 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
) || WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16947 if (WINDOW_HAS_VERTICAL_SCROLL_BAR (w
))
16948 /* Set the thumb's position and size. */
16949 set_vertical_scroll_bar (w
);
16951 if (WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w
))
16952 /* Set the thumb's position and size. */
16953 set_horizontal_scroll_bar (w
);
16955 /* Note that we actually used the scroll bar attached to this
16956 window, so it shouldn't be deleted at the end of redisplay. */
16957 if (FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
)
16958 (*FRAME_TERMINAL (f
)->redeem_scroll_bar_hook
) (w
);
16961 /* Restore current_buffer and value of point in it. The window
16962 update may have changed the buffer, so first make sure `opoint'
16963 is still valid (Bug#6177). */
16964 if (CHARPOS (opoint
) < BEGV
)
16965 TEMP_SET_PT_BOTH (BEGV
, BEGV_BYTE
);
16966 else if (CHARPOS (opoint
) > ZV
)
16967 TEMP_SET_PT_BOTH (Z
, Z_BYTE
);
16969 TEMP_SET_PT_BOTH (CHARPOS (opoint
), BYTEPOS (opoint
));
16971 set_buffer_internal_1 (old
);
16972 /* Avoid an abort in TEMP_SET_PT_BOTH if the buffer has become
16973 shorter. This can be caused by log truncation in *Messages*. */
16974 if (CHARPOS (lpoint
) <= ZV
)
16975 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
16977 unbind_to (count
, Qnil
);
16981 /* Build the complete desired matrix of WINDOW with a window start
16982 buffer position POS.
16984 Value is 1 if successful. It is zero if fonts were loaded during
16985 redisplay which makes re-adjusting glyph matrices necessary, and -1
16986 if point would appear in the scroll margins.
16987 (We check the former only if TRY_WINDOW_IGNORE_FONTS_CHANGE is
16988 unset in FLAGS, and the latter only if TRY_WINDOW_CHECK_MARGINS is
16992 try_window (Lisp_Object window
, struct text_pos pos
, int flags
)
16994 struct window
*w
= XWINDOW (window
);
16996 struct glyph_row
*last_text_row
= NULL
;
16997 struct frame
*f
= XFRAME (w
->frame
);
16998 int frame_line_height
= default_line_pixel_height (w
);
17000 /* Make POS the new window start. */
17001 set_marker_both (w
->start
, Qnil
, CHARPOS (pos
), BYTEPOS (pos
));
17003 /* Mark cursor position as unknown. No overlay arrow seen. */
17004 w
->cursor
.vpos
= -1;
17005 overlay_arrow_seen
= 0;
17007 /* Initialize iterator and info to start at POS. */
17008 start_display (&it
, w
, pos
);
17009 it
.glyph_row
->reversed_p
= false;
17011 /* Display all lines of W. */
17012 while (it
.current_y
< it
.last_visible_y
)
17014 if (display_line (&it
))
17015 last_text_row
= it
.glyph_row
- 1;
17016 if (f
->fonts_changed
&& !(flags
& TRY_WINDOW_IGNORE_FONTS_CHANGE
))
17020 /* Don't let the cursor end in the scroll margins. */
17021 if ((flags
& TRY_WINDOW_CHECK_MARGINS
)
17022 && !MINI_WINDOW_P (w
))
17024 int this_scroll_margin
;
17025 int window_total_lines
17026 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (f
) / frame_line_height
;
17028 if (scroll_margin
> 0)
17030 this_scroll_margin
= min (scroll_margin
, window_total_lines
/ 4);
17031 this_scroll_margin
*= frame_line_height
;
17034 this_scroll_margin
= 0;
17036 if ((w
->cursor
.y
>= 0 /* not vscrolled */
17037 && w
->cursor
.y
< this_scroll_margin
17038 && CHARPOS (pos
) > BEGV
17039 && IT_CHARPOS (it
) < ZV
)
17040 /* rms: considering make_cursor_line_fully_visible_p here
17041 seems to give wrong results. We don't want to recenter
17042 when the last line is partly visible, we want to allow
17043 that case to be handled in the usual way. */
17044 || w
->cursor
.y
> it
.last_visible_y
- this_scroll_margin
- 1)
17046 w
->cursor
.vpos
= -1;
17047 clear_glyph_matrix (w
->desired_matrix
);
17052 /* If bottom moved off end of frame, change mode line percentage. */
17053 if (w
->window_end_pos
<= 0 && Z
!= IT_CHARPOS (it
))
17054 w
->update_mode_line
= 1;
17056 /* Set window_end_pos to the offset of the last character displayed
17057 on the window from the end of current_buffer. Set
17058 window_end_vpos to its row number. */
17061 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_text_row
));
17062 adjust_window_ends (w
, last_text_row
, 0);
17064 (MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->desired_matrix
,
17065 w
->window_end_vpos
)));
17069 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17070 w
->window_end_pos
= Z
- ZV
;
17071 w
->window_end_vpos
= 0;
17074 /* But that is not valid info until redisplay finishes. */
17075 w
->window_end_valid
= 0;
17081 /************************************************************************
17082 Window redisplay reusing current matrix when buffer has not changed
17083 ************************************************************************/
17085 /* Try redisplay of window W showing an unchanged buffer with a
17086 different window start than the last time it was displayed by
17087 reusing its current matrix. Value is non-zero if successful.
17088 W->start is the new window start. */
17091 try_window_reusing_current_matrix (struct window
*w
)
17093 struct frame
*f
= XFRAME (w
->frame
);
17094 struct glyph_row
*bottom_row
;
17097 struct text_pos start
, new_start
;
17098 int nrows_scrolled
, i
;
17099 struct glyph_row
*last_text_row
;
17100 struct glyph_row
*last_reused_text_row
;
17101 struct glyph_row
*start_row
;
17102 int start_vpos
, min_y
, max_y
;
17105 if (inhibit_try_window_reusing
)
17109 if (/* This function doesn't handle terminal frames. */
17110 !FRAME_WINDOW_P (f
)
17111 /* Don't try to reuse the display if windows have been split
17113 || windows_or_buffers_changed
17114 || f
->cursor_type_changed
)
17117 /* Can't do this if showing trailing whitespace. */
17118 if (!NILP (Vshow_trailing_whitespace
))
17121 /* If top-line visibility has changed, give up. */
17122 if (WINDOW_WANTS_HEADER_LINE_P (w
)
17123 != MATRIX_HEADER_LINE_ROW (w
->current_matrix
)->mode_line_p
)
17126 /* Give up if old or new display is scrolled vertically. We could
17127 make this function handle this, but right now it doesn't. */
17128 start_row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17129 if (w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
))
17132 /* The variable new_start now holds the new window start. The old
17133 start `start' can be determined from the current matrix. */
17134 SET_TEXT_POS_FROM_MARKER (new_start
, w
->start
);
17135 start
= start_row
->minpos
;
17136 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17138 /* Clear the desired matrix for the display below. */
17139 clear_glyph_matrix (w
->desired_matrix
);
17141 if (CHARPOS (new_start
) <= CHARPOS (start
))
17143 /* Don't use this method if the display starts with an ellipsis
17144 displayed for invisible text. It's not easy to handle that case
17145 below, and it's certainly not worth the effort since this is
17146 not a frequent case. */
17147 if (in_ellipses_for_invisible_text_p (&start_row
->start
, w
))
17150 IF_DEBUG (debug_method_add (w
, "twu1"));
17152 /* Display up to a row that can be reused. The variable
17153 last_text_row is set to the last row displayed that displays
17154 text. Note that it.vpos == 0 if or if not there is a
17155 header-line; it's not the same as the MATRIX_ROW_VPOS! */
17156 start_display (&it
, w
, new_start
);
17157 w
->cursor
.vpos
= -1;
17158 last_text_row
= last_reused_text_row
= NULL
;
17160 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17162 /* If we have reached into the characters in the START row,
17163 that means the line boundaries have changed. So we
17164 can't start copying with the row START. Maybe it will
17165 work to start copying with the following row. */
17166 while (IT_CHARPOS (it
) > CHARPOS (start
))
17168 /* Advance to the next row as the "start". */
17170 start
= start_row
->minpos
;
17171 /* If there are no more rows to try, or just one, give up. */
17172 if (start_row
== MATRIX_MODE_LINE_ROW (w
->current_matrix
) - 1
17173 || w
->vscroll
|| MATRIX_ROW_PARTIALLY_VISIBLE_P (w
, start_row
)
17174 || CHARPOS (start
) == ZV
)
17176 clear_glyph_matrix (w
->desired_matrix
);
17180 start_vpos
= MATRIX_ROW_VPOS (start_row
, w
->current_matrix
);
17182 /* If we have reached alignment, we can copy the rest of the
17184 if (IT_CHARPOS (it
) == CHARPOS (start
)
17185 /* Don't accept "alignment" inside a display vector,
17186 since start_row could have started in the middle of
17187 that same display vector (thus their character
17188 positions match), and we have no way of telling if
17189 that is the case. */
17190 && it
.current
.dpvec_index
< 0)
17193 it
.glyph_row
->reversed_p
= false;
17194 if (display_line (&it
))
17195 last_text_row
= it
.glyph_row
- 1;
17199 /* A value of current_y < last_visible_y means that we stopped
17200 at the previous window start, which in turn means that we
17201 have at least one reusable row. */
17202 if (it
.current_y
< it
.last_visible_y
)
17204 struct glyph_row
*row
;
17206 /* IT.vpos always starts from 0; it counts text lines. */
17207 nrows_scrolled
= it
.vpos
- (start_row
- MATRIX_FIRST_TEXT_ROW (w
->current_matrix
));
17209 /* Find PT if not already found in the lines displayed. */
17210 if (w
->cursor
.vpos
< 0)
17212 int dy
= it
.current_y
- start_row
->y
;
17214 row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17215 row
= row_containing_pos (w
, PT
, row
, NULL
, dy
);
17217 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0,
17218 dy
, nrows_scrolled
);
17221 clear_glyph_matrix (w
->desired_matrix
);
17226 /* Scroll the display. Do it before the current matrix is
17227 changed. The problem here is that update has not yet
17228 run, i.e. part of the current matrix is not up to date.
17229 scroll_run_hook will clear the cursor, and use the
17230 current matrix to get the height of the row the cursor is
17232 run
.current_y
= start_row
->y
;
17233 run
.desired_y
= it
.current_y
;
17234 run
.height
= it
.last_visible_y
- it
.current_y
;
17236 if (run
.height
> 0 && run
.current_y
!= run
.desired_y
)
17239 FRAME_RIF (f
)->update_window_begin_hook (w
);
17240 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17241 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17242 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17246 /* Shift current matrix down by nrows_scrolled lines. */
17247 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17248 rotate_matrix (w
->current_matrix
,
17250 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17253 /* Disable lines that must be updated. */
17254 for (i
= 0; i
< nrows_scrolled
; ++i
)
17255 (start_row
+ i
)->enabled_p
= false;
17257 /* Re-compute Y positions. */
17258 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17259 max_y
= it
.last_visible_y
;
17260 for (row
= start_row
+ nrows_scrolled
;
17264 row
->y
= it
.current_y
;
17265 row
->visible_height
= row
->height
;
17267 if (row
->y
< min_y
)
17268 row
->visible_height
-= min_y
- row
->y
;
17269 if (row
->y
+ row
->height
> max_y
)
17270 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17271 if (row
->fringe_bitmap_periodic_p
)
17272 row
->redraw_fringe_bitmaps_p
= 1;
17274 it
.current_y
+= row
->height
;
17276 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17277 last_reused_text_row
= row
;
17278 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
.last_visible_y
)
17282 /* Disable lines in the current matrix which are now
17283 below the window. */
17284 for (++row
; row
< bottom_row
; ++row
)
17285 row
->enabled_p
= row
->mode_line_p
= 0;
17288 /* Update window_end_pos etc.; last_reused_text_row is the last
17289 reused row from the current matrix containing text, if any.
17290 The value of last_text_row is the last displayed line
17291 containing text. */
17292 if (last_reused_text_row
)
17293 adjust_window_ends (w
, last_reused_text_row
, 1);
17294 else if (last_text_row
)
17295 adjust_window_ends (w
, last_text_row
, 0);
17298 /* This window must be completely empty. */
17299 w
->window_end_bytepos
= Z_BYTE
- ZV_BYTE
;
17300 w
->window_end_pos
= Z
- ZV
;
17301 w
->window_end_vpos
= 0;
17303 w
->window_end_valid
= 0;
17305 /* Update hint: don't try scrolling again in update_window. */
17306 w
->desired_matrix
->no_scrolling_p
= 1;
17309 debug_method_add (w
, "try_window_reusing_current_matrix 1");
17313 else if (CHARPOS (new_start
) > CHARPOS (start
))
17315 struct glyph_row
*pt_row
, *row
;
17316 struct glyph_row
*first_reusable_row
;
17317 struct glyph_row
*first_row_to_display
;
17319 int yb
= window_text_bottom_y (w
);
17321 /* Find the row starting at new_start, if there is one. Don't
17322 reuse a partially visible line at the end. */
17323 first_reusable_row
= start_row
;
17324 while (first_reusable_row
->enabled_p
17325 && MATRIX_ROW_BOTTOM_Y (first_reusable_row
) < yb
17326 && (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17327 < CHARPOS (new_start
)))
17328 ++first_reusable_row
;
17330 /* Give up if there is no row to reuse. */
17331 if (MATRIX_ROW_BOTTOM_Y (first_reusable_row
) >= yb
17332 || !first_reusable_row
->enabled_p
17333 || (MATRIX_ROW_START_CHARPOS (first_reusable_row
)
17334 != CHARPOS (new_start
)))
17337 /* We can reuse fully visible rows beginning with
17338 first_reusable_row to the end of the window. Set
17339 first_row_to_display to the first row that cannot be reused.
17340 Set pt_row to the row containing point, if there is any. */
17342 for (first_row_to_display
= first_reusable_row
;
17343 MATRIX_ROW_BOTTOM_Y (first_row_to_display
) < yb
;
17344 ++first_row_to_display
)
17346 if (PT
>= MATRIX_ROW_START_CHARPOS (first_row_to_display
)
17347 && (PT
< MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17348 || (PT
== MATRIX_ROW_END_CHARPOS (first_row_to_display
)
17349 && first_row_to_display
->ends_at_zv_p
17350 && pt_row
== NULL
)))
17351 pt_row
= first_row_to_display
;
17354 /* Start displaying at the start of first_row_to_display. */
17355 eassert (first_row_to_display
->y
< yb
);
17356 init_to_row_start (&it
, w
, first_row_to_display
);
17358 nrows_scrolled
= (MATRIX_ROW_VPOS (first_reusable_row
, w
->current_matrix
)
17360 it
.vpos
= (MATRIX_ROW_VPOS (first_row_to_display
, w
->current_matrix
)
17362 it
.current_y
= (first_row_to_display
->y
- first_reusable_row
->y
17363 + WINDOW_HEADER_LINE_HEIGHT (w
));
17365 /* Display lines beginning with first_row_to_display in the
17366 desired matrix. Set last_text_row to the last row displayed
17367 that displays text. */
17368 it
.glyph_row
= MATRIX_ROW (w
->desired_matrix
, it
.vpos
);
17369 if (pt_row
== NULL
)
17370 w
->cursor
.vpos
= -1;
17371 last_text_row
= NULL
;
17372 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
17373 if (display_line (&it
))
17374 last_text_row
= it
.glyph_row
- 1;
17376 /* If point is in a reused row, adjust y and vpos of the cursor
17380 w
->cursor
.vpos
-= nrows_scrolled
;
17381 w
->cursor
.y
-= first_reusable_row
->y
- start_row
->y
;
17384 /* Give up if point isn't in a row displayed or reused. (This
17385 also handles the case where w->cursor.vpos < nrows_scrolled
17386 after the calls to display_line, which can happen with scroll
17387 margins. See bug#1295.) */
17388 if (w
->cursor
.vpos
< 0)
17390 clear_glyph_matrix (w
->desired_matrix
);
17394 /* Scroll the display. */
17395 run
.current_y
= first_reusable_row
->y
;
17396 run
.desired_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17397 run
.height
= it
.last_visible_y
- run
.current_y
;
17398 dy
= run
.current_y
- run
.desired_y
;
17403 FRAME_RIF (f
)->update_window_begin_hook (w
);
17404 FRAME_RIF (f
)->clear_window_mouse_face (w
);
17405 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
17406 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
17410 /* Adjust Y positions of reused rows. */
17411 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
);
17412 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
17413 max_y
= it
.last_visible_y
;
17414 for (row
= first_reusable_row
; row
< first_row_to_display
; ++row
)
17417 row
->visible_height
= row
->height
;
17418 if (row
->y
< min_y
)
17419 row
->visible_height
-= min_y
- row
->y
;
17420 if (row
->y
+ row
->height
> max_y
)
17421 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
17422 if (row
->fringe_bitmap_periodic_p
)
17423 row
->redraw_fringe_bitmaps_p
= 1;
17426 /* Scroll the current matrix. */
17427 eassert (nrows_scrolled
> 0);
17428 rotate_matrix (w
->current_matrix
,
17430 MATRIX_ROW_VPOS (bottom_row
, w
->current_matrix
),
17433 /* Disable rows not reused. */
17434 for (row
-= nrows_scrolled
; row
< bottom_row
; ++row
)
17435 row
->enabled_p
= false;
17437 /* Point may have moved to a different line, so we cannot assume that
17438 the previous cursor position is valid; locate the correct row. */
17441 for (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
);
17443 && PT
>= MATRIX_ROW_END_CHARPOS (row
)
17444 && !row
->ends_at_zv_p
;
17448 w
->cursor
.y
= row
->y
;
17450 if (row
< bottom_row
)
17452 /* Can't simply scan the row for point with
17453 bidi-reordered glyph rows. Let set_cursor_from_row
17454 figure out where to put the cursor, and if it fails,
17456 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
)))
17458 if (!set_cursor_from_row (w
, row
, w
->current_matrix
,
17461 clear_glyph_matrix (w
->desired_matrix
);
17467 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + w
->cursor
.hpos
;
17468 struct glyph
*end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17471 && (!BUFFERP (glyph
->object
)
17472 || glyph
->charpos
< PT
);
17476 w
->cursor
.x
+= glyph
->pixel_width
;
17482 /* Adjust window end. A null value of last_text_row means that
17483 the window end is in reused rows which in turn means that
17484 only its vpos can have changed. */
17486 adjust_window_ends (w
, last_text_row
, 0);
17488 w
->window_end_vpos
-= nrows_scrolled
;
17490 w
->window_end_valid
= 0;
17491 w
->desired_matrix
->no_scrolling_p
= 1;
17494 debug_method_add (w
, "try_window_reusing_current_matrix 2");
17504 /************************************************************************
17505 Window redisplay reusing current matrix when buffer has changed
17506 ************************************************************************/
17508 static struct glyph_row
*find_last_unchanged_at_beg_row (struct window
*);
17509 static struct glyph_row
*find_first_unchanged_at_end_row (struct window
*,
17510 ptrdiff_t *, ptrdiff_t *);
17511 static struct glyph_row
*
17512 find_last_row_displaying_text (struct glyph_matrix
*, struct it
*,
17513 struct glyph_row
*);
17516 /* Return the last row in MATRIX displaying text. If row START is
17517 non-null, start searching with that row. IT gives the dimensions
17518 of the display. Value is null if matrix is empty; otherwise it is
17519 a pointer to the row found. */
17521 static struct glyph_row
*
17522 find_last_row_displaying_text (struct glyph_matrix
*matrix
, struct it
*it
,
17523 struct glyph_row
*start
)
17525 struct glyph_row
*row
, *row_found
;
17527 /* Set row_found to the last row in IT->w's current matrix
17528 displaying text. The loop looks funny but think of partially
17531 row
= start
? start
: MATRIX_FIRST_TEXT_ROW (matrix
);
17532 while (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17534 eassert (row
->enabled_p
);
17536 if (MATRIX_ROW_BOTTOM_Y (row
) >= it
->last_visible_y
)
17545 /* Return the last row in the current matrix of W that is not affected
17546 by changes at the start of current_buffer that occurred since W's
17547 current matrix was built. Value is null if no such row exists.
17549 BEG_UNCHANGED us the number of characters unchanged at the start of
17550 current_buffer. BEG + BEG_UNCHANGED is the buffer position of the
17551 first changed character in current_buffer. Characters at positions <
17552 BEG + BEG_UNCHANGED are at the same buffer positions as they were
17553 when the current matrix was built. */
17555 static struct glyph_row
*
17556 find_last_unchanged_at_beg_row (struct window
*w
)
17558 ptrdiff_t first_changed_pos
= BEG
+ BEG_UNCHANGED
;
17559 struct glyph_row
*row
;
17560 struct glyph_row
*row_found
= NULL
;
17561 int yb
= window_text_bottom_y (w
);
17563 /* Find the last row displaying unchanged text. */
17564 for (row
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17565 MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17566 && MATRIX_ROW_START_CHARPOS (row
) < first_changed_pos
;
17569 if (/* If row ends before first_changed_pos, it is unchanged,
17570 except in some case. */
17571 MATRIX_ROW_END_CHARPOS (row
) <= first_changed_pos
17572 /* When row ends in ZV and we write at ZV it is not
17574 && !row
->ends_at_zv_p
17575 /* When first_changed_pos is the end of a continued line,
17576 row is not unchanged because it may be no longer
17578 && !(MATRIX_ROW_END_CHARPOS (row
) == first_changed_pos
17579 && (row
->continued_p
17580 || row
->exact_window_width_line_p
))
17581 /* If ROW->end is beyond ZV, then ROW->end is outdated and
17582 needs to be recomputed, so don't consider this row as
17583 unchanged. This happens when the last line was
17584 bidi-reordered and was killed immediately before this
17585 redisplay cycle. In that case, ROW->end stores the
17586 buffer position of the first visual-order character of
17587 the killed text, which is now beyond ZV. */
17588 && CHARPOS (row
->end
.pos
) <= ZV
)
17591 /* Stop if last visible row. */
17592 if (MATRIX_ROW_BOTTOM_Y (row
) >= yb
)
17600 /* Find the first glyph row in the current matrix of W that is not
17601 affected by changes at the end of current_buffer since the
17602 time W's current matrix was built.
17604 Return in *DELTA the number of chars by which buffer positions in
17605 unchanged text at the end of current_buffer must be adjusted.
17607 Return in *DELTA_BYTES the corresponding number of bytes.
17609 Value is null if no such row exists, i.e. all rows are affected by
17612 static struct glyph_row
*
17613 find_first_unchanged_at_end_row (struct window
*w
,
17614 ptrdiff_t *delta
, ptrdiff_t *delta_bytes
)
17616 struct glyph_row
*row
;
17617 struct glyph_row
*row_found
= NULL
;
17619 *delta
= *delta_bytes
= 0;
17621 /* Display must not have been paused, otherwise the current matrix
17622 is not up to date. */
17623 eassert (w
->window_end_valid
);
17625 /* A value of window_end_pos >= END_UNCHANGED means that the window
17626 end is in the range of changed text. If so, there is no
17627 unchanged row at the end of W's current matrix. */
17628 if (w
->window_end_pos
>= END_UNCHANGED
)
17631 /* Set row to the last row in W's current matrix displaying text. */
17632 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17634 /* If matrix is entirely empty, no unchanged row exists. */
17635 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17637 /* The value of row is the last glyph row in the matrix having a
17638 meaningful buffer position in it. The end position of row
17639 corresponds to window_end_pos. This allows us to translate
17640 buffer positions in the current matrix to current buffer
17641 positions for characters not in changed text. */
17643 MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17644 ptrdiff_t Z_BYTE_old
=
17645 MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17646 ptrdiff_t last_unchanged_pos
, last_unchanged_pos_old
;
17647 struct glyph_row
*first_text_row
17648 = MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
17650 *delta
= Z
- Z_old
;
17651 *delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17653 /* Set last_unchanged_pos to the buffer position of the last
17654 character in the buffer that has not been changed. Z is the
17655 index + 1 of the last character in current_buffer, i.e. by
17656 subtracting END_UNCHANGED we get the index of the last
17657 unchanged character, and we have to add BEG to get its buffer
17659 last_unchanged_pos
= Z
- END_UNCHANGED
+ BEG
;
17660 last_unchanged_pos_old
= last_unchanged_pos
- *delta
;
17662 /* Search backward from ROW for a row displaying a line that
17663 starts at a minimum position >= last_unchanged_pos_old. */
17664 for (; row
> first_text_row
; --row
)
17666 /* This used to abort, but it can happen.
17667 It is ok to just stop the search instead here. KFS. */
17668 if (!row
->enabled_p
|| !MATRIX_ROW_DISPLAYS_TEXT_P (row
))
17671 if (MATRIX_ROW_START_CHARPOS (row
) >= last_unchanged_pos_old
)
17676 eassert (!row_found
|| MATRIX_ROW_DISPLAYS_TEXT_P (row_found
));
17682 /* Make sure that glyph rows in the current matrix of window W
17683 reference the same glyph memory as corresponding rows in the
17684 frame's frame matrix. This function is called after scrolling W's
17685 current matrix on a terminal frame in try_window_id and
17686 try_window_reusing_current_matrix. */
17689 sync_frame_with_window_matrix_rows (struct window
*w
)
17691 struct frame
*f
= XFRAME (w
->frame
);
17692 struct glyph_row
*window_row
, *window_row_end
, *frame_row
;
17694 /* Preconditions: W must be a leaf window and full-width. Its frame
17695 must have a frame matrix. */
17696 eassert (BUFFERP (w
->contents
));
17697 eassert (WINDOW_FULL_WIDTH_P (w
));
17698 eassert (!FRAME_WINDOW_P (f
));
17700 /* If W is a full-width window, glyph pointers in W's current matrix
17701 have, by definition, to be the same as glyph pointers in the
17702 corresponding frame matrix. Note that frame matrices have no
17703 marginal areas (see build_frame_matrix). */
17704 window_row
= w
->current_matrix
->rows
;
17705 window_row_end
= window_row
+ w
->current_matrix
->nrows
;
17706 frame_row
= f
->current_matrix
->rows
+ WINDOW_TOP_EDGE_LINE (w
);
17707 while (window_row
< window_row_end
)
17709 struct glyph
*start
= window_row
->glyphs
[LEFT_MARGIN_AREA
];
17710 struct glyph
*end
= window_row
->glyphs
[LAST_AREA
];
17712 frame_row
->glyphs
[LEFT_MARGIN_AREA
] = start
;
17713 frame_row
->glyphs
[TEXT_AREA
] = start
;
17714 frame_row
->glyphs
[RIGHT_MARGIN_AREA
] = end
;
17715 frame_row
->glyphs
[LAST_AREA
] = end
;
17717 /* Disable frame rows whose corresponding window rows have
17718 been disabled in try_window_id. */
17719 if (!window_row
->enabled_p
)
17720 frame_row
->enabled_p
= false;
17722 ++window_row
, ++frame_row
;
17727 /* Find the glyph row in window W containing CHARPOS. Consider all
17728 rows between START and END (not inclusive). END null means search
17729 all rows to the end of the display area of W. Value is the row
17730 containing CHARPOS or null. */
17733 row_containing_pos (struct window
*w
, ptrdiff_t charpos
,
17734 struct glyph_row
*start
, struct glyph_row
*end
, int dy
)
17736 struct glyph_row
*row
= start
;
17737 struct glyph_row
*best_row
= NULL
;
17738 ptrdiff_t mindif
= BUF_ZV (XBUFFER (w
->contents
)) + 1;
17741 /* If we happen to start on a header-line, skip that. */
17742 if (row
->mode_line_p
)
17745 if ((end
&& row
>= end
) || !row
->enabled_p
)
17748 last_y
= window_text_bottom_y (w
) - dy
;
17752 /* Give up if we have gone too far. */
17753 if (end
&& row
>= end
)
17755 /* This formerly returned if they were equal.
17756 I think that both quantities are of a "last plus one" type;
17757 if so, when they are equal, the row is within the screen. -- rms. */
17758 if (MATRIX_ROW_BOTTOM_Y (row
) > last_y
)
17761 /* If it is in this row, return this row. */
17762 if (! (MATRIX_ROW_END_CHARPOS (row
) < charpos
17763 || (MATRIX_ROW_END_CHARPOS (row
) == charpos
17764 /* The end position of a row equals the start
17765 position of the next row. If CHARPOS is there, we
17766 would rather consider it displayed in the next
17767 line, except when this line ends in ZV. */
17768 && !row_for_charpos_p (row
, charpos
)))
17769 && charpos
>= MATRIX_ROW_START_CHARPOS (row
))
17773 if (NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17774 || (!best_row
&& !row
->continued_p
))
17776 /* In bidi-reordered rows, there could be several rows whose
17777 edges surround CHARPOS, all of these rows belonging to
17778 the same continued line. We need to find the row which
17779 fits CHARPOS the best. */
17780 for (g
= row
->glyphs
[TEXT_AREA
];
17781 g
< row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
17784 if (!STRINGP (g
->object
))
17786 if (g
->charpos
> 0 && eabs (g
->charpos
- charpos
) < mindif
)
17788 mindif
= eabs (g
->charpos
- charpos
);
17790 /* Exact match always wins. */
17797 else if (best_row
&& !row
->continued_p
)
17804 /* Try to redisplay window W by reusing its existing display. W's
17805 current matrix must be up to date when this function is called,
17806 i.e. window_end_valid must be nonzero.
17810 >= 1 if successful, i.e. display has been updated
17812 1 means the changes were in front of a newline that precedes
17813 the window start, and the whole current matrix was reused
17814 2 means the changes were after the last position displayed
17815 in the window, and the whole current matrix was reused
17816 3 means portions of the current matrix were reused, while
17817 some of the screen lines were redrawn
17818 -1 if redisplay with same window start is known not to succeed
17819 0 if otherwise unsuccessful
17821 The following steps are performed:
17823 1. Find the last row in the current matrix of W that is not
17824 affected by changes at the start of current_buffer. If no such row
17827 2. Find the first row in W's current matrix that is not affected by
17828 changes at the end of current_buffer. Maybe there is no such row.
17830 3. Display lines beginning with the row + 1 found in step 1 to the
17831 row found in step 2 or, if step 2 didn't find a row, to the end of
17834 4. If cursor is not known to appear on the window, give up.
17836 5. If display stopped at the row found in step 2, scroll the
17837 display and current matrix as needed.
17839 6. Maybe display some lines at the end of W, if we must. This can
17840 happen under various circumstances, like a partially visible line
17841 becoming fully visible, or because newly displayed lines are displayed
17842 in smaller font sizes.
17844 7. Update W's window end information. */
17847 try_window_id (struct window
*w
)
17849 struct frame
*f
= XFRAME (w
->frame
);
17850 struct glyph_matrix
*current_matrix
= w
->current_matrix
;
17851 struct glyph_matrix
*desired_matrix
= w
->desired_matrix
;
17852 struct glyph_row
*last_unchanged_at_beg_row
;
17853 struct glyph_row
*first_unchanged_at_end_row
;
17854 struct glyph_row
*row
;
17855 struct glyph_row
*bottom_row
;
17858 ptrdiff_t delta
= 0, delta_bytes
= 0, stop_pos
;
17860 struct text_pos start_pos
;
17862 int first_unchanged_at_end_vpos
= 0;
17863 struct glyph_row
*last_text_row
, *last_text_row_at_end
;
17864 struct text_pos start
;
17865 ptrdiff_t first_changed_charpos
, last_changed_charpos
;
17868 if (inhibit_try_window_id
)
17872 /* This is handy for debugging. */
17874 #define GIVE_UP(X) \
17876 fprintf (stderr, "try_window_id give up %d\n", (X)); \
17880 #define GIVE_UP(X) return 0
17883 SET_TEXT_POS_FROM_MARKER (start
, w
->start
);
17885 /* Don't use this for mini-windows because these can show
17886 messages and mini-buffers, and we don't handle that here. */
17887 if (MINI_WINDOW_P (w
))
17890 /* This flag is used to prevent redisplay optimizations. */
17891 if (windows_or_buffers_changed
|| f
->cursor_type_changed
)
17894 /* This function's optimizations cannot be used if overlays have
17895 changed in the buffer displayed by the window, so give up if they
17897 if (w
->last_overlay_modified
!= OVERLAY_MODIFF
)
17900 /* Verify that narrowing has not changed.
17901 Also verify that we were not told to prevent redisplay optimizations.
17902 It would be nice to further
17903 reduce the number of cases where this prevents try_window_id. */
17904 if (current_buffer
->clip_changed
17905 || current_buffer
->prevent_redisplay_optimizations_p
)
17908 /* Window must either use window-based redisplay or be full width. */
17909 if (!FRAME_WINDOW_P (f
)
17910 && (!FRAME_LINE_INS_DEL_OK (f
)
17911 || !WINDOW_FULL_WIDTH_P (w
)))
17914 /* Give up if point is known NOT to appear in W. */
17915 if (PT
< CHARPOS (start
))
17918 /* Another way to prevent redisplay optimizations. */
17919 if (w
->last_modified
== 0)
17922 /* Verify that window is not hscrolled. */
17923 if (w
->hscroll
!= 0)
17926 /* Verify that display wasn't paused. */
17927 if (!w
->window_end_valid
)
17930 /* Likewise if highlighting trailing whitespace. */
17931 if (!NILP (Vshow_trailing_whitespace
))
17934 /* Can't use this if overlay arrow position and/or string have
17936 if (overlay_arrows_changed_p ())
17939 /* When word-wrap is on, adding a space to the first word of a
17940 wrapped line can change the wrap position, altering the line
17941 above it. It might be worthwhile to handle this more
17942 intelligently, but for now just redisplay from scratch. */
17943 if (!NILP (BVAR (XBUFFER (w
->contents
), word_wrap
)))
17946 /* Under bidi reordering, adding or deleting a character in the
17947 beginning of a paragraph, before the first strong directional
17948 character, can change the base direction of the paragraph (unless
17949 the buffer specifies a fixed paragraph direction), which will
17950 require to redisplay the whole paragraph. It might be worthwhile
17951 to find the paragraph limits and widen the range of redisplayed
17952 lines to that, but for now just give up this optimization and
17953 redisplay from scratch. */
17954 if (!NILP (BVAR (XBUFFER (w
->contents
), bidi_display_reordering
))
17955 && NILP (BVAR (XBUFFER (w
->contents
), bidi_paragraph_direction
)))
17958 /* Make sure beg_unchanged and end_unchanged are up to date. Do it
17959 only if buffer has really changed. The reason is that the gap is
17960 initially at Z for freshly visited files. The code below would
17961 set end_unchanged to 0 in that case. */
17962 if (MODIFF
> SAVE_MODIFF
17963 /* This seems to happen sometimes after saving a buffer. */
17964 || BEG_UNCHANGED
+ END_UNCHANGED
> Z_BYTE
)
17966 if (GPT
- BEG
< BEG_UNCHANGED
)
17967 BEG_UNCHANGED
= GPT
- BEG
;
17968 if (Z
- GPT
< END_UNCHANGED
)
17969 END_UNCHANGED
= Z
- GPT
;
17972 /* The position of the first and last character that has been changed. */
17973 first_changed_charpos
= BEG
+ BEG_UNCHANGED
;
17974 last_changed_charpos
= Z
- END_UNCHANGED
;
17976 /* If window starts after a line end, and the last change is in
17977 front of that newline, then changes don't affect the display.
17978 This case happens with stealth-fontification. Note that although
17979 the display is unchanged, glyph positions in the matrix have to
17980 be adjusted, of course. */
17981 row
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
17982 if (MATRIX_ROW_DISPLAYS_TEXT_P (row
)
17983 && ((last_changed_charpos
< CHARPOS (start
)
17984 && CHARPOS (start
) == BEGV
)
17985 || (last_changed_charpos
< CHARPOS (start
) - 1
17986 && FETCH_BYTE (BYTEPOS (start
) - 1) == '\n')))
17988 ptrdiff_t Z_old
, Z_delta
, Z_BYTE_old
, Z_delta_bytes
;
17989 struct glyph_row
*r0
;
17991 /* Compute how many chars/bytes have been added to or removed
17992 from the buffer. */
17993 Z_old
= MATRIX_ROW_END_CHARPOS (row
) + w
->window_end_pos
;
17994 Z_BYTE_old
= MATRIX_ROW_END_BYTEPOS (row
) + w
->window_end_bytepos
;
17995 Z_delta
= Z
- Z_old
;
17996 Z_delta_bytes
= Z_BYTE
- Z_BYTE_old
;
17998 /* Give up if PT is not in the window. Note that it already has
17999 been checked at the start of try_window_id that PT is not in
18000 front of the window start. */
18001 if (PT
>= MATRIX_ROW_END_CHARPOS (row
) + Z_delta
)
18004 /* If window start is unchanged, we can reuse the whole matrix
18005 as is, after adjusting glyph positions. No need to compute
18006 the window end again, since its offset from Z hasn't changed. */
18007 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18008 if (CHARPOS (start
) == MATRIX_ROW_START_CHARPOS (r0
) + Z_delta
18009 && BYTEPOS (start
) == MATRIX_ROW_START_BYTEPOS (r0
) + Z_delta_bytes
18010 /* PT must not be in a partially visible line. */
18011 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
) + Z_delta
18012 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18014 /* Adjust positions in the glyph matrix. */
18015 if (Z_delta
|| Z_delta_bytes
)
18017 struct glyph_row
*r1
18018 = MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18019 increment_matrix_positions (w
->current_matrix
,
18020 MATRIX_ROW_VPOS (r0
, current_matrix
),
18021 MATRIX_ROW_VPOS (r1
, current_matrix
),
18022 Z_delta
, Z_delta_bytes
);
18025 /* Set the cursor. */
18026 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18028 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18033 /* Handle the case that changes are all below what is displayed in
18034 the window, and that PT is in the window. This shortcut cannot
18035 be taken if ZV is visible in the window, and text has been added
18036 there that is visible in the window. */
18037 if (first_changed_charpos
>= MATRIX_ROW_END_CHARPOS (row
)
18038 /* ZV is not visible in the window, or there are no
18039 changes at ZV, actually. */
18040 && (current_matrix
->zv
> MATRIX_ROW_END_CHARPOS (row
)
18041 || first_changed_charpos
== last_changed_charpos
))
18043 struct glyph_row
*r0
;
18045 /* Give up if PT is not in the window. Note that it already has
18046 been checked at the start of try_window_id that PT is not in
18047 front of the window start. */
18048 if (PT
>= MATRIX_ROW_END_CHARPOS (row
))
18051 /* If window start is unchanged, we can reuse the whole matrix
18052 as is, without changing glyph positions since no text has
18053 been added/removed in front of the window end. */
18054 r0
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18055 if (TEXT_POS_EQUAL_P (start
, r0
->minpos
)
18056 /* PT must not be in a partially visible line. */
18057 && !(PT
>= MATRIX_ROW_START_CHARPOS (row
)
18058 && MATRIX_ROW_BOTTOM_Y (row
) > window_text_bottom_y (w
)))
18060 /* We have to compute the window end anew since text
18061 could have been added/removed after it. */
18062 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18063 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18065 /* Set the cursor. */
18066 row
= row_containing_pos (w
, PT
, r0
, NULL
, 0);
18068 set_cursor_from_row (w
, row
, current_matrix
, 0, 0, 0, 0);
18073 /* Give up if window start is in the changed area.
18075 The condition used to read
18077 (BEG_UNCHANGED + END_UNCHANGED != Z - BEG && ...)
18079 but why that was tested escapes me at the moment. */
18080 if (CHARPOS (start
) >= first_changed_charpos
18081 && CHARPOS (start
) <= last_changed_charpos
)
18084 /* Check that window start agrees with the start of the first glyph
18085 row in its current matrix. Check this after we know the window
18086 start is not in changed text, otherwise positions would not be
18088 row
= MATRIX_FIRST_TEXT_ROW (current_matrix
);
18089 if (!TEXT_POS_EQUAL_P (start
, row
->minpos
))
18092 /* Give up if the window ends in strings. Overlay strings
18093 at the end are difficult to handle, so don't try. */
18094 row
= MATRIX_ROW (current_matrix
, w
->window_end_vpos
);
18095 if (MATRIX_ROW_START_CHARPOS (row
) == MATRIX_ROW_END_CHARPOS (row
))
18098 /* Compute the position at which we have to start displaying new
18099 lines. Some of the lines at the top of the window might be
18100 reusable because they are not displaying changed text. Find the
18101 last row in W's current matrix not affected by changes at the
18102 start of current_buffer. Value is null if changes start in the
18103 first line of window. */
18104 last_unchanged_at_beg_row
= find_last_unchanged_at_beg_row (w
);
18105 if (last_unchanged_at_beg_row
)
18107 /* Avoid starting to display in the middle of a character, a TAB
18108 for instance. This is easier than to set up the iterator
18109 exactly, and it's not a frequent case, so the additional
18110 effort wouldn't really pay off. */
18111 while ((MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
)
18112 || last_unchanged_at_beg_row
->ends_in_newline_from_string_p
)
18113 && last_unchanged_at_beg_row
> w
->current_matrix
->rows
)
18114 --last_unchanged_at_beg_row
;
18116 if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (last_unchanged_at_beg_row
))
18119 if (init_to_row_end (&it
, w
, last_unchanged_at_beg_row
) == 0)
18121 start_pos
= it
.current
.pos
;
18123 /* Start displaying new lines in the desired matrix at the same
18124 vpos we would use in the current matrix, i.e. below
18125 last_unchanged_at_beg_row. */
18126 it
.vpos
= 1 + MATRIX_ROW_VPOS (last_unchanged_at_beg_row
,
18128 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18129 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_unchanged_at_beg_row
);
18131 eassert (it
.hpos
== 0 && it
.current_x
== 0);
18135 /* There are no reusable lines at the start of the window.
18136 Start displaying in the first text line. */
18137 start_display (&it
, w
, start
);
18138 it
.vpos
= it
.first_vpos
;
18139 start_pos
= it
.current
.pos
;
18142 /* Find the first row that is not affected by changes at the end of
18143 the buffer. Value will be null if there is no unchanged row, in
18144 which case we must redisplay to the end of the window. delta
18145 will be set to the value by which buffer positions beginning with
18146 first_unchanged_at_end_row have to be adjusted due to text
18148 first_unchanged_at_end_row
18149 = find_first_unchanged_at_end_row (w
, &delta
, &delta_bytes
);
18150 IF_DEBUG (debug_delta
= delta
);
18151 IF_DEBUG (debug_delta_bytes
= delta_bytes
);
18153 /* Set stop_pos to the buffer position up to which we will have to
18154 display new lines. If first_unchanged_at_end_row != NULL, this
18155 is the buffer position of the start of the line displayed in that
18156 row. For first_unchanged_at_end_row == NULL, use 0 to indicate
18157 that we don't stop at a buffer position. */
18159 if (first_unchanged_at_end_row
)
18161 eassert (last_unchanged_at_beg_row
== NULL
18162 || first_unchanged_at_end_row
>= last_unchanged_at_beg_row
);
18164 /* If this is a continuation line, move forward to the next one
18165 that isn't. Changes in lines above affect this line.
18166 Caution: this may move first_unchanged_at_end_row to a row
18167 not displaying text. */
18168 while (MATRIX_ROW_CONTINUATION_LINE_P (first_unchanged_at_end_row
)
18169 && MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18170 && (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18171 < it
.last_visible_y
))
18172 ++first_unchanged_at_end_row
;
18174 if (!MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
)
18175 || (MATRIX_ROW_BOTTOM_Y (first_unchanged_at_end_row
)
18176 >= it
.last_visible_y
))
18177 first_unchanged_at_end_row
= NULL
;
18180 stop_pos
= (MATRIX_ROW_START_CHARPOS (first_unchanged_at_end_row
)
18182 first_unchanged_at_end_vpos
18183 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, current_matrix
);
18184 eassert (stop_pos
>= Z
- END_UNCHANGED
);
18187 else if (last_unchanged_at_beg_row
== NULL
)
18193 /* Either there is no unchanged row at the end, or the one we have
18194 now displays text. This is a necessary condition for the window
18195 end pos calculation at the end of this function. */
18196 eassert (first_unchanged_at_end_row
== NULL
18197 || MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18199 debug_last_unchanged_at_beg_vpos
18200 = (last_unchanged_at_beg_row
18201 ? MATRIX_ROW_VPOS (last_unchanged_at_beg_row
, current_matrix
)
18203 debug_first_unchanged_at_end_vpos
= first_unchanged_at_end_vpos
;
18205 #endif /* GLYPH_DEBUG */
18208 /* Display new lines. Set last_text_row to the last new line
18209 displayed which has text on it, i.e. might end up as being the
18210 line where the window_end_vpos is. */
18211 w
->cursor
.vpos
= -1;
18212 last_text_row
= NULL
;
18213 overlay_arrow_seen
= 0;
18214 if (it
.current_y
< it
.last_visible_y
18215 && !f
->fonts_changed
18216 && (first_unchanged_at_end_row
== NULL
18217 || IT_CHARPOS (it
) < stop_pos
))
18218 it
.glyph_row
->reversed_p
= false;
18219 while (it
.current_y
< it
.last_visible_y
18220 && !f
->fonts_changed
18221 && (first_unchanged_at_end_row
== NULL
18222 || IT_CHARPOS (it
) < stop_pos
))
18224 if (display_line (&it
))
18225 last_text_row
= it
.glyph_row
- 1;
18228 if (f
->fonts_changed
)
18232 /* Compute differences in buffer positions, y-positions etc. for
18233 lines reused at the bottom of the window. Compute what we can
18235 if (first_unchanged_at_end_row
18236 /* No lines reused because we displayed everything up to the
18237 bottom of the window. */
18238 && it
.current_y
< it
.last_visible_y
)
18241 - MATRIX_ROW_VPOS (first_unchanged_at_end_row
,
18243 dy
= it
.current_y
- first_unchanged_at_end_row
->y
;
18244 run
.current_y
= first_unchanged_at_end_row
->y
;
18245 run
.desired_y
= run
.current_y
+ dy
;
18246 run
.height
= it
.last_visible_y
- max (run
.current_y
, run
.desired_y
);
18250 delta
= delta_bytes
= dvpos
= dy
18251 = run
.current_y
= run
.desired_y
= run
.height
= 0;
18252 first_unchanged_at_end_row
= NULL
;
18254 IF_DEBUG ((debug_dvpos
= dvpos
, debug_dy
= dy
));
18257 /* Find the cursor if not already found. We have to decide whether
18258 PT will appear on this window (it sometimes doesn't, but this is
18259 not a very frequent case.) This decision has to be made before
18260 the current matrix is altered. A value of cursor.vpos < 0 means
18261 that PT is either in one of the lines beginning at
18262 first_unchanged_at_end_row or below the window. Don't care for
18263 lines that might be displayed later at the window end; as
18264 mentioned, this is not a frequent case. */
18265 if (w
->cursor
.vpos
< 0)
18267 /* Cursor in unchanged rows at the top? */
18268 if (PT
< CHARPOS (start_pos
)
18269 && last_unchanged_at_beg_row
)
18271 row
= row_containing_pos (w
, PT
,
18272 MATRIX_FIRST_TEXT_ROW (w
->current_matrix
),
18273 last_unchanged_at_beg_row
+ 1, 0);
18275 set_cursor_from_row (w
, row
, w
->current_matrix
, 0, 0, 0, 0);
18278 /* Start from first_unchanged_at_end_row looking for PT. */
18279 else if (first_unchanged_at_end_row
)
18281 row
= row_containing_pos (w
, PT
- delta
,
18282 first_unchanged_at_end_row
, NULL
, 0);
18284 set_cursor_from_row (w
, row
, w
->current_matrix
, delta
,
18285 delta_bytes
, dy
, dvpos
);
18288 /* Give up if cursor was not found. */
18289 if (w
->cursor
.vpos
< 0)
18291 clear_glyph_matrix (w
->desired_matrix
);
18296 /* Don't let the cursor end in the scroll margins. */
18298 int this_scroll_margin
, cursor_height
;
18299 int frame_line_height
= default_line_pixel_height (w
);
18300 int window_total_lines
18301 = WINDOW_TOTAL_LINES (w
) * FRAME_LINE_HEIGHT (it
.f
) / frame_line_height
;
18303 this_scroll_margin
=
18304 max (0, min (scroll_margin
, window_total_lines
/ 4));
18305 this_scroll_margin
*= frame_line_height
;
18306 cursor_height
= MATRIX_ROW (w
->desired_matrix
, w
->cursor
.vpos
)->height
;
18308 if ((w
->cursor
.y
< this_scroll_margin
18309 && CHARPOS (start
) > BEGV
)
18310 /* Old redisplay didn't take scroll margin into account at the bottom,
18311 but then global-hl-line-mode doesn't scroll. KFS 2004-06-14 */
18312 || (w
->cursor
.y
+ (make_cursor_line_fully_visible_p
18313 ? cursor_height
+ this_scroll_margin
18314 : 1)) > it
.last_visible_y
)
18316 w
->cursor
.vpos
= -1;
18317 clear_glyph_matrix (w
->desired_matrix
);
18322 /* Scroll the display. Do it before changing the current matrix so
18323 that xterm.c doesn't get confused about where the cursor glyph is
18325 if (dy
&& run
.height
)
18329 if (FRAME_WINDOW_P (f
))
18331 FRAME_RIF (f
)->update_window_begin_hook (w
);
18332 FRAME_RIF (f
)->clear_window_mouse_face (w
);
18333 FRAME_RIF (f
)->scroll_run_hook (w
, &run
);
18334 FRAME_RIF (f
)->update_window_end_hook (w
, 0, 0);
18338 /* Terminal frame. In this case, dvpos gives the number of
18339 lines to scroll by; dvpos < 0 means scroll up. */
18341 = MATRIX_ROW_VPOS (first_unchanged_at_end_row
, w
->current_matrix
);
18342 int from
= WINDOW_TOP_EDGE_LINE (w
) + from_vpos
;
18343 int end
= (WINDOW_TOP_EDGE_LINE (w
)
18344 + (WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0)
18345 + window_internal_height (w
));
18347 #if defined (HAVE_GPM) || defined (MSDOS)
18348 x_clear_window_mouse_face (w
);
18350 /* Perform the operation on the screen. */
18353 /* Scroll last_unchanged_at_beg_row to the end of the
18354 window down dvpos lines. */
18355 set_terminal_window (f
, end
);
18357 /* On dumb terminals delete dvpos lines at the end
18358 before inserting dvpos empty lines. */
18359 if (!FRAME_SCROLL_REGION_OK (f
))
18360 ins_del_lines (f
, end
- dvpos
, -dvpos
);
18362 /* Insert dvpos empty lines in front of
18363 last_unchanged_at_beg_row. */
18364 ins_del_lines (f
, from
, dvpos
);
18366 else if (dvpos
< 0)
18368 /* Scroll up last_unchanged_at_beg_vpos to the end of
18369 the window to last_unchanged_at_beg_vpos - |dvpos|. */
18370 set_terminal_window (f
, end
);
18372 /* Delete dvpos lines in front of
18373 last_unchanged_at_beg_vpos. ins_del_lines will set
18374 the cursor to the given vpos and emit |dvpos| delete
18376 ins_del_lines (f
, from
+ dvpos
, dvpos
);
18378 /* On a dumb terminal insert dvpos empty lines at the
18380 if (!FRAME_SCROLL_REGION_OK (f
))
18381 ins_del_lines (f
, end
+ dvpos
, -dvpos
);
18384 set_terminal_window (f
, 0);
18390 /* Shift reused rows of the current matrix to the right position.
18391 BOTTOM_ROW is the last + 1 row in the current matrix reserved for
18393 bottom_row
= MATRIX_BOTTOM_TEXT_ROW (current_matrix
, w
);
18394 bottom_vpos
= MATRIX_ROW_VPOS (bottom_row
, current_matrix
);
18397 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
+ dvpos
,
18398 bottom_vpos
, dvpos
);
18399 clear_glyph_matrix_rows (current_matrix
, bottom_vpos
+ dvpos
,
18402 else if (dvpos
> 0)
18404 rotate_matrix (current_matrix
, first_unchanged_at_end_vpos
,
18405 bottom_vpos
, dvpos
);
18406 clear_glyph_matrix_rows (current_matrix
, first_unchanged_at_end_vpos
,
18407 first_unchanged_at_end_vpos
+ dvpos
);
18410 /* For frame-based redisplay, make sure that current frame and window
18411 matrix are in sync with respect to glyph memory. */
18412 if (!FRAME_WINDOW_P (f
))
18413 sync_frame_with_window_matrix_rows (w
);
18415 /* Adjust buffer positions in reused rows. */
18416 if (delta
|| delta_bytes
)
18417 increment_matrix_positions (current_matrix
,
18418 first_unchanged_at_end_vpos
+ dvpos
,
18419 bottom_vpos
, delta
, delta_bytes
);
18421 /* Adjust Y positions. */
18423 shift_glyph_matrix (w
, current_matrix
,
18424 first_unchanged_at_end_vpos
+ dvpos
,
18427 if (first_unchanged_at_end_row
)
18429 first_unchanged_at_end_row
+= dvpos
;
18430 if (first_unchanged_at_end_row
->y
>= it
.last_visible_y
18431 || !MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
))
18432 first_unchanged_at_end_row
= NULL
;
18435 /* If scrolling up, there may be some lines to display at the end of
18437 last_text_row_at_end
= NULL
;
18440 /* Scrolling up can leave for example a partially visible line
18441 at the end of the window to be redisplayed. */
18442 /* Set last_row to the glyph row in the current matrix where the
18443 window end line is found. It has been moved up or down in
18444 the matrix by dvpos. */
18445 int last_vpos
= w
->window_end_vpos
+ dvpos
;
18446 struct glyph_row
*last_row
= MATRIX_ROW (current_matrix
, last_vpos
);
18448 /* If last_row is the window end line, it should display text. */
18449 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (last_row
));
18451 /* If window end line was partially visible before, begin
18452 displaying at that line. Otherwise begin displaying with the
18453 line following it. */
18454 if (MATRIX_ROW_BOTTOM_Y (last_row
) - dy
>= it
.last_visible_y
)
18456 init_to_row_start (&it
, w
, last_row
);
18457 it
.vpos
= last_vpos
;
18458 it
.current_y
= last_row
->y
;
18462 init_to_row_end (&it
, w
, last_row
);
18463 it
.vpos
= 1 + last_vpos
;
18464 it
.current_y
= MATRIX_ROW_BOTTOM_Y (last_row
);
18468 /* We may start in a continuation line. If so, we have to
18469 get the right continuation_lines_width and current_x. */
18470 it
.continuation_lines_width
= last_row
->continuation_lines_width
;
18471 it
.hpos
= it
.current_x
= 0;
18473 /* Display the rest of the lines at the window end. */
18474 it
.glyph_row
= MATRIX_ROW (desired_matrix
, it
.vpos
);
18475 while (it
.current_y
< it
.last_visible_y
&& !f
->fonts_changed
)
18477 /* Is it always sure that the display agrees with lines in
18478 the current matrix? I don't think so, so we mark rows
18479 displayed invalid in the current matrix by setting their
18480 enabled_p flag to zero. */
18481 SET_MATRIX_ROW_ENABLED_P (w
->current_matrix
, it
.vpos
, false);
18482 if (display_line (&it
))
18483 last_text_row_at_end
= it
.glyph_row
- 1;
18487 /* Update window_end_pos and window_end_vpos. */
18488 if (first_unchanged_at_end_row
&& !last_text_row_at_end
)
18490 /* Window end line if one of the preserved rows from the current
18491 matrix. Set row to the last row displaying text in current
18492 matrix starting at first_unchanged_at_end_row, after
18494 eassert (MATRIX_ROW_DISPLAYS_TEXT_P (first_unchanged_at_end_row
));
18495 row
= find_last_row_displaying_text (w
->current_matrix
, &it
,
18496 first_unchanged_at_end_row
);
18497 eassert (row
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
));
18498 adjust_window_ends (w
, row
, 1);
18499 eassert (w
->window_end_bytepos
>= 0);
18500 IF_DEBUG (debug_method_add (w
, "A"));
18502 else if (last_text_row_at_end
)
18504 adjust_window_ends (w
, last_text_row_at_end
, 0);
18505 eassert (w
->window_end_bytepos
>= 0);
18506 IF_DEBUG (debug_method_add (w
, "B"));
18508 else if (last_text_row
)
18510 /* We have displayed either to the end of the window or at the
18511 end of the window, i.e. the last row with text is to be found
18512 in the desired matrix. */
18513 adjust_window_ends (w
, last_text_row
, 0);
18514 eassert (w
->window_end_bytepos
>= 0);
18516 else if (first_unchanged_at_end_row
== NULL
18517 && last_text_row
== NULL
18518 && last_text_row_at_end
== NULL
)
18520 /* Displayed to end of window, but no line containing text was
18521 displayed. Lines were deleted at the end of the window. */
18522 int first_vpos
= WINDOW_WANTS_HEADER_LINE_P (w
) ? 1 : 0;
18523 int vpos
= w
->window_end_vpos
;
18524 struct glyph_row
*current_row
= current_matrix
->rows
+ vpos
;
18525 struct glyph_row
*desired_row
= desired_matrix
->rows
+ vpos
;
18528 row
== NULL
&& vpos
>= first_vpos
;
18529 --vpos
, --current_row
, --desired_row
)
18531 if (desired_row
->enabled_p
)
18533 if (MATRIX_ROW_DISPLAYS_TEXT_P (desired_row
))
18536 else if (MATRIX_ROW_DISPLAYS_TEXT_P (current_row
))
18540 eassert (row
!= NULL
);
18541 w
->window_end_vpos
= vpos
+ 1;
18542 w
->window_end_pos
= Z
- MATRIX_ROW_END_CHARPOS (row
);
18543 w
->window_end_bytepos
= Z_BYTE
- MATRIX_ROW_END_BYTEPOS (row
);
18544 eassert (w
->window_end_bytepos
>= 0);
18545 IF_DEBUG (debug_method_add (w
, "C"));
18550 IF_DEBUG ((debug_end_pos
= w
->window_end_pos
,
18551 debug_end_vpos
= w
->window_end_vpos
));
18553 /* Record that display has not been completed. */
18554 w
->window_end_valid
= 0;
18555 w
->desired_matrix
->no_scrolling_p
= 1;
18563 /***********************************************************************
18564 More debugging support
18565 ***********************************************************************/
18569 void dump_glyph_row (struct glyph_row
*, int, int) EXTERNALLY_VISIBLE
;
18570 void dump_glyph_matrix (struct glyph_matrix
*, int) EXTERNALLY_VISIBLE
;
18571 void dump_glyph (struct glyph_row
*, struct glyph
*, int) EXTERNALLY_VISIBLE
;
18574 /* Dump the contents of glyph matrix MATRIX on stderr.
18576 GLYPHS 0 means don't show glyph contents.
18577 GLYPHS 1 means show glyphs in short form
18578 GLYPHS > 1 means show glyphs in long form. */
18581 dump_glyph_matrix (struct glyph_matrix
*matrix
, int glyphs
)
18584 for (i
= 0; i
< matrix
->nrows
; ++i
)
18585 dump_glyph_row (MATRIX_ROW (matrix
, i
), i
, glyphs
);
18589 /* Dump contents of glyph GLYPH to stderr. ROW and AREA are
18590 the glyph row and area where the glyph comes from. */
18593 dump_glyph (struct glyph_row
*row
, struct glyph
*glyph
, int area
)
18595 if (glyph
->type
== CHAR_GLYPH
18596 || glyph
->type
== GLYPHLESS_GLYPH
)
18599 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18600 glyph
- row
->glyphs
[TEXT_AREA
],
18601 (glyph
->type
== CHAR_GLYPH
18605 (BUFFERP (glyph
->object
)
18607 : (STRINGP (glyph
->object
)
18609 : (INTEGERP (glyph
->object
)
18612 glyph
->pixel_width
,
18614 (glyph
->u
.ch
< 0x80 && glyph
->u
.ch
>= ' '
18618 glyph
->left_box_line_p
,
18619 glyph
->right_box_line_p
);
18621 else if (glyph
->type
== STRETCH_GLYPH
)
18624 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18625 glyph
- row
->glyphs
[TEXT_AREA
],
18628 (BUFFERP (glyph
->object
)
18630 : (STRINGP (glyph
->object
)
18632 : (INTEGERP (glyph
->object
)
18635 glyph
->pixel_width
,
18639 glyph
->left_box_line_p
,
18640 glyph
->right_box_line_p
);
18642 else if (glyph
->type
== IMAGE_GLYPH
)
18645 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x %c %4d %1.1d%1.1d\n",
18646 glyph
- row
->glyphs
[TEXT_AREA
],
18649 (BUFFERP (glyph
->object
)
18651 : (STRINGP (glyph
->object
)
18653 : (INTEGERP (glyph
->object
)
18656 glyph
->pixel_width
,
18660 glyph
->left_box_line_p
,
18661 glyph
->right_box_line_p
);
18663 else if (glyph
->type
== COMPOSITE_GLYPH
)
18666 " %5"pD
"d %c %9"pI
"d %c %3d 0x%06x",
18667 glyph
- row
->glyphs
[TEXT_AREA
],
18670 (BUFFERP (glyph
->object
)
18672 : (STRINGP (glyph
->object
)
18674 : (INTEGERP (glyph
->object
)
18677 glyph
->pixel_width
,
18679 if (glyph
->u
.cmp
.automatic
)
18682 glyph
->slice
.cmp
.from
, glyph
->slice
.cmp
.to
);
18683 fprintf (stderr
, " . %4d %1.1d%1.1d\n",
18685 glyph
->left_box_line_p
,
18686 glyph
->right_box_line_p
);
18691 /* Dump the contents of glyph row at VPOS in MATRIX to stderr.
18692 GLYPHS 0 means don't show glyph contents.
18693 GLYPHS 1 means show glyphs in short form
18694 GLYPHS > 1 means show glyphs in long form. */
18697 dump_glyph_row (struct glyph_row
*row
, int vpos
, int glyphs
)
18701 fprintf (stderr
, "Row Start End Used oE><\\CTZFesm X Y W H V A P\n");
18702 fprintf (stderr
, "==============================================================================\n");
18704 fprintf (stderr
, "%3d %9"pI
"d %9"pI
"d %4d %1.1d%1.1d%1.1d%1.1d\
18705 %1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d%1.1d %4d %4d %4d %4d %4d %4d %4d\n",
18707 MATRIX_ROW_START_CHARPOS (row
),
18708 MATRIX_ROW_END_CHARPOS (row
),
18709 row
->used
[TEXT_AREA
],
18710 row
->contains_overlapping_glyphs_p
,
18712 row
->truncated_on_left_p
,
18713 row
->truncated_on_right_p
,
18715 MATRIX_ROW_CONTINUATION_LINE_P (row
),
18716 MATRIX_ROW_DISPLAYS_TEXT_P (row
),
18719 row
->ends_in_middle_of_char_p
,
18720 row
->starts_in_middle_of_char_p
,
18726 row
->visible_height
,
18729 /* The next 3 lines should align to "Start" in the header. */
18730 fprintf (stderr
, " %9"pD
"d %9"pD
"d\t%5d\n", row
->start
.overlay_string_index
,
18731 row
->end
.overlay_string_index
,
18732 row
->continuation_lines_width
);
18733 fprintf (stderr
, " %9"pI
"d %9"pI
"d\n",
18734 CHARPOS (row
->start
.string_pos
),
18735 CHARPOS (row
->end
.string_pos
));
18736 fprintf (stderr
, " %9d %9d\n", row
->start
.dpvec_index
,
18737 row
->end
.dpvec_index
);
18744 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18746 struct glyph
*glyph
= row
->glyphs
[area
];
18747 struct glyph
*glyph_end
= glyph
+ row
->used
[area
];
18749 /* Glyph for a line end in text. */
18750 if (area
== TEXT_AREA
&& glyph
== glyph_end
&& glyph
->charpos
> 0)
18753 if (glyph
< glyph_end
)
18754 fprintf (stderr
, " Glyph# Type Pos O W Code C Face LR\n");
18756 for (; glyph
< glyph_end
; ++glyph
)
18757 dump_glyph (row
, glyph
, area
);
18760 else if (glyphs
== 1)
18763 char s
[SHRT_MAX
+ 4];
18765 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
18769 for (i
= 0; i
< row
->used
[area
]; ++i
)
18771 struct glyph
*glyph
= row
->glyphs
[area
] + i
;
18772 if (i
== row
->used
[area
] - 1
18773 && area
== TEXT_AREA
18774 && INTEGERP (glyph
->object
)
18775 && glyph
->type
== CHAR_GLYPH
18776 && glyph
->u
.ch
== ' ')
18778 strcpy (&s
[i
], "[\\n]");
18781 else if (glyph
->type
== CHAR_GLYPH
18782 && glyph
->u
.ch
< 0x80
18783 && glyph
->u
.ch
>= ' ')
18784 s
[i
] = glyph
->u
.ch
;
18790 fprintf (stderr
, "%3d: (%d) '%s'\n", vpos
, row
->enabled_p
, s
);
18796 DEFUN ("dump-glyph-matrix", Fdump_glyph_matrix
,
18797 Sdump_glyph_matrix
, 0, 1, "p",
18798 doc
: /* Dump the current matrix of the selected window to stderr.
18799 Shows contents of glyph row structures. With non-nil
18800 parameter GLYPHS, dump glyphs as well. If GLYPHS is 1 show
18801 glyphs in short form, otherwise show glyphs in long form. */)
18802 (Lisp_Object glyphs
)
18804 struct window
*w
= XWINDOW (selected_window
);
18805 struct buffer
*buffer
= XBUFFER (w
->contents
);
18807 fprintf (stderr
, "PT = %"pI
"d, BEGV = %"pI
"d. ZV = %"pI
"d\n",
18808 BUF_PT (buffer
), BUF_BEGV (buffer
), BUF_ZV (buffer
));
18809 fprintf (stderr
, "Cursor x = %d, y = %d, hpos = %d, vpos = %d\n",
18810 w
->cursor
.x
, w
->cursor
.y
, w
->cursor
.hpos
, w
->cursor
.vpos
);
18811 fprintf (stderr
, "=============================================\n");
18812 dump_glyph_matrix (w
->current_matrix
,
18813 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 0);
18818 DEFUN ("dump-frame-glyph-matrix", Fdump_frame_glyph_matrix
,
18819 Sdump_frame_glyph_matrix
, 0, 0, "", doc
: /* */)
18822 struct frame
*f
= XFRAME (selected_frame
);
18823 dump_glyph_matrix (f
->current_matrix
, 1);
18828 DEFUN ("dump-glyph-row", Fdump_glyph_row
, Sdump_glyph_row
, 1, 2, "",
18829 doc
: /* Dump glyph row ROW to stderr.
18830 GLYPH 0 means don't dump glyphs.
18831 GLYPH 1 means dump glyphs in short form.
18832 GLYPH > 1 or omitted means dump glyphs in long form. */)
18833 (Lisp_Object row
, Lisp_Object glyphs
)
18835 struct glyph_matrix
*matrix
;
18838 CHECK_NUMBER (row
);
18839 matrix
= XWINDOW (selected_window
)->current_matrix
;
18841 if (vpos
>= 0 && vpos
< matrix
->nrows
)
18842 dump_glyph_row (MATRIX_ROW (matrix
, vpos
),
18844 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18849 DEFUN ("dump-tool-bar-row", Fdump_tool_bar_row
, Sdump_tool_bar_row
, 1, 2, "",
18850 doc
: /* Dump glyph row ROW of the tool-bar of the current frame to stderr.
18851 GLYPH 0 means don't dump glyphs.
18852 GLYPH 1 means dump glyphs in short form.
18853 GLYPH > 1 or omitted means dump glyphs in long form.
18855 If there's no tool-bar, or if the tool-bar is not drawn by Emacs,
18857 (Lisp_Object row
, Lisp_Object glyphs
)
18859 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
18860 struct frame
*sf
= SELECTED_FRAME ();
18861 struct glyph_matrix
*m
= XWINDOW (sf
->tool_bar_window
)->current_matrix
;
18864 CHECK_NUMBER (row
);
18866 if (vpos
>= 0 && vpos
< m
->nrows
)
18867 dump_glyph_row (MATRIX_ROW (m
, vpos
), vpos
,
18868 TYPE_RANGED_INTEGERP (int, glyphs
) ? XINT (glyphs
) : 2);
18874 DEFUN ("trace-redisplay", Ftrace_redisplay
, Strace_redisplay
, 0, 1, "P",
18875 doc
: /* Toggle tracing of redisplay.
18876 With ARG, turn tracing on if and only if ARG is positive. */)
18880 trace_redisplay_p
= !trace_redisplay_p
;
18883 arg
= Fprefix_numeric_value (arg
);
18884 trace_redisplay_p
= XINT (arg
) > 0;
18891 DEFUN ("trace-to-stderr", Ftrace_to_stderr
, Strace_to_stderr
, 1, MANY
, "",
18892 doc
: /* Like `format', but print result to stderr.
18893 usage: (trace-to-stderr STRING &rest OBJECTS) */)
18894 (ptrdiff_t nargs
, Lisp_Object
*args
)
18896 Lisp_Object s
= Fformat (nargs
, args
);
18897 fprintf (stderr
, "%s", SDATA (s
));
18901 #endif /* GLYPH_DEBUG */
18905 /***********************************************************************
18906 Building Desired Matrix Rows
18907 ***********************************************************************/
18909 /* Return a temporary glyph row holding the glyphs of an overlay arrow.
18910 Used for non-window-redisplay windows, and for windows w/o left fringe. */
18912 static struct glyph_row
*
18913 get_overlay_arrow_glyph_row (struct window
*w
, Lisp_Object overlay_arrow_string
)
18915 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
18916 struct buffer
*buffer
= XBUFFER (w
->contents
);
18917 struct buffer
*old
= current_buffer
;
18918 const unsigned char *arrow_string
= SDATA (overlay_arrow_string
);
18919 ptrdiff_t arrow_len
= SCHARS (overlay_arrow_string
);
18920 const unsigned char *arrow_end
= arrow_string
+ arrow_len
;
18921 const unsigned char *p
;
18924 int n_glyphs_before
;
18926 set_buffer_temp (buffer
);
18927 init_iterator (&it
, w
, -1, -1, &scratch_glyph_row
, DEFAULT_FACE_ID
);
18928 scratch_glyph_row
.reversed_p
= false;
18929 it
.glyph_row
->used
[TEXT_AREA
] = 0;
18930 SET_TEXT_POS (it
.position
, 0, 0);
18932 multibyte_p
= !NILP (BVAR (buffer
, enable_multibyte_characters
));
18934 while (p
< arrow_end
)
18936 Lisp_Object face
, ilisp
;
18938 /* Get the next character. */
18940 it
.c
= it
.char_to_display
= string_char_and_length (p
, &it
.len
);
18943 it
.c
= it
.char_to_display
= *p
, it
.len
= 1;
18944 if (! ASCII_CHAR_P (it
.c
))
18945 it
.char_to_display
= BYTE8_TO_CHAR (it
.c
);
18949 /* Get its face. */
18950 ilisp
= make_number (p
- arrow_string
);
18951 face
= Fget_text_property (ilisp
, Qface
, overlay_arrow_string
);
18952 it
.face_id
= compute_char_face (f
, it
.char_to_display
, face
);
18954 /* Compute its width, get its glyphs. */
18955 n_glyphs_before
= it
.glyph_row
->used
[TEXT_AREA
];
18956 SET_TEXT_POS (it
.position
, -1, -1);
18957 PRODUCE_GLYPHS (&it
);
18959 /* If this character doesn't fit any more in the line, we have
18960 to remove some glyphs. */
18961 if (it
.current_x
> it
.last_visible_x
)
18963 it
.glyph_row
->used
[TEXT_AREA
] = n_glyphs_before
;
18968 set_buffer_temp (old
);
18969 return it
.glyph_row
;
18973 /* Insert truncation glyphs at the start of IT->glyph_row. Which
18974 glyphs to insert is determined by produce_special_glyphs. */
18977 insert_left_trunc_glyphs (struct it
*it
)
18979 struct it truncate_it
;
18980 struct glyph
*from
, *end
, *to
, *toend
;
18982 eassert (!FRAME_WINDOW_P (it
->f
)
18983 || (!it
->glyph_row
->reversed_p
18984 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
18985 || (it
->glyph_row
->reversed_p
18986 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0));
18988 /* Get the truncation glyphs. */
18990 truncate_it
.current_x
= 0;
18991 truncate_it
.face_id
= DEFAULT_FACE_ID
;
18992 truncate_it
.glyph_row
= &scratch_glyph_row
;
18993 truncate_it
.area
= TEXT_AREA
;
18994 truncate_it
.glyph_row
->used
[TEXT_AREA
] = 0;
18995 CHARPOS (truncate_it
.position
) = BYTEPOS (truncate_it
.position
) = -1;
18996 truncate_it
.object
= make_number (0);
18997 produce_special_glyphs (&truncate_it
, IT_TRUNCATION
);
18999 /* Overwrite glyphs from IT with truncation glyphs. */
19000 if (!it
->glyph_row
->reversed_p
)
19002 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19004 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19005 end
= from
+ tused
;
19006 to
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19007 toend
= to
+ it
->glyph_row
->used
[TEXT_AREA
];
19008 if (FRAME_WINDOW_P (it
->f
))
19010 /* On GUI frames, when variable-size fonts are displayed,
19011 the truncation glyphs may need more pixels than the row's
19012 glyphs they overwrite. We overwrite more glyphs to free
19013 enough screen real estate, and enlarge the stretch glyph
19014 on the right (see display_line), if there is one, to
19015 preserve the screen position of the truncation glyphs on
19018 struct glyph
*g
= to
;
19021 /* The first glyph could be partially visible, in which case
19022 it->glyph_row->x will be negative. But we want the left
19023 truncation glyphs to be aligned at the left margin of the
19024 window, so we override the x coordinate at which the row
19026 it
->glyph_row
->x
= 0;
19027 while (g
< toend
&& w
< it
->truncation_pixel_width
)
19029 w
+= g
->pixel_width
;
19032 if (g
- to
- tused
> 0)
19034 memmove (to
+ tused
, g
, (toend
- g
) * sizeof(*g
));
19035 it
->glyph_row
->used
[TEXT_AREA
] -= g
- to
- tused
;
19037 used
= it
->glyph_row
->used
[TEXT_AREA
];
19038 if (it
->glyph_row
->truncated_on_right_p
19039 && WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0
19040 && it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].type
19043 int extra
= w
- it
->truncation_pixel_width
;
19045 it
->glyph_row
->glyphs
[TEXT_AREA
][used
- 2].pixel_width
+= extra
;
19052 /* There may be padding glyphs left over. Overwrite them too. */
19053 if (!FRAME_WINDOW_P (it
->f
))
19055 while (to
< toend
&& CHAR_GLYPH_PADDING_P (*to
))
19057 from
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19064 it
->glyph_row
->used
[TEXT_AREA
] = to
- it
->glyph_row
->glyphs
[TEXT_AREA
];
19068 short tused
= truncate_it
.glyph_row
->used
[TEXT_AREA
];
19070 /* In R2L rows, overwrite the last (rightmost) glyphs, and do
19071 that back to front. */
19072 end
= truncate_it
.glyph_row
->glyphs
[TEXT_AREA
];
19073 from
= end
+ truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19074 toend
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19075 to
= toend
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19076 if (FRAME_WINDOW_P (it
->f
))
19079 struct glyph
*g
= to
;
19081 while (g
>= toend
&& w
< it
->truncation_pixel_width
)
19083 w
+= g
->pixel_width
;
19086 if (to
- g
- tused
> 0)
19088 if (it
->glyph_row
->truncated_on_right_p
19089 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0
19090 && it
->glyph_row
->glyphs
[TEXT_AREA
][1].type
== STRETCH_GLYPH
)
19092 int extra
= w
- it
->truncation_pixel_width
;
19094 it
->glyph_row
->glyphs
[TEXT_AREA
][1].pixel_width
+= extra
;
19098 while (from
>= end
&& to
>= toend
)
19100 if (!FRAME_WINDOW_P (it
->f
))
19102 while (to
>= toend
&& CHAR_GLYPH_PADDING_P (*to
))
19105 truncate_it
.glyph_row
->glyphs
[TEXT_AREA
]
19106 + truncate_it
.glyph_row
->used
[TEXT_AREA
] - 1;
19107 while (from
>= end
&& to
>= toend
)
19113 /* Need to free some room before prepending additional
19115 int move_by
= from
- end
+ 1;
19116 struct glyph
*g0
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19117 struct glyph
*g
= g0
+ it
->glyph_row
->used
[TEXT_AREA
] - 1;
19119 for ( ; g
>= g0
; g
--)
19121 while (from
>= end
)
19123 it
->glyph_row
->used
[TEXT_AREA
] += move_by
;
19128 /* Compute the hash code for ROW. */
19130 row_hash (struct glyph_row
*row
)
19133 unsigned hashval
= 0;
19135 for (area
= LEFT_MARGIN_AREA
; area
< LAST_AREA
; ++area
)
19136 for (k
= 0; k
< row
->used
[area
]; ++k
)
19137 hashval
= ((((hashval
<< 4) + (hashval
>> 24)) & 0x0fffffff)
19138 + row
->glyphs
[area
][k
].u
.val
19139 + row
->glyphs
[area
][k
].face_id
19140 + row
->glyphs
[area
][k
].padding_p
19141 + (row
->glyphs
[area
][k
].type
<< 2));
19146 /* Compute the pixel height and width of IT->glyph_row.
19148 Most of the time, ascent and height of a display line will be equal
19149 to the max_ascent and max_height values of the display iterator
19150 structure. This is not the case if
19152 1. We hit ZV without displaying anything. In this case, max_ascent
19153 and max_height will be zero.
19155 2. We have some glyphs that don't contribute to the line height.
19156 (The glyph row flag contributes_to_line_height_p is for future
19157 pixmap extensions).
19159 The first case is easily covered by using default values because in
19160 these cases, the line height does not really matter, except that it
19161 must not be zero. */
19164 compute_line_metrics (struct it
*it
)
19166 struct glyph_row
*row
= it
->glyph_row
;
19168 if (FRAME_WINDOW_P (it
->f
))
19170 int i
, min_y
, max_y
;
19172 /* The line may consist of one space only, that was added to
19173 place the cursor on it. If so, the row's height hasn't been
19175 if (row
->height
== 0)
19177 if (it
->max_ascent
+ it
->max_descent
== 0)
19178 it
->max_descent
= it
->max_phys_descent
= FRAME_LINE_HEIGHT (it
->f
);
19179 row
->ascent
= it
->max_ascent
;
19180 row
->height
= it
->max_ascent
+ it
->max_descent
;
19181 row
->phys_ascent
= it
->max_phys_ascent
;
19182 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
19183 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
19186 /* Compute the width of this line. */
19187 row
->pixel_width
= row
->x
;
19188 for (i
= 0; i
< row
->used
[TEXT_AREA
]; ++i
)
19189 row
->pixel_width
+= row
->glyphs
[TEXT_AREA
][i
].pixel_width
;
19191 eassert (row
->pixel_width
>= 0);
19192 eassert (row
->ascent
>= 0 && row
->height
> 0);
19194 row
->overlapping_p
= (MATRIX_ROW_OVERLAPS_SUCC_P (row
)
19195 || MATRIX_ROW_OVERLAPS_PRED_P (row
));
19197 /* If first line's physical ascent is larger than its logical
19198 ascent, use the physical ascent, and make the row taller.
19199 This makes accented characters fully visible. */
19200 if (row
== MATRIX_FIRST_TEXT_ROW (it
->w
->desired_matrix
)
19201 && row
->phys_ascent
> row
->ascent
)
19203 row
->height
+= row
->phys_ascent
- row
->ascent
;
19204 row
->ascent
= row
->phys_ascent
;
19207 /* Compute how much of the line is visible. */
19208 row
->visible_height
= row
->height
;
19210 min_y
= WINDOW_HEADER_LINE_HEIGHT (it
->w
);
19211 max_y
= WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
);
19213 if (row
->y
< min_y
)
19214 row
->visible_height
-= min_y
- row
->y
;
19215 if (row
->y
+ row
->height
> max_y
)
19216 row
->visible_height
-= row
->y
+ row
->height
- max_y
;
19220 row
->pixel_width
= row
->used
[TEXT_AREA
];
19221 if (row
->continued_p
)
19222 row
->pixel_width
-= it
->continuation_pixel_width
;
19223 else if (row
->truncated_on_right_p
)
19224 row
->pixel_width
-= it
->truncation_pixel_width
;
19225 row
->ascent
= row
->phys_ascent
= 0;
19226 row
->height
= row
->phys_height
= row
->visible_height
= 1;
19227 row
->extra_line_spacing
= 0;
19230 /* Compute a hash code for this row. */
19231 row
->hash
= row_hash (row
);
19233 it
->max_ascent
= it
->max_descent
= 0;
19234 it
->max_phys_ascent
= it
->max_phys_descent
= 0;
19238 /* Append one space to the glyph row of iterator IT if doing a
19239 window-based redisplay. The space has the same face as
19240 IT->face_id. Value is non-zero if a space was added.
19242 This function is called to make sure that there is always one glyph
19243 at the end of a glyph row that the cursor can be set on under
19244 window-systems. (If there weren't such a glyph we would not know
19245 how wide and tall a box cursor should be displayed).
19247 At the same time this space let's a nicely handle clearing to the
19248 end of the line if the row ends in italic text. */
19251 append_space_for_newline (struct it
*it
, int default_face_p
)
19253 if (FRAME_WINDOW_P (it
->f
))
19255 int n
= it
->glyph_row
->used
[TEXT_AREA
];
19257 if (it
->glyph_row
->glyphs
[TEXT_AREA
] + n
19258 < it
->glyph_row
->glyphs
[1 + TEXT_AREA
])
19260 /* Save some values that must not be changed.
19261 Must save IT->c and IT->len because otherwise
19262 ITERATOR_AT_END_P wouldn't work anymore after
19263 append_space_for_newline has been called. */
19264 enum display_element_type saved_what
= it
->what
;
19265 int saved_c
= it
->c
, saved_len
= it
->len
;
19266 int saved_char_to_display
= it
->char_to_display
;
19267 int saved_x
= it
->current_x
;
19268 int saved_face_id
= it
->face_id
;
19269 int saved_box_end
= it
->end_of_box_run_p
;
19270 struct text_pos saved_pos
;
19271 Lisp_Object saved_object
;
19274 saved_object
= it
->object
;
19275 saved_pos
= it
->position
;
19277 it
->what
= IT_CHARACTER
;
19278 memset (&it
->position
, 0, sizeof it
->position
);
19279 it
->object
= make_number (0);
19280 it
->c
= it
->char_to_display
= ' ';
19283 /* If the default face was remapped, be sure to use the
19284 remapped face for the appended newline. */
19285 if (default_face_p
)
19286 it
->face_id
= lookup_basic_face (it
->f
, DEFAULT_FACE_ID
);
19287 else if (it
->face_before_selective_p
)
19288 it
->face_id
= it
->saved_face_id
;
19289 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
19290 it
->face_id
= FACE_FOR_CHAR (it
->f
, face
, 0, -1, Qnil
);
19291 /* In R2L rows, we will prepend a stretch glyph that will
19292 have the end_of_box_run_p flag set for it, so there's no
19293 need for the appended newline glyph to have that flag
19295 if (it
->glyph_row
->reversed_p
19296 /* But if the appended newline glyph goes all the way to
19297 the end of the row, there will be no stretch glyph,
19298 so leave the box flag set. */
19299 && saved_x
+ FRAME_COLUMN_WIDTH (it
->f
) < it
->last_visible_x
)
19300 it
->end_of_box_run_p
= 0;
19302 PRODUCE_GLYPHS (it
);
19304 it
->override_ascent
= -1;
19305 it
->constrain_row_ascent_descent_p
= 0;
19306 it
->current_x
= saved_x
;
19307 it
->object
= saved_object
;
19308 it
->position
= saved_pos
;
19309 it
->what
= saved_what
;
19310 it
->face_id
= saved_face_id
;
19311 it
->len
= saved_len
;
19313 it
->char_to_display
= saved_char_to_display
;
19314 it
->end_of_box_run_p
= saved_box_end
;
19323 /* Extend the face of the last glyph in the text area of IT->glyph_row
19324 to the end of the display line. Called from display_line. If the
19325 glyph row is empty, add a space glyph to it so that we know the
19326 face to draw. Set the glyph row flag fill_line_p. If the glyph
19327 row is R2L, prepend a stretch glyph to cover the empty space to the
19328 left of the leftmost glyph. */
19331 extend_face_to_end_of_line (struct it
*it
)
19333 struct face
*face
, *default_face
;
19334 struct frame
*f
= it
->f
;
19336 /* If line is already filled, do nothing. Non window-system frames
19337 get a grace of one more ``pixel'' because their characters are
19338 1-``pixel'' wide, so they hit the equality too early. This grace
19339 is needed only for R2L rows that are not continued, to produce
19340 one extra blank where we could display the cursor. */
19341 if ((it
->current_x
>= it
->last_visible_x
19342 + (!FRAME_WINDOW_P (f
)
19343 && it
->glyph_row
->reversed_p
19344 && !it
->glyph_row
->continued_p
))
19345 /* If the window has display margins, we will need to extend
19346 their face even if the text area is filled. */
19347 && !(WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19348 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0))
19351 /* The default face, possibly remapped. */
19352 default_face
= FACE_FROM_ID (f
, lookup_basic_face (f
, DEFAULT_FACE_ID
));
19354 /* Face extension extends the background and box of IT->face_id
19355 to the end of the line. If the background equals the background
19356 of the frame, we don't have to do anything. */
19357 if (it
->face_before_selective_p
)
19358 face
= FACE_FROM_ID (f
, it
->saved_face_id
);
19360 face
= FACE_FROM_ID (f
, it
->face_id
);
19362 if (FRAME_WINDOW_P (f
)
19363 && MATRIX_ROW_DISPLAYS_TEXT_P (it
->glyph_row
)
19364 && face
->box
== FACE_NO_BOX
19365 && face
->background
== FRAME_BACKGROUND_PIXEL (f
)
19366 #ifdef HAVE_WINDOW_SYSTEM
19369 && !it
->glyph_row
->reversed_p
)
19372 /* Set the glyph row flag indicating that the face of the last glyph
19373 in the text area has to be drawn to the end of the text area. */
19374 it
->glyph_row
->fill_line_p
= 1;
19376 /* If current character of IT is not ASCII, make sure we have the
19377 ASCII face. This will be automatically undone the next time
19378 get_next_display_element returns a multibyte character. Note
19379 that the character will always be single byte in unibyte
19381 if (!ASCII_CHAR_P (it
->c
))
19383 it
->face_id
= FACE_FOR_CHAR (f
, face
, 0, -1, Qnil
);
19386 if (FRAME_WINDOW_P (f
))
19388 /* If the row is empty, add a space with the current face of IT,
19389 so that we know which face to draw. */
19390 if (it
->glyph_row
->used
[TEXT_AREA
] == 0)
19392 it
->glyph_row
->glyphs
[TEXT_AREA
][0] = space_glyph
;
19393 it
->glyph_row
->glyphs
[TEXT_AREA
][0].face_id
= face
->id
;
19394 it
->glyph_row
->used
[TEXT_AREA
] = 1;
19396 /* Mode line and the header line don't have margins, and
19397 likewise the frame's tool-bar window, if there is any. */
19398 if (!(it
->glyph_row
->mode_line_p
19399 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
19400 || (WINDOWP (f
->tool_bar_window
)
19401 && it
->w
== XWINDOW (f
->tool_bar_window
))
19405 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19406 && it
->glyph_row
->used
[LEFT_MARGIN_AREA
] == 0)
19408 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0] = space_glyph
;
19409 it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
][0].face_id
=
19411 it
->glyph_row
->used
[LEFT_MARGIN_AREA
] = 1;
19413 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19414 && it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] == 0)
19416 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0] = space_glyph
;
19417 it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
][0].face_id
=
19419 it
->glyph_row
->used
[RIGHT_MARGIN_AREA
] = 1;
19422 #ifdef HAVE_WINDOW_SYSTEM
19423 if (it
->glyph_row
->reversed_p
)
19425 /* Prepend a stretch glyph to the row, such that the
19426 rightmost glyph will be drawn flushed all the way to the
19427 right margin of the window. The stretch glyph that will
19428 occupy the empty space, if any, to the left of the
19430 struct font
*font
= face
->font
? face
->font
: FRAME_FONT (f
);
19431 struct glyph
*row_start
= it
->glyph_row
->glyphs
[TEXT_AREA
];
19432 struct glyph
*row_end
= row_start
+ it
->glyph_row
->used
[TEXT_AREA
];
19434 int row_width
, stretch_ascent
, stretch_width
;
19435 struct text_pos saved_pos
;
19436 int saved_face_id
, saved_avoid_cursor
, saved_box_start
;
19438 for (row_width
= 0, g
= row_start
; g
< row_end
; g
++)
19439 row_width
+= g
->pixel_width
;
19441 /* FIXME: There are various minor display glitches in R2L
19442 rows when only one of the fringes is missing. The
19443 strange condition below produces the least bad effect. */
19444 if ((WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0)
19445 == (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) == 0)
19446 || WINDOW_RIGHT_FRINGE_WIDTH (it
->w
) != 0)
19447 stretch_width
= window_box_width (it
->w
, TEXT_AREA
);
19449 stretch_width
= it
->last_visible_x
- it
->first_visible_x
;
19450 stretch_width
-= row_width
;
19452 if (stretch_width
> 0)
19455 (((it
->ascent
+ it
->descent
)
19456 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
19457 saved_pos
= it
->position
;
19458 memset (&it
->position
, 0, sizeof it
->position
);
19459 saved_avoid_cursor
= it
->avoid_cursor_p
;
19460 it
->avoid_cursor_p
= 1;
19461 saved_face_id
= it
->face_id
;
19462 saved_box_start
= it
->start_of_box_run_p
;
19463 /* The last row's stretch glyph should get the default
19464 face, to avoid painting the rest of the window with
19465 the region face, if the region ends at ZV. */
19466 if (it
->glyph_row
->ends_at_zv_p
)
19467 it
->face_id
= default_face
->id
;
19469 it
->face_id
= face
->id
;
19470 it
->start_of_box_run_p
= 0;
19471 append_stretch_glyph (it
, make_number (0), stretch_width
,
19472 it
->ascent
+ it
->descent
, stretch_ascent
);
19473 it
->position
= saved_pos
;
19474 it
->avoid_cursor_p
= saved_avoid_cursor
;
19475 it
->face_id
= saved_face_id
;
19476 it
->start_of_box_run_p
= saved_box_start
;
19478 /* If stretch_width comes out negative, it means that the
19479 last glyph is only partially visible. In R2L rows, we
19480 want the leftmost glyph to be partially visible, so we
19481 need to give the row the corresponding left offset. */
19482 if (stretch_width
< 0)
19483 it
->glyph_row
->x
= stretch_width
;
19485 #endif /* HAVE_WINDOW_SYSTEM */
19489 /* Save some values that must not be changed. */
19490 int saved_x
= it
->current_x
;
19491 struct text_pos saved_pos
;
19492 Lisp_Object saved_object
;
19493 enum display_element_type saved_what
= it
->what
;
19494 int saved_face_id
= it
->face_id
;
19496 saved_object
= it
->object
;
19497 saved_pos
= it
->position
;
19499 it
->what
= IT_CHARACTER
;
19500 memset (&it
->position
, 0, sizeof it
->position
);
19501 it
->object
= make_number (0);
19502 it
->c
= it
->char_to_display
= ' ';
19505 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
19506 && (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19507 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19508 && !it
->glyph_row
->mode_line_p
19509 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19511 struct glyph
*g
= it
->glyph_row
->glyphs
[LEFT_MARGIN_AREA
];
19512 struct glyph
*e
= g
+ it
->glyph_row
->used
[LEFT_MARGIN_AREA
];
19514 for (it
->current_x
= 0; g
< e
; g
++)
19515 it
->current_x
+= g
->pixel_width
;
19517 it
->area
= LEFT_MARGIN_AREA
;
19518 it
->face_id
= default_face
->id
;
19519 while (it
->glyph_row
->used
[LEFT_MARGIN_AREA
]
19520 < WINDOW_LEFT_MARGIN_WIDTH (it
->w
))
19522 PRODUCE_GLYPHS (it
);
19523 /* term.c:produce_glyphs advances it->current_x only for
19525 it
->current_x
+= it
->pixel_width
;
19528 it
->current_x
= saved_x
;
19529 it
->area
= TEXT_AREA
;
19532 /* The last row's blank glyphs should get the default face, to
19533 avoid painting the rest of the window with the region face,
19534 if the region ends at ZV. */
19535 if (it
->glyph_row
->ends_at_zv_p
)
19536 it
->face_id
= default_face
->id
;
19538 it
->face_id
= face
->id
;
19539 PRODUCE_GLYPHS (it
);
19541 while (it
->current_x
<= it
->last_visible_x
)
19542 PRODUCE_GLYPHS (it
);
19544 if (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0
19545 && (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19546 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19547 && !it
->glyph_row
->mode_line_p
19548 && default_face
->background
!= FRAME_BACKGROUND_PIXEL (f
))
19550 struct glyph
*g
= it
->glyph_row
->glyphs
[RIGHT_MARGIN_AREA
];
19551 struct glyph
*e
= g
+ it
->glyph_row
->used
[RIGHT_MARGIN_AREA
];
19553 for ( ; g
< e
; g
++)
19554 it
->current_x
+= g
->pixel_width
;
19556 it
->area
= RIGHT_MARGIN_AREA
;
19557 it
->face_id
= default_face
->id
;
19558 while (it
->glyph_row
->used
[RIGHT_MARGIN_AREA
]
19559 < WINDOW_RIGHT_MARGIN_WIDTH (it
->w
))
19561 PRODUCE_GLYPHS (it
);
19562 it
->current_x
+= it
->pixel_width
;
19565 it
->area
= TEXT_AREA
;
19568 /* Don't count these blanks really. It would let us insert a left
19569 truncation glyph below and make us set the cursor on them, maybe. */
19570 it
->current_x
= saved_x
;
19571 it
->object
= saved_object
;
19572 it
->position
= saved_pos
;
19573 it
->what
= saved_what
;
19574 it
->face_id
= saved_face_id
;
19579 /* Value is non-zero if text starting at CHARPOS in current_buffer is
19580 trailing whitespace. */
19583 trailing_whitespace_p (ptrdiff_t charpos
)
19585 ptrdiff_t bytepos
= CHAR_TO_BYTE (charpos
);
19588 while (bytepos
< ZV_BYTE
19589 && (c
= FETCH_CHAR (bytepos
),
19590 c
== ' ' || c
== '\t'))
19593 if (bytepos
>= ZV_BYTE
|| c
== '\n' || c
== '\r')
19595 if (bytepos
!= PT_BYTE
)
19602 /* Highlight trailing whitespace, if any, in ROW. */
19605 highlight_trailing_whitespace (struct frame
*f
, struct glyph_row
*row
)
19607 int used
= row
->used
[TEXT_AREA
];
19611 struct glyph
*start
= row
->glyphs
[TEXT_AREA
];
19612 struct glyph
*glyph
= start
+ used
- 1;
19614 if (row
->reversed_p
)
19616 /* Right-to-left rows need to be processed in the opposite
19617 direction, so swap the edge pointers. */
19619 start
= row
->glyphs
[TEXT_AREA
] + used
- 1;
19622 /* Skip over glyphs inserted to display the cursor at the
19623 end of a line, for extending the face of the last glyph
19624 to the end of the line on terminals, and for truncation
19625 and continuation glyphs. */
19626 if (!row
->reversed_p
)
19628 while (glyph
>= start
19629 && glyph
->type
== CHAR_GLYPH
19630 && INTEGERP (glyph
->object
))
19635 while (glyph
<= start
19636 && glyph
->type
== CHAR_GLYPH
19637 && INTEGERP (glyph
->object
))
19641 /* If last glyph is a space or stretch, and it's trailing
19642 whitespace, set the face of all trailing whitespace glyphs in
19643 IT->glyph_row to `trailing-whitespace'. */
19644 if ((row
->reversed_p
? glyph
<= start
: glyph
>= start
)
19645 && BUFFERP (glyph
->object
)
19646 && (glyph
->type
== STRETCH_GLYPH
19647 || (glyph
->type
== CHAR_GLYPH
19648 && glyph
->u
.ch
== ' '))
19649 && trailing_whitespace_p (glyph
->charpos
))
19651 int face_id
= lookup_named_face (f
, Qtrailing_whitespace
, 0);
19655 if (!row
->reversed_p
)
19657 while (glyph
>= start
19658 && BUFFERP (glyph
->object
)
19659 && (glyph
->type
== STRETCH_GLYPH
19660 || (glyph
->type
== CHAR_GLYPH
19661 && glyph
->u
.ch
== ' ')))
19662 (glyph
--)->face_id
= face_id
;
19666 while (glyph
<= start
19667 && BUFFERP (glyph
->object
)
19668 && (glyph
->type
== STRETCH_GLYPH
19669 || (glyph
->type
== CHAR_GLYPH
19670 && glyph
->u
.ch
== ' ')))
19671 (glyph
++)->face_id
= face_id
;
19678 /* Value is non-zero if glyph row ROW should be
19679 considered to hold the buffer position CHARPOS. */
19682 row_for_charpos_p (struct glyph_row
*row
, ptrdiff_t charpos
)
19686 if (charpos
== CHARPOS (row
->end
.pos
)
19687 || charpos
== MATRIX_ROW_END_CHARPOS (row
))
19689 /* Suppose the row ends on a string.
19690 Unless the row is continued, that means it ends on a newline
19691 in the string. If it's anything other than a display string
19692 (e.g., a before-string from an overlay), we don't want the
19693 cursor there. (This heuristic seems to give the optimal
19694 behavior for the various types of multi-line strings.)
19695 One exception: if the string has `cursor' property on one of
19696 its characters, we _do_ want the cursor there. */
19697 if (CHARPOS (row
->end
.string_pos
) >= 0)
19699 if (row
->continued_p
)
19703 /* Check for `display' property. */
19704 struct glyph
*beg
= row
->glyphs
[TEXT_AREA
];
19705 struct glyph
*end
= beg
+ row
->used
[TEXT_AREA
] - 1;
19706 struct glyph
*glyph
;
19709 for (glyph
= end
; glyph
>= beg
; --glyph
)
19710 if (STRINGP (glyph
->object
))
19713 = Fget_char_property (make_number (charpos
),
19717 && display_prop_string_p (prop
, glyph
->object
));
19718 /* If there's a `cursor' property on one of the
19719 string's characters, this row is a cursor row,
19720 even though this is not a display string. */
19723 Lisp_Object s
= glyph
->object
;
19725 for ( ; glyph
>= beg
&& EQ (glyph
->object
, s
); --glyph
)
19727 ptrdiff_t gpos
= glyph
->charpos
;
19729 if (!NILP (Fget_char_property (make_number (gpos
),
19741 else if (MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))
19743 /* If the row ends in middle of a real character,
19744 and the line is continued, we want the cursor here.
19745 That's because CHARPOS (ROW->end.pos) would equal
19746 PT if PT is before the character. */
19747 if (!row
->ends_in_ellipsis_p
)
19748 result
= row
->continued_p
;
19750 /* If the row ends in an ellipsis, then
19751 CHARPOS (ROW->end.pos) will equal point after the
19752 invisible text. We want that position to be displayed
19753 after the ellipsis. */
19756 /* If the row ends at ZV, display the cursor at the end of that
19757 row instead of at the start of the row below. */
19758 else if (row
->ends_at_zv_p
)
19767 /* Value is non-zero if glyph row ROW should be
19768 used to hold the cursor. */
19771 cursor_row_p (struct glyph_row
*row
)
19773 return row_for_charpos_p (row
, PT
);
19778 /* Push the property PROP so that it will be rendered at the current
19779 position in IT. Return 1 if PROP was successfully pushed, 0
19780 otherwise. Called from handle_line_prefix to handle the
19781 `line-prefix' and `wrap-prefix' properties. */
19784 push_prefix_prop (struct it
*it
, Lisp_Object prop
)
19786 struct text_pos pos
=
19787 STRINGP (it
->string
) ? it
->current
.string_pos
: it
->current
.pos
;
19789 eassert (it
->method
== GET_FROM_BUFFER
19790 || it
->method
== GET_FROM_DISPLAY_VECTOR
19791 || it
->method
== GET_FROM_STRING
);
19793 /* We need to save the current buffer/string position, so it will be
19794 restored by pop_it, because iterate_out_of_display_property
19795 depends on that being set correctly, but some situations leave
19796 it->position not yet set when this function is called. */
19797 push_it (it
, &pos
);
19799 if (STRINGP (prop
))
19801 if (SCHARS (prop
) == 0)
19808 it
->string_from_prefix_prop_p
= 1;
19809 it
->multibyte_p
= STRING_MULTIBYTE (it
->string
);
19810 it
->current
.overlay_string_index
= -1;
19811 IT_STRING_CHARPOS (*it
) = IT_STRING_BYTEPOS (*it
) = 0;
19812 it
->end_charpos
= it
->string_nchars
= SCHARS (it
->string
);
19813 it
->method
= GET_FROM_STRING
;
19814 it
->stop_charpos
= 0;
19816 it
->base_level_stop
= 0;
19818 /* Force paragraph direction to be that of the parent
19820 if (it
->bidi_p
&& it
->bidi_it
.paragraph_dir
== R2L
)
19821 it
->paragraph_embedding
= it
->bidi_it
.paragraph_dir
;
19823 it
->paragraph_embedding
= L2R
;
19825 /* Set up the bidi iterator for this display string. */
19828 it
->bidi_it
.string
.lstring
= it
->string
;
19829 it
->bidi_it
.string
.s
= NULL
;
19830 it
->bidi_it
.string
.schars
= it
->end_charpos
;
19831 it
->bidi_it
.string
.bufpos
= IT_CHARPOS (*it
);
19832 it
->bidi_it
.string
.from_disp_str
= it
->string_from_display_prop_p
;
19833 it
->bidi_it
.string
.unibyte
= !it
->multibyte_p
;
19834 it
->bidi_it
.w
= it
->w
;
19835 bidi_init_it (0, 0, FRAME_WINDOW_P (it
->f
), &it
->bidi_it
);
19838 else if (CONSP (prop
) && EQ (XCAR (prop
), Qspace
))
19840 it
->method
= GET_FROM_STRETCH
;
19843 #ifdef HAVE_WINDOW_SYSTEM
19844 else if (IMAGEP (prop
))
19846 it
->what
= IT_IMAGE
;
19847 it
->image_id
= lookup_image (it
->f
, prop
);
19848 it
->method
= GET_FROM_IMAGE
;
19850 #endif /* HAVE_WINDOW_SYSTEM */
19853 pop_it (it
); /* bogus display property, give up */
19860 /* Return the character-property PROP at the current position in IT. */
19863 get_it_property (struct it
*it
, Lisp_Object prop
)
19865 Lisp_Object position
, object
= it
->object
;
19867 if (STRINGP (object
))
19868 position
= make_number (IT_STRING_CHARPOS (*it
));
19869 else if (BUFFERP (object
))
19871 position
= make_number (IT_CHARPOS (*it
));
19872 object
= it
->window
;
19877 return Fget_char_property (position
, prop
, object
);
19880 /* See if there's a line- or wrap-prefix, and if so, push it on IT. */
19883 handle_line_prefix (struct it
*it
)
19885 Lisp_Object prefix
;
19887 if (it
->continuation_lines_width
> 0)
19889 prefix
= get_it_property (it
, Qwrap_prefix
);
19891 prefix
= Vwrap_prefix
;
19895 prefix
= get_it_property (it
, Qline_prefix
);
19897 prefix
= Vline_prefix
;
19899 if (! NILP (prefix
) && push_prefix_prop (it
, prefix
))
19901 /* If the prefix is wider than the window, and we try to wrap
19902 it, it would acquire its own wrap prefix, and so on till the
19903 iterator stack overflows. So, don't wrap the prefix. */
19904 it
->line_wrap
= TRUNCATE
;
19905 it
->avoid_cursor_p
= 1;
19911 /* Remove N glyphs at the start of a reversed IT->glyph_row. Called
19912 only for R2L lines from display_line and display_string, when they
19913 decide that too many glyphs were produced by PRODUCE_GLYPHS, and
19914 the line/string needs to be continued on the next glyph row. */
19916 unproduce_glyphs (struct it
*it
, int n
)
19918 struct glyph
*glyph
, *end
;
19920 eassert (it
->glyph_row
);
19921 eassert (it
->glyph_row
->reversed_p
);
19922 eassert (it
->area
== TEXT_AREA
);
19923 eassert (n
<= it
->glyph_row
->used
[TEXT_AREA
]);
19925 if (n
> it
->glyph_row
->used
[TEXT_AREA
])
19926 n
= it
->glyph_row
->used
[TEXT_AREA
];
19927 glyph
= it
->glyph_row
->glyphs
[TEXT_AREA
] + n
;
19928 end
= it
->glyph_row
->glyphs
[TEXT_AREA
] + it
->glyph_row
->used
[TEXT_AREA
];
19929 for ( ; glyph
< end
; glyph
++)
19930 glyph
[-n
] = *glyph
;
19933 /* Find the positions in a bidi-reordered ROW to serve as ROW->minpos
19934 and ROW->maxpos. */
19936 find_row_edges (struct it
*it
, struct glyph_row
*row
,
19937 ptrdiff_t min_pos
, ptrdiff_t min_bpos
,
19938 ptrdiff_t max_pos
, ptrdiff_t max_bpos
)
19940 /* FIXME: Revisit this when glyph ``spilling'' in continuation
19941 lines' rows is implemented for bidi-reordered rows. */
19943 /* ROW->minpos is the value of min_pos, the minimal buffer position
19944 we have in ROW, or ROW->start.pos if that is smaller. */
19945 if (min_pos
<= ZV
&& min_pos
< row
->start
.pos
.charpos
)
19946 SET_TEXT_POS (row
->minpos
, min_pos
, min_bpos
);
19948 /* We didn't find buffer positions smaller than ROW->start, or
19949 didn't find _any_ valid buffer positions in any of the glyphs,
19950 so we must trust the iterator's computed positions. */
19951 row
->minpos
= row
->start
.pos
;
19954 max_pos
= CHARPOS (it
->current
.pos
);
19955 max_bpos
= BYTEPOS (it
->current
.pos
);
19958 /* Here are the various use-cases for ending the row, and the
19959 corresponding values for ROW->maxpos:
19961 Line ends in a newline from buffer eol_pos + 1
19962 Line is continued from buffer max_pos + 1
19963 Line is truncated on right it->current.pos
19964 Line ends in a newline from string max_pos + 1(*)
19965 (*) + 1 only when line ends in a forward scan
19966 Line is continued from string max_pos
19967 Line is continued from display vector max_pos
19968 Line is entirely from a string min_pos == max_pos
19969 Line is entirely from a display vector min_pos == max_pos
19970 Line that ends at ZV ZV
19972 If you discover other use-cases, please add them here as
19974 if (row
->ends_at_zv_p
)
19975 row
->maxpos
= it
->current
.pos
;
19976 else if (row
->used
[TEXT_AREA
])
19978 int seen_this_string
= 0;
19979 struct glyph_row
*r1
= row
- 1;
19981 /* Did we see the same display string on the previous row? */
19982 if (STRINGP (it
->object
)
19983 /* this is not the first row */
19984 && row
> it
->w
->desired_matrix
->rows
19985 /* previous row is not the header line */
19986 && !r1
->mode_line_p
19987 /* previous row also ends in a newline from a string */
19988 && r1
->ends_in_newline_from_string_p
)
19990 struct glyph
*start
, *end
;
19992 /* Search for the last glyph of the previous row that came
19993 from buffer or string. Depending on whether the row is
19994 L2R or R2L, we need to process it front to back or the
19995 other way round. */
19996 if (!r1
->reversed_p
)
19998 start
= r1
->glyphs
[TEXT_AREA
];
19999 end
= start
+ r1
->used
[TEXT_AREA
];
20000 /* Glyphs inserted by redisplay have an integer (zero)
20001 as their object. */
20003 && INTEGERP ((end
- 1)->object
)
20004 && (end
- 1)->charpos
<= 0)
20008 if (EQ ((end
- 1)->object
, it
->object
))
20009 seen_this_string
= 1;
20012 /* If all the glyphs of the previous row were inserted
20013 by redisplay, it means the previous row was
20014 produced from a single newline, which is only
20015 possible if that newline came from the same string
20016 as the one which produced this ROW. */
20017 seen_this_string
= 1;
20021 end
= r1
->glyphs
[TEXT_AREA
] - 1;
20022 start
= end
+ r1
->used
[TEXT_AREA
];
20024 && INTEGERP ((end
+ 1)->object
)
20025 && (end
+ 1)->charpos
<= 0)
20029 if (EQ ((end
+ 1)->object
, it
->object
))
20030 seen_this_string
= 1;
20033 seen_this_string
= 1;
20036 /* Take note of each display string that covers a newline only
20037 once, the first time we see it. This is for when a display
20038 string includes more than one newline in it. */
20039 if (row
->ends_in_newline_from_string_p
&& !seen_this_string
)
20041 /* If we were scanning the buffer forward when we displayed
20042 the string, we want to account for at least one buffer
20043 position that belongs to this row (position covered by
20044 the display string), so that cursor positioning will
20045 consider this row as a candidate when point is at the end
20046 of the visual line represented by this row. This is not
20047 required when scanning back, because max_pos will already
20048 have a much larger value. */
20049 if (CHARPOS (row
->end
.pos
) > max_pos
)
20050 INC_BOTH (max_pos
, max_bpos
);
20051 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20053 else if (CHARPOS (it
->eol_pos
) > 0)
20054 SET_TEXT_POS (row
->maxpos
,
20055 CHARPOS (it
->eol_pos
) + 1, BYTEPOS (it
->eol_pos
) + 1);
20056 else if (row
->continued_p
)
20058 /* If max_pos is different from IT's current position, it
20059 means IT->method does not belong to the display element
20060 at max_pos. However, it also means that the display
20061 element at max_pos was displayed in its entirety on this
20062 line, which is equivalent to saying that the next line
20063 starts at the next buffer position. */
20064 if (IT_CHARPOS (*it
) == max_pos
&& it
->method
!= GET_FROM_BUFFER
)
20065 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20068 INC_BOTH (max_pos
, max_bpos
);
20069 SET_TEXT_POS (row
->maxpos
, max_pos
, max_bpos
);
20072 else if (row
->truncated_on_right_p
)
20073 /* display_line already called reseat_at_next_visible_line_start,
20074 which puts the iterator at the beginning of the next line, in
20075 the logical order. */
20076 row
->maxpos
= it
->current
.pos
;
20077 else if (max_pos
== min_pos
&& it
->method
!= GET_FROM_BUFFER
)
20078 /* A line that is entirely from a string/image/stretch... */
20079 row
->maxpos
= row
->minpos
;
20084 row
->maxpos
= it
->current
.pos
;
20087 /* Construct the glyph row IT->glyph_row in the desired matrix of
20088 IT->w from text at the current position of IT. See dispextern.h
20089 for an overview of struct it. Value is non-zero if
20090 IT->glyph_row displays text, as opposed to a line displaying ZV
20094 display_line (struct it
*it
)
20096 struct glyph_row
*row
= it
->glyph_row
;
20097 Lisp_Object overlay_arrow_string
;
20099 void *wrap_data
= NULL
;
20100 int may_wrap
= 0, wrap_x
IF_LINT (= 0);
20101 int wrap_row_used
= -1;
20102 int wrap_row_ascent
IF_LINT (= 0), wrap_row_height
IF_LINT (= 0);
20103 int wrap_row_phys_ascent
IF_LINT (= 0), wrap_row_phys_height
IF_LINT (= 0);
20104 int wrap_row_extra_line_spacing
IF_LINT (= 0);
20105 ptrdiff_t wrap_row_min_pos
IF_LINT (= 0), wrap_row_min_bpos
IF_LINT (= 0);
20106 ptrdiff_t wrap_row_max_pos
IF_LINT (= 0), wrap_row_max_bpos
IF_LINT (= 0);
20108 ptrdiff_t min_pos
= ZV
+ 1, max_pos
= 0;
20109 ptrdiff_t min_bpos
IF_LINT (= 0), max_bpos
IF_LINT (= 0);
20110 bool pending_handle_line_prefix
= false;
20112 /* We always start displaying at hpos zero even if hscrolled. */
20113 eassert (it
->hpos
== 0 && it
->current_x
== 0);
20115 if (MATRIX_ROW_VPOS (row
, it
->w
->desired_matrix
)
20116 >= it
->w
->desired_matrix
->nrows
)
20118 it
->w
->nrows_scale_factor
++;
20119 it
->f
->fonts_changed
= 1;
20123 /* Clear the result glyph row and enable it. */
20124 prepare_desired_row (it
->w
, row
, false);
20126 row
->y
= it
->current_y
;
20127 row
->start
= it
->start
;
20128 row
->continuation_lines_width
= it
->continuation_lines_width
;
20129 row
->displays_text_p
= 1;
20130 row
->starts_in_middle_of_char_p
= it
->starts_in_middle_of_char_p
;
20131 it
->starts_in_middle_of_char_p
= 0;
20133 /* Arrange the overlays nicely for our purposes. Usually, we call
20134 display_line on only one line at a time, in which case this
20135 can't really hurt too much, or we call it on lines which appear
20136 one after another in the buffer, in which case all calls to
20137 recenter_overlay_lists but the first will be pretty cheap. */
20138 recenter_overlay_lists (current_buffer
, IT_CHARPOS (*it
));
20140 /* Move over display elements that are not visible because we are
20141 hscrolled. This may stop at an x-position < IT->first_visible_x
20142 if the first glyph is partially visible or if we hit a line end. */
20143 if (it
->current_x
< it
->first_visible_x
)
20145 enum move_it_result move_result
;
20147 this_line_min_pos
= row
->start
.pos
;
20148 move_result
= move_it_in_display_line_to (it
, ZV
, it
->first_visible_x
,
20149 MOVE_TO_POS
| MOVE_TO_X
);
20150 /* If we are under a large hscroll, move_it_in_display_line_to
20151 could hit the end of the line without reaching
20152 it->first_visible_x. Pretend that we did reach it. This is
20153 especially important on a TTY, where we will call
20154 extend_face_to_end_of_line, which needs to know how many
20155 blank glyphs to produce. */
20156 if (it
->current_x
< it
->first_visible_x
20157 && (move_result
== MOVE_NEWLINE_OR_CR
20158 || move_result
== MOVE_POS_MATCH_OR_ZV
))
20159 it
->current_x
= it
->first_visible_x
;
20161 /* Record the smallest positions seen while we moved over
20162 display elements that are not visible. This is needed by
20163 redisplay_internal for optimizing the case where the cursor
20164 stays inside the same line. The rest of this function only
20165 considers positions that are actually displayed, so
20166 RECORD_MAX_MIN_POS will not otherwise record positions that
20167 are hscrolled to the left of the left edge of the window. */
20168 min_pos
= CHARPOS (this_line_min_pos
);
20169 min_bpos
= BYTEPOS (this_line_min_pos
);
20171 else if (it
->area
== TEXT_AREA
)
20173 /* We only do this when not calling move_it_in_display_line_to
20174 above, because that function calls itself handle_line_prefix. */
20175 handle_line_prefix (it
);
20179 /* Line-prefix and wrap-prefix are always displayed in the text
20180 area. But if this is the first call to display_line after
20181 init_iterator, the iterator might have been set up to write
20182 into a marginal area, e.g. if the line begins with some
20183 display property that writes to the margins. So we need to
20184 wait with the call to handle_line_prefix until whatever
20185 writes to the margin has done its job. */
20186 pending_handle_line_prefix
= true;
20189 /* Get the initial row height. This is either the height of the
20190 text hscrolled, if there is any, or zero. */
20191 row
->ascent
= it
->max_ascent
;
20192 row
->height
= it
->max_ascent
+ it
->max_descent
;
20193 row
->phys_ascent
= it
->max_phys_ascent
;
20194 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
20195 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
20197 /* Utility macro to record max and min buffer positions seen until now. */
20198 #define RECORD_MAX_MIN_POS(IT) \
20201 int composition_p = !STRINGP ((IT)->string) \
20202 && ((IT)->what == IT_COMPOSITION); \
20203 ptrdiff_t current_pos = \
20204 composition_p ? (IT)->cmp_it.charpos \
20205 : IT_CHARPOS (*(IT)); \
20206 ptrdiff_t current_bpos = \
20207 composition_p ? CHAR_TO_BYTE (current_pos) \
20208 : IT_BYTEPOS (*(IT)); \
20209 if (current_pos < min_pos) \
20211 min_pos = current_pos; \
20212 min_bpos = current_bpos; \
20214 if (IT_CHARPOS (*it) > max_pos) \
20216 max_pos = IT_CHARPOS (*it); \
20217 max_bpos = IT_BYTEPOS (*it); \
20222 /* Loop generating characters. The loop is left with IT on the next
20223 character to display. */
20226 int n_glyphs_before
, hpos_before
, x_before
;
20228 int ascent
= 0, descent
= 0, phys_ascent
= 0, phys_descent
= 0;
20230 /* Retrieve the next thing to display. Value is zero if end of
20232 if (!get_next_display_element (it
))
20234 /* Maybe add a space at the end of this line that is used to
20235 display the cursor there under X. Set the charpos of the
20236 first glyph of blank lines not corresponding to any text
20238 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20239 row
->exact_window_width_line_p
= 1;
20240 else if ((append_space_for_newline (it
, 1) && row
->used
[TEXT_AREA
] == 1)
20241 || row
->used
[TEXT_AREA
] == 0)
20243 row
->glyphs
[TEXT_AREA
]->charpos
= -1;
20244 row
->displays_text_p
= 0;
20246 if (!NILP (BVAR (XBUFFER (it
->w
->contents
), indicate_empty_lines
))
20247 && (!MINI_WINDOW_P (it
->w
)
20248 || (minibuf_level
&& EQ (it
->window
, minibuf_window
))))
20249 row
->indicate_empty_line_p
= 1;
20252 it
->continuation_lines_width
= 0;
20253 row
->ends_at_zv_p
= 1;
20254 /* A row that displays right-to-left text must always have
20255 its last face extended all the way to the end of line,
20256 even if this row ends in ZV, because we still write to
20257 the screen left to right. We also need to extend the
20258 last face if the default face is remapped to some
20259 different face, otherwise the functions that clear
20260 portions of the screen will clear with the default face's
20261 background color. */
20262 if (row
->reversed_p
20263 || lookup_basic_face (it
->f
, DEFAULT_FACE_ID
) != DEFAULT_FACE_ID
)
20264 extend_face_to_end_of_line (it
);
20268 /* Now, get the metrics of what we want to display. This also
20269 generates glyphs in `row' (which is IT->glyph_row). */
20270 n_glyphs_before
= row
->used
[TEXT_AREA
];
20273 /* Remember the line height so far in case the next element doesn't
20274 fit on the line. */
20275 if (it
->line_wrap
!= TRUNCATE
)
20277 ascent
= it
->max_ascent
;
20278 descent
= it
->max_descent
;
20279 phys_ascent
= it
->max_phys_ascent
;
20280 phys_descent
= it
->max_phys_descent
;
20282 if (it
->line_wrap
== WORD_WRAP
&& it
->area
== TEXT_AREA
)
20284 if (IT_DISPLAYING_WHITESPACE (it
))
20288 SAVE_IT (wrap_it
, *it
, wrap_data
);
20290 wrap_row_used
= row
->used
[TEXT_AREA
];
20291 wrap_row_ascent
= row
->ascent
;
20292 wrap_row_height
= row
->height
;
20293 wrap_row_phys_ascent
= row
->phys_ascent
;
20294 wrap_row_phys_height
= row
->phys_height
;
20295 wrap_row_extra_line_spacing
= row
->extra_line_spacing
;
20296 wrap_row_min_pos
= min_pos
;
20297 wrap_row_min_bpos
= min_bpos
;
20298 wrap_row_max_pos
= max_pos
;
20299 wrap_row_max_bpos
= max_bpos
;
20305 PRODUCE_GLYPHS (it
);
20307 /* If this display element was in marginal areas, continue with
20309 if (it
->area
!= TEXT_AREA
)
20311 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20312 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20313 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20314 row
->phys_height
= max (row
->phys_height
,
20315 it
->max_phys_ascent
+ it
->max_phys_descent
);
20316 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20317 it
->max_extra_line_spacing
);
20318 set_iterator_to_next (it
, 1);
20319 /* If we didn't handle the line/wrap prefix above, and the
20320 call to set_iterator_to_next just switched to TEXT_AREA,
20321 process the prefix now. */
20322 if (it
->area
== TEXT_AREA
&& pending_handle_line_prefix
)
20324 pending_handle_line_prefix
= false;
20325 handle_line_prefix (it
);
20330 /* Does the display element fit on the line? If we truncate
20331 lines, we should draw past the right edge of the window. If
20332 we don't truncate, we want to stop so that we can display the
20333 continuation glyph before the right margin. If lines are
20334 continued, there are two possible strategies for characters
20335 resulting in more than 1 glyph (e.g. tabs): Display as many
20336 glyphs as possible in this line and leave the rest for the
20337 continuation line, or display the whole element in the next
20338 line. Original redisplay did the former, so we do it also. */
20339 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
20340 hpos_before
= it
->hpos
;
20343 if (/* Not a newline. */
20345 /* Glyphs produced fit entirely in the line. */
20346 && it
->current_x
< it
->last_visible_x
)
20348 it
->hpos
+= nglyphs
;
20349 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20350 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20351 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20352 row
->phys_height
= max (row
->phys_height
,
20353 it
->max_phys_ascent
+ it
->max_phys_descent
);
20354 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20355 it
->max_extra_line_spacing
);
20356 if (it
->current_x
- it
->pixel_width
< it
->first_visible_x
20357 /* In R2L rows, we arrange in extend_face_to_end_of_line
20358 to add a right offset to the line, by a suitable
20359 change to the stretch glyph that is the leftmost
20360 glyph of the line. */
20361 && !row
->reversed_p
)
20362 row
->x
= x
- it
->first_visible_x
;
20363 /* Record the maximum and minimum buffer positions seen so
20364 far in glyphs that will be displayed by this row. */
20366 RECORD_MAX_MIN_POS (it
);
20371 struct glyph
*glyph
;
20373 for (i
= 0; i
< nglyphs
; ++i
, x
= new_x
)
20375 /* Identify the glyphs added by the last call to
20376 PRODUCE_GLYPHS. In R2L rows, they are prepended to
20377 the previous glyphs. */
20378 if (!row
->reversed_p
)
20379 glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
20381 glyph
= row
->glyphs
[TEXT_AREA
] + nglyphs
- 1 - i
;
20382 new_x
= x
+ glyph
->pixel_width
;
20384 if (/* Lines are continued. */
20385 it
->line_wrap
!= TRUNCATE
20386 && (/* Glyph doesn't fit on the line. */
20387 new_x
> it
->last_visible_x
20388 /* Or it fits exactly on a window system frame. */
20389 || (new_x
== it
->last_visible_x
20390 && FRAME_WINDOW_P (it
->f
)
20391 && (row
->reversed_p
20392 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20393 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)))))
20395 /* End of a continued line. */
20398 || (new_x
== it
->last_visible_x
20399 && FRAME_WINDOW_P (it
->f
)
20400 && (row
->reversed_p
20401 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20402 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))))
20404 /* Current glyph is the only one on the line or
20405 fits exactly on the line. We must continue
20406 the line because we can't draw the cursor
20407 after the glyph. */
20408 row
->continued_p
= 1;
20409 it
->current_x
= new_x
;
20410 it
->continuation_lines_width
+= new_x
;
20412 if (i
== nglyphs
- 1)
20414 /* If line-wrap is on, check if a previous
20415 wrap point was found. */
20416 if (wrap_row_used
> 0
20417 /* Even if there is a previous wrap
20418 point, continue the line here as
20419 usual, if (i) the previous character
20420 was a space or tab AND (ii) the
20421 current character is not. */
20423 || IT_DISPLAYING_WHITESPACE (it
)))
20426 /* Record the maximum and minimum buffer
20427 positions seen so far in glyphs that will be
20428 displayed by this row. */
20430 RECORD_MAX_MIN_POS (it
);
20431 set_iterator_to_next (it
, 1);
20432 if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20434 if (!get_next_display_element (it
))
20436 row
->exact_window_width_line_p
= 1;
20437 it
->continuation_lines_width
= 0;
20438 row
->continued_p
= 0;
20439 row
->ends_at_zv_p
= 1;
20441 else if (ITERATOR_AT_END_OF_LINE_P (it
))
20443 row
->continued_p
= 0;
20444 row
->exact_window_width_line_p
= 1;
20448 else if (it
->bidi_p
)
20449 RECORD_MAX_MIN_POS (it
);
20450 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20451 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20452 extend_face_to_end_of_line (it
);
20454 else if (CHAR_GLYPH_PADDING_P (*glyph
)
20455 && !FRAME_WINDOW_P (it
->f
))
20457 /* A padding glyph that doesn't fit on this line.
20458 This means the whole character doesn't fit
20460 if (row
->reversed_p
)
20461 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20462 - n_glyphs_before
);
20463 row
->used
[TEXT_AREA
] = n_glyphs_before
;
20465 /* Fill the rest of the row with continuation
20466 glyphs like in 20.x. */
20467 while (row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
]
20468 < row
->glyphs
[1 + TEXT_AREA
])
20469 produce_special_glyphs (it
, IT_CONTINUATION
);
20471 row
->continued_p
= 1;
20472 it
->current_x
= x_before
;
20473 it
->continuation_lines_width
+= x_before
;
20475 /* Restore the height to what it was before the
20476 element not fitting on the line. */
20477 it
->max_ascent
= ascent
;
20478 it
->max_descent
= descent
;
20479 it
->max_phys_ascent
= phys_ascent
;
20480 it
->max_phys_descent
= phys_descent
;
20481 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20482 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20483 extend_face_to_end_of_line (it
);
20485 else if (wrap_row_used
> 0)
20488 if (row
->reversed_p
)
20489 unproduce_glyphs (it
,
20490 row
->used
[TEXT_AREA
] - wrap_row_used
);
20491 RESTORE_IT (it
, &wrap_it
, wrap_data
);
20492 it
->continuation_lines_width
+= wrap_x
;
20493 row
->used
[TEXT_AREA
] = wrap_row_used
;
20494 row
->ascent
= wrap_row_ascent
;
20495 row
->height
= wrap_row_height
;
20496 row
->phys_ascent
= wrap_row_phys_ascent
;
20497 row
->phys_height
= wrap_row_phys_height
;
20498 row
->extra_line_spacing
= wrap_row_extra_line_spacing
;
20499 min_pos
= wrap_row_min_pos
;
20500 min_bpos
= wrap_row_min_bpos
;
20501 max_pos
= wrap_row_max_pos
;
20502 max_bpos
= wrap_row_max_bpos
;
20503 row
->continued_p
= 1;
20504 row
->ends_at_zv_p
= 0;
20505 row
->exact_window_width_line_p
= 0;
20506 it
->continuation_lines_width
+= x
;
20508 /* Make sure that a non-default face is extended
20509 up to the right margin of the window. */
20510 extend_face_to_end_of_line (it
);
20512 else if (it
->c
== '\t' && FRAME_WINDOW_P (it
->f
))
20514 /* A TAB that extends past the right edge of the
20515 window. This produces a single glyph on
20516 window system frames. We leave the glyph in
20517 this row and let it fill the row, but don't
20518 consume the TAB. */
20519 if ((row
->reversed_p
20520 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20521 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20522 produce_special_glyphs (it
, IT_CONTINUATION
);
20523 it
->continuation_lines_width
+= it
->last_visible_x
;
20524 row
->ends_in_middle_of_char_p
= 1;
20525 row
->continued_p
= 1;
20526 glyph
->pixel_width
= it
->last_visible_x
- x
;
20527 it
->starts_in_middle_of_char_p
= 1;
20528 if (WINDOW_LEFT_MARGIN_WIDTH (it
->w
) > 0
20529 || WINDOW_RIGHT_MARGIN_WIDTH (it
->w
) > 0)
20530 extend_face_to_end_of_line (it
);
20534 /* Something other than a TAB that draws past
20535 the right edge of the window. Restore
20536 positions to values before the element. */
20537 if (row
->reversed_p
)
20538 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
20539 - (n_glyphs_before
+ i
));
20540 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
20542 /* Display continuation glyphs. */
20543 it
->current_x
= x_before
;
20544 it
->continuation_lines_width
+= x
;
20545 if (!FRAME_WINDOW_P (it
->f
)
20546 || (row
->reversed_p
20547 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20548 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20549 produce_special_glyphs (it
, IT_CONTINUATION
);
20550 row
->continued_p
= 1;
20552 extend_face_to_end_of_line (it
);
20554 if (nglyphs
> 1 && i
> 0)
20556 row
->ends_in_middle_of_char_p
= 1;
20557 it
->starts_in_middle_of_char_p
= 1;
20560 /* Restore the height to what it was before the
20561 element not fitting on the line. */
20562 it
->max_ascent
= ascent
;
20563 it
->max_descent
= descent
;
20564 it
->max_phys_ascent
= phys_ascent
;
20565 it
->max_phys_descent
= phys_descent
;
20570 else if (new_x
> it
->first_visible_x
)
20572 /* Increment number of glyphs actually displayed. */
20575 /* Record the maximum and minimum buffer positions
20576 seen so far in glyphs that will be displayed by
20579 RECORD_MAX_MIN_POS (it
);
20581 if (x
< it
->first_visible_x
&& !row
->reversed_p
)
20582 /* Glyph is partially visible, i.e. row starts at
20583 negative X position. Don't do that in R2L
20584 rows, where we arrange to add a right offset to
20585 the line in extend_face_to_end_of_line, by a
20586 suitable change to the stretch glyph that is
20587 the leftmost glyph of the line. */
20588 row
->x
= x
- it
->first_visible_x
;
20589 /* When the last glyph of an R2L row only fits
20590 partially on the line, we need to set row->x to a
20591 negative offset, so that the leftmost glyph is
20592 the one that is partially visible. But if we are
20593 going to produce the truncation glyph, this will
20594 be taken care of in produce_special_glyphs. */
20595 if (row
->reversed_p
20596 && new_x
> it
->last_visible_x
20597 && !(it
->line_wrap
== TRUNCATE
20598 && WINDOW_LEFT_FRINGE_WIDTH (it
->w
) == 0))
20600 eassert (FRAME_WINDOW_P (it
->f
));
20601 row
->x
= it
->last_visible_x
- new_x
;
20606 /* Glyph is completely off the left margin of the
20607 window. This should not happen because of the
20608 move_it_in_display_line at the start of this
20609 function, unless the text display area of the
20610 window is empty. */
20611 eassert (it
->first_visible_x
<= it
->last_visible_x
);
20614 /* Even if this display element produced no glyphs at all,
20615 we want to record its position. */
20616 if (it
->bidi_p
&& nglyphs
== 0)
20617 RECORD_MAX_MIN_POS (it
);
20619 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
20620 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
20621 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
20622 row
->phys_height
= max (row
->phys_height
,
20623 it
->max_phys_ascent
+ it
->max_phys_descent
);
20624 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
20625 it
->max_extra_line_spacing
);
20627 /* End of this display line if row is continued. */
20628 if (row
->continued_p
|| row
->ends_at_zv_p
)
20633 /* Is this a line end? If yes, we're also done, after making
20634 sure that a non-default face is extended up to the right
20635 margin of the window. */
20636 if (ITERATOR_AT_END_OF_LINE_P (it
))
20638 int used_before
= row
->used
[TEXT_AREA
];
20640 row
->ends_in_newline_from_string_p
= STRINGP (it
->object
);
20642 /* Add a space at the end of the line that is used to
20643 display the cursor there. */
20644 if (!IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20645 append_space_for_newline (it
, 0);
20647 /* Extend the face to the end of the line. */
20648 extend_face_to_end_of_line (it
);
20650 /* Make sure we have the position. */
20651 if (used_before
== 0)
20652 row
->glyphs
[TEXT_AREA
]->charpos
= CHARPOS (it
->position
);
20654 /* Record the position of the newline, for use in
20656 it
->eol_pos
= it
->current
.pos
;
20658 /* Consume the line end. This skips over invisible lines. */
20659 set_iterator_to_next (it
, 1);
20660 it
->continuation_lines_width
= 0;
20664 /* Proceed with next display element. Note that this skips
20665 over lines invisible because of selective display. */
20666 set_iterator_to_next (it
, 1);
20668 /* If we truncate lines, we are done when the last displayed
20669 glyphs reach past the right margin of the window. */
20670 if (it
->line_wrap
== TRUNCATE
20671 && ((FRAME_WINDOW_P (it
->f
)
20672 /* Images are preprocessed in produce_image_glyph such
20673 that they are cropped at the right edge of the
20674 window, so an image glyph will always end exactly at
20675 last_visible_x, even if there's no right fringe. */
20676 && ((row
->reversed_p
20677 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20678 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
))
20679 || it
->what
== IT_IMAGE
))
20680 ? (it
->current_x
>= it
->last_visible_x
)
20681 : (it
->current_x
> it
->last_visible_x
)))
20683 /* Maybe add truncation glyphs. */
20684 if (!FRAME_WINDOW_P (it
->f
)
20685 || (row
->reversed_p
20686 ? WINDOW_LEFT_FRINGE_WIDTH (it
->w
)
20687 : WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)) == 0)
20691 if (!row
->reversed_p
)
20693 for (i
= row
->used
[TEXT_AREA
] - 1; i
> 0; --i
)
20694 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20699 for (i
= 0; i
< row
->used
[TEXT_AREA
]; i
++)
20700 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][i
]))
20702 /* Remove any padding glyphs at the front of ROW, to
20703 make room for the truncation glyphs we will be
20704 adding below. The loop below always inserts at
20705 least one truncation glyph, so also remove the
20706 last glyph added to ROW. */
20707 unproduce_glyphs (it
, i
+ 1);
20708 /* Adjust i for the loop below. */
20709 i
= row
->used
[TEXT_AREA
] - (i
+ 1);
20712 /* produce_special_glyphs overwrites the last glyph, so
20713 we don't want that if we want to keep that last
20714 glyph, which means it's an image. */
20715 if (it
->current_x
> it
->last_visible_x
)
20717 it
->current_x
= x_before
;
20718 if (!FRAME_WINDOW_P (it
->f
))
20720 for (n
= row
->used
[TEXT_AREA
]; i
< n
; ++i
)
20722 row
->used
[TEXT_AREA
] = i
;
20723 produce_special_glyphs (it
, IT_TRUNCATION
);
20728 row
->used
[TEXT_AREA
] = i
;
20729 produce_special_glyphs (it
, IT_TRUNCATION
);
20731 it
->hpos
= hpos_before
;
20734 else if (IT_OVERFLOW_NEWLINE_INTO_FRINGE (it
))
20736 /* Don't truncate if we can overflow newline into fringe. */
20737 if (!get_next_display_element (it
))
20739 it
->continuation_lines_width
= 0;
20740 row
->ends_at_zv_p
= 1;
20741 row
->exact_window_width_line_p
= 1;
20744 if (ITERATOR_AT_END_OF_LINE_P (it
))
20746 row
->exact_window_width_line_p
= 1;
20747 goto at_end_of_line
;
20749 it
->current_x
= x_before
;
20750 it
->hpos
= hpos_before
;
20753 row
->truncated_on_right_p
= 1;
20754 it
->continuation_lines_width
= 0;
20755 reseat_at_next_visible_line_start (it
, 0);
20756 /* We insist below that IT's position be at ZV because in
20757 bidi-reordered lines the character at visible line start
20758 might not be the character that follows the newline in
20759 the logical order. */
20760 if (IT_BYTEPOS (*it
) > BEG_BYTE
)
20761 row
->ends_at_zv_p
=
20762 IT_BYTEPOS (*it
) >= ZV_BYTE
&& FETCH_BYTE (ZV_BYTE
- 1) != '\n';
20764 row
->ends_at_zv_p
= false;
20770 bidi_unshelve_cache (wrap_data
, 1);
20772 /* If line is not empty and hscrolled, maybe insert truncation glyphs
20773 at the left window margin. */
20774 if (it
->first_visible_x
20775 && IT_CHARPOS (*it
) != CHARPOS (row
->start
.pos
))
20777 if (!FRAME_WINDOW_P (it
->f
)
20778 || (((row
->reversed_p
20779 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
20780 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
20781 /* Don't let insert_left_trunc_glyphs overwrite the
20782 first glyph of the row if it is an image. */
20783 && row
->glyphs
[TEXT_AREA
]->type
!= IMAGE_GLYPH
))
20784 insert_left_trunc_glyphs (it
);
20785 row
->truncated_on_left_p
= 1;
20788 /* Remember the position at which this line ends.
20790 BIDI Note: any code that needs MATRIX_ROW_START/END_CHARPOS
20791 cannot be before the call to find_row_edges below, since that is
20792 where these positions are determined. */
20793 row
->end
= it
->current
;
20796 row
->minpos
= row
->start
.pos
;
20797 row
->maxpos
= row
->end
.pos
;
20801 /* ROW->minpos and ROW->maxpos must be the smallest and
20802 `1 + the largest' buffer positions in ROW. But if ROW was
20803 bidi-reordered, these two positions can be anywhere in the
20804 row, so we must determine them now. */
20805 find_row_edges (it
, row
, min_pos
, min_bpos
, max_pos
, max_bpos
);
20808 /* If the start of this line is the overlay arrow-position, then
20809 mark this glyph row as the one containing the overlay arrow.
20810 This is clearly a mess with variable size fonts. It would be
20811 better to let it be displayed like cursors under X. */
20812 if ((MATRIX_ROW_DISPLAYS_TEXT_P (row
) || !overlay_arrow_seen
)
20813 && (overlay_arrow_string
= overlay_arrow_at_row (it
, row
),
20814 !NILP (overlay_arrow_string
)))
20816 /* Overlay arrow in window redisplay is a fringe bitmap. */
20817 if (STRINGP (overlay_arrow_string
))
20819 struct glyph_row
*arrow_row
20820 = get_overlay_arrow_glyph_row (it
->w
, overlay_arrow_string
);
20821 struct glyph
*glyph
= arrow_row
->glyphs
[TEXT_AREA
];
20822 struct glyph
*arrow_end
= glyph
+ arrow_row
->used
[TEXT_AREA
];
20823 struct glyph
*p
= row
->glyphs
[TEXT_AREA
];
20824 struct glyph
*p2
, *end
;
20826 /* Copy the arrow glyphs. */
20827 while (glyph
< arrow_end
)
20830 /* Throw away padding glyphs. */
20832 end
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
];
20833 while (p2
< end
&& CHAR_GLYPH_PADDING_P (*p2
))
20839 row
->used
[TEXT_AREA
] = p2
- row
->glyphs
[TEXT_AREA
];
20844 eassert (INTEGERP (overlay_arrow_string
));
20845 row
->overlay_arrow_bitmap
= XINT (overlay_arrow_string
);
20847 overlay_arrow_seen
= 1;
20850 /* Highlight trailing whitespace. */
20851 if (!NILP (Vshow_trailing_whitespace
))
20852 highlight_trailing_whitespace (it
->f
, it
->glyph_row
);
20854 /* Compute pixel dimensions of this line. */
20855 compute_line_metrics (it
);
20857 /* Implementation note: No changes in the glyphs of ROW or in their
20858 faces can be done past this point, because compute_line_metrics
20859 computes ROW's hash value and stores it within the glyph_row
20862 /* Record whether this row ends inside an ellipsis. */
20863 row
->ends_in_ellipsis_p
20864 = (it
->method
== GET_FROM_DISPLAY_VECTOR
20865 && it
->ellipsis_p
);
20867 /* Save fringe bitmaps in this row. */
20868 row
->left_user_fringe_bitmap
= it
->left_user_fringe_bitmap
;
20869 row
->left_user_fringe_face_id
= it
->left_user_fringe_face_id
;
20870 row
->right_user_fringe_bitmap
= it
->right_user_fringe_bitmap
;
20871 row
->right_user_fringe_face_id
= it
->right_user_fringe_face_id
;
20873 it
->left_user_fringe_bitmap
= 0;
20874 it
->left_user_fringe_face_id
= 0;
20875 it
->right_user_fringe_bitmap
= 0;
20876 it
->right_user_fringe_face_id
= 0;
20878 /* Maybe set the cursor. */
20879 cvpos
= it
->w
->cursor
.vpos
;
20881 /* In bidi-reordered rows, keep checking for proper cursor
20882 position even if one has been found already, because buffer
20883 positions in such rows change non-linearly with ROW->VPOS,
20884 when a line is continued. One exception: when we are at ZV,
20885 display cursor on the first suitable glyph row, since all
20886 the empty rows after that also have their position set to ZV. */
20887 /* FIXME: Revisit this when glyph ``spilling'' in continuation
20888 lines' rows is implemented for bidi-reordered rows. */
20890 && !MATRIX_ROW (it
->w
->desired_matrix
, cvpos
)->ends_at_zv_p
))
20891 && PT
>= MATRIX_ROW_START_CHARPOS (row
)
20892 && PT
<= MATRIX_ROW_END_CHARPOS (row
)
20893 && cursor_row_p (row
))
20894 set_cursor_from_row (it
->w
, row
, it
->w
->desired_matrix
, 0, 0, 0, 0);
20896 /* Prepare for the next line. This line starts horizontally at (X
20897 HPOS) = (0 0). Vertical positions are incremented. As a
20898 convenience for the caller, IT->glyph_row is set to the next
20900 it
->current_x
= it
->hpos
= 0;
20901 it
->current_y
+= row
->height
;
20902 SET_TEXT_POS (it
->eol_pos
, 0, 0);
20905 /* The next row should by default use the same value of the
20906 reversed_p flag as this one. set_iterator_to_next decides when
20907 it's a new paragraph, and PRODUCE_GLYPHS recomputes the value of
20908 the flag accordingly. */
20909 if (it
->glyph_row
< MATRIX_BOTTOM_TEXT_ROW (it
->w
->desired_matrix
, it
->w
))
20910 it
->glyph_row
->reversed_p
= row
->reversed_p
;
20911 it
->start
= row
->end
;
20912 return MATRIX_ROW_DISPLAYS_TEXT_P (row
);
20914 #undef RECORD_MAX_MIN_POS
20917 DEFUN ("current-bidi-paragraph-direction", Fcurrent_bidi_paragraph_direction
,
20918 Scurrent_bidi_paragraph_direction
, 0, 1, 0,
20919 doc
: /* Return paragraph direction at point in BUFFER.
20920 Value is either `left-to-right' or `right-to-left'.
20921 If BUFFER is omitted or nil, it defaults to the current buffer.
20923 Paragraph direction determines how the text in the paragraph is displayed.
20924 In left-to-right paragraphs, text begins at the left margin of the window
20925 and the reading direction is generally left to right. In right-to-left
20926 paragraphs, text begins at the right margin and is read from right to left.
20928 See also `bidi-paragraph-direction'. */)
20929 (Lisp_Object buffer
)
20931 struct buffer
*buf
= current_buffer
;
20932 struct buffer
*old
= buf
;
20934 if (! NILP (buffer
))
20936 CHECK_BUFFER (buffer
);
20937 buf
= XBUFFER (buffer
);
20940 if (NILP (BVAR (buf
, bidi_display_reordering
))
20941 || NILP (BVAR (buf
, enable_multibyte_characters
))
20942 /* When we are loading loadup.el, the character property tables
20943 needed for bidi iteration are not yet available. */
20944 || !NILP (Vpurify_flag
))
20945 return Qleft_to_right
;
20946 else if (!NILP (BVAR (buf
, bidi_paragraph_direction
)))
20947 return BVAR (buf
, bidi_paragraph_direction
);
20950 /* Determine the direction from buffer text. We could try to
20951 use current_matrix if it is up to date, but this seems fast
20952 enough as it is. */
20953 struct bidi_it itb
;
20954 ptrdiff_t pos
= BUF_PT (buf
);
20955 ptrdiff_t bytepos
= BUF_PT_BYTE (buf
);
20957 void *itb_data
= bidi_shelve_cache ();
20959 set_buffer_temp (buf
);
20960 /* bidi_paragraph_init finds the base direction of the paragraph
20961 by searching forward from paragraph start. We need the base
20962 direction of the current or _previous_ paragraph, so we need
20963 to make sure we are within that paragraph. To that end, find
20964 the previous non-empty line. */
20965 if (pos
>= ZV
&& pos
> BEGV
)
20966 DEC_BOTH (pos
, bytepos
);
20967 AUTO_STRING (trailing_white_space
, "[\f\t ]*\n");
20968 if (fast_looking_at (trailing_white_space
,
20969 pos
, bytepos
, ZV
, ZV_BYTE
, Qnil
) > 0)
20971 while ((c
= FETCH_BYTE (bytepos
)) == '\n'
20972 || c
== ' ' || c
== '\t' || c
== '\f')
20974 if (bytepos
<= BEGV_BYTE
)
20979 while (!CHAR_HEAD_P (FETCH_BYTE (bytepos
)))
20982 bidi_init_it (pos
, bytepos
, FRAME_WINDOW_P (SELECTED_FRAME ()), &itb
);
20983 itb
.paragraph_dir
= NEUTRAL_DIR
;
20984 itb
.string
.s
= NULL
;
20985 itb
.string
.lstring
= Qnil
;
20986 itb
.string
.bufpos
= 0;
20987 itb
.string
.from_disp_str
= 0;
20988 itb
.string
.unibyte
= 0;
20989 /* We have no window to use here for ignoring window-specific
20990 overlays. Using NULL for window pointer will cause
20991 compute_display_string_pos to use the current buffer. */
20993 bidi_paragraph_init (NEUTRAL_DIR
, &itb
, 1);
20994 bidi_unshelve_cache (itb_data
, 0);
20995 set_buffer_temp (old
);
20996 switch (itb
.paragraph_dir
)
20999 return Qleft_to_right
;
21002 return Qright_to_left
;
21010 DEFUN ("move-point-visually", Fmove_point_visually
,
21011 Smove_point_visually
, 1, 1, 0,
21012 doc
: /* Move point in the visual order in the specified DIRECTION.
21013 DIRECTION can be 1, meaning move to the right, or -1, which moves to the
21016 Value is the new character position of point. */)
21017 (Lisp_Object direction
)
21019 struct window
*w
= XWINDOW (selected_window
);
21020 struct buffer
*b
= XBUFFER (w
->contents
);
21021 struct glyph_row
*row
;
21023 Lisp_Object paragraph_dir
;
21025 #define ROW_GLYPH_NEWLINE_P(ROW,GLYPH) \
21026 (!(ROW)->continued_p \
21027 && INTEGERP ((GLYPH)->object) \
21028 && (GLYPH)->type == CHAR_GLYPH \
21029 && (GLYPH)->u.ch == ' ' \
21030 && (GLYPH)->charpos >= 0 \
21031 && !(GLYPH)->avoid_cursor_p)
21033 CHECK_NUMBER (direction
);
21034 dir
= XINT (direction
);
21040 /* If current matrix is up-to-date, we can use the information
21041 recorded in the glyphs, at least as long as the goal is on the
21043 if (w
->window_end_valid
21044 && !windows_or_buffers_changed
21046 && !b
->clip_changed
21047 && !b
->prevent_redisplay_optimizations_p
21048 && !window_outdated (w
)
21049 /* We rely below on the cursor coordinates to be up to date, but
21050 we cannot trust them if some command moved point since the
21051 last complete redisplay. */
21052 && w
->last_point
== BUF_PT (b
)
21053 && w
->cursor
.vpos
>= 0
21054 && w
->cursor
.vpos
< w
->current_matrix
->nrows
21055 && (row
= MATRIX_ROW (w
->current_matrix
, w
->cursor
.vpos
))->enabled_p
)
21057 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
21058 struct glyph
*e
= dir
> 0 ? g
+ row
->used
[TEXT_AREA
] : g
- 1;
21059 struct glyph
*gpt
= g
+ w
->cursor
.hpos
;
21061 for (g
= gpt
+ dir
; (dir
> 0 ? g
< e
: g
> e
); g
+= dir
)
21063 if (BUFFERP (g
->object
) && g
->charpos
!= PT
)
21065 SET_PT (g
->charpos
);
21066 w
->cursor
.vpos
= -1;
21067 return make_number (PT
);
21069 else if (!INTEGERP (g
->object
) && !EQ (g
->object
, gpt
->object
))
21073 if (BUFFERP (gpt
->object
))
21076 if ((gpt
->resolved_level
- row
->reversed_p
) % 2 == 0)
21077 new_pos
+= (row
->reversed_p
? -dir
: dir
);
21079 new_pos
-= (row
->reversed_p
? -dir
: dir
);
21081 else if (BUFFERP (g
->object
))
21082 new_pos
= g
->charpos
;
21086 w
->cursor
.vpos
= -1;
21087 return make_number (PT
);
21089 else if (ROW_GLYPH_NEWLINE_P (row
, g
))
21091 /* Glyphs inserted at the end of a non-empty line for
21092 positioning the cursor have zero charpos, so we must
21093 deduce the value of point by other means. */
21094 if (g
->charpos
> 0)
21095 SET_PT (g
->charpos
);
21096 else if (row
->ends_at_zv_p
&& PT
!= ZV
)
21098 else if (PT
!= MATRIX_ROW_END_CHARPOS (row
) - 1)
21099 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21102 w
->cursor
.vpos
= -1;
21103 return make_number (PT
);
21106 if (g
== e
|| INTEGERP (g
->object
))
21108 if (row
->truncated_on_left_p
|| row
->truncated_on_right_p
)
21109 goto simulate_display
;
21110 if (!row
->reversed_p
)
21114 if (row
< MATRIX_FIRST_TEXT_ROW (w
->current_matrix
)
21115 || row
> MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
21116 goto simulate_display
;
21120 if (row
->reversed_p
&& !row
->continued_p
)
21122 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21123 w
->cursor
.vpos
= -1;
21124 return make_number (PT
);
21126 g
= row
->glyphs
[TEXT_AREA
];
21127 e
= g
+ row
->used
[TEXT_AREA
];
21128 for ( ; g
< e
; g
++)
21130 if (BUFFERP (g
->object
)
21131 /* Empty lines have only one glyph, which stands
21132 for the newline, and whose charpos is the
21133 buffer position of the newline. */
21134 || ROW_GLYPH_NEWLINE_P (row
, g
)
21135 /* When the buffer ends in a newline, the line at
21136 EOB also has one glyph, but its charpos is -1. */
21137 || (row
->ends_at_zv_p
21138 && !row
->reversed_p
21139 && INTEGERP (g
->object
)
21140 && g
->type
== CHAR_GLYPH
21141 && g
->u
.ch
== ' '))
21143 if (g
->charpos
> 0)
21144 SET_PT (g
->charpos
);
21145 else if (!row
->reversed_p
21146 && row
->ends_at_zv_p
21151 w
->cursor
.vpos
= -1;
21152 return make_number (PT
);
21158 if (!row
->reversed_p
&& !row
->continued_p
)
21160 SET_PT (MATRIX_ROW_END_CHARPOS (row
) - 1);
21161 w
->cursor
.vpos
= -1;
21162 return make_number (PT
);
21164 e
= row
->glyphs
[TEXT_AREA
];
21165 g
= e
+ row
->used
[TEXT_AREA
] - 1;
21166 for ( ; g
>= e
; g
--)
21168 if (BUFFERP (g
->object
)
21169 || (ROW_GLYPH_NEWLINE_P (row
, g
)
21171 /* Empty R2L lines on GUI frames have the buffer
21172 position of the newline stored in the stretch
21174 || g
->type
== STRETCH_GLYPH
21175 || (row
->ends_at_zv_p
21177 && INTEGERP (g
->object
)
21178 && g
->type
== CHAR_GLYPH
21179 && g
->u
.ch
== ' '))
21181 if (g
->charpos
> 0)
21182 SET_PT (g
->charpos
);
21183 else if (row
->reversed_p
21184 && row
->ends_at_zv_p
21189 w
->cursor
.vpos
= -1;
21190 return make_number (PT
);
21199 /* If we wind up here, we failed to move by using the glyphs, so we
21200 need to simulate display instead. */
21203 paragraph_dir
= Fcurrent_bidi_paragraph_direction (w
->contents
);
21205 paragraph_dir
= Qleft_to_right
;
21206 if (EQ (paragraph_dir
, Qright_to_left
))
21208 if (PT
<= BEGV
&& dir
< 0)
21209 xsignal0 (Qbeginning_of_buffer
);
21210 else if (PT
>= ZV
&& dir
> 0)
21211 xsignal0 (Qend_of_buffer
);
21214 struct text_pos pt
;
21216 int pt_x
, target_x
, pixel_width
, pt_vpos
;
21218 bool overshoot_expected
= false;
21219 bool target_is_eol_p
= false;
21221 /* Setup the arena. */
21222 SET_TEXT_POS (pt
, PT
, PT_BYTE
);
21223 start_display (&it
, w
, pt
);
21225 if (it
.cmp_it
.id
< 0
21226 && it
.method
== GET_FROM_STRING
21227 && it
.area
== TEXT_AREA
21228 && it
.string_from_display_prop_p
21229 && (it
.sp
> 0 && it
.stack
[it
.sp
- 1].method
== GET_FROM_BUFFER
))
21230 overshoot_expected
= true;
21232 /* Find the X coordinate of point. We start from the beginning
21233 of this or previous line to make sure we are before point in
21234 the logical order (since the move_it_* functions can only
21237 reseat_at_previous_visible_line_start (&it
);
21238 it
.current_x
= it
.hpos
= it
.current_y
= it
.vpos
= 0;
21239 if (IT_CHARPOS (it
) != PT
)
21241 move_it_to (&it
, overshoot_expected
? PT
- 1 : PT
,
21242 -1, -1, -1, MOVE_TO_POS
);
21243 /* If we missed point because the character there is
21244 displayed out of a display vector that has more than one
21245 glyph, retry expecting overshoot. */
21246 if (it
.method
== GET_FROM_DISPLAY_VECTOR
21247 && it
.current
.dpvec_index
> 0
21248 && !overshoot_expected
)
21250 overshoot_expected
= true;
21253 else if (IT_CHARPOS (it
) != PT
&& !overshoot_expected
)
21254 move_it_in_display_line (&it
, PT
, -1, MOVE_TO_POS
);
21256 pt_x
= it
.current_x
;
21258 if (dir
> 0 || overshoot_expected
)
21260 struct glyph_row
*row
= it
.glyph_row
;
21262 /* When point is at beginning of line, we don't have
21263 information about the glyph there loaded into struct
21264 it. Calling get_next_display_element fixes that. */
21266 get_next_display_element (&it
);
21267 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21268 it
.glyph_row
= NULL
;
21269 PRODUCE_GLYPHS (&it
); /* compute it.pixel_width */
21270 it
.glyph_row
= row
;
21271 /* PRODUCE_GLYPHS advances it.current_x, so we must restore
21272 it, lest it will become out of sync with it's buffer
21274 it
.current_x
= pt_x
;
21277 at_eol_p
= ITERATOR_AT_END_OF_LINE_P (&it
);
21278 pixel_width
= it
.pixel_width
;
21279 if (overshoot_expected
&& at_eol_p
)
21281 else if (pixel_width
<= 0)
21284 /* If there's a display string (or something similar) at point,
21285 we are actually at the glyph to the left of point, so we need
21286 to correct the X coordinate. */
21287 if (overshoot_expected
)
21290 pt_x
+= pixel_width
* it
.bidi_it
.scan_dir
;
21292 pt_x
+= pixel_width
;
21295 /* Compute target X coordinate, either to the left or to the
21296 right of point. On TTY frames, all characters have the same
21297 pixel width of 1, so we can use that. On GUI frames we don't
21298 have an easy way of getting at the pixel width of the
21299 character to the left of point, so we use a different method
21300 of getting to that place. */
21302 target_x
= pt_x
+ pixel_width
;
21304 target_x
= pt_x
- (!FRAME_WINDOW_P (it
.f
)) * pixel_width
;
21306 /* Target X coordinate could be one line above or below the line
21307 of point, in which case we need to adjust the target X
21308 coordinate. Also, if moving to the left, we need to begin at
21309 the left edge of the point's screen line. */
21314 start_display (&it
, w
, pt
);
21315 reseat_at_previous_visible_line_start (&it
);
21316 it
.current_x
= it
.current_y
= it
.hpos
= 0;
21318 move_it_by_lines (&it
, pt_vpos
);
21322 move_it_by_lines (&it
, -1);
21323 target_x
= it
.last_visible_x
- !FRAME_WINDOW_P (it
.f
);
21324 target_is_eol_p
= true;
21325 /* Under word-wrap, we don't know the x coordinate of
21326 the last character displayed on the previous line,
21327 which immediately precedes the wrap point. To find
21328 out its x coordinate, we try moving to the right
21329 margin of the window, which will stop at the wrap
21330 point, and then reset target_x to point at the
21331 character that precedes the wrap point. This is not
21332 needed on GUI frames, because (see below) there we
21333 move from the left margin one grapheme cluster at a
21334 time, and stop when we hit the wrap point. */
21335 if (!FRAME_WINDOW_P (it
.f
) && it
.line_wrap
== WORD_WRAP
)
21337 void *it_data
= NULL
;
21340 SAVE_IT (it2
, it
, it_data
);
21341 move_it_in_display_line_to (&it
, ZV
, target_x
,
21342 MOVE_TO_POS
| MOVE_TO_X
);
21343 /* If we arrived at target_x, that _is_ the last
21344 character on the previous line. */
21345 if (it
.current_x
!= target_x
)
21346 target_x
= it
.current_x
- 1;
21347 RESTORE_IT (&it
, &it2
, it_data
);
21354 || (target_x
>= it
.last_visible_x
21355 && it
.line_wrap
!= TRUNCATE
))
21358 move_it_by_lines (&it
, 0);
21359 move_it_by_lines (&it
, 1);
21364 /* Move to the target X coordinate. */
21365 #ifdef HAVE_WINDOW_SYSTEM
21366 /* On GUI frames, as we don't know the X coordinate of the
21367 character to the left of point, moving point to the left
21368 requires walking, one grapheme cluster at a time, until we
21369 find ourself at a place immediately to the left of the
21370 character at point. */
21371 if (FRAME_WINDOW_P (it
.f
) && dir
< 0)
21373 struct text_pos new_pos
;
21374 enum move_it_result rc
= MOVE_X_REACHED
;
21376 if (it
.current_x
== 0)
21377 get_next_display_element (&it
);
21378 if (it
.what
== IT_COMPOSITION
)
21380 new_pos
.charpos
= it
.cmp_it
.charpos
;
21381 new_pos
.bytepos
= -1;
21384 new_pos
= it
.current
.pos
;
21386 while (it
.current_x
+ it
.pixel_width
<= target_x
21387 && (rc
== MOVE_X_REACHED
21388 /* Under word-wrap, move_it_in_display_line_to
21389 stops at correct coordinates, but sometimes
21390 returns MOVE_POS_MATCH_OR_ZV. */
21391 || (it
.line_wrap
== WORD_WRAP
21392 && rc
== MOVE_POS_MATCH_OR_ZV
)))
21394 int new_x
= it
.current_x
+ it
.pixel_width
;
21396 /* For composed characters, we want the position of the
21397 first character in the grapheme cluster (usually, the
21398 composition's base character), whereas it.current
21399 might give us the position of the _last_ one, e.g. if
21400 the composition is rendered in reverse due to bidi
21402 if (it
.what
== IT_COMPOSITION
)
21404 new_pos
.charpos
= it
.cmp_it
.charpos
;
21405 new_pos
.bytepos
= -1;
21408 new_pos
= it
.current
.pos
;
21409 if (new_x
== it
.current_x
)
21411 rc
= move_it_in_display_line_to (&it
, ZV
, new_x
,
21412 MOVE_TO_POS
| MOVE_TO_X
);
21413 if (ITERATOR_AT_END_OF_LINE_P (&it
) && !target_is_eol_p
)
21416 /* The previous position we saw in the loop is the one we
21418 if (new_pos
.bytepos
== -1)
21419 new_pos
.bytepos
= CHAR_TO_BYTE (new_pos
.charpos
);
21420 it
.current
.pos
= new_pos
;
21424 if (it
.current_x
!= target_x
)
21425 move_it_in_display_line_to (&it
, ZV
, target_x
, MOVE_TO_POS
| MOVE_TO_X
);
21427 /* When lines are truncated, the above loop will stop at the
21428 window edge. But we want to get to the end of line, even if
21429 it is beyond the window edge; automatic hscroll will then
21430 scroll the window to show point as appropriate. */
21431 if (target_is_eol_p
&& it
.line_wrap
== TRUNCATE
21432 && get_next_display_element (&it
))
21434 struct text_pos new_pos
= it
.current
.pos
;
21436 while (!ITERATOR_AT_END_OF_LINE_P (&it
))
21438 set_iterator_to_next (&it
, 0);
21439 if (it
.method
== GET_FROM_BUFFER
)
21440 new_pos
= it
.current
.pos
;
21441 if (!get_next_display_element (&it
))
21445 it
.current
.pos
= new_pos
;
21448 /* If we ended up in a display string that covers point, move to
21449 buffer position to the right in the visual order. */
21452 while (IT_CHARPOS (it
) == PT
)
21454 set_iterator_to_next (&it
, 0);
21455 if (!get_next_display_element (&it
))
21460 /* Move point to that position. */
21461 SET_PT_BOTH (IT_CHARPOS (it
), IT_BYTEPOS (it
));
21464 return make_number (PT
);
21466 #undef ROW_GLYPH_NEWLINE_P
21469 DEFUN ("bidi-resolved-levels", Fbidi_resolved_levels
,
21470 Sbidi_resolved_levels
, 0, 1, 0,
21471 doc
: /* Return the resolved bidirectional levels of characters at VPOS.
21473 The resolved levels are produced by the Emacs bidi reordering engine
21474 that implements the UBA, the Unicode Bidirectional Algorithm. Please
21475 read the Unicode Standard Annex 9 (UAX#9) for background information
21476 about these levels.
21478 VPOS is the zero-based number of the current window's screen line
21479 for which to produce the resolved levels. If VPOS is nil or omitted,
21480 it defaults to the screen line of point. If the window displays a
21481 header line, VPOS of zero will report on the header line, and first
21482 line of text in the window will have VPOS of 1.
21484 Value is an array of resolved levels, indexed by glyph number.
21485 Glyphs are numbered from zero starting from the beginning of the
21486 screen line, i.e. the left edge of the window for left-to-right lines
21487 and from the right edge for right-to-left lines. The resolved levels
21488 are produced only for the window's text area; text in display margins
21491 If the selected window's display is not up-to-date, or if the specified
21492 screen line does not display text, this function returns nil. It is
21493 highly recommended to bind this function to some simple key, like F8,
21494 in order to avoid these problems.
21496 This function exists mainly for testing the correctness of the
21497 Emacs UBA implementation, in particular with the test suite. */)
21500 struct window
*w
= XWINDOW (selected_window
);
21501 struct buffer
*b
= XBUFFER (w
->contents
);
21503 struct glyph_row
*row
;
21507 int d1
, d2
, d3
, d4
, d5
;
21509 pos_visible_p (w
, PT
, &d1
, &d2
, &d3
, &d4
, &d5
, &nrow
);
21513 CHECK_NUMBER_COERCE_MARKER (vpos
);
21514 nrow
= XINT (vpos
);
21517 /* We require up-to-date glyph matrix for this window. */
21518 if (w
->window_end_valid
21519 && !windows_or_buffers_changed
21521 && !b
->clip_changed
21522 && !b
->prevent_redisplay_optimizations_p
21523 && !window_outdated (w
)
21525 && nrow
< w
->current_matrix
->nrows
21526 && (row
= MATRIX_ROW (w
->current_matrix
, nrow
))->enabled_p
21527 && MATRIX_ROW_DISPLAYS_TEXT_P (row
))
21529 struct glyph
*g
, *e
, *g1
;
21531 Lisp_Object levels
;
21533 if (!row
->reversed_p
) /* Left-to-right glyph row. */
21535 g
= g1
= row
->glyphs
[TEXT_AREA
];
21536 e
= g
+ row
->used
[TEXT_AREA
];
21538 /* Skip over glyphs at the start of the row that was
21539 generated by redisplay for its own needs. */
21541 && INTEGERP (g
->object
)
21546 /* Count the "interesting" glyphs in this row. */
21547 for (nglyphs
= 0; g
< e
&& !INTEGERP (g
->object
); g
++)
21550 /* Create and fill the array. */
21551 levels
= make_uninit_vector (nglyphs
);
21552 for (i
= 0; g1
< g
; i
++, g1
++)
21553 ASET (levels
, i
, make_number (g1
->resolved_level
));
21555 else /* Right-to-left glyph row. */
21557 g
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
21558 e
= row
->glyphs
[TEXT_AREA
] - 1;
21560 && INTEGERP (g
->object
)
21564 for (nglyphs
= 0; g
> e
&& !INTEGERP (g
->object
); g
--)
21566 levels
= make_uninit_vector (nglyphs
);
21567 for (i
= 0; g1
> g
; i
++, g1
--)
21568 ASET (levels
, i
, make_number (g1
->resolved_level
));
21578 /***********************************************************************
21580 ***********************************************************************/
21582 /* Redisplay the menu bar in the frame for window W.
21584 The menu bar of X frames that don't have X toolkit support is
21585 displayed in a special window W->frame->menu_bar_window.
21587 The menu bar of terminal frames is treated specially as far as
21588 glyph matrices are concerned. Menu bar lines are not part of
21589 windows, so the update is done directly on the frame matrix rows
21590 for the menu bar. */
21593 display_menu_bar (struct window
*w
)
21595 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
21600 /* Don't do all this for graphical frames. */
21602 if (FRAME_W32_P (f
))
21605 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21611 if (FRAME_NS_P (f
))
21613 #endif /* HAVE_NS */
21615 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
21616 eassert (!FRAME_WINDOW_P (f
));
21617 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
, MENU_FACE_ID
);
21618 it
.first_visible_x
= 0;
21619 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21620 #elif defined (HAVE_X_WINDOWS) /* X without toolkit. */
21621 if (FRAME_WINDOW_P (f
))
21623 /* Menu bar lines are displayed in the desired matrix of the
21624 dummy window menu_bar_window. */
21625 struct window
*menu_w
;
21626 menu_w
= XWINDOW (f
->menu_bar_window
);
21627 init_iterator (&it
, menu_w
, -1, -1, menu_w
->desired_matrix
->rows
,
21629 it
.first_visible_x
= 0;
21630 it
.last_visible_x
= FRAME_PIXEL_WIDTH (f
);
21633 #endif /* not USE_X_TOOLKIT and not USE_GTK */
21635 /* This is a TTY frame, i.e. character hpos/vpos are used as
21637 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
,
21639 it
.first_visible_x
= 0;
21640 it
.last_visible_x
= FRAME_COLS (f
);
21643 /* FIXME: This should be controlled by a user option. See the
21644 comments in redisplay_tool_bar and display_mode_line about
21646 it
.paragraph_embedding
= L2R
;
21648 /* Clear all rows of the menu bar. */
21649 for (i
= 0; i
< FRAME_MENU_BAR_LINES (f
); ++i
)
21651 struct glyph_row
*row
= it
.glyph_row
+ i
;
21652 clear_glyph_row (row
);
21653 row
->enabled_p
= true;
21654 row
->full_width_p
= 1;
21655 row
->reversed_p
= false;
21658 /* Display all items of the menu bar. */
21659 items
= FRAME_MENU_BAR_ITEMS (it
.f
);
21660 for (i
= 0; i
< ASIZE (items
); i
+= 4)
21662 Lisp_Object string
;
21664 /* Stop at nil string. */
21665 string
= AREF (items
, i
+ 1);
21669 /* Remember where item was displayed. */
21670 ASET (items
, i
+ 3, make_number (it
.hpos
));
21672 /* Display the item, pad with one space. */
21673 if (it
.current_x
< it
.last_visible_x
)
21674 display_string (NULL
, string
, Qnil
, 0, 0, &it
,
21675 SCHARS (string
) + 1, 0, 0, -1);
21678 /* Fill out the line with spaces. */
21679 if (it
.current_x
< it
.last_visible_x
)
21680 display_string ("", Qnil
, Qnil
, 0, 0, &it
, -1, 0, 0, -1);
21682 /* Compute the total height of the lines. */
21683 compute_line_metrics (&it
);
21686 /* Deep copy of a glyph row, including the glyphs. */
21688 deep_copy_glyph_row (struct glyph_row
*to
, struct glyph_row
*from
)
21690 struct glyph
*pointers
[1 + LAST_AREA
];
21691 int to_used
= to
->used
[TEXT_AREA
];
21693 /* Save glyph pointers of TO. */
21694 memcpy (pointers
, to
->glyphs
, sizeof to
->glyphs
);
21696 /* Do a structure assignment. */
21699 /* Restore original glyph pointers of TO. */
21700 memcpy (to
->glyphs
, pointers
, sizeof to
->glyphs
);
21702 /* Copy the glyphs. */
21703 memcpy (to
->glyphs
[TEXT_AREA
], from
->glyphs
[TEXT_AREA
],
21704 min (from
->used
[TEXT_AREA
], to_used
) * sizeof (struct glyph
));
21706 /* If we filled only part of the TO row, fill the rest with
21707 space_glyph (which will display as empty space). */
21708 if (to_used
> from
->used
[TEXT_AREA
])
21709 fill_up_frame_row_with_spaces (to
, to_used
);
21712 /* Display one menu item on a TTY, by overwriting the glyphs in the
21713 frame F's desired glyph matrix with glyphs produced from the menu
21714 item text. Called from term.c to display TTY drop-down menus one
21717 ITEM_TEXT is the menu item text as a C string.
21719 FACE_ID is the face ID to be used for this menu item. FACE_ID
21720 could specify one of 3 faces: a face for an enabled item, a face
21721 for a disabled item, or a face for a selected item.
21723 X and Y are coordinates of the first glyph in the frame's desired
21724 matrix to be overwritten by the menu item. Since this is a TTY, Y
21725 is the zero-based number of the glyph row and X is the zero-based
21726 glyph number in the row, starting from left, where to start
21727 displaying the item.
21729 SUBMENU non-zero means this menu item drops down a submenu, which
21730 should be indicated by displaying a proper visual cue after the
21734 display_tty_menu_item (const char *item_text
, int width
, int face_id
,
21735 int x
, int y
, int submenu
)
21738 struct frame
*f
= SELECTED_FRAME ();
21739 struct window
*w
= XWINDOW (f
->selected_window
);
21740 int saved_used
, saved_truncated
, saved_width
, saved_reversed
;
21741 struct glyph_row
*row
;
21742 size_t item_len
= strlen (item_text
);
21744 eassert (FRAME_TERMCAP_P (f
));
21746 /* Don't write beyond the matrix's last row. This can happen for
21747 TTY screens that are not high enough to show the entire menu.
21748 (This is actually a bit of defensive programming, as
21749 tty_menu_display already limits the number of menu items to one
21750 less than the number of screen lines.) */
21751 if (y
>= f
->desired_matrix
->nrows
)
21754 init_iterator (&it
, w
, -1, -1, f
->desired_matrix
->rows
+ y
, MENU_FACE_ID
);
21755 it
.first_visible_x
= 0;
21756 it
.last_visible_x
= FRAME_COLS (f
) - 1;
21757 row
= it
.glyph_row
;
21758 /* Start with the row contents from the current matrix. */
21759 deep_copy_glyph_row (row
, f
->current_matrix
->rows
+ y
);
21760 saved_width
= row
->full_width_p
;
21761 row
->full_width_p
= 1;
21762 saved_reversed
= row
->reversed_p
;
21763 row
->reversed_p
= 0;
21764 row
->enabled_p
= true;
21766 /* Arrange for the menu item glyphs to start at (X,Y) and have the
21768 eassert (x
< f
->desired_matrix
->matrix_w
);
21769 it
.current_x
= it
.hpos
= x
;
21770 it
.current_y
= it
.vpos
= y
;
21771 saved_used
= row
->used
[TEXT_AREA
];
21772 saved_truncated
= row
->truncated_on_right_p
;
21773 row
->used
[TEXT_AREA
] = x
;
21774 it
.face_id
= face_id
;
21775 it
.line_wrap
= TRUNCATE
;
21777 /* FIXME: This should be controlled by a user option. See the
21778 comments in redisplay_tool_bar and display_mode_line about this.
21779 Also, if paragraph_embedding could ever be R2L, changes will be
21780 needed to avoid shifting to the right the row characters in
21781 term.c:append_glyph. */
21782 it
.paragraph_embedding
= L2R
;
21784 /* Pad with a space on the left. */
21785 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 1, 0, FRAME_COLS (f
) - 1, -1);
21787 /* Display the menu item, pad with spaces to WIDTH. */
21790 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21791 item_len
, 0, FRAME_COLS (f
) - 1, -1);
21793 /* Indicate with " >" that there's a submenu. */
21794 display_string (" >", Qnil
, Qnil
, 0, 0, &it
, width
, 0,
21795 FRAME_COLS (f
) - 1, -1);
21798 display_string (item_text
, Qnil
, Qnil
, 0, 0, &it
,
21799 width
, 0, FRAME_COLS (f
) - 1, -1);
21801 row
->used
[TEXT_AREA
] = max (saved_used
, row
->used
[TEXT_AREA
]);
21802 row
->truncated_on_right_p
= saved_truncated
;
21803 row
->hash
= row_hash (row
);
21804 row
->full_width_p
= saved_width
;
21805 row
->reversed_p
= saved_reversed
;
21808 /***********************************************************************
21810 ***********************************************************************/
21812 /* Redisplay mode lines in the window tree whose root is WINDOW. If
21813 FORCE is non-zero, redisplay mode lines unconditionally.
21814 Otherwise, redisplay only mode lines that are garbaged. Value is
21815 the number of windows whose mode lines were redisplayed. */
21818 redisplay_mode_lines (Lisp_Object window
, bool force
)
21822 while (!NILP (window
))
21824 struct window
*w
= XWINDOW (window
);
21826 if (WINDOWP (w
->contents
))
21827 nwindows
+= redisplay_mode_lines (w
->contents
, force
);
21829 || FRAME_GARBAGED_P (XFRAME (w
->frame
))
21830 || !MATRIX_MODE_LINE_ROW (w
->current_matrix
)->enabled_p
)
21832 struct text_pos lpoint
;
21833 struct buffer
*old
= current_buffer
;
21835 /* Set the window's buffer for the mode line display. */
21836 SET_TEXT_POS (lpoint
, PT
, PT_BYTE
);
21837 set_buffer_internal_1 (XBUFFER (w
->contents
));
21839 /* Point refers normally to the selected window. For any
21840 other window, set up appropriate value. */
21841 if (!EQ (window
, selected_window
))
21843 struct text_pos pt
;
21845 CLIP_TEXT_POS_FROM_MARKER (pt
, w
->pointm
);
21846 TEMP_SET_PT_BOTH (CHARPOS (pt
), BYTEPOS (pt
));
21849 /* Display mode lines. */
21850 clear_glyph_matrix (w
->desired_matrix
);
21851 if (display_mode_lines (w
))
21854 /* Restore old settings. */
21855 set_buffer_internal_1 (old
);
21856 TEMP_SET_PT_BOTH (CHARPOS (lpoint
), BYTEPOS (lpoint
));
21866 /* Display the mode and/or header line of window W. Value is the
21867 sum number of mode lines and header lines displayed. */
21870 display_mode_lines (struct window
*w
)
21872 Lisp_Object old_selected_window
= selected_window
;
21873 Lisp_Object old_selected_frame
= selected_frame
;
21874 Lisp_Object new_frame
= w
->frame
;
21875 Lisp_Object old_frame_selected_window
= XFRAME (new_frame
)->selected_window
;
21878 selected_frame
= new_frame
;
21879 /* FIXME: If we were to allow the mode-line's computation changing the buffer
21880 or window's point, then we'd need select_window_1 here as well. */
21881 XSETWINDOW (selected_window
, w
);
21882 XFRAME (new_frame
)->selected_window
= selected_window
;
21884 /* These will be set while the mode line specs are processed. */
21885 line_number_displayed
= 0;
21886 w
->column_number_displayed
= -1;
21888 if (WINDOW_WANTS_MODELINE_P (w
))
21890 struct window
*sel_w
= XWINDOW (old_selected_window
);
21892 /* Select mode line face based on the real selected window. */
21893 display_mode_line (w
, CURRENT_MODE_LINE_FACE_ID_3 (sel_w
, sel_w
, w
),
21894 BVAR (current_buffer
, mode_line_format
));
21898 if (WINDOW_WANTS_HEADER_LINE_P (w
))
21900 display_mode_line (w
, HEADER_LINE_FACE_ID
,
21901 BVAR (current_buffer
, header_line_format
));
21905 XFRAME (new_frame
)->selected_window
= old_frame_selected_window
;
21906 selected_frame
= old_selected_frame
;
21907 selected_window
= old_selected_window
;
21909 w
->must_be_updated_p
= true;
21914 /* Display mode or header line of window W. FACE_ID specifies which
21915 line to display; it is either MODE_LINE_FACE_ID or
21916 HEADER_LINE_FACE_ID. FORMAT is the mode/header line format to
21917 display. Value is the pixel height of the mode/header line
21921 display_mode_line (struct window
*w
, enum face_id face_id
, Lisp_Object format
)
21925 ptrdiff_t count
= SPECPDL_INDEX ();
21927 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
21928 /* Don't extend on a previously drawn mode-line.
21929 This may happen if called from pos_visible_p. */
21930 it
.glyph_row
->enabled_p
= false;
21931 prepare_desired_row (w
, it
.glyph_row
, true);
21933 it
.glyph_row
->mode_line_p
= 1;
21935 /* FIXME: This should be controlled by a user option. But
21936 supporting such an option is not trivial, since the mode line is
21937 made up of many separate strings. */
21938 it
.paragraph_embedding
= L2R
;
21940 record_unwind_protect (unwind_format_mode_line
,
21941 format_mode_line_unwind_data (NULL
, NULL
, Qnil
, 0));
21943 mode_line_target
= MODE_LINE_DISPLAY
;
21945 /* Temporarily make frame's keyboard the current kboard so that
21946 kboard-local variables in the mode_line_format will get the right
21948 push_kboard (FRAME_KBOARD (it
.f
));
21949 record_unwind_save_match_data ();
21950 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
21953 unbind_to (count
, Qnil
);
21955 /* Fill up with spaces. */
21956 display_string (" ", Qnil
, Qnil
, 0, 0, &it
, 10000, -1, -1, 0);
21958 compute_line_metrics (&it
);
21959 it
.glyph_row
->full_width_p
= 1;
21960 it
.glyph_row
->continued_p
= 0;
21961 it
.glyph_row
->truncated_on_left_p
= 0;
21962 it
.glyph_row
->truncated_on_right_p
= 0;
21964 /* Make a 3D mode-line have a shadow at its right end. */
21965 face
= FACE_FROM_ID (it
.f
, face_id
);
21966 extend_face_to_end_of_line (&it
);
21967 if (face
->box
!= FACE_NO_BOX
)
21969 struct glyph
*last
= (it
.glyph_row
->glyphs
[TEXT_AREA
]
21970 + it
.glyph_row
->used
[TEXT_AREA
] - 1);
21971 last
->right_box_line_p
= 1;
21974 return it
.glyph_row
->height
;
21977 /* Move element ELT in LIST to the front of LIST.
21978 Return the updated list. */
21981 move_elt_to_front (Lisp_Object elt
, Lisp_Object list
)
21983 register Lisp_Object tail
, prev
;
21984 register Lisp_Object tem
;
21988 while (CONSP (tail
))
21994 /* Splice out the link TAIL. */
21996 list
= XCDR (tail
);
21998 Fsetcdr (prev
, XCDR (tail
));
22000 /* Now make it the first. */
22001 Fsetcdr (tail
, list
);
22006 tail
= XCDR (tail
);
22010 /* Not found--return unchanged LIST. */
22014 /* Contribute ELT to the mode line for window IT->w. How it
22015 translates into text depends on its data type.
22017 IT describes the display environment in which we display, as usual.
22019 DEPTH is the depth in recursion. It is used to prevent
22020 infinite recursion here.
22022 FIELD_WIDTH is the number of characters the display of ELT should
22023 occupy in the mode line, and PRECISION is the maximum number of
22024 characters to display from ELT's representation. See
22025 display_string for details.
22027 Returns the hpos of the end of the text generated by ELT.
22029 PROPS is a property list to add to any string we encounter.
22031 If RISKY is nonzero, remove (disregard) any properties in any string
22032 we encounter, and ignore :eval and :propertize.
22034 The global variable `mode_line_target' determines whether the
22035 output is passed to `store_mode_line_noprop',
22036 `store_mode_line_string', or `display_string'. */
22039 display_mode_element (struct it
*it
, int depth
, int field_width
, int precision
,
22040 Lisp_Object elt
, Lisp_Object props
, int risky
)
22042 int n
= 0, field
, prec
;
22047 elt
= build_string ("*too-deep*");
22051 switch (XTYPE (elt
))
22055 /* A string: output it and check for %-constructs within it. */
22057 ptrdiff_t offset
= 0;
22059 if (SCHARS (elt
) > 0
22060 && (!NILP (props
) || risky
))
22062 Lisp_Object oprops
, aelt
;
22063 oprops
= Ftext_properties_at (make_number (0), elt
);
22065 /* If the starting string's properties are not what
22066 we want, translate the string. Also, if the string
22067 is risky, do that anyway. */
22069 if (NILP (Fequal (props
, oprops
)) || risky
)
22071 /* If the starting string has properties,
22072 merge the specified ones onto the existing ones. */
22073 if (! NILP (oprops
) && !risky
)
22077 oprops
= Fcopy_sequence (oprops
);
22079 while (CONSP (tem
))
22081 oprops
= Fplist_put (oprops
, XCAR (tem
),
22082 XCAR (XCDR (tem
)));
22083 tem
= XCDR (XCDR (tem
));
22088 aelt
= Fassoc (elt
, mode_line_proptrans_alist
);
22089 if (! NILP (aelt
) && !NILP (Fequal (props
, XCDR (aelt
))))
22091 /* AELT is what we want. Move it to the front
22092 without consing. */
22094 mode_line_proptrans_alist
22095 = move_elt_to_front (aelt
, mode_line_proptrans_alist
);
22101 /* If AELT has the wrong props, it is useless.
22102 so get rid of it. */
22104 mode_line_proptrans_alist
22105 = Fdelq (aelt
, mode_line_proptrans_alist
);
22107 elt
= Fcopy_sequence (elt
);
22108 Fset_text_properties (make_number (0), Flength (elt
),
22110 /* Add this item to mode_line_proptrans_alist. */
22111 mode_line_proptrans_alist
22112 = Fcons (Fcons (elt
, props
),
22113 mode_line_proptrans_alist
);
22114 /* Truncate mode_line_proptrans_alist
22115 to at most 50 elements. */
22116 tem
= Fnthcdr (make_number (50),
22117 mode_line_proptrans_alist
);
22119 XSETCDR (tem
, Qnil
);
22128 prec
= precision
- n
;
22129 switch (mode_line_target
)
22131 case MODE_LINE_NOPROP
:
22132 case MODE_LINE_TITLE
:
22133 n
+= store_mode_line_noprop (SSDATA (elt
), -1, prec
);
22135 case MODE_LINE_STRING
:
22136 n
+= store_mode_line_string (NULL
, elt
, 1, 0, prec
, Qnil
);
22138 case MODE_LINE_DISPLAY
:
22139 n
+= display_string (NULL
, elt
, Qnil
, 0, 0, it
,
22140 0, prec
, 0, STRING_MULTIBYTE (elt
));
22147 /* Handle the non-literal case. */
22149 while ((precision
<= 0 || n
< precision
)
22150 && SREF (elt
, offset
) != 0
22151 && (mode_line_target
!= MODE_LINE_DISPLAY
22152 || it
->current_x
< it
->last_visible_x
))
22154 ptrdiff_t last_offset
= offset
;
22156 /* Advance to end of string or next format specifier. */
22157 while ((c
= SREF (elt
, offset
++)) != '\0' && c
!= '%')
22160 if (offset
- 1 != last_offset
)
22162 ptrdiff_t nchars
, nbytes
;
22164 /* Output to end of string or up to '%'. Field width
22165 is length of string. Don't output more than
22166 PRECISION allows us. */
22169 prec
= c_string_width (SDATA (elt
) + last_offset
,
22170 offset
- last_offset
, precision
- n
,
22173 switch (mode_line_target
)
22175 case MODE_LINE_NOPROP
:
22176 case MODE_LINE_TITLE
:
22177 n
+= store_mode_line_noprop (SSDATA (elt
) + last_offset
, 0, prec
);
22179 case MODE_LINE_STRING
:
22181 ptrdiff_t bytepos
= last_offset
;
22182 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22183 ptrdiff_t endpos
= (precision
<= 0
22184 ? string_byte_to_char (elt
, offset
)
22185 : charpos
+ nchars
);
22187 n
+= store_mode_line_string (NULL
,
22188 Fsubstring (elt
, make_number (charpos
),
22189 make_number (endpos
)),
22193 case MODE_LINE_DISPLAY
:
22195 ptrdiff_t bytepos
= last_offset
;
22196 ptrdiff_t charpos
= string_byte_to_char (elt
, bytepos
);
22198 if (precision
<= 0)
22199 nchars
= string_byte_to_char (elt
, offset
) - charpos
;
22200 n
+= display_string (NULL
, elt
, Qnil
, 0, charpos
,
22202 STRING_MULTIBYTE (elt
));
22207 else /* c == '%' */
22209 ptrdiff_t percent_position
= offset
;
22211 /* Get the specified minimum width. Zero means
22214 while ((c
= SREF (elt
, offset
++)) >= '0' && c
<= '9')
22215 field
= field
* 10 + c
- '0';
22217 /* Don't pad beyond the total padding allowed. */
22218 if (field_width
- n
> 0 && field
> field_width
- n
)
22219 field
= field_width
- n
;
22221 /* Note that either PRECISION <= 0 or N < PRECISION. */
22222 prec
= precision
- n
;
22225 n
+= display_mode_element (it
, depth
, field
, prec
,
22226 Vglobal_mode_string
, props
,
22231 ptrdiff_t bytepos
, charpos
;
22233 Lisp_Object string
;
22235 bytepos
= percent_position
;
22236 charpos
= (STRING_MULTIBYTE (elt
)
22237 ? string_byte_to_char (elt
, bytepos
)
22239 spec
= decode_mode_spec (it
->w
, c
, field
, &string
);
22240 multibyte
= STRINGP (string
) && STRING_MULTIBYTE (string
);
22242 switch (mode_line_target
)
22244 case MODE_LINE_NOPROP
:
22245 case MODE_LINE_TITLE
:
22246 n
+= store_mode_line_noprop (spec
, field
, prec
);
22248 case MODE_LINE_STRING
:
22250 Lisp_Object tem
= build_string (spec
);
22251 props
= Ftext_properties_at (make_number (charpos
), elt
);
22252 /* Should only keep face property in props */
22253 n
+= store_mode_line_string (NULL
, tem
, 0, field
, prec
, props
);
22256 case MODE_LINE_DISPLAY
:
22258 int nglyphs_before
, nwritten
;
22260 nglyphs_before
= it
->glyph_row
->used
[TEXT_AREA
];
22261 nwritten
= display_string (spec
, string
, elt
,
22266 /* Assign to the glyphs written above the
22267 string where the `%x' came from, position
22271 struct glyph
*glyph
22272 = (it
->glyph_row
->glyphs
[TEXT_AREA
]
22276 for (i
= 0; i
< nwritten
; ++i
)
22278 glyph
[i
].object
= elt
;
22279 glyph
[i
].charpos
= charpos
;
22296 /* A symbol: process the value of the symbol recursively
22297 as if it appeared here directly. Avoid error if symbol void.
22298 Special case: if value of symbol is a string, output the string
22301 register Lisp_Object tem
;
22303 /* If the variable is not marked as risky to set
22304 then its contents are risky to use. */
22305 if (NILP (Fget (elt
, Qrisky_local_variable
)))
22308 tem
= Fboundp (elt
);
22311 tem
= Fsymbol_value (elt
);
22312 /* If value is a string, output that string literally:
22313 don't check for % within it. */
22317 if (!EQ (tem
, elt
))
22319 /* Give up right away for nil or t. */
22329 register Lisp_Object car
, tem
;
22331 /* A cons cell: five distinct cases.
22332 If first element is :eval or :propertize, do something special.
22333 If first element is a string or a cons, process all the elements
22334 and effectively concatenate them.
22335 If first element is a negative number, truncate displaying cdr to
22336 at most that many characters. If positive, pad (with spaces)
22337 to at least that many characters.
22338 If first element is a symbol, process the cadr or caddr recursively
22339 according to whether the symbol's value is non-nil or nil. */
22341 if (EQ (car
, QCeval
))
22343 /* An element of the form (:eval FORM) means evaluate FORM
22344 and use the result as mode line elements. */
22349 if (CONSP (XCDR (elt
)))
22352 spec
= safe__eval (true, XCAR (XCDR (elt
)));
22353 n
+= display_mode_element (it
, depth
, field_width
- n
,
22354 precision
- n
, spec
, props
,
22358 else if (EQ (car
, QCpropertize
))
22360 /* An element of the form (:propertize ELT PROPS...)
22361 means display ELT but applying properties PROPS. */
22366 if (CONSP (XCDR (elt
)))
22367 n
+= display_mode_element (it
, depth
, field_width
- n
,
22368 precision
- n
, XCAR (XCDR (elt
)),
22369 XCDR (XCDR (elt
)), risky
);
22371 else if (SYMBOLP (car
))
22373 tem
= Fboundp (car
);
22377 /* elt is now the cdr, and we know it is a cons cell.
22378 Use its car if CAR has a non-nil value. */
22381 tem
= Fsymbol_value (car
);
22388 /* Symbol's value is nil (or symbol is unbound)
22389 Get the cddr of the original list
22390 and if possible find the caddr and use that. */
22394 else if (!CONSP (elt
))
22399 else if (INTEGERP (car
))
22401 register int lim
= XINT (car
);
22405 /* Negative int means reduce maximum width. */
22406 if (precision
<= 0)
22409 precision
= min (precision
, -lim
);
22413 /* Padding specified. Don't let it be more than
22414 current maximum. */
22416 lim
= min (precision
, lim
);
22418 /* If that's more padding than already wanted, queue it.
22419 But don't reduce padding already specified even if
22420 that is beyond the current truncation point. */
22421 field_width
= max (lim
, field_width
);
22425 else if (STRINGP (car
) || CONSP (car
))
22427 Lisp_Object halftail
= elt
;
22431 && (precision
<= 0 || n
< precision
))
22433 n
+= display_mode_element (it
, depth
,
22434 /* Do padding only after the last
22435 element in the list. */
22436 (! CONSP (XCDR (elt
))
22439 precision
- n
, XCAR (elt
),
22443 if ((len
& 1) == 0)
22444 halftail
= XCDR (halftail
);
22445 /* Check for cycle. */
22446 if (EQ (halftail
, elt
))
22455 elt
= build_string ("*invalid*");
22459 /* Pad to FIELD_WIDTH. */
22460 if (field_width
> 0 && n
< field_width
)
22462 switch (mode_line_target
)
22464 case MODE_LINE_NOPROP
:
22465 case MODE_LINE_TITLE
:
22466 n
+= store_mode_line_noprop ("", field_width
- n
, 0);
22468 case MODE_LINE_STRING
:
22469 n
+= store_mode_line_string ("", Qnil
, 0, field_width
- n
, 0, Qnil
);
22471 case MODE_LINE_DISPLAY
:
22472 n
+= display_string ("", Qnil
, Qnil
, 0, 0, it
, field_width
- n
,
22481 /* Store a mode-line string element in mode_line_string_list.
22483 If STRING is non-null, display that C string. Otherwise, the Lisp
22484 string LISP_STRING is displayed.
22486 FIELD_WIDTH is the minimum number of output glyphs to produce.
22487 If STRING has fewer characters than FIELD_WIDTH, pad to the right
22488 with spaces. FIELD_WIDTH <= 0 means don't pad.
22490 PRECISION is the maximum number of characters to output from
22491 STRING. PRECISION <= 0 means don't truncate the string.
22493 If COPY_STRING is non-zero, make a copy of LISP_STRING before adding
22494 properties to the string.
22496 PROPS are the properties to add to the string.
22497 The mode_line_string_face face property is always added to the string.
22501 store_mode_line_string (const char *string
, Lisp_Object lisp_string
, int copy_string
,
22502 int field_width
, int precision
, Lisp_Object props
)
22507 if (string
!= NULL
)
22509 len
= strlen (string
);
22510 if (precision
> 0 && len
> precision
)
22512 lisp_string
= make_string (string
, len
);
22514 props
= mode_line_string_face_prop
;
22515 else if (!NILP (mode_line_string_face
))
22517 Lisp_Object face
= Fplist_get (props
, Qface
);
22518 props
= Fcopy_sequence (props
);
22520 face
= mode_line_string_face
;
22522 face
= list2 (face
, mode_line_string_face
);
22523 props
= Fplist_put (props
, Qface
, face
);
22525 Fadd_text_properties (make_number (0), make_number (len
),
22526 props
, lisp_string
);
22530 len
= XFASTINT (Flength (lisp_string
));
22531 if (precision
> 0 && len
> precision
)
22534 lisp_string
= Fsubstring (lisp_string
, make_number (0), make_number (len
));
22537 if (!NILP (mode_line_string_face
))
22541 props
= Ftext_properties_at (make_number (0), lisp_string
);
22542 face
= Fplist_get (props
, Qface
);
22544 face
= mode_line_string_face
;
22546 face
= list2 (face
, mode_line_string_face
);
22547 props
= list2 (Qface
, face
);
22549 lisp_string
= Fcopy_sequence (lisp_string
);
22552 Fadd_text_properties (make_number (0), make_number (len
),
22553 props
, lisp_string
);
22558 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22562 if (field_width
> len
)
22564 field_width
-= len
;
22565 lisp_string
= Fmake_string (make_number (field_width
), make_number (' '));
22567 Fadd_text_properties (make_number (0), make_number (field_width
),
22568 props
, lisp_string
);
22569 mode_line_string_list
= Fcons (lisp_string
, mode_line_string_list
);
22577 DEFUN ("format-mode-line", Fformat_mode_line
, Sformat_mode_line
,
22579 doc
: /* Format a string out of a mode line format specification.
22580 First arg FORMAT specifies the mode line format (see `mode-line-format'
22581 for details) to use.
22583 By default, the format is evaluated for the currently selected window.
22585 Optional second arg FACE specifies the face property to put on all
22586 characters for which no face is specified. The value nil means the
22587 default face. The value t means whatever face the window's mode line
22588 currently uses (either `mode-line' or `mode-line-inactive',
22589 depending on whether the window is the selected window or not).
22590 An integer value means the value string has no text
22593 Optional third and fourth args WINDOW and BUFFER specify the window
22594 and buffer to use as the context for the formatting (defaults
22595 are the selected window and the WINDOW's buffer). */)
22596 (Lisp_Object format
, Lisp_Object face
,
22597 Lisp_Object window
, Lisp_Object buffer
)
22602 struct buffer
*old_buffer
= NULL
;
22604 int no_props
= INTEGERP (face
);
22605 ptrdiff_t count
= SPECPDL_INDEX ();
22607 int string_start
= 0;
22609 w
= decode_any_window (window
);
22610 XSETWINDOW (window
, w
);
22613 buffer
= w
->contents
;
22614 CHECK_BUFFER (buffer
);
22616 /* Make formatting the modeline a non-op when noninteractive, otherwise
22617 there will be problems later caused by a partially initialized frame. */
22618 if (NILP (format
) || noninteractive
)
22619 return empty_unibyte_string
;
22624 face_id
= (NILP (face
) || EQ (face
, Qdefault
)) ? DEFAULT_FACE_ID
22625 : EQ (face
, Qt
) ? (EQ (window
, selected_window
)
22626 ? MODE_LINE_FACE_ID
: MODE_LINE_INACTIVE_FACE_ID
)
22627 : EQ (face
, Qmode_line
) ? MODE_LINE_FACE_ID
22628 : EQ (face
, Qmode_line_inactive
) ? MODE_LINE_INACTIVE_FACE_ID
22629 : EQ (face
, Qheader_line
) ? HEADER_LINE_FACE_ID
22630 : EQ (face
, Qtool_bar
) ? TOOL_BAR_FACE_ID
22633 old_buffer
= current_buffer
;
22635 /* Save things including mode_line_proptrans_alist,
22636 and set that to nil so that we don't alter the outer value. */
22637 record_unwind_protect (unwind_format_mode_line
,
22638 format_mode_line_unwind_data
22639 (XFRAME (WINDOW_FRAME (w
)),
22640 old_buffer
, selected_window
, 1));
22641 mode_line_proptrans_alist
= Qnil
;
22643 Fselect_window (window
, Qt
);
22644 set_buffer_internal_1 (XBUFFER (buffer
));
22646 init_iterator (&it
, w
, -1, -1, NULL
, face_id
);
22650 mode_line_target
= MODE_LINE_NOPROP
;
22651 mode_line_string_face_prop
= Qnil
;
22652 mode_line_string_list
= Qnil
;
22653 string_start
= MODE_LINE_NOPROP_LEN (0);
22657 mode_line_target
= MODE_LINE_STRING
;
22658 mode_line_string_list
= Qnil
;
22659 mode_line_string_face
= face
;
22660 mode_line_string_face_prop
22661 = NILP (face
) ? Qnil
: list2 (Qface
, face
);
22664 push_kboard (FRAME_KBOARD (it
.f
));
22665 display_mode_element (&it
, 0, 0, 0, format
, Qnil
, 0);
22670 len
= MODE_LINE_NOPROP_LEN (string_start
);
22671 str
= make_string (mode_line_noprop_buf
+ string_start
, len
);
22675 mode_line_string_list
= Fnreverse (mode_line_string_list
);
22676 str
= Fmapconcat (intern ("identity"), mode_line_string_list
,
22677 empty_unibyte_string
);
22680 unbind_to (count
, Qnil
);
22684 /* Write a null-terminated, right justified decimal representation of
22685 the positive integer D to BUF using a minimal field width WIDTH. */
22688 pint2str (register char *buf
, register int width
, register ptrdiff_t d
)
22690 register char *p
= buf
;
22698 *p
++ = d
% 10 + '0';
22703 for (width
-= (int) (p
- buf
); width
> 0; --width
)
22714 /* Write a null-terminated, right justified decimal and "human
22715 readable" representation of the nonnegative integer D to BUF using
22716 a minimal field width WIDTH. D should be smaller than 999.5e24. */
22718 static const char power_letter
[] =
22732 pint2hrstr (char *buf
, int width
, ptrdiff_t d
)
22734 /* We aim to represent the nonnegative integer D as
22735 QUOTIENT.TENTHS * 10 ^ (3 * EXPONENT). */
22736 ptrdiff_t quotient
= d
;
22738 /* -1 means: do not use TENTHS. */
22742 /* Length of QUOTIENT.TENTHS as a string. */
22748 if (quotient
>= 1000)
22750 /* Scale to the appropriate EXPONENT. */
22753 remainder
= quotient
% 1000;
22757 while (quotient
>= 1000);
22759 /* Round to nearest and decide whether to use TENTHS or not. */
22762 tenths
= remainder
/ 100;
22763 if (remainder
% 100 >= 50)
22770 if (quotient
== 10)
22778 if (remainder
>= 500)
22780 if (quotient
< 999)
22791 /* Calculate the LENGTH of QUOTIENT.TENTHS as a string. */
22792 if (tenths
== -1 && quotient
<= 99)
22799 p
= psuffix
= buf
+ max (width
, length
);
22801 /* Print EXPONENT. */
22802 *psuffix
++ = power_letter
[exponent
];
22805 /* Print TENTHS. */
22808 *--p
= '0' + tenths
;
22812 /* Print QUOTIENT. */
22815 int digit
= quotient
% 10;
22816 *--p
= '0' + digit
;
22818 while ((quotient
/= 10) != 0);
22820 /* Print leading spaces. */
22825 /* Set a mnemonic character for coding_system (Lisp symbol) in BUF.
22826 If EOL_FLAG is 1, set also a mnemonic character for end-of-line
22827 type of CODING_SYSTEM. Return updated pointer into BUF. */
22829 static unsigned char invalid_eol_type
[] = "(*invalid*)";
22832 decode_mode_spec_coding (Lisp_Object coding_system
, register char *buf
, int eol_flag
)
22835 bool multibyte
= !NILP (BVAR (current_buffer
, enable_multibyte_characters
));
22836 const unsigned char *eol_str
;
22838 /* The EOL conversion we are using. */
22839 Lisp_Object eoltype
;
22841 val
= CODING_SYSTEM_SPEC (coding_system
);
22844 if (!VECTORP (val
)) /* Not yet decided. */
22846 *buf
++ = multibyte
? '-' : ' ';
22848 eoltype
= eol_mnemonic_undecided
;
22849 /* Don't mention EOL conversion if it isn't decided. */
22854 Lisp_Object eolvalue
;
22856 attrs
= AREF (val
, 0);
22857 eolvalue
= AREF (val
, 2);
22860 ? XFASTINT (CODING_ATTR_MNEMONIC (attrs
))
22865 /* The EOL conversion that is normal on this system. */
22867 if (NILP (eolvalue
)) /* Not yet decided. */
22868 eoltype
= eol_mnemonic_undecided
;
22869 else if (VECTORP (eolvalue
)) /* Not yet decided. */
22870 eoltype
= eol_mnemonic_undecided
;
22871 else /* eolvalue is Qunix, Qdos, or Qmac. */
22872 eoltype
= (EQ (eolvalue
, Qunix
)
22873 ? eol_mnemonic_unix
22874 : (EQ (eolvalue
, Qdos
) == 1
22875 ? eol_mnemonic_dos
: eol_mnemonic_mac
));
22881 /* Mention the EOL conversion if it is not the usual one. */
22882 if (STRINGP (eoltype
))
22884 eol_str
= SDATA (eoltype
);
22885 eol_str_len
= SBYTES (eoltype
);
22887 else if (CHARACTERP (eoltype
))
22889 int c
= XFASTINT (eoltype
);
22890 return buf
+ CHAR_STRING (c
, (unsigned char *) buf
);
22894 eol_str
= invalid_eol_type
;
22895 eol_str_len
= sizeof (invalid_eol_type
) - 1;
22897 memcpy (buf
, eol_str
, eol_str_len
);
22898 buf
+= eol_str_len
;
22904 /* Return a string for the output of a mode line %-spec for window W,
22905 generated by character C. FIELD_WIDTH > 0 means pad the string
22906 returned with spaces to that value. Return a Lisp string in
22907 *STRING if the resulting string is taken from that Lisp string.
22909 Note we operate on the current buffer for most purposes. */
22911 static char lots_of_dashes
[] = "--------------------------------------------------------------------------------------------------------------------------------------------";
22913 static const char *
22914 decode_mode_spec (struct window
*w
, register int c
, int field_width
,
22915 Lisp_Object
*string
)
22918 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
22919 char *decode_mode_spec_buf
= f
->decode_mode_spec_buffer
;
22920 /* We are going to use f->decode_mode_spec_buffer as the buffer to
22921 produce strings from numerical values, so limit preposterously
22922 large values of FIELD_WIDTH to avoid overrunning the buffer's
22923 end. The size of the buffer is enough for FRAME_MESSAGE_BUF_SIZE
22924 bytes plus the terminating null. */
22925 int width
= min (field_width
, FRAME_MESSAGE_BUF_SIZE (f
));
22926 struct buffer
*b
= current_buffer
;
22934 if (!NILP (BVAR (b
, read_only
)))
22936 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22941 /* This differs from %* only for a modified read-only buffer. */
22942 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22944 if (!NILP (BVAR (b
, read_only
)))
22949 /* This differs from %* in ignoring read-only-ness. */
22950 if (BUF_MODIFF (b
) > BUF_SAVE_MODIFF (b
))
22962 if (command_loop_level
> 5)
22964 p
= decode_mode_spec_buf
;
22965 for (i
= 0; i
< command_loop_level
; i
++)
22968 return decode_mode_spec_buf
;
22976 if (command_loop_level
> 5)
22978 p
= decode_mode_spec_buf
;
22979 for (i
= 0; i
< command_loop_level
; i
++)
22982 return decode_mode_spec_buf
;
22989 /* Let lots_of_dashes be a string of infinite length. */
22990 if (mode_line_target
== MODE_LINE_NOPROP
22991 || mode_line_target
== MODE_LINE_STRING
)
22993 if (field_width
<= 0
22994 || field_width
> sizeof (lots_of_dashes
))
22996 for (i
= 0; i
< FRAME_MESSAGE_BUF_SIZE (f
) - 1; ++i
)
22997 decode_mode_spec_buf
[i
] = '-';
22998 decode_mode_spec_buf
[i
] = '\0';
22999 return decode_mode_spec_buf
;
23002 return lots_of_dashes
;
23006 obj
= BVAR (b
, name
);
23010 /* %c and %l are ignored in `frame-title-format'.
23011 (In redisplay_internal, the frame title is drawn _before_ the
23012 windows are updated, so the stuff which depends on actual
23013 window contents (such as %l) may fail to render properly, or
23014 even crash emacs.) */
23015 if (mode_line_target
== MODE_LINE_TITLE
)
23019 ptrdiff_t col
= current_column ();
23020 w
->column_number_displayed
= col
;
23021 pint2str (decode_mode_spec_buf
, width
, col
);
23022 return decode_mode_spec_buf
;
23026 #if !defined SYSTEM_MALLOC && !defined HYBRID_MALLOC
23028 if (NILP (Vmemory_full
))
23031 return "!MEM FULL! ";
23038 /* %F displays the frame name. */
23039 if (!NILP (f
->title
))
23040 return SSDATA (f
->title
);
23041 if (f
->explicit_name
|| ! FRAME_WINDOW_P (f
))
23042 return SSDATA (f
->name
);
23046 obj
= BVAR (b
, filename
);
23051 ptrdiff_t size
= ZV
- BEGV
;
23052 pint2str (decode_mode_spec_buf
, width
, size
);
23053 return decode_mode_spec_buf
;
23058 ptrdiff_t size
= ZV
- BEGV
;
23059 pint2hrstr (decode_mode_spec_buf
, width
, size
);
23060 return decode_mode_spec_buf
;
23065 ptrdiff_t startpos
, startpos_byte
, line
, linepos
, linepos_byte
;
23066 ptrdiff_t topline
, nlines
, height
;
23069 /* %c and %l are ignored in `frame-title-format'. */
23070 if (mode_line_target
== MODE_LINE_TITLE
)
23073 startpos
= marker_position (w
->start
);
23074 startpos_byte
= marker_byte_position (w
->start
);
23075 height
= WINDOW_TOTAL_LINES (w
);
23077 /* If we decided that this buffer isn't suitable for line numbers,
23078 don't forget that too fast. */
23079 if (w
->base_line_pos
== -1)
23082 /* If the buffer is very big, don't waste time. */
23083 if (INTEGERP (Vline_number_display_limit
)
23084 && BUF_ZV (b
) - BUF_BEGV (b
) > XINT (Vline_number_display_limit
))
23086 w
->base_line_pos
= 0;
23087 w
->base_line_number
= 0;
23091 if (w
->base_line_number
> 0
23092 && w
->base_line_pos
> 0
23093 && w
->base_line_pos
<= startpos
)
23095 line
= w
->base_line_number
;
23096 linepos
= w
->base_line_pos
;
23097 linepos_byte
= buf_charpos_to_bytepos (b
, linepos
);
23102 linepos
= BUF_BEGV (b
);
23103 linepos_byte
= BUF_BEGV_BYTE (b
);
23106 /* Count lines from base line to window start position. */
23107 nlines
= display_count_lines (linepos_byte
,
23111 topline
= nlines
+ line
;
23113 /* Determine a new base line, if the old one is too close
23114 or too far away, or if we did not have one.
23115 "Too close" means it's plausible a scroll-down would
23116 go back past it. */
23117 if (startpos
== BUF_BEGV (b
))
23119 w
->base_line_number
= topline
;
23120 w
->base_line_pos
= BUF_BEGV (b
);
23122 else if (nlines
< height
+ 25 || nlines
> height
* 3 + 50
23123 || linepos
== BUF_BEGV (b
))
23125 ptrdiff_t limit
= BUF_BEGV (b
);
23126 ptrdiff_t limit_byte
= BUF_BEGV_BYTE (b
);
23127 ptrdiff_t position
;
23128 ptrdiff_t distance
=
23129 (height
* 2 + 30) * line_number_display_limit_width
;
23131 if (startpos
- distance
> limit
)
23133 limit
= startpos
- distance
;
23134 limit_byte
= CHAR_TO_BYTE (limit
);
23137 nlines
= display_count_lines (startpos_byte
,
23139 - (height
* 2 + 30),
23141 /* If we couldn't find the lines we wanted within
23142 line_number_display_limit_width chars per line,
23143 give up on line numbers for this window. */
23144 if (position
== limit_byte
&& limit
== startpos
- distance
)
23146 w
->base_line_pos
= -1;
23147 w
->base_line_number
= 0;
23151 w
->base_line_number
= topline
- nlines
;
23152 w
->base_line_pos
= BYTE_TO_CHAR (position
);
23155 /* Now count lines from the start pos to point. */
23156 nlines
= display_count_lines (startpos_byte
,
23157 PT_BYTE
, PT
, &junk
);
23159 /* Record that we did display the line number. */
23160 line_number_displayed
= 1;
23162 /* Make the string to show. */
23163 pint2str (decode_mode_spec_buf
, width
, topline
+ nlines
);
23164 return decode_mode_spec_buf
;
23167 char *p
= decode_mode_spec_buf
;
23168 int pad
= width
- 2;
23174 return decode_mode_spec_buf
;
23180 obj
= BVAR (b
, mode_name
);
23184 if (BUF_BEGV (b
) > BUF_BEG (b
) || BUF_ZV (b
) < BUF_Z (b
))
23190 ptrdiff_t pos
= marker_position (w
->start
);
23191 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23193 if (w
->window_end_pos
<= BUF_Z (b
) - BUF_ZV (b
))
23195 if (pos
<= BUF_BEGV (b
))
23200 else if (pos
<= BUF_BEGV (b
))
23204 if (total
> 1000000)
23205 /* Do it differently for a large value, to avoid overflow. */
23206 total
= ((pos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23208 total
= ((pos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23209 /* We can't normally display a 3-digit number,
23210 so get us a 2-digit number that is close. */
23213 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23214 return decode_mode_spec_buf
;
23218 /* Display percentage of size above the bottom of the screen. */
23221 ptrdiff_t toppos
= marker_position (w
->start
);
23222 ptrdiff_t botpos
= BUF_Z (b
) - w
->window_end_pos
;
23223 ptrdiff_t total
= BUF_ZV (b
) - BUF_BEGV (b
);
23225 if (botpos
>= BUF_ZV (b
))
23227 if (toppos
<= BUF_BEGV (b
))
23234 if (total
> 1000000)
23235 /* Do it differently for a large value, to avoid overflow. */
23236 total
= ((botpos
- BUF_BEGV (b
)) + (total
/ 100) - 1) / (total
/ 100);
23238 total
= ((botpos
- BUF_BEGV (b
)) * 100 + total
- 1) / total
;
23239 /* We can't normally display a 3-digit number,
23240 so get us a 2-digit number that is close. */
23243 if (toppos
<= BUF_BEGV (b
))
23244 sprintf (decode_mode_spec_buf
, "Top%2"pD
"d%%", total
);
23246 sprintf (decode_mode_spec_buf
, "%2"pD
"d%%", total
);
23247 return decode_mode_spec_buf
;
23252 /* status of process */
23253 obj
= Fget_buffer_process (Fcurrent_buffer ());
23255 return "no process";
23257 obj
= Fsymbol_name (Fprocess_status (obj
));
23263 ptrdiff_t count
= inhibit_garbage_collection ();
23264 Lisp_Object curdir
= BVAR (current_buffer
, directory
);
23265 Lisp_Object val
= Qnil
;
23267 if (STRINGP (curdir
))
23268 val
= call1 (intern ("file-remote-p"), curdir
);
23270 unbind_to (count
, Qnil
);
23279 /* coding-system (not including end-of-line format) */
23281 /* coding-system (including end-of-line type) */
23283 int eol_flag
= (c
== 'Z');
23284 char *p
= decode_mode_spec_buf
;
23286 if (! FRAME_WINDOW_P (f
))
23288 /* No need to mention EOL here--the terminal never needs
23289 to do EOL conversion. */
23290 p
= decode_mode_spec_coding (CODING_ID_NAME
23291 (FRAME_KEYBOARD_CODING (f
)->id
),
23293 p
= decode_mode_spec_coding (CODING_ID_NAME
23294 (FRAME_TERMINAL_CODING (f
)->id
),
23297 p
= decode_mode_spec_coding (BVAR (b
, buffer_file_coding_system
),
23300 #if 0 /* This proves to be annoying; I think we can do without. -- rms. */
23301 #ifdef subprocesses
23302 obj
= Fget_buffer_process (Fcurrent_buffer ());
23303 if (PROCESSP (obj
))
23305 p
= decode_mode_spec_coding
23306 (XPROCESS (obj
)->decode_coding_system
, p
, eol_flag
);
23307 p
= decode_mode_spec_coding
23308 (XPROCESS (obj
)->encode_coding_system
, p
, eol_flag
);
23310 #endif /* subprocesses */
23313 return decode_mode_spec_buf
;
23320 return SSDATA (obj
);
23327 /* Count up to COUNT lines starting from START_BYTE. COUNT negative
23328 means count lines back from START_BYTE. But don't go beyond
23329 LIMIT_BYTE. Return the number of lines thus found (always
23332 Set *BYTE_POS_PTR to the byte position where we stopped. This is
23333 either the position COUNT lines after/before START_BYTE, if we
23334 found COUNT lines, or LIMIT_BYTE if we hit the limit before finding
23338 display_count_lines (ptrdiff_t start_byte
,
23339 ptrdiff_t limit_byte
, ptrdiff_t count
,
23340 ptrdiff_t *byte_pos_ptr
)
23342 register unsigned char *cursor
;
23343 unsigned char *base
;
23345 register ptrdiff_t ceiling
;
23346 register unsigned char *ceiling_addr
;
23347 ptrdiff_t orig_count
= count
;
23349 /* If we are not in selective display mode,
23350 check only for newlines. */
23351 int selective_display
= (!NILP (BVAR (current_buffer
, selective_display
))
23352 && !INTEGERP (BVAR (current_buffer
, selective_display
)));
23356 while (start_byte
< limit_byte
)
23358 ceiling
= BUFFER_CEILING_OF (start_byte
);
23359 ceiling
= min (limit_byte
- 1, ceiling
);
23360 ceiling_addr
= BYTE_POS_ADDR (ceiling
) + 1;
23361 base
= (cursor
= BYTE_POS_ADDR (start_byte
));
23365 if (selective_display
)
23367 while (*cursor
!= '\n' && *cursor
!= 015
23368 && ++cursor
!= ceiling_addr
)
23370 if (cursor
== ceiling_addr
)
23375 cursor
= memchr (cursor
, '\n', ceiling_addr
- cursor
);
23384 start_byte
+= cursor
- base
;
23385 *byte_pos_ptr
= start_byte
;
23389 while (cursor
< ceiling_addr
);
23391 start_byte
+= ceiling_addr
- base
;
23396 while (start_byte
> limit_byte
)
23398 ceiling
= BUFFER_FLOOR_OF (start_byte
- 1);
23399 ceiling
= max (limit_byte
, ceiling
);
23400 ceiling_addr
= BYTE_POS_ADDR (ceiling
);
23401 base
= (cursor
= BYTE_POS_ADDR (start_byte
- 1) + 1);
23404 if (selective_display
)
23406 while (--cursor
>= ceiling_addr
23407 && *cursor
!= '\n' && *cursor
!= 015)
23409 if (cursor
< ceiling_addr
)
23414 cursor
= memrchr (ceiling_addr
, '\n', cursor
- ceiling_addr
);
23421 start_byte
+= cursor
- base
+ 1;
23422 *byte_pos_ptr
= start_byte
;
23423 /* When scanning backwards, we should
23424 not count the newline posterior to which we stop. */
23425 return - orig_count
- 1;
23428 start_byte
+= ceiling_addr
- base
;
23432 *byte_pos_ptr
= limit_byte
;
23435 return - orig_count
+ count
;
23436 return orig_count
- count
;
23442 /***********************************************************************
23444 ***********************************************************************/
23446 /* Display a NUL-terminated string, starting with index START.
23448 If STRING is non-null, display that C string. Otherwise, the Lisp
23449 string LISP_STRING is displayed. There's a case that STRING is
23450 non-null and LISP_STRING is not nil. It means STRING is a string
23451 data of LISP_STRING. In that case, we display LISP_STRING while
23452 ignoring its text properties.
23454 If FACE_STRING is not nil, FACE_STRING_POS is a position in
23455 FACE_STRING. Display STRING or LISP_STRING with the face at
23456 FACE_STRING_POS in FACE_STRING:
23458 Display the string in the environment given by IT, but use the
23459 standard display table, temporarily.
23461 FIELD_WIDTH is the minimum number of output glyphs to produce.
23462 If STRING has fewer characters than FIELD_WIDTH, pad to the right
23463 with spaces. If STRING has more characters, more than FIELD_WIDTH
23464 glyphs will be produced. FIELD_WIDTH <= 0 means don't pad.
23466 PRECISION is the maximum number of characters to output from
23467 STRING. PRECISION < 0 means don't truncate the string.
23469 This is roughly equivalent to printf format specifiers:
23471 FIELD_WIDTH PRECISION PRINTF
23472 ----------------------------------------
23478 MULTIBYTE zero means do not display multibyte chars, > 0 means do
23479 display them, and < 0 means obey the current buffer's value of
23480 enable_multibyte_characters.
23482 Value is the number of columns displayed. */
23485 display_string (const char *string
, Lisp_Object lisp_string
, Lisp_Object face_string
,
23486 ptrdiff_t face_string_pos
, ptrdiff_t start
, struct it
*it
,
23487 int field_width
, int precision
, int max_x
, int multibyte
)
23489 int hpos_at_start
= it
->hpos
;
23490 int saved_face_id
= it
->face_id
;
23491 struct glyph_row
*row
= it
->glyph_row
;
23492 ptrdiff_t it_charpos
;
23494 /* Initialize the iterator IT for iteration over STRING beginning
23495 with index START. */
23496 reseat_to_string (it
, NILP (lisp_string
) ? string
: NULL
, lisp_string
, start
,
23497 precision
, field_width
, multibyte
);
23498 if (string
&& STRINGP (lisp_string
))
23499 /* LISP_STRING is the one returned by decode_mode_spec. We should
23500 ignore its text properties. */
23501 it
->stop_charpos
= it
->end_charpos
;
23503 /* If displaying STRING, set up the face of the iterator from
23504 FACE_STRING, if that's given. */
23505 if (STRINGP (face_string
))
23511 = face_at_string_position (it
->w
, face_string
, face_string_pos
,
23512 0, &endptr
, it
->base_face_id
, 0);
23513 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
23514 it
->face_box_p
= face
->box
!= FACE_NO_BOX
;
23517 /* Set max_x to the maximum allowed X position. Don't let it go
23518 beyond the right edge of the window. */
23520 max_x
= it
->last_visible_x
;
23522 max_x
= min (max_x
, it
->last_visible_x
);
23524 /* Skip over display elements that are not visible. because IT->w is
23526 if (it
->current_x
< it
->first_visible_x
)
23527 move_it_in_display_line_to (it
, 100000, it
->first_visible_x
,
23528 MOVE_TO_POS
| MOVE_TO_X
);
23530 row
->ascent
= it
->max_ascent
;
23531 row
->height
= it
->max_ascent
+ it
->max_descent
;
23532 row
->phys_ascent
= it
->max_phys_ascent
;
23533 row
->phys_height
= it
->max_phys_ascent
+ it
->max_phys_descent
;
23534 row
->extra_line_spacing
= it
->max_extra_line_spacing
;
23536 if (STRINGP (it
->string
))
23537 it_charpos
= IT_STRING_CHARPOS (*it
);
23539 it_charpos
= IT_CHARPOS (*it
);
23541 /* This condition is for the case that we are called with current_x
23542 past last_visible_x. */
23543 while (it
->current_x
< max_x
)
23545 int x_before
, x
, n_glyphs_before
, i
, nglyphs
;
23547 /* Get the next display element. */
23548 if (!get_next_display_element (it
))
23551 /* Produce glyphs. */
23552 x_before
= it
->current_x
;
23553 n_glyphs_before
= row
->used
[TEXT_AREA
];
23554 PRODUCE_GLYPHS (it
);
23556 nglyphs
= row
->used
[TEXT_AREA
] - n_glyphs_before
;
23559 while (i
< nglyphs
)
23561 struct glyph
*glyph
= row
->glyphs
[TEXT_AREA
] + n_glyphs_before
+ i
;
23563 if (it
->line_wrap
!= TRUNCATE
23564 && x
+ glyph
->pixel_width
> max_x
)
23566 /* End of continued line or max_x reached. */
23567 if (CHAR_GLYPH_PADDING_P (*glyph
))
23569 /* A wide character is unbreakable. */
23570 if (row
->reversed_p
)
23571 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23572 - n_glyphs_before
);
23573 row
->used
[TEXT_AREA
] = n_glyphs_before
;
23574 it
->current_x
= x_before
;
23578 if (row
->reversed_p
)
23579 unproduce_glyphs (it
, row
->used
[TEXT_AREA
]
23580 - (n_glyphs_before
+ i
));
23581 row
->used
[TEXT_AREA
] = n_glyphs_before
+ i
;
23586 else if (x
+ glyph
->pixel_width
>= it
->first_visible_x
)
23588 /* Glyph is at least partially visible. */
23590 if (x
< it
->first_visible_x
)
23591 row
->x
= x
- it
->first_visible_x
;
23595 /* Glyph is off the left margin of the display area.
23596 Should not happen. */
23600 row
->ascent
= max (row
->ascent
, it
->max_ascent
);
23601 row
->height
= max (row
->height
, it
->max_ascent
+ it
->max_descent
);
23602 row
->phys_ascent
= max (row
->phys_ascent
, it
->max_phys_ascent
);
23603 row
->phys_height
= max (row
->phys_height
,
23604 it
->max_phys_ascent
+ it
->max_phys_descent
);
23605 row
->extra_line_spacing
= max (row
->extra_line_spacing
,
23606 it
->max_extra_line_spacing
);
23607 x
+= glyph
->pixel_width
;
23611 /* Stop if max_x reached. */
23615 /* Stop at line ends. */
23616 if (ITERATOR_AT_END_OF_LINE_P (it
))
23618 it
->continuation_lines_width
= 0;
23622 set_iterator_to_next (it
, 1);
23623 if (STRINGP (it
->string
))
23624 it_charpos
= IT_STRING_CHARPOS (*it
);
23626 it_charpos
= IT_CHARPOS (*it
);
23628 /* Stop if truncating at the right edge. */
23629 if (it
->line_wrap
== TRUNCATE
23630 && it
->current_x
>= it
->last_visible_x
)
23632 /* Add truncation mark, but don't do it if the line is
23633 truncated at a padding space. */
23634 if (it_charpos
< it
->string_nchars
)
23636 if (!FRAME_WINDOW_P (it
->f
))
23640 if (it
->current_x
> it
->last_visible_x
)
23642 if (!row
->reversed_p
)
23644 for (ii
= row
->used
[TEXT_AREA
] - 1; ii
> 0; --ii
)
23645 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23650 for (ii
= 0; ii
< row
->used
[TEXT_AREA
]; ii
++)
23651 if (!CHAR_GLYPH_PADDING_P (row
->glyphs
[TEXT_AREA
][ii
]))
23653 unproduce_glyphs (it
, ii
+ 1);
23654 ii
= row
->used
[TEXT_AREA
] - (ii
+ 1);
23656 for (n
= row
->used
[TEXT_AREA
]; ii
< n
; ++ii
)
23658 row
->used
[TEXT_AREA
] = ii
;
23659 produce_special_glyphs (it
, IT_TRUNCATION
);
23662 produce_special_glyphs (it
, IT_TRUNCATION
);
23664 row
->truncated_on_right_p
= 1;
23670 /* Maybe insert a truncation at the left. */
23671 if (it
->first_visible_x
23674 if (!FRAME_WINDOW_P (it
->f
)
23675 || (row
->reversed_p
23676 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23677 : WINDOW_LEFT_FRINGE_WIDTH (it
->w
)) == 0)
23678 insert_left_trunc_glyphs (it
);
23679 row
->truncated_on_left_p
= 1;
23682 it
->face_id
= saved_face_id
;
23684 /* Value is number of columns displayed. */
23685 return it
->hpos
- hpos_at_start
;
23690 /* This is like a combination of memq and assq. Return 1/2 if PROPVAL
23691 appears as an element of LIST or as the car of an element of LIST.
23692 If PROPVAL is a list, compare each element against LIST in that
23693 way, and return 1/2 if any element of PROPVAL is found in LIST.
23694 Otherwise return 0. This function cannot quit.
23695 The return value is 2 if the text is invisible but with an ellipsis
23696 and 1 if it's invisible and without an ellipsis. */
23699 invisible_p (register Lisp_Object propval
, Lisp_Object list
)
23701 register Lisp_Object tail
, proptail
;
23703 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23705 register Lisp_Object tem
;
23707 if (EQ (propval
, tem
))
23709 if (CONSP (tem
) && EQ (propval
, XCAR (tem
)))
23710 return NILP (XCDR (tem
)) ? 1 : 2;
23713 if (CONSP (propval
))
23715 for (proptail
= propval
; CONSP (proptail
); proptail
= XCDR (proptail
))
23717 Lisp_Object propelt
;
23718 propelt
= XCAR (proptail
);
23719 for (tail
= list
; CONSP (tail
); tail
= XCDR (tail
))
23721 register Lisp_Object tem
;
23723 if (EQ (propelt
, tem
))
23725 if (CONSP (tem
) && EQ (propelt
, XCAR (tem
)))
23726 return NILP (XCDR (tem
)) ? 1 : 2;
23734 DEFUN ("invisible-p", Finvisible_p
, Sinvisible_p
, 1, 1, 0,
23735 doc
: /* Non-nil if the property makes the text invisible.
23736 POS-OR-PROP can be a marker or number, in which case it is taken to be
23737 a position in the current buffer and the value of the `invisible' property
23738 is checked; or it can be some other value, which is then presumed to be the
23739 value of the `invisible' property of the text of interest.
23740 The non-nil value returned can be t for truly invisible text or something
23741 else if the text is replaced by an ellipsis. */)
23742 (Lisp_Object pos_or_prop
)
23745 = (NATNUMP (pos_or_prop
) || MARKERP (pos_or_prop
)
23746 ? Fget_char_property (pos_or_prop
, Qinvisible
, Qnil
)
23748 int invis
= TEXT_PROP_MEANS_INVISIBLE (prop
);
23749 return (invis
== 0 ? Qnil
23751 : make_number (invis
));
23754 /* Calculate a width or height in pixels from a specification using
23755 the following elements:
23758 NUM - a (fractional) multiple of the default font width/height
23759 (NUM) - specifies exactly NUM pixels
23760 UNIT - a fixed number of pixels, see below.
23761 ELEMENT - size of a display element in pixels, see below.
23762 (NUM . SPEC) - equals NUM * SPEC
23763 (+ SPEC SPEC ...) - add pixel values
23764 (- SPEC SPEC ...) - subtract pixel values
23765 (- SPEC) - negate pixel value
23768 INT or FLOAT - a number constant
23769 SYMBOL - use symbol's (buffer local) variable binding.
23772 in - pixels per inch *)
23773 mm - pixels per 1/1000 meter *)
23774 cm - pixels per 1/100 meter *)
23775 width - width of current font in pixels.
23776 height - height of current font in pixels.
23778 *) using the ratio(s) defined in display-pixels-per-inch.
23782 left-fringe - left fringe width in pixels
23783 right-fringe - right fringe width in pixels
23785 left-margin - left margin width in pixels
23786 right-margin - right margin width in pixels
23788 scroll-bar - scroll-bar area width in pixels
23792 Pixels corresponding to 5 inches:
23795 Total width of non-text areas on left side of window (if scroll-bar is on left):
23796 '(space :width (+ left-fringe left-margin scroll-bar))
23798 Align to first text column (in header line):
23799 '(space :align-to 0)
23801 Align to middle of text area minus half the width of variable `my-image'
23802 containing a loaded image:
23803 '(space :align-to (0.5 . (- text my-image)))
23805 Width of left margin minus width of 1 character in the default font:
23806 '(space :width (- left-margin 1))
23808 Width of left margin minus width of 2 characters in the current font:
23809 '(space :width (- left-margin (2 . width)))
23811 Center 1 character over left-margin (in header line):
23812 '(space :align-to (+ left-margin (0.5 . left-margin) -0.5))
23814 Different ways to express width of left fringe plus left margin minus one pixel:
23815 '(space :width (- (+ left-fringe left-margin) (1)))
23816 '(space :width (+ left-fringe left-margin (- (1))))
23817 '(space :width (+ left-fringe left-margin (-1)))
23822 calc_pixel_width_or_height (double *res
, struct it
*it
, Lisp_Object prop
,
23823 struct font
*font
, int width_p
, int *align_to
)
23827 #define OK_PIXELS(val) ((*res = (double)(val)), 1)
23828 #define OK_ALIGN_TO(val) ((*align_to = (int)(val)), 1)
23831 return OK_PIXELS (0);
23833 eassert (FRAME_LIVE_P (it
->f
));
23835 if (SYMBOLP (prop
))
23837 if (SCHARS (SYMBOL_NAME (prop
)) == 2)
23839 char *unit
= SSDATA (SYMBOL_NAME (prop
));
23841 if (unit
[0] == 'i' && unit
[1] == 'n')
23843 else if (unit
[0] == 'm' && unit
[1] == 'm')
23845 else if (unit
[0] == 'c' && unit
[1] == 'm')
23851 double ppi
= (width_p
? FRAME_RES_X (it
->f
)
23852 : FRAME_RES_Y (it
->f
));
23855 return OK_PIXELS (ppi
/ pixels
);
23860 #ifdef HAVE_WINDOW_SYSTEM
23861 if (EQ (prop
, Qheight
))
23862 return OK_PIXELS (font
? FONT_HEIGHT (font
) : FRAME_LINE_HEIGHT (it
->f
));
23863 if (EQ (prop
, Qwidth
))
23864 return OK_PIXELS (font
? FONT_WIDTH (font
) : FRAME_COLUMN_WIDTH (it
->f
));
23866 if (EQ (prop
, Qheight
) || EQ (prop
, Qwidth
))
23867 return OK_PIXELS (1);
23870 if (EQ (prop
, Qtext
))
23871 return OK_PIXELS (width_p
23872 ? window_box_width (it
->w
, TEXT_AREA
)
23873 : WINDOW_BOX_HEIGHT_NO_MODE_LINE (it
->w
));
23875 if (align_to
&& *align_to
< 0)
23878 if (EQ (prop
, Qleft
))
23879 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
));
23880 if (EQ (prop
, Qright
))
23881 return OK_ALIGN_TO (window_box_right_offset (it
->w
, TEXT_AREA
));
23882 if (EQ (prop
, Qcenter
))
23883 return OK_ALIGN_TO (window_box_left_offset (it
->w
, TEXT_AREA
)
23884 + window_box_width (it
->w
, TEXT_AREA
) / 2);
23885 if (EQ (prop
, Qleft_fringe
))
23886 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23887 ? WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (it
->w
)
23888 : window_box_right_offset (it
->w
, LEFT_MARGIN_AREA
));
23889 if (EQ (prop
, Qright_fringe
))
23890 return OK_ALIGN_TO (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23891 ? window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23892 : window_box_right_offset (it
->w
, TEXT_AREA
));
23893 if (EQ (prop
, Qleft_margin
))
23894 return OK_ALIGN_TO (window_box_left_offset (it
->w
, LEFT_MARGIN_AREA
));
23895 if (EQ (prop
, Qright_margin
))
23896 return OK_ALIGN_TO (window_box_left_offset (it
->w
, RIGHT_MARGIN_AREA
));
23897 if (EQ (prop
, Qscroll_bar
))
23898 return OK_ALIGN_TO (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (it
->w
)
23900 : (window_box_right_offset (it
->w
, RIGHT_MARGIN_AREA
)
23901 + (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (it
->w
)
23902 ? WINDOW_RIGHT_FRINGE_WIDTH (it
->w
)
23907 if (EQ (prop
, Qleft_fringe
))
23908 return OK_PIXELS (WINDOW_LEFT_FRINGE_WIDTH (it
->w
));
23909 if (EQ (prop
, Qright_fringe
))
23910 return OK_PIXELS (WINDOW_RIGHT_FRINGE_WIDTH (it
->w
));
23911 if (EQ (prop
, Qleft_margin
))
23912 return OK_PIXELS (WINDOW_LEFT_MARGIN_WIDTH (it
->w
));
23913 if (EQ (prop
, Qright_margin
))
23914 return OK_PIXELS (WINDOW_RIGHT_MARGIN_WIDTH (it
->w
));
23915 if (EQ (prop
, Qscroll_bar
))
23916 return OK_PIXELS (WINDOW_SCROLL_BAR_AREA_WIDTH (it
->w
));
23919 prop
= buffer_local_value (prop
, it
->w
->contents
);
23920 if (EQ (prop
, Qunbound
))
23924 if (INTEGERP (prop
) || FLOATP (prop
))
23926 int base_unit
= (width_p
23927 ? FRAME_COLUMN_WIDTH (it
->f
)
23928 : FRAME_LINE_HEIGHT (it
->f
));
23929 return OK_PIXELS (XFLOATINT (prop
) * base_unit
);
23934 Lisp_Object car
= XCAR (prop
);
23935 Lisp_Object cdr
= XCDR (prop
);
23939 #ifdef HAVE_WINDOW_SYSTEM
23940 if (FRAME_WINDOW_P (it
->f
)
23941 && valid_image_p (prop
))
23943 ptrdiff_t id
= lookup_image (it
->f
, prop
);
23944 struct image
*img
= IMAGE_FROM_ID (it
->f
, id
);
23946 return OK_PIXELS (width_p
? img
->width
: img
->height
);
23949 if (EQ (car
, Qplus
) || EQ (car
, Qminus
))
23955 while (CONSP (cdr
))
23957 if (!calc_pixel_width_or_height (&px
, it
, XCAR (cdr
),
23958 font
, width_p
, align_to
))
23961 pixels
= (EQ (car
, Qplus
) ? px
: -px
), first
= 0;
23966 if (EQ (car
, Qminus
))
23968 return OK_PIXELS (pixels
);
23971 car
= buffer_local_value (car
, it
->w
->contents
);
23972 if (EQ (car
, Qunbound
))
23976 if (INTEGERP (car
) || FLOATP (car
))
23979 pixels
= XFLOATINT (car
);
23981 return OK_PIXELS (pixels
);
23982 if (calc_pixel_width_or_height (&fact
, it
, cdr
,
23983 font
, width_p
, align_to
))
23984 return OK_PIXELS (pixels
* fact
);
23995 /***********************************************************************
23997 ***********************************************************************/
23999 #ifdef HAVE_WINDOW_SYSTEM
24004 dump_glyph_string (struct glyph_string
*s
)
24006 fprintf (stderr
, "glyph string\n");
24007 fprintf (stderr
, " x, y, w, h = %d, %d, %d, %d\n",
24008 s
->x
, s
->y
, s
->width
, s
->height
);
24009 fprintf (stderr
, " ybase = %d\n", s
->ybase
);
24010 fprintf (stderr
, " hl = %d\n", s
->hl
);
24011 fprintf (stderr
, " left overhang = %d, right = %d\n",
24012 s
->left_overhang
, s
->right_overhang
);
24013 fprintf (stderr
, " nchars = %d\n", s
->nchars
);
24014 fprintf (stderr
, " extends to end of line = %d\n",
24015 s
->extends_to_end_of_line_p
);
24016 fprintf (stderr
, " font height = %d\n", FONT_HEIGHT (s
->font
));
24017 fprintf (stderr
, " bg width = %d\n", s
->background_width
);
24020 #endif /* GLYPH_DEBUG */
24022 /* Initialize glyph string S. CHAR2B is a suitably allocated vector
24023 of XChar2b structures for S; it can't be allocated in
24024 init_glyph_string because it must be allocated via `alloca'. W
24025 is the window on which S is drawn. ROW and AREA are the glyph row
24026 and area within the row from which S is constructed. START is the
24027 index of the first glyph structure covered by S. HL is a
24028 face-override for drawing S. */
24031 #define OPTIONAL_HDC(hdc) HDC hdc,
24032 #define DECLARE_HDC(hdc) HDC hdc;
24033 #define ALLOCATE_HDC(hdc, f) hdc = get_frame_dc ((f))
24034 #define RELEASE_HDC(hdc, f) release_frame_dc ((f), (hdc))
24037 #ifndef OPTIONAL_HDC
24038 #define OPTIONAL_HDC(hdc)
24039 #define DECLARE_HDC(hdc)
24040 #define ALLOCATE_HDC(hdc, f)
24041 #define RELEASE_HDC(hdc, f)
24045 init_glyph_string (struct glyph_string
*s
,
24047 XChar2b
*char2b
, struct window
*w
, struct glyph_row
*row
,
24048 enum glyph_row_area area
, int start
, enum draw_glyphs_face hl
)
24050 memset (s
, 0, sizeof *s
);
24052 s
->f
= XFRAME (w
->frame
);
24056 s
->display
= FRAME_X_DISPLAY (s
->f
);
24057 s
->window
= FRAME_X_WINDOW (s
->f
);
24058 s
->char2b
= char2b
;
24062 s
->first_glyph
= row
->glyphs
[area
] + start
;
24063 s
->height
= row
->height
;
24064 s
->y
= WINDOW_TO_FRAME_PIXEL_Y (w
, row
->y
);
24065 s
->ybase
= s
->y
+ row
->ascent
;
24069 /* Append the list of glyph strings with head H and tail T to the list
24070 with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the result. */
24073 append_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24074 struct glyph_string
*h
, struct glyph_string
*t
)
24088 /* Prepend the list of glyph strings with head H and tail T to the
24089 list with head *HEAD and tail *TAIL. Set *HEAD and *TAIL to the
24093 prepend_glyph_string_lists (struct glyph_string
**head
, struct glyph_string
**tail
,
24094 struct glyph_string
*h
, struct glyph_string
*t
)
24108 /* Append glyph string S to the list with head *HEAD and tail *TAIL.
24109 Set *HEAD and *TAIL to the resulting list. */
24112 append_glyph_string (struct glyph_string
**head
, struct glyph_string
**tail
,
24113 struct glyph_string
*s
)
24115 s
->next
= s
->prev
= NULL
;
24116 append_glyph_string_lists (head
, tail
, s
, s
);
24120 /* Get face and two-byte form of character C in face FACE_ID on frame F.
24121 The encoding of C is returned in *CHAR2B. DISPLAY_P non-zero means
24122 make sure that X resources for the face returned are allocated.
24123 Value is a pointer to a realized face that is ready for display if
24124 DISPLAY_P is non-zero. */
24126 static struct face
*
24127 get_char_face_and_encoding (struct frame
*f
, int c
, int face_id
,
24128 XChar2b
*char2b
, int display_p
)
24130 struct face
*face
= FACE_FROM_ID (f
, face_id
);
24135 code
= face
->font
->driver
->encode_char (face
->font
, c
);
24137 if (code
== FONT_INVALID_CODE
)
24140 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24142 /* Make sure X resources of the face are allocated. */
24143 #ifdef HAVE_X_WINDOWS
24147 eassert (face
!= NULL
);
24148 prepare_face_for_display (f
, face
);
24155 /* Get face and two-byte form of character glyph GLYPH on frame F.
24156 The encoding of GLYPH->u.ch is returned in *CHAR2B. Value is
24157 a pointer to a realized face that is ready for display. */
24159 static struct face
*
24160 get_glyph_face_and_encoding (struct frame
*f
, struct glyph
*glyph
,
24161 XChar2b
*char2b
, int *two_byte_p
)
24166 eassert (glyph
->type
== CHAR_GLYPH
);
24167 face
= FACE_FROM_ID (f
, glyph
->face_id
);
24169 /* Make sure X resources of the face are allocated. */
24170 eassert (face
!= NULL
);
24171 prepare_face_for_display (f
, face
);
24178 if (CHAR_BYTE8_P (glyph
->u
.ch
))
24179 code
= CHAR_TO_BYTE8 (glyph
->u
.ch
);
24181 code
= face
->font
->driver
->encode_char (face
->font
, glyph
->u
.ch
);
24183 if (code
== FONT_INVALID_CODE
)
24187 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24192 /* Get glyph code of character C in FONT in the two-byte form CHAR2B.
24193 Return 1 if FONT has a glyph for C, otherwise return 0. */
24196 get_char_glyph_code (int c
, struct font
*font
, XChar2b
*char2b
)
24200 if (CHAR_BYTE8_P (c
))
24201 code
= CHAR_TO_BYTE8 (c
);
24203 code
= font
->driver
->encode_char (font
, c
);
24205 if (code
== FONT_INVALID_CODE
)
24207 STORE_XCHAR2B (char2b
, (code
>> 8), (code
& 0xFF));
24212 /* Fill glyph string S with composition components specified by S->cmp.
24214 BASE_FACE is the base face of the composition.
24215 S->cmp_from is the index of the first component for S.
24217 OVERLAPS non-zero means S should draw the foreground only, and use
24218 its physical height for clipping. See also draw_glyphs.
24220 Value is the index of a component not in S. */
24223 fill_composite_glyph_string (struct glyph_string
*s
, struct face
*base_face
,
24227 /* For all glyphs of this composition, starting at the offset
24228 S->cmp_from, until we reach the end of the definition or encounter a
24229 glyph that requires the different face, add it to S. */
24234 s
->for_overlaps
= overlaps
;
24237 for (i
= s
->cmp_from
; i
< s
->cmp
->glyph_len
; i
++)
24239 int c
= COMPOSITION_GLYPH (s
->cmp
, i
);
24241 /* TAB in a composition means display glyphs with padding space
24242 on the left or right. */
24245 int face_id
= FACE_FOR_CHAR (s
->f
, base_face
->ascii_face
, c
,
24248 face
= get_char_face_and_encoding (s
->f
, c
, face_id
,
24255 s
->font
= s
->face
->font
;
24257 else if (s
->face
!= face
)
24265 if (s
->face
== NULL
)
24267 s
->face
= base_face
->ascii_face
;
24268 s
->font
= s
->face
->font
;
24271 /* All glyph strings for the same composition has the same width,
24272 i.e. the width set for the first component of the composition. */
24273 s
->width
= s
->first_glyph
->pixel_width
;
24275 /* If the specified font could not be loaded, use the frame's
24276 default font, but record the fact that we couldn't load it in
24277 the glyph string so that we can draw rectangles for the
24278 characters of the glyph string. */
24279 if (s
->font
== NULL
)
24281 s
->font_not_found_p
= 1;
24282 s
->font
= FRAME_FONT (s
->f
);
24285 /* Adjust base line for subscript/superscript text. */
24286 s
->ybase
+= s
->first_glyph
->voffset
;
24288 /* This glyph string must always be drawn with 16-bit functions. */
24295 fill_gstring_glyph_string (struct glyph_string
*s
, int face_id
,
24296 int start
, int end
, int overlaps
)
24298 struct glyph
*glyph
, *last
;
24299 Lisp_Object lgstring
;
24302 s
->for_overlaps
= overlaps
;
24303 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24304 last
= s
->row
->glyphs
[s
->area
] + end
;
24305 s
->cmp_id
= glyph
->u
.cmp
.id
;
24306 s
->cmp_from
= glyph
->slice
.cmp
.from
;
24307 s
->cmp_to
= glyph
->slice
.cmp
.to
+ 1;
24308 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24309 lgstring
= composition_gstring_from_id (s
->cmp_id
);
24310 s
->font
= XFONT_OBJECT (LGSTRING_FONT (lgstring
));
24312 while (glyph
< last
24313 && glyph
->u
.cmp
.automatic
24314 && glyph
->u
.cmp
.id
== s
->cmp_id
24315 && s
->cmp_to
== glyph
->slice
.cmp
.from
)
24316 s
->cmp_to
= (glyph
++)->slice
.cmp
.to
+ 1;
24318 for (i
= s
->cmp_from
; i
< s
->cmp_to
; i
++)
24320 Lisp_Object lglyph
= LGSTRING_GLYPH (lgstring
, i
);
24321 unsigned code
= LGLYPH_CODE (lglyph
);
24323 STORE_XCHAR2B ((s
->char2b
+ i
), code
>> 8, code
& 0xFF);
24325 s
->width
= composition_gstring_width (lgstring
, s
->cmp_from
, s
->cmp_to
, NULL
);
24326 return glyph
- s
->row
->glyphs
[s
->area
];
24330 /* Fill glyph string S from a sequence glyphs for glyphless characters.
24331 See the comment of fill_glyph_string for arguments.
24332 Value is the index of the first glyph not in S. */
24336 fill_glyphless_glyph_string (struct glyph_string
*s
, int face_id
,
24337 int start
, int end
, int overlaps
)
24339 struct glyph
*glyph
, *last
;
24342 eassert (s
->first_glyph
->type
== GLYPHLESS_GLYPH
);
24343 s
->for_overlaps
= overlaps
;
24344 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24345 last
= s
->row
->glyphs
[s
->area
] + end
;
24346 voffset
= glyph
->voffset
;
24347 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24348 s
->font
= s
->face
->font
? s
->face
->font
: FRAME_FONT (s
->f
);
24350 s
->width
= glyph
->pixel_width
;
24352 while (glyph
< last
24353 && glyph
->type
== GLYPHLESS_GLYPH
24354 && glyph
->voffset
== voffset
24355 && glyph
->face_id
== face_id
)
24358 s
->width
+= glyph
->pixel_width
;
24361 s
->ybase
+= voffset
;
24362 return glyph
- s
->row
->glyphs
[s
->area
];
24366 /* Fill glyph string S from a sequence of character glyphs.
24368 FACE_ID is the face id of the string. START is the index of the
24369 first glyph to consider, END is the index of the last + 1.
24370 OVERLAPS non-zero means S should draw the foreground only, and use
24371 its physical height for clipping. See also draw_glyphs.
24373 Value is the index of the first glyph not in S. */
24376 fill_glyph_string (struct glyph_string
*s
, int face_id
,
24377 int start
, int end
, int overlaps
)
24379 struct glyph
*glyph
, *last
;
24381 int glyph_not_available_p
;
24383 eassert (s
->f
== XFRAME (s
->w
->frame
));
24384 eassert (s
->nchars
== 0);
24385 eassert (start
>= 0 && end
> start
);
24387 s
->for_overlaps
= overlaps
;
24388 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24389 last
= s
->row
->glyphs
[s
->area
] + end
;
24390 voffset
= glyph
->voffset
;
24391 s
->padding_p
= glyph
->padding_p
;
24392 glyph_not_available_p
= glyph
->glyph_not_available_p
;
24394 while (glyph
< last
24395 && glyph
->type
== CHAR_GLYPH
24396 && glyph
->voffset
== voffset
24397 /* Same face id implies same font, nowadays. */
24398 && glyph
->face_id
== face_id
24399 && glyph
->glyph_not_available_p
== glyph_not_available_p
)
24403 s
->face
= get_glyph_face_and_encoding (s
->f
, glyph
,
24404 s
->char2b
+ s
->nchars
,
24406 s
->two_byte_p
= two_byte_p
;
24408 eassert (s
->nchars
<= end
- start
);
24409 s
->width
+= glyph
->pixel_width
;
24410 if (glyph
++->padding_p
!= s
->padding_p
)
24414 s
->font
= s
->face
->font
;
24416 /* If the specified font could not be loaded, use the frame's font,
24417 but record the fact that we couldn't load it in
24418 S->font_not_found_p so that we can draw rectangles for the
24419 characters of the glyph string. */
24420 if (s
->font
== NULL
|| glyph_not_available_p
)
24422 s
->font_not_found_p
= 1;
24423 s
->font
= FRAME_FONT (s
->f
);
24426 /* Adjust base line for subscript/superscript text. */
24427 s
->ybase
+= voffset
;
24429 eassert (s
->face
&& s
->face
->gc
);
24430 return glyph
- s
->row
->glyphs
[s
->area
];
24434 /* Fill glyph string S from image glyph S->first_glyph. */
24437 fill_image_glyph_string (struct glyph_string
*s
)
24439 eassert (s
->first_glyph
->type
== IMAGE_GLYPH
);
24440 s
->img
= IMAGE_FROM_ID (s
->f
, s
->first_glyph
->u
.img_id
);
24442 s
->slice
= s
->first_glyph
->slice
.img
;
24443 s
->face
= FACE_FROM_ID (s
->f
, s
->first_glyph
->face_id
);
24444 s
->font
= s
->face
->font
;
24445 s
->width
= s
->first_glyph
->pixel_width
;
24447 /* Adjust base line for subscript/superscript text. */
24448 s
->ybase
+= s
->first_glyph
->voffset
;
24452 /* Fill glyph string S from a sequence of stretch glyphs.
24454 START is the index of the first glyph to consider,
24455 END is the index of the last + 1.
24457 Value is the index of the first glyph not in S. */
24460 fill_stretch_glyph_string (struct glyph_string
*s
, int start
, int end
)
24462 struct glyph
*glyph
, *last
;
24463 int voffset
, face_id
;
24465 eassert (s
->first_glyph
->type
== STRETCH_GLYPH
);
24467 glyph
= s
->row
->glyphs
[s
->area
] + start
;
24468 last
= s
->row
->glyphs
[s
->area
] + end
;
24469 face_id
= glyph
->face_id
;
24470 s
->face
= FACE_FROM_ID (s
->f
, face_id
);
24471 s
->font
= s
->face
->font
;
24472 s
->width
= glyph
->pixel_width
;
24474 voffset
= glyph
->voffset
;
24478 && glyph
->type
== STRETCH_GLYPH
24479 && glyph
->voffset
== voffset
24480 && glyph
->face_id
== face_id
);
24482 s
->width
+= glyph
->pixel_width
;
24484 /* Adjust base line for subscript/superscript text. */
24485 s
->ybase
+= voffset
;
24487 /* The case that face->gc == 0 is handled when drawing the glyph
24488 string by calling prepare_face_for_display. */
24490 return glyph
- s
->row
->glyphs
[s
->area
];
24493 static struct font_metrics
*
24494 get_per_char_metric (struct font
*font
, XChar2b
*char2b
)
24496 static struct font_metrics metrics
;
24501 code
= (XCHAR2B_BYTE1 (char2b
) << 8) | XCHAR2B_BYTE2 (char2b
);
24502 if (code
== FONT_INVALID_CODE
)
24504 font
->driver
->text_extents (font
, &code
, 1, &metrics
);
24509 Set *LEFT and *RIGHT to the left and right overhang of GLYPH on
24510 frame F. Overhangs of glyphs other than type CHAR_GLYPH are
24511 assumed to be zero. */
24514 x_get_glyph_overhangs (struct glyph
*glyph
, struct frame
*f
, int *left
, int *right
)
24516 *left
= *right
= 0;
24518 if (glyph
->type
== CHAR_GLYPH
)
24522 struct font_metrics
*pcm
;
24524 face
= get_glyph_face_and_encoding (f
, glyph
, &char2b
, NULL
);
24525 if (face
->font
&& (pcm
= get_per_char_metric (face
->font
, &char2b
)))
24527 if (pcm
->rbearing
> pcm
->width
)
24528 *right
= pcm
->rbearing
- pcm
->width
;
24529 if (pcm
->lbearing
< 0)
24530 *left
= -pcm
->lbearing
;
24533 else if (glyph
->type
== COMPOSITE_GLYPH
)
24535 if (! glyph
->u
.cmp
.automatic
)
24537 struct composition
*cmp
= composition_table
[glyph
->u
.cmp
.id
];
24539 if (cmp
->rbearing
> cmp
->pixel_width
)
24540 *right
= cmp
->rbearing
- cmp
->pixel_width
;
24541 if (cmp
->lbearing
< 0)
24542 *left
= - cmp
->lbearing
;
24546 Lisp_Object gstring
= composition_gstring_from_id (glyph
->u
.cmp
.id
);
24547 struct font_metrics metrics
;
24549 composition_gstring_width (gstring
, glyph
->slice
.cmp
.from
,
24550 glyph
->slice
.cmp
.to
+ 1, &metrics
);
24551 if (metrics
.rbearing
> metrics
.width
)
24552 *right
= metrics
.rbearing
- metrics
.width
;
24553 if (metrics
.lbearing
< 0)
24554 *left
= - metrics
.lbearing
;
24560 /* Return the index of the first glyph preceding glyph string S that
24561 is overwritten by S because of S's left overhang. Value is -1
24562 if no glyphs are overwritten. */
24565 left_overwritten (struct glyph_string
*s
)
24569 if (s
->left_overhang
)
24572 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24573 int first
= s
->first_glyph
- glyphs
;
24575 for (i
= first
- 1; i
>= 0 && x
> -s
->left_overhang
; --i
)
24576 x
-= glyphs
[i
].pixel_width
;
24587 /* Return the index of the first glyph preceding glyph string S that
24588 is overwriting S because of its right overhang. Value is -1 if no
24589 glyph in front of S overwrites S. */
24592 left_overwriting (struct glyph_string
*s
)
24595 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24596 int first
= s
->first_glyph
- glyphs
;
24600 for (i
= first
- 1; i
>= 0; --i
)
24603 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24606 x
-= glyphs
[i
].pixel_width
;
24613 /* Return the index of the last glyph following glyph string S that is
24614 overwritten by S because of S's right overhang. Value is -1 if
24615 no such glyph is found. */
24618 right_overwritten (struct glyph_string
*s
)
24622 if (s
->right_overhang
)
24625 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24626 int first
= (s
->first_glyph
- glyphs
24627 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24628 int end
= s
->row
->used
[s
->area
];
24630 for (i
= first
; i
< end
&& s
->right_overhang
> x
; ++i
)
24631 x
+= glyphs
[i
].pixel_width
;
24640 /* Return the index of the last glyph following glyph string S that
24641 overwrites S because of its left overhang. Value is negative
24642 if no such glyph is found. */
24645 right_overwriting (struct glyph_string
*s
)
24648 int end
= s
->row
->used
[s
->area
];
24649 struct glyph
*glyphs
= s
->row
->glyphs
[s
->area
];
24650 int first
= (s
->first_glyph
- glyphs
24651 + (s
->first_glyph
->type
== COMPOSITE_GLYPH
? 1 : s
->nchars
));
24655 for (i
= first
; i
< end
; ++i
)
24658 x_get_glyph_overhangs (glyphs
+ i
, s
->f
, &left
, &right
);
24661 x
+= glyphs
[i
].pixel_width
;
24668 /* Set background width of glyph string S. START is the index of the
24669 first glyph following S. LAST_X is the right-most x-position + 1
24670 in the drawing area. */
24673 set_glyph_string_background_width (struct glyph_string
*s
, int start
, int last_x
)
24675 /* If the face of this glyph string has to be drawn to the end of
24676 the drawing area, set S->extends_to_end_of_line_p. */
24678 if (start
== s
->row
->used
[s
->area
]
24679 && ((s
->row
->fill_line_p
24680 && (s
->hl
== DRAW_NORMAL_TEXT
24681 || s
->hl
== DRAW_IMAGE_RAISED
24682 || s
->hl
== DRAW_IMAGE_SUNKEN
))
24683 || s
->hl
== DRAW_MOUSE_FACE
))
24684 s
->extends_to_end_of_line_p
= 1;
24686 /* If S extends its face to the end of the line, set its
24687 background_width to the distance to the right edge of the drawing
24689 if (s
->extends_to_end_of_line_p
)
24690 s
->background_width
= last_x
- s
->x
+ 1;
24692 s
->background_width
= s
->width
;
24696 /* Compute overhangs and x-positions for glyph string S and its
24697 predecessors, or successors. X is the starting x-position for S.
24698 BACKWARD_P non-zero means process predecessors. */
24701 compute_overhangs_and_x (struct glyph_string
*s
, int x
, int backward_p
)
24707 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24708 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24718 if (FRAME_RIF (s
->f
)->compute_glyph_string_overhangs
)
24719 FRAME_RIF (s
->f
)->compute_glyph_string_overhangs (s
);
24729 /* The following macros are only called from draw_glyphs below.
24730 They reference the following parameters of that function directly:
24731 `w', `row', `area', and `overlap_p'
24732 as well as the following local variables:
24733 `s', `f', and `hdc' (in W32) */
24736 /* On W32, silently add local `hdc' variable to argument list of
24737 init_glyph_string. */
24738 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24739 init_glyph_string (s, hdc, char2b, w, row, area, start, hl)
24741 #define INIT_GLYPH_STRING(s, char2b, w, row, area, start, hl) \
24742 init_glyph_string (s, char2b, w, row, area, start, hl)
24745 /* Add a glyph string for a stretch glyph to the list of strings
24746 between HEAD and TAIL. START is the index of the stretch glyph in
24747 row area AREA of glyph row ROW. END is the index of the last glyph
24748 in that glyph row area. X is the current output position assigned
24749 to the new glyph string constructed. HL overrides that face of the
24750 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24751 is the right-most x-position of the drawing area. */
24753 /* SunOS 4 bundled cc, barfed on continuations in the arg lists here
24754 and below -- keep them on one line. */
24755 #define BUILD_STRETCH_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24758 s = alloca (sizeof *s); \
24759 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24760 START = fill_stretch_glyph_string (s, START, END); \
24761 append_glyph_string (&HEAD, &TAIL, s); \
24767 /* Add a glyph string for an image glyph to the list of strings
24768 between HEAD and TAIL. START is the index of the image glyph in
24769 row area AREA of glyph row ROW. END is the index of the last glyph
24770 in that glyph row area. X is the current output position assigned
24771 to the new glyph string constructed. HL overrides that face of the
24772 glyph; e.g. it is DRAW_CURSOR if a cursor has to be drawn. LAST_X
24773 is the right-most x-position of the drawing area. */
24775 #define BUILD_IMAGE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24778 s = alloca (sizeof *s); \
24779 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24780 fill_image_glyph_string (s); \
24781 append_glyph_string (&HEAD, &TAIL, s); \
24788 /* Add a glyph string for a sequence of character glyphs to the list
24789 of strings between HEAD and TAIL. START is the index of the first
24790 glyph in row area AREA of glyph row ROW that is part of the new
24791 glyph string. END is the index of the last glyph in that glyph row
24792 area. X is the current output position assigned to the new glyph
24793 string constructed. HL overrides that face of the glyph; e.g. it
24794 is DRAW_CURSOR if a cursor has to be drawn. LAST_X is the
24795 right-most x-position of the drawing area. */
24797 #define BUILD_CHAR_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24803 face_id = (row)->glyphs[area][START].face_id; \
24805 s = alloca (sizeof *s); \
24806 SAFE_NALLOCA (char2b, 1, (END) - (START)); \
24807 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24808 append_glyph_string (&HEAD, &TAIL, s); \
24810 START = fill_glyph_string (s, face_id, START, END, overlaps); \
24815 /* Add a glyph string for a composite sequence to the list of strings
24816 between HEAD and TAIL. START is the index of the first glyph in
24817 row area AREA of glyph row ROW that is part of the new glyph
24818 string. END is the index of the last glyph in that glyph row area.
24819 X is the current output position assigned to the new glyph string
24820 constructed. HL overrides that face of the glyph; e.g. it is
24821 DRAW_CURSOR if a cursor has to be drawn. LAST_X is the right-most
24822 x-position of the drawing area. */
24824 #define BUILD_COMPOSITE_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24826 int face_id = (row)->glyphs[area][START].face_id; \
24827 struct face *base_face = FACE_FROM_ID (f, face_id); \
24828 ptrdiff_t cmp_id = (row)->glyphs[area][START].u.cmp.id; \
24829 struct composition *cmp = composition_table[cmp_id]; \
24831 struct glyph_string *first_s = NULL; \
24834 SAFE_NALLOCA (char2b, 1, cmp->glyph_len); \
24836 /* Make glyph_strings for each glyph sequence that is drawable by \
24837 the same face, and append them to HEAD/TAIL. */ \
24838 for (n = 0; n < cmp->glyph_len;) \
24840 s = alloca (sizeof *s); \
24841 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24842 append_glyph_string (&(HEAD), &(TAIL), s); \
24848 n = fill_composite_glyph_string (s, base_face, overlaps); \
24856 /* Add a glyph string for a glyph-string sequence to the list of strings
24857 between HEAD and TAIL. */
24859 #define BUILD_GSTRING_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24863 Lisp_Object gstring; \
24865 face_id = (row)->glyphs[area][START].face_id; \
24866 gstring = (composition_gstring_from_id \
24867 ((row)->glyphs[area][START].u.cmp.id)); \
24868 s = alloca (sizeof *s); \
24869 SAFE_NALLOCA (char2b, 1, LGSTRING_GLYPH_LEN (gstring)); \
24870 INIT_GLYPH_STRING (s, char2b, w, row, area, START, HL); \
24871 append_glyph_string (&(HEAD), &(TAIL), s); \
24873 START = fill_gstring_glyph_string (s, face_id, START, END, overlaps); \
24877 /* Add a glyph string for a sequence of glyphless character's glyphs
24878 to the list of strings between HEAD and TAIL. The meanings of
24879 arguments are the same as those of BUILD_CHAR_GLYPH_STRINGS. */
24881 #define BUILD_GLYPHLESS_GLYPH_STRING(START, END, HEAD, TAIL, HL, X, LAST_X) \
24886 face_id = (row)->glyphs[area][START].face_id; \
24888 s = alloca (sizeof *s); \
24889 INIT_GLYPH_STRING (s, NULL, w, row, area, START, HL); \
24890 append_glyph_string (&HEAD, &TAIL, s); \
24892 START = fill_glyphless_glyph_string (s, face_id, START, END, \
24898 /* Build a list of glyph strings between HEAD and TAIL for the glyphs
24899 of AREA of glyph row ROW on window W between indices START and END.
24900 HL overrides the face for drawing glyph strings, e.g. it is
24901 DRAW_CURSOR to draw a cursor. X and LAST_X are start and end
24902 x-positions of the drawing area.
24904 This is an ugly monster macro construct because we must use alloca
24905 to allocate glyph strings (because draw_glyphs can be called
24906 asynchronously). */
24908 #define BUILD_GLYPH_STRINGS(START, END, HEAD, TAIL, HL, X, LAST_X) \
24911 HEAD = TAIL = NULL; \
24912 while (START < END) \
24914 struct glyph *first_glyph = (row)->glyphs[area] + START; \
24915 switch (first_glyph->type) \
24918 BUILD_CHAR_GLYPH_STRINGS (START, END, HEAD, TAIL, \
24922 case COMPOSITE_GLYPH: \
24923 if (first_glyph->u.cmp.automatic) \
24924 BUILD_GSTRING_GLYPH_STRING (START, END, HEAD, TAIL, \
24927 BUILD_COMPOSITE_GLYPH_STRING (START, END, HEAD, TAIL, \
24931 case STRETCH_GLYPH: \
24932 BUILD_STRETCH_GLYPH_STRING (START, END, HEAD, TAIL, \
24936 case IMAGE_GLYPH: \
24937 BUILD_IMAGE_GLYPH_STRING (START, END, HEAD, TAIL, \
24941 case GLYPHLESS_GLYPH: \
24942 BUILD_GLYPHLESS_GLYPH_STRING (START, END, HEAD, TAIL, \
24952 set_glyph_string_background_width (s, START, LAST_X); \
24959 /* Draw glyphs between START and END in AREA of ROW on window W,
24960 starting at x-position X. X is relative to AREA in W. HL is a
24961 face-override with the following meaning:
24963 DRAW_NORMAL_TEXT draw normally
24964 DRAW_CURSOR draw in cursor face
24965 DRAW_MOUSE_FACE draw in mouse face.
24966 DRAW_INVERSE_VIDEO draw in mode line face
24967 DRAW_IMAGE_SUNKEN draw an image with a sunken relief around it
24968 DRAW_IMAGE_RAISED draw an image with a raised relief around it
24970 If OVERLAPS is non-zero, draw only the foreground of characters and
24971 clip to the physical height of ROW. Non-zero value also defines
24972 the overlapping part to be drawn:
24974 OVERLAPS_PRED overlap with preceding rows
24975 OVERLAPS_SUCC overlap with succeeding rows
24976 OVERLAPS_BOTH overlap with both preceding/succeeding rows
24977 OVERLAPS_ERASED_CURSOR overlap with erased cursor area
24979 Value is the x-position reached, relative to AREA of W. */
24982 draw_glyphs (struct window
*w
, int x
, struct glyph_row
*row
,
24983 enum glyph_row_area area
, ptrdiff_t start
, ptrdiff_t end
,
24984 enum draw_glyphs_face hl
, int overlaps
)
24986 struct glyph_string
*head
, *tail
;
24987 struct glyph_string
*s
;
24988 struct glyph_string
*clip_head
= NULL
, *clip_tail
= NULL
;
24989 int i
, j
, x_reached
, last_x
, area_left
= 0;
24990 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
24993 ALLOCATE_HDC (hdc
, f
);
24995 /* Let's rather be paranoid than getting a SEGV. */
24996 end
= min (end
, row
->used
[area
]);
24997 start
= clip_to_bounds (0, start
, end
);
24999 /* Translate X to frame coordinates. Set last_x to the right
25000 end of the drawing area. */
25001 if (row
->full_width_p
)
25003 /* X is relative to the left edge of W, without scroll bars
25005 area_left
= WINDOW_LEFT_EDGE_X (w
);
25006 last_x
= (WINDOW_LEFT_EDGE_X (w
) + WINDOW_PIXEL_WIDTH (w
)
25007 - (row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
25011 area_left
= window_box_left (w
, area
);
25012 last_x
= area_left
+ window_box_width (w
, area
);
25016 /* Build a doubly-linked list of glyph_string structures between
25017 head and tail from what we have to draw. Note that the macro
25018 BUILD_GLYPH_STRINGS will modify its start parameter. That's
25019 the reason we use a separate variable `i'. */
25022 BUILD_GLYPH_STRINGS (i
, end
, head
, tail
, hl
, x
, last_x
);
25024 x_reached
= tail
->x
+ tail
->background_width
;
25028 /* If there are any glyphs with lbearing < 0 or rbearing > width in
25029 the row, redraw some glyphs in front or following the glyph
25030 strings built above. */
25031 if (head
&& !overlaps
&& row
->contains_overlapping_glyphs_p
)
25033 struct glyph_string
*h
, *t
;
25034 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
25035 int mouse_beg_col
IF_LINT (= 0), mouse_end_col
IF_LINT (= 0);
25036 int check_mouse_face
= 0;
25039 /* If mouse highlighting is on, we may need to draw adjacent
25040 glyphs using mouse-face highlighting. */
25041 if (area
== TEXT_AREA
&& row
->mouse_face_p
25042 && hlinfo
->mouse_face_beg_row
>= 0
25043 && hlinfo
->mouse_face_end_row
>= 0)
25045 ptrdiff_t row_vpos
= MATRIX_ROW_VPOS (row
, w
->current_matrix
);
25047 if (row_vpos
>= hlinfo
->mouse_face_beg_row
25048 && row_vpos
<= hlinfo
->mouse_face_end_row
)
25050 check_mouse_face
= 1;
25051 mouse_beg_col
= (row_vpos
== hlinfo
->mouse_face_beg_row
)
25052 ? hlinfo
->mouse_face_beg_col
: 0;
25053 mouse_end_col
= (row_vpos
== hlinfo
->mouse_face_end_row
)
25054 ? hlinfo
->mouse_face_end_col
25055 : row
->used
[TEXT_AREA
];
25059 /* Compute overhangs for all glyph strings. */
25060 if (FRAME_RIF (f
)->compute_glyph_string_overhangs
)
25061 for (s
= head
; s
; s
= s
->next
)
25062 FRAME_RIF (f
)->compute_glyph_string_overhangs (s
);
25064 /* Prepend glyph strings for glyphs in front of the first glyph
25065 string that are overwritten because of the first glyph
25066 string's left overhang. The background of all strings
25067 prepended must be drawn because the first glyph string
25069 i
= left_overwritten (head
);
25072 enum draw_glyphs_face overlap_hl
;
25074 /* If this row contains mouse highlighting, attempt to draw
25075 the overlapped glyphs with the correct highlight. This
25076 code fails if the overlap encompasses more than one glyph
25077 and mouse-highlight spans only some of these glyphs.
25078 However, making it work perfectly involves a lot more
25079 code, and I don't know if the pathological case occurs in
25080 practice, so we'll stick to this for now. --- cyd */
25081 if (check_mouse_face
25082 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25083 overlap_hl
= DRAW_MOUSE_FACE
;
25085 overlap_hl
= DRAW_NORMAL_TEXT
;
25087 if (hl
!= overlap_hl
)
25090 BUILD_GLYPH_STRINGS (j
, start
, h
, t
,
25091 overlap_hl
, dummy_x
, last_x
);
25093 compute_overhangs_and_x (t
, head
->x
, 1);
25094 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25095 if (clip_head
== NULL
)
25099 /* Prepend glyph strings for glyphs in front of the first glyph
25100 string that overwrite that glyph string because of their
25101 right overhang. For these strings, only the foreground must
25102 be drawn, because it draws over the glyph string at `head'.
25103 The background must not be drawn because this would overwrite
25104 right overhangs of preceding glyphs for which no glyph
25106 i
= left_overwriting (head
);
25109 enum draw_glyphs_face overlap_hl
;
25111 if (check_mouse_face
25112 && mouse_beg_col
< start
&& mouse_end_col
> i
)
25113 overlap_hl
= DRAW_MOUSE_FACE
;
25115 overlap_hl
= DRAW_NORMAL_TEXT
;
25117 if (hl
== overlap_hl
|| clip_head
== NULL
)
25119 BUILD_GLYPH_STRINGS (i
, start
, h
, t
,
25120 overlap_hl
, dummy_x
, last_x
);
25121 for (s
= h
; s
; s
= s
->next
)
25122 s
->background_filled_p
= 1;
25123 compute_overhangs_and_x (t
, head
->x
, 1);
25124 prepend_glyph_string_lists (&head
, &tail
, h
, t
);
25127 /* Append glyphs strings for glyphs following the last glyph
25128 string tail that are overwritten by tail. The background of
25129 these strings has to be drawn because tail's foreground draws
25131 i
= right_overwritten (tail
);
25134 enum draw_glyphs_face overlap_hl
;
25136 if (check_mouse_face
25137 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25138 overlap_hl
= DRAW_MOUSE_FACE
;
25140 overlap_hl
= DRAW_NORMAL_TEXT
;
25142 if (hl
!= overlap_hl
)
25144 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25145 overlap_hl
, x
, last_x
);
25146 /* Because BUILD_GLYPH_STRINGS updates the first argument,
25147 we don't have `end = i;' here. */
25148 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25149 append_glyph_string_lists (&head
, &tail
, h
, t
);
25150 if (clip_tail
== NULL
)
25154 /* Append glyph strings for glyphs following the last glyph
25155 string tail that overwrite tail. The foreground of such
25156 glyphs has to be drawn because it writes into the background
25157 of tail. The background must not be drawn because it could
25158 paint over the foreground of following glyphs. */
25159 i
= right_overwriting (tail
);
25162 enum draw_glyphs_face overlap_hl
;
25163 if (check_mouse_face
25164 && mouse_beg_col
< i
&& mouse_end_col
> end
)
25165 overlap_hl
= DRAW_MOUSE_FACE
;
25167 overlap_hl
= DRAW_NORMAL_TEXT
;
25169 if (hl
== overlap_hl
|| clip_tail
== NULL
)
25171 i
++; /* We must include the Ith glyph. */
25172 BUILD_GLYPH_STRINGS (end
, i
, h
, t
,
25173 overlap_hl
, x
, last_x
);
25174 for (s
= h
; s
; s
= s
->next
)
25175 s
->background_filled_p
= 1;
25176 compute_overhangs_and_x (h
, tail
->x
+ tail
->width
, 0);
25177 append_glyph_string_lists (&head
, &tail
, h
, t
);
25179 if (clip_head
|| clip_tail
)
25180 for (s
= head
; s
; s
= s
->next
)
25182 s
->clip_head
= clip_head
;
25183 s
->clip_tail
= clip_tail
;
25187 /* Draw all strings. */
25188 for (s
= head
; s
; s
= s
->next
)
25189 FRAME_RIF (f
)->draw_glyph_string (s
);
25192 /* When focus a sole frame and move horizontally, this sets on_p to 0
25193 causing a failure to erase prev cursor position. */
25194 if (area
== TEXT_AREA
25195 && !row
->full_width_p
25196 /* When drawing overlapping rows, only the glyph strings'
25197 foreground is drawn, which doesn't erase a cursor
25201 int x0
= clip_head
? clip_head
->x
: (head
? head
->x
: x
);
25202 int x1
= (clip_tail
? clip_tail
->x
+ clip_tail
->background_width
25203 : (tail
? tail
->x
+ tail
->background_width
: x
));
25207 notice_overwritten_cursor (w
, TEXT_AREA
, x0
, x1
,
25208 row
->y
, MATRIX_ROW_BOTTOM_Y (row
));
25212 /* Value is the x-position up to which drawn, relative to AREA of W.
25213 This doesn't include parts drawn because of overhangs. */
25214 if (row
->full_width_p
)
25215 x_reached
= FRAME_TO_WINDOW_PIXEL_X (w
, x_reached
);
25217 x_reached
-= area_left
;
25219 RELEASE_HDC (hdc
, f
);
25225 /* Expand row matrix if too narrow. Don't expand if area
25228 #define IT_EXPAND_MATRIX_WIDTH(it, area) \
25230 if (!it->f->fonts_changed \
25231 && (it->glyph_row->glyphs[area] \
25232 < it->glyph_row->glyphs[area + 1])) \
25234 it->w->ncols_scale_factor++; \
25235 it->f->fonts_changed = 1; \
25239 /* Store one glyph for IT->char_to_display in IT->glyph_row.
25240 Called from x_produce_glyphs when IT->glyph_row is non-null. */
25243 append_glyph (struct it
*it
)
25245 struct glyph
*glyph
;
25246 enum glyph_row_area area
= it
->area
;
25248 eassert (it
->glyph_row
);
25249 eassert (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t');
25251 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25252 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25254 /* If the glyph row is reversed, we need to prepend the glyph
25255 rather than append it. */
25256 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25260 /* Make room for the additional glyph. */
25261 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25263 glyph
= it
->glyph_row
->glyphs
[area
];
25265 glyph
->charpos
= CHARPOS (it
->position
);
25266 glyph
->object
= it
->object
;
25267 if (it
->pixel_width
> 0)
25269 glyph
->pixel_width
= it
->pixel_width
;
25270 glyph
->padding_p
= 0;
25274 /* Assure at least 1-pixel width. Otherwise, cursor can't
25275 be displayed correctly. */
25276 glyph
->pixel_width
= 1;
25277 glyph
->padding_p
= 1;
25279 glyph
->ascent
= it
->ascent
;
25280 glyph
->descent
= it
->descent
;
25281 glyph
->voffset
= it
->voffset
;
25282 glyph
->type
= CHAR_GLYPH
;
25283 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25284 glyph
->multibyte_p
= it
->multibyte_p
;
25285 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25287 /* In R2L rows, the left and the right box edges need to be
25288 drawn in reverse direction. */
25289 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25290 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25294 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25295 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25297 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25298 || it
->phys_descent
> it
->descent
);
25299 glyph
->glyph_not_available_p
= it
->glyph_not_available_p
;
25300 glyph
->face_id
= it
->face_id
;
25301 glyph
->u
.ch
= it
->char_to_display
;
25302 glyph
->slice
.img
= null_glyph_slice
;
25303 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25306 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25307 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25308 glyph
->bidi_type
= it
->bidi_it
.type
;
25312 glyph
->resolved_level
= 0;
25313 glyph
->bidi_type
= UNKNOWN_BT
;
25315 ++it
->glyph_row
->used
[area
];
25318 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25321 /* Store one glyph for the composition IT->cmp_it.id in
25322 IT->glyph_row. Called from x_produce_glyphs when IT->glyph_row is
25326 append_composite_glyph (struct it
*it
)
25328 struct glyph
*glyph
;
25329 enum glyph_row_area area
= it
->area
;
25331 eassert (it
->glyph_row
);
25333 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25334 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25336 /* If the glyph row is reversed, we need to prepend the glyph
25337 rather than append it. */
25338 if (it
->glyph_row
->reversed_p
&& it
->area
== TEXT_AREA
)
25342 /* Make room for the new glyph. */
25343 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[it
->area
]; g
--)
25345 glyph
= it
->glyph_row
->glyphs
[it
->area
];
25347 glyph
->charpos
= it
->cmp_it
.charpos
;
25348 glyph
->object
= it
->object
;
25349 glyph
->pixel_width
= it
->pixel_width
;
25350 glyph
->ascent
= it
->ascent
;
25351 glyph
->descent
= it
->descent
;
25352 glyph
->voffset
= it
->voffset
;
25353 glyph
->type
= COMPOSITE_GLYPH
;
25354 if (it
->cmp_it
.ch
< 0)
25356 glyph
->u
.cmp
.automatic
= 0;
25357 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25358 glyph
->slice
.cmp
.from
= glyph
->slice
.cmp
.to
= 0;
25362 glyph
->u
.cmp
.automatic
= 1;
25363 glyph
->u
.cmp
.id
= it
->cmp_it
.id
;
25364 glyph
->slice
.cmp
.from
= it
->cmp_it
.from
;
25365 glyph
->slice
.cmp
.to
= it
->cmp_it
.to
- 1;
25367 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25368 glyph
->multibyte_p
= it
->multibyte_p
;
25369 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25371 /* In R2L rows, the left and the right box edges need to be
25372 drawn in reverse direction. */
25373 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25374 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25378 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25379 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25381 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
25382 || it
->phys_descent
> it
->descent
);
25383 glyph
->padding_p
= 0;
25384 glyph
->glyph_not_available_p
= 0;
25385 glyph
->face_id
= it
->face_id
;
25386 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25389 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25390 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25391 glyph
->bidi_type
= it
->bidi_it
.type
;
25393 ++it
->glyph_row
->used
[area
];
25396 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25400 /* Change IT->ascent and IT->height according to the setting of
25404 take_vertical_position_into_account (struct it
*it
)
25408 if (it
->voffset
< 0)
25409 /* Increase the ascent so that we can display the text higher
25411 it
->ascent
-= it
->voffset
;
25413 /* Increase the descent so that we can display the text lower
25415 it
->descent
+= it
->voffset
;
25420 /* Produce glyphs/get display metrics for the image IT is loaded with.
25421 See the description of struct display_iterator in dispextern.h for
25422 an overview of struct display_iterator. */
25425 produce_image_glyph (struct it
*it
)
25429 int glyph_ascent
, crop
;
25430 struct glyph_slice slice
;
25432 eassert (it
->what
== IT_IMAGE
);
25434 face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25436 /* Make sure X resources of the face is loaded. */
25437 prepare_face_for_display (it
->f
, face
);
25439 if (it
->image_id
< 0)
25441 /* Fringe bitmap. */
25442 it
->ascent
= it
->phys_ascent
= 0;
25443 it
->descent
= it
->phys_descent
= 0;
25444 it
->pixel_width
= 0;
25449 img
= IMAGE_FROM_ID (it
->f
, it
->image_id
);
25451 /* Make sure X resources of the image is loaded. */
25452 prepare_image_for_display (it
->f
, img
);
25454 slice
.x
= slice
.y
= 0;
25455 slice
.width
= img
->width
;
25456 slice
.height
= img
->height
;
25458 if (INTEGERP (it
->slice
.x
))
25459 slice
.x
= XINT (it
->slice
.x
);
25460 else if (FLOATP (it
->slice
.x
))
25461 slice
.x
= XFLOAT_DATA (it
->slice
.x
) * img
->width
;
25463 if (INTEGERP (it
->slice
.y
))
25464 slice
.y
= XINT (it
->slice
.y
);
25465 else if (FLOATP (it
->slice
.y
))
25466 slice
.y
= XFLOAT_DATA (it
->slice
.y
) * img
->height
;
25468 if (INTEGERP (it
->slice
.width
))
25469 slice
.width
= XINT (it
->slice
.width
);
25470 else if (FLOATP (it
->slice
.width
))
25471 slice
.width
= XFLOAT_DATA (it
->slice
.width
) * img
->width
;
25473 if (INTEGERP (it
->slice
.height
))
25474 slice
.height
= XINT (it
->slice
.height
);
25475 else if (FLOATP (it
->slice
.height
))
25476 slice
.height
= XFLOAT_DATA (it
->slice
.height
) * img
->height
;
25478 if (slice
.x
>= img
->width
)
25479 slice
.x
= img
->width
;
25480 if (slice
.y
>= img
->height
)
25481 slice
.y
= img
->height
;
25482 if (slice
.x
+ slice
.width
>= img
->width
)
25483 slice
.width
= img
->width
- slice
.x
;
25484 if (slice
.y
+ slice
.height
> img
->height
)
25485 slice
.height
= img
->height
- slice
.y
;
25487 if (slice
.width
== 0 || slice
.height
== 0)
25490 it
->ascent
= it
->phys_ascent
= glyph_ascent
= image_ascent (img
, face
, &slice
);
25492 it
->descent
= slice
.height
- glyph_ascent
;
25494 it
->descent
+= img
->vmargin
;
25495 if (slice
.y
+ slice
.height
== img
->height
)
25496 it
->descent
+= img
->vmargin
;
25497 it
->phys_descent
= it
->descent
;
25499 it
->pixel_width
= slice
.width
;
25501 it
->pixel_width
+= img
->hmargin
;
25502 if (slice
.x
+ slice
.width
== img
->width
)
25503 it
->pixel_width
+= img
->hmargin
;
25505 /* It's quite possible for images to have an ascent greater than
25506 their height, so don't get confused in that case. */
25507 if (it
->descent
< 0)
25512 if (face
->box
!= FACE_NO_BOX
)
25514 if (face
->box_line_width
> 0)
25517 it
->ascent
+= face
->box_line_width
;
25518 if (slice
.y
+ slice
.height
== img
->height
)
25519 it
->descent
+= face
->box_line_width
;
25522 if (it
->start_of_box_run_p
&& slice
.x
== 0)
25523 it
->pixel_width
+= eabs (face
->box_line_width
);
25524 if (it
->end_of_box_run_p
&& slice
.x
+ slice
.width
== img
->width
)
25525 it
->pixel_width
+= eabs (face
->box_line_width
);
25528 take_vertical_position_into_account (it
);
25530 /* Automatically crop wide image glyphs at right edge so we can
25531 draw the cursor on same display row. */
25532 if ((crop
= it
->pixel_width
- (it
->last_visible_x
- it
->current_x
), crop
> 0)
25533 && (it
->hpos
== 0 || it
->pixel_width
> it
->last_visible_x
/ 4))
25535 it
->pixel_width
-= crop
;
25536 slice
.width
-= crop
;
25541 struct glyph
*glyph
;
25542 enum glyph_row_area area
= it
->area
;
25544 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25545 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25547 glyph
->charpos
= CHARPOS (it
->position
);
25548 glyph
->object
= it
->object
;
25549 glyph
->pixel_width
= it
->pixel_width
;
25550 glyph
->ascent
= glyph_ascent
;
25551 glyph
->descent
= it
->descent
;
25552 glyph
->voffset
= it
->voffset
;
25553 glyph
->type
= IMAGE_GLYPH
;
25554 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25555 glyph
->multibyte_p
= it
->multibyte_p
;
25556 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25558 /* In R2L rows, the left and the right box edges need to be
25559 drawn in reverse direction. */
25560 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25561 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25565 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25566 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25568 glyph
->overlaps_vertically_p
= 0;
25569 glyph
->padding_p
= 0;
25570 glyph
->glyph_not_available_p
= 0;
25571 glyph
->face_id
= it
->face_id
;
25572 glyph
->u
.img_id
= img
->id
;
25573 glyph
->slice
.img
= slice
;
25574 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25577 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25578 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25579 glyph
->bidi_type
= it
->bidi_it
.type
;
25581 ++it
->glyph_row
->used
[area
];
25584 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25589 /* Append a stretch glyph to IT->glyph_row. OBJECT is the source
25590 of the glyph, WIDTH and HEIGHT are the width and height of the
25591 stretch. ASCENT is the ascent of the glyph (0 <= ASCENT <= HEIGHT). */
25594 append_stretch_glyph (struct it
*it
, Lisp_Object object
,
25595 int width
, int height
, int ascent
)
25597 struct glyph
*glyph
;
25598 enum glyph_row_area area
= it
->area
;
25600 eassert (ascent
>= 0 && ascent
<= height
);
25602 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
25603 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
25605 /* If the glyph row is reversed, we need to prepend the glyph
25606 rather than append it. */
25607 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25611 /* Make room for the additional glyph. */
25612 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
25614 glyph
= it
->glyph_row
->glyphs
[area
];
25616 /* Decrease the width of the first glyph of the row that
25617 begins before first_visible_x (e.g., due to hscroll).
25618 This is so the overall width of the row becomes smaller
25619 by the scroll amount, and the stretch glyph appended by
25620 extend_face_to_end_of_line will be wider, to shift the
25621 row glyphs to the right. (In L2R rows, the corresponding
25622 left-shift effect is accomplished by setting row->x to a
25623 negative value, which won't work with R2L rows.)
25625 This must leave us with a positive value of WIDTH, since
25626 otherwise the call to move_it_in_display_line_to at the
25627 beginning of display_line would have got past the entire
25628 first glyph, and then it->current_x would have been
25629 greater or equal to it->first_visible_x. */
25630 if (it
->current_x
< it
->first_visible_x
)
25631 width
-= it
->first_visible_x
- it
->current_x
;
25632 eassert (width
> 0);
25634 glyph
->charpos
= CHARPOS (it
->position
);
25635 glyph
->object
= object
;
25636 glyph
->pixel_width
= width
;
25637 glyph
->ascent
= ascent
;
25638 glyph
->descent
= height
- ascent
;
25639 glyph
->voffset
= it
->voffset
;
25640 glyph
->type
= STRETCH_GLYPH
;
25641 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
25642 glyph
->multibyte_p
= it
->multibyte_p
;
25643 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
25645 /* In R2L rows, the left and the right box edges need to be
25646 drawn in reverse direction. */
25647 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
25648 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
25652 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
25653 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
25655 glyph
->overlaps_vertically_p
= 0;
25656 glyph
->padding_p
= 0;
25657 glyph
->glyph_not_available_p
= 0;
25658 glyph
->face_id
= it
->face_id
;
25659 glyph
->u
.stretch
.ascent
= ascent
;
25660 glyph
->u
.stretch
.height
= height
;
25661 glyph
->slice
.img
= null_glyph_slice
;
25662 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
25665 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
25666 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
25667 glyph
->bidi_type
= it
->bidi_it
.type
;
25671 glyph
->resolved_level
= 0;
25672 glyph
->bidi_type
= UNKNOWN_BT
;
25674 ++it
->glyph_row
->used
[area
];
25677 IT_EXPAND_MATRIX_WIDTH (it
, area
);
25680 #endif /* HAVE_WINDOW_SYSTEM */
25682 /* Produce a stretch glyph for iterator IT. IT->object is the value
25683 of the glyph property displayed. The value must be a list
25684 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
25687 1. `:width WIDTH' specifies that the space should be WIDTH *
25688 canonical char width wide. WIDTH may be an integer or floating
25691 2. `:relative-width FACTOR' specifies that the width of the stretch
25692 should be computed from the width of the first character having the
25693 `glyph' property, and should be FACTOR times that width.
25695 3. `:align-to HPOS' specifies that the space should be wide enough
25696 to reach HPOS, a value in canonical character units.
25698 Exactly one of the above pairs must be present.
25700 4. `:height HEIGHT' specifies that the height of the stretch produced
25701 should be HEIGHT, measured in canonical character units.
25703 5. `:relative-height FACTOR' specifies that the height of the
25704 stretch should be FACTOR times the height of the characters having
25705 the glyph property.
25707 Either none or exactly one of 4 or 5 must be present.
25709 6. `:ascent ASCENT' specifies that ASCENT percent of the height
25710 of the stretch should be used for the ascent of the stretch.
25711 ASCENT must be in the range 0 <= ASCENT <= 100. */
25714 produce_stretch_glyph (struct it
*it
)
25716 /* (space :width WIDTH :height HEIGHT ...) */
25717 Lisp_Object prop
, plist
;
25718 int width
= 0, height
= 0, align_to
= -1;
25719 int zero_width_ok_p
= 0;
25721 struct font
*font
= NULL
;
25723 #ifdef HAVE_WINDOW_SYSTEM
25725 int zero_height_ok_p
= 0;
25727 if (FRAME_WINDOW_P (it
->f
))
25729 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
25730 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
25731 prepare_face_for_display (it
->f
, face
);
25735 /* List should start with `space'. */
25736 eassert (CONSP (it
->object
) && EQ (XCAR (it
->object
), Qspace
));
25737 plist
= XCDR (it
->object
);
25739 /* Compute the width of the stretch. */
25740 if ((prop
= Fplist_get (plist
, QCwidth
), !NILP (prop
))
25741 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, 0))
25743 /* Absolute width `:width WIDTH' specified and valid. */
25744 zero_width_ok_p
= 1;
25747 #ifdef HAVE_WINDOW_SYSTEM
25748 else if (FRAME_WINDOW_P (it
->f
)
25749 && (prop
= Fplist_get (plist
, QCrelative_width
), NUMVAL (prop
) > 0))
25751 /* Relative width `:relative-width FACTOR' specified and valid.
25752 Compute the width of the characters having the `glyph'
25755 unsigned char *p
= BYTE_POS_ADDR (IT_BYTEPOS (*it
));
25758 if (it
->multibyte_p
)
25759 it2
.c
= it2
.char_to_display
= STRING_CHAR_AND_LENGTH (p
, it2
.len
);
25762 it2
.c
= it2
.char_to_display
= *p
, it2
.len
= 1;
25763 if (! ASCII_CHAR_P (it2
.c
))
25764 it2
.char_to_display
= BYTE8_TO_CHAR (it2
.c
);
25767 it2
.glyph_row
= NULL
;
25768 it2
.what
= IT_CHARACTER
;
25769 x_produce_glyphs (&it2
);
25770 width
= NUMVAL (prop
) * it2
.pixel_width
;
25772 #endif /* HAVE_WINDOW_SYSTEM */
25773 else if ((prop
= Fplist_get (plist
, QCalign_to
), !NILP (prop
))
25774 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 1, &align_to
))
25776 if (it
->glyph_row
== NULL
|| !it
->glyph_row
->mode_line_p
)
25777 align_to
= (align_to
< 0
25779 : align_to
- window_box_left_offset (it
->w
, TEXT_AREA
));
25780 else if (align_to
< 0)
25781 align_to
= window_box_left_offset (it
->w
, TEXT_AREA
);
25782 width
= max (0, (int)tem
+ align_to
- it
->current_x
);
25783 zero_width_ok_p
= 1;
25786 /* Nothing specified -> width defaults to canonical char width. */
25787 width
= FRAME_COLUMN_WIDTH (it
->f
);
25789 if (width
<= 0 && (width
< 0 || !zero_width_ok_p
))
25792 #ifdef HAVE_WINDOW_SYSTEM
25793 /* Compute height. */
25794 if (FRAME_WINDOW_P (it
->f
))
25796 if ((prop
= Fplist_get (plist
, QCheight
), !NILP (prop
))
25797 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25800 zero_height_ok_p
= 1;
25802 else if (prop
= Fplist_get (plist
, QCrelative_height
),
25804 height
= FONT_HEIGHT (font
) * NUMVAL (prop
);
25806 height
= FONT_HEIGHT (font
);
25808 if (height
<= 0 && (height
< 0 || !zero_height_ok_p
))
25811 /* Compute percentage of height used for ascent. If
25812 `:ascent ASCENT' is present and valid, use that. Otherwise,
25813 derive the ascent from the font in use. */
25814 if (prop
= Fplist_get (plist
, QCascent
),
25815 NUMVAL (prop
) > 0 && NUMVAL (prop
) <= 100)
25816 ascent
= height
* NUMVAL (prop
) / 100.0;
25817 else if (!NILP (prop
)
25818 && calc_pixel_width_or_height (&tem
, it
, prop
, font
, 0, 0))
25819 ascent
= min (max (0, (int)tem
), height
);
25821 ascent
= (height
* FONT_BASE (font
)) / FONT_HEIGHT (font
);
25824 #endif /* HAVE_WINDOW_SYSTEM */
25827 if (width
> 0 && it
->line_wrap
!= TRUNCATE
25828 && it
->current_x
+ width
> it
->last_visible_x
)
25830 width
= it
->last_visible_x
- it
->current_x
;
25831 #ifdef HAVE_WINDOW_SYSTEM
25832 /* Subtract one more pixel from the stretch width, but only on
25833 GUI frames, since on a TTY each glyph is one "pixel" wide. */
25834 width
-= FRAME_WINDOW_P (it
->f
);
25838 if (width
> 0 && height
> 0 && it
->glyph_row
)
25840 Lisp_Object o_object
= it
->object
;
25841 Lisp_Object object
= it
->stack
[it
->sp
- 1].string
;
25844 if (!STRINGP (object
))
25845 object
= it
->w
->contents
;
25846 #ifdef HAVE_WINDOW_SYSTEM
25847 if (FRAME_WINDOW_P (it
->f
))
25848 append_stretch_glyph (it
, object
, width
, height
, ascent
);
25852 it
->object
= object
;
25853 it
->char_to_display
= ' ';
25854 it
->pixel_width
= it
->len
= 1;
25856 tty_append_glyph (it
);
25857 it
->object
= o_object
;
25861 it
->pixel_width
= width
;
25862 #ifdef HAVE_WINDOW_SYSTEM
25863 if (FRAME_WINDOW_P (it
->f
))
25865 it
->ascent
= it
->phys_ascent
= ascent
;
25866 it
->descent
= it
->phys_descent
= height
- it
->ascent
;
25867 it
->nglyphs
= width
> 0 && height
> 0 ? 1 : 0;
25868 take_vertical_position_into_account (it
);
25872 it
->nglyphs
= width
;
25875 /* Get information about special display element WHAT in an
25876 environment described by IT. WHAT is one of IT_TRUNCATION or
25877 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
25878 non-null glyph_row member. This function ensures that fields like
25879 face_id, c, len of IT are left untouched. */
25882 produce_special_glyphs (struct it
*it
, enum display_element_type what
)
25889 temp_it
.object
= make_number (0);
25890 memset (&temp_it
.current
, 0, sizeof temp_it
.current
);
25892 if (what
== IT_CONTINUATION
)
25894 /* Continuation glyph. For R2L lines, we mirror it by hand. */
25895 if (it
->bidi_it
.paragraph_dir
== R2L
)
25896 SET_GLYPH_FROM_CHAR (glyph
, '/');
25898 SET_GLYPH_FROM_CHAR (glyph
, '\\');
25900 && (gc
= DISP_CONTINUE_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25902 /* FIXME: Should we mirror GC for R2L lines? */
25903 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25904 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25907 else if (what
== IT_TRUNCATION
)
25909 /* Truncation glyph. */
25910 SET_GLYPH_FROM_CHAR (glyph
, '$');
25912 && (gc
= DISP_TRUNC_GLYPH (it
->dp
), GLYPH_CODE_P (gc
)))
25914 /* FIXME: Should we mirror GC for R2L lines? */
25915 SET_GLYPH_FROM_GLYPH_CODE (glyph
, gc
);
25916 spec_glyph_lookup_face (XWINDOW (it
->window
), &glyph
);
25922 #ifdef HAVE_WINDOW_SYSTEM
25923 /* On a GUI frame, when the right fringe (left fringe for R2L rows)
25924 is turned off, we precede the truncation/continuation glyphs by a
25925 stretch glyph whose width is computed such that these special
25926 glyphs are aligned at the window margin, even when very different
25927 fonts are used in different glyph rows. */
25928 if (FRAME_WINDOW_P (temp_it
.f
)
25929 /* init_iterator calls this with it->glyph_row == NULL, and it
25930 wants only the pixel width of the truncation/continuation
25932 && temp_it
.glyph_row
25933 /* insert_left_trunc_glyphs calls us at the beginning of the
25934 row, and it has its own calculation of the stretch glyph
25936 && temp_it
.glyph_row
->used
[TEXT_AREA
] > 0
25937 && (temp_it
.glyph_row
->reversed_p
25938 ? WINDOW_LEFT_FRINGE_WIDTH (temp_it
.w
)
25939 : WINDOW_RIGHT_FRINGE_WIDTH (temp_it
.w
)) == 0)
25941 int stretch_width
= temp_it
.last_visible_x
- temp_it
.current_x
;
25943 if (stretch_width
> 0)
25945 struct face
*face
= FACE_FROM_ID (temp_it
.f
, temp_it
.face_id
);
25946 struct font
*font
=
25947 face
->font
? face
->font
: FRAME_FONT (temp_it
.f
);
25948 int stretch_ascent
=
25949 (((temp_it
.ascent
+ temp_it
.descent
)
25950 * FONT_BASE (font
)) / FONT_HEIGHT (font
));
25952 append_stretch_glyph (&temp_it
, make_number (0), stretch_width
,
25953 temp_it
.ascent
+ temp_it
.descent
,
25960 temp_it
.what
= IT_CHARACTER
;
25961 temp_it
.c
= temp_it
.char_to_display
= GLYPH_CHAR (glyph
);
25962 temp_it
.face_id
= GLYPH_FACE (glyph
);
25963 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
25965 PRODUCE_GLYPHS (&temp_it
);
25966 it
->pixel_width
= temp_it
.pixel_width
;
25967 it
->nglyphs
= temp_it
.nglyphs
;
25970 #ifdef HAVE_WINDOW_SYSTEM
25972 /* Calculate line-height and line-spacing properties.
25973 An integer value specifies explicit pixel value.
25974 A float value specifies relative value to current face height.
25975 A cons (float . face-name) specifies relative value to
25976 height of specified face font.
25978 Returns height in pixels, or nil. */
25982 calc_line_height_property (struct it
*it
, Lisp_Object val
, struct font
*font
,
25983 int boff
, int override
)
25985 Lisp_Object face_name
= Qnil
;
25986 int ascent
, descent
, height
;
25988 if (NILP (val
) || INTEGERP (val
) || (override
&& EQ (val
, Qt
)))
25993 face_name
= XCAR (val
);
25995 if (!NUMBERP (val
))
25996 val
= make_number (1);
25997 if (NILP (face_name
))
25999 height
= it
->ascent
+ it
->descent
;
26004 if (NILP (face_name
))
26006 font
= FRAME_FONT (it
->f
);
26007 boff
= FRAME_BASELINE_OFFSET (it
->f
);
26009 else if (EQ (face_name
, Qt
))
26018 face_id
= lookup_named_face (it
->f
, face_name
, 0);
26020 return make_number (-1);
26022 face
= FACE_FROM_ID (it
->f
, face_id
);
26025 return make_number (-1);
26026 boff
= font
->baseline_offset
;
26027 if (font
->vertical_centering
)
26028 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26031 ascent
= FONT_BASE (font
) + boff
;
26032 descent
= FONT_DESCENT (font
) - boff
;
26036 it
->override_ascent
= ascent
;
26037 it
->override_descent
= descent
;
26038 it
->override_boff
= boff
;
26041 height
= ascent
+ descent
;
26045 height
= (int)(XFLOAT_DATA (val
) * height
);
26046 else if (INTEGERP (val
))
26047 height
*= XINT (val
);
26049 return make_number (height
);
26053 /* Append a glyph for a glyphless character to IT->glyph_row. FACE_ID
26054 is a face ID to be used for the glyph. FOR_NO_FONT is nonzero if
26055 and only if this is for a character for which no font was found.
26057 If the display method (it->glyphless_method) is
26058 GLYPHLESS_DISPLAY_ACRONYM or GLYPHLESS_DISPLAY_HEX_CODE, LEN is a
26059 length of the acronym or the hexadecimal string, UPPER_XOFF and
26060 UPPER_YOFF are pixel offsets for the upper part of the string,
26061 LOWER_XOFF and LOWER_YOFF are for the lower part.
26063 For the other display methods, LEN through LOWER_YOFF are zero. */
26066 append_glyphless_glyph (struct it
*it
, int face_id
, int for_no_font
, int len
,
26067 short upper_xoff
, short upper_yoff
,
26068 short lower_xoff
, short lower_yoff
)
26070 struct glyph
*glyph
;
26071 enum glyph_row_area area
= it
->area
;
26073 glyph
= it
->glyph_row
->glyphs
[area
] + it
->glyph_row
->used
[area
];
26074 if (glyph
< it
->glyph_row
->glyphs
[area
+ 1])
26076 /* If the glyph row is reversed, we need to prepend the glyph
26077 rather than append it. */
26078 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26082 /* Make room for the additional glyph. */
26083 for (g
= glyph
- 1; g
>= it
->glyph_row
->glyphs
[area
]; g
--)
26085 glyph
= it
->glyph_row
->glyphs
[area
];
26087 glyph
->charpos
= CHARPOS (it
->position
);
26088 glyph
->object
= it
->object
;
26089 glyph
->pixel_width
= it
->pixel_width
;
26090 glyph
->ascent
= it
->ascent
;
26091 glyph
->descent
= it
->descent
;
26092 glyph
->voffset
= it
->voffset
;
26093 glyph
->type
= GLYPHLESS_GLYPH
;
26094 glyph
->u
.glyphless
.method
= it
->glyphless_method
;
26095 glyph
->u
.glyphless
.for_no_font
= for_no_font
;
26096 glyph
->u
.glyphless
.len
= len
;
26097 glyph
->u
.glyphless
.ch
= it
->c
;
26098 glyph
->slice
.glyphless
.upper_xoff
= upper_xoff
;
26099 glyph
->slice
.glyphless
.upper_yoff
= upper_yoff
;
26100 glyph
->slice
.glyphless
.lower_xoff
= lower_xoff
;
26101 glyph
->slice
.glyphless
.lower_yoff
= lower_yoff
;
26102 glyph
->avoid_cursor_p
= it
->avoid_cursor_p
;
26103 glyph
->multibyte_p
= it
->multibyte_p
;
26104 if (it
->glyph_row
->reversed_p
&& area
== TEXT_AREA
)
26106 /* In R2L rows, the left and the right box edges need to be
26107 drawn in reverse direction. */
26108 glyph
->right_box_line_p
= it
->start_of_box_run_p
;
26109 glyph
->left_box_line_p
= it
->end_of_box_run_p
;
26113 glyph
->left_box_line_p
= it
->start_of_box_run_p
;
26114 glyph
->right_box_line_p
= it
->end_of_box_run_p
;
26116 glyph
->overlaps_vertically_p
= (it
->phys_ascent
> it
->ascent
26117 || it
->phys_descent
> it
->descent
);
26118 glyph
->padding_p
= 0;
26119 glyph
->glyph_not_available_p
= 0;
26120 glyph
->face_id
= face_id
;
26121 glyph
->font_type
= FONT_TYPE_UNKNOWN
;
26124 glyph
->resolved_level
= it
->bidi_it
.resolved_level
;
26125 eassert ((it
->bidi_it
.type
& 7) == it
->bidi_it
.type
);
26126 glyph
->bidi_type
= it
->bidi_it
.type
;
26128 ++it
->glyph_row
->used
[area
];
26131 IT_EXPAND_MATRIX_WIDTH (it
, area
);
26135 /* Produce a glyph for a glyphless character for iterator IT.
26136 IT->glyphless_method specifies which method to use for displaying
26137 the character. See the description of enum
26138 glyphless_display_method in dispextern.h for the detail.
26140 FOR_NO_FONT is nonzero if and only if this is for a character for
26141 which no font was found. ACRONYM, if non-nil, is an acronym string
26142 for the character. */
26145 produce_glyphless_glyph (struct it
*it
, int for_no_font
, Lisp_Object acronym
)
26150 int base_width
, base_height
, width
, height
;
26151 short upper_xoff
, upper_yoff
, lower_xoff
, lower_yoff
;
26154 /* Get the metrics of the base font. We always refer to the current
26156 face
= FACE_FROM_ID (it
->f
, it
->face_id
)->ascii_face
;
26157 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26158 it
->ascent
= FONT_BASE (font
) + font
->baseline_offset
;
26159 it
->descent
= FONT_DESCENT (font
) - font
->baseline_offset
;
26160 base_height
= it
->ascent
+ it
->descent
;
26161 base_width
= font
->average_width
;
26163 face_id
= merge_glyphless_glyph_face (it
);
26165 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_THIN_SPACE
)
26167 it
->pixel_width
= THIN_SPACE_WIDTH
;
26169 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26171 else if (it
->glyphless_method
== GLYPHLESS_DISPLAY_EMPTY_BOX
)
26173 width
= CHAR_WIDTH (it
->c
);
26176 else if (width
> 4)
26178 it
->pixel_width
= base_width
* width
;
26180 upper_xoff
= upper_yoff
= lower_xoff
= lower_yoff
= 0;
26186 unsigned int code
[6];
26188 int ascent
, descent
;
26189 struct font_metrics metrics_upper
, metrics_lower
;
26191 face
= FACE_FROM_ID (it
->f
, face_id
);
26192 font
= face
->font
? face
->font
: FRAME_FONT (it
->f
);
26193 prepare_face_for_display (it
->f
, face
);
26195 if (it
->glyphless_method
== GLYPHLESS_DISPLAY_ACRONYM
)
26197 if (! STRINGP (acronym
) && CHAR_TABLE_P (Vglyphless_char_display
))
26198 acronym
= CHAR_TABLE_REF (Vglyphless_char_display
, it
->c
);
26199 if (CONSP (acronym
))
26200 acronym
= XCAR (acronym
);
26201 str
= STRINGP (acronym
) ? SSDATA (acronym
) : "";
26205 eassert (it
->glyphless_method
== GLYPHLESS_DISPLAY_HEX_CODE
);
26206 sprintf (buf
, "%0*X", it
->c
< 0x10000 ? 4 : 6, it
->c
);
26209 for (len
= 0; str
[len
] && ASCII_CHAR_P (str
[len
]) && len
< 6; len
++)
26210 code
[len
] = font
->driver
->encode_char (font
, str
[len
]);
26211 upper_len
= (len
+ 1) / 2;
26212 font
->driver
->text_extents (font
, code
, upper_len
,
26214 font
->driver
->text_extents (font
, code
+ upper_len
, len
- upper_len
,
26219 /* +4 is for vertical bars of a box plus 1-pixel spaces at both side. */
26220 width
= max (metrics_upper
.width
, metrics_lower
.width
) + 4;
26221 upper_xoff
= upper_yoff
= 2; /* the typical case */
26222 if (base_width
>= width
)
26224 /* Align the upper to the left, the lower to the right. */
26225 it
->pixel_width
= base_width
;
26226 lower_xoff
= base_width
- 2 - metrics_lower
.width
;
26230 /* Center the shorter one. */
26231 it
->pixel_width
= width
;
26232 if (metrics_upper
.width
>= metrics_lower
.width
)
26233 lower_xoff
= (width
- metrics_lower
.width
) / 2;
26236 /* FIXME: This code doesn't look right. It formerly was
26237 missing the "lower_xoff = 0;", which couldn't have
26238 been right since it left lower_xoff uninitialized. */
26240 upper_xoff
= (width
- metrics_upper
.width
) / 2;
26244 /* +5 is for horizontal bars of a box plus 1-pixel spaces at
26245 top, bottom, and between upper and lower strings. */
26246 height
= (metrics_upper
.ascent
+ metrics_upper
.descent
26247 + metrics_lower
.ascent
+ metrics_lower
.descent
) + 5;
26248 /* Center vertically.
26249 H:base_height, D:base_descent
26250 h:height, ld:lower_descent, la:lower_ascent, ud:upper_descent
26252 ascent = - (D - H/2 - h/2 + 1); "+ 1" for rounding up
26253 descent = D - H/2 + h/2;
26254 lower_yoff = descent - 2 - ld;
26255 upper_yoff = lower_yoff - la - 1 - ud; */
26256 ascent
= - (it
->descent
- (base_height
+ height
+ 1) / 2);
26257 descent
= it
->descent
- (base_height
- height
) / 2;
26258 lower_yoff
= descent
- 2 - metrics_lower
.descent
;
26259 upper_yoff
= (lower_yoff
- metrics_lower
.ascent
- 1
26260 - metrics_upper
.descent
);
26261 /* Don't make the height shorter than the base height. */
26262 if (height
> base_height
)
26264 it
->ascent
= ascent
;
26265 it
->descent
= descent
;
26269 it
->phys_ascent
= it
->ascent
;
26270 it
->phys_descent
= it
->descent
;
26272 append_glyphless_glyph (it
, face_id
, for_no_font
, len
,
26273 upper_xoff
, upper_yoff
,
26274 lower_xoff
, lower_yoff
);
26276 take_vertical_position_into_account (it
);
26281 Produce glyphs/get display metrics for the display element IT is
26282 loaded with. See the description of struct it in dispextern.h
26283 for an overview of struct it. */
26286 x_produce_glyphs (struct it
*it
)
26288 int extra_line_spacing
= it
->extra_line_spacing
;
26290 it
->glyph_not_available_p
= 0;
26292 if (it
->what
== IT_CHARACTER
)
26295 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26296 struct font
*font
= face
->font
;
26297 struct font_metrics
*pcm
= NULL
;
26298 int boff
; /* Baseline offset. */
26302 /* When no suitable font is found, display this character by
26303 the method specified in the first extra slot of
26304 Vglyphless_char_display. */
26305 Lisp_Object acronym
= lookup_glyphless_char_display (-1, it
);
26307 eassert (it
->what
== IT_GLYPHLESS
);
26308 produce_glyphless_glyph (it
, 1, STRINGP (acronym
) ? acronym
: Qnil
);
26312 boff
= font
->baseline_offset
;
26313 if (font
->vertical_centering
)
26314 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26316 if (it
->char_to_display
!= '\n' && it
->char_to_display
!= '\t')
26322 if (it
->override_ascent
>= 0)
26324 it
->ascent
= it
->override_ascent
;
26325 it
->descent
= it
->override_descent
;
26326 boff
= it
->override_boff
;
26330 it
->ascent
= FONT_BASE (font
) + boff
;
26331 it
->descent
= FONT_DESCENT (font
) - boff
;
26334 if (get_char_glyph_code (it
->char_to_display
, font
, &char2b
))
26336 pcm
= get_per_char_metric (font
, &char2b
);
26337 if (pcm
->width
== 0
26338 && pcm
->rbearing
== 0 && pcm
->lbearing
== 0)
26344 it
->phys_ascent
= pcm
->ascent
+ boff
;
26345 it
->phys_descent
= pcm
->descent
- boff
;
26346 it
->pixel_width
= pcm
->width
;
26350 it
->glyph_not_available_p
= 1;
26351 it
->phys_ascent
= it
->ascent
;
26352 it
->phys_descent
= it
->descent
;
26353 it
->pixel_width
= font
->space_width
;
26356 if (it
->constrain_row_ascent_descent_p
)
26358 if (it
->descent
> it
->max_descent
)
26360 it
->ascent
+= it
->descent
- it
->max_descent
;
26361 it
->descent
= it
->max_descent
;
26363 if (it
->ascent
> it
->max_ascent
)
26365 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26366 it
->ascent
= it
->max_ascent
;
26368 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26369 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26370 extra_line_spacing
= 0;
26373 /* If this is a space inside a region of text with
26374 `space-width' property, change its width. */
26375 stretched_p
= it
->char_to_display
== ' ' && !NILP (it
->space_width
);
26377 it
->pixel_width
*= XFLOATINT (it
->space_width
);
26379 /* If face has a box, add the box thickness to the character
26380 height. If character has a box line to the left and/or
26381 right, add the box line width to the character's width. */
26382 if (face
->box
!= FACE_NO_BOX
)
26384 int thick
= face
->box_line_width
;
26388 it
->ascent
+= thick
;
26389 it
->descent
+= thick
;
26394 if (it
->start_of_box_run_p
)
26395 it
->pixel_width
+= thick
;
26396 if (it
->end_of_box_run_p
)
26397 it
->pixel_width
+= thick
;
26400 /* If face has an overline, add the height of the overline
26401 (1 pixel) and a 1 pixel margin to the character height. */
26402 if (face
->overline_p
)
26403 it
->ascent
+= overline_margin
;
26405 if (it
->constrain_row_ascent_descent_p
)
26407 if (it
->ascent
> it
->max_ascent
)
26408 it
->ascent
= it
->max_ascent
;
26409 if (it
->descent
> it
->max_descent
)
26410 it
->descent
= it
->max_descent
;
26413 take_vertical_position_into_account (it
);
26415 /* If we have to actually produce glyphs, do it. */
26420 /* Translate a space with a `space-width' property
26421 into a stretch glyph. */
26422 int ascent
= (((it
->ascent
+ it
->descent
) * FONT_BASE (font
))
26423 / FONT_HEIGHT (font
));
26424 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26425 it
->ascent
+ it
->descent
, ascent
);
26430 /* If characters with lbearing or rbearing are displayed
26431 in this line, record that fact in a flag of the
26432 glyph row. This is used to optimize X output code. */
26433 if (pcm
&& (pcm
->lbearing
< 0 || pcm
->rbearing
> pcm
->width
))
26434 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26436 if (! stretched_p
&& it
->pixel_width
== 0)
26437 /* We assure that all visible glyphs have at least 1-pixel
26439 it
->pixel_width
= 1;
26441 else if (it
->char_to_display
== '\n')
26443 /* A newline has no width, but we need the height of the
26444 line. But if previous part of the line sets a height,
26445 don't increase that height. */
26447 Lisp_Object height
;
26448 Lisp_Object total_height
= Qnil
;
26450 it
->override_ascent
= -1;
26451 it
->pixel_width
= 0;
26454 height
= get_it_property (it
, Qline_height
);
26455 /* Split (line-height total-height) list. */
26457 && CONSP (XCDR (height
))
26458 && NILP (XCDR (XCDR (height
))))
26460 total_height
= XCAR (XCDR (height
));
26461 height
= XCAR (height
);
26463 height
= calc_line_height_property (it
, height
, font
, boff
, 1);
26465 if (it
->override_ascent
>= 0)
26467 it
->ascent
= it
->override_ascent
;
26468 it
->descent
= it
->override_descent
;
26469 boff
= it
->override_boff
;
26473 it
->ascent
= FONT_BASE (font
) + boff
;
26474 it
->descent
= FONT_DESCENT (font
) - boff
;
26477 if (EQ (height
, Qt
))
26479 if (it
->descent
> it
->max_descent
)
26481 it
->ascent
+= it
->descent
- it
->max_descent
;
26482 it
->descent
= it
->max_descent
;
26484 if (it
->ascent
> it
->max_ascent
)
26486 it
->descent
= min (it
->max_descent
, it
->descent
+ it
->ascent
- it
->max_ascent
);
26487 it
->ascent
= it
->max_ascent
;
26489 it
->phys_ascent
= min (it
->phys_ascent
, it
->ascent
);
26490 it
->phys_descent
= min (it
->phys_descent
, it
->descent
);
26491 it
->constrain_row_ascent_descent_p
= 1;
26492 extra_line_spacing
= 0;
26496 Lisp_Object spacing
;
26498 it
->phys_ascent
= it
->ascent
;
26499 it
->phys_descent
= it
->descent
;
26501 if ((it
->max_ascent
> 0 || it
->max_descent
> 0)
26502 && face
->box
!= FACE_NO_BOX
26503 && face
->box_line_width
> 0)
26505 it
->ascent
+= face
->box_line_width
;
26506 it
->descent
+= face
->box_line_width
;
26509 && XINT (height
) > it
->ascent
+ it
->descent
)
26510 it
->ascent
= XINT (height
) - it
->descent
;
26512 if (!NILP (total_height
))
26513 spacing
= calc_line_height_property (it
, total_height
, font
, boff
, 0);
26516 spacing
= get_it_property (it
, Qline_spacing
);
26517 spacing
= calc_line_height_property (it
, spacing
, font
, boff
, 0);
26519 if (INTEGERP (spacing
))
26521 extra_line_spacing
= XINT (spacing
);
26522 if (!NILP (total_height
))
26523 extra_line_spacing
-= (it
->phys_ascent
+ it
->phys_descent
);
26527 else /* i.e. (it->char_to_display == '\t') */
26529 if (font
->space_width
> 0)
26531 int tab_width
= it
->tab_width
* font
->space_width
;
26532 int x
= it
->current_x
+ it
->continuation_lines_width
;
26533 int next_tab_x
= ((1 + x
+ tab_width
- 1) / tab_width
) * tab_width
;
26535 /* If the distance from the current position to the next tab
26536 stop is less than a space character width, use the
26537 tab stop after that. */
26538 if (next_tab_x
- x
< font
->space_width
)
26539 next_tab_x
+= tab_width
;
26541 it
->pixel_width
= next_tab_x
- x
;
26543 it
->ascent
= it
->phys_ascent
= FONT_BASE (font
) + boff
;
26544 it
->descent
= it
->phys_descent
= FONT_DESCENT (font
) - boff
;
26548 append_stretch_glyph (it
, it
->object
, it
->pixel_width
,
26549 it
->ascent
+ it
->descent
, it
->ascent
);
26554 it
->pixel_width
= 0;
26559 else if (it
->what
== IT_COMPOSITION
&& it
->cmp_it
.ch
< 0)
26561 /* A static composition.
26563 Note: A composition is represented as one glyph in the
26564 glyph matrix. There are no padding glyphs.
26566 Important note: pixel_width, ascent, and descent are the
26567 values of what is drawn by draw_glyphs (i.e. the values of
26568 the overall glyphs composed). */
26569 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26570 int boff
; /* baseline offset */
26571 struct composition
*cmp
= composition_table
[it
->cmp_it
.id
];
26572 int glyph_len
= cmp
->glyph_len
;
26573 struct font
*font
= face
->font
;
26577 /* If we have not yet calculated pixel size data of glyphs of
26578 the composition for the current face font, calculate them
26579 now. Theoretically, we have to check all fonts for the
26580 glyphs, but that requires much time and memory space. So,
26581 here we check only the font of the first glyph. This may
26582 lead to incorrect display, but it's very rare, and C-l
26583 (recenter-top-bottom) can correct the display anyway. */
26584 if (! cmp
->font
|| cmp
->font
!= font
)
26586 /* Ascent and descent of the font of the first character
26587 of this composition (adjusted by baseline offset).
26588 Ascent and descent of overall glyphs should not be less
26589 than these, respectively. */
26590 int font_ascent
, font_descent
, font_height
;
26591 /* Bounding box of the overall glyphs. */
26592 int leftmost
, rightmost
, lowest
, highest
;
26593 int lbearing
, rbearing
;
26594 int i
, width
, ascent
, descent
;
26595 int left_padded
= 0, right_padded
= 0;
26596 int c
IF_LINT (= 0); /* cmp->glyph_len can't be zero; see Bug#8512 */
26598 struct font_metrics
*pcm
;
26599 int font_not_found_p
;
26602 for (glyph_len
= cmp
->glyph_len
; glyph_len
> 0; glyph_len
--)
26603 if ((c
= COMPOSITION_GLYPH (cmp
, glyph_len
- 1)) != '\t')
26605 if (glyph_len
< cmp
->glyph_len
)
26607 for (i
= 0; i
< glyph_len
; i
++)
26609 if ((c
= COMPOSITION_GLYPH (cmp
, i
)) != '\t')
26611 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26616 pos
= (STRINGP (it
->string
) ? IT_STRING_CHARPOS (*it
)
26617 : IT_CHARPOS (*it
));
26618 /* If no suitable font is found, use the default font. */
26619 font_not_found_p
= font
== NULL
;
26620 if (font_not_found_p
)
26622 face
= face
->ascii_face
;
26625 boff
= font
->baseline_offset
;
26626 if (font
->vertical_centering
)
26627 boff
= VCENTER_BASELINE_OFFSET (font
, it
->f
) - boff
;
26628 font_ascent
= FONT_BASE (font
) + boff
;
26629 font_descent
= FONT_DESCENT (font
) - boff
;
26630 font_height
= FONT_HEIGHT (font
);
26635 if (! font_not_found_p
)
26637 get_char_face_and_encoding (it
->f
, c
, it
->face_id
,
26639 pcm
= get_per_char_metric (font
, &char2b
);
26642 /* Initialize the bounding box. */
26645 width
= cmp
->glyph_len
> 0 ? pcm
->width
: 0;
26646 ascent
= pcm
->ascent
;
26647 descent
= pcm
->descent
;
26648 lbearing
= pcm
->lbearing
;
26649 rbearing
= pcm
->rbearing
;
26653 width
= cmp
->glyph_len
> 0 ? font
->space_width
: 0;
26654 ascent
= FONT_BASE (font
);
26655 descent
= FONT_DESCENT (font
);
26662 lowest
= - descent
+ boff
;
26663 highest
= ascent
+ boff
;
26665 if (! font_not_found_p
26666 && font
->default_ascent
26667 && CHAR_TABLE_P (Vuse_default_ascent
)
26668 && !NILP (Faref (Vuse_default_ascent
,
26669 make_number (it
->char_to_display
))))
26670 highest
= font
->default_ascent
+ boff
;
26672 /* Draw the first glyph at the normal position. It may be
26673 shifted to right later if some other glyphs are drawn
26675 cmp
->offsets
[i
* 2] = 0;
26676 cmp
->offsets
[i
* 2 + 1] = boff
;
26677 cmp
->lbearing
= lbearing
;
26678 cmp
->rbearing
= rbearing
;
26680 /* Set cmp->offsets for the remaining glyphs. */
26681 for (i
++; i
< glyph_len
; i
++)
26683 int left
, right
, btm
, top
;
26684 int ch
= COMPOSITION_GLYPH (cmp
, i
);
26686 struct face
*this_face
;
26690 face_id
= FACE_FOR_CHAR (it
->f
, face
, ch
, pos
, it
->string
);
26691 this_face
= FACE_FROM_ID (it
->f
, face_id
);
26692 font
= this_face
->font
;
26698 get_char_face_and_encoding (it
->f
, ch
, face_id
,
26700 pcm
= get_per_char_metric (font
, &char2b
);
26703 cmp
->offsets
[i
* 2] = cmp
->offsets
[i
* 2 + 1] = 0;
26706 width
= pcm
->width
;
26707 ascent
= pcm
->ascent
;
26708 descent
= pcm
->descent
;
26709 lbearing
= pcm
->lbearing
;
26710 rbearing
= pcm
->rbearing
;
26711 if (cmp
->method
!= COMPOSITION_WITH_RULE_ALTCHARS
)
26713 /* Relative composition with or without
26714 alternate chars. */
26715 left
= (leftmost
+ rightmost
- width
) / 2;
26716 btm
= - descent
+ boff
;
26717 if (font
->relative_compose
26718 && (! CHAR_TABLE_P (Vignore_relative_composition
)
26719 || NILP (Faref (Vignore_relative_composition
,
26720 make_number (ch
)))))
26723 if (- descent
>= font
->relative_compose
)
26724 /* One extra pixel between two glyphs. */
26726 else if (ascent
<= 0)
26727 /* One extra pixel between two glyphs. */
26728 btm
= lowest
- 1 - ascent
- descent
;
26733 /* A composition rule is specified by an integer
26734 value that encodes global and new reference
26735 points (GREF and NREF). GREF and NREF are
26736 specified by numbers as below:
26738 0---1---2 -- ascent
26742 9--10--11 -- center
26744 ---3---4---5--- baseline
26746 6---7---8 -- descent
26748 int rule
= COMPOSITION_RULE (cmp
, i
);
26749 int gref
, nref
, grefx
, grefy
, nrefx
, nrefy
, xoff
, yoff
;
26751 COMPOSITION_DECODE_RULE (rule
, gref
, nref
, xoff
, yoff
);
26752 grefx
= gref
% 3, nrefx
= nref
% 3;
26753 grefy
= gref
/ 3, nrefy
= nref
/ 3;
26755 xoff
= font_height
* (xoff
- 128) / 256;
26757 yoff
= font_height
* (yoff
- 128) / 256;
26760 + grefx
* (rightmost
- leftmost
) / 2
26761 - nrefx
* width
/ 2
26764 btm
= ((grefy
== 0 ? highest
26766 : grefy
== 2 ? lowest
26767 : (highest
+ lowest
) / 2)
26768 - (nrefy
== 0 ? ascent
+ descent
26769 : nrefy
== 1 ? descent
- boff
26771 : (ascent
+ descent
) / 2)
26775 cmp
->offsets
[i
* 2] = left
;
26776 cmp
->offsets
[i
* 2 + 1] = btm
+ descent
;
26778 /* Update the bounding box of the overall glyphs. */
26781 right
= left
+ width
;
26782 if (left
< leftmost
)
26784 if (right
> rightmost
)
26787 top
= btm
+ descent
+ ascent
;
26793 if (cmp
->lbearing
> left
+ lbearing
)
26794 cmp
->lbearing
= left
+ lbearing
;
26795 if (cmp
->rbearing
< left
+ rbearing
)
26796 cmp
->rbearing
= left
+ rbearing
;
26800 /* If there are glyphs whose x-offsets are negative,
26801 shift all glyphs to the right and make all x-offsets
26805 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26806 cmp
->offsets
[i
* 2] -= leftmost
;
26807 rightmost
-= leftmost
;
26808 cmp
->lbearing
-= leftmost
;
26809 cmp
->rbearing
-= leftmost
;
26812 if (left_padded
&& cmp
->lbearing
< 0)
26814 for (i
= 0; i
< cmp
->glyph_len
; i
++)
26815 cmp
->offsets
[i
* 2] -= cmp
->lbearing
;
26816 rightmost
-= cmp
->lbearing
;
26817 cmp
->rbearing
-= cmp
->lbearing
;
26820 if (right_padded
&& rightmost
< cmp
->rbearing
)
26822 rightmost
= cmp
->rbearing
;
26825 cmp
->pixel_width
= rightmost
;
26826 cmp
->ascent
= highest
;
26827 cmp
->descent
= - lowest
;
26828 if (cmp
->ascent
< font_ascent
)
26829 cmp
->ascent
= font_ascent
;
26830 if (cmp
->descent
< font_descent
)
26831 cmp
->descent
= font_descent
;
26835 && (cmp
->lbearing
< 0
26836 || cmp
->rbearing
> cmp
->pixel_width
))
26837 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26839 it
->pixel_width
= cmp
->pixel_width
;
26840 it
->ascent
= it
->phys_ascent
= cmp
->ascent
;
26841 it
->descent
= it
->phys_descent
= cmp
->descent
;
26842 if (face
->box
!= FACE_NO_BOX
)
26844 int thick
= face
->box_line_width
;
26848 it
->ascent
+= thick
;
26849 it
->descent
+= thick
;
26854 if (it
->start_of_box_run_p
)
26855 it
->pixel_width
+= thick
;
26856 if (it
->end_of_box_run_p
)
26857 it
->pixel_width
+= thick
;
26860 /* If face has an overline, add the height of the overline
26861 (1 pixel) and a 1 pixel margin to the character height. */
26862 if (face
->overline_p
)
26863 it
->ascent
+= overline_margin
;
26865 take_vertical_position_into_account (it
);
26866 if (it
->ascent
< 0)
26868 if (it
->descent
< 0)
26871 if (it
->glyph_row
&& cmp
->glyph_len
> 0)
26872 append_composite_glyph (it
);
26874 else if (it
->what
== IT_COMPOSITION
)
26876 /* A dynamic (automatic) composition. */
26877 struct face
*face
= FACE_FROM_ID (it
->f
, it
->face_id
);
26878 Lisp_Object gstring
;
26879 struct font_metrics metrics
;
26883 gstring
= composition_gstring_from_id (it
->cmp_it
.id
);
26885 = composition_gstring_width (gstring
, it
->cmp_it
.from
, it
->cmp_it
.to
,
26888 && (metrics
.lbearing
< 0 || metrics
.rbearing
> metrics
.width
))
26889 it
->glyph_row
->contains_overlapping_glyphs_p
= 1;
26890 it
->ascent
= it
->phys_ascent
= metrics
.ascent
;
26891 it
->descent
= it
->phys_descent
= metrics
.descent
;
26892 if (face
->box
!= FACE_NO_BOX
)
26894 int thick
= face
->box_line_width
;
26898 it
->ascent
+= thick
;
26899 it
->descent
+= thick
;
26904 if (it
->start_of_box_run_p
)
26905 it
->pixel_width
+= thick
;
26906 if (it
->end_of_box_run_p
)
26907 it
->pixel_width
+= thick
;
26909 /* If face has an overline, add the height of the overline
26910 (1 pixel) and a 1 pixel margin to the character height. */
26911 if (face
->overline_p
)
26912 it
->ascent
+= overline_margin
;
26913 take_vertical_position_into_account (it
);
26914 if (it
->ascent
< 0)
26916 if (it
->descent
< 0)
26920 append_composite_glyph (it
);
26922 else if (it
->what
== IT_GLYPHLESS
)
26923 produce_glyphless_glyph (it
, 0, Qnil
);
26924 else if (it
->what
== IT_IMAGE
)
26925 produce_image_glyph (it
);
26926 else if (it
->what
== IT_STRETCH
)
26927 produce_stretch_glyph (it
);
26930 /* Accumulate dimensions. Note: can't assume that it->descent > 0
26931 because this isn't true for images with `:ascent 100'. */
26932 eassert (it
->ascent
>= 0 && it
->descent
>= 0);
26933 if (it
->area
== TEXT_AREA
)
26934 it
->current_x
+= it
->pixel_width
;
26936 if (extra_line_spacing
> 0)
26938 it
->descent
+= extra_line_spacing
;
26939 if (extra_line_spacing
> it
->max_extra_line_spacing
)
26940 it
->max_extra_line_spacing
= extra_line_spacing
;
26943 it
->max_ascent
= max (it
->max_ascent
, it
->ascent
);
26944 it
->max_descent
= max (it
->max_descent
, it
->descent
);
26945 it
->max_phys_ascent
= max (it
->max_phys_ascent
, it
->phys_ascent
);
26946 it
->max_phys_descent
= max (it
->max_phys_descent
, it
->phys_descent
);
26950 Output LEN glyphs starting at START at the nominal cursor position.
26951 Advance the nominal cursor over the text. UPDATED_ROW is the glyph row
26952 being updated, and UPDATED_AREA is the area of that row being updated. */
26955 x_write_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
26956 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
26958 int x
, hpos
, chpos
= w
->phys_cursor
.hpos
;
26960 eassert (updated_row
);
26961 /* When the window is hscrolled, cursor hpos can legitimately be out
26962 of bounds, but we draw the cursor at the corresponding window
26963 margin in that case. */
26964 if (!updated_row
->reversed_p
&& chpos
< 0)
26966 if (updated_row
->reversed_p
&& chpos
>= updated_row
->used
[TEXT_AREA
])
26967 chpos
= updated_row
->used
[TEXT_AREA
] - 1;
26971 /* Write glyphs. */
26973 hpos
= start
- updated_row
->glyphs
[updated_area
];
26974 x
= draw_glyphs (w
, w
->output_cursor
.x
,
26975 updated_row
, updated_area
,
26977 DRAW_NORMAL_TEXT
, 0);
26979 /* Invalidate old phys cursor if the glyph at its hpos is redrawn. */
26980 if (updated_area
== TEXT_AREA
26981 && w
->phys_cursor_on_p
26982 && w
->phys_cursor
.vpos
== w
->output_cursor
.vpos
26984 && chpos
< hpos
+ len
)
26985 w
->phys_cursor_on_p
= 0;
26989 /* Advance the output cursor. */
26990 w
->output_cursor
.hpos
+= len
;
26991 w
->output_cursor
.x
= x
;
26996 Insert LEN glyphs from START at the nominal cursor position. */
26999 x_insert_glyphs (struct window
*w
, struct glyph_row
*updated_row
,
27000 struct glyph
*start
, enum glyph_row_area updated_area
, int len
)
27003 int line_height
, shift_by_width
, shifted_region_width
;
27004 struct glyph_row
*row
;
27005 struct glyph
*glyph
;
27006 int frame_x
, frame_y
;
27009 eassert (updated_row
);
27011 f
= XFRAME (WINDOW_FRAME (w
));
27013 /* Get the height of the line we are in. */
27015 line_height
= row
->height
;
27017 /* Get the width of the glyphs to insert. */
27018 shift_by_width
= 0;
27019 for (glyph
= start
; glyph
< start
+ len
; ++glyph
)
27020 shift_by_width
+= glyph
->pixel_width
;
27022 /* Get the width of the region to shift right. */
27023 shifted_region_width
= (window_box_width (w
, updated_area
)
27024 - w
->output_cursor
.x
27028 frame_x
= window_box_left (w
, updated_area
) + w
->output_cursor
.x
;
27029 frame_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, w
->output_cursor
.y
);
27031 FRAME_RIF (f
)->shift_glyphs_for_insert (f
, frame_x
, frame_y
, shifted_region_width
,
27032 line_height
, shift_by_width
);
27034 /* Write the glyphs. */
27035 hpos
= start
- row
->glyphs
[updated_area
];
27036 draw_glyphs (w
, w
->output_cursor
.x
, row
, updated_area
,
27038 DRAW_NORMAL_TEXT
, 0);
27040 /* Advance the output cursor. */
27041 w
->output_cursor
.hpos
+= len
;
27042 w
->output_cursor
.x
+= shift_by_width
;
27048 Erase the current text line from the nominal cursor position
27049 (inclusive) to pixel column TO_X (exclusive). The idea is that
27050 everything from TO_X onward is already erased.
27052 TO_X is a pixel position relative to UPDATED_AREA of currently
27053 updated window W. TO_X == -1 means clear to the end of this area. */
27056 x_clear_end_of_line (struct window
*w
, struct glyph_row
*updated_row
,
27057 enum glyph_row_area updated_area
, int to_x
)
27060 int max_x
, min_y
, max_y
;
27061 int from_x
, from_y
, to_y
;
27063 eassert (updated_row
);
27064 f
= XFRAME (w
->frame
);
27066 if (updated_row
->full_width_p
)
27067 max_x
= (WINDOW_PIXEL_WIDTH (w
)
27068 - (updated_row
->mode_line_p
? WINDOW_RIGHT_DIVIDER_WIDTH (w
) : 0));
27070 max_x
= window_box_width (w
, updated_area
);
27071 max_y
= window_text_bottom_y (w
);
27073 /* TO_X == 0 means don't do anything. TO_X < 0 means clear to end
27074 of window. For TO_X > 0, truncate to end of drawing area. */
27080 to_x
= min (to_x
, max_x
);
27082 to_y
= min (max_y
, w
->output_cursor
.y
+ updated_row
->height
);
27084 /* Notice if the cursor will be cleared by this operation. */
27085 if (!updated_row
->full_width_p
)
27086 notice_overwritten_cursor (w
, updated_area
,
27087 w
->output_cursor
.x
, -1,
27089 MATRIX_ROW_BOTTOM_Y (updated_row
));
27091 from_x
= w
->output_cursor
.x
;
27093 /* Translate to frame coordinates. */
27094 if (updated_row
->full_width_p
)
27096 from_x
= WINDOW_TO_FRAME_PIXEL_X (w
, from_x
);
27097 to_x
= WINDOW_TO_FRAME_PIXEL_X (w
, to_x
);
27101 int area_left
= window_box_left (w
, updated_area
);
27102 from_x
+= area_left
;
27106 min_y
= WINDOW_HEADER_LINE_HEIGHT (w
);
27107 from_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (min_y
, w
->output_cursor
.y
));
27108 to_y
= WINDOW_TO_FRAME_PIXEL_Y (w
, to_y
);
27110 /* Prevent inadvertently clearing to end of the X window. */
27111 if (to_x
> from_x
&& to_y
> from_y
)
27114 FRAME_RIF (f
)->clear_frame_area (f
, from_x
, from_y
,
27115 to_x
- from_x
, to_y
- from_y
);
27120 #endif /* HAVE_WINDOW_SYSTEM */
27124 /***********************************************************************
27126 ***********************************************************************/
27128 /* Value is the internal representation of the specified cursor type
27129 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
27130 of the bar cursor. */
27132 static enum text_cursor_kinds
27133 get_specified_cursor_type (Lisp_Object arg
, int *width
)
27135 enum text_cursor_kinds type
;
27140 if (EQ (arg
, Qbox
))
27141 return FILLED_BOX_CURSOR
;
27143 if (EQ (arg
, Qhollow
))
27144 return HOLLOW_BOX_CURSOR
;
27146 if (EQ (arg
, Qbar
))
27153 && EQ (XCAR (arg
), Qbar
)
27154 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27156 *width
= XINT (XCDR (arg
));
27160 if (EQ (arg
, Qhbar
))
27163 return HBAR_CURSOR
;
27167 && EQ (XCAR (arg
), Qhbar
)
27168 && RANGED_INTEGERP (0, XCDR (arg
), INT_MAX
))
27170 *width
= XINT (XCDR (arg
));
27171 return HBAR_CURSOR
;
27174 /* Treat anything unknown as "hollow box cursor".
27175 It was bad to signal an error; people have trouble fixing
27176 .Xdefaults with Emacs, when it has something bad in it. */
27177 type
= HOLLOW_BOX_CURSOR
;
27182 /* Set the default cursor types for specified frame. */
27184 set_frame_cursor_types (struct frame
*f
, Lisp_Object arg
)
27189 FRAME_DESIRED_CURSOR (f
) = get_specified_cursor_type (arg
, &width
);
27190 FRAME_CURSOR_WIDTH (f
) = width
;
27192 /* By default, set up the blink-off state depending on the on-state. */
27194 tem
= Fassoc (arg
, Vblink_cursor_alist
);
27197 FRAME_BLINK_OFF_CURSOR (f
)
27198 = get_specified_cursor_type (XCDR (tem
), &width
);
27199 FRAME_BLINK_OFF_CURSOR_WIDTH (f
) = width
;
27202 FRAME_BLINK_OFF_CURSOR (f
) = DEFAULT_CURSOR
;
27204 /* Make sure the cursor gets redrawn. */
27205 f
->cursor_type_changed
= 1;
27209 #ifdef HAVE_WINDOW_SYSTEM
27211 /* Return the cursor we want to be displayed in window W. Return
27212 width of bar/hbar cursor through WIDTH arg. Return with
27213 ACTIVE_CURSOR arg set to 1 if cursor in window W is `active'
27214 (i.e. if the `system caret' should track this cursor).
27216 In a mini-buffer window, we want the cursor only to appear if we
27217 are reading input from this window. For the selected window, we
27218 want the cursor type given by the frame parameter or buffer local
27219 setting of cursor-type. If explicitly marked off, draw no cursor.
27220 In all other cases, we want a hollow box cursor. */
27222 static enum text_cursor_kinds
27223 get_window_cursor_type (struct window
*w
, struct glyph
*glyph
, int *width
,
27224 int *active_cursor
)
27226 struct frame
*f
= XFRAME (w
->frame
);
27227 struct buffer
*b
= XBUFFER (w
->contents
);
27228 int cursor_type
= DEFAULT_CURSOR
;
27229 Lisp_Object alt_cursor
;
27230 int non_selected
= 0;
27232 *active_cursor
= 1;
27235 if (cursor_in_echo_area
27236 && FRAME_HAS_MINIBUF_P (f
)
27237 && EQ (FRAME_MINIBUF_WINDOW (f
), echo_area_window
))
27239 if (w
== XWINDOW (echo_area_window
))
27241 if (EQ (BVAR (b
, cursor_type
), Qt
) || NILP (BVAR (b
, cursor_type
)))
27243 *width
= FRAME_CURSOR_WIDTH (f
);
27244 return FRAME_DESIRED_CURSOR (f
);
27247 return get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27250 *active_cursor
= 0;
27254 /* Detect a nonselected window or nonselected frame. */
27255 else if (w
!= XWINDOW (f
->selected_window
)
27256 || f
!= FRAME_DISPLAY_INFO (f
)->x_highlight_frame
)
27258 *active_cursor
= 0;
27260 if (MINI_WINDOW_P (w
) && minibuf_level
== 0)
27266 /* Never display a cursor in a window in which cursor-type is nil. */
27267 if (NILP (BVAR (b
, cursor_type
)))
27270 /* Get the normal cursor type for this window. */
27271 if (EQ (BVAR (b
, cursor_type
), Qt
))
27273 cursor_type
= FRAME_DESIRED_CURSOR (f
);
27274 *width
= FRAME_CURSOR_WIDTH (f
);
27277 cursor_type
= get_specified_cursor_type (BVAR (b
, cursor_type
), width
);
27279 /* Use cursor-in-non-selected-windows instead
27280 for non-selected window or frame. */
27283 alt_cursor
= BVAR (b
, cursor_in_non_selected_windows
);
27284 if (!EQ (Qt
, alt_cursor
))
27285 return get_specified_cursor_type (alt_cursor
, width
);
27286 /* t means modify the normal cursor type. */
27287 if (cursor_type
== FILLED_BOX_CURSOR
)
27288 cursor_type
= HOLLOW_BOX_CURSOR
;
27289 else if (cursor_type
== BAR_CURSOR
&& *width
> 1)
27291 return cursor_type
;
27294 /* Use normal cursor if not blinked off. */
27295 if (!w
->cursor_off_p
)
27297 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
27299 if (cursor_type
== FILLED_BOX_CURSOR
)
27301 /* Using a block cursor on large images can be very annoying.
27302 So use a hollow cursor for "large" images.
27303 If image is not transparent (no mask), also use hollow cursor. */
27304 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
27305 if (img
!= NULL
&& IMAGEP (img
->spec
))
27307 /* Arbitrarily, interpret "Large" as >32x32 and >NxN
27308 where N = size of default frame font size.
27309 This should cover most of the "tiny" icons people may use. */
27311 || img
->width
> max (32, WINDOW_FRAME_COLUMN_WIDTH (w
))
27312 || img
->height
> max (32, WINDOW_FRAME_LINE_HEIGHT (w
)))
27313 cursor_type
= HOLLOW_BOX_CURSOR
;
27316 else if (cursor_type
!= NO_CURSOR
)
27318 /* Display current only supports BOX and HOLLOW cursors for images.
27319 So for now, unconditionally use a HOLLOW cursor when cursor is
27320 not a solid box cursor. */
27321 cursor_type
= HOLLOW_BOX_CURSOR
;
27324 return cursor_type
;
27327 /* Cursor is blinked off, so determine how to "toggle" it. */
27329 /* First look for an entry matching the buffer's cursor-type in blink-cursor-alist. */
27330 if ((alt_cursor
= Fassoc (BVAR (b
, cursor_type
), Vblink_cursor_alist
), !NILP (alt_cursor
)))
27331 return get_specified_cursor_type (XCDR (alt_cursor
), width
);
27333 /* Then see if frame has specified a specific blink off cursor type. */
27334 if (FRAME_BLINK_OFF_CURSOR (f
) != DEFAULT_CURSOR
)
27336 *width
= FRAME_BLINK_OFF_CURSOR_WIDTH (f
);
27337 return FRAME_BLINK_OFF_CURSOR (f
);
27341 /* Some people liked having a permanently visible blinking cursor,
27342 while others had very strong opinions against it. So it was
27343 decided to remove it. KFS 2003-09-03 */
27345 /* Finally perform built-in cursor blinking:
27346 filled box <-> hollow box
27347 wide [h]bar <-> narrow [h]bar
27348 narrow [h]bar <-> no cursor
27349 other type <-> no cursor */
27351 if (cursor_type
== FILLED_BOX_CURSOR
)
27352 return HOLLOW_BOX_CURSOR
;
27354 if ((cursor_type
== BAR_CURSOR
|| cursor_type
== HBAR_CURSOR
) && *width
> 1)
27357 return cursor_type
;
27365 /* Notice when the text cursor of window W has been completely
27366 overwritten by a drawing operation that outputs glyphs in AREA
27367 starting at X0 and ending at X1 in the line starting at Y0 and
27368 ending at Y1. X coordinates are area-relative. X1 < 0 means all
27369 the rest of the line after X0 has been written. Y coordinates
27370 are window-relative. */
27373 notice_overwritten_cursor (struct window
*w
, enum glyph_row_area area
,
27374 int x0
, int x1
, int y0
, int y1
)
27376 int cx0
, cx1
, cy0
, cy1
;
27377 struct glyph_row
*row
;
27379 if (!w
->phys_cursor_on_p
)
27381 if (area
!= TEXT_AREA
)
27384 if (w
->phys_cursor
.vpos
< 0
27385 || w
->phys_cursor
.vpos
>= w
->current_matrix
->nrows
27386 || (row
= w
->current_matrix
->rows
+ w
->phys_cursor
.vpos
,
27387 !(row
->enabled_p
&& MATRIX_ROW_DISPLAYS_TEXT_P (row
))))
27390 if (row
->cursor_in_fringe_p
)
27392 row
->cursor_in_fringe_p
= 0;
27393 draw_fringe_bitmap (w
, row
, row
->reversed_p
);
27394 w
->phys_cursor_on_p
= 0;
27398 cx0
= w
->phys_cursor
.x
;
27399 cx1
= cx0
+ w
->phys_cursor_width
;
27400 if (x0
> cx0
|| (x1
>= 0 && x1
< cx1
))
27403 /* The cursor image will be completely removed from the
27404 screen if the output area intersects the cursor area in
27405 y-direction. When we draw in [y0 y1[, and some part of
27406 the cursor is at y < y0, that part must have been drawn
27407 before. When scrolling, the cursor is erased before
27408 actually scrolling, so we don't come here. When not
27409 scrolling, the rows above the old cursor row must have
27410 changed, and in this case these rows must have written
27411 over the cursor image.
27413 Likewise if part of the cursor is below y1, with the
27414 exception of the cursor being in the first blank row at
27415 the buffer and window end because update_text_area
27416 doesn't draw that row. (Except when it does, but
27417 that's handled in update_text_area.) */
27419 cy0
= w
->phys_cursor
.y
;
27420 cy1
= cy0
+ w
->phys_cursor_height
;
27421 if ((y0
< cy0
|| y0
>= cy1
) && (y1
<= cy0
|| y1
>= cy1
))
27424 w
->phys_cursor_on_p
= 0;
27427 #endif /* HAVE_WINDOW_SYSTEM */
27430 /************************************************************************
27432 ************************************************************************/
27434 #ifdef HAVE_WINDOW_SYSTEM
27437 Fix the display of area AREA of overlapping row ROW in window W
27438 with respect to the overlapping part OVERLAPS. */
27441 x_fix_overlapping_area (struct window
*w
, struct glyph_row
*row
,
27442 enum glyph_row_area area
, int overlaps
)
27449 for (i
= 0; i
< row
->used
[area
];)
27451 if (row
->glyphs
[area
][i
].overlaps_vertically_p
)
27453 int start
= i
, start_x
= x
;
27457 x
+= row
->glyphs
[area
][i
].pixel_width
;
27460 while (i
< row
->used
[area
]
27461 && row
->glyphs
[area
][i
].overlaps_vertically_p
);
27463 draw_glyphs (w
, start_x
, row
, area
,
27465 DRAW_NORMAL_TEXT
, overlaps
);
27469 x
+= row
->glyphs
[area
][i
].pixel_width
;
27479 Draw the cursor glyph of window W in glyph row ROW. See the
27480 comment of draw_glyphs for the meaning of HL. */
27483 draw_phys_cursor_glyph (struct window
*w
, struct glyph_row
*row
,
27484 enum draw_glyphs_face hl
)
27486 /* If cursor hpos is out of bounds, don't draw garbage. This can
27487 happen in mini-buffer windows when switching between echo area
27488 glyphs and mini-buffer. */
27489 if ((row
->reversed_p
27490 ? (w
->phys_cursor
.hpos
>= 0)
27491 : (w
->phys_cursor
.hpos
< row
->used
[TEXT_AREA
])))
27493 int on_p
= w
->phys_cursor_on_p
;
27495 int hpos
= w
->phys_cursor
.hpos
;
27497 /* When the window is hscrolled, cursor hpos can legitimately be
27498 out of bounds, but we draw the cursor at the corresponding
27499 window margin in that case. */
27500 if (!row
->reversed_p
&& hpos
< 0)
27502 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27503 hpos
= row
->used
[TEXT_AREA
] - 1;
27505 x1
= draw_glyphs (w
, w
->phys_cursor
.x
, row
, TEXT_AREA
, hpos
, hpos
+ 1,
27507 w
->phys_cursor_on_p
= on_p
;
27509 if (hl
== DRAW_CURSOR
)
27510 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27511 /* When we erase the cursor, and ROW is overlapped by other
27512 rows, make sure that these overlapping parts of other rows
27514 else if (hl
== DRAW_NORMAL_TEXT
&& row
->overlapped_p
)
27516 w
->phys_cursor_width
= x1
- w
->phys_cursor
.x
;
27518 if (row
> w
->current_matrix
->rows
27519 && MATRIX_ROW_OVERLAPS_SUCC_P (row
- 1))
27520 x_fix_overlapping_area (w
, row
- 1, TEXT_AREA
,
27521 OVERLAPS_ERASED_CURSOR
);
27523 if (MATRIX_ROW_BOTTOM_Y (row
) < window_text_bottom_y (w
)
27524 && MATRIX_ROW_OVERLAPS_PRED_P (row
+ 1))
27525 x_fix_overlapping_area (w
, row
+ 1, TEXT_AREA
,
27526 OVERLAPS_ERASED_CURSOR
);
27532 /* Erase the image of a cursor of window W from the screen. */
27535 erase_phys_cursor (struct window
*w
)
27537 struct frame
*f
= XFRAME (w
->frame
);
27538 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
27539 int hpos
= w
->phys_cursor
.hpos
;
27540 int vpos
= w
->phys_cursor
.vpos
;
27541 int mouse_face_here_p
= 0;
27542 struct glyph_matrix
*active_glyphs
= w
->current_matrix
;
27543 struct glyph_row
*cursor_row
;
27544 struct glyph
*cursor_glyph
;
27545 enum draw_glyphs_face hl
;
27547 /* No cursor displayed or row invalidated => nothing to do on the
27549 if (w
->phys_cursor_type
== NO_CURSOR
)
27550 goto mark_cursor_off
;
27552 /* VPOS >= active_glyphs->nrows means that window has been resized.
27553 Don't bother to erase the cursor. */
27554 if (vpos
>= active_glyphs
->nrows
)
27555 goto mark_cursor_off
;
27557 /* If row containing cursor is marked invalid, there is nothing we
27559 cursor_row
= MATRIX_ROW (active_glyphs
, vpos
);
27560 if (!cursor_row
->enabled_p
)
27561 goto mark_cursor_off
;
27563 /* If line spacing is > 0, old cursor may only be partially visible in
27564 window after split-window. So adjust visible height. */
27565 cursor_row
->visible_height
= min (cursor_row
->visible_height
,
27566 window_text_bottom_y (w
) - cursor_row
->y
);
27568 /* If row is completely invisible, don't attempt to delete a cursor which
27569 isn't there. This can happen if cursor is at top of a window, and
27570 we switch to a buffer with a header line in that window. */
27571 if (cursor_row
->visible_height
<= 0)
27572 goto mark_cursor_off
;
27574 /* If cursor is in the fringe, erase by drawing actual bitmap there. */
27575 if (cursor_row
->cursor_in_fringe_p
)
27577 cursor_row
->cursor_in_fringe_p
= 0;
27578 draw_fringe_bitmap (w
, cursor_row
, cursor_row
->reversed_p
);
27579 goto mark_cursor_off
;
27582 /* This can happen when the new row is shorter than the old one.
27583 In this case, either draw_glyphs or clear_end_of_line
27584 should have cleared the cursor. Note that we wouldn't be
27585 able to erase the cursor in this case because we don't have a
27586 cursor glyph at hand. */
27587 if ((cursor_row
->reversed_p
27588 ? (w
->phys_cursor
.hpos
< 0)
27589 : (w
->phys_cursor
.hpos
>= cursor_row
->used
[TEXT_AREA
])))
27590 goto mark_cursor_off
;
27592 /* When the window is hscrolled, cursor hpos can legitimately be out
27593 of bounds, but we draw the cursor at the corresponding window
27594 margin in that case. */
27595 if (!cursor_row
->reversed_p
&& hpos
< 0)
27597 if (cursor_row
->reversed_p
&& hpos
>= cursor_row
->used
[TEXT_AREA
])
27598 hpos
= cursor_row
->used
[TEXT_AREA
] - 1;
27600 /* If the cursor is in the mouse face area, redisplay that when
27601 we clear the cursor. */
27602 if (! NILP (hlinfo
->mouse_face_window
)
27603 && coords_in_mouse_face_p (w
, hpos
, vpos
)
27604 /* Don't redraw the cursor's spot in mouse face if it is at the
27605 end of a line (on a newline). The cursor appears there, but
27606 mouse highlighting does not. */
27607 && cursor_row
->used
[TEXT_AREA
] > hpos
&& hpos
>= 0)
27608 mouse_face_here_p
= 1;
27610 /* Maybe clear the display under the cursor. */
27611 if (w
->phys_cursor_type
== HOLLOW_BOX_CURSOR
)
27614 int header_line_height
= WINDOW_HEADER_LINE_HEIGHT (w
);
27617 cursor_glyph
= get_phys_cursor_glyph (w
);
27618 if (cursor_glyph
== NULL
)
27619 goto mark_cursor_off
;
27621 width
= cursor_glyph
->pixel_width
;
27622 x
= w
->phys_cursor
.x
;
27628 width
= min (width
, window_box_width (w
, TEXT_AREA
) - x
);
27629 y
= WINDOW_TO_FRAME_PIXEL_Y (w
, max (header_line_height
, cursor_row
->y
));
27630 x
= WINDOW_TEXT_TO_FRAME_PIXEL_X (w
, x
);
27633 FRAME_RIF (f
)->clear_frame_area (f
, x
, y
, width
, cursor_row
->visible_height
);
27636 /* Erase the cursor by redrawing the character underneath it. */
27637 if (mouse_face_here_p
)
27638 hl
= DRAW_MOUSE_FACE
;
27640 hl
= DRAW_NORMAL_TEXT
;
27641 draw_phys_cursor_glyph (w
, cursor_row
, hl
);
27644 w
->phys_cursor_on_p
= 0;
27645 w
->phys_cursor_type
= NO_CURSOR
;
27650 Display or clear cursor of window W. If ON is zero, clear the
27651 cursor. If it is non-zero, display the cursor. If ON is nonzero,
27652 where to put the cursor is specified by HPOS, VPOS, X and Y. */
27655 display_and_set_cursor (struct window
*w
, bool on
,
27656 int hpos
, int vpos
, int x
, int y
)
27658 struct frame
*f
= XFRAME (w
->frame
);
27659 int new_cursor_type
;
27660 int new_cursor_width
;
27662 struct glyph_row
*glyph_row
;
27663 struct glyph
*glyph
;
27665 /* This is pointless on invisible frames, and dangerous on garbaged
27666 windows and frames; in the latter case, the frame or window may
27667 be in the midst of changing its size, and x and y may be off the
27669 if (! FRAME_VISIBLE_P (f
)
27670 || FRAME_GARBAGED_P (f
)
27671 || vpos
>= w
->current_matrix
->nrows
27672 || hpos
>= w
->current_matrix
->matrix_w
)
27675 /* If cursor is off and we want it off, return quickly. */
27676 if (!on
&& !w
->phys_cursor_on_p
)
27679 glyph_row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27680 /* If cursor row is not enabled, we don't really know where to
27681 display the cursor. */
27682 if (!glyph_row
->enabled_p
)
27684 w
->phys_cursor_on_p
= 0;
27689 if (!glyph_row
->exact_window_width_line_p
27690 || (0 <= hpos
&& hpos
< glyph_row
->used
[TEXT_AREA
]))
27691 glyph
= glyph_row
->glyphs
[TEXT_AREA
] + hpos
;
27693 eassert (input_blocked_p ());
27695 /* Set new_cursor_type to the cursor we want to be displayed. */
27696 new_cursor_type
= get_window_cursor_type (w
, glyph
,
27697 &new_cursor_width
, &active_cursor
);
27699 /* If cursor is currently being shown and we don't want it to be or
27700 it is in the wrong place, or the cursor type is not what we want,
27702 if (w
->phys_cursor_on_p
27704 || w
->phys_cursor
.x
!= x
27705 || w
->phys_cursor
.y
!= y
27706 /* HPOS can be negative in R2L rows whose
27707 exact_window_width_line_p flag is set (i.e. their newline
27708 would "overflow into the fringe"). */
27710 || new_cursor_type
!= w
->phys_cursor_type
27711 || ((new_cursor_type
== BAR_CURSOR
|| new_cursor_type
== HBAR_CURSOR
)
27712 && new_cursor_width
!= w
->phys_cursor_width
)))
27713 erase_phys_cursor (w
);
27715 /* Don't check phys_cursor_on_p here because that flag is only set
27716 to zero in some cases where we know that the cursor has been
27717 completely erased, to avoid the extra work of erasing the cursor
27718 twice. In other words, phys_cursor_on_p can be 1 and the cursor
27719 still not be visible, or it has only been partly erased. */
27722 w
->phys_cursor_ascent
= glyph_row
->ascent
;
27723 w
->phys_cursor_height
= glyph_row
->height
;
27725 /* Set phys_cursor_.* before x_draw_.* is called because some
27726 of them may need the information. */
27727 w
->phys_cursor
.x
= x
;
27728 w
->phys_cursor
.y
= glyph_row
->y
;
27729 w
->phys_cursor
.hpos
= hpos
;
27730 w
->phys_cursor
.vpos
= vpos
;
27733 FRAME_RIF (f
)->draw_window_cursor (w
, glyph_row
, x
, y
,
27734 new_cursor_type
, new_cursor_width
,
27735 on
, active_cursor
);
27739 /* Switch the display of W's cursor on or off, according to the value
27743 update_window_cursor (struct window
*w
, bool on
)
27745 /* Don't update cursor in windows whose frame is in the process
27746 of being deleted. */
27747 if (w
->current_matrix
)
27749 int hpos
= w
->phys_cursor
.hpos
;
27750 int vpos
= w
->phys_cursor
.vpos
;
27751 struct glyph_row
*row
;
27753 if (vpos
>= w
->current_matrix
->nrows
27754 || hpos
>= w
->current_matrix
->matrix_w
)
27757 row
= MATRIX_ROW (w
->current_matrix
, vpos
);
27759 /* When the window is hscrolled, cursor hpos can legitimately be
27760 out of bounds, but we draw the cursor at the corresponding
27761 window margin in that case. */
27762 if (!row
->reversed_p
&& hpos
< 0)
27764 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27765 hpos
= row
->used
[TEXT_AREA
] - 1;
27768 display_and_set_cursor (w
, on
, hpos
, vpos
,
27769 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27775 /* Call update_window_cursor with parameter ON_P on all leaf windows
27776 in the window tree rooted at W. */
27779 update_cursor_in_window_tree (struct window
*w
, bool on_p
)
27783 if (WINDOWP (w
->contents
))
27784 update_cursor_in_window_tree (XWINDOW (w
->contents
), on_p
);
27786 update_window_cursor (w
, on_p
);
27788 w
= NILP (w
->next
) ? 0 : XWINDOW (w
->next
);
27794 Display the cursor on window W, or clear it, according to ON_P.
27795 Don't change the cursor's position. */
27798 x_update_cursor (struct frame
*f
, bool on_p
)
27800 update_cursor_in_window_tree (XWINDOW (f
->root_window
), on_p
);
27805 Clear the cursor of window W to background color, and mark the
27806 cursor as not shown. This is used when the text where the cursor
27807 is about to be rewritten. */
27810 x_clear_cursor (struct window
*w
)
27812 if (FRAME_VISIBLE_P (XFRAME (w
->frame
)) && w
->phys_cursor_on_p
)
27813 update_window_cursor (w
, 0);
27816 #endif /* HAVE_WINDOW_SYSTEM */
27818 /* Implementation of draw_row_with_mouse_face for GUI sessions, GPM,
27821 draw_row_with_mouse_face (struct window
*w
, int start_x
, struct glyph_row
*row
,
27822 int start_hpos
, int end_hpos
,
27823 enum draw_glyphs_face draw
)
27825 #ifdef HAVE_WINDOW_SYSTEM
27826 if (FRAME_WINDOW_P (XFRAME (w
->frame
)))
27828 draw_glyphs (w
, start_x
, row
, TEXT_AREA
, start_hpos
, end_hpos
, draw
, 0);
27832 #if defined (HAVE_GPM) || defined (MSDOS) || defined (WINDOWSNT)
27833 tty_draw_row_with_mouse_face (w
, row
, start_hpos
, end_hpos
, draw
);
27837 /* Display the active region described by mouse_face_* according to DRAW. */
27840 show_mouse_face (Mouse_HLInfo
*hlinfo
, enum draw_glyphs_face draw
)
27842 struct window
*w
= XWINDOW (hlinfo
->mouse_face_window
);
27843 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
27845 if (/* If window is in the process of being destroyed, don't bother
27847 w
->current_matrix
!= NULL
27848 /* Don't update mouse highlight if hidden. */
27849 && (draw
!= DRAW_MOUSE_FACE
|| !hlinfo
->mouse_face_hidden
)
27850 /* Recognize when we are called to operate on rows that don't exist
27851 anymore. This can happen when a window is split. */
27852 && hlinfo
->mouse_face_end_row
< w
->current_matrix
->nrows
)
27854 int phys_cursor_on_p
= w
->phys_cursor_on_p
;
27855 struct glyph_row
*row
, *first
, *last
;
27857 first
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_beg_row
);
27858 last
= MATRIX_ROW (w
->current_matrix
, hlinfo
->mouse_face_end_row
);
27860 for (row
= first
; row
<= last
&& row
->enabled_p
; ++row
)
27862 int start_hpos
, end_hpos
, start_x
;
27864 /* For all but the first row, the highlight starts at column 0. */
27867 /* R2L rows have BEG and END in reversed order, but the
27868 screen drawing geometry is always left to right. So
27869 we need to mirror the beginning and end of the
27870 highlighted area in R2L rows. */
27871 if (!row
->reversed_p
)
27873 start_hpos
= hlinfo
->mouse_face_beg_col
;
27874 start_x
= hlinfo
->mouse_face_beg_x
;
27876 else if (row
== last
)
27878 start_hpos
= hlinfo
->mouse_face_end_col
;
27879 start_x
= hlinfo
->mouse_face_end_x
;
27887 else if (row
->reversed_p
&& row
== last
)
27889 start_hpos
= hlinfo
->mouse_face_end_col
;
27890 start_x
= hlinfo
->mouse_face_end_x
;
27900 if (!row
->reversed_p
)
27901 end_hpos
= hlinfo
->mouse_face_end_col
;
27902 else if (row
== first
)
27903 end_hpos
= hlinfo
->mouse_face_beg_col
;
27906 end_hpos
= row
->used
[TEXT_AREA
];
27907 if (draw
== DRAW_NORMAL_TEXT
)
27908 row
->fill_line_p
= 1; /* Clear to end of line */
27911 else if (row
->reversed_p
&& row
== first
)
27912 end_hpos
= hlinfo
->mouse_face_beg_col
;
27915 end_hpos
= row
->used
[TEXT_AREA
];
27916 if (draw
== DRAW_NORMAL_TEXT
)
27917 row
->fill_line_p
= 1; /* Clear to end of line */
27920 if (end_hpos
> start_hpos
)
27922 draw_row_with_mouse_face (w
, start_x
, row
,
27923 start_hpos
, end_hpos
, draw
);
27926 = draw
== DRAW_MOUSE_FACE
|| draw
== DRAW_IMAGE_RAISED
;
27930 #ifdef HAVE_WINDOW_SYSTEM
27931 /* When we've written over the cursor, arrange for it to
27932 be displayed again. */
27933 if (FRAME_WINDOW_P (f
)
27934 && phys_cursor_on_p
&& !w
->phys_cursor_on_p
)
27936 int hpos
= w
->phys_cursor
.hpos
;
27938 /* When the window is hscrolled, cursor hpos can legitimately be
27939 out of bounds, but we draw the cursor at the corresponding
27940 window margin in that case. */
27941 if (!row
->reversed_p
&& hpos
< 0)
27943 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
27944 hpos
= row
->used
[TEXT_AREA
] - 1;
27947 display_and_set_cursor (w
, 1, hpos
, w
->phys_cursor
.vpos
,
27948 w
->phys_cursor
.x
, w
->phys_cursor
.y
);
27951 #endif /* HAVE_WINDOW_SYSTEM */
27954 #ifdef HAVE_WINDOW_SYSTEM
27955 /* Change the mouse cursor. */
27956 if (FRAME_WINDOW_P (f
))
27958 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
27959 if (draw
== DRAW_NORMAL_TEXT
27960 && !EQ (hlinfo
->mouse_face_window
, f
->tool_bar_window
))
27961 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->text_cursor
);
27964 if (draw
== DRAW_MOUSE_FACE
)
27965 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->hand_cursor
);
27967 FRAME_RIF (f
)->define_frame_cursor (f
, FRAME_X_OUTPUT (f
)->nontext_cursor
);
27969 #endif /* HAVE_WINDOW_SYSTEM */
27973 Clear out the mouse-highlighted active region.
27974 Redraw it un-highlighted first. Value is non-zero if mouse
27975 face was actually drawn unhighlighted. */
27978 clear_mouse_face (Mouse_HLInfo
*hlinfo
)
27982 if (!hlinfo
->mouse_face_hidden
&& !NILP (hlinfo
->mouse_face_window
))
27984 show_mouse_face (hlinfo
, DRAW_NORMAL_TEXT
);
27988 hlinfo
->mouse_face_beg_row
= hlinfo
->mouse_face_beg_col
= -1;
27989 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_end_col
= -1;
27990 hlinfo
->mouse_face_window
= Qnil
;
27991 hlinfo
->mouse_face_overlay
= Qnil
;
27995 /* Return true if the coordinates HPOS and VPOS on windows W are
27996 within the mouse face on that window. */
27998 coords_in_mouse_face_p (struct window
*w
, int hpos
, int vpos
)
28000 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
28002 /* Quickly resolve the easy cases. */
28003 if (!(WINDOWP (hlinfo
->mouse_face_window
)
28004 && XWINDOW (hlinfo
->mouse_face_window
) == w
))
28006 if (vpos
< hlinfo
->mouse_face_beg_row
28007 || vpos
> hlinfo
->mouse_face_end_row
)
28009 if (vpos
> hlinfo
->mouse_face_beg_row
28010 && vpos
< hlinfo
->mouse_face_end_row
)
28013 if (!MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
)
28015 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28017 if (hlinfo
->mouse_face_beg_col
<= hpos
&& hpos
< hlinfo
->mouse_face_end_col
)
28020 else if ((vpos
== hlinfo
->mouse_face_beg_row
28021 && hpos
>= hlinfo
->mouse_face_beg_col
)
28022 || (vpos
== hlinfo
->mouse_face_end_row
28023 && hpos
< hlinfo
->mouse_face_end_col
))
28028 if (hlinfo
->mouse_face_beg_row
== hlinfo
->mouse_face_end_row
)
28030 if (hlinfo
->mouse_face_end_col
< hpos
&& hpos
<= hlinfo
->mouse_face_beg_col
)
28033 else if ((vpos
== hlinfo
->mouse_face_beg_row
28034 && hpos
<= hlinfo
->mouse_face_beg_col
)
28035 || (vpos
== hlinfo
->mouse_face_end_row
28036 && hpos
> hlinfo
->mouse_face_end_col
))
28044 True if physical cursor of window W is within mouse face. */
28047 cursor_in_mouse_face_p (struct window
*w
)
28049 int hpos
= w
->phys_cursor
.hpos
;
28050 int vpos
= w
->phys_cursor
.vpos
;
28051 struct glyph_row
*row
= MATRIX_ROW (w
->current_matrix
, vpos
);
28053 /* When the window is hscrolled, cursor hpos can legitimately be out
28054 of bounds, but we draw the cursor at the corresponding window
28055 margin in that case. */
28056 if (!row
->reversed_p
&& hpos
< 0)
28058 if (row
->reversed_p
&& hpos
>= row
->used
[TEXT_AREA
])
28059 hpos
= row
->used
[TEXT_AREA
] - 1;
28061 return coords_in_mouse_face_p (w
, hpos
, vpos
);
28066 /* Find the glyph rows START_ROW and END_ROW of window W that display
28067 characters between buffer positions START_CHARPOS and END_CHARPOS
28068 (excluding END_CHARPOS). DISP_STRING is a display string that
28069 covers these buffer positions. This is similar to
28070 row_containing_pos, but is more accurate when bidi reordering makes
28071 buffer positions change non-linearly with glyph rows. */
28073 rows_from_pos_range (struct window
*w
,
28074 ptrdiff_t start_charpos
, ptrdiff_t end_charpos
,
28075 Lisp_Object disp_string
,
28076 struct glyph_row
**start
, struct glyph_row
**end
)
28078 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28079 int last_y
= window_text_bottom_y (w
);
28080 struct glyph_row
*row
;
28085 while (!first
->enabled_p
28086 && first
< MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
))
28089 /* Find the START row. */
28091 row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
;
28094 /* A row can potentially be the START row if the range of the
28095 characters it displays intersects the range
28096 [START_CHARPOS..END_CHARPOS). */
28097 if (! ((start_charpos
< MATRIX_ROW_START_CHARPOS (row
)
28098 && end_charpos
< MATRIX_ROW_START_CHARPOS (row
))
28099 /* See the commentary in row_containing_pos, for the
28100 explanation of the complicated way to check whether
28101 some position is beyond the end of the characters
28102 displayed by a row. */
28103 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28104 || (start_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28105 && !row
->ends_at_zv_p
28106 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
)))
28107 && (end_charpos
> MATRIX_ROW_END_CHARPOS (row
)
28108 || (end_charpos
== MATRIX_ROW_END_CHARPOS (row
)
28109 && !row
->ends_at_zv_p
28110 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (row
))))))
28112 /* Found a candidate row. Now make sure at least one of the
28113 glyphs it displays has a charpos from the range
28114 [START_CHARPOS..END_CHARPOS).
28116 This is not obvious because bidi reordering could make
28117 buffer positions of a row be 1,2,3,102,101,100, and if we
28118 want to highlight characters in [50..60), we don't want
28119 this row, even though [50..60) does intersect [1..103),
28120 the range of character positions given by the row's start
28121 and end positions. */
28122 struct glyph
*g
= row
->glyphs
[TEXT_AREA
];
28123 struct glyph
*e
= g
+ row
->used
[TEXT_AREA
];
28127 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28128 && start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28129 /* A glyph that comes from DISP_STRING is by
28130 definition to be highlighted. */
28131 || EQ (g
->object
, disp_string
))
28140 /* Find the END row. */
28142 /* If the last row is partially visible, start looking for END
28143 from that row, instead of starting from FIRST. */
28144 && !(row
->enabled_p
28145 && row
->y
< last_y
&& MATRIX_ROW_BOTTOM_Y (row
) > last_y
))
28147 for ( ; row
->enabled_p
&& MATRIX_ROW_BOTTOM_Y (row
) <= last_y
; row
++)
28149 struct glyph_row
*next
= row
+ 1;
28150 ptrdiff_t next_start
= MATRIX_ROW_START_CHARPOS (next
);
28152 if (!next
->enabled_p
28153 || next
>= MATRIX_BOTTOM_TEXT_ROW (w
->current_matrix
, w
)
28154 /* The first row >= START whose range of displayed characters
28155 does NOT intersect the range [START_CHARPOS..END_CHARPOS]
28156 is the row END + 1. */
28157 || (start_charpos
< next_start
28158 && end_charpos
< next_start
)
28159 || ((start_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28160 || (start_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28161 && !next
->ends_at_zv_p
28162 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))
28163 && (end_charpos
> MATRIX_ROW_END_CHARPOS (next
)
28164 || (end_charpos
== MATRIX_ROW_END_CHARPOS (next
)
28165 && !next
->ends_at_zv_p
28166 && !MATRIX_ROW_ENDS_IN_MIDDLE_OF_CHAR_P (next
)))))
28173 /* If the next row's edges intersect [START_CHARPOS..END_CHARPOS],
28174 but none of the characters it displays are in the range, it is
28176 struct glyph
*g
= next
->glyphs
[TEXT_AREA
];
28177 struct glyph
*s
= g
;
28178 struct glyph
*e
= g
+ next
->used
[TEXT_AREA
];
28182 if (((BUFFERP (g
->object
) || INTEGERP (g
->object
))
28183 && ((start_charpos
<= g
->charpos
&& g
->charpos
< end_charpos
)
28184 /* If the buffer position of the first glyph in
28185 the row is equal to END_CHARPOS, it means
28186 the last character to be highlighted is the
28187 newline of ROW, and we must consider NEXT as
28189 || (((!next
->reversed_p
&& g
== s
)
28190 || (next
->reversed_p
&& g
== e
- 1))
28191 && (g
->charpos
== end_charpos
28192 /* Special case for when NEXT is an
28193 empty line at ZV. */
28194 || (g
->charpos
== -1
28195 && !row
->ends_at_zv_p
28196 && next_start
== end_charpos
)))))
28197 /* A glyph that comes from DISP_STRING is by
28198 definition to be highlighted. */
28199 || EQ (g
->object
, disp_string
))
28208 /* The first row that ends at ZV must be the last to be
28210 else if (next
->ends_at_zv_p
)
28219 /* This function sets the mouse_face_* elements of HLINFO, assuming
28220 the mouse cursor is on a glyph with buffer charpos MOUSE_CHARPOS in
28221 window WINDOW. START_CHARPOS and END_CHARPOS are buffer positions
28222 for the overlay or run of text properties specifying the mouse
28223 face. BEFORE_STRING and AFTER_STRING, if non-nil, are a
28224 before-string and after-string that must also be highlighted.
28225 DISP_STRING, if non-nil, is a display string that may cover some
28226 or all of the highlighted text. */
28229 mouse_face_from_buffer_pos (Lisp_Object window
,
28230 Mouse_HLInfo
*hlinfo
,
28231 ptrdiff_t mouse_charpos
,
28232 ptrdiff_t start_charpos
,
28233 ptrdiff_t end_charpos
,
28234 Lisp_Object before_string
,
28235 Lisp_Object after_string
,
28236 Lisp_Object disp_string
)
28238 struct window
*w
= XWINDOW (window
);
28239 struct glyph_row
*first
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28240 struct glyph_row
*r1
, *r2
;
28241 struct glyph
*glyph
, *end
;
28242 ptrdiff_t ignore
, pos
;
28245 eassert (NILP (disp_string
) || STRINGP (disp_string
));
28246 eassert (NILP (before_string
) || STRINGP (before_string
));
28247 eassert (NILP (after_string
) || STRINGP (after_string
));
28249 /* Find the rows corresponding to START_CHARPOS and END_CHARPOS. */
28250 rows_from_pos_range (w
, start_charpos
, end_charpos
, disp_string
, &r1
, &r2
);
28252 r1
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28253 /* If the before-string or display-string contains newlines,
28254 rows_from_pos_range skips to its last row. Move back. */
28255 if (!NILP (before_string
) || !NILP (disp_string
))
28257 struct glyph_row
*prev
;
28258 while ((prev
= r1
- 1, prev
>= first
)
28259 && MATRIX_ROW_END_CHARPOS (prev
) == start_charpos
28260 && prev
->used
[TEXT_AREA
] > 0)
28262 struct glyph
*beg
= prev
->glyphs
[TEXT_AREA
];
28263 glyph
= beg
+ prev
->used
[TEXT_AREA
];
28264 while (--glyph
>= beg
&& INTEGERP (glyph
->object
));
28266 || !(EQ (glyph
->object
, before_string
)
28267 || EQ (glyph
->object
, disp_string
)))
28274 r2
= MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28275 hlinfo
->mouse_face_past_end
= 1;
28277 else if (!NILP (after_string
))
28279 /* If the after-string has newlines, advance to its last row. */
28280 struct glyph_row
*next
;
28281 struct glyph_row
*last
28282 = MATRIX_ROW (w
->current_matrix
, w
->window_end_vpos
);
28284 for (next
= r2
+ 1;
28286 && next
->used
[TEXT_AREA
] > 0
28287 && EQ (next
->glyphs
[TEXT_AREA
]->object
, after_string
);
28291 /* The rest of the display engine assumes that mouse_face_beg_row is
28292 either above mouse_face_end_row or identical to it. But with
28293 bidi-reordered continued lines, the row for START_CHARPOS could
28294 be below the row for END_CHARPOS. If so, swap the rows and store
28295 them in correct order. */
28298 struct glyph_row
*tem
= r2
;
28304 hlinfo
->mouse_face_beg_row
= MATRIX_ROW_VPOS (r1
, w
->current_matrix
);
28305 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r2
, w
->current_matrix
);
28307 /* For a bidi-reordered row, the positions of BEFORE_STRING,
28308 AFTER_STRING, DISP_STRING, START_CHARPOS, and END_CHARPOS
28309 could be anywhere in the row and in any order. The strategy
28310 below is to find the leftmost and the rightmost glyph that
28311 belongs to either of these 3 strings, or whose position is
28312 between START_CHARPOS and END_CHARPOS, and highlight all the
28313 glyphs between those two. This may cover more than just the text
28314 between START_CHARPOS and END_CHARPOS if the range of characters
28315 strides the bidi level boundary, e.g. if the beginning is in R2L
28316 text while the end is in L2R text or vice versa. */
28317 if (!r1
->reversed_p
)
28319 /* This row is in a left to right paragraph. Scan it left to
28321 glyph
= r1
->glyphs
[TEXT_AREA
];
28322 end
= glyph
+ r1
->used
[TEXT_AREA
];
28325 /* Skip truncation glyphs at the start of the glyph row. */
28326 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28328 && INTEGERP (glyph
->object
)
28329 && glyph
->charpos
< 0;
28331 x
+= glyph
->pixel_width
;
28333 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28334 or DISP_STRING, and the first glyph from buffer whose
28335 position is between START_CHARPOS and END_CHARPOS. */
28337 && !INTEGERP (glyph
->object
)
28338 && !EQ (glyph
->object
, disp_string
)
28339 && !(BUFFERP (glyph
->object
)
28340 && (glyph
->charpos
>= start_charpos
28341 && glyph
->charpos
< end_charpos
));
28344 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28345 are present at buffer positions between START_CHARPOS and
28346 END_CHARPOS, or if they come from an overlay. */
28347 if (EQ (glyph
->object
, before_string
))
28349 pos
= string_buffer_position (before_string
,
28351 /* If pos == 0, it means before_string came from an
28352 overlay, not from a buffer position. */
28353 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28356 else if (EQ (glyph
->object
, after_string
))
28358 pos
= string_buffer_position (after_string
, end_charpos
);
28359 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28362 x
+= glyph
->pixel_width
;
28364 hlinfo
->mouse_face_beg_x
= x
;
28365 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28369 /* This row is in a right to left paragraph. Scan it right to
28373 end
= r1
->glyphs
[TEXT_AREA
] - 1;
28374 glyph
= end
+ r1
->used
[TEXT_AREA
];
28376 /* Skip truncation glyphs at the start of the glyph row. */
28377 if (MATRIX_ROW_DISPLAYS_TEXT_P (r1
))
28379 && INTEGERP (glyph
->object
)
28380 && glyph
->charpos
< 0;
28384 /* Scan the glyph row, looking for BEFORE_STRING, AFTER_STRING,
28385 or DISP_STRING, and the first glyph from buffer whose
28386 position is between START_CHARPOS and END_CHARPOS. */
28388 && !INTEGERP (glyph
->object
)
28389 && !EQ (glyph
->object
, disp_string
)
28390 && !(BUFFERP (glyph
->object
)
28391 && (glyph
->charpos
>= start_charpos
28392 && glyph
->charpos
< end_charpos
));
28395 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28396 are present at buffer positions between START_CHARPOS and
28397 END_CHARPOS, or if they come from an overlay. */
28398 if (EQ (glyph
->object
, before_string
))
28400 pos
= string_buffer_position (before_string
, start_charpos
);
28401 /* If pos == 0, it means before_string came from an
28402 overlay, not from a buffer position. */
28403 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28406 else if (EQ (glyph
->object
, after_string
))
28408 pos
= string_buffer_position (after_string
, end_charpos
);
28409 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28414 glyph
++; /* first glyph to the right of the highlighted area */
28415 for (g
= r1
->glyphs
[TEXT_AREA
], x
= r1
->x
; g
< glyph
; g
++)
28416 x
+= g
->pixel_width
;
28417 hlinfo
->mouse_face_beg_x
= x
;
28418 hlinfo
->mouse_face_beg_col
= glyph
- r1
->glyphs
[TEXT_AREA
];
28421 /* If the highlight ends in a different row, compute GLYPH and END
28422 for the end row. Otherwise, reuse the values computed above for
28423 the row where the highlight begins. */
28426 if (!r2
->reversed_p
)
28428 glyph
= r2
->glyphs
[TEXT_AREA
];
28429 end
= glyph
+ r2
->used
[TEXT_AREA
];
28434 end
= r2
->glyphs
[TEXT_AREA
] - 1;
28435 glyph
= end
+ r2
->used
[TEXT_AREA
];
28439 if (!r2
->reversed_p
)
28441 /* Skip truncation and continuation glyphs near the end of the
28442 row, and also blanks and stretch glyphs inserted by
28443 extend_face_to_end_of_line. */
28445 && INTEGERP ((end
- 1)->object
))
28447 /* Scan the rest of the glyph row from the end, looking for the
28448 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28449 DISP_STRING, or whose position is between START_CHARPOS
28453 && !INTEGERP (end
->object
)
28454 && !EQ (end
->object
, disp_string
)
28455 && !(BUFFERP (end
->object
)
28456 && (end
->charpos
>= start_charpos
28457 && end
->charpos
< end_charpos
));
28460 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28461 are present at buffer positions between START_CHARPOS and
28462 END_CHARPOS, or if they come from an overlay. */
28463 if (EQ (end
->object
, before_string
))
28465 pos
= string_buffer_position (before_string
, start_charpos
);
28466 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28469 else if (EQ (end
->object
, after_string
))
28471 pos
= string_buffer_position (after_string
, end_charpos
);
28472 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28476 /* Find the X coordinate of the last glyph to be highlighted. */
28477 for (; glyph
<= end
; ++glyph
)
28478 x
+= glyph
->pixel_width
;
28480 hlinfo
->mouse_face_end_x
= x
;
28481 hlinfo
->mouse_face_end_col
= glyph
- r2
->glyphs
[TEXT_AREA
];
28485 /* Skip truncation and continuation glyphs near the end of the
28486 row, and also blanks and stretch glyphs inserted by
28487 extend_face_to_end_of_line. */
28491 && INTEGERP (end
->object
))
28493 x
+= end
->pixel_width
;
28496 /* Scan the rest of the glyph row from the end, looking for the
28497 first glyph that comes from BEFORE_STRING, AFTER_STRING, or
28498 DISP_STRING, or whose position is between START_CHARPOS
28502 && !INTEGERP (end
->object
)
28503 && !EQ (end
->object
, disp_string
)
28504 && !(BUFFERP (end
->object
)
28505 && (end
->charpos
>= start_charpos
28506 && end
->charpos
< end_charpos
));
28509 /* BEFORE_STRING or AFTER_STRING are only relevant if they
28510 are present at buffer positions between START_CHARPOS and
28511 END_CHARPOS, or if they come from an overlay. */
28512 if (EQ (end
->object
, before_string
))
28514 pos
= string_buffer_position (before_string
, start_charpos
);
28515 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28518 else if (EQ (end
->object
, after_string
))
28520 pos
= string_buffer_position (after_string
, end_charpos
);
28521 if (!pos
|| (pos
>= start_charpos
&& pos
< end_charpos
))
28524 x
+= end
->pixel_width
;
28526 /* If we exited the above loop because we arrived at the last
28527 glyph of the row, and its buffer position is still not in
28528 range, it means the last character in range is the preceding
28529 newline. Bump the end column and x values to get past the
28532 && BUFFERP (end
->object
)
28533 && (end
->charpos
< start_charpos
28534 || end
->charpos
>= end_charpos
))
28536 x
+= end
->pixel_width
;
28539 hlinfo
->mouse_face_end_x
= x
;
28540 hlinfo
->mouse_face_end_col
= end
- r2
->glyphs
[TEXT_AREA
];
28543 hlinfo
->mouse_face_window
= window
;
28544 hlinfo
->mouse_face_face_id
28545 = face_at_buffer_position (w
, mouse_charpos
, &ignore
,
28547 !hlinfo
->mouse_face_hidden
, -1);
28548 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
28551 /* The following function is not used anymore (replaced with
28552 mouse_face_from_string_pos), but I leave it here for the time
28553 being, in case someone would. */
28555 #if 0 /* not used */
28557 /* Find the position of the glyph for position POS in OBJECT in
28558 window W's current matrix, and return in *X, *Y the pixel
28559 coordinates, and return in *HPOS, *VPOS the column/row of the glyph.
28561 RIGHT_P non-zero means return the position of the right edge of the
28562 glyph, RIGHT_P zero means return the left edge position.
28564 If no glyph for POS exists in the matrix, return the position of
28565 the glyph with the next smaller position that is in the matrix, if
28566 RIGHT_P is zero. If RIGHT_P is non-zero, and no glyph for POS
28567 exists in the matrix, return the position of the glyph with the
28568 next larger position in OBJECT.
28570 Value is non-zero if a glyph was found. */
28573 fast_find_string_pos (struct window
*w
, ptrdiff_t pos
, Lisp_Object object
,
28574 int *hpos
, int *vpos
, int *x
, int *y
, int right_p
)
28576 int yb
= window_text_bottom_y (w
);
28577 struct glyph_row
*r
;
28578 struct glyph
*best_glyph
= NULL
;
28579 struct glyph_row
*best_row
= NULL
;
28582 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28583 r
->enabled_p
&& r
->y
< yb
;
28586 struct glyph
*g
= r
->glyphs
[TEXT_AREA
];
28587 struct glyph
*e
= g
+ r
->used
[TEXT_AREA
];
28590 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28591 if (EQ (g
->object
, object
))
28593 if (g
->charpos
== pos
)
28600 else if (best_glyph
== NULL
28601 || ((eabs (g
->charpos
- pos
)
28602 < eabs (best_glyph
->charpos
- pos
))
28605 : g
->charpos
> pos
)))
28619 *hpos
= best_glyph
- best_row
->glyphs
[TEXT_AREA
];
28623 *x
+= best_glyph
->pixel_width
;
28628 *vpos
= MATRIX_ROW_VPOS (best_row
, w
->current_matrix
);
28631 return best_glyph
!= NULL
;
28633 #endif /* not used */
28635 /* Find the positions of the first and the last glyphs in window W's
28636 current matrix that occlude positions [STARTPOS..ENDPOS) in OBJECT
28637 (assumed to be a string), and return in HLINFO's mouse_face_*
28638 members the pixel and column/row coordinates of those glyphs. */
28641 mouse_face_from_string_pos (struct window
*w
, Mouse_HLInfo
*hlinfo
,
28642 Lisp_Object object
,
28643 ptrdiff_t startpos
, ptrdiff_t endpos
)
28645 int yb
= window_text_bottom_y (w
);
28646 struct glyph_row
*r
;
28647 struct glyph
*g
, *e
;
28651 /* Find the glyph row with at least one position in the range
28652 [STARTPOS..ENDPOS), and the first glyph in that row whose
28653 position belongs to that range. */
28654 for (r
= MATRIX_FIRST_TEXT_ROW (w
->current_matrix
);
28655 r
->enabled_p
&& r
->y
< yb
;
28658 if (!r
->reversed_p
)
28660 g
= r
->glyphs
[TEXT_AREA
];
28661 e
= g
+ r
->used
[TEXT_AREA
];
28662 for (gx
= r
->x
; g
< e
; gx
+= g
->pixel_width
, ++g
)
28663 if (EQ (g
->object
, object
)
28664 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28666 hlinfo
->mouse_face_beg_row
28667 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28668 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28669 hlinfo
->mouse_face_beg_x
= gx
;
28678 e
= r
->glyphs
[TEXT_AREA
];
28679 g
= e
+ r
->used
[TEXT_AREA
];
28680 for ( ; g
> e
; --g
)
28681 if (EQ ((g
-1)->object
, object
)
28682 && startpos
<= (g
-1)->charpos
&& (g
-1)->charpos
< endpos
)
28684 hlinfo
->mouse_face_beg_row
28685 = MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28686 hlinfo
->mouse_face_beg_col
= g
- r
->glyphs
[TEXT_AREA
];
28687 for (gx
= r
->x
, g1
= r
->glyphs
[TEXT_AREA
]; g1
< g
; ++g1
)
28688 gx
+= g1
->pixel_width
;
28689 hlinfo
->mouse_face_beg_x
= gx
;
28701 /* Starting with the next row, look for the first row which does NOT
28702 include any glyphs whose positions are in the range. */
28703 for (++r
; r
->enabled_p
&& r
->y
< yb
; ++r
)
28705 g
= r
->glyphs
[TEXT_AREA
];
28706 e
= g
+ r
->used
[TEXT_AREA
];
28708 for ( ; g
< e
; ++g
)
28709 if (EQ (g
->object
, object
)
28710 && startpos
<= g
->charpos
&& g
->charpos
< endpos
)
28719 /* The highlighted region ends on the previous row. */
28722 /* Set the end row. */
28723 hlinfo
->mouse_face_end_row
= MATRIX_ROW_VPOS (r
, w
->current_matrix
);
28725 /* Compute and set the end column and the end column's horizontal
28726 pixel coordinate. */
28727 if (!r
->reversed_p
)
28729 g
= r
->glyphs
[TEXT_AREA
];
28730 e
= g
+ r
->used
[TEXT_AREA
];
28731 for ( ; e
> g
; --e
)
28732 if (EQ ((e
-1)->object
, object
)
28733 && startpos
<= (e
-1)->charpos
&& (e
-1)->charpos
< endpos
)
28735 hlinfo
->mouse_face_end_col
= e
- g
;
28737 for (gx
= r
->x
; g
< e
; ++g
)
28738 gx
+= g
->pixel_width
;
28739 hlinfo
->mouse_face_end_x
= gx
;
28743 e
= r
->glyphs
[TEXT_AREA
];
28744 g
= e
+ r
->used
[TEXT_AREA
];
28745 for (gx
= r
->x
; e
< g
; ++e
)
28747 if (EQ (e
->object
, object
)
28748 && startpos
<= e
->charpos
&& e
->charpos
< endpos
)
28750 gx
+= e
->pixel_width
;
28752 hlinfo
->mouse_face_end_col
= e
- r
->glyphs
[TEXT_AREA
];
28753 hlinfo
->mouse_face_end_x
= gx
;
28757 #ifdef HAVE_WINDOW_SYSTEM
28759 /* See if position X, Y is within a hot-spot of an image. */
28762 on_hot_spot_p (Lisp_Object hot_spot
, int x
, int y
)
28764 if (!CONSP (hot_spot
))
28767 if (EQ (XCAR (hot_spot
), Qrect
))
28769 /* CDR is (Top-Left . Bottom-Right) = ((x0 . y0) . (x1 . y1)) */
28770 Lisp_Object rect
= XCDR (hot_spot
);
28774 if (!CONSP (XCAR (rect
)))
28776 if (!CONSP (XCDR (rect
)))
28778 if (!(tem
= XCAR (XCAR (rect
)), INTEGERP (tem
) && x
>= XINT (tem
)))
28780 if (!(tem
= XCDR (XCAR (rect
)), INTEGERP (tem
) && y
>= XINT (tem
)))
28782 if (!(tem
= XCAR (XCDR (rect
)), INTEGERP (tem
) && x
<= XINT (tem
)))
28784 if (!(tem
= XCDR (XCDR (rect
)), INTEGERP (tem
) && y
<= XINT (tem
)))
28788 else if (EQ (XCAR (hot_spot
), Qcircle
))
28790 /* CDR is (Center . Radius) = ((x0 . y0) . r) */
28791 Lisp_Object circ
= XCDR (hot_spot
);
28792 Lisp_Object lr
, lx0
, ly0
;
28794 && CONSP (XCAR (circ
))
28795 && (lr
= XCDR (circ
), INTEGERP (lr
) || FLOATP (lr
))
28796 && (lx0
= XCAR (XCAR (circ
)), INTEGERP (lx0
))
28797 && (ly0
= XCDR (XCAR (circ
)), INTEGERP (ly0
)))
28799 double r
= XFLOATINT (lr
);
28800 double dx
= XINT (lx0
) - x
;
28801 double dy
= XINT (ly0
) - y
;
28802 return (dx
* dx
+ dy
* dy
<= r
* r
);
28805 else if (EQ (XCAR (hot_spot
), Qpoly
))
28807 /* CDR is [x0 y0 x1 y1 x2 y2 ...x(n-1) y(n-1)] */
28808 if (VECTORP (XCDR (hot_spot
)))
28810 struct Lisp_Vector
*v
= XVECTOR (XCDR (hot_spot
));
28811 Lisp_Object
*poly
= v
->contents
;
28812 ptrdiff_t n
= v
->header
.size
;
28815 Lisp_Object lx
, ly
;
28818 /* Need an even number of coordinates, and at least 3 edges. */
28819 if (n
< 6 || n
& 1)
28822 /* Count edge segments intersecting line from (X,Y) to (X,infinity).
28823 If count is odd, we are inside polygon. Pixels on edges
28824 may or may not be included depending on actual geometry of the
28826 if ((lx
= poly
[n
-2], !INTEGERP (lx
))
28827 || (ly
= poly
[n
-1], !INTEGERP (lx
)))
28829 x0
= XINT (lx
), y0
= XINT (ly
);
28830 for (i
= 0; i
< n
; i
+= 2)
28832 int x1
= x0
, y1
= y0
;
28833 if ((lx
= poly
[i
], !INTEGERP (lx
))
28834 || (ly
= poly
[i
+1], !INTEGERP (ly
)))
28836 x0
= XINT (lx
), y0
= XINT (ly
);
28838 /* Does this segment cross the X line? */
28846 if (y
> y0
&& y
> y1
)
28848 if (y
< y0
+ ((y1
- y0
) * (x
- x0
)) / (x1
- x0
))
28858 find_hot_spot (Lisp_Object map
, int x
, int y
)
28860 while (CONSP (map
))
28862 if (CONSP (XCAR (map
))
28863 && on_hot_spot_p (XCAR (XCAR (map
)), x
, y
))
28871 DEFUN ("lookup-image-map", Flookup_image_map
, Slookup_image_map
,
28873 doc
: /* Lookup in image map MAP coordinates X and Y.
28874 An image map is an alist where each element has the format (AREA ID PLIST).
28875 An AREA is specified as either a rectangle, a circle, or a polygon:
28876 A rectangle is a cons (rect . ((x0 . y0) . (x1 . y1))) specifying the
28877 pixel coordinates of the upper left and bottom right corners.
28878 A circle is a cons (circle . ((x0 . y0) . r)) specifying the center
28879 and the radius of the circle; r may be a float or integer.
28880 A polygon is a cons (poly . [x0 y0 x1 y1 ...]) where each pair in the
28881 vector describes one corner in the polygon.
28882 Returns the alist element for the first matching AREA in MAP. */)
28883 (Lisp_Object map
, Lisp_Object x
, Lisp_Object y
)
28891 return find_hot_spot (map
,
28892 clip_to_bounds (INT_MIN
, XINT (x
), INT_MAX
),
28893 clip_to_bounds (INT_MIN
, XINT (y
), INT_MAX
));
28897 /* Display frame CURSOR, optionally using shape defined by POINTER. */
28899 define_frame_cursor1 (struct frame
*f
, Cursor cursor
, Lisp_Object pointer
)
28901 /* Do not change cursor shape while dragging mouse. */
28902 if (!NILP (do_mouse_tracking
))
28905 if (!NILP (pointer
))
28907 if (EQ (pointer
, Qarrow
))
28908 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28909 else if (EQ (pointer
, Qhand
))
28910 cursor
= FRAME_X_OUTPUT (f
)->hand_cursor
;
28911 else if (EQ (pointer
, Qtext
))
28912 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
28913 else if (EQ (pointer
, intern ("hdrag")))
28914 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
28915 else if (EQ (pointer
, intern ("nhdrag")))
28916 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
28917 #ifdef HAVE_X_WINDOWS
28918 else if (EQ (pointer
, intern ("vdrag")))
28919 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
28921 else if (EQ (pointer
, intern ("hourglass")))
28922 cursor
= FRAME_X_OUTPUT (f
)->hourglass_cursor
;
28923 else if (EQ (pointer
, Qmodeline
))
28924 cursor
= FRAME_X_OUTPUT (f
)->modeline_cursor
;
28926 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
28929 if (cursor
!= No_Cursor
)
28930 FRAME_RIF (f
)->define_frame_cursor (f
, cursor
);
28933 #endif /* HAVE_WINDOW_SYSTEM */
28935 /* Take proper action when mouse has moved to the mode or header line
28936 or marginal area AREA of window W, x-position X and y-position Y.
28937 X is relative to the start of the text display area of W, so the
28938 width of bitmap areas and scroll bars must be subtracted to get a
28939 position relative to the start of the mode line. */
28942 note_mode_line_or_margin_highlight (Lisp_Object window
, int x
, int y
,
28943 enum window_part area
)
28945 struct window
*w
= XWINDOW (window
);
28946 struct frame
*f
= XFRAME (w
->frame
);
28947 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
28948 #ifdef HAVE_WINDOW_SYSTEM
28949 Display_Info
*dpyinfo
;
28951 Cursor cursor
= No_Cursor
;
28952 Lisp_Object pointer
= Qnil
;
28953 int dx
, dy
, width
, height
;
28955 Lisp_Object string
, object
= Qnil
;
28956 Lisp_Object pos
IF_LINT (= Qnil
), help
;
28958 Lisp_Object mouse_face
;
28959 int original_x_pixel
= x
;
28960 struct glyph
* glyph
= NULL
, * row_start_glyph
= NULL
;
28961 struct glyph_row
*row
IF_LINT (= 0);
28963 if (area
== ON_MODE_LINE
|| area
== ON_HEADER_LINE
)
28968 /* Kludge alert: mode_line_string takes X/Y in pixels, but
28969 returns them in row/column units! */
28970 string
= mode_line_string (w
, area
, &x
, &y
, &charpos
,
28971 &object
, &dx
, &dy
, &width
, &height
);
28973 row
= (area
== ON_MODE_LINE
28974 ? MATRIX_MODE_LINE_ROW (w
->current_matrix
)
28975 : MATRIX_HEADER_LINE_ROW (w
->current_matrix
));
28977 /* Find the glyph under the mouse pointer. */
28978 if (row
->mode_line_p
&& row
->enabled_p
)
28980 glyph
= row_start_glyph
= row
->glyphs
[TEXT_AREA
];
28981 end
= glyph
+ row
->used
[TEXT_AREA
];
28983 for (x0
= original_x_pixel
;
28984 glyph
< end
&& x0
>= glyph
->pixel_width
;
28986 x0
-= glyph
->pixel_width
;
28994 x
-= WINDOW_LEFT_SCROLL_BAR_AREA_WIDTH (w
);
28995 /* Kludge alert: marginal_area_string takes X/Y in pixels, but
28996 returns them in row/column units! */
28997 string
= marginal_area_string (w
, area
, &x
, &y
, &charpos
,
28998 &object
, &dx
, &dy
, &width
, &height
);
29003 #ifdef HAVE_WINDOW_SYSTEM
29004 if (IMAGEP (object
))
29006 Lisp_Object image_map
, hotspot
;
29007 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
29009 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
29011 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29015 /* Could check XCAR (hotspot) to see if we enter/leave this hot-spot.
29016 If so, we could look for mouse-enter, mouse-leave
29017 properties in PLIST (and do something...). */
29018 hotspot
= XCDR (hotspot
);
29019 if (CONSP (hotspot
)
29020 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29022 pointer
= Fplist_get (plist
, Qpointer
);
29023 if (NILP (pointer
))
29025 help
= Fplist_get (plist
, Qhelp_echo
);
29028 help_echo_string
= help
;
29029 XSETWINDOW (help_echo_window
, w
);
29030 help_echo_object
= w
->contents
;
29031 help_echo_pos
= charpos
;
29035 if (NILP (pointer
))
29036 pointer
= Fplist_get (XCDR (object
), QCpointer
);
29038 #endif /* HAVE_WINDOW_SYSTEM */
29040 if (STRINGP (string
))
29041 pos
= make_number (charpos
);
29043 /* Set the help text and mouse pointer. If the mouse is on a part
29044 of the mode line without any text (e.g. past the right edge of
29045 the mode line text), use the default help text and pointer. */
29046 if (STRINGP (string
) || area
== ON_MODE_LINE
)
29048 /* Arrange to display the help by setting the global variables
29049 help_echo_string, help_echo_object, and help_echo_pos. */
29052 if (STRINGP (string
))
29053 help
= Fget_text_property (pos
, Qhelp_echo
, string
);
29057 help_echo_string
= help
;
29058 XSETWINDOW (help_echo_window
, w
);
29059 help_echo_object
= string
;
29060 help_echo_pos
= charpos
;
29062 else if (area
== ON_MODE_LINE
)
29064 Lisp_Object default_help
29065 = buffer_local_value (Qmode_line_default_help_echo
,
29068 if (STRINGP (default_help
))
29070 help_echo_string
= default_help
;
29071 XSETWINDOW (help_echo_window
, w
);
29072 help_echo_object
= Qnil
;
29073 help_echo_pos
= -1;
29078 #ifdef HAVE_WINDOW_SYSTEM
29079 /* Change the mouse pointer according to what is under it. */
29080 if (FRAME_WINDOW_P (f
))
29082 bool draggable
= (! WINDOW_BOTTOMMOST_P (w
)
29084 || NILP (Vresize_mini_windows
));
29086 dpyinfo
= FRAME_DISPLAY_INFO (f
);
29087 if (STRINGP (string
))
29089 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29091 if (NILP (pointer
))
29092 pointer
= Fget_text_property (pos
, Qpointer
, string
);
29094 /* Change the mouse pointer according to what is under X/Y. */
29096 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
)))
29099 map
= Fget_text_property (pos
, Qlocal_map
, string
);
29100 if (!KEYMAPP (map
))
29101 map
= Fget_text_property (pos
, Qkeymap
, string
);
29102 if (!KEYMAPP (map
) && draggable
)
29103 cursor
= dpyinfo
->vertical_scroll_bar_cursor
;
29106 else if (draggable
)
29107 /* Default mode-line pointer. */
29108 cursor
= FRAME_DISPLAY_INFO (f
)->vertical_scroll_bar_cursor
;
29113 /* Change the mouse face according to what is under X/Y. */
29114 if (STRINGP (string
))
29116 mouse_face
= Fget_text_property (pos
, Qmouse_face
, string
);
29117 if (!NILP (Vmouse_highlight
) && !NILP (mouse_face
)
29118 && ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29123 struct glyph
* tmp_glyph
;
29127 int total_pixel_width
;
29128 ptrdiff_t begpos
, endpos
, ignore
;
29132 b
= Fprevious_single_property_change (make_number (charpos
+ 1),
29133 Qmouse_face
, string
, Qnil
);
29139 e
= Fnext_single_property_change (pos
, Qmouse_face
, string
, Qnil
);
29141 endpos
= SCHARS (string
);
29145 /* Calculate the glyph position GPOS of GLYPH in the
29146 displayed string, relative to the beginning of the
29147 highlighted part of the string.
29149 Note: GPOS is different from CHARPOS. CHARPOS is the
29150 position of GLYPH in the internal string object. A mode
29151 line string format has structures which are converted to
29152 a flattened string by the Emacs Lisp interpreter. The
29153 internal string is an element of those structures. The
29154 displayed string is the flattened string. */
29155 tmp_glyph
= row_start_glyph
;
29156 while (tmp_glyph
< glyph
29157 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29158 && begpos
<= tmp_glyph
->charpos
29159 && tmp_glyph
->charpos
< endpos
)))
29161 gpos
= glyph
- tmp_glyph
;
29163 /* Calculate the length GSEQ_LENGTH of the glyph sequence of
29164 the highlighted part of the displayed string to which
29165 GLYPH belongs. Note: GSEQ_LENGTH is different from
29166 SCHARS (STRING), because the latter returns the length of
29167 the internal string. */
29168 for (tmp_glyph
= row
->glyphs
[TEXT_AREA
] + row
->used
[TEXT_AREA
] - 1;
29170 && (!(EQ (tmp_glyph
->object
, glyph
->object
)
29171 && begpos
<= tmp_glyph
->charpos
29172 && tmp_glyph
->charpos
< endpos
));
29175 gseq_length
= gpos
+ (tmp_glyph
- glyph
) + 1;
29177 /* Calculate the total pixel width of all the glyphs between
29178 the beginning of the highlighted area and GLYPH. */
29179 total_pixel_width
= 0;
29180 for (tmp_glyph
= glyph
- gpos
; tmp_glyph
!= glyph
; tmp_glyph
++)
29181 total_pixel_width
+= tmp_glyph
->pixel_width
;
29183 /* Pre calculation of re-rendering position. Note: X is in
29184 column units here, after the call to mode_line_string or
29185 marginal_area_string. */
29187 vpos
= (area
== ON_MODE_LINE
29188 ? (w
->current_matrix
)->nrows
- 1
29191 /* If GLYPH's position is included in the region that is
29192 already drawn in mouse face, we have nothing to do. */
29193 if ( EQ (window
, hlinfo
->mouse_face_window
)
29194 && (!row
->reversed_p
29195 ? (hlinfo
->mouse_face_beg_col
<= hpos
29196 && hpos
< hlinfo
->mouse_face_end_col
)
29197 /* In R2L rows we swap BEG and END, see below. */
29198 : (hlinfo
->mouse_face_end_col
<= hpos
29199 && hpos
< hlinfo
->mouse_face_beg_col
))
29200 && hlinfo
->mouse_face_beg_row
== vpos
)
29203 if (clear_mouse_face (hlinfo
))
29204 cursor
= No_Cursor
;
29206 if (!row
->reversed_p
)
29208 hlinfo
->mouse_face_beg_col
= hpos
;
29209 hlinfo
->mouse_face_beg_x
= original_x_pixel
29210 - (total_pixel_width
+ dx
);
29211 hlinfo
->mouse_face_end_col
= hpos
+ gseq_length
;
29212 hlinfo
->mouse_face_end_x
= 0;
29216 /* In R2L rows, show_mouse_face expects BEG and END
29217 coordinates to be swapped. */
29218 hlinfo
->mouse_face_end_col
= hpos
;
29219 hlinfo
->mouse_face_end_x
= original_x_pixel
29220 - (total_pixel_width
+ dx
);
29221 hlinfo
->mouse_face_beg_col
= hpos
+ gseq_length
;
29222 hlinfo
->mouse_face_beg_x
= 0;
29225 hlinfo
->mouse_face_beg_row
= vpos
;
29226 hlinfo
->mouse_face_end_row
= hlinfo
->mouse_face_beg_row
;
29227 hlinfo
->mouse_face_past_end
= 0;
29228 hlinfo
->mouse_face_window
= window
;
29230 hlinfo
->mouse_face_face_id
= face_at_string_position (w
, string
,
29235 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29237 if (NILP (pointer
))
29240 else if ((area
== ON_MODE_LINE
) || (area
== ON_HEADER_LINE
))
29241 clear_mouse_face (hlinfo
);
29243 #ifdef HAVE_WINDOW_SYSTEM
29244 if (FRAME_WINDOW_P (f
))
29245 define_frame_cursor1 (f
, cursor
, pointer
);
29251 Take proper action when the mouse has moved to position X, Y on
29252 frame F with regards to highlighting portions of display that have
29253 mouse-face properties. Also de-highlight portions of display where
29254 the mouse was before, set the mouse pointer shape as appropriate
29255 for the mouse coordinates, and activate help echo (tooltips).
29256 X and Y can be negative or out of range. */
29259 note_mouse_highlight (struct frame
*f
, int x
, int y
)
29261 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29262 enum window_part part
= ON_NOTHING
;
29263 Lisp_Object window
;
29265 Cursor cursor
= No_Cursor
;
29266 Lisp_Object pointer
= Qnil
; /* Takes precedence over cursor! */
29269 /* When a menu is active, don't highlight because this looks odd. */
29270 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (MSDOS)
29271 if (popup_activated ())
29275 if (!f
->glyphs_initialized_p
29276 || f
->pointer_invisible
)
29279 hlinfo
->mouse_face_mouse_x
= x
;
29280 hlinfo
->mouse_face_mouse_y
= y
;
29281 hlinfo
->mouse_face_mouse_frame
= f
;
29283 if (hlinfo
->mouse_face_defer
)
29286 /* Which window is that in? */
29287 window
= window_from_coordinates (f
, x
, y
, &part
, 1);
29289 /* If displaying active text in another window, clear that. */
29290 if (! EQ (window
, hlinfo
->mouse_face_window
)
29291 /* Also clear if we move out of text area in same window. */
29292 || (!NILP (hlinfo
->mouse_face_window
)
29295 && part
!= ON_MODE_LINE
29296 && part
!= ON_HEADER_LINE
))
29297 clear_mouse_face (hlinfo
);
29299 /* Not on a window -> return. */
29300 if (!WINDOWP (window
))
29303 /* Reset help_echo_string. It will get recomputed below. */
29304 help_echo_string
= Qnil
;
29306 /* Convert to window-relative pixel coordinates. */
29307 w
= XWINDOW (window
);
29308 frame_to_window_pixel_xy (w
, &x
, &y
);
29310 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
29311 /* Handle tool-bar window differently since it doesn't display a
29313 if (EQ (window
, f
->tool_bar_window
))
29315 note_tool_bar_highlight (f
, x
, y
);
29320 /* Mouse is on the mode, header line or margin? */
29321 if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
29322 || part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29324 note_mode_line_or_margin_highlight (window
, x
, y
, part
);
29326 #ifdef HAVE_WINDOW_SYSTEM
29327 if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
29329 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29330 /* Show non-text cursor (Bug#16647). */
29338 #ifdef HAVE_WINDOW_SYSTEM
29339 if (part
== ON_VERTICAL_BORDER
)
29341 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29342 help_echo_string
= build_string ("drag-mouse-1: resize");
29344 else if (part
== ON_RIGHT_DIVIDER
)
29346 cursor
= FRAME_X_OUTPUT (f
)->horizontal_drag_cursor
;
29347 help_echo_string
= build_string ("drag-mouse-1: resize");
29349 else if (part
== ON_BOTTOM_DIVIDER
)
29350 if (! WINDOW_BOTTOMMOST_P (w
)
29352 || NILP (Vresize_mini_windows
))
29354 cursor
= FRAME_X_OUTPUT (f
)->vertical_drag_cursor
;
29355 help_echo_string
= build_string ("drag-mouse-1: resize");
29358 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29359 else if (part
== ON_LEFT_FRINGE
|| part
== ON_RIGHT_FRINGE
29360 || part
== ON_VERTICAL_SCROLL_BAR
29361 || part
== ON_HORIZONTAL_SCROLL_BAR
)
29362 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29364 cursor
= FRAME_X_OUTPUT (f
)->text_cursor
;
29367 /* Are we in a window whose display is up to date?
29368 And verify the buffer's text has not changed. */
29369 b
= XBUFFER (w
->contents
);
29370 if (part
== ON_TEXT
&& w
->window_end_valid
&& !window_outdated (w
))
29372 int hpos
, vpos
, dx
, dy
, area
= LAST_AREA
;
29374 struct glyph
*glyph
;
29375 Lisp_Object object
;
29376 Lisp_Object mouse_face
= Qnil
, position
;
29377 Lisp_Object
*overlay_vec
= NULL
;
29378 ptrdiff_t i
, noverlays
;
29379 struct buffer
*obuf
;
29380 ptrdiff_t obegv
, ozv
;
29383 /* Find the glyph under X/Y. */
29384 glyph
= x_y_to_hpos_vpos (w
, x
, y
, &hpos
, &vpos
, &dx
, &dy
, &area
);
29386 #ifdef HAVE_WINDOW_SYSTEM
29387 /* Look for :pointer property on image. */
29388 if (glyph
!= NULL
&& glyph
->type
== IMAGE_GLYPH
)
29390 struct image
*img
= IMAGE_FROM_ID (f
, glyph
->u
.img_id
);
29391 if (img
!= NULL
&& IMAGEP (img
->spec
))
29393 Lisp_Object image_map
, hotspot
;
29394 if ((image_map
= Fplist_get (XCDR (img
->spec
), QCmap
),
29396 && (hotspot
= find_hot_spot (image_map
,
29397 glyph
->slice
.img
.x
+ dx
,
29398 glyph
->slice
.img
.y
+ dy
),
29400 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
29404 /* Could check XCAR (hotspot) to see if we enter/leave
29406 If so, we could look for mouse-enter, mouse-leave
29407 properties in PLIST (and do something...). */
29408 hotspot
= XCDR (hotspot
);
29409 if (CONSP (hotspot
)
29410 && (plist
= XCAR (hotspot
), CONSP (plist
)))
29412 pointer
= Fplist_get (plist
, Qpointer
);
29413 if (NILP (pointer
))
29415 help_echo_string
= Fplist_get (plist
, Qhelp_echo
);
29416 if (!NILP (help_echo_string
))
29418 help_echo_window
= window
;
29419 help_echo_object
= glyph
->object
;
29420 help_echo_pos
= glyph
->charpos
;
29424 if (NILP (pointer
))
29425 pointer
= Fplist_get (XCDR (img
->spec
), QCpointer
);
29428 #endif /* HAVE_WINDOW_SYSTEM */
29430 /* Clear mouse face if X/Y not over text. */
29432 || area
!= TEXT_AREA
29433 || !MATRIX_ROW_DISPLAYS_TEXT_P (MATRIX_ROW (w
->current_matrix
, vpos
))
29434 /* Glyph's OBJECT is an integer for glyphs inserted by the
29435 display engine for its internal purposes, like truncation
29436 and continuation glyphs and blanks beyond the end of
29437 line's text on text terminals. If we are over such a
29438 glyph, we are not over any text. */
29439 || INTEGERP (glyph
->object
)
29440 /* R2L rows have a stretch glyph at their front, which
29441 stands for no text, whereas L2R rows have no glyphs at
29442 all beyond the end of text. Treat such stretch glyphs
29443 like we do with NULL glyphs in L2R rows. */
29444 || (MATRIX_ROW (w
->current_matrix
, vpos
)->reversed_p
29445 && glyph
== MATRIX_ROW_GLYPH_START (w
->current_matrix
, vpos
)
29446 && glyph
->type
== STRETCH_GLYPH
29447 && glyph
->avoid_cursor_p
))
29449 if (clear_mouse_face (hlinfo
))
29450 cursor
= No_Cursor
;
29451 #ifdef HAVE_WINDOW_SYSTEM
29452 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29454 if (area
!= TEXT_AREA
)
29455 cursor
= FRAME_X_OUTPUT (f
)->nontext_cursor
;
29457 pointer
= Vvoid_text_area_pointer
;
29463 pos
= glyph
->charpos
;
29464 object
= glyph
->object
;
29465 if (!STRINGP (object
) && !BUFFERP (object
))
29468 /* If we get an out-of-range value, return now; avoid an error. */
29469 if (BUFFERP (object
) && pos
> BUF_Z (b
))
29472 /* Make the window's buffer temporarily current for
29473 overlays_at and compute_char_face. */
29474 obuf
= current_buffer
;
29475 current_buffer
= b
;
29481 /* Is this char mouse-active or does it have help-echo? */
29482 position
= make_number (pos
);
29486 if (BUFFERP (object
))
29488 /* Put all the overlays we want in a vector in overlay_vec. */
29489 GET_OVERLAYS_AT (pos
, overlay_vec
, noverlays
, NULL
, 0);
29490 /* Sort overlays into increasing priority order. */
29491 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
29496 if (NILP (Vmouse_highlight
))
29498 clear_mouse_face (hlinfo
);
29499 goto check_help_echo
;
29502 same_region
= coords_in_mouse_face_p (w
, hpos
, vpos
);
29505 cursor
= No_Cursor
;
29507 /* Check mouse-face highlighting. */
29509 /* If there exists an overlay with mouse-face overlapping
29510 the one we are currently highlighting, we have to
29511 check if we enter the overlapping overlay, and then
29512 highlight only that. */
29513 || (OVERLAYP (hlinfo
->mouse_face_overlay
)
29514 && mouse_face_overlay_overlaps (hlinfo
->mouse_face_overlay
)))
29516 /* Find the highest priority overlay with a mouse-face. */
29517 Lisp_Object overlay
= Qnil
;
29518 for (i
= noverlays
- 1; i
>= 0 && NILP (overlay
); --i
)
29520 mouse_face
= Foverlay_get (overlay_vec
[i
], Qmouse_face
);
29521 if (!NILP (mouse_face
))
29522 overlay
= overlay_vec
[i
];
29525 /* If we're highlighting the same overlay as before, there's
29526 no need to do that again. */
29527 if (!NILP (overlay
) && EQ (overlay
, hlinfo
->mouse_face_overlay
))
29528 goto check_help_echo
;
29529 hlinfo
->mouse_face_overlay
= overlay
;
29531 /* Clear the display of the old active region, if any. */
29532 if (clear_mouse_face (hlinfo
))
29533 cursor
= No_Cursor
;
29535 /* If no overlay applies, get a text property. */
29536 if (NILP (overlay
))
29537 mouse_face
= Fget_text_property (position
, Qmouse_face
, object
);
29539 /* Next, compute the bounds of the mouse highlighting and
29541 if (!NILP (mouse_face
) && STRINGP (object
))
29543 /* The mouse-highlighting comes from a display string
29544 with a mouse-face. */
29548 s
= Fprevious_single_property_change
29549 (make_number (pos
+ 1), Qmouse_face
, object
, Qnil
);
29550 e
= Fnext_single_property_change
29551 (position
, Qmouse_face
, object
, Qnil
);
29553 s
= make_number (0);
29555 e
= make_number (SCHARS (object
));
29556 mouse_face_from_string_pos (w
, hlinfo
, object
,
29557 XINT (s
), XINT (e
));
29558 hlinfo
->mouse_face_past_end
= 0;
29559 hlinfo
->mouse_face_window
= window
;
29560 hlinfo
->mouse_face_face_id
29561 = face_at_string_position (w
, object
, pos
, 0, &ignore
,
29562 glyph
->face_id
, 1);
29563 show_mouse_face (hlinfo
, DRAW_MOUSE_FACE
);
29564 cursor
= No_Cursor
;
29568 /* The mouse-highlighting, if any, comes from an overlay
29569 or text property in the buffer. */
29570 Lisp_Object buffer
IF_LINT (= Qnil
);
29571 Lisp_Object disp_string
IF_LINT (= Qnil
);
29573 if (STRINGP (object
))
29575 /* If we are on a display string with no mouse-face,
29576 check if the text under it has one. */
29577 struct glyph_row
*r
= MATRIX_ROW (w
->current_matrix
, vpos
);
29578 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29579 pos
= string_buffer_position (object
, start
);
29582 mouse_face
= get_char_property_and_overlay
29583 (make_number (pos
), Qmouse_face
, w
->contents
, &overlay
);
29584 buffer
= w
->contents
;
29585 disp_string
= object
;
29591 disp_string
= Qnil
;
29594 if (!NILP (mouse_face
))
29596 Lisp_Object before
, after
;
29597 Lisp_Object before_string
, after_string
;
29598 /* To correctly find the limits of mouse highlight
29599 in a bidi-reordered buffer, we must not use the
29600 optimization of limiting the search in
29601 previous-single-property-change and
29602 next-single-property-change, because
29603 rows_from_pos_range needs the real start and end
29604 positions to DTRT in this case. That's because
29605 the first row visible in a window does not
29606 necessarily display the character whose position
29607 is the smallest. */
29609 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29610 ? Fmarker_position (w
->start
)
29613 = NILP (BVAR (XBUFFER (buffer
), bidi_display_reordering
))
29614 ? make_number (BUF_Z (XBUFFER (buffer
))
29615 - w
->window_end_pos
)
29618 if (NILP (overlay
))
29620 /* Handle the text property case. */
29621 before
= Fprevious_single_property_change
29622 (make_number (pos
+ 1), Qmouse_face
, buffer
, lim1
);
29623 after
= Fnext_single_property_change
29624 (make_number (pos
), Qmouse_face
, buffer
, lim2
);
29625 before_string
= after_string
= Qnil
;
29629 /* Handle the overlay case. */
29630 before
= Foverlay_start (overlay
);
29631 after
= Foverlay_end (overlay
);
29632 before_string
= Foverlay_get (overlay
, Qbefore_string
);
29633 after_string
= Foverlay_get (overlay
, Qafter_string
);
29635 if (!STRINGP (before_string
)) before_string
= Qnil
;
29636 if (!STRINGP (after_string
)) after_string
= Qnil
;
29639 mouse_face_from_buffer_pos (window
, hlinfo
, pos
,
29642 : XFASTINT (before
),
29644 ? BUF_Z (XBUFFER (buffer
))
29645 : XFASTINT (after
),
29646 before_string
, after_string
,
29648 cursor
= No_Cursor
;
29655 /* Look for a `help-echo' property. */
29656 if (NILP (help_echo_string
)) {
29657 Lisp_Object help
, overlay
;
29659 /* Check overlays first. */
29660 help
= overlay
= Qnil
;
29661 for (i
= noverlays
- 1; i
>= 0 && NILP (help
); --i
)
29663 overlay
= overlay_vec
[i
];
29664 help
= Foverlay_get (overlay
, Qhelp_echo
);
29669 help_echo_string
= help
;
29670 help_echo_window
= window
;
29671 help_echo_object
= overlay
;
29672 help_echo_pos
= pos
;
29676 Lisp_Object obj
= glyph
->object
;
29677 ptrdiff_t charpos
= glyph
->charpos
;
29679 /* Try text properties. */
29682 && charpos
< SCHARS (obj
))
29684 help
= Fget_text_property (make_number (charpos
),
29688 /* If the string itself doesn't specify a help-echo,
29689 see if the buffer text ``under'' it does. */
29690 struct glyph_row
*r
29691 = MATRIX_ROW (w
->current_matrix
, vpos
);
29692 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29693 ptrdiff_t p
= string_buffer_position (obj
, start
);
29696 help
= Fget_char_property (make_number (p
),
29697 Qhelp_echo
, w
->contents
);
29706 else if (BUFFERP (obj
)
29709 help
= Fget_text_property (make_number (charpos
), Qhelp_echo
,
29714 help_echo_string
= help
;
29715 help_echo_window
= window
;
29716 help_echo_object
= obj
;
29717 help_echo_pos
= charpos
;
29722 #ifdef HAVE_WINDOW_SYSTEM
29723 /* Look for a `pointer' property. */
29724 if (FRAME_WINDOW_P (f
) && NILP (pointer
))
29726 /* Check overlays first. */
29727 for (i
= noverlays
- 1; i
>= 0 && NILP (pointer
); --i
)
29728 pointer
= Foverlay_get (overlay_vec
[i
], Qpointer
);
29730 if (NILP (pointer
))
29732 Lisp_Object obj
= glyph
->object
;
29733 ptrdiff_t charpos
= glyph
->charpos
;
29735 /* Try text properties. */
29738 && charpos
< SCHARS (obj
))
29740 pointer
= Fget_text_property (make_number (charpos
),
29742 if (NILP (pointer
))
29744 /* If the string itself doesn't specify a pointer,
29745 see if the buffer text ``under'' it does. */
29746 struct glyph_row
*r
29747 = MATRIX_ROW (w
->current_matrix
, vpos
);
29748 ptrdiff_t start
= MATRIX_ROW_START_CHARPOS (r
);
29749 ptrdiff_t p
= string_buffer_position (obj
, start
);
29751 pointer
= Fget_char_property (make_number (p
),
29752 Qpointer
, w
->contents
);
29755 else if (BUFFERP (obj
)
29758 pointer
= Fget_text_property (make_number (charpos
),
29762 #endif /* HAVE_WINDOW_SYSTEM */
29766 current_buffer
= obuf
;
29772 #ifdef HAVE_WINDOW_SYSTEM
29773 if (FRAME_WINDOW_P (f
))
29774 define_frame_cursor1 (f
, cursor
, pointer
);
29776 /* This is here to prevent a compiler error, about "label at end of
29777 compound statement". */
29784 Clear any mouse-face on window W. This function is part of the
29785 redisplay interface, and is called from try_window_id and similar
29786 functions to ensure the mouse-highlight is off. */
29789 x_clear_window_mouse_face (struct window
*w
)
29791 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (XFRAME (w
->frame
));
29792 Lisp_Object window
;
29795 XSETWINDOW (window
, w
);
29796 if (EQ (window
, hlinfo
->mouse_face_window
))
29797 clear_mouse_face (hlinfo
);
29803 Just discard the mouse face information for frame F, if any.
29804 This is used when the size of F is changed. */
29807 cancel_mouse_face (struct frame
*f
)
29809 Lisp_Object window
;
29810 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
29812 window
= hlinfo
->mouse_face_window
;
29813 if (! NILP (window
) && XFRAME (XWINDOW (window
)->frame
) == f
)
29814 reset_mouse_highlight (hlinfo
);
29819 /***********************************************************************
29821 ***********************************************************************/
29823 #ifdef HAVE_WINDOW_SYSTEM
29825 /* Redraw the part of glyph row area AREA of glyph row ROW on window W
29826 which intersects rectangle R. R is in window-relative coordinates. */
29829 expose_area (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
,
29830 enum glyph_row_area area
)
29832 struct glyph
*first
= row
->glyphs
[area
];
29833 struct glyph
*end
= row
->glyphs
[area
] + row
->used
[area
];
29834 struct glyph
*last
;
29835 int first_x
, start_x
, x
;
29837 if (area
== TEXT_AREA
&& row
->fill_line_p
)
29838 /* If row extends face to end of line write the whole line. */
29839 draw_glyphs (w
, 0, row
, area
,
29840 0, row
->used
[area
],
29841 DRAW_NORMAL_TEXT
, 0);
29844 /* Set START_X to the window-relative start position for drawing glyphs of
29845 AREA. The first glyph of the text area can be partially visible.
29846 The first glyphs of other areas cannot. */
29847 start_x
= window_box_left_offset (w
, area
);
29849 if (area
== TEXT_AREA
)
29852 /* Find the first glyph that must be redrawn. */
29854 && x
+ first
->pixel_width
< r
->x
)
29856 x
+= first
->pixel_width
;
29860 /* Find the last one. */
29864 && x
< r
->x
+ r
->width
)
29866 x
+= last
->pixel_width
;
29872 draw_glyphs (w
, first_x
- start_x
, row
, area
,
29873 first
- row
->glyphs
[area
], last
- row
->glyphs
[area
],
29874 DRAW_NORMAL_TEXT
, 0);
29879 /* Redraw the parts of the glyph row ROW on window W intersecting
29880 rectangle R. R is in window-relative coordinates. Value is
29881 non-zero if mouse-face was overwritten. */
29884 expose_line (struct window
*w
, struct glyph_row
*row
, XRectangle
*r
)
29886 eassert (row
->enabled_p
);
29888 if (row
->mode_line_p
|| w
->pseudo_window_p
)
29889 draw_glyphs (w
, 0, row
, TEXT_AREA
,
29890 0, row
->used
[TEXT_AREA
],
29891 DRAW_NORMAL_TEXT
, 0);
29894 if (row
->used
[LEFT_MARGIN_AREA
])
29895 expose_area (w
, row
, r
, LEFT_MARGIN_AREA
);
29896 if (row
->used
[TEXT_AREA
])
29897 expose_area (w
, row
, r
, TEXT_AREA
);
29898 if (row
->used
[RIGHT_MARGIN_AREA
])
29899 expose_area (w
, row
, r
, RIGHT_MARGIN_AREA
);
29900 draw_row_fringe_bitmaps (w
, row
);
29903 return row
->mouse_face_p
;
29907 /* Redraw those parts of glyphs rows during expose event handling that
29908 overlap other rows. Redrawing of an exposed line writes over parts
29909 of lines overlapping that exposed line; this function fixes that.
29911 W is the window being exposed. FIRST_OVERLAPPING_ROW is the first
29912 row in W's current matrix that is exposed and overlaps other rows.
29913 LAST_OVERLAPPING_ROW is the last such row. */
29916 expose_overlaps (struct window
*w
,
29917 struct glyph_row
*first_overlapping_row
,
29918 struct glyph_row
*last_overlapping_row
,
29921 struct glyph_row
*row
;
29923 for (row
= first_overlapping_row
; row
<= last_overlapping_row
; ++row
)
29924 if (row
->overlapping_p
)
29926 eassert (row
->enabled_p
&& !row
->mode_line_p
);
29929 if (row
->used
[LEFT_MARGIN_AREA
])
29930 x_fix_overlapping_area (w
, row
, LEFT_MARGIN_AREA
, OVERLAPS_BOTH
);
29932 if (row
->used
[TEXT_AREA
])
29933 x_fix_overlapping_area (w
, row
, TEXT_AREA
, OVERLAPS_BOTH
);
29935 if (row
->used
[RIGHT_MARGIN_AREA
])
29936 x_fix_overlapping_area (w
, row
, RIGHT_MARGIN_AREA
, OVERLAPS_BOTH
);
29942 /* Return non-zero if W's cursor intersects rectangle R. */
29945 phys_cursor_in_rect_p (struct window
*w
, XRectangle
*r
)
29947 XRectangle cr
, result
;
29948 struct glyph
*cursor_glyph
;
29949 struct glyph_row
*row
;
29951 if (w
->phys_cursor
.vpos
>= 0
29952 && w
->phys_cursor
.vpos
< w
->current_matrix
->nrows
29953 && (row
= MATRIX_ROW (w
->current_matrix
, w
->phys_cursor
.vpos
),
29955 && row
->cursor_in_fringe_p
)
29957 /* Cursor is in the fringe. */
29958 cr
.x
= window_box_right_offset (w
,
29959 (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
29960 ? RIGHT_MARGIN_AREA
29963 cr
.width
= WINDOW_RIGHT_FRINGE_WIDTH (w
);
29964 cr
.height
= row
->height
;
29965 return x_intersect_rectangles (&cr
, r
, &result
);
29968 cursor_glyph
= get_phys_cursor_glyph (w
);
29971 /* r is relative to W's box, but w->phys_cursor.x is relative
29972 to left edge of W's TEXT area. Adjust it. */
29973 cr
.x
= window_box_left_offset (w
, TEXT_AREA
) + w
->phys_cursor
.x
;
29974 cr
.y
= w
->phys_cursor
.y
;
29975 cr
.width
= cursor_glyph
->pixel_width
;
29976 cr
.height
= w
->phys_cursor_height
;
29977 /* ++KFS: W32 version used W32-specific IntersectRect here, but
29978 I assume the effect is the same -- and this is portable. */
29979 return x_intersect_rectangles (&cr
, r
, &result
);
29981 /* If we don't understand the format, pretend we're not in the hot-spot. */
29987 Draw a vertical window border to the right of window W if W doesn't
29988 have vertical scroll bars. */
29991 x_draw_vertical_border (struct window
*w
)
29993 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
29995 /* We could do better, if we knew what type of scroll-bar the adjacent
29996 windows (on either side) have... But we don't :-(
29997 However, I think this works ok. ++KFS 2003-04-25 */
29999 /* Redraw borders between horizontally adjacent windows. Don't
30000 do it for frames with vertical scroll bars because either the
30001 right scroll bar of a window, or the left scroll bar of its
30002 neighbor will suffice as a border. */
30003 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f
) || FRAME_RIGHT_DIVIDER_WIDTH (f
))
30006 /* Note: It is necessary to redraw both the left and the right
30007 borders, for when only this single window W is being
30009 if (!WINDOW_RIGHTMOST_P (w
)
30010 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
))
30012 int x0
, x1
, y0
, y1
;
30014 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30017 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30020 FRAME_RIF (f
)->draw_vertical_window_border (w
, x1
, y0
, y1
);
30023 if (!WINDOW_LEFTMOST_P (w
)
30024 && !WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w
))
30026 int x0
, x1
, y0
, y1
;
30028 window_box_edges (w
, &x0
, &y0
, &x1
, &y1
);
30031 if (WINDOW_LEFT_FRINGE_WIDTH (w
) == 0)
30034 FRAME_RIF (f
)->draw_vertical_window_border (w
, x0
, y0
, y1
);
30039 /* Draw window dividers for window W. */
30042 x_draw_right_divider (struct window
*w
)
30044 struct frame
*f
= WINDOW_XFRAME (w
);
30046 if (w
->mini
|| w
->pseudo_window_p
)
30048 else if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30050 int x0
= WINDOW_RIGHT_EDGE_X (w
) - WINDOW_RIGHT_DIVIDER_WIDTH (w
);
30051 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30052 int y0
= WINDOW_TOP_EDGE_Y (w
);
30053 /* The bottom divider prevails. */
30054 int y1
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30056 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30061 x_draw_bottom_divider (struct window
*w
)
30063 struct frame
*f
= XFRAME (WINDOW_FRAME (w
));
30065 if (w
->mini
|| w
->pseudo_window_p
)
30067 else if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30069 int x0
= WINDOW_LEFT_EDGE_X (w
);
30070 int x1
= WINDOW_RIGHT_EDGE_X (w
);
30071 int y0
= WINDOW_BOTTOM_EDGE_Y (w
) - WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
30072 int y1
= WINDOW_BOTTOM_EDGE_Y (w
);
30074 FRAME_RIF (f
)->draw_window_divider (w
, x0
, x1
, y0
, y1
);
30078 /* Redraw the part of window W intersection rectangle FR. Pixel
30079 coordinates in FR are frame-relative. Call this function with
30080 input blocked. Value is non-zero if the exposure overwrites
30084 expose_window (struct window
*w
, XRectangle
*fr
)
30086 struct frame
*f
= XFRAME (w
->frame
);
30088 int mouse_face_overwritten_p
= 0;
30090 /* If window is not yet fully initialized, do nothing. This can
30091 happen when toolkit scroll bars are used and a window is split.
30092 Reconfiguring the scroll bar will generate an expose for a newly
30094 if (w
->current_matrix
== NULL
)
30097 /* When we're currently updating the window, display and current
30098 matrix usually don't agree. Arrange for a thorough display
30100 if (w
->must_be_updated_p
)
30102 SET_FRAME_GARBAGED (f
);
30106 /* Frame-relative pixel rectangle of W. */
30107 wr
.x
= WINDOW_LEFT_EDGE_X (w
);
30108 wr
.y
= WINDOW_TOP_EDGE_Y (w
);
30109 wr
.width
= WINDOW_PIXEL_WIDTH (w
);
30110 wr
.height
= WINDOW_PIXEL_HEIGHT (w
);
30112 if (x_intersect_rectangles (fr
, &wr
, &r
))
30114 int yb
= window_text_bottom_y (w
);
30115 struct glyph_row
*row
;
30116 int cursor_cleared_p
, phys_cursor_on_p
;
30117 struct glyph_row
*first_overlapping_row
, *last_overlapping_row
;
30119 TRACE ((stderr
, "expose_window (%d, %d, %d, %d)\n",
30120 r
.x
, r
.y
, r
.width
, r
.height
));
30122 /* Convert to window coordinates. */
30123 r
.x
-= WINDOW_LEFT_EDGE_X (w
);
30124 r
.y
-= WINDOW_TOP_EDGE_Y (w
);
30126 /* Turn off the cursor. */
30127 if (!w
->pseudo_window_p
30128 && phys_cursor_in_rect_p (w
, &r
))
30130 x_clear_cursor (w
);
30131 cursor_cleared_p
= 1;
30134 cursor_cleared_p
= 0;
30136 /* If the row containing the cursor extends face to end of line,
30137 then expose_area might overwrite the cursor outside the
30138 rectangle and thus notice_overwritten_cursor might clear
30139 w->phys_cursor_on_p. We remember the original value and
30140 check later if it is changed. */
30141 phys_cursor_on_p
= w
->phys_cursor_on_p
;
30143 /* Update lines intersecting rectangle R. */
30144 first_overlapping_row
= last_overlapping_row
= NULL
;
30145 for (row
= w
->current_matrix
->rows
;
30150 int y1
= MATRIX_ROW_BOTTOM_Y (row
);
30152 if ((y0
>= r
.y
&& y0
< r
.y
+ r
.height
)
30153 || (y1
> r
.y
&& y1
< r
.y
+ r
.height
)
30154 || (r
.y
>= y0
&& r
.y
< y1
)
30155 || (r
.y
+ r
.height
> y0
&& r
.y
+ r
.height
< y1
))
30157 /* A header line may be overlapping, but there is no need
30158 to fix overlapping areas for them. KFS 2005-02-12 */
30159 if (row
->overlapping_p
&& !row
->mode_line_p
)
30161 if (first_overlapping_row
== NULL
)
30162 first_overlapping_row
= row
;
30163 last_overlapping_row
= row
;
30167 if (expose_line (w
, row
, &r
))
30168 mouse_face_overwritten_p
= 1;
30171 else if (row
->overlapping_p
)
30173 /* We must redraw a row overlapping the exposed area. */
30175 ? y0
+ row
->phys_height
> r
.y
30176 : y0
+ row
->ascent
- row
->phys_ascent
< r
.y
+r
.height
)
30178 if (first_overlapping_row
== NULL
)
30179 first_overlapping_row
= row
;
30180 last_overlapping_row
= row
;
30188 /* Display the mode line if there is one. */
30189 if (WINDOW_WANTS_MODELINE_P (w
)
30190 && (row
= MATRIX_MODE_LINE_ROW (w
->current_matrix
),
30192 && row
->y
< r
.y
+ r
.height
)
30194 if (expose_line (w
, row
, &r
))
30195 mouse_face_overwritten_p
= 1;
30198 if (!w
->pseudo_window_p
)
30200 /* Fix the display of overlapping rows. */
30201 if (first_overlapping_row
)
30202 expose_overlaps (w
, first_overlapping_row
, last_overlapping_row
,
30205 /* Draw border between windows. */
30206 if (WINDOW_RIGHT_DIVIDER_WIDTH (w
))
30207 x_draw_right_divider (w
);
30209 x_draw_vertical_border (w
);
30211 if (WINDOW_BOTTOM_DIVIDER_WIDTH (w
))
30212 x_draw_bottom_divider (w
);
30214 /* Turn the cursor on again. */
30215 if (cursor_cleared_p
30216 || (phys_cursor_on_p
&& !w
->phys_cursor_on_p
))
30217 update_window_cursor (w
, 1);
30221 return mouse_face_overwritten_p
;
30226 /* Redraw (parts) of all windows in the window tree rooted at W that
30227 intersect R. R contains frame pixel coordinates. Value is
30228 non-zero if the exposure overwrites mouse-face. */
30231 expose_window_tree (struct window
*w
, XRectangle
*r
)
30233 struct frame
*f
= XFRAME (w
->frame
);
30234 int mouse_face_overwritten_p
= 0;
30236 while (w
&& !FRAME_GARBAGED_P (f
))
30238 if (WINDOWP (w
->contents
))
30239 mouse_face_overwritten_p
30240 |= expose_window_tree (XWINDOW (w
->contents
), r
);
30242 mouse_face_overwritten_p
|= expose_window (w
, r
);
30244 w
= NILP (w
->next
) ? NULL
: XWINDOW (w
->next
);
30247 return mouse_face_overwritten_p
;
30252 Redisplay an exposed area of frame F. X and Y are the upper-left
30253 corner of the exposed rectangle. W and H are width and height of
30254 the exposed area. All are pixel values. W or H zero means redraw
30255 the entire frame. */
30258 expose_frame (struct frame
*f
, int x
, int y
, int w
, int h
)
30261 int mouse_face_overwritten_p
= 0;
30263 TRACE ((stderr
, "expose_frame "));
30265 /* No need to redraw if frame will be redrawn soon. */
30266 if (FRAME_GARBAGED_P (f
))
30268 TRACE ((stderr
, " garbaged\n"));
30272 /* If basic faces haven't been realized yet, there is no point in
30273 trying to redraw anything. This can happen when we get an expose
30274 event while Emacs is starting, e.g. by moving another window. */
30275 if (FRAME_FACE_CACHE (f
) == NULL
30276 || FRAME_FACE_CACHE (f
)->used
< BASIC_FACE_ID_SENTINEL
)
30278 TRACE ((stderr
, " no faces\n"));
30282 if (w
== 0 || h
== 0)
30285 r
.width
= FRAME_TEXT_WIDTH (f
);
30286 r
.height
= FRAME_TEXT_HEIGHT (f
);
30296 TRACE ((stderr
, "(%d, %d, %d, %d)\n", r
.x
, r
.y
, r
.width
, r
.height
));
30297 mouse_face_overwritten_p
= expose_window_tree (XWINDOW (f
->root_window
), &r
);
30299 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
30300 if (WINDOWP (f
->tool_bar_window
))
30301 mouse_face_overwritten_p
30302 |= expose_window (XWINDOW (f
->tool_bar_window
), &r
);
30305 #ifdef HAVE_X_WINDOWS
30307 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
30308 if (WINDOWP (f
->menu_bar_window
))
30309 mouse_face_overwritten_p
30310 |= expose_window (XWINDOW (f
->menu_bar_window
), &r
);
30311 #endif /* not USE_X_TOOLKIT and not USE_GTK */
30315 /* Some window managers support a focus-follows-mouse style with
30316 delayed raising of frames. Imagine a partially obscured frame,
30317 and moving the mouse into partially obscured mouse-face on that
30318 frame. The visible part of the mouse-face will be highlighted,
30319 then the WM raises the obscured frame. With at least one WM, KDE
30320 2.1, Emacs is not getting any event for the raising of the frame
30321 (even tried with SubstructureRedirectMask), only Expose events.
30322 These expose events will draw text normally, i.e. not
30323 highlighted. Which means we must redo the highlight here.
30324 Subsume it under ``we love X''. --gerd 2001-08-15 */
30325 /* Included in Windows version because Windows most likely does not
30326 do the right thing if any third party tool offers
30327 focus-follows-mouse with delayed raise. --jason 2001-10-12 */
30328 if (mouse_face_overwritten_p
&& !FRAME_GARBAGED_P (f
))
30330 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
30331 if (f
== hlinfo
->mouse_face_mouse_frame
)
30333 int mouse_x
= hlinfo
->mouse_face_mouse_x
;
30334 int mouse_y
= hlinfo
->mouse_face_mouse_y
;
30335 clear_mouse_face (hlinfo
);
30336 note_mouse_highlight (f
, mouse_x
, mouse_y
);
30343 Determine the intersection of two rectangles R1 and R2. Return
30344 the intersection in *RESULT. Value is non-zero if RESULT is not
30348 x_intersect_rectangles (XRectangle
*r1
, XRectangle
*r2
, XRectangle
*result
)
30350 XRectangle
*left
, *right
;
30351 XRectangle
*upper
, *lower
;
30352 int intersection_p
= 0;
30354 /* Rearrange so that R1 is the left-most rectangle. */
30356 left
= r1
, right
= r2
;
30358 left
= r2
, right
= r1
;
30360 /* X0 of the intersection is right.x0, if this is inside R1,
30361 otherwise there is no intersection. */
30362 if (right
->x
<= left
->x
+ left
->width
)
30364 result
->x
= right
->x
;
30366 /* The right end of the intersection is the minimum of
30367 the right ends of left and right. */
30368 result
->width
= (min (left
->x
+ left
->width
, right
->x
+ right
->width
)
30371 /* Same game for Y. */
30373 upper
= r1
, lower
= r2
;
30375 upper
= r2
, lower
= r1
;
30377 /* The upper end of the intersection is lower.y0, if this is inside
30378 of upper. Otherwise, there is no intersection. */
30379 if (lower
->y
<= upper
->y
+ upper
->height
)
30381 result
->y
= lower
->y
;
30383 /* The lower end of the intersection is the minimum of the lower
30384 ends of upper and lower. */
30385 result
->height
= (min (lower
->y
+ lower
->height
,
30386 upper
->y
+ upper
->height
)
30388 intersection_p
= 1;
30392 return intersection_p
;
30395 #endif /* HAVE_WINDOW_SYSTEM */
30398 /***********************************************************************
30400 ***********************************************************************/
30403 syms_of_xdisp (void)
30405 Vwith_echo_area_save_vector
= Qnil
;
30406 staticpro (&Vwith_echo_area_save_vector
);
30408 Vmessage_stack
= Qnil
;
30409 staticpro (&Vmessage_stack
);
30411 DEFSYM (Qinhibit_redisplay
, "inhibit-redisplay");
30412 DEFSYM (Qredisplay_internal
, "redisplay_internal (C function)");
30414 message_dolog_marker1
= Fmake_marker ();
30415 staticpro (&message_dolog_marker1
);
30416 message_dolog_marker2
= Fmake_marker ();
30417 staticpro (&message_dolog_marker2
);
30418 message_dolog_marker3
= Fmake_marker ();
30419 staticpro (&message_dolog_marker3
);
30422 defsubr (&Sdump_frame_glyph_matrix
);
30423 defsubr (&Sdump_glyph_matrix
);
30424 defsubr (&Sdump_glyph_row
);
30425 defsubr (&Sdump_tool_bar_row
);
30426 defsubr (&Strace_redisplay
);
30427 defsubr (&Strace_to_stderr
);
30429 #ifdef HAVE_WINDOW_SYSTEM
30430 defsubr (&Stool_bar_height
);
30431 defsubr (&Slookup_image_map
);
30433 defsubr (&Sline_pixel_height
);
30434 defsubr (&Sformat_mode_line
);
30435 defsubr (&Sinvisible_p
);
30436 defsubr (&Scurrent_bidi_paragraph_direction
);
30437 defsubr (&Swindow_text_pixel_size
);
30438 defsubr (&Smove_point_visually
);
30440 DEFSYM (Qmenu_bar_update_hook
, "menu-bar-update-hook");
30441 DEFSYM (Qoverriding_terminal_local_map
, "overriding-terminal-local-map");
30442 DEFSYM (Qoverriding_local_map
, "overriding-local-map");
30443 DEFSYM (Qwindow_scroll_functions
, "window-scroll-functions");
30444 DEFSYM (Qwindow_text_change_functions
, "window-text-change-functions");
30445 DEFSYM (Qredisplay_end_trigger_functions
, "redisplay-end-trigger-functions");
30446 DEFSYM (Qinhibit_point_motion_hooks
, "inhibit-point-motion-hooks");
30447 DEFSYM (Qeval
, "eval");
30448 DEFSYM (QCdata
, ":data");
30449 DEFSYM (Qdisplay
, "display");
30450 DEFSYM (Qspace_width
, "space-width");
30451 DEFSYM (Qraise
, "raise");
30452 DEFSYM (Qslice
, "slice");
30453 DEFSYM (Qspace
, "space");
30454 DEFSYM (Qmargin
, "margin");
30455 DEFSYM (Qpointer
, "pointer");
30456 DEFSYM (Qleft_margin
, "left-margin");
30457 DEFSYM (Qright_margin
, "right-margin");
30458 DEFSYM (Qcenter
, "center");
30459 DEFSYM (Qline_height
, "line-height");
30460 DEFSYM (QCalign_to
, ":align-to");
30461 DEFSYM (QCrelative_width
, ":relative-width");
30462 DEFSYM (QCrelative_height
, ":relative-height");
30463 DEFSYM (QCeval
, ":eval");
30464 DEFSYM (QCpropertize
, ":propertize");
30465 DEFSYM (QCfile
, ":file");
30466 DEFSYM (Qfontified
, "fontified");
30467 DEFSYM (Qfontification_functions
, "fontification-functions");
30468 DEFSYM (Qtrailing_whitespace
, "trailing-whitespace");
30469 DEFSYM (Qescape_glyph
, "escape-glyph");
30470 DEFSYM (Qnobreak_space
, "nobreak-space");
30471 DEFSYM (Qimage
, "image");
30472 DEFSYM (Qtext
, "text");
30473 DEFSYM (Qboth
, "both");
30474 DEFSYM (Qboth_horiz
, "both-horiz");
30475 DEFSYM (Qtext_image_horiz
, "text-image-horiz");
30476 DEFSYM (QCmap
, ":map");
30477 DEFSYM (QCpointer
, ":pointer");
30478 DEFSYM (Qrect
, "rect");
30479 DEFSYM (Qcircle
, "circle");
30480 DEFSYM (Qpoly
, "poly");
30481 DEFSYM (Qmessage_truncate_lines
, "message-truncate-lines");
30482 DEFSYM (Qgrow_only
, "grow-only");
30483 DEFSYM (Qinhibit_menubar_update
, "inhibit-menubar-update");
30484 DEFSYM (Qinhibit_eval_during_redisplay
, "inhibit-eval-during-redisplay");
30485 DEFSYM (Qposition
, "position");
30486 DEFSYM (Qbuffer_position
, "buffer-position");
30487 DEFSYM (Qobject
, "object");
30488 DEFSYM (Qbar
, "bar");
30489 DEFSYM (Qhbar
, "hbar");
30490 DEFSYM (Qbox
, "box");
30491 DEFSYM (Qhollow
, "hollow");
30492 DEFSYM (Qhand
, "hand");
30493 DEFSYM (Qarrow
, "arrow");
30494 DEFSYM (Qinhibit_free_realized_faces
, "inhibit-free-realized-faces");
30496 list_of_error
= list1 (list2 (intern_c_string ("error"),
30497 intern_c_string ("void-variable")));
30498 staticpro (&list_of_error
);
30500 DEFSYM (Qlast_arrow_position
, "last-arrow-position");
30501 DEFSYM (Qlast_arrow_string
, "last-arrow-string");
30502 DEFSYM (Qoverlay_arrow_string
, "overlay-arrow-string");
30503 DEFSYM (Qoverlay_arrow_bitmap
, "overlay-arrow-bitmap");
30505 echo_buffer
[0] = echo_buffer
[1] = Qnil
;
30506 staticpro (&echo_buffer
[0]);
30507 staticpro (&echo_buffer
[1]);
30509 echo_area_buffer
[0] = echo_area_buffer
[1] = Qnil
;
30510 staticpro (&echo_area_buffer
[0]);
30511 staticpro (&echo_area_buffer
[1]);
30513 Vmessages_buffer_name
= build_pure_c_string ("*Messages*");
30514 staticpro (&Vmessages_buffer_name
);
30516 mode_line_proptrans_alist
= Qnil
;
30517 staticpro (&mode_line_proptrans_alist
);
30518 mode_line_string_list
= Qnil
;
30519 staticpro (&mode_line_string_list
);
30520 mode_line_string_face
= Qnil
;
30521 staticpro (&mode_line_string_face
);
30522 mode_line_string_face_prop
= Qnil
;
30523 staticpro (&mode_line_string_face_prop
);
30524 Vmode_line_unwind_vector
= Qnil
;
30525 staticpro (&Vmode_line_unwind_vector
);
30527 DEFSYM (Qmode_line_default_help_echo
, "mode-line-default-help-echo");
30529 help_echo_string
= Qnil
;
30530 staticpro (&help_echo_string
);
30531 help_echo_object
= Qnil
;
30532 staticpro (&help_echo_object
);
30533 help_echo_window
= Qnil
;
30534 staticpro (&help_echo_window
);
30535 previous_help_echo_string
= Qnil
;
30536 staticpro (&previous_help_echo_string
);
30537 help_echo_pos
= -1;
30539 DEFSYM (Qright_to_left
, "right-to-left");
30540 DEFSYM (Qleft_to_right
, "left-to-right");
30541 defsubr (&Sbidi_resolved_levels
);
30543 #ifdef HAVE_WINDOW_SYSTEM
30544 DEFVAR_BOOL ("x-stretch-cursor", x_stretch_cursor_p
,
30545 doc
: /* Non-nil means draw block cursor as wide as the glyph under it.
30546 For example, if a block cursor is over a tab, it will be drawn as
30547 wide as that tab on the display. */);
30548 x_stretch_cursor_p
= 0;
30551 DEFVAR_LISP ("show-trailing-whitespace", Vshow_trailing_whitespace
,
30552 doc
: /* Non-nil means highlight trailing whitespace.
30553 The face used for trailing whitespace is `trailing-whitespace'. */);
30554 Vshow_trailing_whitespace
= Qnil
;
30556 DEFVAR_LISP ("nobreak-char-display", Vnobreak_char_display
,
30557 doc
: /* Control highlighting of non-ASCII space and hyphen chars.
30558 If the value is t, Emacs highlights non-ASCII chars which have the
30559 same appearance as an ASCII space or hyphen, using the `nobreak-space'
30560 or `escape-glyph' face respectively.
30562 U+00A0 (no-break space), U+00AD (soft hyphen), U+2010 (hyphen), and
30563 U+2011 (non-breaking hyphen) are affected.
30565 Any other non-nil value means to display these characters as a escape
30566 glyph followed by an ordinary space or hyphen.
30568 A value of nil means no special handling of these characters. */);
30569 Vnobreak_char_display
= Qt
;
30571 DEFVAR_LISP ("void-text-area-pointer", Vvoid_text_area_pointer
,
30572 doc
: /* The pointer shape to show in void text areas.
30573 A value of nil means to show the text pointer. Other options are
30574 `arrow', `text', `hand', `vdrag', `hdrag', `nhdrag', `modeline', and
30576 Vvoid_text_area_pointer
= Qarrow
;
30578 DEFVAR_LISP ("inhibit-redisplay", Vinhibit_redisplay
,
30579 doc
: /* Non-nil means don't actually do any redisplay.
30580 This is used for internal purposes. */);
30581 Vinhibit_redisplay
= Qnil
;
30583 DEFVAR_LISP ("global-mode-string", Vglobal_mode_string
,
30584 doc
: /* String (or mode line construct) included (normally) in `mode-line-format'. */);
30585 Vglobal_mode_string
= Qnil
;
30587 DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position
,
30588 doc
: /* Marker for where to display an arrow on top of the buffer text.
30589 This must be the beginning of a line in order to work.
30590 See also `overlay-arrow-string'. */);
30591 Voverlay_arrow_position
= Qnil
;
30593 DEFVAR_LISP ("overlay-arrow-string", Voverlay_arrow_string
,
30594 doc
: /* String to display as an arrow in non-window frames.
30595 See also `overlay-arrow-position'. */);
30596 Voverlay_arrow_string
= build_pure_c_string ("=>");
30598 DEFVAR_LISP ("overlay-arrow-variable-list", Voverlay_arrow_variable_list
,
30599 doc
: /* List of variables (symbols) which hold markers for overlay arrows.
30600 The symbols on this list are examined during redisplay to determine
30601 where to display overlay arrows. */);
30602 Voverlay_arrow_variable_list
30603 = list1 (intern_c_string ("overlay-arrow-position"));
30605 DEFVAR_INT ("scroll-step", emacs_scroll_step
,
30606 doc
: /* The number of lines to try scrolling a window by when point moves out.
30607 If that fails to bring point back on frame, point is centered instead.
30608 If this is zero, point is always centered after it moves off frame.
30609 If you want scrolling to always be a line at a time, you should set
30610 `scroll-conservatively' to a large value rather than set this to 1. */);
30612 DEFVAR_INT ("scroll-conservatively", scroll_conservatively
,
30613 doc
: /* Scroll up to this many lines, to bring point back on screen.
30614 If point moves off-screen, redisplay will scroll by up to
30615 `scroll-conservatively' lines in order to bring point just barely
30616 onto the screen again. If that cannot be done, then redisplay
30617 recenters point as usual.
30619 If the value is greater than 100, redisplay will never recenter point,
30620 but will always scroll just enough text to bring point into view, even
30621 if you move far away.
30623 A value of zero means always recenter point if it moves off screen. */);
30624 scroll_conservatively
= 0;
30626 DEFVAR_INT ("scroll-margin", scroll_margin
,
30627 doc
: /* Number of lines of margin at the top and bottom of a window.
30628 Recenter the window whenever point gets within this many lines
30629 of the top or bottom of the window. */);
30632 DEFVAR_LISP ("display-pixels-per-inch", Vdisplay_pixels_per_inch
,
30633 doc
: /* Pixels per inch value for non-window system displays.
30634 Value is a number or a cons (WIDTH-DPI . HEIGHT-DPI). */);
30635 Vdisplay_pixels_per_inch
= make_float (72.0);
30638 DEFVAR_INT ("debug-end-pos", debug_end_pos
, doc
: /* Don't ask. */);
30641 DEFVAR_LISP ("truncate-partial-width-windows",
30642 Vtruncate_partial_width_windows
,
30643 doc
: /* Non-nil means truncate lines in windows narrower than the frame.
30644 For an integer value, truncate lines in each window narrower than the
30645 full frame width, provided the window width is less than that integer;
30646 otherwise, respect the value of `truncate-lines'.
30648 For any other non-nil value, truncate lines in all windows that do
30649 not span the full frame width.
30651 A value of nil means to respect the value of `truncate-lines'.
30653 If `word-wrap' is enabled, you might want to reduce this. */);
30654 Vtruncate_partial_width_windows
= make_number (50);
30656 DEFVAR_LISP ("line-number-display-limit", Vline_number_display_limit
,
30657 doc
: /* Maximum buffer size for which line number should be displayed.
30658 If the buffer is bigger than this, the line number does not appear
30659 in the mode line. A value of nil means no limit. */);
30660 Vline_number_display_limit
= Qnil
;
30662 DEFVAR_INT ("line-number-display-limit-width",
30663 line_number_display_limit_width
,
30664 doc
: /* Maximum line width (in characters) for line number display.
30665 If the average length of the lines near point is bigger than this, then the
30666 line number may be omitted from the mode line. */);
30667 line_number_display_limit_width
= 200;
30669 DEFVAR_BOOL ("highlight-nonselected-windows", highlight_nonselected_windows
,
30670 doc
: /* Non-nil means highlight region even in nonselected windows. */);
30671 highlight_nonselected_windows
= 0;
30673 DEFVAR_BOOL ("multiple-frames", multiple_frames
,
30674 doc
: /* Non-nil if more than one frame is visible on this display.
30675 Minibuffer-only frames don't count, but iconified frames do.
30676 This variable is not guaranteed to be accurate except while processing
30677 `frame-title-format' and `icon-title-format'. */);
30679 DEFVAR_LISP ("frame-title-format", Vframe_title_format
,
30680 doc
: /* Template for displaying the title bar of visible frames.
30681 \(Assuming the window manager supports this feature.)
30683 This variable has the same structure as `mode-line-format', except that
30684 the %c and %l constructs are ignored. It is used only on frames for
30685 which no explicit name has been set \(see `modify-frame-parameters'). */);
30687 DEFVAR_LISP ("icon-title-format", Vicon_title_format
,
30688 doc
: /* Template for displaying the title bar of an iconified frame.
30689 \(Assuming the window manager supports this feature.)
30690 This variable has the same structure as `mode-line-format' (which see),
30691 and is used only on frames for which no explicit name has been set
30692 \(see `modify-frame-parameters'). */);
30694 = Vframe_title_format
30695 = listn (CONSTYPE_PURE
, 3,
30696 intern_c_string ("multiple-frames"),
30697 build_pure_c_string ("%b"),
30698 listn (CONSTYPE_PURE
, 4,
30699 empty_unibyte_string
,
30700 intern_c_string ("invocation-name"),
30701 build_pure_c_string ("@"),
30702 intern_c_string ("system-name")));
30704 DEFVAR_LISP ("message-log-max", Vmessage_log_max
,
30705 doc
: /* Maximum number of lines to keep in the message log buffer.
30706 If nil, disable message logging. If t, log messages but don't truncate
30707 the buffer when it becomes large. */);
30708 Vmessage_log_max
= make_number (1000);
30710 DEFVAR_LISP ("window-size-change-functions", Vwindow_size_change_functions
,
30711 doc
: /* Functions called before redisplay, if window sizes have changed.
30712 The value should be a list of functions that take one argument.
30713 Just before redisplay, for each frame, if any of its windows have changed
30714 size since the last redisplay, or have been split or deleted,
30715 all the functions in the list are called, with the frame as argument. */);
30716 Vwindow_size_change_functions
= Qnil
;
30718 DEFVAR_LISP ("window-scroll-functions", Vwindow_scroll_functions
,
30719 doc
: /* List of functions to call before redisplaying a window with scrolling.
30720 Each function is called with two arguments, the window and its new
30721 display-start position. Note that these functions are also called by
30722 `set-window-buffer'. Also note that the value of `window-end' is not
30723 valid when these functions are called.
30725 Warning: Do not use this feature to alter the way the window
30726 is scrolled. It is not designed for that, and such use probably won't
30728 Vwindow_scroll_functions
= Qnil
;
30730 DEFVAR_LISP ("window-text-change-functions",
30731 Vwindow_text_change_functions
,
30732 doc
: /* Functions to call in redisplay when text in the window might change. */);
30733 Vwindow_text_change_functions
= Qnil
;
30735 DEFVAR_LISP ("redisplay-end-trigger-functions", Vredisplay_end_trigger_functions
,
30736 doc
: /* Functions called when redisplay of a window reaches the end trigger.
30737 Each function is called with two arguments, the window and the end trigger value.
30738 See `set-window-redisplay-end-trigger'. */);
30739 Vredisplay_end_trigger_functions
= Qnil
;
30741 DEFVAR_LISP ("mouse-autoselect-window", Vmouse_autoselect_window
,
30742 doc
: /* Non-nil means autoselect window with mouse pointer.
30743 If nil, do not autoselect windows.
30744 A positive number means delay autoselection by that many seconds: a
30745 window is autoselected only after the mouse has remained in that
30746 window for the duration of the delay.
30747 A negative number has a similar effect, but causes windows to be
30748 autoselected only after the mouse has stopped moving. \(Because of
30749 the way Emacs compares mouse events, you will occasionally wait twice
30750 that time before the window gets selected.\)
30751 Any other value means to autoselect window instantaneously when the
30752 mouse pointer enters it.
30754 Autoselection selects the minibuffer only if it is active, and never
30755 unselects the minibuffer if it is active.
30757 When customizing this variable make sure that the actual value of
30758 `focus-follows-mouse' matches the behavior of your window manager. */);
30759 Vmouse_autoselect_window
= Qnil
;
30761 DEFVAR_LISP ("auto-resize-tool-bars", Vauto_resize_tool_bars
,
30762 doc
: /* Non-nil means automatically resize tool-bars.
30763 This dynamically changes the tool-bar's height to the minimum height
30764 that is needed to make all tool-bar items visible.
30765 If value is `grow-only', the tool-bar's height is only increased
30766 automatically; to decrease the tool-bar height, use \\[recenter]. */);
30767 Vauto_resize_tool_bars
= Qt
;
30769 DEFVAR_BOOL ("auto-raise-tool-bar-buttons", auto_raise_tool_bar_buttons_p
,
30770 doc
: /* Non-nil means raise tool-bar buttons when the mouse moves over them. */);
30771 auto_raise_tool_bar_buttons_p
= 1;
30773 DEFVAR_BOOL ("make-cursor-line-fully-visible", make_cursor_line_fully_visible_p
,
30774 doc
: /* Non-nil means to scroll (recenter) cursor line if it is not fully visible. */);
30775 make_cursor_line_fully_visible_p
= 1;
30777 DEFVAR_LISP ("tool-bar-border", Vtool_bar_border
,
30778 doc
: /* Border below tool-bar in pixels.
30779 If an integer, use it as the height of the border.
30780 If it is one of `internal-border-width' or `border-width', use the
30781 value of the corresponding frame parameter.
30782 Otherwise, no border is added below the tool-bar. */);
30783 Vtool_bar_border
= Qinternal_border_width
;
30785 DEFVAR_LISP ("tool-bar-button-margin", Vtool_bar_button_margin
,
30786 doc
: /* Margin around tool-bar buttons in pixels.
30787 If an integer, use that for both horizontal and vertical margins.
30788 Otherwise, value should be a pair of integers `(HORZ . VERT)' with
30789 HORZ specifying the horizontal margin, and VERT specifying the
30790 vertical margin. */);
30791 Vtool_bar_button_margin
= make_number (DEFAULT_TOOL_BAR_BUTTON_MARGIN
);
30793 DEFVAR_INT ("tool-bar-button-relief", tool_bar_button_relief
,
30794 doc
: /* Relief thickness of tool-bar buttons. */);
30795 tool_bar_button_relief
= DEFAULT_TOOL_BAR_BUTTON_RELIEF
;
30797 DEFVAR_LISP ("tool-bar-style", Vtool_bar_style
,
30798 doc
: /* Tool bar style to use.
30800 image - show images only
30801 text - show text only
30802 both - show both, text below image
30803 both-horiz - show text to the right of the image
30804 text-image-horiz - show text to the left of the image
30805 any other - use system default or image if no system default.
30807 This variable only affects the GTK+ toolkit version of Emacs. */);
30808 Vtool_bar_style
= Qnil
;
30810 DEFVAR_INT ("tool-bar-max-label-size", tool_bar_max_label_size
,
30811 doc
: /* Maximum number of characters a label can have to be shown.
30812 The tool bar style must also show labels for this to have any effect, see
30813 `tool-bar-style'. */);
30814 tool_bar_max_label_size
= DEFAULT_TOOL_BAR_LABEL_SIZE
;
30816 DEFVAR_LISP ("fontification-functions", Vfontification_functions
,
30817 doc
: /* List of functions to call to fontify regions of text.
30818 Each function is called with one argument POS. Functions must
30819 fontify a region starting at POS in the current buffer, and give
30820 fontified regions the property `fontified'. */);
30821 Vfontification_functions
= Qnil
;
30822 Fmake_variable_buffer_local (Qfontification_functions
);
30824 DEFVAR_BOOL ("unibyte-display-via-language-environment",
30825 unibyte_display_via_language_environment
,
30826 doc
: /* Non-nil means display unibyte text according to language environment.
30827 Specifically, this means that raw bytes in the range 160-255 decimal
30828 are displayed by converting them to the equivalent multibyte characters
30829 according to the current language environment. As a result, they are
30830 displayed according to the current fontset.
30832 Note that this variable affects only how these bytes are displayed,
30833 but does not change the fact they are interpreted as raw bytes. */);
30834 unibyte_display_via_language_environment
= 0;
30836 DEFVAR_LISP ("max-mini-window-height", Vmax_mini_window_height
,
30837 doc
: /* Maximum height for resizing mini-windows (the minibuffer and the echo area).
30838 If a float, it specifies a fraction of the mini-window frame's height.
30839 If an integer, it specifies a number of lines. */);
30840 Vmax_mini_window_height
= make_float (0.25);
30842 DEFVAR_LISP ("resize-mini-windows", Vresize_mini_windows
,
30843 doc
: /* How to resize mini-windows (the minibuffer and the echo area).
30844 A value of nil means don't automatically resize mini-windows.
30845 A value of t means resize them to fit the text displayed in them.
30846 A value of `grow-only', the default, means let mini-windows grow only;
30847 they return to their normal size when the minibuffer is closed, or the
30848 echo area becomes empty. */);
30849 Vresize_mini_windows
= Qgrow_only
;
30851 DEFVAR_LISP ("blink-cursor-alist", Vblink_cursor_alist
,
30852 doc
: /* Alist specifying how to blink the cursor off.
30853 Each element has the form (ON-STATE . OFF-STATE). Whenever the
30854 `cursor-type' frame-parameter or variable equals ON-STATE,
30855 comparing using `equal', Emacs uses OFF-STATE to specify
30856 how to blink it off. ON-STATE and OFF-STATE are values for
30857 the `cursor-type' frame parameter.
30859 If a frame's ON-STATE has no entry in this list,
30860 the frame's other specifications determine how to blink the cursor off. */);
30861 Vblink_cursor_alist
= Qnil
;
30863 DEFVAR_BOOL ("auto-hscroll-mode", automatic_hscrolling_p
,
30864 doc
: /* Allow or disallow automatic horizontal scrolling of windows.
30865 If non-nil, windows are automatically scrolled horizontally to make
30866 point visible. */);
30867 automatic_hscrolling_p
= 1;
30868 DEFSYM (Qauto_hscroll_mode
, "auto-hscroll-mode");
30870 DEFVAR_INT ("hscroll-margin", hscroll_margin
,
30871 doc
: /* How many columns away from the window edge point is allowed to get
30872 before automatic hscrolling will horizontally scroll the window. */);
30873 hscroll_margin
= 5;
30875 DEFVAR_LISP ("hscroll-step", Vhscroll_step
,
30876 doc
: /* How many columns to scroll the window when point gets too close to the edge.
30877 When point is less than `hscroll-margin' columns from the window
30878 edge, automatic hscrolling will scroll the window by the amount of columns
30879 determined by this variable. If its value is a positive integer, scroll that
30880 many columns. If it's a positive floating-point number, it specifies the
30881 fraction of the window's width to scroll. If it's nil or zero, point will be
30882 centered horizontally after the scroll. Any other value, including negative
30883 numbers, are treated as if the value were zero.
30885 Automatic hscrolling always moves point outside the scroll margin, so if
30886 point was more than scroll step columns inside the margin, the window will
30887 scroll more than the value given by the scroll step.
30889 Note that the lower bound for automatic hscrolling specified by `scroll-left'
30890 and `scroll-right' overrides this variable's effect. */);
30891 Vhscroll_step
= make_number (0);
30893 DEFVAR_BOOL ("message-truncate-lines", message_truncate_lines
,
30894 doc
: /* If non-nil, messages are truncated instead of resizing the echo area.
30895 Bind this around calls to `message' to let it take effect. */);
30896 message_truncate_lines
= 0;
30898 DEFVAR_LISP ("menu-bar-update-hook", Vmenu_bar_update_hook
,
30899 doc
: /* Normal hook run to update the menu bar definitions.
30900 Redisplay runs this hook before it redisplays the menu bar.
30901 This is used to update menus such as Buffers, whose contents depend on
30903 Vmenu_bar_update_hook
= Qnil
;
30905 DEFVAR_LISP ("menu-updating-frame", Vmenu_updating_frame
,
30906 doc
: /* Frame for which we are updating a menu.
30907 The enable predicate for a menu binding should check this variable. */);
30908 Vmenu_updating_frame
= Qnil
;
30910 DEFVAR_BOOL ("inhibit-menubar-update", inhibit_menubar_update
,
30911 doc
: /* Non-nil means don't update menu bars. Internal use only. */);
30912 inhibit_menubar_update
= 0;
30914 DEFVAR_LISP ("wrap-prefix", Vwrap_prefix
,
30915 doc
: /* Prefix prepended to all continuation lines at display time.
30916 The value may be a string, an image, or a stretch-glyph; it is
30917 interpreted in the same way as the value of a `display' text property.
30919 This variable is overridden by any `wrap-prefix' text or overlay
30922 To add a prefix to non-continuation lines, use `line-prefix'. */);
30923 Vwrap_prefix
= Qnil
;
30924 DEFSYM (Qwrap_prefix
, "wrap-prefix");
30925 Fmake_variable_buffer_local (Qwrap_prefix
);
30927 DEFVAR_LISP ("line-prefix", Vline_prefix
,
30928 doc
: /* Prefix prepended to all non-continuation lines at display time.
30929 The value may be a string, an image, or a stretch-glyph; it is
30930 interpreted in the same way as the value of a `display' text property.
30932 This variable is overridden by any `line-prefix' text or overlay
30935 To add a prefix to continuation lines, use `wrap-prefix'. */);
30936 Vline_prefix
= Qnil
;
30937 DEFSYM (Qline_prefix
, "line-prefix");
30938 Fmake_variable_buffer_local (Qline_prefix
);
30940 DEFVAR_BOOL ("inhibit-eval-during-redisplay", inhibit_eval_during_redisplay
,
30941 doc
: /* Non-nil means don't eval Lisp during redisplay. */);
30942 inhibit_eval_during_redisplay
= 0;
30944 DEFVAR_BOOL ("inhibit-free-realized-faces", inhibit_free_realized_faces
,
30945 doc
: /* Non-nil means don't free realized faces. Internal use only. */);
30946 inhibit_free_realized_faces
= 0;
30948 DEFVAR_BOOL ("inhibit-bidi-mirroring", inhibit_bidi_mirroring
,
30949 doc
: /* Non-nil means don't mirror characters even when bidi context requires that.
30950 Intended for use during debugging and for testing bidi display;
30951 see biditest.el in the test suite. */);
30952 inhibit_bidi_mirroring
= 0;
30955 DEFVAR_BOOL ("inhibit-try-window-id", inhibit_try_window_id
,
30956 doc
: /* Inhibit try_window_id display optimization. */);
30957 inhibit_try_window_id
= 0;
30959 DEFVAR_BOOL ("inhibit-try-window-reusing", inhibit_try_window_reusing
,
30960 doc
: /* Inhibit try_window_reusing display optimization. */);
30961 inhibit_try_window_reusing
= 0;
30963 DEFVAR_BOOL ("inhibit-try-cursor-movement", inhibit_try_cursor_movement
,
30964 doc
: /* Inhibit try_cursor_movement display optimization. */);
30965 inhibit_try_cursor_movement
= 0;
30966 #endif /* GLYPH_DEBUG */
30968 DEFVAR_INT ("overline-margin", overline_margin
,
30969 doc
: /* Space between overline and text, in pixels.
30970 The default value is 2: the height of the overline (1 pixel) plus 1 pixel
30971 margin to the character height. */);
30972 overline_margin
= 2;
30974 DEFVAR_INT ("underline-minimum-offset",
30975 underline_minimum_offset
,
30976 doc
: /* Minimum distance between baseline and underline.
30977 This can improve legibility of underlined text at small font sizes,
30978 particularly when using variable `x-use-underline-position-properties'
30979 with fonts that specify an UNDERLINE_POSITION relatively close to the
30980 baseline. The default value is 1. */);
30981 underline_minimum_offset
= 1;
30983 DEFVAR_BOOL ("display-hourglass", display_hourglass_p
,
30984 doc
: /* Non-nil means show an hourglass pointer, when Emacs is busy.
30985 This feature only works when on a window system that can change
30986 cursor shapes. */);
30987 display_hourglass_p
= 1;
30989 DEFVAR_LISP ("hourglass-delay", Vhourglass_delay
,
30990 doc
: /* Seconds to wait before displaying an hourglass pointer when Emacs is busy. */);
30991 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
30993 #ifdef HAVE_WINDOW_SYSTEM
30994 hourglass_atimer
= NULL
;
30995 hourglass_shown_p
= 0;
30996 #endif /* HAVE_WINDOW_SYSTEM */
30998 DEFSYM (Qglyphless_char
, "glyphless-char");
30999 DEFSYM (Qhex_code
, "hex-code");
31000 DEFSYM (Qempty_box
, "empty-box");
31001 DEFSYM (Qthin_space
, "thin-space");
31002 DEFSYM (Qzero_width
, "zero-width");
31004 DEFVAR_LISP ("pre-redisplay-function", Vpre_redisplay_function
,
31005 doc
: /* Function run just before redisplay.
31006 It is called with one argument, which is the set of windows that are to
31007 be redisplayed. This set can be nil (meaning, only the selected window),
31008 or t (meaning all windows). */);
31009 Vpre_redisplay_function
= intern ("ignore");
31011 DEFSYM (Qglyphless_char_display
, "glyphless-char-display");
31012 Fput (Qglyphless_char_display
, Qchar_table_extra_slots
, make_number (1));
31014 DEFVAR_LISP ("glyphless-char-display", Vglyphless_char_display
,
31015 doc
: /* Char-table defining glyphless characters.
31016 Each element, if non-nil, should be one of the following:
31017 an ASCII acronym string: display this string in a box
31018 `hex-code': display the hexadecimal code of a character in a box
31019 `empty-box': display as an empty box
31020 `thin-space': display as 1-pixel width space
31021 `zero-width': don't display
31022 An element may also be a cons cell (GRAPHICAL . TEXT), which specifies the
31023 display method for graphical terminals and text terminals respectively.
31024 GRAPHICAL and TEXT should each have one of the values listed above.
31026 The char-table has one extra slot to control the display of a character for
31027 which no font is found. This slot only takes effect on graphical terminals.
31028 Its value should be an ASCII acronym string, `hex-code', `empty-box', or
31029 `thin-space'. The default is `empty-box'.
31031 If a character has a non-nil entry in an active display table, the
31032 display table takes effect; in this case, Emacs does not consult
31033 `glyphless-char-display' at all. */);
31034 Vglyphless_char_display
= Fmake_char_table (Qglyphless_char_display
, Qnil
);
31035 Fset_char_table_extra_slot (Vglyphless_char_display
, make_number (0),
31038 DEFVAR_LISP ("debug-on-message", Vdebug_on_message
,
31039 doc
: /* If non-nil, debug if a message matching this regexp is displayed. */);
31040 Vdebug_on_message
= Qnil
;
31042 DEFVAR_LISP ("redisplay--all-windows-cause", Vredisplay__all_windows_cause
,
31044 Vredisplay__all_windows_cause
31045 = Fmake_vector (make_number (100), make_number (0));
31047 DEFVAR_LISP ("redisplay--mode-lines-cause", Vredisplay__mode_lines_cause
,
31049 Vredisplay__mode_lines_cause
31050 = Fmake_vector (make_number (100), make_number (0));
31054 /* Initialize this module when Emacs starts. */
31059 CHARPOS (this_line_start_pos
) = 0;
31061 if (!noninteractive
)
31063 struct window
*m
= XWINDOW (minibuf_window
);
31064 Lisp_Object frame
= m
->frame
;
31065 struct frame
*f
= XFRAME (frame
);
31066 Lisp_Object root
= FRAME_ROOT_WINDOW (f
);
31067 struct window
*r
= XWINDOW (root
);
31070 echo_area_window
= minibuf_window
;
31072 r
->top_line
= FRAME_TOP_MARGIN (f
);
31073 r
->pixel_top
= r
->top_line
* FRAME_LINE_HEIGHT (f
);
31074 r
->total_cols
= FRAME_COLS (f
);
31075 r
->pixel_width
= r
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31076 r
->total_lines
= FRAME_TOTAL_LINES (f
) - 1 - FRAME_TOP_MARGIN (f
);
31077 r
->pixel_height
= r
->total_lines
* FRAME_LINE_HEIGHT (f
);
31079 m
->top_line
= FRAME_TOTAL_LINES (f
) - 1;
31080 m
->pixel_top
= m
->top_line
* FRAME_LINE_HEIGHT (f
);
31081 m
->total_cols
= FRAME_COLS (f
);
31082 m
->pixel_width
= m
->total_cols
* FRAME_COLUMN_WIDTH (f
);
31083 m
->total_lines
= 1;
31084 m
->pixel_height
= m
->total_lines
* FRAME_LINE_HEIGHT (f
);
31086 scratch_glyph_row
.glyphs
[TEXT_AREA
] = scratch_glyphs
;
31087 scratch_glyph_row
.glyphs
[TEXT_AREA
+ 1]
31088 = scratch_glyphs
+ MAX_SCRATCH_GLYPHS
;
31090 /* The default ellipsis glyphs `...'. */
31091 for (i
= 0; i
< 3; ++i
)
31092 default_invis_vector
[i
] = make_number ('.');
31096 /* Allocate the buffer for frame titles.
31097 Also used for `format-mode-line'. */
31099 mode_line_noprop_buf
= xmalloc (size
);
31100 mode_line_noprop_buf_end
= mode_line_noprop_buf
+ size
;
31101 mode_line_noprop_ptr
= mode_line_noprop_buf
;
31102 mode_line_target
= MODE_LINE_DISPLAY
;
31105 help_echo_showing_p
= 0;
31108 #ifdef HAVE_WINDOW_SYSTEM
31110 /* Platform-independent portion of hourglass implementation. */
31112 /* Timer function of hourglass_atimer. */
31115 show_hourglass (struct atimer
*timer
)
31117 /* The timer implementation will cancel this timer automatically
31118 after this function has run. Set hourglass_atimer to null
31119 so that we know the timer doesn't have to be canceled. */
31120 hourglass_atimer
= NULL
;
31122 if (!hourglass_shown_p
)
31124 Lisp_Object tail
, frame
;
31128 FOR_EACH_FRAME (tail
, frame
)
31130 struct frame
*f
= XFRAME (frame
);
31132 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31133 && FRAME_RIF (f
)->show_hourglass
)
31134 FRAME_RIF (f
)->show_hourglass (f
);
31137 hourglass_shown_p
= 1;
31142 /* Cancel a currently active hourglass timer, and start a new one. */
31145 start_hourglass (void)
31147 struct timespec delay
;
31149 cancel_hourglass ();
31151 if (INTEGERP (Vhourglass_delay
)
31152 && XINT (Vhourglass_delay
) > 0)
31153 delay
= make_timespec (min (XINT (Vhourglass_delay
),
31154 TYPE_MAXIMUM (time_t)),
31156 else if (FLOATP (Vhourglass_delay
)
31157 && XFLOAT_DATA (Vhourglass_delay
) > 0)
31158 delay
= dtotimespec (XFLOAT_DATA (Vhourglass_delay
));
31160 delay
= make_timespec (DEFAULT_HOURGLASS_DELAY
, 0);
31162 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
31163 show_hourglass
, NULL
);
31166 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
31170 cancel_hourglass (void)
31172 if (hourglass_atimer
)
31174 cancel_atimer (hourglass_atimer
);
31175 hourglass_atimer
= NULL
;
31178 if (hourglass_shown_p
)
31180 Lisp_Object tail
, frame
;
31184 FOR_EACH_FRAME (tail
, frame
)
31186 struct frame
*f
= XFRAME (frame
);
31188 if (FRAME_LIVE_P (f
) && FRAME_WINDOW_P (f
)
31189 && FRAME_RIF (f
)->hide_hourglass
)
31190 FRAME_RIF (f
)->hide_hourglass (f
);
31192 /* No cursors on non GUI frames - restore to stock arrow cursor. */
31193 else if (!FRAME_W32_P (f
))
31194 w32_arrow_cursor ();
31198 hourglass_shown_p
= 0;
31203 #endif /* HAVE_WINDOW_SYSTEM */